socketlabs-injectionapi 1.2.1 → 1.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9fce0b211f96b88503365f93ed1270eb5d943d835e21e53fcbee2806621354f0
-  data.tar.gz: bae74a7c4e920b89fdea11aaed1efce1166ccd9ff923ef39f9e04278118eed06
+  metadata.gz: f557916e593c897978060429a0bdb300c61f5047fc879902a2f43ad7a8bffbab
+  data.tar.gz: 31a2adba06e1794c3c1b49e23bb7dbdc6de4be1bc1349e6c0d0cc5ed53cc4757
 SHA512:
-  metadata.gz: 8004fdece9672ae94d3f3fef5838504cb65606f21ff656210a7a91741b0ec713aecc56bcd0926864e5524dc75869bca3914fc98f3f3f9be808243fb859c035e0
-  data.tar.gz: 8a7114b59e0f8ec6c8ad416b30743d346cccd9de03c84a0b2380bf14885a25a7a0d146f7be6017a92dae2af381b8a339dfe442e128a74f67042801274a0b18b5
+  metadata.gz: 143016ece80ad2d42de386599a0455e1fad50172c5471ff74773fb180ec6cbd3a8d100baec4d31ffcf776a11f29bf7e2541c93633acd20bfa70fc8d397919a11
+  data.tar.gz: 13097dbd02d8ba26a590b42fe1da47c115049642c2eb74cad3cf1571b4e8c28ce08efbe56cabc266dd9e2e1d4a5bbc8f94fc7da25a84f4336de1971e013ea8b5

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

data/gemfile.lock

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

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

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+
+module SocketLabs
+  module InjectionApi
+    module Core
+      class ApiKeyParseResult
+        def self.enum
+        {
+          # No result could be produced.
+          "None" =>
+            {
+              :name => "None",
+              :value =>0,
+            },
+          # The key was found to be blank or invalid.
+          "InvalidEmptyOrWhitespace" =>
+            {
+              :name => "InvalidEmptyOrWhitespace",
+              :value =>1,
+            },
+          # The public portion of the key was unable to be parsed.
+          "InvalidUnableToExtractPublicPart" =>
+            {
+              :name => "InvalidUnableToExtractPublicPart",
+              :value =>2,
+            },
+          # The secret portion of the key was unable to be parsed.
+          "InvalidUnableToExtractSecretPart" =>
+            {
+              :name => "InvalidUnableToExtractSecretPart",
+              :value =>3,
+            },
+          # Key was successfully parsed.
+          "Success" =>
+            {
+              :name => "Success",
+              :value =>4,
+            }
+        }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+
+module SocketLabs
+  module InjectionApi
+    module Core
+      class ApiKeyParser
+
+
+        # Parse the API key to determine what kind of key was provided.
+        # @param [String] wholeApiKey: A ApiKeyParseResult with the parsing results
+        # @return [ApiKeyParseResult] the SendResponse from the request
+        def parse(
+          wholeApiKey
+        )
+
+
+
+
+          if wholeApiKey.nil? || wholeApiKey.empty?
+            ApiKeyParseResult.enum["InvalidEmptyOrWhitespace"]
+          end
+
+          if wholeApiKey.length != 61
+            ApiKeyParseResult.enum["InvalidKeyLength"]
+          end
+
+          if wholeApiKey.index('.') == -1
+            ApiKeyParseResult.enum["InvalidKeyFormat"]
+          end
+
+          # extract public part
+          # don't check more than 50 chars
+          publicPartEnd = wholeApiKey[0..50].index('.')
+          if publicPartEnd == -1
+            ApiKeyParseResult.enum["InvalidUnableToExtractPublicPart"]
+          end
+
+          publicPart = wholeApiKey[0..publicPartEnd]
+          if publicPart != 20
+            ApiKeyParseResult.enum["InvalidPublicPartLength"]
+          end
+
+          # now extract the private part
+          if wholeApiKey.length <= publicPartEnd + 1
+            ApiKeyParseResult.enum["InvalidUnableToExtractSecretPart"]
+          end
+
+          privatePart = wholeApiKey[publicPartEnd + 1..wholeApiKey.length]
+
+          if privatePart.length != 40
+            ApiKeyParseResult.enum["InvalidSecretPartLength"]
+          end
+
+          ApiKeyParseResult.enum["Success"]
+
+        end
+
+      end
+    end
+  end
+end

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

@@ -43,6 +43,12 @@ module SocketLabs
           @endpoint = "https://inject.socketlabs.com/api/v1/email"
           @proxy = Array.new
           @timeout = 120
+          @headers =
+            [
+              { :key => "User-Agent", :value => user_agent},
+              { :key => "Content-Type", :value => "application/json; charset=utf-8" },
+              { :key => "Accept", :value => "application/json"}
+            ]
 
           unless arguments.nil? || arguments.empty?
 
@@ -58,6 +64,10 @@ module SocketLabs
               @timeout = arguments[:timeout]
             end
 
+            unless arguments[:authorization].nil? || arguments[:authorization].empty?
+              @headers.push({ :key => "Authorization", :value => 'Bearer ' + arguments[:authorization]})
+            end
+
           end
 
           @http = nil
@@ -73,6 +83,7 @@ module SocketLabs
 
           # send request
           response = @http.request(@request)
+
           http_response = HttpResponse.new(response)
 
           http_response
@@ -87,25 +98,17 @@ module SocketLabs
           "SocketLabs-ruby/#{VERSION};ruby(#{RUBY_VERSION})"
         end
 
-        # headers to add to the request
-        def headers
-          [
-              { :key => "User-Agent", :value => user_agent},
-              { :key => "Content-Type", :value => "application/json; charset=utf-8" },
-              { :key => "Accept", :value => "application/json"}
-          ]
-        end
-
          # add request headers
         # @param [HTTP::NET] request: the request object
         # @return [HTTP::NET] the resulting request
         def add_request_headers(request)
 
-          request.add_field('Content-Type', 'application/json')
-          headers.each do |item|
+          @headers.each do |item|
             request[item[:key]] = item[:value]
           end
+
           request
+
         end
 
         # Build the API request for HTTP::NET
@@ -130,14 +133,7 @@ module SocketLabs
           @request = add_request_headers(net_http.new(uri.request_uri))
 
         end
-
       end
-
-
-
-
-
-
     end
   end
 end

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

@@ -27,39 +27,39 @@ module SocketLabs
 
                 def send(request)
 
-                    if @retry_settings.maximum_number_of_retries == 0
-                        response =  @http_client.send_request(request)
-                        response
-                    end
-
                     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) && (attempts < @retry_settings.maximum_number_of_retries)
-                                attempts += 1
+                            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
-                                response
+                                return response
                             end
 
                         rescue Timeout::Error => exception
-                            attempts += 1
-                            
-                            if attempts > @retry_settings.maximum_number_of_retries
-                                raise exception
-                            end
+                            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

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
           }