ruby-limiter 1.0.1 → 2.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c8b855660b5c5b40e96437d66444cbba63b07af6
-  data.tar.gz: f4486818e1c73464c3b6545ee35601282a1cb798
+SHA256:
+  metadata.gz: 8414ef377bee89d172c77d547a9cc0468bbfbf5a4a2b775ffa8faa137fdbed5b
+  data.tar.gz: 9065acd27f48647174b0cce72bb919869addb4dca0e53e8b5e5d446dfaff53d0
 SHA512:
-  metadata.gz: 53f3886fe4a1f71c5f7454eebfbc764b4880cca6ab1026bfadc3e2ee16709a95c5f01e4e2ff732b49b8a0332ffba06206715fda1561032d0916c47850f289f89
-  data.tar.gz: 4b33aeea30a63521f97adbaa290604cc176788e7a8ea4ea643a94bf08604ce779b53fcb36b9ec8f44c6a5d1d684897d1596635e21c4c3d6ee4cbdd8f3c8443a9
+  metadata.gz: 58dbd481ed08a6ed0ab24664c94488acb2206590de98f6cc06b4770acd797d1744a39d51a362893b7162381edc6da005ee7ec247cdec1fab4f7d9d4686da8355
+  data.tar.gz: 90c28e01feb7964814da473d1bddbaca86a0167f9d580aa9ac3281fafff73bca8c8e7dbda4147a56fc53ad56b8f424f523c881294e888f810760ad6c47f44624

data/.rubocop.yml

@@ -2,4 +2,4 @@ inherit_from:
   - https://shopify.github.io/ruby-style-guide/rubocop.yml
 
 AllCops:
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.7

data/.travis.yml

@@ -1,6 +1,6 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.3
-  - 2.4
-  - 2.5
+  - 2.6
+  - 2.7
+  - 3.0

data/CHANGELOG.md

@@ -1,5 +1,35 @@
 # CHANGELOG
 
+## 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
+
+## v2.0.1
+
+- eliminate kwarg warning in ruby 2.7 (while still supporting 2.6)
+
+## v2.0.0
+
+- end support for ruby 2.3/2.4/2.5
+- test on ruby 2.6/2.7/3.0 (using ruby 2.7 for development)
+
+## v1.1.0
+
+- using Process.clock_gettime(Process::CLOCK_MONOTONIC) instead of Time.now for improved accuracy
+
+## v1.0.2
+
+- DOCFIX: fix name of gem in README
+- BUGFIX: add ruby-limiter.rb so that it works better with bundler
+
 ## v1.0.1
 
 - BUGFIX: support arguments for throttled methods

data/README.md

@@ -7,7 +7,7 @@ This gem implements a simple mechanism to throttle or rate-limit operations in R
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'limiter'
+gem 'ruby-limiter'
 ```
 
 And then execute:
@@ -16,13 +16,13 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install limiter
+    $ gem install ruby-limiter
 
 ## Usage
 
 ### Basic Usage
 
-To rate limit calling an instance method, a mixin is provided. Simply specify the method to me limited, and the maximum
+To rate limit calling an instance method, a mixin is provided. Simply specify the method to be limited, and the maximum
 rate that the method can be called. This rate is (by default) a number of requests per minute.
 
 ``` ruby
@@ -46,22 +46,49 @@ class Widget
 
   # limit the rate we can call tick to 5 times per second
   # when the rate has been exceeded, a call to tick will block until the rate limit would not be exceeded
-  limit_method :tick, rate: 5, interval: 1
+  # and the provided block will be executed
+  limit_method(:tick, rate: 5, interval: 1) do
+    puts 'Limit reached'
+  end
 
   ...
 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.
+
+
 ### Advanced Usage
 
 In cases where the mixin is not appropriate the `RateQueue` class can be used directly. As in the mixin examples above,
-the `interval` parameter is optional (and defaults to 1 minute).
+the `interval` parameter is optional (and defaults to 1 minute). It is also possible
+to provide the block to `RateQueue`, which will be executed on each limit hit (useful for metrics).
 
 ``` ruby
 class Widget
   def initialize
     # create a rate-limited queue which allows 10000 operations per hour
-    @queue = RateQueue.new(10000, interval: 3600)
+    @queue = Limiter::RateQueue.new(10000, interval: 3600) do
+      puts "Hit the limit, waiting"
+    end
   end
 
   def tick

data/Rakefile

@@ -7,6 +7,7 @@ Rake::TestTask.new(:test) do |t|
   t.libs << "test"
   t.libs << "lib"
   t.test_files = FileList["test/**/*_test.rb"]
+  t.warning = true
 end
 
-task default: :test
+task default: :test

data/dev.yml

@@ -3,7 +3,7 @@
 name: limiter
 
 up:
-  - ruby: 2.4.4
+  - ruby: 2.7.3
   - bundler
 
 commands:

data/lib/limiter/clock.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'singleton'
+require 'forwardable'
+
+module Limiter
+  class Clock
+    include Singleton
+
+    extend SingleForwardable
+    def_single_delegators :instance, :sleep, :time
+
+    def sleep(interval)
+      Kernel.sleep(interval)
+    end
+
+    def time
+      Process.clock_gettime(Process::CLOCK_MONOTONIC)
+    end
+  end
+end

data/lib/limiter/mixin.rb

@@ -2,13 +2,13 @@
 
 module Limiter
   module Mixin
-    def limit_method(method, rate:, interval: 60)
-      queue = RateQueue.new(rate, interval: interval)
+    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|
+        define_method(method) do |*args, **options, &blk|
           queue.shift
-          super(*args)
+          options.empty? ? super(*args, &blk) : super(*args, **options, &blk)
         end
       end
 

data/lib/limiter/rate_queue.rb

@@ -2,15 +2,16 @@
 
 module Limiter
   class RateQueue
-    EPOCH = Time.at(0)
+    EPOCH = 0.0
 
-    def initialize(size, interval: 60)
+    def initialize(size, interval: 60, balanced: false, &blk)
       @size = size
       @interval = interval
 
-      @ring = Array.new(size, EPOCH)
+      @ring = balanced ? balanced_ring : unbalanced_ring
       @head = 0
       @mutex = Mutex.new
+      @blk = blk
     end
 
     def shift
@@ -21,7 +22,7 @@ module Limiter
 
         sleep_until(time + @interval)
 
-        @ring[@head] = Time.now
+        @ring[@head] = clock.time
         @head = (@head + 1) % @size
       end
 
@@ -31,9 +32,30 @@ module Limiter
     private
 
     def sleep_until(time)
-      interval = time - Time.now
+      interval = time - clock.time
       return unless interval.positive?
-      sleep(interval)
+      @blk.call if @blk
+      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 = '1.0.1'
+  VERSION = '2.2.2'
 end

data/lib/limiter.rb

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

data/lib/ruby-limiter.rb

@@ -0,0 +1 @@
+require 'limiter'

data/limiter.gemspec

@@ -13,6 +13,13 @@ Gem::Specification.new do |spec|
   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"
+  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|
     f.match(%r{^(test|spec|features)/})
@@ -21,9 +28,10 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = %w(lib)
 
-  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'minitest', '~> 5.0'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest-focus', '~> 1.3'
+  spec.add_development_dependency 'mocha', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rubocop', '~> 0.56'
-  spec.add_development_dependency 'timecop', '~> 0.8.0'
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: ruby-limiter
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 2.2.2
 platform: ruby
 authors:
 - S. Brent Faulkner
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-06 00:00:00.000000000 Z
+date: 2022-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -39,47 +39,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: minitest-focus
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.56'
+        version: '1.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.56'
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: timecop
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: '0.56'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: '0.56'
 description: 
 email:
 - brent.faulkner@shopify.com
@@ -100,14 +114,17 @@ files:
 - bin/setup
 - dev.yml
 - lib/limiter.rb
+- lib/limiter/clock.rb
 - lib/limiter/mixin.rb
 - lib/limiter/rate_queue.rb
 - lib/limiter/version.rb
+- lib/ruby-limiter.rb
 - limiter.gemspec
 homepage: https://github.com/Shopify/limiter
 licenses:
 - MIT
-metadata: {}
+metadata:
+  allowed_push_host: https://rubygems.org
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -116,15 +133,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 3.2.20
 signing_key: 
 specification_version: 4
 summary: Simple Ruby rate limiting mechanism.