├── .gitignore ├── .travis.yml ├── Gemfile ├── LICENSE ├── README.md ├── Rakefile ├── lib ├── sidekiq_mailer.rb └── sidekiq_mailer │ ├── proxy.rb │ ├── version.rb │ └── worker.rb ├── sidekiq_mailer.gemspec └── test ├── sidekiq_mailer_test.rb └── test_helper.rb /.gitignore: -------------------------------------------------------------------------------- 1 | *.gem 2 | *.rbc 3 | .bundle 4 | .config 5 | .yardoc 6 | .rvmrc 7 | Gemfile.lock 8 | InstalledFiles 9 | _yardoc 10 | coverage 11 | doc/ 12 | lib/bundler/man 13 | pkg 14 | rdoc 15 | spec/reports 16 | test/tmp 17 | test/version_tmp 18 | tmp 19 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | env: 2 | - "RAILS_VERSION=3.1.0" 3 | - "RAILS_VERSION=3.2.0" 4 | - "RAILS_VERSION=4.0.0" 5 | rvm: 6 | - 1.9.3 7 | - 2.0.0 8 | - jruby-19mode 9 | -------------------------------------------------------------------------------- /Gemfile: -------------------------------------------------------------------------------- 1 | source 'https://rubygems.org' 2 | 3 | # Specify your gem's dependencies in sidekiq_mailer.gemspec 4 | gemspec 5 | 6 | rails_version = ENV["RAILS_VERSION"] || "default" 7 | 8 | rails = case rails_version 9 | when "master" 10 | {github: "rails/rails"} 11 | when "default" 12 | "~> 3.2.0" 13 | else 14 | "~> #{rails_version}" 15 | end 16 | 17 | gem 'actionmailer', rails -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Copyright (c) 2012 Anderson Dias 2 | 3 | MIT License 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining 6 | a copy of this software and associated documentation files (the 7 | "Software"), to deal in the Software without restriction, including 8 | without limitation the rights to use, copy, modify, merge, publish, 9 | distribute, sublicense, and/or sell copies of the Software, and to 10 | permit persons to whom the Software is furnished to do so, subject to 11 | the following conditions: 12 | 13 | The above copyright notice and this permission notice shall be 14 | included in all copies or substantial portions of the Software. 15 | 16 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 17 | EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 18 | MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 19 | NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE 20 | LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION 21 | OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION 22 | WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Sidekiq::Mailer 2 | 3 | Sidekiq::Mailer adds to your ActionMailer classes the ability to send mails asynchronously. 4 | 5 | ## Usage 6 | 7 | If you want to make a specific mailer to work asynchronously just include Sidekiq::Mailer module: 8 | 9 | class MyMailer < ActionMailer::Base 10 | include Sidekiq::Mailer 11 | 12 | def welcome(to) 13 | ... 14 | end 15 | end 16 | 17 | Now every deliver you make with MyMailer will be asynchronous. 18 | 19 | # Queues the mail to be sent asynchronously by sidekiq 20 | MyMailer.welcome('your@email.com').deliver 21 | 22 | The default queue used by Sidekiq::Mailer is 'mailer'. So, in order to send mails with sidekiq you need to start a worker using: 23 | 24 | sidekiq -q mailer 25 | 26 | If you want to skip sidekiq you should use the 'deliver!' method: 27 | 28 | # Mail will skip sidekiq and will be sent synchronously 29 | MyMailer.welcome('your@email.com').deliver! 30 | 31 | By default Sidekiq::Mailer will retry to send an email if it failed. But you can [override sidekiq options](https://github.com/andersondias/sidekiq_mailer/wiki/Overriding-sidekiq-options) in your mailer. 32 | 33 | ## Installation 34 | 35 | Add this line to your application's Gemfile: 36 | 37 | gem 'sidekiq_mailer' 38 | 39 | And then execute: 40 | 41 | $ bundle 42 | 43 | Or install it yourself as: 44 | 45 | $ gem install sidekiq_mailer 46 | 47 | ## Testing 48 | 49 | Delayed e-mails is an awesome thing in production environments, but for e-mail specs/tests in testing environments it can be a mess causing specs/tests to fail because the e-mail haven't been sent directly. Therefore you can configure what environments that should be excluded like so: 50 | 51 | # config/initializers/sidekiq_mailer.rb 52 | Sidekiq::Mailer.excluded_environments = [:test, :cucumber] 53 | 54 | ## Contributing 55 | 56 | 1. Fork it 57 | 2. Create your feature branch (`git checkout -b my-new-feature`) 58 | 3. Commit your changes (`git commit -am 'Added some feature'`) 59 | 4. Push to the branch (`git push origin my-new-feature`) 60 | 5. Create new Pull Request 61 | -------------------------------------------------------------------------------- /Rakefile: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env rake 2 | # encoding: UTF-8 3 | require "bundler/gem_tasks" 4 | require 'rake/testtask' 5 | 6 | Rake::TestTask.new do |t| 7 | t.libs << 'lib' 8 | t.libs << 'test' 9 | t.pattern = 'test/**/*_test.rb' 10 | t.verbose = true 11 | end 12 | 13 | desc "Run tests" 14 | task :default => :test -------------------------------------------------------------------------------- /lib/sidekiq_mailer.rb: -------------------------------------------------------------------------------- 1 | require 'sidekiq_mailer/version' 2 | require 'sidekiq_mailer/worker' 3 | require 'sidekiq_mailer/proxy' 4 | 5 | module Sidekiq 6 | module Mailer 7 | @@excluded_environments = nil 8 | 9 | def self.excluded_environments=(envs) 10 | @@excluded_environments = [*envs].map { |e| e && e.to_sym } 11 | end 12 | 13 | def self.excluded_environments 14 | @@excluded_environments ||= [] 15 | end 16 | 17 | def self.current_env 18 | if defined?(Rails) 19 | ::Rails.env 20 | else 21 | ENV['RAILS_ENV'].to_s 22 | end 23 | end 24 | 25 | def self.excludes_current_environment? 26 | !ActionMailer::Base.perform_deliveries || (excluded_environments && excluded_environments.include?(current_env.to_sym)) 27 | end 28 | 29 | def self.included(base) 30 | base.extend(ClassMethods) 31 | base.class_attribute :sidekiq_options_hash 32 | end 33 | 34 | module ClassMethods 35 | ## 36 | # Allows customization for this type of Worker. 37 | # Legal options: 38 | # 39 | # :queue - use a named queue for this Worker, default 'mailer' 40 | # :retry - enable the RetryJobs middleware for this Worker, default *true* 41 | # :timeout - timeout the perform method after N seconds, default *nil* 42 | # :backtrace - whether to save any error backtrace in the retry payload to display in web UI, 43 | # can be true, false or an integer number of lines to save, default *false* 44 | def sidekiq_options(opts={}) 45 | self.sidekiq_options_hash = get_sidekiq_options.merge(stringify_keys(opts || {})) 46 | end 47 | 48 | DEFAULT_OPTIONS = { 'retry' => true, 'queue' => 'mailer' } 49 | 50 | def get_sidekiq_options # :nodoc: 51 | self.sidekiq_options_hash ||= DEFAULT_OPTIONS 52 | end 53 | 54 | def stringify_keys(hash) # :nodoc: 55 | hash.keys.each do |key| 56 | hash[key.to_s] = hash.delete(key) 57 | end 58 | hash 59 | end 60 | 61 | def method_missing(method_name, *args) 62 | if action_methods.include?(method_name.to_s) 63 | Sidekiq::Mailer::Proxy.new(self, method_name, *args) 64 | else 65 | super 66 | end 67 | end 68 | end 69 | end 70 | end 71 | -------------------------------------------------------------------------------- /lib/sidekiq_mailer/proxy.rb: -------------------------------------------------------------------------------- 1 | class Sidekiq::Mailer::Proxy 2 | delegate :to_s, :to => :actual_message 3 | 4 | def initialize(mailer_class, method_name, *args) 5 | @mailer_class = mailer_class 6 | @method_name = method_name 7 | *@args = *args 8 | end 9 | 10 | def actual_message 11 | @actual_message ||= @mailer_class.send(:new, @method_name, *@args).message 12 | end 13 | 14 | def deliver 15 | return deliver! if Sidekiq::Mailer.excludes_current_environment? 16 | Sidekiq::Mailer::Worker.client_push(to_sidekiq) 17 | end 18 | 19 | def excluded_environment? 20 | Sidekiq::Mailer.excludes_current_environment? 21 | end 22 | 23 | def deliver! 24 | actual_message.deliver 25 | end 26 | 27 | def method_missing(method_name, *args) 28 | actual_message.send(method_name, *args) 29 | end 30 | 31 | def to_sidekiq 32 | params = { 33 | 'class' => Sidekiq::Mailer::Worker, 34 | 'args' => [@mailer_class.to_s, @method_name, @args] 35 | } 36 | params.merge(@mailer_class.get_sidekiq_options) 37 | end 38 | end 39 | -------------------------------------------------------------------------------- /lib/sidekiq_mailer/version.rb: -------------------------------------------------------------------------------- 1 | module Sidekiq 2 | module Mailer 3 | VERSION = "0.0.8" 4 | end 5 | end 6 | -------------------------------------------------------------------------------- /lib/sidekiq_mailer/worker.rb: -------------------------------------------------------------------------------- 1 | class Sidekiq::Mailer::Worker 2 | include Sidekiq::Worker 3 | 4 | def perform(mailer_class, action, params) 5 | mailer_class.constantize.send(action, *params).deliver! 6 | end 7 | end 8 | -------------------------------------------------------------------------------- /sidekiq_mailer.gemspec: -------------------------------------------------------------------------------- 1 | # -*- encoding: utf-8 -*- 2 | require File.expand_path('../lib/sidekiq_mailer/version', __FILE__) 3 | 4 | Gem::Specification.new do |gem| 5 | gem.authors = ["Anderson Dias"] 6 | gem.email = ["andersondaraujo@gmail.com"] 7 | gem.description = %q{Asynchronous mail delivery using sidekiq} 8 | gem.summary = %q{Turning ActiveMailer deliveries asynchronous using the power of sidekiq} 9 | gem.homepage = "http://github.com/andersondias/sidekiq_mailer" 10 | gem.license = "MIT" 11 | 12 | gem.files = `git ls-files`.split($\) 13 | gem.executables = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) } 14 | gem.test_files = gem.files.grep(%r{^(test|spec|features)/}) 15 | gem.name = "sidekiq_mailer" 16 | gem.require_paths = ["lib"] 17 | gem.version = Sidekiq::Mailer::VERSION 18 | 19 | gem.add_dependency("activesupport", ">= 3.0") 20 | gem.add_dependency("actionmailer", ">= 3.0") 21 | gem.add_dependency("sidekiq", ">= 2.3") 22 | gem.add_development_dependency('rake') 23 | end 24 | -------------------------------------------------------------------------------- /test/sidekiq_mailer_test.rb: -------------------------------------------------------------------------------- 1 | require 'test_helper' 2 | 3 | class BasicMailer < ActionMailer::Base 4 | include Sidekiq::Mailer 5 | 6 | default :from => "from@example.org", :subject => "Subject" 7 | 8 | def welcome(to) 9 | mail(to: to) do |format| 10 | format.text { render :text => "Hello Mikel!" } 11 | format.html { render :text => "

Hello Mikel!

" } 12 | end 13 | end 14 | 15 | def hi(to, name) 16 | mail(to: to) do |format| 17 | format.text { render :text => "Hello Mikel!" } 18 | format.html { render :text => "

Hello Mikel!

" } 19 | end 20 | end 21 | end 22 | 23 | class MailerInAnotherQueue < ActionMailer::Base 24 | include Sidekiq::Mailer 25 | sidekiq_options queue: 'priority', retry: 'false' 26 | 27 | default :from => "from@example.org", :subject => "Subject" 28 | 29 | def bye(to) 30 | mail(to: to) 31 | end 32 | end 33 | 34 | class PreventSomeEmails 35 | def self.delivering_email(message) 36 | if message.to.include?("foo@example.com") 37 | message.perform_deliveries = false 38 | end 39 | end 40 | end 41 | 42 | ActionMailer::Base.register_interceptor(PreventSomeEmails) 43 | 44 | class SidekiqMailerTest < Test::Unit::TestCase 45 | def setup 46 | Sidekiq::Mailer.excluded_environments = [] 47 | ActionMailer::Base.deliveries.clear 48 | Sidekiq::Mailer::Worker.jobs.clear 49 | end 50 | 51 | def test_queue_a_new_job 52 | BasicMailer.hi('test@example.com', 'Tester').deliver 53 | 54 | job_args = Sidekiq::Mailer::Worker.jobs.first['args'] 55 | expected_args = ['BasicMailer', 'hi', ['test@example.com', 'Tester']] 56 | assert_equal expected_args, job_args 57 | end 58 | 59 | def test_queues_at_mailer_queue_by_default 60 | BasicMailer.welcome('test@example.com').deliver 61 | assert_equal 'mailer', Sidekiq::Mailer::Worker.jobs.first['queue'] 62 | end 63 | 64 | def test_default_sidekiq_options 65 | BasicMailer.welcome('test@example.com').deliver 66 | assert_equal 'mailer', Sidekiq::Mailer::Worker.jobs.first['queue'] 67 | assert_equal true, Sidekiq::Mailer::Worker.jobs.first['retry'] 68 | end 69 | 70 | def test_enables_sidekiq_options_overriding 71 | MailerInAnotherQueue.bye('test@example.com').deliver 72 | assert_equal 'priority', Sidekiq::Mailer::Worker.jobs.first['queue'] 73 | assert_equal 'false', Sidekiq::Mailer::Worker.jobs.first['retry'] 74 | end 75 | 76 | def test_delivers_asynchronously 77 | BasicMailer.welcome('test@example.com').deliver 78 | assert_equal 1, Sidekiq::Mailer::Worker.jobs.size 79 | assert_equal 0, ActionMailer::Base.deliveries.size 80 | end 81 | 82 | def test_can_deliver_now 83 | BasicMailer.welcome('test@example.com').deliver! 84 | assert_equal 1, ActionMailer::Base.deliveries.size 85 | end 86 | 87 | def test_really_delivers_email_when_performing_worker_job 88 | Sidekiq::Mailer::Worker.new.perform('BasicMailer', 'welcome', 'test@example.com') 89 | assert_equal 1, ActionMailer::Base.deliveries.size 90 | end 91 | 92 | def test_delivers_synchronously_if_running_in_a_excluded_environment 93 | Sidekiq::Mailer.excluded_environments = [:test] 94 | BasicMailer.welcome('test@example.com').deliver 95 | assert_equal 0, Sidekiq::Mailer::Worker.jobs.size 96 | assert_equal 1, ActionMailer::Base.deliveries.size 97 | end 98 | 99 | def test_does_not_ignore_interceptors_when_delivering_synchronously 100 | BasicMailer.welcome('foo@example.com').deliver! 101 | assert_equal 0, ActionMailer::Base.deliveries.size 102 | end 103 | 104 | def test_does_not_ignore_interceptors_when_delivering_asynchronously 105 | Sidekiq::Mailer::Worker.new.perform('BasicMailer', 'welcome', 'foo@example.com') 106 | assert_equal 0, ActionMailer::Base.deliveries.size 107 | end 108 | end 109 | -------------------------------------------------------------------------------- /test/test_helper.rb: -------------------------------------------------------------------------------- 1 | ENV['RACK_ENV'] = ENV['RAILS_ENV'] = 'test' 2 | require 'test/unit' 3 | 4 | require 'action_mailer' 5 | ActionMailer::Base.delivery_method = :test 6 | 7 | require 'sidekiq' 8 | require 'sidekiq/testing' 9 | 10 | require 'sidekiq_mailer' --------------------------------------------------------------------------------