reach_commons 0.14.94__py3-none-any.whl → 0.14.96__py3-none-any.whl

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.94.dist-info → reach_commons-0.14.96.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: reach_commons
-Version: 0.14.94
+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
@@ -15,6 +15,7 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Requires-Dist: curlify (==2.2.1)
+Requires-Dist: fastapi (==0.115.5)
 Requires-Dist: pydantic (==2.9.2)
 Requires-Dist: setuptools (==68.2.2)
 Requires-Dist: twine (==4.0.2)

{reach_commons-0.14.94.dist-info → reach_commons-0.14.96.dist-info}/RECORD

@@ -1,6 +1,7 @@
 reach_commons/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 reach_commons/app_logging/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 reach_commons/app_logging/http_logger.py,sha256=mljQCdmsmtD2HsC_gsFwZAxPlAiLPYVirVrCjXFxitY,2541
+reach_commons/app_logging/log_deprecated_endpoints.py,sha256=MDGWr998TCWdGGf2L3r-NmnNhuKFDgKqRnkeAbgdkr4,2018
 reach_commons/app_logging/logger.py,sha256=Iq2XTl1zLgHDmVsTMdlFadcYJOqQNhBcFSscacKs_Xs,2295
 reach_commons/app_logging/logging_config.py,sha256=Y1JaZOoQBWgQjkOqYmeDRIm0p2eCOl3yTzgsgqyqm8I,1539
 reach_commons/clients/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -25,6 +26,6 @@ reach_commons/reach_base_model.py,sha256=oyAXoBwXLzsJ8GB1lxsJqiNf4QtfUJ_NI9MkiZ4
 reach_commons/redis_manager.py,sha256=_4FOYPMapwRmWU-5SO1Bm0Cb__Ngkx2hrOPlrJETzX0,1896
 reach_commons/utils.py,sha256=zny3JSj1Ljq1Bbt9RCLhqy0-sWrzb_cPoIccKpWk_Nk,8377
 reach_commons/validations.py,sha256=jc78boM62S9Z0Ip_nV1z7I983gGpW2Y7vOCQtmia8OU,964
-reach_commons-0.14.94.dist-info/METADATA,sha256=DZUdN-JjB01Tc9376SS4IdoDBues8oFaamxlYG6RyB8,1826
-reach_commons-0.14.94.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
-reach_commons-0.14.94.dist-info/RECORD,,
+reach_commons-0.14.96.dist-info/METADATA,sha256=ggrA_DRTLYpowCFQckm5achdzcxZZcieA5VY3ctA9f0,1861
+reach_commons-0.14.96.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
+reach_commons-0.14.96.dist-info/RECORD,,