sidekiq-rate-limiter 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da0ce704c9994a18ca7c39d7538a5ae94c39077b13cbb778268852257b6a3f32
-  data.tar.gz: cfef0d3b9cbd392603bdcc7e7f2110f10a91714623968dc058c425efc7ec871f
+  metadata.gz: eaf0f64591b7ddcbba0d15b889fdfbe2b639cce8b112a8be3e92ec9cac2dc07e
+  data.tar.gz: fbfadc77f1bf676221b3e8c268a4ac60d4a19bc55e3a22a74c2084b9e62c3ee2
 SHA512:
-  metadata.gz: facff020ca688b54a9ce5b294b14f5f7a931c45efb9af22cbfbbb7c1d85c772697e076220ae17e7b6a249adf9c1f4c024de670072e15d8b520a799e15907babf
-  data.tar.gz: fa1f1d598646e7601bd505cf6c5dab9979ae2bd3b39fb14e93d32c248036ef044ab1125d5f5e2e35dfbe70eb7f0d6869fc4fa2a1130fde06eba1f6a40cb94162
+  metadata.gz: 00bf480916d2764f62e2e96b377573bcfe266c05c95d8a395f5b1293c84d3122f11355fa311c9af019fc50b07ae4228c51e06e4ded5dcb571c040b158d5fb6b3
+  data.tar.gz: 2907155a2a62408dcb3e1e928669588bd269057215de35cbe41782ee130e514823ff9fdc618f6b132484151bf8ca652360b213c0eaf398fb20b0ff815e235570

data/.github/workflows/test.yml

@@ -0,0 +1,48 @@
+name: Test
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby-version: ['3.1', '2.7']
+        sidekiq-version: ['4', '5', '6.0', '6.1', '6.x']
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@359bebbc29cbe6c87da6bc9ea3bc930432750108
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+
+      - name: Install dependencies
+        run: bundle install --gemfile=gemfiles/sidekiq_${{ matrix.sidekiq-version }}.gemfile
+
+      - name: Start Redis
+        uses: supercharge/redis-github-action@1.5.0
+
+      - name: Run tests
+        run: bundle exec --gemfile=gemfiles/sidekiq_${{ matrix.sidekiq-version }}.gemfile rspec
+
+      - name: Coveralls
+        uses: coverallsapp/github-action@v1
+        with:
+          flag-name: run-${{ join(matrix.*, '-') }}
+          parallel: true
+      
+  finish:
+    needs: test
+    if: ${{ always() }}
+    runs-on: ubuntu-latest
+    steps:
+    - name: Coveralls Finished
+      uses: coverallsapp/github-action@v1
+      with:
+        parallel-finished: true

data/.ruby-version

@@ -0,0 +1 @@
+2.7.6

data/CHANGELOG.md

@@ -1,3 +1,22 @@
+## 0.2.0 (Mar 1, 2023)
+
+* Upstream fix for sidekiq 6.5.0 [#43, thanks to 5minpause]
+* Add support for new Sidekiq's configuration model [#42, thanks to anero]
+* gemspec: Drop defunct property rubyforge_project [#37, thanks to olleolleolle]
+
+## 0.1.3 (Oct 15, 2019)
+
+* Fix errors when using with redis-rb > 4.1.0 [#30, #31]
+
+## 0.1.2 (Jul 5, 2018)
+
+* Add (provisional) Sidekiq 5 support
+
+## 0.1.1 (Feb 15, 2016)
+
+* Add Sidekiq 4 support
+* Drop Ruby 1.9 support
+
 ## 0.1.0 (May 30, 2014)
 
 * Support callables for all configuration options

data/README.md

@@ -2,18 +2,17 @@ sidekiq-rate-limiter
 ====================
 
 [![Gem Version](https://badge.fury.io/rb/sidekiq-rate-limiter.svg)](https://rubygems.org/gems/sidekiq-rate-limiter)
-[![Build Status](https://secure.travis-ci.org/enova/sidekiq-rate-limiter.svg?branch=master)](http://travis-ci.org/enova/sidekiq-rate-limiter)
+[![Test Status](https://github.com/enova/sidekiq-rate-limiter/actions/workflows/test.yml/badge.svg)](https://github.com/enova/sidekiq-rate-limiter/actions/workflows/test.yml)
 [![Coverage Status](https://coveralls.io/repos/github/enova/sidekiq-rate-limiter/badge.svg?branch=master)](https://coveralls.io/github/enova/sidekiq-rate-limiter?branch=master)
-[![Dependency Status](https://gemnasium.com/enova/sidekiq-rate-limiter.svg)](https://gemnasium.com/enova/sidekiq-rate-limiter)
 
 Redis-backed, per-worker rate limits for job processing.
 
 ## Compatibility
 
-sidekiq-rate-limiter is actively tested against MRI versions 2.1, 2.2, and 2.3.
+sidekiq-rate-limiter is actively tested against MRI versions 2.7 and 3.1.
 
 sidekiq-rate-limiter works by using a custom fetch class, the class responsible
-for pulling work from the queue stored in redis. Consequently you'll want to be
+for pulling work from the queue stored in Redis. Consequently you'll want to be
 careful about using other gems that use a same strategy, [sidekiq-priority](https://github.com/socialpandas/sidekiq-priority)
 being one example.
 
@@ -32,7 +31,7 @@ class MyWorker
 end
 ```
 
-Then you wouldn't need to change anything. 
+Then you wouldn't need to change anything.
 
 ## Installation
 
@@ -60,12 +59,14 @@ require 'sidekiq-rate-limiter/server'
 
 Or, if you prefer, amend your Gemfile like so:
 
-    gem 'sidekiq-rate-limiter', :require => 'sidekiq-rate-limiter/server'
+```ruby
+gem 'sidekiq-rate-limiter', require: 'sidekiq-rate-limiter/server'
+```
 
-By default the limiter uses the name 'sidekiq-rate-limiter'. You can define the
-constant ```Sidekiq::RateLimiter::DEFAULT_LIMIT_NAME``` prior to requiring to
-change this. Alternatively, you can include a 'name' parameter in the configuration
-hash included in sidekiq_options
+By default the limiter uses the name `sidekiq-rate-limiter`. You can define the
+constant `Sidekiq::RateLimiter::DEFAULT_LIMIT_NAME` prior to requiring to
+change this. Alternatively, you can include a `name` parameter in the configuration
+hash included in `sidekiq_options`
 
 For example, the following:
 
@@ -73,11 +74,11 @@ For example, the following:
   class Job
     include Sidekiq::Worker
 
-    sidekiq_options :queue => 'some_silly_queue',
-                    :rate  => {
-                      :name   => 'my_super_awesome_rate_limit',
-                      :limit  => 50,
-                      :period => 3600, ## An hour
+    sidekiq_options queue: 'some_silly_queue',
+                    rate: {
+                      name:   'my_super_awesome_rate_limit',
+                      limit:  50,
+                      period: 3600, ## An hour
                     }
 
     def perform(*args)
@@ -86,7 +87,7 @@ For example, the following:
 ```
 
 The configuration above would result in any jobs beyond the first 50 in a one
-hour period being delayed. The server will continue to fetch items from redis, &
+hour period being delayed. The server will continue to fetch items from Redis, &
 will place any items that are beyond the threshold at the back of their queue.
 
 ### Dynamic Configuration
@@ -99,11 +100,11 @@ The `Proc` may receive as its arguments the same values that will be passed to `
 class Job
   include Sidekiq::Worker
 
-  sidekiq_options :queue => "my_queue",
-                  :rate => {
-                    :name   => ->(user_id, rate_limit) { user_id },
-                    :limit  => ->(user_id, rate_limit) { rate_limit },
-                    :period => ->{ Date.today.monday? ? 2.hours : 4.hours }, # can ignore arguments
+  sidekiq_options queue: "my_queue",1
+                  rate: {
+                    name:   ->(user_id, rate_limit) { user_id },
+                    limit:  ->(user_id, rate_limit) { rate_limit },
+                    period: ->{ Date.today.monday? ? 2.hours : 4.hours }, # can ignore arguments
                   }
 
   def perform(user_id, rate_limit)
@@ -120,9 +121,9 @@ limited multiple times are counted as 'processed' each time, so the stats balloo
 
 ## TODO
 
-* While it subclasses instead of monkey patching, setting Sidekiq.options[:fetch]
+* While it subclasses instead of monkey patching, setting `Sidekiq.options[:fetch]`
 is still asking for interaction issues. It would be better for this to be directly
-in sidekiq or to use some other means to accomplish this goal.
+in Sidekiq or to use some other means to accomplish this goal.
 
 ## Contributing
 

data/gemfiles/{sidekiq_2.gemfile → sidekiq_5.gemfile}

@@ -1,5 +1,5 @@
 source "https://rubygems.org"
 
-gem 'sidekiq', '~> 2.0'
+gem 'sidekiq', '~> 5.0'
 
 gemspec path: '../'

data/gemfiles/{sidekiq_3.gemfile → sidekiq_6.0.gemfile}

@@ -1,5 +1,5 @@
 source "https://rubygems.org"
 
-gem 'sidekiq', '~> 3.0'
+gem 'sidekiq', '~> 6.0.0'
 
 gemspec path: '../'

data/gemfiles/sidekiq_6.1.gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem 'sidekiq', '~> 6.1.0'
+
+gemspec path: '../'

data/gemfiles/sidekiq_6.x.gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem 'sidekiq', '~> 6.5.8'
+
+gemspec path: '../'

data/lib/sidekiq-rate-limiter/fetch.rb

@@ -1,5 +1,4 @@
 require 'sidekiq'
-require 'celluloid' if Sidekiq::VERSION < "4"
 require 'sidekiq/fetch'
 require 'redis_rate_limiter'
 
@@ -27,7 +26,7 @@ module Sidekiq::RateLimiter
 
       options = {
         :limit    => (limit.respond_to?(:call) ? limit.call(*args) : limit).to_i,
-        :interval => (interval.respond_to?(:call) ? interval.call(*args) : interval).to_f,
+        :interval => (interval.respond_to?(:call) ? interval.call(*args) : interval).to_i,
         :name     => (name.respond_to?(:call) ? name.call(*args) : name).to_s,
       }
 
@@ -90,7 +89,7 @@ module Sidekiq::RateLimiter
       worker_class = @message['class']
       options = Object.const_get(worker_class).get_sidekiq_options rescue {}
       server_rate = options['rate'] || options['throttle'] || {}
-      @server_rate = server_rate.stringify_keys
+      @server_rate = server_rate.map { |k, v| [k.to_s, v] }.to_h
     end
   end
 

data/lib/sidekiq-rate-limiter/server.rb

@@ -2,5 +2,12 @@ require 'sidekiq-rate-limiter/version'
 require 'sidekiq-rate-limiter/fetch'
 
 Sidekiq.configure_server do |config|
-  Sidekiq.options[:fetch] = Sidekiq::RateLimiter::Fetch
+  # Backwards compatibility for Sidekiq < 6.1.0 (see https://github.com/mperham/sidekiq/pull/4602 for details)
+  if (Sidekiq::BasicFetch.respond_to?(:bulk_requeue))
+    Sidekiq.options[:fetch] = Sidekiq::RateLimiter::Fetch
+  elsif (Sidekiq::VERSION < '6.5.0') # Sidekiq config was redesigned in https://github.com/mperham/sidekiq/pull/5340
+    Sidekiq.options[:fetch] = Sidekiq::RateLimiter::Fetch.new(Sidekiq.options)
+  else
+    Sidekiq[:fetch] = Sidekiq::RateLimiter::Fetch.new(Sidekiq)
+  end
 end

data/lib/sidekiq-rate-limiter/version.rb

@@ -1,5 +1,5 @@
 module Sidekiq
   module RateLimiter
-    VERSION = "0.1.2"
+    VERSION = "0.2.0"
   end
 end

data/sidekiq-rate-limiter.gemspec

@@ -13,7 +13,6 @@ Gem::Specification.new do |s|
   s.homepage    = "https://github.com/enova/sidekiq-rate-limiter"
   s.summary     = %q{Redis-backed, per-worker rate limits for job processing}
   s.description = %q{Redis-backed, per-worker rate limits for job processing}
-  s.rubyforge_project = "nowarning"
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
@@ -24,8 +23,9 @@ Gem::Specification.new do |s|
   s.add_development_dependency "pry-byebug"
   s.add_development_dependency "rake"
   s.add_development_dependency "rspec", '~> 3.4'
-  s.add_development_dependency "coveralls", '~> 0.8'
+  s.add_development_dependency "simplecov"
+  s.add_development_dependency "simplecov-lcov", '~> 0.8.0'
 
-  s.add_dependency "sidekiq", ">= 2.0", "< 6.0"
+  s.add_dependency "sidekiq", ">= 4.0", "< 7.0"
   s.add_dependency "redis_rate_limiter"
 end

data/spec/sidekiq-rate-limiter/fetch_spec.rb

@@ -27,7 +27,14 @@ RSpec.describe Sidekiq::RateLimiter::Fetch do
     end
   end
 
-  let(:options)       { { queues: [queue, another_queue, another_queue] } }
+  let(:options) do
+    if Sidekiq::VERSION =~ /^(4|5|6\.[0-4])/
+      { queues: [queue, another_queue, another_queue] }
+    else
+      Sidekiq.tap { |s| s[:queues] = [queue, another_queue, another_queue] }
+    end
+  end
+
   let(:queue)         { 'basic' }
   let(:another_queue) { 'some_other_queue' }
   let(:args)          { ['I am some args'] }
@@ -46,8 +53,13 @@ RSpec.describe Sidekiq::RateLimiter::Fetch do
       else
         Sidekiq::Fetcher::TIMEOUT
       end
+    
+    if Sidekiq::VERSION.start_with?('6.5.')
+      _timeout = { timeout: timeout}
+      timeout = _timeout
+    end
 
-    fetch = described_class.new options.merge(:strict => true)
+    fetch = described_class.new options.merge!(:strict => true)
     expect(fetch.queues_cmd).to eql(["queue:#{queue}", "queue:#{another_queue}", timeout])
   end
 

data/spec/sidekiq-rate-limiter/server_spec.rb

@@ -8,13 +8,21 @@ RSpec.describe Sidekiq::RateLimiter, 'server configuration' do
 
   it 'should set Sidekiq.options[:fetch] as desired' do
     Sidekiq.configure_server do |config|
-      expect(Sidekiq.options[:fetch]).to eql(Sidekiq::RateLimiter::Fetch)
+      if Sidekiq::VERSION =~ /^(4|5|6.0)/
+        expect(Sidekiq.options[:fetch]).to eql(Sidekiq::RateLimiter::Fetch)
+      else
+        expect(Sidekiq.options[:fetch]).to be_a(Sidekiq::RateLimiter::Fetch)
+      end
     end
   end
 
   it 'should inherit from Sidekiq::BasicFetch' do
     Sidekiq.configure_server do |config|
-      expect(Sidekiq.options[:fetch]).to be < Sidekiq::BasicFetch
+      if Sidekiq::VERSION =~ /^(4|5|6.0)/
+        expect(Sidekiq.options[:fetch]).to be < Sidekiq::BasicFetch
+      else
+        expect(Sidekiq.options[:fetch].class.ancestors[1]).to be(Sidekiq::BasicFetch)
+      end
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,35 +1,11 @@
 require 'sidekiq'
 require 'sidekiq/testing'
-
-## Confirming presence of redis server executable
-abort "## `redis-server` not in path" if %x(which redis-server).empty?
-redis_dir = "#{File.dirname(__FILE__)}/support/redis"
-
-## Redis configuration
-REDIS_CONFIG = <<-CONF
-  daemonize yes
-  pidfile #{redis_dir}/test.pid
-  port 6380
-  timeout 300
-  save 900 1
-  save 300 10
-  save 60 10000
-  dbfilename test.rdb
-  dir #{redis_dir}
-  loglevel warning
-  logfile stdout
-  databases 1
-CONF
-
-%x(echo '#{REDIS_CONFIG}' > #{redis_dir}/test.conf)
-redis_command = "redis-server #{redis_dir}/test.conf"
-%x[ #{redis_command} ]
-##
+require 'pry-byebug'
 
 ## Configuring sidekiq
 options = {
   logger: nil,
-  redis: { :url => "redis://localhost:6380/0" }
+  redis: { url: ENV.fetch('REDIS_URL', 'redis://localhost:6379/0') }
 }
 
 Sidekiq.configure_client do |config|
@@ -43,12 +19,27 @@ Sidekiq.configure_server do |config|
     config.send("#{option}=", value)
   end
 end
-##
 
+
+## Code Coverage
 require 'simplecov'
 
+SimpleCov.start do
+  if ENV['CI']
+    require 'simplecov-lcov'
+
+    SimpleCov::Formatter::LcovFormatter.config do |c|
+      c.report_with_single_file = true
+      c.single_report_path = 'coverage/lcov.info'
+    end
+
+    formatter SimpleCov::Formatter::LcovFormatter
+  end
+
+  add_filter %w[version.rb spec/]
+end
+
 require File.expand_path("../../lib/sidekiq-rate-limiter", __FILE__)
-##
 
 ## Hook to set Sidekiq::Testing mode using rspec tags
 RSpec.configure do |config|
@@ -76,18 +67,5 @@ RSpec.configure do |config|
     elsif Sidekiq::Testing.fake?
       Sidekiq::Worker.clear_all
     end
-
-  end
-
-  config.after(:all) do
-    ## Stopping Redis
-    ps = %x(ps -A -o pid,command | grep '#{redis_command}' | grep -v grep).split($/)
-    pids = ps.map { |p| p.split(/\s+/).reject(&:empty?).first.to_i }
-    pids.each { |pid| Process.kill("TERM", pid) }
-
-    ## Cleaning up
-    sleep 0.1
-    %x(rm -rf #{redis_dir}/*)
   end
 end
-##

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-rate-limiter
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Docady
 - Blake Thomas
 - Enova
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-07-05 00:00:00.000000000 Z
+date: 2023-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -69,39 +69,53 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.4'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  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: simplecov-lcov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: 0.8.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: 0.8.0
 - !ruby/object:Gem::Dependency
   name: sidekiq
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '4.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '4.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: redis_rate_limiter
   requirement: !ruby/object:Gem::Requirement
@@ -123,18 +137,20 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
-- ".simplecov"
-- ".travis.yml"
+- ".ruby-version"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
-- gemfiles/sidekiq_2.gemfile
-- gemfiles/sidekiq_3.gemfile
 - gemfiles/sidekiq_4.gemfile
+- gemfiles/sidekiq_5.gemfile
+- gemfiles/sidekiq_6.0.gemfile
+- gemfiles/sidekiq_6.1.gemfile
+- gemfiles/sidekiq_6.x.gemfile
 - lib/sidekiq-rate-limiter.rb
 - lib/sidekiq-rate-limiter/fetch.rb
 - lib/sidekiq-rate-limiter/server.rb
@@ -148,7 +164,7 @@ homepage: https://github.com/enova/sidekiq-rate-limiter
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -163,9 +179,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: nowarning
-rubygems_version: 2.7.7
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: Redis-backed, per-worker rate limits for job processing
-test_files: []
+test_files:
+- spec/sidekiq-rate-limiter/fetch_spec.rb
+- spec/sidekiq-rate-limiter/server_spec.rb
+- spec/spec_helper.rb
+- spec/support/redis/.keep

data/.simplecov

@@ -1,6 +0,0 @@
-require 'coveralls'
-
-Coveralls.wear! do
-  add_filter "vendor"
-  add_filter "spec"
-end

data/.travis.yml

@@ -1,20 +0,0 @@
-language: ruby
-cache: bundler
-sudo: false
-rvm:
-  - 2.3.0
-  - 2.2.4
-  - 2.1.8
-
-gemfile:
-  - 'gemfiles/sidekiq_2.gemfile'
-  - 'gemfiles/sidekiq_3.gemfile'
-  - 'gemfiles/sidekiq_4.gemfile'
-
-deploy:
-  provider: rubygems
-  api_key:
-    secure: "VX48kpd9UySMWSDMwjxaNZy14RW1usU7eFLGNeohjCzxUsCywn+mS5/IZHl56vDXWJp7JwnboDiIa74hGV86PcSEM7kr+DAZO33iCazMNTpoWDiH1iJfj0jZbO2rOvx0rGI9fGYcC9xfyKQ37hVb13Eo0bnKa0YX30HArnx7EFo="
-  on:
-    tags: true
-    all_branches: true