speed_limiter 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ee6151563233234c9c453843d4d3d98e8de465905e38e99437caaa6a0e258d6b
+  data.tar.gz: 9efaa7b0784d79a9a23c77015013519380d20b94645e39e725d390030ad48569
+SHA512:
+  metadata.gz: a9672f7b225e6325589c9bb8fae4cc76ad860024b9fbbcdb6f10edc5d4137ac593b4d6ac5370e6490b1ccc1186b0032bf20d572644ec8177afa783d5603cfe2d
+  data.tar.gz: 74020c4965b083e2cea5af94a05299455d2ee64060fc008e8fa9b7b5afacae0a587d432925ece9f7efb860388fa15886742d7c5d722751cdb877d6bf31d30110

data/.github/workflows/lint.yml

@@ -0,0 +1,24 @@
+name: lint
+
+on: [push, pull_request]
+
+permissions:  # added using https://github.com/step-security/secure-workflows
+  contents: read
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    timeout-minutes: 10
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.1'
+          bundler-cache: true
+
+      - name: Run rubocop
+        run: bundle exec rubocop

data/.github/workflows/test.yml

@@ -0,0 +1,44 @@
+name: test
+
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: '40 8 * * MON'
+  push:
+    paths-ignore:
+      - '**/*.md'
+      - 'LICENSE'
+
+permissions:  # added using https://github.com/step-security/secure-workflows
+  contents: read
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+
+    strategy:
+      matrix:
+        ruby-version: ['3.0', '3.1', '3.2', ruby-head]
+        redis-version: ['5.0', '6.0', '6.2', '7.0', '7.2', latest]
+
+    services:
+      redis:
+        image: redis:${{ matrix.redis-version }}
+        ports:
+          - 6379:6379
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+
+      - name: Rackup test throttle server
+        run: bundle exec pumad -C throttle_server/puma.rb throttle_server/config.ru
+
+      - name: Run tests
+        run: bundle exec rspec -fd

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor
+/.ruby-version
+/polyrange-*.gem
+.rspec_status
+Gemfile.lock
+/throttle_server/tmp/*
+
+!.keep

data/.rubocop.yml

@@ -0,0 +1,20 @@
+require:
+  - rubocop-rspec
+  - rubocop-rake
+
+AllCops:
+  TargetRubyVersion: 3.0
+  NewCops: enable
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Metrics/AbcSize:
+  Max: 30
+
+Rspec/MultipleExpectations:
+  Enabled: false
+
+Rspec/ExampleLength:
+  Enabled: false
+

data/Gemfile

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in SpeedLimiter.gemspec
+gemspec
+
+group :development do
+  gem "parallel", "~> 1.23"
+  gem "puma", "~> 6.4"
+  gem "puma-daemon", "~> 0.3", require: false
+  gem "rack", "~> 3.0"
+  gem "rack-attack", "~> 6.7"
+  gem "rackup", "~> 2.1"
+  gem "rake"
+  gem "rspec"
+  gem "rubocop"
+  gem "rubocop-rake"
+  gem "rubocop-rspec"
+end

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Seibii, Inc
+
+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,108 @@
+[![lint](https://github.com/seibii/speed_limiter/actions/workflows/lint.yml/badge.svg?branch=main)](https://github.com/seibii/speed_limiter/actions/workflows/lint.yml) [![test](https://github.com/seibii/speed_limiter/actions/workflows/test.yml/badge.svg)](https://github.com/seibii/speed_limiter/actions/workflows/test.yml) [![Gem Version](https://badge.fury.io/rb/speed_limiter.svg)](https://badge.fury.io/rb/speed_limiter) [![MIT License](http://img.shields.io/badge/license-MIT-blue.svg?style=flat)](LICENSE)
+
+# SpeedLimiter
+
+<img src="README_image.jpg" width="400px" />
+
+This is a Gem for execution limits in multi-process and multi-threaded environments. By using Redis, you can limit execution across multiple processes and threads.
+
+It was mainly created to avoid hitting access limits to the API server.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'speed_limiter'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install speed_limiter
+
+## Usage
+
+```ruby
+# Limit the number of executions to 10 times per second
+SpeedLimiter.throttle('server_name/method_name', limit: 10, period: 1) do
+  # Do something
+end
+```
+
+### Configuration
+
+```ruby
+# config/initializers/speed_limiter.rb
+SpeedLimiter.configure do |config|
+  config.redis_url = ENV['SPEED_LIMITER_REDIS_URL'] || 'redis://localhost:6379/2'
+end
+```
+
+or Use Redis instance
+
+```ruby
+# config/initializers/speed_limiter.rb
+SpeedLimiter.configure do |config|
+  config.redis = Redis.new(host: 'localhost', port: 6379, db: 2)
+end
+```
+
+If you do not want to impose a limit in the test environment, please set it as follows.
+
+```ruby
+# spec/support/speed_limiter.rb
+RSpec.configure do |config|
+  config.before(:suite) do
+    SpeedLimiter.configure do |config|
+      config.no_limit = true
+    end
+  end
+end
+```
+
+## Compatibility
+
+SpeedLimiter officially supports the following Ruby implementations and Redis :
+
+- Ruby MRI 3.0, 3.1, 3.2
+- Redis 5.0, 6.0, 6.2, 7.0, 7.2
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies.
+Please run rspec referring to the following.
+
+Before committing, run bundle exec rubocop to perform a style check.
+You can also run bin/console for an interactive prompt that will allow you to experiment.
+
+### rspec
+
+Start a web server and Redis for testing with the following command.
+
+```
+$ rake test:throttle_server
+$ docker compose up
+```
+
+After that, please run the test with the following command.
+
+```
+$ bundle exec rspec -fd
+```
+
+## Contribution
+
+1. Fork it ( https://github.com/seibii/speed_limiter/fork )
+2. Create your feature branch (git checkout -b my-new-feature)
+3. Commit your changes (git commit -am 'Add some feature')
+4. Push to the branch (git push origin my-new-feature)
+5. Create new Pull Request
+
+## 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,20 @@
+# frozen_string_literal: true
+
+require "rubygems"
+require "bundler/setup"
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+
+task default: :spec
+
+namespace :test do
+  desc "Run rackup for throttle server daemon"
+  task :throttle_server do
+    system "puma -C throttle_server/puma.rb throttle_server/config.ru"
+  end
+end

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "speed_limiter"
+
+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/compose.yaml

@@ -0,0 +1,5 @@
+services:
+  redis:
+    image: redis:latest
+    ports:
+      - "6379:6379"

data/lib/speed_limiter/config.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module SpeedLimiter
+  # config model
+  class Config
+    attr_accessor :redis_url, :redis, :no_limit, :prefix
+
+    def initialize
+      @redis_url = "redis://localhost:6379/0"
+      @redis = nil
+      @no_limit = false
+      @prefix = "speed_limiter"
+    end
+
+    alias no_limit? no_limit
+  end
+end

data/lib/speed_limiter/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SpeedLimiter
+  VERSION = "0.0.1"
+end

data/lib/speed_limiter.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require "speed_limiter/version"
+require "speed_limiter/config"
+require "redis"
+
+# Call speed limiter
+module SpeedLimiter
+  class << self
+    def config
+      @config ||= Config.new
+    end
+
+    def configure
+      yield(config)
+    end
+
+    def redis
+      @redis ||= config.redis || Redis.new(url: config.redis_url)
+    end
+
+    def throttle(key, limit:, period:, &block)
+      return block&.call if config.no_limit?
+
+      key_name = "#{config.prefix}:#{key}"
+      loop do
+        count = increment(key_name, period)
+
+        break(block&.call) if count <= limit
+
+        wait_for_interval(key_name)
+      end
+    end
+
+    private
+
+    def wait_for_interval(key)
+      pttl = redis.pttl(key)
+      ttl = pttl / 1000.0
+
+      return if ttl.negative?
+
+      sleep ttl
+    end
+
+    def increment(key, period) # rubocop:disable Metrics/MethodLength
+      if supports_expire_nx?
+        count, = redis.pipelined do |pipeline|
+          pipeline.incrby(key, 1)
+          pipeline.call(:expire, key, period.to_i, "NX")
+        end
+      else
+        count, ttl = redis.pipelined do |pipeline|
+          pipeline.incrby(key, 1)
+          pipeline.ttl(key)
+        end
+        redis.expire(key, period.to_i) if ttl.negative?
+      end
+
+      count
+    end
+
+    def supports_expire_nx?
+      return @supports_expire_nx if defined?(@supports_expire_nx)
+
+      redis_versions = redis.info("server")["redis_version"]
+      @supports_expire_nx = Gem::Version.new(redis_versions) >= Gem::Version.new("7.0.0")
+    end
+  end
+end

data/speed_limitter.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "speed_limiter/version"
+
+Gem::Specification.new do |spec|
+  spec.required_ruby_version = ">= 3.0.0"
+
+  spec.name          = "speed_limiter"
+  spec.version       = SpeedLimiter::VERSION
+  spec.authors       = ["yuhei mukoyama"]
+  spec.email         = ["yuhei.mukoyama@seibii.com"]
+
+  spec.summary       = "Limit the frequency of execution across multiple threads and processes"
+  spec.homepage      = "https://github.com/seibii/speed_limiter"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["rubygems_mfa_required"] = "true"
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+          "public gem pushes."
+  end
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "redis"
+end

data/throttle_server/config.ru

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require "rack/attack"
+use Rack::Attack
+
+# Throttling test server
+module ThrottlingServer
+  THROTTLE_MATCHER = %r{/(\d+)/(\d+)s(\?.+=.*)?}
+
+  def self.call(env)
+    case env["REQUEST_URI"]
+    when "/"
+      [200, { "content-type" => "text/plain" }, ["Hi!\nPlease access to /#\{limit}/#\{period}s\n\n", throttle_info]]
+    when THROTTLE_MATCHER
+      (limit, period) = Regexp.last_match.captures
+
+      puts "[OK] #{env['REQUEST_METHOD']} #{env['REQUEST_URI']}\n  #{throttle_info.gsub("\n", "\n  ")}"
+      [200, { "content-type" => "text/plain" }, ["OK\n#{limit} / #{period} seconds\n\n", throttle_info]]
+    else
+      [404, { "content-type" => "text/plain" }, ["Not Found"]]
+    end
+  end
+
+  def self.throttle_info
+    list = REDIS.scan_each.map { |key| "#{key} count: #{REDIS.get(key)}, ttl: #{REDIS.pttl(key)}ms" }.sort.join("\n")
+    "Throttle Info:\n#{list}"
+  end
+
+  def self.limit(req)
+    case req.path
+    when THROTTLE_MATCHER
+      Regexp.last_match.captures[0].to_i
+    else
+      9999
+    end
+  end
+
+  def self.period(req)
+    case req.path
+    when THROTTLE_MATCHER
+      Regexp.last_match.captures[1].to_i
+    else
+      9999
+    end
+  end
+end
+
+Rack::Attack.throttle(
+  "requests by path", limit: ThrottlingServer.method(:limit),
+                      period: ThrottlingServer.method(:period)
+) do |request|
+  request.url if request.url.match(ThrottlingServer::THROTTLE_MATCHER)
+end
+
+Rack::Attack.throttled_responder = lambda do |env|
+  puts "[Retry later] #{env['REQUEST_METHOD']} #{env['REQUEST_URI']}\n  " \
+       "#{ThrottlingServer.throttle_info.gsub("\n", "\n  ")}"
+  [429, {}, ["Retry later\n\n", ThrottlingServer.throttle_info]]
+end
+
+require "redis"
+REDIS = Rack::Attack.cache.store = Redis.new(url: ENV.fetch("THROTTLE_SERVER_REDIS_URL", "redis://localhost:6379/15"))
+
+run ThrottlingServer

data/throttle_server/puma.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+workers 5
+
+stdout_redirect "throttle_server/tmp/puma_stdout.log", "throttle_server/tmp/puma_stderr.log", true
+pidfile "throttle_server/tmp/puma.pid"
+
+preload_app!

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: speed_limiter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- yuhei mukoyama
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-11-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+- yuhei.mukoyama@seibii.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/lint.yml"
+- ".github/workflows/test.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE
+- README.md
+- README_image.jpg
+- Rakefile
+- bin/console
+- bin/setup
+- compose.yaml
+- lib/speed_limiter.rb
+- lib/speed_limiter/config.rb
+- lib/speed_limiter/version.rb
+- speed_limitter.gemspec
+- throttle_server/config.ru
+- throttle_server/puma.rb
+- throttle_server/tmp/.keep
+homepage: https://github.com/seibii/speed_limiter
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+  allowed_push_host: https://rubygems.org
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key:
+specification_version: 4
+summary: Limit the frequency of execution across multiple threads and processes
+test_files: []