reject 0.0.1

data/.gitignore

@@ -0,0 +1,16 @@
+*.rbc
+*.sassc
+.sass-cache
+capybara-*.html
+.rspec
+/.bundle
+/vendor/bundle
+/log/*
+/tmp/*
+/db/*.sqlite3
+/public/system/*
+/coverage/
+/spec/tmp/*
+**.orig
+rerun.txt
+pickle-email-*.html

data/README.md

@@ -0,0 +1,94 @@
+Reject
+======
+
+Rack Module to reject unwanted requests.
+
+Sometimes you don't want to reject incoming requests. Use cases could be:
+
+  - block page for maintenance reasons
+  - blacklist resources or clients
+  - enforce usage limits (you might want to use [datagraph/rack-throttle](https://github.com/datagraph/rack-throttle) for that)
+  
+Usage with Rails
+----------------
+
+**Add to Gemfile**:
+
+    gem 'reject', :github => 'tobiasfinknet/reject'
+
+I still have to check that rubygems stuff, maybe i'll have to rename the gem to avoid annoying  :require parameters in the Gemfile
+
+**Add to <environment>.rb**
+
+Basically you still have to write the conditions for rejection on your own. The rest is handled by this gem. This example would deny access to all clients with IPs other than 127.0.0.1:
+ 
+    config.middleware.use "Rack::Reject::Rejector" do |request, opts|
+      request.ip != "127.0.0.1"
+    end
+
+Parameters and defaults
+-----------------------
+
+    default_options = {
+      :code => 503, # HTTP STATUS CODE
+      :msg => "503 SERVICE UNAVAILIBLE", # Text that is displayed as response unless param :file is used
+      :headers => {}, # overwrite headers
+      :retry_after => nil, # send retry after header
+      :html_file => nil # Path to html file to return, e.g. Rails.root.join('public', '500.html')
+    } 
+
+For the retry_after param see [the rfc](http://webee.technion.ac.il/labs/comnet/netcourse/CIE/RFC/2068/201.htm) for examples.
+
+You can set all options in the middleware command and override them on the opts-hash that is passed to your rejection-block.
+
+Examples
+--------
+**Deliver funny random error page on every 5th request (rails)**
+
+	config.middleware.use "Rack::Reject::Rejector", :html_file => Rails.root.join('public', 'iis.html'), :code => 500 do |request, opts|
+      (0...5).to_a.sample == 0
+    end
+	
+Use only on april-fools day. Don't forget to create iis.html.
+
+**Limit the number of incoming requests per ip (rails)**
+
+    config.middleware.insert_before 'Rack::Lock',"Rack::Reject::Rejector", :code => 403 do |request, opts|
+      allowed_requests_per_second = 0.5
+      max_lockout_seconds = 100
+      threshold = 20
+      now = Time.now
+      
+      client_info = Rails.cache.read(request.ip) || [now, 0.0]
+      last_visit = client_info[0]
+      activity = client_info[1]
+      
+      activity = [activity - (now - last_visit) * allowed_requests_per_second, 0.0].max + 1.0
+      activity = [activity, (max_lockout_seconds * allowed_requests_per_second) + threshold].min
+      
+      
+      opts[:retry_after] = ((activity - threshold) / allowed_requests_per_second).ceil.to_s
+      opts[:msg] = "Your last request was only #{(now - last_visit)} seconds ago. \nCome back in #{opts[:retry_after]} seconds."
+      
+      Rails.cache.write(request.ip, [now, activity])
+      
+      activity > threshold
+    end
+
+Make sure to use a fast cross-instance rails cache for this, e.g. [memcache store](http://api.rubyonrails.org/classes/ActiveSupport/Cache/MemCacheStore.html).
+Make also sure to configure the number of allowed requests per second and threshold to your needs, that depends strongly on if assets are delivered through rails or through an external webserver.
+Also there can be lots of non-malicious ajax requests which should not be blocked.
+
+With config.middleware.insert_before, the rejection code is called at the very beginning of the request handling. 
+This will lower the used resources to a minimum.
+
+ToDo
+----
+  - Write lots of awesome tests
+
+Acknowledgements
+-----------------
+  - [datagraph/rack-throttle](https://github.com/datagraph/rack-throttle) was the inspiration to limit requests, although it didn't fit our needs
+  - [ASCIIcasts](http://asciicasts.com/episodes/151-rack-middleware) for explaining how to write a rack module :-)
+  - A strange customer whos performance test consists of a bunch of testers pressing F5 on the slowest pages (that normally wouldn't be requested more often than 5 times a minute)
+

data/lib/rack/reject.rb

@@ -0,0 +1,10 @@
+# encoding: utf-8
+
+require 'rack'
+
+module Rack
+  module Reject
+    autoload :Rejector, 'rack/reject/rejector'  
+    autoload :VERSION, 'rack/reject/version'  
+  end
+end

data/lib/rack/reject/rejector.rb

@@ -0,0 +1,65 @@
+module Rack
+  module Reject
+    class Rejector
+      ##
+      # Reject Request if block.call(request) returns true
+      #      
+      def initialize(app, options = {}, &block)
+        default_options = {
+          :code => 503, # HTTP STATUS CODE
+          :msg => "503 SERVICE UNAVAILIBLE", # Text that is displayed a response unless param :file is used
+          :headers => {}, # overwrite headers
+          :retry_after => nil, # send retry after header, see http://webee.technion.ac.il/labs/comnet/netcourse/CIE/RFC/2068/201.htm
+          :html_file => nil # Path to html file to return, e.g. Rails.root.join('public', '500.html')
+        }        
+        
+        @app, @options, @block = app, default_options.merge(options), block
+      end
+      
+      def call(env)
+        request = Rack::Request.new(env)
+        opts = @options.clone
+        reject?(request, opts) ?  reject!(request, opts) : @app.call(env)
+      end 
+      
+      ##
+      # Check whether the request is to be rejected
+      def reject? request, opts
+        @block.call(request, opts)
+      end 
+      
+      ##
+      # Reject the request
+      def reject! request, opts
+        [status(opts), headers(opts), response(opts)]
+      end
+      
+      def headers opts
+        headers = {}
+        if opts[:html_file].nil?
+          headers['Content-Type'] = 'text/plain; charset=utf-8' 
+        else 
+          headers['Content-Type'] = 'text/html; charset=utf-8' 
+          headers['Content-Disposition'] = "inline; filename='reject.html'"
+          headers['Content-Transfer-Encoding'] = 'binary'
+          headers['Cache-Control'] = 'private'
+        end
+        headers['Retry-After'] = opts[:retry_after] unless opts[:retry_after].nil?
+        
+        headers.merge(opts[:headers])
+      end
+      
+      def status opts
+        opts[:code]
+      end
+      
+      def response opts
+        if opts[:html_file].nil?
+          Array.wrap(opts[:msg])
+        else
+          ::File.open(opts[:html_file], "rb")
+        end
+      end
+    end
+  end
+end

data/lib/rack/reject/version.rb

@@ -0,0 +1,6 @@
+# encoding: utf-8
+module Rack
+  module Reject
+    VERSION = "0.0.1"
+  end
+end

data/reject.gemspec

@@ -0,0 +1,16 @@
+# encoding: utf-8
+$:.push File.expand_path("../lib", __FILE__)
+require "rack/reject/version"
+require "rack/reject/rejector"
+Gem::Specification.new do |s|
+  s.name = 'reject'
+  s.version = Rack::Reject::VERSION
+  s.authors = ["Tobias Fink"]
+  s.email = ["code@tobias-fink.net"]
+  s.homepage = "https://github.com/tobiasfinknet/reject"
+  s.summary = "Rack Module to reject unwanted requests."
+  s.description = "Rack Module to reject unwanted requests."
+  s.licenses = ["MIT", "GPLv3"]
+
+  s.files = `git ls-files`.split("\n")
+end

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: reject
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Tobias Fink
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-01 00:00:00.000000000 Z
+dependencies: []
+description: Rack Module to reject unwanted requests.
+email:
+- code@tobias-fink.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- README.md
+- lib/rack/reject.rb
+- lib/rack/reject/rejector.rb
+- lib/rack/reject/version.rb
+- reject.gemspec
+homepage: https://github.com/tobiasfinknet/reject
+licenses:
+- MIT
+- GPLv3
+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.24
+signing_key: 
+specification_version: 3
+summary: Rack Module to reject unwanted requests.
+test_files: []