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

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

@@ -2,6 +2,23 @@
 Change history
 ==============
 
+2.1.0 (2024-11-29)
+------------------
+
+* Update `notifications-api-common` to version `0.3.1`
+* [#44] include missing `Service` migration from `zgw-consumers`
+* Add `check_autorisaties_subscription` keyword argument to `_test_nrc_config`
+  which allows checking for subscriptions to be optional (defaults to `True`) for the
+  authorization service.
+* Modify `_test_nrc_config` check to skip extra checks if Notificaties API is not configured
+* Add `raise_exceptions` option to `get_client` util
+* Remove assertion in `to_internal_data` util to avoid errors in case of empty (204) responses
+
+2.0.1 (2024-11-22)
+------------------
+
+* move zgw-consumers-oas to ``testutils`` instead of ``tests``, to avoid pulling in irrelevant test deps in other projects
+
 2.0.0 (2024-11-22)
 ------------------
 
@@ -12,7 +29,7 @@ Change history
 
 .. warning::
 
-    If your project uses OAS test utilities, make sure to install them via ``commonground-api-common[tests]``
+    If your project uses OAS test utilities, make sure to install them via ``commonground-api-common[testutils]``
 
 .. warning::
 

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: commonground-api-common
-Version: 2.0.0
+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.0
+Requires-Dist: PyJWT>=2.1.0
 Requires-Dist: requests
 Requires-Dist: requests-mock
 Requires-Dist: coreapi
@@ -51,6 +51,8 @@ Requires-Dist: black; extra == "tests"
 Requires-Dist: requests-mock; extra == "tests"
 Requires-Dist: freezegun; extra == "tests"
 Requires-Dist: zgw-consumers-oas; extra == "tests"
+Provides-Extra: testutils
+Requires-Dist: zgw-consumers-oas; extra == "testutils"
 Provides-Extra: pep8
 Requires-Dist: flake8; extra == "pep8"
 Provides-Extra: coverage

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: commonground-api-common
-Version: 2.0.0
+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.0
+Requires-Dist: PyJWT>=2.1.0
 Requires-Dist: requests
 Requires-Dist: requests-mock
 Requires-Dist: coreapi
@@ -51,6 +51,8 @@ Requires-Dist: black; extra == "tests"
 Requires-Dist: requests-mock; extra == "tests"
 Requires-Dist: freezegun; extra == "tests"
 Requires-Dist: zgw-consumers-oas; extra == "tests"
+Provides-Extra: testutils
+Requires-Dist: zgw-consumers-oas; extra == "testutils"
 Provides-Extra: pep8
 Requires-Dist: flake8; extra == "pep8"
 Provides-Extra: coverage

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

@@ -8,10 +8,10 @@ drf-yasg>=1.20.0
 drf-nested-routers>=0.94.1
 iso-639
 isodate
-notifications-api-common>=0.3.0
+notifications-api-common>=0.3.1
 zgw-consumers>=0.35.1
 oyaml
-PyJWT>=2.0.0
+PyJWT>=2.1.0
 requests
 requests-mock
 coreapi
@@ -46,3 +46,6 @@ black
 requests-mock
 freezegun
 zgw-consumers-oas
+
+[testutils]
+zgw-consumers-oas

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

@@ -1,6 +1,6 @@
 [metadata]
 name = commonground-api-common
-version = 2.0.0
+version = 2.1.0
 description = Commonground API tooling
 long_description = file: README.rst
 url = https://github.com/maykinmedia/commonground-api-common
@@ -41,10 +41,10 @@ install_requires =
 	drf-nested-routers>=0.94.1
 	iso-639
 	isodate
-	notifications-api-common>=0.3.0
+	notifications-api-common>=0.3.1
 	zgw-consumers>=0.35.1
 	oyaml
-	PyJWT>=2.0.0
+	PyJWT>=2.1.0
 	requests
 	requests-mock
 	coreapi
@@ -79,6 +79,8 @@ tests =
 	requests-mock
 	freezegun
 	zgw-consumers-oas
+testutils = 
+	zgw-consumers-oas
 pep8 = flake8
 coverage = pytest-cov
 docs = 

{commonground_api_common-2.0.0 → commonground_api_common-2.1.0}/tests/test_views.py

@@ -1,10 +1,10 @@
 from django.template.response import TemplateResponse
 from django.urls import reverse
+from django.utils.translation import gettext as _
 
 import pytest
 import requests_mock
 from notifications_api_common.models import NotificationsConfig
-from requests import Response
 from rest_framework import status
 from zgw_consumers.test.factories import ServiceFactory
 
@@ -120,7 +120,10 @@ def test_config_view_notifications_error_response(api_client):
     response_content = response.content.decode("utf-8")
 
     assert response.status_code == status.HTTP_200_OK
-    assert "Could not connect with NRC" in response_content
+    assert (
+        _("Cannot retrieve kanalen: HTTP {status_code}").format(status_code=403)
+        in response_content
+    )
 
     assert request_mocker.call_count == 2
 

commonground_api_common-2.1.0/vng_api_common/__init__.py

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

{commonground_api_common-2.0.0 → commonground_api_common-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)

{commonground_api_common-2.0.0 → commonground_api_common-2.1.0}/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 = [

{commonground_api_common-2.0.0 → commonground_api_common-2.1.0}/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"])

commonground_api_common-2.0.0/vng_api_common/__init__.py

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