Merge pull request #6 from socketlabs/usr/mike.boshuyzen/update-meta-data-and-tags

david-schrenker · web-flow · commit ba00d1d06f07 · 2023-01-17T06:43:10.000-08:00
Updated go code templates to add meta data and tags.
diff --git a/.gitignore b/.gitignore
@@ -13,3 +13,5 @@ debug
 
 # Output of the go coverage tool, specifically when used with LiteIDE
 *.out
+
+.vs/*
diff --git a/README.md b/README.md
@@ -192,6 +192,7 @@ For more information about AMP please see [AMP Project](https://amp.dev/document
 
 <a name="version"></a>
 # Version
+* 1.4.0 - Adding Metadata and Tags
 * 1.2.1 - Adding optional retry logic for Http requests. If configured, the request will retry when certain 500 errors occur (500, 502, 503, 504)
 * 1.1.1 - Adding request timeout value on the client for Http requests
 * 1.1.0 - Adds Amp Html Support
diff --git a/examples/basic/BasicComplex/BasicSendComplex.go b/examples/basic/BasicComplex/BasicSendComplex.go
@@ -55,6 +55,13 @@ func main() {
 	//Configure custom message headers
 	basic.CustomHeaders = append(basic.CustomHeaders, message.NewCustomHeader("MyMessageHeader", "I am a message header"))
 
+	//Configure message meta data
+	basic.Metadata = append(basic.Metadata, message.NewMetadata("MyMetaDatra", "I am meta data"))
+
+	//Add message tags
+	basic.Tags = append(basic.Tags, "I am a Tag")
+	basic.Tags = append(basic.Tags, "go-Example")
+
 	//Send the message
 	sendResponse, _ := client.SendBasic(&basic)
 
diff --git a/examples/bulk/BulkComplex/BulkComplex.go b/examples/bulk/BulkComplex/BulkComplex.go
@@ -45,6 +45,12 @@ func main() {
 
 	bulk.AddCustomHeader("testMessageHeader", "I am a message header")
 
+	bulk.AddMetadata("testMetadata", "I am meta data")
+
+	//Add message tags
+	bulk.Tags = append(bulk.Tags, "I am a Tag")
+	bulk.Tags = append(bulk.Tags, "go-Example")
+
 	var htmlBody bytes.Buffer
 	htmlBody.WriteString("<html>")
 	htmlBody.WriteString("   <head><title>Complex</title></head>")
diff --git a/injectionapi/core/injectionrequestfactory.go b/injectionapi/core/injectionrequestfactory.go
@@ -78,6 +78,7 @@ func (factory InjectionRequestFactory) GenerateBulkRequest(message *message.Bulk
 		MessageID:   message.MessageId,
 		CharSet:     message.CharSet,
 		APITemplate: message.ApiTemplate,
+		Tags:		 message.Tags,
 	}
 
 	//set attachments
@@ -86,6 +87,9 @@ func (factory InjectionRequestFactory) GenerateBulkRequest(message *message.Bulk
 	//set custom headers
 	messageJson.CustomHeaders = getCustomHeaders(&message.CustomHeaders)
 
+	//set meta data
+	messageJson.Metadata = getMetadata(&message.Metadata)
+
 	//set from address
 	messageJson.From = serialization.AddressJson{
 		EmailAddress: message.From.EmailAddress,
@@ -197,6 +201,25 @@ func getCustomHeaders(customHeaders *[]message.CustomHeader) []serialization.Cus
 	return results
 }
 
+// getMetadata converts meta data to json-serialization ready format
+func getMetadata(metadata *[]message.Metadata) []serialization.MetadataJson {
+
+	if len(*metadata) == 0 {
+		return nil
+	}
+
+	var results = []serialization.MetadataJson{}
+
+	for _, sourceData := range *metadata {
+		results = append(results, serialization.MetadataJson{
+			Key:  sourceData.Key,
+			Value: sourceData.Value,
+		})
+	}
+
+	return results
+}
+
 // getBulkMergeFields extracts merge fields from slice of bulk recipients in a json-serialization ready format
 func getBulkMergeFields(bulkRecipients *[]message.BulkRecipient) [][]serialization.MergeFieldJson {
 
diff --git a/injectionapi/core/serialization/MetadataJson.go b/injectionapi/core/serialization/MetadataJson.go
@@ -0,0 +1,12 @@
+package serialization
+
+// MetadataJson represents a piece of meta data as a key and value pair.
+// To be serialized into JSON string before sending to the Injection Api.
+type MetadataJson struct {
+
+	// Gets or sets the meta data key
+	Key string `json:"Key"`
+
+	// Gets or sets the meta data value
+	Value string `json:"Value"`
+}
diff --git a/injectionapi/core/serialization/messageJson.go b/injectionapi/core/serialization/messageJson.go
@@ -51,4 +51,11 @@ type MessageJson struct {
 
 	// List of custom message headers added to the message.
 	CustomHeaders []CustomHeadersJson `json:"CustomHeaders,omitempty"`
+
+	// List of custom meta data added to the message.
+	Metadata []MetadataJson `json:"Metadata,omitempty"`
+
+	// List of tags added to the message.
+	Tags []string `json:"Tags,omitempty"`
+
 }
diff --git a/injectionapi/message/basicmessage.go b/injectionapi/message/basicmessage.go
@@ -52,6 +52,14 @@ type BasicMessage struct {
 	//(Optional)
 	CustomHeaders []CustomHeader
 
+	//Optional collection of meta data for the message.
+	//(Optional)
+	Metadata []Metadata
+
+	//Optional collection of tags for the message.
+	//(Optional)
+	Tags []string
+
 	//Collection of To Recipients for the message.
 	To []EmailAddress
 
@@ -104,3 +112,14 @@ func (basic *BasicMessage) AddCustomHeader(name string, value string) {
 	customHeader := NewCustomHeader(name, value)
 	basic.CustomHeaders = append(basic.CustomHeaders, customHeader)
 }
+
+// AddMetadata adds meta data to the message
+func (basic *BasicMessage) AddMetadata(key string, value string) {
+	metadata := NewMetadata(key, value)
+	basic.Metadata = append(basic.Metadata, metadata)
+}
+
+// AddTag adds a tag to the message
+func (basic *BasicMessage) AddTag(value string) {
+	basic.Tags = append(basic.Tags, value)
+}
diff --git a/injectionapi/message/bulkmessage.go b/injectionapi/message/bulkmessage.go
@@ -52,6 +52,14 @@ type BulkMessage struct {
 	// (Optional)
 	CustomHeaders []CustomHeader
 
+	//Optional collection of meta data for the message.
+	//(Optional)
+	Metadata []Metadata
+
+	//Optional collection of tags for the message.
+	//(Optional)
+	Tags []string
+
 	//Collection of To Recipients for the message.
 	To []BulkRecipient
 
@@ -80,6 +88,17 @@ func (bulk *BulkMessage) AddCustomHeader(name string, value string) {
 	bulk.CustomHeaders = append(bulk.CustomHeaders, customHeader)
 }
 
+// AddCustomHeader adds meta data to the message
+func (bulk *BulkMessage) AddMetadata(key string, value string) {
+	metadata := NewMetadata(key, value)
+	bulk.Metadata = append(bulk.Metadata, metadata)
+}
+
+// AddCustomHeader adds a tag to the message
+func (bulk *BulkMessage) AddTag(value string) {
+	bulk.Tags = append(bulk.Tags, value)
+}
+
 // AddGlobalMergeData adds global merge data
 func (bulk *BulkMessage) AddGlobalMergeData(key string, value string) {
 	if bulk.Global == nil || len(bulk.Global) == 0 {
diff --git a/injectionapi/message/metadata.go b/injectionapi/message/metadata.go
@@ -0,0 +1,29 @@
+package message
+
+// CustomHeader  info
+type Metadata struct {
+	Key  string
+	Value string
+}
+
+// NewMetadata  Factory Constructor
+func NewMetadata(key string, value string) Metadata {
+	var c Metadata
+	c.Key = key
+	c.Value = value
+	return c
+}
+
+// IsValid  Determines if the Metadata is valid
+func (c Metadata) IsValid() bool {
+
+	if len(c.Key) == 0 {
+		return false
+	}
+
+	if len(c.Value) == 0 {
+		return false
+	}
+
+	return true
+}
diff --git a/injectionapi/sendresult.go b/injectionapi/sendresult.go
@@ -91,6 +91,8 @@ func (sendResult SendResult) ToResponseMessage() string {
 		return "SDK Validation Error : No message body was found in the message"
 	case SendResultMESSAGEVALIDATIONINVALIDCUSTOMHEADERS:
 		return "SDK Validation Error : Invalid Custom Headers were found in the message"
+	case SendResultMESSAGEVALIDATIONINVALIDMETADATA:
+		return "SDK Validation Error : Invalid Meta Data was found in the message"
 	case SendResultRECIPIENTVALIDATIONINVALIDREPLYTO:
 		return "SDK Validation Error : Invalid ReplyTo Address was found in the message"
 	case SendResultRECIPIENTVALIDATIONINVALIDRECIPIENTS:
@@ -137,7 +139,8 @@ var m = map[SendResult]string{
 	SendResultRECIPIENTVALIDATIONINVALIDRECIPIENTS:  "RecipientValidationInvalidRecipients",
 	SendResultMESSAGEVALIDATIONEMPTYSUBJECT:         "MessageValidationEmptySubject",
 	SendResultMESSAGEVALIDATIONEMPTYMESSAGE:         "MessageValidationEmptyMessage",
-	SendResultMESSAGEVALIDATIONINVALIDCUSTOMHEADERS: "MessageValidationInvalidCustomHeaders"}
+	SendResultMESSAGEVALIDATIONINVALIDCUSTOMHEADERS: "MessageValidationInvalidCustomHeaders",
+	SendResultMESSAGEVALIDATIONINVALIDMETADATA:		 "MessageValidationInvalidMetadata"}
 
 const (
 	//SendResultUNKNOWNERROR - An error has occured that was unforeseen
@@ -250,4 +253,7 @@ const (
 
 	//SendResultMESSAGEVALIDATIONINVALIDCUSTOMHEADERS -  Invalid custom headers found
 	SendResultMESSAGEVALIDATIONINVALIDCUSTOMHEADERS
+
+	//SendResultMESSAGEVALIDATIONINVALIDMETADATA -  Invalid meta data found
+	SendResultMESSAGEVALIDATIONINVALIDMETADATA
 )
diff --git a/injectionapi/sendvalidator.go b/injectionapi/sendvalidator.go
@@ -45,6 +45,9 @@ func (sendValidator) ValidateBasicMessage(basicMessage message.BasicMessage) (re
 	} else if !isValidBasicMessageCustomHeaders(basicMessage) {
 		response.Result = SendResultMESSAGEVALIDATIONINVALIDCUSTOMHEADERS
 
+	} else if !isValidBasicMessageMetadata(basicMessage) {
+		response.Result = SendResultMESSAGEVALIDATIONINVALIDMETADATA
+
 	} else {
 		response.Result = SendResultSUCCESS
 		validRecipientCount, allRecipients := isValidBasicRecipientCount(basicMessage)
@@ -87,6 +90,8 @@ func (sendValidator) ValidateBulkMessage(bulkMessage message.BulkMessage) (respo
 		response.Result = SendResultRECIPIENTVALIDATIONINVALIDREPLYTO
 	} else if !isValidBulkMessageCustomHeaders(bulkMessage) {
 		response.Result = SendResultMESSAGEVALIDATIONINVALIDCUSTOMHEADERS
+	} else if !isValidBulkMessageMetadata(bulkMessage) {
+		response.Result = SendResultMESSAGEVALIDATIONINVALIDMETADATA
 	} else {
 		response.Result = SendResultSUCCESS
 		validRecipientCount, allRecipients := isValidBulkRecipientCount(bulkMessage)
@@ -178,6 +183,36 @@ func isValidBulkMessageCustomHeaders(message message.BulkMessage) bool {
 	return true
 }
 
+func isValidBasicMessageMetadata(message message.BasicMessage) bool {
+	if message.Metadata == nil {
+		return true
+	}
+	if len(message.Metadata) == 0 {
+		return true
+	}
+	for _, metadata := range message.Metadata {
+		if !metadata.IsValid() {
+			return false
+		}
+	}
+	return true
+}
+
+func isValidBulkMessageMetadata(message message.BulkMessage) bool {
+	if message.Metadata == nil {
+		return true
+	}
+	if len(message.Metadata) == 0 {
+		return true
+	}
+	for _, metadata := range message.Metadata {
+		if !metadata.IsValid() {
+			return false
+		}
+	}
+	return true
+}
+
 func isValidBasicRecipientCount(message message.BasicMessage) (isValid bool, allRecipients []message.EmailAddress) {
 	allRecipients = append(message.To, message.Bcc...)
 	allRecipients = append(allRecipients, message.Cc...)

-Original file line number
+Diff line change
 # Output of the go coverage tool, specifically when used with LiteIDE
 *.out
++
 +.vs/*