mandrill-mailer-rails 0.0.1

data/lib/mandrill_action_mailer/railtie.rb

@@ -0,0 +1,12 @@
+require 'rails/railtie'
+require 'mandrill_action_mailer/delivery_handler'
+
+module MandrillActionMailer
+  class Railtie < Rails::Railtie
+    config.mandrill_action_mailer = MandrillActionMailer.config
+
+    initializer 'mandrill_action_mailer.add_delivery_method' do
+      ActionMailer::Base.add_delivery_method(:mandrill, MandrillActionMailer::DeliveryHandler)
+    end
+  end
+end

data/mandrill-mailer-rails.gemspec

@@ -0,0 +1,22 @@
+Gem::Specification.new do |s|
+  s.name        = 'mandrill-mailer-rails'
+  s.version     = '0.0.1'
+  s.authors     = ['Tinfoil Security, Inc.']
+  s.email       = ['engineers@tinfoilsecurity.com']
+  s.homepage    = 'https://www.github.com/bsedat/mandrill-mailer-rails'
+  s.summary     = %q{Handler for Rails to send emails through Mandrill}
+  s.description = %q{Provides an ActionMailer delivery handler sending emails through Mandrill}
+
+  s.files         = `git ls-files`.split("\n")
+  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('mandrill-api')
+  s.add_dependency('rails', '> 3.0')
+
+  s.add_development_dependency('rake')
+  s.add_development_dependency('rspec-rails')
+  s.add_development_dependency('rspec-mocks')
+  s.add_development_dependency('appraisal')
+end

data/spec/integration/deliver_handler_spec.rb

@@ -0,0 +1,166 @@
+require 'spec_helper'
+
+describe 'MandrillActionMailer::DeliverHandler' do
+  let(:client) { double('Mandrill::API') }
+  let(:sender) { double('Mandrill::Messages') }
+
+  before do
+    allow(MandrillActionMailer).to receive(:client).and_return(client)
+    allow(client).to receive(:messages).and_return(sender)
+  end
+
+  context 'when an API key is missing' do
+    before do
+      allow(MandrillActionMailer).to receive(:client).and_call_original
+    end
+
+    it 'should raise an error' do
+      expect { Notifier.test.deliver! }.to raise_error
+    end
+  end
+
+  context 'when the delivery fails' do
+    it 'should raise an error' do
+      allow(sender).to receive(:send).and_raise(RuntimeError.new)
+
+      expect { Notifier.test.deliver! }.to raise_error
+    end
+  end
+
+  context 'when the delivery is best effort' do
+    it 'should not raise an error' do
+      allow(sender).to receive(:send)
+
+      expect { Notifier.test.deliver }.to_not raise_error
+    end
+  end
+
+  it 'should send the email through the Mandrill client' do
+    expect(sender).to receive(:send)
+
+    Notifier.test.deliver
+  end
+
+  it 'should set the subject' do
+    expect(sender).to receive(:send).with(
+      hash_including(
+        :subject => Notifier::SUBJECT
+      )
+    )
+
+    Notifier.test.deliver
+  end
+
+  it 'should set the from field' do
+    expect(sender).to receive(:send).with(
+      hash_including(
+        :from_email => Notifier::FROM
+      )
+    )
+
+    Notifier.test.deliver
+  end
+
+  it 'should not set the from_name field' do
+    expect(sender).to receive(:send).with(
+      hash_excluding(:from_name)
+    )
+
+    Notifier.test.deliver
+  end
+
+  context 'when the from_name is set' do
+    it 'should set the from_name field' do
+      expect(sender).to receive(:send).with(
+        hash_including(
+          :from_name => Notifier::FROM
+        )
+      )
+
+      Notifier.test_from_name.deliver
+    end
+  end
+
+  it 'should set the to field' do
+    expect(sender).to receive(:send).with(
+      hash_including(
+        :to => [
+          {
+            :email => Notifier::TO,
+            :name => Notifier::TO
+          }
+        ]
+      )
+    )
+
+    Notifier.test.deliver
+  end
+
+  it 'should not set the reply-to field' do
+    expect(sender).to receive(:send).with(
+      hash_excluding(
+        :headers => hash_including('Reply-To')
+      )
+    )
+
+    Notifier.test.deliver
+  end
+
+  context 'when the reply-to field is set' do
+    it 'should set the reply-to field' do
+      expect(sender).to receive(:send).with(
+        hash_including(
+          :headers => { 'Reply-To' => Notifier::REPLY_TO }
+        )
+      )
+
+      Notifier.test_reply_to.deliver
+    end
+  end
+
+  it 'should not set the bcc field' do
+    expect(sender).to receive(:send).with(
+      hash_excluding(:bcc)
+    )
+
+    Notifier.test.deliver
+  end
+
+  context 'when the bcc is set' do
+    it 'should set the bcc_address field' do
+      expect(sender).to receive(:send).with(
+        hash_including(
+          :bcc_address => Notifier::BCC
+        )
+      )
+
+      Notifier.test_bcc.deliver
+    end
+  end
+
+  it 'should render multipart messages' do
+    expect(sender).to receive(:send).with(
+      hash_including(
+        :html,
+        :text
+      )
+    )
+
+    Notifier.multipart.deliver
+  end
+
+  it 'should set many to recipients' do
+    expect(sender).to receive(:send).with(
+      hash_including(
+          :to => Notifier::MANY_TO.map do |email|
+            {
+              :email => email,
+              :name => email
+            }
+          end
+      )
+    )
+
+    Notifier.to_many.deliver
+  end
+end

data/spec/rails_app/.gitignore

@@ -0,0 +1,3 @@
+tmp
+log
+

data/spec/rails_app/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/spec/rails_app/app/mailers/notifier.rb

@@ -0,0 +1,35 @@
+class Notifier < ActionMailer::Base
+  TO = 'to@example.org'
+  MANY_TO = [TO, 'to2@example.org']
+  FROM = 'from@example.org'
+  SUBJECT = 'Test Subject'
+  REPLY_TO = 'reply@example.org'
+  BCC = 'bcc@example.org'
+
+  default to: TO, from: FROM, subject: SUBJECT
+
+  def test
+    mail
+  end
+
+  def test_reply_to
+    mail reply_to: REPLY_TO, template_name: 'test'
+  end
+
+  def test_bcc
+    mail bcc: BCC, template_name: 'test'
+  end
+
+  def test_from_name
+    mail from_name: FROM, template_name: 'test'
+  end
+
+  def to_many
+    mail to: MANY_TO, template_name: 'test'
+  end
+
+  def multipart
+    mail
+  end
+
+end

data/spec/rails_app/app/views/notifier/multipart.html.erb

@@ -0,0 +1 @@
+<b>HTML</b>

data/spec/rails_app/app/views/notifier/multipart.text.erb

@@ -0,0 +1 @@
+Plaintext

data/spec/rails_app/app/views/notifier/test.text.erb

@@ -0,0 +1 @@
+Testing!

data/spec/rails_app/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/spec/rails_app/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/spec/rails_app/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/spec/rails_app/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Rails.application

data/spec/rails_app/config/application.rb

@@ -0,0 +1,61 @@
+require File.expand_path('../boot', __FILE__)
+
+require "action_controller/railtie"
+require "action_mailer/railtie"
+# require "active_resource/railtie"
+require "rails/test_unit/railtie"
+require "sprockets/railtie"
+
+Bundler.require(*Rails.groups)
+
+module TestRailsApp
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Custom directories with classes and modules you want to be autoloadable.
+    # config.autoload_paths += %W(#{config.root}/extras)
+
+    # Only load the plugins named here, in the order given (default is alphabetical).
+    # :all can be used as a placeholder for all plugins not explicitly named.
+    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+    # Activate observers that should always be running.
+    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # Configure the default encoding used in templates for Ruby 1.9.
+    config.encoding = "utf-8"
+
+    # Configure sensitive parameters which will be filtered from the log file.
+    config.filter_parameters += [:password]
+
+    # Enable escaping HTML in JSON.
+    config.active_support.escape_html_entities_in_json = true
+
+    # Use SQL instead of Active Record's schema dumper when creating the database.
+    # This is necessary if your schema can't be completely dumped by the schema dumper,
+    # like if you have constraints or database-specific column types
+    # config.active_record.schema_format = :sql
+
+    # Enforce whitelist mode for mass assignment.
+    # This will create an empty whitelist of attributes available for mass-assignment for all models
+    # in your app. As such, your models will need to explicitly whitelist or blacklist accessible
+    # parameters by using an attr_accessible or attr_protected declaration.
+    # config.active_record.whitelist_attributes = true
+
+    # Enable the asset pipeline
+    config.assets.enabled = true
+
+    # Version of your assets, change this if you want to expire all your assets
+    config.assets.version = '1.0'
+  end
+end

data/spec/rails_app/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/spec/rails_app/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require File.expand_path('../application', __FILE__)
+
+# Initialize the Rails application.
+Rails.application.initialize!

data/spec/rails_app/config/environments/test.rb

@@ -0,0 +1,39 @@
+TestRailsApp::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # The test environment is used exclusively to run your application's
+  # test suite. You never need to work with it otherwise. Remember that
+  # your test database is "scratch space" for the test suite and is wiped
+  # and recreated between test runs. Don't rely on the data there!
+  config.cache_classes = true
+
+  # Do not eager load code on boot. This avoids loading your whole application
+  # just for the purpose of running a single test. If you are using a tool that
+  # preloads Rails for running tests, you may have to set it to true.
+  config.eager_load = false
+
+  # Configure static asset server for tests with Cache-Control for performance.
+  config.serve_static_assets  = true
+  config.static_cache_control = 'public, max-age=3600'
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Raise exceptions instead of rendering exception templates.
+  config.action_dispatch.show_exceptions = false
+
+  # Disable request forgery protection in test environment.
+  config.action_controller.allow_forgery_protection = false
+
+  # Tell Action Mailer not to deliver emails to the real world.
+  # The :test delivery method accumulates sent emails in the
+  # ActionMailer::Base.deliveries array.
+  config.action_mailer.delivery_method = :mandrill
+
+  # Print deprecation notices to the stderr.
+  config.active_support.deprecation = :stderr
+
+  # Raises error for missing translations
+  # config.action_view.raise_on_missing_translations = true
+end

data/spec/rails_app/config/initializers/assets.rb

@@ -0,0 +1,8 @@
+# Be sure to restart your server when you modify this file.
+
+# Version of your assets, change this if you want to expire all your assets.
+Rails.application.config.assets.version = '1.0'
+
+# Precompile additional assets.
+# application.js, application.css, and all non-JS/CSS in app/assets folder are already added.
+# Rails.application.config.assets.precompile += %w( search.js )

data/spec/rails_app/config/initializers/cookies_serializer.rb

@@ -0,0 +1,3 @@
+# Be sure to restart your server when you modify this file.
+
+Rails.application.config.action_dispatch.cookies_serializer = :json

data/spec/rails_app/config/initializers/filter_parameter_logging.rb

@@ -0,0 +1,4 @@
+# Be sure to restart your server when you modify this file.
+
+# Configure sensitive parameters which will be filtered from the log file.
+Rails.application.config.filter_parameters += [:password]

data/spec/rails_app/config/initializers/session_store.rb

@@ -0,0 +1,3 @@
+# Be sure to restart your server when you modify this file.
+
+Rails.application.config.session_store :cookie_store, key: '_dummy_session'

data/spec/rails_app/config/initializers/wrap_parameters.rb

@@ -0,0 +1,9 @@
+# Be sure to restart your server when you modify this file.
+
+# This file contains settings for ActionController::ParamsWrapper which
+# is enabled by default.
+
+# Enable parameter wrapping for JSON. You can disable this by setting :format to an empty array.
+ActiveSupport.on_load(:action_controller) do
+  wrap_parameters format: [:json] if respond_to?(:wrap_parameters)
+end

data/spec/rails_app/config/routes.rb

@@ -0,0 +1,56 @@
+Rails.application.routes.draw do
+  # The priority is based upon order of creation: first created -> highest priority.
+  # See how all your routes lay out with "rake routes".
+
+  # You can have the root of your site routed with "root"
+  # root 'welcome#index'
+
+  # Example of regular route:
+  #   get 'products/:id' => 'catalog#view'
+
+  # Example of named route that can be invoked with purchase_url(id: product.id)
+  #   get 'products/:id/purchase' => 'catalog#purchase', as: :purchase
+
+  # Example resource route (maps HTTP verbs to controller actions automatically):
+  #   resources :products
+
+  # Example resource route with options:
+  #   resources :products do
+  #     member do
+  #       get 'short'
+  #       post 'toggle'
+  #     end
+  #
+  #     collection do
+  #       get 'sold'
+  #     end
+  #   end
+
+  # Example resource route with sub-resources:
+  #   resources :products do
+  #     resources :comments, :sales
+  #     resource :seller
+  #   end
+
+  # Example resource route with more complex sub-resources:
+  #   resources :products do
+  #     resources :comments
+  #     resources :sales do
+  #       get 'recent', on: :collection
+  #     end
+  #   end
+
+  # Example resource route with concerns:
+  #   concern :toggleable do
+  #     post 'toggle'
+  #   end
+  #   resources :posts, concerns: :toggleable
+  #   resources :photos, concerns: :toggleable
+
+  # Example resource route within a namespace:
+  #   namespace :admin do
+  #     # Directs /admin/products/* to Admin::ProductsController
+  #     # (app/controllers/admin/products_controller.rb)
+  #     resources :products
+  #   end
+end