dm_courier 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2b8943c2c5c0940d2bd7682f47f6c0a28e990a95
+  data.tar.gz: 770b51e01c169f6d68d7144d53dff1e5f6eac861
+SHA512:
+  metadata.gz: 5cae0696f9e1d6a629eb7723bd4f8dd992b0b3edf0ff803065fcd8f032aa5de9f56d7b7eacde1b180ebc8b3c7e169ace7ddf9faadeb2e54fa5c27ab53f8494df
+  data.tar.gz: 78365d346b2c0d932d3df221edc56bde790f848afe0606e32e0dd3234628ce22c74c488009a7e682bbe6b6d08a1fe283d9c77829ddea859fc0d9e1a421d91a94

data/.codeclimate.yml

@@ -0,0 +1,25 @@
+---
+engines:
+  duplication:
+    enabled: true
+    config:
+      languages:
+      - ruby
+      - javascript
+      - python
+      - php
+  fixme:
+    enabled: true
+  rubocop:
+    enabled: true
+ratings:
+  paths:
+  - "**.inc"
+  - "**.js"
+  - "**.jsx"
+  - "**.module"
+  - "**.php"
+  - "**.py"
+  - "**.rb"
+exclude_paths:
+- spec/

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+tmp/*

data/.hound.yml

@@ -0,0 +1,4 @@
+fail_on_violations: true
+ruby:
+  enabled: true
+  config_file: .rubocop.yml

data/.rubocop.yml

@@ -0,0 +1,292 @@
+AllCops:
+  TargetRubyVersion: 2.2
+  Exclude:
+    - "Gemfile"
+  UseCache: false
+
+LineLength:
+  Max: 120
+
+Style/CollectionMethods:
+  Description: Preferred collection methods.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#map-find-select-reduce-size
+  Enabled: true
+  PreferredMethods:
+    collect: map
+    collect!: map!
+
+Style/DotPosition:
+  Description: Checks the position of the dot in multi-line method calls.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#consistent-multi-line-chains
+  Enabled: true
+  EnforcedStyle: leading
+  SupportedStyles:
+  - leading
+  - trailing
+
+Style/FileName:
+  Description: Use snake_case for source file names.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#snake-case-files
+  Enabled: true
+
+Style/GuardClause:
+  Description: Check for conditionals that can be replaced with guard clauses
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-nested-conditionals
+  Enabled: false
+  MinBodyLength: 1
+
+Style/IfUnlessModifier:
+  Description: Favor modifier if/unless usage when you have a single-line body.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#if-as-a-modifier
+  Enabled: false
+  MaxLineLength: 120
+
+Style/OptionHash:
+  Description: Don't use option hashes when you can use keyword arguments.
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  Description: Use `%`-literal delimiters consistently
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#percent-literal-braces
+  Enabled: false
+  PreferredDelimiters:
+    "%": "()"
+    "%i": "()"
+    "%q": "()"
+    "%Q": "()"
+    "%r": "{}"
+    "%s": "()"
+    "%w": "()"
+    "%W": "()"
+    "%x": "()"
+
+Style/PredicateName:
+  Description: Check the names of predicate methods.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#bool-methods-qmark
+  Enabled: true
+  NamePrefix:
+  - is_
+  - has_
+  - have_
+  NamePrefixBlacklist:
+  - is_
+  Exclude:
+  - spec/**/*
+
+Style/RaiseArgs:
+  Description: Checks the arguments passed to raise/fail.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#exception-class-messages
+  Enabled: false
+  EnforcedStyle: exploded
+  SupportedStyles:
+  - compact
+  - exploded
+
+Style/SignalException:
+  Description: Checks for proper usage of fail and raise.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#fail-method
+  Enabled: false
+  EnforcedStyle: semantic
+  SupportedStyles:
+  - only_raise
+  - only_fail
+  - semantic
+
+Style/SingleLineBlockParams:
+  Description: Enforces the names of some block params.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#reduce-blocks
+  Enabled: false
+  Methods:
+  - reduce:
+    - a
+    - e
+  - inject:
+    - a
+    - e
+Style/CollectionMethods:
+  Description: Preferred collection methods.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#map-find-select-reduce-size
+  Enabled: true
+  PreferredMethods:
+    collect: map
+    collect!: map!
+    reduce: inject
+
+Style/SingleLineMethods:
+  Description: Avoid single-line methods.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-single-line-methods
+  Enabled: false
+  AllowIfMethodIsEmpty: true
+
+Style/StringLiterals:
+  Description: Checks if uses of quotes match the configured preference.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#consistent-string-literals
+  Enabled: true
+  EnforcedStyle: double_quotes
+  SupportedStyles:
+  - single_quotes
+  - double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Description: Checks if uses of quotes inside expressions in interpolated strings
+    match the configured preference.
+  Enabled: true
+  EnforcedStyle: single_quotes
+  SupportedStyles:
+  - single_quotes
+  - double_quotes
+
+Style/TrailingCommaInArguments:
+  Description: 'Checks for trailing comma in argument lists.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas'
+  Enabled: false
+  EnforcedStyleForMultiline: no_comma
+  SupportedStyles:
+  - comma
+  - consistent_comma
+  - no_comma
+
+Style/TrailingCommaInLiteral:
+  Description: 'Checks for trailing comma in array and hash literals.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas'
+  Enabled: false
+  EnforcedStyleForMultiline: no_comma
+  SupportedStyles:
+  - comma
+  - consistent_comma
+  - no_comma
+
+Metrics/AbcSize:
+  Description: A calculated magnitude based on number of assignments, branches, and
+    conditions.
+  Enabled: false
+  Max: 15
+
+Metrics/ClassLength:
+  Description: Avoid classes longer than 100 lines of code.
+  Enabled: false
+  CountComments: false
+  Max: 100
+
+Metrics/ModuleLength:
+  CountComments: false
+  Max: 100
+  Description: Avoid modules longer than 100 lines of code.
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Description: A complexity metric that is strongly correlated to the number of test
+    cases needed to validate a method.
+  Enabled: false
+  Max: 6
+
+Metrics/MethodLength:
+  Description: Avoid methods longer than 10 lines of code.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#short-methods
+  Enabled: false
+  CountComments: false
+  Max: 10
+
+Metrics/ParameterLists:
+  Description: Avoid parameter lists longer than three or four parameters.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#too-many-params
+  Enabled: false
+  Max: 5
+  CountKeywordArgs: true
+
+Metrics/PerceivedComplexity:
+  Description: A complexity metric geared towards measuring complexity for a human
+    reader.
+  Enabled: false
+  Max: 7
+
+Lint/AssignmentInCondition:
+  Description: Don't use assignment in conditions.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#safe-assignment-in-condition
+  Enabled: false
+  AllowSafeAssignment: true
+
+Style/InlineComment:
+  Description: Avoid inline comments.
+  Enabled: true
+
+Style/AccessorMethodName:
+  Description: Check the naming of accessor methods for get_/set_.
+  Enabled: true
+
+Style/Alias:
+  Description: Use alias_method instead of alias.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#alias-method
+  Enabled: true
+
+Style/Documentation:
+  Description: Document classes and non-namespace modules.
+  Enabled: false
+
+Style/DoubleNegation:
+  Description: Checks for uses of double negation (!!).
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-bang-bang
+  Enabled: false
+
+Style/EachWithObject:
+  Description: Prefer `each_with_object` over `inject` or `reduce`.
+  Enabled: false
+
+Style/EmptyLiteral:
+  Description: Prefer literals to Array.new/Hash.new/String.new.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#literal-array-hash
+  Enabled: true
+
+Style/ModuleFunction:
+  Description: Checks for usage of `extend self` in modules.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#module-function
+  Enabled: true
+
+Style/OneLineConditional:
+  Description: Favor the ternary operator(?:) over if/then/else/end constructs.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#ternary-operator
+  Enabled: true
+
+Style/PerlBackrefs:
+  Description: Avoid Perl-style regex back references.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-perl-regexp-last-matchers
+  Enabled: true
+
+Style/Send:
+  Description: Prefer `Object#__send__` or `Object#public_send` to `send`, as `send`
+    may overlap with existing methods.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#prefer-public-send
+  Enabled: false
+
+Style/SpecialGlobalVars:
+  Description: Avoid Perl-style global variables.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-cryptic-perlisms
+  Enabled: true
+
+Style/VariableInterpolation:
+  Description: Don't interpolate global, instance and class variables directly in
+    strings.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#curlies-interpolate
+  Enabled: false
+
+Style/WhenThen:
+  Description: Use when x then ... for one-line cases.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#one-line-cases
+  Enabled: false
+
+Lint/EachWithObjectArgument:
+  Description: Check for immutable argument given to each_with_object.
+  Enabled: true
+
+Lint/HandleExceptions:
+  Description: Don't suppress exception.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#dont-hide-exceptions
+  Enabled: false
+
+Lint/LiteralInCondition:
+  Description: Checks of literals used in conditions.
+  Enabled: false
+
+Lint/LiteralInInterpolation:
+  Description: Checks for literals used in interpolation.
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.2.0

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+sudo: false
+rvm:
+- 2.2
+- 2.3.0
+notifications:
+  email:
+    on_success: change
+    on_failure: always
+addons:
+  code_climate:
+    repo_token: e3eac13dabf5af3f7cd993b869ae5bce1cee735332537815badda3fd4ee2fc28
+script:
+- bundle exec rubocop
+- bundle exec rake spec

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Jaison Erick
+
+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/README.md

@@ -0,0 +1,95 @@
+
+# DM Courier
+
+[![Build Status](https://travis-ci.org/sumoners/dm_courier.svg?branch=master)](https://travis-ci.org/sumoners/dm_courier)
+[![Gem Version](https://badge.fury.io/rb/dm_courier.svg)](http://badge.fury.io/rb/dm_courier)
+[![security](https://hakiri.io/github/sumoners/dm_courier/master.svg)](https://hakiri.io/github/sumoners/dm_courier/master)
+[![Test Coverage](https://codeclimate.com/github/sumoners/dm_courier/badges/coverage.svg)](https://codeclimate.com/github/sumoners/dm_courier/coverage)
+[![Code Climate](https://codeclimate.com/github/sumoners/dm_courier/badges/gpa.svg)](https://codeclimate.com/github/sumoners/dm_courier)
+
+Stick with just one Gem and be free to choose your email delivery service. Rails
+Courier allows you to change easily the deliery method anytime you want.
+
+## Rails Setup
+
+First, add the gem to your Gemfile and run the `bundle` command to install it.
+
+```ruby
+gem 'dm_courier'
+```
+
+Second, set the delivery method in `config/environments/production.rb`.
+
+```ruby
+ config.action_mailer.delivery_method = :dm_courier
+```
+
+Third, create an initializer such as `config/initializers/dm_courier.rb` and
+paste in the following code:
+
+```ruby
+DMCourier.configure do |config|
+  config.api_key = ENV['DM_COURIER_APIKEY']
+  config.service_name = :mandrill # Choose here the service you want to use
+end
+ ```
+
+NOTE: If you don't already have an environment variable for delivery service API
+key, don't forget to create one.
+
+### Available configuration options
+
+Any option with Mailer Support can be used inside the mailer like:
+
+```ruby
+class MyMailer < ActionMailer::Base
+  default track_opens: false
+
+  def notify_user(email)
+    mail(auto_html: false, inline_css: true)
+  end
+end
+```
+
+Option     | Mailer Support | Description
+-----------|----------------|-------------
+`api_key`  | false | Your service API key<br />**Default:** `ENV['DM_COURIER_API_KEY']`
+`service_name`  | false | Your service API name.<br />**Default:** `ENV['DM_COURIER_SERVICE']`
+`async` | false | If the message with be sent asynchronous (depends on the service support)<br />**Default:** false<br />**Services:** mandrill
+`from` | true | A default from address for all emails<br />**Services:** all
+`auto_html` | true |  whether or not to automatically generate an HTML part for messages that are not given HTML<br />**Services:** mandrill
+`auto_text` | true | whether or not to automatically generate a text part for messages that are not given text<br />**Services:** mandrill
+`important` | true | whether or not this message is important, and should be delivered ahead of non-important messages<br />**Default**: false<br />**Services:** mandrill
+`inline_css`  | true | whether or not to automatically inline all CSS styles provided in the message HTML - only for HTML documents less than 256KB in size<br />**Services:** mandrill, sparkpost
+`track_clicks` | true | whether or not to turn on click tracking for the message<br />**Services:** mandrill, sparkpost
+`track_opens` | true | whether or not to turn on open tracking for the message<br />**Services:** mandrill, sparkpost
+`track_url_without_query_string` | true | whether or not to strip the query string from URLs when aggregating tracked URL data<br />**Services:** mandrill
+`log_content` | true  |  set to false to remove content logging for sensitive emails<br />**Services:** mandrill
+`bcc_address` | true  | an optional address to receive an exact copy of each recipient's email<br />**Services:** mandrill
+`return_path_domain` | true | a custom domain to use for the messages's return-path<br />**Services:** mandrill, sparkpost
+`signing_domain` | true | a custom domain to use for SPF/DKIM signing (for "via" or "on behalf of" in email clients)<br />**Services:** mandrill
+`subaccount` | true  | the unique id of a subaccount - must already exist or will fail with an error<br />**Services:** mandrill
+`tracking_domain` | true | a custom domain to use for tracking opens and clicks<br />**Services:** mandrill
+`tags` | true | an array of string to tag the message with. Stats are accumulated using tags, though we only store the first 100 we see, so this should not be unique or change frequently. Tags should be 50 characters or less. Any tags starting with an underscore are reserved for internal use and will cause errors.<br />**Services:** mandrill
+
+## Services
+
+### Mandrill
+
+### SparkPost
+
+The options were choosen to create an abstraction layer above the original
+service API. Because of that some options have different names:
+
+- **return_path_domain**: Is called **return_path** on SparkPost
+- **track_opens**: Is called **open_tracking** on SparkPost
+- **track_clicks**: Is called **click_tracking** on SparkPost
+
+> TODO: Sparkpost service implementation does not support BCC emails yet.
+
+## 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.
+
+This gem is based on the [mandrill_dm](https://github.com/mandrill_dm) gem.

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler"
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+Bundler.require(:default, :development)
+
+task default: :spec
+RSpec::Core::RakeTask.new

data/lib/dm_courier/configurable.rb

@@ -0,0 +1,41 @@
+require "dm_courier/default"
+
+module DMCourier
+  module Configurable
+    attr_accessor :api_key, :service_name, :async, :auto_html, :auto_text, :important,
+                  :inline_css, :track_clicks, :track_opens, :track_url_without_query_string,
+                  :log_content, :bcc_address, :return_path_domain, :signing_domain,
+                  :subaccount, :tracking_domain, :tags, :from
+
+    class << self
+      def keys
+        @keys ||= [:api_key, :service_name, :async, :auto_html, :auto_text, :important,
+                   :inline_css, :track_clicks, :track_opens, :track_url_without_query_string,
+                   :log_content, :bcc_address, :return_path_domain, :signing_domain,
+                   :subaccount, :tracking_domain, :tags, :from]
+      end
+    end
+
+    def configure
+      yield self
+    end
+
+    def reset!
+      DMCourier::Configurable.keys.each do |key|
+        instance_variable_set(:"@#{key}", DMCourier::Default.options[key])
+      end
+
+      self
+    end
+    alias setup reset!
+
+    def same_options?(opts)
+      opts.hash == options.hash
+    end
+
+    def options
+      Hash[DMCourier::Configurable
+           .keys.map { |key| [key, instance_variable_get(:"@#{key}")] }]
+    end
+  end
+end

data/lib/dm_courier/default.rb

@@ -0,0 +1,81 @@
+module DMCourier
+  module Default
+    class << self
+      def options
+        Hash[DMCourier::Configurable.keys.map { |key| [key, send(key)] }]
+      end
+
+      def api_key
+        ENV["DM_COURIER_API_KEY"]
+      end
+
+      def service_name
+        ENV["DM_COURIER_SERVICE"]
+      end
+
+      def async
+        false
+      end
+
+      def auto_html
+        nil
+      end
+
+      def auto_text
+        nil
+      end
+
+      def important
+        nil
+      end
+
+      def inline_css
+        nil
+      end
+
+      def track_clicks
+        nil
+      end
+
+      def track_opens
+        nil
+      end
+
+      def track_url_without_query_string
+        nil
+      end
+
+      def log_content
+        nil
+      end
+
+      def bcc_address
+        nil
+      end
+
+      def return_path_domain
+        nil
+      end
+
+      def signing_domain
+        nil
+      end
+
+      def subaccount
+        nil
+      end
+
+      def tracking_domain
+        nil
+      end
+
+      def tags
+        nil
+      end
+
+      def from
+        nil
+      end
+    end
+  end
+end

data/lib/dm_courier/delivery_method.rb

@@ -0,0 +1,22 @@
+require "dm_courier/service_locator"
+
+module DMCourier
+  class DeliveryMethod
+    include DMCourier::ServiceLocator
+    include DMCourier::Configurable
+
+    attr_reader :response
+
+    def initialize(options = {})
+      DMCourier::Configurable.keys.each do |key|
+        instance_variable_set(:"@#{key}", options[key] ||
+                              DMCourier.instance_variable_get(:"@#{key}"))
+      end
+    end
+    alias settings options
+
+    def deliver!(mail)
+      @response = service.new(mail, options).deliver!
+    end
+  end
+end

data/lib/dm_courier/errors.rb

@@ -0,0 +1,4 @@
+module DMCourier
+  class Error < StandardError; end
+  class InvalidService < Error; end
+end

data/lib/dm_courier/message_helper.rb

@@ -0,0 +1,95 @@
+require "base64"
+
+module DMCourier
+  module Services
+    module MessageHelper
+      def extract_params(params)
+        json = {}
+
+        json
+          .merge!(Hash[
+            params[:nil_true_false].map { |name, key| [name.to_sym, nil_true_false?(key.to_sym)] }
+          ]) if params.key?(:nil_true_false)
+
+        json
+          .merge!(Hash[
+            params[:string].map { |name, key| [name.to_sym, return_string_value(key.to_sym)] }
+          ]) if params.key?(:string)
+
+        json
+      end
+
+      def from_email
+        from.address if from_address
+      end
+
+      def from_name
+        from.display_name if from_address
+      end
+
+      def from
+        Mail::Address.new(from_address)
+      end
+
+      def from_address
+        mail[:from] ? mail[:from].formatted.first : options[:from]
+      end
+
+      def text_part
+        return mail.text_part.body.decoded if mail.multipart? && mail.text_part
+        nil
+      end
+
+      def html_part
+        mail.html_part ? mail.html_part.body.decoded : mail.body.decoded
+      end
+
+      def subject
+        mail.subject
+      end
+
+      def return_string_value(field)
+        value = fallback_options(field)
+        value ? value.to_s : nil
+      end
+
+      def nil_true_false?(field)
+        value = fallback_options(field)
+        return nil if value.nil?
+        value.to_s == "true" ? true : false
+      end
+
+      def fallback_options(field)
+        mail[field] || options[field]
+      end
+
+      def attachments(filter = {})
+        Enumerator.new do |y|
+          attachments = mail.attachments
+          attachments = if filter[:inline]
+                          attachments.select(&:inline?)
+                        else
+                          attachments.reject(&:inline?)
+                        end if filter.key?(:inline)
+
+          attachments.map do |attachment|
+            y.yield(name: attachment.inline? ? attachment.cid : attachment.filename,
+                    type: attachment.mime_type,
+                    content: Base64.encode64(attachment.body.decoded),
+                    inline: attachment.inline?)
+          end
+        end
+      end
+
+      def attachments?(filter = {})
+        found = mail.attachments && !mail.attachments.empty?
+
+        if found && filter.key?(:inline)
+          found &&= mail.attachments.any? { |a| a.inline? == filter[:inline] }
+        end
+
+        found
+      end
+    end
+  end
+end

data/lib/dm_courier/railtie.rb

@@ -0,0 +1,11 @@
+require "dm_courier"
+
+module DMCourier
+  class Railtie < Rails::Railtie
+    initializer "dm_courier.add_delivery_method" do
+      ActiveSupport.on_load :action_mailer do
+        ActionMailer::Base.add_delivery_method :dm_courier, DMCourier::DeliveryMethod
+      end
+    end
+  end
+end

data/lib/dm_courier/service_locator.rb

@@ -0,0 +1,43 @@
+require "dm_courier/services/mandrill"
+require "dm_courier/services/sparkpost"
+
+module DMCourier
+  module ServiceLocator
+    def service
+      @service ||= begin
+                     raise DMCourier::InvalidService unless @service_name
+
+                     constantize(@service_name)
+                   end
+    rescue NameError => e
+      raise DMCourier::InvalidService, e
+    end
+
+    def constantize(service_name)
+      camel_cased_word = "DMCourier::Services::#{service_name.to_s.tr('_', ' ').split.map(&:capitalize).join('')}"
+      names = camel_cased_word.split("::")
+
+      Object.const_get(camel_cased_word) if names.empty?
+
+      names.shift if names.size > 1 && names.first.empty?
+
+      names.inject(Object) do |constant, name|
+        if constant == Object
+          constant.const_get(name)
+        else
+          candidate = constant.const_get(name)
+          next candidate if constant.const_defined?(name, false)
+          next candidate unless Object.const_defined?(name)
+
+          constant = constant.ancestors.inject do |const, ancestor|
+            break const    if ancestor == Object
+            break ancestor if ancestor.const_defined?(name, false)
+            const
+          end
+
+          constant.const_get(name, false)
+        end
+      end
+    end
+  end
+end

data/lib/dm_courier/services/mandrill.rb

@@ -0,0 +1,111 @@
+require "mandrill"
+require "base64"
+
+require "dm_courier/message_helper"
+
+module DMCourier
+  module Services
+    class Mandrill
+      include DMCourier::Services::MessageHelper
+
+      attr_reader :api_key, :async, :mail, :options
+
+      def initialize(mail, options = {})
+        @mail = mail
+        @api_key = options.fetch(:api_key)
+        @async = options.fetch(:async, false)
+        @options = options
+      end
+
+      def name
+        :mandrill
+      end
+
+      def deliver!
+        mandrill_api = ::Mandrill::API.new(api_key)
+        mandrill_api.messages.send(mandrill_message, async)
+      end
+
+      def mandrill_message
+        message = extract_params(nil_true_false: { auto_html: :auto_html,
+                                                   auto_text: :auto_text,
+                                                   important: :important,
+                                                   inline_css: :inline_css,
+                                                   track_clicks: :track_clicks,
+                                                   track_opens: :track_opens,
+                                                   url_strip_qs: :track_url_without_query_string,
+                                                   view_content_link: :log_content },
+                                 string: { bcc_address: :bcc_address,
+                                           return_path_domain: :return_path_domain,
+                                           signing_domain: :signing_domain,
+                                           subaccount: :subaccount,
+                                           tracking_domain: :tracking_domain })
+
+        message[:important] ||= false
+
+        message.merge!(from_email: from_email,
+                       from_name: from_name,
+                       headers: headers,
+                       html: html_part,
+                       subject: subject,
+                       tags: tags,
+                       text: text_part,
+                       to: to)
+
+        message[:attachments] = regular_attachments if attachments?(inline: false)
+        message[:images] = inline_attachments if attachments?(inline: true)
+        message
+      end
+
+      private
+
+      def headers
+        headers = {}
+        value = mail["Reply-To"] || options[:reply_to]
+        headers["Reply-To"] = value.to_s if value
+        headers
+      end
+
+      def tags
+        mail[:tags].to_s.split(", ").map { |tag| tag } +
+          options[:tags].to_s.split(", ").map { |tag| tag }
+      end
+
+      def to
+        %w(to cc bcc)
+          .map { |field| hash_addresses(mail[field]) }
+          .reject(&:nil?)
+          .flatten
+      end
+
+      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 regular_attachments
+        attachments(inline: false).map do |attachment|
+          { name: attachment[:name],
+            type: attachment[:type],
+            content: attachment[:content] }
+        end
+      end
+
+      def inline_attachments
+        attachments(inline: true).map do |attachment|
+          { name: attachment[:name],
+            type: attachment[:type],
+            content: attachment[:content] }
+        end
+      end
+    end
+  end
+end

data/lib/dm_courier/services/sparkpost.rb

@@ -0,0 +1,107 @@
+require "sparkpost"
+require "base64"
+
+require "monkey_patch/sparkpost/request"
+require "dm_courier/message_helper"
+
+module DMCourier
+  module Services
+    class Sparkpost
+      include DMCourier::Services::MessageHelper
+
+      attr_reader :api_key, :mail, :options
+
+      def initialize(mail, options = {})
+        @mail = mail
+        @api_key = options.fetch(:api_key)
+        @options = options
+      end
+
+      def name
+        :sparkpost
+      end
+
+      def deliver!
+        sparkpost = ::SparkPost::Client.new(api_key)
+        transmission = sparkpost.transmission
+
+        transmission.send(:request, transmission.endpoint, api_key, sparkpost_message)
+      end
+
+      def sparkpost_message
+        parameters = extract_params(nil_true_false: { inline_css: :inline_css,
+                                                      click_tracking: :track_clicks,
+                                                      open_tracking: :track_opens },
+                                    string: { return_path: :return_path_domain })
+
+        message = { options: {} }
+        message[:options][:inline_css] = parameters[:inline_css] unless parameters[:inline_css].nil?
+        message[:options][:click_tracking] = parameters[:click_tracking] unless parameters[:click_tracking].nil?
+        message[:options][:open_tracking] = parameters[:open_tracking] unless parameters[:open_tracking].nil?
+
+        message[:return_path] = parameters[:return_path] unless parameters[:return_path].nil?
+
+        from = { email: from_email }
+        from[:name] = from_name if from_name
+
+        message[:content] = {
+          from: from,
+          subject: subject
+        }
+
+        message[:content][:reply_to] = reply_to if reply_to
+        message[:content][:html] = html_part if html_part
+        message[:content][:text] = text_part if text_part
+
+        message[:recipients] = recipients
+
+        message[:content][:attachments] = regular_attachments if attachments?(inline: false)
+        message[:content][:inline_images] = inline_attachments if attachments?(inline: true)
+        message
+      end
+
+      private
+
+      def reply_to
+        value = mail["Reply-To"] || options[:reply_to]
+        value.to_s if value
+      end
+
+      def recipients
+        %w(to cc)
+          .map { |field| hash_addresses(mail[field]) }
+          .reject(&:nil?)
+          .flatten
+      end
+
+      def hash_addresses(address_field)
+        return nil unless address_field
+
+        address_field.formatted.map do |address|
+          address_obj = Mail::Address.new(address)
+          {
+            address: { email: address_obj.address }.tap do |hash|
+              hash[:name] = address_obj.display_name if address_obj.display_name
+            end
+          }
+        end
+      end
+
+      def regular_attachments
+        attachments(inline: false).map do |attachment|
+          { name: attachment[:name],
+            type: attachment[:type],
+            content: attachment[:content] }
+        end
+      end
+
+      def inline_attachments
+        attachments(inline: true).map do |attachment|
+          { name: attachment[:name],
+            type: attachment[:type],
+            content: attachment[:content] }
+        end
+      end
+    end
+  end
+end

data/lib/dm_courier/version.rb

@@ -0,0 +1,3 @@
+module DMCourier
+  VERSION = "0.1.1".freeze
+end

data/lib/dm_courier.rb

@@ -0,0 +1,20 @@
+require "dm_courier/version"
+require "dm_courier/errors"
+require "dm_courier/configurable"
+require "dm_courier/delivery_method"
+
+require "dm_courier/railtie" if defined? Rails
+
+module DMCourier
+  class << self
+    include DMCourier::Configurable
+
+    def delivery_method
+      return @delivery_method if defined?(@delivery_method) &&
+                                 @delivery_method.same_options?(options)
+      @delivery_method = DMCourier::DeliveryMethod.new(options)
+    end
+  end
+end
+
+DMCourier.setup

data/lib/monkey_patch/sparkpost/request.rb

@@ -0,0 +1,21 @@
+require "net/http"
+require "json"
+
+module SparkPost
+  module Request
+    def request(url, api_key, data)
+      uri = URI.parse(url)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      headers = {
+        "User-Agent" => "ruby-sparkpost/" + VERSION,
+        "Content-Type" => "application/json",
+        "Authorization" => api_key
+      }
+      req = Net::HTTP::Post.new(uri.path, headers)
+      req.body = JSON.generate(data)
+
+      process_response(http.request(req))
+    end
+  end
+end

data/rails_courier.gemspec

@@ -0,0 +1,39 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "dm_courier/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "dm_courier"
+  spec.version       = DMCourier::VERSION.dup
+  spec.authors       = ["Jaison Erick"]
+  spec.email         = ["jaisonreis@gmail.com"]
+
+  spec.summary       = "A delivery method that abstract the most common email delivery APIs"
+  spec.description   = "A delivery method that abstract the most common email delivery APIs"
+  spec.homepage      = "http://github.com/sumoners/dm_courier"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`
+                       .split("\x0")
+                       .reject { |f| f.match(%r{^(test|spec|features)/}) }
+
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = ">= 2.2.0"
+  spec.required_rubygems_version = ">= 2.4.5"
+
+  spec.add_dependency "mandrill-api", "~> 1.0.53"
+  spec.add_dependency "sparkpost", "~> 0.1.2"
+  spec.add_dependency "http", "0.9.8"
+
+  spec.add_development_dependency "codeclimate-test-reporter", "~> 0.5"
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rspec", "~> 3.4"
+  spec.add_development_dependency "mail", "~> 2.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "simplecov", "~> 0.11"
+  spec.add_development_dependency "rubocop", "~> 0.36"
+  spec.add_development_dependency "pry"
+end

metadata

@@ -0,0 +1,221 @@
+--- !ruby/object:Gem::Specification
+name: dm_courier
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Jaison Erick
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mandrill-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.53
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.53
+- !ruby/object:Gem::Dependency
+  name: sparkpost
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.8
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.36'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.36'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A delivery method that abstract the most common email delivery APIs
+email:
+- jaisonreis@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".codeclimate.yml"
+- ".gitignore"
+- ".hound.yml"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/dm_courier.rb
+- lib/dm_courier/configurable.rb
+- lib/dm_courier/default.rb
+- lib/dm_courier/delivery_method.rb
+- lib/dm_courier/errors.rb
+- lib/dm_courier/message_helper.rb
+- lib/dm_courier/railtie.rb
+- lib/dm_courier/service_locator.rb
+- lib/dm_courier/services/mandrill.rb
+- lib/dm_courier/services/sparkpost.rb
+- lib/dm_courier/version.rb
+- lib/monkey_patch/sparkpost/request.rb
+- rails_courier.gemspec
+homepage: http://github.com/sumoners/dm_courier
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.5
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: A delivery method that abstract the most common email delivery APIs
+test_files: []