sidekiq_mailer 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.rvmrc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Anderson Dias
+
+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,29 @@
+# Sidekiq::Mailer
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sidekiq_mailer'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sidekiq_mailer
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,14 @@
+#!/usr/bin/env rake
+# encoding: UTF-8
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc "Run tests"
+task :default => :test

data/lib/sidekiq_mailer.rb

@@ -0,0 +1,48 @@
+require 'sidekiq_mailer/version'
+require 'sidekiq_mailer/worker'
+require 'sidekiq_mailer/proxy'
+
+module Sidekiq
+  module Mailer
+    def self.included(base)
+      base.extend(ClassMethods)
+      base.class_attribute :sidekiq_options_hash
+    end
+
+    module ClassMethods
+      ##
+      # Allows customization for this type of Worker.
+      # Legal options:
+      #
+      #   :queue - use a named queue for this Worker, default 'default'
+      #   :retry - enable the RetryJobs middleware for this Worker, default *true*
+      #   :timeout - timeout the perform method after N seconds, default *nil*
+      #   :backtrace - whether to save any error backtrace in the retry payload to display in web UI,
+      #      can be true, false or an integer number of lines to save, default *false*
+      def sidekiq_options(opts={})
+        self.sidekiq_options_hash = get_sidekiq_options.merge(stringify_keys(opts || {}))
+      end
+
+      DEFAULT_OPTIONS = { 'retry' => false, 'queue' => 'mailer' }
+
+      def get_sidekiq_options # :nodoc:
+        self.sidekiq_options_hash ||= DEFAULT_OPTIONS
+      end
+
+      def stringify_keys(hash) # :nodoc:
+        hash.keys.each do |key|
+          hash[key.to_s] = hash.delete(key)
+        end
+        hash
+      end
+
+      def method_missing(method_name, *args)
+        if action_methods.include?(method_name.to_s)
+          Sidekiq::Mailer::Proxy.new(self, method_name, *args)
+        else
+          super
+        end
+      end
+    end
+  end
+end

data/lib/sidekiq_mailer/proxy.rb

@@ -0,0 +1,53 @@
+class Sidekiq::Mailer::Proxy
+  delegate :to_s, :to => :actual_message
+
+  def initialize(mailer_class, method_name, *args)
+    @mailer_class = mailer_class
+    @method_name = method_name
+    *@args = *args
+  end
+
+  def actual_message
+    @actual_message ||= @mailer_class.send(:new, @method_name, *@args).message
+  end
+
+  def deliver
+    params = {
+      'class' => Sidekiq::Mailer::Worker,
+      'args' => [@mailer_class.to_s, @method_name, *@args]
+    }
+    Sidekiq::Mailer::Worker.client_push(params.merge(@mailer_class.get_sidekiq_options))
+  end
+
+  # def deliver_at(time)
+  #   return deliver! if environment_excluded?
+
+  #   unless resque.respond_to? :enqueue_at
+  #     raise "You need to install resque-scheduler to use deliver_at"
+  #   end
+
+  #   if @mailer_class.deliver?
+  #     resque.enqueue_at(time, @mailer_class, @method_name, *@args)
+  #   end
+  # end
+
+  # def deliver_in(time)
+  #   return deliver! if environment_excluded?
+
+  #   unless resque.respond_to? :enqueue_in
+  #     raise "You need to install resque-scheduler to use deliver_in"
+  #   end
+
+  #   if @mailer_class.deliver?
+  #     resque.enqueue_in(time, @mailer_class, @method_name, *@args)
+  #   end
+  # end
+
+  def deliver!
+    actual_message.deliver!
+  end
+
+  def method_missing(method_name, *args)
+    actual_message.send(method_name, *args)
+  end
+end

data/lib/sidekiq_mailer/version.rb

@@ -0,0 +1,5 @@
+module Sidekiq
+  module Mailer
+    VERSION = "0.0.1"
+  end
+end

data/lib/sidekiq_mailer/worker.rb

@@ -0,0 +1,7 @@
+class Sidekiq::Mailer::Worker
+  include Sidekiq::Worker
+
+  def perform(mailer_class, action, params)
+    mailer_class.constantize.send(action, *params).deliver!
+  end
+end

data/sidekiq_mailer.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/sidekiq_mailer/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Anderson Dias"]
+  gem.email         = ["andersondaraujo@gmail.com"]
+  gem.description   = %q{Asynchronous mail delivery using sidekiq}
+  gem.summary       = %q{Turning ActiveMailer deliveries asynchronous using the power of sidekiq}
+  gem.homepage      = "http://github.com/andersondias/sidekiq_mailer"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "sidekiq_mailer"
+  gem.require_paths = ["lib"]
+  gem.version       = Sidekiq::Mailer::VERSION
+
+  gem.add_dependency("activesupport", "~> 3.0")
+  gem.add_dependency("actionmailer", "~> 3.0")
+  gem.add_dependency("sidekiq", "~> 2.3")
+end

data/test/sidekiq_mailer_test.rb

@@ -0,0 +1,68 @@
+require 'test_helper'
+
+class BasicMailer < ActionMailer::Base
+  include Sidekiq::Mailer
+
+  default :from => "from@example.org", :subject => "Subject"
+
+  def welcome(to)
+    mail(to: to)
+  end
+
+  def hi(to, name)
+    mail(to: to)
+  end
+end
+
+class MailerInAnotherQueue < ActionMailer::Base
+  include Sidekiq::Mailer
+  sidekiq_options queue: 'priority', retry: 'false'
+
+  default :from => "from@example.org", :subject => "Subject"
+
+  def bye(to)
+    mail(to: to)
+  end
+end
+
+class SidekiqMailerTest < Test::Unit::TestCase
+  def setup
+    ActionMailer::Base.deliveries.clear
+    Sidekiq::Mailer::Worker.jobs.clear
+  end
+
+  def test_queue_a_new_job
+    BasicMailer.hi('test@test.com', 'Tester').deliver
+
+    job_args = Sidekiq::Mailer::Worker.jobs.first['args']
+    expected_args = ['BasicMailer', :hi, 'test@test.com', 'Tester']
+    assert_equal expected_args, job_args
+  end
+
+  def test_queues_at_mailer_queue_by_default
+    BasicMailer.welcome('test@test.com').deliver
+    assert_equal 'mailer', Sidekiq::Mailer::Worker.jobs.first['queue']
+  end
+
+  def test_enables_sidekiq_options_overriding
+    MailerInAnotherQueue.bye('test@test.com').deliver
+    assert_equal 'priority', Sidekiq::Mailer::Worker.jobs.first['queue']
+    assert_equal 'false', Sidekiq::Mailer::Worker.jobs.first['retry']
+  end
+
+  def test_delivers_asynchronously
+    BasicMailer.welcome('test@test.com').deliver
+    assert_equal 1, Sidekiq::Mailer::Worker.jobs.size
+    assert_equal 0, ActionMailer::Base.deliveries.size
+  end
+
+  def test_can_deliver_now
+    BasicMailer.welcome('test@test.com').deliver!
+    assert_equal 1, ActionMailer::Base.deliveries.size
+  end
+
+  def test_realy_delivers_email_when_performing_worker_job
+    Sidekiq::Mailer::Worker.new.perform('BasicMailer', 'welcome', 'test@test.com')
+    assert_equal 1, ActionMailer::Base.deliveries.size
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+ENV['RACK_ENV'] = ENV['RAILS_ENV'] = 'test'
+require 'test/unit'
+
+require 'action_mailer'
+ActionMailer::Base.delivery_method = :test
+
+require 'sidekiq'
+require 'sidekiq/testing'
+
+require 'sidekiq_mailer'

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq_mailer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Anderson Dias
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: actionmailer
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.3'
+description: Asynchronous mail delivery using sidekiq
+email:
+- andersondaraujo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/sidekiq_mailer.rb
+- lib/sidekiq_mailer/proxy.rb
+- lib/sidekiq_mailer/version.rb
+- lib/sidekiq_mailer/worker.rb
+- sidekiq_mailer.gemspec
+- test/sidekiq_mailer_test.rb
+- test/test_helper.rb
+homepage: http://github.com/andersondias/sidekiq_mailer
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Turning ActiveMailer deliveries asynchronous using the power of sidekiq
+test_files:
+- test/sidekiq_mailer_test.rb
+- test/test_helper.rb