ruby-limiter 2.1.0 → 2.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 144e27e5e203e66c7d753c3da5bce267a514de2f32be74849e96104d6450efe6
-  data.tar.gz: 6ec690da1476b519f6cbb6b22ba921b2c8006db09a706553304c0077a692e553
+  metadata.gz: 8414ef377bee89d172c77d547a9cc0468bbfbf5a4a2b775ffa8faa137fdbed5b
+  data.tar.gz: 9065acd27f48647174b0cce72bb919869addb4dca0e53e8b5e5d446dfaff53d0
 SHA512:
-  metadata.gz: e4568e49199cc0a518439c808bc28e3281bdc44994495a0bee5e379c40c0de29bf45deee1e55d16d4f80df86424f26411c2f8b0fe13af605d18f8eb4b08c61db
-  data.tar.gz: 385abafc6d5e638829c0cd278a311b1d997a5c2b41e1010ae4b46cac5772498906f5254ab44777d353f36ef7ca228ce134ee2d6b91ceae4310384c4d9d5809e7
+  metadata.gz: 58dbd481ed08a6ed0ab24664c94488acb2206590de98f6cc06b4770acd797d1744a39d51a362893b7162381edc6da005ee7ec247cdec1fab4f7d9d4686da8355
+  data.tar.gz: 90c28e01feb7964814da473d1bddbaca86a0167f9d580aa9ac3281fafff73bca8c8e7dbda4147a56fc53ad56b8f424f523c881294e888f810760ad6c47f44624

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # 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

data/README.md

@@ -55,6 +55,27 @@ 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.
+
+
 ### Advanced Usage
 
 In cases where the mixin is not appropriate the `RateQueue` class can be used directly. As in the mixin examples above,

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|

data/lib/limiter/rate_queue.rb

@@ -4,11 +4,11 @@ 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)
+      @ring = balanced ? balanced_ring : unbalanced_ring
       @head = 0
       @mutex = Mutex.new
       @blk = blk
@@ -41,5 +41,21 @@ module Limiter
     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.2.2'
 end

data/limiter.gemspec

@@ -32,6 +32,6 @@ Gem::Specification.new do |spec|
   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 'rake', '~> 13.0'
   spec.add_development_dependency 'rubocop', '~> 0.56'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-limiter
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.2
 platform: ruby
 authors:
 - S. Brent Faulkner
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-08-30 00:00:00.000000000 Z
+date: 2022-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -72,14 +72,14 @@ dependencies:
     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