browsernizer 0.1.0

data/.gitignore

@@ -0,0 +1,6 @@
+.rvmrc
+.rspec
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in browsernizer.gemspec
+gemspec

data/README.md

@@ -0,0 +1,53 @@
+# Browsernizer
+
+Want friendly "please upgrade your browser" page? This gem is for you.
+
+You can redirect your visitors to any page you like (static or dynamic).
+Just specify `config.location` option in initializer file.
+
+
+## Installation
+
+Add following line to your `Gemfile`:
+
+    gem 'browsernizer'
+
+Hook it up:
+
+    rails generate browsernizer:install
+
+Configure browser support in `config/initializers/browsernizer.rb` file.
+
+All browsers that are not listed in initializer file will be considered to be **supported**.
+
+
+## Browsers
+
+You should specify browser name as a string. Here are the available options:
+
+* Chrome
+* Firefox
+* Safari
+* Opera
+* Internet Explorer
+
+And some less popular:
+
+* Android
+* webOS
+* BlackBerry
+* Symbian
+* Camino
+* Iceweasel
+* Seamonkey
+
+Browser detection is done using [useragent gem](https://github.com/josh/useragent).
+
+
+
+## Credits and License
+
+Developed by Milovan Zogovic.
+
+I don't believe in licenses and other woody crap.
+Do whatever you want with this :)

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+task :default => :spec
+
+RSpec::Core::RakeTask.new do |t|
+  t.ruby_opts = ["-w"]
+end

data/browsernizer.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "browsernizer/version"
+
+Gem::Specification.new do |s|
+  s.name        = "browsernizer"
+  s.version     = Browsernizer::VERSION
+  s.authors     = ["Milovan Zogovic"]
+  s.email       = ["milovan.zogovic@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{Want friendly "please upgrade your browser" page? This gem is for you.}
+  s.description = %q{Rack middleware for redirecting unsupported user agents to "please upgrade" page}
+
+  s.rubyforge_project = "browsernizer"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec"
+
+  s.add_runtime_dependency 'useragent', "~> 0.4.6"
+end

data/lib/browsernizer.rb

@@ -0,0 +1,13 @@
+#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"
+require "browsernizer/router"
+require "browsernizer/version"
+
+require 'useragent'

data/lib/browsernizer/browser.rb

@@ -0,0 +1,6 @@
+module Browsernizer
+
+  class Browser < Struct.new(:browser, :version)
+  end
+
+end

data/lib/browsernizer/browser_version.rb

@@ -0,0 +1,24 @@
+module Browsernizer
+  class BrowserVersion
+    include ::Comparable
+
+    attr_accessor :to_a
+
+    def initialize(version)
+      @version = version
+    end
+
+    def to_a
+      @version.split(".").map{ |s| s.to_i }
+    end
+
+    def <=>(other)
+      ([0]*6).zip(to_a, other.to_a).each do |dump, a, b|
+        r = (a||0) <=> (b||0)
+        return r unless r.zero?
+      end
+      0
+    end
+
+  end
+end

data/lib/browsernizer/config.rb

@@ -0,0 +1,26 @@
+module Browsernizer
+  class Config
+
+    def initialize
+      @supported = []
+      @location = "/unsupported-browser.html"
+    end
+
+    def supported(browser, version)
+      @supported << Browser.new(browser.to_s, version.to_s)
+    end
+
+    def location(path)
+      @location = path
+    end
+
+    def get_supported
+      @supported
+    end
+
+    def get_location
+      @location
+    end
+
+  end
+end

data/lib/browsernizer/router.rb

@@ -0,0 +1,46 @@
+module Browsernizer
+
+  class Router
+    def initialize(app, &block)
+      @app = app
+      @config = Config.new
+      yield(@config)
+    end
+
+    def call(env)
+      @env = env
+
+      if html_request? && !on_redirection_path? && unsupported?
+        [307, {"Content-Type" => "text/plain", "Location" => @config.get_location}, []]
+      elsif html_request? && on_redirection_path? && !unsupported?
+        [303, {"Content-Type" => "text/plain", "Location" => "/"}, []]
+      else
+        @app.call(env)
+      end
+    end
+
+  private
+    def html_request?
+      @env["HTTP_ACCEPT"] && @env["HTTP_ACCEPT"].include?("text/html")
+    end
+
+    def on_redirection_path?
+      @env["PATH_INFO"] && @env["PATH_INFO"] == @config.get_location
+    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
+          b = BrowserVersion.new supported_browser.version.to_s
+          a < b
+        end
+        # TODO: when useragent is fixed you can use just this line instead the above
+        # agent < supported_browser
+      end
+    end
+  end
+
+end

data/lib/browsernizer/version.rb

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

data/lib/generators/browsernizer/install_generator.rb

@@ -0,0 +1,12 @@
+module Browsernizer
+
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path("../../templates", __FILE__)
+
+    desc "Copies initializer script"
+    def copy_initializer
+      copy_file "browsernizer.rb", "config/initializers/browsernizer.rb"
+    end
+  end
+
+end

data/lib/generators/templates/browsernizer.rb

@@ -0,0 +1,7 @@
+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

data/spec/browsernizer/browser_version_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe Browsernizer::BrowserVersion do
+
+  describe "Comparable" do
+
+    it "is greater" do
+     version("2").should > version("1")
+     version("1.1").should > version("1")
+     version("1.1").should > version("1.0")
+     version("2").should > version("1.9")
+   end
+
+    it "is equal" do
+      version("1").should == version("1")
+      version("1").should == version("1.0")
+      version("1.0").should == version("1")
+    end
+
+    it "handles strings" do
+      version("1.0").should == version("1.0.alpha")
+    end
+
+  end
+
+
+  def version(str)
+    Browsernizer::BrowserVersion.new(str)
+  end
+
+end

data/spec/browsernizer/config_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+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"
+      subject.supported "Firefox", "10.0"
+      subject.get_supported.should have(2).items
+    end
+  end
+
+  describe "location(path)" do
+    it "sets the redirection path for unsupported browsers" do
+      subject.location "foo.html"
+      subject.get_location.should == "foo.html"
+    end
+  end
+
+end

data/spec/browsernizer/router_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+
+describe Browsernizer::Router do
+
+  let(:app) { mock() }
+
+  subject do
+    Browsernizer::Router.new(app) do |config|
+      config.supported "Firefox", "4"
+      config.supported "Chrome", "7.1"
+      config.location  "/browser.html"
+    end
+  end
+
+  let(:default_env) do
+    {
+      "HTTP_USER_AGENT" => chrome_agent("7.1.1"),
+      "HTTP_ACCEPT" => "text/html",
+      "PATH_INFO" => "/index"
+    }
+  end
+
+  context "All Good" do
+    it "propagates request" do
+      app.should_receive(:call).with(default_env)
+      subject.call(default_env)
+    end
+  end
+
+  context "Unsupported Browser" do
+    before do
+      @env = default_env.merge({
+        "HTTP_USER_AGENT" => chrome_agent("7")
+      })
+    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
+
+    context "Non-html request" do
+      before do
+        @env = @env.merge({
+          "HTTP_ACCEPT" => "text/css"
+        })
+      end
+      it "propagates request" do
+        app.should_receive(:call).with(@env)
+        subject.call(@env)
+      end
+    end
+
+    context "Already on /browser.html page" do
+      before do
+        @env = @env.merge({
+          "PATH_INFO" => "/browser.html"
+        })
+      end
+      it "propagates request" do
+        app.should_receive(:call).with(@env)
+        subject.call(@env)
+      end
+    end
+  end
+
+
+  def chrome_agent(version)
+    "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_7_2) AppleWebKit/535.7 (KHTML, like Gecko) Chrome/#{version} Safari/535.7"
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'rspec'
+require 'browsernizer'

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: browsernizer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Milovan Zogovic
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-06 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70114897960180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70114897960180
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70114897959760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70114897959760
+- !ruby/object:Gem::Dependency
+  name: useragent
+  requirement: &70114897959260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.6
+  type: :runtime
+  prerelease: false
+  version_requirements: *70114897959260
+description: Rack middleware for redirecting unsupported user agents to "please upgrade"
+  page
+email:
+- milovan.zogovic@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- browsernizer.gemspec
+- lib/browsernizer.rb
+- lib/browsernizer/browser.rb
+- lib/browsernizer/browser_version.rb
+- lib/browsernizer/config.rb
+- lib/browsernizer/router.rb
+- lib/browsernizer/version.rb
+- lib/generators/browsernizer/install_generator.rb
+- lib/generators/templates/browsernizer.rb
+- spec/browsernizer/browser_version_spec.rb
+- spec/browsernizer/config_spec.rb
+- spec/browsernizer/router_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: browsernizer
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Want friendly "please upgrade your browser" page? This gem is for you.
+test_files:
+- spec/browsernizer/browser_version_spec.rb
+- spec/browsernizer/config_spec.rb
+- spec/browsernizer/router_spec.rb
+- spec/spec_helper.rb