commonground-api-common 2.5.5__py3-none-any.whl → 2.6.0__py3-none-any.whl

{commonground_api_common-2.5.5.dist-info → commonground_api_common-2.6.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: commonground-api-common
-Version: 2.5.5
+Version: 2.6.0
 Summary: Commonground API tooling
 Home-page: https://github.com/maykinmedia/commonground-api-common
 Author: Maykin Media, VNG-Realisatie

{commonground_api_common-2.5.5.dist-info → commonground_api_common-2.6.0.dist-info}/RECORD

@@ -1,5 +1,5 @@
-commonground_api_common-2.5.5.data/scripts/generate_schema,sha256=OpKgzlFc_uzA3TVW_vHSYXAD_feLaCdTEnkWjIcxVzA,280
-vng_api_common/__init__.py,sha256=UutRtbE_ZOD7CIHaQC80vf8Bv_vmHDWhwjlCbt3yseM,22
+commonground_api_common-2.6.0.data/scripts/generate_schema,sha256=OpKgzlFc_uzA3TVW_vHSYXAD_feLaCdTEnkWjIcxVzA,280
+vng_api_common/__init__.py,sha256=OEib63e0yPEGlhEXyrWE1OwRnleR0cHI7KSX7oZEQLs,22
 vng_api_common/admin.py,sha256=iFtUPGf-ha0I-bXgq8QIFrP23Kzk_H3FlgAjt0U-ip0,259
 vng_api_common/apps.py,sha256=QQiJXRmjX9Q91oh0P9fvVnHe3NSYd1cEcUUBw0HLBCA,3690
 vng_api_common/checks.py,sha256=tOyfV7MMLGh4anrd_W30LvJCxiyQ4sFs1mGd9mtrEc0,1175
@@ -28,7 +28,7 @@ vng_api_common/routers.py,sha256=hEnhBulkgMM-7W_lYaykKTgTBj3-avl7DGsR9P7BbTU,189
 vng_api_common/schema.py,sha256=axs2Q8IXwpHNd5WscQg5xOErL6bWhP8WFItTt4xCFO4,16305
 vng_api_common/scopes.py,sha256=PGs6CkXorAAdWXGFY1bSy-jmsPn122Njen9aFFOpFIQ,2351
 vng_api_common/search.py,sha256=yehS6boCOk1JXLCqAMU-B62hWtbTBSf_WKIVGPgp0Mg,1045
-vng_api_common/serializers.py,sha256=NdrZJqP7p54lRKoKG4mEDS9MqaMcPESIr4dB1tnLaqI,10163
+vng_api_common/serializers.py,sha256=ErIoN1br71eszZ-hRgVUycjQkK6rJNkT5ygsagZoGNg,14084
 vng_api_common/urls.py,sha256=9IWHYLlEIIHNaZ_Zq02qNQ2HJpETb7o-89r7yBM_tQs,270
 vng_api_common/utils.py,sha256=EHqVjZhtqnbU7YrqgYIBss28Sd19jtnTLNaMWLfj3Zw,8203
 vng_api_common/validators.py,sha256=ejaFZvFXFaBlqxjA2_07NSHKHlG5pejrfC_GHjwCj6E,12852
@@ -78,7 +78,7 @@ vng_api_common/authorizations/admin.py,sha256=Tk0yYKbb005E0XZaYYWbucMf_K5M8Hhz62
 vng_api_common/authorizations/middleware.py,sha256=KJ3znCXPRMOVqSur62SmBjvC6RcKxtcWq1rzaHdYR98,8416
 vng_api_common/authorizations/models.py,sha256=slIYxSktxCxSg03Nfb2mhsQse17b93KWE-rdPdMv8Ik,5199
 vng_api_common/authorizations/serializers.py,sha256=3HeKWEqhI3UWwI8SttC4rEID-Epbk7SWsC-bEjolbaw,5151
-vng_api_common/authorizations/utils.py,sha256=VCXdU4q3CQ1cvuYkg1dPWSbZym1Ufoz5gSmbHYkQcgw,521
+vng_api_common/authorizations/utils.py,sha256=GmwTy5GhYk3e1VU4LpdfYdr8VD-R8p00hUY11QBbOhc,555
 vng_api_common/authorizations/validators.py,sha256=u7fKm0QgGy8fiAeYmIEB9Gy-yIE9C-tC2ZpnNQBXPso,2816
 vng_api_common/authorizations/migrations/0001_initial.py,sha256=ooAZtQeDtWgDxXzAP-KnSyyFYLRPM-PMrK5RgOnTPjQ,4360
 vng_api_common/authorizations/migrations/0002_authorizationsconfig.py,sha256=m4taH6ClHI-YHYGGOKaq_qYXGx9lq1InXOGLQKg9MSw,1364
@@ -183,7 +183,7 @@ vng_api_common/tests/auth.py,sha256=IKDWTEFv4Bign4F70-ibsFcnJqRxEJaXvqaPQJWa1xY,
 vng_api_common/tests/caching.py,sha256=zfIw5cRRvO9cekHZZKfRqZc8cx5IfJUYNmcH6cuIMg4,624
 vng_api_common/tests/schema.py,sha256=WDvifDQQiKqIpQijpeQ7rYkFroJmuPuHe7zNhl1Bigk,2293
 vng_api_common/tests/urls.py,sha256=PFrYzQbBC0TFPMEn3uPhcBG0IQs9JsEPqckicJT1UA4,2159
-commonground_api_common-2.5.5.dist-info/METADATA,sha256=-ob8zNCm7QtO8IekDfwux_xZx00EdHYWqEKoqa6_sNU,6988
-commonground_api_common-2.5.5.dist-info/WHEEL,sha256=1tXe9gY0PYatrMPMDd6jXqjfpz_B-Wqm32CPfRC58XU,91
-commonground_api_common-2.5.5.dist-info/top_level.txt,sha256=vPismc83zPzWXTmlNCCwfDlFV9iygJYxNJW5iDjKTgw,15
-commonground_api_common-2.5.5.dist-info/RECORD,,
+commonground_api_common-2.6.0.dist-info/METADATA,sha256=HsGhhHvzoGLHlqzsYvNxs_qrG76ym2BtbcCX3u7jqx8,6988
+commonground_api_common-2.6.0.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+commonground_api_common-2.6.0.dist-info/top_level.txt,sha256=vPismc83zPzWXTmlNCCwfDlFV9iygJYxNJW5iDjKTgw,15
+commonground_api_common-2.6.0.dist-info/RECORD,,

{commonground_api_common-2.5.5.dist-info → commonground_api_common-2.6.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (77.0.3)
+Generator: setuptools (78.1.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

vng_api_common/__init__.py

@@ -1 +1 @@
-__version__ = "2.5.5"
+__version__ = "2.6.0"

vng_api_common/authorizations/utils.py

@@ -12,6 +12,7 @@ def generate_jwt(client_id, secret, user_id, user_representation):
             secret=secret,
             user_id=user_id,
             user_representation=user_representation,
+            jwt_valid_for=5 * 60,
         )
     )
     return f"Bearer {auth._token}"

vng_api_common/serializers.py

@@ -1,13 +1,17 @@
 import datetime
 import inspect
 from collections import OrderedDict
+from functools import reduce
 from typing import List, Optional, Tuple, Union
 
 from django.db import models, transaction
+from django.db.models import Model
 from django.utils.translation import gettext_lazy as _
 
 import isodate
 from rest_framework import fields, serializers
+from rest_framework.request import Request
+from rest_framework_nested.relations import NestedHyperlinkedRelatedField
 
 from .choices import TextChoicesWithDescriptions
 from .descriptors import GegevensGroepType
@@ -164,11 +168,11 @@ class GegevensGroepSerializer(
 
     Usage::
 
-    >>> class VerlengingSerializer(GegevensGroepSerializer):
-    ...     class Meta:
-    ...         model = Zaak
-    ...         gegevensgroep = 'verlenging'
-    >>>
+        >>> class VerlengingSerializer(GegevensGroepSerializer):
+        ...     class Meta:
+        ...         model = Zaak
+        ...         gegevensgroep = 'verlenging'
+        >>>
 
     Where ``Zaak.verlenging`` is a :class:``GegevensGroepType``.
     """
@@ -275,7 +279,77 @@ class NestedGegevensGroepMixin:
         return super().update(instance, validated_data)
 
 
-class LengthHyperlinkedRelatedField(serializers.HyperlinkedRelatedField):
+def get_nested_fk_attribute(instance, relation_path):
+    """
+    Retrieves an attribute from a nested foreign key relation.
+
+    Args:
+    - instance: The model instance (e.g., Book).
+    - relation_path: A string with the relation path, e.g., 'author__publisher__name'.
+
+    Returns:
+    - The value of the nested attribute or None if not found.
+    """
+    relations = relation_path.split("__")
+
+    return reduce(
+        lambda obj, attr: getattr(obj, attr, None) if obj else None, relations, instance
+    )
+
+
+class CacheMixin:
+    """
+    Mixin for Hyperlinked DRF fields to cache the base URI per view, to avoid
+    having to recalculate this for each related object that has to be serialized
+
+    This cache is stored on the field instance itself, so it's reset between requests
+    """
+
+    lookup_url_kwarg = ""  # Should be defined on `HyperlinkedRelatedField`
+    identifier_placeholder = "id-placeholder"
+
+    def get_extra_reverse_kwargs(self) -> dict[str, str]:
+        """
+        Hook to inject extra kwargs to be passed to `reverse()`
+        """
+        return {}
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+
+        self._reverse_cache = {}
+
+    def get_url(
+        self, obj: Model, view_name: str, request: Request, format: str | None
+    ) -> str | None:
+        # Unsaved objects will not yet have a valid URL.
+        if hasattr(obj, "pk") and obj.pk in (None, ""):
+            return None
+
+        base_url = self._reverse_cache.get(view_name)
+
+        if base_url is None:
+            # If not cached, compute and cache it for this request cycle
+            try:
+                # Insert placeholders for identifiers, these will be replaced by
+                # real identifiers later on
+                kwargs = {self.lookup_url_kwarg: self.identifier_placeholder}
+                kwargs.update(self.get_extra_reverse_kwargs())
+
+                base_url = self.reverse(
+                    view_name, kwargs=kwargs, request=request, format=format
+                )
+                self._reverse_cache[view_name] = base_url
+            except Exception as e:
+                raise ValueError(f"Could not resolve reverse for {view_name}: {e}")
+
+        url = base_url.replace(
+            self.identifier_placeholder, str(getattr(obj, self.lookup_url_kwarg))
+        )
+        return url
+
+
+class LengthHyperlinkedRelatedField(CacheMixin, serializers.HyperlinkedRelatedField):
     default_error_messages = {
         "max_length": _("Ensure this field has no more than {max_length} characters."),
         "min_length": _("Ensure this field has at least {min_length} characters."),
@@ -296,3 +370,40 @@ class LengthHyperlinkedRelatedField(serializers.HyperlinkedRelatedField):
             self.fail("min_length", max_length=self.min_length, length=len(data))
 
         return super().to_internal_value(data)
+
+
+class CachedHyperlinkedRelatedField(CacheMixin, serializers.HyperlinkedRelatedField):
+    """
+    Subclass of ``serializers.HyperlinkedRelatedField`` that applies caching in
+    ``.get_url()`` to ``reverse()`` calls to improve serialization performance
+    """
+
+
+class CachedHyperlinkedIdentityField(CacheMixin, serializers.HyperlinkedIdentityField):
+    """
+    Subclass of ``serializers.HyperlinkedIdentityField`` that applies caching in
+    ``.get_url()`` to ``reverse()`` calls to improve serialization performance
+    """
+
+
+class CachedNestedHyperlinkedRelatedField(CacheMixin, NestedHyperlinkedRelatedField):
+    """
+    Subclass of ``serializers.HyperlinkedIdentityField`` that applies caching in
+    ``.get_url()`` to ``reverse()`` calls to improve serialization performance
+    """
+
+    def get_extra_reverse_kwargs(self) -> dict[str, str]:
+        return self.parent_lookup_kwargs
+
+    def get_url(
+        self, obj: Model, view_name: str, request: Request, format: str | None
+    ) -> str | None:
+        url = super().get_url(obj, view_name, request, format)
+
+        if not url:
+            return None
+
+        # Replace the placeholder from the cached base URI with the actual identifier
+        for k, v in self.parent_lookup_kwargs.items():
+            url = url.replace(v, str(get_nested_fk_attribute(obj, v)))
+        return url