Merge pull request #68 from caravancoop/feature/release

Release v0.10

Author: merwok

.circleci/config.yml

@@ -6,98 +6,100 @@ workflows:
     jobs:
       - test-py37
       - test-py36
-      - test-py27
       - check
 
 jobs:
 
   test-py37:
     docker:
       - image: circleci/python:3.7
+      - image: circleci/postgres:10.5
+        environment:
+          POSTGRES_DB: circle_test
+          POSTGRES_USER: testapp
+          POSTGRES_PASSWORD: ""
     working_directory: ~/rest-auth-toolkit
+    environment:
+      DATABASE_URL: postgres://testapp@localhost/circle_test
     steps:
       - checkout
       - restore_cache:
-          key: rest-auth-toolkit-py37-v2
+          keys:
+            - rest-auth-toolkit-py37-v7-{{ arch }}-{{ checksum "requirements-test.txt" }}-{{ checksum "demo/requirements.txt" }}
+            - rest-auth-toolkit-py37-v7-{{ arch }}-{{ checksum "requirements-test.txt" }}
+            - rest-auth-toolkit-py37-v7-{{ arch }}-
       - run:
           name: Install CI tools
           command: |
             python3.7 -m venv venv
             venv/bin/pip install tox
       - run:
           name: Test with Python 3.7
-          command: venv/bin/tox -e py37
+          command: venv/bin/tox -e py37 -- --junitxml=~/reports/tox/coverage.xml
+      - run:
+          name: Check coverage with Python 3.7
+          command: venv/bin/tox -e coverage
       - save_cache:
-          key: rest-auth-toolkit-py37-v2
+          key: rest-auth-toolkit-py37-v7-{{ arch }}-{{ checksum "requirements-test.txt" }}-{{ checksum "demo/requirements.txt" }}
           paths:
             - venv
             - .tox
+      - store_test_results:
+          path: ~/reports
 
   test-py36:
     docker:
       - image: circleci/python:3.6
+      - image: circleci/postgres:10.5
+        environment:
+          POSTGRES_DB: circle_test
+          POSTGRES_USER: testapp
+          POSTGRES_PASSWORD: ""
     working_directory: ~/rest-auth-toolkit
+    environment:
+      DATABASE_URL: postgres://testapp@localhost/circle_test
     steps:
       - checkout
       - restore_cache:
-          key: rest-auth-toolkit-py36-v2
+          keys:
+            - rest-auth-toolkit-py36-v4-{{ arch }}-{{ checksum "requirements-test.txt" }}-{{ checksum "demo/requirements.txt" }}
+            - rest-auth-toolkit-py36-v4-{{ arch }}-{{ checksum "requirements-test.txt" }}-{{ checksum "demo/requirements.txt" }}
+            - rest-auth-toolkit-py36-v4-{{ arch }}-{{ checksum "requirements-test.txt" }}
+            - rest-auth-toolkit-py36-v4-{{ arch }}-
       - run:
           name: Install CI tools
           command: |
             python3.6 -m venv venv
             venv/bin/pip install tox
       - run:
           name: Test with Python 3.6
-          command: venv/bin/tox -e py36
+          command: venv/bin/tox -e py36 -- --junitxml=~/reports/tox/coverage.xml
       - save_cache:
-          key: rest-auth-toolkit-py36-v2
-          paths:
-            - venv
-            - .tox
-
-  test-py27:
-    docker:
-      # This image contains Python 3.6 (to install flit) and 2.7 (to run tests)
-      - image: circleci/python:3.6
-    working_directory: ~/rest-auth-toolkit
-    steps:
-      - checkout
-      - restore_cache:
-          key: rest-auth-toolkit-py27-v2
-      - run:
-          name: Install CI tools
-          command: |
-            python3.6 -m venv venv
-            venv/bin/pip install tox
-      - run:
-          name: Test with Python 2.7
-          command: |
-            venv/bin/tox --sdistonly
-            venv/bin/tox -e py27
-      - save_cache:
-          key: rest-auth-toolkit-py27-v2
+          key: rest-auth-toolkit-py36-v4-{{ arch }}-{{ checksum "requirements-test.txt" }}-{{ checksum "demo/requirements.txt" }}
           paths:
             - venv
             - .tox
+      - store_test_results:
+          path: ~/reports
 
   check:
     docker:
-      - image: circleci/python:3.6
+      - image: circleci/python:3.7
     working_directory: ~/rest-auth-toolkit
     steps:
       - checkout
       - restore_cache:
-          key: rest-auth-toolkit-check-v3
+          key: rest-auth-toolkit-check-v6
       - run:
           name: Install CI tools
           command: |
-            python3.6 -m venv venv
+            python3.7 -m venv venv
             venv/bin/pip install tox
       - run:
           name: Check packaging and dependencies
           command: venv/bin/tox -e pkg
       - save_cache:
-          key: rest-auth-toolkit-check-v3
+          key: rest-auth-toolkit-check-v6
           paths:
             - venv
             - .tox

.gitignore

@@ -4,7 +4,8 @@ __pycache__
 /demo/.env
 
 # Test artifacts
-/.cache/
+/.pytest_cache/
+/.coverage
 /.tox/
 /venv/
 

CHANGELOG.md

@@ -0,0 +1,51 @@
+# Changelog for Rest-Framework-Auth-Toolkit
+
+
+## v0.10
+
+Django password validators are now applied during signup.
+
+Facebook login is fixed (silent error in previous version due to API change).
+
+Partial test coverage.
+
+API docs for the demo app.
+
+### Upgrade notes
+
+Python 3 is required!
+
+
+## v0.9
+
+Run tests and demo with Python 3.7 and Django 2.0.
+
+Package library with flit.
+
+### Upgrade notes
+
+The facepy dependency is now optional.  Depend on
+`rest-framework-auth-toolkit[facebook]` to have it automatically installed.
+
+
+## v0.8
+
+Set up internationalization.
+
+
+## v0.7
+
+Added abstract base user model, with email as username.
+
+
+## v0.6
+
+It is now possible to use login without signup.
+
+
+## v0.5
+
+First published version.
+
+Includes views for signup (with email confirmation), login and logout.
+A demo app shows how to integrate and configure the library.

README.md

@@ -25,3 +25,18 @@ See the [demo](demo/) app for example usage.
 
 ⚠️ This library is not stable yet, make sure to pin your dependencies.
 Recommended form: `rest-framework-auth-toolkit == 0.9.*`
+
+See the [changelog](CHANGELOG.md) for breaking changes.
+
+
+## Contributing
+
+To run tests:
+
+```
+export DATABASE_URL=postgres://ratk@localhost:5432/ratk
+tox
+```
+
+You will have to create the `ratk` role first, as well as
+the `ratk` and `test_ratk` databases.

demo/README.md

@@ -3,6 +3,9 @@
 This is a minimal Django project that shows how to use
 the package and helps checking if changes break usage.
 
+This app is also used by the automated tests.
+
+
 ## How to install
 
 Run this command once from the repository root:
@@ -26,7 +29,7 @@ Define the environment variables needed by the app:
 
 ```
 export DEMO_FACEBOOK_APP_ID="..."
-export DEMO_FACEBOOK_SECRET_KEY="..."
+export DEMO_FACEBOOK_APP_SECRET_KEY="..."
 ```
 
 (using a [virtualenvwrapper hook](https://virtualenvwrapper.readthedocs.io/en/latest/scripts.html#postactivate)
@@ -38,3 +41,5 @@ You can then run Django commands:
 python manage.py migrate
 python manage.py runserver
 ```
+
+Then head on to `http://localhost:8000/api/` to see the endpoints available.

demo/demo/accounts/admin.py

@@ -18,7 +18,7 @@ class EmailConfirmationAdmin(admin.ModelAdmin):
 
 
 class APITokenAdmin(admin.ModelAdmin):
-    list_display = ('key', 'user', 'created')
+    list_display = ('__str__', 'created')
     ordering = ('user', '-created')
     date_hierarchy = 'created'
     readonly_fields = ('key', 'created')

demo/demo/settings.py

@@ -2,17 +2,32 @@
 
 import os
 
+from django.core.management.utils import get_random_secret_key
+
+import dj_database_url
+
 BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
 
 # Quick-start development settings - unsuitable for production
 # See https://docs.djangoproject.com/en/1.11/howto/deployment/checklist/
 
+if os.getenv('RAT_TESTING'):
+    os.environ['DEMO_SECRET_KEY'] = get_random_secret_key()
+    os.environ['DEMO_FACEBOOK_APP_ID'] = 'fb app id'
+    os.environ['DEMO_FACEBOOK_APP_SECRET_KEY'] = 'fb app key'
+
+
 SECRET_KEY = os.getenv('DEMO_SECRET_KEY',
                        '1(9v73@)*ws6i(v_i5*_4ty^+ji0@7u($6onk7pt-_ncxkqs@@')
+
 DEBUG = True
 
 FACEBOOK_APP_ID = os.environ['DEMO_FACEBOOK_APP_ID']
-FACEBOOK_APP_SECRET_KEY = os.environ['DEMO_FACEBOOK_SECRET_KEY']
+FACEBOOK_APP_SECRET_KEY = os.environ['DEMO_FACEBOOK_APP_SECRET_KEY']
+
+DATABASES = {
+    'default': dj_database_url.parse(os.environ['DATABASE_URL']),
+}
 
 SITE_ID = 1
 ROOT_URLCONF = 'demo.urls'
@@ -49,14 +64,6 @@
 ]
 
 
-DATABASES = {
-    'default': {
-        'ENGINE': 'django.db.backends.sqlite3',
-        'NAME': os.path.join(BASE_DIR, 'db.sqlite3'),
-    }
-}
-
-
 EMAIL_BACKEND = 'django.core.mail.backends.console.EmailBackend'
 
 
@@ -102,8 +109,9 @@
     'DEFAULT_AUTHENTICATION_CLASSES': [
         # This is the real authn policy for API clients
         'demo.accounts.authentication.APITokenAuthentication',
-        # Allow using the browsable API for protected resources
-        'rest_framework.authentication.SessionAuthentication',
+    ],
+    'DEFAULT_RENDERER_CLASSES': [
+        'rest_framework.renderers.JSONRenderer',
     ],
     'DEFAULT_PERMISSION_CLASSES': [
         'rest_framework.permissions.IsAuthenticated',

demo/demo/urls.py

@@ -3,9 +3,17 @@
 from django.urls import include, path
 from django.contrib import admin
 
+from rest_framework.documentation import include_docs_urls
+from rest_framework.renderers import DocumentationRenderer
+
 from rest_auth_toolkit.views import FacebookLoginView, LoginView, LogoutView, SignupView
 
 
+class GoAwayRenderer(DocumentationRenderer):
+    # Hide unwanted coreapi code snippets
+    languages = []
+
+
 auth_urlpatterns = [
     path('signup/', SignupView.as_view(), name='signup'),
     path('login/', LoginView.as_view(), name='login'),
@@ -15,6 +23,8 @@
 
 api_urlpatterns = [
     path('account/', include('demo.accounts.urls')),
+    path('', include_docs_urls(title='Demo API', permission_classes=[],
+                               renderer_classes=[GoAwayRenderer])),
     path('', include((auth_urlpatterns, 'auth'))),
 ]
 

demo/requirements.in

@@ -1,8 +1,10 @@
 pip-tools
 
-django == 2.0.*
+django == 2.1.*
 djangorestframework
 django-debug-toolbar
+dj-database-url
+psycopg2
 
 django-model-utils
 django-shortuuidfield
@@ -14,6 +16,5 @@ django-shortuuidfield
 # contains all transitive dependencies
 facepy
 
-# for the browsable API
-markdown
-pygments
+# API docs
+coreapi