rack-ratelimiter 0.0.2

data/.gitignore

@@ -0,0 +1,9 @@
+# Built gems
+pkg
+*.gem
+
+# Sublimetext
+*.sublime-project
+.lock
+.bundle
+.ru

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,22 @@
+PATH
+  remote: .
+  specs:
+    rack-limiter (0.0.1)
+      chronic (>= 0.4.3)
+      rack (>= 1.0.0)
+      redis-namespace (~> 1.0.2)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    chronic (0.4.3)
+    rack (1.3.0)
+    redis (2.2.1)
+    redis-namespace (1.0.3)
+      redis (< 3.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rack-limiter!

data/README.md

@@ -0,0 +1,22 @@
+Rack Limiter
+============
+Simple redis-backed rack middleware to limit incoming http requests. Extracted from Screenfunk.com
+
+## Configuration for Rails apps
+
+Add rack-ratelimiter to your Gemfile
+
+	gem 'rack-racklimiter', :git => "git://github.com/krmdrms/rack-ratelimiter.git",:require => 'rack/rack_limiter'
+
+This will limit all incoming requests
+
+	config.middleware.use "Rack::RateLimiter", :interval => 60, :max_requests => 50, :redis_namespace => 'rack_limiter'
+
+We have Public API @screenfunk which runs on the same rails instance with different domain
+
+	config.middleware.use "Rack::RateLimiter", :interval => 60, :max_requests => 50, :redis_namespace => 'rack_limiter', :limit => {:domain => 'api.screenfunk.com'}
+
+with :limit parameter server only listens given domain.
+
+#License
+(The MIT License) Copyright © 2011 Kerem Durmus

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/*_test.rb'
+  t.verbose = true
+end
+
+task :default => [:test]

data/lib/rack/rate_limiter.rb

@@ -0,0 +1,80 @@
+require "rack"
+require "redis/namespace"
+require "json"
+
+module Rack
+  class RateLimiter
+    def initialize(app, options={})
+      @app = app
+      @options ={
+        :redis => nil,
+        :limit => nil,
+        :max_requests => 60, 
+        :interval => 60, # in seconds
+        :redis_namespace => 'rate_limiter'
+      }.merge(options)
+    end
+
+    def call(env, options={})
+      request = Rack::Request.new(env)
+      status, headers, body = @app.call(env)
+
+      return status, headers, body unless rate_limited?(request)
+
+      begin
+        key = generate_key(request)
+        redis.setex(key, @options[:interval], @options[:max_requests]) unless redis.exists(key)
+        @rate_remaining = redis.decr(key)
+      
+        return limit_exceeded! if @rate_remaining < 0
+      rescue ::Errno::ECONNREFUSED
+        return [status, headers, body]
+      end
+
+      headers.merge!({'X-RateLimit-Limit' => @options[:max_requests].to_s,
+                      'X-RateLimit-Remaining' => @rate_remaining.to_s
+                    })
+
+      return status, headers, body
+    end
+
+    def generate_key(request)
+      "#{client_id(request)}"
+    end
+
+    def client_id(request)
+      request.ip.to_s
+    end
+
+    def rate_limited?(request)
+      limit = @options[:limit]
+
+      unless limit[:domain].nil?
+        return request.host == limit[:domain]
+      end
+
+      return false
+    end
+
+    def limit_exceeded!
+      code = 403
+      body = {:error => {:code => 403, :message => "Rate Limit Exceeded"}}.to_json
+      [code, 
+          {'Content-Type' => 'application/json; charset=utf-8',
+           'Content-Lenght' => body.size.to_s
+          }, body]
+    end
+
+    def redis
+      if @options[:redis].nil?
+        begin
+          @redis = Redis::Namespace.new(@options[:redis_namespace], :redis => Redis.new(:thread_safe => true))
+        rescue Errno::ECONNREFUSED
+        end
+      else
+        @redis = @options[:redis]
+      end
+      @redis
+    end
+  end
+end

data/lib/rack/rate_limiter/version.rb

@@ -0,0 +1,3 @@
+module RateLimiter
+  VERSION = '0.0.2'
+end

data/rack-ratelimiter.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "rack/rate_limiter/version"
+
+Gem::Specification.new do |s|
+  s.name        = "rack-ratelimiter"
+  s.version     = RateLimiter::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Kerem Durmus"]
+  s.email       = ["kerem@keremdurmus.com"]
+  s.homepage    = "http://github.com/krmdrms/rack-ratelimiter"
+  s.summary     = %q{Simple rate-limit middleware}
+  s.description = %q{Redis backed rack middleware for rate-limiting http requests}
+  
+  s.rubyforge_project = "rack-ratelimiter"
+
+  s.required_rubygems_version = ">= 1.3.6"
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- test/*`.split("\n")
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'rack', '>= 1.0.0'
+  s.add_dependency 'redis-namespace', '>= 0.10.0'
+  s.add_dependency "chronic", ">= 0.4.3"
+end

data/test/limiter_test.rb

@@ -0,0 +1,64 @@
+require "test/test_helper"
+
+class RackLimiterTest < Test::Unit::TestCase
+  include Rack::Test::Methods
+
+  def app
+    @app = TestApp.new
+    @rack = Rack::RateLimiter.new(@app, {
+      :interval => 60,
+      :max_requests => 5,
+      :redis_namespace => 'rack_limiter_test',
+      :limit => {:domain => 'api.example.com'}
+      }
+    )
+  end
+
+  def redis
+    @redis = Redis::Namespace.new('rack_limiter_test', :redis => Redis.new)
+  end
+
+  def flush_redis!
+    redis.keys("*").each do |key|
+      redis.del(key)
+    end
+  end
+
+  def setup
+    flush_redis!
+  end
+
+  def test_request
+    get 'http://example.com/'
+    
+    assert_equal 200, last_response.status
+    assert_equal "Hello, World!", last_response.body
+  end
+
+  def test_rate_limited_request
+    5.times do 
+      get 'http://api.example.com/'
+      assert_equal 200, last_response.status
+    end
+
+    get 'http://api.example.com/'
+    body = {:error => {:code => 403, :message => "Rate Limit Exceeded"}}.to_json
+    assert_equal 403, last_response.status
+    assert_equal body, last_response.body
+  end
+
+  def test_rate_limited?
+    10.times do 
+      get 'http://hello.example.com/'
+      assert_equal 200, last_response.status
+    end
+  end
+
+  class TestApp
+    def call(env)
+      [200, {
+        'Content-Type' => 'text/html; charset=utf-8',
+      }, ["Hello, World!"]]
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,6 @@
+require "rubygems"
+require 'redgreen'
+require "rack/test"
+require "test/test_helper"
+require "lib/rack/rate_limiter"
+

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification 
+name: rack-ratelimiter
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Kerem Durmus
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-07 00:00:00 +03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rack
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: redis-namespace
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 55
+        segments: 
+        - 0
+        - 10
+        - 0
+        version: 0.10.0
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: chronic
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 0
+        - 4
+        - 3
+        version: 0.4.3
+  type: :runtime
+  version_requirements: *id003
+description: Redis backed rack middleware for rate-limiting http requests
+email: 
+- kerem@keremdurmus.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/rack/rate_limiter.rb
+- lib/rack/rate_limiter/version.rb
+- rack-ratelimiter.gemspec
+- test/limiter_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/krmdrms/rack-ratelimiter
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: rack-ratelimiter
+rubygems_version: 1.5.3
+signing_key: 
+specification_version: 3
+summary: Simple rate-limit middleware
+test_files: 
+- test/limiter_test.rb
+- test/test_helper.rb