resque-delayable 1.0.0

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 James Smith
+
+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,57 @@
+resque-delayable
+================
+
+A resque plugin which adds a new method `rdelay` to objects. Methods called 
+with `rdelay` are executed asynchronously by resque, allowing your code to 
+continue.
+
+Features
+--------
+- Adds `rdelay` instance and class methods to your models. Works with 
+  ActiveRecord, Mongoid and MongoMapper objects out of the box
+- Works with resque-scheduler. Schedule method execution for the future, 
+  `obj.rdelay(:run_in => 5.minutes).method`
+- Get `rdelay` on any class methods with `include ResqueDelayable`
+- Create a custom seralizer plugin to get `rdelay` on your own instance methods
+
+Installation
+------------
+- Add `gem "resque-delayable"` to your `Gemfile` or `gem install resque-delayable`
+
+Examples
+--------
+
+    class User
+      include ResqueDelayable
+      
+      def self.recompute_caches() ...
+      def get(name) ...
+      def send_welcome_email ...
+    end
+
+    # Works with any serializable instance. ActiveRecord, Mongoid & MongoMapper
+    # are supported out of the box
+    u = User.get("james")
+    u.rdelay.send_welcome_email
+
+    # Works with all class methods
+    User.rdelay.recompute_caches
+
+
+Contributing to resque-delayable
+--------------------------------
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+Copyright
+---------
+
+Copyright (c) 2011 James Smith. See LICENSE.txt for
+further details.
+

data/lib/resque-delayable/delayed_method.rb

@@ -0,0 +1,54 @@
+module ResqueDelayable
+  require "resque"
+
+  begin
+    require "resque/scheduler"
+  rescue LoadError
+  end
+
+  class DelayedMethod
+    attr_accessor :klass
+    attr_accessor :instance
+    attr_accessor :options
+
+    def initialize(klass, instance = nil, options = {})
+      unless instance.nil? || ResqueDelayable::ACTIVE_SERIALIZERS.any? {|klass| klass.serialize_match(instance) }
+        raise "Cannot serialize instances of this type (#{instance.class}). Consider creating a serializer."
+      end
+
+      self.klass = klass
+      self.instance = instance
+      self.options = options
+    end
+  
+    def dequeue(method, *parameters)
+      ::Resque.dequeue(self.klass, method, ::ResqueDelayable::serialize_object(self.instance), *::ResqueDelayable::serialize_object(parameters))
+    end
+
+    def method_missing(method, *parameters)
+      if instance.nil?
+        raise NoMethodError.new("undefined method '#{method}' for #{self.klass}", method, parameters) unless klass.respond_to?(method)
+      else
+        raise NoMethodError.new("undefined method '#{method}' for #{self.instance}", method, parameters) unless instance.respond_to?(method)
+      end
+
+      if self.options[:run_at]
+        if ::Resque.respond_to?(:enqueue_at)
+          ::Resque.enqueue_at(self.options[:run_at], self.klass, method, ::ResqueDelayable::serialize_object(self.instance), *::ResqueDelayable::serialize_object(parameters))
+        else
+          raise "Cannot use run_at, resque-scheduler not installed"
+        end
+      elsif self.options[:run_in]
+        if ::Resque.respond_to?(:enqueue_in)
+          ::Resque.enqueue_in(self.options[:run_in], self.klass, method, ::ResqueDelayable::serialize_object(self.instance), *::ResqueDelayable::serialize_object(parameters))
+        else
+          raise "Cannot use run_in, resque-scheduler not installed"
+        end
+      else
+        ::Resque.enqueue(self.klass, method, ::ResqueDelayable::serialize_object(self.instance), *::ResqueDelayable::serialize_object(parameters))
+      end
+
+      true
+    end
+  end
+end

data/lib/resque-delayable/serializer/active_record_serializer.rb

@@ -0,0 +1,30 @@
+module ResqueDelayable
+  module Serializer
+    class ActiveRecordSerializer
+      PREFIX = "ActiveRecord"
+      MATCHER = Regexp.new("^#{PREFIX}_(\w+)_(\d+)$")
+
+      class << self
+        def serialize_match(object)
+          object.is_a?(ActiveRecord::Base)
+        end
+
+        def deserialize_match(object)
+          object.class == String && MATCHER.match(object)
+        end
+
+        def serialize(object)
+          "#{PREFIX}_#{object.class}_#{object.id}"
+        end
+        
+        def deserialize(object)
+          match = MATCHER.match(object)
+          match[1].constantize.find_by_id(match[2])
+        end
+      end
+    end
+  end
+end
+
+ResqueDelayable::ACTIVE_SERIALIZERS << ResqueDelayable::Serializer::ActiveRecordSerializer
+ActiveRecord::Base.send :include, ResqueDelayable

data/lib/resque-delayable/serializer/mongo_mapper_serializer.rb

@@ -0,0 +1,34 @@
+module ResqueDelayable
+  module Serializer
+    class MongoMapperSerializer
+      PREFIX = "MongoMapper"
+      MATCHER = Regexp.new("^#{PREFIX}_([^_]+)_([^_]+)_([^_]+)$")
+
+      class << self
+        def serialize_match(object)
+          object.is_a?(MongoMapper::Document)
+        end
+
+        def deserialize_match(object)
+          object.class == String && MATCHER.match(object)
+        end
+        
+        def serialize(object)
+          "#{PREFIX}_#{object.class}_#{object.id.class}_#{object.id}"
+        end
+        
+        def deserialize(object)
+          match = MATCHER.match(object)
+
+          id = match[3]
+          id = id.to_i if match[2] == "Fixnum"
+          
+          match[1].constantize.find_by_id(id)
+        end
+      end
+    end
+  end
+end
+
+ResqueDelayable::ACTIVE_SERIALIZERS << ResqueDelayable::Serializer::MongoMapperSerializer
+MongoMapper::Document.send :include, ResqueDelayable

data/lib/resque-delayable/serializer/mongoid_serializer.rb

@@ -0,0 +1,30 @@
+module ResqueDelayable
+  module Serializer
+    class MongoidSerializer
+      PREFIX = "Mongoid"
+      MATCHER = Regexp.new("^#{PREFIX}_([^_]+)_([^_]+)$")
+
+      class << self
+        def serialize_match(object)
+          object.is_a?(Mongoid::Document)
+        end
+
+        def deserialize_match(object)
+          object.class == String && MATCHER.match(object)
+        end
+        
+        def serialize(object)
+          "#{PREFIX}_#{object.class}_#{object.id}"
+        end
+        
+        def deserialize(object)
+          match = MATCHER.match(object)
+          match[1].constantize.find_by_id(id)
+        end
+      end
+    end
+  end
+end
+
+ResqueDelayable::ACTIVE_SERIALIZERS << ResqueDelayable::Serializer::MongoidSerializer
+Mongoid::Document.send :include, ResqueDelayable

data/lib/resque-delayable/version.rb

@@ -0,0 +1,3 @@
+module ResqueDelayable
+  VERSION = File.read(File.join(File.dirname(__FILE__), "../../VERSION"))
+end

data/lib/resque-delayable.rb

@@ -0,0 +1,76 @@
+module ResqueDelayable
+  require "set"
+
+  ACTIVE_SERIALIZERS = Set.new
+
+  require "resque-delayable/delayed_method"
+
+  def self.included(base)
+    base.extend(ClassMethods)
+    super
+  end
+  
+  def self.serialize_object(object)
+    if [Hash, HashWithIndifferentAccess].include?(object.class)
+      object.inject({}) {|doc, (k,v)| doc[k] = serialize_object(v); doc}
+    elsif [Set, Array].include?(object.class)
+      object.map {|v| serialize_object(v)}
+    else
+      ACTIVE_SERIALIZERS.each do |serializer|
+        return serializer.serialize(object) if serializer.serialize_match(object)
+      end
+      
+      object
+    end
+  end
+
+  def self.deserialize_object(object)
+    if [Hash, HashWithIndifferentAccess].include?(object.class)
+      object.inject({}) {|doc, (k,v)| doc[k] = deserialize_object(v); doc}
+    elsif [Set, Array].include?(object.class)
+      object.map {|v| deserialize_object(v)}
+    else
+      ACTIVE_SERIALIZERS.each do |serializer|
+        return serializer.deserialize(object) if serializer.deserialize_match(object)
+      end
+
+      object
+    end
+  end
+
+  module ClassMethods
+    def rdelay(options = {})
+      return DelayedMethod.new(self, nil, options)
+    end
+
+    def perform(cmd, instance, *args)
+      deserialized_args = ::ResqueDelayable.deserialize_object(args)
+
+      if instance
+        # Instance method 
+        deserialized_instance = ::ResqueDelayable.deserialize_object(instance)
+        if deserialized_instance
+          deserialized_instance.send(cmd, *deserialized_args)
+        else
+          puts "ResqueDelayable couldn't find instance '#{instance}' to peform method '#{cmd}' on"
+        end
+      else
+        # Class method
+        send(cmd, *deserialized_args)
+      end
+    end
+  
+    def queue
+      @queue ||= self.name
+    end
+  end
+
+  def rdelay(options = {})
+    return DelayedMethod.new(self.class, self, options)
+  end
+end
+
+# Serialization plugins
+require "resque-delayable/serializer/active_record_serializer"  if defined? ActiveRecord::Base
+require "resque-delayable/serializer/mongo_mapper_serializer"   if defined? MongoMapper::Document
+require "resque-delayable/serializer/mongoid_serializer"        if defined? Mongoid::Document

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification 
+name: resque-delayable
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- James Smith
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-12-14 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id001
+  name: shoulda
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  version_requirements: *id002
+  name: bundler
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 6
+        - 4
+        version: 1.6.4
+  version_requirements: *id003
+  name: jeweler
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id004
+  name: rcov
+  type: :development
+description: Run class methods or methods on activerecord, mongomapper objects later through resque
+email: james@loopj.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.md
+files: 
+- lib/resque-delayable.rb
+- lib/resque-delayable/delayed_method.rb
+- lib/resque-delayable/serializer/active_record_serializer.rb
+- lib/resque-delayable/serializer/mongo_mapper_serializer.rb
+- lib/resque-delayable/serializer/mongoid_serializer.rb
+- lib/resque-delayable/version.rb
+- LICENSE.txt
+- README.md
+homepage: http://github.com/loopj/resque-delayable
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Run class methods or methods on activerecord, mongomapper objects later through resque
+test_files: []
+