diffio 0.1.1__tar.gz → 0.1.2__tar.gz

{diffio-0.1.1/src/diffio.egg-info → diffio-0.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: diffio
-Version: 0.1.1
+Version: 0.1.2
 Summary: Python SDK for the Diffio API.
 Author: Diffio
 License: MIT
@@ -19,6 +19,7 @@ Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: httpx>=0.24.0
+Requires-Dist: svix<2.0.0,>=1.84.1
 Provides-Extra: dev
 Requires-Dist: build>=1.0; extra == "dev"
 Requires-Dist: pytest>=7.4; extra == "dev"
@@ -45,17 +46,11 @@ pip install -e .
 
 ## Configuration
 
-Set the API key with `DIFFIO_API_KEY`. You can also override the base URL with `DIFFIO_API_BASE_URL`.
+Set the API key with `DIFFIO_API_KEY`. If you need to set the base URL explicitly, use the production endpoint with `DIFFIO_API_BASE_URL`.
 
 ```bash
 export DIFFIO_API_KEY="diffio_live_..."
-export DIFFIO_API_BASE_URL="https://us-central1-diffioai.cloudfunctions.net"
-```
-
-For emulators, set the base URL to the Functions emulator host.
-
-```bash
-export DIFFIO_API_BASE_URL="http://127.0.0.1:5001/diffioai/us-central1"
+export DIFFIO_API_BASE_URL="https://us-central1-diffioai.cloudfunctions.net/v1"
 ```
 
 ## Request options
@@ -194,16 +189,6 @@ for generation in generations.generations:
     print(generation.generationId, generation.status)
 ```
 
-## Webhooks portal access
-
-```py
-from diffio import DiffioClient
-
-client = DiffioClient(apiKey="diffio_live_...")
-portal = client.webhooks.get_portal_access(mode="test")
-print(portal.portalUrl)
-```
-
 ## Send a test webhook event
 
 ```py
@@ -212,13 +197,41 @@ from diffio import DiffioClient
 client = DiffioClient(apiKey="diffio_live_...")
 event = client.webhooks.send_test_event(
     eventType="generation.completed",
-    mode="test",
+    mode="live",
     samplePayload={"apiProjectId": "proj_123"},
 )
 
 print(event.svixMessageId)
 ```
 
+## Verify webhook signatures
+
+Use the raw request body (bytes) plus the `svix-*` headers and your webhook signing secret.
+
+```py
+from fastapi import FastAPI, Request, HTTPException
+from diffio import DiffioClient
+import os
+
+app = FastAPI()
+client = DiffioClient(apiKey=os.environ["DIFFIO_API_KEY"])
+
+@app.post("/webhooks/diffio")
+async def diffio_webhook(request: Request):
+    payload = await request.body()
+    headers = request.headers
+    try:
+        event = client.webhooks.verify_signature(
+            payload=payload,
+            headers=headers,
+            secret=os.environ["DIFFIO_WEBHOOK_SECRET"],
+        )
+    except Exception:
+        raise HTTPException(status_code=400, detail="Invalid signature")
+    print("Webhook received", event.eventType)
+    return {"ok": True}
+```
+
 ## Tutorials
 
 * Audio restoration CLI tutorial: `tutorials/audio-restoration-cli/README.md`

{diffio-0.1.1 → diffio-0.1.2}/README.md

@@ -18,17 +18,11 @@ pip install -e .
 
 ## Configuration
 
-Set the API key with `DIFFIO_API_KEY`. You can also override the base URL with `DIFFIO_API_BASE_URL`.
+Set the API key with `DIFFIO_API_KEY`. If you need to set the base URL explicitly, use the production endpoint with `DIFFIO_API_BASE_URL`.
 
 ```bash
 export DIFFIO_API_KEY="diffio_live_..."
-export DIFFIO_API_BASE_URL="https://us-central1-diffioai.cloudfunctions.net"
-```
-
-For emulators, set the base URL to the Functions emulator host.
-
-```bash
-export DIFFIO_API_BASE_URL="http://127.0.0.1:5001/diffioai/us-central1"
+export DIFFIO_API_BASE_URL="https://us-central1-diffioai.cloudfunctions.net/v1"
 ```
 
 ## Request options
@@ -167,16 +161,6 @@ for generation in generations.generations:
     print(generation.generationId, generation.status)
 ```
 
-## Webhooks portal access
-
-```py
-from diffio import DiffioClient
-
-client = DiffioClient(apiKey="diffio_live_...")
-portal = client.webhooks.get_portal_access(mode="test")
-print(portal.portalUrl)
-```
-
 ## Send a test webhook event
 
 ```py
@@ -185,13 +169,41 @@ from diffio import DiffioClient
 client = DiffioClient(apiKey="diffio_live_...")
 event = client.webhooks.send_test_event(
     eventType="generation.completed",
-    mode="test",
+    mode="live",
     samplePayload={"apiProjectId": "proj_123"},
 )
 
 print(event.svixMessageId)
 ```
 
+## Verify webhook signatures
+
+Use the raw request body (bytes) plus the `svix-*` headers and your webhook signing secret.
+
+```py
+from fastapi import FastAPI, Request, HTTPException
+from diffio import DiffioClient
+import os
+
+app = FastAPI()
+client = DiffioClient(apiKey=os.environ["DIFFIO_API_KEY"])
+
+@app.post("/webhooks/diffio")
+async def diffio_webhook(request: Request):
+    payload = await request.body()
+    headers = request.headers
+    try:
+        event = client.webhooks.verify_signature(
+            payload=payload,
+            headers=headers,
+            secret=os.environ["DIFFIO_WEBHOOK_SECRET"],
+        )
+    except Exception:
+        raise HTTPException(status_code=400, detail="Invalid signature")
+    print("Webhook received", event.eventType)
+    return {"ok": True}
+```
+
 ## Tutorials
 
 * Audio restoration CLI tutorial: `tutorials/audio-restoration-cli/README.md`

{diffio-0.1.1 → diffio-0.1.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "diffio"
-version = "0.1.1"
+version = "0.1.2"
 description = "Python SDK for the Diffio API."
 readme = "README.md"
 requires-python = ">=3.8"
@@ -13,7 +13,8 @@ authors = [
     { name = "Diffio" }
 ]
 dependencies = [
-    "httpx>=0.24.0"
+    "httpx>=0.24.0",
+    "svix>=1.84.1,<2.0.0"
 ]
 classifiers = [
     "License :: OSI Approved :: MIT License",

{diffio-0.1.1 → diffio-0.1.2}/src/diffio/__init__.py

@@ -24,7 +24,6 @@ from .types import (
     ProjectSummary,
     WebhookEventType,
     WebhookMode,
-    WebhookPortalResponse,
     WebhookTestEventResponse,
 )
 
@@ -51,9 +50,8 @@ __all__ = [
     "RequestOptions",
     "WebhookEventType",
     "WebhookMode",
-    "WebhookPortalResponse",
     "WebhookTestEventResponse",
     "WebhooksClient",
 ]
 
-__version__ = "0.1.0"
+__version__ = "0.1.2"

{diffio-0.1.1 → diffio-0.1.2}/src/diffio/client.py

@@ -7,6 +7,7 @@ import warnings
 from urllib.parse import urlparse
 
 import httpx
+from svix.webhooks import Webhook
 
 from .errors import DiffioApiError
 from .types import (
@@ -16,12 +17,12 @@ from .types import (
     DownloadType,
     GenerationDownloadResponse,
     GenerationProgressResponse,
+    GenerationWebhookEvent,
     ListProjectGenerationsResponse,
     ListProjectsResponse,
     ModelKey,
     WebhookEventType,
     WebhookMode,
-    WebhookPortalResponse,
     WebhookTestEventResponse,
 )
 
@@ -100,6 +101,35 @@ def _merge_request_options(base_options, override_options):
     )
 
 
+def _normalize_svix_headers(headers):
+    normalized = {}
+    if headers is None:
+        return normalized
+    if not hasattr(headers, "items"):
+        raise ValueError("headers must be a dict-like object")
+    for key, value in headers.items():
+        if value is None:
+            continue
+        if isinstance(value, (list, tuple)):
+            normalized[str(key).lower()] = ",".join([str(item) for item in value])
+        else:
+            normalized[str(key).lower()] = str(value)
+    return normalized
+
+
+def _extract_svix_headers(headers):
+    normalized = _normalize_svix_headers(headers)
+    required = ["svix-id", "svix-timestamp", "svix-signature"]
+    missing = [header for header in required if not normalized.get(header)]
+    if missing:
+        raise DiffioApiError(f"Missing webhook headers: {', '.join(missing)}")
+    return {
+        "svix-id": normalized["svix-id"],
+        "svix-timestamp": normalized["svix-timestamp"],
+        "svix-signature": normalized["svix-signature"],
+    }
+
+
 def _default_request_options():
     return RequestOptions(
         headers={},
@@ -496,42 +526,6 @@ class DiffioClient:
         )
         return GenerationDownloadResponse.from_dict(response)
 
-    def get_webhooks_portal_access(
-        self,
-        *,
-        mode,
-        apiKeyId=None,
-        requestOptions=None,
-    ):
-        """
-        Gets the Svix App Portal URL for configuring webhooks.
-
-        Parameters
-        ----------
-        mode : str
-            Webhook mode, test or live.
-        apiKeyId : str, optional
-            Optional API key id to validate access.
-
-        Returns
-        -------
-        WebhookPortalResponse
-            App portal URL and mode.
-        """
-        if mode not in WebhookMode:
-            raise ValueError("mode must be test or live")
-        payload = {"mode": mode}
-        if apiKeyId is not None:
-            payload["apiKeyId"] = apiKeyId
-
-        response = self._request(
-            "POST",
-            "webhooks/app_portal_access",
-            json_payload=payload,
-            requestOptions=requestOptions,
-        )
-        return WebhookPortalResponse.from_dict(response)
-
     def send_webhook_test_event(
         self,
         *,
@@ -841,19 +835,6 @@ class WebhooksClient:
     def __init__(self, parent):
         self._parent = parent
 
-    def get_portal_access(
-        self,
-        *,
-        mode,
-        apiKeyId=None,
-        requestOptions=None,
-    ):
-        return self._parent.get_webhooks_portal_access(
-            mode=mode,
-            apiKeyId=apiKeyId,
-            requestOptions=requestOptions,
-        )
-
     def send_test_event(
         self,
         *,
@@ -871,6 +852,29 @@ class WebhooksClient:
             requestOptions=requestOptions,
         )
 
+    def verify_signature(
+        self,
+        *,
+        payload,
+        headers,
+        secret,
+    ):
+        if not secret:
+            raise DiffioApiError("secret is required")
+        if payload is None:
+            raise DiffioApiError("payload is required")
+        if not isinstance(payload, (bytes, str)):
+            raise DiffioApiError("payload must be bytes or str")
+
+        webhook = Webhook(secret)
+        try:
+            event = webhook.verify(payload, _extract_svix_headers(headers))
+        except Exception as exc:
+            raise DiffioApiError(str(exc))
+        if not isinstance(event, dict):
+            raise DiffioApiError("Webhook payload must be an object")
+        return GenerationWebhookEvent.from_dict(event)
+
 
 class AudioIsolationClient:
     def __init__(self, parent):

{diffio-0.1.1 → diffio-0.1.2}/src/diffio/types.py

@@ -237,21 +237,6 @@ class GenerationDownloadResponse:
         )
 
 
-class WebhookPortalResponse:
-    def __init__(self, portalUrl, mode, apiKeyId=None):
-        self.portalUrl = portalUrl
-        self.mode = mode
-        self.apiKeyId = apiKeyId
-
-    @classmethod
-    def from_dict(cls, data):
-        return cls(
-            portalUrl=data["portalUrl"],
-            mode=data.get("mode"),
-            apiKeyId=data.get("apiKeyId"),
-        )
-
-
 class WebhookTestEventResponse:
     def __init__(self, svixMessageId, eventId, eventType, mode, apiKeyId=None):
         self.svixMessageId = svixMessageId

{diffio-0.1.1 → diffio-0.1.2/src/diffio.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: diffio
-Version: 0.1.1
+Version: 0.1.2
 Summary: Python SDK for the Diffio API.
 Author: Diffio
 License: MIT
@@ -19,6 +19,7 @@ Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: httpx>=0.24.0
+Requires-Dist: svix<2.0.0,>=1.84.1
 Provides-Extra: dev
 Requires-Dist: build>=1.0; extra == "dev"
 Requires-Dist: pytest>=7.4; extra == "dev"
@@ -45,17 +46,11 @@ pip install -e .
 
 ## Configuration
 
-Set the API key with `DIFFIO_API_KEY`. You can also override the base URL with `DIFFIO_API_BASE_URL`.
+Set the API key with `DIFFIO_API_KEY`. If you need to set the base URL explicitly, use the production endpoint with `DIFFIO_API_BASE_URL`.
 
 ```bash
 export DIFFIO_API_KEY="diffio_live_..."
-export DIFFIO_API_BASE_URL="https://us-central1-diffioai.cloudfunctions.net"
-```
-
-For emulators, set the base URL to the Functions emulator host.
-
-```bash
-export DIFFIO_API_BASE_URL="http://127.0.0.1:5001/diffioai/us-central1"
+export DIFFIO_API_BASE_URL="https://us-central1-diffioai.cloudfunctions.net/v1"
 ```
 
 ## Request options
@@ -194,16 +189,6 @@ for generation in generations.generations:
     print(generation.generationId, generation.status)
 ```
 
-## Webhooks portal access
-
-```py
-from diffio import DiffioClient
-
-client = DiffioClient(apiKey="diffio_live_...")
-portal = client.webhooks.get_portal_access(mode="test")
-print(portal.portalUrl)
-```
-
 ## Send a test webhook event
 
 ```py
@@ -212,13 +197,41 @@ from diffio import DiffioClient
 client = DiffioClient(apiKey="diffio_live_...")
 event = client.webhooks.send_test_event(
     eventType="generation.completed",
-    mode="test",
+    mode="live",
     samplePayload={"apiProjectId": "proj_123"},
 )
 
 print(event.svixMessageId)
 ```
 
+## Verify webhook signatures
+
+Use the raw request body (bytes) plus the `svix-*` headers and your webhook signing secret.
+
+```py
+from fastapi import FastAPI, Request, HTTPException
+from diffio import DiffioClient
+import os
+
+app = FastAPI()
+client = DiffioClient(apiKey=os.environ["DIFFIO_API_KEY"])
+
+@app.post("/webhooks/diffio")
+async def diffio_webhook(request: Request):
+    payload = await request.body()
+    headers = request.headers
+    try:
+        event = client.webhooks.verify_signature(
+            payload=payload,
+            headers=headers,
+            secret=os.environ["DIFFIO_WEBHOOK_SECRET"],
+        )
+    except Exception:
+        raise HTTPException(status_code=400, detail="Invalid signature")
+    print("Webhook received", event.eventType)
+    return {"ok": True}
+```
+
 ## Tutorials
 
 * Audio restoration CLI tutorial: `tutorials/audio-restoration-cli/README.md`

{diffio-0.1.1 → diffio-0.1.2}/src/diffio.egg-info/requires.txt

@@ -1,4 +1,5 @@
 httpx>=0.24.0
+svix<2.0.0,>=1.84.1
 
 [dev]
 build>=1.0

{diffio-0.1.1 → diffio-0.1.2}/tests/test_client.py

@@ -660,35 +660,6 @@ def test_list_project_generations_payload_and_response():
     assert response.generations[0].progress is None
 
 
-def test_webhooks_portal_access_payload_and_response():
-    received = {}
-
-    def handler(request: httpx.Request) -> httpx.Response:
-        received["path"] = request.url.path
-        payload = json.loads(request.content.decode("utf-8"))
-        received["payload"] = payload
-        return httpx.Response(
-            200,
-            json={
-                "portalUrl": "https://app.svix.com/app-portal/test",
-                "mode": "test",
-                "apiKeyId": "key_123",
-            },
-        )
-
-    transport = httpx.MockTransport(handler)
-    http_client = httpx.Client(base_url="https://api.test", transport=transport)
-    client = DiffioClient(apiKey="diffio_live_test", baseUrl="https://api.test", httpClient=http_client)
-
-    response = client.webhooks.get_portal_access(mode="test", apiKeyId="key_123")
-
-    assert received["path"] == "/v1/webhooks/app_portal_access"
-    assert received["payload"]["mode"] == "test"
-    assert received["payload"]["apiKeyId"] == "key_123"
-    assert response.portalUrl == "https://app.svix.com/app-portal/test"
-    assert response.mode == "test"
-
-
 def test_webhooks_send_test_event_payload_and_response():
     received = {}
 
@@ -702,7 +673,7 @@ def test_webhooks_send_test_event_payload_and_response():
                 "svixMessageId": "msg_123",
                 "eventId": "evt_123",
                 "eventType": "generation.completed",
-                "mode": "test",
+                "mode": "live",
                 "apiKeyId": "key_123",
             },
         )
@@ -713,14 +684,14 @@ def test_webhooks_send_test_event_payload_and_response():
 
     response = client.webhooks.send_test_event(
         eventType="generation.completed",
-        mode="test",
+        mode="live",
         apiKeyId="key_123",
         samplePayload={"apiProjectId": "proj_123"},
     )
 
     assert received["path"] == "/v1/webhooks/send_test_event"
     assert received["payload"]["eventType"] == "generation.completed"
-    assert received["payload"]["mode"] == "test"
+    assert received["payload"]["mode"] == "live"
     assert received["payload"]["apiKeyId"] == "key_123"
     assert received["payload"]["samplePayload"]["apiProjectId"] == "proj_123"
     assert response.svixMessageId == "msg_123"