Module: UseragentParser
- Defined in:
- lib/useragent_parser.rb,
lib/useragent_parser/version.rb,
lib/useragent_parser/user_agent.rb,
lib/useragent_parser/parsers/os_parser.rb,
lib/useragent_parser/parsers/device_parser.rb,
lib/useragent_parser/parsers/referrer_parser.rb,
lib/useragent_parser/parsers/user_agent_parser.rb
Defined Under Namespace
Classes: DeviceParser, OSParser, ReferrerParser, UserAgent, UserAgentParser
Constant Summary collapse
- USER_AGENT_PARSERS =
[]
- OS_PARSERS =
[]
- DEVICE_PARSERS =
[]
- REFERRER_PARSERS =
[]
- MOBILE_USER_AGENT_FAMILIES =
[]
- MOBILE_OS_FAMILIES =
[]
- VERSION =
"0.2.3"
Class Method Summary collapse
- .load_parsers! ⇒ Object
- .parse(user_agent_string, *js_args) ⇒ Object
- .parse_browser(user_agent_string, *js_args) ⇒ Object
- .parse_device(user_agent_string, ua_family = nil, os_family = nil) ⇒ Object
- .parse_email(user_agent_string, referrer = nil, *js_args) ⇒ Object
- .parse_os(user_agent_string, js_user_agent_string = nil, js_user_agent_family = nil, js_user_agent_v1 = nil, js_user_agent_v2 = nil, js_user_agent_v3 = nil) ⇒ Object
- .parse_referrer(referrer_string) ⇒ Object
- .parse_user_agent(user_agent_string, js_user_agent_string = nil, js_user_agent_family = nil, js_user_agent_v1 = nil, js_user_agent_v2 = nil, js_user_agent_v3 = nil) ⇒ Object
- .parse_with_referrer(user_agent_string, referrer = nil, *js_args) ⇒ Object
Class Method Details
.load_parsers! ⇒ Object
17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 |
# File 'lib/useragent_parser.rb', line 17 def self.load_parsers! yaml = YAML.load_file(File.(File.dirname(__FILE__)) + "/../config/regexes.yaml") yaml['user_agent_parsers'].each do |parser| regex = parser['regex'] family_replacement = parser.fetch('family_replacement', nil) v1_replacement = parser.fetch('v1_replacement', nil) USER_AGENT_PARSERS.push UseragentParser::UserAgentParser.new(regex, family_replacement, v1_replacement) end yaml['os_parsers'].each do |parser| regex = parser['regex'] os_replacement = parser.fetch('os_replacement', nil) OS_PARSERS.push UseragentParser::OSParser.new(regex, os_replacement) end yaml['device_parsers'].each do |parser| regex = parser['regex'] device_replacement = parser.fetch('device_replacement', nil) DEVICE_PARSERS.push UseragentParser::DeviceParser.new(regex, device_replacement) end yaml['referrer_parsers'].each do |parser| regex = parser['regex'] referrer_replacement = parser.fetch('referrer_replacement', nil) REFERRER_PARSERS.push UseragentParser::ReferrerParser.new(regex, referrer_replacement) end MOBILE_USER_AGENT_FAMILIES.push *yaml['mobile_user_agent_families'] MOBILE_OS_FAMILIES.push *yaml['mobile_os_families'] end |
.parse(user_agent_string, *js_args) ⇒ Object
52 53 54 |
# File 'lib/useragent_parser.rb', line 52 def self.parse(user_agent_string, *js_args) UseragentParser::UserAgent.new(self.parse_browser(user_agent_string, *js_args)) end |
.parse_browser(user_agent_string, *js_args) ⇒ Object
70 71 72 73 74 75 76 77 |
# File 'lib/useragent_parser.rb', line 70 def self.parse_browser(user_agent_string, *js_args) { 'user_agent' => self.parse_user_agent(user_agent_string, *js_args), 'os' => self.parse_os(user_agent_string, *js_args), 'device' => self.parse_device(user_agent_string, *js_args), 'string' => user_agent_string } end |
.parse_device(user_agent_string, ua_family = nil, os_family = nil) ⇒ Object
116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 |
# File 'lib/useragent_parser.rb', line 116 def self.parse_device(user_agent_string, ua_family = nil, os_family = nil) device = nil DEVICE_PARSERS.each do |parser| device = parser.parse(user_agent_string) break unless device.nil? end os_family = device || 'Other' ua_family = self.parse_user_agent(user_agent_string)['family'] if ua_family.nil? os_family = self.parse_os(user_agent_string)['family'] if os_family.nil? if MOBILE_USER_AGENT_FAMILIES.include?(ua_family) is_mobile = true elsif MOBILE_OS_FAMILIES.include?(os_family) is_mobile = true else is_mobile = false end { 'family' => device, 'is_mobile' => is_mobile, 'is_spider' => (device == 'Spider') } end |
.parse_email(user_agent_string, referrer = nil, *js_args) ⇒ Object
60 61 62 63 64 65 66 67 68 |
# File 'lib/useragent_parser.rb', line 60 def self.parse_email(user_agent_string, referrer = nil, *js_args) { 'user_agent' => self.parse_user_agent(user_agent_string, *js_args), 'os' => self.parse_os(user_agent_string, *js_args), 'device' => self.parse_device(user_agent_string, *js_args), 'string' => user_agent_string, 'referrer' => self.parse_referrer(referrer) } end |
.parse_os(user_agent_string, js_user_agent_string = nil, js_user_agent_family = nil, js_user_agent_v1 = nil, js_user_agent_v2 = nil, js_user_agent_v3 = nil) ⇒ Object
105 106 107 108 109 110 111 112 113 114 |
# File 'lib/useragent_parser.rb', line 105 def self.parse_os(user_agent_string, js_user_agent_string = nil, js_user_agent_family = nil, js_user_agent_v1 = nil, js_user_agent_v2 = nil, js_user_agent_v3 = nil) os, os_v1, os_v2, os_v3, os_v4 = nil, nil, nil, nil, nil OS_PARSERS.each do |parser| os, os_v1, os_v2, os_v3, os_v4 = parser.parse(user_agent_string) break unless os.nil? end os ||= 'Other' { 'family' => os, 'major' => os_v1, 'minor' => os_v2, 'patch' => os_v3, 'patch_minor' => os_v4 } end |
.parse_referrer(referrer_string) ⇒ Object
139 140 141 142 143 144 145 146 147 |
# File 'lib/useragent_parser.rb', line 139 def self.parse_referrer(referrer_string) referrer = nil REFERRER_PARSERS.each do |parser| referrer = parser.parse(referrer_string) break unless referrer.nil? end { 'family' => referrer } end |
.parse_user_agent(user_agent_string, js_user_agent_string = nil, js_user_agent_family = nil, js_user_agent_v1 = nil, js_user_agent_v2 = nil, js_user_agent_v3 = nil) ⇒ Object
79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 |
# File 'lib/useragent_parser.rb', line 79 def self.parse_user_agent(user_agent_string, js_user_agent_string = nil, js_user_agent_family = nil, js_user_agent_v1 = nil, js_user_agent_v2 = nil, js_user_agent_v3 = nil) family, v1, v2, v3 = nil # Override via JS properties. if js_user_agent_family.nil? USER_AGENT_PARSERS.each do |parser| family, v1, v2, v3 = parser.parse(user_agent_string) break unless family.nil? end else family = js_user_agent_family v1 = js_user_agent_v1 unless js_user_agent_v1.nil? v2 = js_user_agent_v2 unless js_user_agent_v3.nil? v3 = js_user_agent_v3 unless js_user_agent_v3.nil? end # Override for Chrome Frame IFF Chrome is enabled. if js_user_agent_string && js_user_agent_string.include?('Chrome/') && user_agent_string.include?('chromeframe') family = 'Chrome Frame (%s %s)' % [ family, v1 ] js_ua = self.parse_user_agent(js_user_agent_string) cf_family, v1, v2, v3 = js_ua['family'], js_ua['major'], js_ua['minor'], js_ua['patch'] end family ||= 'Other' { 'family' => family, 'major' => v1, 'minor' => v2, 'patch' => v3 } end |
.parse_with_referrer(user_agent_string, referrer = nil, *js_args) ⇒ Object
56 57 58 |
# File 'lib/useragent_parser.rb', line 56 def self.parse_with_referrer(user_agent_string, referrer = nil, *js_args) UseragentParser::UserAgent.new(self.parse_email(user_agent_string, referrer, *js_args)) end |