Add rest-auth helpers

README.rst

@@ -33,6 +33,7 @@ Features
     - Schema serving with ``SpectacularAPIView`` (Redoc and Swagger-UI views are also available)
     - Optional input/output serializer component split
     - Included support for:
+        - `django-rest-auth <https://github.com/Tivix/django-rest-auth>`_
         - `django-polymorphic <https://github.com/django-polymorphic/django-polymorphic>`_ / `django-rest-polymorphic <https://github.com/apirobot/django-rest-polymorphic>`_
         - `SimpleJWT <https://github.com/SimpleJWT/django-rest-framework-simplejwt>`_
         - `DjangoOAuthToolkit <https://github.com/jazzband/django-oauth-toolkit>`_

drf_spectacular/contrib/__init__.py

@@ -1,6 +1,7 @@
 __all__ = [
     'django_oauth_toolkit',
     'djangorestframework_camel_case',
+    'rest_auth',
     'rest_polymorphic',
     'rest_framework_jwt',
     'rest_framework_simplejwt'

drf_spectacular/contrib/rest_auth.py

@@ -0,0 +1,121 @@
+from django.conf import settings as global_settings
+from rest_framework import serializers
+
+try:
+    from allauth.account.app_settings import EMAIL_VERIFICATION, EmailVerificationMethod
+except ImportError:
+    EMAIL_VERIFICATION, EmailVerificationMethod = None, None
+
+try:
+    from rest_auth.app_settings import JWTSerializer, TokenSerializer, UserDetailsSerializer
+    from rest_auth.registration.app_settings import RegisterSerializer
+except ImportError:
+    JWTSerializer, UserDetailsSerializer, TokenSerializer, RegisterSerializer = (None, ) * 4
+
+from drf_spectacular.extensions import OpenApiViewExtension
+from drf_spectacular.utils import extend_schema
+
+if getattr(global_settings, 'REST_USE_JWT', False):
+    AuthTokenSerializer = JWTSerializer
+else:
+    AuthTokenSerializer = TokenSerializer
+
+
+class DRFDefaultDetailResponseSerializer(serializers.Serializer):
+    detail = serializers.CharField(read_only=True, required=False)
+
+
+if EmailVerificationMethod and EMAIL_VERIFICATION == EmailVerificationMethod.MANDATORY:
+    class RegisterResponseSerializer(DRFDefaultDetailResponseSerializer):  # type: ignore
+        pass
+
+elif AuthTokenSerializer:
+    class RegisterResponseSerializer(serializers.Serializer):  # type: ignore
+        user = UserDetailsSerializer(read_only=True)
+        token = AuthTokenSerializer(read_only=True)
+else:
+    class RegisterResponseSerializer:  # type: ignore
+        pass
+
+
+class RestAuthDefaultResponseView(OpenApiViewExtension):
+
+    def view_replacement(self):
+
+        class Fixed(self.target_class):
+
+            @extend_schema(responses=DRFDefaultDetailResponseSerializer)
+            def post(self, request, *args, **kwargs):
+                pass
+
+        return Fixed
+
+
+class RestAuthLoginView(OpenApiViewExtension):
+    target_class = 'rest_auth.views.LoginView'
+
+    def view_replacement(self):
+
+        class Fixed(self.target_class):
+
+            @extend_schema(responses=AuthTokenSerializer)
+            def post(self, request, *args, **kwargs):
+                pass
+
+        return Fixed
+
+
+class RestAuthLogoutView(OpenApiViewExtension):
+    target_class = 'rest_auth.views.LogoutView'
+
+    def view_replacement(self):
+
+        class Fixed(self.target_class):
+
+            if getattr(global_settings, 'ACCOUNT_LOGOUT_ON_GET', None):
+                @extend_schema(request=None, responses=DRFDefaultDetailResponseSerializer)
+                def get(self, request, *args, **kwargs):
+                    pass
+            else:
+                @extend_schema(exclude=True)
+                def get(self, request, *args, **kwargs):
+                    pass
+
+            @extend_schema(request=None, responses=DRFDefaultDetailResponseSerializer)
+            def post(self, request, *args, **kwargs):
+                pass
+
+        return Fixed
+
+
+class RestAuthPasswordChangeView(RestAuthDefaultResponseView):
+    target_class = 'rest_auth.views.PasswordChangeView'
+
+
+class RestAuthPasswordResetView(RestAuthDefaultResponseView):
+    target_class = 'rest_auth.views.PasswordResetView'
+
+
+class RestAuthPasswordResetConfirmView(RestAuthDefaultResponseView):
+    target_class = 'rest_auth.views.PasswordResetConfirmView'
+
+
+class RestAuthRegisterView(OpenApiViewExtension):
+    target_class = 'rest_auth.registration.views.RegisterView'
+
+    def view_replacement(self):
+
+        class Fixed(self.target_class):
+
+            @extend_schema(
+                request=RegisterSerializer,
+                responses=RegisterResponseSerializer,
+            )
+            def post(self, request, *args, **kwargs):
+                pass
+
+        return Fixed
+
+
+class RestAuthVerifyEmailView(RestAuthDefaultResponseView):
+    target_class = 'rest_auth.registration.views.VerifyEmailView'

requirements/optionals.txt

@@ -1,4 +1,6 @@
+django-allauth
 drf-jwt>=0.13.0
+django-rest-auth
 djangorestframework-simplejwt>=4.4.0
 django-polymorphic>=2.1
 django-rest-polymorphic>=0.1.8

requirements/testing.txt

@@ -1,7 +1,8 @@
+diff-match-patch
 pytest>=5.3.5
 pytest-django>=3.8.0
 pytest-cov>=2.8.1
 flake8>=3.7.9
 mypy>=0.770
 djangorestframework-stubs>=1.1.0
-isort>=5.0.4
+isort>=5.0.4

tests/__init__.py

@@ -1,18 +1,62 @@
+import os
+import sys
+
+from diff_match_patch import diff_match_patch
+
 from drf_spectacular.validation import validate_schema
 
 
-def assert_schema(schema, reference_file):
+def assert_schema(schema, reference_filename, transforms=None):
     from drf_spectacular.renderers import OpenApiJsonRenderer, OpenApiYamlRenderer
 
     schema_yml = OpenApiYamlRenderer().render(schema, renderer_context={})
     # render also a json and provoke serialization issues
     OpenApiJsonRenderer().render(schema, renderer_context={})
 
-    with open(reference_file.replace('.yml', '_out.yml'), 'wb') as fh:
+    if not os.path.exists(reference_filename):
+        generated_filename = reference_filename
+    else:
+        generated_filename = reference_filename.replace('.yml', '_out.yml')
+
+    with open(generated_filename, 'wb') as fh:
         fh.write(schema_yml)
 
-    with open(reference_file) as fh:
-        assert schema_yml.decode() == fh.read()
+    if generated_filename == reference_filename:
+        raise RuntimeError(
+            f'{reference_filename} was not found. '
+            f'It has been created with the generated schema. '
+            f'Review carefully, as it is the baseline for subsequent checks.')
+
+    generated = schema_yml.decode()
+
+    with open(reference_filename) as fh:
+        expected = fh.read()
+
+    # This only does each transform, however it may be necessary to do all
+    # combinations of transforms.
+    # Force to be a list, and insert identity
+    if transforms:
+        transforms = [lambda x: x] + list(transforms)
+    else:
+        transforms = [lambda x: x]
+
+    results = []
+    for result in (transformer(generated) for transformer in transforms):
+        if result not in results:
+            results.append(result)
+            if result == expected:
+                break
+    else:
+        dmp = diff_match_patch()
+        diff = dmp.diff_main(expected, generated)
+        dmp.diff_cleanupSemantic(diff)
+        patch = dmp.patch_toText(dmp.patch_make(diff))
+        assert patch, f'Failed to generate patch from "{expected}" to "{generated}"'
+        msg = f"Patch from {reference_filename} to {generated_filename}: {patch}"
+        if len(transforms) and len(results) != len(transforms):
+            msg = f'{len(transforms) - 1} transformers ineffective: {msg}'
+        print(msg, file=sys.stderr)
+        assert expected == generated, msg
 
     # this is more a less a sanity check as checked-in schemas should be valid anyhow
     validate_schema(schema)

tests/conftest.py

@@ -14,6 +14,8 @@ def pytest_configure(config):
     )
 
     contrib_apps = [
+        'rest_auth',
+        'rest_auth.registration',
         'rest_framework_jwt',
         'oauth2_provider',
         # this is not strictly required and when added django-polymorphic
@@ -69,6 +71,8 @@ def pytest_configure(config):
             'django.contrib.staticfiles',
             'rest_framework',
             'rest_framework.authtoken',
+            'allauth',
+            'allauth.account',
             *[app for app in contrib_apps if module_available(app)],
             'drf_spectacular',
             'tests',
@@ -120,10 +124,23 @@ def pytest_collection_modifyitems(config, items):
                 item.add_marker(allow_contrib_fail)
 
 
+@pytest.hookimpl(hookwrapper=True, tryfirst=True)
+def pytest_runtest_makereport(item, call):
+    """ store outcome result in request """
+    outcome = yield
+    rep = outcome.get_result()
+    setattr(item, "rep_" + rep.when, rep)
+    return rep
+
+
 @pytest.fixture()
-def no_warnings(capsys):
-    """ make sure test emits no warnings """
+def no_warnings(capsys, request):
+    """ make sure successful test emits no warnings """
     yield capsys
+
+    if request.node.rep_call.failed:
+        return
+
     captured = capsys.readouterr()
     assert not captured.out
     assert not captured.err

tests/contrib/test_rest_auth.py

@@ -0,0 +1,40 @@
+import re
+
+import pytest
+from django.urls import include, path
+
+from drf_spectacular.generators import SchemaGenerator
+from tests import assert_schema
+
+transforms = [
+    # User model first_name differences
+    lambda x: re.sub(r'(first_name:\n *type: string\n *maxLength:) 150', r'\g<1> 30', x, re.M),
+    # User model username validator tail
+    lambda x: x.replace(r'+$', r'+\Z'),
+]
+
+
+@pytest.mark.contrib('rest_auth')
+def test_rest_auth(no_warnings):
+    urlpatterns = [
+        path('rest-auth/', include('rest_auth.urls')),
+    ]
+
+    generator = SchemaGenerator(patterns=urlpatterns)
+    schema = generator.get_schema(request=None, public=True)
+
+    assert_schema(schema, 'tests/contrib/test_rest_auth.yml',
+                  transforms=transforms)
+
+
+@pytest.mark.contrib('rest_auth')
+def test_rest_auth_registration(no_warnings):
+    urlpatterns = [
+        path('rest-auth/registration/', include('rest_auth.registration.urls')),
+    ]
+
+    generator = SchemaGenerator(patterns=urlpatterns)
+    schema = generator.get_schema(request=None, public=True)
+
+    assert_schema(schema, 'tests/contrib/test_rest_auth_registration.yml',
+                  transforms=transforms)