resque-status 0.1.5 → 0.2.0

data/README.rdoc

@@ -94,6 +94,21 @@ Its also possible to get a list of current/recent job statuses:
 
   Resque::Status.statuses #=> [#<Resque::Status>, ...]
 
+=== Passing back data from the job
+
+You may want to save data from inside the job to access it from outside the job.
+
+A common use-case is web-triggered jobs that create files, later available for
+download by the user.
+
+A Status is actually just a hash, so inside a job you can do:
+
+    status['filename'] = '/myfilename'
+
+Also, all the status setting methods take any number of hash arguments. So you could do:
+
+    complete('filename' => '/myfilename')
+
 === Kill! Kill! Kill!
 
 Because we're tracking UUIDs per instance, and we're checking in/updating the status

data/lib/resque/job_with_status.rb

@@ -87,6 +87,13 @@ module Resque
       instance.safe_perform!
       instance
     end
+    
+    # Wrapper API to forward a Resque::Job creation API call into a JobWithStatus call.
+    # This is needed to be used with resque scheduler
+    # http://github.com/bvandenbos/resque-scheduler
+    def self.scheduled(queue, klass, *args)
+      create(args)
+    end
 
     # Create a new instance with <tt>uuid</tt> and <tt>options</tt>
     def initialize(uuid, options = {})
@@ -99,15 +106,22 @@ module Resque
     # If an error occurs within the job's work, it will set the status as failed and 
     # re-raise the error.
     def safe_perform!
+      set_status({'status' => 'working'})
       perform
       completed unless status && status.completed?
+      on_success if respond_to?(:on_success)
     rescue Killed
       logger.info "Job #{self} Killed at #{Time.now}"
       Resque::Status.killed(uuid)
+      on_killed if respond_to?(:on_killed)
     rescue => e
       logger.error e
       failed("The task failed because of an error: #{e}")
-      raise e
+      if respond_to?(:on_failure)
+        on_failure(e)
+      else
+        raise e
+      end
     end
 
     # Returns a Redisk::Logger object scoped to this paticular job/uuid

data/lib/resque/server/views/statuses.erb

@@ -39,6 +39,10 @@
   <% end %>
 </table>
 
+<% unless @statuses.empty? %>
+	<%= partial :next_more, :start => @start, :size => @size %>
+<% end %>
+
 <%= poll %>
 
 <script type="text/javascript" charset="utf-8">

data/lib/resque/status.rb

@@ -3,11 +3,11 @@ require 'redisk'
 require 'uuid'
 
 module Resque
-  # Resque::Status is a Hash object that has helper methods for dealing with 
-  # the common status attributes. It also has a number of class methods for 
+  # Resque::Status is a Hash object that has helper methods for dealing with
+  # the common status attributes. It also has a number of class methods for
   # creating/updating/retrieving status objects from Redis
   class Status < Hash
-    VERSION = '0.1.5'
+    VERSION = '0.2.0'
 
     extend Resque::Helpers
 
@@ -33,18 +33,18 @@ module Resque
       val = Resque::Status.new(uuid, *messages)
       redis.set(status_key(uuid), encode(val))
       if expire_in
-        redis.expire(status_key(uuid), expire_in) 
+        redis.expire(status_key(uuid), expire_in)
       end
       val
     end
-    
+
     def self.clear
       status_ids.each do |id|
         redis.del(status_key(id))
         redis.zrem(set_key, id)
       end
     end
-    
+
     # returns a Redisk::Logger scoped to the UUID. Any options passed are passed
     # to the logger initialization.
     #
@@ -54,53 +54,77 @@ module Resque
       Redisk::Logger.new(logger_key(uuid), options)
     end
 
+    def self.count
+      redis.zcard(set_key)
+    end
+
     # Return <tt>num</tt> Resque::Status objects in reverse chronological order.
     # By default returns the entire set.
-    def self.statuses(num = -1)
-      status_ids(num).collect do |id|
+    # @param [Numeric] range_start The optional starting range
+    # @param [Numeric] range_end The optional ending range
+    # @example retuning the last 20 statuses
+    #   Resque::Status.statuses(0, 20)
+    def self.statuses(range_start=nil, range_end=nil)
+      status_ids(range_start, range_end).collect do |id|
         get(id)
       end.compact
     end
-    
+
     # Return the <tt>num</tt> most recent status/job UUIDs in reverse chronological order.
-    def self.status_ids(num = -1)
-      redis.zrevrange(set_key, 0, num) || []
+    def self.status_ids(range_start=nil, range_end=nil)
+      unless range_end && range_start
+        # Because we want a reverse chronological order, we need to get a range starting
+        # by the higest negative number.
+        redis.zrevrange(set_key, 0, -1) || []
+      else
+        # Because we want a reverse chronological order, we need to get a range starting
+        # by the higest negative number. The ordering is transparent from the API user's
+        # perspective so we need to convert the passed params
+        if range_start == 0
+          range_start = -1
+        else
+          range_end -= 1
+        end
+
+
+        (redis.zrevrange(set_key, -(range_end.abs), -(range_start.abs)) || []).reverse
+      end
     end
-                                                                                          
+
     # Kill the job at UUID on its next iteration this works by adding the UUID to a
-    # kill list (a.k.a. a list of jobs to be killed. Each iteration the job checks 
+    # kill list (a.k.a. a list of jobs to be killed. Each iteration the job checks
     # if it _should_ be killed by calling <tt>tick</tt> or <tt>at</tt>. If so, it raises
     # a <tt>Resque::JobWithStatus::Killed</tt> error and sets the status to 'killed'.
-    def self.kill(uuid)                 
+    def self.kill(uuid)
       redis.sadd(kill_key, uuid)
     end
-    
+
     # Remove the job at UUID from the kill list
     def self.killed(uuid)
       redis.srem(kill_key, uuid)
     end
-    
+
     # Return the UUIDs of the jobs on the kill list
     def self.kill_ids
       redis.smembers(kill_key)
     end
-    
+
     # Check whether a job with UUID is on the kill list
     def self.should_kill?(uuid)
       redis.sismember(kill_key, uuid)
     end
-    
+
     # The time in seconds that jobs and statuses should expire from Redis (after
     # the last time they are touched/updated)
     def self.expire_in
       @expire_in
     end
-    
+
     # Set the <tt>expire_in</tt> time in seconds
     def self.expire_in=(seconds)
       @expire_in = seconds.nil? ? nil : seconds.to_i
     end
-    
+
     def self.status_key(uuid)
       "status:#{uuid}"
     end
@@ -111,7 +135,7 @@ module Resque
 
     def self.kill_key
       "_kill"
-    end 
+    end
 
     def self.logger_key(uuid)
       "_log:#{uuid}"
@@ -122,7 +146,7 @@ module Resque
     end
 
     def self.hash_accessor(name, options = {})
-      options[:default] ||= nil 
+      options[:default] ||= nil
       coerce = options[:coerce] ? ".#{options[:coerce]}" : ""
       module_eval <<-EOT
       def #{name}
@@ -151,10 +175,10 @@ module Resque
 
     hash_accessor :num
     hash_accessor :total
-    
+
     # Create a new Resque::Status object. If multiple arguments are passed
     # it is assumed the first argument is the UUID and the rest are status objects.
-    # All arguments are subsequentily merged in order. Strings are assumed to 
+    # All arguments are subsequentily merged in order. Strings are assumed to
     # be messages.
     def initialize(*args)
       super nil
@@ -169,7 +193,7 @@ module Resque
       end
       self.replace(status_hash)
     end
-    
+
     # calculate the % completion of the job based on <tt>status</tt>, <tt>num</tt>
     # and <tt>total</tt>
     def pct_complete
@@ -182,7 +206,7 @@ module Resque
         (((num || 0).to_f / t.to_f) * 100).to_i
       end
     end
-    
+
     # Return the time of the status initialization. If set returns a <tt>Time</tt>
     # object, otherwise returns nil
     def time
@@ -191,22 +215,22 @@ module Resque
 
     STATUSES.each do |status|
       define_method("#{status}?") do
-        self['status'] === status 
+        self['status'] === status
       end
     end
-    
+
     # Can the job be killed? 'failed', 'completed', and 'killed' jobs cant be killed
     # (for pretty obvious reasons)
     def killable?
       !['failed', 'completed', 'killed'].include?(self.status)
     end
-    
+
     unless method_defined?(:to_json)
       def to_json(*args)
         json
       end
     end
-    
+
     # Return a JSON representation of the current object.
     def json
       h = self.dup

data/lib/resque/status_server.rb

@@ -8,7 +8,10 @@ module Resque
     def self.registered(app)
       
       app.get '/statuses' do
-        @statuses = Resque::Status.statuses
+        @start = params[:start].to_i
+        @end = @start + (params[:per_page] || 50)
+        @statuses = Resque::Status.statuses(@start, @end)
+        @size = @statuses.size
         status_view(:statuses)
       end
       

data/resque-status.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{resque-status}
-  s.version = "0.1.5"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Aaron Quint"]
-  s.date = %q{2010-08-23}
+  s.date = %q{2010-10-11}
   s.description = %q{resque-status is an extension to the resque queue system that provides simple trackable jobs. It provides a Resque::Status class which can set/get the statuses of jobs and a Resque::JobWithStatus class that when subclassed provides easily trackable/killable jobs.}
   s.email = %q{aaron@quirkey.com}
   s.extra_rdoc_files = [

data/test/test_resque-status.rb

@@ -87,8 +87,21 @@ class TestResqueStatus < Test::Unit::TestCase
     end
     
     context ".status_ids" do
+      
+      setup do
+        @uuids = []
+        30.times{ Resque::Status.create }
+      end
+    
       should "return an array of job ids" do
         assert Resque::Status.status_ids.is_a?(Array)
+        assert_equal 32, Resque::Status.status_ids.size # 30 + 2
+      end
+      
+      should "let you paginate through the statuses" do
+        assert_equal Resque::Status.status_ids.reverse[0, 10], Resque::Status.status_ids(0, 10)
+        assert_equal Resque::Status.status_ids.reverse[9, 10], Resque::Status.status_ids(10, 20)
+        # assert_equal Resque::Status.status_ids.reverse[0, 10], Resque::Status.status_ids(0, 10)
       end
     end
     
@@ -102,6 +115,16 @@ class TestResqueStatus < Test::Unit::TestCase
       
     end
     
+    # context ".count" do
+    #   
+    #   should "return a count of statuses" do
+    #     statuses = Resque::Status.statuses
+    #     assert_equal 2, statuses.size
+    #     assert_equal statuses.size, Resque::Status.count
+    #   end
+    #   
+    # end
+    
     context ".logger" do
       setup do
         @logger = Resque::Status.logger(@uuid)

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: resque-status
 version: !ruby/object:Gem::Version 
+  hash: 23
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 5
-  version: 0.1.5
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Aaron Quint
@@ -14,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-23 00:00:00 -07:00
+date: 2010-10-11 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -25,6 +26,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 11
         segments: 
         - 2
         - 0
@@ -40,6 +42,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 25
         segments: 
         - 1
         - 3
@@ -55,6 +58,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 21
         segments: 
         - 0
         - 2
@@ -70,6 +74,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 35
         segments: 
         - 2
         - 10
@@ -85,6 +90,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 43
         segments: 
         - 0
         - 9
@@ -134,6 +140,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
@@ -142,6 +149,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"