sidekiq-mailer 0.1.0

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

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 Andre Arko
+
+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,46 @@
+# Sidekiq::Mailer
+
+This gem lets you send mail in the background using Sidekiq.
+
+## Installation
+
+Add the gem to your Gemfile:
+
+    gem 'sidekiq-mailer'
+
+If you're using Bundler 1.0, you'll need to tell Bundler the library file name:
+
+    gem 'sidekiq-mailer', :require => 'sidekiq/mailer'
+
+## Usage
+
+Install into your mailer:
+
+```ruby
+class BackgroundMailer < ActionMailer::Base
+  extend Sidekiq::Mailer
+
+  # optional queue name
+  # queue :mail
+
+  def send_mail(record)
+    mail :to => record.email
+  end
+end
+```
+
+Queue mail jobs using the DelayedJob background mail style:
+
+```ruby
+BackgroundMailer.delay.send_mail(record)
+```
+
+To actually your mail, run `sidekiq`. If you set your mail queue name to "mail", run `sidekiq -q mail` instead.
+
+## Caveats
+
+Right now, it only expects a single ActiveRecord instance as the argument passed to whatever email method you call. This could become a problem in the future, but it's working for me. If it's a problem for you, see the next section. :)
+
+## Contributing
+
+Please do, pull requests happily discussed and accepted.

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/sidekiq/mailer.rb

@@ -0,0 +1,25 @@
+require "sidekiq/mailer/version"
+require "sidekiq/mailer/proxy"
+require "sidekiq/mailer/worker"
+
+module Sidekiq
+  module Mailer
+
+    def delay
+      Proxy.new(self, @queue)
+    end
+
+    def queue(name)
+      @queue = name
+    end
+
+    def self.logger
+      @logger ||= defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
+    end
+
+    def self.logger=(logger)
+      @logger = logger
+    end
+
+  end
+end

data/lib/sidekiq/mailer/proxy.rb

@@ -0,0 +1,25 @@
+require "sidekiq/client"
+
+module Sidekiq
+  module Mailer
+    class Proxy
+
+      def initialize(mailer, queue = "default")
+        @mailer = mailer
+        @queue = queue
+      end
+
+      def method_missing(method, *args)
+        # assuming that mailer methods take a single AR record may bite us later
+        record = args.first
+        if @mailer.respond_to?(method)
+          Sidekiq::Client.push(@queue, "class" => "Sidekiq::Mailer::Worker",
+            "args" => [@mailer.to_s, method, record.class.to_s, record.id])
+        else
+          raise NoMethodError, "undefined method `#{method}' for #{@mailer}:#{@mailer.class}"
+        end
+      end
+
+    end
+  end
+end

data/lib/sidekiq/mailer/version.rb

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

data/lib/sidekiq/mailer/worker.rb

@@ -0,0 +1,24 @@
+require "sidekiq/worker"
+require "sidekiq/util"
+
+module Sidekiq
+  module Mailer
+    class Worker
+      include Sidekiq::Worker
+      include Sidekiq::Util
+
+      def perform(mailer_name, method_name, record_class, record_id)
+        record = constantize(record_class).find(record_id)
+        mailer = constantize(mailer_name)
+        mailer.send(:new, method_name, record).message.deliver
+      rescue => e
+        logger.warn "Could not call #{mailer_name}.#{method_name}. " \
+          "#{e.class}: #{e.message}"
+      end
+
+      def logger
+        Sidekiq::Mailer.logger
+      end
+    end
+  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       = ["André Arko"]
+  gem.email         = ["andre@arko.net"]
+  gem.description   = %q{Module for Rails mailers that sends the mail in the background. Adapted from the resque_mailer gem.}
+  gem.summary       = %q{Use Sidekiq to send Rails emails in the background}
+  gem.homepage      = "http://github.com/indirect/sidekiq-mailer"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "sidekiq-mailer"
+  gem.require_paths = ["lib"]
+  gem.version       = Sidekiq::Mailer::VERSION
+
+  gem.add_dependency "sidekiq", "~> 0.6"
+
+  gem.add_development_dependency "rspec", "~> 2.8.0"
+end

data/spec/sidekiq/mailer/proxy_spec.rb

@@ -0,0 +1,36 @@
+require "spec_helper"
+require "sidekiq/mailer/proxy"
+
+class FakeMailer
+  def self.send_mail(record)
+  end
+end
+
+describe Sidekiq::Mailer::Proxy do
+  let(:record){ mock("AR record", :class => "User", :id => 1) }
+
+  context "when called with an unknown method" do
+    it "raises an exception" do
+      expect { Sidekiq::Mailer::Proxy.new(FakeMailer).wot }.
+        should raise_error(NoMethodError)
+    end
+  end
+
+  context "when called with a mailer method" do
+    it "queues a job to call that mailer later" do
+      Sidekiq::Client.should_receive(:push).with("default",
+        "class" => "Sidekiq::Mailer::Worker",
+        "args" => ["FakeMailer", :send_mail, "User", 1])
+      Sidekiq::Mailer::Proxy.new(FakeMailer).send_mail(record)
+    end
+  end
+
+  context "when given a queue" do
+    it "adds the job to the given queue" do
+      Sidekiq::Client.should_receive(:push).with("mail",
+        "class" => "Sidekiq::Mailer::Worker",
+        "args" => ["FakeMailer", :send_mail, "User", 1])
+      Sidekiq::Mailer::Proxy.new(FakeMailer, "mail").send_mail(record)
+    end
+  end
+end

data/spec/sidekiq/mailer/worker_spec.rb

@@ -0,0 +1,18 @@
+require "spec_helper"
+require "sidekiq/mailer/worker"
+
+class FakeMailer; end
+class FakeUser; end
+
+describe Sidekiq::Mailer::Worker do
+  describe "#perform" do
+    let(:record){ mock("record") }
+
+    it "creates a mailer and sends the message" do
+      FakeUser.should_receive(:find).with(1).and_return(record)
+      FakeMailer.should_receive(:new).with(:send_mail, record)
+
+      subject.perform("FakeMailer", :send_mail, "FakeUser", 1)
+    end
+  end
+end

data/spec/sidekiq/mailer_spec.rb

@@ -0,0 +1,26 @@
+require "spec_helper"
+require "sidekiq/mailer"
+
+class FakeMailer
+  extend Sidekiq::Mailer
+end
+
+describe Sidekiq::Mailer do
+
+  describe "delay method" do
+    it "creates a new proxy" do
+      FakeMailer.delay.should be_a(Sidekiq::Mailer::Proxy)
+    end
+
+    context "when queue is set" do
+      before do
+        FakeMailer.queue(:mail)
+      end
+
+      it "passes proxy the queue name" do
+        Sidekiq::Mailer::Proxy.should_receive(:new).with(FakeMailer, :mail)
+        FakeMailer.delay
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+end
+
+require "sidekiq/mailer"
+require "stringio"
+require "logger"
+
+Sidekiq::Mailer.logger = Logger.new(StringIO.new)

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-mailer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- André Arko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: &70121008484240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70121008484240
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70121008483300 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: *70121008483300
+description: Module for Rails mailers that sends the mail in the background. Adapted
+  from the resque_mailer gem.
+email:
+- andre@arko.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- 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
+- spec/sidekiq/mailer/proxy_spec.rb
+- spec/sidekiq/mailer/worker_spec.rb
+- spec/sidekiq/mailer_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/indirect/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.10
+signing_key: 
+specification_version: 3
+summary: Use Sidekiq to send Rails emails in the background
+test_files:
+- spec/sidekiq/mailer/proxy_spec.rb
+- spec/sidekiq/mailer/worker_spec.rb
+- spec/sidekiq/mailer_spec.rb
+- spec/spec_helper.rb