RubyGems - rack-useragent-filter - Versions diffs - 0.1.3 - Mend

rack-useragent-filter 0.1.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (10) hide show

data/README.rdoc +68 -0
data/Rakefile +28 -0
data/VERSION +1 -0
data/examples/upgrade.html +26 -0
data/lib/rack/user_agent.rb +4 -0
data/lib/rack/user_agent/filter.rb +45 -0
data/test/fixtures/upgrade.erb +1 -0
data/test/test_helper.rb +11 -0
data/test/user_agent_filter_test.rb +81 -0
metadata +111 -0

data/README.rdoc ADDED Viewed

@@ -0,0 +1,68 @@
+= 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>- 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"
+<em>- But... what if IE6 user do wants to see how page looks like in his favourite browser?</em>
+You can show button "I take full responsibility of using IE6. Let me in!". User clicks button and with some little help
+of Javascript cookie named i.e: "deprecated_browser" is saved on user's disk.
+Next time user hits application, middleware checks request for inclusion of cookie "deprecated_browser".
+If it exists unsupported browsers detection is disabled for this user.
+config.middleware.use "Rack::UserAgent::Filter", [
+  {:browser => "Internet Explorer", :version => "7.0"}
+], :force_with_cookie => "deprecated_browser"
+Enjoy it!
+== Authors
+* Sergio Gil <sgilperez@gmail.com>
+* Luismi Cavallé <luismi@lmcavalle.com>
+== Contributors
+* Tomasz Mazur <defkode@gmail.com>
+We're looking forward for your patches. Fork us!
+Copyright (c) 2008 BeBanjo, released under the MIT license

data/Rakefile ADDED Viewed

@@ -0,0 +1,28 @@
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+desc 'Default: run unit tests.'
+task :default => :test
+desc 'Run all tests'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "rack-useragent-filter"
+    gemspec.authors = ["Sergio Gil", "Luismi Cavallé", "Tomasz Mazur"]
+    gemspec.email = ["ballsbreaking@bebanjo.com", "defkode@gmail.com"]
+    gemspec.homepage = "http://github.com/defkode/rack-useragent"
+    gemspec.summary = "Rack Middleware for filtering by user agent"
+    gemspec.add_dependency('rack', '>= 0.9.1')
+    gemspec.add_dependency('useragent', '>=0.1.4')
+  end
+rescue LoadError
+end

data/VERSION ADDED Viewed

	@@ -0,0 +1 @@
1	+ 0.1.3

data/examples/upgrade.html ADDED Viewed

@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Your Browser is not fully Supported</title>
+    <script type='text/javascript'>
+      //<![CDATA[
+        // save cookie
+        function createCookie(name, value) {
+        	document.cookie = name + "=" + value + "; path=/";
+        }
+        // creates cookie "deprecated_browser" with UserAgent as value and reloads the page
+        function continueWithUnsupportedBrowser(){
+          createCookie('deprecated_browser', window.navigator.userAgent);
+          document.location.reload(true);
+          return false
+        }
+      //]]>
+    </script>
+  </head>
+  <body>
+    This is upgrade.html
+    <button onclick='continueWithUnsupportedBrowser()'>I am aware of this restriction, I want to continue</button>
+  </body>
+</html>

data/lib/rack/user_agent.rb ADDED Viewed

@@ -0,0 +1,4 @@
+require 'rack'
+require 'rack/mock'
+require 'rack/user_agent/filter'

data/lib/rack/user_agent/filter.rb ADDED Viewed

@@ -0,0 +1,45 @@
+require 'user_agent'
+require 'erb'
+require 'ostruct'
+module Rack::UserAgent
+  class Filter
+    def initialize(app, browsers = [], options = {})
+      @app                = app
+      @browsers           = browsers
+      @template           = options[:template]
+      @force_with_cookie  = options[:force_with_cookie]
+    end
+    def call(env)
+      request = Rack::Request.new(env)
+      browser = UserAgent.parse(env["HTTP_USER_AGENT"]) if env["HTTP_USER_AGENT"]
+      if !detection_disabled_by_cookie?(request.cookies) && unsupported?(browser)
+        content = render_page(browser)
+        [400, {"Content-Type" => "text/html", "Content-Length" => content.length.to_s}, content]
+      else
+        @app.call(env)
+      end
+    end
+    private
+    def unsupported?(browser)
+      browser && @browsers.map{ |hash| browser < OpenStruct.new(hash) }.any?
+    end
+    def detection_disabled_by_cookie?(cookies)
+      @force_with_cookie && cookies.keys.include?(@force_with_cookie)
+    end
+    def render_page(browser)
+      if @template && File.exists?(@template)
+        @browser = browser # for the template
+        ERB.new(File.read(@template)).result(binding)
+      else
+        "Sorry, your browser is not supported. Please upgrade"
+      end
+    end
+  end
+end

data/test/fixtures/upgrade.erb ADDED Viewed

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

data/test/test_helper.rb ADDED Viewed

@@ -0,0 +1,11 @@
+require "rubygems"
+require "rack/test"
+require "shoulda"
+require File.dirname(__FILE__) + '/../lib/rack/user_agent'
+class SampleApp
+  def call(env)
+    [200, {}, "Sample Response"]
+  end
+end

data/test/user_agent_filter_test.rb ADDED Viewed

@@ -0,0 +1,81 @@
+require File.dirname(__FILE__) + '/test_helper'
+class UserAgentFilterTest < Test::Unit::TestCase
+  include Rack::Test::Methods
+  def setup
+    @outdated_browser = "Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; SV1)" # IE6
+    @modern_browser   = "Mozilla/4.0 (compatible; MSIE 8.0; Windows NT 6.0)"      # IE8
+  end
+  def app
+    SampleApp.new
+  end
+  context "default page" do
+    setup do
+      def app
+       Rack::Builder.new do
+          use Rack::UserAgent::Filter, [{:browser => "Internet Explorer", :version => "7.0"}]
+          run SampleApp.new
+        end
+      end
+    end
+    should "pass" do
+      header "User-Agent", @modern_browser
+      get '/'
+      assert_equal "Sample Response", last_response.body
+    end
+    should "filter" do
+      header "User-Agent", @outdated_browser
+      get '/'
+      assert_equal "Sorry, your browser is not supported. Please upgrade", last_response.body
+    end
+  end
+  context "custom page" do
+    setup do
+      def app
+        Rack::Builder.new do
+           use Rack::UserAgent::Filter, [{:browser => "Internet Explorer", :version => "7.0"}], :template => File.dirname(__FILE__) + "/fixtures/upgrade.erb"
+           run SampleApp.new
+         end
+      end
+    end
+    should "work" do
+      header "User-Agent", @outdated_browser
+      get '/'
+      assert_equal "Hello, Internet Explorer 6.0!", last_response.body
+    end
+  end
+  context "cookie" do
+    setup do
+      def app
+        Rack::Builder.new do
+           use Rack::UserAgent::Filter, [{:browser => "Internet Explorer", :version => "7.0"}], :force_with_cookie => "browser"
+           run SampleApp.new
+         end
+      end
+    end
+    should "pass if cookie set" do
+      header "User-Agent", @outdated_browser
+      set_cookie "browser=Internet Explorer"
+      get '/'
+      assert_equal "Sample Response", last_response.body
+      clear_cookies
+      get '/'
+      assert_equal "Sorry, your browser is not supported. Please upgrade", last_response.body
+    end
+  end
+end

metadata ADDED Viewed

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: rack-useragent-filter
+version: !ruby/object:Gem::Version
+  hash: 29
+  prerelease: false
+  segments:
+  - 0
+  - 1
+  - 3
+  version: 0.1.3
+platform: ruby
+authors:
+- Sergio Gil
+- "Luismi Cavall\xC3\xA9"
+- Tomasz Mazur
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2010-06-01 00:00:00 +02: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: 57
+        segments:
+        - 0
+        - 9
+        - 1
+        version: 0.9.1
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency
+  name: useragent
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        hash: 19
+        segments:
+        - 0
+        - 1
+        - 4
+        version: 0.1.4
+  type: :runtime
+  version_requirements: *id002
+description:
+email:
+- ballsbreaking@bebanjo.com
+- defkode@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+files:
+- README.rdoc
+- Rakefile
+- VERSION
+- examples/upgrade.html
+- lib/rack/user_agent.rb
+- lib/rack/user_agent/filter.rb
+- test/fixtures/upgrade.erb
+- test/test_helper.rb
+- test/user_agent_filter_test.rb
+has_rdoc: true
+homepage: http://github.com/defkode/rack-useragent
+licenses: []
+post_install_message:
+rdoc_options:
+- --charset=UTF-8
+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: 3
+      segments:
+      - 0
+      version: "0"
+requirements: []
+rubyforge_project:
+rubygems_version: 1.3.7
+signing_key:
+specification_version: 3
+summary: Rack Middleware for filtering by user agent
+test_files:
+- test/test_helper.rb
+- test/user_agent_filter_test.rb