rate_limit_control 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9958b377303639efb40904e16149bbae1989b0e5
-  data.tar.gz: 170b6744a697ca0032c4765ffa153c5f1d3b20a6
+  metadata.gz: c1691c8fdde2802b9942b61e37d63a3bc83c380d
+  data.tar.gz: 6c492b7c8aa28e5e2e8930b5e03e28646f157e8c
 SHA512:
-  metadata.gz: b67cf3c9bae2ca662720adae630889123f95d9c4773c78f9d4531e92ad6488e327175c7bd373d35fcf36c8f8545a0b7cefd88bb03e1b8649f598cb52882a38ef
-  data.tar.gz: ec55aedbe3795b2c39a5296e1b390a79ab87683969ee063c8edbcf8173db6f9a8046c997cefc18a2b49c1660a3e7c02d7b4830d03a51c0f545d1f63f27bb58c8
+  metadata.gz: ca14669d3e96df8e483f1424cddd56c0fa6c309d0ec78a7246f6b1cedf73097152263d8bcd9f51edf44224e58ce1e2c457abca780ed7fdb55da1d6668f3c83dd
+  data.tar.gz: 853a151d1a18edce50535b1990b736bb300fab5358851a5bfa7722e01718195b60f73582abd7c1a7ae260099b56e6fe4aa24867253201c6a713cbfcaf4c2bee2

data/.gitignore

@@ -6,6 +6,7 @@
 /pkg/
 /spec/reports/
 /tmp/
+*.gem
 
 # rspec failure tracking
 .rspec_status

data/README.md

@@ -1,8 +1,6 @@
-# RateLimitControl
+# Rate limit control
 
-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_limit_control`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Take control of the rate limit of your actions. This gem is primarily designed to work with Redis, but you can adapt other key-value databases to work with it. It was inspired by this [post](https://medium.com/@pebneter/fast-and-simple-rate-limiting-with-ruby-on-rails-and-redis-68e76ba38ca4).
 
 ## Installation
 
@@ -22,7 +20,34 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Define the configurations of your actions:
+
+```
+action_config = {
+  action: 'rate_limit_example',
+  id: 'foobar',
+  allowed_requests: 5,
+  storage: Redis.new,
+  timeout: 30,
+}
+```
+
+You need to set your action as a block inside the rate limit control:
+```
+RateLimitControl.new(action_config) do
+  puts "This action will be suspended after the 5th execution"
+end
+```
+
+After the 5th execution, the next action will be blocked until the timeout ends up. All actions with the same configuration will be blocked during this time.
+
+## Action params
+
+* **action**: Action name;
+* **id**: Id of the action, the same action could be executed by different requesters;
+* **allowed_requests**: Number of requests allow to be executed during the timeout period;
+* **storage**: Key-value database instance;
+* **timeout**: Time in seconds to unblock actions;
 
 ## Development
 

data/lib/rate_limit_control.rb

@@ -1,79 +1,74 @@
 require "rate_limit_control/version"
 
-module RateLimitControl
-  class Create
-    attr_reader :action, :allowed_requests, :session_counter, :storage, :timeout
-
-    def self.call!(configs)
-      self.new(configs).call
-      yield
-    end
-
-    def initialize(configs)
-      @action = "locked_#{configs[:action]}_#{configs[:id]}_#{Time.now.to_s}"
-      @allowed_requests = configs[:allowed_requests]
-      @session_counter = "#{configs[:action]}_#{configs[:id]}"
-      @storage = configs[:storage]
-      @timeout = configs[:timeout]
-    end
+class RateLimitControl
+  attr_reader :action, :allowed_requests, :session_counter, :storage, :timeout
+
+  def initialize(configs)
+    @action = "locked_#{configs[:action]}_#{configs[:id]}_#{Time.now.to_s}"
+    @allowed_requests = configs[:allowed_requests]
+    @session_counter = "#{configs[:action]}_#{configs[:id]}"
+    @storage = configs[:storage]
+    @timeout = configs[:timeout]
+    call
+    yield
+  end
 
-    def call
-      if session_counter_created?
-        increment_session_counter
-        set_action_as_blocked if actions_exceed_the_total_of_allowed?
-      else
-        create_session_counter
-      end
+  private
 
-      action_blocked_log
-      while action_blocked?; end
-      action_executed_log
+  def call
+    if session_counter_created?
+      increment_session_counter
+      set_action_as_blocked if actions_exceed_the_total_of_allowed?
+    else
+      create_session_counter
     end
 
-    private
+    action_blocked_log
+    while action_blocked?; end
+    action_executed_log
+  end
 
-    def session_counter_created?
-      storage.get(session_counter).present?
-    end
+  def session_counter_created?
+    storage.get(session_counter) != nil
+  end
 
-    def increment_session_counter
-      storage.incr(session_counter)
-    end
+  def increment_session_counter
+    storage.incr(session_counter)
+  end
 
-    def set_action_as_blocked
-      storage.set(action, true)
-      storage.expire(action, action_timeout)
-    end
+  def set_action_as_blocked
+    storage.set(action, true)
+    storage.expire(action, action_timeout)
+  end
 
-    def actions_exceed_the_total_of_allowed?
-      total_of_actions_executed >= allowed_requests
-    end
+  def actions_exceed_the_total_of_allowed?
+    total_of_actions_executed >= allowed_requests
+  end
 
-    def create_session_counter
-      storage.set(session_counter, 0)
-      storage.expire(session_counter, timeout)
-    end
+  def create_session_counter
+    storage.set(session_counter, 0)
+    storage.expire(session_counter, timeout)
+  end
 
-    def action_blocked_log
-      puts "Action is blocked" if action_blocked?
-    end
+  def action_blocked_log
+    puts "Action is blocked" if action_blocked?
+  end
 
-    def action_blocked?
-      storage.get(action).present?
-    end
+  def action_blocked?
+    storage.get(action) != nil
+  end
 
-    def action_executed_log
-      puts action
-      puts "Request executed at #{Time.now.to_s}"
-    end
+  def action_executed_log
+    puts action
+    puts "Request executed at #{Time.now.to_s}"
+  end
 
-    def action_timeout
-      actions_ahead = (total_of_actions_executed / allowed_requests) || 1
-      actions_ahead * timeout
-    end
+  def action_timeout
+    actions_ahead = (total_of_actions_executed / allowed_requests) || 1
+    actions_ahead * timeout
+  end
 
-    def total_of_actions_executed
-      storage.get(session_counter).to_i
-    end
+  def total_of_actions_executed
+    storage.get(session_counter).to_i
   end
 end

data/lib/rate_limit_control/version.rb

@@ -1,3 +1,3 @@
-module RateLimitControl
-  VERSION = "0.1.1"
+class RateLimitControl
+  VERSION = "0.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rate_limit_control
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Rodrigo Boniatti
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-25 00:00:00.000000000 Z
+date: 2019-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler