glutton_ratelimit 0.2.0 → 1.0.0

data/Rakefile

@@ -1,52 +1,50 @@
-require 'rubygems'
-require 'rake'
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "glutton_ratelimit"
-    gem.summary = %Q{Simple Ruby library for self-imposed rater-limiting.}
-    gem.description = %Q{A Ruby library for limiting the number of times a method can be invoked within a specified time period.}
-    gem.email = "stungeye@gmail.com"
-    gem.homepage = "http://github.com/stungeye/glutton_ratelimit"
-    gem.authors = ["Wally Glutton"]
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
-end
-
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-end
-
-begin
-  require 'rcov/rcovtask'
-  Rcov::RcovTask.new do |test|
-    test.libs << 'test'
-    test.pattern = 'test/**/test_*.rb'
-    test.verbose = true
-  end
-rescue LoadError
-  task :rcov do
-    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
-  end
-end
-
-task :test => :check_dependencies
-
-task :default => :test
-
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "glutton_ratelimit #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "glutton_ratelimit"
+    gem.summary = %Q{Simple Ruby library for self-imposed rater-limiting.}
+    gem.description = %Q{A Ruby library for limiting the number of times a method can be invoked within a specified time period.}
+    gem.email = "stungeye@gmail.com"
+    gem.homepage = "http://github.com/stungeye/glutton_ratelimit"
+    gem.authors = ["Wally Glutton"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "glutton_ratelimit #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -1 +1 @@
-0.2.0
+1.0.0

data/examples/limit_instance_methods.rb

@@ -1,34 +1,34 @@
-require 'rubygems'
-require 'glutton_ratelimit'
-
-class LimitInstanceMethods
-  extend GluttonRatelimit
-    
-  def initialize
-    @start = Time.now
-  end
-  
-  def limit_me
-    puts "#{Time.now - @start}"
-    sleep 0.001
-  end
-  
-  def cap_me
-    puts "#{Time.now - @start}"
-    sleep 0.001
-  end
-  
-  rate_limit :limit_me, 6, 6
-  rate_limit :cap_me, 6, 6, GluttonRatelimit::BurstyTokenBucket
-end
-
-t = LimitInstanceMethods.new
-
-puts "Six requests every 6 seconds (Averaged): "
-13.times { t.limit_me }
-puts "Six requests every 6 seconds (Bursty): "
-13.times { t.cap_me }
-
-# In both cases:
-# The 7th execution should occur after 6 seconds after the first.
+require 'rubygems'
+require 'glutton_ratelimit'
+
+class LimitInstanceMethods
+  extend GluttonRatelimit
+    
+  def initialize
+    @start = Time.now
+  end
+  
+  def limit_me
+    puts "#{Time.now - @start}"
+    sleep 0.001
+  end
+  
+  def cap_me
+    puts "#{Time.now - @start}"
+    sleep 0.001
+  end
+  
+  rate_limit :limit_me, 6, 6
+  rate_limit :cap_me, 6, 6, GluttonRatelimit::BurstyTokenBucket
+end
+
+t = LimitInstanceMethods.new
+
+puts "Six requests every 6 seconds (Averaged): "
+13.times { t.limit_me }
+puts "Six requests every 6 seconds (Bursty): "
+13.times { t.cap_me }
+
+# In both cases:
+# The 7th execution should occur after 6 seconds after the first.
 # The 13th execution should occur after 12 seconds after the first.

data/examples/simple_manual.rb

@@ -1,32 +1,32 @@
-# $LOAD_PATH << File.dirname(__FILE__) +'/../lib'
-require 'rubygems'
-require 'glutton_ratelimit'
-
-puts "Maximum of 12 executions every 5 seconds (Bursty):"
-rl = GluttonRatelimit::BurstyTokenBucket.new 12, 5
-
-start = Time.now
-n = 0
-
-rl.times(25) do
-  puts "#{n += 1} - #{Time.now - start}"
-  # Simulating a constant-time task:
-  sleep 0.1
-end
-
-# The 25th execution should occur after 10 seconds has elapsed.
-
-puts "Maximum of 3 executions every 3 seconds (Averaged):"
-rl = GluttonRatelimit::AveragedThrottle.new 3, 3
-# AverageThrottle will attempt to evenly space executions within the allowed period.
-
-start = Time.now
-n = 0
-
-rl.times(7) do 
-  puts "#{n += 1} - #{Time.now - start}"
-  # Simulating a 0 to 1 second random-time task:
-  sleep rand
-end
-
+# $LOAD_PATH << File.dirname(__FILE__) +'/../lib'
+require 'rubygems'
+require 'glutton_ratelimit'
+
+puts "Maximum of 12 executions every 5 seconds (Bursty):"
+rl = GluttonRatelimit::BurstyTokenBucket.new 12, 5
+
+start = Time.now
+n = 0
+
+rl.times(25) do
+  puts "#{n += 1} - #{Time.now - start}"
+  # Simulating a constant-time task:
+  sleep 0.1
+end
+
+# The 25th execution should occur after 10 seconds has elapsed.
+
+puts "Maximum of 3 executions every 3 seconds (Averaged):"
+rl = GluttonRatelimit::AveragedThrottle.new 3, 3
+# AverageThrottle will attempt to evenly space executions within the allowed period.
+
+start = Time.now
+n = 0
+
+rl.times(7) do 
+  puts "#{n += 1} - #{Time.now - start}"
+  # Simulating a 0 to 1 second random-time task:
+  sleep rand
+end
+
 # The 7th execution should occur after 6 seconds has elapsed.

data/glutton_ratelimit.gemspec

@@ -1,64 +1,64 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
-# -*- encoding: utf-8 -*-
-
-Gem::Specification.new do |s|
-  s.name = %q{glutton_ratelimit}
-  s.version = "0.1.0"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Wally Glutton"]
-  s.date = %q{2010-06-10}
-  s.description = %q{A Ruby library for limiting the number of times a method can be invoked within a specified time period.}
-  s.email = %q{stungeye@gmail.com}
-  s.extra_rdoc_files = [
-    "LICENSE",
-     "README.rdoc"
-  ]
-  s.files = [
-    ".document",
-     ".gitignore",
-     "LICENSE",
-     "README.rdoc",
-     "Rakefile",
-     "VERSION",
-     "examples/limit_instance_methods.rb",
-     "examples/simple_manual.rb",
-     "glutton_ratelimit.gemspec",
-     "lib/glutton_ratelimit.rb",
-     "lib/glutton_ratelimit/averaged_throttle.rb",
-     "lib/glutton_ratelimit/bursty_ring_buffer.rb",
-     "lib/glutton_ratelimit/bursty_token_bucket.rb",
-     "test/helper.rb",
-     "test/test_glutton_ratelimit_averaged_throttle.rb",
-     "test/test_glutton_ratelimit_bursty_ring_buffer.rb",
-     "test/test_glutton_ratelimit_bursty_token_bucket.rb",
-     "test/testing_module.rb"
-  ]
-  s.homepage = %q{http://github.com/stungeye/glutton_ratelimit}
-  s.rdoc_options = ["--charset=UTF-8"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.6}
-  s.summary = %q{Simple Ruby library for self-imposed rater-limiting.}
-  s.test_files = [
-    "test/test_glutton_ratelimit_averaged_throttle.rb",
-     "test/helper.rb",
-     "test/test_glutton_ratelimit_bursty_ring_buffer.rb",
-     "test/testing_module.rb",
-     "test/test_glutton_ratelimit_bursty_token_bucket.rb",
-     "examples/limit_instance_methods.rb",
-     "examples/simple_manual.rb"
-  ]
-
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-    else
-    end
-  else
-  end
-end
-
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: glutton_ratelimit 1.0.0 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "glutton_ratelimit".freeze
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib".freeze]
+  s.authors = ["Wally Glutton".freeze]
+  s.date = "2019-12-19"
+  s.description = "A Ruby library for limiting the number of times a method can be invoked within a specified time period.".freeze
+  s.email = "stungeye@gmail.com".freeze
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".github/workflows/ruby.yml",
+    ".ruby-version",
+    ".travis.yml",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "examples/limit_instance_methods.rb",
+    "examples/simple_manual.rb",
+    "glutton_ratelimit.gemspec",
+    "lib/glutton_ratelimit.rb",
+    "lib/glutton_ratelimit/averaged_throttle.rb",
+    "lib/glutton_ratelimit/bursty_ring_buffer.rb",
+    "lib/glutton_ratelimit/bursty_token_bucket.rb",
+    "test/helper.rb",
+    "test/test_glutton_ratelimit_averaged_throttle.rb",
+    "test/test_glutton_ratelimit_bursty_ring_buffer.rb",
+    "test/test_glutton_ratelimit_bursty_token_bucket.rb",
+    "test/testing_module.rb"
+  ]
+  s.homepage = "http://github.com/stungeye/glutton_ratelimit".freeze
+  s.rubygems_version = "2.7.6.2".freeze
+  s.summary = "Simple Ruby library for self-imposed rater-limiting.".freeze
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<jeweler>.freeze, [">= 0"])
+      s.add_runtime_dependency(%q<test-unit>.freeze, [">= 0"])
+    else
+      s.add_dependency(%q<jeweler>.freeze, [">= 0"])
+      s.add_dependency(%q<test-unit>.freeze, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<jeweler>.freeze, [">= 0"])
+    s.add_dependency(%q<test-unit>.freeze, [">= 0"])
+  end
+end
+

data/lib/glutton_ratelimit.rb

@@ -1,38 +1,39 @@
-module GluttonRatelimit
-  
-  def rate_limit symbol, executions, time_period, rl_class = AveragedThrottle
-    rl = rl_class.new executions, time_period
-    old_symbol = "#{symbol}_old".to_sym
-    alias_method old_symbol, symbol
-    define_method symbol do |*args|
-      rl.wait
-      self.send old_symbol, *args
-    end
-  end
-  
-  private
-  # All the other classes extend this parent and are therefore
-  # constructed in the same manner.
-  class ParentLimiter
-    attr_reader :executions
-    
-    def initialize executions, time_period
-      @executions = executions
-      @time_period = time_period
-    end
-    
-    def times(num, &block)
-      raise ArgumentError, "Code block expected"  if not block
-      raise ArgumentError, "Parameter expected to be Fixnum but found a #{num.class}."  unless num.class.equal?(Fixnum)
-      num.times do
-        wait
-        yield
-      end
-    end
-  end
-end
-
-dir = File.expand_path(File.dirname(__FILE__))
-require File.join(dir, "glutton_ratelimit", "bursty_ring_buffer")
-require File.join(dir, "glutton_ratelimit", "bursty_token_bucket")
-require File.join(dir, "glutton_ratelimit", "averaged_throttle")
+module GluttonRatelimit
+
+  def rate_limit symbol, executions, time_period, rl_class = AveragedThrottle
+    rl = rl_class.new executions, time_period
+    old_symbol = "#{symbol}_old".to_sym
+    alias_method old_symbol, symbol
+    define_method symbol do |*args|
+      rl.wait
+      self.send old_symbol, *args
+    end
+  end
+
+  private
+  # All the other classes extend this parent and are therefore
+  # constructed in the same manner.
+  class ParentLimiter
+    attr_reader :executions
+
+    def initialize executions, time_period
+      @executions = executions
+      @time_period = time_period
+    end
+
+    def times(num, &block)
+      raise ArgumentError, "Code block expected"  if not block
+
+      raise ArgumentError, "Parameter expected to be #{Integer.to_s} but found a #{num.class}."  unless num.kind_of?(Integer)
+      num.times do
+        wait
+        yield
+      end
+    end
+  end
+end
+
+dir = File.expand_path(File.dirname(__FILE__))
+require File.join(dir, "glutton_ratelimit", "bursty_ring_buffer")
+require File.join(dir, "glutton_ratelimit", "bursty_token_bucket")
+require File.join(dir, "glutton_ratelimit", "averaged_throttle")

data/lib/glutton_ratelimit/averaged_throttle.rb

@@ -1,44 +1,45 @@
-module GluttonRatelimit
-  
-  class AveragedThrottle < ParentLimiter
-    
-    def reset_bucket
-      @before_previous_execution = Time.now if @before_previous_execution.nil?
-      @oldest_timestamp = Time.now
-      @tokens = @executions
-      @total_task_time = 0
-    end
-    
-    def executed_this_period
-      @executions - @tokens
-    end
-    
-    def average_task_time
-      @total_task_time.to_f / executed_this_period
-    end
-    
-    def wait
-      reset_bucket if @tokens.nil?
-      
-      now = Time.now
-      delta_since_previous = now - @before_previous_execution
-      @total_task_time += delta_since_previous
-      remaining_time = @time_period - (now - @oldest_timestamp)
-      
-      if @tokens.zero?
-        sleep(remaining_time) if remaining_time > 0
-        reset_bucket
-      elsif executed_this_period != 0
-        throttle = (remaining_time.to_f + delta_since_previous) / (@tokens+1) - average_task_time
-        sleep throttle if throttle > 0
-      end
-      
-      @tokens -= 1
-      @before_previous_execution = Time.now
-    end
-    
-  end
-
-end
-
-
+module GluttonRatelimit
+  class AveragedThrottle < ParentLimiter
+    def initialize executions, time_period
+      super(executions, time_period)
+      @tokens = nil
+    end
+    
+    def reset_bucket
+      @before_previous_execution ||= Time.now 
+      @oldest_timestamp = Time.now
+      @tokens = @executions
+      @total_task_time = 0
+    end
+    
+    def executed_this_period
+      @executions - @tokens
+    end
+    
+    def average_task_time
+      @total_task_time.to_f / executed_this_period
+    end
+    
+    def wait
+      reset_bucket if @tokens.nil?
+
+      now = Time.now
+      delta_since_previous = now - @before_previous_execution
+      @total_task_time += delta_since_previous
+      remaining_time = @time_period - (now - @oldest_timestamp)
+      
+      if @tokens.zero?
+        sleep(remaining_time) if remaining_time > 0
+        reset_bucket
+      elsif executed_this_period != 0
+        throttle = (remaining_time.to_f + delta_since_previous) / (@tokens+1) - average_task_time
+        sleep throttle if throttle > 0
+      end
+      
+      @tokens -= 1
+      @before_previous_execution = Time.now
+    end
+  end
+end
+
+