resque-restriction 0.2.1 → 0.2.2

data/.gitignore

@@ -1,2 +1,4 @@
 spec/dump.rdb
 pkg/**
+.idea
+

data/VERSION

@@ -1 +1 @@
-0.2.1
+0.2.2

data/lib/resque-restriction/job.rb

@@ -4,12 +4,28 @@ module Resque
       alias_method :origin_reserve, :reserve
       
       def reserve(queue)
-        if queue == 'restriction' && payload = Resque.pop(queue)
-          constantize(payload['class']).repush(*payload['args'])
-          return
+        if queue =~ /^#{Plugins::Restriction::RESTRICTION_QUEUE_PREFIX}/
+          # If processing the restriction queue, when poping and pushing to end,
+          # we can't tell when we reach the original one, so just walk the length
+          # of the queue so we don't run infinitely long
+          Resque.size(queue).times do |i|
+            # For the job at the head of the queue, repush to restricition queue
+            # if still restricted, otherwise we have a runnable job, so create it
+            # and return
+            payload = Resque.pop(queue)
+            if payload
+              if ! constantize(payload['class']).repush(*payload['args'])
+                return new(queue, payload)
+              end
+            end
+          end
+          return nil
+        else
+          # drop through to original Job::Reserve if not restriction queue
+          origin_reserve(queue)
         end
-        origin_reserve(queue)
       end
+
     end
   end
 end

data/lib/resque-restriction/restriction_job.rb

@@ -9,6 +9,7 @@ module Resque
         :per_month => 31*24*60*60,
         :per_year => 366*24*60*60
       }
+      RESTRICTION_QUEUE_PREFIX = 'restriction'
 
       def settings
         @options ||= {}
@@ -40,7 +41,7 @@ module Resque
               # reincrement the keys if one of the periods triggers DontPerform so
               # that we accurately track capacity
               keys_decremented.each {|k| Resque.redis.incrby(k, 1) }
-              Resque.push "restriction", :class => to_s, :args => args
+              Resque.push restriction_queue_name, :class => to_s, :args => args
               raise Resque::Job::DontPerform
             end
           end
@@ -72,6 +73,11 @@ module Resque
         self.to_s
       end
 
+      def restriction_queue_name
+        queue_name = Resque.queue_from_class(self)
+        "#{RESTRICTION_QUEUE_PREFIX}_#{queue_name}"
+      end
+
       def seconds(period)
         if SECONDS.keys.include? period
           SECONDS[period]
@@ -80,18 +86,23 @@ module Resque
         end
       end
 
+      # if job is still restricted, push back to restriction queue, otherwise push
+      # to real queue.  Since the restrictions will be checked again when run from
+      # real queue, job will just get pushed back onto restriction queue then if
+      # restriction conditions have changed
       def repush(*args)
-        no_restrictions = true
-        queue_name = Resque.queue_from_class(self)
+        has_restrictions = false
         settings.each do |period, number|
           key = redis_key(period, *args)
           value = Resque.redis.get(key)
-          no_restrictions &&= (value.nil? or value == "" or value.to_i > 0)
+          has_restrictions = value && value != "" && value.to_i <= 0
+          break if has_restrictions
         end
-        if no_restrictions
-          Resque.push queue_name, :class => to_s, :args => args
+        if has_restrictions
+          Resque.push restriction_queue_name, :class => to_s, :args => args
+          return true
         else
-          Resque.push "restriction", :class => to_s, :args => args
+          return false
         end
       end
 

data/resque-restriction.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{resque-restriction}
-  s.version = "0.2.1"
+  s.version = "0.2.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Richard Huang"]
-  s.date = %q{2010-07-10}
+  s.date = %q{2010-09-09}
   s.description = %q{resque-restriction is an extension to resque queue system that restricts the execution number of certain jobs in a period time, the exceeded jobs will be executed at the next period.}
   s.email = %q{flyerhzm@gmail.com}
   s.extra_rdoc_files = [

data/spec/resque-restriction/job_spec.rb

@@ -1,20 +1,22 @@
 require File.join(File.dirname(__FILE__) + '/../spec_helper')
 
 describe Resque::Job do
-  it "should repush restriction queue when reserve" do
+  before(:each) do
     Resque.redis.flushall
-    Resque.push('restriction', :class => 'OneHourRestrictionJob', :args => ['any args'])
-    Resque::Job.reserve('restriction').should be_nil
-    Resque::Job.reserve('normal').should == Resque::Job.new('normal', {'class' => 'OneHourRestrictionJob', 'args' => ['any args']})
+  end
+
+  it "should repush restriction queue when reserve" do
+    Resque.push('restriction_normal', :class => 'OneHourRestrictionJob', :args => ['any args'])
+    Resque::Job.reserve('restriction_normal').should == Resque::Job.new('restriction_normal', {'class' => 'OneHourRestrictionJob', 'args' => ['any args']})
+    Resque::Job.reserve('restriction_normal').should be_nil
     Resque::Job.reserve('normal').should be_nil
   end
 
   it "should push back to restriction queue when still restricted" do
-    Resque.redis.flushall
     Resque.redis.set(OneHourRestrictionJob.redis_key(:per_hour), -1)
-    Resque.push('restriction', :class => 'OneHourRestrictionJob', :args => ['any args'])
-    Resque::Job.reserve('restriction').should be_nil
-    Resque.pop('restriction').should == {'class' => 'OneHourRestrictionJob', 'args' => ['any args']}
+    Resque.push('restriction_normal', :class => 'OneHourRestrictionJob', :args => ['any args'])
+    Resque::Job.reserve('restriction_normal').should be_nil
+    Resque.pop('restriction_normal').should == {'class' => 'OneHourRestrictionJob', 'args' => ['any args']}
     Resque::Job.reserve('normal').should be_nil
   end
 
@@ -22,5 +24,16 @@ describe Resque::Job do
     Resque.push('normal', :class => 'OneHourRestrictionJob', :args => ['any args'])
     Resque::Job.reserve('normal').should == Resque::Job.new('normal', {'class' => 'OneHourRestrictionJob', 'args' => ['any args']})
     Resque::Job.reserve('normal').should be_nil
+    Resque::Job.reserve('restriction_normal').should be_nil
   end
+
+  it "should only push back queue_length times to restriction queue" do
+    Resque.redis.set(OneHourRestrictionJob.redis_key(:per_hour), -1)
+    3.times { Resque.push('restriction_normal', :class => 'OneHourRestrictionJob', :args => ['any args']) }
+    Resque.size('restriction_normal').should == 3
+    OneHourRestrictionJob.should_receive(:repush).exactly(3).times.and_return(true)
+    Resque::Job.reserve('restriction_normal')
+  end
+
+
 end

data/spec/resque-restriction/restriction_job_spec.rb

@@ -82,7 +82,7 @@ describe Resque::Plugins::RestrictionJob do
       result = perform_job(OneHourRestrictionJob, "any args")
       result.should_not be_true
       Resque.redis.get(OneHourRestrictionJob.redis_key(:per_hour)).should == "0"
-      Resque.redis.lrange("queue:restriction", 0, -1).should == [Resque.encode(:class => "OneHourRestrictionJob", :args => ["any args"])]
+      Resque.redis.lrange("queue:restriction_normal", 0, -1).should == [Resque.encode(:class => "OneHourRestrictionJob", :args => ["any args"])]
     end
 
     context "multiple restrict" do
@@ -107,5 +107,20 @@ describe Resque::Plugins::RestrictionJob do
         Resque.redis.get(MultipleRestrictionJob.redis_key(:per_300)).should == "1"
       end
     end
+
+    context "repush" do
+      it "should push restricted jobs onto restriction queue" do
+        Resque.redis.set(OneHourRestrictionJob.redis_key(:per_hour), -1)
+        Resque.should_receive(:push).once.with('restriction_normal', :class => 'OneHourRestrictionJob', :args => ['any args'])
+        OneHourRestrictionJob.repush('any args').should be_true
+      end
+
+      it "should not push unrestricted jobs onto restriction queue" do
+        Resque.redis.set(OneHourRestrictionJob.redis_key(:per_hour), 1)
+        Resque.should_not_receive(:push)
+        OneHourRestrictionJob.repush('any args').should be_false
+      end
+
+    end
   end
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 1
-  version: 0.2.1
+  - 2
+  version: 0.2.2
 platform: ruby
 authors: 
 - Richard Huang
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-10 00:00:00 +08:00
+date: 2010-09-09 00:00:00 +08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency