ruby_rate_limiter 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 440ed0f666d00afdb77283021ab3805b4fa18a08e5a5aea371b04d7b6d6cf299
-  data.tar.gz: 75309c235f17894fbe85bc034dcfb2126431d421e3c11ef089879fcedc280355
+  metadata.gz: 6d487b84e9e255e4a2fe403fc98961ee09083d7be86a5bc929e9a106e9455b87
+  data.tar.gz: 28bf084c36db3488761ef6ff9014a0a79743a23c78d1085e55188a2d09262217
 SHA512:
-  metadata.gz: 9ae4e96315c08a5e84cadc97260e0a1c08f9f201e5ef1ecbb9a235718370007bbb69d9f8625103f97ab2868a000403350503c754f2ae984b0b088e93ec6626d1
-  data.tar.gz: 2377e14dd62b12f9e3640781b3be5561a0d6ef0e84301a4d2b52c49928ec2d9f89ac9b510ecb9e467527b34a2bd26c51cf18c132b739ead39e25aae2ba21c663
+  metadata.gz: 1ece0c93d76158c3192290bb0eecbcfe09b82b71e23035b8a6616967a3fddd2af174956d72edde13fb9df3bc00fd579d8195c2115ca8586f51dbad0a8771e03d
+  data.tar.gz: ac79381bda71677bd9a0fed4935f3d167b1a840f51ef4656df951c2563a0fe4f81d561cd4d61c5420a13ef375672c596a05baf258dfab1bda3205f91446cf711

data/README.md

@@ -1,39 +1,100 @@
-# RateLimiter
+# Ruby Rate Limiter
 
-TODO: Delete this and the text below, and describe your gem
+`ruby_rate_limiter` is a Ruby gem that implements a rate limiting mechanism using the Token Bucket algorithm. This gem allows you to control the rate of requests from users or clients, which can be useful for API rate limiting, request throttling, and more.
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rate_limiter`. To experiment with that code, run `bin/console` for an interactive prompt.
+## Features
 
-## Installation
-
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
-Install the gem and add to the application's Gemfile by executing:
-
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
-
-If bundler is not being used to manage dependencies, install the gem by executing:
+- Token Bucket Algorithm: A flexible and efficient algorithm for rate limiting.
+- Redis Backend: Utilizes Redis for token storage and management.
+- Customizable Parameters: Configure the bucket size and refill rate to meet your needs.
+- Supports Time Travel: For easier testing with time manipulation.
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
-
-## Usage
-
-TODO: Write usage instructions here
+## Installation
 
-## Development
+Add `ruby_rate_limiter` to your application's Gemfile:
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+```ruby
+gem 'ruby_rate_limiter'
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+```
 
-## Contributing
+Then run:
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rate_limiter. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/rate_limiter/blob/main/CODE_OF_CONDUCT.md).
+```ruby
+bundle install
+```
 
-## License
+Alternatively, you can install the gem directly using:
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+```ruby
+gem install ruby_rate_limiter
+```
 
-## Code of Conduct
+## Usage
 
-Everyone interacting in the RateLimiter project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/rate_limiter/blob/main/CODE_OF_CONDUCT.md).
+### Configuration
+
+First, configure the RateLimiter::TokenBucket with a unique identifier for each user and specify the storage backend (e.g., Redis).
+
+Create a file in the initialize directory
+
+```ruby
+# config/initializers/ruby_rate_limiter.rb
+require 'ruby_rate_limiter'
+require 'redis'
+
+module RateLimiter
+  def self.bucket
+    @bucket ||= RubyRateLimiter::TokenBucket.new(
+      'user123',
+      storage: RubyRateLimiter::Storage::RedisStorage.new(redis_client),
+      bucket_size: 10,   # Optional: specify bucket size
+      refill_rate: 2     # Optional: specify refill rate (tokens per second)
+    )
+  end
+
+  private
+
+  def self.redis_client
+    @redis_client ||= Redis.new(url: 'redis://localhost:6379/1')
+  end
+end
+
+```
+
+### Usage somewhere, in the controller or better still in a service
+
+```ruby
+class SomeController < ApplicationController
+  def some_action
+    if RateLimiter.bucket.allow_request?
+      # Process the request
+      render json: { message: 'Request processed' }
+    else
+      # Rate limit exceeded
+      render status: 429, json: { error: 'Too many requests' }
+    end
+  end
+end
+```
+
+```ruby
+class SomeService
+  def perform
+    if RateLimiter.bucket.allow_request?
+      # Process the request
+      # Perform the service logic here
+    else
+      # Rate limit exceeded
+      raise 'Too many requests'
+    end
+  end
+end
+
+```
+
+Contributing
+Bug reports and pull requests are welcome on GitHub at https://github.com/Mutuba/ruby-rate-limiter.
+
+License
+The gem is available as open source under the terms of the MIT License.

data/lib/ruby_rate_limiter/storage/abstract_storage.rb

@@ -1,3 +1,4 @@
+# lib/ruby_rate_limiter/storage/abstract_storage.rb
 module RubyRateLimiter
   module Storage
     class AbstractStorage

data/lib/ruby_rate_limiter/storage/redis_storage.rb

@@ -1,11 +1,12 @@
+# lib/ruby_rate_limiter/storage/redis_storage.rb
 require 'redis'
 require_relative 'abstract_storage'
 
 module RubyRateLimiter
   module Storage
     class RedisStorage < AbstractStorage
-      def initialize
-        @redis = Redis.new
+      def initialize(redis_client = Redis.new)
+        @redis = redis_client
       end
 
       def get(key)

data/lib/ruby_rate_limiter/token_bucket.rb

@@ -1,3 +1,4 @@
+# lib/ruby_rate_limiter/token_bucket.rb
 require 'forwardable'
 require_relative 'storage/abstract_storage'
 require_relative 'storage/redis_storage'

data/lib/ruby_rate_limiter/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RateLimiter
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/ruby_rate_limiter.rb

@@ -1,6 +1,10 @@
 # frozen_string_literal: true
-
+# lib/ruby_rate_limiter.rb
 require_relative "ruby_rate_limiter/version"
+require 'ruby_rate_limiter/token_bucket'
+require 'ruby_rate_limiter/storage/abstract_storage'
+require 'ruby_rate_limiter/storage/redis_storage'
+
 
 module RubyRateLimiter
   class Error < StandardError; end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby_rate_limiter
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Mutuba
@@ -37,13 +37,13 @@ files:
 - lib/ruby_rate_limiter/storage/redis_storage.rb
 - lib/ruby_rate_limiter/token_bucket.rb
 - lib/ruby_rate_limiter/version.rb
-homepage: https://github.com/Mutuba/rate-limiter
+homepage: https://github.com/Mutuba/ruby-rate-limiter
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-  homepage_uri: https://github.com/Mutuba/rate-limiter
-  changelog_uri: https://github.com/Mutuba/limiter/blob/main/CHANGELOG.md
+  homepage_uri: https://github.com/Mutuba/ruby-rate-limiter
+  changelog_uri: https://github.com/Mutuba/ruby-rate-limiter/blob/main/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths: