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

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

@@ -2,6 +2,11 @@
 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)
 -------------------
 

{commonground_api_common-1.13.3/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.3
+Version: 1.13.4
 Summary: Commonground API tooling
 Home-page: https://github.com/maykinmedia/commonground-api-common
 Author: Maykin Media, VNG-Realisatie

{commonground_api_common-1.13.3 → 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.3
+Version: 1.13.4
 Summary: Commonground API tooling
 Home-page: https://github.com/maykinmedia/commonground-api-common
 Author: Maykin Media, VNG-Realisatie

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

@@ -109,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

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

@@ -1,6 +1,6 @@
 [metadata]
 name = commonground-api-common
-version = 1.13.3
+version = 1.13.4
 description = Commonground API tooling
 long_description = file: README.rst
 url = https://github.com/maykinmedia/commonground-api-common

{commonground_api_common-1.13.3 → 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.3 → 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.3/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.3/vng_api_common/__init__.py

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