rack-attack-rate-limit 0.1.0

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - "1.9.3"
+  - "2.0.0"
+script: bundle exec rspec

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jason Byck
+
+MIT License
+
+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,58 @@
+# Rack::Attack::RateLimit
+
+[![Build Status](https://travis-ci.org/jbyck/rack-attack-rate-limit.png?branch=master)](https://travis-ci.org/jbyck/rack-attack-rate-limit)
+
+Add rate limit headers for [Rack::Attack](https://github.com/kickstarter/rack-attack) throttles.
+
+## Installation
+
+Install the gem:
+
+```shell
+gem install 'rack-attack-rate-limit'
+```
+
+In your gemfile:
+```ruby
+gem 'rack-attack-rate-limit', require: 'rack/attack/rate-limit'
+```
+
+
+
+And then execute:
+```shell
+bundle
+```
+
+## Usage
+
+Rack::Attack::RateLimit expects a Rack::Attack throttle to be defined:
+
+```ruby
+Rack::Attack.throttle('my_throttle') do |req|
+  req.ip
+end
+```
+
+To include rate limit headers for this throttle, include the Rack::Attack::RateLimit middleware
+
+For Rails 3+:
+
+```ruby
+config.middleware.use Rack::Attack::RateLimit, throttle: 'my_throttle'
+```
+
+Currently, Rack::Attack::RateLimit can only be configured to return rate limit headers for a single throttle, whose name can be specified as an option.
+
+Rate limit headers are:
+
+* 'X-RateLimit-Limit' - The total number of requests allowed.
+* 'X-RateLimit-Remaining' - The number of remaining requests. 
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/rack/attack/rate-limit.rb

@@ -0,0 +1,84 @@
+module Rack
+  module Attack
+    class RateLimit
+      
+      RACK_ATTACK_KEY = 'rack.attack.throttle_data'
+
+      attr_reader :app, :options
+  
+      def initialize(app, options = {})
+        @app = app
+        @options = default_options.merge(options)
+      end
+
+      def call(env)
+        # If env does not have necessary data to extract rate limit data for the provider, then app.call
+        return app.call(env) unless rate_limit_available?(env)     
+        # Otherwise, add rate limit headers
+        status, headers, body = app.call(env)
+        add_rate_limit_headers!(headers, env)
+        [status, headers, body]  
+      end
+    
+      # Returns env key used by Rack::Attack to namespace data
+      #
+      # Returns string
+      def rack_attack_key
+        RACK_ATTACK_KEY
+      end
+  
+      # Default options to configure Rack::RateLimit
+      #
+      # Returns hash
+      def default_options
+        { throttle: 'throttle' }
+      end
+      
+      def throttle
+        options[:throttle] || ''
+      end
+    
+      # Return hash of headers with Rate Limiting data
+      #
+      # headers - Hash of headers
+      #
+      # Returns hash
+      def add_rate_limit_headers!(headers, env)
+        headers['X-RateLimit-Limit']      = rate_limit_limit(env).to_s
+        headers['X-RateLimit-Remaining']  = rate_limit_remaining(env).to_s
+        headers
+      end
+  
+      protected
+  
+      # RateLimit upper limit from Rack::Attack
+      #
+      # env - Hash
+      #
+      # Returns Fixnum
+      def rate_limit_limit(env)
+        env[rack_attack_key][throttle][:limit]
+      end
+  
+      # RateLimit remaining request from Rack::Attack
+      #
+      # env - Hash
+      #
+      # Returns Fixnum
+      def rate_limit_remaining(env)
+        rate_limit_limit(env) - env[rack_attack_key][throttle][:count]
+      end
+      
+      # Rate Limit available method for Rack::Attack provider
+      # Checks the key identifed by options[:namespace] under the rack.attak.throttle_data env hash key
+      #
+      # env - Hash
+      #
+      # Returns boolean 
+      def rate_limit_available?(env)
+        env.key?(rack_attack_key) and env[rack_attack_key].key?(throttle)
+      end
+  
+    end
+  end
+end

data/lib/rack/attack/rate-limit/version.rb

@@ -0,0 +1,7 @@
+module Rack
+  module Attack
+    class RateLimit
+      VERSION = "0.1.0"
+    end
+  end
+end

data/rack-attack-rate-limit.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'rack/attack/rate-limit/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rack-attack-rate-limit"
+  spec.version       = Rack::Attack::RateLimit::VERSION
+  spec.authors       = ["Jason Byck"]
+  spec.email         = ["jasonbyck@gmail.com"]
+  spec.description   = %q{ Add RateLimit headers for Rack::Attack throttling }
+  spec.summary       = %q{ Add RateLimit headers for Rack::Attack throttling }
+  spec.homepage      = "https://github.com/jbyck/rack-attack-rate-limit"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+  
+  spec.add_dependency 'rack'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rack-test"
+  
+end

data/spec/rack/attack/rate-limit_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+describe Rack::Attack::RateLimit do
+  
+  include Rack::Test::Methods
+  
+  let(:throttle) { 'rack_attack_throttle' }
+  
+  let(:app) do
+    use_throttle = throttle
+    Rack::Builder.new {
+      use Rack::Attack::RateLimit, throttle: use_throttle
+      run lambda { |env| [200, {}, 'Hello, World!'] }
+    }.to_app
+    
+  end
+  
+  
+  context 'Throttle data not present from Rack::Attack' do
+    
+    before(:each) do
+      get '/'
+    end 
+    
+    it 'should not create RateLimit headers' do
+      last_response.header.key?('X-RateLimit-Limit').should be false
+      last_response.header.key?('X-RateLimit-Remaining').should be false
+    end
+    
+  end
+
+  context 'Throttle data present from Rack::Attack' do
+    
+    let(:request_limit) { (1..10000).to_a.sample }
+    let(:request_count) { (1..(request_limit-10)).to_a.sample }
+    
+    let(:rack_attack_throttle_data) do
+      { "#{throttle}" => { count: request_count, limit: request_limit } }
+    end
+    
+    before(:each) do
+      get "/", {}, { "#{Rack::Attack::RateLimit::RACK_ATTACK_KEY}" => rack_attack_throttle_data } 
+    end
+    
+    it 'should include RateLimit headers' do
+      last_response.header.key?('X-RateLimit-Limit').should be true
+      last_response.header.key?('X-RateLimit-Remaining').should be true
+    end
+    
+    it 'should return correct rate limit in header' do
+      last_response.header['X-RateLimit-Limit'].to_i.should eq request_limit
+    end
+    
+    it 'should return correct remaining calls in header' do
+      last_response.header['X-RateLimit-Remaining'].to_i.should eq (request_limit-request_count)
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + "../lib")
+
+require 'rspec'
+require 'rack/test'
+require 'rack/attack/rate-limit'
+
+RSpec::configure do |config|
+  
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.formatter = :documentation  
+  config.tty = true
+  config.color_enabled = true
+  
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: rack-attack-rate-limit
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Jason Byck
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! ' Add RateLimit headers for Rack::Attack throttling '
+email:
+- jasonbyck@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rack/attack/rate-limit.rb
+- lib/rack/attack/rate-limit/version.rb
+- rack-attack-rate-limit.gemspec
+- spec/rack/attack/rate-limit_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/jbyck/rack-attack-rate-limit
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Add RateLimit headers for Rack::Attack throttling
+test_files:
+- spec/rack/attack/rate-limit_spec.rb
+- spec/spec_helper.rb