hookbase 1.0.0__tar.gz → 2.1.1__tar.gz

hookbase-2.1.1/.github/workflows/python-publish.yml

@@ -0,0 +1,86 @@
+name: CI / Publish
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[dev]"
+
+      - name: Lint with ruff
+        run: ruff check src/ tests/
+
+      - name: Type check with mypy
+        run: mypy src/hookbase
+
+      - name: Run tests
+        run: pytest -v
+
+  release-build:
+    if: github.event_name == 'release'
+    runs-on: ubuntu-latest
+    needs: test
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+
+      - name: Build release distributions
+        run: |
+          python -m pip install build
+          python -m build
+
+      - name: Upload distributions
+        uses: actions/upload-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+
+  pypi-publish:
+    if: github.event_name == 'release'
+    runs-on: ubuntu-latest
+    needs: release-build
+    permissions:
+      id-token: write
+
+    environment:
+      name: pypi
+      url: https://pypi.org/project/hookbase/${{ github.event.release.tag_name }}
+
+    steps:
+      - name: Retrieve release distributions
+        uses: actions/download-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+
+      - name: Publish release distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: dist/

{hookbase-1.0.0 → hookbase-2.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hookbase
-Version: 1.0.0
+Version: 2.1.1
 Summary: Official Python SDK for the Hookbase webhook management platform
 Project-URL: Homepage, https://hookbase.app
 Project-URL: Documentation, https://docs.hookbase.app/sdk/python
@@ -22,6 +22,7 @@ Classifier: Topic :: Internet :: WWW/HTTP
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Typing :: Typed
 Requires-Python: >=3.9
+Requires-Dist: eval-type-backport>=0.2.0; python_version < '3.10'
 Requires-Dist: httpx<1.0.0,>=0.25.0
 Requires-Dist: pydantic<3.0.0,>=2.0.0
 Provides-Extra: dev

{hookbase-1.0.0 → hookbase-2.1.1}/pyproject.toml

@@ -29,6 +29,7 @@ classifiers = [
 dependencies = [
     "httpx>=0.25.0,<1.0.0",
     "pydantic>=2.0.0,<3.0.0",
+    "eval_type_backport>=0.2.0; python_version < '3.10'",
 ]
 
 [project.optional-dependencies]

hookbase-2.1.1/src/hookbase/_version.py

@@ -0,0 +1 @@
+__version__ = "2.1.1"

{hookbase-1.0.0 → hookbase-2.1.1}/src/hookbase/client.py

@@ -25,6 +25,7 @@ from .resources import (
     AsyncMessageLog,
     AsyncMessages,
     AsyncOrganizations,
+    AsyncPortalTokens,
     AsyncRoutes,
     AsyncSchemas,
     AsyncSources,
@@ -41,6 +42,7 @@ from .resources import (
     MessageLog,
     Messages,
     Organizations,
+    PortalTokens,
     Routes,
     Schemas,
     Sources,
@@ -55,7 +57,7 @@ class _OutboundNamespace:
 
     __slots__ = (
         "applications", "endpoints", "event_types", "subscriptions",
-        "messages", "message_log", "dlq",
+        "messages", "message_log", "portal_tokens", "dlq",
     )
 
     def __init__(self, transport: SyncTransport) -> None:
@@ -65,6 +67,7 @@ class _OutboundNamespace:
         self.subscriptions = Subscriptions(transport)
         self.messages = Messages(transport)
         self.message_log = MessageLog(transport)
+        self.portal_tokens = PortalTokens(transport)
         self.dlq = DLQ(transport)
 
 
@@ -73,7 +76,7 @@ class _AsyncOutboundNamespace:
 
     __slots__ = (
         "applications", "endpoints", "event_types", "subscriptions",
-        "messages", "message_log", "dlq",
+        "messages", "message_log", "portal_tokens", "dlq",
     )
 
     def __init__(self, transport: AsyncTransport) -> None:
@@ -83,6 +86,7 @@ class _AsyncOutboundNamespace:
         self.subscriptions = AsyncSubscriptions(transport)
         self.messages = AsyncMessages(transport)
         self.message_log = AsyncMessageLog(transport)
+        self.portal_tokens = AsyncPortalTokens(transport)
         self.dlq = AsyncDLQ(transport)
 
 

{hookbase-1.0.0 → hookbase-2.1.1}/src/hookbase/models/deliveries.py

@@ -1,10 +1,12 @@
 from __future__ import annotations
 
-from typing import Any, Literal
+from typing import Any
 
 from ._base import HookbaseModel
 
-DeliveryStatus = Literal["pending", "success", "failed", "retrying"]
+# API may return: pending, success, failed, retrying, delivered,
+# failed_over, schema_failed, exhausted, etc.
+DeliveryStatus = str
 
 
 class Delivery(HookbaseModel):

{hookbase-1.0.0 → hookbase-2.1.1}/src/hookbase/models/destinations.py

@@ -1,7 +1,10 @@
 from __future__ import annotations
 
+import json
 from typing import Any, Literal
 
+from pydantic import field_validator
+
 from ._base import HookbaseModel
 
 HttpMethod = Literal["GET", "POST", "PUT", "PATCH", "DELETE"]
@@ -30,6 +33,33 @@ class Destination(HookbaseModel):
     created_at: str = ""
     updated_at: str = ""
 
+    @field_validator("headers", mode="before")
+    @classmethod
+    def parse_headers(cls, v: Any) -> Any:
+        if isinstance(v, str):
+            try:
+                return json.loads(v)
+            except (json.JSONDecodeError, ValueError):
+                return None
+        return v
+
+    @field_validator("auth_config", mode="before")
+    @classmethod
+    def parse_auth_config(cls, v: Any) -> Any:
+        if isinstance(v, str):
+            try:
+                return json.loads(v)
+            except (json.JSONDecodeError, ValueError):
+                return None
+        return v
+
+    @field_validator("is_active", mode="before")
+    @classmethod
+    def parse_is_active(cls, v: Any) -> Any:
+        if isinstance(v, int):
+            return bool(v)
+        return v
+
 
 class CreateDestinationParams(HookbaseModel):
     name: str

{hookbase-1.0.0 → hookbase-2.1.1}/src/hookbase/models/events.py

@@ -1,10 +1,13 @@
 from __future__ import annotations
 
-from typing import Any, Literal
+import json
+from typing import Any
+
+from pydantic import field_validator
 
 from ._base import HookbaseModel
 
-InboundEventStatus = Literal["delivered", "failed", "pending", "partial"]
+InboundEventStatus = str  # API may return: delivered, failed, pending, partial, schema_failed, etc.
 
 
 class DeliveryStats(HookbaseModel):
@@ -53,6 +56,16 @@ class EventDetail(HookbaseModel):
     source_name: str = ""
     deliveries: list[EventDelivery] = []
 
+    @field_validator("headers", mode="before")
+    @classmethod
+    def parse_headers(cls, v: Any) -> Any:
+        if isinstance(v, str):
+            try:
+                return json.loads(v)
+            except (json.JSONDecodeError, ValueError):
+                return {}
+        return v if v is not None else {}
+
 
 class EventDebugEvent(HookbaseModel):
     id: str
@@ -64,6 +77,16 @@ class EventDebugEvent(HookbaseModel):
     received_at: str = ""
     ip_address: str | None = None
 
+    @field_validator("headers", mode="before")
+    @classmethod
+    def parse_headers(cls, v: Any) -> Any:
+        if isinstance(v, str):
+            try:
+                return json.loads(v)
+            except (json.JSONDecodeError, ValueError):
+                return {}
+        return v if v is not None else {}
+
 
 class EventDebugInfo(HookbaseModel):
     event: EventDebugEvent

hookbase-2.1.1/src/hookbase/models/portal_tokens.py

@@ -0,0 +1,23 @@
+from __future__ import annotations
+
+from ._base import HookbaseModel
+
+
+class PortalToken(HookbaseModel):
+    id: str
+    application_id: str = ""
+    token: str | None = None
+    token_prefix: str | None = None
+    name: str | None = None
+    scopes: list[str] = []
+    expires_at: str = ""
+    created_at: str = ""
+    is_expired: bool | None = None
+    is_revoked: bool | None = None
+
+
+class CreatePortalTokenParams(HookbaseModel):
+    name: str | None = None
+    scopes: list[str] | None = None
+    expires_in_days: int | None = None
+    allowed_ips: list[str] | None = None

{hookbase-1.0.0 → hookbase-2.1.1}/src/hookbase/models/sources.py

@@ -1,6 +1,9 @@
 from __future__ import annotations
 
-from typing import Literal
+import json
+from typing import Any, Literal
+
+from pydantic import field_validator
 
 from ._base import HookbaseModel
 
@@ -31,11 +34,30 @@ class Source(HookbaseModel):
     ip_denylist: list[str] | None = None
     rate_limit: int | None = None
     rate_limit_window: int | None = None
+    transient_mode: bool = False
     event_count: int = 0
     last_event_at: str | None = None
     created_at: str = ""
     updated_at: str = ""
 
+    @field_validator("is_active", "verify_signature", "transient_mode", mode="before")
+    @classmethod
+    def parse_bool_from_int(cls, v: Any) -> Any:
+        if isinstance(v, int):
+            return bool(v)
+        return v
+
+    @field_validator("ip_allowlist", "ip_denylist", mode="before")
+    @classmethod
+    def parse_json_list(cls, v: Any) -> Any:
+        if isinstance(v, str):
+            try:
+                parsed = json.loads(v)
+                return parsed if isinstance(parsed, list) else None
+            except (json.JSONDecodeError, ValueError):
+                return None
+        return v
+
 
 class SourceWithSecret(Source):
     signing_secret: str = ""
@@ -55,6 +77,7 @@ class CreateSourceParams(HookbaseModel):
     ip_denylist: list[str] | None = None
     rate_limit: int | None = None
     rate_limit_window: int | None = None
+    transient_mode: bool | None = None
 
 
 class UpdateSourceParams(HookbaseModel):
@@ -70,3 +93,4 @@ class UpdateSourceParams(HookbaseModel):
     ip_denylist: list[str] | None = None
     rate_limit: int | None = None
     rate_limit_window: int | None = None
+    transient_mode: bool | None = None

{hookbase-1.0.0 → hookbase-2.1.1}/src/hookbase/models/transforms.py

@@ -4,7 +4,7 @@ from typing import Any, Literal
 
 from ._base import HookbaseModel
 
-TransformType = Literal["jsonata", "javascript", "mapping"]
+TransformType = Literal["jsonata", "javascript", "mapping", "liquid", "xslt"]
 ContentFormat = Literal["json", "xml", "form", "text"]
 
 

{hookbase-1.0.0 → hookbase-2.1.1}/src/hookbase/resources/__init__.py

@@ -12,6 +12,7 @@ from .filters import AsyncFilters, Filters
 from .message_log import AsyncMessageLog, MessageLog
 from .messages import AsyncMessages, Messages
 from .organizations import AsyncOrganizations, Organizations
+from .portal_tokens import AsyncPortalTokens, PortalTokens
 from .routes import AsyncRoutes, Routes
 from .schemas import AsyncSchemas, Schemas
 from .sources import AsyncSources, Sources
@@ -34,6 +35,7 @@ __all__ = [
     "MessageLog", "AsyncMessageLog",
     "Messages", "AsyncMessages",
     "Organizations", "AsyncOrganizations",
+    "PortalTokens", "AsyncPortalTokens",
     "Routes", "AsyncRoutes",
     "Schemas", "AsyncSchemas",
     "Sources", "AsyncSources",

hookbase-2.1.1/src/hookbase/resources/portal_tokens.py

@@ -0,0 +1,60 @@
+from __future__ import annotations
+
+from typing import Any
+
+from ..models.portal_tokens import CreatePortalTokenParams, PortalToken
+from ._base import AsyncResource, SyncResource, _to_body
+
+
+class PortalTokens(SyncResource):
+    def create(
+        self,
+        application_id: str,
+        params: CreatePortalTokenParams | dict[str, Any] | None = None,
+    ) -> PortalToken:
+        body = _to_body(params) if params else {}
+        resp = self._request(
+            "POST",
+            f"/api/portal/webhook-applications/{application_id}/tokens",
+            json=body,
+        )
+        data = resp.get("data", resp)
+        return self._parse(PortalToken, data)
+
+    def list(self, application_id: str) -> list[PortalToken]:
+        resp = self._request(
+            "GET",
+            f"/api/portal/webhook-applications/{application_id}/tokens",
+        )
+        items = resp.get("data", [])
+        return self._parse_list(PortalToken, items if isinstance(items, list) else [])
+
+    def revoke(self, token_id: str) -> None:
+        self._request("DELETE", f"/api/portal/tokens/{token_id}")
+
+
+class AsyncPortalTokens(AsyncResource):
+    async def create(
+        self,
+        application_id: str,
+        params: CreatePortalTokenParams | dict[str, Any] | None = None,
+    ) -> PortalToken:
+        body = _to_body(params) if params else {}
+        resp = await self._request(
+            "POST",
+            f"/api/portal/webhook-applications/{application_id}/tokens",
+            json=body,
+        )
+        data = resp.get("data", resp)
+        return self._parse(PortalToken, data)
+
+    async def list(self, application_id: str) -> list[PortalToken]:
+        resp = await self._request(
+            "GET",
+            f"/api/portal/webhook-applications/{application_id}/tokens",
+        )
+        items = resp.get("data", [])
+        return self._parse_list(PortalToken, items if isinstance(items, list) else [])
+
+    async def revoke(self, token_id: str) -> None:
+        await self._request("DELETE", f"/api/portal/tokens/{token_id}")

{hookbase-1.0.0 → hookbase-2.1.1}/tests/resources/test_sources.py

@@ -5,6 +5,7 @@ import respx
 
 from hookbase import Hookbase
 from hookbase.models import Source, SourceWithSecret
+from hookbase.models.sources import CreateSourceParams, UpdateSourceParams
 
 from ..conftest import make_paginated_response
 
@@ -110,3 +111,81 @@ def test_import_sources(mock_api, client):
     })
     result = client.sources.import_sources([SOURCE_DATA])
     assert result.imported == 1
+
+
+# --- transient_mode tests ---
+
+
+def test_source_transient_mode_defaults_false():
+    src = Source(**SOURCE_DATA)
+    assert src.transient_mode is False
+
+
+def test_source_transient_mode_true():
+    data = {**SOURCE_DATA, "transientMode": True}
+    src = Source(**data)
+    assert src.transient_mode is True
+
+
+def test_source_transient_mode_from_int():
+    """D1/SQLite returns booleans as 0/1 integers."""
+    data = {**SOURCE_DATA, "transientMode": 1}
+    src = Source(**data)
+    assert src.transient_mode is True
+
+    data_off = {**SOURCE_DATA, "transientMode": 0}
+    src_off = Source(**data_off)
+    assert src_off.transient_mode is False
+
+
+def test_source_transient_mode_serializes_as_camel():
+    src = Source(**{**SOURCE_DATA, "transientMode": True})
+    dumped = src.model_dump(by_alias=True)
+    assert "transientMode" in dumped
+    assert dumped["transientMode"] is True
+
+
+def test_create_source_with_transient_mode(mock_api, client):
+    resp_data = {**SOURCE_DATA, "transientMode": True, "signingSecret": "whsec_abc"}
+    mock_api.post("/api/sources").respond(200, json={"source": resp_data})
+    src = client.sources.create({
+        "name": "HIPAA Source",
+        "slug": "hipaa",
+        "transient_mode": True,
+    })
+    assert isinstance(src, SourceWithSecret)
+    assert src.transient_mode is True
+
+
+def test_create_source_params_serialization():
+    params = CreateSourceParams(name="test", transient_mode=True)
+    dumped = params.model_dump(by_alias=True, exclude_none=True)
+    assert dumped["transientMode"] is True
+
+
+def test_update_source_with_transient_mode(mock_api, client):
+    mock_api.patch("/api/sources/src_1").respond(204)
+    client.sources.update("src_1", {"transient_mode": True})
+
+
+def test_update_source_params_serialization():
+    params = UpdateSourceParams(transient_mode=True)
+    dumped = params.model_dump(by_alias=True, exclude_none=True)
+    assert dumped["transientMode"] is True
+    assert "name" not in dumped
+
+
+def test_get_source_with_transient_mode(mock_api, client):
+    data = {**SOURCE_DATA, "transientMode": True}
+    mock_api.get("/api/sources/src_1").respond(200, json={"source": data})
+    src = client.sources.get("src_1")
+    assert src.transient_mode is True
+
+
+def test_list_sources_with_transient_mode(mock_api, client):
+    data = {**SOURCE_DATA, "transientMode": True}
+    mock_api.get("/api/sources").respond(200, json=make_paginated_response(
+        [data], data_key="sources", total=1,
+    ))
+    page = client.sources.list()
+    assert page.data[0].transient_mode is True

hookbase-1.0.0/src/hookbase/_version.py

@@ -1 +0,0 @@
-__version__ = "1.0.0"