Class: BrowserDetector::Detector

Inherits:
Object
  • Object
show all
Defined in:
lib/browser_detector/detector.rb

Overview

The Detector provides the ability to determine browser information from the user agent string.

Constant Summary collapse

VERSION_REGEX = 
/(\d*)\.(\d*)\.*(\d*)\.*(\d*)/
CHROME_REGEX = 
/.* Chrome\/([\d|.]*).*/i
FIREFOX_REGEX = 
/.* Firefox\/([\d|.]*).*/i
IE_REGEX = 
/.*; MSIE ([\d|.]*);.*/i
OPERA_REGEX = 
/Opera.*Version\/([\d|.]*)/i
SAFARI_REGEX = 
/.*Gecko\) Version\/([\d|.]*) Safari\/[\d|.]*/i
SAFARI_MOBILE_REGEX = 
/.*Gecko\) Version\/([\d|.]*) Mobile\/.* Safari\/[\d|.]*/i

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(user_agent) ⇒ Detector

Returns a new instance of Detector.



16
17
18
 
# File 'lib/browser_detector/detector.rb', line 16

def initialize( user_agent )
  @ua = user_agent.downcase unless user_agent.nil?
end

Instance Attribute Details

#ua ⇒ Object (readonly)

Returns the value of attribute ua.



14
15
16
 
# File 'lib/browser_detector/detector.rb', line 14

def ua
  @ua
end

Class Method Details

.all_browsers ⇒ Object

A list of all the browser types that Guilded recognizes.



160
161
162
 
# File 'lib/browser_detector/detector.rb', line 160

def self.all_browsers
  %w(chrome firefox ie55 ie60 ie70 ie80 konqueror netscape opera safari)
end

.all_mobile_browsers ⇒ Object

A list of all the mobile browser types that Guilded recognizes.



166
167
168
 
# File 'lib/browser_detector/detector.rb', line 166

def self.all_mobile_browsers
  %w(ie_ce4)
end

.patterns ⇒ Object 



20
21
22
23
24
25
26
27
28
29
 
# File 'lib/browser_detector/detector.rb', line 20

def self.patterns
  {
    CHROME_REGEX        => 'chrome',
    IE_REGEX            => 'ie',
    FIREFOX_REGEX       => 'firefox',
    OPERA_REGEX         => 'opera',
    SAFARI_REGEX        => 'safari',
    SAFARI_MOBILE_REGEX => 'safari_mobile'
  }
end

.user_agents ⇒ Object 



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/browser_detector/detector.rb', line 170

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',
    :safari40       => 'Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10_5_6; en-us) AppleWebKit/528.16 (KHTML, like Gecko) Version/4.0 Safari/528.16',
    :safari501      => 'Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10_6_4; en-us) AppleWebKit/533.17.8 (KHTML, like Gecko) Version/5.0.1 Safari/533.17.8',
    :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',
    :safari_mobile4 => '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',
    :safari_mobile3 => 'Mozilla/5.0 (iPhone; U; CPU like Mac OS X; en) AppleWebKit/420+ (KHTML, like Gecko) Version/3.0 Mobile/1A535b Safari/419.3',
  }
end

Instance Method Details

#browser_full_name ⇒ Object

Returns the browser name concatenated with the browser version. for example, ‘ie7’.

Request

  • request - The request object.



130
131
132
 
# File 'lib/browser_detector/detector.rb', line 130

def browser_full_name
  self.send( "browser_full_name_for_#{self.browser_name}".to_sym )
end

#browser_id ⇒ Object

Returns the browser name concatenated with the browser version. for example, ‘ie7’.

Request

  • request - The request object.



139
140
141
 
# File 'lib/browser_detector/detector.rb', line 139

def browser_id
  browser_name + browser_version.gsub( /\./, '' )
end

#browser_is?(options = {}) ⇒ Boolean

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.

Returns:

  • (Boolean) 


42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/browser_detector/detector.rb', line 42

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

#browser_name ⇒ Object

Returns the name of the browser that is making this request. For example ‘ie’.



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/browser_detector/detector.rb', line 71

def browser_name
  begin
    @browser_name ||= begin
      return 'unknown' if ua.nil?

      Detector.patterns.each do |pattern, identifier|
        return identifier if pattern.match( ua )
      end

      if ua.include?( 'konqueror' )
        'konqueror'
      elsif ua.include?( 'netscape' )
        'netscape'
      else
        'unknown'
      end
    end
  rescue
    'unknown'
  end
end

#browser_version ⇒ Object

Returns the version of the browser that is making this request. For example ‘7’.



95
96
97
98
99
 
# File 'lib/browser_detector/detector.rb', line 95

def browser_version
  @browser_version ||= begin
    self.send( "resolve_version_for_#{self.browser_name}".to_sym )
  end
end

#browser_version_build ⇒ Object 



113
114
115
116
117
 
# File 'lib/browser_detector/detector.rb', line 113

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

#browser_version_major ⇒ Object 



101
102
103
104
105
 
# File 'lib/browser_detector/detector.rb', line 101

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

#browser_version_minor ⇒ Object 



107
108
109
110
111
 
# File 'lib/browser_detector/detector.rb', line 107

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

#browser_version_revision ⇒ Object 



119
120
121
122
123
 
# File 'lib/browser_detector/detector.rb', line 119

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

#can_use_png? ⇒ Boolean

Returns true if the current browser type can handle PNGs.

Returns:

  • (Boolean) 


145
146
147
148
 
# File 'lib/browser_detector/detector.rb', line 145

def can_use_png?
  return browser_version.to_i >= 7 if browser_name== 'ie'
  true
end

#iphone? ⇒ Boolean

Returns:

  • (Boolean) 


154
155
156
 
# File 'lib/browser_detector/detector.rb', line 154

def iphone?
  @is_iphone ||= (browser_name == Detector.patterns[SAFARI_MOBILE_REGEX])
end

#webkit? ⇒ Boolean

Returns:

  • (Boolean) 


150
151
152
 
# File 'lib/browser_detector/detector.rb', line 150

def webkit?
  @is_webkit ||= !(/AppleWebKit/i.match( @ua ).nil?)
end