multi_smtp_plus 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b7a68d98408ad8a680dc88eff1216c7e0e223a95f89c8e81bb67b27568617a15
+  data.tar.gz: 0e5385bcf46760c3bffe44280ba11a5f059812c06e9dac9268dfa82cb960bacf
+SHA512:
+  metadata.gz: cfbbda22636aa8c6b70ca16729715068aea67d1530796bf664b886231291751dbe061c1ce10cecca05c8027d80e1b59a76e9e9078dc3fc24116a85dadaa77326
+  data.tar.gz: 461308cb9502a676d3b500c41312fbd6954689694440d4673c7be29be3b30adeba6d0f66e4085efc5daa23c65411190815f48539a72320bf873b26139ed5b713

data/.gitignore

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

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,130 @@
+# MultiSMTP
+
+Email delivery is a critical component of many web applications. Occasionally
+third-party services can experience temporary downtime. We can achieve automatic failover by overriding the default email delivery method with MultiSMTP.
+
+MultiSMTP takes an array of (1..N) SMTP providers and will iterate over each provider until the email is successfully sent.
+
+## Compatibility
+
+- Ruby 3.1–3.3
+- Rails 6.1, 7.x, 8.0+
+- Mail >= 2.7, < 3.0
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "multi_smtp_plus"
+```
+
+Then bundle:
+
+```
+$ bundle
+```
+
+## Configuration
+
+Set the delivery method to `:multi_smtp` for each environment that should use
+the automatic failover. Registration is lazy via `ActiveSupport.on_load(:action_mailer)`.
+
+```ruby
+# config/environments/{staging,production}.rb
+Rails.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
+
+# Optional: choose how providers are ordered for each delivery
+# :sequential (default) or :round_robin
+MultiSMTP.rotation_strategy = :round_robin
+
+# Optional: provide a state store for cross-process round robin
+# It must respond to `#incr(key)` and return an Integer. Example using Redis:
+# MultiSMTP.state_store = Redis.new
+
+sendgrid_settings = {
+  address: 'smtp.sendgrid.net',
+  authentication: :plain,
+  domain: 'example.com',
+  password: ENV['SENDGRID_PASSWORD'],
+  port: 587,
+  user_name: ENV['SENDGRID_USERNAME'],
+  # Optional: dynamically skip this provider when a condition is met
+  # e.g., free-tier quota exhausted
+  skip_if: -> { ENV['SENDGRID_QUOTA_EXHAUSTED'] == '1' }
+}
+
+mailgun_settings = {
+  address: 'smtp.mailgun.org',
+  authentication: :plain,
+  domain: 'example.com',
+  password: ENV['MAILGUN_PASSWORD'],
+  port: 587,
+  user_name: ENV['MAILGUN_USERNAME'],
+  # Example: skip based on a runtime counter (e.g., Redis)
+  # skip_if: -> { Redis.current.get('mailgun:monthly_count').to_i > 990 }
+}
+
+MultiSMTP.smtp_providers = [sendgrid_settings, mailgun_settings]
+```
+
+### Switching between free tiers (never pay for email)
+
+Use either or both of the following:
+
+- **Round-robin rotation**: spreads deliveries among providers so you consume free quotas evenly.
+- **Per-provider `skip_if`**: a Proc/lambda evaluated before attempting a delivery. Return true to skip a provider (e.g., when you detect free-tier quota is exhausted).
+
+For cross-process/app-server rotation, configure `MultiSMTP.state_store` with a Redis-like store that implements `#incr(key)`.
+
+## Error Notifications
+
+If all SMTP providers fail the default behavior is to re-raise the original exception.
+However, we can also specify custom notifications.
+
+```ruby
+# config/initializers/multi_smtp.rb
+require "multi_smtp/notifiers/airbrake"
+
+MultiSMTP.error_notifier = MultiSMTP::Notifiers::Airbrake
+```
+
+If there is another type of notification you'd like to receive, you can create a
+new notifier that implements the class method `.notify(exception, mail)`.
+
+```ruby
+class MyCustomNotifier
+  def self.notify(exception, mail)
+    # send to your observability tool, log with context, etc.
+  end
+end
+
+MultiSMTP.error_notifier = MyCustomNotifier
+```
+
+See the [Airbrake Notifier](lib/multi_smtp/notifiers/airbrake.rb) for more details.
+
+## Migration from <= 0.0.2
+
+- Notifier signature changed from `notify(mail)` to `notify(exception, mail)` to provide error context.
+- Added `MultiSMTP.rotation_strategy` and `MultiSMTP.state_store` for provider ordering.
+- Added per-provider `:skip_if` Proc for dynamic skipping (useful for free-tier quotas).
+- Rails registration is now lazy via `ActiveSupport.on_load(:action_mailer)`.
+- Runtime dependency updated to `mail >= 2.7, < 3` for Rails 6–8 compatibility.
+
+## Contributing
+
+1. Fork it ( https://github.com/harlow/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,78 @@
+require "mail"
+
+module MultiSMTP
+  class Mail < Mail::SMTP
+    def initialize(default_settings)
+      @default_settings = default_settings || {}
+      super(@default_settings)
+    end
+
+    def deliver!(mail)
+      providers = ordered_providers
+
+      providers.each_with_index do |smtp_provider, index|
+        self.settings = default_settings.merge(smtp_provider)
+
+        begin
+          super(mail)
+          break
+        rescue Exception => e
+          next unless all_providers_failed?(index, providers)
+
+          if error_notifier
+            # Pass the exception and the mail to the notifier
+            error_notifier.notify(e, mail)
+          else
+            raise e
+          end
+        end
+      end
+    end
+
+    private
+
+    def ordered_providers
+      case MultiSMTP.rotation_strategy
+      when :round_robin
+        rotate_round_robin(MultiSMTP.smtp_providers.dup)
+      else
+        MultiSMTP.smtp_providers.dup
+      end
+    end
+
+    def rotate_round_robin(list)
+      return list if list.empty? || list.size == 1
+
+      # Cross-process if state_store provided, else per-process fallback
+      start_idx = if (store = MultiSMTP.state_store)
+        store.incr("multi_smtp:rr:index") % list.size
+      else
+        self.class.__per_process_counter = (self.class.__per_process_counter + 1) % list.size
+      end
+
+      list.rotate(start_idx)
+    end
+
+    def self.__per_process_counter
+      @__per_process_counter ||= 0
+    end
+
+    def self.__per_process_counter=(val)
+      @__per_process_counter = val
+    end
+
+    def smtp_providers
+      @smtp_providers ||= MultiSMTP.smtp_providers
+    end
+
+    def error_notifier
+      @error_notifier ||= MultiSMTP.error_notifier
+    end
+
+    def all_providers_failed?(index, providers)
+      (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(exception, mail)
+        ::Airbrake.notify(exception,
+          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 = "1.0.0"
+end

data/lib/multi_smtp.rb

@@ -0,0 +1,51 @@
+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
+
+  # Optional rotation strategy for provider ordering. Supported: :sequential (default), :round_robin
+  def self.rotation_strategy=(strategy)
+    @rotation_strategy = strategy
+  end
+
+  def self.rotation_strategy
+    @rotation_strategy || :sequential
+  end
+
+  # Optional state store for cross-process round robin. Must respond to :incr(key) and return an Integer
+  # Example: a thin wrapper around Redis INCR. If nil, round_robin falls back to per-process rotation.
+  def self.state_store=(store)
+    @state_store = store
+  end
+
+  def self.state_store
+    @state_store
+  end
+end
+
+if defined?(Rails)
+  begin
+    require "active_support"
+    ActiveSupport.on_load(:action_mailer) do
+      ActionMailer::Base.add_delivery_method(:multi_smtp, MultiSMTP::Mail)
+    end
+  rescue LoadError
+    # Fallback for environments without ActiveSupport loaded early
+    ActionMailer::Base.add_delivery_method(:multi_smtp, MultiSMTP::Mail) if defined?(ActionMailer)
+  end
+end

data/multi_smtp.gemspec

@@ -0,0 +1,34 @@
+# 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_plus"
+  spec.version       = MultiSMTP::VERSION
+  spec.authors       = ["Harlow Ward", "Sunwoo Yang"]
+  spec.email         = ["harlow@hward.com", "yangsunwoo@gmail.com"]
+  spec.summary       = %q{Automatic SMTP email failover in Rails with MultiSMTP}
+  spec.description   = %q{MultiSMTP Plus provides automatic SMTP failover and rotation across multiple providers for Rails (6–8). It supports sequential or round-robin rotation and per-provider skip conditions (e.g., free-tier quota checks), with optional cross-process state via Redis.}
+  spec.homepage      = "https://github.com/woosunwoo/multi_smtp"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 3.1"
+  spec.metadata = {
+    "homepage_uri" => spec.homepage,
+    "source_code_uri" => spec.homepage,
+    "changelog_uri" => File.join(spec.homepage, "releases")
+  }
+
+  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"]
+
+  # Mail 2.7–2.8 are used by Rails 6–8
+  spec.add_runtime_dependency "mail", ">= 2.7", "< 3"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "pry", "~> 0.10"
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "rspec", "~> 3.10"
+end

data/spec/lib/multi_smtp/mail_spec.rb

@@ -0,0 +1,82 @@
+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
+    context "notifier is set" 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
+
+    context "notifier is not set" do
+      it "re-raises the original exception" do
+        MultiSMTP.error_notifier = nil
+        allow_any_instance_of(Net::SMTP).to receive(:start).
+          and_raise(Net::SMTPFatalError)
+
+        expect { MultiSMTP::Mail.new({}).deliver!(mail) }.to raise_exception
+      end
+    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,13 @@
+$LOAD_PATH << File.join(File.dirname(__FILE__), "..", "lib")
+$LOAD_PATH << File.join(File.dirname(__FILE__))
+
+require "rubygems"
+require "rspec"
+require "pry"
+require "multi_smtp"
+
+RSpec.configure do |config|
+  config.after :each do
+    MultiSMTP.smtp_providers = nil
+  end
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: multi_smtp_plus
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Harlow Ward
+- Sunwoo Yang
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-08-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+description: MultiSMTP Plus provides automatic SMTP failover and rotation across multiple
+  providers for Rails (6–8). It supports sequential or round-robin rotation and per-provider
+  skip conditions (e.g., free-tier quota checks), with optional cross-process state
+  via Redis.
+email:
+- harlow@hward.com
+- yangsunwoo@gmail.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/woosunwoo/multi_smtp
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/woosunwoo/multi_smtp
+  source_code_uri: https://github.com/woosunwoo/multi_smtp
+  changelog_uri: https://github.com/woosunwoo/multi_smtp/releases
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Automatic SMTP 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