commonground-api-common 1.13.4__py3-none-any.whl → 2.0.1__py3-none-any.whl

vng_api_common/migrations/0006_delete_apicredential.py

@@ -0,0 +1,119 @@
+# Generated by Django 5.1.2 on 2024-10-24 13:51
+
+import logging
+from typing import Set
+
+from django.db import migrations, models
+from django.utils.text import slugify
+
+from zgw_consumers.constants import APITypes, AuthTypes
+
+logger = logging.getLogger(__name__)
+
+
+def _get_api_type(api_root: str) -> APITypes:
+    mapping = {
+        "/autorisaties/api/": APITypes.ac,
+        "/zaken/api/": APITypes.zrc,
+        "/catalogi/api/": APITypes.ztc,
+        "/documenten/api/": APITypes.drc,
+        "/besluiten/api/": APITypes.drc,
+    }
+
+    for path, _type in mapping.items():
+        if path in api_root.lower():
+            return _type
+
+    return APITypes.orc
+
+
+def _get_service_slug(credential: models.Model, existing_slugs: Set[str]) -> str:
+    default_slug: str = slugify(credential.label)
+
+    if default_slug not in existing_slugs or not existing_slugs:
+        return default_slug
+
+    count = 2
+    slug = f"{default_slug}-{count}"
+
+    while slug in existing_slugs:
+        count += 1
+        slug = f"{default_slug}-{count}"
+
+    return slug
+
+
+def migrate_credentials_to_service(apps, _) -> None:
+    APICredential = apps.get_model("vng_api_common", "APICredential")
+    Service = apps.get_model("zgw_consumers", "Service")
+
+    credentials = APICredential.objects.all()
+
+    existings_service_slugs = set(Service.objects.values_list("slug", flat=True))
+
+    for credential in credentials:
+        logger.info(f"Creating Service for {credential.client_id}")
+
+        service_slug = _get_service_slug(credential, existings_service_slugs)
+
+        _, created = Service.objects.get_or_create(
+            api_root=credential.api_root,
+            defaults=dict(
+                label=credential.label,
+                slug=service_slug,
+                api_type=_get_api_type(credential.api_root),
+                auth_type=AuthTypes.zgw,
+                client_id=credential.client_id,
+                secret=credential.secret,
+                user_id=credential.user_id,
+                user_representation=credential.user_representation,
+            ),
+        )
+
+        existings_service_slugs.add(service_slug)
+
+        if created:
+            logger.info(f"Created new Service for {credential.api_root}")
+        else:
+            logger.info(f"Existing service found for {credential.api_root}")
+
+
+def migrate_service_to_credentials(apps, _) -> None:
+    APICredential = apps.get_model("vng_api_common", "APICredential")
+    Service = apps.get_model("zgw_consumers", "Service")
+
+    services = Service.objects.filter(auth_type=AuthTypes.zgw)
+
+    for service in services:
+        logger.info(f"Creating APICredentials for {service.client_id}")
+
+        _, created = APICredential.objects.get_or_create(
+            api_root=service.api_root,
+            defaults=dict(
+                label=f"Migrated credentials for {service.client_id}",
+                client_id=service.client_id,
+                secret=service.secret,
+                user_id=service.user_id,
+                user_representation=service.user_representation,
+            ),
+        )
+        if created:
+            logger.info(f"Created new APICredentials for {service.api_root}")
+        else:
+            logger.info(f"Existing APICredentials found for {service.api_root}")
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("vng_api_common", "0005_auto_20190614_1346"),
+    ]
+
+    operations = [
+        migrations.RunPython(
+            migrate_credentials_to_service, reverse_code=migrate_service_to_credentials
+        ),
+        migrations.DeleteModel(
+            name="APICredential",
+        ),
+    ]

vng_api_common/mocks.py

@@ -1,7 +1,10 @@
 import re
 from urllib.parse import urlparse
 
-from zds_client.client import UUID_PATTERN
+UUID_PATTERN = re.compile(
+    r"[0-9a-f]{8}\-[0-9a-f]{4}\-4[0-9a-f]{3}\-[89ab][0-9a-f]{3}\-[0-9a-f]{12}",
+    flags=re.I,
+)
 
 
 class Response:

vng_api_common/models.py

@@ -1,15 +1,7 @@
-from typing import Optional, Union
-from urllib.parse import urlsplit, urlunsplit
-
 from django.db import models
-from django.db.models.functions import Length
 from django.utils.translation import gettext_lazy as _
 
 from rest_framework.reverse import reverse
-from solo.models import SingletonModel
-from zds_client import Client, ClientAuth
-
-from .client import get_client as _get_client
 
 
 class APIMixin:
@@ -69,106 +61,3 @@ class JWTSecret(models.Model):
 
     def __str__(self):
         return self.identifier
-
-
-class APICredential(models.Model):
-    """
-    Store credentials for external APIs.
-
-    When we need to authenticate against a remote API, we need to know which
-    client ID and secret to use to sign the JWT.
-    """
-
-    api_root = models.URLField(
-        _("API-root"),
-        unique=True,
-        help_text=_(
-            "URL of the external API, ending in a trailing slash. Example: https://example.com/api/v1/"
-        ),
-    )
-    label = models.CharField(
-        _("label"),
-        max_length=100,
-        default="",
-        help_text=_("Human readable label of the external API."),
-    )
-    client_id = models.CharField(
-        _("client ID"),
-        max_length=255,
-        help_text=_("Client ID to identify this API at the external API."),
-    )
-    secret = models.CharField(
-        _("secret"), max_length=255, help_text=_("Secret belonging to the client ID.")
-    )
-    user_id = models.CharField(
-        _("user ID"),
-        max_length=255,
-        help_text=_(
-            "User ID to use for the audit trail. Although these external API credentials are typically used by"
-            "this API itself instead of a user, the user ID is required."
-        ),
-    )
-    user_representation = models.CharField(
-        _("user representation"),
-        max_length=255,
-        default="",
-        help_text=_("Human readable representation of the user."),
-    )
-
-    class Meta:
-        verbose_name = _("external API credential")
-        verbose_name_plural = _("external API credentials")
-
-    def __str__(self):
-        return self.api_root
-
-    @classmethod
-    def get_auth(cls, url: str, **kwargs) -> Union[ClientAuth, None]:
-        split_url = urlsplit(url)
-        scheme_and_domain = urlunsplit(split_url[:2] + ("", "", ""))
-
-        candidates = (
-            cls.objects.filter(api_root__startswith=scheme_and_domain)
-            .annotate(api_root_length=Length("api_root"))
-            .order_by("-api_root_length")
-        )
-
-        # select the one matching
-        for candidate in candidates.iterator():
-            if url.startswith(candidate.api_root):
-                credentials = candidate
-                break
-        else:
-            return None
-
-        auth = ClientAuth(
-            client_id=credentials.client_id,
-            secret=credentials.secret,
-            user_id=credentials.user_id,
-            user_representation=credentials.user_representation,
-            **kwargs,
-        )
-        return auth
-
-
-class ClientConfig(SingletonModel):
-    api_root = models.URLField(_("api root"), unique=True)
-
-    class Meta:
-        abstract = True
-
-    def __str__(self):
-        return self.api_root
-
-    def save(self, *args, **kwargs):
-        if not self.api_root.endswith("/"):
-            self.api_root = f"{self.api_root}/"
-        super().save(*args, **kwargs)
-
-    @classmethod
-    def get_client(cls) -> Optional[Client]:
-        """
-        Construct a client, prepared with the required auth.
-        """
-        config = cls.get_solo()
-        return _get_client(config.api_root, url_is_api_root=True)

vng_api_common/notifications/api/views.py

@@ -3,6 +3,7 @@ from django.utils.module_loading import import_string
 
 from drf_yasg.utils import swagger_auto_schema
 from notifications_api_common.api.serializers import NotificatieSerializer
+from notifications_api_common.constants import SCOPE_NOTIFICATIES_PUBLICEREN_LABEL
 from rest_framework import status
 from rest_framework.response import Response
 from rest_framework.views import APIView
@@ -10,7 +11,6 @@ from rest_framework.views import APIView
 from ...permissions import AuthScopesRequired
 from ...scopes import Scope
 from ...serializers import FoutSerializer, ValidatieFoutSerializer
-from ..constants import SCOPE_NOTIFICATIES_PUBLICEREN_LABEL
 
 
 class NotificationBaseView(APIView):

vng_api_common/notifications/handlers.py

@@ -4,7 +4,7 @@ from djangorestframework_camel_case.util import underscoreize
 
 from ..authorizations.models import Applicatie
 from ..authorizations.serializers import ApplicatieUuidSerializer
-from ..client import get_client
+from ..client import get_client, to_internal_data
 from ..constants import CommonResourceAction
 from ..utils import get_uuid_from_path
 
@@ -20,8 +20,13 @@ class LoggingHandler:
 class AuthHandler:
     def _request_auth(self, url: str) -> dict:
         client = get_client(url)
-        response = client.retrieve("applicatie", url)
-        return underscoreize(response)
+
+        if not client:
+            return {}
+
+        response = client.get(url)
+        data = to_internal_data(response)
+        return underscoreize(data)
 
     def handle(self, message: dict) -> None:
         uuid = get_uuid_from_path(message["resource_url"])

vng_api_common/notifications/migrations/0011_remove_subscription_config_and_more.py

@@ -0,0 +1,23 @@
+# Generated by Django 5.1.2 on 2024-10-25 14:07
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("notifications", "0010_auto_20220704_1419"),
+    ]
+
+    operations = [
+        migrations.RemoveField(
+            model_name="subscription",
+            name="config",
+        ),
+        migrations.DeleteModel(
+            name="NotificationsConfig",
+        ),
+        migrations.DeleteModel(
+            name="Subscription",
+        ),
+    ]

vng_api_common/oas.py

@@ -1,8 +1,5 @@
 """
 Utility module for Open API Specification 3.0.x.
-
-This should get merged into gemma-zds-client, but some heavy refactoring is
-needed for that.
 """
 
 from typing import Union

vng_api_common/routers.py

@@ -8,7 +8,7 @@ class APIRootView(_APIRootView):
     permission_classes = ()
 
 
-class ZDSNestedRegisteringMixin:
+class NestedRegisteringMixin:
     _nested_router = None
 
     def __init__(self, *args, **kwargs):
@@ -47,11 +47,11 @@ class ZDSNestedRegisteringMixin:
             )
 
 
-class NestedSimpleRouter(ZDSNestedRegisteringMixin, routers.NestedSimpleRouter):
+class NestedSimpleRouter(NestedRegisteringMixin, routers.NestedSimpleRouter):
     pass
 
 
-class DefaultRouter(ZDSNestedRegisteringMixin, routers.DefaultRouter):
+class DefaultRouter(NestedRegisteringMixin, routers.DefaultRouter):
     APIRootView = APIRootView
 
 

vng_api_common/tests/schema.py

@@ -5,6 +5,8 @@ from urllib.parse import urlparse
 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"}
 
@@ -69,3 +71,13 @@ def get_validation_errors(response, field, index=0):
             return error
 
         i += 1
+
+
+def mock_service_oas_get(
+    mock: Mocker, url: str, service: str, oas_url: str = ""
+) -> None:
+    if not oas_url:
+        oas_url = f"{url}schema/openapi.yaml?v=3"
+
+    content = read_schema(service)
+    mock.get(oas_url, content=content)

vng_api_common/utils.py

@@ -13,9 +13,6 @@ from django.utils.encoding import smart_str
 from django.utils.module_loading import import_string
 
 from rest_framework.utils import formatting
-from zds_client.client import ClientError
-
-from .client import get_client
 
 try:
     from djangorestframework_camel_case.util import (
@@ -186,25 +183,6 @@ def get_uuid_from_path(path: str) -> str:
     return uuid_str
 
 
-def request_object_attribute(
-    url: str, attribute: str, resource: Union[str, None] = None
-) -> str:
-    client = get_client(url)
-
-    try:
-        result = client.retrieve(resource, url=url)[attribute]
-    except (ClientError, KeyError) as exc:
-        logger.warning(
-            "%s was retrieved from %s with the %s: %s",
-            attribute,
-            url,
-            exc.__class__.__name__,
-            exc,
-        )
-        result = ""
-    return result
-
-
 def generate_unique_identification(instance: models.Model, date_field_name: str):
     model = type(instance)
     model_name = getattr(model, "IDENTIFICATIE_PREFIX", model._meta.model_name.upper())

vng_api_common/validators.py

@@ -11,10 +11,8 @@ from django.utils.deconstruct import deconstructible
 from django.utils.module_loading import import_string
 from django.utils.translation import gettext_lazy as _
 
-import requests
 from rest_framework import serializers, validators
 
-from .client import get_client
 from .constants import RSIN_LENGTH
 from .oas import fetcher, obj_has_shape
 
@@ -221,42 +219,6 @@ class InformatieObjectUniqueValidator(validators.UniqueTogetherValidator):
         super().__call__(attrs)
 
 
-class ObjectInformatieObjectValidator:
-    """
-    Validate that the INFORMATIEOBJECT is linked already in the DRC.
-    """
-
-    message = _(
-        "Het informatieobject is in het DRC nog niet gerelateerd aan dit object."
-    )
-    code = "inconsistent-relation"
-    requires_context = True
-
-    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)
-
-        try:
-            oios = client.list(
-                "objectinformatieobject",
-                query_params={
-                    "informatieobject": informatieobject,
-                    "object": object_url,
-                },
-            )
-        except requests.HTTPError as exc:
-            raise serializers.ValidationError(
-                exc.args[0], code="relation-validation-error"
-            ) from exc
-
-        if len(oios) == 0:
-            raise serializers.ValidationError(self.message, code=self.code)
-
-
 @deconstructible
 class UntilNowValidator:
     """

vng_api_common/views.py

@@ -1,6 +1,7 @@
 import logging
 import os
 from collections import OrderedDict
+from typing import Optional
 
 from django.apps import apps
 from django.conf import settings
@@ -13,7 +14,8 @@ import requests
 from rest_framework import exceptions as drf_exceptions, status
 from rest_framework.response import Response
 from rest_framework.views import exception_handler as drf_exception_handler
-from zds_client import ClientError
+
+from vng_api_common.client import Client, ClientError
 
 from . import exceptions
 from .compat import sentry_client
@@ -128,12 +130,20 @@ def _test_ac_config() -> list:
     auth_config = AuthorizationsConfig.get_solo()
 
     # check if AC auth is configured
-    ac_client = AuthorizationsConfig.get_client()
-    has_ac_auth = ac_client.auth is not None
+    ac_client: Optional[Client] = AuthorizationsConfig.get_client()
+    has_ac_auth = ac_client.auth is not None if ac_client else False
 
     checks = [
         (_("Type of component"), auth_config.get_component_display(), None),
-        (_("AC"), auth_config.api_root, auth_config.api_root.endswith("/")),
+        (
+            _("AC"),
+            (
+                auth_config.authorizations_api_service.api_root
+                if ac_client
+                else _("Missing")
+            ),
+            bool(ac_client),
+        ),
         (
             _("Credentials for AC"),
             _("Configured") if has_ac_auth else _("Missing"),
@@ -145,18 +155,17 @@ def _test_ac_config() -> list:
     if has_ac_auth:
         error = False
 
+        client_id = ac_client.auth.service.client_id
+
         try:
-            ac_client.list(
-                "applicatie", query_params={"clientIds": ac_client.auth.client_id}
+            response: requests.Response = ac_client.get(
+                "applicaties", params={"clientIds": client_id}
             )
-        except requests.ConnectionError:
+
+            response.raise_for_status()
+        except requests.RequestException:
             error = True
             message = _("Could not connect with AC")
-        except ClientError as exc:
-            error = True
-            message = _(
-                "Cannot retrieve authorizations: HTTP {status_code} - {error_code}"
-            ).format(status_code=exc.args[0]["status"], error_code=exc.args[0]["code"])
         else:
             message = _("Can retrieve authorizations")
 
@@ -166,14 +175,13 @@ def _test_ac_config() -> list:
 
 
 def _test_nrc_config() -> list:
-    if not apps.is_installed("vng_api_common.notifications"):
+    if not apps.is_installed("notifications_api_common"):
         return []
 
     from notifications_api_common.models import NotificationsConfig, Subscription
 
     nrc_config = NotificationsConfig.get_solo()
-
-    nrc_client = NotificationsConfig.get_client()
+    nrc_client: Optional[Client] = NotificationsConfig.get_client()
 
     has_nrc_auth = nrc_client.auth is not None if nrc_client else False
 
@@ -199,15 +207,11 @@ def _test_nrc_config() -> list:
         error = False
 
         try:
-            nrc_client.list("kanaal")
-        except requests.ConnectionError:
+            response: requests.Response = nrc_client.get("kanaal")
+            response.raise_for_status()
+        except requests.RequestException:
             error = True
             message = _("Could not connect with NRC")
-        except ClientError as exc:
-            error = True
-            message = _(
-                "Cannot retrieve kanalen: HTTP {status_code} - {error_code}"
-            ).format(status_code=exc.args[0]["status"], error_code=exc.args[0]["code"])
         else:
             message = _("Can retrieve kanalen")
 

vng_api_common/notifications/constants.py

@@ -1,3 +0,0 @@
-# Exernally defined scopes.
-SCOPE_NOTIFICATIES_CONSUMEREN_LABEL = "notificaties.consumeren"
-SCOPE_NOTIFICATIES_PUBLICEREN_LABEL = "notificaties.publiceren"

vng_api_common/notifications/models.py

@@ -1,97 +0,0 @@
-import uuid
-from urllib.parse import urljoin
-
-from django.contrib.postgres.fields import ArrayField
-from django.db import models
-from django.utils.translation import gettext_lazy as _
-
-from zds_client import ClientAuth
-
-from ..client import get_client
-from ..decorators import field_default
-from ..models import APICredential, ClientConfig
-
-
-@field_default("api_root", "https://notificaties-api.vng.cloud/api/v1/")
-class NotificationsConfig(ClientConfig):
-    class Meta:
-        verbose_name = _("Notificatiescomponentconfiguratie")
-
-    def get_auth(self) -> ClientAuth:
-        auth = APICredential.get_auth(self.api_root)
-        return auth
-
-
-class Subscription(models.Model):
-    """
-    A single subscription.
-
-    TODO: on change/update, update the subscription
-    """
-
-    config = models.ForeignKey("NotificationsConfig", on_delete=models.CASCADE)
-
-    callback_url = models.URLField(
-        _("callback url"), help_text=_("Where to send the notifications (webhook url)")
-    )
-    client_id = models.CharField(
-        _("client ID"),
-        max_length=50,
-        help_text=_("Client ID to construct the auth token"),
-    )
-    secret = models.CharField(
-        _("client secret"),
-        max_length=50,
-        help_text=_("Secret to construct the auth token"),
-    )
-    channels = ArrayField(
-        models.CharField(max_length=100),
-        verbose_name=_("channels"),
-        help_text=_("Comma-separated list of channels to subscribe to"),
-    )
-
-    _subscription = models.URLField(
-        _("NC subscription"),
-        blank=True,
-        editable=False,
-        help_text=_("Subscription as it is known in the NC"),
-    )
-
-    class Meta:
-        verbose_name = _("Webhook subscription")
-        verbose_name_plural = _("Webhook subscriptions")
-
-    def __str__(self):
-        return f"{', '.join(self.channels)} - {self.callback_url}"
-
-    def register(self) -> None:
-        """
-        Registers the webhook with the notification component.
-        """
-        dummy_detail_url = urljoin(self.config.api_root, f"foo/{uuid.uuid4()}")
-        client = get_client(dummy_detail_url)
-
-        # This authentication is for the NC to call us. Thus, it's *not* for
-        # calling the NC to create a subscription.
-        self_auth = ClientAuth(
-            client_id=self.client_id,
-            secret=self.secret,
-        )
-        data = {
-            "callbackUrl": self.callback_url,
-            "auth": self_auth.credentials()["Authorization"],
-            "kanalen": [
-                {
-                    "naam": channel,
-                    # FIXME: You need to be able to configure these.
-                    "filters": {},
-                }
-                for channel in self.channels
-            ],
-        }
-
-        # register the subscriber
-        subscriber = client.create("abonnement", data=data)
-
-        self._subscription = subscriber["url"]
-        self.save(update_fields=["_subscription"])