js-api 20260830192902.dev0__tar.gz → 20260908012207.dev0__tar.gz

{js_api-20260830192902.dev0 → js_api-20260908012207.dev0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: js-api
-Version: 20260830192902.dev0
+Version: 20260908012207.dev0
 Summary: Custom API written in Python using FastAPI
 Author-email: Jack Stockley <jack@jstockley.com>
 Project-URL: Homepage, https://github.com/jnstockley/api
@@ -15,7 +15,8 @@ Requires-Dist: fastapi[standard]==0.141.1
 Requires-Dist: sqlalchemy==2.0.52
 Requires-Dist: sqlmodel==0.0.42
 Requires-Dist: python-dotenv==1.2.3
-Requires-Dist: psycopg[binary]==3.3.4
+Requires-Dist: psycopg[binary]==3.3.5
+Requires-Dist: nctalk>=0.0.4
 Dynamic: license-file
 
 # API
@@ -29,6 +30,12 @@ Simplest setup is to start from [compose.yml](https://github.com/jnstockley/api/
 - `DATABASE_URL` - The URL to connect to postgres DB. Must start with `postgresql+psycopg://`. Should be in the format specifiec in [template.env](https://github.com/jnstockley/api/blob/dev/template.env)
 - `TZ` - Timezone of the container
 - `PGTZ` - Timezone the Postgres container should use
+- `NEXTCLOUD_URL` - Base URL (must be `https://`) of the Nextcloud instance used by `/webhook/nextcloud-talk`
+- `NEXTCLOUD_TALK_TOKEN` - Conversation token of the registered [Nextcloud Talk bot](https://nextcloud-talk.readthedocs.io/en/latest/bot-list/) used by `/webhook/nextcloud-talk`
+- `NEXTCLOUD_TALK_SECRET` - Shared secret of the registered Nextcloud Talk bot used by `/webhook/nextcloud-talk`
+
+## Webhooks
+- `POST /webhook/nextcloud-talk` - Forwards a `header` and `message` to a Nextcloud Talk conversation via the [Nextcloud Talk Bot API](https://nextcloud-talk.readthedocs.io/en/latest/bot-list/), using the [nctalk](https://pypi.org/project/nctalk/) package. Requires the `X-API-KEY` header and a JSON body: `{"header": "...", "message": "..."}`
 
 ## How to Access
 Using the [compose.yml](https://github.com/jnstockley/api/blob/dev/compose.yml) file, you can access the API at `http://<IP>:5000/health-check`. If everything is setup correctly, you should see `{"status":"ok"}`

{js_api-20260830192902.dev0 → js_api-20260908012207.dev0}/README.md

@@ -9,6 +9,12 @@ Simplest setup is to start from [compose.yml](https://github.com/jnstockley/api/
 - `DATABASE_URL` - The URL to connect to postgres DB. Must start with `postgresql+psycopg://`. Should be in the format specifiec in [template.env](https://github.com/jnstockley/api/blob/dev/template.env)
 - `TZ` - Timezone of the container
 - `PGTZ` - Timezone the Postgres container should use
+- `NEXTCLOUD_URL` - Base URL (must be `https://`) of the Nextcloud instance used by `/webhook/nextcloud-talk`
+- `NEXTCLOUD_TALK_TOKEN` - Conversation token of the registered [Nextcloud Talk bot](https://nextcloud-talk.readthedocs.io/en/latest/bot-list/) used by `/webhook/nextcloud-talk`
+- `NEXTCLOUD_TALK_SECRET` - Shared secret of the registered Nextcloud Talk bot used by `/webhook/nextcloud-talk`
+
+## Webhooks
+- `POST /webhook/nextcloud-talk` - Forwards a `header` and `message` to a Nextcloud Talk conversation via the [Nextcloud Talk Bot API](https://nextcloud-talk.readthedocs.io/en/latest/bot-list/), using the [nctalk](https://pypi.org/project/nctalk/) package. Requires the `X-API-KEY` header and a JSON body: `{"header": "...", "message": "..."}`
 
 ## How to Access
 Using the [compose.yml](https://github.com/jnstockley/api/blob/dev/compose.yml) file, you can access the API at `http://<IP>:5000/health-check`. If everything is setup correctly, you should see `{"status":"ok"}`

{js_api-20260830192902.dev0 → js_api-20260908012207.dev0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "js-api"
-version = "20260830192902.dev"
+version = "20260908012207.dev"
 description = "Custom API written in Python using FastAPI"
 authors = [
     {name = "Jack Stockley", email = "jack@jstockley.com"}
@@ -17,7 +17,8 @@ dependencies = [
     "sqlalchemy==2.0.52",
     "sqlmodel==0.0.42",
     "python-dotenv==1.2.3",
-    "psycopg[binary]==3.3.4",
+    "psycopg[binary]==3.3.5",
+    "nctalk>=0.0.4",
 ]
 [project.urls]
 Homepage = "https://github.com/jnstockley/api"

{js_api-20260830192902.dev0 → js_api-20260908012207.dev0}/src/api.py

@@ -7,7 +7,7 @@ from dotenv import load_dotenv
 from fastapi import FastAPI
 
 import models
-from controllers import docker, health_check, ip, valentines_day
+from controllers import docker, health_check, ip, valentines_day, webhook
 from database import engine
 from util.healthcheck import healthcheck
 
@@ -44,6 +44,7 @@ app.include_router(health_check.router)
 app.include_router(docker.router)
 app.include_router(ip.router)
 app.include_router(valentines_day.router)
+app.include_router(webhook.router)
 
 if __name__ == "__main__":
     load_dotenv()

js_api-20260908012207.dev0/src/controllers/webhook.py

@@ -0,0 +1,44 @@
+import os
+
+from fastapi import APIRouter, HTTPException, Security
+from nctalk import TalkMessenger
+from pydantic import BaseModel, Field
+
+from util.auth import get_token_header
+from util.logging import logger
+
+router = APIRouter(prefix="/webhook", dependencies=[Security(get_token_header)])
+
+
+class NextcloudTalkWebhook(BaseModel):
+    header: str = Field(..., min_length=1, max_length=200)
+    message: str = Field(..., min_length=1, max_length=32000)
+
+
+@router.post("/databasus")
+async def databasus(webhook: NextcloudTalkWebhook):
+    if webhook.header.strip() == "":
+        raise HTTPException(status_code=422, detail="header cannot be empty")
+    if webhook.message.strip() == "":
+        raise HTTPException(status_code=422, detail="message cannot be empty")
+
+    endpoint_url = os.environ.get("NEXTCLOUD_URL", "").strip()
+    token = os.environ.get("NEXTCLOUD_TALK_TOKEN", "").strip()
+    secret = os.environ.get("NEXTCLOUD_TALK_SECRET", "").strip()
+
+    if not endpoint_url or not token or not secret:
+        raise HTTPException(status_code=500, detail="Nextcloud Talk is not configured")
+    if not endpoint_url.startswith("https://"):
+        raise HTTPException(status_code=500, detail="NEXTCLOUD_URL must use https://")
+
+    messenger = TalkMessenger(endpoint_url=endpoint_url, token=token, secret=secret)
+
+    message = f"**{webhook.header}**\n{webhook.message}"
+
+    if not messenger.send(message):
+        logger.error("Failed to send message to Nextcloud Talk")
+        raise HTTPException(
+            status_code=502, detail="Failed to send message to Nextcloud Talk"
+        )
+
+    return {"status": "sent"}

{js_api-20260830192902.dev0 → js_api-20260908012207.dev0}/src/js_api.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: js-api
-Version: 20260830192902.dev0
+Version: 20260908012207.dev0
 Summary: Custom API written in Python using FastAPI
 Author-email: Jack Stockley <jack@jstockley.com>
 Project-URL: Homepage, https://github.com/jnstockley/api
@@ -15,7 +15,8 @@ Requires-Dist: fastapi[standard]==0.141.1
 Requires-Dist: sqlalchemy==2.0.52
 Requires-Dist: sqlmodel==0.0.42
 Requires-Dist: python-dotenv==1.2.3
-Requires-Dist: psycopg[binary]==3.3.4
+Requires-Dist: psycopg[binary]==3.3.5
+Requires-Dist: nctalk>=0.0.4
 Dynamic: license-file
 
 # API
@@ -29,6 +30,12 @@ Simplest setup is to start from [compose.yml](https://github.com/jnstockley/api/
 - `DATABASE_URL` - The URL to connect to postgres DB. Must start with `postgresql+psycopg://`. Should be in the format specifiec in [template.env](https://github.com/jnstockley/api/blob/dev/template.env)
 - `TZ` - Timezone of the container
 - `PGTZ` - Timezone the Postgres container should use
+- `NEXTCLOUD_URL` - Base URL (must be `https://`) of the Nextcloud instance used by `/webhook/nextcloud-talk`
+- `NEXTCLOUD_TALK_TOKEN` - Conversation token of the registered [Nextcloud Talk bot](https://nextcloud-talk.readthedocs.io/en/latest/bot-list/) used by `/webhook/nextcloud-talk`
+- `NEXTCLOUD_TALK_SECRET` - Shared secret of the registered Nextcloud Talk bot used by `/webhook/nextcloud-talk`
+
+## Webhooks
+- `POST /webhook/nextcloud-talk` - Forwards a `header` and `message` to a Nextcloud Talk conversation via the [Nextcloud Talk Bot API](https://nextcloud-talk.readthedocs.io/en/latest/bot-list/), using the [nctalk](https://pypi.org/project/nctalk/) package. Requires the `X-API-KEY` header and a JSON body: `{"header": "...", "message": "..."}`
 
 ## How to Access
 Using the [compose.yml](https://github.com/jnstockley/api/blob/dev/compose.yml) file, you can access the API at `http://<IP>:5000/health-check`. If everything is setup correctly, you should see `{"status":"ok"}`

{js_api-20260830192902.dev0 → js_api-20260908012207.dev0}/src/js_api.egg-info/SOURCES.txt

@@ -10,6 +10,7 @@ src/controllers/docker.py
 src/controllers/health_check.py
 src/controllers/ip.py
 src/controllers/valentines_day.py
+src/controllers/webhook.py
 src/js_api.egg-info/PKG-INFO
 src/js_api.egg-info/SOURCES.txt
 src/js_api.egg-info/dependency_links.txt
@@ -22,4 +23,5 @@ src/util/healthcheck.py
 src/util/logging.py
 tests/test_docker.py
 tests/test_health_check.py
-tests/test_ip.py
+tests/test_ip.py
+tests/test_webhook.py

{js_api-20260830192902.dev0 → js_api-20260908012207.dev0}/src/js_api.egg-info/requires.txt

@@ -2,4 +2,5 @@ fastapi[standard]==0.141.1
 sqlalchemy==2.0.52
 sqlmodel==0.0.42
 python-dotenv==1.2.3
-psycopg[binary]==3.3.4
+psycopg[binary]==3.3.5
+nctalk>=0.0.4

js_api-20260908012207.dev0/tests/test_webhook.py

@@ -0,0 +1,123 @@
+import os
+from unittest import TestCase
+from unittest.mock import patch
+
+from fastapi.testclient import TestClient
+from sqlalchemy.orm import sessionmaker
+from testcontainers.postgres import PostgresContainer
+
+import models
+from database import engine, get_db
+from src.api import app
+
+postgres = PostgresContainer("postgres:17-alpine").start()
+
+DATABASE_URL = postgres.get_connection_url(driver="psycopg")
+os.environ["DATABASE_URL"] = DATABASE_URL
+
+models.Base.metadata.create_all(bind=engine)
+
+TestingSessionLocal = sessionmaker(autocommit=False, autoflush=False, bind=engine)
+
+client = TestClient(app)
+
+
+def override_get_db():
+    database = TestingSessionLocal()
+    yield database
+    database.close()
+
+
+app.dependency_overrides[get_db] = override_get_db
+
+
+class TestWebhook(TestCase):
+    def setUp(self):
+        os.environ["NEXTCLOUD_URL"] = "https://nextcloud.example.com"
+        os.environ["NEXTCLOUD_TALK_TOKEN"] = "test-token"
+        os.environ["NEXTCLOUD_TALK_SECRET"] = "test-secret"
+
+    def test_missing_body(self):
+        api_key = os.environ["API_KEY"]
+        header = {"X-API-KEY": api_key}
+        response = client.post("/webhook/databasus", headers=header, json={})
+        assert response.status_code == 422
+
+    def test_empty_header(self):
+        api_key = os.environ["API_KEY"]
+        header = {"X-API-KEY": api_key}
+        response = client.post(
+            "/webhook/databasus",
+            headers=header,
+            json={"header": "", "message": "hello"},
+        )
+        assert response.status_code == 422
+
+    def test_empty_message(self):
+        api_key = os.environ["API_KEY"]
+        header = {"X-API-KEY": api_key}
+        response = client.post(
+            "/webhook/databasus",
+            headers=header,
+            json={"header": "title", "message": ""},
+        )
+        assert response.status_code == 422
+
+    def test_not_configured(self):
+        api_key = os.environ["API_KEY"]
+        header = {"X-API-KEY": api_key}
+        del os.environ["NEXTCLOUD_URL"]
+        try:
+            response = client.post(
+                "/webhook/databasus",
+                headers=header,
+                json={"header": "title", "message": "hello"},
+            )
+            assert response.status_code == 500
+        finally:
+            os.environ["NEXTCLOUD_URL"] = "https://nextcloud.example.com"
+
+    def test_insecure_url(self):
+        api_key = os.environ["API_KEY"]
+        header = {"X-API-KEY": api_key}
+        os.environ["NEXTCLOUD_URL"] = "http://nextcloud.example.com"
+        try:
+            response = client.post(
+                "/webhook/databasus",
+                headers=header,
+                json={"header": "title", "message": "hello"},
+            )
+            assert response.status_code == 500
+        finally:
+            os.environ["NEXTCLOUD_URL"] = "https://nextcloud.example.com"
+
+    @patch("controllers.webhook.TalkMessenger.send", return_value=True)
+    def test_send_message(self, mock_send):
+        api_key = os.environ["API_KEY"]
+        header = {"X-API-KEY": api_key}
+        response = client.post(
+            "/webhook/databasus",
+            headers=header,
+            json={"header": "title", "message": "hello"},
+        )
+        assert response.status_code == 200
+        assert response.json() == {"status": "sent"}
+        mock_send.assert_called_once_with("**title**\nhello")
+
+    @patch("controllers.webhook.TalkMessenger.send", return_value=False)
+    def test_send_message_failure(self, mock_send):
+        api_key = os.environ["API_KEY"]
+        header = {"X-API-KEY": api_key}
+        response = client.post(
+            "/webhook/databasus",
+            headers=header,
+            json={"header": "title", "message": "hello"},
+        )
+        assert response.status_code == 502
+
+    def test_missing_api_key(self):
+        response = client.post(
+            "/webhook/databasus",
+            json={"header": "title", "message": "hello"},
+        )
+        assert response.status_code in (401, 422)