resque_extensions 0.0.1

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 nested

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in resque_extensions.gemspec
+gemspec
+
+# this is just for our test project - we need activerecord
+gem "guard-rspec"
+gem "mocha"
+gem "mock_redis"
+gem "rails", "~> 3"
+gem "rspec"
+gem "sqlite3"

data/Guardfile

@@ -0,0 +1,24 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml)$})                 { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+
+  # Capybara features specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml)$})          { |m| "spec/features/#{m[1]}_spec.rb" }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Dan Langevin
+
+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,87 @@
+# ResqueExtensions
+
+Adds behavior to Resque to make it a bit more like Delayed::Job
+
+To use, call `async` where you would have used `send_later`
+
+ActiveRecord Objects are serialized with their class name and ID and pulled
+out of the database when they are run.
+
+## Usage
+
+### Instance Method
+    @my_instance = MyClass.find(params[:id])
+    @my_instance.async(:expensive_method)
+
+### Class Method
+    # This will store just the ID of the MyClass instance passed in and pull 
+    # it out of the DB when the code is run
+    MyClass.async(:other_expensive_method, MyClass.find(1))
+
+### Class Method on a class defined elsewhere
+
+If you don't have access to the Class/Module you need (e.g. a Mailer that
+is defined in a different codebase), you can use 
+`ResqueExtensions.enqueue_class_method`
+
+    ResqueExtensions.enqueue_class_method("MissingClass", :my_method, arg...)
+
+### Serializing ActiveRecord objects
+
+In Delayed::Job, you can enqueue whole objects or collections of objects,
+which are then serialized by Marshal or YAML.  This is problematic for
+several reasons
+
+1. Objects enqueued in one version of Ruby may not be able to be loaded in
+    another
+2. The underlying data may have changed and we can have an invalid version
+    of the object when our job is performed
+3. It is hard to debug jobs and determine exactly what they are doing because
+    Marshal and YAML are not particularly readable formats
+
+To get around this ResqueExtensions serializes Classes and ActiveRecords in
+a string format and then constantizes them or pulls them from the database
+when the job is performed.
+
+This allows us to enqueue jobs in a very flexible way.  The following would
+be converted to strings and the objects would be reified when the job is 
+performed.
+
+    my_instance.async(:my_method, other_instance, array_of_instances)
+
+
+### Specifying a Queue
+
+You can specify a queue to run this job in when you enqueue it as an optional
+last argument
+
+    MyClass.async(
+      :other_expensive_method, MyClass.find(1), :queue => "custom-queue"
+    )
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'resque_extensions'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install resque_extensions
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/resque_extensions.rb

@@ -0,0 +1,22 @@
+require 'resque'
+
+require "resque_extensions/version"
+require "resque_extensions/async_method"
+
+module ResqueExtensions
+  
+  def self.enqueue_class_method(klass, *args)
+    klass = "#{AsyncMethod::CLASS_PREFIX}#{klass}"
+    AsyncMethod.new(klass, *args).enqueue!
+  end
+
+  module ObjectMethods
+    # call this method asynchronously
+    def async(*args)
+      ResqueExtensions::AsyncMethod.new(self, *args).enqueue!
+    end
+  end
+end
+
+Object.send(:extend, ResqueExtensions::ObjectMethods)
+Object.send(:include, ResqueExtensions::ObjectMethods)

data/lib/resque_extensions/async_method.rb

@@ -0,0 +1,124 @@
+module ResqueExtensions
+  class AsyncMethod
+
+    OPTIONAL_SETTINGS = [:queue]
+
+    ACTIVERECORD_PREFIX = "_ActiveRecord::"
+    CLASS_PREFIX = "_Class::"
+
+
+    attr_reader :args
+
+    def self.perform(*args)
+      data = self.reify_data(args)
+      caller = data.shift
+      # call the method with all the args
+      caller.send(*data)
+    end
+
+    # Constructor
+    # @param [Object] caller The class or instance that is doing work
+    # @param [String, Symbol] method The method we are calling
+    # @param args Additional arguments we pass in
+    def initialize(caller, method, *args)
+      @caller = caller
+      @method = method
+      # set up our options
+      self.set_options(args)
+      # leftover args are assigned
+      @args = args
+    end
+
+    # Is the caller a class or an instance of
+    # a class
+    def class_method?
+      @caller.is_a?(Class)
+    end
+
+    def enqueue!
+      Resque::Job.create(
+        self.queue, self.class, *self.data_to_enqueue
+      )
+    end
+
+    # Is the caller an instance or a class
+    def instance_method?
+      !self.class_method?
+    end
+
+    # the queue for this job
+    def queue
+      @queue ||= "default"
+    end
+
+
+    protected
+
+    def self.reify_data(data)
+      # call recursively
+      if data.is_a?(Array)
+        data = data.collect{|d| self.reify_data(d)}
+      # call on values
+      elsif data.is_a?(Hash)
+        data.each_pair do |k,v|
+          data[k] = self.reify_data(v)
+        end
+      # our special ActiveRecord encoding
+      elsif data.to_s =~ /^#{ACTIVERECORD_PREFIX}/
+        # get our ActiveRecord back
+        data = data.split("::")
+        id = data.pop
+        class_name = data[1..-1].join("::")
+        data = Resque::Job.constantize(class_name).find(id)
+      # classes become strings prefixed by _Class
+      elsif data.to_s =~ /^#{CLASS_PREFIX}/
+        data = Resque::Job.constantize(data.gsub(/^#{CLASS_PREFIX}/,''))
+      end
+      # return data
+      data
+    end
+
+    def data_to_enqueue
+      self.prepare_data([@caller, @method, *@args])
+    end
+
+    # prepare our data for Redis
+    def prepare_data(data)
+      # call recursively
+      if data.is_a?(Array)
+        data = data.collect{|d| self.prepare_data(d)}
+      # call on values
+      elsif data.is_a?(Hash)
+        data.each_pair do |k,v|
+          data[k] = self.prepare_data(v)
+        end
+      # our special ActiveRecord encoding
+      elsif data.is_a?(ActiveRecord::Base)
+        data = "_ActiveRecord::#{data.class}::#{data.id}"
+      # classes become strings prefixed by _Class
+      elsif data.is_a?(Class)
+        data = "_Class::#{data.to_s}"
+      end
+      # return data
+      data
+    end
+
+    # set the options passed in as instance variables
+    def set_options(args)
+      if self.has_options?(args.last)
+        args.pop.each_pair do |key, val|
+          instance_variable_set("@#{key}", val)
+        end
+      end
+    end
+
+    # Is the given argument a hash of valid options
+    def has_options?(argument)
+      return false unless argument.is_a?(Hash)
+      # get our keys
+      keys = argument.keys.collect(&:to_sym)
+      # if we have overlaps, we've been passed options
+      return (keys & OPTIONAL_SETTINGS).length > 0
+    end
+  end
+end

data/lib/resque_extensions/version.rb

@@ -0,0 +1,3 @@
+module ResqueExtensions
+  VERSION = "0.0.1"
+end

data/resque_extensions.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'resque_extensions/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "resque_extensions"
+  gem.version       = ResqueExtensions::VERSION
+  gem.authors       = ["Dan Langevin"]
+  gem.email         = ["dan.langevin@lifebooker.com"]
+  gem.description   = %q{An extension to Resque that makes it act more like Delayed::Job}
+  gem.summary       = %q{Resque extensions to add .async}
+  gem.homepage      = "https://github.com/dlangevin/resque_extensions"
+
+  # works with resque before 2.0
+  gem.add_dependency "resque", "~> 1"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/spec/lib/resque_extensions/async_method_spec.rb

@@ -0,0 +1,159 @@
+require 'spec_helper'
+
+module ResqueExtensions
+
+  describe AsyncMethod do
+
+    context ".perform" do
+
+      it "deserializes and calls a method on the caller" do
+        async_method = AsyncMethod.new(MyClass, :my_class_method, "a")
+        async_method.enqueue!
+
+        # make sure we call the correct
+        MyClass.expects(:send).with("my_class_method", "a")
+
+        job = Resque.reserve("default")
+        job.perform
+
+      end
+
+      it "deserializes and calls a method on an ActiveRecord" do
+
+        my_instance = MyClass.create(:name => "Dan")
+
+        async_method = AsyncMethod.new(my_instance, :my_instance_method)
+        async_method.enqueue!
+
+        MyClass.expects(:find).with(my_instance.id.to_s).returns(my_instance)
+        my_instance.expects(:send).with("my_instance_method")
+
+        job = Resque.reserve("default")
+        job.perform
+
+      end
+
+    end
+
+
+    context "#initialize" do
+
+      it "initializes with a class" do
+
+        async_method = AsyncMethod.new(MyClass, :my_class_method)
+        async_method.should be_class_method
+
+      end
+
+      it "initializes with an instance" do
+
+        async_method = AsyncMethod.new(MyClass.new, :my_class_method)
+        async_method.should be_instance_method
+
+      end
+
+    end
+
+    context "#args" do
+
+      it "accepts a variable number of arguments" do
+
+        async_method = AsyncMethod.new(
+          MyClass, :my_class_method, :a, :b, "c"
+        )
+        async_method.args.should eql([:a, :b, "c"])
+
+      end
+
+      it "removes any options from the arguments" do
+        async_method = AsyncMethod.new(
+          MyClass, :my_class_method, :a, :b, {:queue => "test"}
+        )
+        async_method.args.should eql([:a, :b])
+      end
+
+    end
+
+    context "#enqueue" do
+
+      it "creates a new job for the class or instance" do
+        async_method = AsyncMethod.new(MyClass, :my_class_method)
+        async_method.enqueue!
+
+        job = Resque.reserve("default")
+        
+        job.payload.should eql({
+          "class" => "ResqueExtensions::AsyncMethod", 
+          "args" => ["_Class::MyClass", "my_class_method"]
+        })
+
+      end
+
+      it "serializes ActiveRecords passed in as the caller" do
+
+        my_instance = MyClass.create(:name => "Dan")
+
+        async_method = AsyncMethod.new(my_instance, :my_instance_method)
+        async_method.enqueue!
+
+        job = Resque.reserve("default")
+        
+        job.payload.should eql({
+          "class" => "ResqueExtensions::AsyncMethod", 
+          "args" => [
+            "_ActiveRecord::MyClass::#{my_instance.id}", 
+            "my_instance_method"
+          ]
+        })
+
+      end
+
+      it "serializes ActiveRecords passed in as arguments" do
+
+        my_instance = MyClass.create(:name => "Dan")
+
+        async_method = AsyncMethod.new(
+          MyClass, 
+          :my_class_method, 
+          [my_instance], 
+          my_instance, 
+          {:a => my_instance}
+        )
+        async_method.enqueue!
+
+        instance_string = "_ActiveRecord::MyClass::#{my_instance.id}"
+
+
+        job = Resque.reserve("default")
+
+        job.payload.should eql({
+          "class" => "ResqueExtensions::AsyncMethod", 
+          "args" => [
+            "_Class::MyClass", 
+            "my_class_method",
+            [instance_string],
+            instance_string,
+            {"a" => instance_string}
+          ]
+        })
+
+      end
+
+    end
+
+    context "#queue" do
+
+      it "sets the queue if it is passed as an argument" do
+
+        async_method = AsyncMethod.new(
+          MyClass, :my_class_method, :queue => "test"
+        )
+        async_method.queue.should eql("test")
+
+      end
+
+    end
+
+  end
+
+end

data/spec/lib/resque_extensions_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+describe ResqueExtensions do
+
+  context ".enqueue_class_method" do
+
+    it "enqueues a class method from a string" do
+      ResqueExtensions.enqueue_class_method(
+        "MyClass", :my_class_method
+      )
+      MyClass.expects(:send).with("my_class_method")
+
+      job = Resque.reserve("default")
+      job.perform
+    end
+
+  end
+
+  context "ObjectMethods" do
+
+    context ".async" do
+
+      it "enqueues a class method resque" do
+
+        MyClass.async(:my_class_method, "a", "b", "c")
+
+        MyClass.expects(:send).with("my_class_method", "a", "b", "c")
+
+        job = Resque.reserve("default")
+        job.perform
+      end
+
+    end
+
+    context "#async" do
+
+      it "enqueues an instance method resque" do
+
+        my_class = MyClass.create(:name => "test")
+
+        my_class.async(:my_instance_method, {:a => my_class})
+
+        MyClass.stubs(:find).with(my_class.id.to_s).returns(my_class)
+
+        my_class.expects(:send)
+          .with(
+            "my_instance_method", 
+            has_entries("a" => instance_of(MyClass))
+          )
+
+        job = Resque.reserve("default")
+        job.perform
+
+
+      end
+
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,51 @@
+
+require 'resque_extensions'
+
+require 'active_record'
+require 'mock_redis'
+require 'resque'
+
+
+Bundler.setup
+
+ActiveRecord::Base.establish_connection(
+  :adapter => "sqlite3",
+  :database => File.dirname(__FILE__) + "/../tmp/test.sqlite"
+)
+
+Resque.redis = MockRedis.new
+
+# This code will be run each time you run your specs.
+Dir[File.dirname(__FILE__) + "/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.mock_with :mocha
+
+  config.before(:each) do
+    Resque.redis = MockRedis.new
+  end
+
+  config.before(:all) do
+
+    ActiveRecord::Base.connection.create_table(:my_classes, :force => true) do |t|
+
+      t.string(:name)
+      t.timestamps
+    end
+
+    MyClass = Class.new(ActiveRecord::Base) do
+      def my_instance_method(*args)
+        return args
+      end
+
+      def self.my_class_method(*args)
+        return args
+      end
+
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: resque_extensions
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Dan Langevin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: resque
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1'
+description: An extension to Resque that makes it act more like Delayed::Job
+email:
+- dan.langevin@lifebooker.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/resque_extensions.rb
+- lib/resque_extensions/async_method.rb
+- lib/resque_extensions/version.rb
+- resque_extensions.gemspec
+- spec/lib/resque_extensions/async_method_spec.rb
+- spec/lib/resque_extensions_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/dlangevin/resque_extensions
+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.24
+signing_key: 
+specification_version: 3
+summary: Resque extensions to add .async
+test_files:
+- spec/lib/resque_extensions/async_method_spec.rb
+- spec/lib/resque_extensions_spec.rb
+- spec/spec_helper.rb
+has_rdoc: