r4r 0.1.0

data/lib/r4r/token_bucket.rb

@@ -0,0 +1,129 @@
+module R4r
+  # A token bucket is used to control the relative rates of two
+  # processes: one fills the bucket, another empties it.
+  #
+  # A Ruby port of the finagle's TokenBucket.
+  #
+  # @abstract
+  # @see https://github.com/twitter/util/blob/master/util-core/src/main/scala/com/twitter/util/TokenBucket.scala
+  class TokenBucket
+    # Put `n` tokens into the bucket.
+    #
+    # @param [Fixnum] n the number of tokens to remove from the bucket.
+    #   Must be >= 0.
+    def put(n)
+      raise NotImplementedError
+    end
+
+    # Try to get `n` tokens out of the bucket.
+    #
+    # @param [Fixnum] n the number of tokens to remove from the bucket.
+    #   Must be >= 0.
+    # @return [Boolean] true if successful
+    def try_get(n)
+      raise NotImplementedError
+    end
+
+    # The number of tokens currently in the bucket.
+    def count
+      raise NotImplementedError
+    end
+  end
+
+  # A token bucket that doesn't exceed a given bound.
+  #
+  # This is threadsafe, and does not require further synchronization.
+  # The token bucket starts empty.
+  class BoundedTokenBucket < TokenBucket
+
+    # Creates a new {R4r::BoundedTokenBucket}.
+    #
+    # @param [Fixnum] limit the upper bound on the number of tokens in the bucket.
+    # @raise [ArgumentError] if limit isn't positive
+    def initialize(limit:)
+      raise ArgumentError, "limit must be positive, got #{limit}" if limit.to_i <= 0
+
+      @limit = limit.to_i
+      @counter = 0
+    end
+
+    # Put `n` tokens into the bucket.
+    #
+    # If putting in `n` tokens would overflow `limit` tokens, instead sets the
+    # number of tokens to be `limit`.
+    #
+    # @raise [ArgumentError] is n isn't positive
+    def put(n)
+      n = n.to_i
+      raise ArgumentError, "number of tokens must be positive" if n <= 0
+
+      @counter = [@counter + n, @limit].min
+    end
+
+    # @see R4r::TokenBucket#try_get
+    def try_get(n)
+      n = n.to_i
+      raise ArgumentError, "number of tokens must be positive" if n <= 0
+
+      ok = @counter >= n
+
+      if ok
+        @counter -= n
+      end
+
+      ok
+    end
+
+    # @see R4r::TokenBucket#count
+    def count
+      @counter
+    end
+  end
+
+  # A leaky bucket expires tokens after approximately `ttl` time.
+  # Thus, a bucket left alone will empty itself.
+  class LeakyTokenBucket < TokenBucket
+
+    # Creates a new [R4r::LeakyTokenBucket]
+    #
+    # @param [Fixnum] ttl_ms the (approximate) time in milliseconds after which a token will
+    #   expire.
+    # @param [Fixnum] reserve the number of reserve tokens over the TTL
+    #   period. That is, every `ttl` has `reserve` tokens in addition to
+    #   the ones added to the bucket.
+    # @param [R4r::Clock] clock the current time
+    def initialize(ttl_ms:, reserve:, clock: nil)
+      @ttl_ms = ttl_ms.to_i
+      @reserve = reserve.to_i
+      @clock = (clock || R4r.clock)
+      @window = R4r::WindowedAdder.new(range_ms: ttl_ms, slices: 10, clock: @clock)
+    end
+
+    # @see R4r::TokenBucket#put
+    def put(n)
+      n = n.to_i
+      raise ArgumentError, "n cannot be nagative" unless n >= 0
+
+      @window.add(n)
+    end
+
+    # @see R4r::TokenBucket#try_get
+    def try_get(n)
+      n = n.to_i
+      raise ArgumentError, "n cannot be nagative" unless n >= 0
+
+      ok = count >= n
+      if ok
+        @window.add(n * -1)
+      end
+
+      ok
+    end
+
+    # @see R4r::TokenBucket#count
+    def count
+      @window.sum + @reserve
+    end
+
+  end
+end

data/lib/r4r/version.rb

@@ -0,0 +1,3 @@
+module R4r
+  VERSION = "0.1.0"
+end

data/lib/r4r/windowed_adder.rb

@@ -0,0 +1,106 @@
+# require 'concurrent/thread_safe/util/adder'
+# require 'concurrent/atomic/atomic_fixnum'
+
+module R4r
+
+  # A Ruby port of the finagle's WindowedAdder.
+  #
+  # @see https://github.com/twitter/util/blob/master/util-core/src/main/scala/com/twitter/util/WindowedAdder.scala
+  # @see https://github.com/ruby-concurrency/concurrent-ruby/blob/master/lib/concurrent/thread_safe/util/adder.rb
+  class WindowedAdder
+
+    # Creates a time-windowed version of a {Concurrent::ThreadSafe::Util::Adder].
+    #
+    # @param [Fixnum] range_ms the range of time in millisecods to be kept in the adder.
+    # @param [Fixnum] slices the number of slices that are maintained; a higher
+    #   number of slices means finer granularity but also more memory
+    #   consumption. Must be more than 1.
+    # @param [R4r::Clock] clock the current time. for testing.
+    #
+    # @raise [ArgumentError] if slices is less then 1
+    # @raise [ArgumentError] if range is nil
+    # @raise [ArgumentError] if slices is nil
+    def initialize(range_ms:, slices:, clock: nil)
+      raise ArgumentError, "range_ms cannot be nil" if range_ms.nil?
+      raise ArgumentError, "slices cannot be nil" if slices.nil?
+      raise ArgumentError, "slices must be positive" if slices.to_i <= 1
+
+      @window = range_ms.to_i / slices.to_i
+      @slices = slices.to_i - 1
+      @writer = 0 #::Concurrent::ThreadSafe::Util::Adder.new
+      @gen = 0
+      @expired_gen = 0 #::Concurrent::AtomicFixnum.new(@gen)
+      @buf = Array.new(@slices) { 0 }
+      @index = 0
+      @now = (clock || R4r.clock)
+      @old = @now.call
+    end
+
+    # Reset the state of the adder.
+    def reset
+      @buf.fill(0, @slices) { 0 }
+      @writer = 0
+      @old = @now.call
+    end
+
+    # Increment the adder by 1
+    def incr
+      add(1)
+    end
+
+    # Increment the adder by `x`
+    def add(x)
+      expired if (@now.call - @old) >= @window
+
+      @writer += x
+    end
+
+    # Retrieve the current sum of the adder
+    #
+    # @return [Fixnum]
+    def sum
+      expired if (@now.call - @old) >= @window
+
+      value = @writer
+      i = 0
+      while i < @slices
+        value += @buf[i]
+        i += 1
+      end
+
+      value
+    end
+
+    private
+
+    def expired
+      # return unless @expired_gen.compare_and_set(@gen, @gen + 1)
+
+      # At the time of add, we were likely up to date,
+      # so we credit it to the current slice.
+      @buf[@index] = sum_and_reset
+      @index = (@index + 1) % @slices
+
+      # If it turns out we've skipped a number of
+      # slices, we adjust for that here.
+      nskip = [((@now.call - @old) / @window) - 1, @slices].min
+
+      if nskip > 0
+        r = [nskip, @slices - @index].min
+        @buf.fill(@index, r) { 0 }
+        @buf.fill(0, nskip - r) { 0 }
+        @index = (@index + nskip) % @slices
+      end
+
+      @old = @now.call
+      @gen += 1
+    end
+
+    def sum_and_reset
+      sum = @writer
+      @writer = 0
+      sum
+    end
+
+  end
+end

data/r4r.gemspec

@@ -0,0 +1,43 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "r4r/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "r4r"
+  spec.version       = R4r::VERSION
+  spec.authors       = ["Dmitry Galinsky"]
+  spec.email         = ["dima.exe@gmail.com"]
+
+  spec.summary       = %q{Write a short summary, because Rubygems requires one.}
+  spec.description   = %q{Write a longer description or delete this line.}
+  spec.homepage      = "https://github.com"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  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)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.extensions = Dir.glob("ext/r4r/*/extconf.rb")
+
+  # spec.add_dependency "concurrent-ruby", "~> 1.0"
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 11.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "minitest-reporters", "~> 1.1"
+  spec.add_development_dependency "rake-compiler", "~> 1.0"
+  spec.add_development_dependency "minitest-ci", "~> 3.3"
+  spec.add_development_dependency "yard", "~> 0.9"
+end

metadata

@@ -0,0 +1,170 @@
+--- !ruby/object:Gem::Specification
+name: r4r
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dmitry Galinsky
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-03-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.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-ci
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: Write a longer description or delete this line.
+email:
+- dima.exe@gmail.com
+executables: []
+extensions:
+- ext/r4r/ring_bits_ext/extconf.rb
+- ext/r4r/system_clock_ext/extconf.rb
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/ghpages
+- bin/rake
+- bin/setup
+- ext/r4r/ring_bits_ext/extconf.rb
+- ext/r4r/ring_bits_ext/ring_bits_ext.c
+- ext/r4r/system_clock_ext/extconf.rb
+- ext/r4r/system_clock_ext/system_clock_ext.c
+- lib/r4r.rb
+- lib/r4r/clock.rb
+- lib/r4r/retry.rb
+- lib/r4r/retry_budget.rb
+- lib/r4r/retry_policy.rb
+- lib/r4r/ring_bits.rb
+- lib/r4r/token_bucket.rb
+- lib/r4r/version.rb
+- lib/r4r/windowed_adder.rb
+- r4r.gemspec
+homepage: https://github.com
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.4.5.3
+signing_key: 
+specification_version: 4
+summary: Write a short summary, because Rubygems requires one.
+test_files: []