djresttoolkit 0.2.0__tar.gz → 0.4.0__tar.gz

{djresttoolkit-0.2.0 → djresttoolkit-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: djresttoolkit
-Version: 0.2.0
+Version: 0.4.0
 Summary: A collection of Django and DRF utilities to simplify API development.
 Project-URL: Homepage, https://github.com/shaileshpandit141/djresttoolkit
 Project-URL: Documentation, https://shaileshpandit141.github.io/djresttoolkit

{djresttoolkit-0.2.0 → djresttoolkit-0.4.0}/pyproject.toml

@@ -4,7 +4,7 @@
 
 [project]
 name = "djresttoolkit"
-version = "0.2.0"
+version = "0.4.0"
 description = "A collection of Django and DRF utilities to simplify API development."
 readme = { file = "README.md", content-type = "text/markdown" }
 license = { file = "LICENSE" }

djresttoolkit-0.4.0/src/djresttoolkit/middlewares/__init__.py

@@ -0,0 +1,3 @@
+from ._response_time_middleware import ResponseTimeMiddleware
+
+__all__ = ["ResponseTimeMiddleware"]

djresttoolkit-0.4.0/src/djresttoolkit/middlewares/_response_time_middleware.py

@@ -0,0 +1,32 @@
+import logging
+import time
+from collections.abc import Callable
+
+from django.http import HttpRequest, HttpResponse
+
+# Get logger from logging.
+logger = logging.getLogger(__name__)
+
+
+class ResponseTimeMiddleware:
+    """Calculte response response time."""
+
+    def __init__(
+        self,
+        get_response: Callable[[HttpRequest], HttpResponse],
+    ) -> None:
+        "Initilize response time middleware."
+        self.get_response = get_response
+
+    def __call__(self, request: HttpRequest) -> HttpResponse:
+        """Handle to response response time calculation."""
+        start_time = time.perf_counter()
+        response = self.get_response(request)
+        end_time = time.perf_counter()
+
+        response_time = f"{round(end_time - start_time, 5)} seconds"
+        response["X-Response-Time"] = response_time
+
+        logger.info(f"Request processed in {response_time}")
+
+        return response

djresttoolkit-0.4.0/src/djresttoolkit/views/__init__.py

@@ -0,0 +1,3 @@
+from ._exceptions import exception_handler
+
+__all__ = ["exception_handler"]

djresttoolkit-0.4.0/src/djresttoolkit/views/_exceptions/__init__.py

@@ -0,0 +1,3 @@
+from ._exception_handler import exception_handler
+
+__all__ = ["exception_handler"]

djresttoolkit-0.4.0/src/djresttoolkit/views/_exceptions/_exception_handler.py

@@ -0,0 +1,64 @@
+from typing import Any, cast
+
+from django.core.cache import cache
+from django.utils import timezone
+from rest_framework import status, views
+from rest_framework.request import Request
+from rest_framework.response import Response
+from rest_framework.throttling import AnonRateThrottle
+
+
+def exception_handler(exc: Exception, context: dict[str, Any]) -> Response | None:
+    """
+    Custom exception handler that preserves DRF's default functionality
+    while adding custom throttling behavior.
+    """
+
+    # Call DRF's default exception handler first
+    response: Response | None = views.exception_handler(exc, context)
+
+    request: Request | None = context.get("request")
+    view = context.get("view")
+
+    if request and view:
+        # Pick throttle classes from view or default to AnonRateThrottle
+        throttle_classes: list[type[AnonRateThrottle]] = getattr(
+            view, "throttle_classes", [AnonRateThrottle]
+        )
+
+        for throttle_class in throttle_classes:
+            throttle = throttle_class()
+            cache_key = throttle.get_cache_key(request, view)
+            if not cache_key:
+                continue
+
+            history: list[float] = cache.get(cache_key, [])
+            now = timezone.now().timestamp()
+            duration: float = cast(float, throttle.duration)  # type: ignore[attr-defined]
+
+            # Keep only non-expired timestamps
+            history = [float(ts) for ts in history if now - float(ts) < duration]
+
+            # If throttle limit exceeded
+            if len(history) >= throttle.num_requests:  # type: ignore[attr-defined]
+                retry_after: float = (
+                    duration - (now - history[0]) if history else duration
+                )
+
+                return Response(
+                    data={
+                        "detail": "Too many requests. Please try again later.",
+                        "retry_after": {
+                            "time": round(retry_after, 2),
+                            "unit": "seconds",
+                        },
+                    },
+                    status=status.HTTP_429_TOO_MANY_REQUESTS,
+                )
+
+            # Otherwise add current timestamp
+            history.append(now)
+            cache.set(key=cache_key, value=history, timeout=duration)
+
+    # If DRF handled the exception, return that response
+    return response