sidekiq-throttler 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1a48a69a956224bcd3ea8fae08c21210e44f9aee
-  data.tar.gz: 0f9146f8756e701ae3d1eb0beef9654dd0074c56
+  metadata.gz: 8acf1d69eb8a5045cdff1273d3f44342845cfc9b
+  data.tar.gz: 0ca683c9e8cf5149d430391ec1bd85488f3517b9
 SHA512:
-  metadata.gz: 4608ce6e67d51e53626a8d63fbf9d06e462fc502d01cce70eb1997d726a285ec65406cc0d8aa5a59abf375ec153d76d983d4af03a6b4e138959305f66ea61bdb
-  data.tar.gz: bb21a8d354dc7f609beb4e65886479d0688101407087b2b8b45038257f59c178719e91255f8999eff1eeee11b0a08c8bf4875f79e7382bdf0f108622e251f230
+  metadata.gz: 347d780d00c2c9a538c79e0bb48f3977f037d3bd70fbce3a63a24557aa01a92b350a5d80d00fe9fc79985f3c50c7603de6c080ff518380d7ac894066492c9453
+  data.tar.gz: 17003989b18787321d19f939ef07f8a165aa325fd7a63c79561dd5a40eaf50087fcf96450439cbdf6a95c87c00f7bf3f52cc67c3e081568b0d298fe08084c4e3

data/.gitignore

@@ -2,17 +2,18 @@
 *.rbc
 .bundle
 .config
-.rspec
+.rspec-local
 .yardoc
 Gemfile.lock
 InstalledFiles
 _yardoc
 coverage
 doc/
+gemfiles/*.gemfile.lock
 lib/bundler/man
 pkg
 rdoc
 spec/reports
 test/tmp
 test/version_tmp
-tmp
+tmp

data/.rspec

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

data/.travis.yml

@@ -1,9 +1,11 @@
 language: ruby
+services:
+  - redis-server
 rvm:
+  - 2.1.1
+  - 2.1.0
   - 2.0.0
   - 1.9.3
-  - jruby-19mode
-  - rbx-19mode
 branches:
   only:
     - master
@@ -11,7 +13,3 @@ notifications:
   email:
     recipients:
       - gabe@ga.be
-matrix:
-  allow_failures:
-    - rvm: jruby-19mode
-    - rvm: rbx-19mode

data/Appraisals

@@ -0,0 +1,7 @@
+appraise 'sidekiq-2' do
+  gem 'sidekiq', '2.17.7'
+end
+
+appraise 'sidekiq-head' do
+  gem 'sidekiq', github: 'mperham/sidekiq'
+end

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+## 0.4.0 (April 24, 2014)
+
+* Now supports using a Proc for `:period` option.
+
+  *Kainage*
+
+* Fix for throttler spec that was using symbol keys but the testing with
+  string keys.
+
+  *worst*
+
+* Dependency lock is loosened for compatibility with Sidekiq 3.0.
+
+  *Gabe Evans*
+
 ## 0.3.1 (November 5, 2013)
 
 * `Singleton` is explicitly required, fixing a `NameError`.

data/README.md

@@ -14,7 +14,9 @@ Sidekiq::Throttler is actively tested against MRI versions 2.0.0 and 1.9.3.
 
 Add this line to your application's Gemfile:
 
-    gem 'sidekiq-throttler'
+```ruby
+gem 'sidekiq-throttler'
+```
 
 And then execute:
 
@@ -49,7 +51,7 @@ Sidekiq.configure_server do |config|
 end
 ```
 
-## Usage
+## Basic Usage
 
 In a worker, specify a threshold (maximum jobs) and period for throttling:
 
@@ -68,6 +70,48 @@ end
 In the above example, when the number of executed jobs for the worker exceeds
 50 in an hour, remaining jobs will be delayed.
 
+## Advanced Usage
+
+### Custom Keys
+
+By default, each worker has its own key for throttling. For example:
+
+```ruby
+class FooWorker
+  include Sidekiq::Worker
+
+  sidekiq_options throttle: { threshold: 50, period: 1.hour }
+
+  # ...
+end
+
+class BarWorker
+  include Sidekiq::Worker
+
+  sidekiq_options throttle: { threshold: 50, period: 1.hour }
+
+  # ...
+end
+```
+
+Even though `FooWorker` and `BarWorker` use the same throttle options, they are
+treated as different groups. To have multiple workers with shared throttling,
+the `:key` options can be used:
+
+```ruby
+sidekiq_options throttle: { threshold: 50, period: 1.hour, key: 'foobar' }
+```
+
+Any jobs using the same key, regardless of the worker will be tracked under the
+same conditions.
+
+### Dynamic Throttling
+
+Each option (`:threshold`, `:period`, and `:key`) accepts a static value but can
+*also* accept a `Proc` that's called each time a job is processed.
+
+#### Dynamic Keys
+
 If throttling is per-user, for example, you can specify a `Proc` for `key` which
 accepts the arguments passed to your worker's `perform` method:
 
@@ -78,6 +122,8 @@ sidekiq_options throttle: { threshold: 20, period: 1.day, key: ->(user_id){ user
 In the above example, jobs are throttled for each user when they exceed 20 in a
 day.
 
+#### Dynamic Thresholds
+
 Thresholds can be configured based on the arguments passed to your worker's `perform` method,
 similar to how the `key` option works:
 
@@ -87,6 +133,15 @@ sidekiq_options throttle: { threshold: ->(user_id, rate_limit) { rate_limit }, p
 
 In the above example, jobs are throttled for each user when they exceed the rate limit provided in the message. This is useful in cases where each user may have a different rate limit (ex: interacting with external APIs)
 
+#### Dynamic Periods
+
+In this contrived example, our worker is limited to 9 thousand jobs every 10
+minutes. However, on Tuesdays limit jobs to 9 thousand every *15 minutes*:
+
+```ruby
+sidekiq_options throttle: { threshold: 9000, period: ->{ Date.today.tuesday? ? 15.minutes : 10.minutes } }
+```
+
 ## Contributing
 
 1. Fork it

data/Rakefile

@@ -1,4 +1,5 @@
 require 'bundler/gem_tasks'
+require 'appraisal'
 
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec) do |spec|
@@ -15,4 +16,4 @@ task :console, :script do |t, args|
   command  = 'bundle exec pry'
   command += "-r #{args[:script]}" if args[:script]
   sh command
-end
+end

data/gemfiles/sidekiq_2.gemfile

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

data/gemfiles/sidekiq_head.gemfile

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

data/lib/sidekiq/throttler/rate_limit.rb

@@ -83,7 +83,7 @@ module Sidekiq
       # @return [Float]
       #   The number of seconds in the rate limit period.
       def period
-        @period ||= options['period'].to_f
+        @period ||= (options['period'].respond_to?(:call) ? options['period'].call(*payload) : options['period']).to_f
       end
 
       ##

data/lib/sidekiq/throttler/version.rb

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

data/sidekiq-throttler.gemspec

@@ -16,26 +16,25 @@ Gem::Specification.new do |gem|
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.require_paths = ['lib']
+  gem.require_paths = %w(lib)
 
   gem.add_dependency 'activesupport'
-  gem.add_dependency 'sidekiq', '>= 2.5', '< 3.0'
-
-  gem.add_development_dependency 'rake'
-  gem.add_development_dependency 'pry'
-  gem.add_development_dependency 'yard'
-  gem.add_development_dependency 'redcarpet'
-
-  gem.add_development_dependency 'rspec'
-  gem.add_development_dependency 'rspec-redis_helper'
-  gem.add_development_dependency 'timecop'
-  gem.add_development_dependency 'simplecov'
+  gem.add_dependency 'sidekiq', '>= 2.5', '< 3.1'
 
+  gem.add_development_dependency 'appraisal', '~> 0.5'
+  gem.add_development_dependency 'growl'
   gem.add_development_dependency 'guard'
   gem.add_development_dependency 'guard-bundler'
   gem.add_development_dependency 'guard-rspec'
   gem.add_development_dependency 'guard-yard'
+  gem.add_development_dependency 'pry'
+  gem.add_development_dependency 'rake'
   gem.add_development_dependency 'rb-fsevent'
   gem.add_development_dependency 'rb-inotify'
-  gem.add_development_dependency 'growl'
+  gem.add_development_dependency 'redcarpet'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'rspec-redis_helper'
+  gem.add_development_dependency 'simplecov'
+  gem.add_development_dependency 'timecop'
+  gem.add_development_dependency 'yard'
 end

data/spec/app/workers/proc_period_worker.rb

@@ -0,0 +1,10 @@
+class ProcPeriodWorker
+  include Sidekiq::Worker
+
+  sidekiq_options throttle: { threshold: 10, period: Proc.new { |user_id, period| period } }
+
+  def perform(user_id, period)
+    puts user_id
+    puts period
+  end
+end

data/spec/sidekiq/throttler/rate_limit_spec.rb

@@ -136,6 +136,20 @@ describe Sidekiq::Throttler::RateLimit do
 
   describe '#period' do
 
+    context 'when period is a Proc' do
+      let(:worker_class) do
+        ProcPeriodWorker
+      end
+
+      let(:payload) do
+        [1, 1.minute]
+      end
+
+      it 'returns the result of the called Proc' do
+        rate_limit.period.should eq(60)
+      end
+    end
+
     it 'retrieves the period from #options' do
       rate_limit.options['period'] = 10.0
       rate_limit.period.should eq(10.0)

data/spec/sidekiq/throttler_spec.rb

@@ -16,7 +16,7 @@ describe Sidekiq::Throttler do
 
   let(:message) do
     {
-      args: 'Clint Eastwood'
+      'args' => 'Clint Eastwood'
     }
   end
 

metadata

@@ -1,257 +1,271 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-throttler
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Gabe Evans
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-05 00:00:00.000000000 Z
+date: 2014-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: sidekiq
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.5'
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.5'
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.1'
 - !ruby/object:Gem::Dependency
-  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: growl
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: guard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: guard-bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: redcarpet
+  name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: guard-yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec-redis_helper
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: timecop
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rb-fsevent
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: guard
+  name: rb-inotify
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: guard-bundler
+  name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: guard-rspec
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: guard-yard
+  name: rspec-redis_helper
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rb-fsevent
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rb-inotify
+  name: timecop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: growl
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Sidekiq middleware that adds the ability to rate limit job execution.
@@ -261,16 +275,20 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .pryrc
-- .travis.yml
-- .yardopts
+- ".gitignore"
+- ".pryrc"
+- ".rspec"
+- ".travis.yml"
+- ".yardopts"
+- Appraisals
 - CHANGELOG.md
 - Gemfile
 - Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- gemfiles/sidekiq_2.gemfile
+- gemfiles/sidekiq_head.gemfile
 - lib/sidekiq-throttler.rb
 - lib/sidekiq/throttler.rb
 - lib/sidekiq/throttler/rate_limit.rb
@@ -280,6 +298,7 @@ files:
 - sidekiq-throttler.gemspec
 - spec/app/workers/custom_key_worker.rb
 - spec/app/workers/lolz_worker.rb
+- spec/app/workers/proc_period_worker.rb
 - spec/app/workers/proc_threshold_worker.rb
 - spec/app/workers/proc_worker.rb
 - spec/app/workers/regular_worker.rb
@@ -299,17 +318,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.5
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Sidekiq::Throttler is a middleware for Sidekiq that adds the ability to rate
@@ -317,6 +336,7 @@ summary: Sidekiq::Throttler is a middleware for Sidekiq that adds the ability to
 test_files:
 - spec/app/workers/custom_key_worker.rb
 - spec/app/workers/lolz_worker.rb
+- spec/app/workers/proc_period_worker.rb
 - spec/app/workers/proc_threshold_worker.rb
 - spec/app/workers/proc_worker.rb
 - spec/app/workers/regular_worker.rb