adding metadata and tag serialization

Author: david-schrenker

socketlabs/injectionapi/core/injectionrequestfactory.py

@@ -5,6 +5,7 @@
 from ..core.serialization.mergedatajson import MergeDataJson
 from ..core.serialization.mergefieldjson import MergeFieldJson
 from ..core.serialization.messagejson import MessageJson
+from ..core.serialization.metadatajson import MetadataJson
 from ..message.basicmessage import BasicMessage
 from ..message.bulkmessage import BulkMessage
 from ..message.bulkrecipient import BulkRecipient
@@ -56,6 +57,22 @@ def populate_custom_headers(custom_headers: list):
     return custom_header_json
 
 
+def populate_metadata(metadata: list):
+    """
+    Converts a List of Metadata objects to a List of MetadataJson objects.
+    :param metadata: list of Metadata to convert
+    :type metadata: list
+    :return the converted list of MetadataJson
+    :rtype list
+    """
+    if metadata is None:
+        return None
+    metadata_json = []
+    for item in metadata:
+        metadata_json.append(MetadataJson(item.name, item.value))
+    return metadata_json
+
+
 def populate_attachments(attachments: list):
     """
     Converts a list of Attachment objects to a List of AttachmentJson objects.
@@ -149,12 +166,17 @@ def generate_base_message(message: MessageBase):
     message_json.from_email_address = email_address_to_address_json(message.from_email_address)
     message_json.custom_headers = populate_custom_headers(message.custom_headers)
     message_json.attachments = populate_attachments(message.attachments)
+    message_json.metadata = populate_metadata(message.custom_headers)
+    message_json.tags = message.tags
+
     if message.api_template is not None:
         message_json.api_template = str(message.api_template)
 
     if message.reply_to_email_address:
         message_json.reply_to_email_address = email_address_to_address_json(message.reply_to_email_address)
 
+    print (message_json)
+
     return message_json
 
 

socketlabs/injectionapi/core/serialization/messagejson.py

@@ -2,6 +2,7 @@
 from .attachmentjson import AttachmentJson
 from .customheaderjson import CustomHeaderJson
 from .mergedatajson import MergeDataJson
+from .metadatajson import MetadataJson
 
 
 class MessageJson(object):
@@ -27,6 +28,8 @@ def __init__(self):
         self._cc_email_address = []
         self._bcc_email_address = []
         self._merge_data = None
+        self._metadata = []
+        self._tags = []
 
     @property
     def to_email_address(self):
@@ -165,7 +168,7 @@ def amp_body(self, val: str):
         :type val: str
         """
         self._amp_body = val
-        
+
     @property
     def api_template(self):
         """
@@ -355,6 +358,69 @@ def merge_data(self, val: MergeDataJson):
         """
         self._merge_data = val
 
+
+    @property
+    def metadata(self):
+        """
+       Get the list of MetadataJson.
+        :return list of MetadataJson
+        :rtype list
+        """
+        return self._metadata
+
+    @metadata.setter
+    def metadata(self, val: list):
+        """
+        Set the list of MetadataJson.
+        :param val: list of MetadataJson
+        :type val: list
+        """
+        self._metadata = []
+        if val is not None:
+            for item in val:
+                if isinstance(item, MetadataJson):
+                    self._metadata.append(item)
+
+    def add_metadata(self, name: str, val: str):
+        """
+        Add a MetadataJson to the metadata list
+        :param name: the name
+        :type val: str
+        :param val: the value
+        :type val: str
+        """
+        self._metadata.append(MetadataJson(name, val))
+
+    @property
+    def tags(self):
+        """
+       Get the list of tags.
+        :return list of tags
+        :rtype list
+        """
+        return self._tags
+
+    @tags.setter
+    def tags(self, val: list):
+        """
+        Set the list of tags.
+        :param val: list of tags
+        :type val: list
+        """
+        self._tags = []
+        if val is not None:
+            for item in val:
+                if isinstance(item, (dict, list)):
+                    self._tags.append(item)
+
+    def add_tags(self, val: str):
+        """
+        Add a string to the tags list
+        :param val: the value
+        :type val: str
+        """
+        self._tags.append(val)
+
     def to_json(self):
         """
         build json dict for MessageJson
@@ -426,4 +492,13 @@ def to_json(self):
         if self.merge_data:
             json["mergeData"] = self.merge_data.to_json()
 
+        if len(self.metadata) > 0:
+            e = []
+            for i in self.metadata:
+                e.append(i.to_json())
+            json["meta"] = e
+
+        if len(self.tags) > 0:
+            json["tags"] = self.tags
+
         return json

socketlabs/injectionapi/core/serialization/metadatajson.py

@@ -0,0 +1,63 @@
+class MetadataJson(object):
+    """
+    Represents a metadata as a name and value pair.
+    To be serialized into JSON string before sending to the Injection Api.
+    """
+
+    def __init__(self, name: str = None, val: str = None):
+        """
+        Initializes a new instance of the MetadataJson class
+        :param name: the name of the metadata
+        :type name: str
+        :param val: the value of the metadata
+        :type val: str
+        """
+        self._name = name
+        self._value = val
+
+    @property
+    def name(self):
+        """
+        The name of the metadata.
+        :return the name
+        :rtype str
+        """
+        return str(self._name)
+
+    @name.setter
+    def name(self, val: str):
+        """
+        Set the name of the metadata.
+        :param val: the name
+        :type val: str
+        """
+        self._name = val
+
+    @property
+    def value(self):
+        """
+        The value of the metadata.
+        :return the value
+        :rtype str
+        """
+        return str(self._value)
+
+    @value.setter
+    def value(self, val: str):
+        """
+        Set value of the metadata.
+        :param val: the value
+        :type val: str
+        """
+        self._value = val
+
+    def to_json(self):
+        """
+        build json dict for MetadataJson
+        :return the json dictionary
+        :rtype dict
+        """
+        return {
+            "name":  self._name,
+            "value": self._value
+        }