multi_smtp 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8b4c0d11e7bf9ef7fdbe9599079af40962c5619f
+  data.tar.gz: 82f6f530e1025b1e87ddf17dc515dc052abaf79b
+SHA512:
+  metadata.gz: e4716c7ea2d5d1c583fd7eee596b21eb2bfdb20d5d24c5803dc64f94637b1a88db2ec4377bd25a9da75b33688f7ae1c7c920528fa72c4abb48c3928d23a59528
+  data.tar.gz: 091f3eff7730e6afd13a2d2fc777d0cc7d278c6b01f33afe314e9d6abd1fc7510bba12218556f4d3c9a590a684b30be8c7c1340587499802ea86e2a77956fc48

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in multi_smtp.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Harlow Ward
+
+MIT License
+
+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,60 @@
+# MultiSMTP
+
+Email delivery is a critical component of many web applications. Often
+third-party Email services can experience temporary downtime.
+
+We can achieve automatic failover by overriding the default delivery method with the
+MultiSMTP class.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "multi_smtp"
+```
+
+And then execute:
+
+    $ bundle
+
+## Configuration
+
+Set the delivery method to `:multi_smtp` for each environment that should use
+the automatic failover.
+
+```ruby
+# config/environments/{staging,production}.rb
+ExampleApp::Application.configure do
+  config.action_mailer.delivery_method = :multi_smtp
+end
+```
+
+In an initializer configure the MultiSMTP class with an array of (1..N) SMTP
+Providers.
+
+```ruby
+# config/initializers/multi_smtp.rb
+sendgrid_settings = {
+  address: 'smtp.sendgrid.net',
+  authentication: :plain,
+  domain: 'hoteltonight.com',
+  password: ENV['SENDGRID_PASSWORD'],
+  port: '587',
+  user_name: ENV['SENDGRID_USERNAME'],
+}
+
+other_smtp_settings = {
+  # Other SMTP settings
+}
+
+MultiSMTP.smtp_providers = [sendgrid_settings, other_smtp_settings]
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/multi_smtp/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/multi_smtp/mail.rb

@@ -0,0 +1,40 @@
+require "mail"
+
+module MultiSMTP
+  class Mail < Mail::SMTP
+    def initialize(default_settings)
+      @default_settings = default_settings
+    end
+
+    def deliver!(mail)
+      smtp_providers.each_with_index do |smtp_provider, index|
+        self.settings = default_settings.merge(smtp_provider)
+
+        begin
+          super(mail)
+          break
+        rescue Exception => e
+          if all_providers_failed?(index) && error_notifier
+            error_notifier.notify(mail)
+          end
+        end
+      end
+    end
+
+    private
+
+    def smtp_providers
+      @smtp_providers ||= MultiSMTP.smtp_providers
+    end
+
+    def error_notifier
+      @error_notifier ||= MultiSMTP.error_notifier
+    end
+
+    def all_providers_failed?(index)
+      (smtp_providers.size - 1) == index
+    end
+
+    attr_reader :default_settings
+  end
+end

data/lib/multi_smtp/notifiers/airbrake.rb

@@ -0,0 +1,21 @@
+module MultiSMTP
+  module Notifiers
+    module Airbrake
+      def self.notify(e, mail)
+        Airbrake.notify(e,
+          error_message: "Email delivery failed with all SMTP providers.",
+          parameters: { mail: extract_mail_params(mail) }
+        )
+      end
+
+      def self.extract_mail_params(mail)
+        {
+          delivery_handler: mail.delivery_handler.to_s,
+          from: mail.from,
+          subject: mail.subject,
+          to: mail.to
+        }
+      end
+    end
+  end
+end

data/lib/multi_smtp/version.rb

@@ -0,0 +1,3 @@
+module MultiSMTP
+  VERSION = "0.0.1"
+end

data/lib/multi_smtp.rb

@@ -0,0 +1,24 @@
+require "multi_smtp/mail"
+require "multi_smtp/version"
+
+module MultiSMTP
+  def self.error_notifier=(notifier)
+    @error_notifier = notifier
+  end
+
+  def self.error_notifier
+    @error_notifier || false
+  end
+
+  def self.smtp_providers=(providers)
+    @smtp_providers = providers
+  end
+
+  def self.smtp_providers
+    @smtp_providers || raise("MultiSMTP Error: Please specify smtp_providers.")
+  end
+end
+
+if defined?(Rails)
+  ActionMailer::Base.add_delivery_method(:multi_smtp, MultiSMTP::Mail)
+end

data/multi_smtp.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "multi_smtp/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "multi_smtp"
+  spec.version       = MultiSMTP::VERSION
+  spec.authors       = ["Harlow Ward"]
+  spec.email         = ["harlow@hward.com"]
+  spec.summary       = %q{Email failover in Rails with MultiSMTP}
+  spec.description   = %q{Email failover in Rails with MultiSMTP}
+  spec.homepage      = "https://github.com/harlow/multi_smtp"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "mail", "~> 2.6.3"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.1.0"
+end

data/spec/lib/multi_smtp/mail_spec.rb

@@ -0,0 +1,70 @@
+require "spec_helper"
+
+describe MultiSMTP::Mail, "#deliver!" do
+  let(:error_notifier) { double(:notifier) }
+
+  before do
+    allow(error_notifier).to receive(:notify)
+    MultiSMTP.error_notifier = error_notifier
+    MultiSMTP.smtp_providers = [
+      provider("smtp.sendgrid.net", "sendgrid"),
+      provider("smtp.amazaon_ses.com", "amazon_ses")
+    ]
+  end
+
+  context "primary email provider succeeds" do
+    it "sends an email" do
+      allow_any_instance_of(Net::SMTP).to receive(:start).and_return(true)
+
+      MultiSMTP::Mail.new({}).deliver!(mail)
+
+      expect(error_notifier).not_to have_received(:notify)
+    end
+  end
+
+  context "primary email provider fails" do
+    it "sends an email with secondary provider" do
+      allow_any_instance_of(Net::SMTP).to receive(:start).
+        with("test.com", "sendgrid", "password", :login).
+        and_raise(Net::SMTPFatalError)
+
+      allow_any_instance_of(Net::SMTP).to receive(:start).
+        with("test.com", "amazon_ses", "password", :login).
+        and_return(true)
+
+      MultiSMTP::Mail.new({}).deliver!(mail)
+
+      expect(error_notifier).to_not have_received(:notify)
+    end
+  end
+
+  context "all smtp providers fail" do
+    it "notifies airbrake" do
+      allow_any_instance_of(Net::SMTP).to receive(:start).
+        and_raise(Net::SMTPFatalError)
+
+      MultiSMTP::Mail.new({}).deliver!(mail)
+
+      expect(error_notifier).to have_received(:notify).once
+    end
+  end
+
+  def mail
+    Mail.new(
+      delivery_handler: "test",
+      from: "from@test.com",
+      subject: "test",
+      to: "to@test.com"
+    )
+  end
+
+  def provider(address, user_name)
+    {
+      address: address,
+      authentication: :login,
+      domain: "test.com",
+      password: "password",
+      user_name: user_name
+   }
+  end
+end

data/spec/lib/multi_smtp_spec.rb

@@ -0,0 +1,17 @@
+require "spec_helper"
+
+describe MultiSMTP, ".smtp_providers" do
+  it "returns an array of providers" do
+    MultiSMTP.smtp_providers = [:provider1, :provider2]
+
+    result = MultiSMTP.smtp_providers
+
+    expect(result).to eq [:provider1, :provider2]
+  end
+
+  context "no providers set" do
+    it "raises and exception" do
+      expect { MultiSMTP.smtp_providers }.to raise_exception
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH << File.join(File.dirname(__FILE__), "..", "lib")
+$LOAD_PATH << File.join(File.dirname(__FILE__))
+
+require "rubygems"
+require "rspec"
+require "multi_smtp"
+
+RSpec.configure do |config|
+  config.after :each do
+    MultiSMTP.smtp_providers = nil
+  end
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: multi_smtp
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Harlow Ward
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.3
+- !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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+description: Email failover in Rails with MultiSMTP
+email:
+- harlow@hward.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/multi_smtp.rb
+- lib/multi_smtp/mail.rb
+- lib/multi_smtp/notifiers/airbrake.rb
+- lib/multi_smtp/version.rb
+- multi_smtp.gemspec
+- spec/lib/multi_smtp/mail_spec.rb
+- spec/lib/multi_smtp_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/harlow/multi_smtp
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Email failover in Rails with MultiSMTP
+test_files:
+- spec/lib/multi_smtp/mail_spec.rb
+- spec/lib/multi_smtp_spec.rb
+- spec/spec_helper.rb