socketlabs-injectionapi 1.4.2 → 1.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f557916e593c897978060429a0bdb300c61f5047fc879902a2f43ad7a8bffbab
-  data.tar.gz: 31a2adba06e1794c3c1b49e23bb7dbdc6de4be1bc1349e6c0d0cc5ed53cc4757
+  metadata.gz: ee741c53907bad14908179b9fe0ee9d50884adfec3b5df7680bb19a5db3c7715
+  data.tar.gz: d9aff889b425ce7eb65efd939fbd6e7e8682632be9fe566cc6087887cb0e5762
 SHA512:
-  metadata.gz: 143016ece80ad2d42de386599a0455e1fad50172c5471ff74773fb180ec6cbd3a8d100baec4d31ffcf776a11f29bf7e2541c93633acd20bfa70fc8d397919a11
-  data.tar.gz: 13097dbd02d8ba26a590b42fe1da47c115049642c2eb74cad3cf1571b4e8c28ce08efbe56cabc266dd9e2e1d4a5bbc8f94fc7da25a84f4336de1971e013ea8b5
+  metadata.gz: 00c01b3e6dc055a20ed7945b06bd36a6be49dd30336621f2f8dc7453aa721e0f66a1d543ac7a2520ce606c6abf5dbe739bc3008f23669cf2ce5550bf599777b6
+  data.tar.gz: 8dd25c0911d4c9a1479341828e51fabe15469172e8863272609db937a8867805d4062d8f2531b385d811a824b4a9ae6847d4bdd7a7b26b24f17caec3e978cf04

data/README.MD

@@ -1,4 +1,4 @@
-[![SocketLabs](https://static.socketlabs.com/logos/logo-dark-326x64.png)](https://www.socketlabs.com/developers) 
+[![SocketLabs](https://static.socketlabs.com/logos/logo-dark-326x64.png)](https://www.socketlabs.com/developers)
 # [![Twitter Follow](https://img.shields.io/twitter/follow/socketlabs.svg?style=social&label=Follow)](https://twitter.com/socketlabs) [![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/socketlabs/socketlabs-nodejs/blob/master/CONTRIBUTING.md)
 
 The SocketLabs Email Delivery Ruby library allows you to easily send email messages via the [SocketLabs Injection API](https://www.socketlabs.com/docs/inject/).  The library makes it easy to build and send any type of message supported by the API, from a simple message to a single recipient all the way to a complex bulk message sent to a group of recipients with unique merge data per recipient.
@@ -30,7 +30,7 @@ And then execute:
 Install it yourself as:
 
     $ gem install socketlabs-injectionapi
-    
+
 Or From git
 
     $ gem 'socketlabs-injectionapi', :git => "https://github.com/socketlabs/socketlabs-ruby.git"
@@ -41,21 +41,21 @@ For more information please see the [Installing Gems](https://guides.rubygems.or
 <a name="getting-started" id="getting-started"></a>
 # Getting Started
 ## Obtaining your API Key and SocketLabs ServerId number
-In order to get started, you'll need to enable the Injection API feature in the [SocketLabs Control Panel](https://cp.socketlabs.com). 
-Once logged in, navigate to your SocketLabs server's dashboard (if you only have one server on your account you'll be taken here immediately after logging in). 
-Make note of your 4 or 5 digit ServerId number, as you'll need this along with 
-your API key in order to use the Injection API. 
+In order to get started, you'll need to enable the Injection API feature in the [SocketLabs Control Panel](https://cp.socketlabs.com).
+Once logged in, navigate to your SocketLabs server's dashboard (if you only have one server on your account you'll be taken here immediately after logging in).
+Make note of your 4 or 5 digit ServerId number, as you'll need this along with
+your API key in order to use the Injection API.
 
-To enable the Injection API, click on the "For Developers" dropdown on the top-level navigation, then choose the "Configure HTTP Injection API" option. 
+To enable the Injection API, click on the "For Developers" dropdown on the top-level navigation, then choose the "Configure HTTP Injection API" option.
 Once here, you can enable the feature by choosing the "Enabled" option in the
-dropdown. Enabling the feature will also generate your API key, which you'll 
-need (along with your ServerId) to start using the API. Be sure to click the 
+dropdown. Enabling the feature will also generate your API key, which you'll
+need (along with your ServerId) to start using the API. Be sure to click the
 "Update" button to save your changes once you are finished.
 
 
 ## Basic Message
-A basic message is an email message like you'd send from a personal email client such as Outlook. 
-A basic message can have many recipients, including multiple To addresses, CC addresses, and even BCC addresses. 
+A basic message is an email message like you'd send from a personal email client such as Outlook.
+A basic message can have many recipients, including multiple To addresses, CC addresses, and even BCC addresses.
 You can also send a file attachment in a basic message.
 
 ```ruby
@@ -72,7 +72,7 @@ message.plain_text_body = "This is the Plain Text Body of my message."
 
 message.from_email_address = EmailAddress.new("from@example.com")
 
-# A basic message supports up to 50 recipients 
+# A basic message supports up to 50 recipients
 # and supports several different ways to add recipients
 
 # Add a To address by passing the email address
@@ -94,9 +94,9 @@ response = client.send(message)
 ```
 
 ## Bulk Message
-A bulk message usually contains a single recipient per message 
-and is generally used to send the same content to many recipients, 
-optionally customizing the message via the use of MergeData. 
+A bulk message usually contains a single recipient per message
+and is generally used to send the same content to many recipients,
+optionally customizing the message via the use of MergeData.
 For more information about using Merge data, please see the [Injection API documentation](https://www.socketlabs.com/docs/inject/).
 ```ruby
 require "socketlabs-injectionapi"
@@ -130,20 +130,20 @@ response = client.send(message)
 
 <a name="managing-api-keys" id="managing-api-keys"></a>
 ## Managing API Keys
-For ease of demonstration, many of our examples include the ServerId (SOCKETLABS_SERVER_ID) and API key 
-(SOCKETLABS_INJECTION_API_KEY) directly in our code sample. Generally it is not considered a good practice to store 
-sensitive information like this directly in your code. Depending on your project type, we recommend either storing your 
-credentials using Environment Variables. For more information please see: 
+For ease of demonstration, many of our examples include the ServerId (SOCKETLABS_SERVER_ID) and API key
+(SOCKETLABS_INJECTION_API_KEY) directly in our code sample. Generally it is not considered a good practice to store
+sensitive information like this directly in your code. Depending on your project type, we recommend either storing your
+credentials using Environment Variables. For more information please see:
 [Using Environment Variables](https://docs.microsoft.com/en-us/dotnet/api/system.environment.getenvironmentvariable)
 
 
 <a name="examples-and-use-cases" id="examples-and-use-cases"></a>
 # Examples and Use Cases
-In order to demonstrate the many possible use cases for the SDK, we've provided 
-an assortment of code examples. These examples demonstrate many different 
-features available to the Injection API and SDK, including using templates 
-created in the [SocketLabs Email Designer](https://www.socketlabs.com/blog/introducing-new-email-designer/), custom email headers, sending 
-attachments, sending content that is stored in an HTML file, advanced bulk 
+In order to demonstrate the many possible use cases for the SDK, we've provided
+an assortment of code examples. These examples demonstrate many different
+features available to the Injection API and SDK, including using templates
+created in the [SocketLabs Email Designer](https://www.socketlabs.com/blog/introducing-new-email-designer/), custom email headers, sending
+attachments, sending content that is stored in an HTML file, advanced bulk
 merging, and even pulling recipients from a datasource.
 
 ### [Basic send example](https://github.com/socketlabs/socketlabs-ruby/blob/master/examples/basic/basic_send.rb)
@@ -153,11 +153,11 @@ This example demonstrates a Basic Send.
 This example demonstrates many features of the Basic Send, including adding multiple recipients, adding message and mailing id's, and adding an embedded image.
 
 ### [Basic send from HTML file](https://github.com/socketlabs/socketlabs-ruby/blob/master/examples/basic/basic_send_from_html_file.rb)
-This example demonstrates how to read in your HTML content from an HTML file 
+This example demonstrates how to read in your HTML content from an HTML file
 rather than passing in a string directly.
 
 ### [Basic send from SocketLabs Template](https://github.com/socketlabs/socketlabs-ruby/blob/master/examples/basic/basic_send_with_api_template.rb)
-This example demonstrates the sending of a piece of content that was created in the 
+This example demonstrates the sending of a piece of content that was created in the
 SocketLabs Email Designer. This is also known as the [API Templates](https://www.socketlabs.com/blog/introducing-api-templates/) feature.
 
 ### [Basic send with specified character set](https://github.com/socketlabs/socketlabs-ruby/blob/master/examples/basic/basic_send_with_ascii_charset.rb)
@@ -195,19 +195,19 @@ This example demonstrates the results of attempting to do a send with invalid re
 This example demonstrates how to send a bulk message to multiple recipients.
 
 ### [Bulk send with merge data](https://github.com/socketlabs/socketlabs-ruby/blob/master/examples/bulk/bulk_send_with_merge_data.rb)
-This example demonstrates how to send a bulk message to multiple recipients with 
+This example demonstrates how to send a bulk message to multiple recipients with
 unique merge data per recipient.
 
 ### [Bulk send with complex merge including attachments](https://github.com/socketlabs/socketlabs-ruby/blob/master/examples/bulk/bulk_send_complex.rb)
-This example demonstrates many features of the `BulkMessage()`, including 
+This example demonstrates many features of the `BulkMessage()`, including
 adding multiple recipients, merge data, and adding an attachment.
 
 ### [Bulk send with recipients pulled from a datasource](https://github.com/socketlabs/socketlabs-ruby/blob/master/examples/bulk/bulk_send_from_data_source_with_merge_data.rb)
-This example uses a mock repository class to demonstrate how you would pull 
+This example uses a mock repository class to demonstrate how you would pull
 your recipients from a database and create a bulk mailing with merge data.
 
 ### [Bulk send with Ascii charset and special characters](https://github.com/socketlabs/socketlabs-ruby/blob/master/examples/bulk/bulk_send_with_ascii_charset_merge_data.rb)
-This example demonstrates how to send a bulk message with a specified character 
+This example demonstrates how to send a bulk message with a specified character
 set and special characters.
 
 ### [Bulk send with Amp ](https://github.com/socketlabs/socketlabs-ruby/blob/master/examples/bulk/bulk_send_with_amp_body.rb )
@@ -216,6 +216,9 @@ For more information about AMP please see [AMP Project](https://amp.dev/document
 
 <a name="version"></a>
 # Version
+* 1.4.4 - Added MetadataOrTagsAreTooLarge error messsage
+* 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_parser.rb

@@ -9,7 +9,7 @@ module SocketLabs
 
         # 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
+        # @return [ApiKeyParseResult] the ApiKeyParseResult from the request
         def parse(
           wholeApiKey
         )

data/lib/socketlabs/injectionapi/send_result.rb

@@ -316,6 +316,14 @@ module SocketLabs
             :name =>"MessageValidationInvalidMetadata",
             :value =>38,
             :message =>"SDK Validation Error: Message contains invalid metadata"
+          },
+
+          # Metadata and tags exceed 12.5KB
+          "MetadataOrTagsAreTooLarge" =>
+          {
+            :name =>"MetadataOrTagsAreTooLarge",
+            :value =>39,
+            :message =>"Metadata and tags exceed 12.5KB"
           }
 
           }

data/lib/socketlabs/injectionapi/socketlabsclient.rb

@@ -137,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.2'
+    VERSION = '1.4.4'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: socketlabs-injectionapi
 version: !ruby/object:Gem::Version
-  version: 1.4.2
+  version: 1.4.4
 platform: ruby
 authors:
 - David Schrenker
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-22 00:00:00.000000000 Z
+date: 2023-10-17 00:00:00.000000000 Z
 dependencies: []
 description: SocketLabs Email Delivery Ruby Client library
 email: developers@socketlabs.com