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

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

@@ -2,6 +2,21 @@
 Change history
 ==============
 
+2.3.0 (2025-01-09)
+------------------
+
+* Add ConfigurationStep for Applicatie model
+* [#29] Replaced drf-yasg with drf-spectacular
+* [#29] Removed management commands to generate markdown files for scopes and notifications channels:
+    * ``generate_autorisaties``
+    * ``generate_notificaties``
+
+
+2.2.0 (2024-12-10)
+------------------
+
+* Add support for ``django-setup-configuration``, add a ``ConfigurationStep`` for ``JWTSecret``
+
 2.1.2 (2024-11-29)
 ------------------
 

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

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: commonground-api-common
-Version: 2.1.2
+Version: 2.3.0
 Summary: Commonground API tooling
 Home-page: https://github.com/maykinmedia/commonground-api-common
 Author: Maykin Media, VNG-Realisatie
@@ -25,8 +25,8 @@ Requires-Dist: django-solo
 Requires-Dist: djangorestframework>=3.15.0
 Requires-Dist: djangorestframework_camel_case>=1.2.0
 Requires-Dist: django-rest-framework-condition
-Requires-Dist: drf-yasg>=1.20.0
 Requires-Dist: drf-nested-routers>=0.94.1
+Requires-Dist: drf-spectacular
 Requires-Dist: iso-639
 Requires-Dist: isodate
 Requires-Dist: notifications-api-common>=0.3.1
@@ -40,10 +40,15 @@ Requires-Dist: ape-pie
 Provides-Extra: markdown-docs
 Requires-Dist: django-markup<=1.3; extra == "markdown-docs"
 Requires-Dist: markdown; extra == "markdown-docs"
+Provides-Extra: djangorestframework-gis
+Requires-Dist: djangorestframework-gis>=1.0; extra == "djangorestframework-gis"
+Provides-Extra: drf-extra-fields
+Requires-Dist: drf-extra-fields>=3.7.0; extra == "drf-extra-fields"
 Provides-Extra: tests
 Requires-Dist: psycopg2; extra == "tests"
 Requires-Dist: pytest; extra == "tests"
 Requires-Dist: pytest-django; extra == "tests"
+Requires-Dist: pytest-dotenv; extra == "tests"
 Requires-Dist: pytest-factoryboy; extra == "tests"
 Requires-Dist: tox; extra == "tests"
 Requires-Dist: isort; extra == "tests"
@@ -51,8 +56,12 @@ Requires-Dist: black; extra == "tests"
 Requires-Dist: requests-mock; extra == "tests"
 Requires-Dist: freezegun; extra == "tests"
 Requires-Dist: zgw-consumers-oas; extra == "tests"
+Requires-Dist: djangorestframework-gis; extra == "tests"
+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"
 Provides-Extra: pep8
 Requires-Dist: flake8; extra == "pep8"
 Provides-Extra: coverage

commonground_api_common-2.1.2/bin/patch_content_types → commonground_api_common-2.3.0/bin/generate_schema

@@ -9,7 +9,5 @@ if [[ -z "$VIRTUAL_ENV" ]]; then
     exit 1
 fi
 
-source_file=${1:-./src/openapi.yaml}
-manage=${MANAGE:-src/manage.py}
-
-python $manage patch_error_contenttypes $source_file
+echo "generate schema"
+src/manage.py spectacular --file src/openapi.yaml --validate

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

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: commonground-api-common
-Version: 2.1.2
+Version: 2.3.0
 Summary: Commonground API tooling
 Home-page: https://github.com/maykinmedia/commonground-api-common
 Author: Maykin Media, VNG-Realisatie
@@ -25,8 +25,8 @@ Requires-Dist: django-solo
 Requires-Dist: djangorestframework>=3.15.0
 Requires-Dist: djangorestframework_camel_case>=1.2.0
 Requires-Dist: django-rest-framework-condition
-Requires-Dist: drf-yasg>=1.20.0
 Requires-Dist: drf-nested-routers>=0.94.1
+Requires-Dist: drf-spectacular
 Requires-Dist: iso-639
 Requires-Dist: isodate
 Requires-Dist: notifications-api-common>=0.3.1
@@ -40,10 +40,15 @@ Requires-Dist: ape-pie
 Provides-Extra: markdown-docs
 Requires-Dist: django-markup<=1.3; extra == "markdown-docs"
 Requires-Dist: markdown; extra == "markdown-docs"
+Provides-Extra: djangorestframework-gis
+Requires-Dist: djangorestframework-gis>=1.0; extra == "djangorestframework-gis"
+Provides-Extra: drf-extra-fields
+Requires-Dist: drf-extra-fields>=3.7.0; extra == "drf-extra-fields"
 Provides-Extra: tests
 Requires-Dist: psycopg2; extra == "tests"
 Requires-Dist: pytest; extra == "tests"
 Requires-Dist: pytest-django; extra == "tests"
+Requires-Dist: pytest-dotenv; extra == "tests"
 Requires-Dist: pytest-factoryboy; extra == "tests"
 Requires-Dist: tox; extra == "tests"
 Requires-Dist: isort; extra == "tests"
@@ -51,8 +56,12 @@ Requires-Dist: black; extra == "tests"
 Requires-Dist: requests-mock; extra == "tests"
 Requires-Dist: freezegun; extra == "tests"
 Requires-Dist: zgw-consumers-oas; extra == "tests"
+Requires-Dist: djangorestframework-gis; extra == "tests"
+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"
 Provides-Extra: pep8
 Requires-Dist: flake8; extra == "pep8"
 Provides-Extra: coverage

{commonground_api_common-2.1.2 → commonground_api_common-2.3.0}/commonground_api_common.egg-info/SOURCES.txt

@@ -5,8 +5,6 @@ pyproject.toml
 setup.cfg
 setup.py
 bin/generate_schema
-bin/patch_content_types
-bin/use_external_components
 commonground_api_common.egg-info/PKG-INFO
 commonground_api_common.egg-info/SOURCES.txt
 commonground_api_common.egg-info/dependency_links.txt
@@ -18,7 +16,11 @@ tests/test_cache_headers.py
 tests/test_check_query_params.py
 tests/test_checks.py
 tests/test_choices.py
+tests/test_configuration_steps_applicaties.py
+tests/test_configuration_steps_jwtsecrets.py
 tests/test_content_type_headers.py
+tests/test_field_extensions.py
+tests/test_filter_extension.py
 tests/test_filters.py
 tests/test_gegevensgroepen.py
 tests/test_get_resource.py
@@ -29,7 +31,8 @@ tests/test_nested_serializer_validation.py
 tests/test_pagination.py
 tests/test_permissions.py
 tests/test_publish_validators.py
-tests/test_schema_root_tags.py
+tests/test_schema.py
+tests/test_serializer_extensions.py
 tests/test_server_errors.py
 tests/test_utils.py
 tests/test_validators.py
@@ -80,6 +83,7 @@ vng_api_common/audittrails/admin.py
 vng_api_common/audittrails/apps.py
 vng_api_common/audittrails/audits.py
 vng_api_common/audittrails/models.py
+vng_api_common/audittrails/utils.py
 vng_api_common/audittrails/viewsets.py
 vng_api_common/audittrails/api/__init__.py
 vng_api_common/audittrails/api/scopes.py
@@ -140,26 +144,21 @@ 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
-vng_api_common/inspectors/cache.py
-vng_api_common/inspectors/fields.py
-vng_api_common/inspectors/files.py
-vng_api_common/inspectors/geojson.py
-vng_api_common/inspectors/polymorphic.py
-vng_api_common/inspectors/query.py
-vng_api_common/inspectors/utils.py
-vng_api_common/inspectors/view.py
+vng_api_common/extensions/__init__.py
+vng_api_common/extensions/file.py
+vng_api_common/extensions/gegevensgroep.py
+vng_api_common/extensions/geojson.py
+vng_api_common/extensions/hyperlink.py
+vng_api_common/extensions/polymorphic.py
+vng_api_common/extensions/query.py
 vng_api_common/locale/nl/LC_MESSAGES/django.mo
 vng_api_common/locale/nl/LC_MESSAGES/django.po
-vng_api_common/management/__init__.py
-vng_api_common/management/commands/__init__.py
-vng_api_common/management/commands/generate_autorisaties.py
-vng_api_common/management/commands/generate_notificaties.py
-vng_api_common/management/commands/generate_swagger.py
-vng_api_common/management/commands/patch_error_contenttypes.py
-vng_api_common/management/commands/use_external_components.py
 vng_api_common/migrations/0001_initial.py
 vng_api_common/migrations/0002_apicredential.py
 vng_api_common/migrations/0003_auto_20190417_1145.py
@@ -207,11 +206,8 @@ vng_api_common/static/vng_api_common/libs/fontawesome/webfonts/fa-solid-900.svg
 vng_api_common/static/vng_api_common/libs/fontawesome/webfonts/fa-solid-900.ttf
 vng_api_common/static/vng_api_common/libs/fontawesome/webfonts/fa-solid-900.woff
 vng_api_common/static/vng_api_common/libs/fontawesome/webfonts/fa-solid-900.woff2
-vng_api_common/templates/vng_api_common/api_schema_to_markdown_table.md
-vng_api_common/templates/vng_api_common/autorisaties.md
 vng_api_common/templates/vng_api_common/index.html
 vng_api_common/templates/vng_api_common/master.html
-vng_api_common/templates/vng_api_common/notificaties.md
 vng_api_common/templates/vng_api_common/view_config.html
 vng_api_common/templates/vng_api_common/admin/base_site.html
 vng_api_common/templates/vng_api_common/includes/kanalen_card.html

{commonground_api_common-2.1.2 → commonground_api_common-2.3.0}/commonground_api_common.egg-info/requires.txt

@@ -4,8 +4,8 @@ django-solo
 djangorestframework>=3.15.0
 djangorestframework_camel_case>=1.2.0
 django-rest-framework-condition
-drf-yasg>=1.20.0
 drf-nested-routers>=0.94.1
+drf-spectacular
 iso-639
 isodate
 notifications-api-common>=0.3.1
@@ -20,11 +20,17 @@ ape-pie
 [coverage]
 pytest-cov
 
+[djangorestframework_gis]
+djangorestframework-gis>=1.0
+
 [docs]
 psycopg2
 sphinx
 sphinx-rtd-theme
 
+[drf_extra_fields]
+drf-extra-fields>=3.7.0
+
 [markdown_docs]
 django-markup<=1.3
 markdown
@@ -35,10 +41,14 @@ flake8
 [release]
 bump2version
 
+[setup-configuration]
+django-setup-configuration>=0.4.0
+
 [tests]
 psycopg2
 pytest
 pytest-django
+pytest-dotenv
 pytest-factoryboy
 tox
 isort
@@ -46,6 +56,8 @@ black
 requests-mock
 freezegun
 zgw-consumers-oas
+djangorestframework-gis
+drf-extra-fields
 
 [testutils]
 zgw-consumers-oas

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

@@ -1,6 +1,6 @@
 [metadata]
 name = commonground-api-common
-version = 2.1.2
+version = 2.3.0
 description = Commonground API tooling
 long_description = file: README.rst
 url = https://github.com/maykinmedia/commonground-api-common
@@ -28,8 +28,6 @@ include_package_data = True
 packages = find:
 scripts = 
 	bin/generate_schema
-	bin/patch_content_types
-	bin/use_external_components
 install_requires = 
 	django>=4.2.0
 	django-filter>=23.1,<=25.1
@@ -37,8 +35,8 @@ install_requires =
 	djangorestframework>=3.15.0
 	djangorestframework_camel_case>=1.2.0
 	django-rest-framework-condition
-	drf-yasg>=1.20.0 # TODO: remove usage?
 	drf-nested-routers>=0.94.1
+	drf-spectacular
 	iso-639
 	isodate
 	notifications-api-common>=0.3.1
@@ -52,6 +50,7 @@ install_requires =
 tests_require = 
 	pytest
 	pytest-django
+	pytest-dotenv
 	pytest-factoryboy
 	tox
 	isort
@@ -68,10 +67,15 @@ include =
 markdown_docs = 
 	django-markup<=1.3
 	markdown
+djangorestframework_gis = 
+	djangorestframework-gis>=1.0
+drf_extra_fields = 
+	drf-extra-fields>=3.7.0
 tests = 
 	psycopg2
 	pytest
 	pytest-django
+	pytest-dotenv
 	pytest-factoryboy
 	tox
 	isort
@@ -79,8 +83,12 @@ tests =
 	requests-mock
 	freezegun
 	zgw-consumers-oas
+	djangorestframework-gis
+	drf-extra-fields
 testutils = 
 	zgw-consumers-oas
+setup-configuration = 
+	django-setup-configuration>=0.4.0
 pep8 = flake8
 coverage = pytest-cov
 docs = 

{commonground_api_common-2.1.2 → commonground_api_common-2.3.0}/tests/test_cache_headers.py

@@ -1,21 +1,18 @@
 from unittest.mock import patch
 
 from django.db import transaction
+from django.urls import path
 
 import pytest
-from drf_yasg import openapi
-from drf_yasg.generators import SchemaGenerator
 from rest_framework import status, viewsets
 from rest_framework.reverse import reverse
-from rest_framework.test import APIRequestFactory
-from rest_framework.views import APIView
 
 from testapp.factories import GroupFactory, HobbyFactory, PersonFactory
 from testapp.models import Hobby, Person
 from testapp.serializers import HobbySerializer
 from testapp.viewsets import PersonViewSet
+from tests import generate_schema
 from vng_api_common.caching.decorators import conditional_retrieve
-from vng_api_common.inspectors.cache import get_cache_headers
 
 pytestmark = pytest.mark.django_db(transaction=True)
 
@@ -51,17 +48,20 @@ def test_200_on_stale_resource(api_client, person):
 
 
 def test_cache_headers_detected():
-    request = APIRequestFactory().get("/api/persons/1")
-    request = APIView().initialize_request(request)
-    callback = PersonViewSet.as_view({"get": "retrieve"}, detail=True)
-    generator = SchemaGenerator()
-
-    view = generator.create_view(callback, "GET", request=request)
+    urlpatterns = [
+        path(
+            "person/<int:pk>/",
+            PersonViewSet.as_view({"get": "retrieve"}, detail=True),
+            name="person-detail",
+        ),
+    ]
 
-    headers = get_cache_headers(view)
+    schema = generate_schema(urlpatterns)
 
-    assert "ETag" in headers
-    assert isinstance(headers["ETag"], openapi.Schema)
+    parameters = schema["paths"]["/person/{id}/"]["get"]["parameters"]
+    headers = [param for param in parameters if param["in"] == "header"]
+    assert len(headers) == 1
+    assert headers[0]["name"] == "If-None-Match"
 
 
 @pytest.mark.django_db(transaction=False)

commonground_api_common-2.3.0/tests/test_configuration_steps_applicaties.py

@@ -0,0 +1,82 @@
+import pytest
+from django_setup_configuration.test_utils import execute_single_step
+
+from vng_api_common.authorizations.models import Applicatie
+from vng_api_common.contrib.setup_configuration.steps import ApplicatieConfigurationStep
+
+CONFIG_FILE_PATH = "tests/files/setup_config_applicaties.yaml"
+
+
+@pytest.mark.django_db
+def test_execute_configuration_step_success():
+    execute_single_step(ApplicatieConfigurationStep, yaml_source=CONFIG_FILE_PATH)
+
+    assert Applicatie.objects.count() == 2
+
+    applicatie1, applicatie2 = Applicatie.objects.all()
+
+    assert str(applicatie1.uuid) == "78591bab-9a00-4887-849c-53b21a67782f"
+    assert applicatie1.client_ids == ["user-id", "user-id2"]
+    assert applicatie1.label == "applicatie1"
+    assert applicatie1.heeft_alle_autorisaties is True
+
+    assert str(applicatie2.uuid) == "fa0f6d18-5900-4d74-aad4-a748afb2c505"
+    assert applicatie2.client_ids == ["user-id2"]
+    assert applicatie2.label == "applicatie2"
+    assert applicatie2.heeft_alle_autorisaties is True
+
+
+@pytest.mark.django_db
+def test_execute_configuration_step_update_existing():
+    Applicatie.objects.create(
+        uuid="78591bab-9a00-4887-849c-53b21a67782f",
+        client_ids=["old-user-id"],
+        label="old applicatie1",
+    )
+    Applicatie.objects.create(
+        uuid="fa0f6d18-5900-4d74-aad4-a748afb2c505",
+        client_ids=["old-user-id2"],
+        label="old applicatie2",
+    )
+
+    execute_single_step(ApplicatieConfigurationStep, yaml_source=CONFIG_FILE_PATH)
+
+    assert Applicatie.objects.count() == 2
+
+    applicatie1, applicatie2 = Applicatie.objects.all()
+
+    assert str(applicatie1.uuid) == "78591bab-9a00-4887-849c-53b21a67782f"
+    assert applicatie1.client_ids == ["user-id", "user-id2"]
+    assert applicatie1.label == "applicatie1"
+    assert applicatie1.heeft_alle_autorisaties is True
+
+    assert str(applicatie2.uuid) == "fa0f6d18-5900-4d74-aad4-a748afb2c505"
+    assert applicatie2.client_ids == ["user-id2"]
+    assert applicatie2.label == "applicatie2"
+    assert applicatie2.heeft_alle_autorisaties is True
+
+
+@pytest.mark.django_db
+def test_execute_configuration_step_idempotent():
+    def make_assertions():
+        assert Applicatie.objects.count() == 2
+
+        applicatie1, applicatie2 = Applicatie.objects.all()
+
+        assert str(applicatie1.uuid) == "78591bab-9a00-4887-849c-53b21a67782f"
+        assert applicatie1.client_ids == ["user-id", "user-id2"]
+        assert applicatie1.label == "applicatie1"
+        assert applicatie1.heeft_alle_autorisaties is True
+
+        assert str(applicatie2.uuid) == "fa0f6d18-5900-4d74-aad4-a748afb2c505"
+        assert applicatie2.client_ids == ["user-id2"]
+        assert applicatie2.label == "applicatie2"
+        assert applicatie2.heeft_alle_autorisaties is True
+
+    execute_single_step(ApplicatieConfigurationStep, yaml_source=CONFIG_FILE_PATH)
+
+    make_assertions()
+
+    execute_single_step(ApplicatieConfigurationStep, yaml_source=CONFIG_FILE_PATH)
+
+    make_assertions()

commonground_api_common-2.3.0/tests/test_configuration_steps_jwtsecrets.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.3.0/tests/test_content_type_headers.py

@@ -0,0 +1,76 @@
+"""
+Test that the required content type headers are present.
+"""
+
+from django.urls import path
+
+from rest_framework.parsers import JSONParser, MultiPartParser
+from rest_framework.renderers import JSONRenderer
+from rest_framework.response import Response
+from rest_framework.views import APIView
+
+from tests import generate_schema
+
+
+class DummyView(APIView):
+    renderer_classes = (JSONRenderer,)
+
+    def get(self, request):
+        return Response({})
+
+    def post(self, request):
+        return Response({})
+
+
+class JSONView(DummyView):
+    parser_classes = (JSONParser,)
+
+
+class MultiPartView(DummyView):
+    parser_classes = (MultiPartParser,)
+
+
+urlpatterns = [
+    path("json", JSONView.as_view(), name="json"),
+    path("multipart", MultiPartView.as_view(), name="multipart"),
+]
+
+
+def _generate_schema():
+    return generate_schema(urlpatterns)
+
+
+def test_json_content_type():
+    schema = _generate_schema()
+
+    get_operation = schema["paths"]["/json"]["get"]
+    post_operation = schema["paths"]["/json"]["post"]
+
+    assert get_operation.get("parameters", []) == []
+    assert post_operation["parameters"] == [
+        {
+            "description": "Content type of the request body.",
+            "in": "header",
+            "name": "Content-Type",
+            "required": True,
+            "schema": {"enum": ["application/json"], "type": "string"},
+        }
+    ]
+
+
+def test_multipart_content_type():
+    schema = _generate_schema()
+
+    get_operation = schema["paths"]["/multipart"]["get"]
+    post_operation = schema["paths"]["/multipart"]["post"]
+
+    assert get_operation.get("parameters", []) == []
+    assert post_operation["parameters"] == [
+        {
+            "in": "header",
+            "name": "Content-Type",
+            "schema": {"type": "string", "enum": ["multipart/form-data"]},
+            "description": "Content type of the request body.",
+            "required": True,
+        }
+    ]