hyperping 1.4.1__tar.gz → 1.6.0__tar.gz

{hyperping-1.4.1 → hyperping-1.6.0}/CHANGELOG.md

@@ -5,6 +5,48 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.6.0] - 2026-05-06
+
+### Added
+
+- Per-endpoint circuit breaker option (`per_endpoint_circuit_breaker: bool = False`) on
+  `HyperpingClient` and `AsyncHyperpingClient`. When enabled, each `Endpoint` gets its own
+  breaker state so a single flaky endpoint no longer blocks traffic to healthy ones.
+  Sub-resource paths (e.g. `/v1/monitors/{uuid}`, `/v1/monitors/{uuid}/reports`) are
+  bucketed under their parent `Endpoint` prefix so the breaker set stays bounded; pass a
+  custom `breaker_key_fn` to change that. The OPEN-state error message now identifies
+  which endpoint tripped. State for a given path is readable via
+  `client.circuit_breaker_state_for(path)` in either mode. Default behaviour is
+  unchanged. See README for details.
+
+## [1.5.0] - 2026-04-20
+
+### Added
+
+- **`AsyncHyperpingMcpClient`** -- full async counterpart to `HyperpingMcpClient`. All 16
+  MCP methods available via `await`. Uses `httpx.AsyncClient`, `asyncio.Lock`, and async
+  retry with `asyncio.sleep`. Exported from `hyperping` top-level.
+- **Typed MCP returns** -- all 16 MCP client methods now return Pydantic models instead of
+  raw `dict[str, Any]`. Models verified against the live API.
+- **New models**: `TimeGroup`, `ResponseTimeReport`, `AlertHistory`, `MonitorMetricsSummary`,
+  `MttrReport`, `MttaReport`, `ProbeLogResponse`, `TeamMember`, `OutageMonitorSummary`.
+- **MCP error handling parity** -- both sync and async transports now map HTTP 404, 429,
+  400/422 to the same exception types as the REST client (`HyperpingNotFoundError`,
+  `HyperpingRateLimitError`, `HyperpingValidationError`).
+- **MCP retry logic** -- automatic retry with exponential backoff on transient server
+  errors (500, 502, 503, 504) up to `max_retries` times (default 2).
+- **Thread safety** -- `threading.Lock` (sync) and `asyncio.Lock` (async) protect the
+  request ID counter and initialization flag.
+- **83 new tests** covering async MCP transport, client coverage, sync transport error
+  paths, async maintenance/outages, and protocol base classes. Overall coverage: 96%.
+
+### Changed
+
+- **Forward-compatible models** -- all 28 response models changed from `extra="ignore"` to
+  `extra="allow"`. New API fields are preserved instead of silently dropped.
+- **Typed sub-objects** -- `OutageTimeline.outage` is now typed `Outage` (was `dict`),
+  `.monitor` is `OutageMonitorSummary` (was `dict`).
+
 ## [1.4.1] - 2026-04-20
 
 ### Fixed

{hyperping-1.4.1 → hyperping-1.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hyperping
-Version: 1.4.1
+Version: 1.6.0
 Summary: Python SDK for the Hyperping uptime monitoring and incident management API
 Project-URL: Homepage, https://github.com/develeap/hyperping-python
 Project-URL: Documentation, https://github.com/develeap/hyperping-python#readme
@@ -98,6 +98,18 @@ async def main():
 
 The async client supports all the same resources, retry behaviour, and circuit breaker as the sync client. Use `RetryConfig` and `CircuitBreakerConfig` in exactly the same way.
 
+An async MCP client is also available:
+
+```python
+from hyperping import AsyncHyperpingMcpClient
+
+async def main():
+    async with AsyncHyperpingMcpClient(api_key="sk_...") as mcp:
+        summary = await mcp.get_status_summary()
+        members = await mcp.list_team_members()
+        anomalies = await mcp.get_monitor_anomalies("mon_uuid")
+```
+
 ## Authentication
 
 Pass your API key directly or via environment variable:
@@ -277,6 +289,48 @@ client = HyperpingClient(
 )
 ```
 
+### Per-endpoint circuit breaker
+
+By default a single shared circuit breaker covers every request. If one endpoint flakes, every other endpoint is also blocked. Enable `per_endpoint_circuit_breaker=True` to keep one breaker per *endpoint* so a failing endpoint does not punish healthy ones:
+
+```python
+client = HyperpingClient(
+    api_key="sk_...",
+    per_endpoint_circuit_breaker=True,
+)
+
+# Inspect state for an endpoint. The breaker key is canonicalised to the
+# matching `Endpoint` prefix, so all sub-resource paths share a bucket:
+from hyperping import CircuitState, Endpoint
+
+state = client.circuit_breaker_state_for(str(Endpoint.MONITORS))
+# /v1/monitors, /v1/monitors/mon_abc and /v1/monitors/mon_abc/reports all
+# report the same state — they share the `/v1/monitors` breaker.
+assert client.circuit_breaker_state_for(f"{Endpoint.MONITORS}/mon_abc") == state
+assert state in {CircuitState.CLOSED, CircuitState.HALF_OPEN, CircuitState.OPEN}
+```
+
+If you need different bucketing (e.g. one breaker per resource UUID, or a single breaker per HTTP verb), pass a `breaker_key_fn`:
+
+```python
+def per_resource(path: str) -> str:
+    # one breaker per literal request path
+    return path.split("?", 1)[0]
+
+client = HyperpingClient(
+    api_key="sk_...",
+    per_endpoint_circuit_breaker=True,
+    breaker_key_fn=per_resource,
+)
+```
+
+| Option | Type | Default | Description |
+| --- | --- | --- | --- |
+| `per_endpoint_circuit_breaker` | `bool` | `False` | When `True`, maintain a separate circuit breaker keyed by request endpoint instead of using one shared breaker. The same `circuit_breaker_config` applies to every per-endpoint breaker. The shared breaker remains accessible via `client.circuit_breaker`. |
+| `breaker_key_fn` | `Callable[[str], str] \| None` | `None` | Override the default endpoint-prefix bucketing. Receives the request path and returns the breaker key. Default behaviour collapses every path under the matching `Endpoint` prefix so the breaker set stays bounded (one per `Endpoint`); a custom function takes responsibility for keeping the key set bounded. Ignored unless `per_endpoint_circuit_breaker=True`. |
+
+State for any path is readable via `client.circuit_breaker_state_for(path)`. In the default (single-breaker) mode this returns the shared breaker's state for any path, so the call is always safe regardless of the flag. The same options and method are available on `AsyncHyperpingClient`.
+
 ## Type Safety
 
 This package ships a `py.typed` marker (PEP 561) and is fully typed. Works out of the box with mypy and pyright.

{hyperping-1.4.1 → hyperping-1.6.0}/README.md

@@ -61,6 +61,18 @@ async def main():
 
 The async client supports all the same resources, retry behaviour, and circuit breaker as the sync client. Use `RetryConfig` and `CircuitBreakerConfig` in exactly the same way.
 
+An async MCP client is also available:
+
+```python
+from hyperping import AsyncHyperpingMcpClient
+
+async def main():
+    async with AsyncHyperpingMcpClient(api_key="sk_...") as mcp:
+        summary = await mcp.get_status_summary()
+        members = await mcp.list_team_members()
+        anomalies = await mcp.get_monitor_anomalies("mon_uuid")
+```
+
 ## Authentication
 
 Pass your API key directly or via environment variable:
@@ -240,6 +252,48 @@ client = HyperpingClient(
 )
 ```
 
+### Per-endpoint circuit breaker
+
+By default a single shared circuit breaker covers every request. If one endpoint flakes, every other endpoint is also blocked. Enable `per_endpoint_circuit_breaker=True` to keep one breaker per *endpoint* so a failing endpoint does not punish healthy ones:
+
+```python
+client = HyperpingClient(
+    api_key="sk_...",
+    per_endpoint_circuit_breaker=True,
+)
+
+# Inspect state for an endpoint. The breaker key is canonicalised to the
+# matching `Endpoint` prefix, so all sub-resource paths share a bucket:
+from hyperping import CircuitState, Endpoint
+
+state = client.circuit_breaker_state_for(str(Endpoint.MONITORS))
+# /v1/monitors, /v1/monitors/mon_abc and /v1/monitors/mon_abc/reports all
+# report the same state — they share the `/v1/monitors` breaker.
+assert client.circuit_breaker_state_for(f"{Endpoint.MONITORS}/mon_abc") == state
+assert state in {CircuitState.CLOSED, CircuitState.HALF_OPEN, CircuitState.OPEN}
+```
+
+If you need different bucketing (e.g. one breaker per resource UUID, or a single breaker per HTTP verb), pass a `breaker_key_fn`:
+
+```python
+def per_resource(path: str) -> str:
+    # one breaker per literal request path
+    return path.split("?", 1)[0]
+
+client = HyperpingClient(
+    api_key="sk_...",
+    per_endpoint_circuit_breaker=True,
+    breaker_key_fn=per_resource,
+)
+```
+
+| Option | Type | Default | Description |
+| --- | --- | --- | --- |
+| `per_endpoint_circuit_breaker` | `bool` | `False` | When `True`, maintain a separate circuit breaker keyed by request endpoint instead of using one shared breaker. The same `circuit_breaker_config` applies to every per-endpoint breaker. The shared breaker remains accessible via `client.circuit_breaker`. |
+| `breaker_key_fn` | `Callable[[str], str] \| None` | `None` | Override the default endpoint-prefix bucketing. Receives the request path and returns the breaker key. Default behaviour collapses every path under the matching `Endpoint` prefix so the breaker set stays bounded (one per `Endpoint`); a custom function takes responsibility for keeping the key set bounded. Ignored unless `per_endpoint_circuit_breaker=True`. |
+
+State for any path is readable via `client.circuit_breaker_state_for(path)`. In the default (single-breaker) mode this returns the shared breaker's state for any path, so the call is always safe regardless of the flag. The same options and method are available on `AsyncHyperpingClient`.
+
 ## Type Safety
 
 This package ships a `py.typed` marker (PEP 561) and is fully typed. Works out of the box with mypy and pyright.

hyperping-1.6.0/SECURITY.md

@@ -0,0 +1,58 @@
+# Security Policy
+
+## Supported Versions
+
+We release patches for security vulnerabilities for the following versions:
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 1.5.x   | :white_check_mark: |
+| < 1.5   | :x:                |
+
+Older releases may receive a fix at maintainers' discretion when the issue is severe and an upgrade is not feasible. The latest 1.x release is always the recommended target.
+
+## Reporting a Vulnerability
+
+**Please do not report security vulnerabilities through public GitHub issues.**
+
+Instead, please report security vulnerabilities by emailing:
+
+**security@develeap.com**
+
+You should receive a response within 48 hours. If for some reason you do not, please follow up via email to ensure we received your original message.
+
+Please include the following information in your report:
+
+- Type of vulnerability (e.g., credential exposure, request smuggling, deserialization issue, etc.)
+- Full paths of source file(s) related to the vulnerability
+- The location of the affected source code (tag/branch/commit or direct URL)
+- Step-by-step instructions to reproduce the issue
+- Proof-of-concept or exploit code (if possible)
+- Impact of the issue, including how an attacker might exploit it
+- The Python version, `hyperping` package version, and any relevant transitive dependency versions (`pip show hyperping`, `python --version`)
+
+This information will help us triage your report more quickly.
+
+## Preferred Languages
+
+We prefer all communications to be in English.
+
+## Security Update Process
+
+1. The security report is received and assigned a primary handler
+2. The problem is confirmed and a list of affected versions determined
+3. Code is audited to find any potential similar problems
+4. Fixes are prepared for all supported releases
+5. New versions are released to PyPI as soon as possible, and a GitHub Security Advisory is published
+
+## Public Disclosure
+
+We believe in responsible disclosure. We will coordinate the public disclosure with you, and we prefer to fully disclose the vulnerability once a patch is available on PyPI.
+
+## Comments on this Policy
+
+If you have suggestions on how this process could be improved, please submit a pull request or open an issue to discuss.
+
+---
+
+**Thank you for helping keep hyperping-python and our users safe!**

{hyperping-1.4.1 → hyperping-1.6.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "hyperping"
-version = "1.4.1"
+version = "1.6.0"
 description = "Python SDK for the Hyperping uptime monitoring and incident management API"
 readme = {file = "README.md", content-type = "text/markdown"}
 license = {text = "MIT"}

{hyperping-1.4.1 → hyperping-1.6.0}/src/hyperping/__init__.py

@@ -15,6 +15,7 @@ Quick start::
 """
 
 from hyperping._async_client import AsyncHyperpingClient
+from hyperping._async_mcp_client import AsyncHyperpingMcpClient
 from hyperping._version import __version__
 from hyperping.client import (
     CircuitBreaker,
@@ -40,7 +41,7 @@ from hyperping.mcp_client import HyperpingMcpClient
 from hyperping.models import (
     DEFAULT_REGIONS,
     AddIncidentUpdateRequest,
-    AlertNotification,
+    AlertHistory,
     DnsRecordType,
     EscalationPolicy,
     Healthcheck,
@@ -64,10 +65,13 @@ from hyperping.models import (
     MonitorCreate,
     MonitorFrequency,
     MonitorListResponse,
+    MonitorMetricsSummary,
     MonitorProtocol,
     MonitorReport,
     MonitorTimeout,
     MonitorUpdate,
+    MttaReport,
+    MttrReport,
     NotificationOption,
     OnCallSchedule,
     Outage,
@@ -77,14 +81,18 @@ from hyperping.models import (
     OutageTimeline,
     OutageTimelineEvent,
     ProbeLog,
+    ProbeLogResponse,
     Region,
     ReportPeriod,
     RequestHeader,
+    ResponseTimeReport,
     StatusPage,
     StatusPageCreate,
     StatusPageSubscriber,
     StatusPageUpdate,
     StatusSummary,
+    TeamMember,
+    TimeGroup,
 )
 
 __all__ = [
@@ -92,6 +100,7 @@ __all__ = [
     "__version__",
     # Clients
     "AsyncHyperpingClient",
+    "AsyncHyperpingMcpClient",
     "HyperpingClient",
     "HyperpingMcpClient",
     # MCP
@@ -156,14 +165,21 @@ __all__ = [
     # Observability
     "MonitorAnomaly",
     "ProbeLog",
-    "AlertNotification",
+    "ProbeLogResponse",
     # On-call
     "OnCallSchedule",
     "EscalationPolicy",
+    "TeamMember",
     # Integrations
     "Integration",
     # Reporting
     "StatusSummary",
+    "TimeGroup",
+    "ResponseTimeReport",
+    "AlertHistory",
+    "MonitorMetricsSummary",
+    "MttrReport",
+    "MttaReport",
     # Healthchecks
     "Healthcheck",
     "HealthcheckCreate",

{hyperping-1.4.1 → hyperping-1.6.0}/src/hyperping/_async_client.py

@@ -14,7 +14,10 @@ Example::
 import asyncio
 import logging
 import random
+import threading
+from collections.abc import Callable
 from typing import Any
+from urllib.parse import urlsplit
 
 import httpx
 from pydantic import SecretStr
@@ -28,10 +31,11 @@ from hyperping._async_statuspages_mixin import AsyncStatusPagesMixin
 from hyperping._circuit_breaker import (
     CircuitBreaker,
     CircuitBreakerConfig,
+    CircuitState,
 )
 from hyperping._internals import DEFAULT_USER_AGENT, RETRY_AFTER_MAX, sanitize_for_log
 from hyperping.client import DEFAULT_RETRY_CONFIG, RetryConfig
-from hyperping.endpoints import API_BASE
+from hyperping.endpoints import API_BASE, Endpoint
 from hyperping.exceptions import (
     HyperpingAPIError,
     HyperpingAuthError,
@@ -73,6 +77,8 @@ class AsyncHyperpingClient(
         retry_config: RetryConfig | None = None,
         circuit_breaker_config: CircuitBreakerConfig | None = None,
         user_agent: str | None = None,
+        per_endpoint_circuit_breaker: bool = False,
+        breaker_key_fn: Callable[[str], str] | None = None,
     ) -> None:
         """Initialize the async Hyperping API client.
 
@@ -82,8 +88,19 @@ class AsyncHyperpingClient(
             base_url: Override the default API base URL.
             timeout: HTTP request timeout in seconds.
             retry_config: Retry behaviour configuration.
-            circuit_breaker_config: Circuit breaker configuration.
+            circuit_breaker_config: Circuit breaker configuration. When
+                ``per_endpoint_circuit_breaker`` is ``True`` the same config is
+                applied to each per-endpoint breaker.
             user_agent: Custom ``User-Agent`` header value.
+            per_endpoint_circuit_breaker: When ``True``, maintain an
+                independent breaker per :class:`~hyperping.endpoints.Endpoint`
+                prefix (sub-resources inherit the parent endpoint's breaker,
+                so the breaker set stays bounded). Default ``False``
+                preserves the original single-shared-breaker behaviour.
+            breaker_key_fn: Override the default endpoint-prefix bucketing.
+                Receives the request path and must return the breaker key.
+                Ignored unless ``per_endpoint_circuit_breaker`` is ``True``.
+                Caller is responsible for keeping the key set bounded.
         """
         raw_key = api_key.get_secret_value() if isinstance(api_key, SecretStr) else api_key
         if not raw_key or not raw_key.strip():
@@ -92,7 +109,12 @@ class AsyncHyperpingClient(
         self.base_url = (base_url or self.DEFAULT_BASE_URL).rstrip("/")
         self.timeout = timeout
         self.retry_config = retry_config or DEFAULT_RETRY_CONFIG
+        self._circuit_breaker_config = circuit_breaker_config
         self._circuit_breaker = CircuitBreaker(circuit_breaker_config)
+        self._per_endpoint_circuit_breaker = per_endpoint_circuit_breaker
+        self._breaker_key_fn = breaker_key_fn
+        self._endpoint_breakers: dict[str, CircuitBreaker] = {}
+        self._endpoint_breakers_lock = threading.Lock()
 
         self._client = httpx.AsyncClient(
             base_url=self.base_url,
@@ -120,9 +142,74 @@ class AsyncHyperpingClient(
 
     @property
     def circuit_breaker(self) -> CircuitBreaker:
-        """Access the circuit breaker state (for monitoring)."""
+        """Access the (shared) circuit breaker state (for monitoring).
+
+        In per-endpoint mode this returns the original shared breaker, kept
+        for backward compatibility; the per-path breakers are exposed via
+        :meth:`circuit_breaker_state_for`.
+        """
         return self._circuit_breaker
 
+    def _resolve_breaker_key(self, path: str) -> str:
+        """Map a request path to its circuit-breaker key.
+
+        Default bucketing strips query/fragment and collapses the path under
+        the longest matching :class:`Endpoint` prefix; a custom
+        ``breaker_key_fn`` wins outright.
+        """
+        if self._breaker_key_fn is not None:
+            return self._breaker_key_fn(path)
+        pure = urlsplit(path).path
+        for ep in Endpoint:
+            ep_value = ep.value
+            if pure == ep_value or pure.startswith(ep_value + "/"):
+                return ep_value
+        return pure
+
+    def _breaker_for(self, path: str) -> CircuitBreaker:
+        """Return the breaker that governs ``path`` (shared, or per-endpoint)."""
+        if not self._per_endpoint_circuit_breaker:
+            return self._circuit_breaker
+        key = self._resolve_breaker_key(path)
+        # threading.Lock here is intentional: see HyperpingClient._breaker_for
+        # for the rationale (works under both pure-asyncio and mixed-thread use).
+        with self._endpoint_breakers_lock:
+            breaker = self._endpoint_breakers.get(key)
+            if breaker is None:
+                breaker = CircuitBreaker(self._circuit_breaker_config)
+                self._endpoint_breakers[key] = breaker
+            return breaker
+
+    def circuit_breaker_state_for(self, path: str) -> CircuitState:
+        """Return the circuit state of the breaker governing ``path``.
+
+        In per-endpoint mode the path is canonicalised the same way as during
+        a request; untouched buckets report :attr:`CircuitState.CLOSED`
+        without allocating a breaker. In default mode the shared breaker's
+        state is returned for any path.
+        """
+        if not self._per_endpoint_circuit_breaker:
+            return self._circuit_breaker.state
+        key = self._resolve_breaker_key(path)
+        with self._endpoint_breakers_lock:
+            breaker = self._endpoint_breakers.get(key)
+        return breaker.state if breaker is not None else CircuitState.CLOSED
+
+    def _circuit_open_message(self, breaker: CircuitBreaker, path: str) -> str:
+        """Build the error message raised when a request is rejected by an OPEN breaker."""
+        if self._per_endpoint_circuit_breaker:
+            key = self._resolve_breaker_key(path)
+            return (
+                f"Circuit breaker OPEN for {key!r} - API calls to this endpoint suspended. "
+                f"Consecutive failures: {breaker.failure_count}. "
+                f"Will recover after {breaker.recovery_timeout}s."
+            )
+        return (
+            f"Circuit breaker OPEN - API calls suspended. "
+            f"Consecutive failures: {breaker.failure_count}. "
+            f"Will recover after {breaker.recovery_timeout}s."
+        )
+
     # ==================== Error Handling ====================
 
     def _parse_error_body(self, response: httpx.Response) -> dict[str, Any]:
@@ -236,7 +323,7 @@ class AsyncHyperpingClient(
         if response.status_code >= 400:
             return response
 
-        self._circuit_breaker.record_success()
+        self._breaker_for(path).record_success()
         if response.status_code == 204:
             return {}
         return response.json()  # type: ignore[no-any-return]
@@ -262,13 +349,9 @@ class AsyncHyperpingClient(
         Raises:
             HyperpingAPIError: On API errors after retries exhausted
         """
-        if not self._circuit_breaker.call_allowed():
-            cb = self._circuit_breaker
-            raise HyperpingAPIError(
-                f"Circuit breaker OPEN - API calls suspended. "
-                f"Consecutive failures: {cb.failure_count}. "
-                f"Will recover after {cb.recovery_timeout}s."
-            )
+        breaker = self._breaker_for(path)
+        if not breaker.call_allowed():
+            raise HyperpingAPIError(self._circuit_open_message(breaker, path))
 
         last_exception: Exception | None = None
         delay = self.retry_config.initial_delay
@@ -299,7 +382,7 @@ class AsyncHyperpingClient(
                     continue
 
                 if response.status_code >= 500:
-                    self._circuit_breaker.record_failure()
+                    breaker.record_failure()
                 self._handle_response_error(response)
 
             except (httpx.TimeoutException, httpx.RequestError) as e:
@@ -320,7 +403,7 @@ class AsyncHyperpingClient(
                         self.retry_config.max_delay,
                     )
                     continue
-                self._circuit_breaker.record_failure()
+                breaker.record_failure()
                 if isinstance(e, httpx.TimeoutException):
                     raise HyperpingAPIError(f"Request timeout after {max_attempts} attempts") from e
                 raise HyperpingAPIError(f"Request failed: {e}") from e