resque-rate_limited_queue 1.0.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0adf19f43b30aaaa865beda17e99e2082b5f6301
-  data.tar.gz: 7260656ade9a2e129ccf07ac137ecd5c010aee45
+  metadata.gz: 10b17055e5a285f6724e2bb8b857e8258b78dfd5
+  data.tar.gz: 144bf7bb14973f0e3e1a317c58aff1f46965c4f6
 SHA512:
-  metadata.gz: c978c05cc91e3c24d0a685af044e0f2791bff20b08f864a4d12722ab7a9779d94cdef347c242c6cf749eec99b45bb223204b65489afa1e9ae017d72459dc50c9
-  data.tar.gz: 0c6b146eedb305a0522bf920b69600c8339e9e23c62e8ecaaf5d8be9019f1184d0aa60fdf2122ee797716b493fa203c181412e0ff660f8ee3f21ffed5c777d90
+  metadata.gz: 048a567b7ffc945ec45334e215c55f86596569f9780b1e3564b067b4fb83935ab08e5fdde8a0a79f339a2226900d15f67014c0daba1f31c636e01a03d148597a
+  data.tar.gz: 294537d08ab7611a9611658d4ae53fdaad4b3bbb37e73d936004cec4fb4dcdba82f6cbdf29ef05a1bf19b9e3a812d625b14ac8b52a8c38a5aa00cd4a312af475

data/README.md

@@ -15,7 +15,7 @@ If you are using another API, then you need to write a little code that catches
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'resque-rate-limited-queue'
+gem 'resque-rate_limited_queue'
 ```
 
 And then execute:
@@ -24,7 +24,7 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install resque-rate-limited-queue
+    $ gem install resque-rate_limited_queue
 
 ## Usage
 
@@ -80,8 +80,8 @@ Resque::Plugins::RateLimitedQueue.AngellistQueue.un_pause
 MyQueue.un_pause
 MyJob.un_pause
 ```
-### A Pausable job using one of the build-in queues (Twitter, Angellist, Evernote)
-If you're using the [twitter gem[ (https://github.com/sferik/twitter), this is really simple. Instead of queuing using Resque.enqueue, you just use Resque::Plugins::RateLimitedQueue:TwitterQueue.enqueue.
+### A pausable job using one of the build-in queues (Twitter, Angellist, Evernote)
+If you're using the [twitter gem](https://github.com/sferik/twitter), this is really simple. Instead of queuing using Resque.enqueue, you just use Resque::Plugins::RateLimitedQueue:TwitterQueue.enqueue.
 
 Make sure your code in perform doesn't catch the rate_limit exception.
 
@@ -124,7 +124,7 @@ end
 ````
 
 ### Multiple classes of pausable job using a new api
-If you have more than one class of job you want to queue to the api, then you can need to add another Queue class. This isn't hard
+If you have more than one class of job you want to queue to the api, then you need to add another Queue class. This isn't hard
 
 ```ruby
 class MyApiQueue < Resque::Plugins::RateLimitedQueue::BaseApiQueue
@@ -148,7 +148,8 @@ All the functions are class methods
 rate_limited_enqueue(klass, *params)
 rate_limited_requeue(klass, *params)
 ````
-Queue the job specified to the resque queue specified by `@queue`. `rate_limited_requeue` is intended for use when you need the job to be pushed back to the queue; it just calls `rate_limited_queue`, but they are split to make testing with stubs easier.
+Queue the job specified to the resque queue specified by `@queue`. `rate_limited_requeue` is intended for use when you need the job to be pushed back to the queue; there are two reasons to split this from `queue`. Firstly it makes testing easier - secondly there is a boundary condition when you need to requeue the last job in the queue.
+`, but they are split to make testing with stubs easier.
 
 ```ruby
 pause

data/lib/resque-rate_limited_queue/version.rb

@@ -1,3 +1,3 @@
 module RateLimitedQueue
-  VERSION = '1.0.0'
+  VERSION = '1.0.2'
 end

data/lib/resque/plugins/rate_limited_queue/rate_limited_queue.rb

@@ -25,8 +25,14 @@ module Resque
       end
 
       def rate_limited_requeue(klass, *params)
-        # split from above to make it easy to stub for testing
-        rate_limited_enqueue(klass, *params)
+        # if the queue is empty, this was the last job - so queue to the paused queue
+        with_lock do
+          if paused?(true)
+            Resque.enqueue_to(paused_queue_name, klass, *params)
+          else
+            Resque.enqueue_to(@queue, klass, *params)
+          end
+        end
       end
 
       def pause_until(timestamp)
@@ -49,8 +55,15 @@ module Resque
         false
       end
 
-      def paused?
-        Resque.redis.exists(RESQUE_PREFIX + paused_queue_name)
+      def paused?(unknown = false)
+        # parameter is what to return if the queue is empty, and so the state is unknown
+        if Resque.redis.exists(RESQUE_PREFIX + @queue.to_s)
+          false
+        elsif Resque.redis.exists(RESQUE_PREFIX + paused_queue_name)
+          true
+        else
+          unknown
+        end
       end
 
       def paused_queue_name

data/spec/rate_limited_queue_spec.rb

@@ -10,11 +10,11 @@ class RateLimitedTestQueue
     rate_limited_requeue(self, succeed) unless succeed
   end
 
-  def self.queue_name
+  def self.queue_name_private
     @queue.to_s
   end
 
-  def self.queue
+  def self.queue_private
     @queue
   end
 end
@@ -26,7 +26,7 @@ describe Resque::Plugins::RateLimitedQueue do
 
   shared_examples_for 'queue' do |queue_suffix|
     it 'should queue to the correct queue' do
-      queue_param = queue_suffix.empty? ? RateLimitedTestQueue.queue : "#{RateLimitedTestQueue.queue_name}#{queue_suffix}"
+      queue_param = queue_suffix.empty? ? RateLimitedTestQueue.queue_private : "#{RateLimitedTestQueue.queue_name_private}#{queue_suffix}"
       Resque.should_receive(:enqueue_to).with(queue_param, nil, nil)
       RateLimitedTestQueue.rate_limited_enqueue(nil, nil)
     end
@@ -55,19 +55,18 @@ describe Resque::Plugins::RateLimitedQueue do
         Resque.should_not_receive(:enqueue_to)
         RateLimitedTestQueue.perform(true)
       end
-
     end
 
     describe 'pause' do
       it 'should rename the queue to paused' do
-        Resque.redis.should_receive(:renamenx).with("queue:#{RateLimitedTestQueue.queue_name}", "queue:#{RateLimitedTestQueue.queue_name}_paused")
+        Resque.redis.should_receive(:renamenx).with("queue:#{RateLimitedTestQueue.queue_name_private}", "queue:#{RateLimitedTestQueue.queue_name_private}_paused")
         RateLimitedTestQueue.pause
       end
     end
 
     describe 'un_pause' do
       it 'should not unpause the queue' do
-        Resque.redis.should_not_receive(:renamenx).with("queue:#{RateLimitedTestQueue.queue_name}", "queue:#{RateLimitedTestQueue.queue_name}_paused")
+        Resque.redis.should_not_receive(:renamenx).with("queue:#{RateLimitedTestQueue.queue_name_private}", "queue:#{RateLimitedTestQueue.queue_name_private}_paused")
         RateLimitedTestQueue.un_pause
       end
     end
@@ -105,7 +104,7 @@ describe Resque::Plugins::RateLimitedQueue do
 
     describe 'perform' do
       it 'should not execute the block' do
-        Resque.should_receive(:enqueue_to).with("#{RateLimitedTestQueue.queue_name}_paused", RateLimitedTestQueue, true)
+        Resque.should_receive(:enqueue_to).with("#{RateLimitedTestQueue.queue_name_private}_paused", RateLimitedTestQueue, true)
         RateLimitedTestQueue.should_not_receive(:perform)
         RateLimitedTestQueue.around_perform_with_check_and_requeue(true)
       end
@@ -113,7 +112,7 @@ describe Resque::Plugins::RateLimitedQueue do
 
     describe 'un_pause' do
       it 'should rename the queue to live' do
-        Resque.redis.should_receive(:renamenx).with("queue:#{RateLimitedTestQueue.queue_name}_paused", "queue:#{RateLimitedTestQueue.queue_name}")
+        Resque.redis.should_receive(:renamenx).with("queue:#{RateLimitedTestQueue.queue_name_private}_paused", "queue:#{RateLimitedTestQueue.queue_name_private}")
         RateLimitedTestQueue.un_pause
       end
     end
@@ -153,7 +152,6 @@ describe Resque::Plugins::RateLimitedQueue do
           expect { RateLimitedTestQueue.un_pause }.to_not raise_error
         end
       end
-
     end
 
     context 'with other errror' do
@@ -178,7 +176,8 @@ describe Resque::Plugins::RateLimitedQueue do
   describe 'paused?' do
     context 'with paused queue' do
       before do
-        Resque.redis.stub(:exists).and_return(true)
+        Resque.redis.stub(:exists).with("queue:#{RateLimitedTestQueue.queue_name_private}_paused").and_return(true)
+        Resque.redis.stub(:exists).with("queue:#{RateLimitedTestQueue.queue_name_private}").and_return(false)
       end
 
       it 'should return the true if the paused queue exists' do
@@ -188,12 +187,25 @@ describe Resque::Plugins::RateLimitedQueue do
 
     context 'with un paused queue' do
       before do
-        Resque.redis.stub(:exists).and_return(false)
+        Resque.redis.stub(:exists).with("queue:#{RateLimitedTestQueue.queue_name_private}_paused").and_return(false)
+        Resque.redis.stub(:exists).with("queue:#{RateLimitedTestQueue.queue_name_private}").and_return(true)
       end
 
-      it 'should return the false if the paused queue does not exist' do
+      it 'should return the false if the main queue exists exist' do
         expect(RateLimitedTestQueue.paused?).to eq(false)
       end
     end
+
+    context 'with unknown queue state' do
+      before do
+        Resque.redis.stub(:exists).with("queue:#{RateLimitedTestQueue.queue_name_private}_paused").and_return(false)
+        Resque.redis.stub(:exists).with("queue:#{RateLimitedTestQueue.queue_name_private}").and_return(false)
+      end
+
+      it 'should return the default' do
+        expect(RateLimitedTestQueue.paused?(true)).to eq(true)
+        expect(RateLimitedTestQueue.paused?(false)).to eq(false)
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: resque-rate_limited_queue
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.2
 platform: ruby
 authors:
 - Greg Dowling
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-30 00:00:00.000000000 Z
+date: 2015-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: resque
@@ -219,7 +219,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.2
+rubygems_version: 2.4.3
 signing_key: 
 specification_version: 4
 summary: A Resque plugin to help manage jobs that use rate limited apis, pausing when
@@ -231,3 +231,4 @@ test_files:
 - spec/rate_limited_queue_spec.rb
 - spec/rate_limited_un_pause_spec.rb
 - spec/spec_helper.rb
+has_rdoc: