mail_plugger 1.3.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f909bb4d7136983266dbbe01519966ec0a3f5166cd7576401de5129e8fb6d255
-  data.tar.gz: 79a650bdbe95199bb28ff1dddefbf405d09e2dcf661d8bb0557b7c4594d85cc4
+  metadata.gz: 7ec4ac88872c10e0533aac02a9947fdb9f93a7027d004e380cd5a0f854db3840
+  data.tar.gz: 82f4adcbdcac821c94161cc61da1cb2228f3fee00fbfdd7306a17fe5e87a5347
 SHA512:
-  metadata.gz: 82416b31f9a56713434d37055caf55c83d361ea0bb22f1d643116106bc13cb5803974d9f89945ef938471fb63626742299353f40673df24f49f2ef098172daee
-  data.tar.gz: 2ee3ad7f530aad9e8dcf864bef0dc17c3dd23fea193fa796cffd676bf917f11d36a0af95632edb46fd2bb0267c12035f95b4783dd80fea1cff2125d5fcfc90f6
+  metadata.gz: de83d9be11f14e045b70bdfcc6bac03353d3b84fee8e5858cf24558236925d750015117f0d04efb953161b735bf8c3beaa1ac474483e07856a215778633132c8
+  data.tar.gz: 03ff6162170252b04c7af6f7d1754ecd7d8a6e8c1843a59986b5c1b8a279f54542abd744e57e923e524f8526dc1866296a873ae0e1776567da2b94c1f37780e6

data/CHANGELOG.md

@@ -1,5 +1,37 @@
 # Change log
 
+## 1.6.0 (2022-05-26)
+
+### Changes
+
+* Drop Ruby 2.6 support.
+* Fix some grammar issues and typos.
+* Update bundler and gems.
+
+
+## 1.5.0 (2021-12-31)
+
+### Changes
+
+* Add Ruby 3.1 support.
+* Drop Ruby 2.5 support.
+* Require MFA on RubyGems.
+* Update bundler and gems.
+* Fix typo in the README.md.
+* Replace Travis with GitHub Actions.
+
+
+## 1.4.0 (2021-06-08)
+
+### New features
+
+* Add SMTP support. With this modifications we can use SMTP and API delivery methods as well.
+
+### Changes
+
+* Update bundler and gems.
+
+
 ## 1.3.0 (2021-04-14)
 
 ### New features

data/README.md

@@ -3,11 +3,11 @@
 [![Gem Version](https://badge.fury.io/rb/mail_plugger.svg)](https://badge.fury.io/rb/mail_plugger)
 [![MIT license](https://img.shields.io/badge/license-MIT-brightgreen)](https://github.com/MailToolbox/mail_plugger/blob/main/LICENSE.txt)
 [![Ruby Style Guide](https://img.shields.io/badge/code_style-rubocop-brightgreen.svg)](https://github.com/rubocop-hq/rubocop)
-[![Build Status](https://travis-ci.com/MailToolbox/mail_plugger.svg?branch=main)](https://travis-ci.com/MailToolbox/mail_plugger)
+[![MailPlugger CI](https://github.com/MailToolbox/mail_plugger/actions/workflows/mail_plugger_ci.yml/badge.svg)](https://github.com/MailToolbox/mail_plugger/actions/workflows/mail_plugger_ci.yml)
 [![Maintainability](https://api.codeclimate.com/v1/badges/137881380fc475b4a836/maintainability)](https://codeclimate.com/github/MailToolbox/mail_plugger/maintainability)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/137881380fc475b4a836/test_coverage)](https://codeclimate.com/github/MailToolbox/mail_plugger/test_coverage)
 
-**MailPlugger** helps you to use different mail providers' **API**. You can use any APIs which one would like to use. It allows you to send different emails with different APIs. Also it can help to move between providers, load balacing or cost management.
+**MailPlugger** helps you to use different mail providers' **SMTP** and **API**. You can use any SMTPs and APIs which one would like to use. It allows you to send different emails with different SMTPs and APIs. Also, it can help to move between providers, load balancing or cost management.
 
 ## Installation
 
@@ -31,26 +31,29 @@ Or install it yourself as:
 - [How to use MailPlugger::DeliveryMethod class](https://github.com/MailToolbox/mail_plugger/blob/main/docs/usage_of_delivery_method.md)
 - [How to use MailPlugger in a Ruby script or IRB console](https://github.com/MailToolbox/mail_plugger/blob/main/docs/usage_in_script_or_console.md)
 - [How to use MailPlugger in Ruby on Rails](https://github.com/MailToolbox/mail_plugger/blob/main/docs/usage_in_ruby_on_rails.md)
-  - [How to add API specific options to the mailer method in Ruby on Rails](https://github.com/MailToolbox/mail_plugger/blob/main/docs/usage_of_special_options_in_ruby_on_rails.md)
-  - [How to add attachments to the mailer method in Ruby on Rails](https://github.com/MailToolbox/mail_plugger/blob/main/docs/usage_of_attachments_in_ruby_on_rails.md)
-  - [How to use more delivey systems in Ruby on Rails](https://github.com/MailToolbox/mail_plugger/blob/main/docs/usage_of_more_delivery_system_in_ruby_on_rails.md)
-  - [How to use one delivey system with more send methods in Ruby on Rails](https://github.com/MailToolbox/mail_plugger/blob/main/docs/usage_of_one_delivery_system_with_more_send_methods_in_ruby_on_rails.md)
-  - [How to use AWS SES with MailPlugger in Ruby on Rails](https://github.com/MailToolbox/mail_plugger/blob/main/docs/usage_of_aws_ses_in_ruby_on_rails.md)
-  - [How to use SparkPost with MailPlugger in Ruby on Rails](https://github.com/MailToolbox/mail_plugger/blob/main/docs/usage_of_sparkpost_in_ruby_on_rails.md)
-  - [How to use SendGrid with MailPlugger in Ruby on Rails](https://github.com/MailToolbox/mail_plugger/blob/main/docs/usage_of_sendgrid_in_ruby_on_rails.md)
-  - [How to use Mandrill with MailPlugger in Ruby on Rails](https://github.com/MailToolbox/mail_plugger/blob/main/docs/usage_of_mandrill_in_ruby_on_rails.md)
-  - [How to use Postmark with MailPlugger in Ruby on Rails](https://github.com/MailToolbox/mail_plugger/blob/main/docs/usage_of_postmark_in_ruby_on_rails.md)
-  - [How to use Mailgun with MailPlugger in Ruby on Rails](https://github.com/MailToolbox/mail_plugger/blob/main/docs/usage_of_mailgun_in_ruby_on_rails.md)
+  - [How to use more SMTP delivery systems in Ruby on Rails](https://github.com/MailToolbox/mail_plugger/blob/main/docs/usage_of_more_smtp_delivery_systems_in_ruby_on_rails.md)
+  - [How to combine SMTP and API delivery systems in Ruby on Rails](https://github.com/MailToolbox/mail_plugger/blob/main/docs/usage_of_smtp_and_api_delivery_systems_in_ruby_on_rails.md)
+  - [How to add API specific options to the mailer method in Ruby on Rails](https://github.com/MailToolbox/mail_plugger/blob/main/docs/usage_of_api_specific_options_in_ruby_on_rails.md)
+  - [How to use API delivery system that add attachments to the mailer method in Ruby on Rails](https://github.com/MailToolbox/mail_plugger/blob/main/docs/usage_of_api_attachments_in_ruby_on_rails.md)
+  - [How to use more API delivery systems in Ruby on Rails](https://github.com/MailToolbox/mail_plugger/blob/main/docs/usage_of_more_api_delivery_systems_in_ruby_on_rails.md)
+  - [How to use one API delivery system with more send methods in Ruby on Rails](https://github.com/MailToolbox/mail_plugger/blob/main/docs/usage_of_one_api_delivery_system_with_more_send_methods_in_ruby_on_rails.md)
+  - [How to use AWS SES API with MailPlugger in Ruby on Rails](https://github.com/MailToolbox/mail_plugger/blob/main/docs/usage_of_aws_ses_api_in_ruby_on_rails.md)
+  - [How to use SparkPost API with MailPlugger in Ruby on Rails](https://github.com/MailToolbox/mail_plugger/blob/main/docs/usage_of_sparkpost_api_in_ruby_on_rails.md)
+  - [How to use SendGrid API with MailPlugger in Ruby on Rails](https://github.com/MailToolbox/mail_plugger/blob/main/docs/usage_of_sendgrid_api_in_ruby_on_rails.md)
+  - [How to use Mandrill API with MailPlugger in Ruby on Rails](https://github.com/MailToolbox/mail_plugger/blob/main/docs/usage_of_mandrill_api_in_ruby_on_rails.md)
+  - [How to use Postmark API with MailPlugger in Ruby on Rails](https://github.com/MailToolbox/mail_plugger/blob/main/docs/usage_of_postmark_api_in_ruby_on_rails.md)
+  - [How to use Mailgun API with MailPlugger in Ruby on Rails](https://github.com/MailToolbox/mail_plugger/blob/main/docs/usage_of_mailgun_api_in_ruby_on_rails.md)
 
 # F<img src="https://raw.githubusercontent.com/MailToolbox/mail_plugger/main/images/fake_plugger800x500.png" height="22" />kePlugger
 
-**FakePlugger** is a delivery method to mock **MailPlugger**. It is working similarly like **MailPlugger**, but it won't send any emails (but if we would like it is possible, just we should do manually). Also it can write out debug informations or we can manipulate the response with it. Another option that we can use **[MailGrabber](https://github.com/MailToolbox/mail_grabber)** web interface if the delivery method is `:fake_plugger`.
+**FakePlugger** is a delivery method to mock **MailPlugger**. It is working similarly like **MailPlugger**, but it won't send any emails (but if we would like it is possible, just we should do manually). Also, it can write out debug information, or we can manipulate the response with it. Another option that we can use **[MailGrabber](https://github.com/MailToolbox/mail_grabber)** web interface if the delivery method is `:fake_plugger`.
 
 ## Usage
 
 - [How to use FakePlugger::DeliveryMethod class](https://github.com/MailToolbox/mail_plugger/blob/main/docs/usage_of_fake_plugger_delivery_method.md)
 - [How to use FakePlugger in a Ruby script or IRB console](https://github.com/MailToolbox/mail_plugger/blob/main/docs/usage_of_fake_plugger_in_script_or_console.md)
 - [How to use FakePlugger in Ruby on Rails](https://github.com/MailToolbox/mail_plugger/blob/main/docs/usage_of_fake_plugger_in_ruby_on_rails.md)
+  - [How to use FakePlugger with more delivery systems in Ruby on Rails](https://github.com/MailToolbox/mail_plugger/blob/main/docs/usage_of_fake_plugger_with_more_delivery_systems_in_ruby_on_rails.md)
   - [How to use FakePlugger with MailGrabber in Ruby on Rails](https://github.com/MailToolbox/mail_plugger/blob/main/docs/usage_of_fake_plugger_with_mail_grabber_in_ruby_on_rails.md)
 
 ## Development

data/lib/fake_plugger/delivery_method.rb

@@ -23,10 +23,10 @@ module FakePlugger
     #   e.g. 'defined_api'
     #
     # @option options [Boolean] debug
-    #   if true it will show debug informations
+    #   if true, it will show debug information
     #
     # @option options [Boolean] raw_message
-    #   if true it will show raw message
+    #   if true, it will show raw message
     #
     # @option options [String/Symbol/Array/Hash] response
     #   the deliver! method will return with this value or if this value is nil
@@ -38,30 +38,37 @@ module FakePlugger
     def initialize(options = {})
       super
 
-      @debug            = options[:debug] ||
-                          settings[:fake_plugger_debug] || false
-      @raw_message      = options[:raw_message] ||
-                          settings[:fake_plugger_raw_message] || false
-      @response         = options[:response] || settings[:fake_plugger_response]
-      @use_mail_grabber = options[:use_mail_grabber] ||
-                          settings[:fake_plugger_use_mail_grabber] || false
+      @debug            = options[:debug]
+
+      @raw_message      = options[:raw_message]
+
+      @response         = options[:response]
+
+      @use_mail_grabber = options[:use_mail_grabber]
     end
 
+    # Using SMTP:
+    # Mock send message via SMTP protocol if the 'delivery_settings' contains a
+    # 'smtp_settings' key and the value is a hash with the settings.
+    #
+    # Using API:
     # Mock send message with the given client if the message parameter is a
-    # Mail::Message object. If 'response' parameter is nil then it will extract
-    # those information from the Mail::Message object which was provided in the
+    # Mail::Message object. If 'response' parameter is nil, then it will extract
+    # this information from the Mail::Message object which was provided in the
     # 'delivery_options'. After that it generates a hash with these data and
     # returns with the provided client class which has a 'deliver' method, but
     # it won't call the 'deliver' method.
     # If the 'response' parameter is a hash with 'return_delivery_data: true'
-    # then it will retrun with the extracted delivery data.
-    # If the 'response' parameter is not nil then retruns with that given data
+    # then it will return with the extracted delivery data.
+    #
+    #
+    # If the 'response' parameter is not nil, then returns with that given data
     # without call any other methods.
-    # Except if 'debug' is true. In this case it will call those methods which
-    # is calling in normal operation as well.
-    # If 'debug' is true then it prints out some debug informations.
-    # If 'raw_message' is true then it prints out raw message.
-    # if 'use_mail_grabber' is true then it stores the message in a database.
+    # Except if 'debug' is true. In this case, it will call those methods which
+    # are calling in normal operation as well.
+    # If 'debug' is true, then it prints out some debug information.
+    # If 'raw_message' is true, then it prints out raw message.
+    # If 'use_mail_grabber' is true, then it stores the message in a database.
     #
     # @param [Mail::Message] message what we would like to send
     #
@@ -69,6 +76,48 @@ module FakePlugger
     #
     # @example
     #
+    #   # Using SMTP:
+    #
+    #   MailPlugger.plug_in('test_smtp_client') do |smtp|
+    #     smtp.delivery_settings = {
+    #       smtp_settings: {
+    #         address: 'smtp.server.com',
+    #         port: 587,
+    #         domain: 'test.domain.com',
+    #         enable_starttls_auto: true,
+    #         user_name: 'test_user',
+    #         password: '1234',
+    #         authentication: :plain
+    #       }
+    #     }
+    #   end
+    #
+    #   message = Mail.new(from: 'from@example.com', to: 'to@example.com',
+    #                      subject: 'Test email', body: 'Test email body')
+    #
+    #   FakePlugger::DeliveryMethod.new.deliver!(message)
+    #
+    #   # or
+    #
+    #   message = Mail.new(from: 'from@example.com', to: 'to@example.com',
+    #                      subject: 'Test email', body: 'Test email body')
+    #
+    #   FakePlugger::DeliveryMethod.new(
+    #     delivery_settings: {
+    #       smtp_settings: {
+    #         address: 'smtp.server.com',
+    #         port: 587,
+    #         domain: 'test.domain.com',
+    #         enable_starttls_auto: true,
+    #         user_name: 'test_user',
+    #         password: '1234',
+    #         authentication: :plain
+    #       }
+    #     }
+    #   ).deliver!(message)
+    #
+    #   # Using API:
+    #
     #   MailPlugger.plug_in('test_api_client') do |api|
     #     api.delivery_options = %i[from to subject body]
     #     api.delivery_settings = {
@@ -107,6 +156,8 @@ module FakePlugger
 
       @message = message
 
+      update_settings
+
       call_extra_options
 
       return_with_response
@@ -114,8 +165,8 @@ module FakePlugger
 
     private
 
-    # Call extra options like show debug informations, show raw message,
-    # use mail grabber
+    # Call extra options like show debug information, show raw message,
+    # use mail grabber.
     def call_extra_options
       show_debug_info if @debug
       show_raw_message if @raw_message
@@ -125,18 +176,8 @@ module FakePlugger
       MailGrabber::DeliveryMethod.new.deliver!(@message)
     end
 
-    # Return with a response which depends on the conditions.
-    def return_with_response
-      return client.new(delivery_data) if @response.nil?
-      if @response.is_a?(Hash) && @response[:return_delivery_data]
-        return delivery_data
-      end
-
-      @response
-    end
-
-    # Show debug informations from variables and methods.
-    def show_debug_info
+    # Debug information for API
+    def debug_info_for_api
       puts <<~DEBUG_INFO
 
         ===================== FakePlugger::DeliveryMethod =====================
@@ -170,6 +211,62 @@ module FakePlugger
       DEBUG_INFO
     end
 
+    # Debug information for SMTP
+    def debug_info_for_smtp
+      puts <<~DEBUG_INFO
+
+        ===================== FakePlugger::DeliveryMethod =====================
+
+        ------------------------------ Variables ------------------------------
+
+        ==> @delivery_settings: #{@delivery_settings.inspect}
+
+        ==> @default_delivery_system: #{@default_delivery_system.inspect}
+
+        ==> @message: #{@message.inspect}
+
+        ------------------------------- Methods -------------------------------
+
+        ==> delivery_system: #{delivery_system.inspect}
+
+        ==> settings: #{settings.inspect}
+
+        =======================================================================
+
+      DEBUG_INFO
+    end
+
+    # Prepare delivery. It depends on that is SMTP or API.
+    def prepare_delivery
+      if send_via_smtp?
+        @message.delivery_method :smtp, settings[:smtp_settings]
+        @message
+      else
+        client.new(delivery_data)
+      end
+    end
+
+    # Check that it should return with the delivery data.
+    def return_delivery_data?
+      !send_via_smtp? &&
+        @response.is_a?(Hash) &&
+        @response[:return_delivery_data]
+    end
+
+    # Return with a response which depends on the conditions.
+    def return_with_response
+      return prepare_delivery if @response.nil?
+
+      return delivery_data if return_delivery_data?
+
+      @response
+    end
+
+    # Show debug information from variables and methods.
+    def show_debug_info
+      send_via_smtp? ? debug_info_for_smtp : debug_info_for_api
+    end
+
     # Show raw message for debug purpose.
     def show_raw_message
       puts <<~RAW_MESSAGE
@@ -182,5 +279,18 @@ module FakePlugger
 
       RAW_MESSAGE
     end
+
+    # Extract settings values and update attributes.
+    def update_settings
+      # rubocop:disable Naming/MemoizedInstanceVariableName
+      @debug            ||= settings[:fake_plugger_debug] || false
+
+      @raw_message      ||= settings[:fake_plugger_raw_message] || false
+
+      @response         ||= settings[:fake_plugger_response]
+
+      @use_mail_grabber ||= settings[:fake_plugger_use_mail_grabber] || false
+      # rubocop:enable Naming/MemoizedInstanceVariableName
+    end
   end
 end

data/lib/mail_plugger/delivery_method.rb

@@ -30,24 +30,73 @@ module MailPlugger
       @delivery_settings       = options[:delivery_settings] ||
                                  MailPlugger.delivery_settings
 
+      @delivery_systems        = MailPlugger.delivery_systems
+
       @default_delivery_system = options[:default_delivery_system] ||
                                  default_delivery_system_get
 
       @message                 = nil
     end
 
+    # Using SMTP:
+    # Send message via SMTP protocol if the 'delivery_settings' contains a
+    # 'smtp_settings' key and the value is a hash with the settings.
+    #
+    # Using API:
     # Send message with the given client if the message parameter is a
-    # Mail::Message object. Before doing that extract those information from the
+    # Mail::Message object. Before doing that, extract this information from the
     # Mail::Message object which was provided in the 'delivery_options'. After
     # that it generates a hash with these data and sends the message with the
     # 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
+    # @return [Mail::Message/Hash] depends on delivery_settings and method calls
     #
     # @example
     #
+    #   # Using SMTP:
+    #
+    #   MailPlugger.plug_in('test_smtp_client') do |smtp|
+    #     smtp.delivery_settings = {
+    #       smtp_settings: {
+    #         address: 'smtp.server.com',
+    #         port: 587,
+    #         domain: 'test.domain.com',
+    #         enable_starttls_auto: true,
+    #         user_name: 'test_user',
+    #         password: '1234',
+    #         authentication: :plain
+    #       }
+    #     }
+    #   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_settings: {
+    #       smtp_settings: {
+    #         address: 'smtp.server.com',
+    #         port: 587,
+    #         domain: 'test.domain.com',
+    #         enable_starttls_auto: true,
+    #         user_name: 'test_user',
+    #         password: '1234',
+    #         authentication: :plain
+    #       }
+    #     }
+    #   ).deliver!(message)
+    #
+    #   # Using API:
+    #
     #   MailPlugger.plug_in('test_api_client') do |api|
     #     api.delivery_options = %i[from to subject body]
     #     api.client = DefinedApiClientClass
@@ -76,7 +125,12 @@ module MailPlugger
 
       @message = message
 
-      client.new(delivery_data).deliver
+      if send_via_smtp?
+        message.delivery_method :smtp, settings[:smtp_settings]
+        message.deliver!
+      else
+        client.new(delivery_data).deliver
+      end
     end
   end
 end

data/lib/mail_plugger/error.rb

@@ -2,24 +2,25 @@
 
 module MailPlugger
   class Error < StandardError
-    # Specific error class for errors if client is not given or has a wrong type
+    # Specific error class for errors if client is not given or has a wrong
+    # type.
     class WrongApiClient < Error; end
 
-    # Specific error class for errors if delivery options is not given or
-    # has a wrong type
+    # Specific error class for errors if delivery options are not given or
+    # has a wrong type.
     class WrongDeliveryOptions < Error; end
 
-    # Specific error class for errors if delivery settings has a wrong type
+    # Specific error class for errors if delivery settings has a wrong type.
     class WrongDeliverySettings < Error; end
 
-    # Specific error class for errors if delivery system is not given
+    # Specific error class for errors if delivery system is not given.
     class WrongDeliverySystem < Error; end
 
-    # Specific error class for errors if parameter is not given
+    # Specific error class for errors if parameter is not given.
     class WrongParameter < Error; end
 
-    # Specific error class for errors if tries to add undelclared option
-    # in plug_in block
+    # Specific error class for errors if tries to add undeclared option
+    # in plug_in block.
     class WrongPlugInOption < Error; end
   end
 end

data/lib/mail_plugger/mail_helper.rb

@@ -5,6 +5,15 @@ require 'mail/indifferent_hash'
 
 module MailPlugger
   module MailHelper
+    DELIVERY_SETTINGS_KEYS = %i[
+      fake_plugger_debug
+      fake_plugger_raw_message
+      fake_plugger_response
+      fake_plugger_use_mail_grabber
+      return_response
+      smtp_settings
+    ].freeze
+
     # Check the version of a gem.
     #
     # @param [String] gem_name the name of the gem
@@ -18,9 +27,9 @@ module MailPlugger
       requirement.satisfied_by?(current_version)
     end
 
-    # Extract 'client'. If it's a hash then it'll return the right
-    # client belongs to the delivery system. If it's not a hash it'll return
-    # the given value. But if the value doesn't a class it'll raise an error.
+    # Extract 'client'. If it's a hash, then it'll return the right
+    # client belongs to the delivery system. If it's not a hash, it'll return
+    # the given value. But if the value doesn't a class, it'll raise an error.
     #
     # @return [Class] the defined API class
     def client
@@ -64,18 +73,22 @@ module MailPlugger
     end
 
     # Tries to set up a default delivery system, if the 'delivery_system'
-    # wasn't defined in the Mail::Message object and 'delivery_options' and/or
-    # 'client' is a hash. Which means the MailPlugger.plugin method was used,
-    # probably.
+    # wasn't defined in the Mail::Message object, and we're using
+    # MailPlugger.plug_in then it returns with first key of the stored
+    # 'delivery_systems'.
+    # When we aren't using MailPlugger.plug_in method and 'delivery_options',
+    # 'client' and/or 'delivery_settings' is a hash, then it tries to get the
+    # 'delivery_system' from the hashes.
+    # Otherwise, it returns with nil.
     #
-    # @return [Stirng] the first key of the 'delivery_options' or 'client'
+    # @return [Stirng/NilClass] the first key from the extracted keys or nil
     def default_delivery_system_get
       extract_keys&.first
     end
 
-    # Extract 'delivery_options'. If it's a hash then it'll return the right
-    # options belongs to the delivery system. If it's not a hash it'll return
-    # the given value. But if the value doesn't an array it'll raise an error.
+    # Extract 'delivery_options'. If it's a hash, then it'll return the right
+    # options, belongs to the delivery system. If it's not a hash, it'll return
+    # the given value. But if the value doesn't an array, it'll raise an error.
     #
     # @return [Array] the options it'll collect from the Mail::Message object
     def delivery_options
@@ -90,8 +103,9 @@ module MailPlugger
     end
 
     # Extract 'delivery_system' from the Mail::Message object or if it's not
-    # defined then use the default one. If it's still nil and one of the
-    # 'delivery_options' or 'client' is a hash then raise error.
+    # defined, then use the default one. If it's still nil and one of the
+    # 'delivery_options', 'client' and/or 'delivery_settings' is a hash and
+    # 'delivery_settings' doesn't contain 'delivery_system' then raise error.
     #
     # @return [String] with the name of the delivery system
     def delivery_system
@@ -104,12 +118,13 @@ module MailPlugger
       @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.
+    # Check the given 'delivery_options', 'client' and 'delivery_settings' 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)
+      return unless need_delivery_system?
 
       if @delivery_system.nil?
         raise Error::WrongDeliverySystem,
@@ -122,6 +137,17 @@ module MailPlugger
             "\"delivery_system\" '#{@delivery_system}' does not exist"
     end
 
+    # Check that 'delivery_settings' has 'delivery_system' key or not.
+    # If 'delivery_settings' contains 'DELIVERY_SETTINGS_KEYS' then it returns
+    # false, else true.
+    #
+    # @return [Boolean] true/false
+    def exclude_delivey_settings_keys?
+      @delivery_settings.keys.none? do |key|
+        DELIVERY_SETTINGS_KEYS.include?(key.to_sym)
+      end
+    end
+
     # Extract attachments.
     #
     # @return [Array] with extracted attachment hashes
@@ -137,19 +163,32 @@ module MailPlugger
       end
     end
 
-    # Extract keys from 'delivery_options' or 'client', depends on which is a
-    # hash. If none of these are hashes then returns nil.
+    # Return 'delivery_systems' array if it's exist. If not, then extract keys
+    # from 'delivery_options', 'client' or 'delivery_settings',
+    # 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'
+    # @return [Array/NilClass] with the keys or nil
     def extract_keys
+      return @delivery_systems unless @delivery_systems.nil?
+
+      extract_keys_from_other_variables
+    end
+
+    # Extract keys from 'delivery_options', 'client' or 'delivery_settings',
+    # depends on which is a hash. If none of these are hashes, then returns nil.
+    #
+    # @return [Array/NilClass] with the keys from one of the hash or nil
+    def extract_keys_from_other_variables
       if @delivery_options.is_a?(Hash)
         @delivery_options
       elsif @client.is_a?(Hash)
         @client
+      elsif @delivery_settings.is_a?(Hash) && exclude_delivey_settings_keys?
+        @delivery_settings
       end&.keys
     end
 
-    # How to Extract the (unparsed) value of the mail message fields.
+    # How to extract the (unparsed) value of the mail message fields.
     #
     # @return [String] version dependent method call
     def mail_field_value
@@ -174,6 +213,17 @@ module MailPlugger
       message_field.public_send(*mail_field_value)
     end
 
+    # Check if either 'deliviery_options' or 'client' is a hash.
+    # Or delivery_settings is a hash but not contains 'DELIVERY_SETTINGS_KEYS'
+    # in first level.
+    #
+    # @return [Boolean] true/false
+    def need_delivery_system?
+      @delivery_options.is_a?(Hash) ||
+        @client.is_a?(Hash) ||
+        (@delivery_settings.is_a?(Hash) && exclude_delivey_settings_keys?)
+    end
+
     # Extract the value from the given options.
     #
     # @param [Hash/Array/Class] option
@@ -187,11 +237,22 @@ module MailPlugger
       end
     end
 
-    # Extract 'settings'. If it's a hash then it'll return the right
-    # settings belongs to the delivery system. If it's not a hash it'll return
-    # the given value. But if the value doesn't a hash it'll raise an error.
+    # Check that settings contains any SMTP related settings.
+    #
+    # @return [Boolean] true/false
+    def send_via_smtp?
+      return true if settings[:smtp_settings].is_a?(Hash) &&
+                     settings[:smtp_settings].any?
+
+      false
+    end
+
+    # Extract 'settings'. If it's a hash, then it'll return the right
+    # settings, belongs to the delivery system. If 'delivery_settings' is nil,
+    # it'll return an empty hash. But if the value doesn't a hash, it'll raise
+    # an error.
     #
-    # @return [Hash] settings for Mail delivery_method
+    # @return [Hash] settings for Mail delivery_method and/or FakePlugger
     def settings
       @settings ||= option_value_from(@delivery_settings)
 

data/lib/mail_plugger/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MailPlugger
-  VERSION = '1.3.0'
+  VERSION = '1.6.0'
 end

data/lib/mail_plugger.rb

@@ -3,24 +3,45 @@
 require 'mail_plugger/error'
 require 'mail_plugger/mail_helper'
 require 'mail_plugger/delivery_method'
-# If we are using this gem outside of Rails then do not load this code.
+# If we are using this gem outside of Rails, then do not load this code.
 require 'mail_plugger/railtie' if defined?(Rails)
 require 'mail_plugger/version'
 
 require 'fake_plugger/delivery_method'
-# If we are using this gem outside of Rails then do not load this code.
+# If we are using this gem outside of Rails, then do not load this code.
 require 'fake_plugger/railtie' if defined?(Rails)
 
 module MailPlugger
   class << self
-    attr_reader :client, :delivery_options, :delivery_settings
+    attr_reader :client,
+                :delivery_options,
+                :delivery_settings,
+                :delivery_systems
 
-    # Plug in defined API(s) class.
+    # Plug in SMTP(s) or defined API(s) class.
     #
-    # @param [String/Symbol] delivery_system the name of the API
+    # @param [String/Symbol] delivery_system the name of the SMTP/API
     #
     # @example using Rails `config/initializers/mail_plugger.rb`
     #
+    #   # Using SMTP:
+    #
+    #   MailPlugger.plug_in('smtp_client') do |smtp|
+    #     smtp.delivery_settings = {
+    #       smtp_settings: {
+    #         address: 'smtp.server.com',
+    #         port: 587,
+    #         domain: 'test.domain.com',
+    #         enable_starttls_auto: true,
+    #         user_name: 'test_user',
+    #         password: '1234',
+    #         authentication: :plain
+    #       }
+    #     }
+    #   end
+    #
+    #   # Using API:
+    #
     #   # The defined API class should have an 'initialize' and a 'deliver'
     #   # method.
     #   class DefinedApiClientClass
@@ -75,6 +96,7 @@ module MailPlugger
       check_value(delivery_system)
 
       @delivery_system = delivery_system
+      (@delivery_systems ||= []) << delivery_system
 
       yield self
     rescue NoMethodError => e
@@ -82,8 +104,8 @@ module MailPlugger
     end
 
     # 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.
+    # methods. These methods are generating a hash, where the key is the
+    # 'delivery_system'. This let us set/use more than one STMP/API.
     %w[client delivery_options delivery_settings].each do |method|
       define_method "#{method}=" do |value|
         variable = instance_variable_get("@#{method}")
@@ -94,10 +116,10 @@ module MailPlugger
 
     private
 
-    # Check 'delivery_system' is valid or not. If it's not valid then
+    # Check 'delivery_system' is valid or not. If it's not valid, then
     # it will raise an error.
     #
-    # @param [String/Symbol] delivery_system the name of the API
+    # @param [String/Symbol] delivery_system the name of the SMTP/API
     def check_value(delivery_system)
       if delivery_system.nil?
         raise Error::WrongDeliverySystem, '"delivery_system" is nil'
@@ -110,7 +132,7 @@ module MailPlugger
       return if delivery_system.is_a?(String) || delivery_system.is_a?(Symbol)
 
       raise Error::WrongDeliverySystem, '"delivery_system" does not a ' \
-        'String or Symbol'
+                                        'String or Symbol'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mail_plugger
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Norbert Szivós
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-14 00:00:00.000000000 Z
+date: 2022-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mail
@@ -24,8 +24,22 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.5'
-description: Delivery Method to send emails via API(s). We can use this Delivery Method
-  with Ruby on Rails ActionMailer or other solutions.
+- !ruby/object:Gem::Dependency
+  name: net-smtp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+description: Delivery Method to send emails via SMTP(s) and API(s). We can use this
+  Delivery Method with Ruby on Rails ActionMailer or other solutions.
 email:
 - sysqa@yahoo.com
 executables: []
@@ -54,6 +68,7 @@ metadata:
   changelog_uri: https://github.com/MailToolbox/mail_plugger/blob/main/CHANGELOG.md
   bug_tracker_uri: https://github.com/MailToolbox/mail_plugger/issues
   documentation_uri: https://rubydoc.info/gems/mail_plugger
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -62,15 +77,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
-summary: Plug in required mailer API(s) with MailPlugger.
+summary: Plug in required mailer SMTP(s) and API(s) with MailPlugger.
 test_files: []