user_agent_info 0.1.0

data/doc/rdoc-style.css

@@ -0,0 +1,208 @@
+
+body {
+    font-family: Verdana,Arial,Helvetica,sans-serif;
+    font-size:   90%;
+    margin: 0;
+    margin-left: 40px;
+    padding: 0;
+    background: white;
+}
+
+h1,h2,h3,h4 { margin: 0; color: #efefef; background: transparent; }
+h1 { font-size: 150%; }
+h2,h3,h4 { margin-top: 1em; }
+
+a { background: #eef; color: #039; text-decoration: none; }
+a:hover { background: #039; color: #eef; }
+
+/* Override the base stylesheet's Anchor inside a table cell */
+td > a {
+  background: transparent;
+  color: #039;
+  text-decoration: none;
+}
+
+/* and inside a section title */
+.section-title > a {
+  background: transparent;
+  color: #eee;
+  text-decoration: none;
+}
+
+/* === Structural elements =================================== */
+
+div#index {
+    margin: 0;
+    margin-left: -40px;
+    padding: 0;
+    font-size: 90%;
+}
+
+
+div#index a {
+    margin-left: 0.7em;
+}
+
+div#index .section-bar {
+   margin-left: 0px;
+   padding-left: 0.7em;
+   background: #ccc;
+   font-size: small;
+}
+
+
+div#classHeader, div#fileHeader {
+    width: auto;
+    color: white;
+    padding: 0.5em 1.5em 0.5em 1.5em;
+    margin: 0;
+    margin-left: -40px;
+    border-bottom: 3px solid #006;
+}
+
+div#classHeader a, div#fileHeader a {
+    background: inherit;
+    color: white;
+}
+
+div#classHeader td, div#fileHeader td {
+    background: inherit;
+    color: white;
+}
+
+
+div#fileHeader {
+    background: #057;
+}
+
+div#classHeader {
+    background: #048;
+}
+
+
+.class-name-in-header {
+  font-size:  180%;
+  font-weight: bold;
+}
+
+
+div#bodyContent {
+    padding: 0 1.5em 0 1.5em;
+}
+
+div#description {
+    padding: 0.5em 1.5em;
+    background: #efefef;
+    border: 1px dotted #999;
+}
+
+div#description h1,h2,h3,h4,h5,h6 {
+    color: #125;;
+    background: transparent;
+}
+
+div#validator-badges {
+    text-align: center;
+}
+div#validator-badges img { border: 0; }
+
+div#copyright {
+    color: #333;
+    background: #efefef;
+    font: 0.75em sans-serif;
+    margin-top: 5em;
+    margin-bottom: 0;
+    padding: 0.5em 2em;
+}
+
+
+/* === Classes =================================== */
+
+table.header-table {
+    color: white;
+    font-size: small;
+}
+
+.type-note {
+    font-size: small;
+    color: #DEDEDE;
+}
+
+.xxsection-bar {
+    background: #eee;
+    color: #333;
+    padding: 3px;
+}
+
+.section-bar {
+   color: #333;
+   border-bottom: 1px solid #999;
+    margin-left: -20px;
+}
+
+
+.section-title {
+    background: #79a;
+    color: #eee;
+    padding: 3px;
+    margin-top: 2em;
+    margin-left: -30px;
+    border: 1px solid #999;
+}
+
+.top-aligned-row {  vertical-align: top }
+.bottom-aligned-row { vertical-align: bottom }
+
+/* --- Context section classes ----------------------- */
+
+.context-row { }
+.context-item-name { font-family: monospace; font-weight: bold; color: black; }
+.context-item-value { font-size: small; color: #448; }
+.context-item-desc { color: #333; padding-left: 2em; }
+
+/* --- Method classes -------------------------- */
+.method-detail {
+    background: #efefef;
+    padding: 0;
+    margin-top: 0.5em;
+    margin-bottom: 1em;
+    border: 1px dotted #ccc;
+}
+.method-heading {
+  color: black;
+  background: #ccc;
+  border-bottom: 1px solid #666;
+  padding: 0.2em 0.5em 0 0.5em;
+}
+.method-signature { color: black; background: inherit; }
+.method-name { font-weight: bold; }
+.method-args { font-style: italic; }
+.method-description { padding: 0 0.5em 0 0.5em; }
+
+/* --- Source code sections -------------------- */
+
+a.source-toggle { font-size: 90%; }
+div.method-source-code {
+    background: #262626;
+    color: #ffdead;
+    margin: 1em;
+    padding: 0.5em;
+    border: 1px dashed #999;
+    overflow: hidden;
+}
+
+div.method-source-code pre { color: #ffdead; overflow: hidden; }
+
+/* --- Ruby keyword styles --------------------- */
+
+.standalone-code { background: #221111; color: #ffdead; overflow: hidden; }
+
+.ruby-constant  { color: #7fffd4; background: transparent; }
+.ruby-keyword { color: #00ffff; background: transparent; }
+.ruby-ivar    { color: #eedd82; background: transparent; }
+.ruby-operator  { color: #00ffee; background: transparent; }
+.ruby-identifier { color: #ffdead; background: transparent; }
+.ruby-node    { color: #ffa07a; background: transparent; }
+.ruby-comment { color: #b22222; font-weight: bold; background: transparent; }
+.ruby-regexp  { color: #ffa07a; background: transparent; }
+.ruby-value   { color: #7fffd4; background: transparent; }

data/lib/user_agent_info.rb

@@ -0,0 +1,189 @@
+#
+# = UserAgentInfo
+#
+# == simplify user-agent detection in Rails
+#
+# Author:: Mehmet Celik
+#
+# == Usage
+#
+# It extends ActionController::Request and parses the requests HTTP_USER_AGENT header so it can be queried.
+# The supported browsers are IE, Firefox, Chrome, Opera this translates into the methods isIE?, isFirefox?, isChrome, isOpera?
+# You can also supply a version like isIE?('6.0') and you can query if it is worse or/and better then a version isIE_or_worse?('6.0')
+#
+# === Example
+# 
+#   class UpgradeBrowserController < ApplicationController 
+#     def index 
+#       @upgrade = request.user_agent_info.isIE_or_worse?('6.0') 
+#     end 
+#   end 
+
+
+module UserAgentInfo
+  class UserAgent
+    attr_reader :browser_info
+
+    def initialize(r) #:nodoc:
+      parse_browser_info(r)
+    end
+
+# query user_agent_info 
+# 
+#    request.user_agent_info['header']         ==> Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10.5; en-US; rv:1.9.1.4) Gecko/20091016 Firefox/3.5.4 
+#    request.user_agent_info['platform']       ==> Macintosh 
+#    request.user_agent_info['name']           ==> Firefox 
+#    request.user_agent_info['name_display']   ==> Mozilla Firefox 
+#    request.user_agent_info['cpuos']          ==> Intel Mac OS X 10.5 
+#    request.user_agent_info['language']       ==> en-US 
+#    request.user_agent_info['version']        ==> 3.5 
+#    request.user_agent_info['engine']         ==> Gecko/20091016 
+    def [](lookup)
+      @browser_info[lookup]
+    end
+
+# check if browser is Internet Explorer
+#    request.user_agent_info.isIE?                     ==> true if browser is Internet Explorer <br />
+#    request.user_agent_info.isIE?('6.0')              ==> true if browser is Internet Explorer version 6.0                    '==' 
+#    request.user_agent_info.isIE_or_worse?('6.0')     ==> true if browser is Internet Explorer version worse or equal to 6.0  '<=' 
+#    request.user_agent_info.isIE_and_worse?('6.0')    ==> true if browser is Internet Explorer version worse then 6.0         '<' 
+#    request.user_agent_info.isIE_or_better?('6.0')    ==> true if browser is Internet Explorer version better or equal to 6.0 '>=' 
+#    request.user_agent_info.isIE_and_better?('6.0')   ==> true if browser is Internet Explorer version better then 6.0        '>' 
+    def isIE?(version = nil)
+      browser_query('MSIE', version)
+    end
+
+    def isFirefox?(version = nil)
+      browser_query('Firefox', version)
+    end
+
+    def isChrome?(version = nil)
+      browser_query('Chrome', version)
+    end
+
+    def isOpera?(version = nil)
+      browser_query('Opera', version)
+    end
+
+    def method_missing(method_id, *arguments, &block) #:nodoc:
+      actions = ['better', 'worse']
+      operators = ['or', 'and']
+      
+      method = method_id.to_s
+      method_name = "#{method.split('_')[0]}?"
+      
+      operator = method.split('_')[1]      
+      action   = method.split('_')[2].chop
+ 
+      return false if !operators.include?(operator)
+      return false if !action.include?(action)      
+ 
+      if self.send method_name.to_sym
+        if arguments.size != 1
+          raise RuntimeError, "Missing 'version' argument."
+        end
+                
+        version = arguments[0].to_f
+        case 
+        when action.eql?("better") && operator.eql?('or')
+          return @browser_info['version'] >= version
+        when action.eql?("better") && operator.eql?('and')          
+          return @browser_info['version'] > version        
+        when action.eql?("worse") && operator.eql?('or')
+          return @browser_info['version'] <= version
+        when action.eql?("worse") && operator.eql?('and')          
+          return @browser_info['version'] < version        
+        end                  
+      end
+      
+      return false
+    end
+
+    private
+    def parse_browser_info(r)
+      supported_browser = %w(MSIE Firefox Chrome Opera)
+      browser_labels = {"MSIE"    => 'Microsoft Internet Explorer',
+                        "Firefox" => "Mozilla Firefox",
+                        "Chrome"  => "Google Chrome",
+                        "Opera"   => "Opera",
+                        "unknown" => "unknown"}
+      
+      header = platform = name = cpuos = language = engine = ''
+      version = 0.0
+
+      if r.nil?
+        raise "Couldn't determine request"
+      end
+      header = r.headers['HTTP_USER_AGENT']
+
+      case
+      when header.match('MSIE')
+        string_match = header.match('.*? \((.*?)?\)( .*)?')        
+        browser = string_match[1].split(';').map {|e| e.strip}
+
+        platform = browser[0]
+        cpuos       = browser[2]        
+        name_version = browser[1].split(' ')
+        version = name_version[1].to_f
+        name = name_version[0]
+        language = ''        
+      when header.match('Firefox') || header.match('Chrome') || header.match('Safari')
+        string_match = header.match('.*? \((.*?)?\)( .*)?')   
+        browser  = string_match[1].split(';').map {|e| e.strip}
+        platform = browser[0]
+        name     = browser[1]
+        cpuos    = browser[2]
+        language = browser[3]
+                     
+        name_version_engine = string_match[2].gsub(/\(.*?\)/,'').split(' ')
+        name_version = name_version_engine[1].split('/')
+        name         = name_version[0]
+        version      = name_version[1].to_f
+        engine       = name_version_engine[0]                
+      when header.match('Opera')        
+        string_match = header.match('(.*?) \((.*?)?\)( .*)?')        
+        browser  = string_match[1].split('/').map { |e| e.strip }
+        name     = browser[0]
+        version  = browser[1].to_f
+        browser  = string_match[2].split(';').map {|e| e.strip}
+        platform = browser[0]
+        cpuos    = browser[1]
+        language = browser[3]
+        engine   = string_match[3].strip
+      else
+        platform = name = cpuos = language = engine = 'unknown'        
+      end
+
+      @browser_info = {'header' => header, 'platform' => platform, 'name' => name, 'name_display' => browser_labels[name],
+      'cpuos' => cpuos, 'language' => language, 'version' => version, 'engine' => engine}
+
+      @browser_info
+    end
+
+    def browser_query(browser_name, version)
+      response = false
+      if @browser_info.nil?
+        parse_browser_info
+      end
+
+      unless @browser_info.nil?
+        if @browser_info['name'].eql?(browser_name)
+          if version.nil? || version.empty?
+            response = true
+          else
+            response = true if (@browser_info['version'] == version.to_f)
+          end
+        end
+                
+      end
+      response
+    end
+
+  end
+end
+
+class ActionController::Request #:nodoc: all 
+  def user_agent_info
+    UserAgentInfo::UserAgent.new(self)       
+  end
+end

data/tests/test_browsers.rb

@@ -0,0 +1,52 @@
+$LOAD_PATH << '../lib'
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+require 'action_controller'
+require 'user_agent_info'
+
+
+class Request
+  attr_accessor :headers
+  
+  def initialize(header) 
+    @headers = {'HTTP_USER_AGENT' => header}
+  end
+    
+  def user_agent_info
+    UserAgentInfo::UserAgent.new(self)       
+  end
+  
+  def headers
+    @headers
+  end
+  
+end
+
+FIREFOX_OSX_HEADER ='Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10.5; en-US; rv:1.9.1.4) Gecko/20091016 Firefox/3.5.4'
+CHROME_OSX_HEADER  ='Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10_5_8; en-US) AppleWebKit/532.3 (KHTML, like Gecko) Chrome/4.0.223.11 Safari/532.3'
+OPERA_OSX_HEADER   ='Opera/9.80 (Macintosh; Intel Mac OS X; U; en) Presto/2.2.15 Version/10.00'
+IE_80_WIN_HEADER   ='Mozilla/4.0 (compatible; MSIE 8.0; Windows NT 5.1; Trident/4.0)'
+IE_70_WIN_HEADER   ='Mozilla/4.0 (compatible; MSIE 7.0; Windows NT 5.1; .NET CLR 1.1.4322; .NET CLR 2.0.50727; .NET CLR 3.0.04506.648; .NET CLR 3.5.21022; .NET CLR 3.0.4506.2152; .NET CLR 3.5.30729)'
+FIREFOX_WIN_HEADER ='Mozilla/5.0 (Windows; U; Windows NT 5.1; en-GB; rv:1.9.0.14) Gecko/2009082707 Firefox/3.0.14 (.NET CLR 3.5.30729)'
+
+class TestBrowsers < Test::Unit::TestCase
+
+  context "All browsers user agent info" do
+    context "MS Internet Explorer" do
+      setup do
+        @request = Request.new(IE_80_WIN_HEADER)
+        @browser = "This is #{@request.user_agent_info['name_display']} #{@request.user_agent_info['version']}"
+      end
+      
+      should 'be Internet Explorer 8.0' do
+        assert(@request.user_agent_info.isIE?('8.0'), @browser) 
+      end
+
+      should 'be Internet Explorer 6.0 or better' do
+        assert(@request.user_agent_info.isIE_or_better?('6.0'), @browser) 
+      end            
+    end
+  end
+end