costvine-api-utils 0.1.77__tar.gz

costvine_api_utils-0.1.77/PKG-INFO

@@ -0,0 +1,12 @@
+Metadata-Version: 2.4
+Name: costvine-api-utils
+Version: 0.1.77
+Summary: Some simple utilities for handling inbound API calls in Python cloud functions
+Author: John D. Underhill
+Author-email: junderhill@qisproject.com
+Requires-Python: >=3.12,<4.0
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Dist: firebase-functions

costvine_api_utils-0.1.77/costvine_api_utils/__init__.py

@@ -0,0 +1,3 @@
+"""Simple API utilities."""
+
+from .main import *

costvine_api_utils-0.1.77/costvine_api_utils/main.py

@@ -0,0 +1,61 @@
+import os
+import copy
+from collections.abc import Iterable
+from flask import Request
+
+
+def is_health_check(req: Request) -> bool:
+    """Returns True if the specified path is a health check request."""
+
+    return "__/health" in req.path
+
+
+def patch_request(original_request: Request, ssl_domains: Iterable[str]) -> Request:
+    """
+    This function patches the request object so we can use it with the OpenAPI validator: (1) If the name of the called cloud
+    function is not the first component of the path, patch it in; (2) When deployed, SSL terminates at the load balancer, and
+    the scheme (protocol) is always reported as HTTP, even though it was originally HTTPS, so we fix that as well. The
+    `ssl_domains` parameter specifies which host domains should have their scheme patched to HTTPS.
+    """
+
+    req = copy.copy(original_request)
+    print("Original request path:", req.path)
+
+    if not req.path.startswith("/"):
+        print("Warning: Expected the request path to start with a slash. Fixing that.")
+        req.path = "/" + req.path
+
+    service_name = os.environ.get("K_SERVICE", "")
+    print("Service name:", service_name)
+    if not service_name:
+        print(
+            "Warning: Expected the K_SERVICE environment variable to be set. Patching in the service name (if required) will not take place."
+        )
+    elif not req.path.startswith("/" + service_name):
+        req.path = "/" + service_name + req.path
+
+    if req.path.endswith("/"):
+        print("Warning: Expected the request path NOT to end with a slash. Fixing that.")
+        req.path = req.path[:-1]
+
+    print("Patched request path:", req.path)
+
+    url = req.host_url.lower()
+    if any(domain in url for domain in ssl_domains):
+        # `host_url` is a `cached_property`; write through `__dict__` to update the
+        # cached value without tripping type checkers that disallow assignment.
+        req.__dict__["host_url"] = req.host_url.replace("http://", "https://", 1)
+        req.scheme = "https"
+        print("Patched request host_url:", req.host_url)
+
+    return req
+
+
+def get_api_function_name(req: Request) -> str:
+    """Return the API function name or an empty string if none was provided."""
+
+    path_components = patch_request(req, ()).path.split("/")
+
+    if len(path_components) < 3:
+        return ""
+    return path_components[2]

costvine_api_utils-0.1.77/costvine_api_utils/py.typed

@@ -0,0 +1 @@
+

costvine_api_utils-0.1.77/pyproject.toml

@@ -0,0 +1,28 @@
+[tool.poetry]
+name = "costvine-api-utils"
+version = "0.1.77"
+description = "Some simple utilities for handling inbound API calls in Python cloud functions"
+authors = ["John D. Underhill <junderhill@qisproject.com>"]
+
+[tool.costvine.scripts]
+pretty = "pretty"
+format = "format"
+lint = "lint"
+types = "types"
+tests = "tests"
+check = "check"
+"distribute" = "distribute-pypi"
+
+[tool.poetry.dependencies]
+python = "^3.12"
+firebase-functions = "*"
+
+[tool.poetry.group.dev.dependencies]
+pip = "*"
+mypy = "*"
+pylint = "*"
+black = "*"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"