socketlabs-injectionapi 0.0.1.pre.Dev

data/lib/socketlabs/injectionapi/core/serialization/merge_data_json.rb

@@ -0,0 +1,103 @@
+module SocketLabs
+  module InjectionApi
+    module Core
+      module Serialization
+
+        class MergeDataJson
+
+          # @param [Array] per_message
+          # @param [Array] global_merge_data
+          def initialize(
+              per_message = nil,
+              global_merge_data = nil
+          )
+            self.per_message_merge_data = per_message
+            self.global_merge_data = global_merge_data
+          end
+
+          # Get merge field data for each message.
+          # @return [Array]
+          def per_message_merge_data
+            @per_message_merge_data
+          end
+
+          # Set merge field data for each message.
+          # @param [Array] value
+          def per_message_merge_data=(value)
+            @per_message_merge_data = Array.new
+
+            unless value.nil?
+              value.each do |v1|
+                l1 = Array.new
+                v1.each do |v2|
+                  if v2.instance_of? MergeFieldJson
+                    l1.push(v2)
+                  end
+                end
+                @per_message_merge_data.push(l1)
+              end
+
+            end
+
+            # Get merge field data for all messages in the request
+            # @return [Array]
+            def global_merge_data
+              @global_merge_data
+            end
+
+            # Set merge field data for all messages in the request
+            # @param [Array] value
+            def global_merge_data=(value)
+              @global_merge_data = Array.new
+
+              unless value.nil?
+                value.each do |v1|
+                  if v1.instance_of? MergeFieldJson
+                     @global_merge_data.push(v1)
+                  end
+                end
+
+              end
+
+              # build json hash for MergeDataJson
+              # @return [hash]
+              def to_hash
+
+                json = {}
+
+                if @global_merge_data.length > 0
+                  e = Array.new
+                  @global_merge_data.each do |value|
+                    e.push(value.to_hash)
+                  end
+                  json[:global] = e
+                end
+
+                if @per_message_merge_data.length > 0
+                  e = Array.new
+                  @per_message_merge_data.each do |message|
+                    m = Array.new
+                    message.each do |value|
+                      m.push(value.to_hash)
+                    end
+                    e.push(m)
+                  end
+                  json[:perMessage] = e
+                end
+
+                json
+              end
+
+              def empty
+                @global_merge_data.length <= 0 &&  @per_message_merge_data.length <= 0
+              end
+
+            end
+
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/socketlabs/injectionapi/core/serialization/merge_field_json.rb

@@ -0,0 +1,40 @@
+module SocketLabs
+  module InjectionApi
+    module Core
+      module Serialization
+
+        # Represents a merge field as a field and value pair.
+        # To be serialized into JSON string before sending to the Injection Api.
+        class MergeFieldJson
+
+          # The field of your merge field.
+          attr_accessor :field
+          # The merge field value.
+          attr_accessor :value
+
+          # Initializes a new instance of the MergeFieldJson class
+          # @param [String] field
+          # @param [String] value
+          def initialize(
+            field = nil,
+            value = nil
+          )
+            @field = field
+            @value = value
+          end
+
+          # build json hash for MergeFieldJson
+          # @return [hash]
+          def to_hash
+            {
+              :field => @field,
+              :value => @value
+            }
+          end
+
+        end
+
+      end
+    end
+  end
+end

data/lib/socketlabs/injectionapi/core/serialization/message_json.rb

@@ -0,0 +1,250 @@
+module SocketLabs
+  module InjectionApi
+    module Core
+      module Serialization
+
+        class MessageJson
+
+          # the message subject.
+          attr_accessor :subject
+          # the plain text portion of the message body.
+          attr_accessor :plain_text_body
+          # the HTML portion of the message body.
+          attr_accessor :html_body
+          # the api template.
+          attr_accessor :api_template
+          # the custom mailing id.
+          attr_accessor :mailing_id
+          # the custom message id.
+          attr_accessor :message_id
+          # the optional character set. Default is UTF-8
+          attr_accessor :charset
+          # the from email address.
+          attr_accessor :from_email_address
+          # the optional reply to email address.
+          attr_accessor :reply_to
+          # the the MergeDataJson for the message
+          attr_accessor :merge_data
+
+
+          def initialize
+
+            @subject = nil
+            @plain_text_body = nil
+            @html_body = nil
+            @api_template = nil
+            @mailing_id = nil
+            @message_id = nil
+            @charset = nil
+            @from_email_address = nil
+            @reply_to = nil
+            @merge_data = MergeDataJson.new
+            @attachments = Array.new
+            @custom_headers = Array.new
+            @to_email_address = Array.new
+            @cc_email_address = Array.new
+            @bcc_email_address = Array.new
+
+          end
+
+          # Get the list of attachments.
+          # @return [Array]
+          def attachments
+            @attachments
+          end
+          # Set the list of AttachmentJson.
+          # @param [Array] value
+          def attachments=(value)
+            @attachments = Array.new
+            unless value.nil? || value.empty?
+              value.each do |v1|
+                if v1.instance_of? AttachmentJson
+                  @attachments.push(v1)
+                end
+              end
+            end
+          end
+
+          # Add an AttachmentJson to the attachments list.
+          # @param [AttachmentJson] value
+          def add_attachments(value)
+            if value.instance_of? AttachmentJson
+              @attachments.push(value)
+            end
+          end
+
+          #custom_headers
+          # Get the list of CustomHeaderJson.
+          # @return [Array]
+          def custom_headers
+            @custom_headers
+          end
+          # Set the list of CustomHeaderJson.
+          # @param [Array] value
+          def custom_headers=(value)
+            @custom_headers = Array.new
+            unless value.nil? || value.empty?
+              value.each do |v1|
+                if v1.instance_of? CustomHeaderJson
+                  @custom_headers.push(v1)
+                end
+              end
+            end
+          end
+
+          # Add a CustomHeaderJson to the custom header list
+          # @param [CustomHeaderJson] value
+          def add_custom_header(value)
+            if value.instance_of? CustomHeaderJson
+              @custom_headers.push(value)
+            end
+          end
+
+          # Get the To email address list
+          # @return [Array]
+          def to_email_address
+            @to_email_address
+          end
+          # Set the To email address list
+          # @param [Array] value
+          def to_email_address=(value)
+            @to_email_address = Array.new
+            unless value.nil? || value.empty?
+              value.each do |v1|
+                if v1.instance_of? AddressJson
+                  @to_email_address.push(v1)
+                end
+              end
+            end
+          end
+
+          # Get the CC email address list
+          # @return [Array]
+          def cc_email_address
+            @cc_email_address
+          end
+          # Set the CC email address list
+          # @param [Array] value
+          def cc_email_address=(value)
+            @cc_email_address = Array.new
+            unless value.nil? || value.empty?
+              value.each do |v1|
+                if v1.instance_of? AddressJson
+                  @cc_email_address.push(v1)
+                end
+              end
+            end
+          end
+
+          # Get the BCC email address list
+          # @return [Array]
+          def bcc_email_address
+            @bcc_email_address
+          end
+          # Set the BCC email address list
+          # @param [Array] value
+          def bcc_email_address=(value)
+            @bcc_email_address = Array.new
+            unless value.nil? || value.empty?
+              value.each do |v1|
+                if v1.instance_of? AddressJson
+                  @bcc_email_address.push(v1)
+                end
+              end
+            end
+          end
+
+          # build json hash for MessageJson
+          # @return [hash]
+          def to_hash
+
+            json = {
+                :from => @from_email_address.to_hash
+            }
+
+            unless @subject.nil? || @subject.empty?
+              json[:subject] = @subject
+            end
+
+            unless @html_body.nil? || @html_body.empty?
+              json[:htmlBody] = @html_body
+            end
+
+            unless @plain_text_body.nil? || @plain_text_body.empty?
+              json[:textBody] = @plain_text_body
+            end
+
+            unless @api_template.nil?
+              json[:apiTemplate] = @api_template
+            end
+
+            unless @mailing_id.nil? || @mailing_id.empty?
+              json[:mailingId] = @mailing_id
+            end
+
+            unless @message_id.nil? || @message_id.empty?
+              json[:messageId] = @message_id
+            end
+
+            unless @reply_to.nil?
+              json[:replyTo] = @reply_to.to_hash
+            end
+
+            unless @charset.nil? || @charset.empty?
+              json[:charSet] = @charset
+            end
+
+            unless @to_email_address.nil? || @to_email_address.length == 0
+              e = Array.new
+              @to_email_address.each do |value|
+                  e.push(value.to_hash)
+              end
+              json[:to] = e
+            end
+
+            unless @cc_email_address.nil? || @cc_email_address.length == 0
+              e = Array.new
+              @cc_email_address.each do |value|
+                e.push(value.to_hash)
+              end
+              json[:cc] = e
+            end
+
+            unless @bcc_email_address.nil? || @bcc_email_address.length == 0
+              e = Array.new
+              @bcc_email_address.each do |value|
+                e.push(value.to_hash)
+              end
+              json[:bcc] = e
+            end
+
+            unless @custom_headers.nil? || @custom_headers.length == 0
+              e = Array.new
+              @custom_headers.each do |value|
+                e.push(value.to_hash)
+              end
+              json[:customHeaders] = e
+            end
+
+            unless @attachments.nil? || @attachments.length == 0
+              e = Array.new
+              @attachments.each do |value|
+                e.push(value.to_hash)
+              end
+              json[:attachments] = e
+            end
+
+            unless @merge_data.nil? || @merge_data.empty
+                json[:mergeData] = @merge_data.to_hash
+            end
+
+            json
+
+          end
+
+        end
+      end
+    end
+  end
+end
+

data/lib/socketlabs/injectionapi/core/serialization/message_result_dto.rb

@@ -0,0 +1,66 @@
+require_relative '../../address_result.rb'
+
+module SocketLabs
+  module InjectionApi
+    module Core
+      module Serialization
+
+        class MessageResultDto
+          include SocketLabs::InjectionApi
+
+          attr_accessor :index
+          attr_accessor :error_code
+
+          def initialize
+            @index = nil
+            @error_code = nil
+            @address_results = Array.new
+          end
+
+            
+          # Get the List of AddressResult objects
+          # @return [Array]
+          def address_results 
+            @address_results
+          end
+          
+          # Set the List of AddressResult objects
+          # @param [Array] value
+          def address_results=(value) 
+            @address_results = Array.new
+
+            unless value.nil?
+
+              if value.instance_of? Array
+                value.each do |v1|                  
+                  if v1.instance_of? AddressResult
+                    @address_results.push(v1)
+                  end
+                end
+              end
+
+            end
+          end
+
+
+          def to_hash
+            json = {
+                :ErrorCode => @error_code,
+                :Index => @index
+            }
+            if @address_results.length > 0
+              e = Array.new
+              @address_results.each do |value|
+                e.push(value.to_hash)
+              end
+
+              json[:AddressResult] = e
+            end
+            json
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/socketlabs/injectionapi/core/string_extension.rb

@@ -0,0 +1,74 @@
+module SocketLabs
+  module InjectionApi
+    module Core
+
+      class StringExtension
+
+        private
+        def strip_or_self!(str)
+          str.strip! || str if str
+        end
+
+        def value_empty(value)
+          value.nil? || value.empty?
+        end
+
+        def has_invalid_parts(value)
+          value.count('@') != 1
+        end
+
+        def is_part_empty(value)
+
+          unless value_empty(value)
+            true
+          end
+
+          part = strip_or_self!(value)
+
+          unless value_empty(part)
+            true
+          end
+
+          part.length <= 0
+
+        end
+
+        def has_invalid_characters(value)
+          [',', ' ', ';', 191.chr].each do |x|
+            if value.include? x
+              true
+            end
+          end
+          false
+        end
+
+        public
+        def is_valid_email_address(email_address)
+
+          if value_empty(email_address)
+            false
+          else
+
+            if has_invalid_parts(email_address) || has_invalid_characters(email_address)
+              false
+            else
+              parts = email_address.split('@')
+              if parts.count != 2
+                false
+              else
+                !(is_part_empty(parts[0]) || is_part_empty(parts[1]))
+              end
+
+            end
+
+          end
+
+
+        end
+
+      end
+
+
+    end
+  end
+end

data/lib/socketlabs/injectionapi/message/attachment.rb

@@ -0,0 +1,146 @@
+require 'base64'
+require_relative '../core/string_extension.rb'
+
+module SocketLabs
+  module InjectionApi
+    module Message
+
+      # Represents a custom header as a name-value pair.
+      # Example:
+      #
+      #   attachment1 = Attachment(file_path="./bus.png")
+      #
+      #   attachment2 = Attachment("bus", "image/png", "../bus.png")
+      #
+      #   attachment3 = Attachment("bus", "image/png", content=bytes())
+      #   attachment3.add_custom_header("name1", "value1")
+      #   attachment3.add_custom_header("name2", "value2")
+      class Attachment
+
+        # Name of attachment (displayed in email clients).
+        attr_accessor :name
+        # BASE64 encoded string containing the contents of an attachment.
+        attr_accessor :content
+        # The MIME type of the attachment.
+        attr_accessor :mime_type
+        # A list of custom headers for the attachment.
+        attr_accessor :custom_headers
+        # The local file path for your attachment, used to stream the file in.
+        attr_accessor :file_path
+        # The contentId for your attachment, used if you need to reference the attachment in your email content.
+        attr_accessor :content_id
+
+        # Initializes a new instance of the CustomHeader class
+        # @param [merge] arguments - accepted arguments file_path, name, mime_type, content_id, custom_headers, content
+
+        def initialize(arguments)
+
+          @custom_headers = Array.new
+
+          unless arguments[:file_path].nil? || arguments[:file_path].empty?
+            readfile(arguments[:file_path])
+          end
+
+          unless arguments[:name].nil? || arguments[:name].empty?
+            @name = arguments[:name]
+          end
+
+          unless arguments[:mime_type].nil? || arguments[:mime_type].empty?
+            @mime_type = arguments[:mime_type]
+          end
+
+          @content_id = arguments[:content_id]
+
+          @custom_headers = []
+          unless arguments[:custom_headers].nil? || arguments[:custom_headers].empty?
+            @custom_headers = arguments[:custom_headers]
+          end
+
+          unless arguments[:content].nil? || arguments[:content].empty?
+            @content = arguments[:content]
+          end
+
+        end
+
+        # Read the specified file and get a str containing the resulting binary data.
+        # @param [String] file_path
+        def readfile(file_path)
+
+          @file_path = file_path
+          @name = File.basename(file_path)
+          @mime_type = get_mime_type_from_ext(File.extname(file_path))
+
+          file = File.open(file_path, "rb")
+          encoded_string = Base64.encode64(file.read)
+          @content = encoded_string
+
+        end
+
+        # Takes a file extension, minus the '.', and returns the corresponding MimeType for the given extension.
+        # @param [String] extension
+        # @return [String] mime type
+        def get_mime_type_from_ext(extension)
+          extension[0]=''
+          types = [
+            { :ext => "txt", :mime_type => "text/plain" },
+            { :ext => "ini", :mime_type => "text/plain" },
+            { :ext => "sln", :mime_type => "text/plain" },
+            { :ext => "cs", :mime_type => "text/plain" },
+            { :ext => "js", :mime_type => "text/plain" },
+            { :ext => "config", :mime_type => "text/plain" },
+            { :ext => "vb", :mime_type => "text/plain" },
+            { :ext => :"jpg", :mime_type => "image/jpeg" },
+            { :ext => "jpeg", :mime_type => "image/jpeg" },
+            { :ext => "bmp", :mime_type => "image/bmp" },
+            { :ext => "csv", :mime_type => "text/csv" },
+            { :ext => "doc", :mime_type => "application/msword" },
+            { :ext => "docx", :mime_type => "application/vnd.openxmlformats-officedocument.wordprocessingml.document" },
+            { :ext => "gif", :mime_type => "image/gif" },
+            { :ext => "html", :mime_type => "text/html" },
+            { :ext => "pdf", :mime_type => "application/pdf" },
+            { :ext => "png", :mime_type => "image/png" },
+            { :ext => "ppt", :mime_type => "application/vnd.ms-powerpoint" },
+            { :ext => "pptx", :mime_type => "application/vnd.openxmlformats-officedocument.presentationml.presentation" },
+            { :ext => "xls", :mime_type => "application/vnd.ms-excel" },
+            { :ext => "xlsx", :mime_type => "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" },
+            { :ext => "xml", :mime_type => "application/xml" },
+            { :ext => "zip", :mime_type => "application/x-zip-compressed" },
+            { :ext => "wav", :mime_type => "audio/wav" },
+            { :ext => "eml", :mime_type => "message/rfc822" },
+            { :ext => "mp3", :mime_type => "audio/mpeg" },
+            { :ext => "mp4", :mime_type => "video/mp4" },
+            { :ext => "mov", :mime_type => "video/quicktime" }
+          ]
+          mime = types.find {|x| x[:ext] == extension}
+
+            unless mime.nil? || mime.empty?
+            "application/octet-stream"
+            end
+            mime[:mime_type]
+        end
+
+        # Add a CustomHeader to the attachment
+        # @param [String/CustomHeader] name
+        # @param [String] value
+        def add_custom_header(name, value)
+
+          if name.kind_of? CustomHeader
+            @custom_headers.push(name)
+
+          elsif name.kind_of? String
+            @custom_headers.push(CustomHeader.new(name, value))
+
+          end
+        end
+
+        # Represents the Attachment as a String
+        # @return [String]
+        def to_s
+            "#{@name}, #{@mime_type}"
+        end
+
+
+      end
+    end
+  end
+end