jaxn-parse_user_agent 0.1.1

data/README

@@ -0,0 +1 @@
+A simple user agent parser for Ruby.

data/lib/parse_user_agent.rb

@@ -0,0 +1,95 @@
+class ParseUserAgent
+  
+  attr_reader :ostype, :browser, :os_version, :browser_version_major
+  
+  def parse(user_agent)
+    if '-' == user_agent
+      raise 'Invalid User Agent'
+    end
+    
+    @user_agent = user_agent
+    
+    # fix Opera
+    #useragent =~ s/Opera (\d)/Opera\/$1/i;
+    useragent = @user_agent.gsub(/(Opera [\d])/,'Opera\1')
+    
+    # grab all Agent/version strings as 'agents'
+    @agents = Array.new
+    @user_agent.split(/\s+/).each {|string| 
+      if string =~ /\//
+        @agents<< string
+      end
+    }
+    
+    # cycle through the agents to set browser and version (MSIE is set later)
+    if @agents && @agents.length > 0
+        @agents.each {|agent|
+          parts = agent.split('/')
+          @browser = parts[0]
+          @browser_version = parts[1]
+          if @browser == 'Firefox'
+            @browser_version_major = parts[1].slice(0,3)
+            @browser_version_minor = parts[1].sub(@browser_version_major,'').sub('.','')
+          elsif @browser == 'Safari'
+            if parts[1].slice(0,3).to_f < 400
+              @browser_version_major = '1'
+            else
+              @browser_version_major = '2'
+            end
+          else
+            @browser_version_major = parts[1].slice(0,1)
+          end
+        }
+    end
+    
+    # grab all of the properties (within parens)
+    # should be in relation to the agent if possible  
+    @detail = @user_agent
+    @user_agent.gsub(/\((.*)\)/,'').split(/\s/).each {|part| @detail = @detail.gsub(part,'')}
+    @detail = @detail.gsub('(','').gsub(')','').lstrip
+    @properties = @detail.split(/;\s+/)
+    
+    # cycle through the properties to set known quantities
+    @properties.each {|property| 
+      if property =~ /^Win/
+        @ostype = 'Windows'
+        @os = property
+        if parts = property.split(/ /,2)
+          if parts[1] =~ /^NT/
+            @ostype = 'Windows'
+            subparts = parts[1].split(/ /,2)
+            if subparts[1] == '5'
+              @os_version = '2000'
+            elsif subparts[1] == '5.1'
+              @os_version = 'XP'
+            else
+              @os_version = subparts[1]
+            end
+          end
+        end
+      end
+      if property == 'Macintosh'
+        @ostype = 'Macintosh'
+        @os = property
+      end
+      if property =~ /OS X/
+        @ostype = 'Macintosh'
+        @os_version = 'OS X'
+        @os = property
+      end
+      if property =~ /^Linux/
+        @ostype = 'Linux'
+        @os = property
+      end
+      if property =~ /^MSIE/
+        @browser = 'MSIE'
+        @browser_version = property.gsub('MSIE ','').lstrip
+        @browser_version_major,@browser_version_minor = @browser_version.split('.')
+      end
+    }
+    self
+  end
+  
+
+  
+end

data/parse_user_agent.gemspec

@@ -0,0 +1,17 @@
+Gem::Specification.new do |s|
+  s.name     = "parse_user_agent"
+  s.version  = "0.1.1"
+  s.date     = "2008-12-20"
+  s.summary  = "UserAgent parser for Ruby."
+  s.email    = "jackson@tekzen.net"
+  s.homepage = "http://github.com/jaxn/parse_user_agent"
+  s.description = ""
+  s.has_rdoc = true
+  s.authors  = ["Jackson Miller"]
+  s.files    = ["README", 
+		"parse_user_agent.gemspec", 
+		"lib/parse_user_agent.rb"]
+  s.test_files = ["test/parse_user_agent_test.rb"] 
+  s.rdoc_options = ["--main", "README"]
+  s.extra_rdoc_files = ["README"]
+end

data/test/parse_user_agent_test.rb

@@ -0,0 +1,93 @@
+require 'test/unit'
+require 'parse_user_agent'
+
+class ParseUserAgentTest < Test::Unit::TestCase
+
+  def setup
+    # setup a list of user agent strings to test
+    @user_agents = Array.new
+    @user_agents[0] = ParseUserAgent.new
+    @user_agents[1] = ParseUserAgent.new
+    @user_agents[2] = ParseUserAgent.new
+    @user_agents[3] = ParseUserAgent.new
+    @user_agents[4] = ParseUserAgent.new
+    @user_agents[5] = ParseUserAgent.new
+    @user_agents[6] = ParseUserAgent.new
+    @user_agents[7] = ParseUserAgent.new
+    
+    @user_agent_strings = Array.new
+    @user_agent_strings[0] = 'Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US; rv:1.8.0.1) Gecko/20060111 Firefox/1.5.0.1'
+    @user_agent_strings[1] = 'Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; SV1; .NET CLR 1.1.4322)'
+    @user_agent_strings[2] = 'Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; SV1)'
+    @user_agent_strings[3] = 'Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US; rv:1.8.0.2) Gecko/20060308 Firefox/1.5.0.2 '
+    @user_agent_strings[4] = 'Mozilla/5.0 (Macintosh; U; PPC Mac OS X Mach-O; en-US; rv:1.8.0.1) Gecko/20060111 Firefox/1.5.0.1'
+    @user_agent_strings[5] = 'Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; SV1; .NET CLR 1.1.4322; .NET CLR 2.0.50727)'
+    @user_agent_strings[6] = 'Mozilla/5.0 (Macintosh; U; PPC Mac OS X; en) AppleWebKit/417.9 (KHTML, like Gecko) Safari/417.9.2'
+    @user_agent_strings[7] = 'Mozilla/5.0 (Macintosh; U; PPC Mac OS X; en) AppleWebKit/417.9 (KHTML, like Gecko) NetNewsWire/2.0.1'
+    # need to add others like older MSIE, Opera / Konqueror, and Linux / *BSD options, and other languages (does IE not include language?)
+
+    @user_agent_strings.each_index { |n| @user_agents[n].parse(@user_agent_strings[n])}
+    
+  end
+
+  # this should throw a better exception
+  def test_invalid
+    assert_raise(RuntimeError) { ParseUserAgent.new.parse('-')}
+    # need to test blank user agent strings as well
+  end
+
+  # test using new to create
+  def test_create
+    @user_agents.each { |user_agent| assert_kind_of ParseUserAgent, user_agent}
+  end
+  
+  # this test sucks because I had to parse during setup
+  def test_parse
+    @user_agent_strings.each_index { |n| @user_agents[n].parse(@user_agent_strings[n])}
+    @user_agents.each { |user_agent| assert_kind_of ParseUserAgent, user_agent}
+  end
+
+  def test_browser
+    assert_equal 'Firefox', @user_agents[0].browser
+    assert_equal 'MSIE', @user_agents[1].browser
+    assert_equal 'MSIE', @user_agents[2].browser
+    assert_equal 'Firefox', @user_agents[3].browser
+    assert_equal 'Firefox', @user_agents[4].browser
+    assert_equal 'MSIE', @user_agents[5].browser
+    assert_equal 'Safari', @user_agents[6].browser
+    assert_equal 'NetNewsWire', @user_agents[7].browser
+    # add additional tests when more test strings are available
+  end
+
+  def test_browser_version_major
+    assert_equal '1.5',@user_agents[0].browser_version_major
+    assert_equal '6',@user_agents[1].browser_version_major
+    assert_equal '6',@user_agents[2].browser_version_major
+    assert_equal '1.5', @user_agents[3].browser_version_major
+    assert_equal '1.5', @user_agents[4].browser_version_major
+    assert_equal '6', @user_agents[5].browser_version_major
+    assert_equal '2', @user_agents[6].browser_version_major
+    assert_equal '2', @user_agents[7].browser_version_major
+  end
+
+  def test_ostype
+    assert_equal 'Windows', @user_agents[0].ostype
+    assert_equal 'Windows', @user_agents[1].ostype
+    assert_equal 'Windows', @user_agents[2].ostype
+    assert_equal 'Windows', @user_agents[3].ostype
+    assert_equal 'Macintosh', @user_agents[4].ostype
+    assert_equal 'Windows', @user_agents[5].ostype
+    assert_equal 'Macintosh', @user_agents[6].ostype
+  end
+
+  def test_os_version
+    assert_equal 'XP', @user_agents[0].os_version
+    assert_equal 'XP', @user_agents[1].os_version
+    assert_equal 'XP', @user_agents[2].os_version
+    assert_equal 'XP', @user_agents[3].os_version
+    assert_equal 'OS X', @user_agents[4].os_version
+    assert_equal 'XP', @user_agents[5].os_version
+    assert_equal 'OS X', @user_agents[6].os_version
+  end
+
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification 
+name: jaxn-parse_user_agent
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- Jackson Miller
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-12-20 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: ""
+email: jackson@tekzen.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- README
+- parse_user_agent.gemspec
+- lib/parse_user_agent.rb
+has_rdoc: true
+homepage: http://github.com/jaxn/parse_user_agent
+post_install_message: 
+rdoc_options: 
+- --main
+- README
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: UserAgent parser for Ruby.
+test_files: 
+- test/parse_user_agent_test.rb