commonground-api-common 2.3.0__py3-none-any.whl → 2.5.0__py3-none-any.whl

{commonground_api_common-2.3.0.dist-info → commonground_api_common-2.5.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: commonground-api-common
-Version: 2.3.0
+Version: 2.5.0
 Summary: Commonground API tooling
 Home-page: https://github.com/maykinmedia/commonground-api-common
 Author: Maykin Media, VNG-Realisatie
@@ -61,7 +61,7 @@ Requires-Dist: drf-extra-fields; extra == "tests"
 Provides-Extra: testutils
 Requires-Dist: zgw-consumers-oas; extra == "testutils"
 Provides-Extra: setup-configuration
-Requires-Dist: django-setup-configuration>=0.4.0; extra == "setup-configuration"
+Requires-Dist: django-setup-configuration>=0.7.0; extra == "setup-configuration"
 Provides-Extra: pep8
 Requires-Dist: flake8; extra == "pep8"
 Provides-Extra: coverage

{commonground_api_common-2.3.0.dist-info → commonground_api_common-2.5.0.dist-info}/RECORD

@@ -1,7 +1,7 @@
-commonground_api_common-2.3.0.data/scripts/generate_schema,sha256=OpKgzlFc_uzA3TVW_vHSYXAD_feLaCdTEnkWjIcxVzA,280
-vng_api_common/__init__.py,sha256=CpK8IH_dCUAwg9tqv7zm9FxbBFkxCnED1JUiRe7cftU,22
+commonground_api_common-2.5.0.data/scripts/generate_schema,sha256=OpKgzlFc_uzA3TVW_vHSYXAD_feLaCdTEnkWjIcxVzA,280
+vng_api_common/__init__.py,sha256=fMbNgIJqxiZEaSBLadLBt4rZpCHqarzb4Okt-aWsp2E,22
 vng_api_common/admin.py,sha256=iFtUPGf-ha0I-bXgq8QIFrP23Kzk_H3FlgAjt0U-ip0,259
-vng_api_common/apps.py,sha256=14vSvFX2H6alME95uOK9aL5TIWI3reiOW86Qa9kmhNw,3610
+vng_api_common/apps.py,sha256=QQiJXRmjX9Q91oh0P9fvVnHe3NSYd1cEcUUBw0HLBCA,3690
 vng_api_common/checks.py,sha256=tOyfV7MMLGh4anrd_W30LvJCxiyQ4sFs1mGd9mtrEc0,1175
 vng_api_common/choices.py,sha256=dboFRoM34GpRUpxB9WexexccopcQSogu1QIyY4B9ACY,541
 vng_api_common/client.py,sha256=HNLc86RwczAudPBDgH_zQncE19OUaLyhSnacQRxJO0c,1972
@@ -28,12 +28,12 @@ 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=7_7IotlRfVb0woe6Wy79l_el3sPzrSY8-bfiYLbEUqs,10162
+vng_api_common/serializers.py,sha256=NdrZJqP7p54lRKoKG4mEDS9MqaMcPESIr4dB1tnLaqI,10163
 vng_api_common/urls.py,sha256=9IWHYLlEIIHNaZ_Zq02qNQ2HJpETb7o-89r7yBM_tQs,270
 vng_api_common/utils.py,sha256=zrtpssOA-NcJHhAlxioBiXeY3G2R_uf0l8oWkDD_EiE,8511
-vng_api_common/validators.py,sha256=Y1OQrmnH3U01hnCizWc_xjpSSGUWKlwiFxeHHGCThpI,11012
+vng_api_common/validators.py,sha256=ejaFZvFXFaBlqxjA2_07NSHKHlG5pejrfC_GHjwCj6E,12852
 vng_api_common/version.py,sha256=yJV9_yTM7Qnzg0zGNkJQkN9Uai3I_ZUkcyseJRPRk5I,129
-vng_api_common/views.py,sha256=VnvlpDmzBeSkDB9a-pBUkqBncKO7TT-6bY5zbYP4QOk,7607
+vng_api_common/views.py,sha256=pxpI2dl22I9auTYvRJ-Rx-_NHAKgo1F2QwQJF6WIjrE,7603
 vng_api_common/viewsets.py,sha256=z5pzvSymFiiuCjP_-uuW-3OJKZY_psPAt8fWeWySU0c,2278
 vng_api_common/api/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 vng_api_common/api/permissions.py,sha256=okbwiscxlAtbQWTCRDLL2reOxgj0rRDZeDcrtXAYq00,739
@@ -108,7 +108,7 @@ vng_api_common/conf/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSu
 vng_api_common/conf/api.py,sha256=Lx3Kk7S7mKxeaUr0dm6jbKrEh4WI2gye4i7QxN2x69E,3150
 vng_api_common/contrib/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 vng_api_common/contrib/setup_configuration/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-vng_api_common/contrib/setup_configuration/models.py,sha256=ztev7KDGW0ESLl6jSuLx0tlNV58IOL3ibYEfVmjfv2Y,920
+vng_api_common/contrib/setup_configuration/models.py,sha256=oqw0cOrbromC9CS3nWzfpDgOLg_xXyHoAi7jgw0f7Yk,1195
 vng_api_common/contrib/setup_configuration/steps.py,sha256=3jYRdHFlPq5zR-T-SPYTDp_Aipy0JK1HaJFrSgH4Vd0,1680
 vng_api_common/db/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 vng_api_common/db/operations.py,sha256=3vj9zD4EntMSmYsNGN1pRDjAcVM68MESDdoAk9wl0U0,3333
@@ -182,7 +182,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.3.0.dist-info/METADATA,sha256=Ke1dE5k_UQ-0ZdksTJ9aBp_AxOy0ZZh3OxtgTn5AS4k,6988
-commonground_api_common-2.3.0.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-commonground_api_common-2.3.0.dist-info/top_level.txt,sha256=vPismc83zPzWXTmlNCCwfDlFV9iygJYxNJW5iDjKTgw,15
-commonground_api_common-2.3.0.dist-info/RECORD,,
+commonground_api_common-2.5.0.dist-info/METADATA,sha256=h6PrcdoJEkOrGklI9qIKWV6YsNIpPilsXP2fG1m-P0Q,6988
+commonground_api_common-2.5.0.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+commonground_api_common-2.5.0.dist-info/top_level.txt,sha256=vPismc83zPzWXTmlNCCwfDlFV9iygJYxNJW5iDjKTgw,15
+commonground_api_common-2.5.0.dist-info/RECORD,,

vng_api_common/__init__.py

@@ -1 +1 @@
-__version__ = "2.3.0"
+__version__ = "2.5.0"

vng_api_common/apps.py

@@ -1,6 +1,7 @@
 import logging
 
 from django.apps import AppConfig
+from django.core.exceptions import ImproperlyConfigured
 from django.db import models
 from django.forms.fields import CharField
 from django.utils.translation import gettext_lazy as _
@@ -89,7 +90,7 @@ def register_geojson_field_extension() -> None:
     """
     try:
         from rest_framework_gis.fields import GeometryField  # noqa
-    except ImportError:
+    except (ImportError, ImproperlyConfigured):
         logger.debug(
             "Could not import djangorestframework-gis, skipping "
             "GeometryFieldExtension registration."

vng_api_common/contrib/setup_configuration/models.py

@@ -13,10 +13,14 @@ class SingleJWTSecretConfigurationModel(ConfigurationModel):
                 "secret",
             ]
         }
+        extra_kwargs = {
+            "identifier": {"examples": ["application-name"]},
+            "secret": {"examples": ["modify-this"]},
+        }
 
 
 class JWTSecretsConfigurationModel(ConfigurationModel):
-    items: list[SingleJWTSecretConfigurationModel] = Field(default_factory=list)
+    items: list[SingleJWTSecretConfigurationModel] = Field()
 
 
 class SingleApplicatieConfigurationModel(ConfigurationModel):
@@ -26,7 +30,11 @@ class SingleApplicatieConfigurationModel(ConfigurationModel):
         django_model_refs = {
             Applicatie: ["uuid", "client_ids", "label", "heeft_alle_autorisaties"]
         }
+        extra_kwargs = {
+            "client_ids": {"examples": [["open-notificaties-prod"]]},
+            "label": {"examples": ["Open Notificaties (productie)"]},
+        }
 
 
 class ApplicatieConfigurationModel(ConfigurationModel):
-    items: list[SingleApplicatieConfigurationModel] = Field(default_factory=list)
+    items: list[SingleApplicatieConfigurationModel]

vng_api_common/serializers.py

@@ -91,7 +91,7 @@ class ValidatieFoutSerializer(FoutSerializer):
 
 
 def add_choice_values_help_text(
-    choices: Union[models.Choices, List[Tuple[str, str]]]
+    choices: Union[models.Choices, List[Tuple[str, str]]],
 ) -> str:
     is_dj_choices = inspect.isclass(choices) and issubclass(choices, models.Choices)
 

vng_api_common/validators.py

@@ -5,7 +5,6 @@ from typing import Callable
 
 from django.conf import settings
 from django.core.exceptions import ValidationError
-from django.core.validators import RegexValidator
 from django.utils import timezone
 from django.utils.deconstruct import deconstructible
 from django.utils.module_loading import import_string
@@ -13,7 +12,7 @@ from django.utils.translation import gettext_lazy as _
 
 from rest_framework import serializers, validators
 
-from .constants import RSIN_LENGTH
+from .constants import BSN_LENGTH, RSIN_LENGTH
 from .oas import fetcher, obj_has_shape
 
 logger = logging.getLogger(__name__)
@@ -22,6 +21,90 @@ logger = logging.getLogger(__name__)
 WORD_REGEX = re.compile(r"[\w\-]+$", re.ASCII)
 
 
+class BaseIdentifierValidator:
+    """
+    Validator base class that performs common validation logic.
+    Digit check, length, and optional 11-proof check.
+    """
+
+    error_messages = {
+        "isdigit": _("Voer een numerieke waarde in"),
+        "length": _("Waarde moet %(identifier_length)s tekens lang zijn"),
+        "11proefnumber": _("Ongeldige code"),
+    }
+
+    def __init__(
+        self,
+        value: str,
+        identifier_length: int,
+        validate_11proef: bool = False,
+    ):
+        self.value = value
+        self.identifier_length = identifier_length
+        self.validate_11proef = validate_11proef
+
+    def validate_isdigit(self) -> None:
+        """Validates that the value contains only digits."""
+        if not self.value.isdigit():
+            raise ValidationError(self.error_messages["isdigit"], code="only-digits")
+
+    def validate_length(self) -> None:
+        """Validates that the length of the value is within the allowed sizes."""
+        if len(self.value) != self.identifier_length:
+            raise ValidationError(
+                self.error_messages["length"]
+                % {"identifier_length": self.identifier_length},
+                code="invalid-length",
+            )
+
+    def validate_11proefnumber(self) -> None:
+        """Validates the value based on the 11-proof check."""
+        total = 0
+        for multiplier, char in enumerate(reversed(self.value), start=1):
+            if multiplier == 1:
+                total += -multiplier * int(char)
+            else:
+                total += multiplier * int(char)
+
+        if total % 11 != 0:
+            raise ValidationError(self.error_messages["11proefnumber"], code="invalid")
+
+    def validate(self) -> None:
+        self.validate_isdigit()
+        self.validate_length()
+        if self.validate_11proef:
+            self.validate_11proefnumber()
+
+
+def validate_rsin(value: str) -> None:
+    """
+    Validates that a string value is a valid RSIN number by applying the
+    '11-proef' checking.
+
+    :param value: String object representing a presumably good RSIN number.
+    """
+
+    validator = BaseIdentifierValidator(
+        value, identifier_length=RSIN_LENGTH, validate_11proef=True
+    )
+    validator.error_messages["11proefnumber"] = _("Onjuist RSIN nummer")
+    validator.validate()
+
+
+def validate_bsn(value: str) -> None:
+    """
+    Validates that a string value is a valid BSN number by applying the
+    '11-proef' checking.
+
+    :param value: String object representing a presumably good BSN number.
+    """
+    validator = BaseIdentifierValidator(
+        value, identifier_length=BSN_LENGTH, validate_11proef=True
+    )
+    validator.error_messages["11proefnumber"] = _("Onjuist BSN nummer")
+    validator.validate()
+
+
 @deconstructible
 class AlphanumericExcludingDiacritic:
     """
@@ -73,37 +156,6 @@ def validate_non_negative_string(value):
         raise ValidationError("De waarde moet een niet-negatief getal zijn.")
 
 
-validate_digits = RegexValidator(
-    regex="^[0-9]+$", message="Waarde moet numeriek zijn.", code="only-digits"
-)
-
-
-def validate_rsin(value):
-    """
-    Validates that a string value is a valid RSIN number by applying the
-    '11-proef' checking.
-
-    :param value: String object representing a presumably good RSIN number.
-    """
-    # Initial sanity checks.
-    validate_digits(value)
-    if len(value) != RSIN_LENGTH:
-        raise ValidationError(
-            "RSIN moet %s tekens lang zijn." % RSIN_LENGTH, code="invalid-length"
-        )
-
-    # 11-proef check.
-    total = 0
-    for multiplier, char in enumerate(reversed(value), start=1):
-        if multiplier == 1:
-            total += -multiplier * int(char)
-        else:
-            total += multiplier * int(char)
-
-    if total % 11 != 0:
-        raise ValidationError("Onjuist RSIN nummer.", code="invalid")
-
-
 class URLValidator:
     """
     Validate that the URL actually resolves to a HTTP 200

vng_api_common/views.py

@@ -184,12 +184,12 @@ def _test_nrc_config(check_autorisaties_subscription=True) -> list:
     nrc_client: Optional[Client] = NotificationsConfig.get_client()
 
     if not nrc_client:
-        return [((_("NRC"), _("Missing"), False))]
+        return [(_("NRC"), _("Missing"), False)]
 
     has_nrc_auth = nrc_client.auth is not None if nrc_client else False
 
     if not nrc_config.notifications_api_service:
-        checks = [((_("NRC"), _("Missing"), False))]
+        checks = [(_("NRC"), _("Missing"), False)]
         return checks
 
     checks = [