notifications-api-common 0.7.0__tar.gz → 0.7.2__tar.gz

{notifications_api_common-0.7.0 → notifications_api_common-0.7.2}/CHANGELOG.rst

@@ -2,6 +2,16 @@
 Changelog
 =========
 
+0.7.2 (2025-03-28)
+------------------
+
+* Add get_domain() for ``register_kanalen``
+
+0.7.1 (2025-03-20)
+------------------
+
+* Fix quickstart.rst and add ``example.com`` as default value for SITE_DOMAIN
+
 0.7.0 (2025-03-18)
 ------------------
 

{notifications_api_common-0.7.0/notifications_api_common.egg-info → notifications_api_common-0.7.2}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: notifications-api-common
-Version: 0.7.0
+Version: 0.7.2
 Summary: Re-usable integration layer for the Common Ground Notifications API specification.
 Home-page: https://github.com/maykinmedia/notifications-api-common
 Author: Maykin Media
@@ -54,11 +54,12 @@ Requires-Dist: sphinx-rtd-theme; extra == "docs"
 Provides-Extra: release
 Requires-Dist: bumpversion; extra == "release"
 Requires-Dist: twine; extra == "release"
+Dynamic: license-file
 
 notifications-api-common
 ========================
 
-:Version: 0.7.0
+:Version: 0.7.2
 :Source: https://github.com/maykinmedia/notifications-api-common
 :Keywords: notifications, REST, API, Common Ground, ZGW
 :PythonVersion: 3.10

{notifications_api_common-0.7.0 → notifications_api_common-0.7.2}/README.rst

@@ -1,7 +1,7 @@
 notifications-api-common
 ========================
 
-:Version: 0.7.0
+:Version: 0.7.2
 :Source: https://github.com/maykinmedia/notifications-api-common
 :Keywords: notifications, REST, API, Common Ground, ZGW
 :PythonVersion: 3.10

{notifications_api_common-0.7.0 → notifications_api_common-0.7.2}/notifications_api_common/locale/en/LC_MESSAGES/django.po

@@ -6,7 +6,7 @@
 #, fuzzy
 msgid ""
 msgstr ""
-"Project-Id-Version: 0.7.0\n"
+"Project-Id-Version: 0.7.2\n"
 "Report-Msgid-Bugs-To: \n"
 "POT-Creation-Date: 2024-12-12 15:28+0100\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"

{notifications_api_common-0.7.0 → notifications_api_common-0.7.2}/notifications_api_common/locale/nl/LC_MESSAGES/django.po

@@ -6,7 +6,7 @@
 #, fuzzy
 msgid ""
 msgstr ""
-"Project-Id-Version: 0.7.0\n"
+"Project-Id-Version: 0.7.2\n"
 "Report-Msgid-Bugs-To: \n"
 "POT-Creation-Date: 2024-12-12 15:28+0100\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"

{notifications_api_common-0.7.0 → notifications_api_common-0.7.2}/notifications_api_common/management/commands/register_kanalen.py

@@ -11,6 +11,7 @@ from requests.exceptions import JSONDecodeError, RequestException
 from ...kanalen import KANAAL_REGISTRY
 from ...models import NotificationsConfig
 from ...settings import get_setting
+from ...utils import get_domain
 
 logger = logging.getLogger(__name__)
 
@@ -77,7 +78,7 @@ def construct_kanaal_request_data(kanaal: str):
     _kanaal = next(k for k in KANAAL_REGISTRY if k.label == kanaal)
 
     # build up own documentation URL
-    domain = get_setting("SITE_DOMAIN")
+    domain = get_domain()
     protocol = "https" if get_setting("IS_HTTPS") else "http"
     documentation_url = (
         f"{protocol}://{domain}{reverse('notifications:kanalen')}#{kanaal}"

{notifications_api_common-0.7.0 → notifications_api_common-0.7.2}/notifications_api_common/settings.py

@@ -9,6 +9,8 @@ IS_HTTPS = True
 
 NOTIFICATIONS_GUARANTEE_DELIVERY = True
 
+NOTIFICATIONS_API_GET_DOMAIN = "notifications_api_common.utils.get_site_domain"
+
 
 def get_setting(name: str) -> Any:
     this_module = sys.modules[__name__]

{notifications_api_common-0.7.0 → notifications_api_common-0.7.2}/notifications_api_common/utils.py

@@ -2,10 +2,12 @@ from django.conf import settings
 from django.db import models
 from django.http import HttpRequest
 from django.urls import Resolver404, ResolverMatch, get_resolver, get_script_prefix
+from django.utils.module_loading import import_string
 
 from rest_framework.viewsets import ViewSet
 
 from .kanalen import Kanaal
+from .settings import get_setting
 
 
 def notification_documentation(kanaal: Kanaal):
@@ -74,3 +76,22 @@ def get_resource_for_path(path: str) -> models.Model:
     filter_kwargs = {viewset.lookup_field: viewset.kwargs[lookup_url_kwarg]}
 
     return viewset.get_queryset().get(**filter_kwargs)
+
+
+def get_domain() -> str:
+    """
+    Derive the domain where the application is hosted.
+    """
+    getter = import_string(get_setting("NOTIFICATIONS_API_GET_DOMAIN"))
+    return getter()
+
+
+def get_site_domain() -> str:
+    """
+    Derive the domain where the application is hosted.
+
+    You can provide an alternative implementation via the
+    ``NOTIFICATIONS_API_GET_DOMAIN`` setting, which takes a dotted path to a
+    callable taking no arguments.
+    """
+    return settings.SITE_DOMAIN

{notifications_api_common-0.7.0 → notifications_api_common-0.7.2/notifications_api_common.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: notifications-api-common
-Version: 0.7.0
+Version: 0.7.2
 Summary: Re-usable integration layer for the Common Ground Notifications API specification.
 Home-page: https://github.com/maykinmedia/notifications-api-common
 Author: Maykin Media
@@ -54,11 +54,12 @@ Requires-Dist: sphinx-rtd-theme; extra == "docs"
 Provides-Extra: release
 Requires-Dist: bumpversion; extra == "release"
 Requires-Dist: twine; extra == "release"
+Dynamic: license-file
 
 notifications-api-common
 ========================
 
-:Version: 0.7.0
+:Version: 0.7.2
 :Source: https://github.com/maykinmedia/notifications-api-common
 :Keywords: notifications, REST, API, Common Ground, ZGW
 :PythonVersion: 3.10

{notifications_api_common-0.7.0 → notifications_api_common-0.7.2}/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = notifications-api-common
-version = 0.7.0
+version = 0.7.2
 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

{notifications_api_common-0.7.0 → notifications_api_common-0.7.2}/tests/test_register_kanalen.py

@@ -9,7 +9,7 @@ from furl import furl
 
 from notifications_api_common.kanalen import KANAAL_REGISTRY, Kanaal
 
-from .conftest import NOTIFICATIONS_API_ROOT, SITE_DOMAIN
+from .conftest import NOTIFICATIONS_API_ROOT
 
 KANALEN_LIST_URL = (furl(NOTIFICATIONS_API_ROOT) / "kanaal").url
 
@@ -31,7 +31,6 @@ def override_kanalen():
 
 
 @pytest.mark.django_db
-@override_settings(SITE_DOMAIN=SITE_DOMAIN)
 def test_register_kanalen_success(
     notifications_config, requests_mock, override_kanalen
 ):
@@ -64,7 +63,6 @@ def test_register_kanalen_success(
 
 
 @pytest.mark.django_db
-@override_settings(SITE_DOMAIN=SITE_DOMAIN)
 def test_register_kanalen_from_registry_success(
     notifications_config, requests_mock, override_kanalen
 ):
@@ -110,7 +108,6 @@ def test_register_kanalen_from_registry_success(
 
 
 @pytest.mark.django_db
-@override_settings(SITE_DOMAIN=SITE_DOMAIN)
 def test_register_kanalen_existing_kanalen(
     notifications_config, requests_mock, override_kanalen
 ):
@@ -200,7 +197,6 @@ def test_register_kanalen_existing_kanalen(
 
 
 @pytest.mark.django_db
-@override_settings(SITE_DOMAIN=SITE_DOMAIN)
 def test_register_kanalen_unknown_url(
     notifications_config, requests_mock, override_kanalen
 ):
@@ -224,7 +220,6 @@ def test_register_kanalen_unknown_url(
 
 
 @pytest.mark.django_db
-@override_settings(SITE_DOMAIN=SITE_DOMAIN)
 def test_register_kanalen_incorrect_post(
     notifications_config, requests_mock, override_kanalen
 ):
@@ -250,7 +245,6 @@ def test_register_kanalen_incorrect_post(
 
 
 @pytest.mark.django_db
-@override_settings(SITE_DOMAIN=SITE_DOMAIN)
 def test_register_kanalen_update_fails(
     notifications_config, requests_mock, override_kanalen
 ):

{notifications_api_common-0.7.0 → notifications_api_common-0.7.2}/tests/test_utils.py

@@ -3,10 +3,10 @@ from django.test import override_settings
 from notifications_api_common.settings import get_setting
 
 
-@override_settings(SITE_DOMAIN="example.com")
 def test_get_settings():
     assert get_setting("SITE_DOMAIN") == "example.com"
 
 
+@override_settings(SITE_DOMAIN=None)
 def test_get_settings_null_value():
     assert get_setting("SITE_DOMAIN") is None