hookbase 2.0.0__tar.gz → 2.2.0__tar.gz

hookbase-2.2.0/.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-2.0.0 → hookbase-2.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hookbase
-Version: 2.0.0
+Version: 2.2.0
 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-2.0.0 → hookbase-2.2.0}/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.2.0/src/hookbase/_version.py

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

{hookbase-2.0.0 → hookbase-2.2.0}/src/hookbase/models/__init__.py

@@ -18,9 +18,15 @@ from .deliveries import (
 )
 from .destinations import (
     AuthType,
+    AzureBlobConfig,
     CreateDestinationParams,
     Destination,
+    DestinationType,
+    FieldMapping,
+    GCSConfig,
     HttpMethod,
+    R2Config,
+    S3Config,
     TestResult,
     UpdateDestinationParams,
 )
@@ -123,9 +129,15 @@ __all__ = [
     "ReplayResult",
     # Destinations
     "AuthType",
+    "AzureBlobConfig",
     "CreateDestinationParams",
     "Destination",
+    "DestinationType",
+    "FieldMapping",
+    "GCSConfig",
     "HttpMethod",
+    "R2Config",
+    "S3Config",
     "TestResult",
     "UpdateDestinationParams",
     # DLQ

{hookbase-2.0.0 → hookbase-2.2.0}/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 = str  # API may return: pending, success, failed, retrying, delivered, failed_over, schema_failed, exhausted, etc.
+# API may return: pending, success, failed, retrying, delivered,
+# failed_over, schema_failed, exhausted, etc.
+DeliveryStatus = str
 
 
 class Delivery(HookbaseModel):

{hookbase-2.0.0 → hookbase-2.2.0}/src/hookbase/models/destinations.py

@@ -9,6 +9,52 @@ from ._base import HookbaseModel
 
 HttpMethod = Literal["GET", "POST", "PUT", "PATCH", "DELETE"]
 AuthType = Literal["none", "basic", "bearer", "api_key", "custom_header"]
+DestinationType = Literal["http", "s3", "r2", "gcs", "azure_blob"]
+FileFormat = Literal["json", "jsonl"]
+PartitionBy = Literal["date", "hour", "source"]
+FieldMappingType = Literal["string", "number", "boolean", "timestamp", "json"]
+
+
+class FieldMapping(HookbaseModel):
+    source: str
+    target: str
+    type: FieldMappingType
+    default: str | None = None
+
+
+class S3Config(HookbaseModel):
+    bucket: str
+    region: str
+    access_key_id: str
+    secret_access_key: str
+    prefix: str | None = None
+    file_format: FileFormat | None = None
+    partition_by: PartitionBy | None = None
+
+
+class R2Config(HookbaseModel):
+    bucket: str
+    prefix: str | None = None
+    file_format: FileFormat | None = None
+    partition_by: PartitionBy | None = None
+
+
+class GCSConfig(HookbaseModel):
+    bucket: str
+    project_id: str
+    service_account_key: str
+    prefix: str | None = None
+    file_format: FileFormat | None = None
+    partition_by: PartitionBy | None = None
+
+
+class AzureBlobConfig(HookbaseModel):
+    account_name: str
+    account_key: str
+    container_name: str
+    prefix: str | None = None
+    file_format: FileFormat | None = None
+    partition_by: PartitionBy | None = None
 
 
 class Destination(HookbaseModel):
@@ -17,7 +63,8 @@ class Destination(HookbaseModel):
     name: str
     slug: str
     description: str | None = None
-    url: str
+    type: DestinationType = "http"
+    url: str = ""
     method: HttpMethod = "POST"
     headers: dict[str, str] | None = None
     auth_type: str | None = "none"
@@ -28,6 +75,8 @@ class Destination(HookbaseModel):
     rate_limit: int | None = None
     rate_limit_window: int | None = None
     is_active: bool = True
+    config: dict[str, Any] | None = None
+    field_mapping: list[FieldMapping] | None = None
     delivery_count: int = 0
     last_delivery_at: str | None = None
     created_at: str = ""
@@ -53,6 +102,26 @@ class Destination(HookbaseModel):
                 return None
         return v
 
+    @field_validator("config", mode="before")
+    @classmethod
+    def parse_config(cls, v: Any) -> Any:
+        if isinstance(v, str):
+            try:
+                return json.loads(v)
+            except (json.JSONDecodeError, ValueError):
+                return None
+        return v
+
+    @field_validator("field_mapping", mode="before")
+    @classmethod
+    def parse_field_mapping(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:
@@ -65,7 +134,8 @@ class CreateDestinationParams(HookbaseModel):
     name: str
     slug: str | None = None
     description: str | None = None
-    url: str
+    type: DestinationType | None = None
+    url: str | None = None
     method: HttpMethod | None = None
     headers: dict[str, str] | None = None
     auth_type: AuthType | None = None
@@ -75,6 +145,8 @@ class CreateDestinationParams(HookbaseModel):
     retry_interval: int | None = None
     rate_limit: int | None = None
     rate_limit_window: int | None = None
+    config: dict[str, Any] | None = None
+    field_mapping: list[FieldMapping] | None = None
 
 
 class UpdateDestinationParams(HookbaseModel):
@@ -91,6 +163,8 @@ class UpdateDestinationParams(HookbaseModel):
     rate_limit: int | None = None
     rate_limit_window: int | None = None
     is_active: bool | None = None
+    config: dict[str, Any] | None = None
+    field_mapping: list[FieldMapping] | None = None
 
 
 class TestResult(HookbaseModel):

{hookbase-2.0.0 → hookbase-2.2.0}/src/hookbase/models/events.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 import json
-from typing import Any, Literal
+from typing import Any
 
 from pydantic import field_validator
 

{hookbase-2.0.0 → hookbase-2.2.0}/src/hookbase/models/portal_tokens.py

@@ -1,7 +1,5 @@
 from __future__ import annotations
 
-from typing import Any
-
 from ._base import HookbaseModel
 
 

{hookbase-2.0.0 → hookbase-2.2.0}/src/hookbase/models/sources.py

@@ -34,12 +34,13 @@ 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", mode="before")
+    @field_validator("is_active", "verify_signature", "transient_mode", mode="before")
     @classmethod
     def parse_bool_from_int(cls, v: Any) -> Any:
         if isinstance(v, int):
@@ -76,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):
@@ -91,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-2.2.0/tests/resources/test_destinations.py

@@ -0,0 +1,193 @@
+from __future__ import annotations
+
+import pytest
+import respx
+
+from hookbase import Hookbase
+from hookbase.models import Destination, FieldMapping, TestResult
+
+from ..conftest import make_paginated_response
+
+
+@pytest.fixture
+def mock_api():
+    with respx.mock(base_url="https://api.hookbase.app") as mock:
+        yield mock
+
+
+@pytest.fixture
+def client(mock_api):
+    c = Hookbase(api_key="whr_test")
+    yield c
+    c.close()
+
+
+DEST_DATA = {
+    "id": "dst_1",
+    "organizationId": "org_1",
+    "name": "Backend",
+    "slug": "backend",
+    "type": "http",
+    "url": "https://example.com/webhooks",
+    "method": "POST",
+    "authType": "none",
+    "timeout": 30,
+    "retryCount": 3,
+    "retryInterval": 60,
+    "isActive": True,
+    "config": None,
+    "fieldMapping": None,
+    "deliveryCount": 100,
+    "createdAt": "2024-01-01T00:00:00Z",
+    "updatedAt": "2024-01-01T00:00:00Z",
+}
+
+S3_DEST_DATA = {
+    "id": "dst_s3",
+    "organizationId": "org_1",
+    "name": "S3 Archive",
+    "slug": "s3-archive",
+    "type": "s3",
+    "url": "",
+    "method": "POST",
+    "authType": "none",
+    "timeout": 30,
+    "retryCount": 3,
+    "retryInterval": 60,
+    "isActive": True,
+    "config": {
+        "bucket": "my-webhooks",
+        "region": "us-east-1",
+        "accessKeyId": "AKIAIOSFODNN7EXAMPLE",
+        "secretAccessKey": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
+        "prefix": "events/",
+        "fileFormat": "jsonl",
+        "partitionBy": "date",
+    },
+    "fieldMapping": [
+        {"source": "$.id", "target": "event_id", "type": "string"},
+        {"source": "$.payload", "target": "data", "type": "json"},
+        {"source": "$.timestamp", "target": "received_at", "type": "timestamp", "default": "now()"},
+    ],
+    "deliveryCount": 0,
+    "createdAt": "2024-01-01T00:00:00Z",
+    "updatedAt": "2024-01-01T00:00:00Z",
+}
+
+
+def test_list_destinations(mock_api, client):
+    mock_api.get("/api/destinations").respond(200, json=make_paginated_response(
+        [DEST_DATA], data_key="destinations", total=1,
+    ))
+    page = client.destinations.list()
+    assert len(page) == 1
+    assert page.data[0].name == "Backend"
+
+
+def test_get_destination(mock_api, client):
+    mock_api.get("/api/destinations/dst_1").respond(200, json={"destination": DEST_DATA})
+    dest = client.destinations.get("dst_1")
+    assert isinstance(dest, Destination)
+    assert dest.url == "https://example.com/webhooks"
+    assert dest.type == "http"
+    assert dest.config is None
+    assert dest.field_mapping is None
+
+
+def test_get_warehouse_destination(mock_api, client):
+    mock_api.get("/api/destinations/dst_s3").respond(200, json={"destination": S3_DEST_DATA})
+    dest = client.destinations.get("dst_s3")
+    assert isinstance(dest, Destination)
+    assert dest.type == "s3"
+    assert dest.config is not None
+    assert dest.config["bucket"] == "my-webhooks"
+    assert dest.config["region"] == "us-east-1"
+    assert dest.field_mapping is not None
+    assert len(dest.field_mapping) == 3
+    assert dest.field_mapping[0].source == "$.id"
+    assert dest.field_mapping[0].target == "event_id"
+    assert dest.field_mapping[0].type == "string"
+    assert dest.field_mapping[2].default == "now()"
+
+
+def test_create_destination(mock_api, client):
+    mock_api.post("/api/destinations").respond(200, json={"destination": DEST_DATA})
+    dest = client.destinations.create({"name": "Backend", "url": "https://example.com/webhooks"})
+    assert dest.id == "dst_1"
+    assert dest.type == "http"
+
+
+def test_create_warehouse_destination(mock_api, client):
+    mock_api.post("/api/destinations").respond(200, json={"destination": S3_DEST_DATA})
+    dest = client.destinations.create({
+        "name": "S3 Archive",
+        "type": "s3",
+        "config": {
+            "bucket": "my-webhooks",
+            "region": "us-east-1",
+            "accessKeyId": "AKIAIOSFODNN7EXAMPLE",
+            "secretAccessKey": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
+        },
+        "fieldMapping": [
+            {"source": "$.id", "target": "event_id", "type": "string"},
+        ],
+    })
+    assert dest.id == "dst_s3"
+    assert dest.type == "s3"
+    assert dest.config is not None
+    assert dest.field_mapping is not None
+
+
+def test_update_warehouse_destination_config(mock_api, client):
+    updated = {**S3_DEST_DATA, "config": {**S3_DEST_DATA["config"], "bucket": "new-bucket"}}
+    mock_api.patch("/api/destinations/dst_s3").respond(200, json={"destination": updated})
+    client.destinations.update("dst_s3", {
+        "config": {
+            "bucket": "new-bucket",
+            "region": "us-east-1",
+            "accessKeyId": "AKIA",
+            "secretAccessKey": "secret",
+        },
+        "fieldMapping": [
+            {"source": "$.body", "target": "payload", "type": "json"},
+        ],
+    })
+
+
+def test_field_mapping_model():
+    fm = FieldMapping(source="$.id", target="event_id", type="string")
+    assert fm.source == "$.id"
+    assert fm.target == "event_id"
+    assert fm.type == "string"
+    assert fm.default is None
+
+    fm_with_default = FieldMapping(
+        source="$.ts", target="timestamp", type="timestamp", default="now()",
+    )
+    assert fm_with_default.default == "now()"
+
+
+def test_destination_without_type_defaults():
+    """Destinations without type field should default to http."""
+    data = {
+        "id": "dst_old",
+        "name": "Old Dest",
+        "slug": "old-dest",
+        "url": "https://example.com",
+        "method": "POST",
+        "isActive": True,
+    }
+    dest = Destination(**data)
+    assert dest.type == "http"
+    assert dest.config is None
+    assert dest.field_mapping is None
+
+
+def test_test_destination(mock_api, client):
+    mock_api.post("/api/destinations/dst_1/test").respond(200, json={
+        "success": True, "statusCode": 200, "duration": 150.5,
+    })
+    result = client.destinations.test("dst_1")
+    assert isinstance(result, TestResult)
+    assert result.success is True
+    assert result.status_code == 200

{hookbase-2.0.0 → hookbase-2.2.0}/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-2.0.0/src/hookbase/_version.py

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

hookbase-2.0.0/tests/resources/test_destinations.py

@@ -1,72 +0,0 @@
-from __future__ import annotations
-
-import pytest
-import respx
-
-from hookbase import Hookbase
-from hookbase.models import Destination, TestResult
-
-from ..conftest import make_paginated_response
-
-
-@pytest.fixture
-def mock_api():
-    with respx.mock(base_url="https://api.hookbase.app") as mock:
-        yield mock
-
-
-@pytest.fixture
-def client(mock_api):
-    c = Hookbase(api_key="whr_test")
-    yield c
-    c.close()
-
-
-DEST_DATA = {
-    "id": "dst_1",
-    "organizationId": "org_1",
-    "name": "Backend",
-    "slug": "backend",
-    "url": "https://example.com/webhooks",
-    "method": "POST",
-    "authType": "none",
-    "timeout": 30,
-    "retryCount": 3,
-    "retryInterval": 60,
-    "isActive": True,
-    "deliveryCount": 100,
-    "createdAt": "2024-01-01T00:00:00Z",
-    "updatedAt": "2024-01-01T00:00:00Z",
-}
-
-
-def test_list_destinations(mock_api, client):
-    mock_api.get("/api/destinations").respond(200, json=make_paginated_response(
-        [DEST_DATA], data_key="destinations", total=1,
-    ))
-    page = client.destinations.list()
-    assert len(page) == 1
-    assert page.data[0].name == "Backend"
-
-
-def test_get_destination(mock_api, client):
-    mock_api.get("/api/destinations/dst_1").respond(200, json={"destination": DEST_DATA})
-    dest = client.destinations.get("dst_1")
-    assert isinstance(dest, Destination)
-    assert dest.url == "https://example.com/webhooks"
-
-
-def test_create_destination(mock_api, client):
-    mock_api.post("/api/destinations").respond(200, json={"destination": DEST_DATA})
-    dest = client.destinations.create({"name": "Backend", "url": "https://example.com/webhooks"})
-    assert dest.id == "dst_1"
-
-
-def test_test_destination(mock_api, client):
-    mock_api.post("/api/destinations/dst_1/test").respond(200, json={
-        "success": True, "statusCode": 200, "duration": 150.5,
-    })
-    result = client.destinations.test("dst_1")
-    assert isinstance(result, TestResult)
-    assert result.success is True
-    assert result.status_code == 200