socketlabs-injectionapi 0.0.1.pre.Dev

data/lib/socketlabs/injectionapi/send_response.rb

@@ -0,0 +1,63 @@
+module SocketLabs
+  module InjectionApi
+    # The response of an SocketLabsClient send request.
+    class SendResponse
+
+      # The result [SendResult] of the SocketLabsClient send request.
+      attr_accessor :result
+      # The unique key generated by the Injection API if an unexpected error occurs during the SocketLabsClient
+      # send request. This unique key can be used by SocketLabs support to troubleshoot the issue.
+      attr_accessor :transaction_receipt
+      # A Array of AddressResult objects that contain the status of each address that failed.
+      # If no messages failed this array is empty.
+      attr_accessor :address_results
+
+      def initialize (
+          result = nil,
+          transaction_receipt= nil,
+          address_results= nil,
+          response_message= nil
+      )
+        @result = result
+        @transaction_receipt = transaction_receipt
+        @address_results = []
+
+        unless address_results.nil?
+          @address_results = address_results
+        end
+
+      end
+
+      # A message detailing why the SocketLabsClient send request failed.
+      def response_message
+        unless @result.nil?
+          @result[:message]
+        end
+      end
+
+      # Represents the SendResponse as a str.
+      def to_s
+        "#{@result}: #{response_message}"
+      end
+
+      # build json hash for SendResponse
+      def to_json(*)
+        json = {
+            :result => @result.to_json,
+            :transactionReceipt => @transaction_receipt,
+            :responseMessage => response_message
+        }
+        if @address_results.length > 0
+          e = Array.new
+          @address_results.each do |value|
+            e.push(value.to_json)
+          end
+          json[:messageResults] = e
+        end
+        json.to_json
+      end
+
+    end
+
+  end
+end

data/lib/socketlabs/injectionapi/send_result.rb

@@ -0,0 +1,318 @@
+
+module SocketLabs
+  module InjectionApi
+
+    class SendResult
+      # Send Result hash
+      def self.enum
+          {
+        # An error has occurred that was unforeseen
+        "UnknownError" =>          {
+            :name => "UnknownError",
+            :value =>0,
+            :message =>"An error has occurred that was unforeseen"
+          },
+
+        # A timeout occurred sending the message
+        "Timeout" =>
+          {
+            :name =>"Timeout",
+            :value =>1,
+            :message =>"A timeout occurred sending the message"
+          },
+
+        # Successful send of message
+        "Success"  =>
+          {
+            :name =>"Success",
+            :value =>2,
+            :message =>"Successful send of message"
+          },
+
+        # Warnings were found while sending the message
+        "Warning"  =>
+          {
+            :name =>"Warning",
+            :value =>3,
+            :message =>"Warnings were found while sending the message"
+          },
+
+        # Internal server error
+        "InternalError" =>
+          {
+            :name =>"InternalError",
+            :value =>4,
+            :message =>"Internal server error"
+          },
+
+        # Message has exceeded the size limit
+        "MessageTooLarge" =>
+          {
+            :name =>"MessageTooLarge",
+            :value =>5,
+            :message =>"Message has exceeded the size limit"
+          },
+
+        # Message exceeded the maximum allowed recipient count
+        "TooManyRecipients" =>
+          {
+            :name =>"TooManyRecipients",
+            :value =>6,
+            :message =>"Message exceeded the maximum allowed recipient count"
+          },
+
+        # The message request contained invalid data
+        "InvalidData" =>
+          {
+            :name =>"InvalidData",
+            :value =>7,
+            :message =>"The message request contained invalid data"
+          },
+
+        # The account is over the send quota, rate limit exceeded
+        "OverQuota" =>
+          {
+            :name =>"OverQuota",
+            :value =>8,
+            :message =>"The account is over the send quota, rate limit exceeded"
+          },
+
+        # Too many errors occurred sending the message
+        "TooManyErrors" =>
+          {
+            :name =>"TooManyErrors",
+            :value =>9,
+            :message =>"Too many errors occurred sending the message"
+          },
+
+        # The serverId and apiKey combination is not valid
+        "InvalidAuthentication" =>
+          {
+            :name =>"InvalidAuthentication",
+            :value =>10,
+            :message =>"The serverId and apiKey combination is not valid"
+          },
+
+        # The account has been disabled
+        "AccountDisabled" =>
+          {
+            :name =>"AccountDisabled",
+            :value =>11,
+            :message =>"The account has been disabled"
+          },
+
+        # Too many messages were found on the request
+        "TooManyMessages" =>
+          {
+            :name =>"TooManyMessages",
+            :value =>12,
+            :message =>"Too many messages were found on the request"
+          },
+
+        # No valid recipients were found on the message
+        "NoValidRecipients" =>
+          {
+            :name =>"NoValidRecipients",
+            :value =>13,
+            :message =>"No valid recipients were found on the message"
+          },
+
+        # An invalid recipient address was found on the message
+        "InvalidAddress" =>
+          {
+            :name =>"InvalidAddress",
+            :value =>14,
+            :message =>"An invalid recipient address was found on the message"
+          },
+
+        # An invalid attachment was found on the message
+        "InvalidAttachment" =>
+          {
+            :name =>"InvalidAttachment",
+            :value =>15,
+            :message =>"An invalid attachment was found on the message"
+          },
+
+        # No messages were found on the request
+        "NoMessages" =>
+          {
+            :name =>"NoMessages",
+            :value =>16,
+            :message =>"No messages were found on the request"
+          },
+
+        # No message content was found on the request
+        "EmptyMessage" =>
+          {
+            :name =>"EmptyMessage",
+            :value =>17,
+            :message =>"No message content was found on the request"
+          },
+
+        # No subject was found on the message
+        "EmptySubject" =>
+          {
+            :name =>"EmptySubject",
+            :value =>18,
+            :message =>"No subject was found on the message"
+          },
+
+        # An invalid From address was found on the message
+        "InvalidFromAddress" =>
+          {
+            :name =>"InvalidFromAddress",
+            :value =>19,
+            :message =>"An invalid From address was found on the message"
+          },
+
+        # No To addresses were found on the message
+        "EmptyToAddress" =>
+          {
+            :name =>"EmptyToAddress",
+            :value =>20,
+            :message =>"No To addresses were found on the message"
+          },
+
+        # No valid message body was found on the message
+        "NoValidBodyParts" =>
+          {
+            :name =>"NoValidBodyParts",
+            :value =>21,
+            :message =>"No valid message body was found on the message"
+          },
+
+        # An invalid templateId was found on the message
+        "InvalidTemplateId" =>
+          {
+            :name =>"InvalidTemplateId",
+            :value =>22,
+            :message =>"An invalid templateId was found on the message"
+          },
+
+        # The specified templateId has no content associated with it
+        "TemplateHasNoContent" =>
+          {
+            :name =>"TemplateHasNoContent",
+            :value =>23,
+            :message =>"The specified templateId has no content associated with it"
+          },
+
+        # A conflict occurred due to the use of templateId and HtmlBody or TextBody
+        "MessageBodyConflict" =>
+          {
+            :name =>"MessageBodyConflict",
+            :value =>24,
+            :message =>"A conflict occurred due to the use of templateId and HtmlBody or TextBody"
+          },
+
+        # Invalid merge data was found on the message
+        "InvalidMergeData" =>
+          {
+            :name =>"InvalidMergeData",
+            :value =>25,
+            :message =>"Invalid merge data was found on the message"
+          },
+
+        # SDK Validation Error: Authentication validation failed, missing or invalid ServerId or ApiKey
+        "AuthenticationValidationFailed" =>
+          {
+            :name =>"AuthenticationValidationFailed",
+            :value =>26,
+            :message =>"SDK Validation Error: Authentication validation failed, missing or invalid ServerId or ApiKey"
+          },
+
+        # SDK Validation Error: Message exceeded maximum recipient count
+        "RecipientValidationMaxExceeded" =>
+          {
+            :name =>"RecipientValidationMaxExceeded",
+            :value =>27,
+            :message =>"SDK Validation Error: Message exceeded maximum recipient count"
+          },
+
+        # SDK Validation Error: No recipients were found in the message
+        "RecipientValidationNoneInMessage" =>
+          {
+            :name =>"RecipientValidationNoneInMessage",
+            :value =>28,
+            :message =>"SDK Validation Error: No recipients were found in the message"
+          },
+
+        # SDK Validation Error: Message is missing From address
+        "EmailAddressValidationMissingFrom" =>
+          {
+            :name =>"EmailAddressValidationMissingFrom",
+            :value =>29,
+            :message =>"SDK Validation Error: Message is missing From address"
+          },
+
+        # SDK Validation Error: Message is missing To address(es)
+        "RecipientValidationMissingTo" =>
+          {
+            :name =>"RecipientValidationMissingTo",
+            :value =>30,
+            :message =>"SDK Validation Error: Message is missing To address(es)"
+          },
+
+        # SDK Validation Error: Message contains an invalid From address
+        "EmailAddressValidationInvalidFrom" =>
+          {
+            :name =>"EmailAddressValidationInvalidFrom",
+            :value =>31,
+            :message =>"SDK Validation Error: Message contains an invalid From address"
+          },
+
+        # SDK Validation Error: Message does not contain a subject
+        "MessageValidationEmptySubject" =>
+          {
+            :name =>"MessageValidationEmptySubject",
+            :value =>32,
+            :message =>"SDK Validation Error: Message does not contain a subject"
+          },
+
+        # SDK Validation Error: Message does not contain a message body
+        "MessageValidationEmptyMessage" =>
+          {
+            :name =>"MessageValidationEmptyMessage",
+            :value =>33,
+            :message =>"SDK Validation Error: Message does not contain a message body"
+          },
+
+        # SDK Validation Error: Message contains invalid custom headers
+        "MessageValidationInvalidCustomHeaders" =>
+          {
+            :name =>"MessageValidationInvalidCustomHeaders",
+            :value =>34,
+            :message =>"SDK Validation Error: Message contains invalid custom headers"
+          },
+
+        # SDK Validation Error: Message contains invalid ReplyTo address
+        "RecipientValidationInvalidReplyTo" =>
+          {
+            :name =>"RecipientValidationInvalidReplyTo",
+            :value =>35,
+            :message =>"SDK Validation Error: Message contains invalid ReplyTo address"
+          },
+
+        # SDK Validation Error: Message contains invalid recipients
+        "RecipientValidationInvalidRecipients" =>
+          {
+            :name =>"RecipientValidationInvalidRecipients",
+            :value =>36,
+            :message =>"SDK Validation Error: Message contains invalid recipients"
+          },
+
+        # SDK Validation Error: Expected messageType of basic or bulk
+        "MessageValidationInvalidMessageType" =>
+          {
+            :name =>"MessageValidationInvalidMessageType",
+            :value =>37,
+            :message =>"SDK Validation Error: Expected messageType of basic or bulk"
+
+          }
+
+          }
+      end
+
+    end
+  end
+end

data/lib/socketlabs/injectionapi/socketlabsclient.rb

@@ -0,0 +1,123 @@
+require 'net/http'
+require_relative '../version.rb'
+require_relative 'send_response.rb'
+require_relative 'send_result.rb'
+require_relative 'message/message_base.rb'
+require_relative 'message/basic_message.rb'
+require_relative 'message/bulk_message.rb'
+require_relative 'core/injection_request_factory.rb'
+require_relative 'core/http_request.rb'
+
+module SocketLabs
+  module InjectionApi
+    class SocketLabsClient
+      include SocketLabs::InjectionApi::Core
+      include SocketLabs::InjectionApi::Message
+
+      public
+      def initialize (
+          server_id,
+          api_key,
+          proxy= {}
+      )
+        @server_id = server_id
+        @api_key = api_key
+        @proxy = proxy
+        @endpoint = "https://inject.socketlabs.com/api/v1/email"
+      end
+
+      # Sends a Message message and returns the response from the Injection API.
+      # @param [BasicMessage, BulkMessage] message: A Message object to be sent.
+      # @return [SendResponse] the SendResponse from the request
+      def send(message)
+
+        response = SendResponse.new
+
+        if message.instance_of? BasicMessage
+          response = send_basic_message(message)
+        end
+
+        if message.instance_of? BulkMessage
+          response = send_bulk_message(message)
+        end
+
+        response
+
+      end
+
+
+      private
+      # Your SocketLabs ServerId number.
+      attr_accessor :server_id
+      # Your SocketLabs Injection API key.
+      attr_accessor :api_key
+      # The Proxy you would like to use.
+      attr_accessor :proxy
+      # The SocketLabs Injection API endpoint Url
+      attr_accessor :endpoint
+
+      def http_method
+        HttpRequest.http_request_method[:Post]
+      end
+
+      # Sends a BasicMessage message and returns the response from the Injection API.
+      # @param [BasicMessage] message: A BasicMessage object to be sent.
+      # @return [SendResponse] the SendResponse from the request
+      def send_basic_message(message)
+
+        resp = validate_message(message)
+        if resp.result != SendResult.enum["Success"]
+          resp
+        end
+
+        req_factory = InjectionRequestFactory.new(@server_id, @api_key)
+        request = req_factory.generate_request(message)
+
+        # debug
+        request_hash = request.to_hash
+        debug_json = request_hash.to_json
+        puts debug_json
+
+        http_request = HttpRequest.new(http_method, { :http_endpoint => @endpoint, :proxy => @proxy })
+        http_request.send_request(request)
+
+      end
+
+      # Sends a BulkMessage message and returns the response from the Injection API.
+      # @param [BulkMessage] message: A BulkMessage object to be sent.
+      # @return [SendResponse] the SendResponse from the request
+      def send_bulk_message(message)
+
+        resp = validate_message(message)
+        if resp.result != SendResult.enum["Success"]
+          resp
+        end
+
+        req_factory = InjectionRequestFactory.new(@server_id, @api_key)
+        request = req_factory.generate_request(message)
+
+        # debug
+        request_hash = request.to_hash
+        debug_json = request_hash.to_json
+        puts debug_json
+
+        http_request = HttpRequest.new(http_method, { :http_endpoint => @endpoint, :proxy => @proxy })
+        http_request.send_request(request)
+
+      end
+
+      # Validate a BulkMessage message
+      # @param [MessageBase] message
+      # @return [SendResult]
+      def validate_message(message)
+        validator = SendValidator.new
+        resp = validator.validate_credentials(@server_id, @api_key)
+        if resp.result != SendResult.enum["Success"]
+          resp
+        end
+        validator.validate_message(message)
+      end
+
+    end
+  end
+end

data/lib/socketlabs/version.rb

@@ -0,0 +1,5 @@
+module SocketLabs
+  module InjectionApi
+    VERSION = '0.0.1-Dev'
+  end
+end

data/lib/socketlabs-injectionapi.rb

@@ -0,0 +1,27 @@
+require_relative 'socketlabs/injectionapi/core/send_validator'
+require_relative 'socketlabs/injectionapi/core/string_extension'
+require_relative 'socketlabs/injectionapi/address_result'
+require_relative 'socketlabs/injectionapi/proxy'
+require_relative 'socketlabs/injectionapi/send_response'
+require_relative 'socketlabs/injectionapi/send_result'
+require_relative 'socketlabs/injectionapi/socketlabsclient'
+require_relative 'socketlabs/injectionapi/message/attachment'
+require_relative 'socketlabs/injectionapi/message/message_base'
+require_relative 'socketlabs/injectionapi/message/basic_message'
+require_relative 'socketlabs/injectionapi/message/bulk_message'
+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/address_json'
+require_relative 'socketlabs/injectionapi/core/serialization/attachment_json'
+require_relative 'socketlabs/injectionapi/core/serialization/custom_header_json'
+require_relative 'socketlabs/injectionapi/core/serialization/injection_request'
+require_relative 'socketlabs/injectionapi/core/serialization/injection_response_dto'
+require_relative 'socketlabs/injectionapi/core/serialization/merge_data_json'
+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/http_request'
+require_relative 'socketlabs/injectionapi/core/http_response'

data/socketlabs-injectionapi.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'socketlabs/version.rb'
+
+Gem::Specification.new do |spec|
+  spec.name        = 'socketlabs-injectionapi'
+  spec.version     = SocketLabs::InjectionApi::VERSION
+  spec.authors     = ['David Schrenker']
+  spec.email       = 'developers@socketlabs.com'
+  spec.summary     = 'SocketLabs Injection Api'
+  spec.description = 'SocketLabs Email Delivery Ruby Client library'
+  spec.homepage    = 'https://github.com/socketlabs/socketlabs-ruby'
+
+  spec.required_ruby_version = '>= 2.4'
+
+  spec.license     = 'MIT'
+  files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(examples)/})
+  end
+  spec.files        = files
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: socketlabs-injectionapi
+version: !ruby/object:Gem::Version
+  version: 0.0.1.pre.Dev
+platform: ruby
+authors:
+- David Schrenker
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-01-29 00:00:00.000000000 Z
+dependencies: []
+description: SocketLabs Email Delivery Ruby Client library
+email: developers@socketlabs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".idea/inspectionProfiles/Project_Default.xml"
+- ".idea/misc.xml"
+- ".idea/modules.xml"
+- ".idea/socketlabs-ruby.iml"
+- ".idea/vcs.xml"
+- ".idea/workspace.xml"
+- LICENSE.MD
+- README.MD
+- gemfile
+- gemfile.lock
+- lib/socketlabs-injectionapi.rb
+- lib/socketlabs/injectionapi/address_result.rb
+- lib/socketlabs/injectionapi/core/http_request.rb
+- lib/socketlabs/injectionapi/core/http_response.rb
+- lib/socketlabs/injectionapi/core/injection_request_factory.rb
+- lib/socketlabs/injectionapi/core/injection_response_parser.rb
+- lib/socketlabs/injectionapi/core/send_validator.rb
+- lib/socketlabs/injectionapi/core/serialization/address_json.rb
+- lib/socketlabs/injectionapi/core/serialization/attachment_json.rb
+- lib/socketlabs/injectionapi/core/serialization/custom_header_json.rb
+- lib/socketlabs/injectionapi/core/serialization/injection_request.rb
+- lib/socketlabs/injectionapi/core/serialization/injection_response_dto.rb
+- lib/socketlabs/injectionapi/core/serialization/merge_data_json.rb
+- lib/socketlabs/injectionapi/core/serialization/merge_field_json.rb
+- lib/socketlabs/injectionapi/core/serialization/message_json.rb
+- lib/socketlabs/injectionapi/core/serialization/message_result_dto.rb
+- lib/socketlabs/injectionapi/core/string_extension.rb
+- lib/socketlabs/injectionapi/message/attachment.rb
+- lib/socketlabs/injectionapi/message/basic_message.rb
+- lib/socketlabs/injectionapi/message/bulk_message.rb
+- lib/socketlabs/injectionapi/message/bulk_recipient.rb
+- lib/socketlabs/injectionapi/message/custom_header.rb
+- lib/socketlabs/injectionapi/message/email_address.rb
+- lib/socketlabs/injectionapi/message/merge_data.rb
+- lib/socketlabs/injectionapi/message/message_base.rb
+- lib/socketlabs/injectionapi/proxy.rb
+- lib/socketlabs/injectionapi/send_response.rb
+- lib/socketlabs/injectionapi/send_result.rb
+- lib/socketlabs/injectionapi/socketlabsclient.rb
+- lib/socketlabs/version.rb
+- socketlabs-injectionapi.gemspec
+homepage: https://github.com/socketlabs/socketlabs-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14.3
+signing_key: 
+specification_version: 4
+summary: SocketLabs Injection Api
+test_files: []