ModelSerializers / Login protected access / Groups by namespaces

README.md

@@ -60,7 +60,8 @@ Finally include the `rest_framework_docs` urls in your `urls.py`:
 You can find detailed information about the package's settings at [the docs](http://drfdocs.com/settings/).
 
     REST_FRAMEWORK_DOCS = {
-        'HIDE_DOCS': True  # Default: False
+        'HIDE_DOCS': True,  # Default: False
+        'LOGIN_REQUIRED': True,  # Default: True
     }
 
 

demo/project/accounts/serializers.py

@@ -1,5 +1,6 @@
 from rest_framework import serializers
 from project.accounts.models import User
+from rest_framework.authtoken.serializers import AuthTokenSerializer
 
 
 class UserRegistrationSerializer(serializers.ModelSerializer):
@@ -30,3 +31,12 @@ class Meta:
         model = User
         fields = ('id', 'token', 'password',)
         extra_kwargs = {'password': {'write_only': True}}
+
+
+class NestedSerializer(serializers.Serializer):
+    nb_test = serializers.IntegerField(default=0, required=False)
+    liste_codes = serializers.ListField(child=serializers.CharField())
+
+
+class CustomAuthTokenSerializer(AuthTokenSerializer):
+    nested = NestedSerializer(many=True)

demo/project/accounts/urls.py

@@ -1,15 +1,23 @@
+import django
 from django.conf.urls import url
 from project.accounts import views
 
+from rest_framework.routers import SimpleRouter
 
-urlpatterns = [
-    url(r'^test/$', views.TestView.as_view(), name="test-view"),
+account_router = SimpleRouter()
+account_router.register('user-model-viewsets', views.UserModelViewset, base_name='account')
 
+account_urlpatterns = [
+    url(r'^test/$', views.TestView.as_view(), name="test-view"),
     url(r'^login/$', views.LoginView.as_view(), name="login"),
     url(r'^register/$', views.UserRegistrationView.as_view(), name="register"),
     url(r'^reset-password/$', view=views.PasswordResetView.as_view(), name="reset-password"),
     url(r'^reset-password/confirm/$', views.PasswordResetConfirmView.as_view(), name="reset-password-confirm"),
-
     url(r'^user/profile/$', views.UserProfileView.as_view(), name="profile"),
+] + account_router.urls
 
-]
+# Django 1.9 Support for the app_name argument is deprecated
+# https://docs.djangoproject.com/en/1.9/ref/urls/#include
+django_version = django.VERSION
+if django.VERSION[:2] >= (1, 9, ):
+    account_urlpatterns = (account_urlpatterns, 'accounts', )

demo/project/accounts/views.py

@@ -2,13 +2,13 @@
 from django.views.generic.base import TemplateView
 from rest_framework import parsers, renderers, generics, status
 from rest_framework.authtoken.models import Token
-from rest_framework.authtoken.serializers import AuthTokenSerializer
 from rest_framework.permissions import AllowAny
 from rest_framework.response import Response
 from rest_framework.views import APIView
+from rest_framework.viewsets import ModelViewSet
 from project.accounts.models import User
 from project.accounts.serializers import (
-    UserRegistrationSerializer, UserProfileSerializer, ResetPasswordSerializer
+    UserRegistrationSerializer, UserProfileSerializer, ResetPasswordSerializer, CustomAuthTokenSerializer
 )
 
 
@@ -28,7 +28,7 @@ class LoginView(APIView):
     permission_classes = ()
     parser_classes = (parsers.FormParser, parsers.MultiPartParser, parsers.JSONParser,)
     renderer_classes = (renderers.JSONRenderer,)
-    serializer_class = AuthTokenSerializer
+    serializer_class = CustomAuthTokenSerializer
 
     def post(self, request):
         serializer = self.serializer_class(data=request.data)
@@ -81,3 +81,8 @@ def post(self, request, *args, **kwargs):
         if not serializer.is_valid():
             return Response({'errors': serializer.errors}, status=status.HTTP_400_BAD_REQUEST)
         return Response({"msg": "Password updated successfully."}, status=status.HTTP_200_OK)
+
+
+class UserModelViewset(ModelViewSet):
+    queryset = User.objects.all()
+    serializer_class = UserProfileSerializer

demo/project/organisations/urls.py

@@ -1,12 +1,27 @@
+import django
 from django.conf.urls import url
 from project.organisations import views
 
+from rest_framework.routers import SimpleRouter
+from .views import OrganisationModelViewset
 
-urlpatterns = [
+organisation_router = SimpleRouter()
+organisation_router.register('organisation-model-viewsets', OrganisationModelViewset, base_name='organisation')
 
+organisations_urlpatterns = [
     url(r'^create/$', view=views.CreateOrganisationView.as_view(), name="create"),
     url(r'^(?P<slug>[\w-]+)/$', view=views.RetrieveOrganisationView.as_view(), name="organisation"),
     url(r'^(?P<slug>[\w-]+)/members/$', view=views.OrganisationMembersView.as_view(), name="members"),
     url(r'^(?P<slug>[\w-]+)/leave/$', view=views.LeaveOrganisationView.as_view(), name="leave")
+] + organisation_router.urls
 
+members_urlpatterns = [
+    url(r'^(?P<slug>[\w-]+)/members/$', view=views.OrganisationMembersView.as_view(), name="members"),
 ]
+
+# Django 1.9 Support for the app_name argument is deprecated
+# https://docs.djangoproject.com/en/1.9/ref/urls/#include
+django_version = django.VERSION
+if django.VERSION[:2] >= (1, 9, ):
+    organisations_urlpatterns = (organisations_urlpatterns, 'organisations', )
+    members_urlpatterns = (members_urlpatterns, 'organisations', )

demo/project/organisations/views.py

@@ -1,5 +1,6 @@
 from rest_framework import generics, status
 from rest_framework.response import Response
+from rest_framework.viewsets import ModelViewSet
 from project.organisations.models import Organisation, Membership
 from project.organisations.serializers import (
     CreateOrganisationSerializer, OrganisationMembersSerializer, RetrieveOrganisationSerializer
@@ -34,3 +35,8 @@ def delete(self, request, *args, **kwargs):
         instance = self.get_object()
         self.perform_destroy(instance)
         return Response(status=status.HTTP_204_NO_CONTENT)
+
+
+class OrganisationModelViewset(ModelViewSet):
+    queryset = Organisation.objects.all()
+    serializer_class = OrganisationMembersSerializer

demo/project/settings.py

@@ -43,7 +43,6 @@
 
     'project.accounts',
     'project.organisations',
-
 )
 
 MIDDLEWARE_CLASSES = (

demo/project/urls.py

@@ -13,14 +13,36 @@
     1. Add an import:  from blog import urls as blog_urls
     2. Add a URL to urlpatterns:  url(r'^blog/', include(blog_urls))
 """
+import django
 from django.conf.urls import include, url
 from django.contrib import admin
+from rest_framework_docs.views import DRFDocsView
+from .accounts.urls import account_urlpatterns, account_router
+from .organisations.urls import organisations_urlpatterns, members_urlpatterns, organisation_router
 
 urlpatterns = [
     url(r'^admin/', include(admin.site.urls)),
-    url(r'^docs/', include('rest_framework_docs.urls')),
-
-    # API
-    url(r'^accounts/', view=include('project.accounts.urls', namespace='accounts')),
-    url(r'^organisations/', view=include('project.organisations.urls', namespace='organisations')),
 ]
+
+# Django 1.9 Support for the app_name argument is deprecated
+# https://docs.djangoproject.com/en/1.9/ref/urls/#include
+django_version = django.VERSION
+if django.VERSION[:2] >= (1, 9, ):
+    urlpatterns.extend([
+        url(r'^accounts/', view=include(account_urlpatterns, namespace='accounts')),
+        url(r'^organisations/', view=include(organisations_urlpatterns, namespace='organisations')),
+        url(r'^members/', view=include(members_urlpatterns, namespace='members')),
+    ])
+else:
+    urlpatterns.extend([
+        url(r'^accounts/', view=include(account_urlpatterns, namespace='accounts', app_name='account_app')),
+        url(r'^organisations/', view=include(organisations_urlpatterns, namespace='organisations', app_name='organisations_app')),
+        url(r'^members/', view=include(members_urlpatterns, namespace='members', app_name='organisations_app')),
+    ])
+
+
+routers = [account_router, organisation_router]
+urlpatterns.extend([
+    url(r'^docs/(?P<filter_param>[\w-]+)/$', DRFDocsView.as_view(drf_router=routers), name='drfdocs-filter'),
+    url(r'^docs/$', DRFDocsView.as_view(drf_router=routers), name='drfdocs'),
+])

requirements.txt

@@ -1,5 +1,5 @@
-Django==1.8.7
-djangorestframework==3.3.2
-coverage==4.0.3
-flake8==2.5.1
+Django==2.1.0
+djangorestframework==3.7.7
+coverage==4.2
+flake8<3.0.0
 mkdocs==0.15.3

rest_framework_docs/__init__.py

@@ -1 +1,3 @@
 __version__ = '0.0.11'
+
+SERIALIZER_FIELDS = {}

rest_framework_docs/api_docs.py

@@ -1,14 +1,20 @@
+from operator import attrgetter
 from importlib import import_module
 from django.conf import settings
-from django.core.urlresolvers import RegexURLResolver, RegexURLPattern
+from django.urls import URLResolver, URLPattern
 from django.utils.module_loading import import_string
 from rest_framework.views import APIView
+from rest_framework_docs import SERIALIZER_FIELDS
 from rest_framework_docs.api_endpoint import ApiEndpoint
 
 
 class ApiDocumentation(object):
 
-    def __init__(self, drf_router=None):
+    def __init__(self, drf_router=None, filter_param=None):
+        """
+        :param filter_param: namespace or app_name
+        """
+        SERIALIZER_FIELDS.clear()
         self.endpoints = []
         self.drf_router = drf_router
         try:
@@ -17,18 +23,19 @@ def __init__(self, drf_router=None):
             # Handle a case when there's no dot in ROOT_URLCONF
             root_urlconf = import_module(settings.ROOT_URLCONF)
         if hasattr(root_urlconf, 'urls'):
-            self.get_all_view_names(root_urlconf.urls.urlpatterns)
+            self.get_all_view_names(root_urlconf.urls.urlpatterns, filter_param=filter_param)
         else:
-            self.get_all_view_names(root_urlconf.urlpatterns)
+            self.get_all_view_names(root_urlconf.urlpatterns, filter_param=filter_param)
 
-    def get_all_view_names(self, urlpatterns, parent_pattern=None):
+    def get_all_view_names(self, urlpatterns, parent_pattern=None, filter_param=None):
         for pattern in urlpatterns:
-            if isinstance(pattern, RegexURLResolver):
-                parent_pattern = None if pattern._regex == "^" else pattern
-                self.get_all_view_names(urlpatterns=pattern.url_patterns, parent_pattern=parent_pattern)
-            elif isinstance(pattern, RegexURLPattern) and self._is_drf_view(pattern) and not self._is_format_endpoint(pattern):
-                api_endpoint = ApiEndpoint(pattern, parent_pattern, self.drf_router)
-                self.endpoints.append(api_endpoint)
+            if isinstance(pattern, URLResolver) and (not filter_param or filter_param in [pattern.app_name, pattern.namespace]):
+                # parent_pattern = None if pattern._regex == "^" else pattern
+                self.get_all_view_names(urlpatterns=pattern.url_patterns, parent_pattern=None if pattern.pattern.regex.pattern == "^" else pattern, filter_param=filter_param)
+            elif isinstance(pattern, URLPattern) and self._is_drf_view(pattern) and not self._is_format_endpoint(pattern):
+                if not filter_param or parent_pattern:
+                    api_endpoint = ApiEndpoint(pattern, parent_pattern, self.drf_router)
+                    self.endpoints.append(api_endpoint)
 
     def _is_drf_view(self, pattern):
         """
@@ -40,7 +47,7 @@ def _is_format_endpoint(self, pattern):
         """
         Exclude endpoints with a "format" parameter
         """
-        return '?P<format>' in pattern._regex
+        return '?P<format>' in pattern.pattern.regex.pattern
 
     def get_endpoints(self):
-        return self.endpoints
+        return sorted(self.endpoints, key=attrgetter('name', 'path'))