resque_mailer 2.2.7 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bc00ecc2825ecbdfb1569db2d721e2ba1b1e7881
-  data.tar.gz: 4c33b71e7f01d7c077ca5c90df02906dc02ff0f4
+  metadata.gz: fdc6b3606f8bb8c4556b38fd5ba24a0df26c8038
+  data.tar.gz: 26819b80f0f5e6723b1d6127ecb55d02c9c704b8
 SHA512:
-  metadata.gz: 0b79aae5b1b79c4e6cac2f12f9084ac8df048fded91ff9ef62b58450ff95cf30cbc455a13d77f35c60d49c944d2ce08548f3fdca7d3011b0245c9230f040e88c
-  data.tar.gz: 67c0d0c9dc358b4830dbc90aa525366df64a36d1326fd11551355f78b458d282eba89b7db42ebb72bd7ca474f0ae14f73e51c2efcddb9501869cb60de5e40811
+  metadata.gz: 25ede40de656bc07d969848e9492825b617c6cae6fc87bfbb6ce3b25adc36660872bfaff163db65cd6eb17e28f753acc1e496f5a839fd9285c580f871a5cdcc4
+  data.tar.gz: 018c91c5908466b0d0ea6c94390b65ce063b4b60895e2285a1f536c9eeead5e6eafa6b2895bcef36a4ec99b7ffe0fd00cb1d400621d3291fc9d12eea815669b8

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+### 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)

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2014 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

@@ -24,9 +24,11 @@ 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
@@ -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,7 +66,7 @@ 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 
+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:
@@ -89,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_id)
-        # ...
-      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
 
@@ -108,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, 2014
-    MyMailer.reminder_email(params).deliver_at(Time.parse('2014-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.rb

@@ -1,9 +1,12 @@
 require 'resque_mailer/version'
+require 'resque_mailer/serializers/pass_thru_serializer'
+require 'resque_mailer/serializers/active_record_serializer'
 
 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)
@@ -13,17 +16,13 @@ module Resque
       def included(base)
         base.extend(ClassMethods)
       end
-
-      # Deprecated
-      def fallback_to_synchronous=(val)
-        warn "WARNING: fallback_to_synchronous option is deprecated and will be removed in the next release"
-      end
     end
 
     self.logger ||= (defined?(Rails) ? Rails.logger : nil)
     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 +42,18 @@ module Resque
         end
       end
 
-      def perform(action, *args)
+      def perform(action, serialized_args)
         begin
+          args = ::Resque::Mailer.argument_serializer.deserialize(serialized_args)
           message = self.send(:new, action, *args).message
-          message.deliver
+          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 +93,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
 
@@ -126,7 +126,7 @@ 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!
@@ -167,7 +167,11 @@ module Resque
       end
 
       def deliver!
-        actual_message.deliver
+        if actual_message.respond_to?(:deliver_now)
+          actual_message.deliver_now
+        else
+          actual_message.deliver
+        end
       end
 
       def method_missing(method_name, *args)

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.7"
+    VERSION = "2.3.0"
   end
 end

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: resque_mailer
 version: !ruby/object:Gem::Version
-  version: 2.2.7
+  version: 2.3.0
 platform: ruby
 authors:
 - Nick Plante
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-08 00:00:00.000000000 Z
+date: 2016-04-30 00:00:00.000000000 Z
 dependencies:
 - !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'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.6'
 - !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.
@@ -66,6 +66,8 @@ files:
 - 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:
@@ -77,17 +79,17 @@ 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.2.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Rails plugin for sending asynchronous email with ActionMailer and Resque.