ratelimitcop 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e930466da21f605e9a87bd1a1303dca72ade4ae093c500e3fa5bc38c55a558cd
+  data.tar.gz: 50cc68ed62dd77901fe14148ba8762a69c4becfe0b51e8050dde3126df948511
+SHA512:
+  metadata.gz: e51c074ca0b1d59621a97956a4649b86e5421e2615a6b59613e6908346bcbe1ba894d6079298897778deaef296d218d8bbe25b635f6431ea99b344beabfc2987
+  data.tar.gz: 3c6d0c72134ec06c1df11d4171c7329381f66115d747a15fc0a8688247cc13a3fef21942f557b13e11cc71afa94c3efbb2d8619e80c1282c7c609c3f9e1f66dc

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# CHANGELOG
+
+# v1.0.0
+
+ * Initial release of a redis backed rate limiter. Inspired by @ejfinneran's [ratelimit gem](https://github.com/ejfinneran/ratelimit) and @ncr's [alternative limiter suggestion](https://github.com/ejfinneran/ratelimit/issues/38) - [@mathu97](https://github.com/mathu97).

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 mathusans52@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,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,33 @@
+PATH
+  remote: .
+  specs:
+    ratelimitcop (1.0.0)
+      redis (~> 4.4)
+      redis-namespace (~> 1.8.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    fakeredis (0.8.0)
+      redis (~> 4.1)
+    minitest (5.14.4)
+    mocha (1.13.0)
+    rake (12.3.3)
+    redis (4.4.0)
+    redis-namespace (1.8.1)
+      redis (>= 3.0.4)
+    timecop (0.9.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  fakeredis (~> 0.8.0)
+  minitest (~> 5.0)
+  mocha (~> 1.13)
+  rake (~> 12.0)
+  ratelimitcop!
+  timecop (~> 0.9.4)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Mathusan Selvarajah
+
+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,41 @@
+# Ratelimitcop
+
+Ratelimitcop is a redis backed rate limiter. Appropriate for use cases where in-memory rate limiting would not work (i.e rate limiting across multiple processes, servers, apps, etc).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ratelimitcop'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install ratelimitcop
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+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/koffeefinance/ratelimitcop. 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/koffeefinance/ratelimitcop/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 Ratelimitcop project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/koffeefinance/ratelimitcop/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 'ratelimitcop'
+
+# 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/ratelimitcop/version.rb

@@ -0,0 +1,3 @@
+class Ratelimitcop
+  VERSION = '1.0.0'.freeze
+end

data/lib/ratelimitcop.rb

@@ -0,0 +1,63 @@
+require 'ratelimitcop/version'
+require 'redis'
+require 'redis-namespace'
+
+class Ratelimitcop
+  attr_reader :name, :threshold, :interval, :time_span, :bucket_span
+
+  def initialize(name:, threshold:, interval:, redis_connection: {}, time_span: 600, bucket_span: 5)
+    @name = name
+    @threshold = threshold
+    @interval = interval
+    @time_span = time_span
+    @bucket_span = bucket_span
+
+    raise ArgumentError if @interval > @time_span || @interval < @bucket_span
+
+    @redis ||= Redis::Namespace.new(:limiter, redis: Redis.new(redis_connection))
+
+    @all_buckets_count = (@time_span / @bucket_span).floor
+    @sliding_window_buckets_count = (@interval.to_f / @bucket_span).floor
+  end
+
+  def add(count: 1)
+    key = [@name, bucket_index].join(':')
+
+    @redis.multi do
+      @redis.incrby(key, count)
+      @redis.expire(key, @interval)
+    end
+
+    nil
+  end
+
+  def count
+    current_bucket_index = bucket_index
+
+    bucket_indices = @sliding_window_buckets_count.times.map do |i|
+      (current_bucket_index - i) % @all_buckets_count
+    end
+
+    @redis.multi do
+      bucket_indices.map do |i|
+        key = [@name, i].join(':')
+        @redis.get(key)
+      end
+    end.map(&:to_i).sum
+  end
+
+  def exec_within_threshold
+    sleep @bucket_span while exceeded?
+    yield
+  end
+
+  def exceeded?
+    count >= @threshold
+  end
+
+  private
+
+  def bucket_index
+    ((Time.now.to_i % @all_buckets_count) / @bucket_span).floor
+  end
+end

data/ratelimitcop.gemspec

@@ -0,0 +1,39 @@
+require_relative 'lib/ratelimitcop/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ratelimitcop'
+  spec.version       = Ratelimitcop::VERSION
+  spec.authors       = ['Mathusan Selvarajah']
+  spec.email         = ['mathusans52@gmail.com']
+
+  spec.summary       = 'A redis backed rate limiter.'
+  spec.description   = 'A redis backed rate limiter. Appropriate for use cases where in-memory rate limiting \
+                          would not work (i.e rate limiting across multiple processes, servers, apps, etc).'
+  spec.homepage      = 'https://github.com/koffeefinance/ratelimitcop'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.7.0')
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/koffeefinance/ratelimitcop'
+  spec.metadata['changelog_uri'] = 'https://github.com/koffeefinance/ratelimitcop/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(__dir__)) 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']
+
+  spec.add_dependency             'redis', '~> 4.4'
+  spec.add_dependency             'redis-namespace', '~> 1.8.1'
+
+  spec.add_development_dependency 'fakeredis', '~> 0.8.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'mocha', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'timecop', '~> 0.9.4'
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: ratelimitcop
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Mathusan Selvarajah
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-09-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+- !ruby/object:Gem::Dependency
+  name: redis-namespace
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+- !ruby/object:Gem::Dependency
+  name: fakeredis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.4
+description: |-
+  A redis backed rate limiter. Appropriate for use cases where in-memory rate limiting \
+                            would not work (i.e rate limiting across multiple processes, servers, apps, etc).
+email:
+- mathusans52@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/ratelimitcop.rb
+- lib/ratelimitcop/version.rb
+- ratelimitcop.gemspec
+homepage: https://github.com/koffeefinance/ratelimitcop
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/koffeefinance/ratelimitcop
+  source_code_uri: https://github.com/koffeefinance/ratelimitcop
+  changelog_uri: https://github.com/koffeefinance/ratelimitcop/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.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: A redis backed rate limiter.
+test_files: []