Merge pull request #35 from caravancoop/develop

Release v0.9

Author: merwok

Diff for: .circleci/config.yml

@@ -4,20 +4,43 @@ workflows:
   version: 2
   rest-auth-toolkit:
     jobs:
+      - test-py37
       - test-py36
       - test-py27
       - check
 
 jobs:
 
+  test-py37:
+    docker:
+      - image: circleci/python:3.7
+    working_directory: ~/rest-auth-toolkit
+    steps:
+      - checkout
+      - restore_cache:
+          key: rest-auth-toolkit-py37-v2
+      - 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
+      - save_cache:
+          key: rest-auth-toolkit-py37-v2
+          paths:
+            - venv
+            - .tox
+
   test-py36:
     docker:
       - image: circleci/python:3.6
     working_directory: ~/rest-auth-toolkit
     steps:
       - checkout
       - restore_cache:
-          key: rest-auth-toolkit-py36-v1
+          key: rest-auth-toolkit-py36-v2
       - run:
           name: Install CI tools
           command: |
@@ -27,29 +50,32 @@ jobs:
           name: Test with Python 3.6
           command: venv/bin/tox -e py36
       - save_cache:
-          key: rest-auth-toolkit-py36-v1
+          key: rest-auth-toolkit-py36-v2
           paths:
             - venv
             - .tox
 
   test-py27:
     docker:
-      - image: circleci/python:2.7
+      # 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-v1
+          key: rest-auth-toolkit-py27-v2
       - run:
           name: Install CI tools
           command: |
-            virtualenv -p python2.7 venv
+            python3.6 -m venv venv
             venv/bin/pip install tox
       - run:
           name: Test with Python 2.7
-          command: venv/bin/tox -e py27
+          command: |
+            venv/bin/tox --sdistonly
+            venv/bin/tox -e py27
       - save_cache:
-          key: rest-auth-toolkit-py35-v1
+          key: rest-auth-toolkit-py27-v2
           paths:
             - venv
             - .tox
@@ -61,7 +87,7 @@ jobs:
     steps:
       - checkout
       - restore_cache:
-          key: rest-auth-toolkit-check-v2
+          key: rest-auth-toolkit-check-v3
       - run:
           name: Install CI tools
           command: |
@@ -71,7 +97,7 @@ jobs:
           name: Check packaging and dependencies
           command: venv/bin/tox -e pkg
       - save_cache:
-          key: rest-auth-toolkit-check-v2
+          key: rest-auth-toolkit-check-v3
           paths:
             - venv
             - .tox

Diff for: .gitignore

@@ -6,6 +6,7 @@ __pycache__
 # Test artifacts
 /.cache/
 /.tox/
+/venv/
 
 # Packaging litter
 /*.egg-info

Diff for: MANIFEST.in

@@ -1,11 +1,27 @@
 ```
-                       __                   __  __         __              ____   _ __
-       ________  _____/ /_     ____ ___  __/ /_/ /_       / /_____  ____  / / /__(_) /_
-      / ___/ _ \/ ___/ __/ ___/ __ `/ / / / __/ __ \  ___/ __/ __ \/ __ \/ / //_/ / __/
-     / /  /  __(__  ) /_  /__/ /_/ / /_/ / /_/ / / / /__/ /_/ /_/ / /_/ / / ,< / / /_
-    /_/   \___/____/\__/     \__,_/\__,_/\__/_/ /_/     \__/\____/\____/_/_/|_/_/\__/
+                     __                   __  __         __              ____   _ __
+     ________  _____/ /_     ____ ___  __/ /_/ /_       / /_____  ____  / / /__(_) /_
+    / ___/ _ \/ ___/ __/ ___/ __ `/ / / / __/ __ \  ___/ __/ __ \/ __ \/ / //_/ / __/
+   / /  /  __(__  ) /_  /__/ /_/ / /_/ / /_/ / / / /__/ /_/ /_/ / /_/ / / ,< / / /_
+  /_/   \___/____/\__/     \__,_/\__,_/\__/_/ /_/     \__/\____/\____/_/_/|_/_/\__/
 
 ```
 
-Mixins and views to handle signup and login in an API built with
-django-rest-framework.
+This libary provides mixins and views to handle signup, login and
+logout in an API built with django-rest-framework.  After login,
+client applications get a token for the API requests.
+
+Email-based signups are supported out of the box.
+Other methods require you to specify an extra in your requirements;
+for example, to use Facebook login you need to depend on
+`rest-framework-auth-toolkit[facebook]`.
+
+Contrary to other similar modules, rest-auth-toolkit doess not provide
+a set of Django apps to include and configure in your settings, but a
+collection of mixins, base classes, base views and simple templates
+that you can integrate and customize in your own apps.
+
+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.*`

Diff for: README.md

@@ -0,0 +1,40 @@
+# Demo application for Rest-Framework-Auth-Toolkit
+
+This is a minimal Django project that shows how to use
+the package and helps checking if changes break usage.
+
+## How to install
+
+Run this command once from the repository root:
+
+```
+python setup-develop.py develop
+```
+
+This makes the package `rest_auth_toolkit` importable by the demo app,
+with local changes immediately seen.
+
+Go in the `demo` directory and install the other dependencies:
+
+```
+pip install -r requirements.txt
+```
+
+# How to run
+
+Define the environment variables needed by the app:
+
+```
+export DEMO_FACEBOOK_APP_ID="..."
+export DEMO_FACEBOOK_SECRET_KEY="..."
+```
+
+(using a [virtualenvwrapper hook](https://virtualenvwrapper.readthedocs.io/en/latest/scripts.html#postactivate)
+or a `.env` file with [direnv](https://direnv.net/) is a good ideae to make this automatic)
+
+You can then run Django commands:
+
+```
+python manage.py migrate
+python manage.py runserver
+```

Diff for: demo/README.md

@@ -0,0 +1,18 @@
+# Generated by Django 2.0.8 on 2018-09-21 23:51
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('accounts', '0002_auto_20180222_0012'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='user',
+            name='last_name',
+            field=models.CharField(blank=True, max_length=150, verbose_name='last name'),
+        ),
+    ]

Diff for: demo/demo/accounts/migrations/0003_auto_20180921_2351.py

@@ -1,26 +1,26 @@
 """demo URL Configuration."""
 
-from django.conf.urls import url, include
+from django.urls import include, path
 from django.contrib import admin
 
 from rest_auth_toolkit.views import FacebookLoginView, LoginView, LogoutView, SignupView
 
 
 auth_urlpatterns = [
-    url(r'^signup/', SignupView.as_view(), name='signup'),
-    url(r'^login/', LoginView.as_view(), name='login'),
-    url(r'^logout/', LogoutView.as_view(), name='logout'),
-    url(r'^fb-login/', FacebookLoginView.as_view(), name='fb-login'),
+    path('signup/', SignupView.as_view(), name='signup'),
+    path('login/', LoginView.as_view(), name='login'),
+    path('logout/', LogoutView.as_view(), name='logout'),
+    path('fb-login/', FacebookLoginView.as_view(), name='fb-login'),
 ]
 
 api_urlpatterns = [
-    url(r'^account/', include('demo.accounts.urls')),
-    url(r'', include((auth_urlpatterns, 'auth'))),
+    path('account/', include('demo.accounts.urls')),
+    path('', include((auth_urlpatterns, 'auth'))),
 ]
 
 urlpatterns = [
-    url(r'^admin/', admin.site.urls),
-    url(r'^api/', include(api_urlpatterns)),
-    url(r'', include('demo.pages.urls')),
-    url(r'', include('demo.pages.auth_urls')),
+    path('admin/', admin.site.urls),
+    path('api/', include(api_urlpatterns)),
+    path('', include('demo.pages.urls')),
+    path('', include('demo.pages.auth_urls')),
 ]

Diff for: demo/demo/urls.py

@@ -1,15 +1,19 @@
 pip-tools
 
-django ~= 1.11
+django == 2.0.*
 djangorestframework
 django-debug-toolbar
 
-# Note: rest-framework-auth-toolkit is not here, it should already
-# be importable if you do pip install -e from your dev virtualenv.
-
 django-model-utils
 django-shortuuidfield
 
+# TODO add develop install for rest-framework-auth-toolkit
+# (when pip supports PEP 517); see README for how to install rest-auth-toolkit
+#-e ..[facebook]
+# In the meantime we include facepy here to make sure requirements.txt
+# contains all transitive dependencies
+facepy
+
 # for the browsable API
 markdown
 pygments

Diff for: demo/requirements.in

@@ -4,17 +4,23 @@
 #
 #    pip-compile --output-file requirements.txt requirements.in
 #
+certifi==2018.8.24        # via requests
+chardet==3.0.4            # via requests
 click==6.7                # via pip-tools
-django-debug-toolbar==1.9.1
-django-model-utils==3.1.1
+django-debug-toolbar==1.10.1
+django-model-utils==3.1.2
 django-shortuuidfield==0.1.3
-django==1.11.10
-djangorestframework==3.7.7
+django==2.0.8
+djangorestframework==3.8.2
+facepy==1.0.9
 first==2.0.1              # via pip-tools
+idna==2.7                 # via requests
 markdown==2.6.11
-pip-tools==1.11.0
+pip-tools==2.0.2
 pygments==2.2.0
-pytz==2018.3              # via django
+pytz==2018.5              # via django
+requests==2.19.1          # via facepy
 shortuuid==0.5.0          # via django-shortuuidfield
-six==1.11.0               # via django-shortuuidfield, pip-tools
+six==1.11.0               # via django-shortuuidfield, facepy, pip-tools
 sqlparse==0.2.4           # via django-debug-toolbar
+urllib3==1.23             # via requests

Diff for: demo/requirements.txt

@@ -0,0 +1,29 @@
+[build-system]
+requires = ["flit"]
+build-backend = "flit.buildapi"
+
+[tool.flit.metadata]
+module = "rest_auth_toolkit"
+dist-name = "Rest_Framework_Auth_Toolkit"
+author = "Caravan Coop"
+author-email = "[email protected]"
+home-page = "https://github.com/caravancoop/rest-framework-auth-toolkit"
+description-file = "README.md"
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 2.7",
+    "Programming Language :: Python :: 3.5",
+    "Programming Language :: Python :: 3.6",
+    "Programming Language :: Python :: 3.7",
+    "Framework :: Django :: 1.11",
+    "Framework :: Django :: 2.0",
+    "Framework :: Django :: 2.1",
+]
+requires = [
+    "django >= 1.11",
+]
+
+[tool.flit.metadata.requires-extra]
+facebook = ["facepy"]

Diff for: pyproject.toml

@@ -1 +1,5 @@
+"""Simple + flexible signup and login for Django APIs"""
+
+__version__ = '0.9'
+
 default_app_config = 'rest_auth_toolkit.app.RestAuthToolkitConfig'

Diff for: requirements.txt

@@ -5,7 +5,10 @@
 from rest_framework import serializers
 from rest_framework.exceptions import ValidationError
 
-import facepy
+try:
+    import facepy
+except ImportError:
+    facepy = None
 
 
 User = get_user_model()

Diff for: rest_auth_toolkit/__init__.py

@@ -11,6 +11,11 @@
 from .serializers import FacebookLoginDeserializer, LoginDeserializer, SignupDeserializer
 from .utils import get_object_from_setting, get_setting, MissingSetting
 
+try:
+    import facepy
+except ImportError:
+    facepy = None
+
 
 User = get_user_model()
 Token = get_object_from_setting('api_token_class')
@@ -93,6 +98,16 @@ class FacebookLoginView(generics.GenericAPIView):
     serializer_class = get_object_from_setting('facebook_login_serializer_class',
                                                FacebookLoginDeserializer)
 
+    @classmethod
+    def as_view(cls, *args, **kwargs):
+        if facepy is None:
+            raise TypeError('install rest-framework-auth-toolkit[facebook] '
+                            'to enable Facebook logins')
+
+        # TODO error if settings are missing
+
+        return super(FacebookLoginView, cls).as_view(*args, **kwargs)
+
     def post(self, request):
         deserializer = self.get_serializer(data=request.data)
         deserializer.is_valid(raise_exception=True)