rack-pooledthrottle 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f17681ae19c501bb8f4194f2d7e9389f3aae51ee
+  data.tar.gz: 6349f697567a2cbc6f3a04248e710dbd36c253eb
+SHA512:
+  metadata.gz: 2431de24d6e9c40b2f5e0b2b0f5bfdca57d5ae38b5b99e3c3cec3698c258f3cb56d52efbd30472071ca568046b5c5dcbc1784fff2208880ec31eb080eb8ecf1d
+  data.tar.gz: 68eec81e9a722fc99bcbdc66a3cec630ed20500188854bea77ca48f77c83b46a950958b2756a0061f97569ccb4908e5ddbb5cf8e57f3307ad9772552251309f7

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Scott Watermasysk
+
+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,64 @@
+# Rack::Pooledthrottle
+
+Rack::Pooledthrottle is middleware which provides rate-limiting of incoming HTTP requests to Rack applications. You should be able to use it with any Ruby web framework (I have only tested Sinatra and Rails). 
+
+I initially tried to work it into  [Rack Throttle](https://github.com/bendiken/rack-throttle), but because of Rack Throttle's 
+many backend options I thought it would be too complicated. 
+
+So how is it different? 
+
+1. It uses a pool (via [ConnectionPool](https://github.com/mperham/connection_pool)) of connections instead of creating one on each request 
+1. It uses a sliding TTL for tracking. This means if you limit an IP to 10 requests every hour and the first request comes in at 1:30 the user can make up to 9 more requests until 2:30.
+1. The TTL is set on middleware declaration. No other subclasses. 
+1. Database support is limited to Memcached (and eventually Redis)
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rack-pooledthrottle'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack-pooledthrottle
+
+## Usage
+
+### Adding throttling to a Rails application
+
+    require 'rack/pooledthrottle'
+    require 'dalli' #Dalli is not required. You must add it to your gem file if you want to use it. 
+    $mc_pool ||= ConnectionPool.new(size: 5) {Dalli::Client.new}
+    
+    class Application < Rails::Application
+      config.middleware.use Rack::Throttle::Interval, max: 10, ttl: 3600, pool: $mc_pool
+    end    
+    
+### Adding throttling to a Sinatra application
+
+    require 'sinatra'
+    require 'rack/pooledthrottle'
+    
+    use Rack::Throttle::Interval, max: 5, ttl: 60, pool: $mc_pool #see above for pool
+    
+    get('/hello') { "Hello, world!\n" }    
+
+## HAT TIP 
+
+I just want to make it super clear that a vast majority of this code was based on the excellent work of [Rack Throttle](https://github.com/bendiken/rack-throttle).
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/rack-pooledthrottle/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,2 @@
+require "bundler/gem_tasks"
+

data/lib/rack/pooledthrottle.rb

@@ -0,0 +1,11 @@
+require "rack/pooledthrottle/version"
+require 'rack'
+require 'connection_pool'
+require 'rack/pooledthrottle/throttle'
+require 'rack/pooledthrottle/memcached_throttle'
+
+module Rack
+  module PooledThrottle
+    
+  end
+end

data/lib/rack/pooledthrottle/memcached_throttle.rb

@@ -0,0 +1,13 @@
+module Rack
+  module PooledThrottle
+    class MemcachedThrottle < Throttle
+      def initialize(app, options={})
+        super
+      end
+
+      def query_cache?(request)
+          ((pool.with {|cache| cache.incr(cache_key(request), 1, ttl, 1)}) <= max)
+      end      
+    end
+  end
+end

data/lib/rack/pooledthrottle/throttle.rb

@@ -0,0 +1,107 @@
+module Rack
+  module PooledThrottle
+    class Throttle
+      attr_reader :app, :options
+
+      def initialize(app, options = {})
+        @app, @options = app, options
+      end
+
+      def call(env)
+        request = Rack::Request.new(env)
+        allowed?(request) ? app.call(env) : rate_limit_exceeded(request)
+      end
+
+      protected
+
+      def allowed?(request)
+        case
+          when whitelisted?(request) then true
+          when blacklisted?(request) then false
+          else
+            query_cache?(request)
+        end
+      end
+
+      def query_cache?(request)
+        false
+      end
+
+      def whitelisted?(request)
+        false
+      end
+
+      def blacklisted?(request)
+        false
+      end
+
+      def cache_key(request)
+        "#{namespace}:#{key_prefix}#{client_identifier(request)}"
+      end
+
+
+      ##
+      # @param  [Rack::Request] request
+      # @return [String]
+      def client_identifier(request)
+        if cio = options[:client_identifier]
+          cio.call(request)
+        else
+          request.ip.to_s
+        end
+      end
+
+      def namespace
+        options[:namespace] || 'rpt'
+      end
+
+      def key_prefix
+        options[:key_prefix]
+      end
+
+      def pool
+        options[:pool]
+      end
+
+      def max
+        (options[:max] || 10).to_i
+      end
+
+      def ttl
+        (options[:ttl] || 60).to_i
+      end
+
+      ##
+      # Outputs a `Rate Limit Exceeded` error.
+      #
+      # @return [Array(Integer, Hash, #each)]
+      def rate_limit_exceeded(request)
+        options[:rate_limit_exceeded_callback].call(request) if options[:rate_limit_exceeded_callback]
+        headers = respond_to?(:retry_after) ? {'Retry-After' => retry_after.to_f.ceil.to_s} : {}
+        http_error(options[:code] || 403, options[:message] || 'Rate Limit Exceeded', headers)
+      end
+
+      ##
+      # Outputs an HTTP `4xx` or `5xx` response.
+      #
+      # @param  [Integer]                code
+      # @param  [String, #to_s]          message
+      # @param  [Hash{String => String}] headers
+      # @return [Array(Integer, Hash, #each)]
+      def http_error(code, message = nil, headers = {})
+        [code, {'Content-Type' => 'text/plain; charset=utf-8'}.merge(headers),
+          [http_status(code), (message.nil? ? "\n" : " (#{message})\n")]]
+      end
+
+      ##
+      # Returns the standard HTTP status message for the given status `code`.
+      #
+      # @param  [Integer] code
+      # @return [String]
+      def http_status(code)
+        [code, Rack::Utils::HTTP_STATUS_CODES[code]].join(' ')
+      end
+      
+    end
+  end
+end

data/lib/rack/pooledthrottle/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  module Pooledthrottle
+    VERSION = "0.0.1"
+  end
+end

data/rack-pooledthrottle.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/pooledthrottle/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rack-pooledthrottle"
+  spec.version       = Rack::Pooledthrottle::VERSION
+  spec.authors       = ["Scott Watermasysk"]
+  spec.email         = ["scottwater@gmail.com"]
+  spec.summary       = %q{Throttle HTTP requests.}
+  spec.description   = %q{Throttle HTTP requests using a connection pool for all database connections}
+  spec.homepage      = ""
+  spec.license       = "Public Domain"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_runtime_dependency     'rack',      '~> 1'
+  spec.add_runtime_dependency     'connection_pool', "~> 2.2"
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.3"
+  spec.add_development_dependency 'rack-test', '0.6.3'
+  spec.add_development_dependency 'dalli', '~> 2.7'
+  
+end

data/spec/memecached_spec.rb

@@ -0,0 +1,65 @@
+require 'spec_helper'
+require 'dalli'
+
+describe Rack::PooledThrottle::MemcachedThrottle do 
+  include Rack::Test::Methods
+  
+  before(:each) do 
+    pool.with{|m| m.flush}
+    @options = {
+      pool: pool, 
+      max: 3,
+      ttl: 30
+    }
+  end
+  
+  def pool 
+    @pool ||= ConnectionPool.new(size: 1) do 
+      Dalli::Client.new((ENV["MEMCACHED_SERVERS"] || "127.0.0.1:11211").split(",").map{|s| s.strip})
+    end
+  end
+  
+  def app 
+    @app ||= Rack::PooledThrottle::MemcachedThrottle.new(example_target_app, @options)
+  end
+  
+  it 'expect a passing message' do 
+    get '/foo'
+    expect(last_response.body).to show_allowed_response
+  end
+  
+  it 'expect a passing message' do 
+    4.times {get '/foo'}
+    expect(last_response.body).to show_throttled_response
+  end
+  
+  it "should return true if whitelisted" do
+    allow(app).to receive(:whitelisted?).and_return(true)
+    4.times {get "/foo"}
+    expect(last_response.body).to show_allowed_response
+  end
+  
+  it "should return true if blacklisted" do
+    allow(app).to receive(:blacklisted?).and_return(true)
+    get "/foo"
+    expect(last_response.body).to show_throttled_response
+  end
+  
+  
+  it 'should allow the client_identifier to be overriden and pass' do 
+    @options[:max] = 2
+    @options[:client_identifier] = ->(request){request.params['email']}
+    2.times {get('/foo', email: 'scottwater@gmail.com')}
+    2.times {get '/foo', email: 'scott@kickofflabs.com'}
+    expect(last_response.body).to show_allowed_response
+  end
+
+  it 'should allow the client_identifier to be overriden and fail' do 
+    @options[:max] = 2
+    @options[:client_identifier] = ->(request){request.params['email']}
+    2.times {get('/foo', email: 'scottwater@gmail.com')}
+    3.times {get '/foo', email: 'scott@kickofflabs.com'}
+    expect(last_response.body).to show_throttled_response
+  end
+    
+end

data/spec/spec_helper.rb

@@ -0,0 +1,44 @@
+require "rack/test"
+require "rack/pooledthrottle"
+
+def example_target_app
+    target_app = Object.new
+    allow(target_app).to receive_messages(call: [200, {}, "Example App Body"])
+    target_app
+end
+
+RSpec::Matchers.define :show_allowed_response do
+  match do |body|
+    body.include?("Example App Body")
+  end
+  
+  failure_message do
+    "expected response to show the allowed response" 
+  end 
+
+  failure_message_when_negated do
+    "expected response not to show the allowed response" 
+  end
+  
+  description do
+    "expected the allowed response"
+  end 
+end
+
+RSpec::Matchers.define :show_throttled_response do
+  match do |body|
+    body.include?("Rate Limit Exceeded")
+  end
+  
+  failure_message do
+    "expected response to show the throttled response" 
+  end 
+
+  failure_message_when_negated do
+    "expected response not to show the throttled response" 
+  end
+  
+  description do
+    "expected the throttled response"
+  end 
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: rack-pooledthrottle
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Scott Watermasysk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: connection_pool
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.6.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.6.3
+- !ruby/object:Gem::Dependency
+  name: dalli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+description: Throttle HTTP requests using a connection pool for all database connections
+email:
+- scottwater@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rack/pooledthrottle.rb
+- lib/rack/pooledthrottle/memcached_throttle.rb
+- lib/rack/pooledthrottle/throttle.rb
+- lib/rack/pooledthrottle/version.rb
+- rack-pooledthrottle.gemspec
+- spec/memecached_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- Public Domain
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Throttle HTTP requests.
+test_files:
+- spec/memecached_spec.rb
+- spec/spec_helper.rb