rlimiter 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9302bec359d72e7e409dadb2f2c90ddf1eeb67dfc89010b8eccd49ee6fac00e0
+  data.tar.gz: ddbb3f185d724c7c2c3de52da79e867795ea3d52240a05439837ffab30cb43ac
+SHA512:
+  metadata.gz: 32fcab4227ff1437bf11e6b3d3ed421c6ac53aa86d6bbfef2ab562935575d78fda25f5b21f22e8b5a2ae231345fcb868bb2993d54c37ef6ff246b16805ed7348
+  data.tar.gz: 5c32ce88d853cbf5fad618ba872b3904de1423afb2418e27d722159238ab9e986f4a391df49cbf0558de4c670a17694baa853c4d7bbcf4bcc2dd401e9b993a6e

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.16.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 TODO: Write your email address. 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 [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+gemspec
+
+gem 'redis'

data/Gemfile.lock

@@ -0,0 +1,38 @@
+PATH
+  remote: .
+  specs:
+    rlimiter (0.1.8)
+      redis (~> 4.0.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    redis (4.0.2)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  redis
+  rlimiter!
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 TODO: Write your name
+
+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,124 @@
+# Rlimiter
+
+Rlimiter is a simple rate limiting client for Ruby (not limited to RoR!).
+
+The fundamental idea behind this client is to limit the number of hits of any code within the application. Hence it is not
+only limited to API rate limiting, instead can be used in all sorts of scenarios that require circumstantial throttling of throughput.
+
+It currently uses Redis as the main storage client for storing the necessary keys, provided it's fast IO operations and ubiquity in web applications. It is written
+in a manner to effortlessly extend and implement custom storage clients as required.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rlimiter'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rlimiter
+
+## Usage
+
+Rlimiter has to be initialized in application.rb if you are using Rails, or any other bootstrap/initialization file in your application by doing the following:   
+```ruby
+
+CLIENT = 'redis' # Recommended and the only client for now
+HOST = 'rds.host.foobaz' # Redis server hostname, enter 'localhost' if the redis server is on the same machine
+PORT = 6379 # Default port, could be left empty
+
+# Initializes the Rlimiter static class for usage  
+Rlimiter.init(client: CLIENT, host: HOST, port: PORT)
+```
+
+There is one common way to use Rlimiter (which suffices most of the use cases)
+
+```ruby
+
+  LIMIT_COUNT = 100 # Max number of hits allowed
+  
+  LIMIT_DURATION = 60 # Duration in which the max hits are applicable (in seconds)
+  # After the aforementioned duration has elapsed, hit counter is reset to 0. 
+  
+  LIMIT_KEY = 'send_mobile_otp_limit' # Unique key for each operation that has to be rate limited
+  
+  
+  # Implementation
+  
+  return send_mobile_otp if Rlimiter.limit(LIMIT_KEY, LIMIT_COUNT, LIMIT_DURATION)
+  return limit_exceeded_message
+  
+  # :send_mobile_otp is the function that has to be rate limited, Rlimiter.limit call increments the hit count and 
+  # returns true if the operation's limit has not been exceeded, otherwise returns false. 
+```
+
+A more complicated approach could also be implemented :
+
+```ruby
+    
+    @phone_number = '2947126943'
+    @limit_key = generate_limit_key
+    @limit_count = fetch_limit_count
+    limit_breached = Rlimiter.limit(@limit_key, @limit_count, DEFAULT_LIMIT_DURATION)
+    unless limit_breached
+      {
+        :status_code => 200,
+        :otp_dispatch_status => send_mobile_otp,
+        :requests_left => @limit_count - Rlimiter.current_count(@limit_key)
+      }
+    else
+      {
+        :status_code => 429,
+        :otp_dispatch_status => nil,
+        :requests_left => 0,
+        :next_request_in => Rlimiter.next_in(@limit_key, DEFAULT_LIMIT_DURATION)
+      }
+    end
+    
+    # ..........
+    
+    def generate_limit_key
+      "#{LIMIT_KEY_PREFIX}.#{@phone_number}"
+    end
+    
+    def fetch_limit_count
+      return USA_LIMIT_COUNT if number_from_usa?(@phone_number)
+      return INDIA_LIMIT_COUNT if number_from_india?(@phone_number)
+      DEFAULT_LIMIT_COUNT  
+    end
+    
+    # ..........
+    
+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).
+
+### TODOs:
+
+1. Write specs for 100% code coverage.
+2. Add benchmarks.
+3. Integrate Travis. 
+4. Push to rubygems.org.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sdpatro/rlimiter. 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](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Rlimiter project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/sdpatro/rlimiter/blob/master/CODE_OF_CONDUCT.md).

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 "rlimiter"
+
+# 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/rlimiter/client.rb

@@ -0,0 +1,18 @@
+# Inherit the below class for custom implementations of any storage clients.
+module Rlimiter
+  class Client
+
+    def limit(key, count, duration)
+      # Stub
+    end
+
+    def next_in(key, duration)
+      # Stub
+    end
+
+    def current_count
+      # Stub
+    end
+
+  end
+end

data/lib/rlimiter/invalid_client_error.rb

@@ -0,0 +1,4 @@
+module Rlimiter
+  class InvalidClientError < RuntimeError
+  end
+end

data/lib/rlimiter/redis_client.rb

@@ -0,0 +1,101 @@
+require 'redis'
+
+module Rlimiter
+
+  # Redis concrete class of abstract Client
+  # Maintains two redis keys, one for number of hits and other for the start of the time window.
+  # Increases the hit count every time :limit is called, if hit count exceeds the limit count then it is checked whether
+  # if the previous time window is active or not, on the basis of which true/false is returned.
+  class RedisClient < Client
+
+    # Name of key of the hit count number, stores an integer.
+    RATE_COUNT = 'rate_count'.freeze
+
+    # Name of key of the start time of the time window, stores the UTC epoch time.
+    START_TIME = 'start_time'.freeze
+
+    # Initializes and returns a Redis object.
+    #
+    # Requires params hash i.e.
+    # {
+    #   :host => [String] (The hostname of the Redis server)
+    #   :port => [String] (Numeric port number)
+    # }
+    #
+    # For further documentation refer to https://github.com/redis/redis-rb
+    #
+    # Any errors thrown are generated by the redis-rb client.
+    #
+    # @param [Hash] params
+    # @return [Redis]
+    #
+    def initialize(params)
+      @redis = Redis.new(params.deep_symbolize_keys)
+    end
+
+    # Registers a hit corresponding to the key specified, requires the max hit count and the duration to be passed.
+    #
+    # @param [String] key : Should be unique for one operation, can be added for multiple operations if a single rate
+    #                       limiter is to be used for those operations.
+    # @param [Integer] count : Max rate limit count
+    # @param [Integer] duration : Duration of the time window.
+    #
+    # Count and duration params could change in each call and the limit breach value is returned corresponding to that.
+    # Ideally this method should be called with each param a constant on the application level.
+    #
+    # Returns false if the limit has been breached.
+    # Returns true if limit has not been breached. (duh)
+    def limit(key, count, duration)
+      @key = key.to_s
+      @duration = duration.to_i
+
+      # :incr_count increases the hit count and simultaneously checks for breach
+      if incr_count > count
+
+        # :elapsed is the time window start Redis cache
+        # If the time elapsed is less than window duration, the limit has been breached for the current window (return false).
+        return false if @duration - elapsed > 0
+
+        # Else reset the hit count to zero and window start time.
+        reset
+      end
+      true
+    end
+
+    # Gets the hit count for the key passed.
+    # @param [Integer] key
+    def current_count(key)
+      @redis.hget(key, RATE_COUNT).to_i
+    end
+
+    # Gets the ETA for the next window start only if the limit has been breached.
+    # Returns 0 if the limit has not been breached.
+    # @param [String] key
+    # @param [Integer] count
+    # @param [Integer] duration
+    def next_in(key, count, duration)
+      @key = key
+      @duration = duration
+      return 0 if current_count(key) <= count
+      @duration - elapsed
+    end
+
+    private
+
+    def reset
+      @redis.hmset(@key, RATE_COUNT, 1, START_TIME, Time.now.getutc.to_f * 1000)
+    end
+
+    def incr_count
+      @redis.hincrby(@key, RATE_COUNT, 1)
+    end
+
+    def elapsed
+      ((Time.now.getutc.to_f * 1000 - start_time) / 1000).to_i
+    end
+
+    def start_time
+      @redis.hget(@key, START_TIME).to_i
+    end
+  end
+end

data/lib/rlimiter/version.rb

@@ -0,0 +1,3 @@
+module Rlimiter
+  VERSION = '1.0.0'.freeze
+end

data/lib/rlimiter.rb

@@ -0,0 +1,49 @@
+require 'rlimiter/version'
+
+# It is important that the files are loaded in the order specified below because of inheritance dependencies.
+# TODO: Figure out a better way to load
+require_files = %w[/rlimiter/client.rb /rlimiter/invalid_client_error.rb /rlimiter/version.rb /rlimiter/redis_client.rb]
+require_files.each do |file|
+  Dir.glob(File.dirname(File.absolute_path(__FILE__)) + file, &method(:require))
+end
+
+# Module which is single-instantiated in the application via :init.
+module Rlimiterclass InvalidClientError < RuntimeError
+  class << self
+
+    # At the moment only redis client is supported.
+    CLIENTS = %w[redis].freeze
+    attr_accessor :client
+
+    # One time initializes the client which is to be used throughout the application.
+    # The value of params variable will change depending on the storage client to be initialized.
+    # @param [Hash] params
+    # @return [Rlimiter::Client]
+    def init(params)
+      case params[:client]
+      when 'redis'
+        @client = RedisClient.new(params)
+      else
+        raise InvalidClientError, "Valid clients are #{CLIENTS.join(',')}"
+      end
+    end
+
+    # Note : Params for the below methods are kept arbitrary for free implementation and are specific to a single client,
+    # after usage feedback it will be refactored to pertain to a single signature.
+
+    # Register a hit to the client.
+    def limit(*params)
+      client.limit(*params)
+    end
+
+    # Returns when the next hit will be accepted
+    def next_in(*params)
+      client.next_in(*params)
+    end
+
+    # Returns the current hit count.
+    def current_count(*params)
+      client.current_count(*params)
+    end
+  end
+end

data/rlimiter.gemspec

@@ -0,0 +1,37 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rlimiter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rlimiter'
+  spec.version       = Rlimiter::VERSION
+  spec.authors       = ['Sidharth Patro']
+  spec.email         = ['sidharth.patro@outlook.com']
+
+  spec.summary       = 'Rate limiting library for Ruby'
+  spec.homepage      = 'https://github.com/sdpatro/rlimiter'
+  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['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  # 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_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_runtime_dependency 'redis', '~> 4.0.2'
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: rlimiter
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Sidharth Patro
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-09-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: 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: 4.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.2
+description: 
+email:
+- sidharth.patro@outlook.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rlimiter.rb
+- lib/rlimiter/client.rb
+- lib/rlimiter/invalid_client_error.rb
+- lib/rlimiter/redis_client.rb
+- lib/rlimiter/version.rb
+- rlimiter.gemspec
+homepage: https://github.com/sdpatro/rlimiter
+licenses:
+- MIT
+metadata:
+  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: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: Rate limiting library for Ruby
+test_files: []