mandrill_dm 1.3.10

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: da45ca0e20d724e1154679c48ee94c367841b2ba2a92e2e6439e24fabe208a0a
+  data.tar.gz: e71ae1031d63834f1251a4e1ffe39a6ffda26605499ed2a84da361172f03a63c
+SHA512:
+  metadata.gz: b167e432b9b48fb259185d9c4d3103777a06adc78c865605153cbf490ae0d2900511cfade49ad3df7b39f8382d7b067764cd08be4ef223fb7ce3b7fe7f6468e0
+  data.tar.gz: 1ed5d9020f9b1482e786f7aa0b87ce948daad8d10c9ea9e739cb58186f56e20d4b3986683c141aac8f04daef6010bab87f061b886ef88b95e993a8fb6201f2cd

data/Appraisals

@@ -0,0 +1,11 @@
+appraise 'mail-2.7-1' do
+  gem 'mail', '2.7.1'
+end
+
+appraise 'mail-2.7-0' do
+  gem 'mail', '2.7.0'
+end
+
+appraise 'mail-2.6' do
+  gem 'mail', '2.6.6'
+end

data/CHANGELOG.md

@@ -0,0 +1,51 @@
+### 1.3.10 (2022-03-16)
+
+- [MIGRATE from Mandrill IMMEDIATELY](https://github.com/kshnurov/mandrill_dm/blob/master/MIGRATE)
+
+### 1.3.7 (2020-03-23)
+
+- [#66](https://github.com/spovich/mandrill_dm/pull/66) Switch to security-patched fork of mandrill-api gem (mandrill-api-json). Patches CVE-2020-10663.
+
+### 1.3.6 (2018-10-19)
+
+- [#63](https://github.com/spovich/mandrill_dm/pull/63) Adopt Mail::Field#unparsed_value public API, thanks @tensho
+
+### 1.3.5 (2017-12-30)
+
+- [#60](https://github.com/spovich/mandrill_dm/pull/60) Add support for mail 2.7, thanks @tensho
+
+### 1.3.4 (2017-05-28)
+
+- [#55](https://github.com/spovich/mandrill_dm/pull/55) Set default ip pool and override with each message, thanks @dorongutman
+
+### 1.3.3 (2017-02-09)
+
+- [#52](https://github.com/spovich/mandrill_dm/pull/52) Mail gem should be a runtime dependency, thanks @tensho
+- [#51](https://github.com/spovich/mandrill_dm/pull/51) Send all passed headers to Mandrill, thanks @tensho
+- [#49](https://github.com/spovich/mandrill_dm/pull/49) Update readme for use of mandrill templates, thanks @januszm
+- [#48](https://github.com/spovich/mandrill_dm/pull/48) Merge settings and options (multiple api keys), thanks @tensho
+
+### 1.3.2 (2016-06-21)
+
+- [#45](https://github.com/spovich/mandrill_dm/pull/45) fix issue with html only email as plain text, thanks @sysqa
+
+### 1.3.1 (2016-04-25)
+
+- [#43](https://github.com/spovich/mandrill_dm/pull/43) add send_at support, thanks @sbauch, @kshnurov
+- [#42](https://github.com/spovich/mandrill_dm/pull/42) add metadata support, thanks @sbauch
+- [#40](https://github.com/spovich/mandrill_dm/pull/40) drop official support for 1.9.3, ymmv
+- [#39](https://github.com/spovich/mandrill_dm/pull/39) fix sending of text-only emails, thanks @piotrze
+- [#26](https://github.com/spovich/mandrill_dm/pull/26) add mandrill template support, thanks @genaromadrid
+- [#32](https://github.com/spovich/mandrill_dm/pull/32) fix compatibility with `mail` gem >= 2.5.x (rails 3.2+), thanks @sysqa
+- [#23](https://github.com/spovich/mandrill_dm/pull/23) global_merge_vars support, thanks @sysqa
+- [#7](https://github.com/spovich/mandrill_dm/pull/7) asynchronous message support, thanks @beorc
+- [#22](https://github.com/spovich/mandrill_dm/pull/22) merge_vars support, thanks @tomasc
+- [#20](https://github.com/spovich/mandrill_dm/pull/20) Inline image attachments support, thanks @ropiku
+
+### 1.2.0 (2015-03-31)
+
+ - [#2](https://github.com/spovich/mandrill_dm/pull/2) Attachment support
+ - [#3](https://github.com/spovich/mandrill_dm/pull/3) Add tags and headers to mandrill_dm
+ - [#6](https://github.com/spovich/mandrill_dm/pull/6) Update `MandrillDm::DeliveryMethod` to capture the response from the Mandrill API
+ - Add travis-ci to builds
+ - [#14](https://github.com/spovich/mandrill_dm/pull/14) Add `merge` and `merge_language` flags

data/Gemfile

@@ -0,0 +1,2 @@
+source 'http://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Jonathan Berglund
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/MIGRATE

@@ -0,0 +1,27 @@
+####################################################
+# !!! MIGRATE from Mandrill IMMEDIATELY!           #
+####################################################
+
+On 15.03.2022 Mailchimp blocked tens of thousands of accounts
+for one reason: their nationality. There's no law that required that.
+(email: https://github.com/kshnurov/mandrill_dm/mailchimp_email.png)
+
+They didn't give any prior notice, time to migrate, or an option to
+download our data and email lists. We're unable to log in despite
+using Mailchimp & Mandrill for 8 years and an excellent account score.
+
+WE'VE LOST ALL OUR DATA and our operations were disrupted.
+
+Mailchimp's actions are completely unlawful, violate business ethics and
+moral norms. This is pure racism and Nazism. It should not be tolerated.
+
+We urge you to MIGRATE to other services IMMEDIATELY until your account
+is blocked because of your race, sex, nationality, or T-shirt color.
+
+This gem will continue to work, but will log error on every sent message.
+
+You're free to fork it and keep using Mandrill if you support
+punishing innocent people for being born in a particular country,
+no matter what they think about their government and recent events.
+
+####################################################

data/README.md

@@ -0,0 +1,104 @@
+# Mandrill DM
+
+[![Build Status](https://travis-ci.org/spovich/mandrill_dm.svg?branch=master)](https://travis-ci.org/spovich/mandrill_dm)
+[![Gem Version](https://badge.fury.io/rb/mandrill_dm.svg)](http://badge.fury.io/rb/mandrill_dm)
+[![security](https://hakiri.io/github/spovich/mandrill_dm/master.svg)](https://hakiri.io/github/spovich/mandrill_dm/master)
+[![Code Climate](https://codeclimate.com/github/spovich/mandrill_dm/badges/gpa.svg)](https://codeclimate.com/github/spovich/mandrill_dm)
+
+Mandrill DM allows you to use ActionMailer with the Mandrill API. Created by [Jonathan Berglund](https://github.com/jlberglund)
+and maintained by [John Dell](https://github.com/spovich), and [Kirill Shnurov](https://github.com/kshnurov) and various [contributors](https://github.com/spovich/mandrill_dm/graphs/contributors).
+
+## !!! MIGRATE from Mandrill IMMEDIATELY!
+
+On 15.03.2022 Mailchimp blocked tens of thousands of accounts for one reason: their nationality.
+There's no law that required that. [See the email](https://github.com/kshnurov/mandrill_dm/blob/master/mailchimp_email.png)
+
+They didn't give any prior notice, time to migrate, or an option to download our data and email lists.
+We're unable to log in despite using Mailchimp & Mandrill for 8 years and an excellent account score.
+
+WE'VE LOST ALL OUR DATA and our operations were disrupted.
+
+Mailchimp's actions are completely unlawful, violate business ethics and moral norms.
+This is pure racism and Nazism. It should not be tolerated.
+
+We urge you to MIGRATE to other services IMMEDIATELY until your account is blocked because of your race, sex, nationality, or T-shirt color.
+
+This gem will continue to work, but will log error on every sent message.
+
+You're free to fork it and keep using Mandrill if you support punishing innocent people for being born in a particular country,
+no matter what they think about their government and recent events.
+
+## Rails Setup
+
+First, add the gem to your Gemfile and run the `bundle` command to install it.
+
+```ruby
+gem 'mandrill_dm'
+```
+
+Second, set the delivery method in `config/environments/production.rb`.
+
+```ruby
+config.action_mailer.delivery_method = :mandrill
+```
+
+Third, create an initializer such as `config/initializers/mandrill.rb` and paste in the following code:
+
+```ruby
+MandrillDm.configure do |config|
+  config.api_key = ENV['MANDRILL_APIKEY']
+  # config.async = false
+end
+```
+
+NOTE: If you don't already have an environment variable for your Mandrill API key, don't forget to create one.
+
+**Rails 3**: see [Rails 3 (Mail 2.5) support](https://github.com/spovich/mandrill_dm/wiki/Rails-3-(Mail-2.5)-support)
+
+### Available configuration options
+
+Option     | Default value     | Description
+-----------|-------------------|------------------------------------------------------------
+`api_key`  |                   | Mandrill API key.
+`async`    | `false`           | Enable a background sending mode that is optimized for bulk sending.
+
+### Mandrill Templates
+
+If you want to use this gem with mandrill templates you just have to add the `template` param to the `mail` function and set the `body` param to empty string `''`.
+
+> We use `template` instead of `template_name` as described in mandrill documentation since `template_name` it's used by [ActionMailer](http://api.rubyonrails.org/classes/ActionMailer/Base.html).
+
+```ruby
+class MyMailer < ActionMailer::Base
+  def notify_user(email)
+    headers['Reply-To'] = 'your.friend@email.com'
+    mail(
+      to: email,
+      from: 'your@email.com',
+      body: '',
+      template: 'your-mandrill-template-slug',
+      template_content: [ # optional
+        {
+          name: 'header', # the name of the mc:edit editable region to inject into
+          content: 'string to replace a mc:edit="header" in your template', # the content to inject
+        },
+        {
+          name: 'content',
+          content: 'string to replace a mc:edit="content" in your template'
+        }
+      ]
+    )
+  end
+end
+```
+
+## Development & Feedback
+
+Questions or problems? Please use the issue tracker. If you would like to contribute to this project, fork this repository. Pull requests appreciated! Please ensure all specs and rubocop checks pass locally (run `rake`) and
+verify the travis build matrix passes.
+
+This gem was inspired by the [letter_opener](https://github.com/ryanb/letter_opener/) and [mandrill-delivery-handler](https://github.com/earnold/mandrill-delivery-handler) gems. Special thanks to the folks at MailChimp and Mandrill for their Starter service and [Ruby API](https://bitbucket.org/mailchimp/mandrill-api-ruby).
+
+### Interactive Usage
+  $ irb -I . -r 'lib/mandrill_dm'
+  > require 'pry'

data/Rakefile

@@ -0,0 +1,35 @@
+require 'bundler'
+require 'bundler/gem_tasks'
+Bundler.require(:default, :development)
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new
+
+task default: %w[all_checks]
+
+desc 'Run all specs and rubocop checks'
+task :all_checks do
+  Rake::Task['spec'].invoke
+  Rake::Task['rubocop'].invoke
+end
+
+directory 'tmp/coverage'
+desc 'Generates spec coverage results'
+task :coverage do
+  ENV['COVERAGE'] = '1'
+  Rake::Task[:spec].invoke
+  ENV['COVERAGE'] = nil
+  `open tmp/coverage/index.html` if RUBY_PLATFORM['darwin']
+end
+
+desc 'Validate Travis CI configuration'
+task :validate do
+  print ' Travis CI Validation '.center(80, '*') + "\n"
+  result = `travis-lint #{File.expand_path('../.travis.yml', __FILE__)}`
+  puts result.empty? ? 'OK' : result
+  print '*' * 80 + "\n"
+  raise 'Travis CI validation failed' unless result.empty?
+end

data/lib/mandrill_dm/delivery_method.rb

@@ -0,0 +1,38 @@
+module MandrillDm
+  class DeliveryMethod
+    attr_accessor :settings, :response
+
+    def initialize(options = {})
+      @settings = {
+        api_key: MandrillDm.configuration.api_key
+      }.merge!(options)
+    end
+
+    # rubocop:disable Metrics/MethodLength
+    # rubocop:disable Metrics/AbcSize
+    def deliver!(mail)
+      logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
+      logger.error '!!! MIGRATE from Mandrill IMMEDIATELY: https://github.com/kshnurov/mandrill_dm/blob/master/MIGRATE'
+
+      mandrill_api = Mandrill::API.new(settings[:api_key])
+      message = Message.new(mail)
+      @response = if message.template
+                    mandrill_api.messages.send_template(
+                      message.template,
+                      message.template_content,
+                      message.to_json,
+                      MandrillDm.configuration.async,
+                      message.ip_pool || MandrillDm.configuration.ip_pool,
+                      message.send_at
+                    )
+                  else
+                    mandrill_api.messages.send(
+                      message.to_json,
+                      MandrillDm.configuration.async,
+                      message.ip_pool || MandrillDm.configuration.ip_pool,
+                      message.send_at
+                    )
+                  end
+    end
+  end
+end

data/lib/mandrill_dm/message.rb

@@ -0,0 +1,277 @@
+require 'base64'
+
+module MandrillDm
+  class Message # rubocop:disable ClassLength
+    attr_reader :mail
+
+    def initialize(mail)
+      @mail = mail
+    end
+
+    # Returns a Mandrill API compatible attachment hash
+    def attachments
+      regular_attachments = mail.attachments.reject(&:inline?)
+      regular_attachments.collect do |attachment|
+        {
+          name: attachment.filename,
+          type: attachment.mime_type,
+          content: Base64.encode64(attachment.body.decoded)
+        }
+      end
+    end
+
+    # Mandrill uses a different hash for inlined image attachments
+    def images
+      inline_attachments = mail.attachments.select(&:inline?)
+      inline_attachments.collect do |attachment|
+        {
+          name: attachment.cid,
+          type: attachment.mime_type,
+          content: Base64.encode64(attachment.body.decoded)
+        }
+      end
+    end
+
+    def auto_text
+      nil_true_false?(:auto_text)
+    end
+
+    def auto_html
+      nil_true_false?(:auto_html)
+    end
+
+    def bcc_address
+      return_string_value(:bcc_address)
+    end
+
+    def from_email
+      from.address
+    end
+
+    def from_name
+      from.display_name
+    end
+
+    def global_merge_vars
+      get_value(:global_merge_vars)
+    end
+
+    def headers
+      mail.header_fields.reduce({}) do |acc, field|
+        acc.merge(field.name => field.value)
+      end
+    end
+
+    def html
+      return mail.html_part.body.decoded if mail.html_part
+      return_decoded_body('text/html')
+    end
+
+    def template
+      return_string_value(:template)
+    end
+
+    def template_content
+      get_value(:template_content)
+    end
+
+    def important
+      mail[:important].to_s == 'true'
+    end
+
+    def inline_css
+      nil_true_false?(:inline_css)
+    end
+
+    def ip_pool
+      return_string_value(:ip_pool)
+    end
+
+    def merge
+      nil_true_false?(:merge)
+    end
+
+    def merge_language
+      return_string_value(:merge_language)
+    end
+
+    def merge_vars
+      get_value(:merge_vars)
+    end
+
+    def metadata
+      get_value(:metadata)
+    end
+
+    def preserve_recipients
+      nil_true_false?(:preserve_recipients)
+    end
+
+    def return_path_domain
+      return_string_value(:return_path_domain)
+    end
+
+    def send_at
+      value = get_value(:send_at)
+      value ? send_at_formatted_string(value) : nil
+    end
+
+    # mandrill expects `send_at` in UTC as `YYYY-MM-DD HH:MM:SS`
+    def send_at_formatted_string(obj)
+      return obj if obj.is_a?(String)
+
+      obj = obj.to_time if obj.is_a?(DateTime)
+      return obj.utc.strftime('%Y-%m-%d %H:%M:%S') if obj.is_a?(Time)
+
+      raise ArgumentError, 'send_at should be Time/DateTime or String'
+    end
+
+    def signing_domain
+      return_string_value(:signing_domain)
+    end
+
+    def subaccount
+      return_string_value(:subaccount)
+    end
+
+    def subject
+      mail.subject
+    end
+
+    def tags
+      collect_tags
+    end
+
+    def text
+      return mail.text_part.body.decoded if mail.text_part
+      return_decoded_body('text/plain')
+    end
+
+    def to
+      combine_address_fields.reject(&:nil?).flatten
+    end
+
+    def track_clicks
+      nil_true_false?(:track_clicks)
+    end
+
+    def track_opens
+      nil_true_false?(:track_opens)
+    end
+
+    def tracking_domain
+      return_string_value(:tracking_domain)
+    end
+
+    def url_strip_qs
+      nil_true_false?(:url_strip_qs)
+    end
+
+    def view_content_link
+      nil_true_false?(:view_content_link)
+    end
+
+    def to_json # rubocop:disable MethodLength, AbcSize
+      json_hash = {
+        auto_html: auto_html,
+        auto_text: auto_text,
+        bcc_address: bcc_address,
+        from_email: from_email,
+        from_name: from_name,
+        global_merge_vars: global_merge_vars,
+        headers: headers,
+        html: html,
+        important: important,
+        inline_css: inline_css,
+        merge: merge,
+        merge_language: merge_language,
+        merge_vars: merge_vars,
+        metadata: metadata,
+        preserve_recipients: preserve_recipients,
+        return_path_domain: return_path_domain,
+        signing_domain: signing_domain,
+        subaccount: subaccount,
+        subject: subject,
+        tags: tags,
+        text: text,
+        to: to,
+        track_clicks: track_clicks,
+        track_opens: track_opens,
+        tracking_domain: tracking_domain,
+        url_strip_qs: url_strip_qs,
+        view_content_link: view_content_link
+      }
+
+      json_hash[:attachments] = attachments if attachments?
+      json_hash[:images] = images if inline_attachments?
+      json_hash
+    end
+
+  private
+
+    # Returns an array of tags
+    def collect_tags
+      mail[:tags].to_s.split(', ').map { |tag| tag }
+    end
+
+    # Returns a single, flattened hash with all to, cc, and bcc addresses
+    def combine_address_fields
+      %w[to cc bcc].map do |field|
+        hash_addresses(mail[field])
+      end
+    end
+
+    # Returns a Mail::Address object using the from field
+    def from
+      address = mail[:from].formatted
+      Mail::Address.new(address.first)
+    end
+
+    # rubocop:disable Metrics/AbcSize
+    def get_value(field)
+      if mail[field].respond_to?(:unparsed_value)                     # `mail` gem > 2.7.0
+        mail[field].unparsed_value
+      elsif mail[field].instance_variable_defined?('@unparsed_value') # `mail` gem = 2.7.0
+        mail[field].instance_variable_get('@unparsed_value')
+      elsif mail[field].instance_variable_defined?('@value')          # `mail` gem < 2.7.0
+        mail[field].instance_variable_get('@value')
+      end
+    end
+    # rubocop:enable Metrics/AbcSize
+
+    # Returns a Mandrill API compatible email address hash
+    def hash_addresses(address_field)
+      return nil unless address_field
+
+      address_field.formatted.map do |address|
+        address_obj = Mail::Address.new(address)
+        {
+          email: address_obj.address,
+          name: address_obj.display_name,
+          type: address_field.name.downcase
+        }
+      end
+    end
+
+    def attachments?
+      mail.attachments.any? { |a| !a.inline? }
+    end
+
+    def inline_attachments?
+      mail.attachments.any?(&:inline?)
+    end
+
+    def return_decoded_body(mime_type)
+      mail.mime_type == mime_type ? mail.body.decoded : nil
+    end
+
+    def return_string_value(field)
+      mail[field] ? mail[field].to_s : nil
+    end
+
+    def nil_true_false?(field)
+      return nil if mail[field].nil?
+      mail[field].to_s == 'true'
+    end
+  end
+end

data/lib/mandrill_dm/railtie.rb

@@ -0,0 +1,11 @@
+require 'mandrill_dm'
+
+module MandrillDm
+  class Railtie < Rails::Railtie
+    initializer 'mandrill_dm.add_delivery_method' do
+      ActiveSupport.on_load :action_mailer do
+        ActionMailer::Base.add_delivery_method :mandrill, MandrillDm::DeliveryMethod
+      end
+    end
+  end
+end

data/lib/mandrill_dm.rb

@@ -0,0 +1,37 @@
+require 'mandrill'
+require 'date'
+require_relative 'mandrill_dm/message'
+require_relative 'mandrill_dm/delivery_method'
+require_relative 'mandrill_dm/railtie' if defined? Rails
+
+module MandrillDm
+  class << self
+    attr_accessor :configuration
+  end
+
+  # Call this method to modify defaults in your initializers.
+  #
+  # @example
+  #   MandrillDm.configure do |config|
+  #     config.api_key = '1234567890'
+  #   end
+  def self.configure
+    logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
+    logger.error '!!! MIGRATE from Mandrill IMMEDIATELY: https://github.com/kshnurov/mandrill_dm/blob/master/MIGRATE'
+    Warning.warn "!!! MIGRATE from Mandrill IMMEDIATELY: https://github.com/kshnurov/mandrill_dm/blob/master/MIGRATE\n"
+
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  # @see MandrillDm.configure
+  class Configuration
+    attr_accessor :api_key, :async, :ip_pool
+
+    def initialize
+      @api_key = ''
+      @async = false
+      @ip_pool = nil
+    end
+  end
+end

data/mandrill_dm.gemspec

@@ -0,0 +1,27 @@
+Gem::Specification.new do |s|
+  s.name = 'mandrill_dm'
+  s.version = '1.3.10'
+  s.date = '2020-03-20'
+  s.summary = 'A basic Mandrill delivery method for Rails.'
+  s.description = 'A basic Mandrill delivery method for Rails.'
+  s.authors = ['Jonathan Berglund', 'John Dell', 'Kirill Shnurov']
+  s.email = ['jonathan.berglund@gmail.com', 'spovich@gmail.com']
+  s.homepage = 'http://github.com/spovich/mandrill_dm'
+  s.license = 'MIT'
+
+  s.files = Dir['{lib,spec}/**/*', '[A-Z]*'] - ['Gemfile.lock']
+  s.require_path = 'lib'
+  s.required_ruby_version = '>= 2.0'
+
+  s.post_install_message = File.read("MIGRATE") if File.exist?("MIGRATE")
+
+  s.add_dependency 'mail', '>= 2.6'
+  s.add_dependency 'mandrill-api-json', '~> 1.0.54'
+
+  s.add_development_dependency 'pry'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec', '~> 3.7.0'
+  s.add_development_dependency 'rubocop', '0.50.0'
+  s.add_development_dependency 'simplecov', '~> 0.15.1'
+  s.add_development_dependency 'appraisal'
+end