useragent_parser 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2011 Morton Jonuschat
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,49 @@
+# UseragentParser
+
+UseragentParser is a library to detect useful information contained
+within the Useragent Header transmitted by modern web clients.
+
+# Usage
+
+    require 'useragent_parser'
+    ua = UseragentParser.parse('Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10_6_4; en-US) AppleWebKit/525.13 (KHTML, like Gecko) Chrome/8.0.552.237 Safari/525.13')
+
+This will return a hash containing the following keys:
+
+  **family** - The browser family
+  **v1**     - The major browser version
+  **v2**     - The minor browser version
+  **v3**     - The patch level of the browser
+  **os_family**   - The operating system
+  **os_v1**       - The major operating system version
+  **os_v2**       - The minor operating system version
+  **os_v3**       - The patch level of the operating system
+
+In the case that the **family** or **os_family** is unknown, 'Other' will be
+returned. The version components will return _nil_ in the case that the
+respective version level in undetectable.
+
+# Additional information
+
+This is a port of the Python [ua-parser](http://code.google.com/p/ua-parser/) library.
+
+## Maintainers
+
+ * Morton Jonuschat ([github.com/yabawock](https://github.com/yabawock))
+
+# License
+
+Copyright 2011 Morton Jonuschat
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+desc "Run all RSpec tests"
+RSpec::Core::RakeTask.new(:spec)

data/config/user_agent_parser.yaml

@@ -0,0 +1,259 @@
+user_agent_parsers:
+  #### SPECIAL CASES TOP ####
+
+  # must go before Opera
+  - regex: '^(Opera)/(\d+)\.(\d+) \(Nintendo Wii'
+    family_replacement: 'Wii'
+
+  # must go before Firefox to catch SeaMonkey.
+  - regex: '(SeaMonkey|Fennec|Camino)/(\d+)\.(\d+)\.?([ab]?\d+[a-z]*)'
+
+  # must go before Firefox
+
+  # must go before Browser/major_version.minor_version - eg: Minefield/3.1a1pre
+  - regex: '(Namoroka|Shiretoko|Minefield)/(\d+)\.(\d+)\.(\d+(?:pre)?)'
+    family_replacement: 'Firefox ($1)'
+
+  - regex: '(Firefox)/(\d+)\.(\d+)([ab]\d+[a-z]*)'
+    family_replacement: 'Firefox Beta'
+
+  - regex: '(Firefox)-(?:\d+\.\d+)?/(\d+)\.(\d+)([ab]\d+[a-z]*)'
+    family_replacement: 'Firefox Beta'
+
+  - regex: '(Namoroka|Shiretoko|Minefield)/(\d+)\.(\d+)([ab]\d+[a-z]*)?'
+    family_replacement: 'Firefox ($1)'
+
+  - regex: '(Firefox).*Tablet browser (\d+)\.(\d+)\.(\d+)'
+    family_replacement: 'MicroB'
+
+  - regex: '(MozillaDeveloperPreview)/(\d+)\.(\d+)([ab]\d+[a-z]*)?'
+
+  # e.g.: Flock/2.0b2
+  - regex: '(Flock)/(\d+)\.(\d+)(b\d+?)'
+
+  # RockMelt
+  - regex: '(RockMelt)/(\d+)\.(\d+)\.(\d+)'
+
+  # e.g.: Fennec/0.9pre
+  - regex: '(Fennec)/(\d+)\.(\d+)(pre)'
+
+  - regex: '(Navigator)/(\d+)\.(\d+)\.(\d+)'
+    family_replacement: 'Netscape'
+
+  - regex: '(Navigator)/(\d+)\.(\d+)([ab]\d+)'
+    family_replacement: 'Netscape'
+
+  - regex: '(Netscape6)/(\d+)\.(\d+)\.(\d+)'
+    family_replacement: 'Netscape'
+
+  - regex: '(MyIBrow)/(\d+)\.(\d+)'
+    family_replacement: 'My Internet Browser'
+
+  # Opera will stop at 9.80 and hide the real version in the Version string.
+  # see: http://dev.opera.com/articles/view/opera-ua-string-changes/
+  - regex: '(Opera Tablet).*Version\/(\d+)\.(\d+)(?:\.(\d+))?'
+
+  - regex: '(Opera)/.+Opera Mobi.+Version/(\d+)\.(\d+)'
+    family_replacement: 'Opera Mobile'
+
+  - regex: '(Opera Mini)/(\d+)\.(\d+)'
+
+  - regex: '(Opera)/9.80.*Version\/(\d+)\.(\d+)(?:\.(\d+))?'
+
+  # Palm WebOS looks a lot like Safari.
+  - regex: '(webOS)/(\d+)\.(\d+)'
+    family_replacement: 'Palm webOS'
+
+  # LuaKit has no version info.
+  # http://luakit.org/projects/luakit/
+  - regex: '(luakit)'
+    family_replacement: 'LuaKit'
+
+  # Lightning (for Thunderbird)
+  # http://www.mozilla.org/projects/calendar/lightning/
+  - regex: '(Lightning)/(\d+)\.(\d+)([ab]?\d+[a-z]*)'
+
+  # Swiftfox
+  - regex: '(Firefox)/(\d+)\.(\d+)\.(\d+(?:pre)?) \(Swiftfox\)'
+    family_replacement: 'Swiftfox'
+  - regex: '(Firefox)/(\d+)\.(\d+)([ab]\d+[a-z]*)? \(Swiftfox\)'
+    family_replacement: 'Swiftfox'
+
+  # Rekonq
+  - regex: 'rekonq'
+    family_replacement: 'Rekonq'
+
+  # Conkeror lowercase/uppercase
+  # http://conkeror.org/
+  - regex: '(conkeror|Conkeror)/(\d+)\.(\d+)\.?(\d+)?'
+    family_replacement: 'Conkeror'
+
+  # catches lower case konqueror
+  - regex: '(konqueror)/(\d+)\.(\d+)\.(\d+)'
+    family_replacement: 'Konqueror'
+
+  - regex: '(PlayBook).+RIM Tablet OS (\d+)\.(\d+)\.(\d+)'
+
+  - regex: '(WeTab)-Browser'
+
+  - regex: '(wOSBrowser).+TouchPad/(\d+)\.(\d+)'
+    family_replacement: 'webOS TouchPad'
+
+  - regex: '(Comodo_Dragon)/(\d+)\.(\d+)\.(\d+)'
+    family_replacement: 'Comodo Dragon'
+
+  # YottaaMonitor bot
+  - regex: '(YottaaMonitor)'
+
+  # must go before NetFront below
+  - regex: '(Kindle)/(\d+)\.(\d+)'
+
+  # Maxthon Googlebot
+  - regex: 'Googlebot\/\d+\.\d+.+(Maxthon)'
+
+  # Mobile Safari on Android
+  - regex: 'Android.*\).*(Version)/(\d+)\.(\d+)(?:\.(\d+))?.*Safari/'
+    family_replacement: 'Mobile Safari'
+
+  # Mobile Safari on iOS
+  - regex: '(Version)/(\d+)\.(\d+)(?:\.(\d+))?.*Mobile/\w+ Safari/\d+'
+    family_replacement: 'Mobile Safari'
+
+  #### END SPECIAL CASES TOP ####
+
+  #### MAIN CASES - this catches > 50% of all browsers ####
+
+  # Browser/major_version.minor_version.beta_version
+  - regex: '(AdobeAIR|Chromium|FireWeb|Jasmine|ANTGalio|Midori|Fresco|Lobo|PaleMoon|Maxthon|Lynx|OmniWeb|Dillo|Camino|Demeter|Fluid|Fennec|Shiira|Sunrise|Chrome|Flock|Netscape|Lunascape|Epiphany|WebPilot|Vodafone|NetFront|Konqueror|SeaMonkey|Kazehakase|Vienna|Iceape|Iceweasel|IceWeasel|Iron|K-Meleon|Sleipnir|Galeon|GranParadiso|Opera Mini|iCab|NetNewsWire|ThunderBrowse|Thunderbird|Iron|Iris)/(\d+)\.(\d+)\.(\d+)'
+
+  # Browser/major_version.minor_version
+  - regex: '(Bolt|Jasmine|IEMobile|IceCat|Skyfire|Midori|Maxthon|Lynx|Arora|IBrowse|Dillo|Camino|Shiira|Fennec|Phoenix|Chrome|Flock|Netscape|Lunascape|Epiphany|WebPilot|Opera Mini|Opera|Vodafone|NetFront|Konqueror|Googlebot|SeaMonkey|Kazehakase|Vienna|Iceape|Iceweasel|IceWeasel|Iron|K-Meleon|Sleipnir|Galeon|GranParadiso|iCab|NetNewsWire|Iron|Space Bison|Stainless|Orca|Dolfin|BOLT)/(\d+)\.(\d+)'
+
+  # Browser major_version.minor_version.beta_version (space instead of slash)
+  - regex: '(iRider|Crazy Browser|SkipStone|iCab|Lunascape|Sleipnir|Maemo Browser) (\d+)\.(\d+)\.(\d+)'
+  # Browser major_version.minor_version (space instead of slash)
+  - regex: '(iCab|Lunascape|Opera|Android) (\d+)\.(\d+)\.?(\d+)?'
+
+  - regex: '(IEMobile) (\d+)\.(\d+)'
+    family_replacement: 'IE Mobile'
+
+  # AFTER THE EDGE CASES ABOVE!
+  - regex: '(Firefox)/(\d+)\.(\d+)\.(\d+)'
+
+  - regex: '(Firefox)/(\d+)\.(\d+)(pre|[ab]\d+[a-z]*)?'
+  #### END MAIN CASES ####
+
+  #### SPECIAL CASES ####
+  - regex: '(Obigo|OBIGO)[^\d]*(\d+)(?:.(\d+))?'
+    family_replacement: 'Obigo'
+
+  - regex: '(MAXTHON|Maxthon) (\d+)\.(\d+)'
+    family_replacement: 'Maxthon'
+
+  - regex: '(Maxthon|MyIE2|Uzbl|Shiira)'
+    major_version_replacement: '0'
+
+  - regex: '(PLAYSTATION) (\d+)'
+    family_replacement: 'PlayStation'
+
+  - regex: '(PlayStation Portable)[^\d]+(\d+).(\d+)'
+
+  - regex: '(BrowseX) \((\d+)\.(\d+)\.(\d+)'
+
+  - regex: '(POLARIS)/(\d+)\.(\d+)'
+    family_replacement: 'Polaris'
+
+  - regex: '(BonEcho)/(\d+)\.(\d+)\.(\d+)'
+    family_replacement: 'Bon Echo'
+
+  - regex: '(iPod).+Version/(\d+)\.(\d+)\.(\d+)'
+
+  - regex: '(iPhone) OS (\d+)_(\d+)(?:_(\d+))?'
+
+  - regex: '(iPad).+ OS (\d+)_(\d+)(?:_(\d+))?'
+
+  - regex: '(Avant)'
+    major_version_replacement: '1'
+
+  - regex: '(Nokia)[EN]?(\d+)'
+
+  # BlackBerry devices
+  - regex: '(Black[bB]erry).+Version\/(\d+)\.(\d+)\.(\d+)'
+    family_replacement: 'Blackberry'
+
+  - regex: '(Black[bB]erry)\s?(\d+)'
+    family_replacement: 'Blackberry'
+
+  - regex: '(OmniWeb)/v(\d+)\.(\d+)'
+
+  - regex: '(Blazer)/(\d+)\.(\d+)'
+    family_replacement: 'Palm Blazer'
+
+  - regex: '(Pre)/(\d+)\.(\d+)'
+    family_replacement: 'Palm Pre'
+
+  - regex: '(Links) \((\d+)\.(\d+)'
+
+  - regex: '(QtWeb) Internet Browser/(\d+)\.(\d+)'
+
+  #- regex: '\(iPad;.+(Version)/(\d+)\.(\d+)(?:\.(\d+))?.*Safari/'
+  #  family_replacement: 'iPad'
+
+  # Safari
+  - regex: '(Version)/(\d+)\.(\d+)(?:\.(\d+))?.*Safari/'
+    family_replacement: 'Safari'
+  # Safari didn't provide "Version/d.d.d" prior to 3.0
+  - regex: '(Safari)/\d+'
+
+  - regex: '(OLPC)/Update(\d+)\.(\d+)'
+
+  - regex: '(OLPC)/Update()\.(\d+)'
+    major_version_replacement: '0'
+
+  - regex: '(SamsungSGHi560)'
+    family_replacement: 'Samsung SGHi560'
+
+  - regex: '^(SonyEricssonK800i)'
+    family_replacement: 'Sony Ericsson K800i'
+
+  - regex: '(Teleca Q7)'
+
+  - regex: '(MSIE) (\d+)\.(\d+)'
+    family_replacement: 'IE'
+
+
+os_parsers:
+  - regex: '(Windows NT|Windows) (\d+)\.(\d+)'
+    family_replacement: 'Windows'
+  - regex: '(Windows Phone OS) (\d+)\.(\d+)'
+    family_replacement: 'Windows Phone'
+  - regex: '(Windows|Win) (XP|9x|95|98|ME)'
+    family_replacement: 'Windows'
+  - regex: '(Windows CE)'
+  - regex: '(Win)(95|98|9x)'
+    family_replacement: 'Windows'
+  - regex: '(Windows)'
+
+  - regex: '(Android) (\d+)\.(\d+)\.(\d+)'
+  - regex: '(Android) (\d+)\.(\d+)'
+
+  - regex: '(CPU OS|CPU iPhone OS) (\d+)_(\d+)_(\d+) like Mac OS X'
+    family_replacement: 'iOS'
+  - regex: '(CPU OS|CPU iPhone OS) (\d+)_(\d+) like Mac OS X'
+    family_replacement: 'iOS'
+
+  - regex: '(Mac OS X) v?(\d+)\.(\d+)\.?(\d+)?'
+  - regex: '(Mac OS X) v?(\d+)_(\d+)_?(\d+)?'
+  - regex: '(Mac OS X)/(\d+)\.(\d+)\.?(\d+)?'
+  - regex: '(os=Mac) (\d+)\.(\d+)\.(\d+)'
+    family_replacement: 'Mac OS X'
+  - regex: '(Mac OS X|Mac_PowerPC|iMac|MacBook|Macintosh|PowerMac)'
+    family_replacement: 'Mac OS X'
+
+  - regex: '(FreeBSD)'
+  - regex: '(iPhone Simulator)'
+
+  - regex: '(Linux)'
+
+product_parsers:
+  - regex: '(iPhone)'

data/lib/useragent_parser/parser.rb

@@ -0,0 +1,51 @@
+# encoding: utf-8
+
+module UseragentParser
+  class Parser
+    attr_accessor :pattern, :user_agent_re, :family_replacement, :v1_replacement
+
+    def initialize(pattern, family_replacement = nil, v1_replacement = nil)
+      @pattern = pattern
+      @user_agent_re = Regexp.compile(pattern)
+      @family_replacement = family_replacement
+      @v1_replacement = v1_replacement
+    end
+
+    def match_spans(user_agent_string)
+      match_spans = []
+      match = @user_agent_re.match(user_agent_string)
+      if match
+        # Return the offsets
+      end
+    end
+
+    def parse(user_agent_string)
+      family, v1, v2, v3 = nil, nil, nil, nil
+      match = @user_agent_re.match(user_agent_string)
+      if match
+        family = match[1]
+        if @family_replacement
+          if %r'\$1'.match @family_replacement
+            family = @family_replacement.gsub(%r'\$1', match[1])
+          else
+            family = @family_replacement
+          end
+        end
+
+        if @v1_replacement
+          v1 = @v1_replacement
+        else
+          v1 = match[2]
+        end
+
+        if match.size >= 4
+          v2 = match[3]
+          if match.size >= 5
+            v3 = match[4]
+          end
+        end
+      end
+      return family, v1, v2, v3
+    end
+  end
+end

data/lib/useragent_parser/version.rb

@@ -0,0 +1,3 @@
+module UseragentParser
+  VERSION = "0.0.1"
+end

data/lib/useragent_parser.rb

@@ -0,0 +1,79 @@
+require "useragent_parser/version"
+require "useragent_parser/parser"
+
+module UseragentParser
+  USER_AGENT_PARSERS = []
+  OS_PARSERS = []
+
+  def UseragentParser.load_parsers!
+    YAML.load_file(File.expand_path(File.dirname(__FILE__)) + "/../config/user_agent_parser.yaml")['user_agent_parsers'].each do |parser|
+      regex = parser['regex']
+      family_replacement, v1_replacement = nil, nil
+      if parser.has_key?('family_replacement')
+        family_replacement = parser['family_replacement']
+      end
+
+      if parser.has_key?('v1_replacement')
+        v1_replacement = parser['v1_replacement']
+      end
+
+      USER_AGENT_PARSERS.push UseragentParser::Parser.new(regex, family_replacement, v1_replacement)
+    end
+
+    YAML.load_file(File.expand_path(File.dirname(__FILE__)) + "/../config/user_agent_parser.yaml")['os_parsers'].each do |parser|
+      regex = parser['regex']
+      family_replacement, v1_replacement, code_name = nil, nil, nil
+      if parser.has_key?('family_replacement')
+        family_replacement = parser['family_replacement']
+      end
+
+      if parser.has_key?('v1_replacement')
+        v1_replacement = parser['v1_replacement']
+      end
+
+      OS_PARSERS.push UseragentParser::Parser.new(regex, family_replacement, v1_replacement)
+    end
+  end
+
+  def UseragentParser.parse(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, nil, nil, nil
+    os_family, os_v1, os_v2, os_v3 = nil, nil, nil, 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 (%{family} %{v1})' % { :family => family, :v1 => v1 }
+      cf_family, v1, v2, v3 = UseragentParser.parse(js_user_agent_string).values
+    end
+
+    OS_PARSERS.each do |parser|
+      os_family, os_v1, os_v2, os_v3 = parser.parse(user_agent_string)
+      break unless os_family.nil?
+    end
+
+    {
+      'family' => family || 'Other',
+      'v1' => v1,
+      'v2' => v2,
+      'v3' => v3,
+      'os_family' => os_family || 'Other',
+      'os_v1' => os_v1,
+      'os_v2' => os_v2,
+      'os_v3' => os_v3
+    }
+  end
+end
+
+UseragentParser.load_parsers!