mail_plugger 1.0.0.rc1 → 1.2.0

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,53 +0,0 @@
-require:
-  - rubocop-performance
-  - rubocop-rspec
-
-AllCops:
-  NewCops: enable
-  SuggestExtensions: false
-  Exclude:
-    - 'gemfiles/**/*'
-
-Layout/LineLength:
-  Max: 80
-
-Metrics/BlockLength:
-  Exclude:
-    - spec/**/*
-
-Metrics/CyclomaticComplexity:
-  Max: 15
-
-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.rc1)
-      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.8.0)
-      parallel (~> 1.10)
-      parser (>= 3.0.0.0)
-      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, < 3.0)
-    rubocop-ast (1.4.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.21.2)
-      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 (2.0.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.4

data/Rakefile

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-require 'rubocop/rake_task'
-
-RuboCop::RakeTask.new
-
-RSpec::Core::RakeTask.new(:spec)
-
-task default: %i[rubocop spec]

data/bin/console

@@ -1,17 +0,0 @@
-#!/usr/bin/env ruby
-
-# frozen_string_literal: true
-
-require 'bundler/setup'
-require 'mail_plugger'
-require 'mail'
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require 'irb'
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/docs/usage_in_ruby_on_rails.md

@@ -1,182 +0,0 @@
-# How to use MailPlugger in Ruby on Rails
-
-After to add `mail_plugger` gem and the gem of API of the mail provider, create `config/initializers/mail_plugger.rb` file and add something similar.
-
-```ruby
-# NOTE: This is just an example for testing...
-class TestApiClientClass
-  def initialize(options = {})
-    @settings = { api_key: '12345' }
-    @options = options
-  end
-
-  def deliver
-    # e.g. API.new(@settings).client.post(generate_mail_hash)
-    puts " >>> settings: #{@settings.inspect}"
-    puts " >>> options: #{@options.inspect}"
-    puts " >>> generate_mail_hash: #{generate_mail_hash.inspect}"
-    { response: 'OK' }
-  end
-
-  private
-
-  def generate_mail_hash
-    {
-      to: generate_recipients,
-      from: {
-        email: @options[:from].first
-      },
-      subject: @options[:subject],
-      content: [
-        {
-          type: 'text/plain',
-          value: @options[:text_part]
-        },
-        {
-          type: 'text/html; charset=UTF-8',
-          value: @options[:html_part]
-        }
-      ]
-    }
-  end
-
-  def generate_recipients
-    @options[:to].map do |to|
-      {
-        email: to
-      }
-    end
-  end
-end
-
-MailPlugger.plug_in('test_api_client') do |api|
-  api.delivery_options = %i[from to subject text_part html_part]
-  api.client = TestApiClientClass
-end
-```
-
-Then change `config/application.rb` file.
-
-```ruby
-config.action_mailer.delivery_method = :mail_plugger
-```
-
-So now we should add a mailer method. Let's create `app/mailers/test_mailer.rb` file.
-
-```ruby
-class TestMailer < ApplicationMailer
-  default from: 'from@example.com'
-
-  def send_test
-    mail subject: 'Test email', to: 'to@example.com'
-  end
-end
-```
-
-Then we should add views (the body) of this email, so create `app/views/test_mailer/send_test.html.erb`
-
-```erb
-<p>Test email body</p>
-```
-
-and `app/views/test_mailer/send_test.text.erb`.
-
-```erb
-Test email body
-```
-
-In the `rails console` we can try it out.
-
-```ruby
-TestMailer.send_test.deliver_now
-#  Rendering test_mailer/send_test.html.erb within layouts/mailer
-#  Rendered test_mailer/send_test.html.erb within layouts/mailer (1.3ms)
-#  Rendering test_mailer/send_test.text.erb within layouts/mailer
-#  Rendered test_mailer/send_test.text.erb within layouts/mailer (0.5ms)
-#TestMailer#send_test: processed outbound mail in 62.2ms
-# >>> settings: {:api_key=>"12345"}
-# >>> options: {"from"=>["from@example.com"], "to"=>["to@example.com"], "subject"=>"Test email", "text_part"=>"Test email body\n\n", "html_part"=>"<!DOCTYPE html>\n<html>\n  <head>\n    <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n    <style>\n      /* Email styles need to be inline */\n    </style>\n  </head>\n\n  <body>\n    <p>Test email body</p>\n\n  </body>\n</html>\n"}
-# >>> generate_mail_hash: {:to=>[{:email=>"to@example.com"}], :from=>{:email=>"from@example.com"}, :subject=>"Test email", :content=>[{:type=>"text/plain", :value=>"Test email body\n\n"}, {:type=>"text/html; charset=UTF-8", :value=>"<!DOCTYPE html>\n<html>\n  <head>\n    <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n    <style>\n      /* Email styles need to be inline */\n    </style>\n  </head>\n\n  <body>\n    <p>Test email body</p>\n\n  </body>\n</html>\n"}]}
-#Sent mail to to@example.com (12.2ms)
-#Date: Sat, 02 Jan 2021 15:08:53 +0100
-#From: from@example.com
-#To: to@example.com
-#Message-ID: <5ff07e7597b40_104cfebb4988d3@100S-Mac.local.mail>
-#Subject: Test email
-#Mime-Version: 1.0
-#Content-Type: multipart/alternative;
-# boundary="--==_mimepart_5ff07e75956a7_104cfebb498739";
-# charset=UTF-8
-#Content-Transfer-Encoding: 7bit
-#
-#
-#----==_mimepart_5ff07e75956a7_104cfebb498739
-#Content-Type: text/plain;
-# charset=UTF-8
-#Content-Transfer-Encoding: 7bit
-#
-#Test email body
-#
-#
-#----==_mimepart_5ff07e75956a7_104cfebb498739
-#Content-Type: text/html;
-# charset=UTF-8
-#Content-Transfer-Encoding: 7bit
-#
-#<!DOCTYPE html>
-#<html>
-#  <head>
-#    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-#    <style>
-#      /* Email styles need to be inline */
-#    </style>
-#  </head>
-#
-#  <body>
-#    <p>Test email body</p>
-#
-#  </body>
-#</html>
-#
-#----==_mimepart_5ff07e75956a7_104cfebb498739--
-
-#=> #<Mail::Message:61100, Multipart: true, Headers: <Date: Sat, 02 Jan 2021 15:08:53 +0100>, <From: from@example.com>, <To: to@example.com>, <Message-ID: <5ff07e7597b40_104cfebb4988d3@100S-Mac.local.mail>>, <Subject: Test email>, <Mime-Version: 1.0>, <Content-Type: multipart/alternative; boundary="--==_mimepart_5ff07e75956a7_104cfebb498739"; charset=UTF-8>, <Content-Transfer-Encoding: 7bit>>
-
-# or use ! to not render mail
-
-TestMailer.send_test.deliver_now!
-#  Rendering test_mailer/send_test.html.erb within layouts/mailer
-#  Rendered test_mailer/send_test.html.erb within layouts/mailer (0.1ms)
-#  Rendering test_mailer/send_test.text.erb within layouts/mailer
-#  Rendered test_mailer/send_test.text.erb within layouts/mailer (0.0ms)
-#TestMailer#send_test: processed outbound mail in 20.9ms
-# >>> settings: {:api_key=>"12345"}
-# >>> options: {"from"=>["from@example.com"], "to"=>["to@example.com"], "subject"=>"Test email", "text_part"=>"Test email body\n\n", "html_part"=>"<!DOCTYPE html>\n<html>\n  <head>\n    <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n    <style>\n      /* Email styles need to be inline */\n    </style>\n  </head>\n\n  <body>\n    <p>Test email body</p>\n\n  </body>\n</html>\n"}
-# >>> generate_mail_hash: {:to=>[{:email=>"to@example.com"}], :from=>{:email=>"from@example.com"}, :subject=>"Test email", :content=>[{:type=>"text/plain", :value=>"Test email body\n\n"}, {:type=>"text/html; charset=UTF-8", :value=>"<!DOCTYPE html>\n<html>\n  <head>\n    <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n    <style>\n      /* Email styles need to be inline */\n    </style>\n  </head>\n\n  <body>\n    <p>Test email body</p>\n\n  </body>\n</html>\n"}]}
-#=> #<Mail::Message:61140, Multipart: true, Headers: <From: from@example.com>, <To: to@example.com>, <Subject: Test email>, <Mime-Version: 1.0>, <Content-Type: multipart/alternative; boundary="--==_mimepart_5ff082bd7aab5_10afcebb4503a4"; charset=UTF-8>>
-```
-
-Let's add delivery settings as well in `config/initializers/mail_plugger.rb`.
-
-```ruby
-MailPlugger.plug_in('test_api_client') do |api|
-  api.delivery_options = %i[from to subject text_part html_part]
-  api.delivery_settings = { return_response: true }
-  api.client = TestApiClientClass
-end
-```
-
-Then in the `rails console`.
-
-```ruby
-TestMailer.send_test.deliver_now!
-#  Rendering test_mailer/send_test.html.erb within layouts/mailer
-#  Rendered test_mailer/send_test.html.erb within layouts/mailer (0.8ms)
-#  Rendering test_mailer/send_test.text.erb within layouts/mailer
-#  Rendered test_mailer/send_test.text.erb within layouts/mailer (0.4ms)
-#TestMailer#send_test: processed outbound mail in 37.0ms
-# >>> settings: {:api_key=>"12345"}
-# >>> options: {"from"=>["from@example.com"], "to"=>["to@example.com"], "subject"=>"Test email", "text_part"=>"Test email body\n\n", "html_part"=>"<!DOCTYPE html>\n<html>\n  <head>\n    <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n    <style>\n      /* Email styles need to be inline */\n    </style>\n  </head>\n\n  <body>\n    <p>Test email body</p>\n\n  </body>\n</html>\n"}
-# >>> generate_mail_hash: {:to=>[{:email=>"to@example.com"}], :from=>{:email=>"from@example.com"}, :subject=>"Test email", :content=>[{:type=>"text/plain", :value=>"Test email body\n\n"}, {:type=>"text/html; charset=UTF-8", :value=>"<!DOCTYPE html>\n<html>\n  <head>\n    <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n    <style>\n      /* Email styles need to be inline */\n    </style>\n  </head>\n\n  <body>\n    <p>Test email body</p>\n\n  </body>\n</html>\n"}]}
-#=> {:response=>"OK"}
-```