notifications-api-common 0.2.2__tar.gz → 0.3.1__tar.gz

{notifications-api-common-0.2.2 → notifications_api_common-0.3.1}/CHANGELOG.rst

@@ -2,6 +2,25 @@
 Changelog
 =========
 
+0.3.1 (2024-10-27)
+------------------
+
+* Fixed kanalen not being registered. This regression was introduced in `0.3.0`.
+
+0.3.0 (2024-10-24)
+------------------
+
+* Upgraded Django requirement  to >= 4.2
+* Upgraded minimum python requirement to >= 3.10
+* Added python 3.12 support
+* Added the `NOTIFICATIONS_GUARANTEE_DELIVERY` environment variable which allows
+  `RuntimeError`s to be raised (or not to) whenever no Notifications API is
+  configured. The default for this setting is set to `True`.
+* Upgraded zgw-consumers to 0.35.1
+  * This removed support for retrieving external OAS files to determine
+  * This requires `zgw_consumers.models.Service` ("service") instances to be
+    created to do external API calls through `zgw_consumer`
+
 0.2.2 (2023-04-20)
 ------------------
 

{notifications-api-common-0.2.2/notifications_api_common.egg-info → notifications_api_common-0.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: notifications-api-common
-Version: 0.2.2
+Version: 0.3.1
 Summary: Re-usable integration layer for the Common Ground Notifications API specification.
 Home-page: https://github.com/maykinmedia/notifications-api-common
 Author: Maykin Media
@@ -12,32 +12,53 @@ Project-URL: Source Code, https://github.com/maykinmedia/notifications-api-commo
 Keywords: notifications,REST,API,Common Ground,ZGW
 Classifier: Development Status :: 4 - Beta
 Classifier: Framework :: Django
-Classifier: Framework :: Django :: 3.2
-Classifier: Framework :: Django :: 4.0
+Classifier: Framework :: Django :: 4.2
 Classifier: Intended Audience :: Developers
 Classifier: Operating System :: Unix
 Classifier: Operating System :: MacOS
 Classifier: Operating System :: Microsoft :: Windows
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
+License-File: LICENSE
+Requires-Dist: django>=4.2.0
+Requires-Dist: django-solo
+Requires-Dist: djangorestframework>=3.12.0
+Requires-Dist: celery
+Requires-Dist: djangorestframework_camel_case>=1.2.0
+Requires-Dist: zgw-consumers>=0.35.1
+Requires-Dist: ape-pie
 Provides-Extra: db
+Requires-Dist: psycopg2; extra == "db"
 Provides-Extra: tests
+Requires-Dist: psycopg2; extra == "tests"
+Requires-Dist: pytest; extra == "tests"
+Requires-Dist: pytest-django; extra == "tests"
+Requires-Dist: freezegun; extra == "tests"
+Requires-Dist: tox; extra == "tests"
+Requires-Dist: isort; extra == "tests"
+Requires-Dist: black; extra == "tests"
+Requires-Dist: flake8; extra == "tests"
+Requires-Dist: zgw-consumers[testutils]>=0.35.1; extra == "tests"
 Provides-Extra: pep8
+Requires-Dist: flake8; extra == "pep8"
 Provides-Extra: coverage
+Requires-Dist: pytest-cov; extra == "coverage"
 Provides-Extra: docs
+Requires-Dist: sphinx; extra == "docs"
+Requires-Dist: sphinx-rtd-theme; extra == "docs"
 Provides-Extra: release
-License-File: LICENSE
+Requires-Dist: bumpversion; extra == "release"
+Requires-Dist: twine; extra == "release"
 
 notifications-api-common
 ========================
 
-:Version: 0.2.2
+:Version: 0.3.1
 :Source: https://github.com/maykinmedia/notifications-api-common
 :Keywords: notifications, REST, API, Common Ground, ZGW
-:PythonVersion: 3.9
+:PythonVersion: 3.10
 
 |build-status| |code-quality| |black| |coverage| |docs|
 
@@ -62,9 +83,10 @@ Installation
 Requirements
 ------------
 
-* Python 3.7 or above
+* Python 3.10 or above
 * setuptools 30.3.0 or above
-* Django 3.2 or newer
+* Django 4.2 or newer
+* Celery 5.0 or newer setup with one worker deployed
 
 
 Install

{notifications-api-common-0.2.2 → notifications_api_common-0.3.1}/README.rst

@@ -1,10 +1,10 @@
 notifications-api-common
 ========================
 
-:Version: 0.2.2
+:Version: 0.3.1
 :Source: https://github.com/maykinmedia/notifications-api-common
 :Keywords: notifications, REST, API, Common Ground, ZGW
-:PythonVersion: 3.9
+:PythonVersion: 3.10
 
 |build-status| |code-quality| |black| |coverage| |docs|
 
@@ -29,9 +29,10 @@ Installation
 Requirements
 ------------
 
-* Python 3.7 or above
+* Python 3.10 or above
 * setuptools 30.3.0 or above
-* Django 3.2 or newer
+* Django 4.2 or newer
+* Celery 5.0 or newer setup with one worker deployed
 
 
 Install

{notifications-api-common-0.2.2 → notifications_api_common-0.3.1}/notifications_api_common/admin.py

@@ -3,7 +3,6 @@ from django.utils.translation import gettext_lazy as _
 
 from requests.exceptions import RequestException
 from solo.admin import SingletonModelAdmin
-from zds_client.client import ClientError
 
 from .models import NotificationsConfig, Subscription
 
@@ -20,7 +19,7 @@ def register_webhook(modeladmin, request, queryset):
 
         try:
             sub.register()
-        except (ClientError, RequestException) as e:
+        except RequestException as e:
             messages.error(
                 request,
                 _(

{notifications-api-common-0.2.2 → notifications_api_common-0.3.1}/notifications_api_common/kanalen.py

@@ -1,6 +1,7 @@
 """
 Provide notifications kanaal/exchange classes.
 """
+
 from collections import defaultdict
 from typing import Dict, Tuple
 

{notifications-api-common-0.2.2 → notifications_api_common-0.3.1}/notifications_api_common/locale/en/LC_MESSAGES/django.po

@@ -6,7 +6,7 @@
 #, fuzzy
 msgid ""
 msgstr ""
-"Project-Id-Version: 0.2.2\n"
+"Project-Id-Version: 0.3.1\n"
 "Report-Msgid-Bugs-To: \n"
 "POT-Creation-Date: 2022-12-14 13:45+0100\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"

{notifications-api-common-0.2.2 → notifications_api_common-0.3.1}/notifications_api_common/locale/nl/LC_MESSAGES/django.po

@@ -6,7 +6,7 @@
 #, fuzzy
 msgid ""
 msgstr ""
-"Project-Id-Version: 0.2.2\n"
+"Project-Id-Version: 0.3.1\n"
 "Report-Msgid-Bugs-To: \n"
 "POT-Creation-Date: 2022-12-14 13:45+0100\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"

notifications_api_common-0.3.1/notifications_api_common/management/commands/register_kanalen.py

@@ -0,0 +1,137 @@
+import logging
+from typing import Optional
+
+from django.contrib.sites.models import Site
+from django.core.management.base import BaseCommand
+from django.urls import reverse
+
+from requests import Response
+from requests.exceptions import JSONDecodeError, RequestException
+from zgw_consumers.models import Service
+
+from ...kanalen import KANAAL_REGISTRY
+from ...models import NotificationsConfig
+from ...settings import get_setting
+
+logger = logging.getLogger(__name__)
+
+
+class KanaalException(Exception):
+    kanaal: str
+    data: dict | list
+    service: Service
+
+    def __init__(
+        self, kanaal: str, service: Service, data: Optional[dict | list] = None
+    ):
+        super().__init__()
+
+        self.kanaal = kanaal
+        self.service = service
+        self.data = data or {}
+
+
+class KanaalRequestException(KanaalException):
+    def __str__(self) -> str:
+        return (
+            f"Unable to retrieve kanaal {self.kanaal} from {self.service}: {self.data}"
+        )
+
+
+class KanaalCreateException(KanaalException):
+    def __str__(self) -> str:
+        return f"Unable to create kanaal {self.kanaal} at {self.service}: {self.data}"
+
+
+class KanaalExistsException(KanaalException):
+    def __str__(self) -> str:
+        return f"Kanaal '{self.kanaal}' already exists within {self.service}"
+
+
+def create_kanaal(kanaal: str, service: Service) -> None:
+    """
+    Create a kanaal, if it doesn't exist yet.
+    """
+    client = NotificationsConfig.get_client()
+
+    assert client
+
+    # look up the exchange in the registry
+    _kanaal = next(k for k in KANAAL_REGISTRY if k.label == kanaal)
+
+    response_data = []
+
+    try:
+        response: Response = client.get("kanaal", params={"naam": kanaal})
+        kanalen: list[dict] = response.json() or []
+        response.raise_for_status()
+    except (RequestException, JSONDecodeError) as exception:
+        raise KanaalRequestException(
+            kanaal=kanaal, service=service, data=response_data
+        ) from exception
+
+    if kanalen:
+        raise KanaalExistsException(kanaal=kanaal, service=service, data=response_data)
+
+    # build up own documentation URL
+    domain = Site.objects.get_current().domain
+    protocol = "https" if get_setting("IS_HTTPS") else "http"
+    documentation_url = (
+        f"{protocol}://{domain}{reverse('notifications:kanalen')}#{kanaal}"
+    )
+
+    try:
+        response: Response = client.post(
+            "kanaal",
+            json={
+                "naam": kanaal,
+                "documentatieLink": documentation_url,
+                "filters": list(_kanaal.kenmerken),
+            },
+        )
+
+        response_data: dict = response.json() or {}
+        response.raise_for_status()
+    except (RequestException, JSONDecodeError) as exception:
+        raise KanaalCreateException(
+            kanaal=kanaal, service=service, data=response_data
+        ) from exception
+
+
+class Command(BaseCommand):
+    help = "Create kanaal in notification component"
+
+    def add_arguments(self, parser):
+        parser.add_argument(
+            "--kanalen",
+            nargs="*",
+            type=str,
+            help=(
+                "Names of the kanalen (will use the `KANAAL_REGISTRY` if not specified)"
+            ),
+        )
+
+    def handle(self, **options):
+        config = NotificationsConfig.get_solo()
+
+        if not config.notifications_api_service:
+            self.stderr.write(
+                "NotificationsConfig does not have a "
+                "`notifications_api_service` configured"
+            )
+
+        service = config.notifications_api_service
+
+        # use CLI arg or fall back to setting
+        kanalen = options["kanalen"] or sorted(
+            [kanaal.label for kanaal in KANAAL_REGISTRY]
+        )
+
+        for kanaal in kanalen:
+            try:
+                create_kanaal(kanaal, service)
+                self.stdout.write(
+                    f"Registered kanaal '{kanaal}' with {service.api_root}"
+                )
+            except (KanaalException,) as exception:
+                self.stderr.write(f"{str(exception)} . Skipping..")

{notifications-api-common-0.2.2 → notifications_api_common-0.3.1}/notifications_api_common/models.py

@@ -4,8 +4,9 @@ from django.contrib.postgres.fields import ArrayField
 from django.db import models
 from django.utils.translation import gettext_lazy as _
 
+from ape_pie.client import APIClient
 from solo.models import SingletonModel
-from zds_client import Client, ClientAuth
+from zgw_consumers.client import ZGWAuth, build_client
 from zgw_consumers.constants import APITypes
 from zgw_consumers.models import Service
 
@@ -56,13 +57,15 @@ class NotificationsConfig(SingletonModel):
         )
 
     @classmethod
-    def get_client(cls) -> Optional[Client]:
+    def get_client(cls) -> Optional[APIClient]:
         """
         Construct a client, prepared with the required auth.
         """
         config = cls.get_solo()
         if config.notifications_api_service:
-            return config.notifications_api_service.build_client()
+            return build_client(
+                config.notifications_api_service, client_factory=APIClient
+            )
         return None
 
 
@@ -110,23 +113,20 @@ class Subscription(models.Model):
         """
         Registers the webhook with the notification component.
         """
-        assert (
-            NotificationsConfig.get_solo().notifications_api_service
-        ), "No service for Notifications API configured"
+        service = NotificationsConfig.get_solo().notifications_api_service
+        assert service, "No service for Notifications API configured"
 
         client = NotificationsConfig.get_client()
+        assert client
 
         # This authentication is for the NC to call us. Thus, it's *not* for
         # calling the NC to create a subscription.
         # TODO should be replaced with `TokenAuth`
         # see: maykinmedia/notifications-api-common/pull/1#discussion_r941450384
-        self_auth = ClientAuth(
-            client_id=self.client_id,
-            secret=self.secret,
-        )
+        self_auth = ZGWAuth(service)
         data = {
             "callbackUrl": self.callback_url,
-            "auth": self_auth.credentials()["Authorization"],
+            "auth": f"Bearer {self_auth._token}",
             "kanalen": [
                 {
                     "naam": channel,
@@ -138,7 +138,7 @@ class Subscription(models.Model):
         }
 
         # register the subscriber
-        subscriber = client.create("abonnement", data=data)
+        subscriber = client.post("abonnement", json=data).json()
 
         self._subscription = subscriber["url"]
         self.save(update_fields=["_subscription"])

{notifications-api-common-0.2.2 → notifications_api_common-0.3.1}/notifications_api_common/settings.py

@@ -7,6 +7,8 @@ NOTIFICATIONS_DISABLED = False
 
 IS_HTTPS = True
 
+NOTIFICATIONS_GUARANTEE_DELIVERY = True
+
 
 def get_setting(name: str) -> Any:
     this_module = sys.modules[__name__]

{notifications-api-common-0.2.2 → notifications_api_common-0.3.1}/notifications_api_common/tasks.py

@@ -2,7 +2,6 @@ import logging
 
 import requests
 from celery import shared_task
-from zds_client import ClientError
 
 from .autoretry import add_autoretry_behaviour
 from .models import NotificationsConfig
@@ -27,13 +26,14 @@ def send_notification(self, message: dict) -> None:
         return
 
     try:
-        client.create("notificaties", message)
+        response = client.post("notificaties", json=message)
+        response.raise_for_status()
     # any unexpected errors should show up in error-monitoring, so we only
-    # catch ClientError exceptions
-    except (ClientError, requests.HTTPError) as exc:
+    # catch HTTPError exceptions
+    except requests.HTTPError as exc:
         logger.warning(
             "Could not deliver message to %s",
-            client.api_root,
+            client.base_url,
             exc_info=exc,
             extra={
                 "notification_msg": message,

{notifications-api-common-0.2.2 → notifications_api_common-0.3.1}/notifications_api_common/viewsets.py

@@ -161,11 +161,16 @@ class NotificationMixin(metaclass=NotificationMixinBase):
         # build the content of the notification
         message = self.construct_message(data, instance=instance)
 
-        # build the client from the singleton config. This will raise an
-        # exception if the config is not complete. We want this to hard-fail!
+        # build the client from the singleton config.
+        # This will raise an exception if the config is not complete unless
+        # NOTIFICATIONS_GUARANTEE_DELIVERY is explicitly set to False
         client = NotificationsConfig.get_client()
         if client is None:
-            raise RuntimeError("Could not build a client for Notifications API")
+            msg = "Not notifying, Notifications API configuration is broken or absent."
+            logger.warning(msg)
+            if get_setting("NOTIFICATIONS_GUARANTEE_DELIVERY"):
+                raise RuntimeError(msg)
+            return
 
         # We've performed all the work that can raise uncaught exceptions that we can
         # still put inside an atomic transaction block. Next, we schedule the actual

{notifications-api-common-0.2.2 → notifications_api_common-0.3.1/notifications_api_common.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: notifications-api-common
-Version: 0.2.2
+Version: 0.3.1
 Summary: Re-usable integration layer for the Common Ground Notifications API specification.
 Home-page: https://github.com/maykinmedia/notifications-api-common
 Author: Maykin Media
@@ -12,32 +12,53 @@ Project-URL: Source Code, https://github.com/maykinmedia/notifications-api-commo
 Keywords: notifications,REST,API,Common Ground,ZGW
 Classifier: Development Status :: 4 - Beta
 Classifier: Framework :: Django
-Classifier: Framework :: Django :: 3.2
-Classifier: Framework :: Django :: 4.0
+Classifier: Framework :: Django :: 4.2
 Classifier: Intended Audience :: Developers
 Classifier: Operating System :: Unix
 Classifier: Operating System :: MacOS
 Classifier: Operating System :: Microsoft :: Windows
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
+License-File: LICENSE
+Requires-Dist: django>=4.2.0
+Requires-Dist: django-solo
+Requires-Dist: djangorestframework>=3.12.0
+Requires-Dist: celery
+Requires-Dist: djangorestframework_camel_case>=1.2.0
+Requires-Dist: zgw-consumers>=0.35.1
+Requires-Dist: ape-pie
 Provides-Extra: db
+Requires-Dist: psycopg2; extra == "db"
 Provides-Extra: tests
+Requires-Dist: psycopg2; extra == "tests"
+Requires-Dist: pytest; extra == "tests"
+Requires-Dist: pytest-django; extra == "tests"
+Requires-Dist: freezegun; extra == "tests"
+Requires-Dist: tox; extra == "tests"
+Requires-Dist: isort; extra == "tests"
+Requires-Dist: black; extra == "tests"
+Requires-Dist: flake8; extra == "tests"
+Requires-Dist: zgw-consumers[testutils]>=0.35.1; extra == "tests"
 Provides-Extra: pep8
+Requires-Dist: flake8; extra == "pep8"
 Provides-Extra: coverage
+Requires-Dist: pytest-cov; extra == "coverage"
 Provides-Extra: docs
+Requires-Dist: sphinx; extra == "docs"
+Requires-Dist: sphinx-rtd-theme; extra == "docs"
 Provides-Extra: release
-License-File: LICENSE
+Requires-Dist: bumpversion; extra == "release"
+Requires-Dist: twine; extra == "release"
 
 notifications-api-common
 ========================
 
-:Version: 0.2.2
+:Version: 0.3.1
 :Source: https://github.com/maykinmedia/notifications-api-common
 :Keywords: notifications, REST, API, Common Ground, ZGW
-:PythonVersion: 3.9
+:PythonVersion: 3.10
 
 |build-status| |code-quality| |black| |coverage| |docs|
 
@@ -62,9 +83,10 @@ Installation
 Requirements
 ------------
 
-* Python 3.7 or above
+* Python 3.10 or above
 * setuptools 30.3.0 or above
-* Django 3.2 or newer
+* Django 4.2 or newer
+* Celery 5.0 or newer setup with one worker deployed
 
 
 Install

{notifications-api-common-0.2.2 → notifications_api_common-0.3.1}/notifications_api_common.egg-info/SOURCES.txt

@@ -50,5 +50,6 @@ notifications_api_common/templates/notifications_api_common/kanalen.html
 notifications_api_common/tests/__init__.py
 notifications_api_common/tests/utils.py
 tests/test_kanaal_documentation.py
+tests/test_register_kanalen.py
 tests/test_register_webhook.py
 tests/test_send_message.py

{notifications-api-common-0.2.2 → notifications_api_common-0.3.1}/notifications_api_common.egg-info/requires.txt

@@ -1,10 +1,10 @@
-django>=3.2.0
+django>=4.2.0
 django-solo
 djangorestframework>=3.12.0
 celery
 djangorestframework_camel_case>=1.2.0
-gemma-zds-client>=0.15.0
-zgw-consumers
+zgw-consumers>=0.35.1
+ape-pie
 
 [coverage]
 pytest-cov
@@ -32,3 +32,4 @@ tox
 isort
 black
 flake8
+zgw-consumers[testutils]>=0.35.1

{notifications-api-common-0.2.2 → notifications_api_common-0.3.1}/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = notifications-api-common
-version = 0.2.2
+version = 0.3.1
 description = Re-usable integration layer for the Common Ground Notifications API specification.
 long_description = file: README.rst
 url = https://github.com/maykinmedia/notifications-api-common
@@ -15,16 +15,14 @@ keywords = notifications, REST, API, Common Ground, ZGW
 classifiers = 
 	Development Status :: 4 - Beta
 	Framework :: Django
-	Framework :: Django :: 3.2
-	Framework :: Django :: 4.0
+	Framework :: Django :: 4.2
 	Intended Audience :: Developers
 	Operating System :: Unix
 	Operating System :: MacOS
 	Operating System :: Microsoft :: Windows
-	Programming Language :: Python :: 3.7
-	Programming Language :: Python :: 3.8
-	Programming Language :: Python :: 3.9
 	Programming Language :: Python :: 3.10
+	Programming Language :: Python :: 3.11
+	Programming Language :: Python :: 3.12
 	Topic :: Software Development :: Libraries :: Python Modules
 
 [options]
@@ -32,13 +30,13 @@ zip_safe = False
 include_package_data = True
 packages = find:
 install_requires = 
-	django>=3.2.0
+	django>=4.2.0
 	django-solo
 	djangorestframework>=3.12.0
 	celery
 	djangorestframework_camel_case>=1.2.0
-	gemma-zds-client>=0.15.0
-	zgw-consumers
+	zgw-consumers>=0.35.1
+	ape-pie
 tests_require = 
 	psycopg2
 	pytest
@@ -48,6 +46,7 @@ tests_require =
 	isort
 	black
 	flake8
+	zgw-consumers[testutils]>=0.35.1
 
 [options.packages.find]
 include = 
@@ -66,6 +65,7 @@ tests =
 	isort
 	black
 	flake8
+	zgw-consumers[testutils]>=0.35.1
 pep8 = flake8
 coverage = pytest-cov
 docs = 

notifications_api_common-0.3.1/tests/test_register_kanalen.py

@@ -0,0 +1,191 @@
+from io import StringIO
+from unittest.mock import Mock, patch
+from urllib.parse import urlencode
+
+from django.test.testcases import call_command
+
+import pytest
+
+from notifications_api_common.kanalen import KANAAL_REGISTRY, Kanaal
+
+kanalen = set(
+    (
+        Kanaal(label="foobar", main_resource=Mock()),
+        Kanaal(label="boofar", main_resource=Mock()),
+    )
+)
+
+KANAAL_REGISTRY.clear()
+KANAAL_REGISTRY.update(kanalen)
+
+
+@pytest.mark.django_db
+def test_register_kanalen_success(notifications_config, requests_mock):
+    kanaal_url = f"{notifications_config.notifications_api_service.api_root}kanaal"
+    params = urlencode(dict(naam="foobar"))
+
+    requests_mock.get(f"{kanaal_url}?{params}", json=[])
+
+    requests_mock.post(
+        kanaal_url,
+        json={
+            "url": "http://example.com",
+            "naam": "string",
+            "documentatieLink": "http://example.com",
+            "filters": ["string"],
+        },
+        status_code=201,
+    )
+
+    reverse_patch = (
+        "notifications_api_common.management.commands.register_kanalen.reverse"
+    )
+
+    with patch(reverse_patch) as mocked_reverse:
+        mocked_reverse.return_value = "/notifications/kanalen"
+
+        call_command("register_kanalen", kanalen=["foobar"])
+
+    assert len(requests_mock.request_history) == 2
+
+    get_request = requests_mock.request_history[0]
+
+    assert get_request._request.url == f"{kanaal_url}?{params}"
+
+    post_request = requests_mock.request_history[1]
+
+    assert post_request._request.url == kanaal_url
+
+
+@pytest.mark.django_db
+def test_register_kanalen_from_registry_success(notifications_config, requests_mock):
+    kanaal_url = f"{notifications_config.notifications_api_service.api_root}kanaal"
+
+    url_mapping = {
+        kanaal.label: f"{kanaal_url}?{urlencode(dict(naam=kanaal.label))}"
+        for kanaal in kanalen
+    }
+
+    for kanaal in kanalen:
+        requests_mock.get(url_mapping[kanaal.label], json=[])
+
+        requests_mock.post(
+            kanaal_url,
+            json={
+                "url": "http://example.com",
+                "naam": kanaal.label,
+                "documentatieLink": "http://example.com",
+                "filters": ["string"],
+            },
+            status_code=201,
+        )
+
+    reverse_patch = (
+        "notifications_api_common.management.commands.register_kanalen.reverse"
+    )
+
+    with patch(reverse_patch) as mocked_reverse:
+        mocked_reverse.return_value = "/notifications/kanalen"
+
+        call_command("register_kanalen")
+
+    assert len(requests_mock.request_history) == 4
+
+    # kanalen are sorted by label
+    first_get_request = requests_mock.request_history[0]
+    assert first_get_request._request.url == url_mapping["boofar"]
+
+    first_post_request = requests_mock.request_history[1]
+    assert first_post_request._request.url == kanaal_url
+
+    second_get_request = requests_mock.request_history[2]
+    assert second_get_request._request.url == url_mapping["foobar"]
+
+    second_post_request = requests_mock.request_history[3]
+    assert second_post_request._request.url == kanaal_url
+
+
+@pytest.mark.django_db
+def test_register_kanalen_existing_kanalen(notifications_config, requests_mock):
+    """
+    Test that already registered kanalen does not cause issues
+    """
+    kanaal_url = f"{notifications_config.notifications_api_service.api_root}kanaal"
+    params = urlencode(dict(naam="foobar"))
+
+    requests_mock.get(
+        f"{kanaal_url}?{params}",
+        json=[
+            {
+                "url": "http://example.com",
+                "naam": "foobar",
+                "documentatieLink": "http://example.com",
+                "filters": ["string"],
+            }
+        ],
+    )
+
+    call_command("register_kanalen", kanalen=["foobar"])
+
+    assert len(requests_mock.request_history) == 1
+
+    request = requests_mock.request_history[0]
+
+    assert request._request.url == f"{kanaal_url}?{params}"
+
+
+@pytest.mark.django_db
+def test_register_kanalen_unknown_url(notifications_config, requests_mock):
+    kanaal_url = f"{notifications_config.notifications_api_service.api_root}kanaal"
+    params = urlencode(dict(naam="foobar"))
+
+    requests_mock.get(f"{kanaal_url}?{params}", status_code=404)
+
+    stderr = StringIO()
+
+    call_command("register_kanalen", kanalen=["foobar"], stderr=stderr)
+
+    partial_failure_message = "Unable to retrieve kanaal foobar"
+
+    assert partial_failure_message in stderr.getvalue()
+
+    assert len(requests_mock.request_history) == 1
+
+    request = requests_mock.request_history[0]
+
+    assert request._request.url == f"{kanaal_url}?{params}"
+
+
+@pytest.mark.django_db
+def test_register_kanalen_incorrect_post(notifications_config, requests_mock):
+    kanaal_url = f"{notifications_config.notifications_api_service.api_root}kanaal"
+    params = urlencode(dict(naam="foobar"))
+
+    requests_mock.get(f"{kanaal_url}?{params}", json=[])
+
+    requests_mock.post(kanaal_url, json={"error": "foo"}, status_code=400)
+
+    stderr = StringIO()
+
+    reverse_patch = (
+        "notifications_api_common.management.commands.register_kanalen.reverse"
+    )
+
+    with patch(reverse_patch) as mocked_reverse:
+        mocked_reverse.return_value = "/notifications/kanalen"
+
+        call_command("register_kanalen", kanalen=["foobar"], stderr=stderr)
+
+    partial_failure_message = "Unable to create kanaal foobar"
+
+    assert partial_failure_message in stderr.getvalue()
+
+    assert len(requests_mock.request_history) == 2
+
+    get_request = requests_mock.request_history[0]
+
+    assert get_request._request.url == f"{kanaal_url}?{params}"
+
+    post_request = requests_mock.request_history[1]
+
+    assert post_request._request.url == kanaal_url

{notifications-api-common-0.2.2 → notifications_api_common-0.3.1}/tests/test_register_webhook.py

@@ -4,16 +4,23 @@ from django.contrib.messages import get_messages
 from django.utils.translation import gettext as _
 
 import pytest
-from requests.exceptions import RequestException
-from zds_client.client import ClientError
+from requests.exceptions import HTTPError, RequestException
 
 from notifications_api_common.admin import register_webhook
 from notifications_api_common.models import Subscription
 
 
+class MockResponse:
+    def __init__(self, data):
+        self.data = data
+
+    def json(self):
+        return self.data
+
+
 @patch(
-    "zds_client.client.Client.create",
-    return_value={"url": "https://example.com/api/v1/abonnementen/1"},
+    "ape_pie.APIClient.post",
+    return_value=MockResponse({"url": "https://example.com/api/v1/abonnementen/1"}),
 )
 @pytest.mark.django_db
 def test_register_webhook_success(
@@ -47,9 +54,7 @@ def test_register_webhook_request_exception(
         channels=["zaken"],
     )
 
-    with patch(
-        "zds_client.client.Client.create", side_effect=RequestException("exception")
-    ):
+    with patch("ape_pie.APIClient.post", side_effect=RequestException("exception")):
         register_webhook(object, request_with_middleware, Subscription.objects.all())
 
     messages = list(get_messages(request_with_middleware))
@@ -61,7 +66,7 @@ def test_register_webhook_request_exception(
 
 
 @pytest.mark.django_db
-def test_register_webhook_client_error(request_with_middleware, notifications_config):
+def test_register_webhook_http_error(request_with_middleware, notifications_config):
     Subscription.objects.create(
         callback_url="https://example.com/callback",
         client_id="client_id",
@@ -69,7 +74,7 @@ def test_register_webhook_client_error(request_with_middleware, notifications_co
         channels=["zaken"],
     )
 
-    with patch("zds_client.client.Client.create", side_effect=ClientError("exception")):
+    with patch("ape_pie.APIClient.post", side_effect=HTTPError("400")):
         register_webhook(object, request_with_middleware, Subscription.objects.all())
 
     messages = list(get_messages(request_with_middleware))
@@ -77,4 +82,4 @@ def test_register_webhook_client_error(request_with_middleware, notifications_co
     assert len(messages) == 1
     assert messages[0].message == _(
         "Something went wrong while registering subscription for {callback_url}: {e}"
-    ).format(callback_url="https://example.com/callback", e="exception")
+    ).format(callback_url="https://example.com/callback", e="400")

{notifications-api-common-0.2.2 → notifications_api_common-0.3.1}/tests/test_send_message.py

@@ -1,12 +1,12 @@
 from pathlib import Path
 from unittest.mock import patch
 
+from django.test import override_settings
 from django.urls import reverse
 
 import pytest
 from celery.exceptions import Retry
 from freezegun import freeze_time
-from zgw_consumers.test import mock_service_oas_get
 
 from notifications_api_common.tasks import NotificationException, send_notification
 from testapp.models import Person
@@ -50,9 +50,6 @@ def test_api_create_person(api_client, notifications_config):
 @pytest.mark.django_db()
 def test_task_send_notification_success(notifications_config, requests_mock, settings):
     msg = {"foo": "bar"}
-    # add mocks
-    settings.ZGW_CONSUMERS_TEST_SCHEMA_DIRS = [TESTS_DIR / "schemas"]
-    mock_service_oas_get(requests_mock, NOTIFICATIONS_API_ROOT, "nrc")
     requests_mock.post(f"{NOTIFICATIONS_API_ROOT}notificaties", status_code=201)
 
     send_notification(msg)
@@ -68,10 +65,6 @@ def test_task_send_notification_with_retry(
     notifications_config, requests_mock, settings
 ):
     msg = {"foo": "bar"}
-
-    # add NRC mocks
-    settings.ZGW_CONSUMERS_TEST_SCHEMA_DIRS = [TESTS_DIR / "schemas"]
-    mock_service_oas_get(requests_mock, NOTIFICATIONS_API_ROOT, "nrc")
     exc = NotificationException()
     requests_mock.post(f"{NOTIFICATIONS_API_ROOT}notificaties", exc=exc)
 
@@ -93,8 +86,6 @@ def test_task_send_notification_catch_404(
     which can be handled by the lib users
     """
     # add NRC mocks
-    settings.ZGW_CONSUMERS_TEST_SCHEMA_DIRS = [TESTS_DIR / "schemas"]
-    mock_service_oas_get(requests_mock, NOTIFICATIONS_API_ROOT, "nrc")
     requests_mock.post(f"{NOTIFICATIONS_API_ROOT}notificaties", status_code=404)
 
     with pytest.raises(NotificationException):
@@ -110,9 +101,36 @@ def test_task_send_notification_catch_500(
     which can be handled by the lib users
     """
     # add NRC mocks
-    settings.ZGW_CONSUMERS_TEST_SCHEMA_DIRS = [TESTS_DIR / "schemas"]
-    mock_service_oas_get(requests_mock, NOTIFICATIONS_API_ROOT, "nrc")
     requests_mock.post(f"{NOTIFICATIONS_API_ROOT}notificaties", status_code=500)
 
     with pytest.raises(NotificationException):
         send_notification({"foo": "bar"})
+
+
+@freeze_time("2022-01-01")
+@pytest.mark.django_db(transaction=True)
+def test_api_create_person_unconfigured(api_client, notifications_config):
+    """Test the default behavior of NOTIFICATIONS_GUARANTEE_DELIVERY=True"""
+    notifications_config.delete()
+    url = reverse("person-list")
+    data = {"name": "John", "address_street": "Grotestraat", "address_number": "1"}
+
+    with pytest.raises(RuntimeError):
+        response = api_client.post(url, data)
+
+    assert Person.objects.count() == 0
+
+
+@freeze_time("2022-01-01")
+@pytest.mark.django_db(transaction=True)
+@override_settings(NOTIFICATIONS_GUARANTEE_DELIVERY=False)
+def test_api_create_person_unconfigured_notifications_guarantee_delivery_false(
+    api_client, notifications_config
+):
+    notifications_config.delete()
+    url = reverse("person-list")
+    data = {"name": "John", "address_street": "Grotestraat", "address_number": "1"}
+
+    response = api_client.post(url, data)
+
+    assert Person.objects.count() == 1

notifications-api-common-0.2.2/notifications_api_common/management/commands/register_kanalen.py

@@ -1,82 +0,0 @@
-import logging
-
-from django.contrib.sites.models import Site
-from django.core.management.base import BaseCommand
-from django.urls import reverse
-
-from ...kanalen import KANAAL_REGISTRY
-from ...models import NotificationsConfig
-from ...settings import get_setting
-
-logger = logging.getLogger(__name__)
-
-
-class KanaalExists(Exception):
-    pass
-
-
-def create_kanaal(kanaal: str) -> None:
-    """
-    Create a kanaal, if it doesn't exist yet.
-    """
-    client = NotificationsConfig.get_client()
-
-    # look up the exchange in the registry
-    _kanaal = next(k for k in KANAAL_REGISTRY if k.label == kanaal)
-
-    kanalen = client.list("kanaal", query_params={"naam": kanaal})
-    if kanalen:
-        raise KanaalExists()
-
-    # build up own documentation URL
-    domain = Site.objects.get_current().domain
-    protocol = "https" if get_setting("IS_HTTPS") else "http"
-    documentation_url = (
-        f"{protocol}://{domain}{reverse('notifications:kanalen')}#{kanaal}"
-    )
-
-    client.create(
-        "kanaal",
-        {
-            "naam": kanaal,
-            "documentatieLink": documentation_url,
-            "filters": list(_kanaal.kenmerken),
-        },
-    )
-
-
-class Command(BaseCommand):
-    help = "Create kanaal in notification component"
-
-    def add_arguments(self, parser):
-        parser.add_argument(
-            "--kanalen",
-            nargs="*",
-            type=str,
-            help=(
-                "Names of the kanalen (will use the `KANAAL_REGISTRY` if not specified)"
-            ),
-        )
-
-    def handle(self, **options):
-        config = NotificationsConfig.get_solo()
-
-        if not config.notifications_api_service:
-            self.stderr.write(
-                "NotificationsConfig does not have a "
-                "`notifications_api_service` configured"
-            )
-
-        api_root = config.notifications_api_service.api_root
-
-        # use CLI arg or fall back to setting
-        kanalen = options["kanalen"] or sorted(
-            [kanaal.label for kanaal in KANAAL_REGISTRY]
-        )
-
-        for kanaal in kanalen:
-            try:
-                create_kanaal(kanaal)
-                self.stdout.write(f"Registered kanaal '{kanaal}' with {api_root}")
-            except KanaalExists:
-                self.stderr.write(f"Kanaal '{kanaal}' already exists within {api_root}")