commonground-api-common 2.3.0__tar.gz → 2.5.0__tar.gz

{commonground_api_common-2.3.0 → commonground_api_common-2.5.0}/CHANGELOG.rst

@@ -2,6 +2,21 @@
 Change history
 ==============
 
+2.5.0 (2025-02-06)
+------------------
+
+* Update setup-config docs to use example directive and add extra example values to models
+
+2.4.1 (2025-01-14)
+------------------
+
+* Make geojson fields optional by catching ImproperlyConfigured errors
+
+2.4.0 (2025-01-13)
+------------------
+
+* [#57] Improved validation of RSIN and BSN by creating a generic validator.
+
 2.3.0 (2025-01-09)
 ------------------
 

{commonground_api_common-2.3.0/commonground_api_common.egg-info → commonground_api_common-2.5.0}/PKG-INFO

@@ -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 → commonground_api_common-2.5.0/commonground_api_common.egg-info}/PKG-INFO

@@ -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 → commonground_api_common-2.5.0}/commonground_api_common.egg-info/requires.txt

@@ -42,7 +42,7 @@ flake8
 bump2version
 
 [setup-configuration]
-django-setup-configuration>=0.4.0
+django-setup-configuration>=0.7.0
 
 [tests]
 psycopg2

{commonground_api_common-2.3.0 → commonground_api_common-2.5.0}/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = commonground-api-common
-version = 2.3.0
+version = 2.5.0
 description = Commonground API tooling
 long_description = file: README.rst
 url = https://github.com/maykinmedia/commonground-api-common
@@ -88,7 +88,7 @@ tests =
 testutils = 
 	zgw-consumers-oas
 setup-configuration = 
-	django-setup-configuration>=0.4.0
+	django-setup-configuration>=0.7.0
 pep8 = flake8
 coverage = pytest-cov
 docs = 

commonground_api_common-2.5.0/tests/test_validators.py

@@ -0,0 +1,106 @@
+from django.core.exceptions import ValidationError
+
+import pytest
+
+from vng_api_common.validators import (
+    AlphanumericExcludingDiacritic,
+    BaseIdentifierValidator,
+    validate_bsn,
+    validate_rsin,
+)
+
+
+@pytest.mark.parametrize("value", ["foo$", "aëeeei", "no spaces allowed"])
+def test_alphanumeric_validator_error_invalid_input(value):
+    validator = AlphanumericExcludingDiacritic()
+
+    with pytest.raises(ValidationError):
+        validator(value)
+
+
+@pytest.mark.parametrize(
+    "value",
+    [
+        "simple",
+        "dashes-are-ok",
+        "underscores_are_too",
+        "let_us_not_forget_about_numb3rs",
+    ],
+)
+def test_alphanumeric_validator_error_valid_input(value):
+    validator = AlphanumericExcludingDiacritic()
+    try:
+        validator(value)
+    except ValidationError:
+        pytest.fail("Should have passed validation")
+
+
+def test_equality_validator_instances():
+    validator1 = AlphanumericExcludingDiacritic()
+    validator2 = AlphanumericExcludingDiacritic()
+
+    assert validator1 == validator2
+
+
+def test_valid():
+    validator = BaseIdentifierValidator(
+        "296648875", identifier_length=9, validate_11proef=True
+    )
+    validator.validate()
+
+
+def test_invalid_length():
+    validator = BaseIdentifierValidator(
+        "1234", identifier_length=9, validate_11proef=True
+    )
+
+    with pytest.raises(ValidationError) as error:
+        validator.validate()
+    assert "Waarde moet 9 tekens lang zijn" in str(error.value)
+
+
+def test_invalid_isdigit():
+    validator = BaseIdentifierValidator(
+        "1234TEST", identifier_length=9, validate_11proef=True
+    )
+
+    with pytest.raises(ValidationError) as error:
+        validator.validate()
+    assert "Voer een numerieke waarde in" in str(error.value)
+
+
+def test_invalid_11proefnumber():
+    validator = BaseIdentifierValidator(
+        "123456789", identifier_length=9, validate_11proef=True
+    )
+    with pytest.raises(ValidationError) as error:
+        validator.validate()
+    assert "Ongeldige code" in str(error.value)
+
+
+def test_valid_bsn():
+    validate_bsn("296648875")
+
+
+def test_invalid_bsn():
+    with pytest.raises(ValidationError) as error:
+        validate_bsn("123456789")  # validate_11proef
+    assert "Onjuist BSN nummer" in str(error.value)
+
+    with pytest.raises(ValidationError) as error:
+        validate_bsn("12345678")  # validate_length
+    assert "Waarde moet 9 tekens lang zijn" in str(error.value)
+
+
+def test_valid_rsin():
+    validate_rsin("296648875")
+
+
+def test_invalid_rsin():
+    with pytest.raises(ValidationError) as error:
+        validate_rsin("123456789")  # validate_11proef
+    assert "Onjuist RSIN nummer" in str(error.value)
+
+    with pytest.raises(ValidationError) as error:
+        validate_rsin("12345678")  # validate_length
+    assert "Waarde moet 9 tekens lang zijn" in str(error.value)

commonground_api_common-2.5.0/vng_api_common/__init__.py

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

{commonground_api_common-2.3.0 → commonground_api_common-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."

{commonground_api_common-2.3.0 → commonground_api_common-2.5.0}/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]

{commonground_api_common-2.3.0 → commonground_api_common-2.5.0}/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)
 

{commonground_api_common-2.3.0 → commonground_api_common-2.5.0}/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

{commonground_api_common-2.3.0 → commonground_api_common-2.5.0}/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 = [

commonground_api_common-2.3.0/tests/test_validators.py

@@ -1,37 +0,0 @@
-from django.core.exceptions import ValidationError
-
-import pytest
-
-from vng_api_common.validators import AlphanumericExcludingDiacritic
-
-
-@pytest.mark.parametrize("value", ["foo$", "aëeeei", "no spaces allowed"])
-def test_alphanumeric_validator_error_invalid_input(value):
-    validator = AlphanumericExcludingDiacritic()
-
-    with pytest.raises(ValidationError):
-        validator(value)
-
-
-@pytest.mark.parametrize(
-    "value",
-    [
-        "simple",
-        "dashes-are-ok",
-        "underscores_are_too",
-        "let_us_not_forget_about_numb3rs",
-    ],
-)
-def test_alphanumeric_validator_error_valid_input(value):
-    validator = AlphanumericExcludingDiacritic()
-    try:
-        validator(value)
-    except ValidationError:
-        pytest.fail("Should have passed validation")
-
-
-def test_equality_validator_instances():
-    validator1 = AlphanumericExcludingDiacritic()
-    validator2 = AlphanumericExcludingDiacritic()
-
-    assert validator1 == validator2

commonground_api_common-2.3.0/vng_api_common/__init__.py

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