Merge pull request #4 from bsgip/cactusschema

Migrated to cactus-schema

Author: joshvote

.github/workflows/linttest.yml

@@ -59,7 +59,7 @@ jobs:
 
       - name: Install Dependencies
         run: |
-          pip install .[server,dev]
+          pip install .[dev]
 
       - name: Run mypy
         run: mypy .
@@ -82,7 +82,7 @@ jobs:
 
       - name: Install Dependencies
         run: |
-          pip install .[server,test]
+          pip install .[test]
 
       - name: Run Pytest
         run: pytest

Dockerfile

@@ -8,7 +8,7 @@ RUN apt-get update; apt-get install -y git openssh-client
 RUN git config --global url."https://git@github.com/".insteadOf "ssh://git@github.com/"
 
 # Install app / dependencies
-RUN pip install --no-cache-dir "cactus-client-notifications[server] @ git+ssh://git@github.com/bsgip/cactus-client-notifications.git@${CACTUS_CLIENT_NOTIFICATIONS_VERSION}" gunicorn
+RUN pip install --no-cache-dir "cactus-client-notifications @ git+ssh://git@github.com/bsgip/cactus-client-notifications.git@${CACTUS_CLIENT_NOTIFICATIONS_VERSION}" gunicorn
 
 # RUN stage
 FROM  python:3.12-slim

README.md

@@ -11,11 +11,9 @@ Any mutual TLS / other considerations are expected to be managed at the point of
 
 ## Development
 
-`pip install cactus_client_notifications` will install ONLY the schema dependencies (the default)
+`pip install cactus_client_notifications` will install all dependencies for running the server
 
-`pip install cactus_client_notifications[server]` will also install the dependencies for running the server (use for deployments)
-
-`pip install cactus_client_notifications[server,dev,test]` will install ALL dependencies for development / tests
+`pip install cactus_client_notifications[dev,test]` will install ALL dependencies for development / tests
 
 ## Configuration
 

pyproject.toml

@@ -42,14 +42,13 @@ build-backend = "setuptools.build_meta"
 [project]
 name = "cactus_client_notifications"
 dynamic = ["version", "readme"]
-description = "Schema and mini webserver for accepting CSIP-Aus subscription notifications via dynamic webhook URIs."
+description = "Mini webserver for accepting CSIP-Aus subscription notifications via dynamic webhook URIs."
 dependencies = [
-    "dataclass-wizard>=0.35.0,<1",
-
+    "cactus-schema>=0.0.4,<1",
+    "aiohttp>=3.11.12,<4",
 ] # These dependencies are purely for the schema (the default reference). Server dependencies require "server"
 
 [project.optional-dependencies]
-server = ["aiohttp>=3.11.12,<4"]
 dev = ["bandit", "black", "coverage", "flake8", "flake8-bugbear", "mypy"]
 test = ["assertical", "pytest", "pytest-asyncio", "pytest-aiohttp", "freezegun"]
 

src/cactus_client_notifications/schema/__init__.py

@@ -8,8 +8,8 @@
 from typing import Any
 
 from aiohttp import web
+from cactus_schema.notification import CollectedHeader, CollectedNotification
 
-from cactus_client_notifications.schema import CollectedHeader, CollectedNotification
 from cactus_client_notifications.server.time import utc_now
 
 logger = logging.getLogger(__name__)

src/cactus_client_notifications/server/endpoint_store.py

@@ -3,13 +3,13 @@
 from importlib.metadata import version
 
 from aiohttp import ContentTypeError, web
-
-from cactus_client_notifications.schema import (
-    URI_ENDPOINT,
+from cactus_schema.notification import (
     CollectEndpointResponse,
     ConfigureEndpointRequest,
     CreateEndpointResponse,
+    uri,
 )
+
 from cactus_client_notifications.server.endpoint_store import (
     NotificationException,
     generate_collected_notification,
@@ -62,7 +62,7 @@ def path_join(*parts: str) -> str:
 def generate_public_uri(server_settings: ServerSettings, endpoint_id: str) -> str:
     """Generates the public facing URI for a specific endpoint_id"""
     return path_join(
-        server_settings.public_server_url, server_settings.mount_point, URI_ENDPOINT.format(endpoint_id=endpoint_id)
+        server_settings.public_server_url, server_settings.mount_point, uri.URI_ENDPOINT.format(endpoint_id=endpoint_id)
     )
 
 

src/cactus_client_notifications/server/handler.py

@@ -7,8 +7,8 @@
 from typing import AsyncGenerator
 
 from aiohttp import web
+from cactus_schema.notification import uri
 
-import cactus_client_notifications.schema as schema
 import cactus_client_notifications.server.shared as shared
 from cactus_client_notifications.server import handler
 from cactus_client_notifications.server.endpoint_store import EndpointStore
@@ -91,13 +91,13 @@ def create_app() -> web.Application:
     # Add routes for Test Runner
     mount = server_settings.mount_point
     app.router.add_route(
-        "POST", handler.path_join(mount, schema.URI_MANAGE_ENDPOINT_LIST), handler.post_manage_endpoint_list
+        "POST", handler.path_join(mount, uri.URI_MANAGE_ENDPOINT_LIST), handler.post_manage_endpoint_list
     )
-    app.router.add_route("GET", handler.path_join(mount, schema.URI_MANAGE_ENDPOINT), handler.get_manage_endpoint)
-    app.router.add_route("PUT", handler.path_join(mount, schema.URI_MANAGE_ENDPOINT), handler.put_manage_endpoint)
-    app.router.add_route("DELETE", handler.path_join(mount, schema.URI_MANAGE_ENDPOINT), handler.delete_manage_endpoint)
-    app.router.add_route("*", handler.path_join(mount, schema.URI_ENDPOINT), handler.webhook_endpoint)
-    app.router.add_route("GET", handler.path_join(mount, schema.URI_MANAGE_SERVER), handler.get_manage_server)
+    app.router.add_route("GET", handler.path_join(mount, uri.URI_MANAGE_ENDPOINT), handler.get_manage_endpoint)
+    app.router.add_route("PUT", handler.path_join(mount, uri.URI_MANAGE_ENDPOINT), handler.put_manage_endpoint)
+    app.router.add_route("DELETE", handler.path_join(mount, uri.URI_MANAGE_ENDPOINT), handler.delete_manage_endpoint)
+    app.router.add_route("*", handler.path_join(mount, uri.URI_ENDPOINT), handler.webhook_endpoint)
+    app.router.add_route("GET", handler.path_join(mount, uri.URI_MANAGE_SERVER), handler.get_manage_server)
 
     # Start the periodic task
     app.cleanup_ctx.append(setup_periodic_task)

src/cactus_client_notifications/server/main.py

@@ -3,8 +3,7 @@
 
 import pytest
 from aiohttp import ClientSession
-
-from cactus_client_notifications.schema import (
+from cactus_schema.notification import (
     CollectEndpointResponse,
     ConfigureEndpointRequest,
     CreateEndpointResponse,

tests/integration/test_endpoints.py

@@ -1,10 +1,9 @@
+import cactus_schema.notification as schema
 import pytest
 from assertical.asserts.generator import assert_class_instance_equality
 from assertical.fake.generator import generate_class_instance
 from dataclass_wizard import JSONWizard
 
-import cactus_client_notifications.schema as schema
-
 
 @pytest.mark.parametrize(
     "type",