socketlabs-injectionapi 1.1.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6836ca1a20d067ff9b472ed43b5cc27355216e03f67ceba0afbfe658581b6aca
-  data.tar.gz: 370b18591dc5cc3bc1ee4c30f42871d7ec7c53423ec68c15136e36a3a353ebfc
+  metadata.gz: 166ba13c298ad93c8c2ea44c9a2af22399a3a00c5bde303e7daabfd080cd0563
+  data.tar.gz: b1fcab9c9778c858306c8dfa5bc3f117a043df81383207878c2c4cb566196ec6
 SHA512:
-  metadata.gz: 485ce4f186821ae6faf881e8931e5f7583d6e6131c754c4aabb8a4c57e938110a860bbe31a0bb21fe00363a60fe1041ea72f59dc86e4e7c65f37f1466869626b
-  data.tar.gz: 63b65f20755c0f31d1c3208c6007ddf57164b811e0b7d515abcc9ca2944781370f9bf294fd5455237105184a2f1293f22f5558de1057f4725c0fdbbc2baab66c
+  metadata.gz: 9b793d816754372596a2c8681bb6d5ec226d4a06a4b6985d0ebe801883adbbdeab1c2973a666500c95b642639084c24dd03e6e524cc0b45e4424eb15c548053d
+  data.tar.gz: 3700a0da0d4a12a79446dd45fcf63043909cc454efc6963341164a5cfdf55e6b33f2c5337540cb1b9035dbcaa4ba15f3e79e93b2352e07d16285e9b5eaffef04

data/.gitignore

@@ -49,3 +49,5 @@ build-iPhoneSimulator/
 
 # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
 .rvmrc
+
+.idea

data/README.MD

@@ -14,7 +14,7 @@ The SocketLabs Email Delivery Ruby library allows you to easily send email messa
 <a name="prerequisites-and-installation" id="prerequisites-and-installation"></a>
 # Prerequisites and Installation
 ## Prerequisites
-* A supported Ruby version (2.4 and above)
+* A supported Ruby version (3.1 and above)
 * A SocketLabs account. If you don't have one yet, you can [sign up for a free account](https://signup.socketlabs.com/step-1?plan=free) to get started.
 
 ## Installation
@@ -175,6 +175,9 @@ This example demonstrates how to embed an image in your message.
 ### [Basic send with a web proxy](https://github.com/socketlabs/socketlabs-ruby/blob/master/examples/basic/basic_send_with_proxy.rb)
 This example demonstrates how to use a proxy with your HTTP client.
 
+### [Basic send with retry enabled](https://github.com/socketlabs/socketlabs-ruby/blob/master/examples/basic/basic_send_with_retry.rb)
+This example demonstrates how to use the retry logic with your HTTP client.
+
 ### [Basic send with Amp ](https://github.com/socketlabs/socketlabs-ruby/blob/master/examples/basic/basic_send_with_amp_body.rb)
 This example demonstrates how to send a basic message with an AMP Html body.
 For more information about AMP please see [AMP Project](https://amp.dev/documentation/)
@@ -213,6 +216,8 @@ For more information about AMP please see [AMP Project](https://amp.dev/document
 
 <a name="version"></a>
 # Version
+* 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
 * 1.0.0 - Initial Release
 

data/gemfile.lock

@@ -1,17 +1,18 @@
 PATH
   remote: .
   specs:
-    socketlabs-injectionapi (1.1.0)
+    socketlabs-injectionapi (1.4.1)
 
 GEM
   remote: http://rubygems.org/
   specs:
 
 PLATFORMS
+  x64-mingw-ucrt
   x64-mingw32
 
 DEPENDENCIES
   socketlabs-injectionapi!
 
 BUNDLED WITH
-   2.1.4
+   2.3.7

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

@@ -28,6 +28,8 @@ module SocketLabs
         attr_reader :proxy
         # The Net::HTTP used when making the HTTP request
         attr_reader :http
+        # The Timeout to use when making the HTTP request
+        attr_reader :timeout
 
         # @param [Hash] http_request_method
         # @param [Hash] arguments:
@@ -40,6 +42,7 @@ module SocketLabs
           @request_method = http_request_method
           @endpoint = "https://inject.socketlabs.com/api/v1/email"
           @proxy = Array.new
+          @timeout = 120
 
           unless arguments.nil? || arguments.empty?
 
@@ -51,6 +54,10 @@ module SocketLabs
               @proxy = arguments[:proxy]
             end
 
+            unless arguments[:timeout].nil?
+              @timeout = arguments[:timeout]
+            end
+
           end
 
           @http = nil
@@ -68,8 +75,7 @@ module SocketLabs
           response = @http.request(@request)
           http_response = HttpResponse.new(response)
 
-          parser = InjectionResponseParser.new
-          parser.parse(http_response)
+          http_response
 
         end
 
@@ -112,6 +118,8 @@ module SocketLabs
           params += @proxy.values_at(:host, :port, :user, :pass) unless @proxy.empty?
 
           @http = Net::HTTP.new(*params)
+          # add timeout
+          @http.read_timeout = @timeout
           # add ssl
           if @endpoint.start_with?('https')
             @http.use_ssl = true

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

@@ -4,10 +4,12 @@ require_relative '../message/email_address.rb'
 require_relative '../message/bulk_message.rb'
 require_relative '../message/bulk_recipient.rb'
 require_relative '../message/custom_header.rb'
+require_relative '../message/metadata.rb'
 
 require_relative 'serialization/address_json.rb'
 require_relative 'serialization/attachment_json.rb'
 require_relative 'serialization/custom_header_json.rb'
+require_relative 'serialization/metadata_json.rb'
 require_relative 'serialization/message_json.rb'
 require_relative 'serialization/merge_data_json.rb'
 
@@ -68,6 +70,8 @@ module SocketLabs
           message_json.charset = message.charset
           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.metadata = populate_metadata(message.metadata)
+          message_json.tags = message.tags
           message_json.attachments = populate_attachments(message.attachments)
 
           unless message.api_template.nil?
@@ -80,7 +84,7 @@ module SocketLabs
 
         end
 
-        # Converts a list of Attachment objects to a List of AttachmentJson objects.
+        # Converts a list of CustomHeader objects to a List of CustomHeaderJson objects.
         # @param [Array] custom_headers: list of CustomHeader to convert
         # @return [Array] the converted list of CustomHeaderJson
         def populate_custom_headers(custom_headers)
@@ -103,6 +107,29 @@ module SocketLabs
 
         end
 
+        # Converts a list of Metadata objects to a List of MetadataJson objects.
+        # @param [Array] metadata: list of Metadata to convert
+        # @return [Array] the converted list of MetadataJson
+        def populate_metadata(metadata)
+
+          if metadata.nil? || metadata.empty?
+            nil
+          end
+
+          metadata_json = Array.new
+
+          metadata.each do |header|
+            if header.instance_of? Metadata
+              metadata_json.push(MetadataJson.new(header.key, header.value))
+            elsif header.instance_of? Hash
+              metadata_json.push(MetadataJson.new(header[:key], header[:value]))
+            end
+          end
+
+          metadata_json
+
+        end
+
         # Converts a list of Attachment objects to a List of AttachmentJson objects.
         # @param [Attachment] attachments: list of Attachment to convert
         # @return [Array] the converted list of AttachmentJson

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

@@ -0,0 +1,68 @@
+require_relative '../../version.rb'
+require_relative '../retrysettings.rb'
+require_relative 'injection_response_parser'
+
+module SocketLabs
+    module InjectionApi
+        module Core
+            class RetryHandler
+                # include SocketLabsClient::InjectionApi
+
+                private
+
+                attr_accessor :http_client
+                attr_accessor :endpoint_url
+                attr_accessor :retry_settings
+                attr_accessor :error_codes
+
+                def initialize(client, endpoint, settings)
+                    @http_client = client
+                    @endpoint_url = endpoint
+                    @retry_settings = settings
+                    @error_codes = [500, 502, 503, 504]
+
+                end
+
+                public
+
+                def send(request)
+
+                    attempts = 0
+                    exception = nil
+
+                    loop do
+                        wait_interval = @retry_settings.get_next_wait_interval(attempts)
+                        attempts += 1
+
+                        begin
+                            response = @http_client.send_request(request)
+
+                            if @error_codes.include? response.status_code.to_i
+                                exception = SocketLabs::InjectionApi::Exceptions::ServerException.new("Failed to send email. Received #{response.status_code} from server.")
+                                sleep(wait_interval)
+                            else
+                                return response
+                            end
+
+                        rescue Timeout::Error => exception
+                            exception = exception
+
+                            break if attempts > @retry_settings.maximum_number_of_retries
+                            sleep(wait_interval)
+                        
+                        rescue Exception => exception
+                            raise exception
+                        end
+
+                        break if attempts > @retry_settings.maximum_number_of_retries
+                    end
+
+                    raise exception if exception
+
+                    false
+                end
+
+            end
+        end
+    end
+end

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

@@ -4,6 +4,7 @@ require_relative '../message/email_address.rb'
 require_relative '../message/bulk_message.rb'
 require_relative '../message/bulk_recipient.rb'
 require_relative '../message/custom_header.rb'
+require_relative '../message/metadata.rb'
 
 module SocketLabs
   module InjectionApi
@@ -44,7 +45,7 @@ module SocketLabs
             SendResponse.new(result=SendResult.enum["AuthenticationValidationFailed"])
           end
 
-          if server_id.nil? || server_id.empty?
+          if server_id.nil? || (!server_id.is_a?(Integer) && server_id.empty?)
             SendResponse.new(result=SendResult.enum["AuthenticationValidationFailed"])
           end
 
@@ -82,6 +83,9 @@ module SocketLabs
           unless has_valid_custom_headers(message.custom_headers)
             SendResult.enum["MessageValidationInvalidCustomHeaders"]
           end
+          unless has_valid_metadata(message.metadata)
+            SendResult.enum["MessageValidationInvalidMetadata"]
+          end
 
           SendResult.enum["Success"]
 
@@ -351,6 +355,25 @@ module SocketLabs
 
         end
 
+        # Check if the list of metadata is valid
+        # @param [Array] metadata
+        # @return [Array]
+        def has_valid_metadata(metadata)
+
+          unless metadata.nil? || metadata.empty?
+            metadata.each do |item|
+              if item.instance_of? Metadata
+                unless item.is_valid
+                  false
+                end
+              end
+            end
+          end
+
+          true
+
+        end
+
         # @param [BasicMessage] message
         # @return [SendResponse]
         def validate_basic_message(message)

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

@@ -44,6 +44,8 @@ module SocketLabs
             @merge_data = MergeDataJson.new
             @attachments = Array.new
             @custom_headers = Array.new
+            @metadata = Array.new
+            @tags = Array.new
             @to_email_address = Array.new
             @cc_email_address = Array.new
             @bcc_email_address = Array.new
@@ -82,6 +84,7 @@ module SocketLabs
           def custom_headers
             @custom_headers
           end
+
           # Set the list of CustomHeaderJson.
           # @param [Array] value
           def custom_headers=(value)
@@ -103,6 +106,63 @@ module SocketLabs
             end
           end
 
+          #metadata
+          # Get the list of MetadataJson.
+          # @return [Array]
+          def metadata
+            @metadata
+          end
+
+          # Set the list of MetadataJson.
+          # @param [Array] value
+          def metadata=(value)
+            @metadata = Array.new
+            unless value.nil? || value.empty?
+              value.each do |v1|
+                if v1.instance_of? MetadataJson
+                  @metadata.push(v1)
+                end
+              end
+            end
+          end
+
+          # Add a MetadataJson to the metadata list
+          # @param [MetadataJson] value
+          def add_metadata(value)
+            if value.instance_of? MetadataJson
+              @metadata.push(value)
+            end
+          end
+
+          # Get the list of tags added to the message.
+          def tags
+            @tags
+          end
+
+          # Set the list of tags added to the message.
+          def tags=(value)
+            @tags = Array.new
+            unless value.nil? || value.empty?
+              value.each do |v1|
+                if v1.kind_of? String
+                  @tags.push(v1)
+                else
+                  raise StandardError("Invalid type for tag, type of 'String' was expected")
+                end
+              end
+            end
+          end
+
+          # Add a Tag to the message.
+          # @param [String] value
+          def add_metadata(value = nil)
+
+            if value.kind_of? String
+              @tags.push(value)
+            end
+
+          end
+
           # Get the To email address list
           # @return [Array]
           def to_email_address
@@ -233,6 +293,18 @@ module SocketLabs
               json[:customHeaders] = e
             end
 
+            unless @metadata.nil? || @metadata.length == 0
+              e = Array.new
+              @metadata.each do |value|
+                e.push(value.to_hash)
+              end
+              json[:metadata] = e
+            end
+
+            unless @tags.nil? || @tags.length == 0
+              json[:tags] = @tags
+            end
+
             unless @attachments.nil? || @attachments.length == 0
               e = Array.new
               @attachments.each do |value|

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

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

data/lib/socketlabs/injectionapi/exceptions/server_exception.rb

@@ -0,0 +1,7 @@
+module SocketLabs
+  module InjectionApi
+    module Exceptions
+      class ServerException < Exception;end
+    end
+  end
+end

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

@@ -12,6 +12,7 @@ module SocketLabs
           @to_email_address = Array.new
           @cc_email_address = Array.new
           @bcc_email_address = Array.new
+          @tags = Array.new
 
         end
 
@@ -87,6 +88,8 @@ module SocketLabs
               replyTo: @reply_to_email_address,
               attachments: @attachments,
               customHeaders: @custom_headers,
+              metadata: @metadata,
+              tags: @tags,
               to: @to_email_address,
               cc: @cc_email_address,
               bcc: @bcc_email_address

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

@@ -55,6 +55,8 @@ module SocketLabs
             replyTo: @reply_to_email_address,
             attachments: @attachments,
             customHeaders: @custom_headers,
+            metadata: @metadata,
+            tags: @tags,
             to: @to_recipient,
             global_merge_data: @global_merge_data
           }

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

@@ -20,11 +20,11 @@ module SocketLabs
         # (Optional) Either TextBody or HtmlBody must be used with the AmpBody or use a ApiTemplate
         attr_accessor :api_template
         # the custom MailingId for the message.
-        # See https://www.injectionapi.com/blog/best-practices-for-using-custom-mailingids-and-messageids/
+        # See https://www.socketlabs.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/
+        # See https://www.socketlabs.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
@@ -77,6 +77,8 @@ module SocketLabs
 
           @attachments = Array.new
           @custom_headers = Array.new
+          @metadata = Array.new
+          @tags = Array.new
 
         end
 
@@ -140,6 +142,7 @@ module SocketLabs
         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
@@ -153,6 +156,7 @@ module SocketLabs
             end
           end
         end
+
         # Add a CustomHeader to the message.
         # @param [String/CustomHeader] name
         # @param [String] value
@@ -168,6 +172,68 @@ module SocketLabs
 
         end
 
+        # Get the list of metadata added to the message.
+        def metadata
+          @metadata
+        end
+
+        # Set the list of metadata added to the message.
+        def metadata=(value)
+          @metadata = Array.new
+          unless value.nil? || value.empty?
+            value.each do |v1|
+              if v1.instance_of? Metadata
+                @metadata.push(v1)
+              else
+                raise StandardError("Invalid type for metadata, type of 'Metadata' was expected")
+              end
+            end
+          end
+        end
+
+        # Add a Metadata to the message.
+        # @param [String/Metadata] key
+        # @param [String] value
+        def add_metadata(key, value = nil)
+
+          if key.kind_of? Metadata
+            @metadata.push(key)
+
+          elsif key.kind_of? String
+            @metadata.push(Metadata.new(key, value))
+
+          end
+
+        end
+
+        # Get the list of tags added to the message.
+        def tags
+          @tags
+        end
+
+        # Set the list of tags added to the message.
+        def tags=(value)
+          @tags = Array.new
+          unless value.nil? || value.empty?
+            value.each do |v1|
+              if v1.kind_of? String
+                @tags.push(v1)
+              else
+                raise StandardError("Invalid type for tag, type of 'String' was expected")
+              end
+            end
+          end
+        end
+
+        # Add a Tag to the message.
+        # @param [String] value
+        def add_tag(value = nil)
+
+          if value.kind_of? String
+            @tags.push(value)
+          end
+
+        end
 
 
       end

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

@@ -0,0 +1,52 @@
+require_relative '../core/string_extension.rb'
+
+module SocketLabs
+  module InjectionApi
+    module Message
+
+      # Represents metadata as a key-value pair.
+      # Example:
+      #
+      #   metadata1 = Metadata.new
+      #   metadata1.key = "key1"
+      #   metadata1.value = "value1"
+      #
+      #   metadata2 = Metadata.new("key2", "value2")
+
+      class Metadata
+
+        # the key of the metadata item
+        attr_accessor :key
+        # the value of the metadata item
+        attr_accessor :value
+
+        # Initializes a new instance of the Metadata class
+        # @param [String] key
+        # @param [String] value
+        def initialize(
+          key = nil,
+            value = nil
+        )
+          @key = key
+          @value = value
+        end
+
+        # Determines if the Metadata is valid.
+        # @return [Boolean]
+        def is_valid
+          valid_key = !(@key.nil? || @key.empty?)
+          valid_value = !(@value.nil? || @value.empty?)
+
+          valid_key && valid_value
+        end
+
+        # Represents the Metadata key-value pair as a String
+        # @return [String]
+        def to_s
+            "#{@key}, #{@value}"
+        end
+
+      end
+    end
+  end
+end