bebanjo-rack-useragent 0.0.1

data/README.rdoc

@@ -0,0 +1,58 @@
+= Rack::UserAgent
+
+Rack Middleware for filtering by user agent
+
+== Use
+
+Let's say you don't support IE6 and want to prevent IE6 users from accessing to your Rails app. You're in luck. Just add this to your <tt>config/environment.rb</tt>:
+
+  config.gem "bebanjo-rack-useragent", :lib => "rack/user_agent", :source => "http://gems.github.com"
+  
+  config.middleware.use "Rack::UserAgent::Filter", [
+    {:browser => "Internet Explorer", :version => "7.0"}
+  ]
+  
+And, of course, install the gem:
+
+  $ [sudo] rake gems:install
+  
+Done! From now on users with IE version lower than 7.0 will get a nice error message saying that their browsers need to be updated... Ok, ok, not so nice message, you can personalize it by putting an <tt>upgrade.html</tt> file inside the <tt>/public</tt> directory of your application.
+
+<em>- Hey, I need to show localized versions of the message to my french and spanish users!</em>
+
+No problem, just add <tt>upgrade.es.html</tt> and <tt>upgrade.fr.html</tt> to <tt>/public</tt> (Note that <tt>rack.locale</tt> env variable needs to be previously set for this to work. <tt>Rack::Locale</tt> in rack-contrib[http://github.com/rack/rack-contrib] can do that for you)
+
+<em>- Cool!, what about something more dynamic... like ERB?</em>
+
+Granted! You'll have to add to the config which template to use. In <tt>environment.rb</tt>:
+
+  config.middleware.use "Rack::UserAgent::Filter", [
+    {:browser => "Internet Explorer", :version => "7.0"}
+  ], :template => "#{RAILS_ROOT}/app/views/shared/upgrade.html.erb"
+  
+Then you could show the browser version as part of your message:
+
+  Sorry but <%= "#{@browser.browser} #{@browser.version}" %> is not supported
+  
+<em>- Can I use it with non-Rails Rack frameworks, like Sinatra?</em>
+
+Sure. You only have to take into account that you'll always have to set which template to use. i.e: In <tt>config.ru</tt>:
+
+  require 'rack/user_agent'
+  
+  use Rack::UserAgent::Filter, [
+    {:browser => "Internet Explorer", :version => "7.0"}
+  ], :template => File.dirname(__FILE__) + "/public/upgrade.html"
+  
+Enjoy it!
+
+== Authors
+
+* Sergio Gil <sgilperez@gmail.com>
+* Luismi Cavallé <luismi@lmcavalle.com>
+
+== Contributors
+
+We're looking forward for your patches. Fork us!
+
+Copyright (c) 2008 BeBanjo, released under the MIT license

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/rack/user_agent/filter.rb

@@ -0,0 +1,46 @@
+require 'rubygems'
+require 'user_agent'
+require 'erb'
+require 'ostruct'
+
+module Rack::UserAgent
+  class Filter
+    def initialize(app, config = [], options = {})
+      @app = app
+      @browsers = config
+      @template = options[:template]
+    end
+
+    def call(env)
+      browser = UserAgent.parse(env["HTTP_USER_AGENT"]) if env["HTTP_USER_AGENT"]
+      if unsupported?(browser)
+        [400, {"Content-Type" => "text/html"}, page(env['rack.locale'], browser)]
+      else
+        @app.call(env)
+      end
+    end
+
+    private
+
+    def unsupported?(browser)
+       browser && @browsers.any? { |hash| browser < OpenStruct.new(hash) }
+    end
+
+    def page(locale, browser)
+      return "Sorry, your browser is not supported. Please upgrade" unless template = template_file(locale)
+      @browser = browser # for the template
+      ERB.new(File.read(template)).result(binding)
+    end
+
+    def template_file(locale)
+      candidates = [ @template ]
+      
+      if defined?(RAILS_ROOT)
+        candidates += [ File.join(RAILS_ROOT, "public", "upgrade.#{locale}.html"),
+                        File.join(RAILS_ROOT, "public", "upgrade.html") ] 
+      end
+               
+      candidates.compact.detect{ |template| File.exists?(template) }
+    end
+  end
+end

data/lib/rack/user_agent.rb

@@ -0,0 +1,6 @@
+require 'rack'
+
+module Rack::UserAgent
+  VERSION = "0.1.0"
+  autoload :Filter, 'rack/user_agent/filter'  
+end

data/rack-useragent.gemspec

@@ -0,0 +1,50 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{rack-useragent}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Sergio Gil", "Luismi Cavall\303\251"]
+  s.date = %q{2009-05-22}
+  s.email = %q{ballsbreaking@bebanjo.com}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    "README.rdoc",
+     "VERSION",
+     "lib/rack/user_agent.rb",
+     "lib/rack/user_agent/filter.rb",
+     "rack-useragent.gemspec",
+     "test/public/upgrade.es.html",
+     "test/public/upgrade.html",
+     "test/upgrade.erb",
+     "test/user_agent_filter_test.rb"
+  ]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/bebanjo/rack-useragent}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Rack Middleware for filtering by user agent}
+  s.test_files = [
+    "test/user_agent_filter_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rack>, [">= 0.9.1"])
+      s.add_runtime_dependency(%q<josh-useragent>, [">= 0"])
+    else
+      s.add_dependency(%q<rack>, [">= 0.9.1"])
+      s.add_dependency(%q<josh-useragent>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rack>, [">= 0.9.1"])
+    s.add_dependency(%q<josh-useragent>, [">= 0"])
+  end
+end

data/test/public/upgrade.es.html

@@ -0,0 +1 @@
+This is upgrade.es.html

data/test/public/upgrade.html

@@ -0,0 +1 @@
+This is upgrade.html

data/test/upgrade.erb

@@ -0,0 +1 @@
+Hello, <%= "#{@browser.browser} #{@browser.version}" %>!

data/test/user_agent_filter_test.rb

@@ -0,0 +1,81 @@
+require 'test/unit'
+require 'rubygems'
+require 'mocha'
+
+require File.dirname(__FILE__) + '/../lib/rack/user_agent'
+
+class UserAgentFilterTest < Test::Unit::TestCase
+  
+  STATUS  = 0
+  HEADERS = 1
+  BODY    = 2
+  
+  def setup
+    @app_response = stub
+    @app = stub(:call => @app_response)
+  end
+  
+  def teardown
+    Object.send(:remove_const, "RAILS_ROOT") if defined?(RAILS_ROOT)
+  end
+  
+  def test_user_agent_supported
+    filter = Rack::UserAgent::Filter.new(@app, [{:browser => "Internet Explorer", :version => "7.0"}])
+    env = {"HTTP_USER_AGENT" => "Mozilla/4.0 (compatible; MSIE 7.0; Windows NT 6.0)"}
+    @app.expects(:call).with(env).returns(@app_response)
+    response = filter.call(env)
+    assert_equal @app_response, response
+  end
+  
+  def test_no_config_given
+    filter = Rack::UserAgent::Filter.new(@app)
+    env = {"HTTP_USER_AGENT" => "Mozilla/4.0 (compatible; MSIE 7.0; Windows NT 6.0)"}
+    response = filter.call(env)
+    assert_equal @app_response, response
+  end
+  
+  def test_no_user_agent
+    filter = Rack::UserAgent::Filter.new(@app, [{:browser => "Internet Explorer", :version => "7.0"}])
+    response = filter.call({})
+    assert_equal @app_response, response
+  end
+  
+  def test_user_agent_unsupported
+    filter = Rack::UserAgent::Filter.new(@app, [{:browser => "Internet Explorer", :version => "7.0"}])
+    response = filter.call("HTTP_USER_AGENT" => "Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; SV1)")
+    assert_equal 400, response[STATUS]
+    assert response[BODY].include?("Sorry, your browser is not supported. Please upgrade")
+  end
+  
+  def test_user_agent_not_unsupported
+    filter = Rack::UserAgent::Filter.new(@app, [{:browser => "Internet Explorer", :version => "7.0"}])
+    response = filter.call("HTTP_USER_AGENT" => "Mozilla/5.0 (Macintosh; U; Intel Mac OS X; en-US; rv:1.8.1.14) Gecko/20080404 Firefox/2.0.0.14")
+    assert_equal @app_response, response
+  end
+  
+  def test_upgrade_html_is_served_if_available
+    Object.const_set("RAILS_ROOT", File.dirname(__FILE__))
+    filter = Rack::UserAgent::Filter.new(@app, [{:browser => "Internet Explorer", :version => "7.0"}])
+    response = filter.call("HTTP_USER_AGENT" => "Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; SV1)")
+    assert_equal 400, response[STATUS]
+    assert_equal "This is upgrade.html", response[BODY]
+  end
+
+  def test_localized_upgrade_html
+    Object.const_set("RAILS_ROOT", File.dirname(__FILE__))
+    filter = Rack::UserAgent::Filter.new(@app, [{:browser => "Internet Explorer", :version => "7.0"}])
+    response = filter.call("HTTP_USER_AGENT" => "Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; SV1)",
+                           "rack.locale" => "es")
+    assert_equal 400, response[STATUS]
+    assert_equal "This is upgrade.es.html", response[BODY]
+  end
+  
+  def test_erb_template
+    filter = Rack::UserAgent::Filter.new(@app, [{:browser => "Internet Explorer", :version => "7.0"}], 
+                                               :template => File.dirname(__FILE__) + "/upgrade.erb")
+    response = filter.call("HTTP_USER_AGENT" => "Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; SV1)")
+    assert_equal 400, response[STATUS]
+    assert_equal "Hello, Internet Explorer 6.0!", response[BODY]
+  end
+  
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification 
+name: bebanjo-rack-useragent
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Sergio Gil
+- "Luismi Cavall\xC3\xA9"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-22 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rack
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.9.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: josh-useragent
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: ballsbreaking@bebanjo.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- README.rdoc
+- VERSION
+- lib/rack/user_agent.rb
+- lib/rack/user_agent/filter.rb
+- rack-useragent.gemspec
+- test/public/upgrade.es.html
+- test/public/upgrade.html
+- test/upgrade.erb
+- test/user_agent_filter_test.rb
+has_rdoc: true
+homepage: http://github.com/bebanjo/rack-useragent
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Rack Middleware for filtering by user agent
+test_files: 
+- test/user_agent_filter_test.rb