nocoffee_redis_rate_limit 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d3812f6d2f2f6dde5af25214c972cc6b5e3d04e30d8021255ebf383e7bd88e35
+  data.tar.gz: ddfc5ddbe7d0597ef1b7dfbf3579b63340dc7688e4f4e2cb29d2087a4e2f93bd
+SHA512:
+  metadata.gz: 8460e1b07604f68494fc31ee7d2c5bf5cf559cd4b615b1a85ab3ab1b3f4fda7d3dd97b5c8c2d7f84a8c4af8b5f797ff814dc243673195e3ef0bce2693fdbd089
+  data.tar.gz: 7401bec585ab4b527c74a85f744ce62d55d6a84dd12e64288867df69a96079640ff1af39d637c7dcbd306ec8d78d0ee09a2bb2600a939b6e764a8703d479b9d9

data/.gitignore

@@ -0,0 +1 @@
+pkg/

data/.rspec_status

@@ -0,0 +1,7 @@
+example_id                               | status | run_time        |
+---------------------------------------- | ------ | --------------- |
+./spec/redis_rate_limit_spec.rb[1:1]     | passed | 0.00466 seconds |
+./spec/redis_rate_limit_spec.rb[1:2:1:1] | passed | 0.01318 seconds |
+./spec/redis_rate_limit_spec.rb[1:2:2:1] | passed | 0.00462 seconds |
+./spec/redis_rate_limit_spec.rb[1:2:3:1] | passed | 1.01 seconds    |
+./spec/redis_rate_limit_spec.rb[1:2:4:1] | passed | 2.01 seconds    |

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in redis_rate_limit.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,40 @@
+PATH
+  remote: .
+  specs:
+    nocoffee_redis_rate_limit (0.1.0)
+      redis (>= 5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    connection_pool (2.3.0)
+    diff-lcs (1.5.0)
+    rake (13.0.6)
+    redis (5.0.6)
+      redis-client (>= 0.9.0)
+    redis-client (0.13.0)
+      connection_pool
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.1)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+
+PLATFORMS
+  x86_64-darwin-21
+
+DEPENDENCIES
+  nocoffee_redis_rate_limit!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.3.10

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Didier Lafforgue, Julien Girard
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,45 @@
+# RedisRateLimit
+
+If an application goes beyond quota defined by public APIs, they might ban it. To overcome this issue, developers have to wrap each call to public APIs and make sure they don't make more requests than allowed.
+
+Or in another words, this gem helps you to respect the ratio limit defined by external services like Twilio or others before your account gets suspended.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'redis_rate_limit'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install redis_rate_limit
+
+## Usage
+
+```ruby
+rate_limit = new('Twilio', max_rpm: 60, redis: $redis)
+
+rate_limite.safe_call do 
+  twilio_sdk.send_verification_sms('+123456789')
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/redis_rate_limit.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "redis_rate_limit"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/redis_rate_limit/version.rb

@@ -0,0 +1,3 @@
+module RedisRateLimit
+  VERSION = '0.1.0'
+end

data/lib/redis_rate_limit.rb

@@ -0,0 +1,41 @@
+require 'redis_rate_limit/version'
+
+module RedisRateLimit
+  class RateLimit
+    DURATION_IN_SECONDS = {
+      max_rpd: 60 * 60 * 24,
+      max_rph: 60 * 60,
+      max_rpm: 60,
+      max_rps: 1,
+    }
+    attr_reader :topic, :limits, :redis
+    def initialize(topic, max_rpd: nil, max_rpm: nil, max_rph: nil, max_rps: nil, redis: nil)
+      @topic, @redis = topic, redis
+      @limits = [[:max_rps, max_rps], [:max_rpm, max_rpm], [:max_rph, max_rph], [:max_rpd, max_rpd]] # order is important
+      raise 'You must set the redis option' if @redis.nil?
+      raise 'You must set at least a limit (max_rpd, max_rpm, max_rph or max_rps)' if @limits.map(&:last).all?(&:nil?)
+    end
+    def safe_call(&block)
+      @limits.each do |(type, value)|
+        next if value.nil? || value == 0
+        _topic = "#{topic}-#{type}"
+        current = redis.get(_topic).to_i
+        if current >= value
+          return [:error, "Too many requests (#{type}: #{value})"]
+        else
+          redis.multi do
+            redis.incr(_topic)
+            redis.expire(_topic, DURATION_IN_SECONDS[type])
+          end
+        end
+      end
+      [:ok, yield]
+    end
+    def reset
+      @limits.each do |(type, _)|
+        _topic = "#{topic}-#{type}"
+        redis.set(_topic, 0)
+      end
+    end
+  end
+end

data/redis_rate_limit/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/redis_rate_limit/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/redis_rate_limit/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.3
+before_install: gem install bundler -v 1.17.2

data/redis_rate_limit.gemspec

@@ -0,0 +1,32 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'redis_rate_limit/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'nocoffee_redis_rate_limit'
+  spec.version       = RedisRateLimit::VERSION
+  spec.authors       = ['Didier Lafforgue', 'Julien Girard']
+  spec.email         = ['didier@nocoffee.fr']
+
+  spec.summary       = %q{This gem is a possible usage of https://redis.io/commands/INCR.}
+  spec.description   = %q{If an application goes beyond quota defined by public APIs, they might ban it.
+To overcome this issue, developers have to wrap each call to public APIs
+and make sure they don't make more requests than allowed.}
+  spec.homepage      = "https://github.com/NoCoffeeHQ/rate_limit"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+
+  spec.add_dependency 'redis', '>= 5'
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: nocoffee_redis_rate_limit
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Didier Lafforgue
+- Julien Girard
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-03-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+description: |-
+  If an application goes beyond quota defined by public APIs, they might ban it.
+  To overcome this issue, developers have to wrap each call to public APIs
+  and make sure they don't make more requests than allowed.
+email:
+- didier@nocoffee.fr
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec_status"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/redis_rate_limit.rb
+- lib/redis_rate_limit/version.rb
+- redis_rate_limit.gemspec
+- redis_rate_limit/.gitignore
+- redis_rate_limit/.rspec
+- redis_rate_limit/.travis.yml
+homepage: https://github.com/NoCoffeeHQ/rate_limit
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.32
+signing_key:
+specification_version: 4
+summary: This gem is a possible usage of https://redis.io/commands/INCR.
+test_files: []