sidekiq-throttler 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8acf1d69eb8a5045cdff1273d3f44342845cfc9b
-  data.tar.gz: 0ca683c9e8cf5149d430391ec1bd85488f3517b9
+  metadata.gz: 19e1d69fd9be458ce6356483854f19513b01e5e7
+  data.tar.gz: 1c0582120520cfa48ce066cf410f7d48c492a394
 SHA512:
-  metadata.gz: 347d780d00c2c9a538c79e0bb48f3977f037d3bd70fbce3a63a24557aa01a92b350a5d80d00fe9fc79985f3c50c7603de6c080ff518380d7ac894066492c9453
-  data.tar.gz: 17003989b18787321d19f939ef07f8a165aa325fd7a63c79561dd5a40eaf50087fcf96450439cbdf6a95c87c00f7bf3f52cc67c3e081568b0d298fe08084c4e3
+  metadata.gz: 35a019db24bfd3833fa22edfed15b00b144b9a73966de3b9c075f794b832ba7e4cf4791f633f8432cc35ad21e9ace738d94635268c5b0109b6c866dc1d68832f
+  data.tar.gz: 1d74ed077c71d2ff8630d0286958a2869ca3bb4a83e6f3b5fa74f967cfbf7312ae05150176b14f34883fb827ea7bad5438527f138afb8ee8a6530e3a0542406a

data/.rspec

@@ -1,2 +1,2 @@
---format nested
+--format documentation
 --color

data/.travis.yml

@@ -13,3 +13,6 @@ notifications:
   email:
     recipients:
       - gabe@ga.be
+gemfile:
+  - gemfiles/sidekiq_2.gemfile
+  - gemfiles/sidekiq_master.gemfile

data/Appraisals

@@ -2,6 +2,6 @@ appraise 'sidekiq-2' do
   gem 'sidekiq', '2.17.7'
 end
 
-appraise 'sidekiq-head' do
+appraise 'sidekiq-master' do
   gem 'sidekiq', github: 'mperham/sidekiq'
 end

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+## 0.4.1 (June 18, 2014)
+
+* Dependency lock is loosened further for compatibility with Sidekiq 3.x.
+
+  *Gabe Evans*
+
+* Appraisal is used for continous integration with Sidekiq 2.x and Sidekiq's
+  master branch.
+
+  *Gabe Evans*
+
+* Specs now use RSpec 3 and the `expect()` syntax.
+
+  *Gabe Evans*
+
 ## 0.4.0 (April 24, 2014)
 
 * Now supports using a Proc for `:period` option.

data/Gemfile

@@ -2,3 +2,5 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in sidekiq-throttler.gemspec
 gemspec
+
+gem 'appraisal', '~> 1.0.0'

data/README.md

@@ -2,13 +2,15 @@
 
 [![Build Status](https://secure.travis-ci.org/gevans/sidekiq-throttler.png)](http://travis-ci.org/gevans/sidekiq-throttler)
 [![Dependency Status](https://gemnasium.com/gevans/sidekiq-throttler.png)](https://gemnasium.com/gevans/sidekiq-throttler)
+[![Gem Version](https://badge.fury.io/rb/sidekiq-throttler.svg)](http://badge.fury.io/rb/sidekiq-throttler)
 
 Sidekiq::Throttler is a middleware for Sidekiq that adds the ability to rate
 limit job execution on a per-worker basis.
 
 ## Compatibility
 
-Sidekiq::Throttler is actively tested against MRI versions 2.0.0 and 1.9.3.
+Sidekiq::Throttler is actively tested against MRI versions 2.1.1, 2.1.0, 2.0.0,
+and 1.9.3.
 
 ## Installation
 

data/gemfiles/sidekiq_2.gemfile

@@ -2,6 +2,7 @@
 
 source "https://rubygems.org"
 
+gem "appraisal", "~> 1.0.0"
 gem "sidekiq", "2.17.7"
 
-gemspec :path=>"../"
+gemspec :path => "../"

data/gemfiles/sidekiq_master.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal", "~> 1.0.0"
+gem "sidekiq", :github => "mperham/sidekiq"
+
+gemspec :path => "../"

data/lib/sidekiq/throttler/version.rb

@@ -1,5 +1,5 @@
 module Sidekiq
   class Throttler
-    VERSION = '0.4.0'
+    VERSION = '0.4.1'
   end
 end

data/sidekiq-throttler.gemspec

@@ -19,9 +19,8 @@ Gem::Specification.new do |gem|
   gem.require_paths = %w(lib)
 
   gem.add_dependency 'activesupport'
-  gem.add_dependency 'sidekiq', '>= 2.5', '< 3.1'
+  gem.add_dependency 'sidekiq', '>= 2.5', '< 4.0'
 
-  gem.add_development_dependency 'appraisal', '~> 0.5'
   gem.add_development_dependency 'growl'
   gem.add_development_dependency 'guard'
   gem.add_development_dependency 'guard-bundler'

data/spec/sidekiq/throttler/rate_limit_spec.rb

@@ -19,7 +19,7 @@ shared_examples "incrementing" do
         rate_limit.increment
       end
 
-      rate_limit.count.should eq(5)
+      expect(rate_limit.count).to eq(5)
     end
   end
 end
@@ -53,15 +53,15 @@ describe Sidekiq::Throttler::RateLimit do
   describe '.new' do
 
     it 'initializes with a provided worker' do
-      rate_limit.worker.should eq(worker)
+      expect(rate_limit.worker).to eq(worker)
     end
 
     it 'initializes with provided payload' do
-      rate_limit.payload.should eq(payload)
+      expect(rate_limit.payload).to eq(payload)
     end
 
     it 'initializes with a provided queue' do
-      rate_limit.queue.should eq('meow')
+      expect(rate_limit.queue).to eq('meow')
     end
 
     context "with an invalid storage backend" do
@@ -76,17 +76,17 @@ describe Sidekiq::Throttler::RateLimit do
   describe '#options' do
 
     it 'retrieves throttle options from the worker' do
-      worker_class.get_sidekiq_options.should_receive(:[]).with('throttle')
+      expect(worker_class.get_sidekiq_options).to receive(:[]).with('throttle')
       rate_limit.options
     end
 
     it 'stringifies the option keys' do
-      worker_class.get_sidekiq_options['throttle'].should_receive(:stringify_keys)
+      expect(worker_class.get_sidekiq_options['throttle']).to receive(:stringify_keys)
       rate_limit.options
     end
 
     it 'caches the returned options' do
-      rate_limit.options.object_id.should eq(rate_limit.options.object_id)
+      expect(rate_limit.options.object_id).to eq(rate_limit.options.object_id)
     end
 
     context 'when the worker specifies no throttle options' do
@@ -98,7 +98,7 @@ describe Sidekiq::Throttler::RateLimit do
       end
 
       it 'returns an empty hash' do
-        rate_limit.options.should eq({})
+        expect(rate_limit.options).to eq({})
       end
     end
   end
@@ -115,22 +115,22 @@ describe Sidekiq::Throttler::RateLimit do
       end
 
       it 'returns the result of the called Proc' do
-        rate_limit.threshold.should eq(500)
+        expect(rate_limit.threshold).to eq(500)
       end
     end
 
     it 'retrieves the threshold from #options' do
       rate_limit.options['threshold'] = 26
-      rate_limit.threshold.should eq(26)
+      expect(rate_limit.threshold).to eq(26)
     end
 
     it 'converts the threshold to an integer' do
       rate_limit.options['threshold'] = '33'
-      rate_limit.threshold.should be_a(Integer)
+      expect(rate_limit.threshold).to be_a(Integer)
     end
 
     it 'caches the returned integer' do
-      rate_limit.threshold.object_id.should eq(rate_limit.threshold.object_id)
+      expect(rate_limit.threshold.object_id).to eq(rate_limit.threshold.object_id)
     end
   end
 
@@ -146,22 +146,22 @@ describe Sidekiq::Throttler::RateLimit do
       end
 
       it 'returns the result of the called Proc' do
-        rate_limit.period.should eq(60)
+        expect(rate_limit.period).to eq(60)
       end
     end
 
     it 'retrieves the period from #options' do
       rate_limit.options['period'] = 10.0
-      rate_limit.period.should eq(10.0)
+      expect(rate_limit.period).to eq(10.0)
     end
 
     it 'converts the period to a float' do
       rate_limit.options['period'] = 27
-      rate_limit.period.should be_a(Float)
+      expect(rate_limit.period).to be_a(Float)
     end
 
     it 'caches the returned float' do
-      rate_limit.period.object_id.should eq(rate_limit.period.object_id)
+      expect(rate_limit.period.object_id).to eq(rate_limit.period.object_id)
     end
   end
 
@@ -172,13 +172,13 @@ describe Sidekiq::Throttler::RateLimit do
     end
 
     it 'caches the key from the worker' do
-      rate_limit.key.object_id.should eq(rate_limit.key.object_id)
+      expect(rate_limit.key.object_id).to eq(rate_limit.key.object_id)
     end
 
     context 'when key is a string' do
 
       it 'returns the key as a symbol' do
-        rate_limit.key.should eq('winning')
+        expect(rate_limit.key).to eq('winning')
       end
     end
 
@@ -193,7 +193,7 @@ describe Sidekiq::Throttler::RateLimit do
       end
 
       it 'returns the result of the called Proc' do
-        rate_limit.key.should eq('wat:is:this')
+        expect(rate_limit.key).to eq('wat:is:this')
       end
     end
   end
@@ -203,7 +203,7 @@ describe Sidekiq::Throttler::RateLimit do
     context 'when options are correctly specified' do
 
       it 'returns true' do
-        rate_limit.can_throttle?.should be_true
+        expect(rate_limit.can_throttle?).to be_truthy
       end
     end
 
@@ -212,8 +212,8 @@ describe Sidekiq::Throttler::RateLimit do
       context "when ##{method} is zero" do
 
         it 'returns false' do
-          rate_limit.stub(method.to_sym).and_return(0)
-          rate_limit.can_throttle?.should be_false
+          allow(rate_limit).to receive(method.to_sym).and_return(0)
+          expect(rate_limit.can_throttle?).to be_falsey
         end
       end
     end
@@ -224,24 +224,24 @@ describe Sidekiq::Throttler::RateLimit do
     context 'when #count is equal to #threshold' do
 
       it 'returns true' do
-        rate_limit.should_receive(:count).and_return(rate_limit.threshold)
-        rate_limit.should be_exceeded
+        expect(rate_limit).to receive(:count).and_return(rate_limit.threshold)
+        expect(rate_limit).to be_exceeded
       end
     end
 
     context 'when #count is greater than #threshold' do
 
       it 'returns true' do
-        rate_limit.should_receive(:count).and_return(rate_limit.threshold + 1)
-        rate_limit.should be_exceeded
+        expect(rate_limit).to receive(:count).and_return(rate_limit.threshold + 1)
+        expect(rate_limit).to be_exceeded
       end
     end
 
     context 'when #count is less than #threshold' do
 
       it 'returns false' do
-        rate_limit.should_receive(:count).and_return(0)
-        rate_limit.should_not be_exceeded
+        expect(rate_limit).to receive(:count).and_return(0)
+        expect(rate_limit).not_to be_exceeded
       end
     end
   end
@@ -249,10 +249,10 @@ describe Sidekiq::Throttler::RateLimit do
   describe '#within_bounds?' do
 
     it 'returns the opposite of #exceeded?' do
-      rate_limit.should_receive(:exceeded?).and_return(true)
-      rate_limit.should_not be_within_bounds
-      rate_limit.should_receive(:exceeded?).and_return(false)
-      rate_limit.should be_within_bounds
+      expect(rate_limit).to receive(:exceeded?).and_return(true)
+      expect(rate_limit).not_to be_within_bounds
+      expect(rate_limit).to receive(:exceeded?).and_return(false)
+      expect(rate_limit).to be_within_bounds
     end
   end
 
@@ -275,12 +275,12 @@ describe Sidekiq::Throttler::RateLimit do
     context 'when rate limit cannot be throttled' do
 
       before do
-        rate_limit.should_receive(:can_throttle?).and_return(false)
+        expect(rate_limit).to receive(:can_throttle?).and_return(false)
       end
 
       it 'calls the within bounds callback' do
         callback = Proc.new {}
-        callback.should_receive(:call)
+        expect(callback).to receive(:call)
 
         rate_limit.within_bounds(&callback)
         rate_limit.execute
@@ -289,7 +289,7 @@ describe Sidekiq::Throttler::RateLimit do
       it 'does not increment the counter' do
         rate_limit.within_bounds {}
 
-        rate_limit.should_not_receive(:increment)
+        expect(rate_limit).not_to receive(:increment)
         rate_limit.execute
       end
     end
@@ -297,12 +297,12 @@ describe Sidekiq::Throttler::RateLimit do
     context 'when rate limit is exceeded' do
 
       before do
-        rate_limit.should_receive(:exceeded?).and_return(true)
+        expect(rate_limit).to receive(:exceeded?).and_return(true)
       end
 
       it 'calls the exceeded callback with the configured #period' do
         callback = Proc.new {}
-        callback.should_receive(:call).with(rate_limit.period)
+        expect(callback).to receive(:call).with(rate_limit.period)
 
         rate_limit.exceeded(&callback)
         rate_limit.execute
@@ -314,13 +314,13 @@ describe Sidekiq::Throttler::RateLimit do
       it 'increments the counter' do
         rate_limit.within_bounds {}
 
-        rate_limit.should_receive(:increment)
+        expect(rate_limit).to receive(:increment)
         rate_limit.execute
       end
 
       it 'calls the within bounds callback' do
         callback = Proc.new {}
-        callback.should_receive(:call)
+        expect(callback).to receive(:call)
 
         rate_limit.within_bounds(&callback)
         rate_limit.execute
@@ -333,7 +333,7 @@ describe Sidekiq::Throttler::RateLimit do
     context 'when no jobs have executed' do
 
       it 'returns 0' do
-        rate_limit.count.should be_zero
+        expect(rate_limit.count).to be_zero
       end
     end
   end

data/spec/sidekiq/throttler/storage/redis_spec.rb

@@ -5,31 +5,31 @@ describe Sidekiq::Throttler::Storage::Redis do
 
   before(:each) do
     @sidekiq = double()
-    Sidekiq.stub(:redis).and_yield(@sidekiq)
+    allow(Sidekiq).to receive(:redis).and_yield(@sidekiq)
   end
 
   describe "#prune" do
     it "pops the last item off the list if it's lower than the cutoff" do
-      @sidekiq.stub(:lindex).and_return(100, nil)
-      @sidekiq.should_receive(:rpop).with("throttled:fake").and_return(100)
+      allow(@sidekiq).to receive(:lindex).and_return(100, nil)
+      expect(@sidekiq).to receive(:rpop).with("throttled:fake").and_return(100)
       storage.prune("fake", 200)
     end
 
     it "leaves the last item on the list if it's higher than the cutoff" do
-      @sidekiq.stub(:lindex).and_return(200, nil)
-      @sidekiq.should_not_receive(:rpop)
+      allow(@sidekiq).to receive(:lindex).and_return(200, nil)
+      expect(@sidekiq).not_to receive(:rpop)
       storage.prune("fake", 100)
     end
 
     context "when another job has concurrently removed a timestamp" do
 
       before(:each) do
-        @sidekiq.stub(:lindex) { 100 }
-        @sidekiq.stub(:rpop)   { 200 }
+        allow(@sidekiq).to receive(:lindex) { 100 }
+        allow(@sidekiq).to receive(:rpop)   { 200 }
       end
 
       it "pushes the value back onto the list" do
-        @sidekiq.should_receive(:rpush).with("throttled:fake", 200)
+        expect(@sidekiq).to receive(:rpush).with("throttled:fake", 200)
         storage.prune("fake", 1000)
       end
     end

data/spec/sidekiq/throttler_spec.rb

@@ -27,7 +27,7 @@ describe Sidekiq::Throttler do
   describe '#call' do
 
     it 'instantiates a rate limit with the worker, args, and queue' do
-      Sidekiq::Throttler::RateLimit.should_receive(:new).with(
+      expect(Sidekiq::Throttler::RateLimit).to receive(:new).with(
         worker, message['args'], queue, options
       ).and_call_original
 
@@ -39,15 +39,15 @@ describe Sidekiq::Throttler do
     end
 
     it 'calls RateLimit#execute' do
-      Sidekiq::Throttler::RateLimit.any_instance.should_receive(:execute)
+      expect_any_instance_of(Sidekiq::Throttler::RateLimit).to receive(:execute)
       throttler.call(worker, message, queue)
     end
 
     context 'when rate limit is exceeded' do
 
       it 'requeues the job with a delay' do
-        Sidekiq::Throttler::RateLimit.any_instance.should_receive(:exceeded?).and_return(true)
-        worker.class.should_receive(:perform_in).with(1.minute, *message['args'])
+        expect_any_instance_of(Sidekiq::Throttler::RateLimit).to receive(:exceeded?).and_return(true)
+        expect(worker.class).to receive(:perform_in).with(1.minute, *message['args'])
         throttler.call(worker, message, queue)
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-throttler
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Gabe Evans
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-24 00:00:00.000000000 Z
+date: 2014-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -33,7 +33,7 @@ dependencies:
         version: '2.5'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -43,21 +43,7 @@ dependencies:
         version: '2.5'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3.1'
-- !ruby/object:Gem::Dependency
-  name: appraisal
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: growl
   requirement: !ruby/object:Gem::Requirement
@@ -288,7 +274,7 @@ files:
 - README.md
 - Rakefile
 - gemfiles/sidekiq_2.gemfile
-- gemfiles/sidekiq_head.gemfile
+- gemfiles/sidekiq_master.gemfile
 - lib/sidekiq-throttler.rb
 - lib/sidekiq/throttler.rb
 - lib/sidekiq/throttler/rate_limit.rb
@@ -305,7 +291,6 @@ files:
 - spec/sidekiq/throttler/rate_limit_spec.rb
 - spec/sidekiq/throttler/storage/redis_spec.rb
 - spec/sidekiq/throttler_spec.rb
-- spec/spec.opts
 - spec/spec_helper.rb
 - spec/support/sidekiq.rb
 homepage: https://github.com/gevans/sidekiq-throttler
@@ -343,7 +328,6 @@ test_files:
 - spec/sidekiq/throttler/rate_limit_spec.rb
 - spec/sidekiq/throttler/storage/redis_spec.rb
 - spec/sidekiq/throttler_spec.rb
-- spec/spec.opts
 - spec/spec_helper.rb
 - spec/support/sidekiq.rb
 has_rdoc: 

data/gemfiles/sidekiq_head.gemfile

@@ -1,7 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "sidekiq", :github=>"mperham/sidekiq"
-
-gemspec :path=>"../"

data/spec/spec.opts

@@ -1,2 +0,0 @@
---color
---format progress