resque_mailer 2.0.3 → 2.1.0

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+### 2.1.0 / 2012-02-17
+
+* Message decoy acts more like a real message (to\_s)
+* Removed jeweler as a dependency (managing gem directly via Bundler)
+* Removed Resque dependency for compatibility with Resque forks
+  (mongo-resque, etc)
+* Add support for non-Rails applications (Fabio Kreusch)
+
 ### 2.0.3 / 2012-02-17
 
 * Added ability to override local queue name (example scenario: using
@@ -23,7 +31,7 @@
 
 ### 1.0.1 / 2010-12-21
 
-* Respect ActionMailer::Base.perform_deliveries
+* Respect ActionMailer::Base.perform\_deliveries
 
 ### v1.0.0 / 2010-07-28
 

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2011 Nick Plante
+Copyright (c) 2012 Nick Plante
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -27,8 +27,8 @@ method variant:
 
     MyMailer.subject_email(params).deliver!
 
-Oh, by the way. Don't forget that your async mailer jobs will be processed by
-a separate worker. This means that you should resist the temptation to pass
+Oh, by the way. Don't forget that **your async mailer jobs will be processed by
+a separate worker**. This means that you should resist the temptation to pass
 database-backed objects as parameters in your mailer and instead pass record
 identifiers. Then, in your delivery method, you can look up the record from
 the id and use it as needed.
@@ -92,6 +92,4 @@ configure the environments that should be excluded like so:
 
 ## Credits
 
-This work was originally inspired by delayed_job_mailer
-(http://github.com/andersondias/delayed_job_mailer) by Anderson Dias. Enhanced
-and modified to work with Resque by Nick Plante.
+Developed by Nick Plante with help from a number of [contributors](https://github.com/zapnap/resque_mailer/contributors).

data/lib/resque_mailer.rb

@@ -1,7 +1,9 @@
+require 'resque_mailer/version'
+
 module Resque
   module Mailer
     class << self
-      attr_accessor :default_queue_name, :default_queue_target
+      attr_accessor :default_queue_name, :default_queue_target, :current_env
       attr_reader :excluded_environments
 
       def excluded_environments=(envs)
@@ -19,7 +21,11 @@ module Resque
 
     module ClassMethods
       def current_env
-        ::Rails.env
+        if defined?(Rails)
+          ::Resque::Mailer.current_env || ::Rails.env
+        else
+          ::Resque::Mailer.current_env
+        end
       end
 
       def method_missing(method_name, *args)
@@ -53,7 +59,7 @@ module Resque
       end
 
       def excluded_environment?(name)
-        ::Resque::Mailer.excluded_environments && ::Resque::Mailer.excluded_environments.include?(name.to_sym)
+        ::Resque::Mailer.excluded_environments && ::Resque::Mailer.excluded_environments.include?(name.try(:to_sym))
       end
 
       def deliver?
@@ -62,6 +68,8 @@ module Resque
     end
 
     class MessageDecoy
+      delegate :to_s, :to => :actual_message
+
       def initialize(mailer_class, method_name, *args)
         @mailer_class = mailer_class
         @method_name = method_name

data/lib/resque_mailer/version.rb

@@ -0,0 +1,5 @@
+module Resque
+  module Mailer
+    VERSION = "2.1.0"
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: resque_mailer
 version: !ruby/object:Gem::Version 
-  hash: 9
+  hash: 11
   prerelease: 
   segments: 
   - 2
+  - 1
   - 0
-  - 3
-  version: 2.0.3
+  version: 2.1.0
 platform: ruby
 authors: 
 - Nick Plante
@@ -15,58 +15,40 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-02-17 00:00:00 Z
+date: 2012-06-10 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 25
-        segments: 
-        - 1
-        - 2
-        - 3
-        version: 1.2.3
-  requirement: *id001
-  prerelease: false
-  name: resque
-  type: :runtime
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
         hash: 7
         segments: 
         - 3
         - 0
-        - 0
-        version: 3.0.0
-  requirement: *id002
+        version: "3.0"
+  requirement: *id001
   prerelease: false
   name: actionmailer
   type: :runtime
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 23
+        hash: 15
         segments: 
         - 2
         - 6
-        - 0
-        version: 2.6.0
-  requirement: *id003
+        version: "2.6"
+  requirement: *id002
   prerelease: false
   name: rspec
   type: :development
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -77,114 +59,27 @@ dependencies:
         - 6
         - 0
         version: 0.6.0
-  requirement: *id004
+  requirement: *id003
   prerelease: false
   name: yard
   type: :development
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id005 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 23
-        segments: 
-        - 1
-        - 0
-        - 0
-        version: 1.0.0
-  requirement: *id005
-  prerelease: false
-  name: bundler
-  type: :development
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id006 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 11
-        segments: 
-        - 1
-        - 6
-        - 2
-        version: 1.6.2
-  requirement: *id006
-  prerelease: false
-  name: jeweler
-  type: :development
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id007 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 23
-        segments: 
-        - 2
-        - 6
-        - 0
-        version: 2.6.0
-  requirement: *id007
-  prerelease: false
-  name: rspec
-  type: :development
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id008 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 25
-        segments: 
-        - 1
-        - 2
-        - 3
-        version: 1.2.3
-  requirement: *id008
-  prerelease: false
-  name: resque
-  type: :development
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id009 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 3
-        - 0
-        - 0
-        version: 3.0.0
-  requirement: *id009
-  prerelease: false
-  name: actionmailer
-  type: :development
-description: Rails plugin for sending asynchronous email with ActionMailer and Resque
-email: nap@zerosum.org
+description: Rails plugin for sending asynchronous email with ActionMailer and Resque.
+email: 
+- nap@zerosum.org
 executables: []
 
 extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README.md
-files: 
-- .document
 - CHANGELOG.md
-- Gemfile
-- Gemfile.lock
-- LICENSE
 - README.md
-- Rakefile
-- VERSION
+files: 
+- lib/resque_mailer/version.rb
 - lib/resque_mailer.rb
-- rails/init.rb
-- resque_mailer.gemspec
-- spec/resque_mailer_spec.rb
-- spec/spec.opts
-- spec/spec_helper.rb
+- README.md
+- LICENSE
+- CHANGELOG.md
 homepage: http://github.com/zapnap/resque_mailer
 licenses: []
 
@@ -217,6 +112,6 @@ rubyforge_project:
 rubygems_version: 1.8.9
 signing_key: 
 specification_version: 3
-summary: Rails plugin for sending asynchronous email with ActionMailer and Resque
+summary: Rails plugin for sending asynchronous email with ActionMailer and Resque.
 test_files: []
 

data/.document

@@ -1,3 +0,0 @@
-README.rdoc
-lib/**/*.rb
-LICENSE

data/Gemfile

@@ -1,17 +0,0 @@
-source 'http://rubygems.org'
-
-# Add dependencies required to use your gem here.
-# Example:
-#   gem 'activesupport', '>= 2.3.5'
-
-gem 'resque', '>= 1.2.3'
-gem 'actionmailer', '>= 3.0.0'
-
-# Add dependencies to develop your gem here.
-# Include everything needed to run rake, tests, features, etc.
-group :development do
-  gem 'rspec', '>= 2.6.0'
-  gem 'yard', '>= 0.6.0'
-  gem 'bundler', '~> 1.0.0'
-  gem 'jeweler', '~> 1.6.2'
-end

data/Gemfile.lock

@@ -1,83 +0,0 @@
-GEM
-  remote: http://rubygems.org/
-  specs:
-    abstract (1.0.0)
-    actionmailer (3.0.9)
-      actionpack (= 3.0.9)
-      mail (~> 2.2.19)
-    actionpack (3.0.9)
-      activemodel (= 3.0.9)
-      activesupport (= 3.0.9)
-      builder (~> 2.1.2)
-      erubis (~> 2.6.6)
-      i18n (~> 0.5.0)
-      rack (~> 1.2.1)
-      rack-mount (~> 0.6.14)
-      rack-test (~> 0.5.7)
-      tzinfo (~> 0.3.23)
-    activemodel (3.0.9)
-      activesupport (= 3.0.9)
-      builder (~> 2.1.2)
-      i18n (~> 0.5.0)
-    activesupport (3.0.9)
-    builder (2.1.2)
-    diff-lcs (1.1.2)
-    erubis (2.6.6)
-      abstract (>= 1.0.0)
-    git (1.2.5)
-    i18n (0.5.0)
-    jeweler (1.6.2)
-      bundler (~> 1.0)
-      git (>= 1.2.5)
-      rake
-    json (1.5.3)
-    mail (2.2.19)
-      activesupport (>= 2.3.6)
-      i18n (>= 0.4.0)
-      mime-types (~> 1.16)
-      treetop (~> 1.4.8)
-    mime-types (1.16)
-    polyglot (0.3.1)
-    rack (1.2.3)
-    rack-mount (0.6.14)
-      rack (>= 1.0.0)
-    rack-test (0.5.7)
-      rack (>= 1.0)
-    rake (0.9.2)
-    redis (2.2.1)
-    redis-namespace (1.0.3)
-      redis (< 3.0.0)
-    resque (1.17.1)
-      json (>= 1.4.6, < 1.6)
-      redis-namespace (~> 1.0.2)
-      sinatra (>= 0.9.2)
-      vegas (~> 0.1.2)
-    rspec (2.6.0)
-      rspec-core (~> 2.6.0)
-      rspec-expectations (~> 2.6.0)
-      rspec-mocks (~> 2.6.0)
-    rspec-core (2.6.4)
-    rspec-expectations (2.6.0)
-      diff-lcs (~> 1.1.2)
-    rspec-mocks (2.6.0)
-    sinatra (1.2.6)
-      rack (~> 1.1)
-      tilt (>= 1.2.2, < 2.0)
-    tilt (1.3.2)
-    treetop (1.4.9)
-      polyglot (>= 0.3.1)
-    tzinfo (0.3.28)
-    vegas (0.1.8)
-      rack (>= 1.0.0)
-    yard (0.7.2)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  actionmailer (>= 3.0.0)
-  bundler (~> 1.0.0)
-  jeweler (~> 1.6.2)
-  resque (>= 1.2.3)
-  rspec (>= 2.6.0)
-  yard (>= 0.6.0)

data/Rakefile

@@ -1,45 +0,0 @@
-# encoding: utf-8
-
-require 'rubygems'
-require 'bundler'
-
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-
-require 'rake'
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "resque_mailer"
-    gem.summary = %Q{Rails plugin for sending asynchronous email with ActionMailer and Resque}
-    gem.description = %Q{Rails plugin for sending asynchronous email with ActionMailer and Resque}
-    gem.email = "nap@zerosum.org"
-    gem.homepage = "http://github.com/zapnap/resque_mailer"
-    gem.authors = ["Nick Plante"]
-    gem.add_development_dependency "rspec", ">= 2.6.0"
-    gem.add_development_dependency "resque", ">= 1.2.3"
-    gem.add_development_dependency "actionmailer", ">= 3.0.0"
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
-  end
-  Jeweler::RubygemsDotOrgTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
-end
-
-require 'rspec/core'
-require 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.pattern = ["spec/resque_mailer_spec.rb"]
-end
-
-task :default => :spec
-
-require 'yard'
-YARD::Rake::YardocTask.new

data/VERSION

@@ -1 +0,0 @@
-2.0.3

data/rails/init.rb

@@ -1 +0,0 @@
-require File.expand_path(File.join(File.dirname(__FILE__), '../lib', 'resque_mailer'))

data/resque_mailer.gemspec

@@ -1,76 +0,0 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
-# -*- encoding: utf-8 -*-
-
-Gem::Specification.new do |s|
-  s.name = %q{resque_mailer}
-  s.version = "2.0.3"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = [%q{Nick Plante}]
-  s.date = %q{2012-02-17}
-  s.description = %q{Rails plugin for sending asynchronous email with ActionMailer and Resque}
-  s.email = %q{nap@zerosum.org}
-  s.extra_rdoc_files = [
-    "LICENSE",
-    "README.md"
-  ]
-  s.files = [
-    ".document",
-    "CHANGELOG.md",
-    "Gemfile",
-    "Gemfile.lock",
-    "LICENSE",
-    "README.md",
-    "Rakefile",
-    "VERSION",
-    "lib/resque_mailer.rb",
-    "rails/init.rb",
-    "resque_mailer.gemspec",
-    "spec/resque_mailer_spec.rb",
-    "spec/spec.opts",
-    "spec/spec_helper.rb"
-  ]
-  s.homepage = %q{http://github.com/zapnap/resque_mailer}
-  s.require_paths = [%q{lib}]
-  s.rubygems_version = %q{1.8.9}
-  s.summary = %q{Rails plugin for sending asynchronous email with ActionMailer and Resque}
-
-  if s.respond_to? :specification_version then
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<resque>, [">= 1.2.3"])
-      s.add_runtime_dependency(%q<actionmailer>, [">= 3.0.0"])
-      s.add_development_dependency(%q<rspec>, [">= 2.6.0"])
-      s.add_development_dependency(%q<yard>, [">= 0.6.0"])
-      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_development_dependency(%q<jeweler>, ["~> 1.6.2"])
-      s.add_development_dependency(%q<rspec>, [">= 2.6.0"])
-      s.add_development_dependency(%q<resque>, [">= 1.2.3"])
-      s.add_development_dependency(%q<actionmailer>, [">= 3.0.0"])
-    else
-      s.add_dependency(%q<resque>, [">= 1.2.3"])
-      s.add_dependency(%q<actionmailer>, [">= 3.0.0"])
-      s.add_dependency(%q<rspec>, [">= 2.6.0"])
-      s.add_dependency(%q<yard>, [">= 0.6.0"])
-      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_dependency(%q<jeweler>, ["~> 1.6.2"])
-      s.add_dependency(%q<rspec>, [">= 2.6.0"])
-      s.add_dependency(%q<resque>, [">= 1.2.3"])
-      s.add_dependency(%q<actionmailer>, [">= 3.0.0"])
-    end
-  else
-    s.add_dependency(%q<resque>, [">= 1.2.3"])
-    s.add_dependency(%q<actionmailer>, [">= 3.0.0"])
-    s.add_dependency(%q<rspec>, [">= 2.6.0"])
-    s.add_dependency(%q<yard>, [">= 0.6.0"])
-    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-    s.add_dependency(%q<jeweler>, ["~> 1.6.2"])
-    s.add_dependency(%q<rspec>, [">= 2.6.0"])
-    s.add_dependency(%q<resque>, [">= 1.2.3"])
-    s.add_dependency(%q<actionmailer>, [">= 3.0.0"])
-  end
-end
-

data/spec/resque_mailer_spec.rb

@@ -1,110 +0,0 @@
-require File.join(File.expand_path(File.dirname(__FILE__)), 'spec_helper')
-
-class FakeResque
-  def self.enqueue(*args); end
-end
-
-class Rails3Mailer < ActionMailer::Base
-  include Resque::Mailer
-  default :from => "from@example.org", :subject => "Subject"
-  MAIL_PARAMS = { :to => "crafty@example.org" }
-
-  def test_mail(*params)
-    Resque::Mailer.success!
-    mail(*params)
-  end
-end
-
-class PriorityMailer < Rails3Mailer
-  self.queue = 'priority_mailer'
-end
-
-describe Resque::Mailer do
-  let(:resque) { FakeResque }
-
-  before do
-    Resque::Mailer.default_queue_target = resque
-    Resque::Mailer.stub(:success!)
-    Rails3Mailer.stub(:current_env => :test)
-  end
-
-  describe "resque" do
-    it "allows overriding of the default queue target (for testing)" do
-      Resque::Mailer.default_queue_target = FakeResque
-      Rails3Mailer.resque.should == FakeResque
-    end
-  end
-
-  describe "queue" do
-    it "defaults to the 'mailer' queue" do
-      Rails3Mailer.queue.should == "mailer"
-    end
-
-    it "allows overriding of the default queue name" do
-      Resque::Mailer.default_queue_name = "postal"
-      Rails3Mailer.queue.should == "postal"
-    end
-
-    it "allows overriding of the local queue name" do
-      PriorityMailer.queue.should == "priority_mailer"
-    end
-  end
-
-  describe '#deliver' do
-    before(:all) do
-      @delivery = lambda {
-        Rails3Mailer.test_mail(Rails3Mailer::MAIL_PARAMS).deliver
-      }
-    end
-
-    it 'should not deliver the email synchronously' do
-      lambda { @delivery.call }.should_not change(ActionMailer::Base.deliveries, :size)
-    end
-
-    it 'should place the deliver action on the Resque "mailer" queue' do
-      resque.should_receive(:enqueue).with(Rails3Mailer, :test_mail, Rails3Mailer::MAIL_PARAMS)
-      @delivery.call
-    end
-
-    context "when current env is excluded" do
-      it 'should not deliver through Resque for excluded environments' do
-        Resque::Mailer.stub(:excluded_environments => [:custom])
-        Rails3Mailer.should_receive(:current_env).and_return(:custom)
-        resque.should_not_receive(:enqueue)
-        @delivery.call
-      end
-    end
-
-    it 'should not invoke the method body more than once' do
-      Resque::Mailer.should_not_receive(:success!)
-      Rails3Mailer.test_mail(Rails3Mailer::MAIL_PARAMS).deliver
-    end
-  end
-
-  describe '#deliver!' do
-    it 'should deliver the email synchronously' do
-      lambda { Rails3Mailer.test_mail(Rails3Mailer::MAIL_PARAMS).deliver! }.should change(ActionMailer::Base.deliveries, :size).by(1)
-    end
-  end
-
-  describe 'perform' do
-    it 'should perform a queued mailer job' do
-      lambda {
-        Rails3Mailer.perform(:test_mail, Rails3Mailer::MAIL_PARAMS)
-      }.should change(ActionMailer::Base.deliveries, :size).by(1)
-    end
-  end
-
-  describe 'original mail methods' do
-    it 'should be preserved' do
-      Rails3Mailer.test_mail(Rails3Mailer::MAIL_PARAMS).subject.should == 'Subject'
-      Rails3Mailer.test_mail(Rails3Mailer::MAIL_PARAMS).from.should include('from@example.org')
-      Rails3Mailer.test_mail(Rails3Mailer::MAIL_PARAMS).to.should include('crafty@example.org')
-    end
-
-    it 'should require execution of the method body prior to queueing' do
-      Resque::Mailer.should_receive(:success!).once
-      Rails3Mailer.test_mail(Rails3Mailer::MAIL_PARAMS).subject
-    end
-  end
-end

data/spec/spec.opts

@@ -1 +0,0 @@
---color

data/spec/spec_helper.rb

@@ -1,9 +0,0 @@
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-
-require 'action_mailer'
-require 'resque_mailer'
-require 'rspec/autorun'
-
-Resque::Mailer.excluded_environments = []
-ActionMailer::Base.delivery_method = :test