ruby_rate_limiter 2.0.2 → 2.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c941d7875c4fabbe2df0861b89e8b7d18af0e001ac3f3e1425e51f59590a300c
-  data.tar.gz: a1a1f7431b4797271fb5db464e771257505ec5b403adc5813aa38b477b223228
+  metadata.gz: b60324c24d3fc51e14f066637e25ff4ac9b4ada858e58847faf3038412071228
+  data.tar.gz: f93cf75cb76aa970caa2d09c49899ebbb13a637fad485d4bf8e4e804a0af6ff4
 SHA512:
-  metadata.gz: ef02828da1412884377e4eac4687672be0757ec13409e6bdb31df93b3dfdd3bcab0ffd3786180ddbb172f7c006d99aa0ab14ac933b03730904ee107140f65626
-  data.tar.gz: 652883cc2da93a8eb07b10958f8120d3f57d900338d3d5b43a4fdba8e2d4c8ea5b0a613db0fbba9681997866b30c825f521737b1fa576dff8eaf7b021942ed5e
+  metadata.gz: eeeaca8c796fd0431016764af4c6c6d7a4535bbac91a93d616fa7e4dbc196d21b13667fa5e1f612d0226b47431925dad7b7dbc642e7312122123d56a4a971ed7
+  data.tar.gz: 6d18b90e23f0b6b0597cd27a62b3ce7e05c8d5aa01fce90c00d6a96df939bf9d2b7fbc63496343bb3382a84760a71d4a0c44ad8eb59fd85e22feaf168f5e6aa3

data/README.md

@@ -44,57 +44,63 @@ require 'ruby_rate_limiter'
 require 'redis'
 
 module RateLimiter
-  def self.bucket
-    @bucket ||= RubyRateLimiter::TokenBucket.new(
-      'user123',
+  DEFAULT_BUCKET_SIZE = 10
+  DEFAULT_REFILL_RATE = 1
+  DEFAULT_TIME_UNIT = :minute
+
+  def self.for(user_identifier:, bucket_size: DEFAULT_BUCKET_SIZE, refill_rate: DEFAULT_REFILL_RATE, time_unit: DEFAULT_TIME_UNIT)
+    RubyRateLimiter::TokenBucket.new(
+      user_identifier: user_identifier,
       storage: RubyRateLimiter::Storage::RedisStorage.new(redis_client),
-      bucket_size: 10,   # Optional: specify bucket size
-      refill_rate: 2     # Optional: specify refill rate (tokens per second)
+      bucket_size: bucket_size,
+      refill_rate: refill_rate,
+      time_unit: time_unit
     )
   end
 
   private
 
   def self.redis_client
-    @redis_client ||= Redis.new(url: 'redis://localhost:6379/1')
+    @redis_client ||= Redis.new(url: ENV['REDIS_URL'])
   end
 end
 
+
+
 ```
 
 ### Usage somewhere, in the controller or better still in a service
 
+Maybe have some 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
+class RateLimiterService
+  def self.rate_limit_exceeded?(user_identifier)
+    rate_limiter = RateLimiter.for(user_identifier: user_identifier)
+    !rate_limiter.allow_request?
   end
 end
+
 ```
 
+Usage in the controller
+
 ```ruby
-class SomeService
-  def perform
-    if RateLimiter.bucket.allow_request?
-      # Process the request
-      # Perform the service logic here
+class SomeController < ApplicationController
+  def some_action
+    user_identifier = current_user ? "user:#{current_user.id}" : "ip:#{request.remote_ip}"
+    if RateLimiterService.rate_limit_exceeded?(user_identifier)
+      render status: 429, json: { error: 'Too many requests' }
     else
-      # Rate limit exceeded
-      raise 'Too many requests'
+      # Process the request
+      render json: { message: 'Request processed' }
     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/token_bucket.rb

@@ -34,28 +34,36 @@ module RubyRateLimiter
     def allow_request?
       refill_tokens
       tokens = get_bucket_size
+      puts "Allow request: tokens before = #{tokens}" # Debugging line
       return false if tokens < 1
 
       update_bucket_size(tokens - 1)
+      puts "Allow request: tokens after = #{get_bucket_size}" # Debugging line
       true
     end
 
     private
 
     def get_bucket_size
-      (@storage.get("#{@user_id}_tokens") || @bucket_size).to_i
+      size = (@storage.get("#{@user_id}_tokens") || @bucket_size).to_i
+      puts "get_bucket_size: #{@user_id}_tokens = #{size}"
+      size
     end
 
     def get_last_refill_time
-      (@storage.get("#{@user_id}_last_refill") || Time.now.to_f).to_f
+      time = (@storage.get("#{@user_id}_last_refill") || Time.now.to_f).to_f
+      puts "get_last_refill_time: #{@user_id}_last_refill = #{time}"
+      time
     end
 
     def update_bucket_size(tokens)
+      puts "update_bucket_size: #{@user_id}_tokens = #{tokens}"
       @storage.set("#{@user_id}_tokens", tokens)
     end
 
     def update_last_refill_time(timestamp)
       @storage.set("#{@user_id}_last_refill", timestamp)
+      puts "update_last_refill_time: #{@user_id}_last_refill = #{timestamp}"
     end
 
     def refill_tokens
@@ -64,11 +72,14 @@ module RubyRateLimiter
       elapsed_time = current_time - last_refill_time
 
       new_tokens = (elapsed_time * @refill_rate_per_second).to_i
+      puts "Refill tokens: elapsed_time = #{elapsed_time}, new_tokens = #{new_tokens}" # Debugging line
+
       return if new_tokens <= 0
 
       tokens = [get_bucket_size + new_tokens, @bucket_size].min
       update_bucket_size(tokens)
       update_last_refill_time(current_time)
+      puts "Refill tokens: updated tokens = #{tokens}, current_time = #{current_time}" # Debugging line
     end
   end
 end

data/lib/ruby_rate_limiter/version.rb

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

data/lib/ruby_rate_limiter.rb

@@ -5,7 +5,6 @@ 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
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby_rate_limiter
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.0.3
 platform: ruby
 authors:
 - Mutuba
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-15 00:00:00.000000000 Z
+date: 2024-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis