pygrestqlambda 0.0.3__py3-none-any.whl → 0.0.4__py3-none-any.whl

pygrestqlambda/aws/lambda_function/json_transform.py

@@ -6,9 +6,9 @@ from datetime import date, datetime
 from decimal import Decimal
 from uuid import UUID
 
-def json_output(value: object) -> str:
+def to_string(value: object) -> str:
     """
-    Calculates the serialised version of an object to return in a JSON response
+    Calculates the string version of an object to return in a JSON response
     """
 
     # Handle UUIDs

pygrestqlambda/aws/lambda_function/rest_api_gateway_proxy_integration.py

@@ -6,11 +6,11 @@ Returns payload structure expected by REST API Gateway
 https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-lambda-proxy-integrations.html#api-gateway-simple-proxy-for-lambda-output-format
 """
 
-from base64 import b64encode
+from base64 import b64encode, b64decode
 from dataclasses import dataclass
 import json
 import logging
-from pygrestqlambda.aws.lambda_function.json_transform import json_output
+from pygrestqlambda.aws.lambda_function.json_transform import to_string
 
 
 @dataclass
@@ -22,25 +22,40 @@ class Response:
     status_code: int | None = 401
     headers: dict | None = None
     multi_value_headers: dict | None = None
-    body: str | None = None
+    body: str | dict | None = None
 
     def get_payload(self) -> dict:
         """
         Gets payload to send to REST API Gateway
         """
 
+        is_json = False
+        if isinstance(self.body, dict):
+            is_json = True
+
         # Set headers
         if self.headers is None:
             self.headers = {}
 
         if "Content-Type" not in self.headers:
-            self.headers["Content-Type"] = "application/json"
+            logging.debug("No content type header set")
+            if is_json:
+                logging.debug("Using application/json for content-type")
+                self.headers["Content-Type"] = "application/json"
+            else:
+                logging.debug("Using text/plain for content-type")
+                self.headers["Content-Type"] = "text/plain"
 
         # Calculate body
         if self.is_base64_encoded:
             body = b64encode(self.body).decode("utf-8")
         else:
-            body = json.dumps(self.body, default=json_output)
+            if is_json:
+                logging.debug("Body is a JSON object")
+                body = json.dumps(self.body, default=to_string)
+            else:
+                logging.debug("Body is plain text")
+                body = self.body
 
         logging.debug("Transforming dataclass dictionary to JSON")
         data = {
@@ -52,3 +67,83 @@ class Response:
         }
 
         return data
+
+# pylint: disable=too-many-instance-attributes
+class Request:
+    """
+    Lambda function proxy integration request
+    """
+
+    def __init__(self, event: dict):
+        self.event = event
+        # Extract authorisation information
+        self.cognito_uid = self.get_cognito_uid()
+        # Extract headers needed for body and response
+        self.accept: str = self.get_header('accept')
+        self.content_type: str = self.get_header('content-type')
+        # Extract resource
+        self.resource = event.get('resource')
+        self.method = event.get('httpMethod')
+        # Extract parameters
+        self.query_params = event.get('multiValueQueryStringParameters')
+        self.path_params = event.get('pathParameters')
+        # Extract body
+        self.body = self.get_body()
+
+
+    def get_body(self):
+        """
+        Returns body from request, decodes from base64 if necessary
+        """
+
+        body = self.event.get('body')
+        content = body
+        if self.event.get('isBase64Encoded'):
+            if body:
+                content = b64decode(body)
+
+        # Handle no content type
+        if self.content_type is None:
+            return content
+
+        # Handle plain text
+        if self.content_type.lower() == 'text/plain':
+            return str(content)
+
+        # Handle JSON
+        if self.content_type.lower() == 'application/json':
+            return json.loads(content)
+
+        return content
+
+
+    def get_cognito_uid(self):
+        """
+        Retrieve Cognito UID from supplied claim
+        """
+        claims = self.event.get('requestContext', {}).get('authorizer', {}).get('claims')
+
+        if claims is None:
+            logging.info('No claims in event request context authoriser')
+            return None
+
+        cognito_uid = claims.get('sub')
+
+        return cognito_uid
+
+
+    def get_header(self, header_name: str):
+        """
+        Retrieve Accept header
+        """
+
+        headers = self.event.get('headers')
+        if headers is None:
+            return None
+
+        # Lowercase all the headers
+        headers_lower = {k.lower():v for k,v in headers.items()}
+
+        accept = headers_lower.get(header_name.lower())
+
+        return accept

pygrestqlambda-0.0.4.dist-info/METADATA

@@ -0,0 +1,124 @@
+Metadata-Version: 2.4
+Name: pygrestqlambda
+Version: 0.0.4
+Summary: PostgreSQL REST API framework for AWS Lambda functions
+Project-URL: Homepage, https://github.com/mesogate/pygrestqlambda
+Project-URL: Issues, https://github.com/mesogate/pygrestqlambda/issues
+Author-email: Voquis Limited <opensource@voquis.com>
+License-File: LICENSE
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.11
+Requires-Dist: aws-xray-sdk
+Requires-Dist: boto3
+Provides-Extra: dev
+Requires-Dist: build; extra == 'dev'
+Requires-Dist: docker; extra == 'dev'
+Requires-Dist: httpx; extra == 'dev'
+Requires-Dist: psycopg[binary]; extra == 'dev'
+Requires-Dist: pylint; extra == 'dev'
+Requires-Dist: pytest; extra == 'dev'
+Requires-Dist: pytest-cov; extra == 'dev'
+Requires-Dist: pytest-xdist; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Requires-Dist: twine; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# Python PostgreSQL REST API framework for AWS Lambda functions
+> [!NOTE]
+> Project status: `Alpha`
+
+A REST API web framework for persisting records in a PostgreSQL database.
+
+## Supported features
+- Automatic creation of `uid` fields
+- Automatic setting of `created_at` and `last_updated_at` timestamps
+- Automatic setting of `creator_uid` and `last_updater_uid`
+- RDS with IAM credentials
+
+## Examples
+See [Examples docs directory](./docs/examples/)
+
+## Sequence diagrams
+
+### High-level infrastructure
+
+This sequence diagram shows how a lambda function running this library is intended to be deployed.
+
+```mermaid
+sequenceDiagram
+    # Set up actors and participants
+    actor User
+    participant APIGW as API Gateway
+    participant Cognito as Cognito
+    box Purple This library
+        participant Lambda as Lambda Function
+    end
+    participant RDS as RDS Database
+
+    # Set up Sequences
+    User ->> APIGW: HTTP /resource
+    activate APIGW
+        APIGW -->> Cognito: Authenticate
+        activate Cognito
+            Cognito ->> APIGW: Authenticated
+        deactivate Cognito
+        APIGW ->> Lambda: Send proxy integration request
+        activate Lambda
+            Lambda ->> RDS: Fetch/mutate
+            activate RDS
+                RDS -->> Lambda: Return records
+            deactivate RDS
+            Lambda -->> APIGW: Return response
+        deactivate Lambda
+        APIGW -->> User: Return response
+    deactivate APIGW
+```
+
+### Low-level architecture
+
+This sequence diagram shows the layers within the library that handle request and response processing.
+
+```mermaid
+sequenceDiagram
+
+    Participant APIGW as API Gateway
+    box Purple This library as a deployed Lambda Function
+        Participant CONT as Controller
+        Participant REQM as Request Mapper
+        Participant RESOURCEM as Resource Mapper
+        Participant DBM as Database  Mapper
+        Participant RESPONSEM as Response Mapper
+    end
+    Participant RDS
+
+    APIGW ->> CONT: Send `event` dict
+    activate CONT
+        CONT ->> REQM: Map request
+        activate REQM
+            REQM ->> CONT: Mapped request
+        deactivate REQM
+
+        CONT ->> RESOURCEM: Map resource
+        activate RESOURCEM
+            RESOURCEM -->> CONT: Mapped resource
+        deactivate RESOURCEM
+
+        CONT ->> DBM: Request resource operation
+        activate DBM
+            DBM ->> RDS: Perform resource operation
+            activate RDS
+                RDS -->> DBM: Return resources
+            deactivate RDS
+            DBM -->> CONT: Return resource
+        deactivate DBM
+
+        CONT ->> RESPONSEM: Map response
+        activate RESPONSEM
+            RESPONSEM -->> CONT: Mapped response
+        deactivate RESPONSEM
+
+        CONT -->> APIGW: Return response
+    deactivate CONT
+```

{pygrestqlambda-0.0.3.dist-info → pygrestqlambda-0.0.4.dist-info}/RECORD

@@ -1,11 +1,11 @@
 pygrestqlambda/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 pygrestqlambda/aws/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 pygrestqlambda/aws/lambda_function/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-pygrestqlambda/aws/lambda_function/json_transform.py,sha256=SlUnG23gzy_zHpVP-thRYaWc91w6OFisTGrxKah6UL4,634
-pygrestqlambda/aws/lambda_function/rest_api_gateway_proxy_integration.py,sha256=TDn9D_BivcTPoNK1PhgymnF0V8blWaEE0cYV9v3aCLQ,1699
+pygrestqlambda/aws/lambda_function/json_transform.py,sha256=Hb09h8n4tYS58vnP03QG46cV_ghCrVzfBctHdUURv6g,628
+pygrestqlambda/aws/lambda_function/rest_api_gateway_proxy_integration.py,sha256=xE1w7dd-AUTQZB1Jc8DG_pqibWpasYB1rM1BQwuAJyI,4505
 pygrestqlambda/db/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 pygrestqlambda/db/record.py,sha256=6HwvVIB8iJxxcoLeFgk51Gik_w7--w5fQzLN0ntB8iw,1527
-pygrestqlambda-0.0.3.dist-info/METADATA,sha256=yshe1yJ4gp-ndptTYh93fEIGhWxabm9aWycVLBfkgfI,1294
-pygrestqlambda-0.0.3.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-pygrestqlambda-0.0.3.dist-info/licenses/LICENSE,sha256=8QeS1c5uv4AYoEG3M80OSCBuC_Pk-6vjU1VBUnlX2m0,1071
-pygrestqlambda-0.0.3.dist-info/RECORD,,
+pygrestqlambda-0.0.4.dist-info/METADATA,sha256=Bm0rNQxaQJ_LY5m9zF75BRO3pCzcGbhbZMRPvTnx47s,3796
+pygrestqlambda-0.0.4.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+pygrestqlambda-0.0.4.dist-info/licenses/LICENSE,sha256=8QeS1c5uv4AYoEG3M80OSCBuC_Pk-6vjU1VBUnlX2m0,1071
+pygrestqlambda-0.0.4.dist-info/RECORD,,

pygrestqlambda-0.0.3.dist-info/METADATA

@@ -1,37 +0,0 @@
-Metadata-Version: 2.4
-Name: pygrestqlambda
-Version: 0.0.3
-Summary: PostgreSQL REST API framework for AWS Lambda functions
-Project-URL: Homepage, https://github.com/mesogate/pygrestqlambda
-Project-URL: Issues, https://github.com/mesogate/pygrestqlambda/issues
-Author-email: Voquis Limited <opensource@voquis.com>
-License-File: LICENSE
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3
-Requires-Python: >=3.11
-Requires-Dist: aws-xray-sdk
-Requires-Dist: boto3
-Provides-Extra: dev
-Requires-Dist: build; extra == 'dev'
-Requires-Dist: pylint; extra == 'dev'
-Requires-Dist: pytest; extra == 'dev'
-Requires-Dist: pytest-cov; extra == 'dev'
-Requires-Dist: ruff; extra == 'dev'
-Requires-Dist: twine; extra == 'dev'
-Description-Content-Type: text/markdown
-
-# Python PostgreSQL REST API framework for AWS Lambda functions
-> [!NOTE]
-> Project status: `Alpha`
-
-A REST API web framework for persisting records in a PostgreSQL database.
-
-## Supported features
-- Automatic creation of `uid` fields
-- Automatic setting of `created_at` and `last_updated_at` timestamps
-- Automatic setting of `creator_uid` and `last_updater_uid`
-- RDS with IAM credentials
-
-## Examples
-See [Examples docs directory](./docs/examples/)