django-pfx 1.2.dev34__tar.gz → 1.2.dev38__tar.gz

{django-pfx-1.2.dev34 → django-pfx-1.2.dev38}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: django-pfx
-Version: 1.2.dev34
+Version: 1.2.dev38
 Summary: Django PFX is a toolkit to build web APIs dedicated to be used by React progressive web app.
 Author: Hervé Martinet
 Author-email: herve.martinet@gmail.com

{django-pfx-1.2.dev34 → django-pfx-1.2.dev38}/django_pfx.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: django-pfx
-Version: 1.2.dev34
+Version: 1.2.dev38
 Summary: Django PFX is a toolkit to build web APIs dedicated to be used by React progressive web app.
 Author: Hervé Martinet
 Author-email: herve.martinet@gmail.com

{django-pfx-1.2.dev34 → django-pfx-1.2.dev38}/pfx/pfxcore/__init__.py

@@ -1,3 +1,5 @@
 from .shortcuts import register_views
 
 default_app_config = 'pfx.pfxcore.apps.PfxCoreConfig'
+
+__PFX_VIEWS__ = []

{django-pfx-1.2.dev34 → django-pfx-1.2.dev38}/pfx/pfxcore/management/commands/makeapidoc.py

@@ -5,6 +5,7 @@ from django.core.management.base import BaseCommand
 
 from apispec import APISpec
 
+from pfx.pfxcore import __PFX_VIEWS__
 from pfx.pfxcore.settings import PFXSettings
 
 settings = PFXSettings()
@@ -15,7 +16,13 @@ DEFAULT_TEMPLATE = dict(
 
 
 def get_spec():
-    return APISpec(**{**DEFAULT_TEMPLATE, **settings.PFX_OPENAPI_TEMPLATE})
+    spec = APISpec(**{**DEFAULT_TEMPLATE, **settings.PFX_OPENAPI_TEMPLATE})
+    for view in __PFX_VIEWS__:
+        for url in view.get_urls():
+            spec.path(
+                path=url['path'],
+                operations={k: {} for k, v in url['methods'].items()})
+    return spec
 
 
 class Command(BaseCommand):

{django-pfx-1.2.dev34 → django-pfx-1.2.dev38}/pfx/pfxcore/views/rest_views.py

@@ -12,6 +12,7 @@ from django.urls import path
 from django.utils.translation import gettext_lazy as _
 from django.views import View
 
+from pfx.pfxcore import __PFX_VIEWS__
 from pfx.pfxcore.decorator import rest_api
 from pfx.pfxcore.exceptions import (
     APIError,
@@ -551,9 +552,10 @@ class BaseRestView(SecuredRestViewMixin, View):
             process, path.lstrip('/').split('/'))
 
     @classmethod
-    def as_urlpatterns(cls):
+    def get_urls(cls, as_pattern=False):
         def fullpath(p2):
-            return f'{cls.rest_view_path}{p2}'.lstrip('/')
+            res = f'{cls.rest_view_path}{p2}'.lstrip('/')
+            return res if as_pattern else f'/{res}'
 
         paths = {}
         for name in dir(cls):
@@ -568,11 +570,19 @@ class BaseRestView(SecuredRestViewMixin, View):
                             "you cannot set different priority for same path")
                     methods['priority'] = m.rest_api_priority
         return [
-            path(fullpath(p), cls.as_view(pfx_methods=ms))
+            path(fullpath(p), cls.as_view(pfx_methods=ms)) if as_pattern
+            else dict(path=fullpath(p), methods={
+                k: v for k, v in ms.items() if k != 'priority'})
             for p, ms in sorted(
                 paths.items(), key=lambda e: cls._path_order(*e),
                 reverse=True)]
 
+    @classmethod
+    def as_urlpatterns(cls):
+        if cls not in __PFX_VIEWS__:
+            __PFX_VIEWS__.append(cls)
+        return cls.get_urls(as_pattern=True)
+
 
 class RestView(
         ListRestViewMixin,

django-pfx-1.2.dev38/tests/tests/test_api_doc.py

@@ -0,0 +1,53 @@
+from django.test import TestCase, override_settings
+
+from pfx.pfxcore.management.commands.makeapidoc import get_spec
+from pfx.pfxcore.test import TestAssertMixin
+from tests.views import AuthorRestView
+
+
+class ApiDocTest(TestAssertMixin, TestCase):
+    def test_default_generation(self):
+        spec = get_spec().to_dict()
+        self.assertEqual(spec['openapi'], "3.0.2")
+        info = spec['info']
+        self.assertEqual(info['title'], "PFX API")
+        self.assertEqual(info['version'], "1.0.0")
+
+    @override_settings(PFX_OPENAPI_TEMPLATE=dict(
+        title="MyAPI",
+        info=dict(description="A test API")))
+    def test_default_customized_generation(self):
+        spec = get_spec().to_dict()
+        self.assertEqual(spec['openapi'], "3.0.2")
+        info = spec['info']
+        self.assertEqual(info['title'], "MyAPI")
+        self.assertEqual(info['version'], "1.0.0")
+        self.assertEqual(info['description'], "A test API")
+
+    def test_paths_generation(self):
+        def assertMethods(paths, p, methods):
+            self.assertEqual(set(paths[p].keys()), methods)
+
+        spec = get_spec().to_dict()
+        paths = spec['paths']
+        assertMethods(paths, '/authors', {'get', 'post'})
+        assertMethods(paths, '/authors/<int:id>', {'get', 'put', 'delete'})
+        assertMethods(paths, '/authors/slug/<slug:slug>', {'get'})
+        assertMethods(paths, '/authors/cache/<int:id>', {'get'})
+
+    def test_view_get_urls(self):
+        def assertMethods(urls, p, methods):
+            self.assertEqual(next(filter(
+                lambda u: u['path'] == p, urls))['methods'], methods)
+
+        urls = AuthorRestView.get_urls()
+
+        # Methods from RestView
+        assertMethods(urls, '/authors', dict(get='get_list', post='post'))
+        assertMethods(urls, '/authors/<int:id>', dict(
+            delete='delete', get='get', put='put'))
+        # A method from SlugDetailRestViewMixin
+        assertMethods(urls, '/authors/slug/<slug:slug>', dict(
+            get='get_by_slug'))
+        # A method from AuthorRestView itself
+        assertMethods(urls, '/authors/cache/<int:id>', dict(get='cache_get'))

django-pfx-1.2.dev34/tests/tests/test_api_doc.py

@@ -1,24 +0,0 @@
-from django.test import TestCase, override_settings
-
-from pfx.pfxcore.management.commands.makeapidoc import get_spec
-from pfx.pfxcore.test import TestAssertMixin
-
-
-class ApiDocTest(TestAssertMixin, TestCase):
-    def test_default_generation(self):
-        spec = get_spec().to_dict()
-        self.assertEqual(spec['openapi'], "3.0.2")
-        info = spec['info']
-        self.assertEqual(info['title'], "PFX API")
-        self.assertEqual(info['version'], "1.0.0")
-
-    @override_settings(PFX_OPENAPI_TEMPLATE=dict(
-        title="MyAPI",
-        info=dict(description="A test API")))
-    def test_default_customized_generation(self):
-        spec = get_spec().to_dict()
-        self.assertEqual(spec['openapi'], "3.0.2")
-        info = spec['info']
-        self.assertEqual(info['title'], "MyAPI")
-        self.assertEqual(info['version'], "1.0.0")
-        self.assertEqual(info['description'], "A test API")