rapidity 0.0.3.59007 → 0.0.4.88264

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 40693850bff25145da969b8f51894fbb7b01dc774ab6534e38cad3c4c461cbc7
-  data.tar.gz: be8657014c79b06a6e7191d3e2aff293720ac5e9418591d3a4e962de4e4774eb
+  metadata.gz: b1ce2b9094e761e73932f6a5c4e249a54ab971fc89ee735b04c7748c68d562af
+  data.tar.gz: b33de26c3a4c10d18b087ba4ac168a9136764429b2a988be2814a591c7b82c5a
 SHA512:
-  metadata.gz: f18ecca6be2877265cfa7d2afa434d515668502ea820a7fa0a41c805ab59e6163acda6c52b46dddc2c8396265e05ea8947c6b2f48e4c8c4dec3544ee23ac33e0
-  data.tar.gz: 28869c4c007d2dba9012c006c5b09ab7157d0ce592a4ad891f365c5036096c28a9b9ddb1d85d17ecf31c744be07f09cdf924a6a4d73e594f200e416e8ce24e8c
+  metadata.gz: 4cc96ac7a6f910293ff9d1ca0218894a04605253fb41caa627dea3593850b4e4b1bb6d9bd892733353cdcde73a23f151c08aa0b55e473a8e5533497c23876ca9
+  data.tar.gz: 79db7352433e17fce63344856da58107b0fd87215b1d5f5e1207ff250cb2a73e8d8f5afb8287b13f7538269ec3df061dc783f632eeb98fa6b964ae485822a6eb

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rapidity (0.0.3.59007)
+    rapidity (0.0.4.88264)
       activesupport
       connection_pool
       redis
@@ -58,7 +58,7 @@ GEM
     psych (3.3.2)
     public_suffix (4.0.6)
     rainbow (3.0.0)
-    redis (4.4.0)
+    redis (4.7.0)
     reek (6.0.4)
       kwalify (~> 0.7.0)
       parser (~> 3.0.0)
@@ -142,4 +142,4 @@ DEPENDENCIES
   timeouter
 
 BUNDLED WITH
-   2.2.14
+   2.2.27

data/README.md

@@ -0,0 +1,92 @@
+# Rapidity
+
+[![Gem Version](https://badge.fury.io/rb/rapidity.svg)](https://rubygems.org/gems/rapidity)
+[![Gem](https://img.shields.io/gem/dt/rapidity.svg)](https://rubygems.org/gems/rapidity/versions)
+[![YARD](https://badgen.net/badge/YARD/doc/blue)](http://www.rubydoc.info/gems/rapidity)
+
+[![Coverage](https://lysander.rnds.pro/api/v1/badges/rapidity_coverage.svg)](https://lysander.rnds.pro/api/v1/badges/rapidity_coverage.html)
+[![Quality](https://lysander.rnds.pro/api/v1/badges/rapidity_quality.svg)](https://lysander.rnds.pro/api/v1/badges/rapidity_quality.html)
+[![Outdated](https://lysander.rnds.pro/api/v1/badges/rapidity_outdated.svg)](https://lysander.rnds.pro/api/v1/badges/rapidity_outdated.html)
+[![Vulnerabilities](https://lysander.rnds.pro/api/v1/badges/rapidity_vulnerable.svg)](https://lysander.rnds.pro/api/v1/badges/rapidity_vulnerable.html)
+
+Simple but fast Redis-backed distributed rate limiter. Allows you to specify time interval and count within to limit distributed operations.
+
+Features:
+ 
+ - extremly simple
+ - safe
+ - fast
+
+## Usage
+
+Rapidity has two variants:
+
+- simple `Rapidity::Limiter` to handle single distibuted counter
+- complex `Rapidity::Composer` to handle multiple counters at once
+
+### Single conter with concurrent access
+
+```ruby
+pool = ConnectionPool.new(size: 10) do
+  Redis.new(url: ENV.fetch('REDIS_URL', 'redis://127.0.0.1:6379'))
+end
+
+# allow no more 10 requests within 5 seconds
+limiter = Rapidity::Limiter.new(pool, name: 'requests', threshold: 10, interval: 5)
+
+loop do
+  # try to obtain 3 requests at once
+  quota = limiter.obtain(3).times do
+    make_request
+  end
+
+  if quota == 0
+    # no more requests allowed within interval
+    sleep 1
+  end
+end
+
+```
+
+### Multiple counters
+
+```ruby
+pool = ConnectionPool.new(size: 10) do
+  Redis.new(url: ENV.fetch('REDIS_URL', 'redis://127.0.0.1:6379'))
+end
+
+LIMITS = [
+  { interval: 1, threshold: 2 },        # no more 2 requests per second
+  { interval: 60, threshold: 200 },     # no more 200 requests per minute
+  { interval: 86400, threshold: 10000 } # no more 10k requests per day
+]
+
+limiter = Rapidity::Composer.new(pool, name: 'requests', limits: LIMITS)
+
+loop do
+  # try to obtain 3 requests at once
+  quota = limiter.obtain(3).times do
+    make_request
+  end
+
+  if quota == 0
+    # no more requests allowed within interval
+    puts limiter.remains # inspect current limits
+    sleep 1
+  end
+end
+
+```
+
+## Installation
+
+It's a gem:
+```bash
+  gem install rapidity
+```
+There's also the wonders of [the Gemfile](http://bundler.io):
+```ruby
+  gem 'rapidity'
+```
+
+

data/lib/rapidity/limiter.rb

@@ -29,13 +29,13 @@ module Rapidity
     # Get current counter
     # @return remaining counter value
     def remains
-      _, result = @pool.with do |conn|
+      results = @pool.with do |conn|
         conn.multi do
           conn.set(key('remains'), threshold, ex: interval, nx: true)
           conn.get(key('remains'))
         end
       end
-      result.to_i
+      results[1].to_i #=> conn.get(key('remains'))
     end
 
     # Obtain values from counter
@@ -43,24 +43,35 @@ module Rapidity
     def obtain(count = 5)
       count = count.abs
 
-      _, taken = @pool.with do |conn|
+      results = @pool.with do |conn|
         conn.multi do
           conn.set(key('remains'), threshold, ex: interval, nx: true)
           conn.decrby(key('remains'), count)
         end
       end
 
+      taken = results[1].to_i #=> conn.decrby(key('remains'), count)
+
       if taken < 0
         overflow = taken.abs
         to_return = [count, overflow].min
 
-        @pool.with do |conn|
+        results = @pool.with do |conn|
           conn.multi do
             conn.set(key('remains'), threshold - to_return, ex: interval, nx: true)
             conn.incrby(key('remains'), to_return)
+            conn.ttl(key('remains'))
           end
         end
 
+        ttl = results[2].to_i #=> conn.ttl(key('remains'))
+
+        # reset if no ttl present
+        if ttl == -1 
+          STDERR.puts "ERROR[#{Time.now}]: TTL for key #{key('remains').inspect} disappeared!"
+          @pool.with {|c| c.expire(key('remains'), interval) } 
+        end
+
         count - to_return
       else
         count

data/lib/rapidity/version.rb

@@ -1,6 +1,6 @@
 module Rapidity
 
-  VERSION = '0.0.3'.freeze
+  VERSION = '0.0.4'.freeze
 
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rapidity
 version: !ruby/object:Gem::Version
-  version: 0.0.3.59007
+  version: 0.0.4.88264
 platform: ruby
 authors:
 - Yurusov Vlad
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-04 00:00:00.000000000 Z
+date: 2022-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -232,6 +232,7 @@ files:
 - Gemfile
 - Gemfile.lock
 - LICENSE
+- README.md
 - lib/rapidity.rb
 - lib/rapidity/composer.rb
 - lib/rapidity/limiter.rb