resque_mailer 2.1.0 → 2.2.0

data/CHANGELOG.md

@@ -1,4 +1,10 @@
-### 2.1.0 / 2012-02-17
+### 2.2.0 / 2012-12-01
+* Added logging for failed deliveries (Mike Swieton)
+* Fixed / preserved exceptions for template renders (Sidharth Shanker)
+* Add `deliver_at` and `deliver_in` methods for scheduling mail in the
+  future if resque-scheduler is installed (Harry Marr)
+
+### 2.1.0 / 2012-06-09
 
 * Message decoy acts more like a real message (to\_s)
 * Removed jeweler as a dependency (managing gem directly via Bundler)

data/README.md

@@ -15,7 +15,7 @@ Include Resque::Mailer in your ActionMailer subclass(es) like this:
       include Resque::Mailer
     end
 
-Now, when <tt>MyMailer.subject_email(params).deliver</tt> is called, an entry
+Now, when `MyMailer.subject_email(params).deliver` is called, an entry
 will be created in the job queue. Your Resque workers will be able to deliver
 this message for you. The queue we're using is imaginatively named +mailer+,
 so just make sure your workers know about it and are loading your environment:
@@ -33,8 +33,8 @@ 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.
 
-If you want to set a different default queue name for your mailer, you can 
-change the <tt>default_queue_name</tt> property like so:
+If you want to set a different default queue name for your mailer, you can
+change the `default_queue_name` property like so:
 
     # config/initializers/resque_mailer.rb
     Resque::Mailer.default_queue_name = 'application_specific_mailer'
@@ -45,6 +45,19 @@ name when starting your workers.
 
     QUEUE=application_specific_mailer rake environment resque:work
 
+### Using with Resque Scheduler
+
+If [resque-scheduler](https://github.com/bvandenbos/resque-scheduler) is
+installed, two extra methods will be available: `deliver_at` and `deliver_in`.
+These will enqueue mail for delivery at a specified time in the future.
+
+    # Delivers on the 25th of December, 2013
+    MyMailer.reminder_email(params).deliver_at(Time.parse('2013-12-25'))
+
+    # Delivers in 7 days
+    MyMailer.reminder_email(params).deliver_in(7.days)
+
+
 ## Resque::Mailer as a Project Default
 
 If you have a variety of mailers in your application and want all of them to use
@@ -81,6 +94,11 @@ configure the environments that should be excluded like so:
     # config/initializers/resque_mailer.rb
     Resque::Mailer.excluded_environments = [:test, :cucumber]
 
+Note: Define `current_env` if using Resque::Mailer in a non-Rails project:
+
+    Resque::Mailer.current_env = :production
+
+
 ## Note on Patches / Pull Requests
 
 * Fork the project.

data/lib/resque_mailer.rb

@@ -3,7 +3,7 @@ require 'resque_mailer/version'
 module Resque
   module Mailer
     class << self
-      attr_accessor :default_queue_name, :default_queue_target, :current_env
+      attr_accessor :default_queue_name, :default_queue_target, :current_env, :logger
       attr_reader :excluded_environments
 
       def excluded_environments=(envs)
@@ -15,6 +15,7 @@ module Resque
       end
     end
 
+    self.logger = nil
     self.default_queue_target = ::Resque
     self.default_queue_name = "mailer"
     self.excluded_environments = [:test]
@@ -29,8 +30,6 @@ module Resque
       end
 
       def method_missing(method_name, *args)
-        return super if environment_excluded?
-
         if action_methods.include?(method_name.to_s)
           MessageDecoy.new(self, method_name, *args)
         else
@@ -39,11 +38,16 @@ module Resque
       end
 
       def perform(action, *args)
-        self.send(:new, action, *args).message.deliver
-      end
-
-      def environment_excluded?
-        !ActionMailer::Base.perform_deliveries || excluded_environment?(current_env)
+        begin
+          self.send(:new, action, *args).message.deliver
+        rescue Exception => ex
+          if logger
+            logger.error "Unable to deliver email [#{action}]: #{ex}"
+            logger.error ex.backtrace.join("\n\t")
+          end
+          
+          raise ex
+        end
       end
 
       def queue
@@ -80,16 +84,54 @@ module Resque
         ::Resque::Mailer.default_queue_target
       end
 
+      def current_env
+        ::Rails.env
+      end
+
+      def environment_excluded?
+        !ActionMailer::Base.perform_deliveries || excluded_environment?(current_env)
+      end
+
+      def excluded_environment?(name)
+        ::Resque::Mailer.excluded_environments && ::Resque::Mailer.excluded_environments.include?(name.to_sym)
+      end
+
       def actual_message
         @actual_message ||= @mailer_class.send(:new, @method_name, *@args).message
       end
 
       def deliver
+        return deliver! if environment_excluded?
+
         if @mailer_class.deliver?
           resque.enqueue(@mailer_class, @method_name, *@args)
         end
       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

data/lib/resque_mailer/version.rb

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

metadata

@@ -1,80 +1,74 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: resque_mailer
-version: !ruby/object:Gem::Version 
-  hash: 11
+version: !ruby/object:Gem::Version
+  version: 2.2.0
   prerelease: 
-  segments: 
-  - 2
-  - 1
-  - 0
-  version: 2.1.0
 platform: ruby
-authors: 
+authors:
 - Nick Plante
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-06-10 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
+date: 2012-12-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionmailer
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 3
-        - 0
-        version: "3.0"
-  requirement: *id001
-  prerelease: false
-  name: actionmailer
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :runtime
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 15
-        segments: 
-        - 2
-        - 6
-        version: "2.6"
-  requirement: *id002
-  prerelease: false
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
   name: rspec
-  type: :development
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 0
-        - 6
-        - 0
-        version: 0.6.0
-  requirement: *id003
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
   name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.6.0
   type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.6.0
 description: Rails plugin for sending asynchronous email with ActionMailer and Resque.
-email: 
+email:
 - nap@zerosum.org
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - LICENSE
 - CHANGELOG.md
 - README.md
-files: 
+files:
 - lib/resque_mailer/version.rb
 - lib/resque_mailer.rb
 - README.md
@@ -82,36 +76,32 @@ files:
 - CHANGELOG.md
 homepage: http://github.com/zapnap/resque_mailer
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: 1935343156117809086
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
+      hash: 1935343156117809086
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.9
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Rails plugin for sending asynchronous email with ActionMailer and Resque.
 test_files: []
-