Merge pull request #58 from ahopkins/initialize

Overhaul initialization and configuration

.codacy.yml

@@ -1,3 +1,4 @@
 exclude_paths:
   - example/**
   - tests/**
+  - docs/**

.coveragerc

@@ -14,5 +14,6 @@ exclude_lines =
     no cov
     no qa
     noqa
+    NOQA
     pragma: no cover
     if __name__ == .__main__.:

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = sanic-jwt
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/source/conf.py

@@ -0,0 +1,170 @@
+# -*- coding: utf-8 -*-
+#
+# sanic-jwt documentation build configuration file, created by
+# sphinx-quickstart on Mon Jan 22 01:30:22 2018.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = ['sphinx.ext.autodoc',
+    'sphinx.ext.todo',
+    'sphinx.ext.viewcode']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'sanic-jwt'
+copyright = u'2018, Adam Hopkins'
+author = u'Adam Hopkins'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = u'0.4.1'
+# The full version, including alpha/beta/rc tags.
+release = u'0.4.1'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This patterns also effect to html_static_path and html_extra_path
+exclude_patterns = []
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = True
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'sphinx_rtd_theme'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#
+# html_theme_options = {}
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# This is required for the alabaster theme
+# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
+html_sidebars = {
+    '**': [
+        'relations.html',  # needs 'show_related': True theme option to display
+        'searchbox.html',
+    ]
+}
+
+
+# -- Options for HTMLHelp output ------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'sanic-jwtdoc'
+
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, 'sanic-jwt.tex', u'sanic-jwt Documentation',
+     u'Adam Hopkins', 'manual'),
+]
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'sanic-jwt', u'sanic-jwt Documentation',
+     [author], 1)
+]
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (master_doc, 'sanic-jwt', u'sanic-jwt Documentation',
+     author, 'sanic-jwt', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+

docs/source/index.rst

@@ -0,0 +1,29 @@
+=========
+Sanic JWT
+=========
+
+Sanic JWT is a module meant to add authentication protection and endpoints to a `Sanic <http://sanic.readthedocs.io>`_.
+
+It is meant to be both `easy` to get up and running, and `extensible` for the developer. It can act to :doc:`protect endpoints <pages/protected>` and also :doc:`provide authentication scoping <pages/scoped>`, all wrapped into a nice `JWT <https://jwt.io>`_.
+
+Pick your favorite user management system, run :doc:`a single function to initialize <pages/initialization>`, and you are all set.
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   pages/gettingstarted
+   pages/installation
+   pages/simpleusage
+   pages/whatisjwt
+   pages/initialization
+   pages/endpoints
+   pages/handlers
+   pages/protected
+   pages/scoped
+   pages/refreshtokens
+   pages/exceptions
+   pages/settings
+   pages/examples
+   pages/contributing
+   pages/history

docs/source/pages/contributing.rst

@@ -0,0 +1,3 @@
+============
+Contributing
+============

docs/source/pages/endpoints.rst

@@ -0,0 +1,123 @@
+=========
+Endpoints
+=========
+
+Sanic JWT sets itseld up to run as a `Sanic Blueprint <http://sanic.readthedocs.io/en/latest/sanic/blueprints.html>`_ at the ``/auth`` path. ::
+
+    http://localhost:8000/auth
+
+This is can be changed via the ``SANIC_JWT_URL_PREFIX`` setting. :doc:`See settings for more <settings>`. ::
+
+    app.config.SANIC_JWT_URL_PREFIX = '/api/authentication'
+
+All Sanic JWT endpoints will now be available at: ::
+
+    http://localhost:8000/api/authentication
+
+------------
+
+++++++++++++
+Authenticate
+++++++++++++
+
+| **Path**: ``/auth``
+| **Acceptable Methods**: ``POST``
+| **Purpose**: Generates an access token if the ``authenticate`` :doc:`method <initialization>` evaluates to ``True``.
+| **Example**:
+|
+
+Request ::
+
+    curl -X POST -H "Content-Type: application/json" -d '{"username": "<USERNAME>", "password": "<PASSWORD>"}' http://localhost:8000/auth
+
+Response ::
+
+    {
+        "access_token": "<JWT>"
+    }
+
+------------
+
+++++++++++++
+Verification
+++++++++++++
+
+| **Path**: ``/auth/verify``
+| **Acceptable Methods**: ``GET``
+| **Purpose**: Check whether or not a given access token is valid.
+| **Example**:
+|
+
+Request ::
+
+    curl -X GET -H "Authorization: Bearer <JWT>" http://localhost:8000/auth/verify
+
+Response ::
+
+    200 Response
+    {
+        "valid": true
+    }
+
+    ## or
+
+    400 Response
+    {
+        "valid": false,
+        "reason": "Signature has expired"
+    }
+
+------------
+
+++++++++++++++++++++
+Current User Details
+++++++++++++++++++++
+
+| **Path**: ``/auth/me``
+| **Acceptable Methods**: ``GET``
+| **Purpose**: Retrieve information about the currently authenticated user.
+| **Example**:
+|
+
+Request ::
+
+    curl -X GET -H "Authorization: Bearer <JWT>" http://localhost:8000/auth/me
+
+Response ::
+
+    200 Response
+    {
+        "user_id": 123456
+    }
+
+
+.. note::
+
+    Because this package does not know about you user management layer, you need to have a user object that either is a dict or a object instance with a ``to_dict()`` method (this order is respected). The output of these methods will be used to generate the ``/me`` response.
+
+------------
+
++++++++++++++
+Refresh Token
++++++++++++++
+
+| **Path**: ``/auth/refresh``
+| **Acceptable Methods**: ``POST``
+| **Purpose**: Ask for a new access token given an existing refresh token
+| **Example**:
+|
+
+Request ::
+
+    curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer <JWT>" -d '{"refresh_token": "<REFRESH TOKEN>"}' http://localhost:8000/auth/refresh
+
+Response ::
+
+    {
+        "access_token": "<JWT>"
+    }
+
+
+.. note::
+
+    Do not forget to supply an existing ``access_token``. Even if it is expired, you **must** send the token along so that the application can get the ``user_id`` from the token's payload and cross reference it with the ``refresh_token``.

docs/source/pages/examples.rst

@@ -0,0 +1,23 @@
+========
+Examples
+========
+
++++++
+Basic
++++++
+
+++++++++++++++++++++++++++++
+Protecting Class Based Views
+++++++++++++++++++++++++++++
+
++++++++++++++
+Refresh token
++++++++++++++
+
++++++++++++++++
+Dynamic Scoping
++++++++++++++++
+
+++++++++++++++++++
+Passwordless Login
+++++++++++++++++++

docs/source/pages/exceptions.rst

@@ -0,0 +1,3 @@
+==========
+Exceptions
+==========