hookbase 2.5.0__tar.gz → 2.6.0__tar.gz

{hookbase-2.5.0 → hookbase-2.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hookbase
-Version: 2.5.0
+Version: 2.6.0
 Summary: Official Python SDK for the Hookbase webhook management platform
 Project-URL: Homepage, https://hookbase.app
 Project-URL: Documentation, https://www.hookbase.app/docs/send/sdk

hookbase-2.6.0/src/hookbase/_version.py

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

{hookbase-2.5.0 → hookbase-2.6.0}/src/hookbase/models/__init__.py

@@ -26,8 +26,11 @@ from .destinations import (
     GCSConfig,
     HttpMethod,
     R2Config,
+    RateUnit,
     S3Config,
     TestResult,
+    Throttle,
+    ThrottleMode,
     UpdateDestinationParams,
 )
 from .dlq import (
@@ -137,8 +140,11 @@ __all__ = [
     "GCSConfig",
     "HttpMethod",
     "R2Config",
+    "RateUnit",
     "S3Config",
     "TestResult",
+    "Throttle",
+    "ThrottleMode",
     "UpdateDestinationParams",
     # DLQ
     "DlqBulkDeleteResult",

{hookbase-2.5.0 → hookbase-2.6.0}/src/hookbase/models/destinations.py

@@ -3,7 +3,7 @@ from __future__ import annotations
 import json
 from typing import Any, Literal
 
-from pydantic import field_validator
+from pydantic import field_validator, model_validator
 
 from ._base import HookbaseModel
 
@@ -13,6 +13,8 @@ DestinationType = Literal["http", "s3", "r2", "gcs", "azure_blob"]
 FileFormat = Literal["json", "jsonl"]
 PartitionBy = Literal["date", "hour", "source"]
 FieldMappingType = Literal["string", "number", "boolean", "timestamp", "json"]
+ThrottleMode = Literal["off", "rate", "concurrency"]
+RateUnit = Literal["second", "minute", "hour"]
 
 
 class FieldMapping(HookbaseModel):
@@ -57,6 +59,14 @@ class AzureBlobConfig(HookbaseModel):
     partition_by: PartitionBy | None = None
 
 
+class Throttle(HookbaseModel):
+    mode: ThrottleMode = "off"
+    rate_limit: int | None = None
+    rate_unit: RateUnit | None = None
+    max_concurrency: int | None = None
+    queue_limit: int | None = None
+
+
 class Destination(HookbaseModel):
     id: str
     organization_id: str | None = None
@@ -72,8 +82,7 @@ class Destination(HookbaseModel):
     timeout: int = 30
     retry_count: int = 3
     retry_interval: int = 60
-    rate_limit: int | None = None
-    rate_limit_window: int | None = None
+    throttle: Throttle | None = None
     is_active: bool = True
     use_static_ip: bool = True
     config: dict[str, Any] | None = None
@@ -85,6 +94,30 @@ class Destination(HookbaseModel):
     created_at: str = ""
     updated_at: str = ""
 
+    @model_validator(mode="before")
+    @classmethod
+    def _normalize_throttle(cls, data: Any) -> Any:
+        """Normalize the two response shapes the API uses for throttle data.
+
+        POST /api/destinations (create) and GET /api/destinations/export nest
+        throttle fields under a `throttle` object, but GET /api/destinations
+        (list) and GET /api/destinations/:id return them as flat top-level
+        `throttleMode`/`throttleRateLimit`/`throttleRateUnit`/
+        `throttleMaxConcurrency`/`throttleQueueLimit` fields (spread directly
+        from the DB row). Fold the flat shape into a nested `throttle` dict
+        so both response shapes populate the same field.
+        """
+        if isinstance(data, dict) and "throttle" not in data and "throttleMode" in data:
+            data = dict(data)
+            data["throttle"] = {
+                "mode": data.pop("throttleMode", None) or "off",
+                "rateLimit": data.pop("throttleRateLimit", None),
+                "rateUnit": data.pop("throttleRateUnit", None),
+                "maxConcurrency": data.pop("throttleMaxConcurrency", None),
+                "queueLimit": data.pop("throttleQueueLimit", None),
+            }
+        return data
+
     @field_validator("headers", mode="before")
     @classmethod
     def parse_headers(cls, v: Any) -> Any:
@@ -146,8 +179,7 @@ class CreateDestinationParams(HookbaseModel):
     timeout: int | None = None
     retry_count: int | None = None
     retry_interval: int | None = None
-    rate_limit: int | None = None
-    rate_limit_window: int | None = None
+    throttle: Throttle | None = None
     config: dict[str, Any] | None = None
     field_mapping: list[FieldMapping] | None = None
     use_static_ip: bool | None = None
@@ -166,8 +198,7 @@ class UpdateDestinationParams(HookbaseModel):
     timeout: int | None = None
     retry_count: int | None = None
     retry_interval: int | None = None
-    rate_limit: int | None = None
-    rate_limit_window: int | None = None
+    throttle: Throttle | None = None
     is_active: bool | None = None
     config: dict[str, Any] | None = None
     field_mapping: list[FieldMapping] | None = None

{hookbase-2.5.0 → hookbase-2.6.0}/tests/resources/test_destinations.py

@@ -4,7 +4,14 @@ import pytest
 import respx
 
 from hookbase import Hookbase
-from hookbase.models import Destination, FieldMapping, TestResult
+from hookbase.models import (
+    CreateDestinationParams,
+    Destination,
+    FieldMapping,
+    TestResult,
+    Throttle,
+    UpdateDestinationParams,
+)
 
 from ..conftest import make_paginated_response
 
@@ -183,6 +190,87 @@ def test_destination_without_type_defaults():
     assert dest.field_mapping is None
 
 
+def test_throttle_model():
+    throttle = Throttle(mode="rate", rate_limit=10, rate_unit="minute")
+    assert throttle.mode == "rate"
+    assert throttle.rate_limit == 10
+    assert throttle.rate_unit == "minute"
+    assert throttle.max_concurrency is None
+    assert throttle.queue_limit is None
+
+    default_throttle = Throttle()
+    assert default_throttle.mode == "off"
+
+
+def test_create_destination_response_nests_throttle(mock_api, client):
+    """POST /api/destinations nests throttle fields under `throttle`."""
+    data = {
+        **DEST_DATA,
+        "throttle": {
+            "mode": "rate",
+            "rateLimit": 100,
+            "rateUnit": "minute",
+            "maxConcurrency": None,
+            "queueLimit": 50,
+        },
+    }
+    mock_api.post("/api/destinations").respond(200, json={"destination": data})
+    dest = client.destinations.create({"name": "Backend", "url": "https://example.com/webhooks"})
+    assert dest.throttle is not None
+    assert dest.throttle.mode == "rate"
+    assert dest.throttle.rate_limit == 100
+    assert dest.throttle.rate_unit == "minute"
+    assert dest.throttle.max_concurrency is None
+    assert dest.throttle.queue_limit == 50
+
+
+def test_get_destination_response_has_flat_throttle_fields(mock_api, client):
+    """GET /api/destinations/:id returns throttle fields flat (spread from the
+    DB row) rather than nested under `throttle`; the model must normalize
+    this into the same `throttle` field used by the create/export shape."""
+    data = {
+        **DEST_DATA,
+        "throttleMode": "concurrency",
+        "throttleRateLimit": None,
+        "throttleRateUnit": None,
+        "throttleMaxConcurrency": 5,
+        "throttleQueueLimit": None,
+    }
+    mock_api.get("/api/destinations/dst_1").respond(200, json={"destination": data})
+    dest = client.destinations.get("dst_1")
+    assert dest.throttle is not None
+    assert dest.throttle.mode == "concurrency"
+    assert dest.throttle.max_concurrency == 5
+    assert dest.throttle.rate_limit is None
+
+
+def test_destination_without_throttle_data():
+    dest = Destination(**DEST_DATA)
+    assert dest.throttle is None
+
+
+def test_create_destination_params_throttle_serializes_camelcase():
+    params = CreateDestinationParams(
+        name="Backend",
+        url="https://example.com/webhooks",
+        throttle=Throttle(mode="rate", rate_limit=10, rate_unit="minute"),
+    )
+    body = params.model_dump(by_alias=True, exclude_none=True)
+    assert body["throttle"] == {"mode": "rate", "rateLimit": 10, "rateUnit": "minute"}
+
+
+def test_update_destination_params_throttle_serializes_camelcase():
+    params = UpdateDestinationParams(
+        throttle=Throttle(mode="concurrency", max_concurrency=25, queue_limit=100),
+    )
+    body = params.model_dump(by_alias=True, exclude_none=True)
+    assert body["throttle"] == {
+        "mode": "concurrency",
+        "maxConcurrency": 25,
+        "queueLimit": 100,
+    }
+
+
 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,

hookbase-2.5.0/src/hookbase/_version.py

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