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

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

@@ -2,6 +2,20 @@
 Changelog
 =========
 
+0.7.3 (2025-06-17)
+------------------
+
+**New features**
+
+* [#37] Set the ``notifications_api_service_identifier`` field as required in setup-configuration
+* Add the env variable ``TIME_LEEWAY`` that defines a leeway in ``UntilNowValidator``
+
+**Maintenance**
+
+* [maykinmedia/open-api-framework#132] Replace ``check_sphinx.py`` with ``make``
+* [maykinmedia/open-api-framework#133] Replace ``black``, ``isort`` and ``flake8`` with ``ruff`` and update code-quality workflow
+* [maykinmedia/open-api-framework#140] Upgrade python to 3.12
+
 0.7.2 (2025-03-28)
 ------------------
 

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: notifications-api-common
-Version: 0.7.2
+Version: 0.7.3
 Summary: Re-usable integration layer for the Common Ground Notifications API specification.
 Home-page: https://github.com/maykinmedia/notifications-api-common
 Author: Maykin Media
@@ -37,12 +37,8 @@ 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: ruff; 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: setup-configuration
@@ -59,12 +55,12 @@ Dynamic: license-file
 notifications-api-common
 ========================
 
-:Version: 0.7.2
+:Version: 0.7.3
 :Source: https://github.com/maykinmedia/notifications-api-common
 :Keywords: notifications, REST, API, Common Ground, ZGW
-:PythonVersion: 3.10
+:PythonVersion: 3.12
 
-|build-status| |code-quality| |black| |coverage| |docs|
+|build-status| |code-quality| |ruff| |coverage| |docs|
 
 |python-versions| |django-versions| |pypi-version|
 
@@ -115,9 +111,10 @@ See the `documentation <https://notifications-api-common.readthedocs.io/>`_.
      :alt: Code quality checks
      :target: https://github.com/maykinmedia/notifications-api-common/actions?query=workflow%3A%22Code+quality+checks%22
 
-.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
-    :target: https://github.com/psf/black
-
+.. |ruff| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
+    :target: https://github.com/astral-sh/ruff
+    :alt: Ruff
+    
 .. |coverage| image:: https://codecov.io/gh/maykinmedia/notifications-api-common/branch/main/graph/badge.svg
     :target: https://codecov.io/gh/maykinmedia/notifications-api-common
     :alt: Coverage status

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

@@ -1,12 +1,12 @@
 notifications-api-common
 ========================
 
-:Version: 0.7.2
+:Version: 0.7.3
 :Source: https://github.com/maykinmedia/notifications-api-common
 :Keywords: notifications, REST, API, Common Ground, ZGW
-:PythonVersion: 3.10
+:PythonVersion: 3.12
 
-|build-status| |code-quality| |black| |coverage| |docs|
+|build-status| |code-quality| |ruff| |coverage| |docs|
 
 |python-versions| |django-versions| |pypi-version|
 
@@ -57,9 +57,10 @@ See the `documentation <https://notifications-api-common.readthedocs.io/>`_.
      :alt: Code quality checks
      :target: https://github.com/maykinmedia/notifications-api-common/actions?query=workflow%3A%22Code+quality+checks%22
 
-.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
-    :target: https://github.com/psf/black
-
+.. |ruff| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
+    :target: https://github.com/astral-sh/ruff
+    :alt: Ruff
+    
 .. |coverage| image:: https://codecov.io/gh/maykinmedia/notifications-api-common/branch/main/graph/badge.svg
     :target: https://codecov.io/gh/maykinmedia/notifications-api-common
     :alt: Coverage status

{notifications_api_common-0.7.2 → notifications_api_common-0.7.3}/notifications_api_common/api/serializers.py

@@ -28,7 +28,7 @@ class NotificatieSerializer(serializers.Serializer):
     )
     resource_url = serializers.URLField(
         label=_("resource URL"),
-        help_text=_("URL-referentie naar de `resource` van de publicerende " "API."),
+        help_text=_("URL-referentie naar de `resource` van de publicerende API."),
     )
     actie = serializers.CharField(
         label=_("actie"),

{notifications_api_common-0.7.2 → notifications_api_common-0.7.3}/notifications_api_common/contrib/setup_configuration/models.py

@@ -6,7 +6,10 @@ from notifications_api_common.models import NotificationsConfig, Subscription
 
 class NotificationConfigurationModel(ConfigurationModel):
     notifications_api_service_identifier: str = DjangoModelRef(
-        NotificationsConfig, "notifications_api_service", examples=["notificaties-api"]
+        NotificationsConfig,
+        "notifications_api_service",
+        examples=["notificaties-api"],
+        default=...,
     )
 
     class Meta:

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

@@ -6,7 +6,7 @@
 #, fuzzy
 msgid ""
 msgstr ""
-"Project-Id-Version: 0.7.2\n"
+"Project-Id-Version: 0.7.3\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.2 → notifications_api_common-0.7.3}/notifications_api_common/locale/nl/LC_MESSAGES/django.po

@@ -6,7 +6,7 @@
 #, fuzzy
 msgid ""
 msgstr ""
-"Project-Id-Version: 0.7.2\n"
+"Project-Id-Version: 0.7.3\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.2 → notifications_api_common-0.7.3}/notifications_api_common/settings.py

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

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

@@ -22,7 +22,7 @@ def notification_documentation(kanaal: Kanaal):
 **Resources en acties**
 """
     for resource, actions in kanaal.get_usage():
-        doc += f"""- `{resource}`: {', '.join(actions)}\n"""
+        doc += f"""- `{resource}`: {", ".join(actions)}\n"""
     return doc
 
 

{notifications_api_common-0.7.2 → notifications_api_common-0.7.3}/notifications_api_common/validators.py

@@ -1,10 +1,13 @@
 import logging
+from datetime import timedelta
 
 from django.core.exceptions import ValidationError
 from django.utils import timezone
 from django.utils.deconstruct import deconstructible
 from django.utils.translation import gettext_lazy as _
 
+from .settings import get_setting
+
 logger = logging.getLogger(__name__)
 
 
@@ -14,6 +17,8 @@ class UntilNowValidator:
     Validate a datetime to not be in the future.
 
     This means that `now` is included.
+
+    Some leeway can be added with the TIME_LEEWAY setting.
     """
 
     message = _("Ensure this value is not in the future.")
@@ -21,7 +26,7 @@ class UntilNowValidator:
 
     @property
     def limit_value(self):
-        return timezone.now()
+        return timezone.now() + timedelta(seconds=get_setting("TIME_LEEWAY"))
 
     def __call__(self, value):
         if value > self.limit_value:

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: notifications-api-common
-Version: 0.7.2
+Version: 0.7.3
 Summary: Re-usable integration layer for the Common Ground Notifications API specification.
 Home-page: https://github.com/maykinmedia/notifications-api-common
 Author: Maykin Media
@@ -37,12 +37,8 @@ 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: ruff; 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: setup-configuration
@@ -59,12 +55,12 @@ Dynamic: license-file
 notifications-api-common
 ========================
 
-:Version: 0.7.2
+:Version: 0.7.3
 :Source: https://github.com/maykinmedia/notifications-api-common
 :Keywords: notifications, REST, API, Common Ground, ZGW
-:PythonVersion: 3.10
+:PythonVersion: 3.12
 
-|build-status| |code-quality| |black| |coverage| |docs|
+|build-status| |code-quality| |ruff| |coverage| |docs|
 
 |python-versions| |django-versions| |pypi-version|
 
@@ -115,9 +111,10 @@ See the `documentation <https://notifications-api-common.readthedocs.io/>`_.
      :alt: Code quality checks
      :target: https://github.com/maykinmedia/notifications-api-common/actions?query=workflow%3A%22Code+quality+checks%22
 
-.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
-    :target: https://github.com/psf/black
-
+.. |ruff| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
+    :target: https://github.com/astral-sh/ruff
+    :alt: Ruff
+    
 .. |coverage| image:: https://codecov.io/gh/maykinmedia/notifications-api-common/branch/main/graph/badge.svg
     :target: https://codecov.io/gh/maykinmedia/notifications-api-common
     :alt: Coverage status

{notifications_api_common-0.7.2 → notifications_api_common-0.7.3}/notifications_api_common.egg-info/SOURCES.txt

@@ -63,4 +63,5 @@ tests/test_register_kanalen.py
 tests/test_register_webhook.py
 tests/test_send_message.py
 tests/test_subscription_configuration_steps.py
-tests/test_utils.py
+tests/test_utils.py
+tests/test_validators.py

{notifications_api_common-0.7.2 → notifications_api_common-0.7.3}/notifications_api_common.egg-info/requires.txt

@@ -16,9 +16,6 @@ psycopg2
 sphinx
 sphinx-rtd-theme
 
-[pep8]
-flake8
-
 [release]
 bumpversion
 twine
@@ -33,7 +30,5 @@ pytest
 pytest-django
 freezegun
 tox
-isort
-black
-flake8
+ruff
 zgw-consumers[testutils]>=0.35.1

notifications_api_common-0.7.3/pyproject.toml

@@ -0,0 +1,126 @@
+[build-system]
+requires = ["setuptools >= 30.3.0"]  # version supporting setup.cfg]
+build-backend = "setuptools.build_meta"
+
+# Bumpversion configuration
+
+[tool.bumpversion]
+commit = false
+tag = false
+current_version = "0.7.3"
+
+[[tool.bumpversion.files]]
+filename = "setup.cfg"
+
+[[tool.bumpversion.files]]
+filename = "README.rst"
+
+[[tool.bumpversion.files]]
+filename = "docs/conf.py"
+
+[[tool.bumpversion.files]]
+filename = "notifications_api_common/locale/en/LC_MESSAGES/django.po"
+
+[[tool.bumpversion.files]]
+filename = "notifications_api_common/locale/nl/LC_MESSAGES/django.po"
+
+[tool.ruff]
+# Exclude folders and files
+exclude = [
+    "migrations",
+    "static",
+    "media",
+]
+
+# Same as Black
+line-length = 88
+indent-width = 4
+
+target-version = "py312"
+
+[tool.ruff.lint]
+select = [
+    # https://docs.astral.sh/ruff/rules/#isort-i
+    "I",
+    # https://docs.astral.sh/ruff/rules/#error-e
+    "E",
+    # https://docs.astral.sh/ruff/rules/#pyflakes-f
+    "F",
+    # https://docs.astral.sh/ruff/rules/#flake8-simplify-sim
+    "SIM",
+    # https://docs.astral.sh/ruff/rules/#perflint-perf
+    "PERF",
+    # https://docs.astral.sh/ruff/rules/#refurb-furb
+    "FURB",
+    # https://docs.astral.sh/ruff/rules/#flake8-bugbear-b
+    "B006",
+    "B010",
+    # https://docs.astral.sh/ruff/rules/#pep8-naming-n
+    "N",
+]
+
+ignore = [
+    # Checks for assertRaises and pytest.raises context managers that catch Exception or BaseException.
+    "B017",
+    # Checks for useless expressions.
+    "B018",
+    # Checks for raise statements in exception handlers that lack a from clause.
+    "B904",
+    # Whitespace before ':' (conflicts with Black)
+    "E203",
+    # Checks for lines that exceed the specified maximum character length.
+    "E501",
+    # Do not assign a lambda expression
+    "E731",
+    # Name may be undefined from '*' import
+    "F405",
+    # Checks for CamelCase imports that are aliased to lowercase names
+    "N813",
+    # Checks for CamelCase imports that are aliased to constant-style names.
+    "N814",
+    # Checks for class variable names that follow the mixedCase convention
+    "N815",
+    # Exception name should be named with Error suffix
+    "N818",
+    # Checks for instance methods that use a name other than self for their first argument.
+    "N805",
+    # Checks for the use of non-lowercase variable names in functions
+    "N806",
+    # Checks for functions names that do not follow the snake_case naming convention.
+    "N802",
+    # Checks for module names that do not follow the snake_case naming convention or are otherwise invalid.
+    "N999",
+    # Checks for for loops that can be replaced by a list comprehension.
+    "PERF401",
+    # Checks for `if` statements that can be replaced with bool
+    "SIM103",
+    # Check for if-else-blocks that can be replaced with a ternary operator
+    "SIM108",
+    #Check for environment variables that are not capitalized.
+    "SIM112",
+    # Checks for nested if statements that can be collapsed into a single if statement
+    "SIM102",
+    # Use a single `with` statement with multiple contexts instead of nested `with` statements
+    "SIM117",
+]
+
+
+# Import sorting configuration (equivalent to isort)
+[tool.ruff.lint.isort]
+combine-as-imports = true
+force-wrap-aliases = false
+known-first-party = ["notifications_api_common"]
+lines-after-imports = -1
+relative-imports-order = "furthest-to-closest"
+sections = { django = ["django"] }
+section-order = [
+    "future",
+    "standard-library",
+    "django",
+    "third-party",
+    "first-party",
+    "local-folder",
+]
+
+[tool.ruff.format]
+line-ending = "lf"

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

@@ -1,6 +1,6 @@
 [metadata]
 name = notifications-api-common
-version = 0.7.2
+version = 0.7.3
 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
@@ -43,9 +43,7 @@ tests_require =
 	pytest-django
 	freezegun
 	tox
-	isort
-	black
-	flake8
+	ruff
 	zgw-consumers[testutils]>=0.35.1
 
 [options.packages.find]
@@ -62,11 +60,8 @@ tests =
 	pytest-django
 	freezegun
 	tox
-	isort
-	black
-	flake8
+	ruff
 	zgw-consumers[testutils]>=0.35.1
-pep8 = flake8
 coverage = pytest-cov
 setup-configuration = 
 	django-setup-configuration>=0.7.0
@@ -81,30 +76,10 @@ release =
 [aliases]
 test = pytest
 
-[isort]
-combine_as_imports = true
-default_section = THIRDPARTY
-include_trailing_comma = true
-line_length = 88
-multi_line_output = 3
-force_grid_wrap = 0
-use_parentheses = True
-ensure_newline_before_comments = True
-skip = env,.tox,.history,.eggs
-known_django = django
-known_first_party = notifications_api_common
-sections = FUTURE,STDLIB,DJANGO,THIRDPARTY,FIRSTPARTY,LOCALFOLDER
-
 [tool:pytest]
 testpaths = tests
 DJANGO_SETTINGS_MODULE = testapp.settings
 
-[pep8]
-
-[flake8]
-max-line-length = 88
-exclude = env,.tox,doc
-
 [egg_info]
 tag_build = 
 tag_date = 0

{notifications_api_common-0.7.2 → notifications_api_common-0.7.3}/tests/test_configuration_steps.py

@@ -57,16 +57,15 @@ def test_execute_configuration_step_update_existing():
 
 
 @pytest.mark.django_db
-def test_execute_configuration_step_without_service_success():
+def test_execute_configuration_step_without_service_is_not_allowed():
     with pytest.raises(PrerequisiteFailed) as excinfo:
         execute_single_step(
             NotificationConfigurationStep, yaml_source=CONFIG_FILE_PATH_NO_SERVICE
         )
 
-    assert (
-        "notifications_config.notifications_api_service_identifier\n  Input should be a valid string"
-        in str(excinfo.value)
-    )
+    assert "notifications_api_service_identifier" in str(excinfo.value)
+    assert "validation error" in str(excinfo.value)
+    assert "Field required" in str(excinfo.value)
 
 
 @pytest.mark.django_db

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

@@ -1,7 +1,6 @@
 from io import StringIO
 from unittest.mock import Mock
 
-from django.test import override_settings
 from django.test.testcases import call_command
 
 import pytest
@@ -16,7 +15,6 @@ KANALEN_LIST_URL = (furl(NOTIFICATIONS_API_ROOT) / "kanaal").url
 
 @pytest.fixture
 def override_kanalen():
-
     kanalen = set(
         (
             Kanaal(

{notifications_api_common-0.7.2 → notifications_api_common-0.7.3}/tests/test_send_message.py

@@ -117,7 +117,7 @@ def test_api_create_person_unconfigured(api_client, notifications_config):
     data = {"name": "John", "address_street": "Grotestraat", "address_number": "1"}
 
     with pytest.raises(RuntimeError):
-        response = api_client.post(url, data)
+        api_client.post(url, data)
 
     assert Person.objects.count() == 0
 
@@ -132,6 +132,6 @@ def test_api_create_person_unconfigured_notifications_guarantee_delivery_false(
     url = reverse("person-list")
     data = {"name": "John", "address_street": "Grotestraat", "address_number": "1"}
 
-    response = api_client.post(url, data)
+    api_client.post(url, data)
 
     assert Person.objects.count() == 1

notifications_api_common-0.7.3/tests/test_validators.py

@@ -0,0 +1,23 @@
+from datetime import datetime
+
+from django.core.exceptions import ValidationError
+
+import pytest
+from freezegun import freeze_time
+
+from notifications_api_common.validators import UntilNowValidator
+
+
+@freeze_time("2021-08-23T14:20:00")
+def test_invalid_date():
+    validator = UntilNowValidator()
+    with pytest.raises(ValidationError) as error:
+        validator(datetime(2021, 8, 23, 14, 20, 4))
+    assert "Ensure this value is not in the future." in str(error.value)
+
+
+@freeze_time("2021-08-23T14:20:00")
+def test_invalid_date_with_leeway(settings):
+    settings.TIME_LEEWAY = 5
+    validator = UntilNowValidator()
+    validator(datetime(2021, 8, 23, 14, 20, 4))

notifications_api_common-0.7.2/pyproject.toml

@@ -1,3 +0,0 @@
-[build-system]
-requires = ["setuptools >= 30.3.0"]  # version supporting setup.cfg]
-build-backend = "setuptools.build_meta"