rack-bouncer 1.2

data/.gitignore

@@ -0,0 +1,3 @@
+pkg/*
+.DS_Store
+*.gem

data/.rvmrc

@@ -0,0 +1 @@
+rvm use ree-1.8.7-2011.03@rack-bouncer --create

data/Gemfile

@@ -0,0 +1,4 @@
+# encoding: UTF-8
+source :rubygems
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,18 @@
+PATH
+  remote: .
+  specs:
+    rack-bouncer (1.2)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    minitest (2.11.1)
+    rack (1.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  minitest (~> 2.11.1)
+  rack (~> 1.4.1)
+  rack-bouncer!

data/README.md

@@ -0,0 +1,53 @@
+# rack-bouncer
+
+A Rack middleware that expels undesirable browsers out of your website. This project lovingly extends the `rack-noie6` gem.
+
+| _Browser_         | _Undesirable Versions_ |
+|-------------------|------------------------|
+| Internet Explorer | < 8                    |
+| AOL               | All                    |
+
+## usage
+
+    gem install rack-bouncer
+    require "rack/bouncer"
+
+The default redirects users to [Browse Happy](http://browsehappy.com/):
+
+    use Rack::Bouncer
+
+You can redirect users to a page in your website:
+
+    use Rack::Bouncer, :redirect => "/bouncer.html"
+
+You can redirect users to a URL as well:
+
+    use Rack::Bouncer, :redirect => "http://slashdot.org"
+
+You can even specify a minimum version of IE like so:
+
+    use Rack::Bouncer, :redirect => "http://slashdot.org", :minimum_ie => 6.0
+
+You can even specify a set of safe paths:
+
+    use Rack::Bouncer, :safe_paths => ["/assets", "/images", "/stylesheets", "/javascripts", "/feedback"]
+
+*NOTE:* By default, the above paths are safe already.
+
+## contributing
+
+Pull requests are very welcome.
+
+## acknowledgments
+
+Thanks to [juliocesar](http://github.com/juliocesar), [sant0sk1](http://github.com/sant0sk1), [wjessop](http://github.com/wjessop), and [robomc](https://github.com/robomc) for their contributions to `rack-noie6`.
+
+## license
+
+Copyright (c) 2012 Ryan Sobol
+
+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/Rakefile

@@ -0,0 +1,58 @@
+# encoding: UTF-8
+require "rake/testtask"
+
+task :default => [:test]
+
+Rake::TestTask.new do |t|
+  t.libs.push "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.verbose = true
+end
+
+###################################################################################################
+
+require File.expand_path("lib/rack/bouncer", File.dirname(__FILE__))
+
+namespace :gem do
+  desc "Builds a gem from the current project's Gem::Specification"
+  task :build do
+    puts "==> Building RubyGem"
+
+    if `git status` !~ /working directory clean/
+      abort "  Cannot build RubyGem because the working directory is not clean."
+    end
+
+    system "gem build rack-bouncer.gemspec"
+  end
+
+  desc "Removes the gem file for the current project"
+  task :clean do
+    puts "==> Cleaning up RubyGem build"
+    jeweler do |gem_file|
+      rm gem_file, :verbose => false
+      puts "  Removed #{gem_file}"
+    end
+  end
+
+  desc "Pushes the current gem to RubyGems.org"
+  task :push do
+    puts "==> Pushing RubyGem"
+    jeweler { |gem_file| system "gem push #{gem_file}"}
+  end
+
+  desc "Builds, pushes, and cleans a gem for the current project"
+  task :release do
+    Rake::Task["gem:build"].invoke
+    Rake::Task["gem:push"].invoke
+    Rake::Task["gem:clean"].invoke
+  end
+
+  def jeweler(&block)
+    file = "rack-bouncer-#{Rack::Bouncer::VERSION}.gem"
+    if File.exists?(file)
+      yield file
+    else
+      puts "  RubyGem #{file.inspect} does not exist"
+    end
+  end
+end

data/lib/rack/bouncer.rb

@@ -0,0 +1,64 @@
+# encoding: UTF-8
+
+module Rack
+  class Bouncer
+    VERSION = "1.2"
+
+    DEFAULT_OPTIONS = {
+      :safe_paths => ["/assets", "/images", "/stylesheets", "/javascripts", "/feedback"],
+      :redirect   => "http://browsehappy.com/",
+      :minimum_ie => 8.0
+    }
+
+    def initialize(app, options = {})
+      @app     = app
+      @options = DEFAULT_OPTIONS.merge(options)
+    end
+
+    def call(env)
+      if !safe_path(env) && (ie6_found_in?(env) || aol_found_in?(env))
+        kick_it
+      else
+        @app.call(env)
+      end
+    end
+
+    private
+
+    def safe_path(env)
+      path       = env["PATH_INFO"]
+      safe_paths = @options[:safe_paths].join("|")
+
+      path == @options[:redirect] || path =~ Regexp.new("^(#{safe_paths})")
+    end
+
+    def ie6_found_in?(env)
+      if env["HTTP_USER_AGENT"]
+        is_ie?(env["HTTP_USER_AGENT"]) and ie_version(env["HTTP_USER_AGENT"]) < @options[:minimum_ie] and @options[:redirect] != env["PATH_INFO"]
+      end
+    end
+
+    def is_ie?(ua_string)
+      # We need at least one digit to be able to get the version, hence the \d
+      ua_string.match(/MSIE \d/) ? true : false
+    end
+
+    def aol_found_in?(env)
+      if env["HTTP_USER_AGENT"]
+        is_aol?(env["HTTP_USER_AGENT"])
+      end
+    end
+
+    def is_aol?(ua_string)
+      ua_string.match(/AOL \d/) ? true : false
+    end
+
+    def ie_version(ua_string)
+      ua_string.match(/MSIE (\S+)/)[1].to_f
+    end
+
+    def kick_it
+      [302, {"Location" => @options[:redirect], "Content-Type" => "text/html"}, "Browser not supported"]
+    end
+  end
+end

data/rack-bouncer.gemspec

@@ -0,0 +1,24 @@
+# encoding: UTF-8
+require File.expand_path("lib/rack/bouncer", File.dirname(__FILE__))
+
+Gem::Specification.new do |s|
+  s.name        = "rack-bouncer"
+  s.version     = Rack::Bouncer::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Jerod Santo", "Julio Cesar Ody", "Will Jessop", "Ryan Sobol"]
+  s.email       = "contact@ryansobol.com"
+  s.homepage    = "https://github.com/ryansobol/rack-bouncer"
+  s.summary     = "A Rack middleware that expels undesirable browsers out of your website."
+  s.description = "A Rack middleware that expels undesirable browsers out of your website. This project lovingly extends the rack-noie6 gem."
+
+  s.required_ruby_version     = "~> 1.8.7"
+  s.required_rubygems_version = ">= 1.3.7"
+  s.rubyforge_project         = "rack-bouncer"
+
+  s.add_development_dependency "minitest",  "~> 2.11.1"
+  s.add_development_dependency "rack",      "~> 1.4.1"
+
+  s.files              = `git ls-files`.split("\n")
+  s.test_files         = `git ls-files -- spec/*`.split("\n")
+  s.require_paths      = ["lib"]
+end

data/test/lib/rack/bouncer_test.rb

@@ -0,0 +1,264 @@
+# encoding: UTF-8
+require "rubygems"
+require "minitest/autorun"
+require "rack/mock"
+
+require "rack/bouncer"
+
+class TestApp
+  def call(env)
+    [200, {}, "Hi Internets!"]
+  end
+end
+
+def create_request(options = {})
+  Rack::MockRequest.new(Rack::Bouncer.new(TestApp.new, options))
+end
+
+class Rack::Bouncer::Test < MiniTest::Unit::TestCase
+
+  def test_version
+    assert_equal "1.2", Rack::Bouncer::VERSION
+  end
+
+  def test_default_safe_paths
+    expected = ["/assets", "/images", "/stylesheets", "/javascripts", "/feedback"]
+    assert_equal expected, Rack::Bouncer::DEFAULT_OPTIONS[:safe_paths]
+  end
+
+  def test_default_redirect
+    assert_equal "http://browsehappy.com/", Rack::Bouncer::DEFAULT_OPTIONS[:redirect]
+  end
+
+  def test_default_minimum_ie
+    assert_equal 8.0, Rack::Bouncer::DEFAULT_OPTIONS[:minimum_ie]
+  end
+
+  def test_allows_if_no_user_agent_specified
+    request  = create_request
+    response = request.get("/")
+    assert_equal 200, response.status
+    assert_equal "Hi Internets!", response.body
+  end
+
+  # Internet Explorer
+  #################################################################################################
+
+  def test_allows_if_not_ie
+    request  = create_request
+    response = request.get("/", {"HTTP_USER_AGENT" => "Mozilla/5.0"})
+    assert_equal "Hi Internets!", response.body
+  end
+
+  def test_allows_ie_if_no_version_available
+    request  = create_request
+    response = request.get("/", {"HTTP_USER_AGENT" => "Mozilla/4.0 (compatible; MSIE l4me; Windows XP)"})
+    assert_equal 200, response.status
+    assert_equal "Hi Internets!", response.body
+  end
+
+  def test_expels_ie_6_and_redirects_to_default
+    request  = create_request
+    response = request.get("/", {"HTTP_USER_AGENT" => "Mozilla/4.0 (MSIE 6.0; Windows NT 5.1)" })
+    assert_equal 302, response.status
+    assert_equal response.location, "http://browsehappy.com/"
+  end
+
+  def test_expels_ie_6_and_redirects_to_internal_url
+    request  = create_request(:redirect => "/foo")
+    response = request.get("/", {"HTTP_USER_AGENT" => "Mozilla/4.0 (MSIE 6.0; Windows NT 5.1)" })
+    assert_equal 302, response.status
+    assert_equal response.location, "/foo"
+  end
+
+  def test_expels_ie_6_and_redirects_to_external_url
+    request  = create_request(:redirect => "http://getfirefox.com")
+    response = request.get("/", {"HTTP_USER_AGENT" => "Mozilla/4.0 (MSIE 6.0; Windows NT 5.1)" })
+    assert_equal 302, response.status
+    assert_equal response.location, "http://getfirefox.com"
+  end
+
+  def test_allows_ie_6_when_minimum
+    request  = create_request(:minimum_ie => 6.0)
+    response = request.get("/", {"HTTP_USER_AGENT" => "Mozilla/4.0 (MSIE 6.0; Windows NT 5.1)" })
+    assert_equal 200, response.status
+    assert_equal "Hi Internets!", response.body
+  end
+
+  def test_expels_ie_7
+    request  = create_request
+    response = request.get("/", {"HTTP_USER_AGENT" => "Mozilla/4.0 (compatible; MSIE 7.0; Windows NT 6.0)" })
+    assert_equal 302, response.status
+    assert_equal response.location, "http://browsehappy.com/"
+  end
+
+  def test_allows_ie_7_when_minimum
+    request  = create_request(:minimum_ie => 7.0)
+    response = request.get("/", {"HTTP_USER_AGENT" => "Mozilla/4.0 (compatible; MSIE 7.0; Windows NT 6.0)" })
+    assert_equal 200, response.status
+    assert_equal "Hi Internets!", response.body
+  end
+
+  def test_allows_ie_8
+    request  = create_request
+    response = request.get("/", {"HTTP_USER_AGENT" => "User-Agent:Mozilla/4.0 (compatible; MSIE 8.0; Windows NT 6.0; Trident/4.0)" })
+    assert_equal 200, response.status
+    assert_equal "Hi Internets!", response.body
+  end
+
+  def test_allows_ie_8_when_minimum
+    request  = create_request(:minimum_ie => 8.0)
+    response = request.get("/", {"HTTP_USER_AGENT" => "User-Agent:Mozilla/4.0 (compatible; MSIE 8.0; Windows NT 6.0; Trident/4.0)" })
+    assert_equal 200, response.status
+    assert_equal "Hi Internets!", response.body
+  end
+
+  def test_allows_ie_9
+    request  = create_request
+    response = request.get("/", {"HTTP_USER_AGENT" => "Mozilla/5.0 (compatible; MSIE 9.0; Windows NT 6.1; Trident/5.0;" })
+    assert_equal 200, response.status
+    assert_equal "Hi Internets!", response.body
+  end
+
+  # AOL
+  #################################################################################################
+
+  def test_expels_aol_6
+    request  = create_request
+    response = request.get("/", {"HTTP_USER_AGENT" => "Mozilla/4.0 (compatible; MSIE 5.5; AOL 6.0; Windows 98)" })
+    assert_equal 302, response.status
+    assert_equal response.location, "http://browsehappy.com/"
+  end
+
+  def test_expels_aol_7
+    request  = create_request
+    response = request.get("/", {"HTTP_USER_AGENT" => "Mozilla/4.0 (compatible; MSIE 7.0; AOL 7.0; Windows NT 5.1)" })
+    assert_equal 302, response.status
+    assert_equal response.location, "http://browsehappy.com/"
+  end
+
+  def test_expels_aol_8
+    request  = create_request
+    response = request.get("/", {"HTTP_USER_AGENT" => "Mozilla/4.0 (compatible; MSIE 7.0; AOL 8.0; Windows NT 5.1)" })
+    assert_equal 302, response.status
+    assert_equal response.location, "http://browsehappy.com/"
+  end
+
+  def test_expels_aol_9
+    request  = create_request
+    response = request.get("/", {"HTTP_USER_AGENT" => "Mozilla/4.0 (compatible; MSIE 7.0; AOL 9.0; Windows NT 5.1)" })
+    assert_equal 302, response.status
+    assert_equal response.location, "http://browsehappy.com/"
+  end
+
+  def test_expels_aol_9_1
+    request  = create_request
+    response = request.get("/", {"HTTP_USER_AGENT" => "Mozilla/4.0 (compatible; MSIE 7.0; AOL 9.1; AOLBuild 4334.5000; Windows NT 5.1; Trident/4.0)" })
+    assert_equal 302, response.status
+    assert_equal response.location, "http://browsehappy.com/"
+  end
+
+  def test_expels_aol_9_5
+    request  = create_request
+    response = request.get("/", {"HTTP_USER_AGENT" => "Mozilla/4.0 (compatible; MSIE 7.0; AOL 9.5; AOLBuild 4337.43; Windows NT 5.1; Trident/4.0)" })
+    assert_equal 302, response.status
+    assert_equal response.location, "http://browsehappy.com/"
+  end
+
+  def test_expels_aol_9_6
+    request  = create_request
+    response = request.get("/", {"HTTP_USER_AGENT" => "Mozilla/4.0 (compatible; MSIE 8.0; AOL 9.6; AOLBuild 4340.5004; Windows NT 5.1; Trident/4.0)" })
+    assert_equal 302, response.status
+    assert_equal response.location, "http://browsehappy.com/"
+  end
+
+  # Firefox
+  #################################################################################################
+
+  def test_allows_firefox_4
+    request  = create_request
+    response = request.get("/", {"HTTP_USER_AGENT" => "Mozilla/5.0 (Windows NT 6.1; rv:2.0.1) Gecko/20100101 Firefox/4.0" })
+    assert_equal 200, response.status
+    assert_equal "Hi Internets!", response.body
+  end
+
+  # Safari
+  #################################################################################################
+
+  def test_allows_safari_5_0
+    request  = create_request
+    response = request.get("/", {"HTTP_USER_AGENT" => "Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US) AppleWebKit/533.18.1 (KHTML, like Gecko) Version/5.0 Safari/533.16" })
+    assert_equal 200, response.status
+    assert_equal "Hi Internets!", response.body
+  end
+
+  def test_allows_safari_5_1
+    request  = create_request
+    response = request.get("/", {"HTTP_USER_AGENT" => "Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10_6_8; en-us) AppleWebKit/534.52.7 (KHTML, like Gecko) Version/5.1 Safari/534.52.7" })
+    assert_equal 200, response.status
+    assert_equal "Hi Internets!", response.body
+  end
+
+  # Chrome
+  #################################################################################################
+
+  def test_allows_chrome_16
+    request  = create_request
+    response = request.get("/", {"HTTP_USER_AGENT" => "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_7_2) AppleWebKit/535.7 (KHTML, like Gecko) Chrome/16.0.912.77 Safari/535.7" })
+    assert_equal 200, response.status
+    assert_equal "Hi Internets!", response.body
+  end
+
+  # Safe Paths
+  #################################################################################################
+
+  def test_allows_redirect_path
+    request  = create_request(:redirect => "/browser")
+    response = request.get("/browser", {"HTTP_USER_AGENT" => "Mozilla/4.0 (MSIE 6.0; Windows NT 5.1)" })
+    assert_equal 200, response.status
+    assert_equal "Hi Internets!", response.body
+  end
+
+  def test_expels_non_redirect_path
+    request  = create_request(:redirect => "/browser")
+    response = request.get("/wrong", {"HTTP_USER_AGENT" => "Mozilla/4.0 (MSIE 6.0; Windows NT 5.1)" })
+    assert_equal 302, response.status
+    assert_equal response.location, "/browser"
+  end
+
+  def test_allows_assets_path
+    request  = create_request
+    response = request.get("/assets", {"HTTP_USER_AGENT" => "Mozilla/4.0 (MSIE 6.0; Windows NT 5.1)" })
+    assert_equal 200, response.status
+    assert_equal "Hi Internets!", response.body
+  end
+
+  def test_allows_images_path
+    request  = create_request
+    response = request.get("/images", {"HTTP_USER_AGENT" => "Mozilla/4.0 (MSIE 6.0; Windows NT 5.1)" })
+    assert_equal 200, response.status
+    assert_equal "Hi Internets!", response.body
+  end
+
+  def test_allows_stylesheets_path
+    request  = create_request
+    response = request.get("/stylesheets", {"HTTP_USER_AGENT" => "Mozilla/4.0 (MSIE 6.0; Windows NT 5.1)" })
+    assert_equal 200, response.status
+    assert_equal "Hi Internets!", response.body
+  end
+
+  def test_allows_javascripts_path
+    request  = create_request
+    response = request.get("/javascripts", {"HTTP_USER_AGENT" => "Mozilla/4.0 (MSIE 6.0; Windows NT 5.1)" })
+    assert_equal 200, response.status
+    assert_equal "Hi Internets!", response.body
+  end
+
+  def test_allows_feedback_path
+    request  = create_request
+    response = request.get("/feedback", {"HTTP_USER_AGENT" => "Mozilla/4.0 (MSIE 6.0; Windows NT 5.1)" })
+    assert_equal 200, response.status
+    assert_equal "Hi Internets!", response.body
+  end
+
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification 
+name: rack-bouncer
+version: !ruby/object:Gem::Version 
+  hash: 11
+  prerelease: 
+  segments: 
+  - 1
+  - 2
+  version: "1.2"
+platform: ruby
+authors: 
+- Jerod Santo
+- Julio Cesar Ody
+- Will Jessop
+- Ryan Sobol
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-02-08 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: minitest
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 33
+        segments: 
+        - 2
+        - 11
+        - 1
+        version: 2.11.1
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rack
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 1
+        - 4
+        - 1
+        version: 1.4.1
+  type: :development
+  version_requirements: *id002
+description: A Rack middleware that expels undesirable browsers out of your website. This project lovingly extends the rack-noie6 gem.
+email: contact@ryansobol.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/rack/bouncer.rb
+- rack-bouncer.gemspec
+- test/lib/rack/bouncer_test.rb
+has_rdoc: true
+homepage: https://github.com/ryansobol/rack-bouncer
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ~>
+    - !ruby/object:Gem::Version 
+      hash: 57
+      segments: 
+      - 1
+      - 8
+      - 7
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 21
+      segments: 
+      - 1
+      - 3
+      - 7
+      version: 1.3.7
+requirements: []
+
+rubyforge_project: rack-bouncer
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: A Rack middleware that expels undesirable browsers out of your website.
+test_files: []
+