rate_limit-htb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 130ddde0f1a336c53bab0089fb2d0355a7f38f16
+  data.tar.gz: ce908f450073260e47d55e377dbfe2b76960bc79
+SHA512:
+  metadata.gz: 0024efa388d90fd228c308d4bb61251e76d4c26385d7cf741de53991fd3cbd7d4b0982a798d7fd191662412196c4b3ba92378cb6cd05a8504034dc9648acdccc
+  data.tar.gz: c6661bfc9b20e2f0368633e090609020904a43516b7553e344aa3187ea7b70401dc73c1e3e83f70cdafc5e6b1aac40b5efec548dd92e269afe345a3213e106bb

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.idea
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.2
+before_install: gem install bundler -v 1.16.0

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in rate_limit-htb.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    rate_limit-htb (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  rate_limit-htb!
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Dominic Althaus
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,63 @@
+# RateLimit::Htb
+
+This is a Ruby implementation of the hierarchical Token bucket algorithm. It allows you to limit
+the rate certain operations are executed. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rate_limit-htb'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rate_limit-htb
+
+## Usage
+
+```ruby
+root = RateLimit::Htb::Bucket.new 1000
+child1 = RateLimit::Htb::Bucket.new 300, root
+child2 = RateLimit::Htb::Bucket.new 600, root
+
+threads = []
+
+# prints stuff twice as fast as the other two
+threads << Thread.new do
+  100.times do
+    child1.blocking_take 200
+    puts "stuff"
+  end
+end
+
+threads << Thread.new do
+  100.times do
+    child2.blocking_take 400
+    puts "stuff2"
+  end
+end
+
+# Is called rarely because the other thread needs all the tokens.
+threads << Thread.new do
+  100.times do
+    child2.blocking_take 400
+    puts "stuff3"
+  end
+end
+
+threads.each { |t| t.join }
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/HappyKadaver/rate_limit-htb.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rate_limit/htb"
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rate_limit/htb/version.rb

@@ -0,0 +1,5 @@
+module RateLimit
+  module Htb
+    VERSION = "0.1.0"
+  end
+end

data/lib/rate_limit/htb.rb

@@ -0,0 +1,128 @@
+require "rate_limit/htb/version"
+
+module RateLimit
+  # Htb is a ruby implementation of the hierarchical token bucket algorithm.
+  #
+  # It allows you to do rate limiting in a hierarchical fashion in other words you can put a large rate at the root of
+  # and smaller rates as children. This way you can guarantee your children a minimum rate and a maximum rate up to the
+  # rate of the parents. The rate is represented by Tokens you take out of buckets.
+  #
+  # The sum of the rates of the children on the same level may not be greater than the rate of their parent or they will
+  # exceed the the rate of their parent.
+  #
+  # =Example
+  #   root = RateLimit::Htb::Bucket.new 1000
+  #   child1 = RateLimit::Htb::Bucket.new 300, root
+  #   child2 = RateLimit::Htb::Bucket.new 600, root
+  #
+  #   threads = []
+  #
+  #   # prints stuff twice as fast as the other two
+  #   threads << Thread.new do
+  #     100.times do
+  #       child1.blocking_take 200
+  #       puts "stuff"
+  #     end
+  #   end
+  #
+  #   threads << Thread.new do
+  #     100.times do
+  #       child2.blocking_take 400
+  #       puts "stuff2"
+  #     end
+  #   end
+  #
+  #   # Is called rarely because the other thread needs all the tokens.
+  #   threads << Thread.new do
+  #     100.times do
+  #       child2.blocking_take 400
+  #       puts "stuff3"
+  #     end
+  #   end
+  #
+  #   threads.each { |t| t.join }
+  module Htb
+    class Bucket
+
+      # ==== Attributes
+      #
+      # * +rate+ - Amount of tokens generated every second.
+      # * +parent+ - Parent of this bucket. Any tokens taken from this bucket will also be taken from parent. When a
+      #   parent is specified the rate of this bucket will be between the rate of this bucket and the rate of the parent.
+      #   The parent bucket should have a larger rate than their children.
+      #
+      def initialize(rate, parent = nil)
+        @lock = Monitor.new
+        @rate = rate
+        @bucket_size = rate
+        @parent = parent
+        @tokens = rate
+        @last_update_timestamp = Time.now
+      end
+
+      # Take the specified amount of tokens from this bucket
+      #
+      # If you want your code to block execution until it could take the specified amount of tokens use #blocking_take
+      # instead.
+      #
+      # * *Returns* :
+      #   - true if the amount of tokens could be taken from this bucket or a parent.
+      def take(amount)
+        @lock.synchronize do
+          replenish
+
+          could_take = can_take? amount
+          account amount if could_take
+
+          could_take
+        end
+      end
+
+
+      # This method takes the specified amount of tokens from the bucket and blocks execution until it was successful.
+      #
+      # This method tries to be smart about the amount of time it waits. It will wait the minimum time it takes to
+      # replenish enough tokens.
+      def blocking_take(amount)
+        # Try to take amount tokens from this bucket or wait for the tokens to replenish
+        # do this until we could get the amount of tokens we wanted
+        until take amount
+          duration = amount.to_f / @rate
+          puts "sleeping for #{duration}"
+          sleep duration
+        end
+      end
+
+      protected
+
+      def replenish(timestamp = Time.now)
+        @lock.synchronize do
+          @parent.replenish timestamp if @parent
+
+          elapsed = timestamp - @last_update_timestamp
+          @tokens = [@bucket_size, @tokens + @rate * elapsed].min
+
+          @last_update_timestamp = timestamp
+        end
+      end
+
+      def can_take?(amount)
+        @tokens >= amount || (@parent && @parent.can_take?(amount))
+      end
+
+      def account(amount)
+        @lock.synchronize do
+          @tokens = @tokens - amount
+          @parent.account amount if @parent
+        end
+      end
+
+      def rate
+        return @rate if @rate != 0
+        return @parent.rate if @parent
+
+        raise 'NO Bucket in this hierachie has a Limit other than zero!!'
+      end
+    end
+  end
+end

data/rate_limit-htb.gemspec

@@ -0,0 +1,27 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "rate_limit/htb/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rate_limit-htb"
+  spec.version       = RateLimit::Htb::VERSION
+  spec.authors       = ["Dominic Althaus"]
+  spec.email         = ["althaus.dominic@gmail.com"]
+
+  spec.summary       = %q{A ruby implementation of the hierarchical token bucket algorithm.}
+  spec.description   = %q{A ruby implementation of the hierarchical token bucket algorithm. It allows you to define rates on different levels of a hierachie to limit the speed of certain operations.}
+  spec.homepage      = "https://github.com/HappyKadaver/rate_limit-htb"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: rate_limit-htb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dominic Althaus
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-06-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A ruby implementation of the hierarchical token bucket algorithm. It
+  allows you to define rates on different levels of a hierachie to limit the speed
+  of certain operations.
+email:
+- althaus.dominic@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rate_limit/htb.rb
+- lib/rate_limit/htb/version.rb
+- rate_limit-htb.gemspec
+homepage: https://github.com/HappyKadaver/rate_limit-htb
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: A ruby implementation of the hierarchical token bucket algorithm.
+test_files: []