commonground-api-common 1.13.2__tar.gz → 1.13.4__tar.gz

{commonground_api_common-1.13.2 → commonground_api_common-1.13.4}/CHANGELOG.rst

@@ -2,6 +2,18 @@
 Change history
 ==============
 
+1.13.4 (2024-10-25)
+-------------------
+
+* Move AuthMiddleware to authorizations app, to avoid unnecessary migrations for projects that don't use ``vng_api_common.authorizations``
+
+1.13.3 (2024-09-05)
+-------------------
+
+* Dropped support for Python 3.8 and Python 3.9
+* [#33] Added dynamic pagination
+
+
 1.13.2 (2024-07-05)
 -------------------
 

{commonground_api_common-1.13.2/commonground_api_common.egg-info → commonground_api_common-1.13.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: commonground-api-common
-Version: 1.13.2
+Version: 1.13.4
 Summary: Commonground API tooling
 Home-page: https://github.com/maykinmedia/commonground-api-common
 Author: Maykin Media, VNG-Realisatie
@@ -17,8 +17,6 @@ Classifier: Operating System :: MacOS
 Classifier: Operating System :: Microsoft :: Windows
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Topic :: Software Development :: Libraries :: Python Modules

{commonground_api_common-1.13.2 → commonground_api_common-1.13.4/commonground_api_common.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: commonground-api-common
-Version: 1.13.2
+Version: 1.13.4
 Summary: Commonground API tooling
 Home-page: https://github.com/maykinmedia/commonground-api-common
 Author: Maykin Media, VNG-Realisatie
@@ -17,8 +17,6 @@ Classifier: Operating System :: MacOS
 Classifier: Operating System :: Microsoft :: Windows
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Topic :: Software Development :: Libraries :: Python Modules

{commonground_api_common-1.13.2 → commonground_api_common-1.13.4}/commonground_api_common.egg-info/SOURCES.txt

@@ -26,6 +26,7 @@ tests/test_get_resource.py
 tests/test_jwt_decoding.py
 tests/test_jwtsecrets.py
 tests/test_nested_serializer_validation.py
+tests/test_pagination.py
 tests/test_permissions.py
 tests/test_publish_validator.py
 tests/test_schema_root_tags.py
@@ -55,6 +56,7 @@ vng_api_common/middleware.py
 vng_api_common/mocks.py
 vng_api_common/models.py
 vng_api_common/oas.py
+vng_api_common/pagination.py
 vng_api_common/permissions.py
 vng_api_common/polymorphism.py
 vng_api_common/routers.py
@@ -107,6 +109,7 @@ vng_api_common/audittrails/migrations/__init__.py
 vng_api_common/audittrails/migrations/_operations.py
 vng_api_common/authorizations/__init__.py
 vng_api_common/authorizations/admin.py
+vng_api_common/authorizations/middleware.py
 vng_api_common/authorizations/models.py
 vng_api_common/authorizations/serializers.py
 vng_api_common/authorizations/validators.py
@@ -180,29 +183,28 @@ vng_api_common/notifications/migrations/0008_auto_20190502_0415.py
 vng_api_common/notifications/migrations/0009_auto_20190729_0427.py
 vng_api_common/notifications/migrations/0010_auto_20220704_1419.py
 vng_api_common/notifications/migrations/__init__.py
-vng_api_common/static/./vng_api_common/css/screen.css
-vng_api_common/static/./vng_api_common/css/admin/admin_overrides.css
-vng_api_common/static/./vng_api_common/ico/favicon.png
-vng_api_common/static/./vng_api_common/img/vng.svg
-vng_api_common/static/./vng_api_common/libs/fontawesome/LICENSE.txt
-vng_api_common/static/./vng_api_common/libs/fontawesome/css/all.css
-vng_api_common/static/./vng_api_common/libs/fontawesome/css/all.min.css
-vng_api_common/static/./vng_api_common/libs/fontawesome/webfonts/fa-brands-400.eot
-vng_api_common/static/./vng_api_common/libs/fontawesome/webfonts/fa-brands-400.svg
-vng_api_common/static/./vng_api_common/libs/fontawesome/webfonts/fa-brands-400.ttf
-vng_api_common/static/./vng_api_common/libs/fontawesome/webfonts/fa-brands-400.woff
-vng_api_common/static/./vng_api_common/libs/fontawesome/webfonts/fa-brands-400.woff2
-vng_api_common/static/./vng_api_common/libs/fontawesome/webfonts/fa-regular-400.eot
-vng_api_common/static/./vng_api_common/libs/fontawesome/webfonts/fa-regular-400.svg
-vng_api_common/static/./vng_api_common/libs/fontawesome/webfonts/fa-regular-400.ttf
-vng_api_common/static/./vng_api_common/libs/fontawesome/webfonts/fa-regular-400.woff
-vng_api_common/static/./vng_api_common/libs/fontawesome/webfonts/fa-regular-400.woff2
-vng_api_common/static/./vng_api_common/libs/fontawesome/webfonts/fa-solid-900.eot
-vng_api_common/static/./vng_api_common/libs/fontawesome/webfonts/fa-solid-900.svg
-vng_api_common/static/./vng_api_common/libs/fontawesome/webfonts/fa-solid-900.ttf
-vng_api_common/static/./vng_api_common/libs/fontawesome/webfonts/fa-solid-900.woff
-vng_api_common/static/./vng_api_common/libs/fontawesome/webfonts/fa-solid-900.woff2
+vng_api_common/static/vng_api_common/css/screen.css
+vng_api_common/static/vng_api_common/css/admin/admin_overrides.css
+vng_api_common/static/vng_api_common/ico/favicon.png
+vng_api_common/static/vng_api_common/img/vng.svg
 vng_api_common/static/vng_api_common/libs/fontawesome/LICENSE.txt
+vng_api_common/static/vng_api_common/libs/fontawesome/css/all.css
+vng_api_common/static/vng_api_common/libs/fontawesome/css/all.min.css
+vng_api_common/static/vng_api_common/libs/fontawesome/webfonts/fa-brands-400.eot
+vng_api_common/static/vng_api_common/libs/fontawesome/webfonts/fa-brands-400.svg
+vng_api_common/static/vng_api_common/libs/fontawesome/webfonts/fa-brands-400.ttf
+vng_api_common/static/vng_api_common/libs/fontawesome/webfonts/fa-brands-400.woff
+vng_api_common/static/vng_api_common/libs/fontawesome/webfonts/fa-brands-400.woff2
+vng_api_common/static/vng_api_common/libs/fontawesome/webfonts/fa-regular-400.eot
+vng_api_common/static/vng_api_common/libs/fontawesome/webfonts/fa-regular-400.svg
+vng_api_common/static/vng_api_common/libs/fontawesome/webfonts/fa-regular-400.ttf
+vng_api_common/static/vng_api_common/libs/fontawesome/webfonts/fa-regular-400.woff
+vng_api_common/static/vng_api_common/libs/fontawesome/webfonts/fa-regular-400.woff2
+vng_api_common/static/vng_api_common/libs/fontawesome/webfonts/fa-solid-900.eot
+vng_api_common/static/vng_api_common/libs/fontawesome/webfonts/fa-solid-900.svg
+vng_api_common/static/vng_api_common/libs/fontawesome/webfonts/fa-solid-900.ttf
+vng_api_common/static/vng_api_common/libs/fontawesome/webfonts/fa-solid-900.woff
+vng_api_common/static/vng_api_common/libs/fontawesome/webfonts/fa-solid-900.woff2
 vng_api_common/templates/vng_api_common/api_schema_to_markdown_table.md
 vng_api_common/templates/vng_api_common/autorisaties.md
 vng_api_common/templates/vng_api_common/index.html

{commonground_api_common-1.13.2 → commonground_api_common-1.13.4}/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = commonground-api-common
-version = 1.13.2
+version = 1.13.4
 description = Commonground API tooling
 long_description = file: README.rst
 url = https://github.com/maykinmedia/commonground-api-common
@@ -19,8 +19,6 @@ classifiers =
 	Operating System :: Microsoft :: Windows
 	Programming Language :: Python :: 3
 	Programming Language :: Python :: 3 :: Only
-	Programming Language :: Python :: 3.8
-	Programming Language :: Python :: 3.9
 	Programming Language :: Python :: 3.10
 	Programming Language :: Python :: 3.11
 	Topic :: Software Development :: Libraries :: Python Modules

{commonground_api_common-1.13.2 → commonground_api_common-1.13.4}/tests/test_jwt_decoding.py

@@ -5,7 +5,7 @@ import pytest
 from freezegun import freeze_time
 from jwt import ImmatureSignatureError
 
-from vng_api_common.middleware import JWTAuth
+from vng_api_common.authorizations.middleware import JWTAuth
 from vng_api_common.models import JWTSecret
 
 

commonground_api_common-1.13.4/tests/test_pagination.py

@@ -0,0 +1,35 @@
+import pytest
+from rest_framework import status
+from rest_framework.reverse import reverse
+
+from testapp.factories import HobbyFactory
+
+
+@pytest.mark.django_db
+def test_list_with_default_page_size(api_client):
+    HobbyFactory.create_batch(10)
+    path = reverse("paginate-hobby-list")
+
+    response = api_client.get(path)
+
+    assert response.status_code == status.HTTP_200_OK
+
+    data = response.json()
+
+    assert data["count"] == 10
+    assert data["next"] is None
+
+
+@pytest.mark.django_db
+def test_list_with_page_size_in_query(api_client):
+    HobbyFactory.create_batch(10)
+    path = reverse("paginate-hobby-list")
+
+    response = api_client.get(path, {"pageSize": 5})
+    assert response.status_code == status.HTTP_200_OK
+
+    data = response.json()
+
+    assert data["count"] == 10
+    assert len(data["results"]) == 5
+    assert data["next"] == f"http://testserver{path}?page=2&pageSize=5"

{commonground_api_common-1.13.2 → commonground_api_common-1.13.4}/tests/test_permissions.py

@@ -10,9 +10,9 @@ from rest_framework.response import Response
 from rest_framework.test import APIRequestFactory
 from rest_framework.views import APIView
 
+from vng_api_common.authorizations.middleware import JWTAuth
 from vng_api_common.authorizations.models import Applicatie, Autorisatie
 from vng_api_common.constants import ComponentTypes
-from vng_api_common.middleware import JWTAuth
 from vng_api_common.permissions import BaseAuthRequired
 from vng_api_common.scopes import Scope
 from vng_api_common.tests import generate_jwt_auth

commonground_api_common-1.13.4/vng_api_common/__init__.py

@@ -0,0 +1 @@
+__version__ = "1.13.4"

{commonground_api_common-1.13.2/vng_api_common → commonground_api_common-1.13.4/vng_api_common/authorizations}/middleware.py

@@ -1,5 +1,3 @@
-# https://pyjwt.readthedocs.io/en/latest/usage.html#reading-headers-without-validation
-# -> we can put the organization/service in the headers itself
 import logging
 from typing import Any, Dict, Iterable, List, Optional
 
@@ -11,20 +9,20 @@ from django.utils.translation import gettext as _
 import jwt
 from djangorestframework_camel_case.util import underscoreize
 from rest_framework.exceptions import PermissionDenied
-from rest_framework.response import Response
 from zds_client.client import ClientError
 
-from .authorizations.models import Applicatie, AuthorizationsConfig, Autorisatie
-from .authorizations.serializers import ApplicatieUuidSerializer
-from .constants import VERSION_HEADER, VertrouwelijkheidsAanduiding
-from .models import JWTSecret
-from .utils import get_uuid_from_path
+from vng_api_common.constants import VertrouwelijkheidsAanduiding
+
+from ..models import JWTSecret
+from ..utils import get_uuid_from_path
+from .models import Applicatie, AuthorizationsConfig, Autorisatie
+from .serializers import ApplicatieUuidSerializer
 
 logger = logging.getLogger(__name__)
 
 
 class JWTAuth:
-    def __init__(self, encoded: str = None):
+    def __init__(self, encoded: Optional[str] = None):
         self.encoded = encoded
 
     @property
@@ -152,7 +150,7 @@ class JWTAuth:
         return self._payload
 
     @property
-    def client_id(self) -> str:
+    def client_id(self) -> Optional[str]:
         if not self.payload:
             return None
         return self.payload["client_id"]
@@ -235,27 +233,3 @@ class AuthMiddleware:
             encoded = None
 
         request.jwt_auth = JWTAuth(encoded)
-
-
-class APIVersionHeaderMiddleware:
-    """
-    Include a header specifying the API-version
-    """
-
-    def __init__(self, get_response=None):
-        self.get_response = get_response
-
-    def __call__(self, request):
-        if self.get_response is None:
-            return None
-
-        response = self.get_response(request)
-
-        # not an API response, exit early
-        if not isinstance(response, Response):
-            return response
-
-        # set the header
-        response[VERSION_HEADER] = settings.API_VERSION
-
-        return response

commonground_api_common-1.13.4/vng_api_common/middleware.py

@@ -0,0 +1,35 @@
+# https://pyjwt.readthedocs.io/en/latest/usage.html#reading-headers-without-validation
+# -> we can put the organization/service in the headers itself
+import logging
+
+from django.conf import settings
+
+from rest_framework.response import Response
+
+from .constants import VERSION_HEADER
+
+logger = logging.getLogger(__name__)
+
+
+class APIVersionHeaderMiddleware:
+    """
+    Include a header specifying the API-version
+    """
+
+    def __init__(self, get_response=None):
+        self.get_response = get_response
+
+    def __call__(self, request):
+        if self.get_response is None:
+            return None
+
+        response = self.get_response(request)
+
+        # not an API response, exit early
+        if not isinstance(response, Response):
+            return response
+
+        # set the header
+        response[VERSION_HEADER] = settings.API_VERSION
+
+        return response

commonground_api_common-1.13.4/vng_api_common/pagination.py

@@ -0,0 +1,10 @@
+from rest_framework.pagination import PageNumberPagination
+
+
+class DynamicPageSizeMixin:
+    page_size = 100
+    page_size_query_param = "pageSize"
+    max_page_size = 500
+
+
+class DynamicPageSizePagination(DynamicPageSizeMixin, PageNumberPagination): ...

commonground_api_common-1.13.2/vng_api_common/__init__.py

@@ -1 +0,0 @@
-__version__ = "1.13.2"