Merge pull request #123 from anx-bhagmann/browsable-api

Add helper function to extend django-drf browsable API with passwordr…

Author: nezhar

README.md

@@ -274,6 +274,39 @@ django-rest-passwordreset Version | Django Versions | Django Rest Framework Vers
 
 This package supports the [DRF auto-generated documentation](https://www.django-rest-framework.org/topics/documenting-your-api/) (via `coreapi`) as well as the [DRF browsable API](https://www.django-rest-framework.org/topics/browsable-api/).
 
+To add the endpoints to the browsable API, you can use a helper function in your `urls.py` file:
+```python
+from rest_framework.routers import DefaultRouter
+from django_rest_passwordreset.urls import add_reset_password_urls_to_router
+
+router = DefaultRouter()
+add_reset_password_urls_to_router(router, base_path='api/auth/passwordreset')
+```
+
+Alternatively you can import the ViewSets manually and customize the routes for your setup:
+```python
+from rest_framework.routers import DefaultRouter
+from django_rest_passwordreset.views import ResetPasswordValidateTokenViewSet, ResetPasswordConfirmViewSet, \
+    ResetPasswordRequestTokenViewSet
+
+router = DefaultRouter()
+router.register(
+    r'api/auth/passwordreset/validate_token',
+    ResetPasswordValidateTokenViewSet,
+    basename='reset-password-validate'
+)
+router.register(
+    r'api/auth/passwordreset/confirm',
+    ResetPasswordConfirmViewSet,
+    basename='reset-password-confirm'
+)
+router.register(
+    r'api/auth/passwordreset/',
+    ResetPasswordRequestTokenViewSet,
+    basename='reset-password-request'
+)
+```
+
 ![drf_browsable_email_validation](docs/browsable_api_email_validation.png "Browsable API E-Mail Validation")
 
 ![drf_browsable_password_validation](docs/browsable_api_password_validation.png "Browsable API E-Mail Validation")

django_rest_passwordreset/urls.py

@@ -1,10 +1,31 @@
-""" URL Configuration for core auth
-"""
-from django.conf.urls import url, include
-from django_rest_passwordreset.views import reset_password_request_token, reset_password_confirm, reset_password_validate_token
+""" URL Configuration for core auth """
+from django.conf.urls import url
+
+from django_rest_passwordreset.views import ResetPasswordValidateTokenViewSet, ResetPasswordConfirmViewSet, \
+    ResetPasswordRequestTokenViewSet, reset_password_validate_token, reset_password_confirm, \
+    reset_password_request_token
 
 app_name = 'password_reset'
 
+
+def add_reset_password_urls_to_router(router, base_path=''):
+    router.register(
+        base_path + r'/validate_token',
+        ResetPasswordValidateTokenViewSet,
+        basename='reset-password-validate'
+    )
+    router.register(
+        base_path + r'/confirm',
+        ResetPasswordConfirmViewSet,
+        basename='reset-password-confirm'
+    )
+    router.register(
+        base_path + r'',
+        ResetPasswordRequestTokenViewSet,
+        basename='reset-password-request'
+    )
+
+
 urlpatterns = [
     url(r'^validate_token/', reset_password_validate_token, name="reset-password-validate"),
     url(r'^confirm/', reset_password_confirm, name="reset-password-confirm"),

django_rest_passwordreset/views.py

@@ -1,17 +1,19 @@
 from datetime import timedelta
+
+from django.conf import settings
 from django.contrib.auth import get_user_model
-from django.core.exceptions import ValidationError
 from django.contrib.auth.password_validation import validate_password, get_password_validators
-from django.utils.translation import gettext_lazy as _
+from django.core.exceptions import ValidationError
 from django.utils import timezone
-from django.conf import settings
-from rest_framework import status, exceptions
+from django.utils.translation import gettext_lazy as _
+from rest_framework import exceptions
 from rest_framework.generics import GenericAPIView
 from rest_framework.response import Response
+from rest_framework.viewsets import GenericViewSet
 
-from django_rest_passwordreset.serializers import EmailSerializer, PasswordTokenSerializer, ResetTokenSerializer
 from django_rest_passwordreset.models import ResetPasswordToken, clear_expired, get_password_reset_token_expiry_time, \
     get_password_reset_lookup_field
+from django_rest_passwordreset.serializers import EmailSerializer, PasswordTokenSerializer, ResetTokenSerializer
 from django_rest_passwordreset.signals import reset_password_token_created, pre_password_reset, post_password_reset
 
 User = get_user_model()
@@ -22,7 +24,10 @@
     'ResetPasswordRequestToken',
     'reset_password_validate_token',
     'reset_password_confirm',
-    'reset_password_request_token'
+    'reset_password_request_token',
+    'ResetPasswordValidateTokenViewSet',
+    'ResetPasswordConfirmViewSet',
+    'ResetPasswordRequestTokenViewSet'
 ]
 
 HTTP_USER_AGENT_HEADER = getattr(settings, 'DJANGO_REST_PASSWORDRESET_HTTP_USER_AGENT_HEADER', 'HTTP_USER_AGENT')
@@ -156,6 +161,35 @@ def post(self, request, *args, **kwargs):
         return Response({'status': 'OK'})
 
 
+class ResetPasswordValidateTokenViewSet(ResetPasswordValidateToken, GenericViewSet):
+    """
+    An Api ViewSet which provides a method to verify that a token is valid
+    """
+
+    def create(self, request, *args, **kwargs):
+        return super(ResetPasswordValidateTokenViewSet, self).post(request, *args, **kwargs)
+
+
+class ResetPasswordConfirmViewSet(ResetPasswordConfirm, GenericViewSet):
+    """
+    An Api ViewSet which provides a method to reset a password based on a unique token
+    """
+
+    def create(self, request, *args, **kwargs):
+        return super(ResetPasswordConfirmViewSet, self).post(request, *args, **kwargs)
+
+
+class ResetPasswordRequestTokenViewSet(ResetPasswordRequestToken, GenericViewSet):
+    """
+    An Api ViewSet which provides a method to request a password reset token based on an e-mail address
+
+    Sends a signal reset_password_token_created when a reset token was created
+    """
+
+    def create(self, request, *args, **kwargs):
+        return super(ResetPasswordRequestTokenViewSet, self).post(request, *args, **kwargs)
+
+
 reset_password_validate_token = ResetPasswordValidateToken.as_view()
 reset_password_confirm = ResetPasswordConfirm.as_view()
 reset_password_request_token = ResetPasswordRequestToken.as_view()