rails_rate_limiter 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d82c4e44c5fbd709bf78fdd289e80d7d09ad22e9
-  data.tar.gz: 54e6b7c805bb217398b06dec94f4002522ac8b48
+  metadata.gz: db2890d6018db0c943f902630dc6eddadef419e9
+  data.tar.gz: 5c43ec7b72b33a5472689063ca9bf7832996af93
 SHA512:
-  metadata.gz: e42895cbe22f74b33b13f8732202b746415e3f8d38117007890ee05333378ea38c5e0acc242e090aa82e013ace738636df004b0d3bdda976fc0b8a3a16b40e97
-  data.tar.gz: a078a449b36a996444d3588d5384e6a6cf60292d7cd0da726d015633df168980ba8ebd51351015cf5b90d41c9b2f09d9faa82a5ed2fd0d6112b70cc7b51bdf3c
+  metadata.gz: 3df66eb7f88bc89a555e9fa728283c4bf208f3a4fc565bde4d85b309736f4cb31d748d56b98c3ddeff69567f04e66f50383336b00e2772466fdf72ddb76bf046
+  data.tar.gz: 90ed942eaff1ef6f96b450604bef48afe3acc3389173cb7496745353c450005f1338bf84bcb47746d483a1107e68a9f8f0d4e4babac5c47c0e2dd82d5ef24068

data/README.md

@@ -1,6 +1,6 @@
 # RailsRateLimiter
 
-This is a high level rate limiting gem for Ruby on Rails using Redis. It limits amount of requests on controllers level, that allows you to customize rate limiting options using everything that available in your action, e.g. `current_user`.
+This is a high level rate limiting gem for Ruby on Rails using Redis. It limits amount of requests on controller's level, that allows you to customize rate limiting options using everything that available in your action, e.g. `current_user`.
 
 ## Installation
 
@@ -26,6 +26,8 @@ Add `include RateLimiter` to the controller you want to rate limit. It allows yo
 
 ```ruby
 class Posts < ApplicationController
+  include RailsRateLimiter
+
   rate_limit limit: 100, per: 1.hour, only: :index do |info|
     render plain: I18n.t('rate_limit_exceeded', seconds: info.time_left),
            status: :too_many_requests
@@ -65,7 +67,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rails_rate_limiter.
+Bug reports and pull requests are welcome on GitHub at https://github.com/rkotov93/rails_rate_limiter.
 
 ## License
 

data/lib/rails_rate_limiter.rb

@@ -5,40 +5,37 @@ require 'rails_rate_limiter/version'
 require 'rails_rate_limiter/strategies'
 require 'rails_rate_limiter/error'
 
+# Provides `rate_limit` callback to limit amount of requests
+# and handle rate limit exceeding
 module RailsRateLimiter
   extend ActiveSupport::Concern
 
   class_methods do
-    # Sets callback that checks if rate limit was exceeded.
+    # Sets callback that handles rate limit exceeding. Additionally to
+    # described options supports all the `before_action` options.
     #
-    # == Arguments:
+    # @example Renders text with time left in case of rate limit exceeding.
+    #   rate_limit limit: 100, per: 1.hour, only: :index do |info|
+    #     render plain: "Next request can be done in #{info.time_left} seconds",
+    #            status: :too_many_requests
+    #   end
     #
-    #   +&block+      - Executed if rate limit exceded.
-    #                   This argument is mandatory.
-    #
-    # == Options:
-    #
-    #   +strategy+   - Rate limiting strategy.
-    #                  Default value is :sliding_window_log
-    #
-    #   +limit+      - The number of allowed request per time period.
-    #                  Supports lambda and proc. Default value is 100
-    #   +per+        - Time period in seconds. Supports lambda and proc as well.
-    #                  Default value is 1.hour
-    #   +pattern+    - lambda or proc. Can be used if you want to use something
-    #                  instead of IP as cache key identifier. For example
-    #                  `->current_user.id`. Uses `request.remote_ip` by default.
-    #   +client+     - Redis client. Uses `Redis.new` by default.
-    #
-    # Any option avaiable for `before_action` can be used.
-    #
-    # == Examples:
-    #
-    # rate_limit limit: 100, per: 1.hour, only: :index do |info|
-    #   render plain: I18n.t('rate_limit_exceeded', seconds: info.time_left),
-    #          status: :too_many_requests
-    # end
+    # @param [Hash] options
+    # @option options [Symbol] :strategy Rate limiting strategy.
+    #   Default value is :sliding_window_log
+    # @option options [Fixnum, Lambda, Proc] :limit The number of allowed
+    #   requests per time period. Default value is 100
+    # @option options [Fixnum, Lambda, Proc] :per Time period in seconds.
+    #   Default value is 1.hour
+    # @option options [Lambda, Proc] :pattern Can be used if you want to use
+    #   something instead of IP as cache key identifier. For example
+    #   `-> { current_user.id }`. Default value is `request.remote_ip`
+    # @option options [Object] :cient Redis client.
+    #   Uses `Redis.new` if not specified
     #
+    # @yield [info] Executed if rate limit exceded. This argument is mandatory.
+    # @yieldparam [RailsRateLimiter::Result] Represent information about
+    #   rate limiting
     def rate_limit(options = {}, &block)
       raise Error, 'Handling block was not provided' unless block_given?
 

data/lib/rails_rate_limiter/result.rb

@@ -1,4 +1,5 @@
 module RailsRateLimiter
+  # Provides results of rate limiting
   class Result
     attr_reader :time_left
 

data/lib/rails_rate_limiter/strategies/sliding_window_log.rb

@@ -8,6 +8,11 @@ module RailsRateLimiter
 
       attr_reader :limit, :expires_in, :requester_pattern
 
+      # @param limit [Fixnum, Lambda, Proc] The number of allowed
+      #   requests per time period.
+      # @param per [Fixnum, Lambda, Proc] :per Time period in seconds.
+      # @param requester [Lambda, Proc] Identifies request
+      # @param client [Object] Redis client
       def initialize(limit, per, requester, client = nil)
         @limit = limit.respond_to?(:call) ? limit.call : limit
         @expires_in = calculate_expires_in(per)
@@ -28,11 +33,13 @@ module RailsRateLimiter
         @client ||= Redis.new
       end
 
+      # Removes all SORTED SET members that have a score < current_timestamp
       def remove_expired_set_members
-        # remove all SORTED SET members that have a score < current_timestamp
         client.zremrangebyscore(cache_key, '-inf', "(#{current_timestamp}")
       end
 
+      # Adds requests to SORTED SET with expiring_timestamp
+      # and current_timestamp
       def log_request
         expiring_timestamp = current_timestamp + expires_in
         client.zadd(cache_key, expiring_timestamp, current_timestamp)

data/lib/rails_rate_limiter/version.rb

@@ -1,3 +1,3 @@
 module RailsRateLimiter
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_rate_limiter
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Ruslan Kotov