prorate 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d846e16d888b11395f59a44e8d487e9c3cccf336
+  data.tar.gz: 16051a7c67452164d40c3d8c785a26b973eaf54e
+SHA512:
+  metadata.gz: b241b77bf6ec18bd394a0360bebd6b9e10b3b0cde21f1642860b0425d33b8b3a50dbaba9a5fe4fd7b5595dd95a566dfe122939a94711b651afec125e3ecfcc94
+  data.tar.gz: 1f110ef412d5c231f1eed8550f3957c4fc9797eef42f3a92de802b2be1d15b06c450b1913706c036dd30924925acfce410ec29adf495539ea0dd08763f904d50

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.5
+before_install: gem install bundler -v 1.12.5

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Julik Tarkhanov
+
+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,55 @@
+# Prorate
+
+Provides a low-level time-based throttle. Is mainly meant for situations where using something like Rack::Attack is not very
+useful since you need access to more variables.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'prorate'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install prorate
+
+## Usage
+
+Within your Rails controller:
+
+    throttle_args[:block_for] ||= throttle_args.fetch(:period)
+    t = Prorate::Throttle.new(redis: Redis.new, logger: Rails.logger,
+        name: "throttle-login-email", limit: 20, period: 5.seconds)
+    # Add all the parameters that function as a discriminator
+    t << request.ip
+    t << params.require(:email)
+    # ...and call the throttle! method
+    t.throttle! # Will raise a Prorate::Throttled exception if the limit has been reached
+
+To capture that exception, in the controller
+
+    rescue_from Prorate::Throttled do |e|
+      render nothing: true, status: 429
+    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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/WeTransfer/prorate.
+
+
+## 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 "prorate"
+
+# 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/prorate.rb

@@ -0,0 +1,11 @@
+require "prorate/version"
+require "ks"
+require "logger"
+require "redis"
+
+module Prorate
+  Dir.glob(__dir__ + '/prorate/**/*.rb').sort.each do |path|
+    require path
+  end
+  # Your code goes here...
+end

data/lib/prorate/block_for.rb

@@ -0,0 +1,13 @@
+module Prorate
+  module BlockFor
+    def self.block!(redis:, id:, duration:)
+      k = "bl:%s" % id
+      redis.setex(k, duration.to_i, 1)
+    end
+  
+    def self.blocked?(redis:, id:)
+      k = "bl:%s" % id
+      !!redis.get(k)
+    end
+  end
+end

data/lib/prorate/counter.rb

@@ -0,0 +1,53 @@
+module Prorate
+  # The counter implements a rolling window throttling mechanism. At each call to incr(), the Redis time
+  # is obtained. A counter then gets set at the key corresponding to the timestamp of the request, with a
+  # granularity of a second. If requests are done continuously and in large volume, the counter will therefore
+  # create one key for each second of the given rolling window size. he counters per second are set to auto-expire
+  # after the window lapses. When incr() is performed, there is 
+  class Counter
+    def initialize(redis:, logger: NullLogger, id:, window_size:)
+      @redis = redis
+      @logger = logger
+      @id = id
+      @in_span_of_seconds = window_size.to_i.abs
+    end
+  
+    # Increments the throttle counter for this identifier, and returns the total number of requests
+    # performed so far within the given time span. The caller can then determine whether the request has
+    # to be throttled or can be let through.
+    def incr
+      sec, _ = @redis.time # Use Redis time instead of the system timestamp, so that all the nodes are consistent
+      ts = sec.to_i # All Redis results are strings
+      k = key_for_ts(ts)
+      # Do the Redis stuff in a transaction, and capture only the necessary values
+      # (the result of MULTI is all the return values of each call in sequence)
+      *_, done_last_second, _, counter_values = @redis.multi do |txn|
+        # Increment the counter 
+        txn.incr(k)
+        txn.expire(k, @in_span_of_seconds)
+
+        span_start = ts - @in_span_of_seconds
+        span_end = ts + 1
+        possible_keys = (span_start..span_end).map{|prev_time| key_for_ts(prev_time) }
+        @logger.debug { "%s: Scanning %d possible keys" % [@id, possible_keys.length] }
+        
+        # Fetch all the counter values within the time window. Despite the fact that this
+        # will return thousands of elements for large sliding window sizes, the values are
+        # small and an MGET in Redis is pretty cheap, so perf should stay well within limits.
+        txn.mget(*possible_keys)
+      end
+
+      # Sum all the values. The empty keys return nils from MGET, which become 0 on to_i casts.
+      total_requests_during_period = counter_values.map(&:to_i).inject(&:+)
+      @logger.debug { "%s: %d reqs total during the last %d seconds" % [@id, total_requests_during_period, @in_span_of_seconds] }
+      
+      total_requests_during_period
+    end
+  
+    private
+
+    def key_for_ts(ts)
+      "th:%s:%d" % [@id, ts]
+    end
+  end
+end

data/lib/prorate/null_logger.rb

@@ -0,0 +1,10 @@
+module Prorate
+  module NullLogger
+    def self.debug(*); end
+    def self.info(*); end
+    def self.warn(*); end
+    def self.error(*); end
+    def self.fatal(*); end
+    def self.unknown(*); end
+  end
+end

data/lib/prorate/null_pool.rb

@@ -0,0 +1,5 @@
+module Prorate
+  class NullPool < Struct.new(:conn)
+    def with; yield conn; end
+  end
+end

data/lib/prorate/throttle.rb

@@ -0,0 +1,34 @@
+require 'digest'
+
+module Prorate
+  class Throttle < Ks.strict(:name, :limit, :period, :block_for, :redis, :logger)
+    def initialize(*)
+      super
+      @discriminators = [name.to_s]
+      self.redis = NullPool.new(redis) unless redis.respond_to?(:with)
+    end
+    
+    def <<(discriminator)
+      @discriminators << discriminator
+    end
+    
+    def throttle!
+      discriminator = Digest::SHA1.hexdigest(Marshal.dump(@discriminators))
+      identifier = [name, discriminator].join(':')
+      
+      redis.with do |r|
+        logger.info { "Checking throttle block %s" % name }
+        raise Throttled.new(block_for) if Prorate::BlockFor.blocked?(id: identifier, redis: r)
+
+        logger.info { "Applying throttle counter %s" % name }
+        c = Prorate::Counter.new(redis: r, id: identifier, logger: logger, window_size: period)
+        after_increment = c.incr
+        if after_increment > limit
+          logger.warn { "Throttle %s exceeded limit of %d at %d" % [name, limit, after_increment] }
+          Prorate::BlockFor.block!(redis: r, id: identifier, duration: block_for)
+          raise Throttled.new(period)
+        end
+      end
+    end
+  end
+end

data/lib/prorate/throttled.rb

@@ -0,0 +1,9 @@
+module Prorate
+  class Throttled < StandardError
+    attr_reader :retry_in_seconds
+    def initialize(try_again_in)
+      @retry_in_seconds = try_again_in
+      super("Throttled, please lower your temper and try again in %d seconds" % try_again_in)
+    end
+  end
+end

data/lib/prorate/version.rb

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

data/prorate.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'prorate/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "prorate"
+  spec.version       = Prorate::VERSION
+  spec.authors       = ["Julik Tarkhanov"]
+  spec.email         = ["me@julik.nl"]
+
+  spec.summary       = %q{Time-restricted rate limiter using Redis}
+  spec.description   = %q{Can be used to implement all kinds of throttles}
+  spec.homepage      = "https://github.com/WeTransfer/prorate"
+  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
+
+  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_dependency "ks"
+  spec.add_dependency "redis", ">= 2"
+  spec.add_development_dependency "connection_pool", "~> 1"
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: prorate
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Julik Tarkhanov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-02-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ks
+  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: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: connection_pool
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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'
+description: Can be used to implement all kinds of throttles
+email:
+- me@julik.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/prorate.rb
+- lib/prorate/block_for.rb
+- lib/prorate/counter.rb
+- lib/prorate/null_logger.rb
+- lib/prorate/null_pool.rb
+- lib/prorate/throttle.rb
+- lib/prorate/throttled.rb
+- lib/prorate/version.rb
+- prorate.gemspec
+homepage: https://github.com/WeTransfer/prorate
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Time-restricted rate limiter using Redis
+test_files: []