mandrill_mailer 0.0.1 → 0.0.2

data/Gemfile.lock

@@ -0,0 +1,66 @@
+PATH
+  remote: .
+  specs:
+    mandrill_mailer (0.0.2)
+      actionpack
+      activesupport
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionpack (3.2.8)
+      activemodel (= 3.2.8)
+      activesupport (= 3.2.8)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.4)
+      rack (~> 1.4.0)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.1.3)
+    activemodel (3.2.8)
+      activesupport (= 3.2.8)
+      builder (~> 3.0.0)
+    activesupport (3.2.8)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    builder (3.0.3)
+    coderay (1.0.7)
+    diff-lcs (1.1.3)
+    erubis (2.7.0)
+    hike (1.2.1)
+    i18n (0.6.1)
+    journey (1.0.4)
+    method_source (0.8)
+    multi_json (1.3.6)
+    pry (0.9.10)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.3.1)
+    rack (1.4.1)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.3)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.3)
+    slop (3.3.3)
+    sprockets (2.1.3)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    tilt (1.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  mandrill_mailer!
+  pry
+  rspec

data/README.md

@@ -3,6 +3,7 @@ MandrilMailer class for sending transactional emails through mandril.
 Only template based emails are supported at this time.
 
 ## Usage
+Add `gem 'mailchimp'`
 Add `gem 'mandrill_mailer'` to your Gemfile
 
 Add this to your `mail.rb` in initializers:

data/lib/mandrill_mailer/transactional_mailer.rb

@@ -0,0 +1,308 @@
+# MandrilMailer class for sending transactional emails through mandril.
+# Only template based emails are supported at this time.
+
+# Example usage:
+
+# class InvitationMailer < MandrillMailer
+#   default from: 'support@codeschool.com'
+
+#   def invite(invitation)
+#     mandrill_mail template: 'Group Invite',
+#                   subject: I18n.t('invitation_mailer.invite.subject'),
+#                   to: {email: invitation.email, name: 'user level 1'},
+#                   vars: {
+#                     'OWNER_NAME' => invitation.owner_name,
+#                     'INVITATION_URL' => new_invitation_url(email: invitation.email, secret: invitation.secret)
+#                   },
+#                   template_content: {}
+#   end
+# end
+
+# #default:
+#   :from - set the default from email address for the mailer
+
+# .mandrill_mail
+#   :template(required) - Template name from within Mandrill
+
+#   :subject(required) - Subject of the email
+
+#   :to(required) - Accepts an email String, or hash with :name and :email keys
+#     ex. {email: 'someone@email.com', name: 'Bob Bertly'}
+
+#   :vars - A Hash of merge tags made available to the email. Use them in the
+#     email by wrapping them in '*||*' vars: {'OWNER_NAME' => 'Suzy'} is used
+#     by doing: *|OWNER_NAME|* in the email template within Mandrill
+
+#   :template_content - A Hash of values and content for Mandrill editable content blocks.
+#     In MailChimp templates there are editable regions with 'mc:edit' attributes that look
+#     a little like: '<div mc:edit="header">My email content</div>' You can insert content directly into
+#     these fields by passing a Hash {'header' => 'my email content'}
+
+# :headers - Extra headers to add to the message (currently only Reply-To and X-* headers are allowed) {"...": "..."}
+
+# :bcc - Add an email to bcc to
+
+# :tags - Array of Strings 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.
+
+# :google_analytics_domains - Array of Strings indicating for which any
+#   matching URLs will automatically have Google Analytics parameters appended
+#   to their query string automatically.
+
+# :google_analytics_campaign - String indicating the value to set for
+#   the utm_campaign tracking parameter. If this isn't provided the email's
+#   from address will be used instead.
+
+module MandrillMailer
+  class TransactionalMailer
+    # include Rails.application.routes.url_helpers
+    include ActionView::Helpers::NumberHelper
+
+    # Public: Defaults for the mailer. Currently the only option is from:
+    #
+    # options - The Hash options used to refine the selection (default: {}):
+    #             :from - Default from email address
+    #
+    # Examples
+    #
+    #   default from: 'foo@bar.com'
+    #
+    # Returns options
+    def self.default(args)
+      @@defaults ||= {}
+      @@defaults[:from] ||= 'example@email.com'
+      @@defaults.merge!(args)
+    end
+
+    # Public: setup a way to test mailer methods
+    #
+    # mailer_method - Name of the mailer method the test setup is for
+    # block - Block of code to execute to perform the test. The mailer
+    #         and options are passed to the block. The options have to
+    #         contain at least the :email to send the test to.
+    #
+    # Examples
+    #
+    # test_setup_for :invite do |mailer, options|
+    #   invitation = OpenStruct.new({
+    #     email: options[:email],
+    #     owner_name: 'foobar',
+    #     secret: rand(9000000..1000000).to_s
+    #   })
+    #   mailer.invite(invitation).deliver
+    # end
+    #
+    # Returns the duplicated String.
+    def self.test_setup_for(mailer_method, &block)
+      @@mailer_methods ||= {}
+      @@mailer_methods[mailer_method] = block
+    end
+
+    # Public: Executes a test email
+    #
+    # mailer_method - Method to execute
+    # options - The Hash options used to refine the selection (default: {}):
+    #             :email - The email to send the test to.
+    #
+    # Examples
+    #
+    # InvitationMailer.test(:invite, email: 'benny@envylabs.com')
+    #
+    # Returns the duplicated String.
+    def self.test(mailer_method, options={})
+      unless options[:email]
+        raise Exception 'Please specify a :email option(email to send the test to)'
+      end
+
+      if @@mailer_methods[mailer_method]
+        @@mailer_methods[mailer_method].call(self.new, options)
+      else
+        raise Exception "The mailer method: #{mailer_method} does not have test setup"
+      end
+
+    end
+
+    # Public: this enables the api key to be set in an initializer
+    #         ex. MandrillMailer.api_key = ENV[MANDRILL_API_KEY]
+    #
+    # key - Api key for the Mandrill api
+    #
+    #
+    # Returns the key(String)
+    def self.api_key=(key)
+      @@api_key = key
+    end
+
+    def default_url_options=(options={})
+      @@url_host = options[:host]
+    end
+
+    # Public: Triggers the stored Mandril params to be sent to the Mandrill api
+    #
+    # text - The String to be duplicated.
+    # count - The Integer number of times to duplicate the text.
+    #
+    # Examples
+    #
+    #   multiplex('Tom', 4)
+    #   # => 'TomTomTomTom'
+    #
+    # Returns the duplicated String.
+    def deliver
+      mandrill = Mailchimp::Mandrill.new(api_key)
+      mandrill.messages_send_template(@data)
+    end
+
+    # Public: Build the hash needed to send to the mandrill api
+    #
+    # args - The Hash options used to refine the selection:
+    #             :template - Template name in Mandrill
+    #             :subject - Subject of the email
+    #             :to - Email to send the mandrill email to
+    #             :vars - Merge vars used in the email for dynamic data
+    #             :bcc - bcc email for the mandrill email
+    #             :tags - Tags for the email
+    #             :google_analytics_domains - Google analytics domains
+    #             :google_analytics_campaign - Google analytics campaign
+    #
+    # Examples
+    #
+    # mandrill_mail template: 'Group Invite',
+    #               subject: I18n.t('invitation_mailer.invite.subject'),
+    #               to: invitation.email,
+    #               vars: {
+    #                 'OWNER_NAME' => invitation.owner_name,
+    #                 'INVITATION_URL' => new_invitation_url(email: invitation.email, secret: invitation.secret)
+    #               }
+    #
+    # Returns the the mandrill mailer class (this is so you can chain #deliver like a normal mailer)
+    def mandrill_mail(args)
+
+      # Mandrill requires template content to be there
+      args[:template_content] = {"blank" => ""} if args[:template_content].blank?
+
+      # format the :to param to what Mandrill expects if a string or array is passed
+      args[:to] = format_to_params(args[:to])
+
+      @data = {"key" => api_key,
+        "template_name" => args[:template],
+        "template_content" => mandrill_args(args[:template_content]),
+        "message" => {
+          "subject" => args[:subject],
+          "from_email" => args[:from] || @@defaults[:from],
+          "from_name" => args[:from_name] || @@defaults[:from],
+          "to" => args[:to],
+          "headers" => args[:headers],
+          "track_opens" => true,
+          "track_clicks" => true,
+          "auto_text" => true,
+          "url_strip_qs" => true,
+          "bcc_address" => args[:bcc],
+          "global_merge_vars" => mandrill_args(args[:vars]),
+          # "merge_vars" =>[
+          #   {
+          #     "rcpt" => "email@email.com"
+          #     "vars" => {"name" => "VARS", "content" => "vars content"}
+          #   }
+          # ]
+
+          "tags" => args[:tags],
+          "google_analytics_domains" => args[:google_analytics_domains],
+          "google_analytics_campaign" => args[:google_analytics_campaign]
+          # "metadata" =>["..."],
+          # "attachments" =>[
+          #   {"type" => "example type", "name" => "example name", "content" => "example content"}
+          # ]
+        }
+      }
+
+      # return self so we can chain deliver after the method call, like a normal mailer.
+      return self
+    end
+
+    def data
+      @data
+    end
+
+    protected
+
+    # Public: Url helper for creating OpenStruct compatible urls
+    #         This is used for making sure urls will still work with
+    #         OpenStructs used in the email testing code
+    #
+    #         OpenStruct should have a .url property to work with this
+    #
+    # object - Object that would normally be passed into the route helper
+    # route_helper - The route helper as a symbol needed for the url
+    #
+    # Examples
+    #
+    # 'VIDEO_URL' => open_struct_url(video, :code_tv_video_url)
+    #
+    # Returns the url as a string
+    def test_friendly_url(object, route_helper)
+      if object.kind_of? OpenStruct
+        object.url
+      else
+        method(route_helper).call(object)
+      end
+    end
+
+    # Makes this class act as a singleton without it actually being a singleton
+    # This keeps the syntax the same as the orginal mailers so we can swap quickly if something
+    # goes wrong.
+    def self.method_missing(method, *args)
+      return super unless respond_to?(method)
+      new.method(method).call(*args)
+    end
+
+    def self.respond_to?(method, include_private = false)
+      super || instance_methods.include?(method)
+    end
+
+    # Proxy route helpers to rails if Rails exists
+    def method_missing(method, *args)
+      return super unless defined?(Rails) && Rails.application.routes.url_helpers.respond_to?(method)
+      Rails.application.routes.url_helpers.method(method).call(*args, host: @@url_host)
+    end
+
+    def image_path(image)
+      ActionController::Base.helpers.asset_path(image)
+    end
+
+    def image_url(image)
+      "#{root_url}#{image_path(image).split('/').reject!(&:empty?).join('/')}"
+    end
+
+    # convert a normal hash into the format mandrill needs
+    def mandrill_args(args)
+      args.map do |k,v|
+        {'name' => k, 'content' => v}
+      end
+    end
+
+    # handle if to params is an array of either hashes or strings or the single string
+    def format_to_params(to_params)
+      if to_params.kind_of? Array
+        to_params.map do |p|
+          to_params_item(p)
+        end
+      else
+        [to_params_item(to_params)]
+      end
+    end
+
+    # single to params item
+    def to_params_item(item)
+      return {"email" => item, "name" => "Code School Customer"} unless item.kind_of? Hash
+      item
+    end
+
+    def api_key
+      @@api_key || ''
+    end
+  end
+end

data/lib/mandrill_mailer/version.rb

@@ -1,3 +1,3 @@
 module MandrillMailer
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/mandrill_mailer.rb

@@ -1,4 +1,6 @@
-require 'mandrill_mailer/mandrill_mailer'
+require 'action_view'
+require 'mandrill_mailer/transactional_mailer'
+require 'mandrill_mailer/version'
 
 module MandrillMailer
 

data/mandrill_mailer.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Adam Rensel"]
   s.email       = ["adamrensel@codeschool.com"]
-  s.homepage    = ""
+  s.homepage    = "https://github.com/renz45/mandrill_mailer"
   s.summary     = %q{Transactional Mailer for Mandrill}
   s.description = %q{Transactional Mailer for Mandrill}
 
@@ -16,4 +16,9 @@ Gem::Specification.new do |s|
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
+
+  s.add_dependency 'activesupport'
+  s.add_dependency 'actionpack'
+  s.add_development_dependency 'pry'
+  s.add_development_dependency 'rspec'
 end

data/spec/mandrill_mailer_spec.rb

@@ -0,0 +1,132 @@
+require "spec_helper"
+
+describe MandrillMailer::TransactionalMailer do
+  let(:image_path) { '/assets/image.jpg' }
+  let(:default_host) { 'localhost:3000' }
+  let(:mailer) {described_class.new}
+  let(:api_key) { '1237861278' }
+
+  before do
+    MandrillMailer::TransactionalMailer.api_key = api_key
+    MandrillMailer::TransactionalMailer.default_url_options = { host: default_host }
+    MandrillMailer::TransactionalMailer.any_instance.stub(:image_path).and_return(image_path)
+  end
+
+  # this only works from within a Rails application
+  # describe '#image_url' do
+  #   subject { mailer.send(:image_url, 'image.jpg') }
+
+  #   it 'should return the full path to the image' do
+  #     should eq "http://#{default_host}#{image_path}"
+  #   end
+  # end
+
+  describe '#mandrill_args' do
+    let(:arg_name) { 'USER_NAME' }
+    let(:arg_value) { 'bob' }
+
+    subject { mailer.send(:mandrill_args, {arg_name => arg_value}) }
+
+    it 'should convert the args to the correct format' do
+      should eq [{'name' => arg_name, 'content' => arg_value}]
+    end
+  end
+
+  describe '#format_to_params' do
+    let(:email) { 'bob@email.com' }
+    let(:name) { 'bob' }
+    let(:default_name) { 'Code School Customer' }
+
+    context 'with a single email string' do
+      subject { mailer.send(:format_to_params, email) }
+
+      it 'should format args to a format mandrill likes' do
+        should eq [{"email" => email, "name" => default_name}] 
+      end
+    end
+
+    context 'with a single email string array' do
+      subject { mailer.send(:format_to_params, [email]) }
+
+      it 'should format args to a format mandrill likes' do
+        should eq [{"email" => email, "name" => default_name}] 
+      end
+    end
+
+    context 'with a single email/name Hash' do
+      subject { mailer.send(:format_to_params, {"email" => email, "name" => name}) }
+
+      it 'should format args to a format mandrill likes' do
+        should eq [{"email" => email, "name" => name}]
+      end
+    end
+
+    context 'with a single email/name hash Array' do
+      subject { mailer.send(:format_to_params, [{"email" => email, "name" => name}]) }
+
+      it 'should format args to a format mandrill likes' do
+        should eq [{"email" => email, "name" => name}] 
+      end
+    end
+  end
+
+  describe '#mandrill_mail' do
+    let(:template_content_name) { 'edit' }
+    let(:template_content_content) { 'edit_content' }
+    let(:from_email) { 'from@email.com' }
+    let(:var_name) { 'USER_NAME' }
+    let(:var_content) { 'bobert' }
+    let(:to_email) { 'bob@email.com' }
+    let(:to_name) { 'bob' }
+
+    let(:data) do
+      {
+        template: 'Email Template',
+        subject: "super secret",
+        to: {'email' => to_email, 'name' => to_name},
+        vars: {
+          var_name => var_content
+        },
+        template_content: {template_content_name => template_content_content},
+        headers: {"Reply-To" => "support@email.com"},
+        bcc: 'email@email.com',
+        tags: ['tag1'],
+        google_analytics_domains: ["http://site.com"],
+        google_analytics_campaign: '1237423474'
+      }
+    end
+    subject { mailer.mandrill_mail(data) }
+
+    before do
+      MandrillMailer::TransactionalMailer.default from: from_email
+    end
+
+    it 'should return the current class instance' do
+      should eq mailer
+    end
+
+    it 'should produce the correct data' do
+      mail = MandrillMailer::TransactionalMailer.new().mandrill_mail(data)
+      mail.data.should eq ({"key" => api_key, 
+        "template_name" => data[:template],
+        "template_content" => [{'name' => template_content_name, 'content' => template_content_content}],
+        "message" => {
+          "subject" => data[:subject], 
+          "from_email" => from_email, 
+          "from_name" => from_email, 
+          "to" => [{'email' => to_email, 'name' => to_name}],
+          "headers" => data[:headers],
+          "track_opens" => true,
+          "track_clicks" => true,
+          "auto_text" => true,
+          "url_strip_qs" => true,
+          "bcc_address" => data[:bcc], 
+          "global_merge_vars" => [{"name" => var_name, "content" => var_content}],
+          "tags" => data[:tags],
+          "google_analytics_domains" => data[:google_analytics_domains],
+          "google_analytics_campaign" => data[:google_analytics_campaign]
+        }
+      })
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'rspec'
+require 'mandrill_mailer'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mandrill_mailer
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,71 @@ autorequire:
 bindir: bin
 cert_chain: []
 date: 2012-09-24 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Transactional Mailer for Mandrill
 email:
 - adamrensel@codeschool.com
@@ -20,12 +84,15 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
+- Gemfile.lock
 - README.md
 - lib/mandrill_mailer.rb
-- lib/mandrill_mailer/mandrill_mailer.rb
+- lib/mandrill_mailer/transactional_mailer.rb
 - lib/mandrill_mailer/version.rb
 - mandrill_mailer.gemspec
-homepage: ''
+- spec/mandrill_mailer_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/renz45/mandrill_mailer
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -49,4 +116,6 @@ rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Transactional Mailer for Mandrill
-test_files: []
+test_files:
+- spec/mandrill_mailer_spec.rb
+- spec/spec_helper.rb

data/lib/mandrill_mailer/mandrill_mailer.rb

@@ -1,297 +0,0 @@
-# MandrilMailer class for sending transactional emails through mandril.
-# Only template based emails are supported at this time.
-
-# Example usage:
-
-# class InvitationMailer < MandrillMailer
-#   default from: 'support@codeschool.com'
-
-#   def invite(invitation)
-#     mandrill_mail template: 'Group Invite',
-#                   subject: I18n.t('invitation_mailer.invite.subject'),
-#                   to: {email: invitation.email, name: 'user level 1'},
-#                   vars: {
-#                     'OWNER_NAME' => invitation.owner_name,
-#                     'INVITATION_URL' => new_invitation_url(email: invitation.email, secret: invitation.secret)
-#                   },
-#                   template_content: {}
-#   end
-# end
-
-# #default:
-#   :from - set the default from email address for the mailer
-
-# .mandrill_mail
-#   :template(required) - Template name from within Mandrill
-
-#   :subject(required) - Subject of the email
-
-#   :to(required) - Accepts an email String, or hash with :name and :email keys
-#     ex. {email: 'someone@email.com', name: 'Bob Bertly'}
-
-#   :vars - A Hash of merge tags made available to the email. Use them in the
-#     email by wrapping them in '*||*' vars: {'OWNER_NAME' => 'Suzy'} is used
-#     by doing: *|OWNER_NAME|* in the email template within Mandrill
-
-#   :template_content - A Hash of values and content for Mandrill editable content blocks.
-#     In MailChimp templates there are editable regions with 'mc:edit' attributes that look
-#     a little like: '<div mc:edit="header">My email content</div>' You can insert content directly into
-#     these fields by passing a Hash {'header' => 'my email content'}
-
-# :headers - Extra headers to add to the message (currently only Reply-To and X-* headers are allowed) {"...": "..."}
-
-# :bcc - Add an email to bcc to
-
-# :tags - Array of Strings 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.
-
-# :google_analytics_domains - Array of Strings indicating for which any
-#   matching URLs will automatically have Google Analytics parameters appended
-#   to their query string automatically.
-
-# :google_analytics_campaign - String indicating the value to set for
-#   the utm_campaign tracking parameter. If this isn't provided the email's
-#   from address will be used instead.
-
-
-class MandrillMailer
-  include Rails.application.routes.url_helpers
-  include ActionView::Helpers::NumberHelper
-
-  # Public: Defaults for the mailer. Currently the only option is from:
-  #
-  # options - The Hash options used to refine the selection (default: {}):
-  #             :from - Default from email address
-  #
-  # Examples
-  #
-  #   default from: 'foo@bar.com'
-  #
-  # Returns options
-  def self.default(args)
-    @@defaults ||= {}
-    @@defaults[:from] ||= 'example@email.com'
-    @@defaults.merge!(args)
-  end
-
-  # Public: setup a way to test mailer methods
-  #
-  # mailer_method - Name of the mailer method the test setup is for
-  # block - Block of code to execute to perform the test. The mailer
-  #         and options are passed to the block. The options have to
-  #         contain at least the :email to send the test to.
-  #
-  # Examples
-  #
-  # test_setup_for :invite do |mailer, options|
-  #   invitation = OpenStruct.new({
-  #     email: options[:email],
-  #     owner_name: 'foobar',
-  #     secret: rand(9000000..1000000).to_s
-  #   })
-  #   mailer.invite(invitation).deliver
-  # end
-  #
-  # Returns the duplicated String.
-  def self.test_setup_for(mailer_method, &block)
-    @@mailer_methods ||= {}
-    @@mailer_methods[mailer_method] = block
-  end
-
-  # Public: Executes a test email
-  #
-  # mailer_method - Method to execute
-  # options - The Hash options used to refine the selection (default: {}):
-  #             :email - The email to send the test to.
-  #
-  # Examples
-  #
-  # InvitationMailer.test(:invite, email: 'benny@envylabs.com')
-  #
-  # Returns the duplicated String.
-  def self.test(mailer_method, options={})
-    unless options[:email]
-      raise Exception 'Please specify a :email option(email to send the test to)'
-    end
-
-    if @@mailer_methods[mailer_method]
-      @@mailer_methods[mailer_method].call(self.new, options)
-    else
-      raise Exception "The mailer method: #{mailer_method} does not have test setup"
-    end
-
-  end
-
-  # Public: this enables the api key to be set in an initializer
-  #         ex. MandrillMailer.api_key = ENV[MANDRILL_API_KEY]
-  #
-  # key - Api key for the Mandrill api
-  #
-  #
-  # Returns the key(String)
-  def self.api_key=(key)
-    @@api_key = key
-  end
-
-  # Public: Triggers the stored Mandril params to be sent to the Mandrill api
-  #
-  # text - The String to be duplicated.
-  # count - The Integer number of times to duplicate the text.
-  #
-  # Examples
-  #
-  #   multiplex('Tom', 4)
-  #   # => 'TomTomTomTom'
-  #
-  # Returns the duplicated String.
-  def deliver
-    mandrill = Mailchimp::Mandrill.new(api_key)
-    mandrill.messages_send_template(@data)
-  end
-
-  protected
-
-  # Public: Url helper for creating OpenStruct compatible urls
-  #         This is used for making sure urls will still work with
-  #         OpenStructs used in the email testing code
-  #
-  #         OpenStruct should have a .url property to work with this
-  #
-  # object - Object that would normally be passed into the route helper
-  # route_helper - The route helper as a symbol needed for the url
-  #
-  # Examples
-  #
-  # 'VIDEO_URL' => open_struct_url(video, :code_tv_video_url)
-  #
-  # Returns the url as a string
-  def test_friendly_url(object, route_helper)
-    if object.kind_of? OpenStruct
-      object.url
-    else
-      method(route_helper).call(object)
-    end
-  end
-
-  # Makes this class act as a singleton without it actually being a singleton
-  # This keeps the syntax the same as the orginal mailers so we can swap quickly if something
-  # goes wrong.
-  def self.method_missing(method, *args)
-    return super unless respond_to?(method)
-    new.method(method).call(*args)
-  end
-
-  def self.respond_to?(method, include_private = false)
-    super || instance_methods.include?(method)
-  end
-
-  # Public: Build the hash needed to send to the mandrill api
-  #
-  # args - The Hash options used to refine the selection:
-  #             :template - Template name in Mandrill
-  #             :subject - Subject of the email
-  #             :to - Email to send the mandrill email to
-  #             :vars - Merge vars used in the email for dynamic data
-  #             :bcc - bcc email for the mandrill email
-  #             :tags - Tags for the email
-  #             :google_analytics_domains - Google analytics domains
-  #             :google_analytics_campaign - Google analytics campaign
-  #
-  # Examples
-  #
-  # mandrill_mail template: 'Group Invite',
-  #               subject: I18n.t('invitation_mailer.invite.subject'),
-  #               to: invitation.email,
-  #               vars: {
-  #                 'OWNER_NAME' => invitation.owner_name,
-  #                 'INVITATION_URL' => new_invitation_url(email: invitation.email, secret: invitation.secret)
-  #               }
-  #
-  # Returns the the mandrill mailer class (this is so you can chain #deliver like a normal mailer)
-  def mandrill_mail(args)
-
-    # Mandrill requires template content to be there
-    args[:template_content] = {"blank" => ""} if args[:template_content].blank?
-
-    # format the :to param to what Mandrill expects if a string or array is passed
-    args[:to] = format_to_params(args[:to])
-
-    @data = {"key" => api_key,
-      "template_name" => args[:template],
-      "template_content" => mandrill_args(args[:template_content]),
-      "message" => {
-        "subject" => args[:subject],
-        "from_email" => args[:from] || @@defaults[:from],
-        "from_name" => args[:from_name] || @@defaults[:from],
-        "to" => args[:to],
-        "headers" => args[:headers],
-        "track_opens" => true,
-        "track_clicks" => true,
-        "auto_text" => true,
-        "url_strip_qs" => true,
-        "bcc_address" => args[:bcc],
-        "global_merge_vars" => mandrill_args(args[:vars]),
-        # "merge_vars" =>[
-        #   {
-        #     "rcpt" => "email@email.com"
-        #     "vars" => {"name" => "VARS", "content" => "vars content"}
-        #   }
-        # ]
-
-        "tags" => args[:tags],
-        "google_analytics_domains" => args[:google_analytics_domains],
-        "google_analytics_campaign" => args[:google_analytics_campaign]
-        # "metadata" =>["..."],
-        # "attachments" =>[
-        #   {"type" => "example type", "name" => "example name", "content" => "example content"}
-        # ]
-      }
-    }
-
-    # return self so we can chain deliver after the method call, like a normal mailer.
-    return self
-  end
-
-  def data
-    @data
-  end
-
-  def image_path(image)
-    ActionController::Base.helpers.asset_path(image)
-  end
-
-  def image_url(image)
-    "#{root_url}#{image_path(image).split('/').reject!(&:empty?).join('/')}"
-  end
-
-  # convert a normal hash into the format mandrill needs
-  def mandrill_args(args)
-    args.map do |k,v|
-      {'name' => k, 'content' => v}
-    end
-  end
-
-  # handle if to params is an array of either hashes or strings or the single string
-  def format_to_params(to_params)
-    if to_params.kind_of? Array
-      to_params.map do |p|
-        to_params_item(p)
-      end
-    else
-      [to_params_item(to_params)]
-    end
-  end
-
-  # single to params item
-  def to_params_item(item)
-    return {"email" => item, "name" => "Code School Customer"} unless item.kind_of? Hash
-    item
-  end
-
-  def api_key
-    @@api_key || ''
-  end
-end