bozos_buckets 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0d3bb1c894e1ca2de1e7af0ddd3caa4f811714b26d3d4c2167d29f244912c0d8
+  data.tar.gz: ea3fb4defd1bafe75f0f19027d731f20864ff677856bab6bee24f5f12a3a6b33
+SHA512:
+  metadata.gz: 3094d1293de5d27a9400d2dabe1c040f0d897f61d1f7e2920590e00e117f7d305e640f85f87bb318b1b4da9a925a5f8748ae390b2db506dc36d119f1e31ab685
+  data.tar.gz: 03d6d2bf6e953233c5e71ce2d433138333ce9c78253afdf53020b4eb4e75a12a687b394be49c339d152e1bda20d852e881a51fd7483c3a50bc7d5a850a855d4a

data/lib/bozos_buckets/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+# Top level module for BozosBuckets
+module BozosBuckets
+  # Version constant
+  VERSION = '0.0.1'
+end

data/lib/bozos_buckets.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require_relative './bozos_buckets/version'
+
+module BozosBuckets
+
+  # Class representing a token bucket
+  class Bucket
+    attr_reader :current_token_count, :refill_rate, :max_token_count, :last_refilled
+
+    # Constructs a Bucket instance
+    #
+    # @param initial_token_count [Integer] the number of tokens the bucket
+    #   starts with
+    # @param refill_rate [Double] How many tokens per second should be added to
+    #   the bucket. For example, 1 would be 1 token per second. 0.1 would be one
+    #   token per 10 seconds
+    # @param max_token_count [Integer] the maximum number of tokens the bucket
+    #   can hold. Defaults to the initial_token_count if not provided
+    # @return An instance of BozosBucket
+    def initialize(initial_token_count: 100, refill_rate: 1, max_token_count: 100)
+      @current_token_count = initial_token_count
+      @refill_rate = refill_rate
+      @max_token_count = max_token_count || initial_token_count
+      reset_last_refilled
+    end
+
+    # Attempt to use tokens from the bucket. If there are sufficient 
+    # tokens, @current_token_count is decremented by the `count` and method
+    # returns `true`. If there are not sufficient tokens, method returns
+    # false without changing the @current_token_count
+    #
+    # @param count [Integer] Number of tokens that should be used
+    # @return [Boolean] Whether there were sufficient tokens when called
+    def use_tokens(count: 1)
+      refill_bucket
+
+      if (@current_token_count - count) >= 0
+        @current_token_count -= count
+        return true
+      else
+        return false
+      end
+    end
+
+    # Determines how many seconds have passed since the last time the bucket
+    # was used, calculates how many tokens should be added to the bucket, and
+    # adds them by updating @current_token_count
+    #
+    # @return [Integer] the current_token_count after refilling the bucket
+    def refill_bucket
+      elapsed_seconds = Time.now.to_i - last_refilled
+      tokens_to_add = (elapsed_seconds * refill_rate).floor
+
+      reset_last_refilled
+
+      @current_token_count = [@current_token_count + tokens_to_add, max_token_count].min
+    end
+
+    private
+
+    # Resets the last_refilled timestamp to the current time. Called by 
+    # {#refill_bucket} after calculating elapsed time
+    #
+    # @return [Integer] last used timestamp in Unix epoch format. Should
+    #   always be the current time
+    def reset_last_refilled
+      @last_refilled = Time.now.to_i
+    end
+  end
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: bozos_buckets
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Alex Glover
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-09-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |2
+      A low overhead implementation of a token bucket for rate limiting.
+      Does not use an array or linked list, and therefore has a tiny memory footprint
+email: alexdglover@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/bozos_buckets.rb
+- lib/bozos_buckets/version.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: A low overhead implementation of a token bucket
+test_files: []