resque-rate_limited_queue 0.0.34 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7e527af5c61dffd1cf36981d45454eb11fc92b7f
-  data.tar.gz: f1404b76b2df66c297e02136367b68d7b76d6aef
+  metadata.gz: 0adf19f43b30aaaa865beda17e99e2082b5f6301
+  data.tar.gz: 7260656ade9a2e129ccf07ac137ecd5c010aee45
 SHA512:
-  metadata.gz: c345508ebbe921d8e596018de2c6ff17bc90a84adf096297adcf80df10d3509256b1d9bc3d714bb2740629c264ddbeb12376983b0105bc7e2505446006c12078
-  data.tar.gz: d1ba61f141ee4407b3a52fcf0a43679c9bc2f878fe99a3a27aaf3b4ef715a2dd87e9f97a0dc322b40b3c0e375faa925350e9598a63102046d007460f6129e729
+  metadata.gz: c978c05cc91e3c24d0a685af044e0f2791bff20b08f864a4d12722ab7a9779d94cdef347c242c6cf749eec99b45bb223204b65489afa1e9ae017d72459dc50c9
+  data.tar.gz: 0c6b146eedb305a0522bf920b69600c8339e9e23c62e8ecaaf5d8be9019f1184d0aa60fdf2122ee797716b493fa203c181412e0ff660f8ee3f21ffed5c777d90

data/README.md

@@ -1,7 +1,5 @@
 # Resque Rate Limited Queue
 
-PLEASE NOTE THIS IS NOW SUITABLE FOR TRIAL USE - I EXPECT TO RELEASE A STABLE VERSION IN EARLY JAN 2015
-
 A Resque plugin which makes handling jobs that use rate limited apis easier
 
 If you have a series of jobs in a queue, this gem will pause the queue when one of the jobs hits a rate limit, and re-start the queue when the rate limit has expired.
@@ -44,13 +42,13 @@ Queues can be unpaused in two ways.
 
 The most elegant is using [resque-scheduler](https://github.com/resque/resque-scheduler), this works well as long as you aren't running on a platform like heroku which requires a dedicated worker to run the resque-scheduler.
 
-To tell the gem to use resque-scheduler you need to include resque-scheduler in your Gemfile - and also let the gem know which queue to use to schedule the unpause job (make sure this isn't a queue that could get paused). Put this in an initializer.
+To tell the gem to use `resque-scheduler` you need to include it in your Gemfile - and also let the gem know which queue to use to schedule the unpause job (make sure this isn't a queue that could get paused). Put this in an initializer.
 
 ```ruby
 Resque::Plugins::RateLimitedQueue::UnPause.queue = :my_queue
 ```
 
-Please see the section below on how to unpause on heroku as an alternative. If you don't install resque-scheduler AND configure the queue, then the gem will not schedule unpause jobs this way.
+Please see the section below on how to unpause on heroku as an alternative. If you don't install `resque-scheduler` AND configure the queue, then the gem will not schedule unpause jobs this way.
 
 #### Workers
 Queues are paused by renaming them, so a resque queue called 'twitter\_api' will be renamed 'twitter\_api\_paused' when it hits a rate limit. Of course this will only work if your resque workers are not also taking jobs from the 'twitter\_api\_paused' queue. So your worker commands need to look like:
@@ -115,7 +113,7 @@ class MyApiJob
   def self.perform(*params)
     do_api_stuff
   rescue MyApiRateLimit
-    pause_for(Time.now + WAIT_TIME, name)
+    pause_until(Time.now + WAIT_TIME, name)
     rate_limited_requeue(self, *params)
   end
 
@@ -136,13 +134,62 @@ class MyApiQueue < Resque::Plugins::RateLimitedQueue::BaseApiQueue
   def self.perform(klass, *params)
     super
   rescue MyApiRateLimit
-    pause_for(Time.now + WAIT_TIME, name)
+    pause_until(Time.now + WAIT_TIME, name)
     rate_limited_requeue(self, klass, *params)
   end
 end
 ````
 If you do this - please contribute - and I'll add to the gem.
 
+## Development Documentation
+All the functions are class methods
+
+```ruby
+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.
+
+```ruby
+pause
+````
+Pauses the queue specified by `@queue`, if it is not already paused.
+In most cases you should call `pause_until` to pause a queue when you hit a rate limit.
+
+```ruby
+un_pause
+````
+Un-pauses the queue specified by `@queue`, if it is paused.
+
+```ruby
+pause_until(timestamp)
+````
+Pauses the queue (specified by `@queue`) and then queues a job to unpause the queue specified by `@queue`, using resque-scheduler to the queue specified by `Resque::Plugins::RateLimitedQueue::UnPause.queue` at the timestamp specified.
+If `resque-schedule` is not included, or `UnPause.queue` isn't specified this will just pause the queue.
+
+This is the prefered function to call when you hit a rate limit, since it with work regardless of the unpause method used by the application.
+
+```ruby
+paused?
+````
+This returns true or false to indicate wheher the queue is paused. Be aware that the queue state could change get after the call returns, but before your code executes. Use `with_lock` if you need to avoid this.
+
+```ruby
+paused_queue_name
+````
+Returns the name of the queue when it is paused.
+
+```ruby
+with_lock(&block)
+````
+Takes ownership of the PauseQueue semaphor before executing the block passed. Useful if you need to test the state of the queue and take some action without the state changing.
+
+```ruby
+find_class(klass)
+````
+Takes the parameter passed, and if it's a string class name, tries to turn it into a class.
+
+
 ## Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/resque_rate_limited_queue/fork )
@@ -151,7 +198,16 @@ If you do this - please contribute - and I'll add to the gem.
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
 
+
+## Version history
+
+0.0.x Mostly pre-release versions
+
+1.0.0 First release version. Breaking change - renamed  `pause_for` to be `pause_until` to better reflect function
+
+
+
 ## Final thoughts
-Thanks to [Dominic](https://github.com/dominicsayers) for idea of renaming the redis key - and the sample  code that does this.
+Thanks to [Dominic](https://github.com/dominicsayers) for idea of renaming the redis key - and the sample code that does this.
 
 This is my first gem - so please forgive any errors - and feedback very welcome

data/lib/resque-rate_limited_queue/version.rb

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

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

@@ -10,7 +10,7 @@ module Resque
         def self.perform(klass, *params)
           super
         rescue AngellistApi::Error::TooManyRequests
-          pause_for(Time.now + (60 * 60))
+          pause_until(Time.now + (60 * 60))
           rate_limited_requeue(self, klass, *params)
         end
       end

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

@@ -9,7 +9,7 @@ module Resque
         def self.perform(klass, *params)
           super
         rescue Evernote::EDAM::Error::EDAMSystemException => e
-          pause_for(Time.now + 60 * e.rateLimitDuration.seconds)
+          pause_until(Time.now + 60 * e.rateLimitDuration.seconds)
           rate_limited_requeue(self, klass, *params)
         end
       end

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

@@ -10,7 +10,7 @@ module Resque
           super
         rescue Twitter::Error::TooManyRequests,
                Twitter::Error::EnhanceYourCalm => e
-          pause_for(Time.now + e.rate_limit.reset_in)
+          pause_until(Time.now + e.rate_limit.reset_in)
           rate_limited_requeue(self, klass, *params)
         end
       end

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

@@ -29,7 +29,7 @@ module Resque
         rate_limited_enqueue(klass, *params)
       end
 
-      def pause_for(timestamp)
+      def pause_until(timestamp)
         UnPause.enqueue(timestamp, name) if pause
       end
 

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

@@ -26,6 +26,7 @@ module Resque
           end
 
           def class_from_string(str)
+            return Object.const_get(str) unless str.include?('::')
             str.split('::').reduce(Object) do |mod, class_name|
               mod.const_get(class_name)
             end

data/spec/apis/angellist_queue_spec.rb

@@ -41,7 +41,7 @@ describe Resque::Plugins::RateLimitedQueue::AngellistQueue do
         Resque::Plugins::RateLimitedQueue::AngellistQueue.stub(:rate_limited_requeue)
       end
       it 'pauses queue when request fails' do
-        Resque::Plugins::RateLimitedQueue::AngellistQueue.should_receive(:pause_for)
+        Resque::Plugins::RateLimitedQueue::AngellistQueue.should_receive(:pause_until)
         Resque::Plugins::RateLimitedQueue::AngellistQueue
           .enqueue(RateLimitedTestQueueAL, false)
       end

data/spec/apis/evernote_queue_spec.rb

@@ -46,7 +46,7 @@ describe Resque::Plugins::RateLimitedQueue::EvernoteQueue do
         Resque::Plugins::RateLimitedQueue::EvernoteQueue.stub(:rate_limited_requeue)
       end
       it 'pauses queue when request fails' do
-        Resque::Plugins::RateLimitedQueue::EvernoteQueue.should_receive(:pause_for)
+        Resque::Plugins::RateLimitedQueue::EvernoteQueue.should_receive(:pause_until)
         Resque::Plugins::RateLimitedQueue::EvernoteQueue
           .enqueue(RateLimitedTestQueueEn, false)
       end

data/spec/apis/twitter_queue_spec.rb

@@ -42,7 +42,7 @@ describe Resque::Plugins::RateLimitedQueue::TwitterQueue do
         Resque::Plugins::RateLimitedQueue::TwitterQueue.stub(:rate_limited_requeue)
       end
       it 'pauses queue when request fails' do
-        Resque::Plugins::RateLimitedQueue::TwitterQueue.should_receive(:pause_for)
+        Resque::Plugins::RateLimitedQueue::TwitterQueue.should_receive(:pause_until)
         Resque::Plugins::RateLimitedQueue::TwitterQueue
           .enqueue(RateLimitedTestQueueTw, false)
       end

data/spec/rate_limited_queue_spec.rb

@@ -72,20 +72,20 @@ describe Resque::Plugins::RateLimitedQueue do
       end
     end
 
-    describe 'pause_for' do
+    describe 'pause_until' do
       before do
         Resque.redis.stub(:renamenx).and_return(true)
       end
 
       it 'should pause the queue' do
         RateLimitedTestQueue.should_receive(:pause)
-        RateLimitedTestQueue.pause_for(Time.now + (5 * 60 * 60))
+        RateLimitedTestQueue.pause_until(Time.now + (5 * 60 * 60))
       end
 
       it 'should schedule an unpause job' do
         Resque::Plugins::RateLimitedQueue::UnPause.should_receive(:enqueue)
           .with(nil, 'RateLimitedTestQueue')
-        RateLimitedTestQueue.pause_for(nil)
+        RateLimitedTestQueue.pause_until(nil)
       end
     end
   end
@@ -174,4 +174,26 @@ describe Resque::Plugins::RateLimitedQueue do
       end
     end
   end
+
+  describe 'paused?' do
+    context 'with paused queue' do
+      before do
+        Resque.redis.stub(:exists).and_return(true)
+      end
+
+      it 'should return the true if the paused queue exists' do
+        expect(RateLimitedTestQueue.paused?).to eq(true)
+      end
+    end
+
+    context 'with un paused queue' do
+      before do
+        Resque.redis.stub(:exists).and_return(false)
+      end
+
+      it 'should return the false if the paused queue does not exist' do
+        expect(RateLimitedTestQueue.paused?).to eq(false)
+      end
+    end
+  end
 end

data/spec/rate_limited_un_pause_spec.rb

@@ -35,4 +35,15 @@ describe Resque::Plugins::RateLimitedQueue::UnPause do
     end
   end
 
+  describe 'class_from_string' do
+    it 'converts unqualified classes' do
+      expect(Resque::Plugins::RateLimitedQueue::UnPause.class_from_string(RateLimitedTestQueue.to_s))
+        .to eq(RateLimitedTestQueue)
+    end
+    it 'converts qualified classes' do
+      expect(Resque::Plugins::RateLimitedQueue::UnPause.class_from_string(Resque::Plugins::RateLimitedQueue::UnPause.to_s))
+        .to eq(Resque::Plugins::RateLimitedQueue::UnPause)
+    end
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: resque-rate_limited_queue
 version: !ruby/object:Gem::Version
-  version: 0.0.34
+  version: 1.0.0
 platform: ruby
 authors:
 - Greg Dowling
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-28 00:00:00.000000000 Z
+date: 2014-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: resque