philiprehberger-token_bucket 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e7ddac1684bf5df901153bdedaf854e3ab75dfa81fb6ca0fd84d409f7fbc204c
+  data.tar.gz: d33d3308029a9e87045698e7e1e1086feafa92dfccb12149c42c6448e35a4206
+SHA512:
+  metadata.gz: 12ef0e320932d5a9f1922f2ec522844be24dffb6e79e885b4906917cfdabb32e50a06cf60d40c2a6ec3edcac8f284975106a77881cdf71857ed106ceac875dde
+  data.tar.gz: 90ccdc8daa02d3ec0200dc66146629f7e73a85c7e1e355259da864aec904abe1337484c90aeac8a9c5e1670c86b705f66fed00c834803371feaf3fa7d84033e8

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Changelog
+
+All notable changes to this gem will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] - 2026-03-22
+
+### Added
+- Initial release
+- Token bucket rate limiter with configurable capacity and refill rate
+- Blocking take and non-blocking try_take methods
+- Available token count and wait time estimation
+- Thread-safe implementation with Mutex

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 philiprehberger
+
+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,81 @@
+# philiprehberger-token_bucket
+
+[![Tests](https://github.com/philiprehberger/rb-token-bucket/actions/workflows/ci.yml/badge.svg)](https://github.com/philiprehberger/rb-token-bucket/actions/workflows/ci.yml)
+[![Gem Version](https://badge.fury.io/rb/philiprehberger-token_bucket.svg)](https://rubygems.org/gems/philiprehberger-token_bucket)
+[![License](https://img.shields.io/github/license/philiprehberger/rb-token-bucket)](LICENSE)
+
+Token bucket rate limiter with configurable capacity and refill rate
+
+## Requirements
+
+- Ruby >= 3.1
+
+## Installation
+
+Add to your Gemfile:
+
+```ruby
+gem 'philiprehberger-token_bucket'
+```
+
+Or install directly:
+
+```bash
+gem install philiprehberger-token_bucket
+```
+
+## Usage
+
+```ruby
+require 'philiprehberger/token_bucket'
+
+bucket = Philiprehberger::TokenBucket::Bucket.new(capacity: 10, refill_rate: 5)
+```
+
+### Blocking Take
+
+```ruby
+bucket.take(3)    # blocks until 3 tokens are available, then consumes them
+bucket.take       # takes 1 token by default
+```
+
+### Non-blocking Take
+
+```ruby
+if bucket.try_take(2)
+  # tokens acquired, proceed
+else
+  # not enough tokens, try again later
+end
+```
+
+### Checking Availability
+
+```ruby
+bucket.available   # => current number of tokens (Float)
+bucket.wait_time(5) # => seconds until 5 tokens will be available
+```
+
+## API
+
+### `Philiprehberger::TokenBucket::Bucket`
+
+| Method | Description |
+|--------|-------------|
+| `.new(capacity:, refill_rate:)` | Create a bucket with max tokens and tokens-per-second refill |
+| `#take(n = 1)` | Block until n tokens are available, then consume them |
+| `#try_take(n = 1)` | Consume n tokens if available, return true/false |
+| `#available` | Return the current number of available tokens |
+| `#wait_time(n = 1)` | Estimate seconds until n tokens will be available |
+
+## Development
+
+```bash
+bundle install
+bundle exec rspec
+bundle exec rubocop
+```
+
+## License
+
+MIT

data/lib/philiprehberger/token_bucket/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Philiprehberger
+  module TokenBucket
+    VERSION = '0.1.0'
+  end
+end

data/lib/philiprehberger/token_bucket.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+require_relative 'token_bucket/version'
+
+module Philiprehberger
+  module TokenBucket
+    class Error < StandardError; end
+
+    # A thread-safe token bucket rate limiter
+    class Bucket
+      # @param capacity [Numeric] maximum number of tokens
+      # @param refill_rate [Numeric] tokens added per second
+      def initialize(capacity:, refill_rate:)
+        raise Error, 'capacity must be positive' unless capacity.positive?
+        raise Error, 'refill_rate must be positive' unless refill_rate.positive?
+
+        @capacity = capacity.to_f
+        @refill_rate = refill_rate.to_f
+        @tokens = @capacity
+        @last_refill = now
+        @mutex = Mutex.new
+      end
+
+      # Take n tokens, blocking until they are available
+      #
+      # @param n [Numeric] number of tokens to take
+      # @return [void]
+      # @raise [Error] if n exceeds capacity
+      def take(n = 1)
+        raise Error, "cannot take #{n} tokens from bucket with capacity #{@capacity}" if n > @capacity
+
+        loop do
+          wait = nil
+          @mutex.synchronize do
+            refill
+            if @tokens >= n
+              @tokens -= n
+              return
+            end
+            wait = compute_wait_time(n)
+          end
+          sleep(wait)
+        end
+      end
+
+      # Try to take n tokens without blocking
+      #
+      # @param n [Numeric] number of tokens to take
+      # @return [Boolean] true if tokens were taken, false otherwise
+      def try_take(n = 1)
+        @mutex.synchronize do
+          refill
+          if @tokens >= n
+            @tokens -= n
+            true
+          else
+            false
+          end
+        end
+      end
+
+      # Return the number of currently available tokens
+      #
+      # @return [Float] available tokens
+      def available
+        @mutex.synchronize do
+          refill
+          @tokens
+        end
+      end
+
+      # Calculate how long to wait for n tokens to become available
+      #
+      # @param n [Numeric] number of tokens needed
+      # @return [Float] seconds to wait (0.0 if tokens are already available)
+      def wait_time(n = 1)
+        @mutex.synchronize do
+          refill
+          compute_wait_time(n)
+        end
+      end
+
+      private
+
+      def compute_wait_time(n)
+        deficit = n - @tokens
+        return 0.0 if deficit <= 0
+
+        deficit / @refill_rate
+      end
+
+      def refill
+        current = now
+        elapsed = current - @last_refill
+        @tokens = [@tokens + elapsed * @refill_rate, @capacity].min
+        @last_refill = current
+      end
+
+      def now
+        Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: philiprehberger-token_bucket
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Philip Rehberger
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-03-22 00:00:00.000000000 Z
+dependencies: []
+description: Thread-safe token bucket rate limiter with configurable capacity and
+  refill rate, supporting blocking and non-blocking token acquisition.
+email:
+- me@philiprehberger.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/philiprehberger/token_bucket.rb
+- lib/philiprehberger/token_bucket/version.rb
+homepage: https://github.com/philiprehberger/rb-token-bucket
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/philiprehberger/rb-token-bucket
+  source_code_uri: https://github.com/philiprehberger/rb-token-bucket
+  changelog_uri: https://github.com/philiprehberger/rb-token-bucket/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/philiprehberger/rb-token-bucket/issues
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: Token bucket rate limiter with configurable capacity and refill rate
+test_files: []