socketlabs-injectionapi 1.4.0 → 1.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 166ba13c298ad93c8c2ea44c9a2af22399a3a00c5bde303e7daabfd080cd0563
-  data.tar.gz: b1fcab9c9778c858306c8dfa5bc3f117a043df81383207878c2c4cb566196ec6
+  metadata.gz: 8cb53859e473d0b39783967b98f0c1d44a5bbd2d9e3a41518e9831dad9d3274a
+  data.tar.gz: c710342add94849a727216e28ab82e33c07bb57b4ec80fd370f246a11c34520d
 SHA512:
-  metadata.gz: 9b793d816754372596a2c8681bb6d5ec226d4a06a4b6985d0ebe801883adbbdeab1c2973a666500c95b642639084c24dd03e6e524cc0b45e4424eb15c548053d
-  data.tar.gz: 3700a0da0d4a12a79446dd45fcf63043909cc454efc6963341164a5cfdf55e6b33f2c5337540cb1b9035dbcaa4ba15f3e79e93b2352e07d16285e9b5eaffef04
+  metadata.gz: 56d7c9867149469570940396836f8c69c2bf1e060774932ae5f7d8a3b98ecb9a89faf5544b03318cb489984222e003361078518bf6cecc12c2f1caa8e0f9ee1d
+  data.tar.gz: f09a1e585ba59a97862ff888dc659f2a49ce3e91b419c984389daea0910843d60829afe915ea1614ec816da8d0aae3c101ff9ff440e21a27d6c276016f81bb16

data/README.MD

@@ -216,6 +216,8 @@ For more information about AMP please see [AMP Project](https://amp.dev/document
 
 <a name="version"></a>
 # Version
+* 1.4.2 - Adding API Key Authorization 
+* 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

data/gemfile.lock

@@ -1,18 +1,18 @@
-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
+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,69 @@
+# 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,
+            },
+          # Invalid key length was found.
+          "InvalidKeyLength" =>
+            {
+              :name => "InvalidKeyLength",
+              :value => 1,
+            },
+          # Invalid key format was found.
+          "InvalidKeyFormat" =>
+            {
+              :name => "InvalidKeyFormat",
+              :value => 2,
+            },
+          # The key was found to be blank or invalid.
+          "InvalidEmptyOrWhitespace" =>
+            {
+              :name => "InvalidEmptyOrWhitespace",
+              :value => 3,
+            },
+          # The public portion of the key was unable to be parsed.
+          "InvalidUnableToExtractPublicPart" =>
+            {
+              :name => "InvalidUnableToExtractPublicPart",
+              :value => 4,
+            },
+          # The secret portion of the key was unable to be parsed.
+          "InvalidUnableToExtractSecretPart" =>
+            {
+              :name => "InvalidUnableToExtractSecretPart",
+              :value => 5,
+            },
+          # The public portion of the key is the incorrect length.
+          "InvalidPublicPartLength" =>
+            {
+              :name => "InvalidPublicPartLength",
+              :value => 6,
+            },
+          # The secret portion of the key is the incorrect length.
+          "InvalidSecretPartLength" =>
+            {
+              :name => "InvalidSecretPartLength",
+              :value => 7,
+            },
+          # Key was successfully parsed.
+          "Success" =>
+            {
+              :name => "Success",
+              :value => 8,
+            }
+        }
+        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 ApiKeyParseResult 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/socketlabsclient.rb

@@ -93,7 +93,22 @@ module SocketLabs
         debug_json = request_hash.to_json
         @request_json = debug_json
 
-        http_request = HttpRequest.new(http_method, { :http_endpoint => @endpoint, :proxy => @proxy, :timeout => @request_timeout })
+        apiKeyParser = ApiKeyParser.new()
+        parseResult = apiKeyParser.parse(@api_key);
+
+        httpArguments = {
+          :http_endpoint => @endpoint,
+          :proxy => @proxy,
+          :timeout => @request_timeout,
+          :authorization => ''
+        }
+        if parseResult == ApiKeyParseResult.enum["Success"]
+          httpArguments[:authorization] = @api_key
+          request.api_key = ''
+        end
+
+        http_request = HttpRequest.new(http_method, httpArguments)
+
         retry_handler = RetryHandler.new(http_request, @endpoint, RetrySettings.new(@number_of_retries))
         response = retry_handler.send(request)
 
@@ -122,6 +137,20 @@ module SocketLabs
         debug_json = request_hash.to_json
         @request_json = debug_json
 
+        apiKeyParser = ApiKeyParser.new()
+        parseResult = apiKeyParser.parse(@api_key);
+
+        httpArguments = {
+          :http_endpoint => @endpoint,
+          :proxy => @proxy,
+          :timeout => @request_timeout,
+          :authorization => ''
+        }
+        if parseResult == ApiKeyParseResult.enum["Success"]
+          httpArguments[:authorization] = @api_key
+          request.api_key = ''
+        end
+
         http_request = HttpRequest.new(http_method, { :http_endpoint => @endpoint, :proxy => @proxy, :timeout => @request_timeout })
         retry_handler = RetryHandler.new(http_request, @endpoint, RetrySettings.new(@number_of_retries))
         response = retry_handler.send(request)

data/lib/socketlabs/version.rb

@@ -1,5 +1,5 @@
 module SocketLabs
   module InjectionApi
-    VERSION = '1.4.0'
+    VERSION = '1.4.3'
   end
 end

data/lib/socketlabs-injectionapi.rb

@@ -16,6 +16,8 @@ require_relative 'socketlabs/injectionapi/message/bulk_recipient'
 require_relative 'socketlabs/injectionapi/message/custom_header'
 require_relative 'socketlabs/injectionapi/message/email_address'
 require_relative 'socketlabs/injectionapi/message/merge_data'
+
+require_relative 'socketlabs/injectionapi/core/serialization/message_result_dto'
 require_relative 'socketlabs/injectionapi/core/serialization/address_json'
 require_relative 'socketlabs/injectionapi/core/serialization/attachment_json'
 require_relative 'socketlabs/injectionapi/core/serialization/custom_header_json'
@@ -26,6 +28,8 @@ require_relative 'socketlabs/injectionapi/core/serialization/merge_field_json'
 require_relative 'socketlabs/injectionapi/core/serialization/message_json'
 require_relative 'socketlabs/injectionapi/core/serialization/message_result_dto'
 require_relative 'socketlabs/injectionapi/core/injection_request_factory'
+require_relative 'socketlabs/injectionapi/core/api_key_parser'
+require_relative 'socketlabs/injectionapi/core/api_key_parse_result'
 require_relative 'socketlabs/injectionapi/core/http_request'
 require_relative 'socketlabs/injectionapi/core/retryhandler'
 require_relative 'socketlabs/injectionapi/core/http_response'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: socketlabs-injectionapi
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.4.3
 platform: ruby
 authors:
 - David Schrenker
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-18 00:00:00.000000000 Z
+date: 2023-05-22 00:00:00.000000000 Z
 dependencies: []
 description: SocketLabs Email Delivery Ruby Client library
 email: developers@socketlabs.com
@@ -26,6 +26,8 @@ files:
 - gemfile.lock
 - lib/socketlabs-injectionapi.rb
 - lib/socketlabs/injectionapi/address_result.rb
+- lib/socketlabs/injectionapi/core/api_key_parse_result.rb
+- lib/socketlabs/injectionapi/core/api_key_parser.rb
 - lib/socketlabs/injectionapi/core/http_request.rb
 - lib/socketlabs/injectionapi/core/http_response.rb
 - lib/socketlabs/injectionapi/core/injection_request_factory.rb
@@ -79,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: SocketLabs Injection Api