rlimiter 1.0.4 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 528b2e9c5b67936908454361b5d3bbdce2649ef4de738afd9d14097b274f28b3
-  data.tar.gz: 5a72ff348d385e692cd5fd967c13e9c8543481ffb61f22288f1a66f3a3a6f46b
+  metadata.gz: 86ce52b16110098b2ec69c9913b0557416bee91b46c46aeeb840f151938ce9e2
+  data.tar.gz: 5496daf4b76627a21d00d8092fd2d5c6806a23b422c4e9ca3f11431a35b1ac85
 SHA512:
-  metadata.gz: 3766e84a11dcb16f8c333355bc26d27fe9407a851558e189892acf9bc1a572aeec4d59693e437e692fde4d37a92d3cdf9ef3a0dbdb1827e7df6d700354df2c31
-  data.tar.gz: 2767cd4c071defd0b2c31087edb81e29216b755319e401159b991355a7b61d6328efbe456fde725ca791e40ff6592e2b66b8ffc7e9567b9f0ffc82fec93907fa
+  metadata.gz: 2ce84183c112ab6d55b974cf66faf7b67956e9aaec68c2f4b5448fe8af03de91075e48539d3b7202c94bbfb83bc452858a62d3b3ebb2bda643e7becd7fdbc6b1
+  data.tar.gz: 6274a2d372b45c8b064723858c24bf0b99d36e02c62be590ad0245914dd98169adad8fbd1bbed1981a0b05c85daf624c3a070a7a1a5c52c64359d26862b419ef

data/.coveralls.yml

@@ -1 +1 @@
-repo_token: LhuzAphV1s78Ypdbn9PRsKMDlCpcxMLGk
+repo_token: $COVERALLS_REPO_TOKEN

data/lib/rlimiter.rb

@@ -1,9 +1,8 @@
 require 'rlimiter/version'
 
-# It is important that the files are loaded in the order specified below because of inheritance dependencies.
-# TODO: Figure out a better way to load
-require_files = %w[/rlimiter/client.rb /rlimiter/invalid_client_error.rb /rlimiter/version.rb /rlimiter/redis_client.rb]
-require_files.each do |file|
+# It is important that the files are loaded in the order specified below because of
+# inheritance dependencies.
+%w[/rlimiter/client.rb /rlimiter/invalid_client_error.rb /rlimiter/version.rb /rlimiter/redis_client.rb].each do |file|
   Dir.glob(File.dirname(File.absolute_path(__FILE__)) + file, &method(:require))
 end
 
@@ -15,8 +14,10 @@ module Rlimiter
     CLIENTS = %w[redis].freeze
     attr_reader :client
 
-    # One time initializes the client which is to be used throughout the application.
-    # The value of params variable will change depending on the storage client to be initialized.
+    # One time initializes the client which is to be used throughout the
+    # application. The value of params variable will change depending on the
+    # storage client to be initialized.
+    #
     # @param [Hash] params
     # @return [Rlimiter::Client]
     def init(params)
@@ -28,8 +29,9 @@ module Rlimiter
       end
     end
 
-    # Note : Params for the below methods are kept arbitrary for free implementation and are specific to a single client,
-    # after usage feedback it will be refactored to pertain to a single signature.
+    # Note : Params for the below methods are kept arbitrary for free
+    # implementation and are specific to a single client, after usage feedback
+    # it will be refactored to pertain to a single signature.
 
     # Register a hit to the client.
     def limit(*params)

data/lib/rlimiter/client.rb

@@ -14,5 +14,9 @@ module Rlimiter
       # Stub
     end
 
+    def clear(key)
+      # Stub
+    end
+
   end
 end

data/lib/rlimiter/redis_client.rb

@@ -1,13 +1,14 @@
 require 'redis'
 
 module Rlimiter
-
   # Redis concrete class of abstract Client
-  # Maintains two redis keys, one for number of hits and other for the start of the time window.
-  # Increases the hit count every time :limit is called, if hit count exceeds the limit count then it is checked whether
-  # if the previous time window is active or not, on the basis of which true/false is returned.
+  # Maintains two redis keys, one for number of hits and other for the start of
+  # the time window.
+  # Increases the hit count every time :limit is called, if hit count exceeds
+  # the limit count then it is checked whether
+  # if the previous time window is active or not, on the basis of which
+  # true/false is returned.
   class RedisClient < Client
-
     # Name of key of the hit count number, stores an integer.
     RATE_COUNT = 'rate_count'.freeze
 
@@ -33,15 +34,19 @@ module Rlimiter
       @redis = Redis.new(params)
     end
 
-    # Registers a hit corresponding to the key specified, requires the max hit count and the duration to be passed.
+    # Registers a hit corresponding to the key specified, requires the max hit
+    # count and the duration to be passed.
     #
-    # @param [String] key : Should be unique for one operation, can be added for multiple operations if a single rate
+    # @param [String] key : Should be unique for one operation, can be added for
+    # multiple operations if a single rate
     #                       limiter is to be used for those operations.
     # @param [Integer] count : Max rate limit count
     # @param [Integer] duration : Duration of the time window.
     #
-    # Count and duration params could change in each call and the limit breach value is returned corresponding to that.
-    # Ideally this method should be called with each param a constant on the application level.
+    # Count and duration params could change in each call and the limit breach
+    # value is returned corresponding to that.
+    # Ideally this method should be called with each param a constant on the
+    # application level.
     #
     # Returns false if the limit has been breached.
     # Returns true if limit has not been breached. (duh)
@@ -53,7 +58,8 @@ module Rlimiter
       if incr_count > count
 
         # :elapsed is the time window start Redis cache
-        # If the time elapsed is less than window duration, the limit has been breached for the current window (return false).
+        # If the time elapsed is less than window duration, the limit has been
+        # breached for the current window (return false).
         return false if @duration - elapsed > 0
 
         # Else reset the hit count to zero and window start time.
@@ -77,9 +83,18 @@ module Rlimiter
       @key = key
       @duration = duration
       return 0 if current_count(key) < count
+
       [@duration - elapsed, 0].max
     end
 
+    # Clear the key from the data store.
+    # @param [String] key
+    # @return [TrueClass|FalseClass] depending on whether key has been deleted
+    # successfully.
+    def clear(key)
+      @redis.del(key) == 1
+    end
+
     private
 
     def reset

data/lib/rlimiter/version.rb

@@ -1,5 +1,5 @@
 module Rlimiter
   #:nocov:
-  VERSION = '1.0.4'.freeze
+  VERSION = '1.0.5'.freeze
   #:nocov:
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rlimiter
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
 platform: ruby
 authors:
 - Sidharth Patro
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-06 00:00:00.000000000 Z
+date: 2019-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -118,7 +118,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 2.7.8
 signing_key: 
 specification_version: 4
 summary: Rate limiting library for Ruby