resque_mailer 2.2.6 → 2.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 53a54447608a2968256ef39072f6308d1dbc2169
-  data.tar.gz: e9ff62895bacee201cca55e7f3cb5ed805302cb4
+  metadata.gz: 548d9708f6b7a14a37327ffb46f45576582ec6bf
+  data.tar.gz: 9e8be7d64d9ec61fe8b5448a1b7e5ab79ceb47a0
 SHA512:
-  metadata.gz: c49ea092064b92528689c38ac49eac32d1c0f451c4e56701a27ac0b3c713609d9bd6daaf1b0e1d6e2245c05168f2ae2dd84fa979d4ba6dfe7f06dca4fdf14de4
-  data.tar.gz: 6be3cbf5e72deba7c4950f22f01effb46e0c6f2a7a20a02b83eaca5be5218166f7bfead4ae8ed75b4050a7359b502091c2b4b192f2be0cb363fb54470da42c94
+  metadata.gz: 94c591b3103a3f56ba56243da5858cd18ef6666dfe15018298081d93de71e270426e76985f6fd4a62fbb1a8d1a13ad76a50404c8045261c5b185e94d74d882ee
+  data.tar.gz: 9f580508433f12a0c4ab1ba66ccbda30efd4e23cc27e82b5e6abe3183c8b4b32fa80d366e3939447f31407725c43c621652ed19f801b755b40e7b31c3c87f61a

data/CHANGELOG.md

@@ -1,5 +1,33 @@
-### EDGE / 2013-11-12
-* Add action and args as arguments to the error handler lambda for 
+### 2.4.3 / 2017-09-18
+* Fix for duplicated keys (J Garcia)
+
+### 2.4.2 / 2017-01-30
+* Fix for breaking change with symbolied keys vs strings (J Garcia)
+
+### 2.4.1 / 2016-12-10
+* Symbolize argument keys to fix mailer block syntax issues (J Garcia)
+* Alias method for `deliver_now` (Kurt Funai)
+
+### 2.4.0 / 2016-10-05
+* Rails 5 compatibility
+
+### 2.3.1 / 2016-07-03
+* Serializer bugfix for scheduler integration
+* RSpec cleanup
+
+### 2.3.0 / 2016-04-30
+* Convert specs to use modern RSpec expectation syntax
+* Added argument serializers (Andrew DiMichele, René Klačan, Adam Bird)
+* ActiveRecord argument serializer (René Klačan)
+* Use `deliver_now` if available
+* Remove deprecated fallback / error options in prep for 2.3.x
+
+### 2.2.7 / 2014-10-08
+* Pass respond_to? inquiries through to decoy (to allow preview, etc)
+  (Ian Lesperance)
+
+### 2.2.6 / 2013-11-13
+* Add action and args as arguments to the error handler lambda for
   requeuing (Ellis Berner, Austen Ito)
 * Redis client v3 support; fix unhandled exception when offline
   (Yoav Matchulsky)
@@ -7,13 +35,13 @@
 ### 2.2.5 / 2013-10-10
 * Travis Integration (Peter Goldstein)
 * ActionMailer 4.0 test compatibility (Peter Goldstein)
-* Added `unschedule_delivery` method for resque-scheduler integration 
+* Added `unschedule_delivery` method for resque-scheduler integration
   (gsdean)
 
 ### 2.2.4 / 2013-05-25
 * Compatibility for Rails 4 pre-release (Ben Woosley)
 * Fallback to synchronous is default when connection to Redis fails
-* Avoid lazy evaluation of mail when excluded, for use with mail_view 
+* Avoid lazy evaluation of mail when excluded, for use with mail_view
   (gingerlime)
 
 ### 2.2.3 / 2013-02-27

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2013 Nick Plante
+Copyright (c) 2016 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

@@ -6,7 +6,7 @@ A gem plugin which allows messages prepared by ActionMailer to be delivered
 asynchronously. Assumes you're using [Resque](https://github.com/resque/resque)
 for your background jobs.
 
-Note that recent (2.0+) versions of Resque::Mailer only work with Rails 3.x or 4.x.
+Note that recent (2.0+) versions of Resque::Mailer only work with Rails 3.x or later.
 For a version compatible with Rails 2, specify v1.x in your Gemfile.
 
 ## Installation
@@ -24,13 +24,15 @@ If you're using Bundler to manage your dependencies, you should add it to your G
 
 Include Resque::Mailer in your ActionMailer subclass(es) like this:
 
-    class MyMailer < ActionMailer::Base
-      include Resque::Mailer
-    end
+```ruby
+class MyMailer < ActionMailer::Base
+  include Resque::Mailer
+end
+```
 
 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+,
+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:
 
     QUEUE=mailer rake environment resque:work
@@ -38,19 +40,24 @@ so just make sure your workers know about it and are loading your environment:
 Note that you can still have mail delivered synchronously by using the bang
 method variant:
 
-    MyMailer.subject_email(params).deliver!
+```ruby
+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
 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.
+the id and use it as needed. If you'd like, you can write your own serializer
+to automate such things; see the section on serializers below.
 
 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'
+```ruby
+# config/initializers/resque_mailer.rb
+Resque::Mailer.default_queue_name = 'application_specific_mailer'
+```
 
 This is useful when you are running more than one application using
 resque_mailer in a shared environment. You will need to use the new queue
@@ -59,9 +66,8 @@ name when starting your workers.
     QUEUE=application_specific_mailer rake environment resque:work
 
 Custom handling of errors that arise when sending a message is possible by
-assigning a lambda to the `error_hander` attribute.
-
-There are two supported lambdas for backwards compatiability:
+assigning a lambda to the `error_handler` attribute. There are two supported
+lambdas for backwards compatiability.
 
 The first lamba will be deprecated in a future release:
 
@@ -77,10 +83,10 @@ mailers to be requeued on failure:
 ```ruby
 Resque::Mailer.error_handler = lambda { |mailer, message, error, action, args|
   # Necessary to re-enqueue jobs that receieve the SIGTERM signal
-  if exception.is_a?(Resque::TermException)
+  if error.is_a?(Resque::TermException)
     Resque.enqueue(mailer, action, *args)
   else
-    raise exception
+    raise error
   end
 }
 ```
@@ -90,18 +96,32 @@ Resque::Mailer.error_handler = lambda { |mailer, message, error, action, args|
 If you have a variety of mailers in your application and want all of them to use
 Resque::Mailer by default, you can subclass ActionMailer::Base and have your
 other mailers inherit from an AsyncMailer:
+```ruby
+# config/initializers/resque_mailer.rb
+class AsyncMailer < ActionMailer::Base
+  include Resque::Mailer
+end
+
+# app/mailers/example_mailer.rb
+class ExampleMailer < AsyncMailer
+  def say_hello(user_id)
+    # ...
+  end
+end
+```
+
+### Writing an Argument Serializer
 
-    # config/initializers/resque_mailer.rb
-    class AsyncMailer < ActionMailer::Base
-      include Resque::Mailer
-    end
+By default, the arguments you pass to your mailer are passed as-is to Resque. This
+means you cannot pass things like database-backed objects. If you'd like to write
+your own serializer to enable such things, simply write a class that implements
+the class methods `self.serialize(*args)` and `self.deserialize(data)` and set
+`Resque::Mailer.argument_serializer = YourSerializerClass` in your resque_mailer
+initializer.
 
-    # app/mailers/example_mailer.rb
-    class ExampleMailer < AsyncMailer
-      def say_hello(user)
-        # ...
-      end
-    end
+There's also Active Record serializer which allows you to pass AR
+models directly as arguments. To use it just do:
+`Resque::Mailer.argument_serializer = Resque::Mailer::Serializers::ActiveRecordSerializer`
 
 ### Using with Resque Scheduler
 
@@ -109,27 +129,29 @@ 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)
+```ruby
+# Delivers on the 25th of December, 2014
+MyMailer.reminder_email(params).deliver_at(Time.parse('2014-12-25'))
 
-    # Unschedule delivery
-    MyMailer.reminder_email(params).unschedule_delivery
+# Delivers in 7 days
+MyMailer.reminder_email(params).deliver_in(7.days)
 
+# Unschedule delivery
+MyMailer.reminder_email(params).unschedule_delivery
+```
 ## Testing
 
 You don't want to be sending actual emails in the test environment, so you can
 configure the environments that should be excluded like so:
-
-    # config/initializers/resque_mailer.rb
-    Resque::Mailer.excluded_environments = [:test, :cucumber]
+```ruby
+# 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
-
+```ruby
+Resque::Mailer.current_env = :production
+```
 
 ## Note on Patches / Pull Requests
 

data/lib/resque_mailer/serializers/active_record_serializer.rb

@@ -0,0 +1,29 @@
+module Resque
+  module Mailer
+    module Serializers
+      module ActiveRecordSerializer
+        extend self
+
+        def serialize(*args)
+          args.map do |arg|
+            if arg.is_a?(ActiveRecord::Base)
+              { "class_name" => arg.class.name, "id" => arg.id }
+            else
+              arg
+            end
+          end
+        end
+
+        def deserialize(data)
+          data.map do |arg|
+            if arg.is_a?(Hash) && arg.has_key?("class_name") && arg.has_key?("id")
+              arg["class_name"].constantize.find(arg["id"])
+            else
+              arg
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/resque_mailer/serializers/pass_thru_serializer.rb

@@ -0,0 +1,23 @@
+module Resque
+  module Mailer
+    module Serializers
+
+      # Simple serializer for Resque arguments
+      # New serializers need only implement the self.serialize(*args) and self.deserialize(data)
+      # * self.serialize(*args) should return the arguments serialized as an object
+      # * self.deserialize(data) should take the serialized object as its only argument and return the array of arguments
+
+      module PassThruSerializer
+        extend self
+
+        def serialize(*args)
+          args
+        end
+
+        def deserialize(data)
+          data
+        end
+      end
+    end
+  end
+end

data/lib/resque_mailer/version.rb

@@ -1,5 +1,5 @@
 module Resque
   module Mailer
-    VERSION = "2.2.6"
+    VERSION = "2.4.3"
   end
 end

data/lib/resque_mailer.rb

@@ -1,22 +1,27 @@
 require 'resque_mailer/version'
+require 'resque_mailer/serializers/pass_thru_serializer'
+require 'resque_mailer/serializers/active_record_serializer'
+require 'active_support/core_ext/hash'
 
 module Resque
   module Mailer
     class << self
       attr_accessor :default_queue_name, :default_queue_target, :current_env, :logger, :error_handler
+      attr_accessor :argument_serializer
       attr_reader :excluded_environments
 
       def excluded_environments=(envs)
         @excluded_environments = [*envs].map { |e| e.to_sym }
       end
 
-      def included(base)
-        base.extend(ClassMethods)
+      def prepare_message(klass, action, *args)
+        msg = klass.send(:new)
+        msg.process(action, *args)
+        msg.message
       end
 
-      # Deprecated
-      def fallback_to_synchronous=(val)
-        warn "WARNING: fallback_to_synchronous option is deprecated and will be removed in the next release"
+      def included(base)
+        base.extend(ClassMethods)
       end
     end
 
@@ -24,6 +29,7 @@ module Resque
     self.default_queue_target = ::Resque
     self.default_queue_name = "mailer"
     self.excluded_environments = [:test]
+    self.argument_serializer = ::Resque::Mailer::Serializers::PassThruSerializer
 
     module ClassMethods
 
@@ -43,18 +49,24 @@ module Resque
         end
       end
 
-      def perform(action, *args)
+      def perform(action, serialized_args)
         begin
-          message = self.send(:new, action, *args).message
-          message.deliver
+          args = ::Resque::Mailer.argument_serializer.deserialize(serialized_args)
+          # Set hash as hash with indifferent access so mailer block syntax (needs symbols) works
+          if args.is_a?(Array)
+            args = args.each_with_object([]) do |arg, o|
+              o << (arg.is_a?(Hash) ? arg.with_indifferent_access : arg)
+            end
+          end
+          message = ::Resque::Mailer.prepare_message(self, action, *args)
+          if message.respond_to?(:deliver_now)
+            message.deliver_now
+          else
+            message.deliver
+          end
         rescue Exception => ex
           if Mailer.error_handler
-            if Mailer.error_handler.arity == 3
-              warn "WARNING: error handlers with 3 arguments are deprecated and will be removed in the next release"
-              Mailer.error_handler.call(self, message, ex)
-            else
-              Mailer.error_handler.call(self, message, ex, action, args)
-            end
+            Mailer.error_handler.call(self, message, ex, action, args)
           else
             if logger
               logger.error "Unable to deliver email [#{action}]: #{ex}"
@@ -94,6 +106,7 @@ module Resque
         @mailer_class = mailer_class
         @method_name = method_name
         *@args = *args
+        @serialized_args = ::Resque::Mailer.argument_serializer.serialize(*args)
         actual_message if environment_excluded?
       end
 
@@ -118,7 +131,7 @@ module Resque
       end
 
       def actual_message
-        @actual_message ||= @mailer_class.send(:new, @method_name, *@args).message
+        @actual_message ||= ::Resque::Mailer.prepare_message(@mailer_class, @method_name, *@args)
       end
 
       def deliver
@@ -126,13 +139,14 @@ module Resque
 
         if @mailer_class.deliver?
           begin
-            resque.enqueue(@mailer_class, @method_name, *@args)
+            resque.enqueue(@mailer_class, @method_name, @serialized_args)
           rescue Errno::ECONNREFUSED, Redis::CannotConnectError
             logger.error "Unable to connect to Redis; falling back to synchronous mail delivery" if logger
             deliver!
           end
         end
       end
+      alias_method :deliver_now, :deliver
 
       def deliver_at(time)
         return deliver! if environment_excluded?
@@ -142,7 +156,7 @@ module Resque
         end
 
         if @mailer_class.deliver?
-          resque.enqueue_at(time, @mailer_class, @method_name, *@args)
+          resque.enqueue_at(time, @mailer_class, @method_name, @serialized_args)
         end
       end
 
@@ -154,7 +168,7 @@ module Resque
         end
 
         if @mailer_class.deliver?
-          resque.enqueue_in(time, @mailer_class, @method_name, *@args)
+          resque.enqueue_in(time, @mailer_class, @method_name, @serialized_args)
         end
       end
 
@@ -163,17 +177,26 @@ module Resque
           raise "You need to install resque-scheduler to use unschedule_delivery"
         end
 
-        resque.remove_delayed(@mailer_class, @method_name, *@args)
+        resque.remove_delayed(@mailer_class, @method_name, @serialized_args)
       end
 
       def deliver!
-        actual_message.deliver
+        if actual_message.respond_to?(:deliver_now)
+          actual_message.deliver_now
+        else
+          actual_message.deliver
+        end
       end
+      alias_method :deliver_now!, :deliver!
 
       def method_missing(method_name, *args)
         actual_message.send(method_name, *args)
       end
 
+      def respond_to?(method_name, *args)
+        super || actual_message.respond_to?(method_name, *args)
+      end
+
       def logger
         @mailer_class.logger
       end

metadata

@@ -1,55 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: resque_mailer
 version: !ruby/object:Gem::Version
-  version: 2.2.6
+  version: 2.4.3
 platform: ruby
 authors:
 - Nick Plante
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-13 00:00:00.000000000 Z
+date: 2017-09-18 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: actionmailer
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.6.0
 description: Rails plugin for sending asynchronous email with ActionMailer and Resque.
@@ -62,13 +76,16 @@ extra_rdoc_files:
 - CHANGELOG.md
 - README.md
 files:
-- lib/resque_mailer/version.rb
-- lib/resque_mailer.rb
-- README.md
-- LICENSE
 - CHANGELOG.md
+- LICENSE
+- README.md
+- lib/resque_mailer.rb
+- lib/resque_mailer/serializers/active_record_serializer.rb
+- lib/resque_mailer/serializers/pass_thru_serializer.rb
+- lib/resque_mailer/version.rb
 homepage: http://github.com/zapnap/resque_mailer
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -76,19 +93,18 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Rails plugin for sending asynchronous email with ActionMailer and Resque.
 test_files: []
-has_rdoc: