django-pfx 1.2.dev32__tar.gz → 1.2.dev36__tar.gz

{django-pfx-1.2.dev32 → django-pfx-1.2.dev36}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: django-pfx
-Version: 1.2.dev32
+Version: 1.2.dev36
 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.dev32 → django-pfx-1.2.dev36}/django_pfx.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: django-pfx
-Version: 1.2.dev32
+Version: 1.2.dev36
 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.dev32 → django-pfx-1.2.dev36}/django_pfx.egg-info/SOURCES.txt

@@ -32,6 +32,9 @@ pfx/pfxcore/http/__init__.py
 pfx/pfxcore/http/json_response.py
 pfx/pfxcore/locale/fr/LC_MESSAGES/django.mo
 pfx/pfxcore/locale/fr/LC_MESSAGES/django.po
+pfx/pfxcore/management/__init__.py
+pfx/pfxcore/management/commands/__init__.py
+pfx/pfxcore/management/commands/makeapidoc.py
 pfx/pfxcore/middleware/__init__.py
 pfx/pfxcore/middleware/authentication.py
 pfx/pfxcore/middleware/locale.py
@@ -67,6 +70,7 @@ tests/settings/dev_default.py
 tests/tests/__init__.py
 tests/tests/basic_api_errors.py
 tests/tests/basic_api_test.py
+tests/tests/test_api_doc.py
 tests/tests/test_auth_api.py
 tests/tests/test_cache.py
 tests/tests/test_fields.py

{django-pfx-1.2.dev32 → django-pfx-1.2.dev36}/django_pfx.egg-info/requires.txt

@@ -4,3 +4,4 @@ django_json_widget
 pyjwt>=2.1
 Babel
 boto3
+apispec

django-pfx-1.2.dev36/pfx/pfxcore/default_settings.py

@@ -0,0 +1,9 @@
+PFX_TOKEN_SHORT_VALIDITY = {'hours': 12}
+PFX_TOKEN_LONG_VALIDITY = {'days': 30}
+
+PFX_COOKIE_DOMAIN = None
+PFX_COOKIE_SECURE = True
+PFX_COOKIE_SAMESITE = 'None'
+
+PFX_OPENAPI_PATH = "doc/api/openapi.json"
+PFX_OPENAPI_TEMPLATE = {}

django-pfx-1.2.dev36/pfx/pfxcore/management/commands/makeapidoc.py

@@ -0,0 +1,33 @@
+import json
+from pathlib import Path
+
+from django.core.management.base import BaseCommand
+
+from apispec import APISpec
+
+from pfx.pfxcore.settings import PFXSettings
+
+settings = PFXSettings()
+DEFAULT_TEMPLATE = dict(
+    title="PFX API",
+    version="1.0.0",
+    openapi_version="3.0.2")
+
+
+def get_spec():
+    return APISpec(**{**DEFAULT_TEMPLATE, **settings.PFX_OPENAPI_TEMPLATE})
+
+
+class Command(BaseCommand):
+    help = 'Generate OpenAPI documentation'
+
+    def handle(self, *args, **options):
+        spec = get_spec()
+
+        path = Path(settings.PFX_OPENAPI_PATH)
+        path.parent.mkdir(parents=True, exist_ok=True)
+        with open(path, "w") as outfile:
+            json.dump(spec.to_dict(), outfile, indent=2)
+
+        self.stdout.write(self.style.SUCCESS(
+            f"OpenAPI documentation generated: {path}"))

{django-pfx-1.2.dev32 → django-pfx-1.2.dev36}/pfx/pfxcore/settings.py

@@ -1,6 +1,6 @@
 from django.conf import settings
 
-from .default_settings import default_settings
+from . import default_settings
 
 
 class PFXSettings:
@@ -8,4 +8,4 @@ class PFXSettings:
         try:
             return getattr(settings, attr)
         except AttributeError:
-            return default_settings[attr]
+            return getattr(default_settings, attr)

{django-pfx-1.2.dev32 → django-pfx-1.2.dev36}/pfx/pfxcore/views/rest_views.py

@@ -551,7 +551,7 @@ 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('/')
 
@@ -568,11 +568,17 @@ 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):
+        return cls.get_urls(as_pattern=True)
+
 
 class RestView(
         ListRestViewMixin,

{django-pfx-1.2.dev32 → django-pfx-1.2.dev36}/requirements.txt

@@ -10,3 +10,4 @@ pyjwt>=2.1
 boto3
 build
 freezegun
+apispec

{django-pfx-1.2.dev32 → django-pfx-1.2.dev36}/setup.cfg

@@ -35,6 +35,7 @@ install_requires =
 	pyjwt>=2.1
 	Babel
 	boto3
+	apispec
 
 [options.packages.find]
 exclude = 

{django-pfx-1.2.dev32 → django-pfx-1.2.dev36}/tests/tests/__init__.py

@@ -1,5 +1,6 @@
 from .basic_api_errors import BasicAPIErrorTest
 from .basic_api_test import BasicAPITest
+from .test_api_doc import ApiDocTest
 from .test_auth_api import AuthAPITest
 from .test_cache import TestCache
 from .test_fields import FieldsTest

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

@@ -0,0 +1,47 @@
+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_view_get_urls(self):
+        def get_methods(url, p):
+            return next(filter(lambda u: u['path'] == p, urls))['methods']
+
+        urls = AuthorRestView.get_urls()
+
+        # Methods from RestView
+        self.assertEqual(
+            get_methods(urls, 'authors'),
+            dict(get='get_list', post='post'))
+        self.assertEqual(
+            get_methods(urls, 'authors/<int:id>'),
+            dict(delete='delete', get='get', put='put'))
+        # A method from SlugDetailRestViewMixin
+        self.assertEqual(
+            get_methods(urls, 'authors/slug/<slug:slug>'),
+            dict(get='get_by_slug'))
+        # A method from AuthorRestView itself
+        self.assertEqual(
+            get_methods(urls, 'authors/cache/<int:id>'),
+            dict(get='cache_get'))

django-pfx-1.2.dev32/pfx/pfxcore/default_settings.py

@@ -1,8 +0,0 @@
-default_settings = dict(
-    PFX_TOKEN_SHORT_VALIDITY={'hours': 12},
-    PFX_TOKEN_LONG_VALIDITY={'days': 30},
-
-    PFX_COOKIE_DOMAIN=None,
-    PFX_COOKIE_SECURE=True,
-    PFX_COOKIE_SAMESITE='None',
-)