useragent_parser 0.0.2 → 0.0.3

data/lib/useragent_parser.rb

@@ -1,5 +1,6 @@
 require "useragent_parser/version"
 require "useragent_parser/parser"
+require "useragent_parser/user_agent"
 
 module UseragentParser
   USER_AGENT_PARSERS = []
@@ -56,7 +57,7 @@ module UseragentParser
     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['family'], js_ua['v1'], js_ua['v2'], js_ua['v3']
+      cf_family, v1, v2, v3 = js_ua.browser_family, js_ua.browser_major_version, js_ua.browser_minor_version, js_ua.browser_patch_version
     end
 
     OS_PARSERS.each do |parser|
@@ -64,16 +65,7 @@ module UseragentParser
       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
-    }
+    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 })
   end
 end
 

data/lib/useragent_parser/user_agent.rb

@@ -0,0 +1,88 @@
+module UseragentParser
+  class UserAgent
+    attr_reader :browser, :browser_family, :browser_version, :browser_major_version, :browser_minor_version, :browser_patch_version
+    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']
+    end
+
+    def browser_version
+      @browser_version ||= "#{browser_major_version}.#{browser_minor_version}.#{browser_patch_version}".gsub(/\.+$/, '').strip
+    end
+
+    def os_version
+      @browser_version ||= "#{os_major_version}.#{os_minor_version}.#{os_patch_version}".gsub(/\.+$/, '').strip
+    end
+
+    def os
+      @os ||= os_name
+    end
+
+    def browser
+      @browser ||= browser_name
+    end
+
+    protected
+
+    def browser_name
+      "#{browser_family} #{browser_version}"
+    end
+
+    def os_name
+      case os_family
+      when 'Windows' then os_names_win
+      when 'Windows NT' then os_names_winnt
+      when 'Mac OS X' then os_names_osx
+      else "#{os_family} #{os_version}".strip
+      end
+    end
+
+    def os_release
+      @release ||= "#{os_major_version}.#{os_minor_version}".gsub(/\.$/, '')
+    end
+
+    def os_names_win
+      "Microsoft Windows #{os_version}"
+    end
+
+    def os_names_winnt
+      prefix = "Microsoft Windows"
+      case os_release
+      when "3.1" then "#{prefix} NT 3.1"
+      when "3.5" then "#{prefix} NT 3.5"
+      when "4.0" then "#{prefix} NT 4.0"
+      when "5.0" then "#{prefix} 2000"
+      when "5.1" then "#{prefix} XP"
+      when "5.2" then "#{prefix} XP 64bit / Server 2003"
+      when "6.0" then "#{prefix} Vista / Server 2008"
+      when "6.1" then "#{prefix} 7 / Server 2008 R2"
+      when "6.2" then "#{prefix} 8"
+      else "#{prefix} #{os_version}"
+      end
+    end
+
+    def os_names_osx
+      prefix = "Apple Mac OS X"
+      case os_release
+      when "10.0" then "#{prefix} #{os_version} (Cheetah)"
+      when "10.1" then "#{prefix} #{os_version} (Puma)"
+      when "10.2" then "#{prefix} #{os_version} (Jaguar)"
+      when "10.3" then "#{prefix} #{os_version} (Panther)"
+      when "10.4" then "#{prefix} #{os_version} (Tiger)"
+      when "10.5" then "#{prefix} #{os_version} (Leopard)"
+      when "10.6" then "#{prefix} #{os_version} (Snow Leopard)"
+      when "10.7" then "#{prefix} #{os_version} (Lion)"
+      else "#{prefix} #{os_version}"
+      end
+    end
+  end
+end

data/lib/useragent_parser/version.rb

@@ -1,3 +1,3 @@
 module UseragentParser
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/spec_helper.rb

@@ -2,6 +2,7 @@
 
 require 'rubygems'
 require 'multi_json'
+require 'useragent_parser'
 
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
 

data/spec/useragent_parser/user_agent_spec.rb

@@ -0,0 +1,161 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe UseragentParser::UserAgent do
+  describe "for browser details" do
+    it "should report the browser family" do
+      UseragentParser::UserAgent.new({ 'family' => 'Chrome', 'v1' => '14', 'v2' => '0', 'v3' => '835' }).browser_family.should == 'Chrome'
+    end
+
+    it "should report the browser major version" do
+      UseragentParser::UserAgent.new({ 'family' => 'Chrome', 'v1' => '14', 'v2' => '0', 'v3' => '835' }).browser_major_version.should == '14'
+    end
+
+    it "should report the browser minor version" do
+      UseragentParser::UserAgent.new({ 'family' => 'Chrome', 'v1' => '14', 'v2' => '0', 'v3' => '835' }).browser_minor_version.should == '0'
+    end
+
+    it "should report the browser patch version" do
+      UseragentParser::UserAgent.new({ 'family' => 'Chrome', 'v1' => '14', 'v2' => '0', 'v3' => '835' }).browser_patch_version.should == '835'
+    end
+
+    it "should report the browser version" do
+      UseragentParser::UserAgent.new({ 'family' => 'Chrome', 'v1' => '14', 'v2' => '0', 'v3' => '835' }).browser_version.should == '14.0.835'
+    end
+
+    it "should report the browser version without patch level" do
+      UseragentParser::UserAgent.new({ 'family' => 'Firefox', 'v1' => '5', 'v2' => '0' }).browser_version.should == '5.0'
+    end
+
+    it "should report the browser version without minor version" do
+      UseragentParser::UserAgent.new({ 'family' => 'Firefox', 'v1' => '5' }).browser_version.should == '5'
+    end
+
+    it "should report the browser family without version" do
+      UseragentParser::UserAgent.new({ 'family' => 'Opera' }).browser_version.should == ''
+    end
+  end
+
+  describe "for operating system details" do
+    it "should report the os family" do
+      UseragentParser::UserAgent.new({ 'os_family' => 'Windows NT', 'os_v1' => '3', 'os_v2' => '1' }).os_family.should == 'Windows NT'
+    end
+
+    it "should report the major os version" do
+      UseragentParser::UserAgent.new({ 'os_family' => 'Windows NT', 'os_v1' => '3', 'os_v2' => '1' }).os_major_version.should == '3'
+    end
+
+    it "should report the minor os version" do
+      UseragentParser::UserAgent.new({ 'os_family' => 'Windows NT', 'os_v1' => '3', 'os_v2' => '1' }).os_minor_version.should == '1'
+    end
+
+    it "should report the os patchlevel" do
+      UseragentParser::UserAgent.new({ 'os_family' => 'Windows NT', 'os_v1' => '3', 'os_v2' => '1' }).os_patch_version.should be_nil
+    end
+
+    it "should report the os version" do
+      UseragentParser::UserAgent.new({ 'os_family' => 'Windows NT', 'os_v1' => '3', 'os_v2' => '1' }).os_version.should == '3.1'
+    end
+
+    it "should know the code name for Windows NT 3.1" do
+      UseragentParser::UserAgent.new({ 'os_family' => 'Windows NT', 'os_v1' => '3', 'os_v2' => '1' }).os.should == 'Microsoft Windows NT 3.1'
+    end
+
+    it "should know the code name for Windows NT 3.5" do
+      UseragentParser::UserAgent.new({ 'os_family' => 'Windows NT', 'os_v1' => '3', 'os_v2' => '5' }).os.should == 'Microsoft Windows NT 3.5'
+    end
+
+    it "should know the code name for Windows NT 4.0" do
+      UseragentParser::UserAgent.new({ 'os_family' => 'Windows NT', 'os_v1' => '4', 'os_v2' => '0' }).os.should == 'Microsoft Windows NT 4.0'
+    end
+
+    it "should know the code name for Windows 2000" do
+      UseragentParser::UserAgent.new({ 'os_family' => 'Windows NT', 'os_v1' => '5', 'os_v2' => '0' }).os.should == 'Microsoft Windows 2000'
+    end
+
+    it "should know the code name for Windows XP" do
+      UseragentParser::UserAgent.new({ 'os_family' => 'Windows NT', 'os_v1' => '5', 'os_v2' => '1' }).os.should == 'Microsoft Windows XP'
+    end
+
+    it "should know the code name for Windows XP 64bit / Server 2003" do
+      UseragentParser::UserAgent.new({ 'os_family' => 'Windows NT', 'os_v1' => '5', 'os_v2' => '2' }).os.should == 'Microsoft Windows XP 64bit / Server 2003'
+    end
+
+    it "should know the code name for Windows Vista / Server 2008" do
+      UseragentParser::UserAgent.new({ 'os_family' => 'Windows NT', 'os_v1' => '6', 'os_v2' => '0' }).os.should == 'Microsoft Windows Vista / Server 2008'
+    end
+
+    it "should know the code name for Windows 7 / Server 2008 R2" do
+      UseragentParser::UserAgent.new({ 'os_family' => 'Windows NT', 'os_v1' => '6', 'os_v2' => '1' }).os.should == 'Microsoft Windows 7 / Server 2008 R2'
+    end
+
+    it "should know the code name for Windows 8" do
+      UseragentParser::UserAgent.new({ 'os_family' => 'Windows NT', 'os_v1' => '6', 'os_v2' => '2' }).os.should == 'Microsoft Windows 8'
+    end
+
+    it "should know the code name for Windows 3.1" do
+      UseragentParser::UserAgent.new({ 'os_family' => 'Windows', 'os_v1' => '3', 'os_v2' => '1' }).os.should == 'Microsoft Windows 3.1'
+    end
+
+    it "should know the code name for Windows 95" do
+      UseragentParser::UserAgent.new({ 'os_family' => 'Windows', 'os_v1' => '95' }).os.should == 'Microsoft Windows 95'
+    end
+
+    it "should know the code name for Windows 98" do
+      UseragentParser::UserAgent.new({ 'os_family' => 'Windows', 'os_v1' => '98' }).os.should == 'Microsoft Windows 98'
+    end
+
+    it "should know the code name for Windows ME" do
+      UseragentParser::UserAgent.new({ 'os_family' => 'Windows', 'os_v1' => 'ME' }).os.should == 'Microsoft Windows ME'
+    end
+
+    it "should know the code name for Windows 9x" do
+      UseragentParser::UserAgent.new({ 'os_family' => 'Windows', 'os_v1' => '9x' }).os.should == 'Microsoft Windows 9x'
+    end
+
+    it "should know the code name for Mac OS X 10.0" do
+      UseragentParser::UserAgent.new({ 'os_family' => 'Mac OS X', 'os_v1' => '10', 'os_v2' => '0' }).os.should == 'Apple Mac OS X 10.0 (Cheetah)'
+    end
+
+    it "should know the code name for Mac OS X 10.0" do
+      UseragentParser::UserAgent.new({ 'os_family' => 'Mac OS X', 'os_v1' => '10', 'os_v2' => '0', 'os_v3' => 2 }).os.should == 'Apple Mac OS X 10.0.2 (Cheetah)'
+    end
+
+    it "should know the code name for Mac OS X 10.1" do
+      UseragentParser::UserAgent.new({ 'os_family' => 'Mac OS X', 'os_v1' => '10', 'os_v2' => '1', 'os_v3' => 2 }).os.should == 'Apple Mac OS X 10.1.2 (Puma)'
+    end
+
+    it "should know the code name for Mac OS X 10.2" do
+      UseragentParser::UserAgent.new({ 'os_family' => 'Mac OS X', 'os_v1' => '10', 'os_v2' => '2', 'os_v3' => 2 }).os.should == 'Apple Mac OS X 10.2.2 (Jaguar)'
+    end
+
+    it "should know the code name for Mac OS X 10.3" do
+      UseragentParser::UserAgent.new({ 'os_family' => 'Mac OS X', 'os_v1' => '10', 'os_v2' => '3', 'os_v3' => 2 }).os.should == 'Apple Mac OS X 10.3.2 (Panther)'
+    end
+
+    it "should know the code name for Mac OS X 10.4" do
+      UseragentParser::UserAgent.new({ 'os_family' => 'Mac OS X', 'os_v1' => '10', 'os_v2' => '4', 'os_v3' => 2 }).os.should == 'Apple Mac OS X 10.4.2 (Tiger)'
+    end
+
+    it "should know the code name for Mac OS X 10.5" do
+      UseragentParser::UserAgent.new({ 'os_family' => 'Mac OS X', 'os_v1' => '10', 'os_v2' => '5', 'os_v3' => 2 }).os.should == 'Apple Mac OS X 10.5.2 (Leopard)'
+    end
+
+    it "should know the code name for Mac OS X 10.6" do
+      UseragentParser::UserAgent.new({ 'os_family' => 'Mac OS X', 'os_v1' => '10', 'os_v2' => '6', 'os_v3' => 2 }).os.should == 'Apple Mac OS X 10.6.2 (Snow Leopard)'
+    end
+
+    it "should know the code name for Mac OS X 10.7" do
+      UseragentParser::UserAgent.new({ 'os_family' => 'Mac OS X', 'os_v1' => '10', 'os_v2' => '7', 'os_v3' => '2' }).os.should == 'Apple Mac OS X 10.7.2 (Lion)'
+    end
+
+    it "should provide a generic os/version for other operating systems" do
+      UseragentParser::UserAgent.new({ 'os_family' => 'Linux', 'os_v1' => '2', 'os_v2' => '6', 'os_v3' => '32' }).os.should == 'Linux 2.6.32'
+    end
+
+    it "should provide a generic os name without version" do
+      UseragentParser::UserAgent.new({ 'os_family' => 'FreeBSD' }).os.should == 'FreeBSD'
+    end
+  end
+end

data/spec/useragent_parser/useragent_parser_spec.rb

@@ -1,7 +1,6 @@
 # encoding: utf-8
 
 require 'spec_helper'
-require 'useragent_parser'
 
 describe UseragentParser do
   YAML.load_file(File.expand_path(File.dirname(__FILE__)) + "/../fixtures/test_user_agent_parser.yaml")['test_cases'].each do |testcase|
@@ -11,14 +10,14 @@ describe UseragentParser do
         js_ua = [ js_ua['js_user_agent_string'], js_ua['js_user_agent_family'], js_ua['js_user_agent_v1'], js_ua['js_user_agent_v2'], js_ua['js_user_agent_v3'] ]
       end
       result = UseragentParser.parse(testcase['user_agent_string'], *js_ua)
-      result['family'].should     == testcase['family']
-      result['v1'].should         == testcase['v1']
-      result['v2'].should         == testcase['v2']
-      result['v3'].should         == testcase['v3']
-      result['os_family'].should  == testcase['os_family']
-      result['os_v1'].should      == testcase['os_v1']
-      result['os_v2'].should      == testcase['os_v2']
-      result['os_v3'].should      == testcase['os_v3']
+      result.browser_family.should        == testcase['family']
+      result.browser_major_version.should == testcase['v1']
+      result.browser_minor_version.should == testcase['v2']
+      result.browser_patch_version.should == testcase['v3']
+      result.os_family.should             == testcase['os_family']
+      result.os_major_version.should      == testcase['os_v1']
+      result.os_minor_version.should      == testcase['os_v2']
+      result.os_patch_version.should      == testcase['os_v3']
     end
   end
 
@@ -29,10 +28,10 @@ describe UseragentParser do
         js_ua = eval(testcase['js_ua'].gsub("': '", "' => '")).values
       end
       result = UseragentParser.parse(testcase['user_agent_string'], *js_ua)
-      result['family'].should == testcase['family']
-      result['v1'].should     == testcase['v1']
-      result['v2'].should     == testcase['v2']
-      result['v3'].should     == testcase['v3']
+      result.browser_family.should        == testcase['family']
+      result.browser_major_version.should == testcase['v1']
+      result.browser_minor_version.should == testcase['v2']
+      result.browser_patch_version.should == testcase['v3']
     end
   end
 
@@ -43,10 +42,10 @@ describe UseragentParser do
         js_ua = eval(testcase['js_ua'].gsub("': '", "' => '")).values
       end
       result = UseragentParser.parse(testcase['user_agent_string'], *js_ua)
-      result['family'].should == testcase['family']
-      result['v1'].should     == testcase['v1']
-      result['v2'].should     == testcase['v2']
-      result['v3'].should     == testcase['v3']
+      result.browser_family.should        == testcase['family']
+      result.browser_major_version.should == testcase['v1']
+      result.browser_minor_version.should == testcase['v2']
+      result.browser_patch_version.should == testcase['v3']
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: useragent_parser
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-22 00:00:00.000000000Z
+date: 2011-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70355423603360 !ruby/object:Gem::Requirement
+  requirement: &70149734670220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 0.9.0
   type: :development
   prerelease: false
-  version_requirements: *70355423603360
+  version_requirements: *70149734670220
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70355423602860 !ruby/object:Gem::Requirement
+  requirement: &70149734667680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 2.6.0
   type: :development
   prerelease: false
-  version_requirements: *70355423602860
+  version_requirements: *70149734667680
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &70355423602380 !ruby/object:Gem::Requirement
+  requirement: &70149734667040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,7 +43,7 @@ dependencies:
         version: 1.0.1
   type: :development
   prerelease: false
-  version_requirements: *70355423602380
+  version_requirements: *70149734667040
 description: UseragentParser extracts browser and operating system information from
   the headers sent by most browsers and email clients
 email:
@@ -61,11 +61,13 @@ files:
 - config/user_agent_parser.yaml
 - lib/useragent_parser.rb
 - lib/useragent_parser/parser.rb
+- lib/useragent_parser/user_agent.rb
 - lib/useragent_parser/version.rb
 - spec/fixtures/firefox_user_agent_strings.yaml
 - spec/fixtures/pgts_browser_list.yaml
 - spec/fixtures/test_user_agent_parser.yaml
 - spec/spec_helper.rb
+- spec/useragent_parser/user_agent_spec.rb
 - spec/useragent_parser/useragent_parser_spec.rb
 - useragent_parser.gemspec
 homepage: https://github.com/yabawock/useragent_parser
@@ -82,7 +84,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4296264269086320975
+      hash: -1317810903120692867
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -91,10 +93,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4296264269086320975
+      hash: -1317810903120692867
 requirements: []
 rubyforge_project: useragent_parser
-rubygems_version: 1.8.6
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: A library to extract informtion from Useragent headers
@@ -103,4 +105,5 @@ test_files:
 - spec/fixtures/pgts_browser_list.yaml
 - spec/fixtures/test_user_agent_parser.yaml
 - spec/spec_helper.rb
+- spec/useragent_parser/user_agent_spec.rb
 - spec/useragent_parser/useragent_parser_spec.rb