philiprehberger-rate_limiter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6a165ad8eaaff27921b80e53c761406c60f83f28ab2d985e720f284660eb9da7
+  data.tar.gz: 80ff04b248a0913de8d288c0426e3f37f8cf98442e3d4cbc2012e5b313838c53
+SHA512:
+  metadata.gz: d59438c4d038a1a3ceec480e1d19596014ef291971531df1dbf97b2335f285ba95c0a959cc047aa3f4ff6c5a45f38ad5648d0813367f1bc7b6f5aa1a283b30dc
+  data.tar.gz: 9728caa5a94a01a6df61c2ed0fffe37a53010d51481e281b592b8d06dbf73f267deae0bc69001643126effad1163cf2669a5da0223289c8033f012143d556439

data/CHANGELOG.md

@@ -0,0 +1,21 @@
+# 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-10
+
+### Added
+- Initial release
+- Sliding window rate limiting with per-key tracking
+- Token bucket rate limiting with automatic refill
+- Thread-safe operations with Mutex
+- `allow?` to check and consume in one call
+- `peek` to check without consuming
+- `remaining` to query available quota
+- `reset` to clear state for a key
+- Convenience factory methods on the module

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,100 @@
+# philiprehberger-rate_limiter
+
+[![Tests](https://github.com/philiprehberger/rb-rate-limiter/actions/workflows/ci.yml/badge.svg)](https://github.com/philiprehberger/rb-rate-limiter/actions/workflows/ci.yml)
+[![Gem Version](https://badge.fury.io/rb/philiprehberger-rate_limiter.svg)](https://rubygems.org/gems/philiprehberger-rate_limiter)
+
+In-memory rate limiter with sliding window and token bucket algorithms, per-key tracking, and thread safety.
+
+## Requirements
+
+- Ruby >= 3.1
+
+## Installation
+
+Add to your Gemfile:
+
+```ruby
+gem "philiprehberger-rate_limiter"
+```
+
+Then run:
+
+```bash
+bundle install
+```
+
+Or install directly:
+
+```bash
+gem install philiprehberger-rate_limiter
+```
+
+## Usage
+
+```ruby
+require "philiprehberger/rate_limiter"
+```
+
+### Sliding Window
+
+Limits the number of requests within a rolling time window.
+
+```ruby
+limiter = Philiprehberger::RateLimiter.sliding_window(limit: 100, window: 60)
+
+if limiter.allow?("user:123")
+  # Request is allowed
+else
+  # Rate limit exceeded
+end
+```
+
+### Token Bucket
+
+Allows bursts up to a capacity, refilling at a steady rate.
+
+```ruby
+limiter = Philiprehberger::RateLimiter.token_bucket(rate: 10, capacity: 50)
+
+if limiter.allow?("api:key")
+  # Request is allowed
+else
+  # Rate limit exceeded
+end
+```
+
+### Peeking Without Consuming
+
+```ruby
+limiter.peek("user:123")      # => true/false (does not consume)
+limiter.remaining("user:123") # => number of remaining requests/tokens
+```
+
+### Resetting a Key
+
+```ruby
+limiter.reset("user:123")
+```
+
+## API
+
+| Method | Description |
+|--------|-------------|
+| `RateLimiter.sliding_window(limit:, window:)` | Create a sliding window limiter |
+| `RateLimiter.token_bucket(rate:, capacity:)` | Create a token bucket limiter |
+| `#allow?(key)` | Check and consume one request/token; returns `true`/`false` |
+| `#peek(key)` | Check availability without consuming |
+| `#remaining(key)` | Return remaining request/token count |
+| `#reset(key)` | Clear all state for a key |
+
+## Development
+
+```bash
+bundle install
+bundle exec rspec      # Run tests
+bundle exec rubocop    # Check code style
+```
+
+## License
+
+MIT

data/lib/philiprehberger/rate_limiter/sliding_window.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Philiprehberger
+  module RateLimiter
+    class SlidingWindow
+      def initialize(limit:, window:)
+        @limit = limit
+        @window = window
+        @store = {}
+        @mutex = Mutex.new
+      end
+
+      def allow?(key)
+        @mutex.synchronize { try_acquire(key) }
+      end
+
+      def peek(key)
+        @mutex.synchronize { count_remaining(key).positive? }
+      end
+
+      def remaining(key)
+        @mutex.synchronize { count_remaining(key) }
+      end
+
+      def reset(key)
+        @mutex.synchronize { @store.delete(key.to_s) }
+      end
+
+      private
+
+      def try_acquire(key)
+        cleanup(key)
+        entries = fetch_entries(key)
+        return false if entries.length >= @limit
+
+        entries << now
+        true
+      end
+
+      def count_remaining(key)
+        cleanup(key)
+        entries = fetch_entries(key)
+        [@limit - entries.length, 0].max
+      end
+
+      def cleanup(key)
+        entries = fetch_entries(key)
+        cutoff = now - @window
+        entries.reject! { |ts| ts <= cutoff }
+      end
+
+      def fetch_entries(key)
+        @store[key.to_s] ||= []
+      end
+
+      def now
+        Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      end
+    end
+  end
+end

data/lib/philiprehberger/rate_limiter/token_bucket.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Philiprehberger
+  module RateLimiter
+    class TokenBucket
+      def initialize(rate:, capacity:)
+        @rate = rate.to_f
+        @capacity = capacity.to_f
+        @store = {}
+        @mutex = Mutex.new
+      end
+
+      def allow?(key)
+        @mutex.synchronize { try_acquire(key) }
+      end
+
+      def peek(key)
+        @mutex.synchronize { token_count(key) >= 1.0 }
+      end
+
+      def remaining(key)
+        @mutex.synchronize { token_count(key).to_i }
+      end
+
+      def reset(key)
+        @mutex.synchronize { @store.delete(key.to_s) }
+      end
+
+      private
+
+      def try_acquire(key)
+        refill(key)
+        bucket = fetch_bucket(key)
+        return false if bucket[:tokens] < 1.0
+
+        bucket[:tokens] -= 1.0
+        true
+      end
+
+      def token_count(key)
+        refill(key)
+        bucket = fetch_bucket(key)
+        [bucket[:tokens], @capacity].min
+      end
+
+      def refill(key)
+        bucket = fetch_bucket(key)
+        elapsed = now - bucket[:last_refill]
+        bucket[:tokens] = [bucket[:tokens] + (elapsed * @rate), @capacity].min
+        bucket[:last_refill] = now
+      end
+
+      def fetch_bucket(key)
+        @store[key.to_s] ||= { tokens: @capacity, last_refill: now }
+      end
+
+      def now
+        Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      end
+    end
+  end
+end

data/lib/philiprehberger/rate_limiter/version.rb

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

data/lib/philiprehberger/rate_limiter.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative "rate_limiter/version"
+require_relative "rate_limiter/sliding_window"
+require_relative "rate_limiter/token_bucket"
+
+module Philiprehberger
+  module RateLimiter
+    class Error < StandardError; end
+
+    def self.sliding_window(limit:, window:)
+      SlidingWindow.new(limit: limit, window: window)
+    end
+
+    def self.token_bucket(rate:, capacity:)
+      TokenBucket.new(rate: rate, capacity: capacity)
+    end
+  end
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: philiprehberger-rate_limiter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Philip Rehberger
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-03-11 00:00:00.000000000 Z
+dependencies: []
+description: A zero-dependency Ruby gem for rate limiting with sliding window and
+  token bucket algorithms, per-key tracking, and thread safety.
+email:
+- me@philiprehberger.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/philiprehberger/rate_limiter.rb
+- lib/philiprehberger/rate_limiter/sliding_window.rb
+- lib/philiprehberger/rate_limiter/token_bucket.rb
+- lib/philiprehberger/rate_limiter/version.rb
+homepage: https://github.com/philiprehberger/rb-rate-limiter
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/philiprehberger/rb-rate-limiter
+  source_code_uri: https://github.com/philiprehberger/rb-rate-limiter
+  changelog_uri: https://github.com/philiprehberger/rb-rate-limiter/blob/main/CHANGELOG.md
+  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'
+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: In-memory rate limiter with sliding window and token bucket
+test_files: []