v2.0.6

docs: fix simple typo, mashmallow -> marshmallow

.github/workflows/lint.yaml

@@ -0,0 +1,23 @@
+name: Lint
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.7
+
+      - name: Install dependencies
+        run: |
+          python -m pip install pipenv
+          pipenv install --dev --system
+
+      - name: Lint
+        run: pre-commit run --all-files --show-diff-on-failure

.github/workflows/test.yaml

@@ -0,0 +1,30 @@
+name: Test
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: [3.6, 3.7, 3.8]
+        os: [ubuntu-latest, macos-latest]
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install pipenv
+          pipenv install --dev --system
+
+      - name: Tests
+        run: |
+          python --version
+          pytest

.gitignore

@@ -1,6 +1,7 @@
 .vscode/
 .cache
 .idea
+.python-version
 .coverage
 .pytest_cache
 .DS_Store

.pre-commit-config.yaml

@@ -0,0 +1,13 @@
+repos:
+  - repo: https://github.com/psf/black
+    rev: 20.8b1
+    hooks:
+      - id: black
+        types: [python]
+
+  - repo: https://github.com/pre-commit/mirrors-prettier
+    rev: v2.2.1
+    hooks:
+      - id: prettier
+        args: [--prose-wrap=always, --print-width=88]
+        exclude: ^docs/source/_static/

.travis.yml

@@ -1,12 +0,0 @@
-language: python
-python:
-  - "3.6"
-
-# command to install dependencies
-install:
-  - "pip install pipenv --upgrade-strategy=only-if-needed"
-  - "pipenv install --dev"
-
-# command to run the dependencies
-script:
-  - "pytest"

CHANGELOG.md

@@ -1,20 +1,381 @@
-# v0.0.6:
- - Ability to mount WSGI apps.
- - Supply content-type when serving up the schema.
+# Changelog
 
-# v0.0.5:
- - OpenAPI Schema support.
- - Safe load/dump yaml.
+All notable changes to this project will be documented in this file.
 
-# v0.0.4:
- - Asyncronous support for data uploads.
- - Bug fixes.
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and
+this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [v2.0.5] - 2019-12-15
+
+### Added
+
+- Update requirements to support python 3.8
+
+## [v2.0.4] - 2019-11-19
+
+### Fixed
+
+- Fix static app resolving
+
+## [v2.0.3] - 2019-09-20
+
+### Fixed
+
+- Fix template conflicts
+
+## [v2.0.2] - 2019-09-20
+
+### Fixed
+
+- Fix template conflicts
+
+## [v2.0.1] - 2019-09-20
+
+### Fixed
+
+- Fix template import
+
+## [v2.0.0] - 2019-09-19
+
+### Changed
+
+- Refactor Router and Schema
+
+## [v1.3.2] - 2019-08-15
+
+### Added
+
+- ASGI 3 support
+- CI tests for python 3.8-dev
+- Now requests have `state` a mapping object
+
+### Deprecated
+
+- ASGI 2
+
+## [v1.3.1] - 2019-04-28
+
+### Added
+
+- Route params Converters
+- Add search for documentation pages
+
+### Changed
+
+- Bump dependencies
+
+## [v1.3.0] - 2019-02-22
+
+### Fixed
+
+- Versioning issue
+- Multiple cookies.
+- Whitenoise returns not found.
+- Other bugfixes.
+
+### Added
+
+- Stream support via `resp.stream`.
+- Cookie directives via `resp.set_cookie`.
+- Add `resp.html` to send HTML.
+- Other improvements.
+
+## [v1.1.3] - 2019-01-12
+
+### Changed
+
+- Refactor `_route_for`
+
+### Fixed
+
+- Resolve startup/shutdwown events
+
+## [v1.2.0] - 2018-12-29
+
+### Added
+
+- Documentations
+
+### Changed
+
+- Use Starlette's LifeSpan middleware
+- Update denpendencies
+
+### Fixed
+
+- Fix route.is_class_based
+- Fix test_500
+- Typos
+
+## [v1.1.2] - 2018-11-11
+
+### Fixed
+
+- Minor fixes for Open API
+- Typos
+
+## [v1.1.1] - 2018-10-29
+
+### Changed
+
+- Run sync views in a threadpoolexecutor.
+
+## [v1.1.0] - 2018-10-27
+
+### Added
+
+- Support for `before_request`.
+
+## [v1.0.5]- 2018-10-27
+
+### Fixed
+
+- Fix sessions.
+
+## [v1.0.4] - 2018-10-27
+
+### Fixed
+
+- Potential bufix for cookies.
+
+## [v1.0.3] - 2018-10-27
+
+### Fixed
+
+- Bugfix for redirects.
+
+## [v1.0.2] - 2018-10-27
+
+### Changed
+
+- Improvement for static file hosting.
+
+## [v1.0.1] - 2018-10-26
+
+### Changed
+
+- Improve cors configuration settings.
+
+## [v1.0.0] - 2018-10-26
+
+### Changed
+
+- Move GraphQL support into a built-in plugin.
+
+## [v0.3.3] - 2018-10-25
+
+### Added
+
+- CORS support
+
+### Changed
+
+- Improved exceptions.
+
+## [v0.3.2] - 2018-10-25
+
+### Changed
+
+- Subtle improvements.
+
+## [v0.3.1] - 2018-10-24
+
+### Fixed
+
+- Packaging fix.
+
+## [v0.3.0] - 2018-10-24
+
+### Changed
+
+- Interactive Documentation endpoint.
+- Minor improvements.
+
+## [v0.2.3] - 2018-10-24
+
+### Changed
+
+- Overall improvements.
+
+## [v0.2.2] - 2018-10-23
+
+### Added
+
+- Show traceback info when background tasks raise exceptions.
+
+## [v0.2.1] - 2018-10-23
+
+### Added
+
+- api.requests.
+
+## [v0.2.0] - 2018-10-22
+
+### Added
+
+- WebSocket support.
+
+## [v0.1.6] - 2018-10-20
+
+### Added
+
+- 500 support.
+
+## [v0.1.5] - 2018-10-20
+
+### Added
+
+- File upload support
+
+### Changed
+
+- Improvements to sequential media reading.
+
+## [v0.1.4] - 2018-10-19
+
+### Fixed
+
+- Stability.
+
+## [v0.1.3] - 2018-10-18
+
+### Added
+
+- Sessions support.
+
+## [v0.1.2] - 2018-10-18
+
+### Added
+
+- Cookies support.
+
+## [v0.1.1] - 2018-10-17
+
+### Changed
+
+- Default routes.
+
+## [v0.1.0] - 2018-10-17
+
+### Added
+
+- Prototype of static application support.
+
+## [v0.0.10] - 2018-10-17
+
+### Fixed
+
+- Bugfix for async class-based views.
+
+## [v0.0.9] - 2018-10-17
+
+### Fixed
+
+- Bugfix for async class-based views.
+
+## [v0.0.8] - 2018-10-17
+
+### Added
+
+- GraphiQL Support.
+
+### Changed
+
+- Improvement to route selection.
+
+## [v0.0.7] - 2018-10-16
+
+### Changed
+
+- Immutable Request object.
+
+## [v0.0.6] - 2018-10-16
+
+### Added
+
+- Ability to mount WSGI apps.
+- Supply content-type when serving up the schema.
+
+## [v0.0.5] - 2018-10-15
+
+### Added
+
+- OpenAPI Schema support.
+- Safe load/dump yaml.
+
+## [v0.0.4] - 2018-10-15
+
+### Added
+
+- Asynchronous support for data uploads.
+
+### Fixed
 
-# v0.0.3:
 - Bug fixes.
 
-# v0.0.2
+## [v0.0.3] - 2018-10-13
+
+### Fixed
+
+- Bug fixes.
+
+## [v0.0.2] - 2018-10-13
+
+### Changed
+
 - Switch to ASGI/Starlette.
 
-# v0.0.1
+## [v0.0.1] - 2018-10-12
+
+### Added
+
 - Conception!
+
+[unreleased]: https://github.com/taoufik07/responder/compare/v2.0.5..HEAD
+[v2.0.5]: https://github.com/taoufik07/responder/compare/v2.0.4..v2.0.5
+[v2.0.4]: https://github.com/taoufik07/responder/compare/v2.0.3..v2.0.4
+[v2.0.3]: https://github.com/taoufik07/responder/compare/v2.0.2..v2.0.3
+[v2.0.2]: https://github.com/taoufik07/responder/compare/v2.0.1..v2.0.2
+[v2.0.1]: https://github.com/taoufik07/responder/compare/v2.0.0..v2.0.1
+[v2.0.0]: https://github.com/taoufik07/responder/compare/v1.3.2..v2.0.0
+[v1.3.2]: https://github.com/taoufik07/responder/compare/v1.3.1..v1.3.2
+[v1.3.1]: https://github.com/taoufik07/responder/compare/v1.3.0..v1.3.1
+[v1.3.0]: https://github.com/taoufik07/responder/compare/v1.2.0..v1.3.0
+[v1.2.0]: https://github.com/taoufik07/responder/compare/v1.1.3..v1.2.0
+[v1.1.3]: https://github.com/taoufik07/responder/compare/v1.1.2..v1.1.3
+[v1.1.2]: https://github.com/taoufik07/responder/compare/v1.1.1..v1.1.2
+[v1.1.1]: https://github.com/taoufik07/responder/compare/v1.1.0..v1.1.1
+[v1.1.0]: https://github.com/taoufik07/responder/compare/v1.0.5..v1.1.0
+[v1.0.5]: https://github.com/taoufik07/responder/compare/v1.0.4..v1.0.5
+[v1.0.4]: https://github.com/taoufik07/responder/compare/v1.0.3..v1.0.4
+[v1.0.3]: https://github.com/taoufik07/responder/compare/v1.0.2..v1.0.3
+[v1.0.2]: https://github.com/taoufik07/responder/compare/v1.0.1..v1.0.2
+[v1.0.1]: https://github.com/taoufik07/responder/compare/v1.0.0..v1.0.1
+[v1.0.0]: https://github.com/taoufik07/responder/compare/v0.3.3..v1.0.0
+[v0.3.3]: https://github.com/taoufik07/responder/compare/v0.3.2..v0.3.3
+[v0.3.2]: https://github.com/taoufik07/responder/compare/v0.3.1..v0.3.2
+[v0.3.1]: https://github.com/taoufik07/responder/compare/v0.3.0..v0.3.1
+[v0.3.0]: https://github.com/taoufik07/responder/compare/v0.2.3..v0.3.0
+[v0.2.3]: https://github.com/taoufik07/responder/compare/v0.2.2..v0.2.3
+[v0.2.2]: https://github.com/taoufik07/responder/compare/v0.2.1..v0.2.2
+[v0.2.1]: https://github.com/taoufik07/responder/compare/v0.2.0..v0.2.1
+[v0.2.0]: https://github.com/taoufik07/responder/compare/v0.1.6..v0.2.0
+[v0.1.6]: https://github.com/taoufik07/responder/compare/v0.1.5..v0.1.6
+[v0.1.5]: https://github.com/taoufik07/responder/compare/v0.1.4..v0.1.5
+[v0.1.4]: https://github.com/taoufik07/responder/compare/v0.1.3..v0.1.4
+[v0.1.3]: https://github.com/taoufik07/responder/compare/v0.1.2..v0.1.3
+[v0.1.2]: https://github.com/taoufik07/responder/compare/v0.1.1..v0.1.2
+[v0.1.1]: https://github.com/taoufik07/responder/compare/v0.1.0..v0.1.1
+[v0.1.0]: https://github.com/taoufik07/responder/compare/v0.0.10..v0.1.0
+[v0.0.10]: https://github.com/taoufik07/responder/compare/v0.0.9..v0.0.10
+[v0.0.9]: https://github.com/taoufik07/responder/compare/v0.0.8..v0.0.9
+[v0.0.8]: https://github.com/taoufik07/responder/compare/v0.0.7..v0.0.8
+[v0.0.7]: https://github.com/taoufik07/responder/compare/v0.0.6..v0.0.7
+[v0.0.6]: https://github.com/taoufik07/responder/compare/v0.0.5..v0.0.6
+[v0.0.5]: https://github.com/taoufik07/responder/compare/v0.0.4..v0.0.5
+[v0.0.4]: https://github.com/taoufik07/responder/compare/v0.0.3..v0.0.4
+[v0.0.3]: https://github.com/taoufik07/responder/compare/v0.0.2..v0.0.3
+[v0.0.2]: https://github.com/taoufik07/responder/compare/v0.0.1..v0.0.2
+[v0.0.1]: https://github.com/taoufik07/responder/compare/v0.0.0..v0.0.1

MANIFEST.in

@@ -0,0 +1 @@
+include LICENSE

Pipfile

@@ -5,18 +5,17 @@ name = "pypi"
 
 [packages]
 responder = {editable = true, path = "."}
+pre-commit = "*"
 
 [dev-packages]
 pytest = "*"
 "flake8" = "*"
-black = "*"
+black = "==20.8b1"
 twine = "*"
 flask = "*"
 sphinx = "*"
 marshmallow = "*"
-
-[requires]
-python_version = "3.7"
+pytest-cov = "*"
 
 [pipenv]
 allow_prereleases = true

README.md

@@ -1,170 +1,85 @@
 # Responder: a familiar HTTP Service Framework for Python
 
-[![Build Status](https://travis-ci.org/kennethreitz/responder.svg?branch=master)](https://travis-ci.org/kennethreitz/responder)
+[![Build Status](https://travis-ci.org/taoufik07/responder.svg?branch=master)](https://travis-ci.org/taoufik07/responder)
 [![Documentation Status](https://readthedocs.org/projects/mybinder/badge/?version=latest)](https://responder.readthedocs.io/en/latest/)
 [![image](https://img.shields.io/pypi/v/responder.svg)](https://pypi.org/project/responder/)
 [![image](https://img.shields.io/pypi/l/responder.svg)](https://pypi.org/project/responder/)
 [![image](https://img.shields.io/pypi/pyversions/responder.svg)](https://pypi.org/project/responder/)
-[![image](https://img.shields.io/github/contributors/kennethreitz/responder.svg)](https://github.com/kennethreitz/responder/graphs/contributors)
+[![image](https://img.shields.io/github/contributors/taoufik07/responder.svg)](https://github.com/taoufik07/responder/graphs/contributors)
 
-[![](https://github.com/kennethreitz/responder/raw/master/ext/small.jpg)](http://python-responder.org/)
+[![](https://farm2.staticflickr.com/1959/43750081370_a4e20752de_o_d.png)](https://responder.readthedocs.io)
 
-The Python world certainly doesn't need more web frameworks. But, it does need more creativity, so I thought I'd spread some [Hacktoberfest](https://hacktoberfest.digitalocean.com/) spirit around, bring some of my ideas to the table, and see what I could come up with.
-
-```python
-import responder
-
-api = responder.API()
-
-@api.route("/{greeting}")
-async def greet_world(req, resp, *, greeting):
-    resp.text = f"{greeting}, world!"
-
-if __name__ == '__main__':
-    api.run()
-```
-
-That `async` declaration is optional. [View documentation](http://python-responder.org).
-
-This gets you a ASGI app, with a production static files server pre-installed, jinja2 templating (without additional imports), and a production webserver based on uvloop, serving up requests with gzip compression automatically.
+Powered by [Starlette](https://www.starlette.io/). That `async` declaration is optional.
+[View documentation](https://responder.readthedocs.io).
 
+This gets you a ASGI app, with a production static files server pre-installed, jinja2
+templating (without additional imports), and a production webserver based on uvloop,
+serving up requests with gzip compression automatically.
 
 ## Testimonials
 
-> "Pleasantly very taken with python-responder. [@kennethreitz](https://twitter.com/kennethreitz) at his absolute best." —Rudraksh M.K.
+> "Pleasantly very taken with python-responder.
+> [@kennethreitz](https://twitter.com/kennethreitz) at his absolute best." —Rudraksh
+> M.K.
 
-> "ASGI is going to enable all sorts of new high-performance web services. It's awesome to see Responder starting to take advantage of that." — Tom Christie author of [Django REST Framework](https://www.django-rest-framework.org/)
+> "ASGI is going to enable all sorts of new high-performance web services. It's awesome
+> to see Responder starting to take advantage of that." — Tom Christie author of
+> [Django REST Framework](https://www.django-rest-framework.org/)
 
-> "I love that you are exploring new patterns. Go go go!" — Danny Greenfield, author of [Two Scoops of Django]()
-
-> "Love what I have seen while it's in progress! Many features of Responder are from my wishlist for Flask, and it's even faster and even easier than Flask!" — Luna C.
+> "I love that you are exploring new patterns. Go go go!" — Danny Greenfield, author of
+> [Two Scoops of Django]()
 
 ## More Examples
 
-Class-based views (and setting some headers and stuff):
-
-```python
-@api.route("/{greeting}")
-class GreetingResource:
-    def on_request(req, resp, *, greeting):   # or on_get...
-        resp.text = f"{greeting}, world!"
-        resp.headers.update({'X-Life': '42'})
-        resp.status_code = api.status_codes.HTTP_416
-```
-
-Render a template, with arguments:
-
-```python
-@api.route("/{greeting}")
-def greet_world(req, resp, *, greeting):
-    resp.content = api.template("index.html", greeting=greeting)
-```
-
-The `api` instance is available as an object during template rendering.
-
-Here, you can spawn off a background thread to run any function, out-of-request:
-
-```python
-@api.route("/")
-def hello(req, resp):
-
-    @api.background.task
-    def sleep(s=10):
-        time.sleep(s)
-        print("slept!")
-
-    sleep()
-    resp.content = "processing"
-```
-
-And even serve a GraphQL API:
-
-```python
-import graphene
-
-class Query(graphene.ObjectType):
-    hello = graphene.String(name=graphene.String(default_value="stranger"))
-
-    def resolve_hello(self, info, name):
-        return "Hello " + name
-
-api.add_route("/graph", graphene.Schema(query=Query))
-```
-
-We can then send a query to our service:
-
-```pycon
->>> requests = api.session()
->>> r = requests.get("http://;/graph", params={"query": "{ hello }"})
->>> r.json()
-{'data': {'hello': 'Hello stranger'}}
-```
-
-Or, request YAML back:
-
-```pycon
->>> r = requests.get("http://;/graph", params={"query": "{ hello(name:\"john\") }"}, headers={"Accept": "application/x-yaml"})
->>> print(r.text)
-data: {hello: Hello john}
-
-```
-
-Want HSTS?
-
-```
-api = responder.API(enable_hsts=True)
-```
-
-Boom.
-
+See
+[the documentation's feature tour](https://responder.readthedocs.io/en/latest/tour.html)
+for more details on features available in Responder.
 
 # Installing Responder
 
-Install the latest release:
-
+Install the stable release:
 
     $ pipenv install responder
     ✨🍰✨
 
-
 Or, install from the development branch:
 
-    $ pipenv install -e git+https://github.com/kennethreitz/responder.git#egg=responder
+    $ pipenv install -e git+https://github.com/taoufik07/responder.git#egg=responder
 
 Only **Python 3.6+** is supported.
 
-
 # The Basic Idea
 
-The primary concept here is to bring the niceties that are brought forth from both Flask and Falcon and unify them into a single framework, along with some new ideas I have. I also wanted to take some of the API primitives that are instilled in the Requests library and put them into a web framework. So, you'll find a lot of parallels here with Requests.
+The primary concept here is to bring the niceties that are brought forth from both Flask
+and Falcon and unify them into a single framework, along with some new ideas I have. I
+also wanted to take some of the API primitives that are instilled in the Requests
+library and put them into a web framework. So, you'll find a lot of parallels here with
+Requests.
 
-- Setting `resp.text` sends back unicode, while setting `resp.content` sends back bytes.
-- Setting `resp.media` sends back JSON/YAML (`.text`/`.content` override this).
+- Setting `resp.content` sends back bytes.
+- Setting `resp.text` sends back unicode, while setting `resp.html` sends back HTML.
+- Setting `resp.media` sends back JSON/YAML (`.text`/`.html`/`.content` override this).
 - Case-insensitive `req.headers` dict (from Requests directly).
 - `resp.status_code`, `req.method`, `req.url`, and other familiar friends.
 
 ## Ideas
 
-- Flask-style route expression, with new capabilities -- all while using Python 3.6+'s new f-string syntax.
-- I love Falcon's "every request and response is passed into to each view and mutated" methodology, especially `response.media`, and have used it here. In addition to supporting JSON, I have decided to support YAML as well, as Kubernetes is slowly taking over the world, and it uses YAML for all the things. Content-negotiation and all that.
+- Flask-style route expression, with new capabilities -- all while using Python 3.6+'s
+  new f-string syntax.
+- I love Falcon's "every request and response is passed into to each view and mutated"
+  methodology, especially `response.media`, and have used it here. In addition to
+  supporting JSON, I have decided to support YAML as well, as Kubernetes is slowly
+  taking over the world, and it uses YAML for all the things. Content-negotiation and
+  all that.
 - **A built in testing client that uses the actual Requests you know and love**.
 - The ability to mount other WSGI apps easily.
 - Automatic gzipped-responses.
-- In addition to Falcon's `on_get`, `on_post`, etc methods, Responder features an `on_request` method, which gets called on every type of request, much like Requests.
+- In addition to Falcon's `on_get`, `on_post`, etc methods, Responder features an
+  `on_request` method, which gets called on every type of request, much like Requests.
 - A production static file server is built-in.
-- Uvicorn built-in as a production web server. I would have chosen Gunicorn, but it doesn't run on Windows. Plus, Uvicorn serves well to protect against slowloris attacks, making nginx unnecessary in production.
-- GraphQL support, via Graphene. The goal here is to have any GraphQL query exposable at any route, magically.
-
-## Future Ideas
-
-- Cookie-based sessions are currently an afterthought, as this is an API framework, but websites are APIs too.
-- If frontend websites are supported, provide an official way to run webpack.
-
-# The Goal
-
-The primary goal here is to learn, not to get adoption. Though, who knows how these things will pan out.
-
-
-----------
-
-[![hacktoberfest](https://hacktoberfest.digitalocean.com/assets/hacktoberfest-2018-social-card-c8d2e1489f647f2e0a26e6f598adeb760872818905b34cd437afc7ac2857ceab.png)](https://hacktoberfest.digitalocean.com/)
+- Uvicorn built-in as a production web server. I would have chosen Gunicorn, but it
+  doesn't run on Windows. Plus, Uvicorn serves well to protect against slowloris
+  attacks, making nginx unnecessary in production.
+- GraphQL support, via Graphene. The goal here is to have any GraphQL query exposable at
+  any route, magically.
+- Provide an official way to run webpack.

docs/requirements.txt

@@ -4,7 +4,7 @@ atomicwrites==1.2.1
 attrs==18.2.0
 babel==2.6.0
 black==18.9b0
-bleach==3.0.2
+bleach==3.1.4
 certifi==2018.8.24
 cffi==1.11.5
 chardet==3.0.4
@@ -45,4 +45,4 @@ tqdm==4.26.0
 twine==1.12.1
 urllib3==1.23
 webencodings==0.5.1
-werkzeug==0.14.1
+werkzeug==0.15.5

docs/source/_static/custom.css

@@ -1,7 +1,7 @@
 /* Hide module name and default value for environment variable section */
-div[id$='environment-variables'] code.descclassname {
-    display: none;
+div[id$="environment-variables"] code.descclassname {
+  display: none;
 }
-div[id$='environment-variables'] em.property {
-    display: none;
+div[id$="environment-variables"] em.property {
+  display: none;
 }

docs/source/_static/konami.js

@@ -10,142 +10,152 @@
  */
 
 var Konami = function (callback) {
-    var konami = {
-        addEvent: function (obj, type, fn, ref_obj) {
-            if (obj.addEventListener)
-                obj.addEventListener(type, fn, false);
-            else if (obj.attachEvent) {
-                // IE
-                obj["e" + type + fn] = fn;
-                obj[type + fn] = function () {
-                    obj["e" + type + fn](window.event, ref_obj);
-                }
-                obj.attachEvent("on" + type, obj[type + fn]);
-            }
-        },
-        removeEvent: function (obj, eventName, eventCallback) {
-            if (obj.removeEventListener) {
-                obj.removeEventListener(eventName, eventCallback);
-            } else if (obj.attachEvent) {
-                obj.detachEvent(eventName);
-            }
-        },
-        input: "",
-        pattern: "38384040373937396665",
-        keydownHandler: function (e, ref_obj) {
-            if (ref_obj) {
-                konami = ref_obj;
-            } // IE
-            konami.input += e ? e.keyCode : event.keyCode;
-            if (konami.input.length > konami.pattern.length) {
-                konami.input = konami.input.substr((konami.input.length - konami.pattern.length));
-            }
-            if (konami.input === konami.pattern) {
-                konami.code(konami._currentLink);
-                konami.input = '';
-                e.preventDefault();
-                return false;
-            }
-        },
-        load: function (link) {
-            this._currentLink = link;
-            this.addEvent(document, "keydown", this.keydownHandler, this);
-            this.iphone.load(link);
-        },
-        unload: function () {
-            this.removeEvent(document, 'keydown', this.keydownHandler);
-            this.iphone.unload();
-        },
-        code: function (link) {
-            window.location = link
-        },
-        iphone: {
-            start_x: 0,
-            start_y: 0,
-            stop_x: 0,
-            stop_y: 0,
-            tap: false,
-            capture: false,
-            orig_keys: "",
-            keys: ["UP", "UP", "DOWN", "DOWN", "LEFT", "RIGHT", "LEFT", "RIGHT", "TAP", "TAP"],
-            input: [],
-            code: function (link) {
-                konami.code(link);
-            },
-            touchmoveHandler: function (e) {
-                if (e.touches.length === 1 && konami.iphone.capture === true) {
-                    var touch = e.touches[0];
-                    konami.iphone.stop_x = touch.pageX;
-                    konami.iphone.stop_y = touch.pageY;
-                    konami.iphone.tap = false;
-                    konami.iphone.capture = false;
-                    konami.iphone.check_direction();
-                }
-            },
-            touchendHandler: function () {
-                konami.iphone.input.push(konami.iphone.check_direction());
-                
-                if (konami.iphone.input.length > konami.iphone.keys.length) konami.iphone.input.shift();
-                
-                if (konami.iphone.input.length === konami.iphone.keys.length) {
-                    var match = true;
-                    for (var i = 0; i < konami.iphone.keys.length; i++) {
-                        if (konami.iphone.input[i] !== konami.iphone.keys[i]) {
-                            match = false;
-                        }
-                    }
-                    if (match) {
-                        konami.iphone.code(konami._currentLink);
-                    }
-                }
-            },
-            touchstartHandler: function (e) {
-                konami.iphone.start_x = e.changedTouches[0].pageX;
-                konami.iphone.start_y = e.changedTouches[0].pageY;
-                konami.iphone.tap = true;
-                konami.iphone.capture = true;
-            },
-            load: function (link) {
-                this.orig_keys = this.keys;
-                konami.addEvent(document, "touchmove", this.touchmoveHandler);
-                konami.addEvent(document, "touchend", this.touchendHandler, false);
-                konami.addEvent(document, "touchstart", this.touchstartHandler);
-            },
-            unload: function () {
-                konami.removeEvent(document, 'touchmove', this.touchmoveHandler);
-                konami.removeEvent(document, 'touchend', this.touchendHandler);
-                konami.removeEvent(document, 'touchstart', this.touchstartHandler);
-            },
-            check_direction: function () {
-                x_magnitude = Math.abs(this.start_x - this.stop_x);
-                y_magnitude = Math.abs(this.start_y - this.stop_y);
-                x = ((this.start_x - this.stop_x) < 0) ? "RIGHT" : "LEFT";
-                y = ((this.start_y - this.stop_y) < 0) ? "DOWN" : "UP";
-                result = (x_magnitude > y_magnitude) ? x : y;
-                result = (this.tap === true) ? "TAP" : result;
-                return result;
-            }
+  var konami = {
+    addEvent: function (obj, type, fn, ref_obj) {
+      if (obj.addEventListener) obj.addEventListener(type, fn, false);
+      else if (obj.attachEvent) {
+        // IE
+        obj["e" + type + fn] = fn;
+        obj[type + fn] = function () {
+          obj["e" + type + fn](window.event, ref_obj);
+        };
+        obj.attachEvent("on" + type, obj[type + fn]);
+      }
+    },
+    removeEvent: function (obj, eventName, eventCallback) {
+      if (obj.removeEventListener) {
+        obj.removeEventListener(eventName, eventCallback);
+      } else if (obj.attachEvent) {
+        obj.detachEvent(eventName);
+      }
+    },
+    input: "",
+    pattern: "38384040373937396665",
+    keydownHandler: function (e, ref_obj) {
+      if (ref_obj) {
+        konami = ref_obj;
+      } // IE
+      konami.input += e ? e.keyCode : event.keyCode;
+      if (konami.input.length > konami.pattern.length) {
+        konami.input = konami.input.substr(konami.input.length - konami.pattern.length);
+      }
+      if (konami.input === konami.pattern) {
+        konami.code(konami._currentLink);
+        konami.input = "";
+        e.preventDefault();
+        return false;
+      }
+    },
+    load: function (link) {
+      this._currentLink = link;
+      this.addEvent(document, "keydown", this.keydownHandler, this);
+      this.iphone.load(link);
+    },
+    unload: function () {
+      this.removeEvent(document, "keydown", this.keydownHandler);
+      this.iphone.unload();
+    },
+    code: function (link) {
+      window.location = link;
+    },
+    iphone: {
+      start_x: 0,
+      start_y: 0,
+      stop_x: 0,
+      stop_y: 0,
+      tap: false,
+      capture: false,
+      orig_keys: "",
+      keys: [
+        "UP",
+        "UP",
+        "DOWN",
+        "DOWN",
+        "LEFT",
+        "RIGHT",
+        "LEFT",
+        "RIGHT",
+        "TAP",
+        "TAP",
+      ],
+      input: [],
+      code: function (link) {
+        konami.code(link);
+      },
+      touchmoveHandler: function (e) {
+        if (e.touches.length === 1 && konami.iphone.capture === true) {
+          var touch = e.touches[0];
+          konami.iphone.stop_x = touch.pageX;
+          konami.iphone.stop_y = touch.pageY;
+          konami.iphone.tap = false;
+          konami.iphone.capture = false;
+          konami.iphone.check_direction();
         }
-    }
+      },
+      touchendHandler: function () {
+        konami.iphone.input.push(konami.iphone.check_direction());
 
-    typeof callback === "string" && konami.load(callback);
-    if (typeof callback === "function") {
-        konami.code = callback;
-        konami.load();
-    }
+        if (konami.iphone.input.length > konami.iphone.keys.length)
+          konami.iphone.input.shift();
 
-    return konami;
+        if (konami.iphone.input.length === konami.iphone.keys.length) {
+          var match = true;
+          for (var i = 0; i < konami.iphone.keys.length; i++) {
+            if (konami.iphone.input[i] !== konami.iphone.keys[i]) {
+              match = false;
+            }
+          }
+          if (match) {
+            konami.iphone.code(konami._currentLink);
+          }
+        }
+      },
+      touchstartHandler: function (e) {
+        konami.iphone.start_x = e.changedTouches[0].pageX;
+        konami.iphone.start_y = e.changedTouches[0].pageY;
+        konami.iphone.tap = true;
+        konami.iphone.capture = true;
+      },
+      load: function (link) {
+        this.orig_keys = this.keys;
+        konami.addEvent(document, "touchmove", this.touchmoveHandler);
+        konami.addEvent(document, "touchend", this.touchendHandler, false);
+        konami.addEvent(document, "touchstart", this.touchstartHandler);
+      },
+      unload: function () {
+        konami.removeEvent(document, "touchmove", this.touchmoveHandler);
+        konami.removeEvent(document, "touchend", this.touchendHandler);
+        konami.removeEvent(document, "touchstart", this.touchstartHandler);
+      },
+      check_direction: function () {
+        x_magnitude = Math.abs(this.start_x - this.stop_x);
+        y_magnitude = Math.abs(this.start_y - this.stop_y);
+        x = this.start_x - this.stop_x < 0 ? "RIGHT" : "LEFT";
+        y = this.start_y - this.stop_y < 0 ? "DOWN" : "UP";
+        result = x_magnitude > y_magnitude ? x : y;
+        result = this.tap === true ? "TAP" : result;
+        return result;
+      },
+    },
+  };
+
+  typeof callback === "string" && konami.load(callback);
+  if (typeof callback === "function") {
+    konami.code = callback;
+    konami.load();
+  }
+
+  return konami;
 };
 
-
-if (typeof module !== 'undefined' && typeof module.exports !== 'undefined') {
-        module.exports = Konami;
+if (typeof module !== "undefined" && typeof module.exports !== "undefined") {
+  module.exports = Konami;
 } else {
-        if (typeof define === 'function' && define.amd) {
-                define([], function() {
-                        return Konami;
-                });
-        } else {
-                window.Konami = Konami;
-        }
+  if (typeof define === "function" && define.amd) {
+    define([], function () {
+      return Konami;
+    });
+  } else {
+    window.Konami = Konami;
+  }
 }

docs/source/_templates/hacks.html

@@ -1,5 +1,11 @@
-<link rel="stylesheet" type="text/css" href="https://cloud.typography.com/7584432/7586812/css/fonts.css" />
-<script type="text/javascript">$('#searchbox').hide(0);</script>
+<link
+  rel="stylesheet"
+  type="text/css"
+  href="https://cloud.typography.com/7584432/7586812/css/fonts.css"
+/>
+<script type="text/javascript">
+  $("#searchbox").hide(0);
+</script>
 <!--Alabaster (krTheme++) Hacks -->
 
 <!-- CSS Adjustments (I'm very picky.) -->
@@ -26,7 +32,7 @@
   .class em,
   .descname,
   .method em {
-    font-family: "Operator Mono SSm A", "Operator Mono SSm B" !important;
+    font-family: "Operator Mono SSm A", "Operator Mono SSm B", monospace !important;
     font-weight: 400 !important;
   }
 
@@ -39,9 +45,7 @@
   }
 
   .method {
-
     margin-bottom: 2em;
-
   }
 
   .si,
@@ -80,8 +84,6 @@
     margin-top: -1em;
   }
 
-
-
   /* "Quick Search" should be not be shown for now. */
   div#searchbox h3 {
     display: none;
@@ -118,10 +120,12 @@
 <script async src="https://www.googletagmanager.com/gtag/js?id=UA-127383416-1"></script>
 <script>
   window.dataLayer = window.dataLayer || [];
-  function gtag() { dataLayer.push(arguments); }
-  gtag('js', new Date());
+  function gtag() {
+    dataLayer.push(arguments);
+  }
+  gtag("js", new Date());
 
-  gtag('config', 'UA-127383416-1');
+  gtag("config", "UA-127383416-1");
 </script>
 
 <!-- There are no more hacks. -->
@@ -130,7 +134,10 @@
 
 <script src="{{ pathto('_static/', 1) }}/konami.js"></script>
 <script>
-  var easter_egg = new Konami('https://www.myfortunecookie.co.uk/fortunes/' + (Math.floor(Math.random() * 152) + 1));
+  var easter_egg = new Konami(
+    "https://www.myfortunecookie.co.uk/fortunes/" +
+      (Math.floor(Math.random() * 152) + 1)
+  );
 </script>
 
 <style>
@@ -140,67 +147,94 @@
 </style>
 
 <!-- GitHub Logo -->
-<a href="https://github.com/kennethreitz/responder" class="github-corner" aria-label="View source on GitHub">
-  <svg width="80" height="80" viewBox="0 0 250 250" style="fill:#151513; color:#fff; position: absolute; top: 0; border: 0; right: 0;"
-    aria-hidden="true">
+<a
+  href="https://github.com/kennethreitz/responder"
+  class="github-corner"
+  aria-label="View source on GitHub"
+>
+  <svg
+    width="80"
+    height="80"
+    viewBox="0 0 250 250"
+    style="fill: #151513; color: #fff; position: absolute; top: 0; border: 0; right: 0"
+    aria-hidden="true"
+  >
     <path d="M0,0 L115,115 L130,115 L142,142 L250,250 L250,0 Z"></path>
-    <path d="M128.3,109.0 C113.8,99.7 119.0,89.6 119.0,89.6 C122.0,82.7 120.5,78.6 120.5,78.6 C119.2,72.0 123.4,76.3 123.4,76.3 C127.3,80.9 125.5,87.3 125.5,87.3 C122.9,97.6 130.6,101.9 134.4,103.2"
-      fill="currentColor" style="transform-origin: 130px 106px;" class="octo-arm"></path>
-    <path d="M115.0,115.0 C114.9,115.1 118.7,116.5 119.8,115.4 L133.7,101.6 C136.9,99.2 139.9,98.4 142.2,98.6 C133.8,88.0 127.5,74.4 143.8,58.0 C148.5,53.4 154.0,51.2 159.7,51.0 C160.3,49.4 163.2,43.6 171.4,40.1 C171.4,40.1 176.1,42.5 178.8,56.2 C183.1,58.6 187.2,61.8 190.9,65.4 C194.5,69.0 197.7,73.2 200.1,77.6 C213.8,80.2 216.3,84.9 216.3,84.9 C212.7,93.1 206.9,96.0 205.4,96.6 C205.1,102.4 203.0,107.8 198.3,112.5 C181.9,128.9 168.3,122.5 157.7,114.1 C157.9,116.9 156.7,120.9 152.7,124.9 L141.0,136.5 C139.8,137.7 141.6,141.9 141.8,141.8 Z"
-      fill="currentColor" class="octo-body"></path>
+    <path
+      d="M128.3,109.0 C113.8,99.7 119.0,89.6 119.0,89.6 C122.0,82.7 120.5,78.6 120.5,78.6 C119.2,72.0 123.4,76.3 123.4,76.3 C127.3,80.9 125.5,87.3 125.5,87.3 C122.9,97.6 130.6,101.9 134.4,103.2"
+      fill="currentColor"
+      style="transform-origin: 130px 106px"
+      class="octo-arm"
+    ></path>
+    <path
+      d="M115.0,115.0 C114.9,115.1 118.7,116.5 119.8,115.4 L133.7,101.6 C136.9,99.2 139.9,98.4 142.2,98.6 C133.8,88.0 127.5,74.4 143.8,58.0 C148.5,53.4 154.0,51.2 159.7,51.0 C160.3,49.4 163.2,43.6 171.4,40.1 C171.4,40.1 176.1,42.5 178.8,56.2 C183.1,58.6 187.2,61.8 190.9,65.4 C194.5,69.0 197.7,73.2 200.1,77.6 C213.8,80.2 216.3,84.9 216.3,84.9 C212.7,93.1 206.9,96.0 205.4,96.6 C205.1,102.4 203.0,107.8 198.3,112.5 C181.9,128.9 168.3,122.5 157.7,114.1 C157.9,116.9 156.7,120.9 152.7,124.9 L141.0,136.5 C139.8,137.7 141.6,141.9 141.8,141.8 Z"
+      fill="currentColor"
+      class="octo-body"
+    ></path>
   </svg>
 </a>
 <style>
   .github-corner:hover .octo-arm {
-    animation: octocat-wave 560ms ease-in-out
+    animation: octocat-wave 560ms ease-in-out;
   }
 
   @keyframes octocat-wave {
-
     0%,
     100% {
-      transform: rotate(0)
+      transform: rotate(0);
     }
 
     20%,
     60% {
-      transform: rotate(-25deg)
+      transform: rotate(-25deg);
     }
 
     40%,
     80% {
-      transform: rotate(10deg)
+      transform: rotate(10deg);
     }
   }
 
-  @media (max-width:500px) {
+  @media (max-width: 500px) {
     .github-corner:hover .octo-arm {
-      animation: none
+      animation: none;
     }
 
     .github-corner .octo-arm {
-      animation: octocat-wave 560ms ease-in-out
+      animation: octocat-wave 560ms ease-in-out;
     }
   }
 </style>
 
-
 <!-- That was not a hack. That was art.
 
 <!-- UserVoice JavaScript SDK (only needed once on a page) -->
-<script>(function () { var uv = document.createElement('script'); uv.type = 'text/javascript'; uv.async = true; uv.src = '//widget.uservoice.com/f4AQraEfwInlMzkexfRLg.js'; var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(uv, s) })()</script>
+<script>
+  (function () {
+    var uv = document.createElement("script");
+    uv.type = "text/javascript";
+    uv.async = true;
+    uv.src = "//widget.uservoice.com/f4AQraEfwInlMzkexfRLg.js";
+    var s = document.getElementsByTagName("script")[0];
+    s.parentNode.insertBefore(uv, s);
+  })();
+</script>
 
 <!-- A tab to launch the Classic Widget -->
 <script>
   UserVoice = window.UserVoice || [];
-  UserVoice.push(['showTab', 'classic_widget', {
-    mode: 'feedback',
-    primary_color: '#fa8c28',
-    link_color: '#0a8cc6',
-    forum_id: 913660,
-    tab_label: 'Got feedback?',
-    tab_color: '#00994f',
-    tab_position: 'bottom-left',
-    tab_inverted: true
-  }]);
+  UserVoice.push([
+    "showTab",
+    "classic_widget",
+    {
+      mode: "feedback",
+      primary_color: "#fa8c28",
+      link_color: "#0a8cc6",
+      forum_id: 913660,
+      tab_label: "Got feedback?",
+      tab_color: "#00994f",
+      tab_position: "bottom-left",
+      tab_inverted: true,
+    },
+  ]);
 </script>

docs/source/_templates/sidebarintro.html

@@ -1,33 +1,93 @@
 <p class="logo">
   <a href="{{ pathto(master_doc) }}">
-    <img class="logo" src="{{ pathto('_static/responder.png', 1) }}" title="https://kennethreitz.org/tattoos" />
+    <img
+      class="logo"
+      src="{{ pathto('_static/responder.png', 1) }}"
+      title="https://kennethreitz.org/tattoos"
+    />
   </a>
 </p>
 
 <p>
-  <iframe src="https://ghbtns.com/github-btn.html?user=kennethreitz&repo=responder&type=watch&count=true&size=large"
-    allowtransparency="true" frameborder="0" scrolling="0" width="200px" height="35px"></iframe>
+  <iframe
+    src="https://ghbtns.com/github-btn.html?user=kennethreitz&repo=responder&type=watch&count=true&size=large"
+    allowtransparency="true"
+    frameborder="0"
+    scrolling="0"
+    width="200px"
+    height="35px"
+  ></iframe>
 </p>
+<link
+  rel="stylesheet"
+  href="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css"
+/>
+<style>
+  .algolia-autocomplete {
+    width: 100%;
+    height: 1.5em;
+  }
+  .algolia-autocomplete a {
+    border-bottom: none !important;
+  }
+  #doc_search {
+    width: 100%;
+    height: 100%;
+  }
+</style>
+<input id="doc_search" placeholder="Search the doc" autofocus />
+<script
+  type="text/javascript"
+  src="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.js"
+  onload="docsearch({
+  apiKey: 'ac965312db252e0496283c75c6f76f0b',
+  indexName: 'python-responder',
+  inputSelector: '#doc_search',
+  debug: false // Set debug to true if you want to inspect the dropdown
+})"
+  async
+></script>
 
-<p>
-  <strong>Responder</strong> is a web service framework, written for human beings.
-</p>
+<p><strong>Responder</strong> is a web service framework, written for human beings.</p>
 
 <h3>Stay Informed</h3>
 <p>Receive updates on new releases and upcoming projects.</p>
 
-<p><iframe src="https://ghbtns.com/github-btn.html?user=kennethreitz&type=follow&count=true" allowtransparency="true"
-    frameborder="0" scrolling="0" width="200" height="20"></iframe></p>
-
-<p><a href="https://twitter.com/kennethreitz" class="twitter-follow-button" data-show-count="false">Follow
-    @kennethreitz</a>
-  <script>!function (d, s, id) { var js, fjs = d.getElementsByTagName(s)[0], p = /^http:/.test(d.location) ? 'http' : 'https'; if (!d.getElementById(id)) { js = d.createElement(s); js.id = id; js.src = p + '://platform.twitter.com/widgets.js'; fjs.parentNode.insertBefore(js, fjs); } }(document, 'script', 'twitter-wjs');</script>
+<p>
+  <iframe
+    src="https://ghbtns.com/github-btn.html?user=kennethreitz&type=follow&count=true"
+    allowtransparency="true"
+    frameborder="0"
+    scrolling="0"
+    width="200"
+    height="20"
+  ></iframe>
 </p>
 
+<p>
+  <a
+    href="https://twitter.com/kennethreitz"
+    class="twitter-follow-button"
+    data-show-count="false"
+    >Follow @kennethreitz</a
+  >
+  <script>
+    !(function (d, s, id) {
+      var js,
+        fjs = d.getElementsByTagName(s)[0],
+        p = /^http:/.test(d.location) ? "http" : "https";
+      if (!d.getElementById(id)) {
+        js = d.createElement(s);
+        js.id = id;
+        js.src = p + "://platform.twitter.com/widgets.js";
+        fjs.parentNode.insertBefore(js, fjs);
+      }
+    })(document, "script", "twitter-wjs");
+  </script>
+</p>
 
 <h3>Useful Links</h3>
 <ul>
-
   <li><a href="http://github.com/kennethreitz/responder">Responder @ GitHub</a></li>
   <li><a href="http://pypi.python.org/pypi/responder">Responder @ PyPI</a></li>
   <li><a href="http://github.com/kennethreitz/responder/issues">Issue Tracker</a></li>

docs/source/_templates/sidebarlogo.html

@@ -1,33 +1,93 @@
 <p class="logo">
   <a href="{{ pathto(master_doc) }}">
-    <img class="logo" src="{{ pathto('_static/responder.png', 1) }}" title="https://kennethreitz.org/tattoos" />
+    <img
+      class="logo"
+      src="{{ pathto('_static/responder.png', 1) }}"
+      title="https://kennethreitz.org/tattoos"
+    />
   </a>
 </p>
 
 <p>
-  <iframe src="https://ghbtns.com/github-btn.html?user=kennethreitz&repo=responder&type=watch&count=true&size=large"
-    allowtransparency="true" frameborder="0" scrolling="0" width="200px" height="35px"></iframe>
+  <iframe
+    src="https://ghbtns.com/github-btn.html?user=kennethreitz&repo=responder&type=watch&count=true&size=large"
+    allowtransparency="true"
+    frameborder="0"
+    scrolling="0"
+    width="200px"
+    height="35px"
+  ></iframe>
 </p>
+<link
+  rel="stylesheet"
+  href="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css"
+/>
+<style>
+  .algolia-autocomplete {
+    width: 100%;
+    height: 1.5em;
+  }
+  .algolia-autocomplete a {
+    border-bottom: none !important;
+  }
+  #doc_search {
+    width: 100%;
+    height: 100%;
+  }
+</style>
+<input id="doc_search" placeholder="Search the doc" autofocus />
+<script
+  type="text/javascript"
+  src="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.js"
+  onload="docsearch({
+  apiKey: 'ac965312db252e0496283c75c6f76f0b',
+  indexName: 'python-responder',
+  inputSelector: '#doc_search',
+  debug: false // Set debug to true if you want to inspect the dropdown
+})"
+  async
+></script>
 
-<p>
-  <strong>Responder</strong> is a web service framework, written for human beings.
-</p>
+<p><strong>Responder</strong> is a web service framework, written for human beings.</p>
 
 <h3>Stay Informed</h3>
 <p>Receive updates on new releases and upcoming projects.</p>
 
-<p><iframe src="https://ghbtns.com/github-btn.html?user=kennethreitz&type=follow&count=true" allowtransparency="true"
-    frameborder="0" scrolling="0" width="200" height="20"></iframe></p>
-
-<p><a href="https://twitter.com/kennethreitz" class="twitter-follow-button" data-show-count="false">Follow
-    @kennethreitz</a>
-  <script>!function (d, s, id) { var js, fjs = d.getElementsByTagName(s)[0], p = /^http:/.test(d.location) ? 'http' : 'https'; if (!d.getElementById(id)) { js = d.createElement(s); js.id = id; js.src = p + '://platform.twitter.com/widgets.js'; fjs.parentNode.insertBefore(js, fjs); } }(document, 'script', 'twitter-wjs');</script>
+<p>
+  <iframe
+    src="https://ghbtns.com/github-btn.html?user=kennethreitz&type=follow&count=true"
+    allowtransparency="true"
+    frameborder="0"
+    scrolling="0"
+    width="200"
+    height="20"
+  ></iframe>
 </p>
 
+<p>
+  <a
+    href="https://twitter.com/kennethreitz"
+    class="twitter-follow-button"
+    data-show-count="false"
+    >Follow @kennethreitz</a
+  >
+  <script>
+    !(function (d, s, id) {
+      var js,
+        fjs = d.getElementsByTagName(s)[0],
+        p = /^http:/.test(d.location) ? "http" : "https";
+      if (!d.getElementById(id)) {
+        js = d.createElement(s);
+        js.id = id;
+        js.src = p + "://platform.twitter.com/widgets.js";
+        fjs.parentNode.insertBefore(js, fjs);
+      }
+    })(document, "script", "twitter-wjs");
+  </script>
+</p>
 
 <h3>Useful Links</h3>
 <ul>
-
   <li><a href="http://github.com/kennethreitz/responder">Responder @ GitHub</a></li>
   <li><a href="http://pypi.python.org/pypi/responder">Responder @ PyPI</a></li>
   <li><a href="http://github.com/kennethreitz/responder/issues">Issue Tracker</a></li>

docs/source/deployment.rst

@@ -0,0 +1,58 @@
+Deploying Responder
+===================
+
+You can deploy Responder anywhere you can deploy a basic Python application.
+
+Docker Deployment
+-----------------
+
+Assuming existing ``api.py`` and ``Pipfile.lock`` containing ``responder``.
+
+``Dockerfile``::
+
+    FROM kennethreitz/pipenv
+    ENV PORT '80'
+    COPY . /app
+    CMD python3 api.py
+    EXPOSE 80
+
+That's it!
+
+Heroku Deployment
+-----------------
+
+The basics::
+
+    $ mkdir my-api
+    $ cd my-api
+    $ git init
+    $ heroku create
+    ...
+
+Install Responder::
+
+    $ pipenv install responder
+    ...
+
+Write out an ``api.py``::
+
+    import responder
+
+    api = responder.API()
+
+    @api.route("/")
+    async def hello(req, resp):
+        resp.text = "hello, world!"
+
+    if __name__ == "__main__":
+        api.run()
+
+Write out a ``Procfile``::
+
+    web: python api.py
+
+That's it! Next, we commit and push to Heroku::
+
+    $ git add -A
+    $ git commit -m 'initial commit'
+    $ git push heroku master

docs/source/index.rst

@@ -21,9 +21,6 @@ A familiar HTTP Service Framework
 .. |image5| image:: https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg
    :target: https://saythanks.io/to/kennethreitz
 
-The Python world certainly doesn't need more web frameworks. But, it does need more creativity, so I thought I'd
-spread some `Hacktoberfest <https://hacktoberfest.digitalocean.com/>`_ spirit around, bring some of my ideas to the table, and see what I could come up with.
-
 .. code:: python
 
    import responder
@@ -37,22 +34,28 @@ spread some `Hacktoberfest <https://hacktoberfest.digitalocean.com/>`_ spirit ar
    if __name__ == '__main__':
        api.run()
 
-That ``async`` declaration is optional.
+Powered by `Starlette <https://www.starlette.io/>`_. That ``async`` declaration is optional.
 
 This gets you a ASGI app, with a production static files server
+(`WhiteNoise <http://whitenoise.evans.io/en/stable/>`_)
 pre-installed, jinja2 templating (without additional imports), and a
-production webserver based on uvloop, serving up requests with gzip
-compression automatically.
+production webserver based on uvloop, serving up requests with
+automatic gzip compression.
 
 Features
 --------
 
 - A pleasant API, with a single import statement.
-- ASGI framework, the future of Python web services.
+- Class-based views without inheritance.
+- `ASGI <https://asgi.readthedocs.io>`_ framework, the future of Python web services.
+- WebSocket support!
 - The ability to mount any ASGI / WSGI app at a subroute.
-- *f-string syntax* route declration.
+- `f-string syntax <https://docs.python.org/3/whatsnew/3.6.html#pep-498-formatted-string-literals>`_ route declaration.
 - Mutable response object, passed into each view. No need to return anything.
 - Background tasks, spawned off in a ``ThreadPoolExecutor``.
+- GraphQL (with *GraphiQL*) support!
+- OpenAPI schema generation, with interactive documentation!
+- Single-page webapp support!
 
 Testimonials
 ------------
@@ -79,18 +82,8 @@ Testimonials
     — Danny Greenfield, author of `Two Scoops of Django`_
 
 
-..
-
-
-   “The most ambitious crossover event in history.”
-
-    —Pablo Cabezas, `on Tom Christie joining the project`_
-
-
-.. _APIStar: https://github.com/encode/apistar
 .. _Django REST Framework: https://www.django-rest-framework.org/
-.. _Two Scoops of Django:
-.. _on Tom Christie joining the project: https://twitter.com/pabloteleco/status/1050841098321620992?s=20
+.. _Two Scoops of Django: https://www.twoscoopspress.com/products/two-scoops-of-django-1-11
 
 User Guides
 -----------
@@ -100,6 +93,8 @@ User Guides
 
    quickstart
    tour
+   deployment
+   testing
    api
 
 
@@ -119,8 +114,9 @@ The Basic Idea
 
 The primary concept here is to bring the niceties that are brought forth from both Flask and Falcon and unify them into a single framework, along with some new ideas I have. I also wanted to take some of the API primitives that are instilled in the Requests library and put them into a web framework. So, you'll find a lot of parallels here with Requests.
 
-- Setting ``resp.text`` sends back unicode, while setting ``resp.content`` sends back bytes.
-- Setting ``resp.media`` sends back JSON/YAML (``.text``/``.content`` override this).
+- Setting ``resp.content`` sends back bytes.
+- Setting ``resp.text`` sends back unicode, while setting ``resp.html`` sends back HTML.
+- Setting ``resp.media`` sends back JSON/YAML (``.text``/``.html``/``.content`` override this).
 - Case-insensitive ``req.headers`` dict (from Requests directly).
 - ``resp.status_code``, ``req.method``, ``req.url``, and other familiar friends.
 
@@ -128,24 +124,16 @@ Ideas
 -----
 
 - Flask-style route expression, with new capabilities -- all while using Python 3.6+'s new f-string syntax.
-- I love Falcon's "every request and response is passed into to each view and mutated" methodology, especially ``response.media``, and have used it here. In addition to supporting JSON, I have decided to support YAML as well, as Kubernetes is slowly taking over the world, and it uses YAML for all the things. Content-negotiation and all that.
+- I love Falcon's "every request and response is passed into each view and mutated" methodology, especially ``response.media``, and have used it here. In addition to supporting JSON, I have decided to support YAML as well, as Kubernetes is slowly taking over the world, and it uses YAML for all the things. Content-negotiation and all that.
 - **A built in testing client that uses the actual Requests you know and love**.
 - The ability to mount other WSGI apps easily.
 - Automatic gzipped-responses.
 - In addition to Falcon's ``on_get``, ``on_post``, etc methods, Responder features an ``on_request`` method, which gets called on every type of request, much like Requests.
 - A production static files server is built-in.
-- Uvicorn built-in as a production web server. I would have chosen Gunicorn, but it doesn't run on Windows. Plus, Uvicorn serves well to protect against slowloris attacks, making nginx unneccessary in production.
+- `Uvicorn <https://www.uvicorn.org/>`_ is built-in as a production web server. I would have chosen Gunicorn, but it doesn't run on Windows. Plus, Uvicorn serves well to protect against `slowloris <https://en.wikipedia.org/wiki/Slowloris_(computer_security)>`_ attacks, making nginx unnecessary in production.
 - GraphQL support, via Graphene. The goal here is to have any GraphQL query exposable at any route, magically.
 
 
-Future Ideas
-------------
-
-- Cookie-based sessions are currently an afterthought, as this is an API framework, but websites are APIs too.
-- If frontend websites are supported, provide an official way to run webpack.
-
-
-
 Indices and tables
 ==================
 

docs/source/quickstart.rst

@@ -34,7 +34,7 @@ Next, we can run our web service easily, with ``api.run()``::
 
 This will spin up a production web server on port ``5042``, ready for incoming HTTP requests.
 
-Note: you can pass ``port=5000`` if you want to customize the port. The ``PORT`` environment variable for established web service providers (e.g. Heroku) will automatically be honored.
+Note: you can pass ``port=5000`` if you want to customize the port. The ``PORT`` environment variable for established web service providers (e.g. Heroku) will automatically be honored and will set the listening address to ``0.0.0.0`` automatically (also configurable through the ``address`` keyword argument).
 
 
 Accept Route Arguments
@@ -48,6 +48,14 @@ If you want dynamic URLs, you can use Python's familiar *f-string syntax* to dec
 
 A ``GET`` request to ``/hello/brettcannon`` will result in a response of ``hello, brettcannon!``.
 
+Type convertors are also available::
+
+    @api.route("/add/{a:int}/{b:int}")
+    async def add(req, resp, *, a, b):
+        resp.text = f"{a} + {b} = {a + b}"
+
+Supported types: ``str``, ``int`` and ``float``.
+
 Returning JSON / YAML
 ---------------------
 
@@ -65,13 +73,30 @@ If the client requests YAML instead (with a header of ``Accept: application/x-ya
 Rendering a Template
 --------------------
 
-If you want to render a template, simply use ``api.template``. No need for additional imports::
+Responder provides a built-in light `jinja2 <http://jinja.pocoo.org/docs/>`_ wrapper ``templates.Templates``
+
+Usage::
+
+  from responder.templates import Templates
+
+  templates = Templates()
+
+  @api.route("/hello/{name}/html")
+  def hello(req, resp, name):
+      resp.html = templates.render("hello.html", name=name)
+
+
+Also a ``render_async`` is available::
+
+    templates = Templates(enable_async=True)
+    resp.html = await templates.render_async("hello.html", who=who)
+
+You can also use the existing ``api.template(filename, *args, **kwargs)`` to render templates::
 
     @api.route("/hello/{who}/html")
     def hello_html(req, resp, *, who):
-        resp.content = api.template('hello.html', who=who)
+        resp.html = api.template('hello.html', who=who)
 
-The ``api`` instance is available as an object during template rendering.
 
 Setting Response Status Code
 ----------------------------
@@ -90,7 +115,7 @@ If you want to set a response header, like ``X-Pizza: 42``, simply modify the ``
 
     @api.route("/pizza")
     def pizza_pizza(req, resp):
-        resp.headers['X-Pizza'] = 42
+        resp.headers['X-Pizza'] = '42'
 
 That's it!
 
@@ -115,7 +140,7 @@ Here, we'll process our data in the background, while responding immediately to
 
         # Parse the incoming data as form-encoded.
         # Note: 'json' and 'yaml' formats are also automatically supported.
-        data = await resp.media()
+        data = await req.media()
 
         # Process the data (in the background).
         process_data(data)
@@ -124,3 +149,29 @@ Here, we'll process our data in the background, while responding immediately to
         resp.media = {'success': True}
 
 A ``POST`` request to ``/incoming`` will result in an immediate response of ``{'success': true}``.
+
+
+Here's a sample code to post a file with background::
+
+    @api.route("/")
+    async def upload_file(req, resp):
+
+        @api.background.task
+        def process_data(data):
+            f = open('./{}'.format(data['file']['filename']), 'w')
+            f.write(data['file']['content'].decode('utf-8'))
+            f.close()
+
+        data = await req.media(format='files')
+        process_data(data)
+
+        resp.media = {'success': 'ok'}
+
+You can send a file easily with requests::
+
+	  import requests
+
+	  data = {'file': ('hello.txt', 'hello, world!', "text/plain")}
+	  r = requests.post('http://127.0.0.1:8210/file', files=data)
+
+	  print(r.text)

docs/source/testing.rst

@@ -0,0 +1,81 @@
+Building and Testing with Responder
+===================================
+
+Responder comes with a first-class, well supported test client for your ASGI web services: **Requests**.
+
+Here, we'll go over the basics of setting up a proper Python package and adding testing to it.
+
+The Basics
+----------
+
+Your repository should look like this::
+
+    Pipfile   Pipfile.lock   api.py  test_api.py
+
+``$ cat api.py``::
+
+    import responder
+
+    api = responder.API()
+
+    @api.route("/")
+    def hello_world(req, resp):
+        resp.text = "hello, world!"
+
+    if __name__ == "__main__":
+        api.run()
+
+
+``$ cat Pipfile``::
+
+    [[source]]
+    url = "https://pypi.org/simple"
+    verify_ssl = true
+    name = "pypi"
+
+    [packages]
+    responder = "*"
+
+    [dev-packages]
+    pytest = "*"
+
+    [requires]
+    python_version = "3.7"
+
+    [pipenv]
+    allow_prereleases = true
+
+Writing Tests
+-------------
+
+``$ cat test_api.py``::
+
+    import pytest
+    import api as service
+
+    @pytest.fixture
+    def api():
+        return service.api
+
+
+    def test_hello_world(api):
+        r = api.requests.get("/")
+        assert r.text == "hello, world!"
+
+``$ pytest``::
+
+    ...
+    ========================== 1 passed in 0.10 seconds ==========================
+
+
+(Optional) Proper Python Package
+--------------------------------
+
+Optionally, you can not rely on relative imports, and instead install your api as a proper package. This requires:
+
+1. A `proper setup.py <https://github.com/kennethreitz/setup.py>`_ file.
+2. ``$ pipenv install -e . --dev``
+
+This will allow you to only specify your dependencies once: in ``setup.py``. ``$ pipenv lock`` will automatically lock your transitive dependencies (e.g. Responder), even if it's not specified in the ``Pipfile``.
+
+This will ensure that your application gets installed in every developer's environment, using Pipenv.

docs/source/tour.rst

@@ -9,7 +9,7 @@ Class-based views (and setting some headers and stuff)::
 
     @api.route("/{greeting}")
     class GreetingResource:
-        def on_request(req, resp, *, greeting):   # or on_get...
+        def on_request(self, req, resp, *, greeting):   # or on_get...
             resp.text = f"{greeting}, world!"
             resp.headers.update({'X-Life': '42'})
             resp.status_code = api.status_codes.HTTP_416
@@ -43,40 +43,53 @@ Serve a GraphQL API::
         hello = graphene.String(name=graphene.String(default_value="stranger"))
 
         def resolve_hello(self, info, name):
-            return "Hello " + name
+            return f"Hello {name}"
 
-    api.add_route("/graph", graphene.Schema(query=Query))
+    schema = graphene.Schema(query=Query)
+    view = responder.ext.GraphQLView(api=api, schema=schema)
 
+    api.add_route("/graph", view)
 
-Built-in Testing Client (Requests)
-----------------------------------
+Visiting the endpoint will render a *GraphiQL* instance, in the browser.
 
-We can then send a query to our service::
+You can make use of Responder's Request and Response objects in your GraphQL resolvers through ``info.context['request']`` and ``info.context['response']``.
 
-    >>> requests = api.session()
-    >>> r = requests.get("http://;/graph", params={"query": "{ hello }"})
-    >>> r.json()
-    {'data': {'hello': 'Hello stranger'}}
-
-
-Or, request YAML back::
-
-    >>> r = requests.get("http://;/graph", params={"query": "{ hello(name:\"john\") }"}, headers={"Accept": "application/x-yaml"})
-    >>> print(r.text)
-    data: {hello: Hello john}
 
 OpenAPI Schema Support
 ----------------------
 
-Responder comes with built-in support for OpenAPI / marshmallow::
+Responder comes with built-in support for OpenAPI / marshmallow
+
+New in Responder `1.4.0`::
 
     import responder
+    from responder.ext.schema import Schema as OpenAPISchema
     from marshmallow import Schema, fields
 
-    api = responder.API(title="Web Service", version="1.0", openapi="3.0")
+    contact = {
+        "name": "API Support",
+        "url": "http://www.example.com/support",
+        "email": "support@example.com",
+    }
+    license = {
+        "name": "Apache 2.0",
+        "url": "https://www.apache.org/licenses/LICENSE-2.0.html",
+    }
+    
+    api = responder.API()
 
+    schema = OpenAPISchema(
+        app=api,
+        title="Web Service",
+        version="1.0",
+        openapi="3.0.2",
+        description="A simple pet store",
+        terms_of_service="http://example.com/terms/",
+        contact=contact,
+        license=license,
+    )
 
-    @api.schema("Pet")
+    @schema.schema("Pet")
     class PetSchema(Schema):
         name = fields.Str()
 
@@ -90,38 +103,280 @@ Responder comes with built-in support for OpenAPI / marshmallow::
             responses:
                 200:
                     description: A pet to be returned
-                    schema:
-                        $ref = "#/components/schemas/Pet"
+                    content:  
+                        application/json: 
+                            schema: 
+                                $ref: '#/components/schemas/Pet'                         
         """
         resp.media = PetSchema().dump({"name": "little orange"})
 
 
+Old way *It's recommended to use the code above* ::
+
+    import responder
+    from marshmallow import Schema, fields
+
+    contact = {
+        "name": "API Support",
+        "url": "http://www.example.com/support",
+        "email": "support@example.com",
+    }
+    license = {
+        "name": "Apache 2.0",
+        "url": "https://www.apache.org/licenses/LICENSE-2.0.html",
+    }
+
+    api = responder.API(
+        title="Web Service",
+        version="1.0",
+        openapi="3.0.2",
+        description="A simple pet store",
+        terms_of_service="http://example.com/terms/",
+        contact=contact,
+        license=license,
+    )
+
+    @api.schema("Pet")
+    class PetSchema(Schema):
+        name = fields.Str()
+
+    @api.route("/")
+    def route(req, resp):
+        """A cute furry animal endpoint.
+        ---
+        get:
+            description: Get a random pet
+            responses:
+                200:
+                    description: A pet to be returned
+                    content:  
+                        application/json: 
+                            schema: 
+                                $ref: '#/components/schemas/Pet'                         
+        """
+        resp.media = PetSchema().dump({"name": "little orange"})
+
 ::
 
     >>> r = api.session().get("http://;/schema.yml")
 
     >>> print(r.text)
     components:
-    parameters: {}
-    schemas:
+      parameters: {}
+      responses: {}
+      schemas:
         Pet:
-        properties:
+          properties:
             name: {type: string}
-        type: object
-    info: {title: Web Service, version: 1.0}
-    openapi: '3.0'
+          type: object
+      securitySchemes: {}
+    info:
+      contact: {email: support@example.com, name: API Support, url: 'http://www.example.com/support'}
+      description: This is a sample server for a pet store.
+      license: {name: Apache 2.0, url: 'https://www.apache.org/licenses/LICENSE-2.0.html'}
+      termsOfService: http://example.com/terms/
+      title: Web Service
+      version: 1.0
+    openapi: 3.0.2
     paths:
       /:
         get:
           description: Get a random pet
           responses:
-            200: {description: A pet to be returned, schema: $ref = "#/components/schemas/Pet"}
+            200: {description: A pet to be returned, schema: $ref: "#/components/schemas/Pet"}
     tags: []
 
+
+Interactive Documentation
+-------------------------
+
+Responder can automatically supply API Documentation for you. Using the example above
+
+The new and recommended way::
+
+    ...
+    from responder.ext.schema import Schema
+    ...
+    api = responder.API()
+
+    schema = Schema(
+        app=api,
+        title="Web Service",
+        version="1.0",
+        openapi="3.0.2",
+        ...
+        docs_route='/docs',
+        ...
+        description=description,
+        terms_of_service=terms_of_service,
+        contact=contact,
+        license=license,
+    )
+    
+
+The old way ::
+
+    api = responder.API(
+        title="Web Service",
+        version="1.0",
+        openapi="3.0.2",
+        docs_route='/docs',
+        description=description,
+        terms_of_service=terms_of_service,
+        contact=contact,
+        license=license,
+    )
+
+This will make ``/docs`` render interactive documentation for your API.
+
+Mount a WSGI / ASGI Apps (e.g. Flask, Starlette,...)
+----------------------------------------------------
+
+Responder gives you the ability to mount another ASGI / WSGI app at a subroute::
+
+    import responder
+    from flask import Flask
+
+    api = responder.API()
+    flask = Flask(__name__)
+
+    @flask.route('/')
+    def hello():
+        return 'hello'
+
+    api.mount('/flask', flask)
+
+That's it!
+
+Single-Page Web Apps
+--------------------
+
+If you have a single-page webapp, you can tell Responder to serve up your ``static/index.html`` at a route, like so::
+
+    api.add_route("/", static=True)
+
+This will make ``index.html`` the default response to all undefined routes.
+
+Reading / Writing Cookies
+-------------------------
+
+Responder makes it very easy to interact with cookies from a Request, or add some to a Response::
+
+    >>> resp.cookies["hello"] = "world"
+
+    >>> req.cookies
+    {"hello": "world"}
+
+
+To set cookies directives, you should use `resp.set_cookie`::
+
+    >>> resp.set_cookie("hello", value="world", max_age=60)
+
+Supported directives:
+
+* ``key`` - **Required**
+* ``value`` - [OPTIONAL] - Defaults to ``""``. 
+* ``expires`` - Defaults to ``None``.
+* ``max_age`` - Defaults to ``None``.
+* ``domain`` - Defaults to ``None``.
+* ``path`` - Defaults to ``"/"``.
+* ``secure`` - Defaults to ``False``.
+* ``httponly`` - Defaults to ``True``.
+
+For more information see `directives <https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie#Directives>`_
+
+
+Using Cookie-Based Sessions
+---------------------------
+
+Responder has built-in support for cookie-based sessions. To enable cookie-based sessions, simply add something to the ``resp.session`` dictionary::
+
+    >>> resp.session['username'] = 'kennethreitz'
+
+A cookie called ``Responder-Session`` will be set, which contains all the data in ``resp.session``. It is signed, for verification purposes.
+
+You can easily read a Request's session data, that can be trusted to have originated from the API::
+
+    >>> req.session
+    {'username': 'kennethreitz'}
+
+**Note**: if you are using this in production, you should pass the ``secret_key`` argument to ``API(...)``::
+
+    api = responder.API(secret_key=os.environ['SECRET_KEY'])
+
+Using ``before_request``
+------------------------
+
+If you'd like a view to be executed before every request, simply do the following::
+
+    @api.route(before_request=True)
+    def prepare_response(req, resp):
+        resp.headers["X-Pizza"] = "42"
+
+Now all requests to your HTTP Service will include an ``X-Pizza`` header.
+
+For ``websockets``::
+
+    @api.route(before_request=True, websocket=True)
+    def prepare_response(ws):
+        await ws.accept()
+
+
+WebSocket Support
+-----------------
+
+Responder supports WebSockets::
+
+    @api.route('/ws', websocket=True)
+    async def websocket(ws):
+        await ws.accept()
+        while True:
+            name = await ws.receive_text()
+            await ws.send_text(f"Hello {name}!")
+        await ws.close()
+
+Accepting the connection::
+
+    await websocket.accept()
+
+Sending and receiving data::
+
+    await websocket.send_{format}(data) 
+    await websocket.receive_{format}(data)
+
+Supported formats: ``text``, ``json``, ``bytes``.
+
+Closing the connection::
+
+    await websocket.close()
+
+Using Requests Test Client
+--------------------------
+
+Responder comes with a first-class, well supported test client for your ASGI web services: **Requests**.
+
+Here's an example of a test (written with pytest)::
+
+    import myapi
+
+    @pytest.fixture
+    def api():
+        return myapi.api
+
+    def test_response(api):
+        hello = "hello, world!"
+
+        @api.route('/some-url')
+        def some_view(req, resp):
+            resp.text = hello
+
+        r = api.requests.get(url=api.url_for(some_view))
+        assert r.text == hello
+
 HSTS (Redirect to HTTPS)
 ------------------------
 
-Want HSTS?
+Want HSTS (to redirect all traffic to HTTPS)?
 
 ::
 
@@ -129,3 +384,44 @@ Want HSTS?
 
 
 Boom.
+
+CORS
+----
+
+Want `CORS <https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS/>`_ ?
+
+::
+
+    api = responder.API(cors=True)
+
+
+The default parameters used by **Responder** are restrictive by default, so you'll need to explicitly enable particular origins, methods, or headers, in order for browsers to be permitted to use them in a Cross-Domain context.
+
+In order to set custom parameters, you need to set the ``cors_params`` argument of ``api``, a dictionary containing the following entries:
+
+* ``allow_origins`` - A list of origins that should be permitted to make cross-origin requests. eg. ``['https://example.org', 'https://www.example.org']``. You can use ``['*']`` to allow any origin.
+* ``allow_origin_regex`` - A regex string to match against origins that should be permitted to make cross-origin requests. eg. ``'https://.*\.example\.org'``.
+* ``allow_methods`` - A list of HTTP methods that should be allowed for cross-origin requests. Defaults to `['GET']`. You can use ``['*']`` to allow all standard methods.
+* ``allow_headers`` - A list of HTTP request headers that should be supported for cross-origin requests. Defaults to ``[]``. You can use ``['*']`` to allow all headers. The ``Accept``, ``Accept-Language``, ``Content-Language`` and ``Content-Type`` headers are always allowed for CORS requests.
+* ``allow_credentials`` - Indicate that cookies should be supported for cross-origin requests. Defaults to ``False``.
+* ``expose_headers`` - Indicate any response headers that should be made accessible to the browser. Defaults to ``[]``.
+* ``max_age`` - Sets a maximum time in seconds for browsers to cache CORS responses. Defaults to ``60``.
+
+Trusted Hosts
+-------------
+
+Make sure that all the incoming requests headers have a valid ``host``, that matches one of the provided patterns in the ``allowed_hosts`` attribute, in order to prevent HTTP Host Header attacks.
+
+A 400 response will be raised, if a request does not match any of the provided patterns in the ``allowed_hosts`` attribute.
+
+::
+
+    api = responder.API(allowed_hosts=['example.com', 'tenant.example.com'])
+
+* ``allowed_hosts`` - A list of allowed hostnames. 
+
+Note:
+
+* By default, all hostnames are allowed.
+* Wildcard domains such as ``*.example.com`` are supported.
+* To allow any hostname use ``allowed_hosts=["*"]``.

pyproject.toml

@@ -0,0 +1,3 @@
+[build-system]
+requires = ["setuptools", "wheel"]
+build-backend = "setuptools.build_meta:__legacy__"

pytest.ini

@@ -1,4 +1,4 @@
 [pytest]
-; addopts= -rsxX -s -v --strict
+;addopts= -rsxX -s -v --strict
 filterwarnings =
     error::UserWarning

readthedocs.yml

@@ -1,5 +1,5 @@
 build:
-    image: latest
+  image: latest
 
 python:
-    version: 3.6
+  version: 3.6

responder/__init__.py

@@ -1 +1,2 @@
 from .core import *
+from . import ext

responder/__version__.py

@@ -1 +1 @@
-__version__ = "0.0.6"
+__version__ = "2.0.6"

responder/api.py

@@ -1,35 +1,39 @@
-import os
 import json
-from functools import partial
+import os
+
 from pathlib import Path
 
-import uvicorn
-
-import asyncio
 import jinja2
-from graphql_server import encode_execution_results, json_encode, default_format_error
-from starlette.routing import Router
+import uvicorn
+from starlette.exceptions import ExceptionMiddleware
+from starlette.middleware.wsgi import WSGIMiddleware
+from starlette.middleware.errors import ServerErrorMiddleware
+from starlette.middleware.cors import CORSMiddleware
+from starlette.middleware.gzip import GZipMiddleware
+from starlette.middleware.httpsredirect import HTTPSRedirectMiddleware
+from starlette.middleware.trustedhost import TrustedHostMiddleware
+from starlette.middleware.sessions import SessionMiddleware
 from starlette.staticfiles import StaticFiles
 from starlette.testclient import TestClient
-from apispec import APISpec
-from apispec.ext.marshmallow import MarshmallowPlugin
-from apispec import yaml_utils
-from asgiref.wsgi import WsgiToAsgi
+from starlette.websockets import WebSocket
 
-from . import models
-from . import status_codes
-from .routes import Route
-from .formats import get_formats
+from . import models, status_codes
 from .background import BackgroundQueue
+from .formats import get_formats
+from .routes import Router
+from .statics import DEFAULT_API_THEME, DEFAULT_CORS_PARAMS, DEFAULT_SECRET_KEY
+from .ext.schema import Schema as OpenAPISchema
+from .staticfiles import StaticFiles
+from .templates import Templates
 
 
-# TODO: consider moving status codes here
 class API:
     """The primary web-service class.
 
-        :param static_dir: The directory to use for static files. Will be created for you if it doesn't already exist.
-        :param templates_dir: The directory to use for templates. Will be created for you if it doesn't already exist.
-        :param enable_hsts: If ``True``, send all responses to HTTPS URLs.
+    :param static_dir: The directory to use for static files. Will be created for you if it doesn't already exist.
+    :param templates_dir: The directory to use for templates. Will be created for you if it doesn't already exist.
+    :param auto_escape: If ``True``, HTML and XML templates will automatically be escaped.
+    :param enable_hsts: If ``True``, send all responses to HTTPS URLs.
     """
 
     status_codes = status_codes
@@ -37,112 +41,127 @@ class API:
     def __init__(
         self,
         *,
+        debug=False,
         title=None,
         version=None,
+        description=None,
+        terms_of_service=None,
+        contact=None,
+        license=None,
         openapi=None,
         openapi_route="/schema.yml",
         static_dir="static",
+        static_route="/static",
         templates_dir="templates",
+        auto_escape=True,
+        secret_key=DEFAULT_SECRET_KEY,
         enable_hsts=False,
+        docs_route=None,
+        cors=False,
+        cors_params=DEFAULT_CORS_PARAMS,
+        allowed_hosts=None,
     ):
-        self.title = title
-        self.version = version
-        self.openapi_version = openapi
-        self.static_dir = Path(os.path.abspath(static_dir))
-        self.static_route = f"/{static_dir}"
-        self.templates_dir = Path(os.path.abspath(templates_dir))
-        self.routes = {}
-        self.schemas = {}
+        self.background = BackgroundQueue()
+
+        self.secret_key = secret_key
+
+        self.router = Router()
+
+        if static_dir is not None:
+            if static_route is None:
+                static_route = static_dir
+            static_dir = Path(os.path.abspath(static_dir))
+
+        self.static_dir = static_dir
+        self.static_route = static_route
 
         self.hsts_enabled = enable_hsts
-        self.static_files = StaticFiles(directory=str(self.static_dir))
-        self.apps = {self.static_route: self.static_files}
+        self.cors = cors
+        self.cors_params = cors_params
+        self.debug = debug
+
+        if not allowed_hosts:
+            # if not debug:
+            #     raise RuntimeError(
+            #         "You need to specify `allowed_hosts` when debug is set to False"
+            #     )
+            allowed_hosts = ["*"]
+        self.allowed_hosts = allowed_hosts
+
+        if self.static_dir is not None:
+            os.makedirs(self.static_dir, exist_ok=True)
+
+        if self.static_dir is not None:
+            self.mount(self.static_route, self.static_app)
 
         self.formats = get_formats()
 
-        # Make the static/templates directory if they don't exist.
-        for _dir in (self.static_dir, self.templates_dir):
-            os.makedirs(_dir, exist_ok=True)
-
         # Cached requests session.
         self._session = None
-        self.background = BackgroundQueue()
 
-        if self.openapi_version:
-            self.add_route(openapi_route, self.schema_response)
+        self.default_endpoint = None
+        self.app = ExceptionMiddleware(self.router, debug=debug)
+        self.add_middleware(GZipMiddleware)
+
+        if self.hsts_enabled:
+            self.add_middleware(HTTPSRedirectMiddleware)
+
+        self.add_middleware(TrustedHostMiddleware, allowed_hosts=self.allowed_hosts)
+
+        if self.cors:
+            self.add_middleware(CORSMiddleware, **self.cors_params)
+        self.add_middleware(ServerErrorMiddleware, debug=debug)
+        self.add_middleware(SessionMiddleware, secret_key=self.secret_key)
+
+        if openapi or docs_route:
+            self.openapi = OpenAPISchema(
+                app=self,
+                title=title,
+                version=version,
+                openapi=openapi,
+                docs_route=docs_route,
+                description=description,
+                terms_of_service=terms_of_service,
+                contact=contact,
+                license=license,
+                openapi_route=openapi_route,
+                static_route=static_route,
+            )
+
+        # TODO: Update docs for templates
+        self.templates = Templates(directory=templates_dir)
+        self.requests = (
+            self.session()
+        )  #: A Requests session that is connected to the ASGI app.
 
     @property
-    def _apispec(self):
-        spec = APISpec(
-            title=self.title,
-            version=self.version,
-            openapi_version=self.openapi_version,
-            plugins=[MarshmallowPlugin()],
-        )
+    def static_app(self):
+        if not hasattr(self, "_static_app"):
+            assert self.static_dir is not None
+            self._static_app = StaticFiles(directory=self.static_dir)
+        return self._static_app
 
-        for route in self.routes:
-            if self.routes[route].description:
-                operations = yaml_utils.load_operations_from_docstring(
-                    self.routes[route].description
-                )
-                spec.add_path(path=route, operations=operations)
+    def before_request(self, websocket=False):
+        def decorator(f):
+            self.router.before_request(f, websocket=websocket)
+            return f
 
-        for name, schema in self.schemas.items():
-            spec.definition(name, schema=schema)
+        return decorator
 
-        return spec
-
-    @property
-    def openapi(self):
-        return self._apispec.to_yaml()
-
-    def __call__(self, scope):
-        path = scope["path"]
-        root_path = scope.get("root_path", "")
-
-        # Call into a submounted app, if one exists.
-        for path_prefix, app in self.apps.items():
-            if path.startswith(path_prefix):
-                scope["path"] = path[len(path_prefix) :]
-                scope["root_path"] = root_path + path_prefix
-                try:
-                    return app(scope)
-                except TypeError:
-                    app = WsgiToAsgi(app)
-                    return app(scope)
-
-        # Call the main dispatcher.
-        async def asgi(receive, send):
-            nonlocal scope, self
-
-            req = models.Request(scope, receive=receive)
-            resp = await self._dispatch_request(req)
-            await resp(receive, send)
-
-        return asgi
-
-    def add_schema(self, name, schema, check_existing=True):
-        """Adds a mashmallow schema to the API specification."""
-        if check_existing:
-            assert name not in self.schemas
-
-        self.schemas[name] = schema
+    def add_middleware(self, middleware_cls, **middleware_config):
+        self.app = middleware_cls(self.app, **middleware_config)
 
     def schema(self, name, **options):
         """Decorator for creating new routes around function and class definitions.
-
         Usage::
-
             from marshmallow import Schema, fields
-
             @api.schema("Pet")
             class PetSchema(Schema):
                 name = fields.Str()
-
         """
 
         def decorator(f):
-            self.add_schema(name=name, schema=f, **options)
+            self.openapi.add_schema(name=name, schema=f, **options)
             return f
 
         return decorator
@@ -152,142 +171,100 @@ class API:
 
         :param path: The path portion of a URL, to test all known routes against.
         """
-        for (route, route_object) in self.routes.items():
-            if route_object.does_match(path):
+        for route in self.router.routes:
+            match, _ = route.matches(path)
+            if match:
                 return route
 
-    async def _dispatch_request(self, req):
-        # Set formats on Request object.
-        req.formats = self.formats
-
-        route = self.path_matches_route(req.url.path)
-        resp = models.Response(req=req, formats=self.formats)
-
-        if self.hsts_enabled:
-            if req.url.startswith("http://"):
-                url = req.url.replace("http://", "https://", 1)
-                self.redirect(resp, location=url)
-
-        if route:
-            try:
-                params = self.routes[route].incoming_matches(req.url.path)
-                result = self.routes[route].endpoint(req, resp, **params)
-                if hasattr(result, "cr_running"):
-                    await result
-            # The request is using class-based views.
-            except TypeError as e:
-                try:
-                    view = self.routes[route].endpoint(**params)
-                except TypeError:
-                    view = self.routes[route].endpoint
-                    try:
-                        # GraphQL Schema.
-                        assert hasattr(view, "execute")
-                        await self.graphql_response(req, resp, schema=view)
-                    except AssertionError:
-                        # WSGI App.
-                        # try:
-                        #     return view(
-                        #         environ=req._environ, start_response=req._start_response
-                        #     )
-                        # except TypeError:
-                        #     pass
-                        pass
-
-                # Run on_request first.
-                try:
-                    getattr(view, "on_request")(req, resp)
-                except AttributeError:
-                    pass
-
-                # Then on_get.
-                method = req.method.lower()
-
-                try:
-                    getattr(view, f"on_{method}")(req, resp)
-                except AttributeError:
-                    pass
-        else:
-            self.default_response(req, resp)
-
-        return resp
-
-    def add_route(self, route, endpoint, *, check_existing=True):
-        # TODO: add graphiql
-        """Add a route to the API.
+    def add_route(
+        self,
+        route=None,
+        endpoint=None,
+        *,
+        default=False,
+        static=True,
+        check_existing=True,
+        websocket=False,
+        before_request=False,
+    ):
+        """Adds a route to the API.
 
         :param route: A string representation of the route.
-        :param endpoint: The endpoint for the route -- can be a callable, a class, a WSGI application, or graphene schema (GraphQL).
-        :param check_existing: If ``True``, an AssertionError will be raised, if the route is already defined.
+        :param endpoint: The endpoint for the route -- can be a callable, or a class.
+        :param default: If ``True``, all unknown requests will route to this view.
+        :param static: If ``True``, and no endpoint was passed, render "static/index.html", and it will become a default route.
         """
-        if check_existing:
-            assert route not in self.routes
 
-        # TODO: Support grpahiql.
-        self.routes[route] = Route(route, endpoint)
+        # Path
+        if static:
+            assert self.static_dir is not None
+            if not endpoint:
+                endpoint = self._static_response
+                default = True
 
-    def default_response(self, req, resp):
-        resp.status_code = status_codes.HTTP_404
-        resp.text = "Not found."
+        self.router.add_route(
+            route,
+            endpoint,
+            default=default,
+            websocket=websocket,
+            before_request=before_request,
+            check_existing=check_existing,
+        )
 
-    def schema_response(self, req, resp):
-        resp.status_code = status_codes.HTTP_200
-        resp.headers["Content-Type"] = "application/x-yaml"
-        resp.content = self.openapi
+    async def _static_response(self, req, resp):
+        assert self.static_dir is not None
+
+        index = (self.static_dir / "index.html").resolve()
+        if os.path.exists(index):
+            with open(index, "r") as f:
+                resp.html = f.read()
+        else:
+            resp.status_code = status_codes.HTTP_404
+            resp.text = "Not found."
 
     def redirect(
         self, resp, location, *, set_text=True, status_code=status_codes.HTTP_301
     ):
         """Redirects a given response to a given location.
-
         :param resp: The Response to mutate.
         :param location: The location of the redirect.
         :param set_text: If ``True``, sets the Redirect body content automatically.
         :param status_code: an `API.status_codes` attribute, or an integer, representing the HTTP status code of the redirect.
         """
+        resp.redirect(location, set_text=set_text, status_code=status_code)
 
-        assert resp.status_code.is_300(status_code)
+    def on_event(self, event_type: str, **args):
+        """Decorator for registering functions or coroutines to run at certain events
+        Supported events: startup, shutdown
 
-        resp.status_code = status_code
-        if set_text:
-            resp.text = f"Redirecting to: {location}"
-        resp.headers.update({"Location": location})
+        Usage::
 
-    @staticmethod
-    async def _resolve_graphql_query(req):
-        if "json" in req.mimetype:
-            return (await req.media("json"))["query"]
+            @api.on_event('startup')
+            async def open_database_connection_pool():
+                ...
 
-        # Support query/q in form data.
-        # Form data is awaiting https://github.com/encode/starlette/pull/102
-        # if "query" in req.media("form"):
-        #     return req.media("form")["query"]
-        # if "q" in req.media("form"):
-        #     return req.media("form")["q"]
+            @api.on_event('shutdown')
+            async def close_database_connection_pool():
+                ...
 
-        # Support query/q in params.
-        if "query" in req.params:
-            return req.params["query"]
-        if "q" in req.params:
-            return req.params["q"]
+        """
 
-        # Otherwise, the request text is used (typical).
-        # TODO: Make some assertions about content-type here.
-        return req.text
+        def decorator(func):
+            self.add_event_handler(event_type, func, **args)
+            return func
 
-    async def graphql_response(self, req, resp, schema):
-        query = await self._resolve_graphql_query(req)
-        result = schema.execute(query)
-        result, status_code = encode_execution_results(
-            [result],
-            is_batch=False,
-            format_error=default_format_error,
-            encode=partial(json_encode, pretty=False),
-        )
-        resp.media = json.loads(result)
-        return (query, result, status_code)
+        return decorator
 
-    def route(self, route, **options):
+    def add_event_handler(self, event_type, handler):
+        """Adds an event handler to the API.
+
+        :param event_type: A string in ("startup", "shutdown")
+        :param handler: The function to run. Can be either a function or a coroutine.
+        """
+
+        self.router.add_event_handler(event_type, handler)
+
+    def route(self, route=None, **options):
         """Decorator for creating new routes around function and class definitions.
 
         Usage::
@@ -310,7 +287,7 @@ class API:
         :param route: String representation of the route to be used (shouldn't be parameterized).
         :param app: The other WSGI / ASGI app.
         """
-        self.apps.update({route: app})
+        self.router.apps.update({route: app})
 
     def session(self, base_url="http://;"):
         """Testing HTTP client. Returns a Requests session object, able to send HTTP requests to the Responder application.
@@ -319,89 +296,47 @@ class API:
         """
 
         if self._session is None:
-            self._session = TestClient(self)
+            self._session = TestClient(self, base_url=base_url)
         return self._session
 
-    def url_for(self, endpoint, testing=False, **params):
+    def url_for(self, endpoint, **params):
         # TODO: Absolute_url
         """Given an endpoint, returns a rendered URL for its route.
 
-        :param view: The route endpoint you're searching for.
+        :param endpoint: The route endpoint you're searching for.
         :param params: Data to pass into the URL generator (for parameterized URLs).
         """
-        for (route, route_object) in self.routes.items():
-            if route_object.endpoint == endpoint:
-                return route_object.url(testing=testing, **params)
-        raise ValueError
+        return self.router.url_for(endpoint, **params)
 
-    def static_url(self, asset):
-        """Given a static asset, return its URL path."""
-        return f"{self.static_route}/{str(asset)}"
-
-    def template(self, name, auto_escape=True, **values):
+    def template(self, filename, *args, **kwargs):
         """Renders the given `jinja2 <http://jinja.pocoo.org/docs/>`_ template, with provided values supplied.
-
-        Note: The current ``api`` instance is always passed into the view.
-
-        :param name: The filename of the jinja2 template, in ``templates_dir``.
-        :param auto_escape: If ``True``, HTML and XML will automatically be escaped.
-        :param values: Data to pass into the template.
+        Note: The current ``api`` instance is by default passed into the view. This is set in the dict ``api.jinja_values_base``.
+        :param filename: The filename of the jinja2 template, in ``templates_dir``.
+        :param *args: Data to pass into the template.
+        :param *kwargs: Date to pass into the template.
         """
-        # Give reference to self.
-        values.update(api=self)
+        return self.templates.render(filename, *args, **kwargs)
 
-        if auto_escape:
-            env = jinja2.Environment(
-                loader=jinja2.FileSystemLoader(
-                    str(self.templates_dir), followlinks=True
-                ),
-                autoescape=jinja2.select_autoescape(["html", "xml"]),
-            )
-        else:
-            env = jinja2.Environment(
-                loader=jinja2.FileSystemLoader(
-                    str(self.templates_dir), followlinks=True
-                ),
-                autoescape=jinja2.select_autoescape([]),
-            )
-
-        template = env.get_template(name)
-        return template.render(**values)
-
-    def template_string(self, s, auto_escape=True, **values):
+    def template_string(self, source, *args, **kwargs):
         """Renders the given `jinja2 <http://jinja.pocoo.org/docs/>`_ template string, with provided values supplied.
-
-        Note: The current ``api`` instance is always passed into the view.
-
-        :param s: The template to use.
-        :param auto_escape: If ``True``, HTML and XML will automatically be escaped.
-        :param values: Data to pass into the template.
+        Note: The current ``api`` instance is by default passed into the view. This is set in the dict ``api.jinja_values_base``.
+        :param source: The template to use.
+        :param *args: Data to pass into the template.
+        :param **kwargs: Data to pass into the template.
         """
-        # Give reference to self.
-        values.update(api=self)
+        return self.templates.render_string(source, *args, **kwargs)
 
-        if auto_escape:
-            env = jinja2.Environment(
-                loader=jinja2.BaseLoader,
-                autoescape=jinja2.select_autoescape(["html", "xml"]),
-            )
-        else:
-            env = jinja2.Environment(
-                loader=jinja2.BaseLoader, autoescape=jinja2.select_autoescape([])
-            )
-
-        template = env.from_string(s)
-        return template.render(**values)
-
-    def run(self, address=None, port=None, **options):
+    def serve(self, *, address=None, port=None, debug=False, **options):
         """Runs the application with uvicorn. If the ``PORT`` environment
         variable is set, requests will be served on that port automatically to all
         known hosts.
 
         :param address: The address to bind to.
         :param port: The port to bind to. If none is provided, one will be selected at random.
+        :param debug: Run uvicorn server in debug mode.
         :param options: Additional keyword arguments to send to ``uvicorn.run()``.
         """
+
         if "PORT" in os.environ:
             if address is None:
                 address = "0.0.0.0"
@@ -412,4 +347,15 @@ class API:
         if port is None:
             port = 5042
 
-        uvicorn.run(self, host=address, port=port, **options)
+        def spawn():
+            uvicorn.run(self, host=address, port=port, debug=debug, **options)
+
+        spawn()
+
+    def run(self, **kwargs):
+        if "debug" not in kwargs:
+            kwargs.update({"debug": self.debug})
+        self.serve(**kwargs)
+
+    async def __call__(self, scope, receive, send):
+        await self.app(scope, receive, send)

responder/background.py

@@ -1,5 +1,9 @@
-import multiprocessing
+import asyncio
+import functools
 import concurrent.futures
+import multiprocessing
+import traceback
+from starlette.concurrency import run_in_threadpool
 
 
 class BackgroundQueue:
@@ -20,8 +24,21 @@ class BackgroundQueue:
         return f
 
     def task(self, f):
+        def on_future_done(fs):
+            try:
+                fs.result()
+            except:
+                traceback.print_exc()
+
         def do_task(*args, **kwargs):
             result = self.run(f, *args, **kwargs)
+            result.add_done_callback(on_future_done)
             return result
 
         return do_task
+
+    async def __call__(self, func, *args, **kwargs) -> None:
+        if asyncio.iscoroutinefunction(func):
+            return await asyncio.ensure_future(func(*args, **kwargs))
+        else:
+            return await run_in_threadpool(func, *args, **kwargs)

responder/cli.py

@@ -0,0 +1,43 @@
+"""Responder.
+
+Usage:
+  responder
+  responder run [--build] [--debug] <module>
+  responder build
+  responder --version
+
+Options:
+  -h --help     Show this screen.
+  -v --version  Show version.
+
+"""
+
+import os
+
+import docopt
+from .__version__ import __version__
+
+
+def cli():
+    args = docopt.docopt(
+        __doc__, argv=None, help=True, version=__version__, options_first=False
+    )
+
+    module = args["<module>"]
+    build = args["build"] or args["--build"]
+    run = args["run"]
+
+    if build:
+        os.system("npm run build")
+
+    if run:
+        split_module = module.split(":")
+
+        if len(split_module) > 1:
+            module = split_module[0]
+            prop = split_module[1]
+        else:
+            prop = "api"
+
+        app = __import__(module)
+        getattr(app, prop).run()

responder/core.py

@@ -1,2 +1,3 @@
 from .api import API
 from .models import Request, Response
+from .cli import cli

responder/ext/__init__.py

@@ -0,0 +1 @@
+from .graphql import GraphQLView

responder/ext/graphql/__init__.py

@@ -0,0 +1,70 @@
+import json
+from functools import partial
+
+from graphql_server import default_format_error, encode_execution_results, json_encode
+
+from .templates import GRAPHIQL
+
+
+class GraphQLView:
+    def __init__(self, *, api, schema):
+        self.api = api
+        self.schema = schema
+
+    @staticmethod
+    async def _resolve_graphql_query(req):
+        # TODO: Get variables and operation_name from form data, params, request text?
+
+        if "json" in req.mimetype:
+            json_media = await req.media("json")
+            return (
+                json_media["query"],
+                json_media.get("variables"),
+                json_media.get("operationName"),
+            )
+
+        # Support query/q in form data.
+        # Form data is awaiting https://github.com/encode/starlette/pull/102
+        # if "query" in req.media("form"):
+        #     return req.media("form")["query"], None, None
+        # if "q" in req.media("form"):
+        #     return req.media("form")["q"], None, None
+
+        # Support query/q in params.
+        if "query" in req.params:
+            return req.params["query"], None, None
+        if "q" in req.params:
+            return req.params["q"], None, None
+
+        # Otherwise, the request text is used (typical).
+        # TODO: Make some assertions about content-type here.
+        return req.text, None, None
+
+    async def graphql_response(self, req, resp, schema):
+        show_graphiql = req.method == "get" and req.accepts("text/html")
+
+        if show_graphiql:
+            resp.content = self.api.templates.render_string(
+                GRAPHIQL, endpoint=req.url.path
+            )
+            return
+
+        query, variables, operation_name = await self._resolve_graphql_query(req)
+        context = {"request": req, "response": resp}
+        result = schema.execute(
+            query, variables=variables, operation_name=operation_name, context=context
+        )
+        result, status_code = encode_execution_results(
+            [result],
+            is_batch=False,
+            format_error=default_format_error,
+            encode=partial(json_encode, pretty=False),
+        )
+        resp.media = json.loads(result)
+        return (query, result, status_code)
+
+    async def on_request(self, req, resp):
+        await self.graphql_response(req, resp, self.schema)
+
+    async def __call__(self, req, resp):
+        await self.on_request(req, resp)

responder/ext/graphql/templates.py

@@ -0,0 +1,145 @@
+GRAPHIQL = """
+{% set GRAPHIQL_VERSION = '0.12.0' %}
+
+<!--
+ *  Copyright (c) Facebook, Inc.
+ *  All rights reserved.
+ *
+ *  This source code is licensed under the license found in the
+ *  LICENSE file in the root directory of this source tree.
+-->
+<!DOCTYPE html>
+<html>
+  <head>
+    <style>
+      body {
+        height: 100%;
+        margin: 0;
+        width: 100%;
+        overflow: hidden;
+      }
+      #graphiql {
+        height: 100vh;
+      }
+    </style>
+
+    <!--
+      This GraphiQL example depends on Promise and fetch, which are available in
+      modern browsers, but can be "polyfilled" for older browsers.
+      GraphiQL itself depends on React DOM.
+      If you do not want to rely on a CDN, you can host these files locally or
+      include them directly in your favored resource bunder.
+    -->
+    <link href="//cdn.jsdelivr.net/npm/graphiql@{{ GRAPHIQL_VERSION }}/graphiql.css" rel="stylesheet"/>
+    <script src="//cdn.jsdelivr.net/npm/whatwg-fetch@2.0.3/fetch.min.js"></script>
+    <script src="//cdn.jsdelivr.net/npm/react@16.2.0/umd/react.production.min.js"></script>
+    <script src="//cdn.jsdelivr.net/npm/react-dom@16.2.0/umd/react-dom.production.min.js"></script>
+    <script src="//cdn.jsdelivr.net/npm/graphiql@{{ GRAPHIQL_VERSION }}/graphiql.min.js"></script>
+  </head>
+  <body>
+    <div id="graphiql">Loading...</div>
+    <script>
+
+      /**
+       * This GraphiQL example illustrates how to use some of GraphiQL's props
+       * in order to enable reading and updating the URL parameters, making
+       * link sharing of queries a little bit easier.
+       *
+       * This is only one example of this kind of feature, GraphiQL exposes
+       * various React params to enable interesting integrations.
+       */
+
+      // Parse the search string to get url parameters.
+      var search = window.location.search;
+      var parameters = {};
+      search.substr(1).split('&').forEach(function (entry) {
+        var eq = entry.indexOf('=');
+        if (eq >= 0) {
+          parameters[decodeURIComponent(entry.slice(0, eq))] =
+            decodeURIComponent(entry.slice(eq + 1));
+        }
+      });
+
+      // if variables was provided, try to format it.
+      if (parameters.variables) {
+        try {
+          parameters.variables =
+            JSON.stringify(JSON.parse(parameters.variables), null, 2);
+        } catch (e) {
+          // Do nothing, we want to display the invalid JSON as a string, rather
+          // than present an error.
+        }
+      }
+
+      // When the query and variables string is edited, update the URL bar so
+      // that it can be easily shared
+      function onEditQuery(newQuery) {
+        parameters.query = newQuery;
+        updateURL();
+      }
+
+      function onEditVariables(newVariables) {
+        parameters.variables = newVariables;
+        updateURL();
+      }
+
+      function onEditOperationName(newOperationName) {
+        parameters.operationName = newOperationName;
+        updateURL();
+      }
+
+      function updateURL() {
+        var newSearch = '?' + Object.keys(parameters).filter(function (key) {
+          return Boolean(parameters[key]);
+        }).map(function (key) {
+          return encodeURIComponent(key) + '=' +
+            encodeURIComponent(parameters[key]);
+        }).join('&');
+        history.replaceState(null, null, newSearch);
+      }
+
+      // Defines a GraphQL fetcher using the fetch API. You're not required to
+      // use fetch, and could instead implement graphQLFetcher however you like,
+      // as long as it returns a Promise or Observable.
+      function graphQLFetcher(graphQLParams) {
+        // This example expects a GraphQL server at the path /graphql.
+        // Change this to point wherever you host your GraphQL server.
+        return fetch('{{ endpoint }}', {
+          method: 'post',
+          headers: {
+            'Accept': 'application/json',
+            'Content-Type': 'application/json',
+          },
+          body: JSON.stringify(graphQLParams),
+          credentials: 'include',
+        }).then(function (response) {
+          return response.text();
+        }).then(function (responseBody) {
+          try {
+            return JSON.parse(responseBody);
+          } catch (error) {
+            return responseBody;
+          }
+        });
+      }
+
+      // Render <GraphiQL /> into the body.
+      // See the README in the top level of this module to learn more about
+      // how you can customize GraphiQL by providing different values or
+      // additional child elements.
+      ReactDOM.render(
+        React.createElement(GraphiQL, {
+          fetcher: graphQLFetcher,
+          query: parameters.query,
+          variables: parameters.variables,
+          operationName: parameters.operationName,
+          onEditQuery: onEditQuery,
+          onEditVariables: onEditVariables,
+          onEditOperationName: onEditOperationName
+        }),
+        document.getElementById('graphiql')
+      );
+    </script>
+  </body>
+</html>
+""".strip()

responder/ext/schema/__init__.py

@@ -0,0 +1,160 @@
+import os
+from pathlib import Path
+
+import apistar
+import jinja2
+import yaml
+from apispec import APISpec, yaml_utils
+from apispec.ext.marshmallow import MarshmallowPlugin
+
+from responder.statics import DEFAULT_API_THEME
+from responder.staticfiles import StaticFiles
+from responder import status_codes
+
+
+class Schema:
+    def __init__(
+        self,
+        app,
+        title,
+        version,
+        plugins=None,
+        description=None,
+        terms_of_service=None,
+        contact=None,
+        license=None,
+        openapi=None,
+        openapi_route="/schema.yml",
+        docs_route="/docs/",
+        static_route="/static",
+    ):
+        self.app = app
+        self.schemas = {}
+        self.title = title
+        self.version = version
+        self.description = description
+        self.terms_of_service = terms_of_service
+        self.contact = contact
+        self.license = license
+
+        self.openapi_version = openapi
+        self.openapi_route = openapi_route
+
+        self.docs_theme = DEFAULT_API_THEME
+        self.docs_route = docs_route
+
+        self.plugins = [MarshmallowPlugin()] if plugins is None else plugins
+
+        if self.openapi_version is not None:
+            self.app.add_route(self.openapi_route, self.schema_response)
+
+        if self.docs_route is not None:
+            self.app.add_route(self.docs_route, self.docs_response)
+
+        theme_path = (
+            Path(apistar.__file__).parent / "themes" / self.docs_theme / "static"
+        ).resolve()
+
+        self.static_route = static_route
+
+        self.app.static_app.add_directory(theme_path)
+
+    @property
+    def _apispec(self):
+
+        info = {}
+        if self.description is not None:
+            info["description"] = self.description
+        if self.terms_of_service is not None:
+            info["termsOfService"] = self.terms_of_service
+        if self.contact is not None:
+            info["contact"] = self.contact
+        if self.license is not None:
+            info["license"] = self.license
+
+        spec = APISpec(
+            title=self.title,
+            version=self.version,
+            openapi_version=self.openapi_version,
+            plugins=self.plugins,
+            info=info,
+        )
+
+        for route in self.app.router.routes:
+            if route.description:
+                operations = yaml_utils.load_operations_from_docstring(
+                    route.description
+                )
+                spec.path(path=route.route, operations=operations)
+
+        for name, schema in self.schemas.items():
+            spec.components.schema(name, schema=schema)
+
+        return spec
+
+    @property
+    def openapi(self):
+        return self._apispec.to_yaml()
+
+    def add_schema(self, name, schema, check_existing=True):
+        """Adds a marshmallow schema to the API specification."""
+        if check_existing:
+            assert name not in self.schemas
+
+        self.schemas[name] = schema
+
+    def schema(self, name, **options):
+        """Decorator for creating new routes around function and class definitions.
+
+        Usage::
+
+            from marshmallow import Schema, fields
+
+            @api.schema("Pet")
+            class PetSchema(Schema):
+                name = fields.Str()
+
+        """
+
+        def decorator(f):
+            self.add_schema(name=name, schema=f, **options)
+            return f
+
+        return decorator
+
+    @property
+    def docs(self):
+
+        loader = jinja2.PrefixLoader(
+            {
+                self.docs_theme: jinja2.PackageLoader(
+                    "apistar", os.path.join("themes", self.docs_theme, "templates")
+                )
+            }
+        )
+        env = jinja2.Environment(autoescape=True, loader=loader)
+        document = apistar.document.Document()
+        document.content = yaml.safe_load(self.openapi)
+
+        template = env.get_template("/".join([self.docs_theme, "index.html"]))
+
+        return template.render(
+            document=document,
+            langs=["javascript", "python"],
+            code_style=None,
+            static_url=self.static_url,
+            schema_url="/schema.yml",
+        )
+
+    def static_url(self, asset):
+        """Given a static asset, return its URL path."""
+        assert self.static_route is not None
+        return f"{self.static_route}/{str(asset)}"
+
+    def docs_response(self, req, resp):
+        resp.html = self.docs
+
+    def schema_response(self, req, resp):
+        resp.status_code = status_codes.HTTP_200
+        resp.headers["Content-Type"] = "application/x-yaml"
+        resp.content = self.openapi

responder/formats.py

@@ -1,10 +1,33 @@
-import yaml
 import json
+from urllib.parse import urlencode
+
+import yaml
+from requests_toolbelt.multipart import decoder
+
+from .models import QueryDict
 
 
 async def format_form(r, encode=False):
-    if not encode:
-        return await r._starlette.form()
+    if encode:
+        pass
+    elif "multipart/form-data" in r.headers.get("Content-Type"):
+        decode = decoder.MultipartDecoder(await r.content, r.mimetype)
+        querys = list()
+        for part in decode.parts:
+            header = part.headers.get(b"Content-Disposition").decode("utf-8")
+            text = part.text
+
+            for section in [h.strip() for h in header.split(";")]:
+                split = section.split("=")
+                if len(split) > 1:
+                    key = split[1]
+                    key = key[1:-1]
+                    querys.append((key, text))
+
+        content = urlencode(querys)
+        return QueryDict(content)
+    else:
+        return QueryDict(await r.text)
 
 
 async def format_yaml(r, encode=False):
@@ -23,5 +46,45 @@ async def format_json(r, encode=False):
         return json.loads(await r.content)
 
 
+async def format_files(r, encode=False):
+    if encode:
+        pass
+    else:
+        decoded = decoder.MultipartDecoder(await r.content, r.mimetype)
+        dump = {}
+        for part in decoded.parts:
+            header = part.headers[b"Content-Disposition"].decode("utf-8")
+            mimetype = part.headers.get(b"Content-Type", None)
+            filename = None
+
+            for section in [h.strip() for h in header.split(";")]:
+                split = section.split("=")
+                if len(split) > 1:
+                    key = split[0]
+                    value = split[1]
+
+                    value = value[1:-1]
+
+                    if key == "filename":
+                        filename = value
+                    elif key == "name":
+                        formname = value
+
+            if mimetype is None:
+                dump[formname] = part.content
+            else:
+                dump[formname] = {
+                    "filename": filename,
+                    "content": part.content,
+                    "content-type": mimetype.decode("utf-8"),
+                }
+        return dump
+
+
 def get_formats():
-    return {"json": format_json, "yaml": format_yaml, "form": format_form}
+    return {
+        "json": format_json,
+        "yaml": format_yaml,
+        "form": format_form,
+        "files": format_files,
+    }

responder/models.py

@@ -1,20 +1,28 @@
+import functools
 import io
+import inspect
 import json
 import gzip
+from urllib.parse import parse_qs
+from base64 import b64decode
+from http.cookies import SimpleCookie
 
 import chardet
 import rfc3986
 import graphene
 import yaml
+
 from requests.structures import CaseInsensitiveDict
+from requests.cookies import RequestsCookieJar
+
 from starlette.datastructures import MutableHeaders
-from starlette.requests import Request as StarletteRequest
-from starlette.responses import Response as StarletteResponse
+from starlette.requests import Request as StarletteRequest, State
+from starlette.responses import (
+    Response as StarletteResponse,
+    StreamingResponse as StarletteStreamingResponse,
+)
 
-
-from urllib.parse import parse_qs
-
-from .status_codes import HTTP_200
+from .status_codes import HTTP_200, HTTP_301
 from .statics import DEFAULT_ENCODING
 
 
@@ -86,50 +94,95 @@ class QueryDict(dict):
         yield from super().items()
 
 
-# TODO: add slots
 class Request:
     __slots__ = [
         "_starlette",
         "formats",
-        "headers",
-        "mimetype",
-        "method",
-        "full_url",
-        "url",
-        "params",
+        "_headers",
         "_encoding",
+        "api",
+        "_content",
+        "_cookies",
     ]
 
-    def __init__(self, scope, receive):
+    def __init__(self, scope, receive, api=None, formats=None):
         self._starlette = StarletteRequest(scope, receive)
-        self.formats = None
+        self.formats = formats
         self._encoding = None
+        self.api = api
+        self._content = None
 
         headers = CaseInsensitiveDict()
-        for header, value in self._starlette.headers.items():
-            headers[header] = value
+        for key, value in self._starlette.headers.items():
+            headers[key] = value
 
-        self.headers = (
-            headers
-        )  #: A case-insensitive dictionary, containing all headers sent in the Request.
+        self._headers = headers
+        self._cookies = None
 
-        self.mimetype = self.headers.get("Content-Type", "")
+    @property
+    def session(self):
+        """The session data, in dict form, from the Request."""
+        return self._starlette.session
 
-        self.method = (
-            self._starlette.method.lower()
-        )  #: The incoming HTTP method used for the request, lower-cased.
+    @property
+    def headers(self):
+        """A case-insensitive dictionary, containing all headers sent in the Request."""
+        return self._headers
 
-        self.full_url = str(
-            self._starlette.url
-        )  #: The full URL of the Request, query parameters and all.
+    @property
+    def mimetype(self):
+        return self.headers.get("Content-Type", "")
 
-        self.url = rfc3986.urlparse(self.full_url)  #: The parsed URL of the Request
+    @property
+    def method(self):
+        """The incoming HTTP method used for the request, lower-cased."""
+        return self._starlette.method.lower()
+
+    @property
+    def full_url(self):
+        """The full URL of the Request, query parameters and all."""
+        return str(self._starlette.url)
+
+    @property
+    def url(self):
+        """The parsed URL of the Request."""
+        return rfc3986.urlparse(self.full_url)
+
+    @property
+    def cookies(self):
+        """The cookies sent in the Request, as a dictionary."""
+        if self._cookies is None:
+            cookies = RequestsCookieJar()
+            cookie_header = self.headers.get("Cookie", "")
+
+            bc = SimpleCookie(cookie_header)
+            for key, morsel in bc.items():
+                cookies[key] = morsel.value
+
+            self._cookies = cookies.get_dict()
+
+        return self._cookies
+
+    @property
+    def params(self):
+        """A dictionary of the parsed query parameters used for the Request."""
         try:
-            self.params = QueryDict(
-                self.url.query
-            )  #: A dictionary of the parsed query parameters used for the Request.
+            return QueryDict(self.url.query)
         except AttributeError:
-            self.params = {}
+            return QueryDict({})
+
+    @property
+    def state(self) -> State:
+        """
+        Use the state to store additional information.
+
+        This can be a very helpful feature, if you want to hand over
+        information from a middelware or a route decorator to the
+        actual route handler.
+
+        Usage: ``request.state.time_started = time.time()``
+        """
+        return self._starlette.state
 
     @property
     async def encoding(self):
@@ -138,13 +191,7 @@ class Request:
         if self._encoding:
             return self._encoding
 
-        # Then try what's defined by the Request.
-        elif await self.declared_encoding:
-            return self.declared_encoding
-
-        # Then, automatically detect the encoding.
-        else:
-            return await self.apparent_encoding
+        return await self.apparent_encoding
 
     @encoding.setter
     def encoding(self, value):
@@ -153,12 +200,14 @@ class Request:
     @property
     async def content(self):
         """The Request body, as bytes. Must be awaited."""
-        return await self._starlette.body()
+        if not self._content:
+            self._content = await self._starlette.body()
+        return self._content
 
     @property
     async def text(self):
         """The Request body, as unicode. Must be awaited."""
-        return (await self._starlette.body()).decode(await self.encoding)
+        return (await self.content).decode(await self.encoding)
 
     @property
     async def declared_encoding(self):
@@ -172,8 +221,8 @@ class Request:
 
         if declared_encoding:
             return declared_encoding
-        else:
-            return chardet.detect(await self.content)["encoding"]
+
+        return chardet.detect(await self.content)["encoding"] or DEFAULT_ENCODING
 
     @property
     def is_secure(self):
@@ -184,7 +233,7 @@ class Request:
         return content_type in self.headers.get("Accept", [])
 
     async def media(self, format=None):
-        """Renders incoming json/yaml/form data as Python objects.
+        """Renders incoming json/yaml/form data as Python objects. Must be awaited.
 
         :param format: The name of the format being used. Alternatively accepts a custom callable for the format type.
         """
@@ -199,39 +248,80 @@ class Request:
             return await format(self)
 
 
+def content_setter(mimetype):
+    def getter(instance):
+        return instance.content
+
+    def setter(instance, value):
+        instance.content = value
+        instance.mimetype = mimetype
+
+    return property(fget=getter, fset=setter)
+
+
 class Response:
     __slots__ = [
         "req",
         "status_code",
-        "text",
         "content",
         "encoding",
         "media",
         "headers",
         "formats",
+        "cookies",
+        "session",
+        "mimetype",
+        "_stream",
     ]
 
+    text = content_setter("text/plain")
+    html = content_setter("text/html")
+
     def __init__(self, req, *, formats):
         self.req = req
-        self.status_code = HTTP_200  #: The HTTP Status Code to use for the Response.
-        self.text = None  #: A unicode representation of the response body.
+        self.status_code = None  #: The HTTP Status Code to use for the Response.
         self.content = None  #: A bytes representation of the response body.
+        self.mimetype = None
         self.encoding = DEFAULT_ENCODING
-        self.media = (
-            None
-        )  #: A Python object that will be content-negotiated and sent back to the client. Typically, in JSON formatting.
+        self.media = None  #: A Python object that will be content-negotiated and sent back to the client. Typically, in JSON formatting.
+        self._stream = None
         self.headers = (
             {}
-        )  #: A Python dictionary of {Key: value}, representing the headers of the response.
+        )  #: A Python dictionary of ``{key: value}``, representing the headers of the response.
         self.formats = formats
+        self.cookies = SimpleCookie()  #: The cookies set in the Response
+        self.session = (
+            req.session
+        )  #: The cookie-based session data, in dict form, to add to the Response.
+
+    # Property or func/dec
+    def stream(self, func, *args, **kwargs):
+        assert inspect.isasyncgenfunction(func)
+
+        self._stream = functools.partial(func, *args, **kwargs)
+
+        return func
+
+    def redirect(self, location, *, set_text=True, status_code=HTTP_301):
+        self.status_code = status_code
+        if set_text:
+            self.text = f"Redirecting to: {location}"
+        self.headers.update({"Location": location})
 
     @property
     async def body(self):
-        if self.content:
-            return (self.content, {})
+        if self._stream is not None:
+            return (self._stream(), {})
 
-        if self.text:
-            return (self.text.encode(self.encoding), {"Encoding": self.encoding})
+        if self.content is not None:
+            headers = {}
+            content = self.content
+            if self.mimetype is not None:
+                headers["Content-Type"] = self.mimetype
+            if self.mimetype == "text/plain" and self.encoding is not None:
+                headers["Encoding"] = self.encoding
+                content = content.encode(self.encoding)
+            return (content, headers)
 
         for format in self.formats:
             if self.req.accepts(format):
@@ -243,44 +333,48 @@ class Response:
             {"Content-Type": "application/json"},
         )
 
-    @property
-    async def gzipped_body(self):
+    def set_cookie(
+        self,
+        key,
+        value="",
+        expires=None,
+        path="/",
+        domain=None,
+        max_age=None,
+        secure=False,
+        httponly=True,
+    ):
+        self.cookies[key] = value
+        morsel = self.cookies[key]
+        if expires is not None:
+            morsel["expires"] = expires
+        if path is not None:
+            morsel["path"] = path
+        if domain is not None:
+            morsel["domain"] = domain
+        if max_age is not None:
+            morsel["max-age"] = max_age
+        morsel["secure"] = secure
+        morsel["httponly"] = httponly
 
+    def _prepare_cookies(self, starlette_response):
+        cookie_header = (
+            (b"set-cookie", morsel.output(header="").lstrip().encode("latin-1"))
+            for morsel in self.cookies.values()
+        )
+        starlette_response.raw_headers.extend(cookie_header)
+
+    async def __call__(self, scope, receive, send):
         body, headers = await self.body
-
-        if isinstance(body, str):
-            body = body.encode(self.encoding)
-
-        if "gzip" in self.req.headers["Accept-Encoding"].lower():
-            gzip_buffer = io.BytesIO()
-            gzip_file = gzip.GzipFile(mode="wb", fileobj=gzip_buffer)
-            gzip_file.write(body)
-            gzip_file.close()
-
-            new_headers = {
-                "Content-Encoding": "gzip",
-                "Vary": "Accept-Encoding",
-                "Content-Length": str(len(body)),
-            }
-            headers.update(new_headers)
-
-            return (gzip_buffer.getvalue(), headers)
-        else:
-            return (body, headers)
-
-    async def __call__(self, receive, send):
-        body, headers = await self.body
-        if len(await self.body) > 500:
-            body, headers = await self.gzipped_body
         if self.headers:
             headers.update(self.headers)
 
-        response = StarletteResponse(
-            body, status_code=self.status_code, headers=headers
-        )
-        await response(receive, send)
+        if self._stream is not None:
+            response_cls = StarletteStreamingResponse
+        else:
+            response_cls = StarletteResponse
 
+        response = response_cls(body, status_code=self.status_code, headers=headers)
+        self._prepare_cookies(response)
 
-class Schema(graphene.Schema):
-    def on_request(self, req, resp):
-        pass
+        await response(scope, receive, send)

responder/routes.py

@@ -1,57 +1,358 @@
-from parse import parse, search
+import asyncio
+import json
+import re
+import inspect
+import traceback
+from collections import defaultdict
+
+from starlette.middleware.wsgi import WSGIMiddleware
+from starlette.websockets import WebSocket, WebSocketClose
+from starlette.concurrency import run_in_threadpool
+from starlette.exceptions import HTTPException
+
+from .models import Request, Response
+from . import status_codes
+from .formats import get_formats
+from .statics import DEFAULT_SESSION_COOKIE
 
 
-def memoize(f):
-    def helper(self, s):
-        memoize_key = f"{f.__name__}:{s}"
-        if memoize_key not in self._memo:
-            self._memo[memoize_key] = f(self, s)
-        return self._memo[memoize_key]
+_CONVERTORS = {
+    "int": (int, r"\d+"),
+    "str": (str, r"[^/]+"),
+    "float": (float, r"\d+(.\d+)?"),
+}
 
-    return helper
+PARAM_RE = re.compile("{([a-zA-Z_][a-zA-Z0-9_]*)(:[a-zA-Z_][a-zA-Z0-9_]*)?}")
 
 
-class Route:
-    def __init__(self, route, endpoint):
+def compile_path(path):
+    path_re = "^"
+    param_convertors = {}
+    idx = 0
+
+    for match in PARAM_RE.finditer(path):
+        param_name, convertor_type = match.groups(default="str")
+        convertor_type = convertor_type.lstrip(":")
+        assert (
+            convertor_type in _CONVERTORS.keys()
+        ), f"Unknown path convertor '{convertor_type}'"
+        convertor, convertor_re = _CONVERTORS[convertor_type]
+
+        path_re += path[idx : match.start()]
+        path_re += rf"(?P<{param_name}>{convertor_re})"
+
+        param_convertors[param_name] = convertor
+
+        idx = match.end()
+
+    path_re += path[idx:] + "$"
+
+    return re.compile(path_re), param_convertors
+
+
+class BaseRoute:
+    def matches(self, scope):
+        raise NotImplementedError()
+
+    async def __call__(self, scope, receive, send):
+        raise NotImplementedError()
+
+
+class Route(BaseRoute):
+    def __init__(self, route, endpoint, *, before_request=False):
+        assert route.startswith("/"), "Route path must start with '/'"
         self.route = route
         self.endpoint = endpoint
-        self._memo = {}
+        self.before_request = before_request
+
+        self.path_re, self.param_convertors = compile_path(route)
 
     def __repr__(self):
         return f"<Route {self.route!r}={self.endpoint!r}>"
 
-    def __eq__(self, other):
-        if hasattr(other, "route"):
-            # Being compared to other routes.
-            return self.route == other.route
-        else:
-            # Strings.
-            return self.does_match(other)
+    def url(self, **params):
+        return self.route.format(**params)
+
+    @property
+    def endpoint_name(self):
+        return self.endpoint.__name__
 
     @property
     def description(self):
         return self.endpoint.__doc__
 
+    def matches(self, scope):
+        if scope["type"] != "http":
+            return False, {}
+
+        path = scope["path"]
+        match = self.path_re.match(path)
+
+        if match is None:
+            return False, {}
+
+        matched_params = match.groupdict()
+        for key, value in matched_params.items():
+            matched_params[key] = self.param_convertors[key](value)
+
+        return True, {"path_params": {**matched_params}}
+
+    async def __call__(self, scope, receive, send):
+        request = Request(scope, receive, formats=get_formats())
+        response = Response(req=request, formats=get_formats())
+
+        path_params = scope.get("path_params", {})
+        before_requests = scope.get("before_requests", [])
+
+        for before_request in before_requests.get("http", []):
+            if asyncio.iscoroutinefunction(before_request):
+                await before_request(request, response)
+            else:
+                await run_in_threadpool(before_request, request, response)
+
+        views = []
+
+        if inspect.isclass(self.endpoint):
+            endpoint = self.endpoint()
+            on_request = getattr(endpoint, "on_request", None)
+            if on_request:
+                views.append(on_request)
+
+            method_name = f"on_{request.method}"
+            try:
+                view = getattr(endpoint, method_name)
+                views.append(view)
+            except AttributeError:
+                if on_request is None:
+                    raise HTTPException(status_code=status_codes.HTTP_405)
+        else:
+            views.append(self.endpoint)
+
+        for view in views:
+            # "Monckey patch" for graphql: explicitly checking __call__
+            if asyncio.iscoroutinefunction(view) or asyncio.iscoroutinefunction(
+                view.__call__
+            ):
+                await view(request, response, **path_params)
+            else:
+                await run_in_threadpool(view, request, response, **path_params)
+
+        if response.status_code is None:
+            response.status_code = status_codes.HTTP_200
+
+        await response(scope, receive, send)
+
+    def __eq__(self, other):
+        # [TODO] compare to str ?
+        return self.route == other.route and self.endpoint == other.endpoint
+
+    def __hash__(self):
+        return hash(self.route) ^ hash(self.endpoint) ^ hash(self.before_request)
+
+
+class WebSocketRoute(BaseRoute):
+    def __init__(self, route, endpoint, *, before_request=False):
+        assert route.startswith("/"), "Route path must start with '/'"
+        self.route = route
+        self.endpoint = endpoint
+        self.before_request = before_request
+
+        self.path_re, self.param_convertors = compile_path(route)
+
+    def __repr__(self):
+        return f"<Route {self.route!r}={self.endpoint!r}>"
+
+    def url(self, **params):
+        return self.route.format(**params)
+
     @property
-    def has_parameters(self):
-        return all([("{" in self.route), ("}" in self.route)])
+    def endpoint_name(self):
+        return self.endpoint.__name__
 
-    @memoize
-    def does_match(self, s):
-        if s == self.route:
-            return True
+    @property
+    def description(self):
+        return self.endpoint.__doc__
 
-        named = self.incoming_matches(s)
-        return bool(len(named))
+    def matches(self, scope):
+        if scope["type"] != "websocket":
+            return False, {}
 
-    @memoize
-    def incoming_matches(self, s):
-        results = parse(self.route, s)
-        return results.named if results else {}
+        path = scope["path"]
+        match = self.path_re.match(path)
 
-    def url(self, testing=False, **params):
-        url = self.route.format(**params)
-        if testing:
-            url = f"http://;{url}"
+        if match is None:
+            return False, {}
 
-        return url
+        matched_params = match.groupdict()
+        for key, value in matched_params.items():
+            matched_params[key] = self.param_convertors[key](value)
+
+        return True, {"path_params": {**matched_params}}
+
+    async def __call__(self, scope, receive, send):
+        ws = WebSocket(scope, receive, send)
+
+        before_requests = scope.get("before_requests", [])
+        for before_request in before_requests.get("ws", []):
+            await before_request(ws)
+
+        await self.endpoint(ws)
+
+    def __eq__(self, other):
+        # [TODO] compare to str ?
+        return self.route == other.route and self.endpoint == other.endpoint
+
+    def __hash__(self):
+        return hash(self.route) ^ hash(self.endpoint) ^ hash(self.before_request)
+
+
+class Router:
+    def __init__(self, routes=None, default_response=None, before_requests=None):
+        self.routes = [] if routes is None else list(routes)
+        # [TODO] Make its own router
+        self.apps = {}
+        self.default_endpoint = (
+            self.default_response if default_response is None else default_response
+        )
+        self.before_requests = (
+            {"http": [], "ws": []} if before_requests is None else before_requests
+        )
+        self.events = defaultdict(list)
+
+    def add_route(
+        self,
+        route=None,
+        endpoint=None,
+        *,
+        default=False,
+        websocket=False,
+        before_request=False,
+        check_existing=False,
+    ):
+        """Adds a route to the router.
+        :param route: A string representation of the route
+        :param endpoint: The endpoint for the route -- can be callable, or class.
+        :param default: If ``True``, all unknown requests will route to this view.
+        """
+        if before_request:
+            if websocket:
+                self.before_requests.setdefault("ws", []).append(endpoint)
+            else:
+                self.before_requests.setdefault("http", []).append(endpoint)
+            return
+
+        if check_existing:
+            assert not self.routes or route not in (
+                item.route for item in self.routes
+            ), f"Route '{route}' already exists"
+
+        if default:
+            self.default_endpoint = endpoint
+
+        if websocket:
+            route = WebSocketRoute(route, endpoint)
+        else:
+            route = Route(route, endpoint)
+
+        self.routes.append(route)
+
+    def mount(self, route, app):
+        """Mounts ASGI / WSGI applications at a given route"""
+        self.apps.update(route, app)
+
+    def add_event_handler(self, event_type, handler):
+        assert event_type in (
+            "startup",
+            "shutdown",
+        ), f"Only 'startup' and 'shutdown' events are supported, not {event_type}."
+        self.events[event_type].append(handler)
+
+    async def trigger_event(self, event_type):
+        for handler in self.events.get(event_type, []):
+            if asyncio.iscoroutinefunction(handler):
+                await handler()
+            else:
+                handler()
+
+    def before_request(self, endpoint, websocket=False):
+        if websocket:
+            self.before_requests.setdefault("ws", []).append(endpoint)
+        else:
+            self.before_requests.setdefault("http", []).append(endpoint)
+
+    def url_for(self, endpoint, **params):
+        # TODO: Check for params
+        for route in self.routes:
+            if endpoint in (route.endpoint, route.endpoint.__name__):
+                return route.url(**params)
+        return None
+
+    async def default_response(self, scope, receive, send):
+        if scope["type"] == "websocket":
+            websocket_close = WebSocketClose()
+            await websocket_close(receive, send)
+            return
+
+        request = Request(scope, receive)
+        response = Response(request, formats=get_formats())
+
+        raise HTTPException(status_code=status_codes.HTTP_404)
+
+    def _resolve_route(self, scope):
+        for route in self.routes:
+            matches, child_scope = route.matches(scope)
+            if matches:
+                scope.update(child_scope)
+                return route
+        return None
+
+    async def lifespan(self, scope, receive, send):
+        message = await receive()
+        assert message["type"] == "lifespan.startup"
+
+        try:
+            await self.trigger_event("startup")
+        except BaseException:
+            msg = traceback.format_exc()
+            await send({"type": "lifespan.startup.failed", "message": msg})
+            raise
+
+        await send({"type": "lifespan.startup.complete"})
+        message = await receive()
+        assert message["type"] == "lifespan.shutdown"
+        await self.trigger_event("shutdown")
+        await send({"type": "lifespan.shutdown.complete"})
+
+    async def __call__(self, scope, receive, send):
+        assert scope["type"] in ("http", "websocket", "lifespan")
+
+        if scope["type"] == "lifespan":
+            await self.lifespan(scope, receive, send)
+            return
+
+        path = scope["path"]
+        root_path = scope.get("root_path", "")
+
+        # Check "primary" mounted routes first (before submounted apps)
+        route = self._resolve_route(scope)
+
+        scope["before_requests"] = self.before_requests
+
+        if route is not None:
+            await route(scope, receive, send)
+            return
+
+        # Call into a submounted app, if one exists.
+        for path_prefix, app in self.apps.items():
+            if path.startswith(path_prefix):
+                scope["path"] = path[len(path_prefix) :]
+                scope["root_path"] = root_path + path_prefix
+                try:
+                    await app(scope, receive, send)
+                    return
+                except TypeError:
+                    app = WSGIMiddleware(app)
+                    await app(scope, receive, send)
+                    return
+
+        await self.default_endpoint(scope, receive, send)

responder/staticfiles.py

@@ -0,0 +1,18 @@
+import typing
+
+from starlette.staticfiles import StaticFiles
+
+
+class StaticFiles(StaticFiles):
+    """I've created an issue to disccuss allowing multiple directories in starletter's `StaticFiles`.
+
+    https://github.com/encode/starlette/issues/625
+
+    I've also made a PR to add this method to starlette StaticFiles
+    Once accepted we will remove this.
+
+    https://github.com/encode/starlette/pull/626
+    """
+
+    def add_directory(self, directory: str) -> None:
+        self.all_directories = [*self.all_directories, *self.get_directories(directory)]

responder/statics.py

@@ -1 +1,14 @@
 DEFAULT_ENCODING = "utf-8"
+DEFAULT_API_THEME = "swaggerui"
+DEFAULT_SESSION_COOKIE = "Responder-Session"
+DEFAULT_SECRET_KEY = "NOTASECRET"
+
+DEFAULT_CORS_PARAMS = {
+    "allow_origins": (),
+    "allow_methods": ("GET",),
+    "allow_headers": (),
+    "allow_credentials": False,
+    "allow_origin_regex": None,
+    "expose_headers": (),
+    "max_age": 600,
+}

responder/templates.py

@@ -0,0 +1,59 @@
+from contextlib import contextmanager
+
+import jinja2
+
+
+class Templates:
+    def __init__(
+        self, directory="templates", autoescape=True, context=None, enable_async=False
+    ):
+        self.directory = directory
+        self._env = jinja2.Environment(
+            loader=jinja2.FileSystemLoader([str(self.directory)]),
+            autoescape=autoescape,
+            enable_async=enable_async,
+        )
+        self.default_context = {} if context is None else {**context}
+        self._env.globals.update(self.default_context)
+
+    @property
+    def context(self):
+        return self._env.globals
+
+    @context.setter
+    def context(self, context):
+        self._env.globals = {**self.default_context, **context}
+
+    def get_template(self, name):
+        return self._env.get_template(name)
+
+    def render(self, template, *args, **kwargs):
+        """Renders the given `jinja2 <http://jinja.pocoo.org/docs/>`_ template, with provided values supplied.
+
+        :param template: The filename of the jinja2 template.
+        :param **kwargs: Data to pass into the template.
+        :param **kwargs: Data to pass into the template.
+        """
+        return self.get_template(template).render(*args, **kwargs)
+
+    @contextmanager
+    def _async(self):
+        self._env.is_async = True
+        try:
+            yield
+        finally:
+            self._env.is_async = False
+
+    async def render_async(self, template, *args, **kwargs):
+        with self._async():
+            return await self.get_template(template).render_async(*args, **kwargs)
+
+    def render_string(self, source, *args, **kwargs):
+        """Renders the given `jinja2 <http://jinja.pocoo.org/docs/>`_ template string, with provided values supplied.
+
+        :param source: The template to use.
+        :param *args, **kwargs: Data to pass into the template.
+        :param **kwargs: Data to pass into the template.
+        """
+        template = self._env.from_string(source)
+        return template.render(*args, **kwargs)

setup.py

@@ -22,22 +22,24 @@ if sys.argv[-1] == "publish":
     sys.exit()
 
 required = [
-    "starlette",
-    "uvicorn",
+    "starlette==0.13.*",
+    "uvicorn>=0.11.7,<0.13",
     "aiofiles",
     "pyyaml",
     "requests",
-    "graphene",
+    "graphene<3.0",
     "graphql-server-core>=1.1",
     "jinja2",
-    "parse",
-    "uvloop ; sys_platform != 'win32'",
     "rfc3986",
     "python-multipart",
     "chardet",
     "apispec>=1.0.0b1",
     "marshmallow",
-    "asgiref",
+    "whitenoise",
+    "docopt",
+    "requests-toolbelt",
+    "apistar",
+    "itsdangerous",
 ]
 
 
@@ -65,7 +67,7 @@ class DebCommand(Command):
             rmtree(os.path.join(here, "deb_dist"))
         except FileNotFoundError:
             pass
-        self.status(u"Creating debian mainfest…")
+        self.status(u"Creating debian manifest…")
         os.system(
             "python setup.py --command-packages=stdeb.command sdist_dsc -z artful --package3=pipenv --depends3=python3-virtualenv-clone"
         )
@@ -117,24 +119,8 @@ setup(
     author_email="me@kennethreitz.org",
     url="https://github.com/kennethreitz/responder",
     packages=find_packages(exclude=["tests"]),
-    # entry_points={
-    #     "console_scripts": ["responder=responder:cli"]
-    # },
-    package_data={
-        # "": ["LICENSE", "NOTICES"],
-        #     "pipenv.vendor.requests": ["*.pem"],
-        #     "pipenv.vendor.certifi": ["*.pem"],
-        #     "pipenv.vendor.click_completion": ["*.j2"],
-        #     "pipenv.patched.notpip._vendor.certifi": ["*.pem"],
-        #     "pipenv.patched.notpip._vendor.requests": ["*.pem"],
-        #     "pipenv.patched.notpip._vendor.distlib._backport": ["sysconfig.cfg"],
-        #     "pipenv.patched.notpip._vendor.distlib": [
-        #         "t32.exe",
-        #         "t64.exe",
-        #         "w32.exe",
-        #         "w64.exe",
-        #     ],
-    },
+    entry_points={"console_scripts": ["responder=responder.cli:cli"]},
+    package_data={},
     python_requires=">=3.6",
     setup_requires=[],
     install_requires=required,
@@ -142,7 +128,7 @@ setup(
     include_package_data=True,
     license="Apache 2.0",
     classifiers=[
-        "License :: OSI Approved :: MIT License",
+        "License :: OSI Approved :: Apache Software License",
         "Programming Language :: Python",
         "Programming Language :: Python :: 3",
         "Programming Language :: Python :: 3.6",

templates/test.html

@@ -1,3 +0,0 @@
-this is a test
-
-{{ api.static_url('test') }}

tests/conftest.py

@@ -2,6 +2,8 @@ import graphene
 import responder
 from pathlib import Path
 import pytest
+import multiprocessing
+import concurrent.futures
 
 
 @pytest.fixture
@@ -16,12 +18,12 @@ def current_dir():
 
 @pytest.fixture
 def api():
-    return responder.API()
+    return responder.API(debug=False, allowed_hosts=[";"])
 
 
 @pytest.fixture
 def session(api):
-    return api.session()
+    return api.requests
 
 
 @pytest.fixture
@@ -54,3 +56,12 @@ def schema():
             return f"Hello {name}"
 
     return graphene.Schema(query=Query)
+
+
+@pytest.fixture
+def template_path(tmpdir):
+    # create a Jinja template file on the filesystem
+    template_name = "test.html"
+    template_file = tmpdir.mkdir("static").join(template_name)
+    template_file.write("{{ var }}")
+    return template_file

tests/test_encodings.py

@@ -22,15 +22,3 @@ def test_bytes_encoding(api, session):
 
     r = session.get(api.url_for(route), data=data)
     assert r.content == data
-
-
-def test_false_encoding_raises(api, session):
-    data = "hi mom!"
-
-    @api.route("/")
-    async def route(req, resp):
-        req.encoding = "non-existient"
-        resp.text = await req.text
-
-    with pytest.raises(LookupError):
-        session.get(api.url_for(route), data=data)

tests/test_routes.py

@@ -1,83 +0,0 @@
-import pytest
-from responder import routes
-
-
-@pytest.mark.parametrize(
-    "route, expected",
-    [
-        pytest.param("/", False, id="home path without params"),
-        pytest.param("/test_path", False, id="sub path without params"),
-        pytest.param("/{test_path}", True, id="path with params"),
-    ],
-)
-def test_parameter(route, expected):
-    r = routes.Route(route, "test_endpoint")
-    assert r.has_parameters is expected
-
-
-def test_url():
-    r = routes.Route("/{my_path}", "test_endpoint")
-    url = r.url(my_path="path")
-    assert url == "/path"
-
-
-def test_equal():
-    r = routes.Route("/{path_param}", "test_endpoint")
-    r2 = routes.Route("/{path_param}", "test_endpoint")
-    r3 = routes.Route("/test_path", "test_endpoint")
-
-    assert r == r2
-    assert r != r3
-
-
-@pytest.mark.parametrize(
-    "path_param, actual, match",
-    [
-        pytest.param(
-            "/{greetings}", "/hello", {"greetings": "hello"}, id="with one strformat"
-        ),
-        pytest.param(
-            "/{greetings}.{name}",
-            "/hi.jane",
-            {"greetings": "hi", "name": "jane"},
-            id="with dot in url and two strformat",
-        ),
-        pytest.param(
-            "/{greetings}/{name}",
-            "/hi/john",
-            {"greetings": "hi", "name": "john"},
-            id="with sub url and two strformat",
-        ),
-        pytest.param(
-            "/concrete_path", "/foo", {}, id="test concrete path with no match"
-        ),
-    ],
-)
-def test_incoming_matches(path_param, actual, match):
-    r = routes.Route(path_param, "test_endpoint")
-    assert r.incoming_matches(actual) == match
-
-
-def test_incoming_matches_with_concrete_path_no_match():
-    r = routes.Route("/concrete_path", "test_endpoint")
-    assert r.incoming_matches("hello") == {}
-
-
-@pytest.mark.parametrize(
-    "route, match, expected",
-    [
-        pytest.param(
-            "/{path_param}",
-            "/{path_param}",
-            True,
-            id="with both parametrized path match",
-        ),
-        pytest.param(
-            "/concrete", "/concrete", True, id="with both concrete path match"
-        ),
-        pytest.param("/concrete", "/no_match", False, id="with no match"),
-    ],
-)
-def test_does_match_with_route(route, match, expected):
-    r = routes.Route(route, "test_endpoint")
-    assert r.does_match(match) == expected

tests/test_status_codes.py

@@ -0,0 +1,67 @@
+import pytest
+from responder import status_codes
+
+
+@pytest.mark.parametrize(
+    "status_code, expected",
+    [
+        pytest.param(101, True, id="Normal 101"),
+        pytest.param(199, True, id="Not actual status code but within 100"),
+        pytest.param(0, False, id="Zero case (below 100)"),
+        pytest.param(200, False, id="Above 100"),
+    ],
+)
+def test_is_100(status_code, expected):
+    assert status_codes.is_100(status_code) is expected
+
+
+@pytest.mark.parametrize(
+    "status_code, expected",
+    [
+        pytest.param(201, True, id="Normal 201"),
+        pytest.param(299, True, id="Not actual status code but within 200"),
+        pytest.param(0, False, id="Zero case (below 200)"),
+        pytest.param(300, False, id="Above 200"),
+    ],
+)
+def test_is_200(status_code, expected):
+    assert status_codes.is_200(status_code) is expected
+
+
+@pytest.mark.parametrize(
+    "status_code, expected",
+    [
+        pytest.param(301, True, id="Normal 301"),
+        pytest.param(399, True, id="Not actual status code but within 300"),
+        pytest.param(0, False, id="Zero case (below 300)"),
+        pytest.param(400, False, id="Above 300"),
+    ],
+)
+def test_is_300(status_code, expected):
+    assert status_codes.is_300(status_code) is expected
+
+
+@pytest.mark.parametrize(
+    "status_code, expected",
+    [
+        pytest.param(401, True, id="Normal 401"),
+        pytest.param(499, True, id="Not actual status code but within 400"),
+        pytest.param(0, False, id="Zero case (below 400)"),
+        pytest.param(500, False, id="Above 400"),
+    ],
+)
+def test_is_400(status_code, expected):
+    assert status_codes.is_400(status_code) is expected
+
+
+@pytest.mark.parametrize(
+    "status_code, expected",
+    [
+        pytest.param(501, True, id="Normal 501"),
+        pytest.param(599, True, id="Not actual status code but within 500"),
+        pytest.param(0, False, id="Zero case (below 500)"),
+        pytest.param(600, False, id="Above 500"),
+    ],
+)
+def test_is_500(status_code, expected):
+    assert status_codes.is_500(status_code) is expected