ruby_rolling_rate_limiter 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7a4d27689f6f0095e817f2ddc39e345e7a0fdb09
+  data.tar.gz: 974182baa28ce3742660d2cc5996c40fbe19c749
+SHA512:
+  metadata.gz: 81fb38c9de11936c994ab72b05c41b9b6679250327b9e9e17499af7b06c4f3d78d5fb69dd54894139f510e73cada103a3374b0eb1800471b3e0d214f0fe3d7ca
+  data.tar.gz: 1cb014c36c572ce9022021c37adddb1d9500f85c0f0f76bf0e806ec07ca1a2e1bb7501a99859672ad975430b70336c100f417853877dc484e6b90d7f53290eb3

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/builds/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.2
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+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.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at karl@inventionlabs.com.au. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ruby_rolling_rate_limiter.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Karl Kloppenborg
+
+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,76 @@
+# RubyRollingRateLimiter
+
+Often Redis is used for rate limiting purposes.
+Usually the rate limit packages available count how many times something happens on a certain second or a certain minute. When the clock ticks to the next minute, rate limit counter is reset back to the zero. 
+
+This might be problematic if you are looking to limit rates where hits per integration time window is very low. 
+If you are looking to limit to the five hits per minute, in one time window you get just one hit and six in another, even though the average over two minutes is 3.5.
+
+This package allows you to implement a correct rolling window of threshold that's backed by ATOMIC storage in Redis meaning you can use this implementation across multiple machines and processes.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ruby_rolling_rate_limiter'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ruby_rolling_rate_limiter
+
+## Usage
+
+To use the rate limiting service use the following example:
+
+```ruby
+require 'ruby_rolling_rate_limiter'
+
+$redis = Redis.new
+#
+# Namespace is to group rate limiters, give it any name you want.
+# 60 = rolling_window in seconds.
+# 25 is the max calls in that window.
+# Optional arguments include min_distance (defaults to one second)
+# and also redis object can be passed.
+#
+rate_limiter = RubyRollingRateLimiter.new("MyAwesomeRateLimiter", 60, 25)
+
+# This is a unique identifier of the rate limit. It can be used to specify a rate limit per user for example. Give it any unique name.
+rate_limiter.set_call_identifier("karl@karlos.com")
+
+#Default call_size is 1 you can change this by using
+# rate_limiter.can_call_proceed?(call_size)
+#
+if rate_limiter.can_call_proceed?
+  # Process the task
+
+else
+  # Get the error
+  puts rate_limiter.current_error
+end
+```
+
+Tada!
+
+--Karl.
+## 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/logicsaas/ruby_rolling_rate_limiter. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

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 => :spec

data/bin/console

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

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

@@ -0,0 +1,96 @@
+require "ruby_rolling_rate_limiter/version"
+require "ruby_rolling_rate_limiter/errors"
+require "redis"
+require 'redis-lock'
+require "date"
+
+class RubyRollingRateLimiter
+  # Your code goes here...
+  attr_reader :current_error
+
+  def initialize(limiter_identifier, interval_in_seconds, max_calls_per_interval, min_distance_between_calls_in_seconds = 1, redis_connection = $redis)
+    @limiter_identifier = limiter_identifier
+    @interval_in_seconds = interval_in_seconds
+    @max_calls_per_interval = max_calls_per_interval
+    @min_distance_between_calls_in_seconds = min_distance_between_calls_in_seconds
+    @redis_connection = redis_connection
+    
+    #Check to ensure args are good.
+    validate_arguments
+
+    # Check Redis is there
+    check_redis_is_available
+
+  end
+
+
+  def set_call_identifier(id)
+    raise Errors::ArgumentInvalid, "The id must be a string or number with length greater than zero" unless id.length > 0
+    @id = id
+  end
+
+  def can_call_proceed?(call_size = 1)
+    if call_size > @max_calls_per_interval
+      @current_error = {code: 0, result: false, error: "Call size too big. Max calls in rolling window is: #{@max_calls_per_interval}. Increase your max_calls_per_interval or decrease your call_size", retry_in: 0}
+      return false
+    end
+    results = false
+    now = DateTime.now.strftime('%s%6N').to_i # Time since EPOC in microseconds.
+    interval = @interval_in_seconds * 1000 * 1000 # Inteval in microseconds
+
+    key = "#{self.class.name}-#{@limiter_identifier}-#{@id}"
+    
+    clear_before = now - interval
+    # Begin multi redis
+    @redis_connection.lock("#{key}-lock") do |lock|
+      @redis_connection.multi
+      @redis_connection.zremrangebyscore(key, 0, clear_before.to_s)
+      @redis_connection.zrange(key, 0, -1)
+      cur = @redis_connection.exec
+
+      if (cur[1].count <= @max_calls_per_interval) && ((cur[1].count+call_size) <= @max_calls_per_interval) && ((@min_distance_between_calls_in_seconds * 1000 * 1000) && (now - cur[1].last.to_i) > (@min_distance_between_calls_in_seconds * 1000 * 1000))
+        @redis_connection.multi
+        @redis_connection.zrange(key, 0, -1)
+        call_size.times do 
+          @redis_connection.zadd(key, now.to_s, now.to_s)
+        end
+        @redis_connection.expire(key, @interval_in_seconds)
+        results = @redis_connection.exec
+      else
+        results = [cur[1]]
+      end
+    end
+    if results
+      call_set = results[0]
+      too_many_in_interval = call_set.count >= @max_calls_per_interval
+      time_since_last_request = (@min_distance_between_calls_in_seconds * 1000 * 1000) && (now - call_set.last.to_i)
+
+      if too_many_in_interval
+        @current_error = {code: 1, result: false, error: "Too many requests", retry_in: (call_set.first.to_i - now + interval) / 1000 / 1000, retry_in_micro: (call_set.first.to_i - now + interval)}
+        return false
+      elsif (call_set.count+call_size) > @max_calls_per_interval
+        @current_error = {code: 2, result: false, error: "Call Size too big for available access, trying to make #{call_size} with only #{call_set.count} calls available in window", retry_in: (call_set.first.to_i - now + interval) / 1000 / 1000, retry_in_micro: (call_set.first.to_i - now + interval)}
+        return false
+      elsif time_since_last_request < (@min_distance_between_calls_in_seconds * 1000 * 1000)
+        @current_error = {code: 3, result: false, error: "Attempting to thrash faster than the minimal distance between calls", retry_in: @min_distance_between_calls_in_seconds, retry_in_micro: (@min_distance_between_calls_in_seconds * 1000 * 1000)}
+        return false
+      end
+      return true
+    end
+    return false
+  end
+
+  private
+  def validate_arguments
+    raise Errors::ArgumentInvalid, "limiter_identifier argument must be 1 or more characters long" unless @limiter_identifier.length > 0
+    raise Errors::ArgumentInvalid, "interval_in_seconds argument must be an integer, this is specified in seconds" unless @interval_in_seconds.is_a? Integer and @interval_in_seconds > 0
+    raise Errors::ArgumentInvalid, "max_calls_per_interval argument must be an integer, this is the amount of calls that can be made during the rolling window." unless @max_calls_per_interval.is_a? Integer and @max_calls_per_interval > 0
+    raise Errors::ArgumentInvalid, "min_distance_between_calls_in_seconds argument must be an integer, this is the buffer between each call during the rolling window" unless @min_distance_between_calls_in_seconds.is_a? Integer and @min_distance_between_calls_in_seconds > 0
+  end
+
+  #
+  # Checks to ensure redis is present and available,
+  def check_redis_is_available
+    raise Errors::RedisNotFound, "Unable to find redis connection, either declare a global $redis connection or add the connection to the last argument on #{self.class.name} initializer" unless @redis_connection.is_a? Object and @redis_connection.class == Redis
+  end
+end

data/lib/ruby_rolling_rate_limiter/errors.rb

@@ -0,0 +1,6 @@
+class RubyRollingRateLimiter
+  module Errors
+    class RedisNotFound < StandardError; end
+    class ArgumentInvalid < StandardError; end
+  end
+end

data/lib/ruby_rolling_rate_limiter/version.rb

@@ -0,0 +1,3 @@
+class RubyRollingRateLimiter
+  VERSION = "0.1.1"
+end

data/ruby_rolling_rate_limiter.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ruby_rolling_rate_limiter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ruby_rolling_rate_limiter"
+  spec.version       = RubyRollingRateLimiter::VERSION
+  spec.authors       = ["Karl Kloppenborg"]
+  spec.email         = ["karl@logicsaas.com"]
+
+  spec.summary       = %q{Ruby Rolling Rate Limiter provides a redis backed rolling window rate limiting service}
+  spec.description   = %q{Often Redis is used for rate limiting purposes. Usually the rate limit packages available count how many times something happens on a certain second or a certain minute. When the clock ticks to the next minute, rate limit counter is reset back to the zero. This might be problematic if you are looking to limit rates where hits per integration time window is very low. If you are looking to limit to the five hits per minute, in one time window you get just one hit and six in another, even though the average over two minutes is 3.5. This package allows you to implement a correct rolling window of threshold that's backed by ATOMIC storage in Redis meaning you can use this implementation across multiple machines and processes.}
+  spec.homepage      = "https://github.com/logicsaas/ruby_rolling_rate_limiter"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "bump"
+
+  spec.add_runtime_dependency "redis", "~> 3.2"
+  spec.add_runtime_dependency "mlanett-redis-lock"
+end

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: ruby_rolling_rate_limiter
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Karl Kloppenborg
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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: bump
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: mlanett-redis-lock
+  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: Often Redis is used for rate limiting purposes. Usually the rate limit
+  packages available count how many times something happens on a certain second or
+  a certain minute. When the clock ticks to the next minute, rate limit counter is
+  reset back to the zero. This might be problematic if you are looking to limit rates
+  where hits per integration time window is very low. If you are looking to limit
+  to the five hits per minute, in one time window you get just one hit and six in
+  another, even though the average over two minutes is 3.5. This package allows you
+  to implement a correct rolling window of threshold that's backed by ATOMIC storage
+  in Redis meaning you can use this implementation across multiple machines and processes.
+email:
+- karl@logicsaas.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/ruby_rolling_rate_limiter.rb
+- lib/ruby_rolling_rate_limiter/errors.rb
+- lib/ruby_rolling_rate_limiter/version.rb
+- ruby_rolling_rate_limiter.gemspec
+homepage: https://github.com/logicsaas/ruby_rolling_rate_limiter
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.4
+signing_key: 
+specification_version: 4
+summary: Ruby Rolling Rate Limiter provides a redis backed rolling window rate limiting
+  service
+test_files: []