browser_detector 1.0.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/History.txt

@@ -0,0 +1,4 @@
+= 1.0.0 2009-10-19
+
+* Initial release.
+* Moved browser detector out of the Guilded framework to its own Gem.

data/LICENSE

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 2009 C. Jason Harrelson (midas)
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,106 @@
+= browser_detector
+
+http://github.com/midas/browser_detector
+
+
+== DESCRIPTION
+
+Determines the name and version of the browser currently making a request.
+
+The browser detector uses the HTTP user agent string to determine which browser is making the current request.  The detector
+can determine the name, version, major version, minor version, build version and revision version of the current browser.
+
+If using Rails, there are several view helpers available that use the BrowserDetector: g_browser_name(), g_browser_version(),
+g_browser_full_name() and g_browser_is?().
+
+
+== FEATURES
+
+* Detector class that can determine the browser name and version given a user agent string.
+* List of known user agents.
+* List of example user agent strings for each known user agent.
+
+
+== INSTALL
+
+  gem sources -a http://gemcutter.org
+  sudo gem install 
+
+
+== INSTALL FOR RAILS
+
+Add to environment file:
+
+  config.gem "browser_detector", :version => '1.0.0', :source => 'http://gemcutter.org'
+
+
+== USAGE
+
+The following examples will assume Firefox 3.5.3 on OS/X is being used.  The user agent string for Firefox 3.5.3 on OS/X is:
+
+  Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10.6; en-US; rv:1.9.1.3) Gecko/20090824 Firefox/3.5.3
+
+=== Detector Class
+
+  @detector = BrowserDetector::Detector.new( request.env['HTTP_USER_AGENT'] )
+  puts @detector.browser_name # firefox
+  puts @detector.browser_version # 3.5.3
+  puts @detector.full_name # Firefox 3.5.3
+  puts @detector.browser_is? :name => :firefox, :version => '3.5.3' # true
+  puts @detector.browser_is? :name => :firefox, :major_version => 3, :minor_version => '5', build_version => '3' # true
+
+=== Within Rails Views
+
+g_browser_name
+
+  <% if g_browser_name == 'firefox' %>
+    ...
+
+g_browser_version
+
+  <% if g_browser_version == '3.5.3' %>
+    ...
+
+g_browser_full_name
+
+  <%= g_browser_full_name # Outputs: Firefox 3.5.3 %>
+
+g_browser_is?
+
+  <% if g_browser_is?( :name => 'firefox', :version => '3.5.3' ) %>
+    ...
+
+  <% if g_browser_is?( :name => 'firefox', :major_version => '3' ) %>
+    ...
+
+  <% if g_browser_is?( :name => :firefox, :major_version => 3, :minor_version => 5, :build_version => 3 ) %>
+    ...
+
+  <% if g_browser_is?( :name => :firefox, :major_version => 3, :minor_version => 5, :build_version => 3, :revision_version => 0 ) %>
+    ...
+
+
+== LICENSE
+
+(The MIT License)
+
+Copyright (c) 2009 C. Jason Harrelson (midas)
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "browser_detector"
+    gem.summary = %Q{Determines the name and version of the browser currently making a request.}
+    gem.description = %Q{Determines the name and version of the browser currently making a request.}
+    gem.email = "jason@lookforwardenterprises.com"
+    gem.homepage = "http://github.com/midas/browser_detector"
+    gem.authors = ["C. Jason Harrelson (midas)"]
+    gem.add_development_dependency "shoulda", ">= 2.10.2"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "browser_detector #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/browser_detector.gemspec

@@ -0,0 +1,62 @@
+# 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{browser_detector}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["C. Jason Harrelson (midas)"]
+  s.date = %q{2010-02-03}
+  s.description = %q{Determines the name and version of the browser currently making a request.}
+  s.email = %q{jason@lookforwardenterprises.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "History.txt",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "browser_detector.gemspec",
+     "lib/browser_detector.rb",
+     "lib/browser_detector/detector.rb",
+     "lib/browser_detector/rails.rb",
+     "lib/browser_detector/rails/view_helpers.rb",
+     "test/browser_detector/detector_test.rb",
+     "test/browser_detector/rails/view_helpers_test.rb",
+     "test/browser_detector_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/midas/browser_detector}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Determines the name and version of the browser currently making a request.}
+  s.test_files = [
+    "test/browser_detector/detector_test.rb",
+     "test/browser_detector/rails/view_helpers_test.rb",
+     "test/browser_detector_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<shoulda>, [">= 2.10.2"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 2.10.2"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 2.10.2"])
+  end
+end
+

data/lib/browser_detector/detector.rb

@@ -0,0 +1,233 @@
+module BrowserDetector 
+  
+  # The Detector provides the ability to determine browser information from the user 
+  # agent string.
+  #
+  class Detector
+    
+    attr_reader :ua
+    
+    def initialize( user_agent )
+      @ua = user_agent.downcase unless user_agent.nil?
+      @version_regex = /(\d*)\.(\d*)\.*(\d*)\.*(\d*)/
+    end
+    
+    # Returns true if the browser matches the options ent in, otherwise returns false.
+    #
+    # === Request
+    # * +request+ - The request object.
+    #
+    # === Options
+    # * +:name+ - The name of the browser.  For example 'ie' or :ie.
+    # * +:version+ - The version of the browser.  For example '3.0.5'.
+    # * +:major_version+ - The major version of the browser.  For example '3' or 3.
+    # * +:minor_version+ - The minor version of the browser.  For example '0' or 0.
+    #
+    def browser_is?( options={} )
+      name = options[:name]
+      version = options[:version]
+      major_version = options[:major_version]
+      minor_version = options[:minor_version]
+      build_version = options[:build_version]
+      revision_version = options[:revision_version]
+      
+      name ||= self.browser_name
+      version ||= self.browser_version
+      major_version ||= self.browser_version_major
+      minor_version ||= self.browser_version_minor
+      build_version ||= self.browser_version_build
+      revision_version ||= self.browser_version_revision
+
+      name = name.to_s.strip
+      version = version.to_s.strip
+      major_version = major_version.to_s.strip
+      minor_version = minor_version.to_s.strip
+      build_version = build_version.to_s.strip
+      revision_version = revision_version.to_s.strip
+      
+      self.browser_name == name && self.browser_version == version && self.browser_version_major == major_version &&
+        self.browser_version_minor == minor_version #&& self.browser_version_build == build_version && 
+        #self.browser_version_revision == revision_version
+    end
+
+    # Returns the name of the browser that is making this request.  For example 'ie'.
+    #
+    # === Request
+    # * +request+ - The request object.
+    #
+    def browser_name
+      begin
+        @browser_name ||= begin
+          ua = @ua
+          if ua.nil?
+            'unknown'
+          else
+            if ua.index( 'msie' ) && !ua.index( 'opera' ) && !ua.index( 'webtv' )
+              if ua.index( 'windows ce' )
+                'ie' + '_ce' #+ ua[ua.index( 'msie' ) + 5].chr 
+              else
+                'ie' # + ua[ua.index( 'msie' ) + 5].chr
+              end
+            elsif ua.include?( 'opera' )
+              'opera'
+            elsif ua.include?( 'konqueror' ) 
+              'konqueror'
+            elsif ua.include?( 'applewebkit/' )
+              'safari'
+            elsif ua.include?( 'chrome' )
+              'chrome'
+            elsif ua.include?( 'firefox' )
+              'firefox'
+            elsif ua.include?( 'netscape' )
+              'netscape'
+            else
+              'unknown'
+            end
+          end
+        end
+      rescue
+        'unknown'
+      end
+    end
+
+    # Returns the version of the browser that is making this request.  For example '7'.
+    #
+    # === Request
+    # * +request+ - The request object.
+    #
+    def browser_version
+      @browser_version ||= begin
+        self.send( "resolve_version_for_#{self.browser_name}".to_sym )
+      end
+    end
+
+    def browser_version_major
+      match = @version_regex.match( browser_version )
+      return match[1].to_i.to_s unless match.nil? || match.size < 2
+      '0'
+    end
+
+    def browser_version_minor
+      match = @version_regex.match( browser_version )
+      return match[2].to_i.to_s unless match.nil? || match.size < 3
+      '0'
+    end
+    
+    def browser_version_build
+      match = @version_regex.match( browser_version )
+      return match[3].to_i.to_s unless match.nil? || match.size < 4 || match[3].empty? || match[3].nil?
+      '0'
+    end
+    
+    def browser_version_revision
+      match = @version_regex.match( browser_version )
+      return match[4].to_i.to_s unless match.nil? || match.size < 5 || match[4].empty? || match[4].nil?
+      '0'
+    end
+    
+    # Returns the browser name concatenated with the browser version.  for example, 'ie7'.
+    #
+    # === Request
+    # * +request+ - The request object.
+    #
+    def browser_full_name
+      self.send( "browser_full_name_for_#{self.browser_name}".to_sym )
+    end
+    
+    # Returns the browser name concatenated with the browser version.  for example, 'ie7'.
+    #
+    # === Request
+    # * +request+ - The request object.
+    #
+    def browser_id
+      browser_name + browser_version.gsub( /\./, '' )
+    end
+    
+    # Returns true if the current browser type can handle PNGs.
+    #
+    def can_use_png?
+      return browser_version.to_i >= 7 if browser_name== 'ie'
+    	true
+  	end
+
+    # A list of all the browser types that Guilded recognizes.
+    #
+    def self.all_browsers
+      %w( chrome firefox ie55 ie60 ie70 ie80 konqueror netscape opera safari )
+    end
+
+    # A list of all the mobile browser types that Guilded recognizes.
+    #
+    def self.all_mobile_browsers
+      %w( ie_ce4 iphone )
+    end
+    
+    def self.user_agents
+      { 
+        :ie55 => 'Mozilla/4.0 (compatible; MSIE 5.5; Windows NT 5.1)', 
+        :ie60 => 'Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1)',
+        :ie70 => 'Mozilla/4.0 (compatible; MSIE 7.0; Windows NT 5.1)',
+        :ie80 => 'Mozilla/4.0 (compatible; MSIE 8.0; Windows NT 5.1; Trident/4.0)',
+        :firefox2 => 'Mozilla/5.0 (Macintosh; U; Intel Mac OS X; en-US; rv:1.8.1.17) Gecko/20080829 Firefox/2.0.0.17',
+        :firefox3 => 'Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10.6; en-US; rv:1.9.0.11) Gecko/2009060214 Firefox/3.0.11',
+        :firefox35 => 'Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10.6; en-US; rv:1.9.1.3) Gecko/20090824 Firefox/3.5.3',
+        :firefox35win => 'Mozilla/5.0 (Windows; U; Windows NT 6.0; en-US; rv:1.9.1.3) Gecko/20090824 Firefox/3.5.3 (.NET CLR 3.5.30729)',
+        :opera10 => 'Opera/9.80 (Macintosh; Intel Mac OS X; U; en) Presto/2.2.15 Version/10.00',
+        :safari403 => 'Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10_6_1; en-US) AppleWebKit/532.2 (KHTML, like Gecko) Chrome/4.0.221.8 Safari/532.2',
+        :iphone3 => 'Mozilla/5.0 (iPhone; U; CPU iPhone OS 3_1 like Mac OS X; en-us) AppleWebKit/528.18 (KHTML, like Gecko) Version/4.0 Mobile/7C144 Safari/528.16',
+        :iphone2 => 'Mozilla/5.0 (iPhone; U; CPU like Mac OS X; en) AppleWebKit/420+ (KHTML, like Gecko) Version/3.0 Mobile/1A535b Safari/419.3',
+        :chrome3 => 'Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US) AppleWebKit/532.0 (KHTML, like Gecko) Chrome/3.0.195.27 Safari/532.0',
+        :chrome4 => 'Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10_6_1; en-US) AppleWebKit/532.2 (KHTML, like Gecko) Chrome/4.0.221.8 Safari/532.2'
+      }
+    end
+    
+    protected
+    
+    def resolve_version_for_ie
+      match = /.*msie (.*); windows nt 5.1/.match( @ua )
+      return match.nil? ? '0' : match[1]
+    end
+    
+    def resolve_version_for_firefox
+      match = /.*\((.*); u;.*firefox\/(.*) \(.net.*/.match( @ua )
+      if match.nil?
+        match = /.*\((.*); u;.*firefox\/(.*)/.match( @ua )
+        return match.nil? ? '0' : match[2]
+      end
+      return match.nil? ? '0' : match[2]
+    end
+    
+    def resolve_version_for_opera
+      match = /.*\((.*); intel.*version\/(.*)/.match( @ua )
+      return match.nil? ? '0' : match[2]
+    end
+    
+    def resolve_version_for_safari
+      match = /.* safari\/(.*)/.match( @ua )
+      rev = match.nil? ? 0 : match[1]
+      return case rev
+        when '528.16' then '4.0.0'
+        when '530.18' then '4.0.1'
+        when '530.19' then '4.0.2'
+        when '531.9', '532.2' then '4.0.3'
+        else '0.0.0.0'
+      end
+    end
+    
+    def browser_full_name_for_ie
+      "Internet Explorer #{browser_version}"
+    end
+    
+    def browser_full_name_for_firefox
+      "Firefox #{browser_version}"
+    end
+    
+    def browser_full_name_for_opera
+      "Opera #{browser_version}"
+    end
+    
+    def browser_full_name_for_safari
+      "Safari #{browser_version}"
+    end
+  end
+end

data/lib/browser_detector/rails/view_helpers.rb

@@ -0,0 +1,61 @@
+module BrowserDetector
+  module Rails
+    module ViewHelpers
+      
+      # Returns the name of the browser that is making this request.  For example 'ie'.  When using 
+      # the browser detector in the contoller you may put a :g_browser_detector variabe in the session if 
+      # you wish to keep the BrowserDetector from being instantiated more than once per request.
+      #
+      def g_browser_name
+        setup_detector
+        @g_browser_detector.browser_name
+      end
+
+      # Returns the version of the browser that is making this request.  For example '7'.  When using 
+      # the browser detector in the contoller you may put a :g_browser_detector variabe in the session if 
+      # you wish to keep the BrowserDetector from being instantiated more than once per request.
+      #
+      def g_browser_version
+        setup_detector
+        @g_browser_detector.browser_version
+      end
+
+      # Returns the full browser name.  For example, 'Internet Explorer 7.0'.
+      #
+      def g_browser_full_name
+        setup_detector
+        @g_browser_detector.browser_full_name
+      end
+      
+      # Returns the browser name concatenated with the browser version.  for example, 'ie7'.  When using 
+      # the browser detector in the contoller you may put a :g_browser_detector variabe in the session if 
+      # you wish to keep the BrowserDetector from being instantiated more than once per request.
+      #
+      def g_browser_id
+        setup_detector
+        @g_browser_detector.browser_id
+      end
+
+      # Returns true if the browser matches the options ent in, otherwise returns false.  When using 
+      # the browser detector in the contoller you may put a :g_browser_detector variable in the session if 
+      # you wish to keep the Detector from being instantiated more than once per request.
+      #
+      # === Options
+      # * +:name+ - The name of the browser.  For example 'ie'.
+      # * +:version+ - The version of the browser.  For example '7'.
+      #
+      def g_browser_is?( options={} )
+        setup_detector
+        @g_browser_detector.browser_is?( options )
+      end
+      
+      protected
+      
+      def setup_detector
+        @g_browser_detector = session[:g_browser_detector] if respond_to?( :session )
+        @g_browser_detector ||= BrowserDetector::Detector.new( request.env['HTTP_USER_AGENT'] )
+      end
+      
+    end
+  end
+end

data/lib/browser_detector/rails.rb

@@ -0,0 +1,4 @@
+module BrowserDetector
+  module Rails
+  end
+end

data/lib/browser_detector.rb

@@ -0,0 +1,11 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'browser_detector/detector'
+require 'browser_detector/rails/view_helpers'
+
+module BrowserDetector
+  VERSION = '1.0.0'
+end
+
+ActionView::Base.send( :include, BrowserDetector::Rails::ViewHelpers ) if defined?( ActionView )