resque-meta 1.0.3 → 2.0.0

data/README.md

@@ -1,7 +1,9 @@
 Resque Meta
 ===========
 
-A [Resque][rq] plugin. Requires Resque 1.8.
+[![Build Status](https://secure.travis-ci.org/lmarlow/resque-meta.png)](http://travis-ci.org/lmarlow/resque-meta)
+
+A [Resque][rq] plugin. Requires Resque 1.8 and Redis 2+.
 
 If you want to be able to add metadata for a job
 to track anything you want, extend it with this module.

data/lib/resque/plugins/meta.rb

@@ -47,6 +47,17 @@ module Resque
         24 * 60 * 60
       end
 
+      # Override in your job to control how many seconds a job's
+      # metadata will live after it is enqueued and *before* it finishes.
+      # This includes the condition
+      # where the job and metadata are never finished because of a
+      # shutdown or server crash. Defaults to 0 (i.e.
+      # forever).  Return nil or 0 to set them to never expire.
+      # Use caution: this value should be longer than your jobs take to run!
+      def before_finish_expire_in
+        0
+      end
+
       # Enqueues a job in Resque and return the association metadata.
       # The meta_id in the returned object can be used to fetch the
       # metadata again in the future.
@@ -60,8 +71,11 @@ module Resque
       def store_meta(meta)
         key = "meta:#{meta.meta_id}"
         json = Resque.encode(meta.data)
-        Resque.redis.set(key, json)
-        Resque.redis.expireat("resque:#{key}", meta.expire_at) if meta.expire_at > 0
+        if meta.expire_at > 0
+          Resque.redis.setex(key, meta.expire_at - Time.now.to_i, json)
+        else
+          Resque.redis.set(key, json)
+        end
         meta
       end
 

data/lib/resque/plugins/meta/metadata.rb

@@ -4,7 +4,7 @@ module Resque
   module Plugins
     module Meta
       class Metadata
-        attr_reader :job_class, :meta_id, :data, :enqueued_at, :expire_in
+        attr_reader :job_class, :meta_id, :data, :enqueued_at, :expire_in, :before_finish_expire_in
 
         def initialize(data_hash)
           data_hash['enqueued_at'] ||= to_time_format_str(Time.now)
@@ -18,6 +18,7 @@ module Resque
             data_hash['job_class'] = @job_class.to_s
           end
           @expire_in = @job_class.expire_meta_in || 0
+          @before_finish_expire_in = @job_class.before_finish_expire_in || 0
         end
 
         # Reload the metadata from the store
@@ -64,8 +65,13 @@ module Resque
         end
 
         def expire_at
+          # expiry after finished
           if finished? && expire_in > 0
             finished_at.to_i + expire_in
+          # expiry after enqueued
+          elsif before_finish_expire_in > 0
+            enqueued_at.to_i + before_finish_expire_in
+          # default ttl is forever
           else
             0
           end

data/lib/resque/plugins/meta/version.rb

@@ -1,7 +1,7 @@
 module Resque
   module Plugins
     module Meta
-      Version = '1.0.3'
+      Version = '2.0.0'
     end
   end
 end

data/test/meta_test.rb

@@ -49,13 +49,25 @@ class FailingJob
   end
 end
 
+class TransientJob
+  extend Resque::Plugins::Meta
+  @queue = :test
+
+  def self.perform(meta_id)
+  end
+
+  def self.before_finish_expire_in
+    1
+  end
+end
+
 class MetaTest < Test::Unit::TestCase
   def setup
     Resque.redis.flushall
   end
 
   def test_meta_version
-    assert_equal '1.0.3', Resque::Plugins::Meta::Version
+    assert_equal '2.0.0', Resque::Plugins::Meta::Version
   end
 
   def test_lint
@@ -120,6 +132,16 @@ class MetaTest < Test::Unit::TestCase
     assert_nil meta
   end
 
+  def test_expired_metadata_before_finished
+    meta = TransientJob.enqueue()
+    worker = Resque::Worker.new(:test)
+    assert meta = TransientJob.get_meta(meta.meta_id)
+
+    sleep 2
+    meta = TransientJob.get_meta(meta.meta_id)
+    assert_equal nil, meta
+  end
+
   def test_slow_job
     meta = SlowJob.enqueue('foo', 'bar')
     worker = Resque::Worker.new(:test)

data/test/redis-test.conf

@@ -109,11 +109,6 @@ databases 16
 
 ############################### 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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: resque-meta
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 15
   prerelease: 
   segments: 
-  - 1
+  - 2
   - 0
-  - 3
-  version: 1.0.3
+  - 0
+  version: 2.0.0
 platform: ruby
 authors: 
 - Lee Marlow
@@ -15,13 +15,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-10 00:00:00 -07:00
-default_executable: 
+date: 2012-12-04 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: resque
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -32,7 +30,38 @@ dependencies:
         - 8
         version: "1.8"
   type: :runtime
-  version_requirements: *id001
+  requirement: *id001
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  name: rake
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 63
+        segments: 
+        - 0
+        - 9
+        - 2
+        version: 0.9.2
+  type: :development
+  requirement: *id002
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  name: json
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  requirement: *id003
+  prerelease: false
 description: |
   A Resque plugin.  If you want to be able to add metadata for a job
   to track anything you want, extend it with this module.
@@ -79,7 +108,6 @@ files:
 - test/meta_test.rb
 - test/redis-test.conf
 - test/test_helper.rb
-has_rdoc: false
 homepage: http://github.com/lmarlow/resque-meta
 licenses: []
 
@@ -109,7 +137,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.4.2
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: A Resque plugin for storing job metadata.