Skip to content

Commit

Permalink
Merge 59f8c6f into 5ddbf62
Browse files Browse the repository at this point in the history
  • Loading branch information
jcwilson committed Jan 19, 2019
2 parents 5ddbf62 + 59f8c6f commit bcc596d
Show file tree
Hide file tree
Showing 9 changed files with 322 additions and 68 deletions.
41 changes: 32 additions & 9 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -1,18 +1,41 @@
language: python
python:
- "2.6"
- "2.7"
- "3.3"
- "3.4"
- "3.5"
- "3.6"

matrix:
include:
- python: 2.6
env:
- WITH_JWT=false
WITH_HAWK=false
- python: 2.7
env:
- WITH_JWT=true
WITH_HAWK=true
- python: 3.3
env:
- WITH_JWT=false
WITH_HAWK=false
- python: 3.4
env:
- WITH_JWT=true
WITH_HAWK=true
- python: 3.5
env:
- WITH_JWT=true
WITH_HAWK=true
- python: 3.6
env:
- WITH_JWT=true
WITH_HAWK=true

before_install:
- pip install --upgrade pytest

install: "pip install -r requirements-dev.txt"
install:
- pip install -r requirements-dev.txt"
$WITH_JWT && pip install pyjwt>=1.7.0
$WITH_HAWK && pip install mohawk>=1.0.0

script: py.test --cov-report term-missing --cov=falcon_auth

after_success:
- coveralls
- coveralls
16 changes: 16 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
FROM python:latest

RUN pip install -U pytest

WORKDIR /srv

COPY falcon_auth falcon_auth
COPY tests tests
COPY setup.py setup.py
COPY setup.cfg setup.cfg
COPY requirements.txt requirements.txt

RUN pip install -r requirements.txt
RUN pip install 'pytest<4' pyjwt

CMD ["/bin/bash"]
24 changes: 23 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,12 @@ Install the extension with pip, or easy\_install.
$ pip install -U falcon-auth
If you wish to use the optional backends, specify those dependencies, too.

.. code:: bash
$ pip install -U falcon-auth[backend-hawk,backend-jwt]
Usage
-----

Expand Down Expand Up @@ -126,6 +132,22 @@ header contains a prefix (typically Token) followed by an `API Token`
+ **JWT Authentication**

Token based authentication using the `JSON Web Token standard <https://jwt.io/introduction/>`__
If you wish to use this backend, be sure to add the optional dependency to your requirements:

.. code:: text
falcon-auth[backend-jwt]
+ **Hawk Authentication**

Token based authentication using the `Hawk "Holder-Of-Key Authentication Scheme" <https://github.com/hueniverse/hawk>`__
If you wish to use this backend, be sure to add the optional dependency to your requirements:

.. code:: text
falcon-auth[backend-hawk]
+ **Dummy Authentication**

Expand All @@ -134,7 +156,7 @@ Backend which does not perform any authentication checks
+ **Multi Backend Authentication**

A Backend which comprises of multiple backends and requires any of them to authenticate
the request successfully
the request successfully.

Tests
-----
Expand Down

0 comments on commit bcc596d

Please sign in to comment.