django-cfg 1.4.116__py3-none-any.whl → 1.5.14__py3-none-any.whl

django_cfg/apps/integrations/grpc/migrations/0006_grpcrequestlog_api_key_and_more.py

@@ -0,0 +1,34 @@
+# Generated by Django 5.2.7 on 2025-11-04 05:30
+
+import django.db.models.deletion
+from django.conf import settings
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("grpc", "0005_grpcapikey"),
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="grpcrequestlog",
+            name="api_key",
+            field=models.ForeignKey(
+                blank=True,
+                help_text="API key used for authentication (if applicable)",
+                null=True,
+                on_delete=django.db.models.deletion.SET_NULL,
+                related_name="request_logs",
+                to="grpc.grpcapikey",
+            ),
+        ),
+        migrations.AddIndex(
+            model_name="grpcrequestlog",
+            index=models.Index(
+                fields=["api_key", "-created_at"], name="django_cfg__api_key_218ecc_idx"
+            ),
+        ),
+    ]

django_cfg/apps/integrations/grpc/models/__init__.py

@@ -0,0 +1,13 @@
+"""
+Models for gRPC app.
+"""
+
+from .grpc_api_key import GrpcApiKey
+from .grpc_request_log import GRPCRequestLog
+from .grpc_server_status import GRPCServerStatus
+
+__all__ = [
+    "GrpcApiKey",
+    "GRPCRequestLog",
+    "GRPCServerStatus",
+]

django_cfg/apps/integrations/grpc/models/grpc_api_key.py

@@ -0,0 +1,198 @@
+"""
+gRPC API Key Model.
+
+Django model for managing API keys used for gRPC authentication.
+Provides secure, revocable authentication for services and CLI tools.
+"""
+
+import secrets
+from django.conf import settings
+from django.db import models
+from django.utils import timezone
+
+
+def generate_api_key() -> str:
+    """
+    Generate a secure random API key.
+
+    Returns:
+        32-character hex string (128 bits of entropy)
+    """
+    return secrets.token_hex(32)
+
+
+class GrpcApiKey(models.Model):
+    """
+    API Key for gRPC authentication.
+
+    Provides secure, revocable authentication for:
+    - Service-to-service communication
+    - CLI tools and scripts
+    - Internal systems
+    - Development and testing
+
+    Features:
+    - Auto-generated secure keys
+    - User association for permissions
+    - Expiration support
+    - Usage tracking
+    - Easy revocation via admin
+
+    Example:
+        >>> # Create API key for a service
+        >>> key = GrpcApiKey.objects.create_for_user(
+        ...     user=admin_user,
+        ...     name="Analytics Service",
+        ...     description="Internal analytics microservice"
+        ... )
+        >>> print(key.key)  # Use this in service config
+
+        >>> # Check if key is valid
+        >>> if key.is_valid:
+        ...     user = key.user
+    """
+
+    # Custom manager
+    from ..managers.grpc_api_key import GrpcApiKeyManager
+    objects: GrpcApiKeyManager = GrpcApiKeyManager()
+
+    class KeyTypeChoices(models.TextChoices):
+        """Type of API key."""
+        SERVICE = "service", "Service-to-Service"
+        CLI = "cli", "CLI Tool"
+        WEBHOOK = "webhook", "Webhook"
+        INTERNAL = "internal", "Internal System"
+        DEVELOPMENT = "development", "Development"
+
+    # Identity
+    key = models.CharField(
+        max_length=64,
+        unique=True,
+        default=generate_api_key,
+        db_index=True,
+        help_text="API key (auto-generated)",
+    )
+
+    name = models.CharField(
+        max_length=255,
+        help_text="Descriptive name for this key (e.g., 'Analytics Service')",
+    )
+
+    description = models.TextField(
+        blank=True,
+        help_text="Additional details about this key's purpose",
+    )
+
+    key_type = models.CharField(
+        max_length=20,
+        choices=KeyTypeChoices.choices,
+        default=KeyTypeChoices.SERVICE,
+        help_text="Type of API key",
+    )
+
+    # User association
+    user = models.ForeignKey(
+        settings.AUTH_USER_MODEL,
+        on_delete=models.CASCADE,
+        related_name="grpc_api_keys",
+        help_text="User this key authenticates as",
+    )
+
+    # Status
+    is_active = models.BooleanField(
+        default=True,
+        db_index=True,
+        help_text="Whether this key is currently active (can be used)",
+    )
+
+    # Expiration
+    expires_at = models.DateTimeField(
+        null=True,
+        blank=True,
+        db_index=True,
+        help_text="When this key expires (null = never expires)",
+    )
+
+    # Usage tracking
+    last_used_at = models.DateTimeField(
+        null=True,
+        blank=True,
+        help_text="When this key was last used",
+    )
+
+    request_count = models.IntegerField(
+        default=0,
+        help_text="Total number of requests made with this key",
+    )
+
+    # Metadata
+    created_by = models.ForeignKey(
+        settings.AUTH_USER_MODEL,
+        on_delete=models.SET_NULL,
+        null=True,
+        blank=True,
+        related_name="created_grpc_api_keys",
+        help_text="User who created this key",
+    )
+
+    # Timestamps
+    created_at = models.DateTimeField(
+        auto_now_add=True,
+        db_index=True,
+        help_text="When this key was created",
+    )
+
+    updated_at = models.DateTimeField(
+        auto_now=True,
+        help_text="When this key was last updated",
+    )
+
+    class Meta:
+        db_table = "django_cfg_grpc_api_key"
+        ordering = ["-created_at"]
+        indexes = [
+            models.Index(fields=["user", "-created_at"]),
+            models.Index(fields=["is_active", "-created_at"]),
+            models.Index(fields=["expires_at"]),
+            models.Index(fields=["key_type", "-created_at"]),
+        ]
+        verbose_name = "gRPC API Key"
+        verbose_name_plural = "gRPC API Keys"
+
+    def __str__(self) -> str:
+        """String representation."""
+        status = "✓" if self.is_valid else "✗"
+        return f"{status} {self.name} ({self.user.username})"
+
+    @property
+    def is_expired(self) -> bool:
+        """Check if key has expired."""
+        if not self.expires_at:
+            return False
+        return timezone.now() > self.expires_at
+
+    @property
+    def is_valid(self) -> bool:
+        """Check if key is valid (active and not expired)."""
+        return self.is_active and not self.is_expired
+
+    @property
+    def masked_key(self) -> str:
+        """Return masked version of key for display."""
+        if len(self.key) <= 8:
+            return self.key
+        return f"{self.key[:4]}...{self.key[-4:]}"
+
+    def mark_used(self) -> None:
+        """Mark this key as used (update last_used_at and increment counter)."""
+        self.last_used_at = timezone.now()
+        self.request_count += 1
+        self.save(update_fields=["last_used_at", "request_count"])
+
+    def revoke(self) -> None:
+        """Revoke this key (set is_active=False)."""
+        self.is_active = False
+        self.save(update_fields=["is_active"])
+
+
+__all__ = ["GrpcApiKey", "generate_api_key"]

django_cfg/apps/integrations/grpc/models/grpc_request_log.py

@@ -0,0 +1,230 @@
+"""
+gRPC Request Log Model.
+
+Django model for tracking gRPC requests and responses.
+Provides observability for debugging and monitoring.
+"""
+
+from django.conf import settings
+from django.db import models
+from django.utils import timezone
+
+from .grpc_api_key import GrpcApiKey
+
+class GRPCRequestLog(models.Model):
+    """
+    Log of gRPC requests and responses.
+
+    Tracks all gRPC method calls with status, timing, and error tracking.
+    Provides observability for debugging and monitoring.
+
+    Example:
+        >>> log = GRPCRequestLog.objects.create(
+        ...     request_id="abc123",
+        ...     service_name="myapp.UserService",
+        ...     method_name="GetUser",
+        ... )
+        >>> log.mark_success(duration_ms=125)
+    """
+
+    # Custom manager
+    from ..managers.grpc_request_log import GRPCRequestLogManager
+
+    objects: GRPCRequestLogManager = GRPCRequestLogManager()
+
+    class StatusChoices(models.TextChoices):
+        """Status of gRPC request."""
+
+        PENDING = "pending", "Pending"
+        SUCCESS = "success", "Success"
+        ERROR = "error", "Error"
+        CANCELLED = "cancelled", "Cancelled"
+        TIMEOUT = "timeout", "Timeout"
+
+    # Identity
+    request_id = models.CharField(
+        max_length=100,
+        unique=True,
+        db_index=True,
+        help_text="Unique request identifier (UUID)",
+    )
+
+    # gRPC details
+    service_name = models.CharField(
+        max_length=200,
+        db_index=True,
+        help_text="gRPC service name (e.g., myapp.UserService)",
+    )
+
+    method_name = models.CharField(
+        max_length=200,
+        db_index=True,
+        help_text="gRPC method name (e.g., GetUser)",
+    )
+
+    full_method = models.CharField(
+        max_length=400,
+        db_index=True,
+        help_text="Full method path (e.g., /myapp.UserService/GetUser)",
+    )
+
+    # Request/Response data
+    request_size = models.IntegerField(
+        null=True,
+        blank=True,
+        help_text="Request size in bytes",
+    )
+
+    response_size = models.IntegerField(
+        null=True,
+        blank=True,
+        help_text="Response size in bytes",
+    )
+
+    request_data = models.JSONField(
+        null=True,
+        blank=True,
+        help_text="Request data (if logged)",
+    )
+
+    response_data = models.JSONField(
+        null=True,
+        blank=True,
+        help_text="Response data (if logged)",
+    )
+
+    # Status tracking
+    status = models.CharField(
+        max_length=20,
+        choices=StatusChoices.choices,
+        default=StatusChoices.PENDING,
+        db_index=True,
+        help_text="Current status of request",
+    )
+
+    grpc_status_code = models.CharField(
+        max_length=50,
+        null=True,
+        blank=True,
+        db_index=True,
+        help_text="gRPC status code (OK, CANCELLED, INVALID_ARGUMENT, etc.)",
+    )
+
+    error_message = models.TextField(
+        null=True,
+        blank=True,
+        help_text="Error message if failed",
+    )
+
+    error_details = models.JSONField(
+        null=True,
+        blank=True,
+        help_text="Additional error details",
+    )
+
+    # Performance
+    duration_ms = models.IntegerField(
+        null=True,
+        blank=True,
+        help_text="Total duration in milliseconds",
+    )
+
+    # User context
+    user = models.ForeignKey(
+        settings.AUTH_USER_MODEL,
+        on_delete=models.SET_NULL,
+        null=True,
+        blank=True,
+        related_name="grpc_request_logs",
+        help_text="Authenticated user (if applicable)",
+    )
+
+    api_key = models.ForeignKey(
+        GrpcApiKey,
+        on_delete=models.SET_NULL,
+        null=True,
+        blank=True,
+        related_name="request_logs",
+        help_text="API key used for authentication (if applicable)",
+    )
+
+    is_authenticated = models.BooleanField(
+        default=False,
+        db_index=True,
+        help_text="Whether request was authenticated",
+    )
+
+    # Client metadata
+    client_ip = models.GenericIPAddressField(
+        null=True,
+        blank=True,
+        help_text="Client IP address",
+    )
+
+    user_agent = models.TextField(
+        null=True,
+        blank=True,
+        help_text="User agent from metadata",
+    )
+
+    peer = models.CharField(
+        max_length=200,
+        null=True,
+        blank=True,
+        help_text="gRPC peer information",
+    )
+
+    # Timestamps
+    created_at = models.DateTimeField(
+        auto_now_add=True,
+        db_index=True,
+        help_text="When request was received",
+    )
+
+    completed_at = models.DateTimeField(
+        null=True,
+        blank=True,
+        db_index=True,
+        help_text="When request completed (success/error)",
+    )
+
+    class Meta:
+        db_table = "django_cfg_grpc_request_log"
+        ordering = ["-created_at"]
+        indexes = [
+            models.Index(fields=["service_name", "-created_at"]),
+            models.Index(fields=["method_name", "-created_at"]),
+            models.Index(fields=["status", "-created_at"]),
+            models.Index(fields=["user", "-created_at"]),
+            models.Index(fields=["api_key", "-created_at"]),
+            models.Index(fields=["grpc_status_code", "-created_at"]),
+        ]
+        verbose_name = "gRPC Request Log"
+        verbose_name_plural = "gRPC Request Logs"
+
+    def __str__(self) -> str:
+        """String representation."""
+        return f"{self.full_method} ({self.request_id[:8]}...) - {self.status}"
+
+    @property
+    def is_completed(self) -> bool:
+        """Check if request is completed (any terminal status)."""
+        return self.status in [
+            self.StatusChoices.SUCCESS,
+            self.StatusChoices.ERROR,
+            self.StatusChoices.CANCELLED,
+            self.StatusChoices.TIMEOUT,
+        ]
+
+    @property
+    def is_successful(self) -> bool:
+        """Check if request was successful."""
+        return self.status == self.StatusChoices.SUCCESS
+
+    @property
+    def success_rate(self) -> float:
+        """Calculate success rate (for compatibility with stats)."""
+        return 1.0 if self.is_successful else 0.0
+
+
+__all__ = ["GRPCRequestLog"]