with_rate_limit 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3a52da5e1624b2f3b36e1cdc60c251f812d755724a9de91db702a0fcf02a2662
+  data.tar.gz: 58a5e04f83e57074c6b8c31effa0ef165522fdc07e61d0fb770e5f68a4e65ebd
+SHA512:
+  metadata.gz: f48ab435664e64f9626f935b9ba55741a397674e3e4470be19e80c2c32053fafd9100be5d4e6f6ca642f53f84120e419322041d8c58631105ac1baa4b9bf6af8
+  data.tar.gz: 0b51e0119bf214ecd21801d311c0fd1bd086bef591121cbbd7bb95fcabc4177773dda045b2d9bfa442c46ef72315c28784734196fd69e58f3fd6416a478728f6

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea/

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.8
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at aterletskiy@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in with_rate_limit.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "minitest", "~> 5.0"
+gem "mocha", "~> 1.11.2"
+gem "redis", "~> 4.0.2"

data/Gemfile.lock

@@ -0,0 +1,25 @@
+PATH
+  remote: .
+  specs:
+    with_rate_limit (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.14.2)
+    mocha (1.11.2)
+    rake (12.3.3)
+    redis (4.0.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  mocha (~> 1.11.2)
+  rake (~> 12.0)
+  redis (~> 4.0.2)
+  with_rate_limit!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Aleksandr Terletskiy
+
+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,103 @@
+# with-rate-limit
+
+`with-rate-limit` is a simple, lightweight and robust rate limiting tool. It supports in-memory or Redis
+as a store for distributed operations. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'with_rate_limit'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install with_rate_limit
+
+## Basic Usage
+
+```ruby
+interval = 1 # interval in seconds
+rate_limit = 5 # number of operations within given interval
+options = {
+  cache_key: "daily_requests", # default: "[limit]-operations-per-[interval]"
+  strategy: WithRateLimit::Strategy::Sleep, # default strategy, see #strategies
+  cache: WithRateLimit::Cache::Memory, # default cache mechanism, see #cache-mechanism
+}
+with_rate_limit interval, rate_limit, options do
+  # do something here
+  # operation performed here will be rated limited 
+  # with `Sleep` strategy, if rate limit is hit, `with_rate_limit` will wait for the remainder of the interval.
+end 
+```
+
+### Multiple rate limits
+If you need to set up multiple rate limits, i.e. 5000 requests/day **and** 5 requests/sec, you can nest `with_rate_limit` calls.
+
+```ruby
+with_rate_limit 1.day.to_i, 5000 do
+    with_rate_limit 1, 5 do
+        # do something here
+    end
+end
+```
+
+### Strategies
+**WithRateLimit::Strategy::Sleep** 
+Simply sleeps until the beginning of the next interval if rate limit is hit. Avoid `Sleep` with 
+large intervals with limit that are likely to exceeded early as it may block application requests. 
+
+**WithRateLimit::Strategy::RaiseError**
+Raises an `WithRateLimit::LimitExceededError` with the number of second to wait until next interval.
+
+```ruby
+with_rate_limit 1, 5 do
+    # do something
+rescue WithRateLimit::LimitExceededError => e  
+    # reschedule this task for `e.timeout` seconds from now. 
+end
+```
+
+Different strategies can be used in nested `with_rate_limit` calls.
+
+### Cache 
+
+**WithRateLimit::Cache::Memory**
+Stores cache data for `cache_key` in memory.  
+
+**WithRateLimit::Cache::Redis**
+Stores cache data for `cache_key` in Redis so it can be shared in distributed systems.  Redis can be configured through
+`WithRateLimit::Cache::Redis.configure` method.
+
+```ruby
+redis_cache = WithRateLimit::Cache::Redis.configure { |conf| conf[:redis_options] = {url: 'redis://localhost:6379'}}
+with_rate_limit 1, 5, {cache: redis_cache} do
+    # do something
+end
+```
+
+Different cache mechanisms can be used in nested `with_rate_limit` calls too.
+
+## Extending
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/aterletskiy/with_rate_limit. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/with_rate_limit/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the WithRateLimit project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/with_rate_limit/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "with_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/with_rate_limit.rb

@@ -0,0 +1,65 @@
+require "with_rate_limit/version"
+require "with_rate_limit/limit_exceeded_error"
+require "with_rate_limit/strategy"
+require "with_rate_limit/strategy/raise_error"
+require "with_rate_limit/strategy/sleep"
+require "with_rate_limit/cache"
+require "with_rate_limit/cache/memory"
+require "with_rate_limit/cache/redis"
+require "date"
+
+module WithRateLimit
+  def with_rate_limit(interval, limit, options = {}, &block)
+    options = default_options(interval, limit).merge(options.transform_keys &:to_sym)
+    validate_options(options)
+    
+    strategy = options[:strategy]
+    cache_key = options[:cache_key]
+    cache = options[:cache]
+    cache_data = cache.get(cache_key).transform_keys(&:to_sym)
+    
+    last_interval_started_at = cache_data[:last_interval_started_at] || current_timestamp
+    operations_count = cache_data[:operations_count].to_i
+    timestamp = current_timestamp
+    count_reset_delta = timestamp - last_interval_started_at
+    interval = interval * 1000
+  
+    if (count_reset_delta < interval) && operations_count >= limit
+      strategy.execute((interval - count_reset_delta) / 1000.0)
+      return with_rate_limit(interval / 1000, limit, options, &block)
+    elsif count_reset_delta > interval
+      cache.set(cache_key, {last_interval_started_at: timestamp, operations_count: 1})
+    else
+      cache.set(cache_key, {last_interval_started_at: timestamp, operations_count: operations_count + 1})
+    end
+  
+    begin
+      yield
+    rescue StandardError => e
+      raise e
+    end
+  end
+  
+  private
+  
+  def current_timestamp
+    DateTime.now.strftime('%Q').to_i
+  end
+  
+  def default_options(interval, limit)
+    {
+      cache_key: "#{limit}-operations-per-#{interval}",
+      strategy: WithRateLimit::Strategy::Sleep,
+      cache: WithRateLimit::Cache::Memory
+    }
+  end
+  
+  def redis_client
+    @redis_client ||= Redis.new(url: ENV['REDIS_HOST'])
+  end
+  
+  def validate_options(options)
+    raise "Invalid 'cache' option value.  Must be a subclass of WithRateLimit::Cache" unless options[:cache] < WithRateLimit::Cache
+    raise "Invalid 'strategy' option value.  Must be a subclass of WithRateLimit::Strategy" unless options[:strategy] < WithRateLimit::Strategy
+  end
+end

data/lib/with_rate_limit/cache.rb

@@ -0,0 +1,11 @@
+module WithRateLimit
+  class Cache
+    def set(key, values)
+      raise "Method 'set' must be implemented by a subclass"
+    end
+    
+    def get(key)
+      raise "Method 'get' must be implemented by a subclass"
+    end
+  end
+end

data/lib/with_rate_limit/cache/memory.rb

@@ -0,0 +1,15 @@
+module WithRateLimit
+  class Cache::Memory < Cache
+    def self.set(key, values)
+      cache[key] = values
+    end
+    
+    def self.get(key)
+      cache[key] || {}
+    end
+    
+    def self.cache
+      @cache ||= {}
+    end
+  end
+end

data/lib/with_rate_limit/cache/redis.rb

@@ -0,0 +1,37 @@
+require "redis"
+
+module WithRateLimit
+  class Cache::Redis < Cache
+    def self.set(key, values)
+      cache_data = cache
+      cache_data[key] ||= {}
+      cache_data[key].merge!(values)
+      
+      redis_client.set('with-rate-limit', JSON(cache_data))
+    end
+    
+    def self.get(key)
+      cache[key] || {}
+    end
+    
+    def self.configure
+      yield configuration
+      return self
+    end
+
+    private
+    
+    def self.configuration
+      @redis_client = nil
+      @configuration ||= {}
+    end
+
+    def self.cache
+      redis_client.exists('with-rate-limit') ? JSON(redis_client.get('with-rate-limit')) : {}
+    end
+    
+    def self.redis_client
+      @redis_client ||= ::Redis.new(configuration[:redis_options])
+    end
+  end
+end

data/lib/with_rate_limit/limit_exceeded_error.rb

@@ -0,0 +1,11 @@
+module WithRateLimit
+  class LimitExceededError < StandardError
+    attr_accessor :timeout
+    
+    def initialize(timeout)
+      @timeout = timeout
+      
+      super("Rate limit exceeded, #{timeout} second until next execution.")
+    end
+  end
+end

data/lib/with_rate_limit/strategy.rb

@@ -0,0 +1,7 @@
+module WithRateLimit
+  class Strategy
+    def self.execute(timeout)
+      raise "Method 'execute' must be implemented by a subclass"
+    end
+  end
+end

data/lib/with_rate_limit/strategy/raise_error.rb

@@ -0,0 +1,7 @@
+module WithRateLimit
+  class Strategy::RaiseError < Strategy
+    def self.execute(timeout)
+      raise WithRateLimit::LimitExceededError.new(timeout)
+    end
+  end
+end

data/lib/with_rate_limit/strategy/sleep.rb

@@ -0,0 +1,7 @@
+module WithRateLimit
+  class Strategy::Sleep < Strategy
+    def self.execute(timeout)
+      sleep timeout
+    end
+  end
+end

data/lib/with_rate_limit/version.rb

@@ -0,0 +1,3 @@
+module WithRateLimit
+  VERSION = "0.1.0"
+end

data/with_rate_limit.gemspec

@@ -0,0 +1,29 @@
+require_relative 'lib/with_rate_limit/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "with_rate_limit"
+  spec.version       = WithRateLimit::VERSION
+  spec.authors       = ["Aleksandr Terletskiy"]
+  spec.email         = ["aterletskiy@gmail.com"]
+
+  spec.summary       = %q{Rate limits operations that are passed in to block}
+  spec.description   = %q{Allows operations that are passed into `with_rate_limit` block to be rate limited}
+  spec.homepage      = "https://github.com/aterletskiy/with_rate_limit"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  # spec.metadata["allowed_push_host"] = "http://mygemserver.com"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/aterletskiy/with_rate_limit"
+  spec.metadata["changelog_uri"] = "https://github.com/aterletskiy/with_rate_limit/CHANGELOG.md"
+
+  # 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        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: with_rate_limit
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Aleksandr Terletskiy
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-09-12 00:00:00.000000000 Z
+dependencies: []
+description: Allows operations that are passed into `with_rate_limit` block to be
+  rate limited
+email:
+- aterletskiy@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/with_rate_limit.rb
+- lib/with_rate_limit/cache.rb
+- lib/with_rate_limit/cache/memory.rb
+- lib/with_rate_limit/cache/redis.rb
+- lib/with_rate_limit/limit_exceeded_error.rb
+- lib/with_rate_limit/strategy.rb
+- lib/with_rate_limit/strategy/raise_error.rb
+- lib/with_rate_limit/strategy/sleep.rb
+- lib/with_rate_limit/version.rb
+- with_rate_limit.gemspec
+homepage: https://github.com/aterletskiy/with_rate_limit
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/aterletskiy/with_rate_limit
+  source_code_uri: https://github.com/aterletskiy/with_rate_limit
+  changelog_uri: https://github.com/aterletskiy/with_rate_limit/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: Rate limits operations that are passed in to block
+test_files: []