mail_plugger 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 403f35a6dee9fc93915f2271da9664c04e9fcce377badde7ef4a071a889f0022
-  data.tar.gz: 146f2ab69a3848eea46951e4ffb97fa1ee6bea3dd3a61e2b507ed4880e7dd3a0
+  metadata.gz: f909bb4d7136983266dbbe01519966ec0a3f5166cd7576401de5129e8fb6d255
+  data.tar.gz: 79a650bdbe95199bb28ff1dddefbf405d09e2dcf661d8bb0557b7c4594d85cc4
 SHA512:
-  metadata.gz: f236b23b4f0c0712161e3de82d33fe72186414dd09c4472470863b408d21cb236a6bf445b66f82ffc4cfc1c28b46d8e88000ed9af862cda788c9ada2845fef50
-  data.tar.gz: fc8f8254b3a46145744eebd9f1d67841e990b0d53a7364c32126d6b1b2c9a8a65ff30def68da4c223d58d43ad07aa76646ecfed8c8a13b2c04840b09e5e2139b
+  metadata.gz: 82416b31f9a56713434d37055caf55c83d361ea0bb22f1d643116106bc13cb5803974d9f89945ef938471fb63626742299353f40673df24f49f2ef098172daee
+  data.tar.gz: 2ee3ad7f530aad9e8dcf864bef0dc17c3dd23fea193fa796cffd676bf917f11d36a0af95632edb46fd2bb0267c12035f95b4783dd80fea1cff2125d5fcfc90f6

data/CHANGELOG.md

@@ -1,21 +1,35 @@
 # Change log
 
+## 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
+* Move mail_plugger repository into MailToolbox organization.
 
 ### Changes
 
-* Update gems
-* Fix some documentation issues
+* 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.
+* 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.
 
@@ -61,7 +75,7 @@
 * 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)

data/README.md

@@ -44,13 +44,14 @@ Or install it yourself as:
 
 # 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.
+**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 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

@@ -1,5 +1,7 @@
 # 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
@@ -29,13 +31,20 @@ module FakePlugger
     # @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] || settings[:fake_plugger_debug] || false
-      @raw_message = options[:raw_message] ||
-                     settings[:fake_plugger_raw_message] || false
-      @response    = options[:response] || settings[:fake_plugger_response]
+      @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
     end
 
     # Mock send message with the given client if the message parameter is a
@@ -52,6 +61,7 @@ module FakePlugger
     # 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
     #
@@ -64,6 +74,7 @@ module FakePlugger
     #     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
@@ -84,6 +95,7 @@ module FakePlugger
     #     client: DefinedApiClientClass,
     #     debug: true,
     #     raw_message: true,
+    #     use_mail_grabber: true,
     #     response: { response: 'OK' }
     #   ).deliver!(message)
     #
@@ -95,14 +107,24 @@ module FakePlugger
 
       @message = message
 
-      show_debug_info if @debug
-      show_raw_message if @raw_message
+      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
+
     # Return with a response which depends on the conditions.
     def return_with_response
       return client.new(delivery_data) if @response.nil?
@@ -123,9 +145,9 @@ module FakePlugger
 
         ==> @client: #{@client.inspect}
 
-        ==> @delivery_options: #{@delivery_options.inspect}"
+        ==> @delivery_options: #{@delivery_options.inspect}
 
-        ==> @delivery_settings: #{@delivery_settings.inspect}"
+        ==> @delivery_settings: #{@delivery_settings.inspect}
 
         ==> @default_delivery_system: #{@default_delivery_system.inspect}
 

data/lib/mail_plugger/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mail_plugger
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Norbert Szivós
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-18 00:00:00.000000000 Z
+date: 2021-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mail