reach_commons 0.14.95__tar.gz → 0.14.96__tar.gz

{reach_commons-0.14.95 → reach_commons-0.14.96}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: reach_commons
-Version: 0.14.95
+Version: 0.14.96
 Summary: Reach Commons is a versatile utility library designed to streamline and enhance development workflows within the Reach ecosystem.
 License: MIT
 Author: Wilson Moraes

{reach_commons-0.14.95 → reach_commons-0.14.96}/pyproject.toml

@@ -1,7 +1,7 @@
 # isort .; black .; poetry build; poetry publish
 [tool.poetry]
 name = "reach_commons"
-version = "0.14.95"
+version = "0.14.96"
 description = "Reach Commons is a versatile utility library designed to streamline and enhance development workflows within the Reach ecosystem."
 authors = ["Wilson Moraes <wmoraes@getreach.ai>"]
 license = "MIT"

reach_commons-0.14.96/reach_commons/app_logging/log_deprecated_endpoints.py

@@ -0,0 +1,53 @@
+import datetime
+
+from fastapi import Request, Response
+
+from reach_commons.app_logging.logger import get_reach_logger
+
+logger = get_reach_logger()
+
+
+def add_deprecation_headers(
+    request: Request,
+    response: Response,
+    added_date: datetime.datetime,
+    deprecation_period_days: int = 180,
+    replacement_url: str = None,
+):
+    """
+    Adds deprecation headers to the response and logs deprecation information.
+
+    Args:
+        request (Request): The HTTP request object.
+        response (Response): The HTTP response object.
+        added_date (datetime.datetime): The date when deprecation was announced.
+        deprecation_period_days (int): Number of days before the endpoint is removed (default: 180).
+        replacement_url (str, optional): URL of the replacement endpoint, if available.
+    """
+    removal_date = added_date + datetime.timedelta(days=deprecation_period_days)
+    removal_date_str = removal_date.strftime("%a, %d %b %Y %H:%M:%S GMT")
+    current_date = datetime.datetime.utcnow()
+
+    path = request.url.path if request else "Unknown Path"
+    method = request.method if request else "Unknown Method"
+
+    deprecation_warning = f'299 "{method} {path}" is deprecated and will be removed on [{removal_date_str}]"'
+
+    response.headers["Deprecation-Warning"] = deprecation_warning
+
+    if replacement_url:
+        response.headers["Replacement-Endpoint"] = replacement_url
+
+    if current_date < removal_date:
+        logger.warning(
+            f"Deprecated endpoint accessed: {method} {path}. "
+            f"Deprecation period ends on {removal_date_str}."
+            + (f" Replacement endpoint: {replacement_url}" if replacement_url else "")
+        )
+
+    elif current_date >= removal_date:
+        logger.error(
+            f"Access to removed endpoint: {method} {path}. "
+            f"Removal date was {removal_date_str}."
+            + (f" Replacement endpoint: {replacement_url}" if replacement_url else "")
+        )

reach_commons-0.14.95/reach_commons/app_logging/log_deprecated_endpoints.py

@@ -1,55 +0,0 @@
-from datetime import datetime, timedelta
-from functools import wraps
-
-from fastapi import Request
-from fastapi.responses import Response
-
-from reach_commons.app_logging.logger import get_reach_logger
-
-logger = get_reach_logger()
-
-
-def deprecated_warning(added_date: datetime, deprecation_period_days: int = 180):
-    """
-    Decorator to indicate that an endpoint is deprecated in FastAPI.
-
-    - Adds a "Warning" header to the response during the deprecation period.
-    - Uses HTTP status 409 ("Gone") after the deprecation period ends.
-    - Uses HTTP status 301 ("Moved Permanently") if a replacement URL is provided.
-
-    Args:
-        added_date (datetime): The date when the deprecation was announced.
-        deprecation_period_days (int): Number of days before the endpoint is removed (default: 180).
-    """
-
-    def decorator(func):
-        @wraps(func)
-        async def wrapper(request: Request, response: Response, *args, **kwargs):
-            removal_date = added_date + timedelta(days=deprecation_period_days)
-            removal_date_str = removal_date.strftime("%a, %d %b %Y %H:%M:%S GMT")
-            current_date = datetime.utcnow()
-
-            path = request.url.path if request else "Unknown Path"
-            method = request.method if request else "Unknown Method"
-
-            warning_message = f'299 "{method} {path}" is deprecated and will be removed on [{removal_date_str}]"'
-
-            response.headers["Deprecation-Warning"] = warning_message
-
-            if current_date < removal_date:
-                logger.warning(
-                    f"Deprecated endpoint accessed: {method} {path}. "
-                    f"Deprecation period ends on {removal_date_str}."
-                )
-
-            elif current_date >= removal_date:
-                logger.error(
-                    f"Access to removed endpoint: {method} {path}. "
-                    f"Removal date was {removal_date_str}."
-                )
-
-            return await func(request, response, *args, **kwargs)
-
-        return wrapper
-
-    return decorator