redis_rate_limit 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4bb561742b30caf0fde6c6483febf005b1977d81
+  data.tar.gz: 0616bfb579d95deaf434aa1f845d4a6de5e729c4
+SHA512:
+  metadata.gz: e7706879fcdc0731ba444d8420a9b19d157cf87eda6b3521b558ea09b7314bb72d42fc051a19e90636ca47d94809067f00e5b98d6e4c649e829d8df1b2a02675
+  data.tar.gz: f0865113f790f8f519e62c70749af4e7526b6c062e7b139f8a358d18bb6ac27e97f54c81fc1cd152d3150a9025c9413b6318952ee72dbca0e5ecca4c8fc7e1ce

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--drb
+--format Fuubar
+--color

data/.simplecov

@@ -0,0 +1,3 @@
+SimpleCov.start do
+  add_group "lib", "lib"
+end

data/.travis.yml

@@ -0,0 +1,6 @@
+sudo: false
+script: "bundle exec rspec"
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.13.7

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Hacene Boubguel
+
+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 @@
+# RedisRateLimit
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/redis_rate_limit`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'redis_rate_limit'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install redis_rate_limit
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/redis_rate_limit.
+
+
+## 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,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 "redis_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

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/redis_rate_limit/daily.rb

@@ -0,0 +1,16 @@
+module RedisRateLimit
+  class Daily < Period
+
+    # Create an instance of Daily
+    # @param [String] name A unique namespace that identify the subject to track : users, emails, ip ...
+    # @param [Hash] options Options hash
+    # @option options [Integer] :limit (86_400) How many transactions to perform during the defined interval
+    # @option options [Redis]   :redis (nil) Redis client
+    # @return [Daily] Daily instance
+    def initialize(name, options = {})
+      super(name, options.merge({format: '%Y-%m-%d', interval: 86_400}))
+    end
+
+  end
+end
+

data/lib/redis_rate_limit/hourly.rb

@@ -0,0 +1,16 @@
+module RedisRateLimit
+  class Hourly < Period
+
+    # Create an instance of Hourly
+    # @param [String] name A unique namespace that identify the subject to track : users, emails, ip ...
+    # @param [Hash] options Options hash
+    # @option options [Integer] :limit (3600) How many transactions to perform during the defined interval
+    # @option options [Redis]   :redis (nil) Redis client
+    # @return [Hourly] Hourly instance
+    def initialize(name, options = {})
+      super(name, options.merge({format: '%Y-%m-%dT%H', interval: 3600}))
+    end
+
+  end
+end
+

data/lib/redis_rate_limit/minute.rb

@@ -0,0 +1,16 @@
+module RedisRateLimit
+  class Minute < Period
+
+    # Create an instance of Minute
+    # @param [String] name A unique namespace that identify the subject to track : users, emails, ip ...
+    # @param [Hash] options Options hash
+    # @option options [Integer] :limit (60) How many transactions to perform during the defined interval
+    # @option options [Redis]   :redis (nil) Redis client
+    # @return [Minute] Minute instance
+    def initialize(name, options = {})
+      super(name, options.merge({format: '%Y-%m-%dT%H:%M', interval: 60}))
+    end
+
+  end
+end
+

data/lib/redis_rate_limit/period.rb

@@ -0,0 +1,84 @@
+module RedisRateLimit
+  class Period
+
+    # Create an instance of Period.
+    # @param [String] name A unique namespace that identify the subject to track : users, emails, ip ...
+    # @param [Hash] options Options hash
+    # @option options [String]  :format ('%Y-%m-%dT%H:%M') Formated date that represents the time span to track
+    # @option options [Integer] :interval (60) The duration in seconds before the next reset
+    # @option options [Integer] :limit (60) How many transactions to perform during the defined interval
+    # @option options [Redis]   :redis (nil) Redis client
+    # @return [Period] Period instance
+    def initialize(name, options = {})
+      @ratelimit_name = "rate_limit:#{name}"
+      @format = options[:format] || '%Y-%m-%dT%H:%M'
+      @interval = options[:interval] || 60
+      @limit = options[:limit] || @interval
+      @redis = options[:redis]
+    end
+
+    # Get an access if the rate limit is not exeeded
+    # @param [String] client The value of the subject to track : 1234, foo@bar.com, 127.0.0.1
+    # @return [Hash] Access ticket
+    def get_access(client)
+      current_time = Time.now
+      range = current_time.strftime(@format)
+      current_counter = counter(client)
+      reset = current_time.to_i + @interval - (current_time.to_i % @interval)
+      unless current_counter < @limit
+        return {
+          "pass" => false,
+          "RateLimit" => {"X-RateLimit-Limit" => @limit, "X-RateLimit-Remaining" => 0, "X-RateLimit-Reset" => reset}
+        }
+      end
+      counter = @redis.hincrby(key(client), range, 1)
+      remaining = @limit - counter
+      return {
+        "pass" => true,
+        "RateLimit" => {"X-RateLimit-Limit" => @limit, "X-RateLimit-Remaining" => remaining, "X-RateLimit-Reset" => reset}
+      }
+    end
+
+    # Get an access if the rate limit is not exeeded or wait few seconds
+    # @param [String] client The value of the subject to track : 1234, foo@bar.com, 127.0.0.1
+    # @return [Hash] Access ticket
+    def get_access_or_wait(client)
+      result = nil
+      result = get_access(client)
+      return result if result["pass"]
+      time_to_sleep = result["RateLimit"]["X-RateLimit-Reset"] - Time.now.to_i
+      sleep(time_to_sleep)
+      get_access(client)
+    end
+
+    # Get the access count for a given client within the current time range
+    # @param [String] client The value of the subject to track : 1234, foo@bar.com, 127.0.0.1
+    # @return [Integer] access count
+    def counter(client)
+      range = Time.now.strftime(@format)
+      @redis.hget(key(client), range).to_i
+    end
+
+    # Get access history for a given client
+    # @param [String] client The value of the subject to track : 1234, foo@bar.com, 127.0.0.1
+    # @return [Array] Array of hash. key : time range, value : access counter
+    def history(client)
+      @redis.hgetall(key(client))
+    end
+
+    # Clean access history
+    # @param [String] client The value of the subject to track : 1234, foo@bar.com, 127.0.0.1
+    # @return [Integer] access count
+    def clear(client)
+      @redis.expire(key(client), 0)
+    end
+
+    private
+
+    def key(client)
+      "#{@ratelimit_name}:#{client}"
+    end
+
+  end
+end
+

data/lib/redis_rate_limit/version.rb

@@ -0,0 +1,3 @@
+module RedisRateLimit
+  VERSION = "1.0.0"
+end

data/lib/redis_rate_limit.rb

@@ -0,0 +1,10 @@
+require "redis"
+require "redis_rate_limit/version"
+require "redis_rate_limit/period"
+require "redis_rate_limit/daily"
+require "redis_rate_limit/hourly"
+require "redis_rate_limit/minute"
+
+module RedisRateLimit
+  # Your code goes here...
+end

data/redis_rate_limit.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'redis_rate_limit/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "redis_rate_limit"
+  spec.version       = RedisRateLimit::VERSION
+  spec.authors       = ["neceha-bgl"]
+  spec.email         = ["neceha.bgl@gmail.com"]
+
+  spec.summary       = %q{Rate Limit controler based on Redis}
+  spec.description   = %q{Controle the number of requests permitted to make per minute/hour/day}
+  spec.homepage      = "https://github.com/neceha-bgl/redis_rate_limit"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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"
+  spec.add_development_dependency "fakeredis",  "~> 0.3.0"
+  spec.add_development_dependency "activesupport"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "fuubar"
+  spec.add_development_dependency "timecop"
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "yard"
+end

metadata

@@ -0,0 +1,216 @@
+--- !ruby/object:Gem::Specification
+name: redis_rate_limit
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- neceha-bgl
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-01-06 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'
+- !ruby/object:Gem::Dependency
+  name: fakeredis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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: pry
+  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: fuubar
+  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: timecop
+  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: bundler
+  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: '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: simplecov
+  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: yard
+  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'
+description: Controle the number of requests permitted to make per minute/hour/day
+email:
+- neceha.bgl@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".simplecov"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/redis_rate_limit.rb
+- lib/redis_rate_limit/daily.rb
+- lib/redis_rate_limit/hourly.rb
+- lib/redis_rate_limit/minute.rb
+- lib/redis_rate_limit/period.rb
+- lib/redis_rate_limit/version.rb
+- redis_rate_limit.gemspec
+homepage: https://github.com/neceha-bgl/redis_rate_limit
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Rate Limit controler based on Redis
+test_files: []
+has_rdoc: