mail_plugger 1.0.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b4dd3655061ce3563a5a47717b4450a24a85d402e9e1b87fc035584be6caf9fc
-  data.tar.gz: 9dace2ebc237cef9590074e5b25b7a8878cbf3c7ba14af9bf612567fa370cb94
+  metadata.gz: a4e017acfdc5bd84be87de9bb9b213dbeaf5356436b896be22c2fdd8cf0f484e
+  data.tar.gz: 75dfedda8f0d97436469c5cbdb29b8316cb1e00a9a479168950b342870c4cf2b
 SHA512:
-  metadata.gz: 21092888241af389665f0d5f03341cfed7d13bea5f3f753fedac3c3316e01ac6908bbebc262822f19b70fd14afd2bf485b3b45209ed8505ff1aa794f1473a526
-  data.tar.gz: 713f8ba5dd65c40f965887dedb2e39618745aec161f69d1ca3a14f710a870d1f7517e617e75c700dcde7dca79ff71ac405ef6d26df328fef1432f0dac1de4485
+  metadata.gz: a7229b6a397f883683331bb341be7356061367362bfd8d8d2f3c82b46c9a774355c60ba85d643b19cf25284e6335c46f6bdcd06aa821613662bec7ff04fde833
+  data.tar.gz: dbe3dcd8e421074b5df9d1144672b1cebe852e3a06f46d6273505ca0833fe31f650bfe8e5d40ccc57cff17e698a75ac84af3821b2f5b07572bd559e70241eebb

data/CHANGELOG.md

@@ -1,28 +1,94 @@
 # Change log
 
+## 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
+
+* Add MailGrabber to FakePlugger. Now we can use FakePlugger and MailGrabber in same time.
+
+### Changes
+
+* Remove unnecessary double quotes from `show_debug_info` method in `FakePlugger::DeliveryMethod` and fix documentations.
+* Update bundler and gems.
+* Update bug_report.md.
+
+
+## 1.2.0 (2021-03-18)
+
+### New organization
+
+* Move mail_plugger repository into MailToolbox organization.
+
+### Changes
+
+* Update gems.
+* Fix some documentation issues.
+
+
+## 1.1.1 (2021-01-21)
+
+### Changes
+
+* Change `FakePlugger::DeliveryMethod` to returns with the extracted delivery data instead of the message object.
+* Update code documentations.
+* Add missing FakePlugger description in the README.md.
+
+
+## 1.1.0 (2021-01-18)
+
+### New features
+
+* Add FakePlugger to mock MailPlugger.
+
+### Changes
+
+* Fix typos in the documentations.
+* Add more metadata to gempspec file.
+
+
 ## 1.0.1 (2021-01-15)
 
+### Changes
+
 * Tidy up the gemspec file and change which files contains in the gem. Now the gem is much smaller.
 * Add a new mail plugger image which has a different canvas and use it in the README.md.
 
+
 ## 1.0.0 (2021-01-14)
 
+### Changes
+
 * Update gems.
 * Remove `webmock` gem to clean up unused things.
 * Update documentations.
 
+
 ## 1.0.0.rc1 (2021-01-13)
 
+### Changes
+
 * Change description and fix changelog_uri in gemspec file.
 * Add/Change documentations.
 * Update gems.
 * Change `MailPlugger.plug_in` and `MailPlugger::MailHelper.delivery_options` methods to accept strings and symbols.
-* Change `MailPlugger::MailHelper.delivery_data` method that we can retrieve massage object as well.
+* Change `MailPlugger::MailHelper.delivery_data` method that we can retrieve message object as well.
 * Check hash keys in `MailPlugger::MailHelper.delivery_system` method, so now if we are add wrong `delivey_system` then we are getting a meaningful error message.
 * Change `MailPlugger::MailHelper.extract_attachments` method. If an attachment is inline then the hash contains the `filename` and `cid` as well.
 * Add/Change tests.
-* Change `MailPlugger::MailHelper.delivery_option` that returns with indifferent hash
+* Change `MailPlugger::MailHelper.delivery_option` that returns with indifferent hash.
+
 
 ## 1.0.0.beta1 (2021-01-02)
 
-* Implement MailPlugger methods and functionality. See [README.md](https://github.com/norbertszivos/mail_plugger/blob/main/README.md)
+* Implement MailPlugger methods and functionality. See [README.md](https://github.com/MailToolbox/mail_plugger/blob/main/README.md)

data/README.md

@@ -1,13 +1,13 @@
-# M<img src="https://raw.githubusercontent.com/norbertszivos/mail_plugger/master/images/mail_plugger800x500.png" height="22" />ilPlugger
+# M<img src="https://raw.githubusercontent.com/MailToolbox/mail_plugger/main/images/mail_plugger800x500.png" height="22" />ilPlugger
 
 [![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)](LICENSE.txt)
+[![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/norbertszivos/mail_plugger.svg?branch=main)](https://travis-ci.com/norbertszivos/mail_plugger)
-[![Maintainability](https://api.codeclimate.com/v1/badges/bd2cda43214c111d8d16/maintainability)](https://codeclimate.com/github/norbertszivos/mail_plugger/maintainability)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/bd2cda43214c111d8d16/test_coverage)](https://codeclimate.com/github/norbertszivos/mail_plugger/test_coverage)
+[![Build Status](https://travis-ci.com/MailToolbox/mail_plugger.svg?branch=main)](https://travis-ci.com/MailToolbox/mail_plugger)
+[![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 balacing or cost management.
 
 ## Installation
 
@@ -27,20 +27,34 @@ Or install it yourself as:
 
 ## Usage
 
-- [How to use MailPlugger.plug_in method](https://github.com/norbertszivos/mail_plugger/blob/main/docs/usage_of_plug_in_method.md)
-- [How to use MailPlugger::DeliveryMethod class](https://github.com/norbertszivos/mail_plugger/blob/main/docs/usage_of_delivery_method.md)
-- [How to use MailPlugger in a Ruby script or IRB console](https://github.com/norbertszivos/mail_plugger/blob/main/docs/usage_in_script_or_console.md)
-- [How to use MailPlugger in Ruby on Rails](https://github.com/norbertszivos/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/norbertszivos/mail_plugger/blob/main/docs/usage_of_secial_options_in_ruby_on_rails.md)
-  - [How to add attachments to the mailer method in Ruby on Rails](https://github.com/norbertszivos/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/norbertszivos/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/norbertszivos/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/norbertszivos/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/norbertszivos/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/norbertszivos/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/norbertszivos/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/norbertszivos/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/norbertszivos/mail_plugger/blob/main/docs/usage_of_mailgun_in_ruby_on_rails.md)
+- [How to use MailPlugger.plug_in method](https://github.com/MailToolbox/mail_plugger/blob/main/docs/usage_of_plug_in_method.md)
+- [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 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`.
+
+## 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
 
@@ -50,7 +64,7 @@ To install this gem onto your local machine, run `bundle exec rake install`.
 
 To release a new version:
 
-- Update CHANGELOG.md
+- Update [CHANGELOG.md](https://github.com/MailToolbox/mail_plugger/blob/main/CHANGELOG.md)
 - Update the version number in `version.rb` manually or use `gem-release` gem and run `gem bump -v major|minor|patch|rc|beta`.
 - Build gem with `bundle exec rake build`.
 - Run `bundle install` and `bundle exec appraisal install` to update gemfiles and commit the changes.
@@ -58,7 +72,7 @@ To release a new version:
 
 ## Contributing
 
-Bug reports and pull requests are welcome. Please read [CONTRIBUTING.md](https://github.com/norbertszivos/mail_plugger/blob/main/CONTRIBUTING.md) if you would like to contribute to this project.
+Bug reports and pull requests are welcome. Please read [CONTRIBUTING.md](https://github.com/MailToolbox/mail_plugger/blob/main/CONTRIBUTING.md) if you would like to contribute to this project.
 
 ## Inspiration
 
@@ -69,4 +83,4 @@ Bug reports and pull requests are welcome. Please read [CONTRIBUTING.md](https:/
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://github.com/norbertszivos/mail_plugger/blob/main/LICENSE.txt).
+The gem is available as open source under the terms of the [MIT License](https://github.com/MailToolbox/mail_plugger/blob/main/LICENSE.txt).

data/lib/fake_plugger/delivery_method.rb

@@ -0,0 +1,296 @@
+# frozen_string_literal: true
+
+require 'mail_grabber' if Gem.loaded_specs.key?('mail_grabber')
+
+module FakePlugger
+  class DeliveryMethod < MailPlugger::DeliveryMethod
+    # Initialize FakePlugger delivery method attributes. If we are using
+    # MailPlugger.plug_in method, then these attributes can be nil, if not then
+    # we should set these attributes.
+    #
+    # @param [Hash] options check 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'
+    #
+    # @option options [Boolean] debug
+    #   if true it will show debug informations
+    #
+    # @option options [Boolean] 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
+    #   then it will return with the client object
+    #
+    # @option options [Boolean] use_mail_grabber
+    #   if true it will store the message in a database which MailGrabber can
+    #   read
+    def initialize(options = {})
+      super
+
+      @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
+    # '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
+    # 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.
+    #
+    # @param [Mail::Message] message what we would like to send
+    #
+    # @return [Mail::Message/Hash] depends on the given value
+    #
+    # @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 = {
+    #       fake_plugger_debug: true,
+    #       fake_plugger_raw_message: true,
+    #       fake_plugger_use_mail_grabber: true,
+    #       fake_plugger_response: { response: 'OK' }
+    #     }
+    #     api.client = DefinedApiClientClass
+    #   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_options: %i[from to subject body],
+    #     client: DefinedApiClientClass,
+    #     debug: true,
+    #     raw_message: true,
+    #     use_mail_grabber: true,
+    #     response: { response: 'OK' }
+    #   ).deliver!(message)
+    #
+    def deliver!(message)
+      unless message.is_a?(Mail::Message)
+        raise MailPlugger::Error::WrongParameter,
+              'The given parameter is not a Mail::Message'
+      end
+
+      @message = message
+
+      update_settings
+
+      call_extra_options
+
+      return_with_response
+    end
+
+    private
+
+    # Call extra options like show debug informations, show raw message,
+    # use mail grabber.
+    def call_extra_options
+      show_debug_info if @debug
+      show_raw_message if @raw_message
+
+      return unless Gem.loaded_specs.key?('mail_grabber') && @use_mail_grabber
+
+      MailGrabber::DeliveryMethod.new.deliver!(@message)
+    end
+
+    # Debug informations for API
+    def debug_info_for_api
+      puts <<~DEBUG_INFO
+
+        ===================== FakePlugger::DeliveryMethod =====================
+
+        ------------------------------ Variables ------------------------------
+
+        ==> @client: #{@client.inspect}
+
+        ==> @delivery_options: #{@delivery_options.inspect}
+
+        ==> @delivery_settings: #{@delivery_settings.inspect}
+
+        ==> @default_delivery_system: #{@default_delivery_system.inspect}
+
+        ==> @message: #{@message.inspect}
+
+        ------------------------------- Methods -------------------------------
+
+        ==> client: #{client.inspect}
+
+        ==> delivery_system: #{delivery_system.inspect}
+
+        ==> delivery_options: #{delivery_options.inspect}
+
+        ==> delivery_data: #{delivery_data.inspect}
+
+        ==> settings: #{settings.inspect}
+
+        =======================================================================
+
+      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 retrun 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 informations 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
+
+        ============================ Mail::Message ============================
+
+        #{@message}
+
+        =======================================================================
+
+      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/fake_plugger/railtie.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module FakePlugger
+  class Railtie < Rails::Railtie
+    initializer 'fake_plugger.add_delivery_method' do
+      ActiveSupport.on_load :action_mailer do
+        ActionMailer::Base.add_delivery_method(
+          :fake_plugger,
+          FakePlugger::DeliveryMethod
+        )
+      end
+    end
+  end
+end

data/lib/mail_plugger.rb

@@ -7,17 +7,42 @@ require 'mail_plugger/delivery_method'
 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.
+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`
     #
-    #   # The defined API class should have an 'initializer' and a 'deliver'
+    #   # 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
     #     def initialize(options = {})
@@ -71,6 +96,7 @@ module MailPlugger
       check_value(delivery_system)
 
       @delivery_system = delivery_system
+      (@delivery_systems ||= []) << delivery_system
 
       yield self
     rescue NoMethodError => e
@@ -79,7 +105,7 @@ module MailPlugger
 
     # 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.
+    # 'delivery_system'. This let us to 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}")
@@ -90,6 +116,10 @@ module MailPlugger
 
     private
 
+    # 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 SMTP/API
     def check_value(delivery_system)
       if delivery_system.nil?
         raise Error::WrongDeliverySystem, '"delivery_system" is nil'

data/lib/mail_plugger/delivery_method.rb

@@ -30,12 +30,19 @@ 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 which was provided in the 'delivery_options'. After
@@ -44,10 +51,52 @@ module MailPlugger
     #
     # @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/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
@@ -64,11 +73,15 @@ 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 are'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
@@ -91,7 +104,8 @@ module MailPlugger
 
     # 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.
+    # '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.
+    # 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 retruns
+    # 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,15 +163,28 @@ 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
 
@@ -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
 
+    # 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 it's not a hash it'll return
-    # the given value. But if the value doesn't a hash it'll raise an error.
+    # 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.0.1'
+  VERSION = '1.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mail_plugger
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.4.0
 platform: ruby
 authors:
 - Norbert Szivós
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-15 00:00:00.000000000 Z
+date: 2021-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mail
@@ -24,8 +24,8 @@ 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.
+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: []
@@ -37,19 +37,23 @@ files:
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
+- lib/fake_plugger/delivery_method.rb
+- lib/fake_plugger/railtie.rb
 - lib/mail_plugger.rb
 - lib/mail_plugger/delivery_method.rb
 - lib/mail_plugger/error.rb
 - lib/mail_plugger/mail_helper.rb
 - lib/mail_plugger/railtie.rb
 - lib/mail_plugger/version.rb
-homepage: https://github.com/norbertszivos/mail_plugger
+homepage: https://github.com/MailToolbox/mail_plugger
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/norbertszivos/mail_plugger
-  source_code_uri: https://github.com/norbertszivos/mail_plugger
-  changelog_uri: https://github.com/norbertszivos/mail_plugger/blob/main/CHANGELOG.md
+  homepage_uri: https://github.com/MailToolbox/mail_plugger
+  source_code_uri: https://github.com/MailToolbox/mail_plugger
+  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
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -68,5 +72,5 @@ requirements: []
 rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
-summary: Plug in the required mailer API(s) with MailPlugger.
+summary: Plug in required mailer SMTP(s) and API(s) with MailPlugger.
 test_files: []