browsernizer 0.1.0 → 0.1.1

data/README.md

@@ -18,7 +18,42 @@ Hook it up:
 
 Configure browser support in `config/initializers/browsernizer.rb` file.
 
-All browsers that are not listed in initializer file will be considered to be **supported**.
+
+## Configuration
+
+Initializer file is pretty self explanatory. Here is the default one:
+
+    Rails.application.config.middleware.use Browsernizer::Router do |config|
+      config.supported "Internet Explorer", "9"
+      config.supported "Firefox", "4"
+      config.supported "Opera", "11.1"
+      config.supported "Chrome", "7"
+      config.location  "/browser.html"
+    end
+
+It states that IE9+, FF4+, Opera 11.1+ and Chrome 7+ are supported.
+Non listed browsers are considered to be supported regardless of their version.
+Unsupported browsers will be redirected to `/browser.html` page.
+
+If you wish to completely prevent some browsers from accessing website
+(regardless of their version), for now you can specify some really high
+version number (e.g. "666").
+
+Specifying location is optional. If you prefer handling unsupported browsers on
+your own, you can access browsernizer info from `request.env['browsernizer']`
+within your controller.
+
+For example, you can set before filter to display flash notice:
+
+    before_filter :check_browser_support
+
+    def check_browser_support
+      unless request.env['browsernizer']['supported']
+        flash.notice = "Your browser is not supported"
+      end
+    end
+
+You can also access `browser` and `version` variables from this env hash.
 
 
 ## Browsers
@@ -49,5 +84,5 @@ Browser detection is done using [useragent gem](https://github.com/josh/useragen
 
 Developed by Milovan Zogovic.
 
-I don't believe in licenses and other woody crap.
+I don't believe in licenses and other legal crap.
 Do whatever you want with this :)

data/lib/browsernizer/config.rb

@@ -3,7 +3,8 @@ module Browsernizer
 
     def initialize
       @supported = []
-      @location = "/unsupported-browser.html"
+      @location = nil
+      @handler = lambda { }
     end
 
     def supported(browser, version)

data/lib/browsernizer/router.rb

@@ -1,6 +1,8 @@
 module Browsernizer
 
   class Router
+    attr_reader :config
+
     def initialize(app, &block)
       @app = app
       @config = Config.new
@@ -9,17 +11,36 @@ module Browsernizer
 
     def call(env)
       @env = env
+      @env["browsernizer"] = {
+        "supported" => true,
+        "browser" => agent.browser.to_s,
+        "version" => agent.version.to_s
+      }
 
       if html_request? && !on_redirection_path? && unsupported?
-        [307, {"Content-Type" => "text/plain", "Location" => @config.get_location}, []]
+        handle_unsupported
       elsif html_request? && on_redirection_path? && !unsupported?
-        [303, {"Content-Type" => "text/plain", "Location" => "/"}, []]
+        handle_visits_by_accident
       else
         @app.call(env)
       end
     end
 
   private
+    def handle_unsupported
+      @env["browsernizer"]["supported"] = false
+
+      if @config.get_location
+        [307, {"Content-Type" => "text/plain", "Location" => @config.get_location}, []]
+      else
+        @app.call(@env)
+      end
+    end
+
+    def handle_visits_by_accident
+      [303, {"Content-Type" => "text/plain", "Location" => "/"}, []]
+    end
+
     def html_request?
       @env["HTTP_ACCEPT"] && @env["HTTP_ACCEPT"].include?("text/html")
     end
@@ -28,9 +49,12 @@ module Browsernizer
       @env["PATH_INFO"] && @env["PATH_INFO"] == @config.get_location
     end
 
+    def agent
+      ::UserAgent.parse @env["HTTP_USER_AGENT"]
+    end
+
     # supported by default
     def unsupported?
-      agent = ::UserAgent.parse @env["HTTP_USER_AGENT"]
       @config.get_supported.detect do |supported_browser|
         if agent.browser.to_s.downcase == supported_browser.browser.to_s.downcase
           a = BrowserVersion.new agent.version.to_s

data/lib/browsernizer/version.rb

@@ -1,3 +1,3 @@
 module Browsernizer
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/browsernizer.rb

@@ -1,9 +1,3 @@
-#TODO: remove when useragent gem is fixed
-require 'rubygems'
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
-require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE'])
-
-
 require "browsernizer/browser"
 require "browsernizer/browser_version"
 require "browsernizer/config"

data/spec/browsernizer/config_spec.rb

@@ -4,13 +4,6 @@ describe Browsernizer::Config do
 
   subject { config = Browsernizer::Config.new }
 
-  describe "new" do
-    it "sets the defaults" do
-      subject.get_supported.should == []
-      subject.get_location.should == "/unsupported-browser.html"
-    end
-  end
-
   describe "supported(name, version)" do
     it "defines new supported browser" do
       subject.supported "Chrome", "16.0"

data/spec/browsernizer/router_spec.rb

@@ -8,7 +8,6 @@ describe Browsernizer::Router do
     Browsernizer::Router.new(app) do |config|
       config.supported "Firefox", "4"
       config.supported "Chrome", "7.1"
-      config.location  "/browser.html"
     end
   end
 
@@ -21,8 +20,14 @@ describe Browsernizer::Router do
   end
 
   context "All Good" do
-    it "propagates request" do
-      app.should_receive(:call).with(default_env)
+    it "sets browsernizer env and propagates request" do
+      response = default_env.dup
+      response['browsernizer'] = {
+        'supported' => true,
+        'browser' => "Chrome",
+        'version' => "7.1.1"
+      }
+      app.should_receive(:call).with(response)
       subject.call(default_env)
     end
   end
@@ -34,15 +39,30 @@ describe Browsernizer::Router do
       })
     end
 
-    it "prevents propagation" do
-      app.should_not_receive(:call)
+    it "updates 'browsernizer' env variable and propagates request" do
+      @response = @env.dup
+      @response['browsernizer'] = {
+        'supported' => false,
+        'browser' => "Chrome",
+        'version' => "7"
+      }
+      app.should_receive(:call).with(@response)
       subject.call(@env)
     end
 
-    it "redirects to proper location" do
-      response = subject.call(@env)
-      response[0].should == 307
-      response[1]["Location"].should == "/browser.html"
+    context "location is set" do
+      before do
+        subject.config.location "/browser.html"
+      end
+      it "prevents propagation" do
+        app.should_not_receive(:call)
+        subject.call(@env)
+      end
+      it "redirects to proper location" do
+        response = subject.call(@env)
+        response[0].should == 307
+        response[1]["Location"].should == "/browser.html"
+      end
     end
 
     context "Non-html request" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: browsernizer
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-06 00:00:00.000000000Z
+date: 2012-02-08 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70114897960180 !ruby/object:Gem::Requirement
+  requirement: &70317243772500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70114897960180
+  version_requirements: *70317243772500
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70114897959760 !ruby/object:Gem::Requirement
+  requirement: &70317243772080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70114897959760
+  version_requirements: *70317243772080
 - !ruby/object:Gem::Dependency
   name: useragent
-  requirement: &70114897959260 !ruby/object:Gem::Requirement
+  requirement: &70317243771580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,7 +43,7 @@ dependencies:
         version: 0.4.6
   type: :runtime
   prerelease: false
-  version_requirements: *70114897959260
+  version_requirements: *70317243771580
 description: Rack middleware for redirecting unsupported user agents to "please upgrade"
   page
 email: