RubyGems - mail_plugger - Versions diffs - 1.0.0 → 1.3.0 - Mend

mail_plugger 1.0.0 → 1.3.0

Files changed (45) hide show

checksums.yaml +4 -4
data/CHANGELOG.md +63 -3
data/README.md +33 -22
data/lib/fake_plugger/delivery_method.rb +186 -0
data/lib/fake_plugger/railtie.rb +14 -0
data/lib/mail_plugger.rb +9 -1
data/lib/mail_plugger/version.rb +1 -1
metadata +15 -46
data/.github/ISSUE_TEMPLATE/bug_report.md +0 -22
data/.github/ISSUE_TEMPLATE/feature_request.md +0 -16
data/.gitignore +0 -11
data/.rspec +0 -3
data/.rubocop.yml +0 -53
data/.travis.yml +0 -22
data/Appraisals +0 -13
data/CODE_OF_CONDUCT.md +0 -14
data/CONTRIBUTING.md +0 -26
data/Gemfile +0 -18
data/Gemfile.lock +0 -81
data/Rakefile +0 -11
data/bin/console +0 -17
data/bin/setup +0 -8
data/docs/usage_in_ruby_on_rails.md +0 -182
data/docs/usage_in_script_or_console.md +0 -158
data/docs/usage_of_attachments_in_ruby_on_rails.md +0 -110
data/docs/usage_of_aws_ses_in_ruby_on_rails.md +0 -136
data/docs/usage_of_delivery_method.md +0 -104
data/docs/usage_of_mailgun_in_ruby_on_rails.md +0 -58
data/docs/usage_of_mandrill_in_ruby_on_rails.md +0 -104
data/docs/usage_of_more_delivery_system_in_ruby_on_rails.md +0 -332
data/docs/usage_of_one_delivery_system_with_more_send_methods_in_ruby_on_rails.md +0 -119
data/docs/usage_of_plug_in_method.md +0 -62
data/docs/usage_of_postmark_in_ruby_on_rails.md +0 -59
data/docs/usage_of_secial_options_in_ruby_on_rails.md +0 -90
data/docs/usage_of_sendgrid_in_ruby_on_rails.md +0 -82
data/docs/usage_of_sparkpost_in_ruby_on_rails.md +0 -142
data/gemfiles/.bundle/config +0 -2
data/gemfiles/mail_2.6.gemfile +0 -14
data/gemfiles/mail_2.6.gemfile.lock +0 -84
data/gemfiles/mail_2.7.0.gemfile +0 -14
data/gemfiles/mail_2.7.0.gemfile.lock +0 -82
data/gemfiles/mail_2.7.gemfile +0 -14
data/gemfiles/mail_2.7.gemfile.lock +0 -82
data/images/mail_plugger.png +0 -0
data/mail_plugger.gemspec +0 -40

data/docs/usage_of_one_delivery_system_with_more_send_methods_in_ruby_on_rails.md DELETED Viewed

@@ -1,119 +0,0 @@
-# How to use one delivey system with more send methods in Ruby on Rails
-Let's modify the configuration which was defined [here](https://github.com/norbertszivos/mail_plugger/blob/main/docs/usage_of_more_delivery_system_in_ruby_on_rails.md).
-Change the API and `MailPlugger.plug_in` method in `config/initializers/mail_plugger.rb`.
-```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}"
-    case @options[:send_method]
-    when 'send_email1'
-      client.send_email1(generate_mail_hash)
-    when 'send_email2'
-      client.send_email2(generate_mail_hash)
-    end
-  end
-  private
-  def client
-    Class.new do
-      def self.send_email1(params)
-        puts " >>>>> send_email1 params: #{params.inspect}"
-        { response: 'Send email version 1' }
-      end
-      def self.send_email2(params)
-        puts " >>>>> send_email2 params: #{params.inspect}"
-        { response: 'Send email version 2' }
-      end
-    end
-  end
-  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 send_method]
-  api.delivery_settings = { return_response: true }
-  api.client = TestApiClientClass
-end
-```
-Then change `app/mailers/test_mailer.rb` file.
-```ruby
-class TestMailer < ApplicationMailer
-  default from: 'from@example.com', delivery_system: 'test_api_client'
-  def send_test
-    mail subject: 'Test email', to: 'to@example.com', send_method: 'send_email1'
-  end
-  def send_test2
-    mail subject: 'Test email', to: 'to@example.com', send_method: 'send_email2'
-  end
-end
-```
-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 (0.7ms)
-#  Rendering test_mailer/send_test.text.erb within layouts/mailer
-#  Rendered test_mailer/send_test.text.erb within layouts/mailer (0.2ms)
-#TestMailer#send_test: processed outbound mail in 31.6ms
-# >>> 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", "send_method"=>"send_email1"}
-# >>>>> send_email1 params: {: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=>"Send email version 1"}
-TestMailer.send_test2.deliver_now!
-#  Rendering test_mailer/send_test2.html.erb within layouts/mailer
-#  Rendered test_mailer/send_test2.html.erb within layouts/mailer (0.4ms)
-#  Rendering test_mailer/send_test2.text.erb within layouts/mailer
-#  Rendered test_mailer/send_test2.text.erb within layouts/mailer (0.3ms)
-#TestMailer#send_test2: processed outbound mail in 17.5ms
-# >>> 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", "send_method"=>"send_email2"}
-# >>>>> send_email2 params: {: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=>"Send email version 2"}
-```

data/docs/usage_of_plug_in_method.md DELETED Viewed

@@ -1,62 +0,0 @@
-# How to use MailPlugger.plug_in method
-With `plug_in` method we can add configurations for the delivery method.
-It has a parameter which calls to `delivery_system`. This parameter is a name of the delivery system like `aws_ses`, `sparkpost`, `sendgrid`, etc. Basically it can be anything which helps to identify this delivery system. The `delivery_system` can be either String or Symbol, but the `delivery_system` type should match with the type of the `Mail::Message` object `delivery_system` parameter (if `delivery_system` is String then in the `Mail::Message` object `delivery_system` parameter should be String as well).
-It can accept 3 configurations:
-- `client` which should be a Class. This Class is a special class which generates the data and calls the API to send the message.
-- `delivery_options` which should be an Array with Symbols or Strings. It will search these options in the `Mail::Message` object like `from`, `to`, `cc`, `bcc`, `subject`, `body`, `text_part`, `html_part`, `attachments` or anything what we will add to this object. Also we can retrieve the `Mail::Message` object with `message_obj`.
-- `delivery_settings` which should be a Hash. The Mail gem can use these settings like `{ return_response: true }` (The keys are should be Symbols).
-Example:
-```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[:body]
-        }
-      ]
-    }
-  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 body]
-  api.delivery_settings = { return_response: true }
-  api.client = TestApiClientClass
-end
-```

data/docs/usage_of_postmark_in_ruby_on_rails.md DELETED Viewed

@@ -1,59 +0,0 @@
-# How to use Postmark with MailPlugger in Ruby on Rails
-**Please note that these examples were not tested, but I believe it should work.**
-Let's use mailer method which was defined [here](https://github.com/norbertszivos/mail_plugger/blob/main/docs/usage_in_ruby_on_rails.md).
-Add `postmark` to the `Gemfile`.
-```ruby
-gem 'postmark'
-```
-Then run `bundle install` command to deploy the gem.
-Change the API and `MailPlugger.plug_in` method in `config/initializers/mail_plugger.rb`.
-```ruby
-class PostmarkApiClient
-  def initialize(options = {})
-    @settings = { token: ENV['POSTMARK_TOKEN'] }
-    @options = options
-  end
-  def deliver
-    Postmark::ApiClient.new(@settings[:token]).deliver(generate_mail_hash)
-  end
-  private
-  def generate_mail_hash
-    {
-      from: @options[:from].first,
-      to: @options[:to],
-      subject: @options[:subject],
-      text_body: @options[:text_part],
-      html_body: @options[:html_part],
-      tag: @options[:tag]
-    }
-  end
-end
-MailPlugger.plug_in('postmark') do |api|
-  api.delivery_options = %i[from to subject text_part html_part tag]
-  api.delivery_settings = { return_response: true }
-  api.client = PostmarkApiClient
-end
-```
-Then modify the mailer method a little bit.
-```ruby
-class TestMailer < ApplicationMailer
-  default from: 'from@example.com'
-  def send_test
-    mail subject: 'Test email', to: 'to@example.com', delivery_system: 'postmark', tag: 'send_test'
-  end
-end
-```

data/docs/usage_of_secial_options_in_ruby_on_rails.md DELETED Viewed

@@ -1,90 +0,0 @@
-# How to add API specific options to the mailer method in Ruby on Rails
-Let's use mailer method which was defined [here](https://github.com/norbertszivos/mail_plugger/blob/main/docs/usage_in_ruby_on_rails.md).
-Change the API and `MailPlugger.plug_in` method in `config/initializers/mail_plugger.rb`.
-```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]
-        }
-      ],
-      string: @options[:string],
-      boolean: @options[:boolean],
-      array: @options[:array],
-      hash: @options[:hash]
-    }
-  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 string boolean array hash]
-  api.delivery_settings = { return_response: true }
-  api.client = TestApiClientClass
-end
-```
-So add special API options to the mailer method. Let's change `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', string: 'This is the string', boolean: true, array: ['This', 'is', 'the array'], hash: { this: 'is the hash' }
-  end
-end
-```
-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 (0.9ms)
-#  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 35.3ms
-# >>> 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", "string"=>"This is the string", "boolean"=>true, "array"=>["This", "is", "the array"], "hash"=>{"this"=>"is the hash"}}
-# >>> 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"}], :string=>"This is the string", :boolean=>true, :array=>["This", "is", "the array"], :hash=>{:this=>"is the hash"}}
-#=> {:response=>"OK"}
-```

data/docs/usage_of_sendgrid_in_ruby_on_rails.md DELETED Viewed

@@ -1,82 +0,0 @@
-# How to use SendGrid with MailPlugger in Ruby on Rails
-**Please note that these examples were not tested, but I believe it should work.**
-Let's use mailer method which was defined [here](https://github.com/norbertszivos/mail_plugger/blob/main/docs/usage_in_ruby_on_rails.md).
-Add `sendgrid-ruby` to the `Gemfile`.
-```ruby
-gem 'sendgrid-ruby'
-```
-Then run `bundle install` command to deploy the gem.
-Change the API and `MailPlugger.plug_in` method in `config/initializers/mail_plugger.rb`.
-```ruby
-class SendGridApiClient
-  def initialize(options = {})
-    @settings = { api_key: ENV['SENDGRID_API_KEY'] }
-    @options = options
-  end
-  def deliver
-    SendGrid::API.new(@settings).client.mail._("send").post(generate_mail_hash)
-  end
-  private
-  def generate_mail_hash
-    {
-      request_body: {
-        personalizations: [
-          {
-            to: generate_recipients,
-            subject: @options[:subject]
-          }
-        ],
-        from: {
-          email: @options[:from].first
-        },
-        content: [
-          {
-            type: 'text/plain',
-            value: @options[:text_part]
-          },
-          {
-            type: 'text/html',
-            value: @options[:html_part]
-          }
-        ]
-      }
-    }
-  end
-  def generate_recipients
-    @options[:to].map do |to|
-      {
-        email: to
-      }
-    end
-  end
-end
-MailPlugger.plug_in('sendgrid') do |api|
-  api.delivery_options = %i[from to subject text_part html_part]
-  api.delivery_settings = { return_response: true }
-  api.client = SendGridApiClient
-end
-```
-Then modify the mailer method a little bit.
-```ruby
-class TestMailer < ApplicationMailer
-  default from: 'from@example.com'
-  def send_test
-    mail subject: 'Test email', to: 'to@example.com', delivery_system: 'sendgrid'
-  end
-end
-```

data/docs/usage_of_sparkpost_in_ruby_on_rails.md DELETED Viewed

@@ -1,142 +0,0 @@
-# How to use SparkPost with MailPlugger in Ruby on Rails
-**Please note that these examples were not tested, but I believe it should work.**
-Let's use mailer method which was defined [here](https://github.com/norbertszivos/mail_plugger/blob/main/docs/usage_in_ruby_on_rails.md).
-Add `simple_spark` to the `Gemfile`.
-```ruby
-gem 'simple_spark'
-```
-Then run `bundle install` command to deploy the gem.
-## Send Inline Content
-Change the API and `MailPlugger.plug_in` method in `config/initializers/mail_plugger.rb`.
-```ruby
-class SparkPostApiClient
-  def initialize(options = {})
-    @settings = { api_key: ENV['SPARKPOST_API_KEY'] }
-    @options = options
-  end
-  def deliver
-    SimpleSpark::Client.new(@settings).transmissions.create(generate_mail_hash)
-  end
-  private
-  def generate_mail_hash
-    {
-      options: @options[:options],
-      campaign_id: @options[:tag],
-      content: {
-        from: {
-          email: @options[:from].first
-        },
-        subject: @options[:subject],
-        text: @options[:text_part],
-        html: @options[:html_part]
-      },
-      metadata: @options[:metadata],
-      recipients: generate_recipients
-    }
-  end
-  def generate_recipients
-    @options[:to].map do |to|
-      {
-        address: {
-          email: to
-        },
-        tags: [
-          @options[:tag]
-        ],
-      }
-    end
-  end
-end
-MailPlugger.plug_in('sparkpost') do |api|
-  api.delivery_options = %i[from to subject text_part html_part options tag metadata]
-  api.delivery_settings = { return_response: true }
-  api.client = SparkPostApiClient
-end
-```
-Then modify the mailer method a little bit.
-```ruby
-class TestMailer < ApplicationMailer
-  default from: 'from@example.com'
-  def send_test
-    mail subject: 'Test email', to: 'to@example.com', delivery_system: 'sparkpost', tag: 'send_test', options: { open_tracking: true, click_tracking: false, transactional: true }, metadata: { website: 'testwebsite' }
-  end
-end
-```
-## Send RFC822 Content
-Change the API and `MailPlugger.plug_in` method in `config/initializers/mail_plugger.rb`.
-```ruby
-class SparkPostApiClient
-  def initialize(options = {})
-    @settings = { api_key: ENV['SPARKPOST_API_KEY'] }
-    @options = options
-  end
-  def deliver
-    SimpleSpark::Client.new(@settings).transmissions.create(generate_mail_hash)
-  end
-  private
-  def generate_mail_hash
-    {
-      options: @options[:options],
-      campaign_id: @options[:tag],
-      content: {
-        email_rfc822: @options[:message_obj].to_s
-      },
-      metadata: @options[:metadata],
-      recipients: generate_recipients
-    }
-  end
-  def generate_recipients
-    @options[:to].map do |to|
-      {
-        address: {
-          email: to
-        },
-        tags: [
-          @options[:tag]
-        ],
-      }
-    end
-  end
-end
-MailPlugger.plug_in('sparkpost') do |api|
-  api.delivery_options = %i[to options message_obj tag metadata]
-  api.delivery_settings = { return_response: true }
-  api.client = SparkPostApiClient
-end
-```
-Then modify the mailer method a little bit.
-```ruby
-class TestMailer < ApplicationMailer
-  default from: 'from@example.com'
-  def send_test
-    mail subject: 'Test email', to: 'to@example.com', delivery_system: 'sparkpost', tag: 'send_test', options: { open_tracking: true, click_tracking: false, transactional: true }, metadata: { website: 'testwebsite' }
-  end
-end
-```