mail_plugger 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b4dd3655061ce3563a5a47717b4450a24a85d402e9e1b87fc035584be6caf9fc
-  data.tar.gz: 9dace2ebc237cef9590074e5b25b7a8878cbf3c7ba14af9bf612567fa370cb94
+  metadata.gz: 3ae30c8103f7eecb765d0e08984c79c39b116781adebbbc31bb1c56e0aac2273
+  data.tar.gz: 3cd75d6aabb8a301f0def36fdfd77f1d624a8c15d7ad60bcc5c60174392e2185
 SHA512:
-  metadata.gz: 21092888241af389665f0d5f03341cfed7d13bea5f3f753fedac3c3316e01ac6908bbebc262822f19b70fd14afd2bf485b3b45209ed8505ff1aa794f1473a526
-  data.tar.gz: 713f8ba5dd65c40f965887dedb2e39618745aec161f69d1ca3a14f710a870d1f7517e617e75c700dcde7dca79ff71ac405ef6d26df328fef1432f0dac1de4485
+  metadata.gz: ed702bc39827fbe0afdaa6db1737367fb8bf329aa096dcd1092109673eea45f6fdb1b84a8eb0da0fd8283724ac57f9eae2ae44607a156a6025c6de661aeb0fbf
+  data.tar.gz: df3d125a0342d83a0e19802dcfcb3a0ac7f2c682b9de733d2c53cb81da11d6a0f04df828113912eee1f991d8b45cf720e4503f57f494ffcfcf0283895ea86257

data/CHANGELOG.md

@@ -1,28 +1,50 @@
 # Change log
 
+
+## 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
 
+
 ## 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)

data/README.md

@@ -1,4 +1,4 @@
-# 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/norbertszivos/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)
@@ -31,7 +31,7 @@ Or install it yourself as:
 - [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 API specific options to the mailer method in Ruby on Rails](https://github.com/norbertszivos/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/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)
@@ -42,6 +42,14 @@ Or install it yourself as:
   - [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)
 
+# F<img src="https://raw.githubusercontent.com/norbertszivos/mail_plugger/main/images/fake_plugger800x500.png" height="22" />kePlugger
+
+## Usage
+
+- [How to use FakePlugger::DeliveryMethod class](https://github.com/norbertszivos/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/norbertszivos/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/norbertszivos/mail_plugger/blob/main/docs/usage_of_fake_plugger_in_ruby_on_rails.md)
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/fake_plugger/delivery_method.rb

@@ -0,0 +1,162 @@
+# frozen_string_literal: true
+
+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
+    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]
+    end
+
+    # 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_message_obj: true' then
+    # it will retrun with the Mail::Message object.
+    # 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.
+    #
+    # @param [Mail::Message] message what we would like to send
+    #
+    # @return [Mail::Message/Hash] depend on give value
+    #
+    # @example
+    #
+    #   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_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,
+    #     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
+
+      show_debug_info if @debug
+      show_raw_message if @raw_message
+
+      return_with_response
+    end
+
+    private
+
+    # Return with a response which depends on the conditions.
+    def return_with_response
+      return client.new(delivery_data) if @response.nil?
+      return @message if @response.is_a?(Hash) && @response[:return_message_obj]
+
+      @response
+    end
+
+    # Show debug informations from variables and methods.
+    def show_debug_info
+      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
+
+    # Show raw message for debug purpose.
+    def show_raw_message
+      puts <<~RAW_MESSAGE
+
+        ============================ Mail::Message ============================
+
+        #{@message}
+
+        =======================================================================
+
+      RAW_MESSAGE
+    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,6 +7,10 @@ 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
@@ -17,7 +21,7 @@ module MailPlugger
     #
     # @example using Rails `config/initializers/mail_plugger.rb`
     #
-    #   # The defined API class should have an 'initializer' and a 'deliver'
+    #   # The defined API class should have an 'initialize' and a 'deliver'
     #   # method.
     #   class DefinedApiClientClass
     #     def initialize(options = {})
@@ -90,6 +94,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 API
     def check_value(delivery_system)
       if delivery_system.nil?
         raise Error::WrongDeliverySystem, '"delivery_system" is nil'

data/lib/mail_plugger/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MailPlugger
-  VERSION = '1.0.1'
+  VERSION = '1.1.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.1.0
 platform: ruby
 authors:
 - Norbert Szivós
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-15 00:00:00.000000000 Z
+date: 2021-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mail
@@ -37,6 +37,8 @@ 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
@@ -50,6 +52,8 @@ 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
+  bug_tracker_uri: https://github.com/norbertszivos/mail_plugger/issues
+  documentation_uri: https://rubydoc.info/gems/mail_plugger
 post_install_message:
 rdoc_options: []
 require_paths: