resque-send-later 0.1.0

data/HISTORY.md

@@ -0,0 +1,4 @@
+## 0.1.0 (2011-05-17)
+
+* Initial version.
+

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Monica McArthur
+
+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,70 @@
+ResqueSendLater
+============
+
+A [Resque][rq] plugin. Requires Resque 1.9.10.
+
+Implements an approximation of DelayedJob's send_later on resque.
+
+
+Usage / Examples
+================
+
+Usage 1: Delaying an instance method call for any object that has a class find(id) method
+(e.g., Rails ActiveRecord):
+
+The class itself:
+
+    class TestThing < ActiveRecord::Base
+      include Resque::Plugins::SendLater
+    
+      def method_to_delay(arg1, arg2)
+        <some code>
+      end
+    end
+
+Delaying a method call on any instance of the class:
+
+  t = TestThing.find(_id_)
+  t.send_later(:method_to_delay, a1, a2)
+  
+Usage 2: Delaying a class method call on any class
+
+The class itself:
+
+    class TestThing
+      include Resque::Plugins::SendLater
+    
+      def TestThing.class_method_to_delay(arg1, arg2)
+        <some code>
+      end
+    end
+
+Delaying a method call:
+
+  TestThing.send_later(:class_method_to_delay, a1, a2)
+
+
+Customize & Extend
+==================
+
+No options for now.
+
+
+Install
+=======
+
+### As a gem
+
+    $ gem install resque-send-later
+
+### In a Rails app, as a plugin
+
+    $ rails plugin install git://github.com/Mechaferret/resque-send-later.git
+
+
+Acknowledgements
+================
+
+Copyright (c) 2011 Monica McArthur, released under the MIT license.
+
+[rq]: http://github.com/defunkt/resque

data/Rakefile

@@ -0,0 +1,23 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the resque_send_later plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the resque_send_later plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ResqueSendLater'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/resque-send-later.rb

@@ -0,0 +1 @@
+require 'resque/plugins/send_later'

data/lib/resque/plugins/send_later.rb

@@ -0,0 +1,54 @@
+module Resque
+  module Plugins
+    module SendLater
+      begin
+        include Spawn
+      rescue
+      end
+    	def self.included(base)
+        base.extend self
+      end
+      
+      def send_later(method, *args)
+        if self.instance_of? Class
+          classname = self.to_s
+          refid = nil
+        else
+          classname = self.class.to_s
+          refid = self.id
+        end
+        Resque.enqueue(Resque::Plugins::SendLater::DelayedPerformer, classname, refid, method, *args)
+      rescue Exception => ex
+        handle_exception(ex, method, *args)
+      end
+      
+      
+      def handle_exception(ex, method, *args)
+        # Try to spawn instead
+        if defined? Spawn
+          puts "transaction spawning due to exception #{ex.inspect} #{ex.backtrace.join("\n")}"
+          spawn do
+            self.send(method, *args)
+          end
+        else
+          puts "no way to handle transaction with exception #{ex.inspect} #{ex.backtrace.join("\n")}"
+        end
+      end
+      
+      class DelayedPerformer
+        @queue = :method
+
+        def self.perform(klass, object_id, method, *args)
+          if object_id.nil? # class method delay
+            klass.constantize.send(method, *args)
+          else
+            model = klass.constantize.send(:find, object_id)
+            model.send(method, *args)
+          end
+        end
+
+      end
+
+    end
+  end
+end

data/test/fixtures/test_thing.rb

@@ -0,0 +1,42 @@
+class TestThing
+  include Resque::Plugins::SendLater
+  
+  attr_accessor :id, :delayed_message
+  @@delayed_class_message = nil
+  @@delayed_message = nil
+
+  def TestThing.find(_id)
+    t = TestThing.new
+    t.id = _id
+    t
+  end
+
+  def ask_now(what)
+    puts "You asked for #{what} from #{self.id} at #{Time.now}"
+    self.send_later(:get_later, what)
+  end
+  
+  def get_later(what)
+    @@delayed_message = "You got #{what} from #{self.id}"
+    puts "Do not panic. Thank you for your patience. #{@@delayed_message} at #{Time.now}!"
+  end
+  
+  def self.ask_now(what)
+    puts "You asked for #{what} from #{self.to_s} at #{Time.now}"
+    TestThing.send_later(:get_later, what)
+  end
+  
+  def self.get_later(what)
+    @@delayed_class_message = "You got #{what} from #{self.to_s}"
+    puts "Do not panic. Thank you for your patience. #{@@delayed_class_message} at #{Time.now}!"
+  end
+  
+  def self.delayed_class_message
+    @@delayed_class_message
+  end
+
+  def self.delayed_message
+    @@delayed_message
+  end
+
+end

data/test/redis-test.conf

@@ -0,0 +1,132 @@
+# Redis configuration file example
+
+# By default Redis does not run as a daemon. Use 'yes' if you need it.
+# Note that Redis will write a pid file in /var/run/redis.pid when daemonized.
+daemonize yes
+
+# When run as a daemon, Redis write a pid file in /var/run/redis.pid by default.
+# You can specify a custom pid file location here.
+pidfile ./test/redis-test.pid
+
+# Accept connections on the specified port, default is 6379
+port 9736
+
+# If you want you can bind a single interface, if the bind option is not
+# specified all the interfaces will listen for connections.
+#
+# bind 127.0.0.1
+
+# Close the connection after a client is idle for N seconds (0 to disable)
+timeout 300
+
+# Save the DB on disk:
+#
+#   save <seconds> <changes>
+#
+#   Will save the DB if both the given number of seconds and the given
+#   number of write operations against the DB occurred.
+#
+#   In the example below the behaviour will be to save:
+#   after 900 sec (15 min) if at least 1 key changed
+#   after 300 sec (5 min) if at least 10 keys changed
+#   after 60 sec if at least 10000 keys changed
+save 900 1
+save 300 10
+save 60 10000
+
+# The filename where to dump the DB
+dbfilename dump.rdb
+
+# For default save/load DB in/from the working directory
+# Note that you must specify a directory not a file name.
+dir ./test/
+
+# Set server verbosity to 'debug'
+# it can be one of:
+# debug (a lot of information, useful for development/testing)
+# notice (moderately verbose, what you want in production probably)
+# warning (only very important / critical messages are logged)
+loglevel debug
+
+# Specify the log file name. Also 'stdout' can be used to force
+# the demon to log on the standard output. Note that if you use standard
+# output for logging but daemonize, logs will be sent to /dev/null
+logfile stdout
+
+# Set the number of databases. The default database is DB 0, you can select
+# a different one on a per-connection basis using SELECT <dbid> where
+# dbid is a number between 0 and 'databases'-1
+databases 16
+
+################################# REPLICATION #################################
+
+# Master-Slave replication. Use slaveof to make a Redis instance a copy of
+# another Redis server. Note that the configuration is local to the slave
+# so for example it is possible to configure the slave to save the DB with a
+# different interval, or to listen to another port, and so on.
+
+# slaveof <masterip> <masterport>
+
+################################## SECURITY ###################################
+
+# Require clients to issue AUTH <PASSWORD> before processing any other
+# commands.  This might be useful in environments in which you do not trust
+# others with access to the host running redis-server.
+#
+# This should stay commented out for backward compatibility and because most
+# people do not need auth (e.g. they run their own servers).
+
+# requirepass foobared
+
+################################### LIMITS ####################################
+
+# Set the max number of connected clients at the same time. By default there
+# is no limit, and it's up to the number of file descriptors the Redis process
+# is able to open. The special value '0' means no limts.
+# Once the limit is reached Redis will close all the new connections sending
+# an error 'max number of clients reached'.
+
+# maxclients 128
+
+# Don't use more memory than the specified amount of bytes.
+# When the memory limit is reached Redis will try to remove keys with an
+# EXPIRE set. It will try to start freeing keys that are going to expire
+# in little time and preserve keys with a longer time to live.
+# Redis will also try to remove objects from free lists if possible.
+#
+# If all this fails, Redis will start to reply with errors to commands
+# that will use more memory, like SET, LPUSH, and so on, and will continue
+# to reply to most read-only commands like GET.
+#
+# WARNING: maxmemory can be a good idea mainly if you want to use Redis as a
+# 'state' server or cache, not as a real DB. When Redis is used as a real
+# database the memory usage will grow over the weeks, it will be obvious if
+# it is going to use too much memory in the long run, and you'll have the time
+# to upgrade. With maxmemory after the limit is reached you'll start to get
+# errors for write operations, and this may even lead to DB inconsistency.
+
+# maxmemory <bytes>
+
+############################### ADVANCED CONFIG ###############################
+
+# Glue small output buffers together in order to send small replies in a
+# single TCP packet. Uses a bit more CPU but most of the times it is a win
+# in terms of number of queries per second. Use 'yes' if unsure.
+glueoutputbuf yes
+
+# Use object sharing. Can save a lot of memory if you have many common
+# string in your dataset, but performs lookups against the shared objects
+# pool so it uses more CPU and can be a bit slower. Usually it's a good
+# idea.
+#
+# When object sharing is enabled (shareobjects yes) you can use
+# shareobjectspoolsize to control the size of the pool used in order to try
+# object sharing. A bigger pool size will lead to better sharing capabilities.
+# In general you want this value to be at least the double of the number of
+# very common strings you have in your dataset.
+#
+# WARNING: object sharing is experimental, don't enable this feature
+# in production before of Redis 1.0-stable. Still please try this feature in
+# your development environment so that we can test it better.
+#shareobjects no
+#shareobjectspoolsize 1024

data/test/send_later_test.rb

@@ -0,0 +1,31 @@
+require File.expand_path('test_helper.rb', File.dirname(__FILE__))
+
+class SendLaterTest < Test::Unit::TestCase
+
+  def setup
+    $success = $lock_failed = $lock_expired = 0
+    Resque.redis.flushall
+    @worker = Resque::Worker.new(:method)
+  end
+
+  def test_lint
+    assert_nothing_raised do
+      Resque::Plugin.lint(Resque::Plugins::SendLater)
+    end
+  end
+
+  def test_instance_send_later
+    t = TestThing.new
+    t.id = 11
+    t.ask_now('instance request')
+    @worker.process
+    assert_equal TestThing.delayed_message, "You got instance request from 11"
+  end
+
+  def test_class_send_later
+    TestThing.ask_now('class request')
+    @worker.process
+    assert_equal TestThing.delayed_class_message, 'You got class request from TestThing'
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,44 @@
+dir = File.dirname(File.expand_path(__FILE__))
+$LOAD_PATH.unshift dir + '/../lib'
+$TESTING = true
+
+require 'rubygems'
+require 'test/unit'
+require 'resque'
+require 'active_support'
+require 'active_support/test_case'
+
+require 'logger'
+require '../revrails/vendor/plugins/spawn/lib/spawn'
+require 'resque-send-later'
+
+# make sure we can run redis
+if !system('which redis-server')
+  puts '', "** can't find `redis-server` in your path"
+  puts "** try running `sudo rake install`"
+  abort ''
+end
+
+# start our own redis when the tests start,
+# kill it when they end
+at_exit do
+  next if $!
+
+  if defined?(MiniTest)
+    exit_code = MiniTest::Unit.new.run(ARGV)
+  else
+    exit_code = Test::Unit::AutoRunner.run
+  end
+
+  pid = `ps -e -o pid,command | grep [r]edis-test`.split(" ")[0]
+  puts 'Killing test redis server...'
+  `rm -f #{dir}/dump.rdb`
+  Process.kill('KILL', pid.to_i)
+  exit exit_code
+end
+
+puts 'Starting redis for testing at localhost:9736...'
+`redis-server #{dir}/redis-test.conf`
+Resque.redis = '127.0.0.1:9736'
+
+Dir.glob(File.expand_path(dir + '/fixtures/*')).each { |filename| require filename }

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification 
+name: resque-send-later
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Monica McArthur
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-17 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: resque
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 39
+        segments: 
+        - 1
+        - 9
+        - 10
+        version: 1.9.10
+  type: :runtime
+  version_requirements: *id001
+description: "    A Resque plugin. Implements an approximation of DelayedJob's send_later on resque. Has a little more ease-of-use and features than the example provided with Resque.\n"
+email: mechaferret@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.md
+- Rakefile
+- MIT-LICENSE
+- HISTORY.md
+- lib/resque/plugins/send_later.rb
+- lib/resque-send-later.rb
+- test/fixtures/test_thing.rb
+- test/redis-test.conf
+- test/send_later_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/mechaferret/resque-send-later
+licenses: []
+
+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.3.7
+signing_key: 
+specification_version: 3
+summary: A Resque plugin that implements an approximation of DelayedJob's send_later on resque.
+test_files: []
+