Merge pull request #1472 from maykinmedia/tasks/2838-ok2-client-zgw-c…

…onsumers-compat

[#2838] Make OpenKlant2 client compatible with zgw_consumers logic

src/open_inwoner/openklant/models.py

@@ -1,7 +1,9 @@
 import uuid
 from dataclasses import dataclass
+from typing import Self
 from urllib.parse import urljoin
 
+from django.core.exceptions import ImproperlyConfigured
 from django.db import models
 from django.utils.translation import gettext_lazy as _
 
@@ -208,8 +210,12 @@ def api_url(self):
         return urljoin(self.api_root, self.api_path)
 
     @classmethod
-    def from_django_settings(cls):
+    def from_django_settings(cls) -> Self:
         from django.conf import settings
 
-        if config := getattr(settings, "OPENKLANT2_CONFIG", None):
-            return cls(**config)
+        if not (config := getattr(settings, "OPENKLANT2_CONFIG", None)):
+            raise ImproperlyConfigured(
+                "Please set OPENKLANT2_CONFIG in your settings to configure OpenKlant2"
+            )
+
+        return cls(**config)

src/open_inwoner/openklant/services.py

@@ -154,8 +154,10 @@ class OpenKlant2Service:
     def __init__(self, config: OpenKlant2Config | None = None):
         self.config = config or OpenKlant2Config.from_django_settings()
         self.client = OpenKlant2Client(
-            api_url=self.config.api_url,
-            api_token=self.config.api_token,
+            base_url=self.config.api_url,
+            request_kwargs={
+                "headers": {"Authorization": f"Token {self.config.api_token}"}
+            },
         )
         if mijn_vragen_actor := getattr(config, "mijn_vragen_actor", None):
             self.mijn_vragen_actor = (

src/openklant2/client.py

@@ -1,3 +1,5 @@
+from typing import Any
+
 from ape_pie import APIClient
 
 from openklant2._resources.actor import ActorResource
@@ -10,21 +12,28 @@
 from openklant2._resources.partij_identificator import PartijIdentificatorResource
 
 
-class OpenKlant2Client:
-    http_client: APIClient
+class OpenKlant2Client(APIClient):
     partij: PartijResource
+    partij_identificator: PartijIdentificatorResource
+    digitaal_adres: DigitaalAdresResource
+    klant_contact: KlantContactResource
+    onderwerp_object: OnderwerpObjectResource
+    actor: ActorResource
+    interne_taak: InterneTaakResource
+    betrokkene: BetrokkeneResource
 
-    def __init__(self, api_url: str, api_token: str):
-        self.http_client = APIClient(
-            request_kwargs={"headers": {"Authorization": f"Token {api_token}"}},
-            base_url=api_url,
-        )
+    def __init__(
+        self,
+        base_url: str,
+        request_kwargs: dict[str, Any] | None = None,
+    ):
+        super().__init__(base_url=base_url, request_kwargs=request_kwargs)
 
-        self.partij = PartijResource(self.http_client)
-        self.partij_identificator = PartijIdentificatorResource(self.http_client)
-        self.digitaal_adres = DigitaalAdresResource(self.http_client)
-        self.klant_contact = KlantContactResource(self.http_client)
-        self.onderwerp_object = OnderwerpObjectResource(self.http_client)
-        self.actor = ActorResource(self.http_client)
-        self.interne_taak = InterneTaakResource(self.http_client)
-        self.betrokkene = BetrokkeneResource(self.http_client)
+        self.partij = PartijResource(self)
+        self.partij_identificator = PartijIdentificatorResource(self)
+        self.digitaal_adres = DigitaalAdresResource(self)
+        self.klant_contact = KlantContactResource(self)
+        self.onderwerp_object = OnderwerpObjectResource(self)
+        self.actor = ActorResource(self)
+        self.interne_taak = InterneTaakResource(self)
+        self.betrokkene = BetrokkeneResource(self)

src/openklant2/tests/helpers.py

@@ -148,8 +148,8 @@ def api_url(self):
 
     def client_factory(self):
         return OpenKlant2Client(
-            api_url=self.api_url,
-            api_token=self._api_token,
+            base_url=self.api_url,
+            request_kwargs={"headers": {"Authorization": f"Token {self._api_token}"}},
         )
 
     def clean_state(self):