ruby-limiter 2.1.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 144e27e5e203e66c7d753c3da5bce267a514de2f32be74849e96104d6450efe6
-  data.tar.gz: 6ec690da1476b519f6cbb6b22ba921b2c8006db09a706553304c0077a692e553
+  metadata.gz: b2f455d4d68023ae8d22bffc74ea4b6ad7abff350d6eb907e64c8e7db7c46caf
+  data.tar.gz: 18b08614e86f69ae5f3d1cb8209b2f9a3c70364567366fd27464d3a27cad37ee
 SHA512:
-  metadata.gz: e4568e49199cc0a518439c808bc28e3281bdc44994495a0bee5e379c40c0de29bf45deee1e55d16d4f80df86424f26411c2f8b0fe13af605d18f8eb4b08c61db
-  data.tar.gz: 385abafc6d5e638829c0cd278a311b1d997a5c2b41e1010ae4b46cac5772498906f5254ab44777d353f36ef7ca228ce134ee2d6b91ceae4310384c4d9d5809e7
+  metadata.gz: 6a2e10e3516975acd55786d335431a51f85946000d35fcc4c7bc18b22dcd59d9d651d09f8c4b0af597452b8a737e797cff7d1ca141e6d8ebbc0e2e5f05b96466
+  data.tar.gz: '08c8276f451020a58782ac27d030be523cab952a22db219c01ee1fde303a2d3df1eb7a76a6013a5418d0986a41bfc24794a5fb2a31c1cff9e90bc4c416227b00'

data/.github/workflows/ci.yml

@@ -0,0 +1,61 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: CI
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+permissions:
+  actions: read
+  contents: read
+  security-events: write
+
+jobs:
+  rubocop:
+
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.2
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Rubocop run
+      run: |
+        bash -c "
+          bundle exec rubocop --require code_scanning --format CodeScanning::SarifFormatter -o rubocop.sarif
+          [[ $? -ne 2 ]]
+        "
+    - name: Upload Sarif output
+      uses: github/codeql-action/upload-sarif@v2
+      with:
+        sarif_file: rubocop.sarif
+
+  tests:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['3.0', '3.1', '3.2']
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rake

data/.github/workflows/gem-push.yml

@@ -0,0 +1,31 @@
+name: Ruby Gem
+
+on:
+  push:
+    tags: [ "v*" ]
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.2
+
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${RUBYGEMS_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        RUBYGEMS_API_KEY: "${{secrets.RUBYGEMS_API_KEY}}"

data/.rubocop.yml

@@ -1,5 +1,14 @@
-inherit_from:
-  - https://shopify.github.io/ruby-style-guide/rubocop.yml
+inherit_gem:
+  rubocop-shopify: rubocop.yml
+
+require:
+  - rubocop-minitest
+  - rubocop-rake
 
 AllCops:
-  TargetRubyVersion: 2.7
+  NewCops: enable
+  TargetRubyVersion: 3.2
+
+Naming/FileName:
+  Exclude:
+    - 'lib/ruby-limiter.rb'

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # CHANGELOG
 
+## v2.3.0
+
+- add support for resetting RateQueue
+- add support for resetting mixin-limited method
+
+## v2.2.2
+
+- security update to rake 13.0.6 [CVE-2020-8130]
+
+## v2.2.0
+
+- adds support for "balancing" requests over time
+
 ## v2.1.0
 
 - add support to call a block when limiting takes place

data/Gemfile

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 gemspec

data/README.md

@@ -1,4 +1,4 @@
-# Limiter [![Build Status](https://travis-ci.org/Shopify/limiter.svg?branch=master)](https://travis-ci.org/Shopify/limiter)
+# Limiter [![Build Status](https://github.com/Shopify/limiter/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/Shopify/limiter/actions/workflows/ci.yml)
 
 This gem implements a simple mechanism to throttle or rate-limit operations in Ruby.
 
@@ -55,6 +55,44 @@ class Widget
 end
 ```
 
+#### Load balancing
+
+By default all calls to the `limit_method` will be bursted, e.g. as quick as possible, until the rate is exceeded.
+Then we wait for the remainder of the interval to continue. To even out the burst, an optional `balanced` parameter can be
+provided to enable interleaving between the method calls, e.g: `interleave = interval / size`.
+
+``` ruby
+  ...
+  limit_method :tick, rate: 60, balanced: true
+  ...
+```
+
+For example: with an interval of 60 seconds and a rate of 60:
+
+`balanced: false`
+: As quickly as possible we call the method 60 times, then we wait for the remainder of the time.
+
+`balanced: true`
+: We interleave each call with 1 second so we call this method every second.
+
+#### Resetting a rate-limited method
+
+There are times when it may be necessary to reset the rate limiter for a method, for example during testing.
+
+This can be done by calling `reset_method_limit!` on the class, where "method" is replaced with the name of the method being limited.
+
+Given the example above, the following would reset the rate limit for the `tick` method during test setup:
+
+``` ruby
+class WidgetTest < Minitest::Test
+  def setup
+    Widget.reset_tick_limit!
+  end
+
+  ...
+end
+```
+
 ### Advanced Usage
 
 In cases where the mixin is not appropriate the `RateQueue` class can be used directly. As in the mixin examples above,
@@ -78,6 +116,18 @@ class Widget
 end
 ```
 
+#### Resetting a RateQueue
+
+In some circumstances it may be desirable to reset a rate queue, for example after invoking an API that resets an external rate limit.
+
+This can be done by calling `reset` on the queue.
+
+``` ruby
+  ...
+  @queue.reset
+  ...
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/Rakefile

@@ -10,4 +10,4 @@ Rake::TestTask.new(:test) do |t|
   t.warning = true
 end
 
-task default: :test
+task default: :test

data/bin/console

@@ -1,8 +1,8 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require 'bundler/setup'
-require 'limiter'
+require "bundler/setup"
+require "limiter"
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -11,5 +11,5 @@ require 'limiter'
 # require 'pry'
 # Pry.start
 
-require 'irb'
+require "irb"
 IRB.start(__FILE__)

data/bin/rake

@@ -9,8 +9,10 @@
 #
 
 require "pathname"
-ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
-  Pathname.new(__FILE__).realpath)
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path(
+  "../../Gemfile",
+  Pathname.new(__FILE__).realpath,
+)
 
 bundle_binstub = File.expand_path("../bundle", __FILE__)
 

data/bin/rubocop

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+
+bundle_binstub = File.expand_path("bundle", __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300).include?("This file was generated by Bundler")
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rubocop", "rubocop")

data/dev.yml

@@ -3,8 +3,9 @@
 name: limiter
 
 up:
-  - ruby: 2.7.3
+  - ruby: 3.2.2
   - bundler
 
 commands:
   test: bin/rake test
+  style: bin/rubocop -a

data/lib/limiter/clock.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'singleton'
-require 'forwardable'
+require "singleton"
+require "forwardable"
 
 module Limiter
   class Clock

data/lib/limiter/mixin.rb

@@ -2,8 +2,8 @@
 
 module Limiter
   module Mixin
-    def limit_method(method, rate:, interval: 60, &b)
-      queue = RateQueue.new(rate, interval: interval, &b)
+    def limit_method(method, rate:, interval: 60, balanced: false, &b)
+      queue = RateQueue.new(rate, interval: interval, balanced: balanced, &b)
 
       mixin = Module.new do
         define_method(method) do |*args, **options, &blk|
@@ -12,7 +12,11 @@ module Limiter
         end
       end
 
-      prepend mixin
+      define_singleton_method("reset_#{method}_limit!") do
+        queue.reset
+      end
+
+      prepend(mixin)
     end
   end
 end

data/lib/limiter/rate_queue.rb

@@ -4,14 +4,23 @@ module Limiter
   class RateQueue
     EPOCH = 0.0
 
-    def initialize(size, interval: 60, &blk)
+    def initialize(size, interval: 60, balanced: false, &blk)
       @size = size
       @interval = interval
 
-      @ring = Array.new(size, EPOCH)
-      @head = 0
+      @balanced = balanced
+
       @mutex = Mutex.new
       @blk = blk
+
+      reset
+    end
+
+    def reset
+      @mutex.synchronize do
+        @ring = @balanced ? balanced_ring : unbalanced_ring
+        @head = 0
+      end
     end
 
     def shift
@@ -34,12 +43,29 @@ module Limiter
     def sleep_until(time)
       interval = time - clock.time
       return unless interval.positive?
-      @blk.call if @blk
+
+      @blk&.call
       clock.sleep(interval)
     end
 
     def clock
       Clock
     end
+
+    def unbalanced_ring
+      Array.new(@size, EPOCH)
+    end
+
+    def balanced_ring
+      (0...@size).map { |i| base_time + (gap * i) }
+    end
+
+    def gap
+      @interval.to_f / @size.to_f
+    end
+
+    def base_time
+      clock.time - @interval
+    end
   end
 end

data/lib/limiter/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Limiter
-  VERSION = '2.1.0'
+  VERSION = "2.3.0"
 end

data/lib/limiter.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'limiter/clock'
-require 'limiter/mixin'
-require 'limiter/rate_queue'
-require 'limiter/version'
+require "limiter/clock"
+require "limiter/mixin"
+require "limiter/rate_queue"
+require "limiter/version"

data/lib/ruby-limiter.rb

@@ -1 +1,3 @@
-require 'limiter'
+# frozen_string_literal: true
+
+require "limiter"

data/limiter.gemspec

@@ -1,37 +1,41 @@
 # frozen_string_literal: true
 
-lib = File.expand_path('lib', __dir__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'limiter/version'
+require "limiter/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = 'ruby-limiter'
+  spec.name          = "ruby-limiter"
   spec.version       = Limiter::VERSION
-  spec.authors       = ['S. Brent Faulkner']
-  spec.email         = ['brent.faulkner@shopify.com']
+  spec.authors       = ["S. Brent Faulkner"]
+  spec.email         = ["brent.faulkner@shopify.com"]
 
-  spec.summary       = 'Simple Ruby rate limiting mechanism.'
-  spec.homepage      = 'https://github.com/Shopify/limiter'
-  spec.license       = 'MIT'
+  spec.summary       = "Simple Ruby rate limiting mechanism."
+  spec.homepage      = "https://github.com/Shopify/limiter"
+  spec.license       = "MIT"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.6.0")
 
   if spec.respond_to?(:metadata)
-    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
   else
     raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
   end
 
-  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+  spec.files = %x(git ls-files -z).split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = 'exe'
+  spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = %w(lib)
+  spec.require_paths = ["lib"]
 
-  spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'minitest', '~> 5.0'
-  spec.add_development_dependency 'minitest-focus', '~> 1.3'
-  spec.add_development_dependency 'mocha', '~> 1.11'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rubocop', '~> 0.56'
+  spec.add_development_dependency("bundler")
+  spec.add_development_dependency("code-scanning-rubocop", "~> 0.6.1")
+  spec.add_development_dependency("minitest", "~> 5.20")
+  spec.add_development_dependency("minitest-focus", "~> 1.4")
+  spec.add_development_dependency("mocha", "~> 2.1")
+  spec.add_development_dependency("rake", "~> 13.0")
+  spec.add_development_dependency("rubocop", "~> 1.57")
+  spec.add_development_dependency("rubocop-minitest", "~> 0.33.0")
+  spec.add_development_dependency("rubocop-rake", "~> 0.6.0")
+  spec.add_development_dependency("rubocop-shopify", "~> 2.14")
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-limiter
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.3.0
 platform: ruby
 authors:
 - S. Brent Faulkner
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-08-30 00:00:00.000000000 Z
+date: 2023-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -24,76 +24,132 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: code-scanning-rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.1
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.20'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.20'
 - !ruby/object:Gem::Dependency
   name: minitest-focus
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.56'
+        version: '1.57'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.57'
+- !ruby/object:Gem::Dependency
+  name: rubocop-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.33.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.33.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-shopify
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.56'
+        version: '2.14'
 description: 
 email:
 - brent.faulkner@shopify.com
@@ -101,9 +157,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
+- ".github/workflows/gem-push.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -111,6 +168,7 @@ files:
 - Rakefile
 - bin/console
 - bin/rake
+- bin/rubocop
 - bin/setup
 - dev.yml
 - lib/limiter.rb
@@ -140,7 +198,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.20
+rubygems_version: 3.4.10
 signing_key: 
 specification_version: 4
 summary: Simple Ruby rate limiting mechanism.

data/.travis.yml

@@ -1,6 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.6
-  - 2.7
-  - 3.0