django-cfg 1.4.61__py3-none-any.whl → 1.4.63__py3-none-any.whl

django_cfg/apps/centrifugo/serializers/admin_api.py

@@ -0,0 +1,264 @@
+"""
+Centrifugo Admin API Serializers.
+
+Pydantic models for Centrifugo server HTTP API requests and responses.
+Based on Centrifugo v6 API specification from api.proto.
+"""
+
+from typing import Any, Dict, List, Optional
+from pydantic import BaseModel, Field
+
+
+# ==================== Common Types ====================
+
+
+class CentrifugoError(BaseModel):
+    """Centrifugo API error structure."""
+
+    code: int = Field(default=0, description="Error code (0 = no error)")
+    message: str = Field(default="", description="Error message")
+
+
+class CentrifugoMetrics(BaseModel):
+    """Server metrics."""
+
+    interval: float = Field(description="Metrics collection interval")
+    items: Dict[str, float] = Field(description="Metric name to value mapping")
+
+
+class CentrifugoProcess(BaseModel):
+    """Process information."""
+
+    cpu: float = Field(description="CPU usage percentage")
+    rss: int = Field(description="Resident set size in bytes")
+
+
+# ==================== Info API ====================
+
+
+class CentrifugoInfoRequest(BaseModel):
+    """Request for server info (no parameters)."""
+
+    pass
+
+
+class CentrifugoNodeInfo(BaseModel):
+    """Information about a single Centrifugo node."""
+
+    uid: str = Field(description="Unique node identifier")
+    name: str = Field(description="Node name")
+    version: str = Field(description="Centrifugo version")
+    num_clients: int = Field(description="Number of connected clients")
+    num_users: int = Field(description="Number of unique users")
+    num_channels: int = Field(description="Number of active channels")
+    uptime: int = Field(description="Node uptime in seconds")
+    num_subs: int = Field(description="Total number of subscriptions")
+    metrics: Optional[CentrifugoMetrics] = Field(
+        default=None, description="Server metrics"
+    )
+    process: Optional[CentrifugoProcess] = Field(
+        default=None, description="Process information"
+    )
+
+
+class CentrifugoInfoResult(BaseModel):
+    """Info result wrapper."""
+
+    nodes: List[CentrifugoNodeInfo] = Field(description="List of Centrifugo nodes")
+
+
+class CentrifugoInfoResponse(BaseModel):
+    """Server info response."""
+
+    error: Optional[CentrifugoError] = Field(default=None, description="Error if any")
+    result: Optional[CentrifugoInfoResult] = Field(
+        default=None, description="Result data"
+    )
+
+
+# ==================== Channels API ====================
+
+
+class CentrifugoChannelsRequest(BaseModel):
+    """Request to list active channels."""
+
+    pattern: Optional[str] = Field(
+        default=None, description="Pattern to filter channels (e.g., 'user:*')"
+    )
+
+
+class CentrifugoChannelInfo(BaseModel):
+    """Information about a single channel."""
+
+    num_clients: int = Field(description="Number of connected clients in channel")
+
+
+class CentrifugoChannelsResult(BaseModel):
+    """Channels result wrapper."""
+
+    channels: Dict[str, CentrifugoChannelInfo] = Field(
+        description="Map of channel names to channel info"
+    )
+
+
+class CentrifugoChannelsResponse(BaseModel):
+    """List of active channels response."""
+
+    error: Optional[CentrifugoError] = Field(default=None, description="Error if any")
+    result: Optional[CentrifugoChannelsResult] = Field(
+        default=None, description="Result data"
+    )
+
+
+# ==================== Presence API ====================
+
+
+class CentrifugoPresenceRequest(BaseModel):
+    """Request to get channel presence."""
+
+    channel: str = Field(description="Channel name")
+
+
+class CentrifugoClientInfo(BaseModel):
+    """Information about connected client."""
+
+    user: str = Field(description="User ID")
+    client: str = Field(description="Client UUID")
+    conn_info: Optional[Dict[str, Any]] = Field(
+        default=None, description="Connection metadata"
+    )
+    chan_info: Optional[Dict[str, Any]] = Field(
+        default=None, description="Channel-specific metadata"
+    )
+
+
+class CentrifugoPresenceResult(BaseModel):
+    """Presence result wrapper."""
+
+    presence: Dict[str, CentrifugoClientInfo] = Field(
+        description="Map of client IDs to client info"
+    )
+
+
+class CentrifugoPresenceResponse(BaseModel):
+    """Channel presence response."""
+
+    error: Optional[CentrifugoError] = Field(default=None, description="Error if any")
+    result: Optional[CentrifugoPresenceResult] = Field(
+        default=None, description="Result data"
+    )
+
+
+# ==================== Presence Stats API ====================
+
+
+class CentrifugoPresenceStatsRequest(BaseModel):
+    """Request to get channel presence statistics."""
+
+    channel: str = Field(description="Channel name")
+
+
+class CentrifugoPresenceStatsResult(BaseModel):
+    """Presence stats result."""
+
+    num_clients: int = Field(description="Number of connected clients")
+    num_users: int = Field(description="Number of unique users")
+
+
+class CentrifugoPresenceStatsResponse(BaseModel):
+    """Channel presence stats response."""
+
+    error: Optional[CentrifugoError] = Field(default=None, description="Error if any")
+    result: Optional[CentrifugoPresenceStatsResult] = Field(
+        default=None, description="Result data"
+    )
+
+
+# ==================== History API ====================
+
+
+class CentrifugoStreamPosition(BaseModel):
+    """Stream position for pagination."""
+
+    offset: int = Field(description="Stream offset")
+    epoch: str = Field(description="Stream epoch")
+
+
+class CentrifugoHistoryRequest(BaseModel):
+    """Request to get channel history."""
+
+    channel: str = Field(description="Channel name")
+    limit: Optional[int] = Field(
+        default=None, ge=1, le=1000, description="Maximum number of messages to return"
+    )
+    since: Optional[CentrifugoStreamPosition] = Field(
+        default=None, description="Stream position to get messages since"
+    )
+    reverse: Optional[bool] = Field(
+        default=False, description="Reverse message order (newest first)"
+    )
+
+
+class CentrifugoPublication(BaseModel):
+    """Single publication (message) in channel history."""
+
+    data: Dict[str, Any] = Field(description="Message payload")
+    info: Optional[CentrifugoClientInfo] = Field(
+        default=None, description="Publisher client info"
+    )
+    offset: int = Field(description="Message offset in channel stream")
+    tags: Optional[Dict[str, str]] = Field(
+        default=None, description="Optional message tags"
+    )
+
+
+class CentrifugoHistoryResult(BaseModel):
+    """History result wrapper."""
+
+    publications: List[CentrifugoPublication] = Field(
+        description="List of publications"
+    )
+    epoch: str = Field(description="Current stream epoch")
+    offset: int = Field(description="Latest stream offset")
+
+
+class CentrifugoHistoryResponse(BaseModel):
+    """Channel history response."""
+
+    error: Optional[CentrifugoError] = Field(default=None, description="Error if any")
+    result: Optional[CentrifugoHistoryResult] = Field(
+        default=None, description="Result data"
+    )
+
+
+__all__ = [
+    # Common types
+    "CentrifugoError",
+    "CentrifugoMetrics",
+    "CentrifugoProcess",
+    # Info API
+    "CentrifugoInfoRequest",
+    "CentrifugoInfoResponse",
+    "CentrifugoInfoResult",
+    "CentrifugoNodeInfo",
+    # Channels API
+    "CentrifugoChannelsRequest",
+    "CentrifugoChannelsResponse",
+    "CentrifugoChannelsResult",
+    "CentrifugoChannelInfo",
+    # Presence API
+    "CentrifugoPresenceRequest",
+    "CentrifugoPresenceResponse",
+    "CentrifugoPresenceResult",
+    "CentrifugoClientInfo",
+    # Presence Stats API
+    "CentrifugoPresenceStatsRequest",
+    "CentrifugoPresenceStatsResponse",
+    "CentrifugoPresenceStatsResult",
+    # History API
+    "CentrifugoHistoryRequest",
+    "CentrifugoHistoryResponse",
+    "CentrifugoHistoryResult",
+    "CentrifugoPublication",
+    "CentrifugoStreamPosition",
+]

django_cfg/apps/centrifugo/serializers/channels.py

@@ -0,0 +1,26 @@
+"""
+Channel statistics serializers for Centrifugo monitoring API.
+"""
+
+from pydantic import BaseModel, Field
+
+
+class ChannelStatsSerializer(BaseModel):
+    """Statistics per channel."""
+
+    channel: str = Field(description="Channel name")
+    total: int = Field(description="Total publishes to this channel")
+    successful: int = Field(description="Successful publishes")
+    failed: int = Field(description="Failed publishes")
+    avg_duration_ms: float = Field(description="Average duration")
+    avg_acks: float = Field(description="Average ACKs received")
+
+
+class ChannelListSerializer(BaseModel):
+    """List of channel statistics."""
+
+    channels: list[ChannelStatsSerializer] = Field(description="Channel statistics")
+    total_channels: int = Field(description="Total number of channels")
+
+
+__all__ = ["ChannelStatsSerializer", "ChannelListSerializer"]

django_cfg/apps/centrifugo/serializers/health.py

@@ -0,0 +1,17 @@
+"""
+Health check serializer for Centrifugo monitoring API.
+"""
+
+from pydantic import BaseModel, Field
+
+
+class HealthCheckSerializer(BaseModel):
+    """Health check response."""
+
+    status: str = Field(description="Health status: healthy or unhealthy")
+    wrapper_url: str = Field(description="Configured wrapper URL")
+    has_api_key: bool = Field(description="Whether API key is configured")
+    timestamp: str = Field(description="Current timestamp")
+
+
+__all__ = ["HealthCheckSerializer"]

django_cfg/apps/centrifugo/serializers/publishes.py

@@ -0,0 +1,16 @@
+"""
+Publishes serializers for Centrifugo monitoring API.
+"""
+
+from pydantic import BaseModel, Field
+
+
+class RecentPublishesSerializer(BaseModel):
+    """Recent publishes list."""
+
+    publishes: list[dict] = Field(description="List of recent publishes")
+    count: int = Field(description="Number of publishes returned")
+    total_available: int = Field(description="Total publishes available")
+
+
+__all__ = ["RecentPublishesSerializer"]

django_cfg/apps/centrifugo/serializers/stats.py

@@ -0,0 +1,21 @@
+"""
+Statistics serializers for Centrifugo monitoring API.
+"""
+
+from pydantic import BaseModel, Field
+
+
+class OverviewStatsSerializer(BaseModel):
+    """Overview statistics for Centrifugo publishes."""
+
+    total: int = Field(description="Total publishes in period")
+    successful: int = Field(description="Successful publishes")
+    failed: int = Field(description="Failed publishes")
+    timeout: int = Field(description="Timeout publishes")
+    success_rate: float = Field(description="Success rate percentage")
+    avg_duration_ms: float = Field(description="Average duration in milliseconds")
+    avg_acks_received: float = Field(description="Average ACKs received")
+    period_hours: int = Field(description="Statistics period in hours")
+
+
+__all__ = ["OverviewStatsSerializer"]

django_cfg/apps/centrifugo/services/__init__.py

@@ -0,0 +1,12 @@
+"""
+Centrifugo Services.
+
+Business logic layer for Centrifugo integration.
+"""
+
+from .config_helper import get_centrifugo_config, get_centrifugo_config_or_default
+
+__all__ = [
+    "get_centrifugo_config",
+    "get_centrifugo_config_or_default",
+]

django_cfg/apps/centrifugo/services/client/__init__.py

@@ -0,0 +1,29 @@
+"""
+Centrifugo Client.
+
+Django client for publishing messages to Centrifugo via Python Wrapper.
+"""
+
+from .client import CentrifugoClient, PublishResponse, get_centrifugo_client
+from .config import DjangoCfgCentrifugoConfig
+from .exceptions import (
+    CentrifugoBaseException,
+    CentrifugoConfigurationError,
+    CentrifugoConnectionError,
+    CentrifugoPublishError,
+    CentrifugoTimeoutError,
+    CentrifugoValidationError,
+)
+
+__all__ = [
+    "DjangoCfgCentrifugoConfig",
+    "CentrifugoClient",
+    "get_centrifugo_client",
+    "PublishResponse",
+    "CentrifugoBaseException",
+    "CentrifugoTimeoutError",
+    "CentrifugoPublishError",
+    "CentrifugoConnectionError",
+    "CentrifugoConfigurationError",
+    "CentrifugoValidationError",
+]