glutton_ratelimit 0.2.0 → 1.0.0

data/lib/glutton_ratelimit/bursty_ring_buffer.rb

@@ -1,24 +1,24 @@
-module GluttonRatelimit
-  
-  class BurstyRingBuffer < ParentLimiter
-    
-    def oldest_timestamp
-      @timestamps = Array.new executions, (Time.now - @time_period) if @timestamps.nil?
-      @timestamps[0]
-    end
-    
-    def current_timestamp= new_stamp
-      @timestamps.push(new_stamp).shift
-    end
-      
-    def wait
-      delta = Time.now - oldest_timestamp
-      sleep(@time_period - delta) if delta < @time_period
-      self.current_timestamp = Time.now
-    end
-    
-  end
-
-end
-
-
+module GluttonRatelimit
+  
+  class BurstyRingBuffer < ParentLimiter
+    
+    def oldest_timestamp
+      @timestamps ||= Array.new executions, (Time.now - @time_period) 
+      @timestamps[0]
+    end
+    
+    def current_timestamp= new_stamp
+      @timestamps.push(new_stamp).shift
+    end
+      
+    def wait
+      delta = Time.now - oldest_timestamp
+      sleep(@time_period - delta) if delta < @time_period
+      self.current_timestamp = Time.now
+    end
+    
+  end
+
+end
+
+

data/lib/glutton_ratelimit/bursty_token_bucket.rb

@@ -1,26 +1,30 @@
-module GluttonRatelimit
-  
-  class BurstyTokenBucket < ParentLimiter
-    
-    def reset_bucket
-      @oldest_timestamp = Time.now
-      @tokens = @executions
-    end
-    
-    def wait
-      reset_bucket if @tokens.nil?
-      
-      if @tokens.zero?
-        delta = Time.now - @oldest_timestamp
-        sleep(@time_period - delta) if delta < @time_period
-        reset_bucket
-      end
-      
-      @tokens -= 1
-    end
-    
-  end
-
-end
-
-
+module GluttonRatelimit
+  
+  class BurstyTokenBucket < ParentLimiter
+    def initialize executions, time_period
+      super(executions, time_period)
+      @tokens = nil
+    end
+    
+    def reset_bucket
+      @oldest_timestamp = Time.now
+      @tokens = @executions
+    end
+    
+    def wait
+      reset_bucket if @tokens.nil?
+      
+      if @tokens.zero?
+        delta = Time.now - @oldest_timestamp
+        sleep(@time_period - delta) if delta < @time_period
+        reset_bucket
+      end
+      
+      @tokens -= 1
+    end
+    
+  end
+
+end
+
+

data/test/helper.rb

@@ -1,20 +1,20 @@
-require 'rubygems'
-require 'test/unit'
-
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-require 'glutton_ratelimit'
-
-class Test::Unit::TestCase
-end
-
-def timed_run ratelimiter, passes = 1
-  before_last_invocation = 0
-  start_time = Time.now
-  ratelimiter.times(passes * ratelimiter.executions + 1) do
-    before_last_invocation = Time.now
-    yield
-  end 
-  before_last_invocation - start_time
-end
-
+require 'rubygems'
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'glutton_ratelimit'
+
+class Test::Unit::TestCase
+end
+
+def timed_run ratelimiter, passes = 1
+  before_last_invocation = 0
+  start_time = Time.now
+  ratelimiter.times(passes * ratelimiter.executions + 1) do
+    before_last_invocation = Time.now
+    yield
+  end 
+  before_last_invocation - start_time
+end
+

data/test/test_glutton_ratelimit_averaged_throttle.rb

@@ -1,15 +1,15 @@
-require 'helper'
-require 'testing_module.rb'
-
-class TestGluttonRatelimitAveragedThrottle < Test::Unit::TestCase
-  include TestingModule
-  
-  def setup
-    @testClass = GluttonRatelimit::AveragedThrottle
-  end
-  
-  def test_object_creations
-    rl = @testClass.new 1, 1
-    assert_instance_of GluttonRatelimit::AveragedThrottle, rl
-  end
-end
+require 'helper'
+require 'testing_module.rb'
+
+class TestGluttonRatelimitAveragedThrottle < Test::Unit::TestCase
+  include TestingModule # All the shared tests are in here.
+  
+  def setup
+    @testClass = GluttonRatelimit::AveragedThrottle
+  end
+  
+  def test_object_creations
+    rl = @testClass.new 1, 1
+    assert_instance_of GluttonRatelimit::AveragedThrottle, rl
+  end
+end

data/test/test_glutton_ratelimit_bursty_ring_buffer.rb

@@ -1,15 +1,15 @@
-require 'helper'
-require 'testing_module.rb'
-
-class TestGluttonRatelimitBurstyRingBuffer < Test::Unit::TestCase
-  include TestingModule
-  
-  def setup
-    @testClass = GluttonRatelimit::BurstyRingBuffer
-  end
-  
-  def test_object_creations
-    rl = @testClass.new 1, 1
-    assert_instance_of GluttonRatelimit::BurstyRingBuffer, rl
-  end
-end
+require 'helper'
+require 'testing_module.rb'
+
+class TestGluttonRatelimitBurstyRingBuffer < Test::Unit::TestCase
+  include TestingModule # All the shared tests are in here.
+  
+  def setup
+    @testClass = GluttonRatelimit::BurstyRingBuffer
+  end
+  
+  def test_object_creations
+    rl = @testClass.new 1, 1
+    assert_instance_of GluttonRatelimit::BurstyRingBuffer, rl
+  end
+end

data/test/test_glutton_ratelimit_bursty_token_bucket.rb

@@ -1,15 +1,15 @@
-require 'helper'
-require 'testing_module.rb'
-
-class TestGluttonRatelimitBurtyTokenBucket < Test::Unit::TestCase
-  include TestingModule
-  
-  def setup
-    @testClass = GluttonRatelimit::BurstyTokenBucket
-  end
-  
-  def test_object_creations
-    rl = @testClass.new 1, 1
-    assert_instance_of GluttonRatelimit::BurstyTokenBucket, rl
-  end
-end
+require 'helper'
+require 'testing_module.rb'
+
+class TestGluttonRatelimitBurtyTokenBucket < Test::Unit::TestCase
+  include TestingModule # All the shared tests are in here.
+  
+  def setup
+    @testClass = GluttonRatelimit::BurstyTokenBucket
+  end
+  
+  def test_object_creations
+    rl = @testClass.new 1, 1
+    assert_instance_of GluttonRatelimit::BurstyTokenBucket, rl
+  end
+end

data/test/testing_module.rb

@@ -1,69 +1,73 @@
-module TestingModule
-  # This module assumes use as a mixin within
-  # a test class which defines @testClass.
-  
-  def test_120_tasks_every_second_with_ms_task
-    min_time = 1
-    rl = @testClass.new 120, min_time
-    delta = timed_run(rl) { sleep 0.001 }
-    #puts "#{delta} >? #{min_time}"
-    assert delta >= min_time
-  end
-  
-  def test_120_tasks_every_quarter_second_with_ms_task
-    min_time = 0.25
-    rl = @testClass.new 120, min_time
-    delta = timed_run(rl) { sleep 0.001 }
-    #puts "#{delta} >? #{min_time}"
-    assert delta >= min_time
-  end
-  
-  def test_120_tasks_every_second_with_cenisecond_task
-    min_time = 1
-    rl = @testClass.new 120, min_time
-    delta = timed_run(rl) { sleep 0.01 }
-    #puts "#{delta} >? #{min_time}"
-    assert delta >= min_time
-  end
-  
-  def test_50_tasks_every_second_with_no_task
-    min_time = 1
-    rl = @testClass.new 50, min_time
-    delta = timed_run(rl) { sleep 0 }
-    #puts "#{delta} >? #{min_time}"
-    # Allowed to be off by 0.5% since there is no task time.
-    assert((delta / min_time) > 0.995)
-  end
-  
-  def test_1_task_every_1_seconds_with_1_second_task
-    min_time = 1
-    rl = @testClass.new 1, min_time
-    delta = timed_run(rl) { sleep 1 }
-    #puts "#{delta} >? #{min_time}"
-    assert delta >= min_time
-  end
-  
-  def test_5_tasks_every_quarter_second_four_runs_with_ms_task
-    min_time = 0.25
-    rl = @testClass.new 1, min_time
-    delta = timed_run(rl, 4) { sleep 0.001 }
-    #puts "#{delta} >? #{min_time}"
-    assert delta >= min_time * 4
-  end
-  
-  def test_120_tasks_every_half_second_two_runs_with_no_task
-    min_time = 0.5
-    rl = @testClass.new 120, min_time
-    delta = timed_run(rl, 2) { sleep 0 }
-    # Allowed to be off by 0.5% since there is no task time.
-    assert((delta / (min_time * 2)) > 0.995)
-  end
-  
-  def test_10_tasks_every_1_seconds_two_runs_with_short_rnd_task
-    min_time = 1
-    rl = @testClass.new 10, min_time
-    delta = timed_run(rl, 2) { sleep(0.2 * rand) }
-    assert delta >= min_time * 2
-  end
-  
-end
+module TestingModule
+  # This module assumes use as a mixin within
+  # a test class which defines @testClass.
+
+  TIMING_TOLERANCE = 0.995 # Timing can be off by 0.5%
+
+  def test_120_tasks_every_second_with_ms_task
+    min_time = 1
+    rl = @testClass.new 120, min_time
+    delta = timed_run(rl) { sleep 0.001 }
+    # puts "\n#{delta} >? #{min_time}"
+    assert((delta / min_time) > TIMING_TOLERANCE)
+  end
+
+  def test_120_tasks_every_quarter_second_with_ms_task
+    min_time = 0.25
+    rl = @testClass.new 120, min_time
+    delta = timed_run(rl) { sleep 0.001 }
+    # puts "\n#{delta} >? #{min_time}"
+    assert((delta / min_time) > TIMING_TOLERANCE)
+  end
+
+  def test_120_tasks_every_second_with_cenisecond_task
+    min_time = 1
+    rl = @testClass.new 120, min_time
+    delta = timed_run(rl) { sleep 0.01 }
+    # puts "\n#{delta} >? #{min_time}"
+    assert((delta / min_time) > TIMING_TOLERANCE)
+  end
+
+  def test_50_tasks_every_second_with_no_task
+    min_time = 1
+    rl = @testClass.new 50, min_time
+    delta = timed_run(rl) { sleep 0 }
+    # puts "\n#{delta} >? #{min_time}"
+    assert((delta / min_time) > TIMING_TOLERANCE)
+  end
+
+  def test_1_task_every_1_seconds_with_1_second_task
+    min_time = 1
+    rl = @testClass.new 1, min_time
+    delta = timed_run(rl) { sleep 1 }
+    # puts "\n#{delta} >? #{min_time}"
+    assert((delta / min_time) > TIMING_TOLERANCE)
+  end
+
+  def test_5_tasks_every_quarter_second_four_runs_with_ms_task
+    min_time = 0.25
+    runs = 4
+    rl = @testClass.new 1, min_time
+    delta = timed_run(rl, runs) { sleep 0.001 }
+    # puts "\n#{delta} >? #{min_time * runs}"
+    assert((delta / (min_time * runs)) > TIMING_TOLERANCE)
+  end
+
+  def test_120_tasks_every_half_second_two_runs_with_no_task
+    min_time = 0.5
+    runs = 2
+    rl = @testClass.new 120, min_time
+    delta = timed_run(rl, 2) { sleep 0 }
+    # puts "\n#{delta} >? #{min_time * runs}"
+    assert((delta / (min_time * runs)) > TIMING_TOLERANCE)
+  end
+
+  def test_10_tasks_every_1_seconds_two_runs_with_short_rnd_task
+    min_time = 1
+    runs = 2
+    rl = @testClass.new 10, min_time
+    delta = timed_run(rl, 2) { sleep(0.2 * rand) }
+    # puts "\n#{delta} >? #{min_time * runs}"
+    assert((delta / (min_time * runs)) > TIMING_TOLERANCE)
+  end
+end

metadata

@@ -1,34 +1,58 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: glutton_ratelimit
-version: !ruby/object:Gem::Version 
-  hash: 23
-  prerelease: 
-  segments: 
-  - 0
-  - 2
-  - 0
-  version: 0.2.0
+version: !ruby/object:Gem::Version
+  version: 1.0.0
 platform: ruby
-authors: 
+authors:
 - Wally Glutton
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-06-30 00:00:00 Z
-dependencies: []
-
-description: A Ruby library for limiting the number of times a method can be invoked within a specified time period.
+date: 2019-12-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  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: test-unit
+  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'
+description: A Ruby library for limiting the number of times a method can be invoked
+  within a specified time period.
 email: stungeye@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - LICENSE
 - README.rdoc
-files: 
-- .document
+files:
+- ".document"
+- ".github/workflows/ruby.yml"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
 - LICENSE
 - README.rdoc
 - Rakefile
@@ -47,36 +71,25 @@ files:
 - test/testing_module.rb
 homepage: http://github.com/stungeye/glutton_ratelimit
 licenses: []
-
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.5
+rubygems_version: 2.7.6.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Simple Ruby library for self-imposed rater-limiting.
 test_files: []
-