socketlabs-injectionapi 0.0.1.pre.Dev

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

@@ -0,0 +1,136 @@
+require_relative 'message_base.rb'
+require_relative 'email_address.rb'
+
+module SocketLabs
+  module InjectionApi
+    module Message
+      class BasicMessage < MessageBase
+
+        def initialize(arguments = nil)
+          super
+
+          @to_email_address = Array.new
+          @cc_email_address = Array.new
+          @bcc_email_address = Array.new
+
+        end
+
+        # Get the To EmailAddress list
+        def to_email_address
+          @to_email_address
+        end
+        # Set the To EmailAddress list
+        def to_email_address=(value)
+          @to_email_address = Array.new
+          convert_email_address(@to_email_address, value)
+        end
+        # Add an EmailAddress to the To recipient list.
+        # @param [String] email_address
+        # @param [String] friendly_name
+        def add_to_email_address(email_address, friendly_name = nil)
+          convert_email_address(@to_email_address, email_address, friendly_name)
+        end
+
+        # Get the CC EmailAddress list
+        def cc_email_address
+          @cc_email_address
+        end
+        # Set the CC EmailAddress list
+        def cc_email_address=(value)
+          @cc_email_address = Array.new
+          convert_email_address(@cc_email_address, value)
+        end
+        # Add an EmailAddress to the CC recipient list.
+        # @param [String] email_address
+        # @param [String] friendly_name
+        def add_cc_email_address(email_address, friendly_name = nil)
+          convert_email_address(@cc_email_address, email_address, friendly_name)
+        end
+
+        # Get the CC EmailAddress list
+        def bcc_email_address
+          @bcc_email_address
+        end
+        # Set the CC EmailAddress list
+        def bcc_email_address=(value)
+          @bcc_email_address = Array.new
+          convert_email_address(@bcc_email_address, value)
+        end
+        # Add an EmailAddress to the CC recipient list.
+        # @param [String] email_address
+        # @param [String] friendly_name
+        def add_bcc_email_address(email_address, friendly_name = nil)
+          convert_email_address(@bcc_email_address, email_address, friendly_name)
+        end
+
+
+        def to_s
+          c = @to_email_address.any? ? @to_email_address.count : 0
+          c = c + (@cc_email_address.any? ? @cc_email_address.count : 0)
+          c = c + (@bcc_email_address.any? ? @bcc_email_address.count : 0)
+
+          "Recipients: #{c}, Subject: '#{@subject}'"
+
+        end
+
+        def to_json
+          {
+              subject: @subject,
+              textBody: @plain_text_body,
+              htmlBody: @html_body,
+              apiTemplate: @api_template,
+              mailingId: @mailing_id,
+              messageId: @message_id,
+              charSet: @charset,
+              from: @from_email_address,
+              replyTo: @reply_to_email_address,
+              attachments: @attachments,
+              customHeaders: @custom_headers,
+              to: @to_email_address,
+              cc: @cc_email_address,
+              bcc: @bcc_email_address
+          }
+        end
+
+        private
+        def convert_email_address(array_instance, email_address, friendly_name = nil)
+
+          if email_address.kind_of? Array
+            convert_email_address_array(array_instance, email_address)
+          else
+            convert_email_address_object(array_instance, email_address, friendly_name)
+          end
+        end
+
+        def convert_email_address_object(array_instance, email_address, friendly_name = nil)
+          unless email_address.nil?
+
+            if email_address.kind_of? EmailAddress
+              array_instance.push(email_address)
+
+            elsif email_address.kind_of? String
+              array_instance.push(EmailAddress.new(email_address, friendly_name))
+
+            elsif email_address.kind_of? Hash or email_address.kind_of? OpenStruct
+              array_instance.push(EmailAddress.new(email_address[:email_address], email_address[:friendly_name]))
+
+            end
+
+          end
+
+        end
+
+        def convert_email_address_array(array_instance, value)
+
+          if value.kind_of? Array
+            value.each do |x|
+              convert_email_address_object(array_instance, x)
+            end
+          end
+
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,103 @@
+require_relative 'message_base.rb'
+require_relative 'bulk_recipient.rb'
+
+module SocketLabs
+  module InjectionApi
+    module Message
+      class BulkMessage < MessageBase
+
+        def initialize(arguments = nil)
+          super
+          @to_recipient = Array.new
+          @global_merge_data = Array.new
+        end
+
+        attr_accessor :global_merge_data
+
+        # Get the To BulkRecipient list
+        def to_recipient
+          @to_recipient
+        end
+        # Set the To BulkRecipient list
+        def to_recipient=(value)
+          @to_recipient = Array.new
+          convert_bulk_recipient(@to_email_address, value)
+        end
+
+        # Add an BulkRecipient to the To recipient list.
+        # @param [String] email_address
+        # @param [String] friendly_name
+        # @param [Array] merge_data
+        def add_to_recipient(email_address, friendly_name = nil, merge_data = nil)
+          convert_bulk_recipient(@to_recipient, email_address, friendly_name, merge_data)
+        end
+
+        def add_global_merge_data(key, value)
+          @global_merge_data.push(MergeData.new(key, value))
+        end
+
+        def to_s
+          c = @to_recipient.any? ? @to_recipient.count : 0
+          "Recipients: #{c}, Subject: '#{@subject}'"
+        end
+
+        def to_json
+          {
+            subject: @subject,
+            textBody: @plain_text_body,
+            htmlBody: @html_body,
+            apiTemplate: @api_template,
+            mailingId: @mailing_id,
+            messageId: @message_id,
+            charSet: @charset,
+            from: @from_email_address,
+            replyTo: @reply_to_email_address,
+            attachments: @attachments,
+            customHeaders: @custom_headers,
+            to: @to_recipient,
+            global_merge_data: @global_merge_data
+          }
+        end
+
+        private
+        def convert_bulk_recipient(array_instance, recipient, friendly_name = nil, merge_data = nil)
+
+          if recipient.kind_of? Array
+            convert_bulk_recipient_array(array_instance, recipient)
+          else
+            convert_bulk_recipient_object(array_instance, recipient, friendly_name, merge_data)
+          end
+        end
+
+        def convert_bulk_recipient_object(array_instance, recipient, friendly_name = nil, merge_data = nil)
+          unless recipient.nil?
+
+            if recipient.kind_of? BulkRecipient
+              array_instance.push(recipient)
+
+            elsif recipient.kind_of? String
+              array_instance.push(BulkRecipient.new(recipient, { :friendly_name => friendly_name, :merge_data => merge_data }))
+
+            elsif recipient.kind_of? Hash or recipient.kind_of? OpenStruct
+              array_instance.push(BulkRecipient.new(email_address[:email_address], { :friendly_name => email_address[:friendly_name], :merge_data => email_address[:merge_data] }, ))
+
+            end
+
+          end
+
+        end
+
+        def convert_bulk_recipient_array(array_instance, value)
+
+          if value.kind_of? Array
+            value.each do |x|
+              convert_email_address_object(array_instance, x)
+            end
+          end
+
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,87 @@
+require_relative '../core/string_extension.rb'
+
+module SocketLabs
+  module InjectionApi
+    module Message
+
+        # Represents an individual BulkRecipient for a message.
+        # Example:
+        #   email_address1 = BulkRecipient.new("recipient@example.com")
+        #
+        #   email_address2 = BulkRecipient.new("recipient@example.com", "Recipient")
+        #
+        #   email_address3 = BulkRecipient.new("recipient@example.com", "Recipient")
+        #   email_address3.merge_data.push(MergeData.new("name1", "value1"))
+        #   email_address3.add_merge_data("name2", "value2")
+        class BulkRecipient
+          include SocketLabs::InjectionApi
+          include SocketLabs::InjectionApi::Core
+
+        # A valid email address.
+        attr_accessor :email_address
+        # The friendly or display name for the recipient.
+        attr_accessor :friendly_name
+        # Merge data unique to the instance of the bulk recipient.
+        attr_accessor :merge_data
+
+        # Creates a new instance of the BulkRecipient class.
+        # @param [String] email_address
+        # @param [Hash] arguments
+        def initialize(
+            email_address,
+            arguments = nil
+        )
+          @email_address = email_address
+          @merge_data = Array.new
+
+          unless arguments.nil? || arguments.empty?
+
+            unless arguments[:friendly_name].nil? || arguments[:friendly_name].empty?
+              @friendly_name = arguments[:friendly_name]
+            end
+
+            unless arguments[:merge_data].nil? || arguments[:merge_data].empty?
+              unless arguments[:merge_data].nil? || arguments[:merge_data].empty?
+                arguments[:merge_data].each do |value|
+                  if value.instance_of? MergeData
+                    @merge_data.push(value)
+                  elsif value.instance_of? Hash
+                    @merge_data.push(MergeData.new(value[:key], value[:value]))
+                  end
+                end
+              end
+            end
+
+          end
+
+        end
+
+        # Add to an Array of MergeData
+        # @param [String] key
+        # @param [String] value
+        def add_merge_data(key, value)
+          @merge_data.push(MergeData.new(key, value))
+        end
+
+        # Determines if the BulkRecipient is valid. Does simple syntax validation on the email address.
+        # @return [Boolean]
+        def is_valid
+          StringExtension.new.is_valid_email_address(@email_address)
+        end
+
+        # Represents the BulkRecipient as a string
+        # @return [String]
+        def to_s
+          if @friendly_name.nil? || @friendly_name.empty?
+            @email_address
+          else
+            "#{@friendly_name} <#{@email_address}>"
+          end
+
+        end
+
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,53 @@
+require_relative '../core/string_extension.rb'
+
+module SocketLabs
+  module InjectionApi
+    module Message
+
+      # Represents a custom header as a name-value pair.
+      # Example:
+      #
+      #   header1 = CustomHeader.new
+      #   header1.name = "name1"
+      #   header1.value = "value1"
+      #
+      #   header2 = CustomHeader.new("name2", "value2")
+
+      class CustomHeader
+
+        # the name of the custom header
+        attr_accessor :name
+        # the value of the custom header
+        attr_accessor :value
+
+        # Initializes a new instance of the CustomHeader class
+        # @param [String] name
+        # @param [String] value
+        def initialize(
+            name = nil,
+            value = nil
+        )
+          @name = name
+          @value = value
+        end
+
+        # Determines if the CustomHeader is valid.
+        # @return [Boolean]
+        def is_valid
+          valid_name = !(@name.nil? || @name.empty?)
+          valid_value = !(@value.nil? || @value.empty?)
+
+          valid_name && valid_value
+        end
+
+        # Represents the CustomHeader name-value pair as a String
+        # @return [String]
+        def to_s
+            "#{@name}, #{@value}"
+        end
+
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+require_relative '../core/string_extension.rb'
+
+module SocketLabs
+  module InjectionApi
+    module Message
+
+        # Represents an individual email address for a message.
+        # Example:
+        #   email_address = EmailAddress.new("recipient@example.com", "Recipient 1")
+
+        class EmailAddress
+          include SocketLabs::InjectionApi
+          include SocketLabs::InjectionApi::Core
+
+        # the email address
+        attr_accessor :email_address
+        # the friendly or display name
+        attr_accessor :friendly_name
+
+        # Initializes a new instance of the EmailAddress class
+        # @param [String] email_address
+        # @param [String] friendly_name
+        def initialize(
+            email_address,
+            friendly_name = nil
+        )
+          @email_address = email_address
+          @friendly_name = friendly_name
+        end
+
+        # Determines if the EmailAddress is valid. Does simple syntax validation on the email address.
+        # @return [Boolean]
+        def is_valid
+          StringExtension.new.is_valid_email_address(@email_address)
+        end
+
+        # Represents the EmailAddress as a string
+        # @return [String]
+        def to_s
+          if @friendly_name.nil? || @friendly_name.empty?
+            @email_address
+          else
+            "#{@friendly_name} <#{@email_address}>"
+          end
+
+        end
+
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,50 @@
+require_relative '../core/string_extension.rb'
+
+module SocketLabs
+  module InjectionApi
+    module Message
+
+      # Represents MergeData as a key and value pair.
+      # Example:
+      #   data1 = MergeData.new("key1", "value1")
+
+      class MergeData
+
+        # the MergeData key
+        attr_accessor :key
+        # the value of the custom header
+        attr_accessor :value
+
+        # Initializes a new instance of the CustomHeader class
+        # @param [String] key
+        # @param [String] value
+        def initialize(
+            key = nil,
+            value = nil
+        )
+          @key = key
+          @value = value
+        end
+
+        # A quick check to ensure that the MergeData is valid.
+        # @return [Boolean]
+        def is_valid
+          valid_key = StringExtension.is_nil_or_white_space(@key)
+          valid_value = StringExtension.is_nil_or_white_space(@value)
+          if valid_key && valid_value
+            true
+          end
+          false
+        end
+
+        # Represents the CustomHeader name-value pair as a String
+        # @return [String]
+        def to_s
+            "#{@name}, #{@value}"
+        end
+
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,167 @@
+
+module SocketLabs
+  module InjectionApi
+    module Message
+      class MessageBase
+
+        public
+        # 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 for the message.
+        attr_accessor :api_template
+        # the custom MailingId for the message.
+        # See https://www.injectionapi.com/blog/best-practices-for-using-custom-mailingids-and-messageids/
+        # for more information.
+        attr_accessor :mailing_id
+        # the custom MessageId for the message.
+        # See https://www.injectionapi.com/blog/best-practices-for-using-custom-mailingids-and-messageids/
+        # for more information.
+        attr_accessor :message_id
+        # the optional character set. Default is UTF-8
+        attr_accessor :charset
+
+        def initialize(arguments = nil)
+
+          unless arguments.nil? || arguments.empty?
+
+            unless arguments[:subject].nil? || arguments[:subject].empty?
+              @subject = arguments[:subject]
+            end
+
+            unless arguments[:plain_text_body].nil? || arguments[:plain_text_body].empty?
+              @plain_text_body = arguments[:plain_text_body]
+            end
+
+            unless arguments[:html_body].nil? || arguments[:html_body].empty?
+              @html_body = arguments[:html_body]
+            end
+
+            unless arguments[:api_template].nil? || arguments[:api_template].empty?
+              @api_template = arguments[:api_template]
+            end
+
+            unless arguments[:mailing_id].nil? || arguments[:mailing_id].empty?
+              @mailing_id = arguments[:mailing_id]
+            end
+
+            unless arguments[:message_id].nil? || arguments[:message_id].empty?
+              @message_id = arguments[:message_id]
+            end
+
+            unless arguments[:charset].nil? || arguments[:charset].empty?
+              @charset = arguments[:charset]
+            end
+
+            unless arguments[:charset].nil? || arguments[:charset].empty?
+              @charset = arguments[:charset]
+            end
+
+          end
+
+          @from_email_address = nil
+          @reply_to_email_address = nil
+
+          @attachments = Array.new
+          @custom_headers = Array.new
+
+        end
+
+        # Get the From email address.
+        def from_email_address
+          @from_email_address
+        end
+        # Set the From email address.
+        def from_email_address=(value)
+          unless value.nil?
+            if value.kind_of? EmailAddress
+              @from_email_address = value
+            elsif value.kind_of? String
+              @from_email_address = EmailAddress.new(value)
+            else
+              raise StandardError("Invalid type for reply_to_email_address, type of 'EmailAddress' or 'String' was expected")
+            end
+          end
+        end
+
+        # Get the optional reply to  email address for the message.
+        def reply_to_email_address
+          @reply_to_email_address
+        end
+        # Set the optional reply to address for the message.
+        def reply_to_email_address=(value)
+          unless value.nil?
+            if value.kind_of?(EmailAddress)
+              @reply_to_email_address = value
+            elsif value.kind_of? String
+              @from_email_address = EmailAddress.new(value)
+            else
+              raise StandardError("Invalid type for reply_to_email_address, type of 'EmailAddress' or 'String' was expected")
+            end
+          end
+        end
+
+        # Get the list of attachments.
+        def attachments
+          @attachments
+        end
+        # Set the list of attachments.
+        def attachments=(value)
+          @attachments = Array.new
+          unless value.nil? || value.empty?
+            value.each do |v1|
+              if v1.instance_of? Attachment
+                @attachments.push(v1)
+              else
+                raise StandardError("Invalid type for attachments, type of 'Attachment' was expected")
+              end
+            end
+          end
+        end
+        # Add an attachment to the attachments list.
+        def add_attachment(value)
+          @attachments.push(value)
+        end
+
+        # Get the list of custom message headers added to the message.
+        def custom_headers
+          @custom_headers
+        end
+        # Set the list of custom message headers added to the message.
+        def custom_headers=(value)
+          @custom_headers = Array.new
+          unless value.nil? || value.empty?
+            value.each do |v1|
+              if v1.instance_of? CustomHeader
+                @custom_headers.push(v1)
+              else
+                raise StandardError("Invalid type for custom_headers, type of 'CustomHeader' was expected")
+              end
+            end
+          end
+        end
+        # Add a CustomHeader to the message.
+        # @param [String/CustomHeader] name
+        # @param [String] value
+        def add_custom_header(header, value = nil)
+
+          if header.kind_of? CustomHeader
+            @custom_headers.push(header)
+
+          elsif header.kind_of? String
+            @custom_headers.push(CustomHeader.new(header, value))
+
+          end
+
+        end
+
+
+
+      end
+    end
+  end
+end
+

data/lib/socketlabs/injectionapi/proxy.rb

@@ -0,0 +1,29 @@
+module SocketLabs
+  module InjectionApi
+
+    # Represents a http proxy.
+    class Proxy
+
+      # The name of the proxy hostname
+      attr_accessor :host
+      # The value of the proxy port
+      attr_accessor :port
+
+      def initialize (
+          host= nil,
+          port= nil
+      )
+        @host = host
+        @port = port
+      end
+
+      # Returns the Proxy as a string.
+      # @return [String]
+      def to_s
+        "#{@host}:#{@port}"
+      end
+
+    end
+
+  end
+end