mail_plugger 1.0.0.beta1 → 1.0.0.rc1

data/gemfiles/mail_2.6.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    mail_plugger (0.1.0)
+    mail_plugger (1.0.0.rc1)
       mail (~> 2.5)
 
 GEM
@@ -45,16 +45,16 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.1)
-    rubocop (1.7.0)
+    rubocop (1.8.0)
       parallel (~> 1.10)
-      parser (>= 2.7.1.5)
+      parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
       rubocop-ast (>= 1.2.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (1.3.0)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.0)
       parser (>= 2.7.1.5)
     rubocop-performance (1.9.2)
       rubocop (>= 0.90.0, < 2.0)
@@ -63,14 +63,14 @@ GEM
       rubocop (~> 1.0)
       rubocop-ast (>= 1.1.0)
     ruby-progressbar (1.11.0)
-    simplecov (0.20.0)
+    simplecov (0.21.2)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.2)
     thor (1.0.1)
-    unicode-display_width (1.7.0)
+    unicode-display_width (2.0.0)
     webmock (3.11.0)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
@@ -92,4 +92,4 @@ DEPENDENCIES
   webmock (~> 3.0)
 
 BUNDLED WITH
-   2.2.3
+   2.2.4

data/gemfiles/mail_2.7.0.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    mail_plugger (0.1.0)
+    mail_plugger (1.0.0.rc1)
       mail (~> 2.5)
 
 GEM
@@ -43,16 +43,16 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.1)
-    rubocop (1.7.0)
+    rubocop (1.8.0)
       parallel (~> 1.10)
-      parser (>= 2.7.1.5)
+      parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
       rubocop-ast (>= 1.2.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (1.3.0)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.0)
       parser (>= 2.7.1.5)
     rubocop-performance (1.9.2)
       rubocop (>= 0.90.0, < 2.0)
@@ -61,14 +61,14 @@ GEM
       rubocop (~> 1.0)
       rubocop-ast (>= 1.1.0)
     ruby-progressbar (1.11.0)
-    simplecov (0.20.0)
+    simplecov (0.21.2)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.2)
     thor (1.0.1)
-    unicode-display_width (1.7.0)
+    unicode-display_width (2.0.0)
     webmock (3.11.0)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
@@ -90,4 +90,4 @@ DEPENDENCIES
   webmock (~> 3.0)
 
 BUNDLED WITH
-   2.2.3
+   2.2.4

data/gemfiles/mail_2.7.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    mail_plugger (0.1.0)
+    mail_plugger (1.0.0.rc1)
       mail (~> 2.5)
 
 GEM
@@ -43,16 +43,16 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.1)
-    rubocop (1.7.0)
+    rubocop (1.8.0)
       parallel (~> 1.10)
-      parser (>= 2.7.1.5)
+      parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
       rubocop-ast (>= 1.2.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (1.3.0)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.0)
       parser (>= 2.7.1.5)
     rubocop-performance (1.9.2)
       rubocop (>= 0.90.0, < 2.0)
@@ -61,14 +61,14 @@ GEM
       rubocop (~> 1.0)
       rubocop-ast (>= 1.1.0)
     ruby-progressbar (1.11.0)
-    simplecov (0.20.0)
+    simplecov (0.21.2)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.2)
     thor (1.0.1)
-    unicode-display_width (1.7.0)
+    unicode-display_width (2.0.0)
     webmock (3.11.0)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
@@ -90,4 +90,4 @@ DEPENDENCIES
   webmock (~> 3.0)
 
 BUNDLED WITH
-   2.2.3
+   2.2.4

data/lib/mail_plugger.rb

@@ -9,26 +9,22 @@ require 'mail_plugger/version'
 
 module MailPlugger
   class << self
-    attr_reader :delivery_options, :delivery_settings, :client
+    attr_reader :client, :delivery_options, :delivery_settings
 
     # Plug in defined API(s) class.
     #
-    # @param [String] delivery_system the name of the API
+    # @param [String/Symbol] delivery_system the name of the API
     #
     # @example using Rails config/initializers/mail_plugger.rb
     #
     # The defined API class should have an 'initializer' and a 'deliver' method.
     #   class DefinedApiClientClass
-    #     def initialize(options = {}) # required
-    #       @settings = { api_key: ENV['API_KEY'] }
-    #       @massage_to = options[:to]
-    #       @message_from = options[:from]
-    #       @message_subject = options[:subject]
-    #       @message_body_text = options[:text_part]
-    #       @message_body_html = options[:html_part]
+    #     def initialize(options = {})
+    #       @settings = { api_key: '12345' }
+    #       @options = options
     #     end
     #
-    #     def deliver # required
+    #     def deliver
     #       API.new(@settings).client.post(generate_mail_hash)
     #     end
     #
@@ -38,24 +34,24 @@ module MailPlugger
     #       {
     #         to: generate_recipients,
     #         from: {
-    #           email: @message_from
+    #           email: @options[:from].first
     #         },
-    #         subject: @message_subject,
+    #         subject: @options[:subject],
     #         content: [
     #           {
     #             type: 'text/plain',
-    #             value: @message_body_text
+    #             value: @options[:text_part]
     #           },
     #           {
-    #             type: 'text/html',
-    #             value: @message_body_html
+    #             type: 'text/html; charset=UTF-8',
+    #             value: @options[:html_part]
     #           }
     #         ]
     #       }
     #     end
     #
     #     def generate_recipients
-    #       @massage_to.map do |to|
+    #       @options[:to].map do |to|
     #         {
     #           email: to
     #         }
@@ -63,18 +59,15 @@ module MailPlugger
     #     end
     #   end
     #
-    #   MailPlugger.plug_in('definedapi') do |api|
+    #   MailPlugger.plug_in('defined_api') do |api|
     #     # It will search these options in the Mail::Message object
     #     api.delivery_options = [:to, :from, :subject, :text_part, :html_part]
-    #
+    #     api.delivery_settings = { return_response: true }
     #     api.client = DefinedApiClientClass
     #   end
     #
     def plug_in(delivery_system)
-      if delivery_system.nil? || delivery_system.strip.empty?
-        raise Error::WrongDeliverySystem, 'Delivery system is nil or empty. ' \
-          'You should provide correct MailPlugger.plug_in parameter'
-      end
+      check_value(delivery_system)
 
       @delivery_system = delivery_system
 
@@ -83,15 +76,32 @@ module MailPlugger
       raise Error::WrongPlugInOption, e.message
     end
 
-    # Define 'delivery_options' and 'client' setter methods. These methods are
-    # generating a hash where the key is the 'delivery_system'. This let us to
-    # set/use more than one API.
-    %w[delivery_options delivery_settings client].each do |method|
+    # Define 'client', 'delivery_options' and 'delivery_settings' setter
+    # methods. These methods are generating a hash where the key is the
+    # 'delivery_system'. This let us to set/use more than one API.
+    %w[client delivery_options delivery_settings].each do |method|
       define_method "#{method}=" do |value|
         variable = instance_variable_get("@#{method}")
         variable = instance_variable_set("@#{method}", {}) if variable.nil?
         variable[@delivery_system] = value
       end
     end
+
+    private
+
+    def check_value(delivery_system)
+      if delivery_system.nil?
+        raise Error::WrongDeliverySystem, '"delivery_system" is nil'
+      end
+
+      if delivery_system.is_a?(String) && delivery_system.strip.empty?
+        raise Error::WrongDeliverySystem, '"delivery_system" is empty'
+      end
+
+      return if delivery_system.is_a?(String) || delivery_system.is_a?(Symbol)
+
+      raise Error::WrongDeliverySystem, '"delivery_system" does not a ' \
+        'String or Symbol'
+    end
   end
 end

data/lib/mail_plugger/delivery_method.rb

@@ -8,19 +8,31 @@ module MailPlugger
     # method, then these attributes can be nil, if not then we should set these
     # attributes.
     #
-    # @param [Hash] options with the credentials
+    # @param [Hash] options below
+    # @option options [Class/Hash] client
+    #   e.g. DefinedApiClientClass or { 'key' => DefinedApiClientClass }
+    #
+    # @option options [Array/Hash] delivery_options
+    #   e.g. [:to, :from, :subject, :body] or
+    #   { 'key' => [:to, :from, :subject, :body] }
+    #
+    # @option options [Hash] delivery_settings
+    #   e.g. { return_response: true }
+    #
+    # @option options [String/Symbol] default_delivery_system
+    #   e.g. 'defined_api'
     def initialize(options = {})
+      @client                  = options[:client] || MailPlugger.client
+
       @delivery_options        = options[:delivery_options] ||
                                  MailPlugger.delivery_options
 
-      @client                  = options[:client] || MailPlugger.client
+      @delivery_settings       = options[:delivery_settings] ||
+                                 MailPlugger.delivery_settings
 
       @default_delivery_system = options[:default_delivery_system] ||
                                  default_delivery_system_get
 
-      @delivery_settings       = options[:delivery_settings] ||
-                                 MailPlugger.delivery_settings
-
       @message                 = nil
     end
 
@@ -31,6 +43,31 @@ module MailPlugger
     # provided client class which has a 'deliver' method.
     #
     # @param [Mail::Message] message what we would like to send
+    #
+    # @return [Mail::Message/Hash] depend on delivery_settings and method calls
+    #
+    # @example
+    #
+    #   MailPlugger.plug_in('test_api_client') do |api|
+    #     api.delivery_options = %i[from to subject body]
+    #     api.client = DefinedApiClientClass
+    #   end
+    #
+    #   message = Mail.new(from: 'from@example.com', to: 'to@example.com',
+    #                      subject: 'Test email', body: 'Test email body')
+    #
+    #   MailPlugger::DeliveryMethod.new.deliver!(message)
+    #
+    # or
+    #
+    #   message = Mail.new(from: 'from@example.com', to: 'to@example.com',
+    #                      subject: 'Test email', body: 'Test email body')
+    #
+    #   MailPlugger::DeliveryMethod.new(
+    #     delivery_options: %i[from to subject body],
+    #     client: DefinedApiClientClass
+    #   ).deliver!(message)
+    #
     def deliver!(message)
       unless message.is_a?(Mail::Message)
         raise Error::WrongParameter,

data/lib/mail_plugger/mail_helper.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'base64'
+require 'mail/indifferent_hash'
 
 module MailPlugger
   module MailHelper
@@ -42,6 +43,8 @@ module MailPlugger
       data = {}
 
       delivery_options.each do |option|
+        option = option.to_sym unless option.is_a?(Symbol)
+
         data[option] =
           case option
           when :from, :to, :cc, :bcc, :subject
@@ -50,12 +53,14 @@ module MailPlugger
             extract_attachments
           when :body, :html_part, :text_part
             @message.public_send(option)&.decoded
+          when :message_obj
+            @message
           else
-            message_field_value_from(@message[option.to_s])
+            message_field_value_from(@message[option])
           end
       end
 
-      data
+      Mail::IndifferentHash.new(data)
     end
 
     # Tries to set up a default delivery system, if the 'delivery_system'
@@ -65,11 +70,7 @@ module MailPlugger
     #
     # @return [Stirng] the first key of the 'delivery_options' or 'client'
     def default_delivery_system_get
-      if @delivery_options.is_a?(Hash)
-        @delivery_options
-      elsif @client.is_a?(Hash)
-        @client
-      end&.keys&.first
+      extract_keys&.first
     end
 
     # Extract 'delivery_options'. If it's a hash then it'll return the right
@@ -95,16 +96,30 @@ module MailPlugger
     # @return [String] with the name of the delivery system
     def delivery_system
       @delivery_system ||=
-        (@message && message_field_value_from(@message['delivery_system'])) ||
+        (@message && message_field_value_from(@message[:delivery_system])) ||
         @default_delivery_system
 
-      if @delivery_system.nil? &&
-         (@delivery_options.is_a?(Hash) || @client.is_a?(Hash))
+      delivery_system_value_check
+
+      @delivery_system
+    end
+
+    # Check the given 'delivery_options' or 'client' are hashes and
+    # if one of that does then check the 'delivery_system' is valid or not.
+    # If the given 'delivery_system' is nil or doesn't match with extracted keys
+    # then it will raise error.
+    def delivery_system_value_check
+      return unless @delivery_options.is_a?(Hash) || @client.is_a?(Hash)
+
+      if @delivery_system.nil?
         raise Error::WrongDeliverySystem,
               '"delivery_system" was not defined as a Mail::Message parameter'
       end
 
-      @delivery_system
+      return if extract_keys&.include?(@delivery_system)
+
+      raise Error::WrongDeliverySystem,
+            "\"delivery_system\" '#{@delivery_system}' does not exist"
     end
 
     # Extract attachments.
@@ -112,21 +127,29 @@ module MailPlugger
     # @return [Array] with extracted attachment hashes
     def extract_attachments
       @message.attachments&.map do |attachment|
-        hash =
-          if attachment.inline?
-            { cid: attachment.cid }
-          else
-            { filename: attachment.filename }
-          end
+        hash = attachment.inline? ? { cid: attachment.cid } : {}
 
         hash.merge(
+          filename: attachment.filename,
           type: attachment.mime_type,
           content: Base64.encode64(attachment.decoded)
         )
       end
     end
 
-    # How to Extract the (uparsed) value of the mail message fields.
+    # Extract keys from 'delivery_options' or 'client', depends on which is a
+    # hash. If none of these are hashes then returns nil.
+    #
+    # @return [Array/NilClass] with the keys of 'delivery_options' or 'client'
+    def extract_keys
+      if @delivery_options.is_a?(Hash)
+        @delivery_options
+      elsif @client.is_a?(Hash)
+        @client
+      end&.keys
+    end
+
+    # How to Extract the (unparsed) value of the mail message fields.
     #
     # @return [String] version dependent method call
     def mail_field_value