redis_rate_limiter 0.0.4 → 0.0.5

data/lib/redis_rate_limiter.rb

@@ -1,11 +1,24 @@
 require 'redis'
 
 class RedisRateLimiter
+
+  # @!attribute key
+  #   @return [String] Name which uniquely identifies this rate limiter
+  # @!attribute redis
+  #   @return [Redis] Redis client associated with this rate limiter
+  # @!attribute interval
+  #   @return [Integer] Time span this rate limiter tracks in seconds
+  # @!attribute limit
+  #   @return [Integer] Max count allowed by rate limiter in interval
   attr_accessor :key, :redis, :limit, :interval
 
-  # options:
-  # :interval - time span to track in seconds
-  # :limit    - max count allowed in interval
+  # Initializes a new RedisRateLimiter object
+  #
+  # @param [String] key A name to uniquely identify this rate limiter
+  # @param [Redis] redis Redis client associated with rate limiter
+  # @param options [Integer] :interval Time span to track in seconds
+  # @param options [Integer] :limit Max count allowed in interval
+  # @return [RedisRateLimiter] Instance of this rate limiter
   def initialize key, redis, options = {}
     @key      = key
     @redis    = redis
@@ -13,6 +26,10 @@ class RedisRateLimiter
     @interval = options[:interval] || 60
   end
 
+  # Add to subject's count
+  #
+  # @param [String] subject A name to uniquely identify subject
+  # @param [time] time UNIX timestamp of event
   def add subject, time = Time.now.to_i
     subject = "#{@key}:#{subject}"
     @redis.multi do
@@ -22,10 +39,14 @@ class RedisRateLimiter
     end
   end
 
+  # Check if subject has exceeded count
+  #
+  # @param [String] subject Name which uniquely identifies subject
+  # @return [Boolean] Returns true if subject has exceeded count
   def exceeded? subject
     subject = "#{@key}:#{subject}"
     return false if @redis.llen(subject) < @limit
-    last = @redis.lrange(subject, @limit - 1, @limit - 1).last
+    last = @redis.lindex(subject, -1)
     Time.now.to_i - last.to_i < @interval
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redis_rate_limiter
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -75,6 +75,38 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Redis-backed rate limiter
 email: sean.xie.sx@gmail.com
 executables: []