rapidity 0.0.4 → 0.0.5.88265

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e5b2867053a9585cf900e8b33f71993636e8b685fea22a0735d03a45d7c36c44
-  data.tar.gz: 32d6e2e8dc7b06b5951044cf9d375ecf62e0e3c9093a184d6c71213066da387b
+  metadata.gz: 6faa9172962dc6c7004e59dc8e827f16572b99c41b586c7221539d2bf253dda5
+  data.tar.gz: fb698e043084b6ad4491c2c85b785f9678aba9996f333e3df6bae45d6f76a76a
 SHA512:
-  metadata.gz: 47d2226e37cddfa6d743f550ca4522909874e5f0476be4447bc5aac7afe16aa43ca70f64c8196d805e23db104af705088e79af4ec7a1d0192830297950678b56
-  data.tar.gz: 7fa7c1e532876677d1f4aef57cc36cb310b61382c5ca630cdc4b90e115eeb01e6020e419e66d322d89e424647c602294ed776c399b5eaff124a8fcc3fd8e5bcb
+  metadata.gz: d76e69e666ae0ab3a541f8ce725b2aae485ac9c7218163bd23bcaf4023f33db748da42f5dab7b978699f3f0ac3c0cfce9b49e2933127b81613d7df4533bc7496
+  data.tar.gz: 7434ad4f51dc20142d28f5df0bd004f79e8674dec8ac317683d18921626469525f81956ce4c3b7a8260c11cdb3cd7f281bb3f7f7aac5123e532899a9446d1587

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rapidity (0.0.4)
+    rapidity (0.0.5.88265)
       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)

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/version.rb

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

metadata

@@ -1,12 +1,12 @@
 --- !ruby/object:Gem::Specification
 name: rapidity
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5.88265
 platform: ruby
 authors:
 - Yurusov Vlad
 - Samoilenko Yuri
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
 date: 2022-06-25 00:00:00.000000000 Z
@@ -237,10 +237,10 @@ files:
 - lib/rapidity/composer.rb
 - lib/rapidity/limiter.rb
 - lib/rapidity/version.rb
-homepage:
+homepage: 
 licenses: []
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -255,8 +255,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.8
-signing_key:
+rubygems_version: 3.0.3
+signing_key: 
 specification_version: 4
 summary: Simple distributed Redis-backed rate limiter
 test_files: []