useragent_parser 0.0.4 → 0.1.0

data/lib/useragent_parser/parsers/device_parser.rb

@@ -0,0 +1,38 @@
+# encoding: utf-8
+
+module UseragentParser
+  class DeviceParser
+    attr_accessor :pattern, :user_agent_re, :device_replacement
+
+    def initialize(pattern, device_replacement = nil)
+      @pattern = pattern
+      @user_agent_re = Regexp.compile(pattern)
+      @device_replacement = device_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)
+      device = nil
+      match = @user_agent_re.match(user_agent_string)
+      if match
+        if @device_replacement
+          if %r'\$1'.match @device_replacement
+            device = @device_replacement.gsub(%r'\$1', match[1])
+          else
+            device = @device_replacement
+          end
+        else
+          device = match[1]
+        end
+      end
+      return device
+    end
+  end
+end

data/lib/useragent_parser/parsers/os_parser.rb

@@ -0,0 +1,39 @@
+# encoding: utf-8
+
+module UseragentParser
+  class OSParser
+    attr_accessor :pattern, :user_agent_re, :family_replacement, :major_replacement
+
+    def initialize(pattern, os_replacement = nil)
+      @pattern = pattern
+      @user_agent_re = Regexp.compile(pattern)
+      @os_replacement = os_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)
+      os, os_v1, os_v2, os_v3, os_v4 = nil, nil, nil, nil, nil
+      match = @user_agent_re.match(user_agent_string)
+      if match
+        if @os_replacement
+          os = @os_replacement
+        else
+          os = match[1]
+        end
+
+        os_v1 = match[2] if match.size >= 3
+        os_v2 = match[3] if match.size >= 4
+        os_v3 = match[4] if match.size >= 5
+        os_v4 = match[5] if match.size >= 6
+      end
+      return os, os_v1, os_v2, os_v3, os_v4
+    end
+  end
+end

data/lib/useragent_parser/{parser.rb → parsers/user_agent_parser.rb}

@@ -1,7 +1,7 @@
 # encoding: utf-8
 
 module UseragentParser
-  class Parser
+  class UserAgentParser
     attr_accessor :pattern, :user_agent_re, :family_replacement, :v1_replacement
 
     def initialize(pattern, family_replacement = nil, v1_replacement = nil)
@@ -38,12 +38,8 @@ module UseragentParser
           v1 = match[2]
         end
 
-        if match.size >= 4
-          v2 = match[3]
-          if match.size >= 5
-            v3 = match[4]
-          end
-        end
+        v2 = match[3] if match.size >= 4
+        v3 = match[4] if match.size >= 5
       end
       return family, v1, v2, v3
     end

data/lib/useragent_parser/user_agent.rb

@@ -4,15 +4,37 @@ module UseragentParser
     attr_reader :os, :os_family, :os_version, :os_major_version, :os_minor_version, :os_patch_version
 
     def initialize(details = {})
-      @browser_family = details['family'] || 'Other'
-      @browser_major_version = details['v1']
-      @browser_minor_version = details['v2']
-      @browser_patch_version = details['v3']
-
-      @os_family = details['os_family'] || 'Other'
-      @os_major_version = details['os_v1']
-      @os_minor_version = details['os_v2']
-      @os_patch_version = details['os_v3']
+      if user_agent = details['user_agent']
+        @browser_family = user_agent['family'] || 'Other'
+        @browser_major_version = user_agent['major']
+        @browser_minor_version = user_agent['minor']
+        @browser_patch_version = user_agent['patch']
+      end
+
+      if os = details['os']
+        @os_family = os['family'] || 'Other'
+        @os_major_version = os['major']
+        @os_minor_version = os['minor']
+        @os_patch_version = os['patch']
+      end
+
+       if device = details['device']
+         @device = device['family']
+         @is_mobile = device['is_mobile']
+         @is_spider = device['is_spider']
+       end
+    end
+
+    def device
+      @device
+    end
+
+    def is_mobile?
+      !!@is_mobile
+    end
+
+    def is_spider?
+      !!@is_spider
     end
 
     def browser_version

data/lib/useragent_parser/version.rb

@@ -1,3 +1,3 @@
 module UseragentParser
-  VERSION = "0.0.4"
+  VERSION = "0.1.0"
 end

data/lib/useragent_parser.rb

@@ -1,45 +1,56 @@
 require "useragent_parser/version"
-require "useragent_parser/parser"
+require "useragent_parser/parsers/user_agent_parser"
+require "useragent_parser/parsers/os_parser"
+require "useragent_parser/parsers/device_parser"
 require "useragent_parser/user_agent"
 
 module UseragentParser
   USER_AGENT_PARSERS = []
   OS_PARSERS = []
+  DEVICE_PARSERS = []
+  MOBILE_USER_AGENT_FAMILIES = []
+  MOBILE_OS_FAMILIES = []
 
-  def UseragentParser.load_parsers!
-    YAML.load_file(File.expand_path(File.dirname(__FILE__)) + "/../config/user_agent_parser.yaml")['user_agent_parsers'].each do |parser|
+  def self.load_parsers!
+    yaml = YAML.load_file(File.expand_path(File.dirname(__FILE__)) + "/../config/regexes.yaml")
+    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
+      family_replacement = parser.fetch('family_replacement', nil)
+      v1_replacement = parser.fetch('v1_replacement', nil)
 
-      USER_AGENT_PARSERS.push UseragentParser::Parser.new(regex, family_replacement, v1_replacement)
+      USER_AGENT_PARSERS.push UseragentParser::UserAgentParser.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|
+    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
+      os_replacement = parser.fetch('os_replacement', nil)
 
-      if parser.has_key?('v1_replacement')
-        v1_replacement = parser['v1_replacement']
-      end
+      OS_PARSERS.push UseragentParser::OSParser.new(regex, os_replacement)
+    end
 
-      OS_PARSERS.push UseragentParser::Parser.new(regex, family_replacement, v1_replacement)
+    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
+
+    MOBILE_USER_AGENT_FAMILIES.push *yaml['mobile_user_agent_families']
+    MOBILE_OS_FAMILIES.push *yaml['mobile_os_families']
   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
+  def self.parse_all(user_agent_string, *js_args)
+    # UseragentParser::UserAgent.new{
+    {
+      '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
 
+  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|
@@ -56,16 +67,46 @@ module UseragentParser
     # 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 = UseragentParser.parse(js_user_agent_string)
-      cf_family, v1, v2, v3 = js_ua.browser_family, js_ua.browser_major_version, js_ua.browser_minor_version, js_ua.browser_patch_version
+      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
+
+  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_family, os_v1, os_v2, os_v3 = parser.parse(user_agent_string)
-      break unless os_family.nil?
+      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
+
+  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
 
-    UseragentParser::UserAgent.new({ 'family' => family, 'v1' => v1, 'v2' => v2, 'v3' => v3, 'os_family' => os_family, 'os_v1' => os_v1, 'os_v2' => os_v2, 'os_v3' => os_v3 })
+    { 'family' => device, 'is_mobile' => is_mobile, 'is_spider' => (device == 'Spider') }
   end
 end
 

data/spec/fixtures/additional_os_tests.yaml

@@ -0,0 +1,134 @@
+test_cases:
+
+  - user_agent_string: 'Mozilla/5.0 (Linux; U; Android 2.1-update1; en-us; Nexus One Build/ERE27) AppleWebKit/530.17 (KHTML, like Gecko) Version/4.0 Mobile Safari/530.17,gzip(gfe),gzip(gfe)'
+    family: 'Android'
+    major: '2'
+    minor: '1'
+    patch: 'update1'
+    patch_minor:
+  
+  - user_agent_string: 'Mozilla/5.0 (Macintosh; U; Intel Mac OS X Mach-O; en-en; rv:1.9.0.12) Gecko/2009070609 Firefox/3.0.12,gzip(gfe),gzip(gfe)'
+    family: 'Mac OS X'
+    major:
+    minor:
+    patch:
+    patch_minor:
+  
+  - user_agent_string: 'Opera/9.80 (iPhone; Opera Mini/5.0.019802/21.572; U; en) Presto/2.5.25 Version/10.54'
+    family: 'iOS'
+    major:
+    minor:
+    patch:
+    patch_minor:
+  
+  - user_agent_string: 'Mozilla/5.0 (SymbianOS/9.2; U; Series60/3.1 NokiaN95/12.0.013; Profile/MIDP-2.0 Configuration/CLDC-1.1 ) AppleWebKit/413 (KHTML, like Gecko) Safari/413'
+    family: 'Symbian OS'
+    major: '9'
+    minor: '2'
+    patch:
+    patch_minor:
+  
+  - user_agent_string: 'Opera/9.80 (S60; SymbOS; Opera Mobi/499; U; de) Presto/2.4.18 Version/10.00,gzip(gfe),gzip(gfe)'
+    family: 'Symbian OS'
+    major:
+    minor:
+    patch:
+    patch_minor:
+  
+  - user_agent_string: 'Mozilla/5.0 (Symbian/3; Series60/5.2 NokiaN8-00/010.022; Profile/MIDP-2.1 Configuration/CLDC-1.1 ) AppleWebKit/525 (KHTML, like Gecko) Version/3.0 BrowserNG/7.2.6.3 3gpp-gba,gzip(gfe),gzip(gfe)'
+    family: 'Symbian^3'
+    major:
+    minor:
+    patch:
+    patch_minor:
+  
+  - user_agent_string: 'BlackBerry9000/4.6.0.167 Profile/MIDP-2.0 Configuration/CLDC-1.1 VendorID/102'
+    family: 'BlackBerry OS'
+    major: '4'
+    minor: '6'
+    patch: '0'
+    patch_minor: '167'
+  
+  - user_agent_string: 'Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9.2.8) Gecko/20100723 Linux Mint/9 (Isadora) Firefox/3.6.8'
+    family: 'Linux Mint'
+    major: '9'
+    minor:
+    patch:
+    patch_minor:
+  
+  - user_agent_string: 'Mozilla/5.0 (X11; CrOS i686 13.587.80) AppleWebKit/535.1 (KHTML, like Gecko) Chrome/13.0.782.99 Safari/535.1'
+    family: 'Chrome OS'
+    major: '13'
+    minor: '587'
+    patch: '80'
+    patch_minor:
+  
+  - user_agent_string: 'Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9.0.1) Gecko/2008072310 Red Hat/3.0.1-3.el4 Firefox/3.0.1,gzip(gfe),gzip(gfe)'
+    family: 'Red Hat'
+    major: '3'
+    minor: '0'
+    patch: '1'
+    patch_minor:
+        
+  - user_agent_string: 'Mozilla/5.0 ( U; Linux x86_32; en-US; rv:1.0) Gecko/20090723 Puppy/3.6.8-0.1.1 Firefox/3.6.7,gzip(gfe),gzip(gfe)'
+    family: 'Puppy'
+    major: '3'
+    minor: '6'
+    patch: '8'
+    patch_minor:
+       
+  - user_agent_string: 'Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9.2.14) Gecko/20110301 PCLinuxOS/1.9.2.14-1pclos2011 (2011) Firefox/3.6.14,gzip(gfe),gzip(gfe),gzip(gfe)'
+    family: 'PCLinuxOS'
+    major: '1'
+    minor: '9'
+    patch: '2'
+    patch_minor: '14'
+ 
+  - user_agent_string: 'Mozilla/5.0 (X11; U; Linux x86_64; cs-CZ; rv:1.9.0.4) Gecko/2008111217 Fedora/3.0.4-1.fc9 Firefox/3.0.4'
+    family: 'Fedora'
+    major: '3'
+    minor: '0'
+    patch: '4'
+    patch_minor:
+    
+  - user_agent_string: 'Mozilla/5.0 (X11; 78; CentOS; US-en) AppleWebKit/527+ (KHTML, like Gecko) Bolt/0.862 Version/3.0 Safari/523.15'
+    family: 'CentOS'
+    major:
+    minor:
+    patch:
+    patch_minor:
+    
+  - user_agent_string: 'Mozilla/5.0 (BlackBerry; U; BlackBerry 9780; en) AppleWebKit/534.8+ (KHTML, like Gecko) Version/6.0.0.526 Mobile Safari/534.8+,gzip(gfe),gzip(gfe),gzip(gfe)'
+    family: 'BlackBerry OS'
+    major: '6'
+    minor: '0'
+    patch: '0'
+    patch_minor: '526'
+    
+  - user_agent_string: 'Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9.1.2) Gecko/20090807 Mandriva Linux/1.9.1.2-1.1mud2009.1 (2009.1) Firefox/3.5.2 FirePHP/0.3,gzip(gfe),gzip(gfe)'
+    family: 'Mandriva'
+    major: '1'
+    minor: '9'
+    patch: '1'
+    patch_minor: '2'
+    
+  - user_agent_string: 'Opera/9.80 (X11; Linux x86_64; U; Slackware; lt) Presto/2.8.131 Version/11.11'
+    family: 'Slackware'
+    major:
+    minor:
+    patch:
+    patch_minor:
+    
+  - user_agent_string: 'Mozilla/5.0 (compatible; MSIE 9.0; Windows Phone OS 7.5; Trident/5.0; IEMobile/9.0; SAMSUNG; SGH-i917)'
+    family: 'Windows Phone OS'
+    major: '7'
+    minor: '5'
+    patch:
+    patch_minor:
+    
+  - user_agent_string: ''
+    family: 'Other'
+    major:
+    minor:
+    patch:
+    patch_minor: