rack-useragent-filter 0.1.4 → 0.1.7

data/.gitignore

@@ -0,0 +1,2 @@
+pkg
+*.gem

data/README.rdoc

@@ -1,20 +1,20 @@
-= Rack::UserAgent
+= Rack::UserAgent::Filter
 
 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>:
+Let's say you don't support IE6 and want to prevent IE6 users from accessing to your Rack app. You're in luck. Just add this to your Gemfile:
+  
+  gem "rack-useragent-filter", :require => "rack/useragent/filter"
 
-  config.gem "rack-useragent-filter", :lib => "rack/user_agent"
   
-  config.middleware.use "Rack::UserAgent::Filter", [
-    {:browser => "Internet Explorer", :version => "7.0"}
+  in config.ru:
+  
+  use Rack::UserAgent::Filter, [
+    ["Internet Explorer", "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.
 
@@ -22,23 +22,15 @@ Done! From now on users with IE version lower than 7.0 will get a nice error mes
 
 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"
+  use Rack::UserAgent::Filter, [
+    ["Internet Explorer", "7.0"]
+  ], :template => File.dirname(__FILE__) + "/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>
@@ -49,20 +41,15 @@ Next time user hits application, middleware checks request for inclusion of cook
 If it exists unsupported browsers detection is disabled for this user.
 
 config.middleware.use "Rack::UserAgent::Filter", [
-  {:browser => "Internet Explorer", :version => "7.0"}
+  ["Internet Explorer", "7.0"]
 ], :force_with_cookie => "deprecated_browser"
-  
-Enjoy it!
 
 == Authors
 
+* Tomasz Mazur <defkode@gmail.com>
 * 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

@@ -17,9 +17,9 @@ begin
   require 'jeweler'
   Jeweler::Tasks.new do |gemspec|
     gemspec.name = "rack-useragent-filter"
-    gemspec.authors = ["Sergio Gil", "Luismi Cavallé"]
-    gemspec.email = "ballsbreaking@bebanjo.com"
-    gemspec.homepage = "http://github.com/bebanjo/rack-useragent"
+    gemspec.authors = ["Tomasz Mazur", "Sergio Gil", "Luismi Cavallé"]
+    gemspec.email = "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.5')

data/VERSION

@@ -1 +1 @@
-0.1.4
+0.1.7

data/lib/rack/useragent/filter.rb

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

data/rack-useragent-filter.gemspec

@@ -0,0 +1,59 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{rack-useragent-filter}
+  s.version = "0.1.7"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Tomasz Mazur", "Sergio Gil", "Luismi Cavall\303\251"]
+  s.date = %q{2010-09-03}
+  s.email = %q{defkode@gmail.com}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "examples/upgrade.html",
+     "lib/rack/useragent/filter.rb",
+     "rack-useragent-filter.gemspec",
+     "test/fixtures/upgrade.erb",
+     "test/fixtures/upgrade.haml",
+     "test/test_helper.rb",
+     "test/user_agent_filter_test.rb"
+  ]
+  s.homepage = %q{http://github.com/defkode/rack-useragent}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Rack Middleware for filtering by user agent}
+  s.test_files = [
+    "test/test_helper.rb",
+     "test/user_agent_filter_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rack>, [">= 0.9.1"])
+      s.add_runtime_dependency(%q<useragent>, [">= 0.1.5"])
+      s.add_runtime_dependency(%q<tilt>, [">= 1.0.0"])
+    else
+      s.add_dependency(%q<rack>, [">= 0.9.1"])
+      s.add_dependency(%q<useragent>, [">= 0.1.5"])
+      s.add_dependency(%q<tilt>, [">= 1.0.0"])
+    end
+  else
+    s.add_dependency(%q<rack>, [">= 0.9.1"])
+    s.add_dependency(%q<useragent>, [">= 0.1.5"])
+    s.add_dependency(%q<tilt>, [">= 1.0.0"])
+  end
+end
+

data/test/test_helper.rb

@@ -2,7 +2,7 @@ require "rubygems"
 require "rack/test"
 require "shoulda"
 
-require File.dirname(__FILE__) + '/../lib/rack/user_agent'
+require File.dirname(__FILE__) + '/../rack-useragent-filter'
 
 class SampleApp
   def call(env)

data/test/user_agent_filter_test.rb

@@ -17,7 +17,7 @@ class UserAgentFilterTest < Test::Unit::TestCase
     setup do
       def app
        Rack::Builder.new do
-          use Rack::UserAgent::Filter, [{:browser => "Internet Explorer", :version => "7.0"}]
+          use Rack::UserAgent::Filter, [["Internet Explorer", "7.0"]]
           run SampleApp.new
         end
       end
@@ -40,7 +40,7 @@ class UserAgentFilterTest < Test::Unit::TestCase
     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"
+           use Rack::UserAgent::Filter, [["Internet Explorer", "7.0"]], :template => File.dirname(__FILE__) + "/fixtures/upgrade.erb"
            run SampleApp.new
          end
       end
@@ -58,7 +58,7 @@ class UserAgentFilterTest < Test::Unit::TestCase
     setup do
       def app
         Rack::Builder.new do
-           use Rack::UserAgent::Filter, [{:browser => "Internet Explorer", :version => "7.0"}], :template => File.dirname(__FILE__) + "/fixtures/upgrade.haml"
+           use Rack::UserAgent::Filter, [["Internet Explorer", "7.0"]], :template => File.dirname(__FILE__) + "/fixtures/upgrade.haml"
            run SampleApp.new
          end
       end
@@ -77,7 +77,7 @@ class UserAgentFilterTest < Test::Unit::TestCase
     setup do
       def app
         Rack::Builder.new do
-           use Rack::UserAgent::Filter, [{:browser => "Internet Explorer", :version => "7.0"}], :force_with_cookie => "browser"
+           use Rack::UserAgent::Filter, [["Internet Explorer", "7.0"]], :force_with_cookie => "browser"
            run SampleApp.new
          end
       end

metadata

@@ -1,22 +1,23 @@
 --- !ruby/object:Gem::Specification 
 name: rack-useragent-filter
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 21
   prerelease: false
   segments: 
   - 0
   - 1
-  - 4
-  version: 0.1.4
+  - 7
+  version: 0.1.7
 platform: ruby
 authors: 
+- Tomasz Mazur
 - Sergio Gil
 - "Luismi Cavall\xC3\xA9"
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2010-07-20 00:00:00 +02:00
+date: 2010-09-03 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -68,7 +69,7 @@ dependencies:
   type: :runtime
   version_requirements: *id003
 description: 
-email: ballsbreaking@bebanjo.com
+email: defkode@gmail.com
 executables: []
 
 extensions: []
@@ -76,18 +77,19 @@ extensions: []
 extra_rdoc_files: 
 - README.rdoc
 files: 
+- .gitignore
 - README.rdoc
 - Rakefile
 - VERSION
 - examples/upgrade.html
-- lib/rack/user_agent.rb
-- lib/rack/user_agent/filter.rb
+- lib/rack/useragent/filter.rb
+- rack-useragent-filter.gemspec
 - test/fixtures/upgrade.erb
 - test/fixtures/upgrade.haml
 - test/test_helper.rb
 - test/user_agent_filter_test.rb
 has_rdoc: true
-homepage: http://github.com/bebanjo/rack-useragent
+homepage: http://github.com/defkode/rack-useragent
 licenses: []
 
 post_install_message: 

data/lib/rack/user_agent.rb

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

data/lib/rack/user_agent/filter.rb

@@ -1,46 +0,0 @@
-require 'user_agent'
-require 'erb'
-require 'tilt'
-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
-        Tilt.new(@template).render(self)
-      else
-        "Sorry, your browser is not supported. Please upgrade" 
-      end
-    end
-
-  end
-end