mail_plugger 1.0.0.beta1 → 1.1.1

data/lib/mail_plugger/mail_helper.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'base64'
+require 'mail/indifferent_hash'
 
 module MailPlugger
   module MailHelper
@@ -42,6 +43,8 @@ module MailPlugger
       data = {}
 
       delivery_options.each do |option|
+        option = option.to_sym unless option.is_a?(Symbol)
+
         data[option] =
           case option
           when :from, :to, :cc, :bcc, :subject
@@ -50,12 +53,14 @@ module MailPlugger
             extract_attachments
           when :body, :html_part, :text_part
             @message.public_send(option)&.decoded
+          when :message_obj
+            @message
           else
-            message_field_value_from(@message[option.to_s])
+            message_field_value_from(@message[option])
           end
       end
 
-      data
+      Mail::IndifferentHash.new(data)
     end
 
     # Tries to set up a default delivery system, if the 'delivery_system'
@@ -65,11 +70,7 @@ module MailPlugger
     #
     # @return [Stirng] the first key of the 'delivery_options' or 'client'
     def default_delivery_system_get
-      if @delivery_options.is_a?(Hash)
-        @delivery_options
-      elsif @client.is_a?(Hash)
-        @client
-      end&.keys&.first
+      extract_keys&.first
     end
 
     # Extract 'delivery_options'. If it's a hash then it'll return the right
@@ -95,16 +96,30 @@ module MailPlugger
     # @return [String] with the name of the delivery system
     def delivery_system
       @delivery_system ||=
-        (@message && message_field_value_from(@message['delivery_system'])) ||
+        (@message && message_field_value_from(@message[:delivery_system])) ||
         @default_delivery_system
 
-      if @delivery_system.nil? &&
-         (@delivery_options.is_a?(Hash) || @client.is_a?(Hash))
+      delivery_system_value_check
+
+      @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.
+    def delivery_system_value_check
+      return unless @delivery_options.is_a?(Hash) || @client.is_a?(Hash)
+
+      if @delivery_system.nil?
         raise Error::WrongDeliverySystem,
               '"delivery_system" was not defined as a Mail::Message parameter'
       end
 
-      @delivery_system
+      return if extract_keys&.include?(@delivery_system)
+
+      raise Error::WrongDeliverySystem,
+            "\"delivery_system\" '#{@delivery_system}' does not exist"
     end
 
     # Extract attachments.
@@ -112,21 +127,29 @@ module MailPlugger
     # @return [Array] with extracted attachment hashes
     def extract_attachments
       @message.attachments&.map do |attachment|
-        hash =
-          if attachment.inline?
-            { cid: attachment.cid }
-          else
-            { filename: attachment.filename }
-          end
+        hash = attachment.inline? ? { cid: attachment.cid } : {}
 
         hash.merge(
+          filename: attachment.filename,
           type: attachment.mime_type,
           content: Base64.encode64(attachment.decoded)
         )
       end
     end
 
-    # How to Extract the (uparsed) value of the mail message fields.
+    # Extract keys from 'delivery_options' or 'client', 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'
+    def extract_keys
+      if @delivery_options.is_a?(Hash)
+        @delivery_options
+      elsif @client.is_a?(Hash)
+        @client
+      end&.keys
+    end
+
+    # How to Extract the (unparsed) value of the mail message fields.
     #
     # @return [String] version dependent method call
     def mail_field_value

data/lib/mail_plugger/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MailPlugger
-  VERSION = '1.0.0.beta1'
+  VERSION = '1.1.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mail_plugger
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta1
+  version: 1.1.1
 platform: ruby
 authors:
 - Norbert Szivós
 autorequire:
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2021-01-02 00:00:00.000000000 Z
+date: 2021-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mail
@@ -24,55 +24,36 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.5'
-description: Delivery Method to send emails via the defined API(s), e.g. for Rails
-  ActionMailer.
+description: Delivery Method to send emails via API(s). We can use this Delivery Method
+  with Ruby on Rails ActionMailer or other solutions.
 email:
 - sysqa@yahoo.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
 files:
-- ".github/ISSUE_TEMPLATE/bug_report.md"
-- ".github/ISSUE_TEMPLATE/feature_request.md"
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- ".travis.yml"
-- Appraisals
 - CHANGELOG.md
-- CODE_OF_CONDUCT.md
-- CONTRIBUTING.md
-- Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
-- Rakefile
-- bin/console
-- bin/setup
-- docs/usage_in_ruby_on_rails.md
-- docs/usage_in_script_or_console.md
-- gemfiles/.bundle/config
-- gemfiles/mail_2.6.gemfile
-- gemfiles/mail_2.6.gemfile.lock
-- gemfiles/mail_2.7.0.gemfile
-- gemfiles/mail_2.7.0.gemfile.lock
-- gemfiles/mail_2.7.gemfile
-- gemfiles/mail_2.7.gemfile.lock
-- images/mail_plugger.png
+- 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
-- mail_plugger.gemspec
 homepage: https://github.com/norbertszivos/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/CHANGELOG.md
+  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:
@@ -84,11 +65,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: Plug in the required mailer API(s) with MailPlugger.

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,22 +0,0 @@
----
-name: Bug report
-about: Create a report to help us improve
----
-
-**Describe the bug**
-A clear and concise description of what the bug is.
-
-**To Reproduce**
-This is important! Providing us with a reliable way to reproduce a problem will expedite its solution.
-
-**Expected behavior**
-A clear and concise description of what you expected to happen.
-
-**Actual behavior
-Describe here what actually happened.
-
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
-
-**Additional context**
-Add any other context about the problem here.

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,16 +0,0 @@
----
-name: Feature request
-about: Suggest an idea for this project
----
-
-**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
-
-**Describe the solution you'd like**
-A clear and concise description of what you want to happen.
-
-**Describe alternatives you've considered**
-A clear and concise description of any alternative solutions or features you've considered.
-
-**Additional context**
-Add any other context or screenshots about the feature request here.

data/.gitignore

@@ -1,11 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-
-# rspec failure tracking
-.rspec_status

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper

data/.rubocop.yml

@@ -1,50 +0,0 @@
-require:
-  - rubocop-performance
-  - rubocop-rspec
-
-AllCops:
-  NewCops: enable
-  SuggestExtensions: false
-  Exclude:
-    - 'gemfiles/**/*'
-
-Layout/LineLength:
-  Max: 80
-
-Metrics/BlockLength:
-  Exclude:
-    - spec/**/*
-
-Metrics/MethodLength:
-  Max: 20
-
-Metrics/ModuleLength:
-  Max: 150
-
-Lint/AmbiguousBlockAssociation:
-  Exclude:
-    - spec/**/*
-
-Style/Documentation:
-  Enabled: false
-
-Style/DocumentationMethod:
-  Enabled: true
-
-RSpec/ContextWording:
-  Enabled: false
-
-RSpec/MessageChain:
-  Enabled: false
-
-RSpec/MessageSpies:
-  EnforcedStyle: receive
-
-RSpec/MultipleExpectations:
-  Enabled: false
-
-RSpec/MultipleMemoizedHelpers:
-  Max: 10
-
-RSpec/NestedGroups:
-  Enabled: false

data/.travis.yml

@@ -1,22 +0,0 @@
----
-env:
-  global:
-    - CC_TEST_REPORTER_ID=b510dcaf1de6f05f2fcdd623d5870628f3ab45124249a0819a63bea1257e8e79
-language: ruby
-cache: bundler
-rvm:
-  - 2.5
-  - 2.6
-  - 2.7
-  - 3.0
-before_install: gem install bundler -v 2.2.3
-before_script:
-  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
-  - chmod +x ./cc-test-reporter
-  - ./cc-test-reporter before-build
-gemfile:
-  - gemfiles/mail_2.7.gemfile
-  - gemfiles/mail_2.7.0.gemfile
-  - gemfiles/mail_2.6.gemfile
-after_script:
-  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/Appraisals

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-appraise 'mail-2.7' do
-  gem 'mail', '~> 2.7.0'
-end
-
-appraise 'mail-2.7.0' do
-  gem 'mail', '2.7.0'
-end
-
-appraise 'mail-2.6' do
-  gem 'mail', '~> 2.6.0'
-end

data/CODE_OF_CONDUCT.md

@@ -1,14 +0,0 @@
-# The MailPlugger Community Code of Conduct
-
-**Note:** We have picked the following code of conduct based on [Ruby's own code of conduct](https://www.ruby-lang.org/en/conduct/).
-
-This document provides a few simple community guidelines for a safe, respectful,
-productive, and collaborative place for any person who is willing to contribute
-to the MailPlugger community. It applies to all "collaborative spaces", which are
-defined as community communications channels (such as mailing lists, submitted
-patches, commit comments, etc.).
-
-* Participants will be tolerant of opposing views.
-* Participants must ensure that their language and actions are free of personal attacks and disparaging personal remarks.
-* When interpreting the words and actions of others, participants should always assume good intentions.
-* Behaviour which can be reasonably considered harassment will not be tolerated.

data/CONTRIBUTING.md

@@ -1,26 +0,0 @@
-# Contributing
-
-If you discover issues, have ideas for improvements or new features,
-please report them to the [issue tracker](https://github.com/norbertszivos/mail_plugger/issues) of the repository or
-submit a pull request. Please, try to follow these guidelines when you
-do so.
-
-## Issue reporting
-
-* Check that the issue has not already been reported.
-* Check that the issue has not already been fixed in the latest code.
-* Be clear, concise and precise in your description of the problem.
-* Open an issue with a descriptive title and summary.
-* Include any relevant code to the issue summary.
-
-## Pull requests
-
-* Fork the project.
-* Use a feature branch to easily amend a pull request later, if necessary.
-* Write good commit messages.
-* Use the same coding conventions as the rest of the project.
-* If your change has a corresponding open GitHub issue, prefix the commit message with `[#github-issue-number]`.
-* Make sure to add tests for it.
-* Make sure the test suite is passing (usually this is as simple as running `bundle exec rake`).
-* Squash related commits together.
-* Open a pull request that relates to *only* one subject with a clear title and description.

data/Gemfile

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in mail_plugger.gemspec
-gemspec
-
-gem 'appraisal'
-
-gem 'rake', '~> 13.0'
-
-# Ruby static code analyzer and code formatter, code linter in short
-gem 'rubocop', '~> 1.7', require: false
-gem 'rubocop-performance', require: false
-gem 'rubocop-rspec', require: false
-
-gem 'rspec', '~> 3.0'
-gem 'simplecov', require: false
-gem 'webmock', '~> 3.0'

data/Gemfile.lock

@@ -1,92 +0,0 @@
-PATH
-  remote: .
-  specs:
-    mail_plugger (1.0.0.beta1)
-      mail (~> 2.5)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    addressable (2.7.0)
-      public_suffix (>= 2.0.2, < 5.0)
-    appraisal (2.3.0)
-      bundler
-      rake
-      thor (>= 0.14.0)
-    ast (2.4.1)
-    crack (0.4.5)
-      rexml
-    diff-lcs (1.4.4)
-    docile (1.3.4)
-    hashdiff (1.0.1)
-    mail (2.7.1)
-      mini_mime (>= 0.1.1)
-    mini_mime (1.0.2)
-    parallel (1.20.1)
-    parser (3.0.0.0)
-      ast (~> 2.4.1)
-    public_suffix (4.0.6)
-    rainbow (3.0.0)
-    rake (13.0.3)
-    regexp_parser (2.0.3)
-    rexml (3.2.4)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.1)
-    rubocop (1.7.0)
-      parallel (~> 1.10)
-      parser (>= 2.7.1.5)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.2.0, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (1.3.0)
-      parser (>= 2.7.1.5)
-    rubocop-performance (1.9.2)
-      rubocop (>= 0.90.0, < 2.0)
-      rubocop-ast (>= 0.4.0)
-    rubocop-rspec (2.1.0)
-      rubocop (~> 1.0)
-      rubocop-ast (>= 1.1.0)
-    ruby-progressbar (1.11.0)
-    simplecov (0.20.0)
-      docile (~> 1.1)
-      simplecov-html (~> 0.11)
-      simplecov_json_formatter (~> 0.1)
-    simplecov-html (0.12.3)
-    simplecov_json_formatter (0.1.2)
-    thor (1.0.1)
-    unicode-display_width (1.7.0)
-    webmock (3.11.0)
-      addressable (>= 2.3.6)
-      crack (>= 0.3.2)
-      hashdiff (>= 0.4.0, < 2.0.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  appraisal
-  mail_plugger!
-  rake (~> 13.0)
-  rspec (~> 3.0)
-  rubocop (~> 1.7)
-  rubocop-performance
-  rubocop-rspec
-  simplecov
-  webmock (~> 3.0)
-
-BUNDLED WITH
-   2.2.3