.gitattributes

@@ -0,0 +1 @@
+nix/opam-selection.nix linguist-generated=true

.github/workflows/changelog.yml

@@ -0,0 +1,23 @@
+name: Changelog
+
+on:
+  pull_request:
+    branches: [ master ]
+    types: [ opened, synchronize, reopened, labeled, unlabeled ]
+
+jobs:
+  build:
+    name: Check changelog entry
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v1
+
+      - name: Check CHANGES.md changed
+        if: ${{ !contains(github.event.pull_request.labels.*.name, 'no changelog') }}
+        env:
+          BASE_REF: ${{ github.event.pull_request.base.ref }}
+        run: |
+          ! git diff --exit-code origin/$BASE_REF -- CHANGES.md

.github/workflows/ci.yml

@@ -0,0 +1,41 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    name: Build and test
+
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      fail-fast: false
+      matrix:
+        os:
+          - macos-latest
+          - ubuntu-latest
+          - windows-latest
+        ocaml-compiler:
+          - 4.13.x
+        include:
+          - os: ubuntu-latest
+            ocaml-compiler: 4.08.x
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Use OCaml ${{ matrix.ocaml-version }}
+        uses: ocaml/setup-ocaml@v2
+        with:
+          ocaml-compiler: ${{ matrix.ocaml-compiler }}
+          dune-cache: ${{ matrix.os != 'macos-latest' }}
+          opam-depext-flags: --with-test
+
+      - run: opam install . --deps-only --with-test
+
+      - name: Run tests
+        run: make test
+
+      - name: Build examples
+        run: opam exec -- dune build @example

.gitignore

@@ -1,53 +1,18 @@
-*.cmt
-*.cmti
-*.o
-*.cmo
-*.cma
-*.cmxs
-*.opt
-*.run
-*.cmi
-*.cmx
-*.cmxa
-*.annot
-*.depends
-*.cmxi
-*.mllib
-*.mldylib
-*.mlpack
-*.odocl
-*.odocdir
-*.docl
-*.docdir
-*.cmt
-*.a
-
+# ocamlbuild working directory
 _build/
-examples/_build/
+
+# ocamlbuild targets
+*.byte
 *.native
-myocamlbuild.ml
-setup.data
-setup.log
-setup.ml
-META
-_tags
-TAGS
-*.omc
-*.omakedb
-.omakedb.lock
-_tests
 
-examples/auth_middleware
-examples/exit_hook_example
-examples/hello_world
-examples/hello_world_basic
-examples/hello_world_html
-examples/middleware_ua
-examples/read_json_body
-examples/sample
-examples/static_serve_override
-examples/uppercase_middleware
-lib_test/routes
-*.merlin
+# Merlin configuring file for Vim and Emacs
+.merlin
+
+# Dune generated files
 *.install
-_opam
+
+# Local OPAM switch
+_opam/
+
+# Nix-build geenrated artifact
+result

.ocamlformat

@@ -0,0 +1,3 @@
+profile = janestreet
+parse-docstrings = true
+wrap-comments = true

CHANGES.md

@@ -0,0 +1,86 @@
+# Unreleased
+
+## Added
+
+- Change type signature of static and static_unix middlewares to get ETag as promise.
+- Make static_unix middleware derive ETag from file modification timestamp.
+- `App.debug` and `App.verbose`
+- Give access to client's sockaddr from within an Opium handler
+
+## Fixed
+
+- Fix Fullsplat behavior (routes with `**`)
+- Undo splat reverse order. Now, the matches for `/*/*/*` with the url `/a/b/c` will return `["a"; "b"; "c"]`
+- deprecated `Term` commands
+
+## Changed
+
+- Update various opium-testing apis to avoid raising warning 16
+- replacing `mirage-crypto` with `digestif`, because `mirage-crypto` doesn't provide `md5` and `sha1` anymore
+
+# 0.20.0
+
+## Added
+
+- New `Auth` module to work with `Authorization` header (#238)
+- New `basic_auth` middleware to protect handlers with a `Basic` authentication method (#238)
+- New `Response.of_file` API for conveniently creating a response of a file (#244)
+- Add a package `opium-graphql` to easily create GraphQL server with Opium (#235)
+- Add a function `App.run_multicore` that uses pre-forking and spawns multiple processes that will handle incoming requests (#239)
+
+## Fixed
+
+- Fix reading cookie values when multiple cookies are present in `Cookie` header (#246)
+
+# 0.19.0
+
+This release is a complete rewrite of the Opium's internal that switches from Cohttp to Httpaf.
+As demonstrated in several benchmarks, Httpaf's latency is much lower than Cohttp's in stress tests, so it is expected that Opium will perform better in these high pressure situations with this change.
+
+The underlying HTTP server implementation is now contained in the `rock` package, that provides a Service and Filter implementation, inspired by Finagle's. The architecture is similar to Ruby's Rack library (hence the name), so one can compose complex web applications by combining Rock applications.
+
+The `rock` package offers a very slim API, with very few dependencies, so it should be an attractive option for other Web framework to build on, which would allow the re-usability of middlewares and handlers, independently of the framework used (e.g. one could use Sihl middlewares with Opium, and vice versa).
+
+Apart from the architectural changes, this release comes with a lot of additionnal utilities and middlewares which should make Opium a better candidate for complex web applications, without having to re-write a lot of common Web server functionnalities.
+
+The Request and Response modules now provide:
+
+- JSON encoders/decoders with `Yojson`
+- HTML encoders/decoders with `Tyxml`
+- XML encoders/decoders with `Tyxml`
+- SVG encoders/decoders with `Tyxml`
+- multipart/form encoders/decoders with `multipart_form_data`
+- urlencoded encoders/decoders with `Uri`
+
+And the following middlewares are now built-in:
+
+- `debugger` to display an HTML page with the errors in case of failures
+- `logger` to log requests and responses, with a timer
+- `allow_cors` to add CORS headers
+- `static` to serve static content given a custom read function (e.g. read from S3)
+- `static_unix` to to serve static content from the local filesystem
+- `content_length` to add the `Content-Length` header to responses
+- `method_override` to replace the HTTP method with the one found in the `_method` field of `application/x-www-form-urlencoded` encoded `POST` requests.
+- `etag` to add `ETag` header to the responses and send an HTTP code `304` when the computed ETag matches the one specified in the request.
+- `method_required` to filter the requests by method and respond with an HTTP code `405` if the method is not allowed.
+- `head` to add supports for `HEAD` request for handlers that receive `GET` requests.
+
+Lastly, this release also adds a package `opium-testing` that can be used to test Opium applications with `Alcotest`. It provides `Testable` modules for every Opium types, and implements helper functions to easily get an `Opium.Response` from an `Opium.Request`.
+
+# 0.18.0
+
+* Make examples easier to find and add documentation related to features used in them. (#125, @shonfeder)
+* Allow overriding 404 handlers (#127, @anuragsoni)
+* Support cohttp streaming response (#135, #137, #139, @anuragsoni)
+
+# v0.17.1
+
+* Change Deferred.t to Lwt.t in readme (#91, @rymdhund)
+* Remove `cow` from deps (#92, @anuragsoni)
+
+# v0.17.0
+
+* Switch to dune (#88, @anuragsoni)
+* Keep the "/" cookie default and expose all cookie directives (#82, @actionshrimp)
+* Do not assume base 64 encoding of cookies (#74, @malthe)
+* Add caching capabilities to middleware (#76, @mattjbray)

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Rudi Grinberg
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.