feat(splat): add uptick_splat library

Author: uptickmetachu

lambda_function.py

@@ -322,18 +322,30 @@ def lambda_handler(event, context):
 
 
 def check_license():
-    tree = ET.parse('./prince-engine/license/license.dat')
-    parsed_license = {child.tag: (child.attrib, child.text) for child in tree.getroot() if child.tag != 'signature'}
-    is_demo_license = bool(list(filter(lambda x: x[0] == 'option' and x[1].get('id') == 'demo', parsed_license)))
-    
-    return respond({
-        "statusCode": 200,
-        "headers": {
-            "Content-Type": "application/json",
-        },
-        "body": json.dumps({**parsed_license, 'is_demo_license': is_demo_license}),
-        "isBase64Encoded": False,
-    })
+    tree = ET.parse("./prince-engine/license/license.dat")
+    parsed_license = {
+        child.tag: (child.attrib, child.text)
+        for child in tree.getroot()
+        if child.tag != "signature"
+    }
+    is_demo_license = bool(
+        list(
+            filter(
+                lambda x: x[0] == "option" and x[1].get("id") == "demo", parsed_license
+            )
+        )
+    )
+
+    return respond(
+        {
+            "statusCode": 200,
+            "headers": {
+                "Content-Type": "application/json",
+            },
+            "body": json.dumps({**parsed_license, "is_demo_license": is_demo_license}),
+            "isBase64Encoded": False,
+        }
+    )
 
 
 if __name__ == "__main__":

poetry.lock

@@ -1,13 +1,15 @@
 [tool.poetry]
 name = "uptick-splat"
 version = "0.1.0"
-description = "Splat library"
+description = "Django library for invoking splat"
 authors = ["william chu <[email protected]>"]
 readme = "README.md"
-packages = [{include = "uptick_splat"}]
+packages = [{ include = "uptick_splat" }]
 
 [tool.poetry.dependencies]
 python = "^3.9"
+django = ">=3.1, <5.0.0"
+boto3 = "*"
 
 
 [build-system]

pyproject.toml

@@ -0,0 +1,11 @@
+from .config import config  # noqa
+from .utils import SplatPDFGenerationFailure, pdf_with_splat  # noqa
+
+__version__ = "0.1.0"
+
+__all__ = [
+    "config",
+    "SplatPDFGenerationFailure",
+    "pdf_with_splat",
+    "__version__",
+]

uptick_splat/__init__.py

@@ -0,0 +1,36 @@
+from dataclasses import dataclass
+from typing import Any, Callable
+
+import boto3
+
+from .logging import logger
+
+
+def get_session() -> Any:
+    """This function can be overridden to provide a custom session"""
+    session = boto3.session.Session()
+    return session
+
+
+def delete_key(bucket_name: str, path: str) -> None:
+    """This function can be overriden to provide a custom delete key function"""
+    session = config.get_session()
+    s3_client = session.client("s3")
+    try:
+        s3_client.delete_object(Bucket=bucket_name, Key=path)
+    except Exception as e:
+        logger.warning(f"Failed to delete {path} from s3: {e}")
+
+
+@dataclass
+class Config:
+    function_region: str = "ap-southeast-2"
+    function_name: str = "splat-prod"
+    default_bucket_name: str = ""
+    default_html_key: str = "ExpireAfter=1w"
+
+    get_session: Callable[[], Any] = get_session
+    delete_key: Callable[[str, str], None] = delete_key
+
+
+config = Config()

uptick_splat/config.py

@@ -0,0 +1,2 @@
+class SplatPDFGenerationFailure(Exception):
+    pass

uptick_splat/exceptions.py

@@ -0,0 +1,4 @@
+import logging
+
+metrics = logging.getLogger("metrics")
+logger = logging.getLogger("splat")