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

{commonground_api_common-2.0.1.dist-info → commonground_api_common-2.1.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: commonground-api-common
-Version: 2.0.1
+Version: 2.1.0
 Summary: Commonground API tooling
 Home-page: https://github.com/maykinmedia/commonground-api-common
 Author: Maykin Media, VNG-Realisatie
@@ -29,10 +29,10 @@ Requires-Dist: drf-yasg>=1.20.0
 Requires-Dist: drf-nested-routers>=0.94.1
 Requires-Dist: iso-639
 Requires-Dist: isodate
-Requires-Dist: notifications-api-common>=0.3.0
+Requires-Dist: notifications-api-common>=0.3.1
 Requires-Dist: zgw-consumers>=0.35.1
 Requires-Dist: oyaml
-Requires-Dist: PyJWT>=2.0.1
+Requires-Dist: PyJWT>=2.1.0
 Requires-Dist: requests
 Requires-Dist: requests-mock
 Requires-Dist: coreapi

{commonground_api_common-2.0.1.dist-info → commonground_api_common-2.1.0.dist-info}/RECORD

@@ -1,12 +1,12 @@
-commonground_api_common-2.0.1.data/scripts/generate_schema,sha256=UKhznmbHX1zUjPx8G3XtxUPQiqnyd3TOIXs27Tnjl7U,952
-commonground_api_common-2.0.1.data/scripts/patch_content_types,sha256=dpGpYrZOZe8O5CHWd0F0QnP6Wk_7lK6DyuVZpBPr4mY,319
-commonground_api_common-2.0.1.data/scripts/use_external_components,sha256=xvvbngO2aDUagVXv4xRUqPaVtH_eOaVMWLQ8lyAPhEA,369
-vng_api_common/__init__.py,sha256=wAxkK8w13vqoF47A8iqWdSlIgRRXmZiQ0R4wePZfzhs,22
+commonground_api_common-2.1.0.data/scripts/generate_schema,sha256=UKhznmbHX1zUjPx8G3XtxUPQiqnyd3TOIXs27Tnjl7U,952
+commonground_api_common-2.1.0.data/scripts/patch_content_types,sha256=dpGpYrZOZe8O5CHWd0F0QnP6Wk_7lK6DyuVZpBPr4mY,319
+commonground_api_common-2.1.0.data/scripts/use_external_components,sha256=xvvbngO2aDUagVXv4xRUqPaVtH_eOaVMWLQ8lyAPhEA,369
+vng_api_common/__init__.py,sha256=Xybt2skBZamGMNlLuOX1IG-h4uIxqUDGAO8MIGWrJac,22
 vng_api_common/admin.py,sha256=iFtUPGf-ha0I-bXgq8QIFrP23Kzk_H3FlgAjt0U-ip0,259
 vng_api_common/apps.py,sha256=wOQuxUImMpH39R0JrDdCZp5ADaUM8jU8vFPFW9froSs,3458
 vng_api_common/checks.py,sha256=tOyfV7MMLGh4anrd_W30LvJCxiyQ4sFs1mGd9mtrEc0,1175
 vng_api_common/choices.py,sha256=dboFRoM34GpRUpxB9WexexccopcQSogu1QIyY4B9ACY,541
-vng_api_common/client.py,sha256=EZWygrJum6pLeKS77mzynfV9kq0gPTjXXSHEpeyEZHg,1888
+vng_api_common/client.py,sha256=HNLc86RwczAudPBDgH_zQncE19OUaLyhSnacQRxJO0c,1972
 vng_api_common/compat.py,sha256=n4jDFSPzXnh-D_VXjftKMCJYj_q_t6eJrUTWLayl8jQ,768
 vng_api_common/constants.py,sha256=yYtnYId9alRuhGBoqaO8lkXYi_ATi2FW-wEDGRpiRuQ,10948
 vng_api_common/decorators.py,sha256=_p-mAyi5Na_-ll00ErcQ3mRoZNCsJzYDAliXn50Bmes,278
@@ -35,7 +35,7 @@ vng_api_common/urls.py,sha256=9IWHYLlEIIHNaZ_Zq02qNQ2HJpETb7o-89r7yBM_tQs,270
 vng_api_common/utils.py,sha256=zrtpssOA-NcJHhAlxioBiXeY3G2R_uf0l8oWkDD_EiE,8511
 vng_api_common/validators.py,sha256=Y1OQrmnH3U01hnCizWc_xjpSSGUWKlwiFxeHHGCThpI,11012
 vng_api_common/version.py,sha256=yJV9_yTM7Qnzg0zGNkJQkN9Uai3I_ZUkcyseJRPRk5I,129
-vng_api_common/views.py,sha256=seRGa-_2BPtrtHP6C6mmQCnT10q9ECfRHa8lpwyEcmM,7230
+vng_api_common/views.py,sha256=trsAZjyZt0PRaZOCDvjMJ5xTz4Ic0u4M73k0K_2qS4o,7620
 vng_api_common/viewsets.py,sha256=z5pzvSymFiiuCjP_-uuW-3OJKZY_psPAt8fWeWySU0c,2278
 vng_api_common/api/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 vng_api_common/api/permissions.py,sha256=okbwiscxlAtbQWTCRDLL2reOxgj0rRDZeDcrtXAYq00,739
@@ -132,7 +132,7 @@ vng_api_common/migrations/0002_apicredential.py,sha256=AYgkLMizI0g-Ogth8j_FVJHTD
 vng_api_common/migrations/0003_auto_20190417_1145.py,sha256=0ABqDggAdjmZxhSsLrMb2ZBwTcR1BOWo1Tn8StfiG0A,1001
 vng_api_common/migrations/0004_auto_20190517_0903.py,sha256=-Qcei-AJx4SXbEYMojmYInhV74uKtDncGP1PLs6hn0M,707
 vng_api_common/migrations/0005_auto_20190614_1346.py,sha256=5n8SVpbEJzLrSx-7d446Vy1--SaDfO05hAltrSRQx6o,2949
-vng_api_common/migrations/0006_delete_apicredential.py,sha256=VMVwH4vj9Zq-oF_Z1Do9wobgePtkujwd8bO8M57ACt0,3621
+vng_api_common/migrations/0006_delete_apicredential.py,sha256=lN9NFSbwMGlrREe_5LtqxiPk74_1iCbeoMhY5B7pXjc,3681
 vng_api_common/migrations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 vng_api_common/notifications/__init__.py,sha256=UvHr_M8s-dZjCQOp60rLDqP_T3D0CgRIqc8ry5bIM8c,229
 vng_api_common/notifications/apps.py,sha256=7grk1hxQn5usAWV-sWATmNJ4TwSvT3izXVvV-L-zb_s,208
@@ -191,7 +191,7 @@ vng_api_common/tests/auth.py,sha256=IKDWTEFv4Bign4F70-ibsFcnJqRxEJaXvqaPQJWa1xY,
 vng_api_common/tests/caching.py,sha256=zfIw5cRRvO9cekHZZKfRqZc8cx5IfJUYNmcH6cuIMg4,624
 vng_api_common/tests/schema.py,sha256=irt_kIp1uJsnYIJlrpk0-qM9W6i44WyX3GSiJvGUfdU,2288
 vng_api_common/tests/urls.py,sha256=PFrYzQbBC0TFPMEn3uPhcBG0IQs9JsEPqckicJT1UA4,2159
-commonground_api_common-2.0.1.dist-info/METADATA,sha256=-xJGeWAsWqA4c1ZWjSmfVaEJl7AcHAyvGuGwLbgyAws,6497
-commonground_api_common-2.0.1.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
-commonground_api_common-2.0.1.dist-info/top_level.txt,sha256=vPismc83zPzWXTmlNCCwfDlFV9iygJYxNJW5iDjKTgw,15
-commonground_api_common-2.0.1.dist-info/RECORD,,
+commonground_api_common-2.1.0.dist-info/METADATA,sha256=SCXtFBl_MO_jXJ-9ulYtK3dX0bTQcuK84IDaWTwbRUM,6497
+commonground_api_common-2.1.0.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
+commonground_api_common-2.1.0.dist-info/top_level.txt,sha256=vPismc83zPzWXTmlNCCwfDlFV9iygJYxNJW5iDjKTgw,15
+commonground_api_common-2.1.0.dist-info/RECORD,,

vng_api_common/__init__.py

@@ -1 +1 @@
-__version__ = "2.0.1"
+__version__ = "2.1.0"

vng_api_common/client.py

@@ -3,10 +3,6 @@ Interface to get a client object for a given URL.
 """
 
 import logging
-from typing import Any, Optional
-
-from django.conf import settings
-from django.utils.module_loading import import_string
 
 from ape_pie import APIClient
 from requests import JSONDecodeError, RequestException, Response
@@ -18,6 +14,10 @@ class ClientError(RuntimeError):
     pass
 
 
+class NoServiceConfigured(RuntimeError):
+    pass
+
+
 # TODO: use more approriate method name
 def to_internal_data(response: Response) -> dict | list | None:
     try:
@@ -33,7 +33,6 @@ def to_internal_data(response: Response) -> dict | list | None:
             raise
         raise ClientError(response_json if response_json is not None else {}) from exc
 
-    assert response_json
     return response_json
 
 
@@ -56,7 +55,9 @@ class Client(APIClient):
         return super().request(method, url, *args, **kwargs)
 
 
-def get_client(url: str) -> Client | None:
+def get_client(
+    url: str, raise_exceptions: bool = False, **client_kwargs
+) -> Client | None:
     """
     Get a client instance for the given URL.
     If no suitable client is found, ``None`` is returned.
@@ -64,10 +65,12 @@ def get_client(url: str) -> Client | None:
     from zgw_consumers.client import build_client
     from zgw_consumers.models import Service
 
-    service: Optional[Service] = Service.get_service(url)
+    service: Service | None = Service.get_service(url)
 
     if not service:
         logger.warning(f"No service configured for {url}")
-        return None
+        if raise_exceptions:
+            raise NoServiceConfigured(f"{url} API should be added to Service model")
+        return
 
-    return build_client(service, client_factory=Client)
+    return build_client(service, client_factory=Client, **client_kwargs)

vng_api_common/migrations/0006_delete_apicredential.py

@@ -107,6 +107,7 @@ class Migration(migrations.Migration):
 
     dependencies = [
         ("vng_api_common", "0005_auto_20190614_1346"),
+        ("zgw_consumers", "0022_set_default_service_slug"),
     ]
 
     operations = [

vng_api_common/views.py

@@ -174,7 +174,7 @@ def _test_ac_config() -> list:
     return checks
 
 
-def _test_nrc_config() -> list:
+def _test_nrc_config(check_autorisaties_subscription=True) -> list:
     if not apps.is_installed("notifications_api_common"):
         return []
 
@@ -183,6 +183,9 @@ def _test_nrc_config() -> list:
     nrc_config = NotificationsConfig.get_solo()
     nrc_client: Optional[Client] = NotificationsConfig.get_client()
 
+    if not nrc_client:
+        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:
@@ -209,14 +212,22 @@ def _test_nrc_config() -> list:
         try:
             response: requests.Response = nrc_client.get("kanaal")
             response.raise_for_status()
-        except requests.RequestException:
+        except requests.ConnectionError:
             error = True
             message = _("Could not connect with NRC")
+        except requests.HTTPError as exc:
+            error = True
+            message = _("Cannot retrieve kanalen: HTTP {status_code}").format(
+                status_code=exc.response.status_code
+            )
         else:
             message = _("Can retrieve kanalen")
 
         checks.append((_("NRC connection and authorizations"), message, not error))
 
+    if not check_autorisaties_subscription:
+        return checks
+
     #  check if there's a subscription for AC notifications
     has_sub = (
         Subscription.objects.filter(channels__contains=["autorisaties"])