mail_plugger 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 174f3fa6b0708e5e3635df906ef07df145dbfecade90452bae98d2bfef912f5a
-  data.tar.gz: 58c9aa8b5a2dc5d6552a02d79775d45bfbea6bb770fa4943b97986d4c58ad485
+  metadata.gz: 7ec4ac88872c10e0533aac02a9947fdb9f93a7027d004e380cd5a0f854db3840
+  data.tar.gz: 82f4adcbdcac821c94161cc61da1cb2228f3fee00fbfdd7306a17fe5e87a5347
 SHA512:
-  metadata.gz: 1de355d0eff072fcd5ac56b99d258143a7d52eb7edfd23851335c8089ffab8cde18fb86fb6c952828b8529f573778216c10118043322df703311b491605c0779
-  data.tar.gz: 46c0e544614420ade838a70b01031fbd2cf3698c98c7666869638bbfb42622dbf9ea47261a013bbb461e3ba4bffc5497ece8bc222da55bd65479bede4d127edc
+  metadata.gz: de83d9be11f14e045b70bdfcc6bac03353d3b84fee8e5858cf24558236925d750015117f0d04efb953161b735bf8c3beaa1ac474483e07856a215778633132c8
+  data.tar.gz: 03ff6162170252b04c7af6f7d1754ecd7d8a6e8c1843a59986b5c1b8a279f54542abd744e57e923e524f8526dc1866296a873ae0e1776567da2b94c1f37780e6

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # 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

data/README.md

@@ -7,7 +7,7 @@
 [![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' **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.
+**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
 
@@ -46,7 +46,7 @@ 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. 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
 

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
@@ -53,22 +53,22 @@ module FakePlugger
     #
     # 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.
+    # then it will return with the extracted delivery data.
     #
     #
-    # If the 'response' parameter is not nil then retruns with that given 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
     #
@@ -165,7 +165,7 @@ module FakePlugger
 
     private
 
-    # Call extra options like show debug informations, show raw message,
+    # Call extra options like show debug information, show raw message,
     # use mail grabber.
     def call_extra_options
       show_debug_info if @debug
@@ -176,7 +176,7 @@ module FakePlugger
       MailGrabber::DeliveryMethod.new.deliver!(@message)
     end
 
-    # Debug informations for API
+    # Debug information for API
     def debug_info_for_api
       puts <<~DEBUG_INFO
 
@@ -246,7 +246,7 @@ module FakePlugger
       end
     end
 
-    # Check that it should retrun with the delivery data.
+    # Check that it should return with the delivery data.
     def return_delivery_data?
       !send_via_smtp? &&
         @response.is_a?(Hash) &&
@@ -262,7 +262,7 @@ module FakePlugger
       @response
     end
 
-    # Show debug informations from variables and methods.
+    # Show debug information from variables and methods.
     def show_debug_info
       send_via_smtp? ? debug_info_for_smtp : debug_info_for_api
     end

data/lib/mail_plugger/delivery_method.rb

@@ -44,7 +44,7 @@ module MailPlugger
     #
     # 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.

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

@@ -27,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
@@ -73,22 +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 we're using
+    # 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',
+    # 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.
+    # Otherwise, it returns with nil.
     #
     # @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
@@ -103,7 +103,7 @@ 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
+    # 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.
     #
@@ -121,8 +121,8 @@ module MailPlugger
     # 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.
+    # 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 need_delivery_system?
 
@@ -138,7 +138,7 @@ module MailPlugger
     end
 
     # Check that 'delivery_settings' has 'delivery_system' key or not.
-    # If 'delivery_settings' contains 'DELIVERY_SETTINGS_KEYS' then it retruns
+    # If 'delivery_settings' contains 'DELIVERY_SETTINGS_KEYS' then it returns
     # false, else true.
     #
     # @return [Boolean] true/false
@@ -163,9 +163,9 @@ module MailPlugger
       end
     end
 
-    # Return 'delivery_systems' array if it's exist. If not then extract keys
+    # 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.
+    # depends on which is a hash. If none of these are hashes, then returns nil.
     #
     # @return [Array/NilClass] with the keys or nil
     def extract_keys
@@ -175,7 +175,7 @@ module MailPlugger
     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.
+    # 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
@@ -188,7 +188,7 @@ module MailPlugger
       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
@@ -247,9 +247,9 @@ module MailPlugger
       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
+    # 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 and/or FakePlugger

data/lib/mail_plugger/version.rb

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

data/lib/mail_plugger.rb

@@ -3,12 +3,12 @@
 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
@@ -104,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 STMP/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}")
@@ -116,7 +116,7 @@ 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 SMTP/API

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mail_plugger
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Norbert Szivós
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-31 00:00:00.000000000 Z
+date: 2022-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mail
@@ -77,7 +77,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="