rack-congestion 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 693570cf6841abf6dd17eaad6d15fe862d4f9641
+  data.tar.gz: b4cfba48ed33833109973199b7bdd47fb8703229
+SHA512:
+  metadata.gz: 2a16cc9ffd977a35fcb1229628c87fa76ebdb602373b2fc7ebd1bb24329816159ae47367f546e31d1b95f1f474c92293034b260fd19a1087508a3a3ee59d450a
+  data.tar.gz: acbdcacc1948ca3e21a65bd20f0dbdcd9ff1672e0147e3ac1e7fed92236ec62c678fbdf6b3b255790bb23805c0fb6e55b9d289262732b7c2ce74bb4a879e3a1d

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+sudo: false
+cache: bundler
+rvm:
+  - 1.9.3
+  - 2.2.0
+  - jruby-19mode
+services:
+  - redis-server
+jruby_before_script: &jruby_before_script
+  - bundle exec jbundle install

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, 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, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other 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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/Guardfile

@@ -0,0 +1,6 @@
+guard :rspec, cmd: 'bundle exec rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$}){ |m| "spec/#{ m[1] }_spec.rb" }
+  watch('spec/spec_helper.rb'){ 'spec' }
+  watch(%r{^spec/support/(.+)\.rb$}){ 'spec' }
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Michael Parrish
+
+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,80 @@
+# Rack::Congestion
+
+[![Build Status](https://travis-ci.org/parrish/Rack-Congestion.svg?branch=master)](https://travis-ci.org/parrish/Rack-Congestion)
+[![Test Coverage](https://codeclimate.com/github/parrish/Rack-Congestion/badges/coverage.svg)](https://codeclimate.com/github/parrish/Rack-Congestion)
+[![Code Climate](https://codeclimate.com/github/parrish/Rack-Congestion/badges/gpa.svg)](https://codeclimate.com/github/parrish/Rack-Congestion)
+
+Rack middleware for [Congestion](https://github.com/parrish/Congestion)
+
+Provides rate limiting for Rack-based applications.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rack-congestion'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack-congestion
+
+## Usage
+
+The available limiters are:
+
+- `Rack::Congestion::Limiter`
+  - Application-wide limiting
+- `Rack::Congestion::IpLimiter`
+  - Limits requests per-IP
+- `Rack::Congestion::PathLimiter`
+  - Limits requests for a path segment
+  - e.g. limit requests to `'/api'`
+  - accepts `path:`(required) and `path_matcher:`(optional) options
+
+Examples and more advanced usage can be found in [examples](examples)
+
+### In a Rack application
+
+```ruby
+require 'rack/congestion'
+
+# Limit requests to
+#   - a maximum of 100 requests per minute
+#   - a maximum rate of 1 request every 100 milliseconds
+use Rack::Congestion::IpLimiter, interval: 60, max_in_interval: 100, min_delay: 0.1
+
+run ->(env){
+  [200, { 'Content-Type' => 'text/plain' }, ['Hello world']]
+}
+```
+
+### In a Rails application
+
+```ruby
+# config/application.rb
+require 'rack/congestion'
+
+class YourApplication < Rails::Application
+  config.middleware.use Rack::Congestion::IpLimiter
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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 run the specs, run `bundle exec rake`.
+
+## Contributing
+
+1. Fork it ( https://github.com/parrish/rack-congestion/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,5 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new :spec
+task default: :spec

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'congestion'
+require 'pry'
+
+Pry.start

data/bin/setup

@@ -0,0 +1,5 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install

data/examples/custom.ru

@@ -0,0 +1,15 @@
+require 'rack/congestion'
+
+class CustomLimiter < Rack::Congestion::PathLimiter
+  def key
+    ->{ "#{ request.ip }-#{ path }" }
+  end
+end
+
+# Limit requests to
+#   - a maximum of 10 requests per minute per user to /api
+use CustomLimiter, path: 'api', interval: 60, max_in_interval: 10
+
+run ->(env){
+  [200, { 'Content-Type' => 'text/plain' }, ['Hello world']]
+}

data/examples/global.ru

@@ -0,0 +1,14 @@
+require 'rack/congestion'
+
+# Limit requests to
+#   - a maximum of 10 requests per minute
+#   - a maximum rate of 1 request every second
+#   - Unsuccessful requests count towards limits
+use Rack::Congestion::Limiter, {
+  interval: 60, max_in_interval: 10, min_delay: 1,
+  track_rejected: true
+}
+
+run ->(env){
+  [200, { 'Content-Type' => 'text/plain' }, ['Hello world']]
+}

data/examples/per_ip_and_global.ru

@@ -0,0 +1,11 @@
+require 'rack/congestion'
+
+# Limit requests to
+#   - a global maximum of 10 requests per minute
+#   - a maximum of 1 request per minute per user
+use Rack::Congestion::Limiter,   interval: 60, max_in_interval: 10
+use Rack::Congestion::IpLimiter, interval: 60, max_in_interval: 1
+
+run ->(env){
+  [200, { 'Content-Type' => 'text/plain' }, ['Hello world']]
+}

data/examples/per_path.ru

@@ -0,0 +1,14 @@
+require 'rack/congestion'
+
+# Limit requests to
+#   - a maximum of 10 requests per minute to /api
+#   - a maximum of 5 requests per minute to everything else
+use Rack::Congestion::PathLimiter, path: 'api', interval: 60,
+  max_in_interval: 10
+
+use Rack::Congestion::PathLimiter, path: 'other', interval: 60,
+  max_in_interval: 5, path_matcher: /^\/(?!api)/i
+
+run ->(env){
+  [200, { 'Content-Type' => 'text/plain' }, ['Hello world']]
+}

data/lib/rack/congestion/ip_limiter.rb

@@ -0,0 +1,9 @@
+module Rack
+  module Congestion
+    class IpLimiter < Limiter
+      def key
+        ->{ request ? request.ip : nil }
+      end
+    end
+  end
+end

data/lib/rack/congestion/limiter.rb

@@ -0,0 +1,45 @@
+module Rack
+  module Congestion
+    class Limiter
+      attr_accessor :app, :options
+      attr_reader :env
+
+      def initialize(app, options = { })
+        self.app = app
+        self.options = options
+      end
+
+      def call(env)
+        dup._call env
+      end
+
+      def _call(env)
+        @env = env
+        request.allowed? ? app.call(env) : rejected_response
+      end
+
+      def request
+        @request ||= Rack::Congestion::Request.new env, key, options
+      end
+
+      def key
+        ->{ 'global' }
+      end
+
+      def rejected_response
+        [
+          429,
+          {
+            'Content-Type' => 'text/plain; charset=utf-8',
+            'Retry-After' => backoff
+          },
+          ['Rate Limit Exceeded']
+        ]
+      end
+
+      def backoff
+        request.backoff.to_s rescue -1
+      end
+    end
+  end
+end

data/lib/rack/congestion/path_limiter.rb

@@ -0,0 +1,39 @@
+module Rack
+  module Congestion
+    class PathLimiter < Limiter
+      attr_accessor :path, :path_matcher
+
+      def initialize(app, options = { })
+        self.path = normalize_path_from options
+        self.path_matcher = normalize_matcher_from options
+        super
+      end
+
+      def _call(env)
+        @env = env
+        ignored? ? app.call(env) : super(env)
+      end
+
+      def key
+        ->{ path }
+      end
+
+      def ignored?
+        request.path !~ path_matcher
+      end
+
+      protected
+
+      def normalize_path_from(options)
+        self.path = options.delete :path
+        path.sub(/^\/*/, '/').sub /\/+$/, ''
+      end
+
+      def normalize_matcher_from(options)
+        self.path_matcher = options.delete :path_matcher
+        return path_matcher if path_matcher
+        Regexp.new path.sub(/^\^?/, '^'), 'i'
+      end
+    end
+  end
+end

data/lib/rack/congestion/request.rb

@@ -0,0 +1,33 @@
+require 'forwardable'
+
+module Rack
+  module Congestion
+    class Request
+      extend Forwardable
+      attr_accessor :env, :key, :options
+
+      def_delegators :rack_request,
+        :ip, :path, :content_type, :session, :scheme,
+        :ssl?, :delete?, :get?, :head?, :options?, :link?,
+        :patch?, :post?, :put?, :trace?, :unlink?, :cookies, :xhr?
+
+      def_delegators :congestion,
+        :allowed?, :backoff, :first_request, :last_request,
+        :rejected?, :too_frequent?, :too_many?, :total_requests
+
+      def initialize(env, key, options = { })
+        self.env = env
+        self.key = key
+        self.options = options
+      end
+
+      def rack_request
+        @rack_request ||= Rack::Request.new env
+      end
+
+      def congestion
+        @congestion ||= ::Congestion.request key.call, options
+      end
+    end
+  end
+end

data/lib/rack/congestion/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  module Congestion
+    VERSION = '0.0.2'
+  end
+end

data/lib/rack/congestion.rb

@@ -0,0 +1,11 @@
+require 'congestion'
+require 'rack/congestion/version'
+
+module Rack
+  module Congestion
+    require 'rack/congestion/request'
+    require 'rack/congestion/limiter'
+    require 'rack/congestion/ip_limiter'
+    require 'rack/congestion/path_limiter'
+  end
+end

data/rack-congestion.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rack/congestion/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rack-congestion'
+  spec.version       = Rack::Congestion::VERSION
+  spec.authors       = ['Michael Parrish']
+  spec.email         = ['michael@zooniverse.org']
+
+  spec.summary       = %q{Redis rate limiter Rack middleware}
+  spec.description   = %q{Rack middleware rate limiter that provides both time-based limits and quantity-based limits}
+  spec.homepage      = 'https://github.com/parrish/rack-congestion'
+  spec.license       = 'MIT'
+
+  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_runtime_dependency     'congestion', '~> 0.0.2'
+  spec.add_runtime_dependency     'rack', '>= 1.5'
+  spec.add_runtime_dependency     'rack-test', '>= 0.6'
+  spec.add_development_dependency 'bundler', '>= 1.5'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.2'
+  spec.add_development_dependency 'rspec-its', '~> 1.2'
+  spec.add_development_dependency 'guard-rspec', '~> 4.5'
+  spec.add_development_dependency 'timecop', '~> 0.7'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'codeclimate-test-reporter'
+end

metadata

@@ -0,0 +1,221 @@
+--- !ruby/object:Gem::Specification
+name: rack-congestion
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Michael Parrish
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-04-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: congestion
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !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: codeclimate-test-reporter
+  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: Rack middleware rate limiter that provides both time-based limits and
+  quantity-based limits
+email:
+- michael@zooniverse.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- examples/custom.ru
+- examples/global.ru
+- examples/per_ip_and_global.ru
+- examples/per_path.ru
+- lib/rack/congestion.rb
+- lib/rack/congestion/ip_limiter.rb
+- lib/rack/congestion/limiter.rb
+- lib/rack/congestion/path_limiter.rb
+- lib/rack/congestion/request.rb
+- lib/rack/congestion/version.rb
+- rack-congestion.gemspec
+homepage: https://github.com/parrish/rack-congestion
+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.6
+signing_key: 
+specification_version: 4
+summary: Redis rate limiter Rack middleware
+test_files: []