relay-python-sdk 0.1.0__py3-none-any.whl

relay_python/__init__.py

@@ -0,0 +1,14 @@
+"""Official Python SDK for Relay."""
+from .client import Relay
+from .exceptions import (
+    AuthenticationError,
+    NotFoundError,
+    RateLimitError,
+    RelayError,
+    ServerError,
+    ValidationError,
+)
+from .models import Delivery, Endpoint, Event
+
+__version__ = "0.1.0"
+__all__ = ["Relay", "Event", "Endpoint", "Delivery", "RelayError", "AuthenticationError", "NotFoundError", "ValidationError", "RateLimitError", "ServerError"]

relay_python/_http.py

@@ -0,0 +1,50 @@
+"""Internal HTTP transport."""
+from typing import Any
+
+import httpx
+
+from .exceptions import _raise_for_status
+
+
+class HttpTransport:
+    """Thin wrapper over httpx.Client with error mapping."""
+
+    def __init__(self, base_url: str, api_key: str, timeout: float) -> None:
+        self._client = httpx.Client(
+            base_url=base_url.rstrip("/"),
+            headers={
+                "Authorization": f"Bearer {api_key}",
+                "User-Agent": "relay-python/0.1.0",
+                "Content-Type": "application/json",
+            },
+            timeout=timeout,
+        )
+
+    def close(self) -> None:
+        self._client.close()
+
+    def request(
+        self,
+        method: str,
+        path: str,
+        *,
+        json: Any = None,
+        headers: dict[str, str] | None = None,
+    ) -> dict[str, Any]:
+        resp = self._client.request(method, path, json=json, headers=headers)
+        body: dict[str, Any] = {}
+        if resp.content:
+            try:
+                body = resp.json()
+            except ValueError:
+                body = {}
+        code = body.get("code") if isinstance(body, dict) else None
+        message = body.get("error") or resp.text or resp.reason_phrase
+        _raise_for_status(resp.status_code, code, message)
+        return body
+
+    def __enter__(self) -> "HttpTransport":
+        return self
+
+    def __exit__(self, *args: Any) -> None:
+        self.close()

relay_python/client.py

@@ -0,0 +1,136 @@
+"""Main Relay SDK client."""
+from typing import Any
+
+from . import exceptions
+from ._http import HttpTransport
+from .models import Delivery, Endpoint
+
+
+class Relay:
+    """Client for the Relay webhook delivery API.
+
+    Example:
+        >>> client = Relay(api_key="...", base_url="http://localhost:8080")
+        >>> event = client.send_event(
+        ...     source="stripe",
+        ...     event_type="payment.completed",
+        ...     data={"amount": 5000},
+        ...     idempotency_key="order-123",
+        ... )
+    """
+
+    def __init__(
+        self,
+        api_key: str,
+        *,
+        base_url: str = "http://localhost:8080",
+        timeout: float = 30.0,
+    ) -> None:
+        if not api_key:
+            raise exceptions.AuthenticationError(
+                "api_key must be provided", status=401
+            )
+        self._http = HttpTransport(base_url, api_key, timeout)
+
+    # ============ Events ============
+
+    def send_event(
+        self,
+        *,
+        source: str,
+        event_type: str,
+        data: dict[str, Any],
+        idempotency_key: str | None = None,
+    ) -> dict[str, Any]:
+        """Submit an event for delivery."""
+        headers: dict[str, str] = {}
+        if idempotency_key:
+            headers["Idempotency-Key"] = idempotency_key
+        return self._http.request(
+            "POST",
+            "/v1/events",
+            json={"source": source, "event_type": event_type, "data": data},
+            headers=headers,
+        )
+
+    def replay_event(self, event_id: str) -> dict[str, Any]:
+        """Replay a previously failed event."""
+        return self._http.request("POST", f"/v1/events/{event_id}/replay")
+
+    def get_deliveries(self, event_id: str) -> list[Delivery]:
+        """Get all delivery attempts for an event."""
+        body = self._http.request("GET", f"/v1/events/{event_id}/deliveries")
+        items = body.get("deliveries") or body.get("items") or []
+        return [Delivery.from_dict(d) for d in items]
+
+    def get_attempts(self, event_id: str) -> list[dict[str, Any]]:
+        """Get detailed attempt history for an event."""
+        body = self._http.request("GET", f"/v1/events/{event_id}/attempts")
+        attempts: list[dict[str, Any]] = body.get("attempts", [])
+        return attempts
+
+    # ============ Endpoints ============
+
+    def list_endpoints(self) -> list[Endpoint]:
+        """List all registered webhook endpoints."""
+        body = self._http.request("GET", "/v1/endpoints")
+        items = body.get("endpoints") or body.get("items") or []
+        return [Endpoint.from_dict(e) for e in items]
+
+    def get_endpoint(self, endpoint_id: str) -> Endpoint:
+        """Get a single endpoint by ID."""
+        body = self._http.request("GET", f"/v1/endpoints/{endpoint_id}")
+        return Endpoint.from_dict(body)
+
+    def create_endpoint(
+        self,
+        *,
+        url: str,
+        event_types: list[str] | None = None,
+        secret: str | None = None,
+    ) -> Endpoint:
+        """Register a new webhook endpoint."""
+        payload: dict[str, Any] = {"url": url}
+        if event_types:
+            payload["event_types"] = event_types
+        if secret:
+            payload["secret"] = secret
+        body = self._http.request("POST", "/v1/endpoints", json=payload)
+        return Endpoint.from_dict(body)
+
+    def update_endpoint(
+        self,
+        endpoint_id: str,
+        *,
+        url: str | None = None,
+        enabled: bool | None = None,
+        event_types: list[str] | None = None,
+    ) -> Endpoint:
+        """Update an existing endpoint."""
+        payload: dict[str, Any] = {}
+        if url is not None:
+            payload["url"] = url
+        if enabled is not None:
+            payload["enabled"] = enabled
+        if event_types is not None:
+            payload["event_types"] = event_types
+        body = self._http.request(
+            "PATCH", f"/v1/endpoints/{endpoint_id}", json=payload
+        )
+        return Endpoint.from_dict(body)
+
+    def disable_endpoint(self, endpoint_id: str) -> None:
+        """Soft-delete (disable) an endpoint."""
+        self._http.request("DELETE", f"/v1/endpoints/{endpoint_id}")
+
+    # ============ Lifecycle ============
+
+    def close(self) -> None:
+        """Close the underlying HTTP client."""
+        self._http.close()
+
+    def __enter__(self) -> "Relay":
+        return self
+
+    def __exit__(self, *args: Any) -> None:
+        self.close()

relay_python/exceptions.py

@@ -0,0 +1,69 @@
+"""Exception hierarchy for the Relay SDK."""
+
+
+class RelayError(Exception):
+    """Base exception for all Relay SDK errors."""
+
+    def __init__(
+        self,
+        message: str,
+        *,
+        status: int | None = None,
+        code: str | None = None,
+    ) -> None:
+        super().__init__(message)
+        self.message = message
+        self.status = status
+        self.code = code
+
+    def __repr__(self) -> str:
+        parts = [f"message={self.message!r}"]
+        if self.status is not None:
+            parts.append(f"status={self.status}")
+        if self.code:
+            parts.append(f"code={self.code!r}")
+        return f"{self.__class__.__name__}({', '.join(parts)})"
+
+
+class AuthenticationError(RelayError):
+    """401/403 — Invalid or missing API key."""
+
+
+class NotFoundError(RelayError):
+    """404 — Resource does not exist."""
+
+
+class ValidationError(RelayError):
+    """400/409 — Request body or parameters are invalid."""
+
+
+class RateLimitError(RelayError):
+    """429 — Rate limit exceeded."""
+
+
+class ServerError(RelayError):
+    """5xx — Server-side error."""
+
+
+def _raise_for_status(status: int, code: str | None, message: str) -> None:
+    """Raise the appropriate exception based on HTTP status code."""
+    if 200 <= status < 300:
+        return
+
+    status_map: dict[int, type[RelayError]] = {
+        400: ValidationError,
+        401: AuthenticationError,
+        403: AuthenticationError,
+        404: NotFoundError,
+        409: ValidationError,
+        429: RateLimitError,
+    }
+
+    if status in status_map:
+        exc_cls = status_map[status]
+    elif status >= 500:
+        exc_cls = ServerError
+    else:
+        exc_cls = RelayError
+
+    raise exc_cls(message, status=status, code=code)

relay_python/models.py

@@ -0,0 +1,79 @@
+"""Data models for the Relay SDK."""
+from dataclasses import dataclass
+from datetime import datetime
+from typing import Any
+
+
+def _parse_dt(value: str | None) -> datetime | None:
+    if not value:
+        return None
+    return datetime.fromisoformat(value.replace("Z", "+00:00"))
+
+
+@dataclass(frozen=True)
+class Event:
+    """A webhook event submitted to Relay."""
+
+    id: str
+    source: str
+    event_type: str
+    data: dict[str, Any]
+    status: str
+    created_at: datetime
+
+    @classmethod
+    def from_dict(cls, d: dict[str, Any]) -> "Event":
+        return cls(
+            id=d["id"],
+            source=d["source"],
+            event_type=d["event_type"],
+            data=d.get("data", {}),
+            status=d["status"],
+            created_at=_parse_dt(d["created_at"]) or datetime.now(),
+        )
+
+
+@dataclass(frozen=True)
+class Endpoint:
+    """A downstream webhook destination."""
+
+    id: str
+    url: str
+    enabled: bool
+    event_types: list[str]
+    created_at: datetime
+
+    @classmethod
+    def from_dict(cls, d: dict[str, Any]) -> "Endpoint":
+        return cls(
+            id=d["id"],
+            url=d["url"],
+            enabled=d.get("enabled", True),
+            event_types=d.get("event_types", []),
+            created_at=_parse_dt(d["created_at"]) or datetime.now(),
+        )
+
+
+@dataclass(frozen=True)
+class Delivery:
+    """A delivery attempt of an event to an endpoint."""
+
+    id: str
+    event_id: str
+    endpoint_id: str
+    status: str
+    response_status: int | None
+    attempt_count: int
+    next_retry_at: datetime | None
+
+    @classmethod
+    def from_dict(cls, d: dict[str, Any]) -> "Delivery":
+        return cls(
+            id=d["id"],
+            event_id=d["event_id"],
+            endpoint_id=d["endpoint_id"],
+            status=d["status"],
+            response_status=d.get("response_status"),
+            attempt_count=d.get("attempt_count", 0),
+            next_retry_at=_parse_dt(d.get("next_retry_at")),
+        )

relay_python_sdk-0.1.0.dist-info/METADATA

@@ -0,0 +1,27 @@
+Metadata-Version: 2.5
+Name: relay-python-sdk
+Version: 0.1.0
+Summary: Official Python SDK for Relay webhook delivery infrastructure
+Project-URL: Homepage, https://github.com/rajputomsingh/Relay
+Author-email: relay-python-sdk <omchouhan227@gmail.com>
+License: Apache-2.0
+License-File: LICENSE
+Keywords: relay,webhook-delivery,webhooks
+Classifier: Development Status :: 4 - Beta
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: httpx>=0.27.0
+Provides-Extra: dev
+Requires-Dist: build>=1.2; extra == 'dev'
+Requires-Dist: mypy>=1.11; extra == 'dev'
+Requires-Dist: pytest-httpx>=0.33; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff>=0.6; extra == 'dev'
+Requires-Dist: twine>=5.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# relay-python-sdk
+
+Official Python SDK for [Relay](https://github.com/rajputomsingh/Relay).

relay_python_sdk-0.1.0.dist-info/RECORD

@@ -0,0 +1,9 @@
+relay_python/__init__.py,sha256=0ly0xjgGLvYCoR1LspLM8OMjgeY5s5CFdYB8UOApxDA,441
+relay_python/_http.py,sha256=QjJlA90G9Uwr0OyTVqICYW3hQOYIVktdYMnfH9_UB2M,1422
+relay_python/client.py,sha256=l4xexXLJ5k2akM1oKpIhvQhWPv3ugEuVDKUxKq5Fr50,4437
+relay_python/exceptions.py,sha256=fXjSSVp7azT0hszAKkIPT6g3S8wRck0jvR5UAw2MwnI,1750
+relay_python/models.py,sha256=JE-Y24CUTgzO8pRkLyrLUj2zuFBwRjo0G_5z0d6ZjCo,1980
+relay_python_sdk-0.1.0.dist-info/METADATA,sha256=BLYaQdXTBlshjxRH8MmJbeKzsLRC1IxU_kYZaBF9-EE,981
+relay_python_sdk-0.1.0.dist-info/WHEEL,sha256=2iZrJkDIkeDh0k9SikKMqFuRP-ua6mb4Ir1AsER4BEw,87
+relay_python_sdk-0.1.0.dist-info/licenses/LICENSE,sha256=hpmDtDm0RtcimwZUVlpdL4rUpvQPnzhdllTRGra7844,11563
+relay_python_sdk-0.1.0.dist-info/RECORD,,

relay_python_sdk-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.33.0
+Root-Is-Purelib: true
+Tag: py3-none-any

relay_python_sdk-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.