commonground-api-common 2.1.0__tar.gz → 2.2.0__tar.gz

{commonground_api_common-2.1.0 → commonground_api_common-2.2.0}/CHANGELOG.rst

@@ -2,6 +2,21 @@
 Change history
 ==============
 
+2.2.0 (2024-12-10)
+------------------
+
+* Add support for ``django-setup-configuration``, add a ``ConfigurationStep`` for ``JWTSecret``
+
+2.1.2 (2024-11-29)
+------------------
+
+* Version 2.1.1 tagged the incorrect commit (`403494178746fba882208ee7e49f9dd6a2c6c5f6`)
+
+2.1.1 (2024-11-29)
+------------------
+
+* Move zgw-consumers-oas import to related function
+
 2.1.0 (2024-11-29)
 ------------------
 

{commonground_api_common-2.1.0/commonground_api_common.egg-info → commonground_api_common-2.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: commonground-api-common
-Version: 2.1.0
+Version: 2.2.0
 Summary: Commonground API tooling
 Home-page: https://github.com/maykinmedia/commonground-api-common
 Author: Maykin Media, VNG-Realisatie
@@ -32,7 +32,7 @@ Requires-Dist: isodate
 Requires-Dist: notifications-api-common>=0.3.1
 Requires-Dist: zgw-consumers>=0.35.1
 Requires-Dist: oyaml
-Requires-Dist: PyJWT>=2.1.0
+Requires-Dist: PyJWT>=2.1.1
 Requires-Dist: requests
 Requires-Dist: requests-mock
 Requires-Dist: coreapi
@@ -53,6 +53,8 @@ Requires-Dist: freezegun; extra == "tests"
 Requires-Dist: zgw-consumers-oas; 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"
 Provides-Extra: pep8
 Requires-Dist: flake8; extra == "pep8"
 Provides-Extra: coverage

{commonground_api_common-2.1.0 → commonground_api_common-2.2.0/commonground_api_common.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: commonground-api-common
-Version: 2.1.0
+Version: 2.2.0
 Summary: Commonground API tooling
 Home-page: https://github.com/maykinmedia/commonground-api-common
 Author: Maykin Media, VNG-Realisatie
@@ -32,7 +32,7 @@ Requires-Dist: isodate
 Requires-Dist: notifications-api-common>=0.3.1
 Requires-Dist: zgw-consumers>=0.35.1
 Requires-Dist: oyaml
-Requires-Dist: PyJWT>=2.1.0
+Requires-Dist: PyJWT>=2.1.1
 Requires-Dist: requests
 Requires-Dist: requests-mock
 Requires-Dist: coreapi
@@ -53,6 +53,8 @@ Requires-Dist: freezegun; extra == "tests"
 Requires-Dist: zgw-consumers-oas; 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"
 Provides-Extra: pep8
 Requires-Dist: flake8; extra == "pep8"
 Provides-Extra: coverage

{commonground_api_common-2.1.0 → commonground_api_common-2.2.0}/commonground_api_common.egg-info/SOURCES.txt

@@ -18,6 +18,7 @@ tests/test_cache_headers.py
 tests/test_check_query_params.py
 tests/test_checks.py
 tests/test_choices.py
+tests/test_configuration_steps.py
 tests/test_content_type_headers.py
 tests/test_filters.py
 tests/test_gegevensgroepen.py
@@ -140,6 +141,10 @@ vng_api_common/caching/registry.py
 vng_api_common/caching/signals.py
 vng_api_common/conf/__init__.py
 vng_api_common/conf/api.py
+vng_api_common/contrib/__init__.py
+vng_api_common/contrib/setup_configuration/__init__.py
+vng_api_common/contrib/setup_configuration/models.py
+vng_api_common/contrib/setup_configuration/steps.py
 vng_api_common/db/__init__.py
 vng_api_common/db/operations.py
 vng_api_common/inspectors/__init__.py

{commonground_api_common-2.1.0 → commonground_api_common-2.2.0}/commonground_api_common.egg-info/requires.txt

@@ -11,7 +11,7 @@ isodate
 notifications-api-common>=0.3.1
 zgw-consumers>=0.35.1
 oyaml
-PyJWT>=2.1.0
+PyJWT>=2.1.1
 requests
 requests-mock
 coreapi
@@ -35,6 +35,9 @@ flake8
 [release]
 bump2version
 
+[setup-configuration]
+django-setup-configuration>=0.4.0
+
 [tests]
 psycopg2
 pytest

{commonground_api_common-2.1.0 → commonground_api_common-2.2.0}/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = commonground-api-common
-version = 2.1.0
+version = 2.2.0
 description = Commonground API tooling
 long_description = file: README.rst
 url = https://github.com/maykinmedia/commonground-api-common
@@ -44,7 +44,7 @@ install_requires =
 	notifications-api-common>=0.3.1
 	zgw-consumers>=0.35.1
 	oyaml
-	PyJWT>=2.1.0
+	PyJWT>=2.1.1
 	requests
 	requests-mock
 	coreapi
@@ -81,6 +81,8 @@ tests =
 	zgw-consumers-oas
 testutils = 
 	zgw-consumers-oas
+setup-configuration = 
+	django-setup-configuration>=0.4.0
 pep8 = flake8
 coverage = pytest-cov
 docs = 

commonground_api_common-2.2.0/tests/test_configuration_steps.py

@@ -0,0 +1,62 @@
+import pytest
+from django_setup_configuration.test_utils import execute_single_step
+
+from vng_api_common.contrib.setup_configuration.steps import JWTSecretsConfigurationStep
+from vng_api_common.models import JWTSecret
+
+CONFIG_FILE_PATH = "tests/files/setup_config_jwtsecrets.yaml"
+
+
+@pytest.mark.django_db
+def test_execute_configuration_step_success():
+    execute_single_step(JWTSecretsConfigurationStep, yaml_source=CONFIG_FILE_PATH)
+
+    assert JWTSecret.objects.count() == 2
+
+    credential1, credential2 = JWTSecret.objects.all()
+
+    assert credential1.identifier == "user-id"
+    assert credential1.secret == "super-secret"
+
+    assert credential2.identifier == "user-id2"
+    assert credential2.secret == "super-secret2"
+
+
+@pytest.mark.django_db
+def test_execute_configuration_step_update_existing():
+    JWTSecret.objects.create(identifier="user-id", secret="old")
+    JWTSecret.objects.create(identifier="user-id2", secret="old2")
+
+    execute_single_step(JWTSecretsConfigurationStep, yaml_source=CONFIG_FILE_PATH)
+
+    assert JWTSecret.objects.count() == 2
+
+    credential1, credential2 = JWTSecret.objects.all()
+
+    assert credential1.identifier == "user-id"
+    assert credential1.secret == "super-secret"
+
+    assert credential2.identifier == "user-id2"
+    assert credential2.secret == "super-secret2"
+
+
+@pytest.mark.django_db
+def test_execute_configuration_step_idempotent():
+    def make_assertions():
+        assert JWTSecret.objects.count() == 2
+
+        credential1, credential2 = JWTSecret.objects.all()
+
+        assert credential1.identifier == "user-id"
+        assert credential1.secret == "super-secret"
+
+        assert credential2.identifier == "user-id2"
+        assert credential2.secret == "super-secret2"
+
+    execute_single_step(JWTSecretsConfigurationStep, yaml_source=CONFIG_FILE_PATH)
+
+    make_assertions()
+
+    execute_single_step(JWTSecretsConfigurationStep, yaml_source=CONFIG_FILE_PATH)
+
+    make_assertions()

commonground_api_common-2.2.0/vng_api_common/__init__.py

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

commonground_api_common-2.2.0/vng_api_common/contrib/setup_configuration/models.py

@@ -0,0 +1,18 @@
+from django_setup_configuration.models import ConfigurationModel
+from pydantic import Field
+
+from vng_api_common.models import JWTSecret
+
+
+class SingleJWTSecretConfigurationModel(ConfigurationModel):
+    class Meta:
+        django_model_refs = {
+            JWTSecret: [
+                "identifier",
+                "secret",
+            ]
+        }
+
+
+class JWTSecretsConfigurationModel(ConfigurationModel):
+    items: list[SingleJWTSecretConfigurationModel] = Field(default_factory=list)

commonground_api_common-2.2.0/vng_api_common/contrib/setup_configuration/steps.py

@@ -0,0 +1,23 @@
+from django_setup_configuration.configuration import BaseConfigurationStep
+
+from vng_api_common.models import JWTSecret
+
+from .models import JWTSecretsConfigurationModel
+
+
+class JWTSecretsConfigurationStep(BaseConfigurationStep[JWTSecretsConfigurationModel]):
+    """
+    Configure credentials for Applications that need access
+    """
+
+    verbose_name = "Configuration to create credentials"
+    config_model = JWTSecretsConfigurationModel
+    namespace = "vng_api_common_credentials"
+    enable_setting = "vng_api_common_credentials_config_enable"
+
+    def execute(self, model: JWTSecretsConfigurationModel):
+        for config in model.items:
+            JWTSecret.objects.update_or_create(
+                identifier=config.identifier,
+                defaults={"secret": config.secret},
+            )

{commonground_api_common-2.1.0 → commonground_api_common-2.2.0}/vng_api_common/tests/schema.py

@@ -6,7 +6,6 @@ from django.conf import settings
 
 import yaml
 from requests_mock import Mocker
-from zgw_consumers_oas.schema_loading import read_schema
 
 DEFAULT_PATH_PARAMETERS = {"version": "1"}
 
@@ -76,6 +75,8 @@ def get_validation_errors(response, field, index=0):
 def mock_service_oas_get(
     mock: Mocker, url: str, service: str, oas_url: str = ""
 ) -> None:
+    from zgw_consumers_oas.schema_loading import read_schema
+
     if not oas_url:
         oas_url = f"{url}schema/openapi.yaml?v=3"
 

commonground_api_common-2.1.0/vng_api_common/__init__.py

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