Merge pull request #15 from inhabitedtype/release

Initial release
inhabitedtype · Aug 5, 2015 · 2bb26e9 · 2bb26e9
2 parents 2b56fa8 + e8627a8
commit 2bb26e9
Show file tree

Hide file tree

Showing 8 changed files with 215 additions and 35 deletions.
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,30 @@
+Copyright (c) 2015, Inhabited Type LLC
+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+
+1. Redistributions of source code must retain the above copyright
+   notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright
+   notice, this list of conditions and the following disclaimer in the
+   documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the author nor the names of his contributors
+   may be used to endorse or promote products derived from this software
+   without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE CONTRIBUTORS ``AS IS'' AND ANY EXPRESS
+OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.
diff --git a/README.md b/README.md
@@ -1,32 +1,36 @@
 # ocaml-webmachine
 
-ocaml-webmachine is a layer on top of cohttp library that implements the state
-machines described in [RFC 7231 - Semantics and Content][7231], [RFC 7232 -
-Conditional Requests][7232], [RFC 7234 - Cachcing][7234], and [RFC 7235 -
-Authentication][7235]. This is inspired by Basho's [webmachine][] project.
+ocaml-webmachine is a layer on top of [cohttp][] that implements a
+state-machine-based HTTP request processor. It's particularly well-suited for
+writing RESTful APIs. As the name suggests, this is an OCaml port of the
+[webmachine][] project.
+
+[cohttp]: https://github.com/mirage/ocaml-webmachine
+[webmachine]: https://github.com/webmachine/webmachine
 
 [![Build Status](https://magnum.travis-ci.com/inhabitedtype/ocaml-webmachine.svg?token=XSg14w1MrphqpyipUNfk&branch=master)](https://magnum.travis-ci.com/inhabitedtype/ocaml-webmachine)
 
-[7231]: http://tools.ietf.org/html/rfc7231
-[7232]: http://tools.ietf.org/html/rfc7232
-[7234]: http://tools.ietf.org/html/rfc7234
-[7235]: http://tools.ietf.org/html/rfc7235
+## Installation
 
-[webmachine]: https://github.com/basho/webmachine
+Install the library and its depenencies via [OPAM][opam]:
 
-## Installation
+```bash
+opam install webmachine
+```
+
+## Development
 
-Install the core library and its dependencies by pinning:
+To install development versions of the library, pin the package:
 
 ```bash
 opam pin add webmachine
 ```
 
-During development, you can install the latest changes by commiting them to the
-local git repository and running:
+You can install the latest changes by commiting them to the local git
+repository and running:
 
 ```bash
-opam upgrade
+opam upgrade webmachine
 ```
 
 For building and running the tests during development, you will need to install
@@ -47,8 +51,8 @@ at each node in the diagram by defining the appropriate method in a `resource`
 subclass. The correspondence is suggested by the name of the method for now.
 This will be better-documented in the future.
 
-[diagram]: https://raw.githubusercontent.com/basho/webmachine/develop/docs/http-headers-status-v3.png
+[diagram]: https://raw.githubusercontent.com/webmachine/webmachine/develop/docs/http-headers-status-v3.png
 
 ## License
 
-Proprietary and confidential.
+BSD3, see LICENSE file for its text.
diff --git a/lib/webmachine.ml b/lib/webmachine.ml
@@ -1,7 +1,34 @@
 (*----------------------------------------------------------------------------
-    Copyright (c) 2015 Inhabited Type LLC. All rights reserved.
-
-    Proprietary and confidential.
+    Copyright (c) 2015 Inhabited Type LLC.
+
+    All rights reserved.
+
+    Redistribution and use in source and binary forms, with or without
+    modification, are permitted provided that the following conditions
+    are met:
+
+    1. Redistributions of source code must retain the above copyright
+       notice, this list of conditions and the following disclaimer.
+
+    2. Redistributions in binary form must reproduce the above copyright
+       notice, this list of conditions and the following disclaimer in the
+       documentation and/or other materials provided with the distribution.
+
+    3. Neither the name of the author nor the names of his contributors
+       may be used to endorse or promote products derived from this software
+       without specific prior written permission.
+
+    THIS SOFTWARE IS PROVIDED BY THE CONTRIBUTORS ``AS IS'' AND ANY EXPRESS
+    OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+    WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+    DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE FOR
+    ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+    DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+    OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+    HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+    STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+    ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+    POSSIBILITY OF SUCH DAMAGE.
   ----------------------------------------------------------------------------*)
 
 open Cohttp
@@ -522,9 +549,10 @@ module Make(IO:IO) = struct
         | None            -> assert false
         | Some (type_, _) -> type_
       in
-      let value = match charset with
-      | None             -> type_
-      | Some (charset,_) -> Printf.sprintf "%s; charset=%s" type_ charset
+      let value =
+        match charset with
+        | None             -> type_
+        | Some (charset,_) -> Printf.sprintf "%s; charset=%s" type_ charset
       in
       self#set_response_header "Content-Type" value;
       match self#get_request_header "accept-encoding" with

diff --git a/lib/webmachine.mli b/lib/webmachine.mli
@@ -1,7 +1,34 @@
 (*----------------------------------------------------------------------------
-    Copyright (c) 2015 Inhabited Type LLC. All rights reserved.
-
-    Proprietary and confidential.
+    Copyright (c) 2015 Inhabited Type LLC.
+
+    All rights reserved.
+
+    Redistribution and use in source and binary forms, with or without
+    modification, are permitted provided that the following conditions
+    are met:
+
+    1. Redistributions of source code must retain the above copyright
+       notice, this list of conditions and the following disclaimer.
+
+    2. Redistributions in binary form must reproduce the above copyright
+       notice, this list of conditions and the following disclaimer in the
+       documentation and/or other materials provided with the distribution.
+
+    3. Neither the name of the author nor the names of his contributors
+       may be used to endorse or promote products derived from this software
+       without specific prior written permission.
+
+    THIS SOFTWARE IS PROVIDED BY THE CONTRIBUTORS ``AS IS'' AND ANY EXPRESS
+    OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+    WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+    DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE FOR
+    ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+    DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+    OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+    HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+    STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+    ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+    POSSIBILITY OF SUCH DAMAGE.
   ----------------------------------------------------------------------------*)
 
 open Cohttp

diff --git a/lib/wm_util.ml b/lib/wm_util.ml
@@ -1,3 +1,36 @@
+(*----------------------------------------------------------------------------
+    Copyright (c) 2015 Inhabited Type LLC.
+
+    All rights reserved.
+
+    Redistribution and use in source and binary forms, with or without
+    modification, are permitted provided that the following conditions
+    are met:
+
+    1. Redistributions of source code must retain the above copyright
+       notice, this list of conditions and the following disclaimer.
+
+    2. Redistributions in binary form must reproduce the above copyright
+       notice, this list of conditions and the following disclaimer in the
+       documentation and/or other materials provided with the distribution.
+
+    3. Neither the name of the author nor the names of his contributors
+       may be used to endorse or promote products derived from this software
+       without specific prior written permission.
+
+    THIS SOFTWARE IS PROVIDED BY THE CONTRIBUTORS ``AS IS'' AND ANY EXPRESS
+    OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+    WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+    DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE FOR
+    ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+    DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+    OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+    HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+    STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+    ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+    POSSIBILITY OF SUCH DAMAGE.
+  ----------------------------------------------------------------------------*)
+
 let re_split_ws =
   let open Re in
   let space = greedy (rep space) in

diff --git a/lib_test/test_dispatch.ml b/lib_test/test_dispatch.ml
@@ -1,7 +1,34 @@
 (*----------------------------------------------------------------------------
-    Copyright (c) 2015 Inhabited Type LLC. All rights reserved.
-
-    Proprietary and confidential.
+    Copyright (c) 2015 Inhabited Type LLC.
+
+    All rights reserved.
+
+    Redistribution and use in source and binary forms, with or without
+    modification, are permitted provided that the following conditions
+    are met:
+
+    1. Redistributions of source code must retain the above copyright
+       notice, this list of conditions and the following disclaimer.
+
+    2. Redistributions in binary form must reproduce the above copyright
+       notice, this list of conditions and the following disclaimer in the
+       documentation and/or other materials provided with the distribution.
+
+    3. Neither the name of the author nor the names of his contributors
+       may be used to endorse or promote products derived from this software
+       without specific prior written permission.
+
+    THIS SOFTWARE IS PROVIDED BY THE CONTRIBUTORS ``AS IS'' AND ANY EXPRESS
+    OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+    WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+    DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE FOR
+    ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+    DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+    OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+    HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+    STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+    ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+    POSSIBILITY OF SUCH DAMAGE.
   ----------------------------------------------------------------------------*)
 
 module Id = struct

diff --git a/lib_test/test_logic.ml b/lib_test/test_logic.ml
@@ -1,7 +1,34 @@
 (*----------------------------------------------------------------------------
-    Copyright (c) 2015 Inhabited Type LLC. All rights reserved.
-
-    Proprietary and confidential.
+    Copyright (c) 2015 Inhabited Type LLC.
+
+    All rights reserved.
+
+    Redistribution and use in source and binary forms, with or without
+    modification, are permitted provided that the following conditions
+    are met:
+
+    1. Redistributions of source code must retain the above copyright
+       notice, this list of conditions and the following disclaimer.
+
+    2. Redistributions in binary form must reproduce the above copyright
+       notice, this list of conditions and the following disclaimer in the
+       documentation and/or other materials provided with the distribution.
+
+    3. Neither the name of the author nor the names of his contributors
+       may be used to endorse or promote products derived from this software
+       without specific prior written permission.
+
+    THIS SOFTWARE IS PROVIDED BY THE CONTRIBUTORS ``AS IS'' AND ANY EXPRESS
+    OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+    WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+    DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE FOR
+    ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+    DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+    OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+    HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+    STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+    ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+    POSSIBILITY OF SUCH DAMAGE.
   ----------------------------------------------------------------------------*)
 
 module Id = struct

diff --git a/opam b/opam
@@ -1,27 +1,31 @@
 opam-version: "1.2"
 version: "dev"
 maintainer: "Spiros Eliopoulos <[email protected]>"
+homepage: "https://github.com/inhabitedtype/ocaml-webmachine"
+dev-repo: "https://github.com/inhabitedtype/ocaml-webmachine"
+bug-reports: "https://github.com/inhabitedtype/ocaml-webmachine/issues"
 authors: ["Inhabited Type LLC"]
 license: "PROP"
 
 build: [
   ["./configure" "--prefix=%{prefix}%"]
-  ["make"]
+  [make]
 ]
 install: [
-  ["make" "install"]
+  [make "install"]
 ]
 remove: [
   ["ocamlfind" "remove" "webmachine"]
 ]
 
 build-test: [
   ["./configure" "--enable-tests"]
-  ["make"]
-  ["make" "test"]
+  [make]
+  [make "test"]
 ]
 
 depends: [
+  "ounit" {test}
   "ocamlfind" {build}
   "cohttp"
   "re" {>="1.3.0"}