my-aws-helpers 2.0.0__tar.gz → 2.2.0__tar.gz

{my_aws_helpers-2.0.0 → my_aws_helpers-2.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: my_aws_helpers
-Version: 2.0.0
+Version: 2.2.0
 Summary: AWS Helpers
 Home-page: https://github.com/JarrodMccarthy/aws_helpers.git
 Author: Jarrod McCarthy

{my_aws_helpers-2.0.0 → my_aws_helpers-2.2.0}/my_aws_helpers/dynamo.py

@@ -41,31 +41,31 @@ class MetaData:
         return ""
 
 
-class BaseTableObject(MetaData):
+class BaseTableObject:
     """
     An Abstract class that helps ensure your objects
     conform to the AssetTable schema and
     implement serialisation/deserialisation for Dynamo
     """
 
-    pk: str
-    sk: str
-
+    @abstractmethod
     def _get_pk(self):
-        pass
+        raise NotImplementedError()
 
+    @abstractmethod
     def _get_sk(self):
-        pass
+        raise NotImplementedError()
 
-    @abstractclassmethod
-    def _from_dynamo_representation():
+    @classmethod
+    @abstractmethod
+    def _from_dynamo_representation(cls):
         """
         Deserialises this object from Dynamo Representation
         """
         pass
 
     @abstractmethod
-    def _to_dynamo_representation():
+    def _to_dynamo_representation(self):
         """
         Serialises this object to Dynamo Representation
         """
@@ -74,10 +74,9 @@ class BaseTableObject(MetaData):
     def _optional_get(self, kwargs: dict, key: str, default: Any):
         return kwargs.get(key) if kwargs.get(key) else default
 
-    def __init__(self, **kwargs) -> None:
-        super().__init__(**kwargs)
-        self.pk = self._optional_get(kwargs=kwargs, key="pk", default=self._get_pk())
-        self.sk = self._optional_get(kwargs=kwargs, key="sk", default=self._get_sk())
+    def __init__(self) -> None:
+        pass
+        
 
 
 class DynamoSerialiser:

my_aws_helpers-2.2.0/my_aws_helpers/event.py

@@ -0,0 +1,73 @@
+from __future__ import annotations
+from my_aws_helpers.dynamo import BaseTableObject, DynamoSerialiser
+from datetime import datetime
+from enum import Enum
+from uuid import uuid4
+from copy import copy
+
+
+class EventDynamoKeys:
+    @staticmethod
+    def get_event_pk(id: str):
+        return f"id##{id}"
+    
+    @staticmethod
+    def get_event_sk(id: str):
+        return f"id##{id}"    
+
+
+class EventStatus(str, Enum):
+    in_progress = "in_progress"
+    success = "success"
+    fail = "fail"
+
+
+class Event(BaseTableObject):
+    status: str
+    message: str
+    id: str
+    created_timestamp: datetime
+
+    def __init__(
+        self,
+        status: str,
+        message: str,
+        id: str = None,
+        created_timestamp: datetime = None,
+    ):
+        super().__init__()
+        self.status: str = self.set_status(status=status)
+        self.message: str = message
+        self.id: str = id if id else uuid4().hex
+        self.created_timestamp: datetime = created_timestamp if created_timestamp else datetime.now()
+
+    def set_status(self, status: str) -> str:
+        if status not in list(EventStatus):
+            raise Exception("Status must be a member of EventStatus")
+        return status
+
+    def _get_pk(self):
+        return EventDynamoKeys.get_event_pk(self.id)
+    
+    def _get_sk(self):
+        return EventDynamoKeys.get_event_sk(self.id)  
+
+    @classmethod
+    def _from_dynamo_representation(cls, obj: dict):
+        """
+        Deserialises this object from Dynamo Representation
+        """
+        this_obj = copy(obj)
+        this_obj.pop('pk')
+        this_obj.pop('sk')
+        return cls(**this_obj)
+
+    def _to_dynamo_representation(self):
+        """
+        Serialises this object to Dynamo Representation
+        """
+        obj = copy(vars(self))
+        obj['pk'] = self._get_pk()
+        obj['sk'] = self._get_sk()
+        return DynamoSerialiser.object_serialiser(obj=obj)
+

{my_aws_helpers-2.0.0 → my_aws_helpers-2.2.0}/my_aws_helpers.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: my-aws-helpers
-Version: 2.0.0
+Version: 2.2.0
 Summary: AWS Helpers
 Home-page: https://github.com/JarrodMccarthy/aws_helpers.git
 Author: Jarrod McCarthy

{my_aws_helpers-2.0.0 → my_aws_helpers-2.2.0}/my_aws_helpers.egg-info/SOURCES.txt

@@ -6,6 +6,7 @@ my_aws_helpers/auth.py
 my_aws_helpers/cognito.py
 my_aws_helpers/dynamo.py
 my_aws_helpers/errors.py
+my_aws_helpers/event.py
 my_aws_helpers/logging.py
 my_aws_helpers/s3.py
 my_aws_helpers/sfn.py
@@ -14,4 +15,5 @@ my_aws_helpers.egg-info/SOURCES.txt
 my_aws_helpers.egg-info/dependency_links.txt
 my_aws_helpers.egg-info/requires.txt
 my_aws_helpers.egg-info/top_level.txt
-my_aws_helpers.egg-info/zip-safe
+my_aws_helpers.egg-info/zip-safe
+tests/test_event.py

{my_aws_helpers-2.0.0 → my_aws_helpers-2.2.0}/setup.py

@@ -3,7 +3,7 @@ from setuptools import find_namespace_packages, setup
 
 base_path = os.path.abspath(os.path.dirname(__file__))
 
-version = "2.0.0"
+version = "2.2.0"
 
 setup(
     name="my_aws_helpers",

my_aws_helpers-2.2.0/tests/test_event.py

@@ -0,0 +1,23 @@
+from my_aws_helpers.event import Event, EventStatus
+import pytest
+
+
+def test_event():
+    event = Event(status=EventStatus.success.value, message="test event")
+    assert event != None
+
+def test_event_wrong_status():
+    with pytest.raises(Exception):
+        Event(status="not success", message="test event")
+
+def test_serialiser():
+    event = Event(status=EventStatus.success.value, message="test event")
+    dynamo_repr = event._to_dynamo_representation()
+
+    assert dynamo_repr['pk'] == f"id##{event.id}"
+    assert dynamo_repr['sk'] == f"id##{event.id}"
+
+    obj = Event._from_dynamo_representation(obj = dynamo_repr)
+
+    assert isinstance(obj, Event) == True
+