commonground-api-common 1.12.2__tar.gz → 1.13.1__tar.gz

commonground_api_common-1.13.1/CHANGELOG.rst

@@ -0,0 +1,17 @@
+==============
+Change history
+==============
+
+1.13.1 (2024-05-28)
+-------------------
+
+* Marked notifications view scopes as private
+* Added natural keys to authorization models
+
+
+1.13.0 (2024-03-01)
+-------------------
+
+* Added support of Django 4.2
+* Removed support of Python 3.7
+* Added support of Python 3.11

{commonground-api-common-1.12.2/commonground_api_common.egg-info → commonground_api_common-1.13.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: commonground-api-common
-Version: 1.12.2
+Version: 1.13.1
 Summary: Commonground API tooling
 Home-page: https://github.com/maykinmedia/commonground-api-common
 Author: Maykin Media, VNG-Realisatie
@@ -10,22 +10,22 @@ Keywords: openapi,swagger,django
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Framework :: Django
 Classifier: Framework :: Django :: 3.2
-Classifier: Framework :: Django :: 4.1
+Classifier: Framework :: Django :: 4.2
 Classifier: Intended Audience :: Developers
 Classifier: Operating System :: Unix
 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.7
 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
-Requires-Dist: django<4.2,>=3.2.0
+Requires-Dist: django>=3.2.0
 Requires-Dist: django-filter>=2.0
 Requires-Dist: django-solo
-Requires-Dist: djangorestframework~=3.12.0
+Requires-Dist: djangorestframework>=3.11.0
 Requires-Dist: djangorestframework_camel_case>=1.2.0
 Requires-Dist: django-rest-framework-condition
 Requires-Dist: drf-yasg>=1.20.0
@@ -36,7 +36,6 @@ Requires-Dist: isodate
 Requires-Dist: notifications-api-common>=0.2.2
 Requires-Dist: oyaml
 Requires-Dist: PyJWT>=2.0.0
-Requires-Dist: pyyaml
 Requires-Dist: requests
 Requires-Dist: coreapi
 Provides-Extra: markdown-docs

{commonground-api-common-1.12.2 → commonground_api_common-1.13.1/commonground_api_common.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: commonground-api-common
-Version: 1.12.2
+Version: 1.13.1
 Summary: Commonground API tooling
 Home-page: https://github.com/maykinmedia/commonground-api-common
 Author: Maykin Media, VNG-Realisatie
@@ -10,22 +10,22 @@ Keywords: openapi,swagger,django
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Framework :: Django
 Classifier: Framework :: Django :: 3.2
-Classifier: Framework :: Django :: 4.1
+Classifier: Framework :: Django :: 4.2
 Classifier: Intended Audience :: Developers
 Classifier: Operating System :: Unix
 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.7
 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
-Requires-Dist: django<4.2,>=3.2.0
+Requires-Dist: django>=3.2.0
 Requires-Dist: django-filter>=2.0
 Requires-Dist: django-solo
-Requires-Dist: djangorestframework~=3.12.0
+Requires-Dist: djangorestframework>=3.11.0
 Requires-Dist: djangorestframework_camel_case>=1.2.0
 Requires-Dist: django-rest-framework-condition
 Requires-Dist: drf-yasg>=1.20.0
@@ -36,7 +36,6 @@ Requires-Dist: isodate
 Requires-Dist: notifications-api-common>=0.2.2
 Requires-Dist: oyaml
 Requires-Dist: PyJWT>=2.0.0
-Requires-Dist: pyyaml
 Requires-Dist: requests
 Requires-Dist: coreapi
 Provides-Extra: markdown-docs

{commonground-api-common-1.12.2 → commonground_api_common-1.13.1}/commonground_api_common.egg-info/SOURCES.txt

@@ -1,3 +1,4 @@
+CHANGELOG.rst
 MANIFEST.in
 README.rst
 pyproject.toml

{commonground-api-common-1.12.2 → commonground_api_common-1.13.1}/commonground_api_common.egg-info/requires.txt

@@ -1,7 +1,7 @@
-django<4.2,>=3.2.0
+django>=3.2.0
 django-filter>=2.0
 django-solo
-djangorestframework~=3.12.0
+djangorestframework>=3.11.0
 djangorestframework_camel_case>=1.2.0
 django-rest-framework-condition
 drf-yasg>=1.20.0
@@ -12,7 +12,6 @@ isodate
 notifications-api-common>=0.2.2
 oyaml
 PyJWT>=2.0.0
-pyyaml
 requests
 coreapi
 

{commonground-api-common-1.12.2 → commonground_api_common-1.13.1}/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = commonground-api-common
-version = 1.12.2
+version = 1.13.1
 description = Commonground API tooling
 long_description = file: README.rst
 url = https://github.com/maykinmedia/commonground-api-common
@@ -12,17 +12,17 @@ classifiers =
 	Development Status :: 5 - Production/Stable
 	Framework :: Django
 	Framework :: Django :: 3.2
-	Framework :: Django :: 4.1
+	Framework :: Django :: 4.2
 	Intended Audience :: Developers
 	Operating System :: Unix
 	Operating System :: MacOS
 	Operating System :: Microsoft :: Windows
 	Programming Language :: Python :: 3
 	Programming Language :: Python :: 3 :: Only
-	Programming Language :: Python :: 3.7
 	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
 
 [options]
@@ -34,10 +34,10 @@ scripts =
 	bin/patch_content_types
 	bin/use_external_components
 install_requires = 
-	django>=3.2.0,<4.2
+	django>=3.2.0
 	django-filter>=2.0
 	django-solo
-	djangorestframework~=3.12.0
+	djangorestframework>=3.11.0
 	djangorestframework_camel_case>=1.2.0
 	django-rest-framework-condition
 	drf-yasg>=1.20.0
@@ -48,7 +48,6 @@ install_requires =
 	notifications-api-common>=0.2.2
 	oyaml
 	PyJWT>=2.0.0
-	pyyaml
 	requests
 	coreapi
 tests_require = 
@@ -92,15 +91,13 @@ release =
 test = pytest
 
 [isort]
+profile = black
 combine_as_imports = true
-default_section = THIRDPARTY
-include_trailing_comma = true
-line_length = 88
-multi_line_output = 3
-force_grid_wrap = 0
-use_parentheses = True
-ensure_newline_before_comments = True
-skip = env,.tox,.history,.eggs
+skip = 
+	env
+	node_modules
+	.tox
+skip_glob = **/migrations/**
 known_django = django
 known_first_party = vng_api_common
 sections = FUTURE,STDLIB,DJANGO,THIRDPARTY,FIRSTPARTY,LOCALFOLDER
@@ -109,7 +106,7 @@ sections = FUTURE,STDLIB,DJANGO,THIRDPARTY,FIRSTPARTY,LOCALFOLDER
 testpaths = tests
 DJANGO_SETTINGS_MODULE = testapp.settings
 
-[pep8]
+[pycodestyle]
 max-line-length = 88
 exclude = env,.tox,doc
 

commonground_api_common-1.13.1/vng_api_common/__init__.py

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

{commonground-api-common-1.12.2 → commonground_api_common-1.13.1}/vng_api_common/authorizations/models.py

@@ -23,6 +23,11 @@ class AuthorizationsConfig(ClientConfig):
         verbose_name = _("Autorisatiecomponentconfiguratie")
 
 
+class ApplicatieManager(models.Manager):
+    def get_by_natural_key(self, uuid):
+        return self.get(uuid=uuid)
+
+
 class Applicatie(APIMixin, models.Model):
     """
     Client level of authorization
@@ -52,10 +57,20 @@ class Applicatie(APIMixin, models.Model):
         ),
     )
 
+    objects = ApplicatieManager()
+
+    def natural_key(self):
+        return (str(self.uuid),)
+
     def __str__(self):
         return f"Applicatie ({self.label})"
 
 
+class AutorisatieManager(models.Manager):
+    def get_by_natural_key(self, applicatie, component, scopes):
+        return self.get(applicatie=applicatie, component=component, scopes=scopes)
+
+
 class Autorisatie(APIMixin, models.Model):
     applicatie = models.ForeignKey(
         "Applicatie",
@@ -109,6 +124,15 @@ class Autorisatie(APIMixin, models.Model):
         blank=True,
     )
 
+    objects = AutorisatieManager()
+
+    def natural_key(self):
+        return (
+            self.applicatie,
+            self.component,
+            self.scopes,
+        )
+
     def satisfy_vertrouwelijkheid(self, vertrouwelijkheidaanduiding: str) -> bool:
         max_confid_level = VertrouwelijkheidsAanduiding.get_choice(
             self.max_vertrouwelijkheidaanduiding

{commonground-api-common-1.12.2 → commonground_api_common-1.13.1}/vng_api_common/authorizations/validators.py

@@ -15,20 +15,14 @@ class UniqueClientIDValidator:
     message = _(
         "The clientID(s) {client_id} are already used in application(s) {app_id}"
     )
+    requires_context = True
 
-    def set_context(self, serializer_field):
-        """
-        This hook is called by the serializer instance,
-        prior to the validation call being made.
-        """
-        # Determine the existing instance, if this is an update operation.
-        self.instance = getattr(serializer_field.parent, "instance", None)
-
-    def __call__(self, value: List[str]):
+    def __call__(self, value: List[str], serializer_field):
+        instance = getattr(serializer_field.parent, "instance", None)
         qs = Applicatie.objects.all()
 
-        if self.instance:
-            qs = qs.exclude(id=self.instance.id)
+        if instance:
+            qs = qs.exclude(id=instance.id)
 
         existing = qs.filter(client_ids__overlap=value).values_list(
             "uuid", "client_ids"

{commonground-api-common-1.12.2 → commonground_api_common-1.13.1}/vng_api_common/caching/etags.py

@@ -157,7 +157,8 @@ class EtagUpdate:
         connection = transaction.get_connection(using)
 
         func = MethodCallback(etag_update.calculate_new_value)
-        for _, _func in connection.run_on_commit:
+        for run_on_commit in connection.run_on_commit:
+            _func = run_on_commit[1]
             if func == _func:
                 logger.debug(
                     "Update for model instance %r with pk %s was already scheduled",

{commonground-api-common-1.12.2 → commonground_api_common-1.13.1}/vng_api_common/inspectors/query.py

@@ -1,10 +1,5 @@
 from django.db import models
-
-try:
-    from django.utils.encoding import force_str
-except ImportError:  # Django < 4.0
-    from django.utils.encoding import force_text as force_str
-
+from django.utils.encoding import force_str
 from django.utils.translation import gettext as _
 
 from django_filters.filters import BaseCSVFilter, ChoiceFilter

{commonground-api-common-1.12.2 → commonground_api_common-1.13.1}/vng_api_common/models.py

@@ -34,6 +34,11 @@ class APIMixin:
         return url
 
 
+class JWTSecretManager(models.Manager):
+    def get_by_natural_key(self, identifier):
+        return self.get(identifier=identifier)
+
+
 class JWTSecret(models.Model):
     """
     Store credentials of clients that want to access our API.
@@ -53,6 +58,11 @@ class JWTSecret(models.Model):
         _("secret"), max_length=255, help_text=_("Secret belonging to the client ID.")
     )
 
+    objects = JWTSecretManager()
+
+    def natural_key(self):
+        return (self.identifier,)
+
     class Meta:
         verbose_name = _("client credential")
         verbose_name_plural = _("client credentials")

{commonground-api-common-1.12.2 → commonground_api_common-1.13.1}/vng_api_common/notifications/api/views.py

@@ -21,9 +21,7 @@ class NotificationBaseView(APIView):
     swagger_schema = None
 
     permission_classes = (AuthScopesRequired,)
-    required_scopes = Scope(
-        SCOPE_NOTIFICATIES_PUBLICEREN_LABEL
-    )  # FIXME: this should be standalone!
+    required_scopes = Scope(SCOPE_NOTIFICATIES_PUBLICEREN_LABEL, private=True)
 
     def get_serializer(self, *args, **kwargs):
         return NotificatieSerializer(*args, **kwargs)
@@ -55,7 +53,9 @@ class NotificationBaseView(APIView):
 class NotificationView(NotificationBaseView):
     action = "create"
     permission_classes = (AuthScopesRequired,)
-    required_scopes = {"create": Scope(SCOPE_NOTIFICATIES_PUBLICEREN_LABEL)}
+    required_scopes = {
+        "create": Scope(SCOPE_NOTIFICATIES_PUBLICEREN_LABEL, private=True)
+    }
 
     def create(self, request, *args, **kwargs):
         return self.post(request, *args, **kwargs)

{commonground-api-common-1.12.2 → commonground_api_common-1.13.1}/vng_api_common/validators.py

@@ -206,20 +206,18 @@ class ResourceValidator(URLValidator):
 
 
 class InformatieObjectUniqueValidator(validators.UniqueTogetherValidator):
+    requires_context = True
+
     def __init__(self, parent_field, field: str):
         self.parent_field = parent_field
         self.field = field
         super().__init__(None, (parent_field, field))
 
-    def set_context(self, serializer_field):
-        serializer = serializer_field.parent
-        super().set_context(serializer)
-
-        self.queryset = serializer.Meta.model._default_manager.all()
-        self.parent_object = serializer.context["parent_object"]
-
-    def __call__(self, informatieobject: str):
-        attrs = {self.parent_field: self.parent_object, self.field: informatieobject}
+    def __call__(self, informatieobject: str, serializer):
+        attrs = {
+            self.parent_field: serializer.context["parent_object"],
+            self.field: informatieobject,
+        }
         super().__call__(attrs)
 
 
@@ -232,17 +230,12 @@ class ObjectInformatieObjectValidator:
         "Het informatieobject is in het DRC nog niet gerelateerd aan dit object."
     )
     code = "inconsistent-relation"
+    requires_context = True
 
-    def set_context(self, serializer):
-        """
-        This hook is called by the serializer instance,
-        prior to the validation call being made.
-        """
-        self.parent_object = serializer.context["parent_object"]
-        self.request = serializer.context["request"]
-
-    def __call__(self, informatieobject: str):
-        object_url = self.parent_object.get_absolute_api_url(self.request)
+    def __call__(self, informatieobject: str, serializer):
+        object_url = serializer.context["parent_object"].get_absolute_api_url(
+            self.request
+        )
 
         # dynamic so that it can be mocked in tests easily
         client = get_client(informatieobject)
@@ -311,40 +304,33 @@ class UniekeIdentificatieValidator:
 
     message = _("Deze identificatie bestaat al binnen de organisatie")
     code = "identificatie-niet-uniek"
+    requires_context = True
 
     def __init__(self, organisatie_field: str, identificatie_field="identificatie"):
         self.organisatie_field = organisatie_field
         self.identificatie_field = identificatie_field
 
-    def set_context(self, serializer):
-        """
-        This hook is called by the serializer instance,
-        prior to the validation call being made.
-        """
-        # Determine the existing instance, if this is an update operation.
-        self.instance = getattr(serializer, "instance", None)
-        self.model = serializer.Meta.model
-
-    def __call__(self, attrs: dict):
+    def __call__(self, attrs: dict, serializer):
+        instance = getattr(serializer, "instance", None)
         identificatie = attrs.get(self.identificatie_field)
         if not identificatie:
-            if self.instance:
+            if instance:
                 # In case of a partial update
-                identificatie = self.instance.identificatie
+                identificatie = instance.identificatie
             else:
                 # identification is being generated, and the generation checks for
                 # uniqueness
                 return
 
         organisatie = attrs.get(self.organisatie_field)
-        pk = self.instance.pk if self.instance else None
+        pk = instance.pk if instance else None
 
         # if we're updating an instance, setting the current values will not
         # trigger an error because the instance-to-be-updated is excluded from
         # the queryset. If either bronorganisatie or identificatie changes,
         # and it already exists, it will raise a validation error
         combination_exists = (
-            self.model.objects
+            serializer.Meta.model.objects
             # in case of an update, exclude the current object. for a create, this
             # will be None
             .exclude(pk=pk)
@@ -370,22 +356,15 @@ class IsImmutableValidator:
 
     message = _("Dit veld mag niet gewijzigd worden.")
     code = "wijzigen-niet-toegelaten"
+    requires_context = True
 
-    def set_context(self, serializer_field):
-        """
-        This hook is called by the serializer instance,
-        prior to the validation call being made.
-        """
-        # Determine the existing instance, if this is an update operation.
-        self.serializer_field = serializer_field
-        self.instance = getattr(serializer_field.parent, "instance", None)
-
-    def __call__(self, new_value):
+    def __call__(self, new_value, serializer_field):
+        instance = getattr(serializer_field.parent, "instance", None)
         # no instance -> it's not an update
-        if not self.instance:
+        if not instance:
             return
 
-        current_value = getattr(self.instance, self.serializer_field.field_name)
+        current_value = getattr(instance, serializer_field.field_name)
 
         if new_value != current_value:
             raise serializers.ValidationError(self.message, code=self.code)

commonground-api-common-1.12.2/vng_api_common/__init__.py

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