agent_orange 0.0.2 → 0.0.3

data/README.rdoc

@@ -36,13 +36,11 @@ If you're going to use it with Rails then add the gem to your Gemfile.
 === Looking at the device
 
   >> device = ua.device
-  => "iPhone 3G"
+  => "Mobile"
   >> device.type
   => "mobile"
-  >> device.manufacturer
-  => "Apple"
   >> device.name
-  => "iPhone"
+  => "Mobile"
   >> device.version
   => nil
 
@@ -60,6 +58,28 @@ If you're going to use it with Rails then add the gem to your Gemfile.
   >> ua.is_mobile?
   => true
 
+=== Looking at the platform
+
+  >> platform = ua.device.platform
+  => "iPhone"
+  >> platform.type
+  => "iphone"
+  >> platform.name
+  => "iPhone"
+  >> platform.version
+  => "3GS"
+  
+=== Looking at the operating system
+
+  >> os = ua.device.os
+  => "iPhone OS 4.3"
+  >> os.type
+  => "iphone_os"
+  >> os.name
+  => "iPhone OS"
+  >> os.version
+  => "4.3"
+  
 === Looking at the web engine
 
   >> engine = ua.device.engine

data/bin/agent_orange_example

@@ -2,6 +2,21 @@
 
 require "agent_orange/user_agent"
 
+user_agent_strings = [
+  "Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10_5_5; sv-se) AppleWebKit/525.26.2 (KHTML, like Gecko) Version/3.2 Safari/525.26.12",
+  "Mozilla/5.0 (iPhone; U; Linux i686; pt-br) AppleWebKit/532+ (KHTML, like Gecko) Version/3.0 Mobile/1A538b Safari/419.3 Midori/0.2.0",
+  "Mozilla/5.0 (iPhone; U; CPU iPhone OS 4_3_1 like Mac OS X; zh-tw) AppleWebKit/533.17.9 (KHTML, like Gecko) Version/5.0.2 Mobile/8G4 Safari/6533.18.5",
+  "Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10_6_8; de-at) AppleWebKit/533.21.1 (KHTML, like Gecko) Version/5.0.5 Safari/533.21.1",
+  "Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10_5_8; en-us) AppleWebKit/533.21.1 (KHTML, like Gecko) Version/5.0.5 Safari/533.21.1",
+  "Mozilla/5.0 (Windows; U; Windows NT 6.1; tr-TR) AppleWebKit/533.20.25 (KHTML, like Gecko) Version/5.0.4 Safari/533.20.27",
+  "Mozilla/5.0 (compatible; MSIE 10.0; Windows NT 6.1; Trident/6.0)",
+  "Mozilla/5.0 (compatible; MSIE 9.0; Windows NT 6.1; WOW64; Trident/5.0; SLCC2; .NET CLR 2.0.50727; .NET CLR 3.5.30729; .NET CLR 3.0.30729; Media Center PC 6.0; Zune 4.0; InfoPath.3; MS-RTC LM 8; .NET4.0C; .NET4.0E)",
+  "Mozilla/5.0 (Windows NT 6.1; rv:6.0) Gecko/20110814 Firefox/6.0",
+  "Mozilla/5.0 (X11; U; Linux i586; de; rv:5.0) Gecko/20100101 Firefox/5.0",
+  "Opera/9.80 (Windows NT 6.1; U; es-ES) Presto/2.9.181 Version/12.00",
+  "Opera/9.80 (X11; Linux i686; U; ru) Presto/2.8.131 Version/11.11"
+  ]
+
 def process_user_agent(ua_str)
   puts
   puts '='*120
@@ -12,8 +27,6 @@ def process_user_agent(ua_str)
   puts '='*120
 end
 
-ua_str = "Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10_5_5; sv-se) AppleWebKit/525.26.2 (KHTML, like Gecko) Version/3.2 Safari/525.26.12"
-process_user_agent(ua_str)
-
-ua_str = "Mozilla/5.0 (iPhone; U; Linux i686; pt-br) AppleWebKit/532+ (KHTML, like Gecko) Version/3.0 Mobile/1A538b Safari/419.3 Midori/0.2.0"
-process_user_agent(ua_str)
+user_agent_strings.each do |ua_str|
+  process_user_agent(ua_str)
+end

data/lib/agent_orange/browser.rb

@@ -6,6 +6,7 @@ module AgentOrange
     BROWSERS = {
       :ie       => 'MSIE|Internet Explorer|IE',
       :firefox  => 'Firefox',
+      :opera    => 'Opera',
       :safari   => 'Safari'
     }
     
@@ -36,6 +37,8 @@ module AgentOrange
             self.type = "firefox"
           elsif name =~ /(#{BROWSERS[:safari]})/i
             self.type = "safari"
+          elsif name =~ /(#{BROWSERS[:opera]})/i
+            self.type = "opera"
           else
             self.type = "other"
           end

data/lib/agent_orange/device.rb

@@ -1,3 +1,5 @@
+require 'agent_orange/platform'
+require 'agent_orange/operating_system'
 require 'agent_orange/engine'
 
 module AgentOrange
@@ -28,9 +30,9 @@ module AgentOrange
         if comment =~ /(#{DEVICES.collect{|cat,regex| regex}.join(')|(')})/i
           # Found the device
           AgentOrange.debug "  Got a device in group #{i+1}!", 2
-          AgentOrange.debug "  Raw Name   : #{name}", 2
-          AgentOrange.debug "  Raw Version: #{version}", 2
-          AgentOrange.debug "  Raw Comment: #{comment}", 2
+          AgentOrange.debug "  Group Raw Name   : #{name}", 2
+          AgentOrange.debug "  Group Raw Version: #{version}", 2
+          AgentOrange.debug "  Group Raw Comment: #{comment}", 2
           AgentOrange.debug "", 2
                     
           # Determine device type
@@ -45,7 +47,7 @@ module AgentOrange
           end
           
           # Determine device name
-          self.name = comment.split(';')[0]
+          self.name = self.type.capitalize
           
           # Determine device version
           self.version = nil
@@ -60,6 +62,8 @@ module AgentOrange
       AgentOrange.debug "  Version: #{self.version}", 2
       AgentOrange.debug "", 2
       
+      self.platform = AgentOrange::Platform.new(user_agent)
+      self.operating_system = AgentOrange::OperatingSystem.new(user_agent)
       self.engine = AgentOrange::Engine.new(user_agent)
     end
     

data/lib/agent_orange/operating_system.rb

@@ -1,9 +1,88 @@
 module AgentOrange
   class OperatingSystem
-    attr_accessor :name, :version
+    attr_accessor :type, :name, :version
     
+    OPERATING_SYSTEMS = {
+      :android => 'android',
+      :freebsd => 'freebsd',
+      :ios => 'iphone|ipad|ipod',
+      :linux => 'linux',
+      :netbsd => 'netbsd',
+      :osx => 'osx',
+      :windows => 'windows'
+    }
+
+    OPERATING_SYSTEM_NAMES = {
+      :android => 'Android',
+      :freebsd => 'FreeBSD',
+      :ios => 'Apple iOS',
+      :linux => 'Linux',
+      :netbsd => 'NetBSD',
+      :osx => 'Mac OS X',
+      :windows => 'Windows'
+    }
+    
+    def initialize(user_agent)
+      self.parse(user_agent)
+    end
+
+    def parse(user_agent)
+      AgentOrange.debug "OPERATING SYSTEM PARSING", 2
+      groups = user_agent.scan(/([^\/[:space:]]*)(\/([^[:space:]]*))?([[:space:]]*\[[a-zA-Z][a-zA-Z]\])?[[:space:]]*(\((([^()]|(\([^()]*\)))*)\))?[[:space:]]*/i)
+      groups.each_with_index do |pieces,i|
+        name = pieces[0]
+        version = pieces[2]
+        comment = pieces[5]
+
+        if comment =~ /(#{OPERATING_SYSTEMS.collect{|cat,regex| regex}.join(')|(')})/i
+          # Found the operating system
+          AgentOrange.debug "  Got an operating system in group #{i+1}!", 2
+          AgentOrange.debug "  Raw Name   : #{name}", 2
+          AgentOrange.debug "  Raw Version: #{version}", 2
+          AgentOrange.debug "  Raw Comment: #{comment}", 2
+          AgentOrange.debug "", 2
+
+          # Determine operating system type
+          if comment =~ /(#{OPERATING_SYSTEMS[:android]})/i
+            self.type = "android"
+          end
+          if comment =~ /(#{OPERATING_SYSTEMS[:freebsd]})/i
+            self.type = "freebsd"
+          end
+          if comment =~ /(#{OPERATING_SYSTEMS[:ios]})/i
+            self.type = "ios"
+          end
+          if comment =~ /(#{OPERATING_SYSTEMS[:linux]})/i
+            self.type = "linux"
+          end
+          if comment =~ /(#{OPERATING_SYSTEMS[:netbsd]})/i
+            self.type = "netbsd"
+          end
+          if comment =~ /(#{OPERATING_SYSTEMS[:osx]})/i
+            self.type = "osx"
+          end
+          if comment =~ /(#{OPERATING_SYSTEMS[:windows]})/i
+            self.type = "windows"
+          end
+
+          # Determine operating system name
+          self.name = OPERATING_SYSTEM_NAMES[self.type.to_sym]
+
+          # Determine operating system version
+          self.version = nil
+        end
+
+      end
+
+      AgentOrange.debug "OPERATING SYSTEM ANALYSIS", 2
+      AgentOrange.debug "  Type: #{self.type}", 2
+      AgentOrange.debug "  Name: #{self.name}", 2
+      AgentOrange.debug "  Version: #{self.version}", 2
+      AgentOrange.debug "", 2
+    end
+
     def to_s
-      "OS X 10.6"
+      [self.name, self.version].compact.join(' ')
     end
   end
 end

data/lib/agent_orange/platform.rb

@@ -1,9 +1,73 @@
 module AgentOrange
   class Platform
-    attr_accessor :name, :version
+    attr_accessor :type, :name, :version
+
+    PLATFORMS = {
+      :android => 'android',
+      :ios => 'iphone|ipad|ipod',
+      :mac => 'macintosh',
+      :pc => 'freebsd|linux|netbsd|windows|x11'
+    }
+    
+    PLATFORM_NAMES = {
+      :android => 'Android',
+      :ios => 'iOS',
+      :mac => 'Macintosh',
+      :pc => 'PC'
+    }
+    
+    def initialize(user_agent)
+      self.parse(user_agent)
+    end
+    
+    def parse(user_agent)
+      AgentOrange.debug "PLATFORM PARSING", 2
+      groups = user_agent.scan(/([^\/[:space:]]*)(\/([^[:space:]]*))?([[:space:]]*\[[a-zA-Z][a-zA-Z]\])?[[:space:]]*(\((([^()]|(\([^()]*\)))*)\))?[[:space:]]*/i)
+      groups.each_with_index do |pieces,i|
+        name = pieces[0]
+        version = pieces[2]
+        comment = pieces[5]
+        
+        if comment =~ /(#{PLATFORMS.collect{|cat,regex| regex}.join(')|(')})/i
+          # Found the device
+          AgentOrange.debug "  Got a platform in group #{i+1}!", 2
+          AgentOrange.debug "  Raw Name   : #{name}", 2
+          AgentOrange.debug "  Raw Version: #{version}", 2
+          AgentOrange.debug "  Raw Comment: #{comment}", 2
+          AgentOrange.debug "", 2
+                    
+          # Determine platform type
+          if comment =~ /(#{PLATFORMS[:android]})/i
+            self.type = "android"
+          end
+          if comment =~ /(#{PLATFORMS[:ios]})/i
+            self.type = "ios"
+          end
+          if comment =~ /(#{PLATFORMS[:mac]})/i
+            self.type = "mac"
+          end
+          if comment =~ /(#{PLATFORMS[:pc]})/i
+            self.type = "pc"
+          end
+          
+          # Determine platform name
+          self.name = PLATFORM_NAMES[self.type.to_sym]
+          
+          # Determine platform version
+          self.version = nil
+        end
+
+      end
+      
+      AgentOrange.debug "PLATFORM ANALYSIS", 2
+      AgentOrange.debug "  Type: #{self.type}", 2
+      AgentOrange.debug "  Name: #{self.name}", 2
+      AgentOrange.debug "  Version: #{self.version}", 2
+      AgentOrange.debug "", 2
+    end
     
     def to_s
-      "#{name} #{version}"
+      [self.name, self.version].compact.join(' ')
     end
   end
 end

data/lib/agent_orange/user_agent.rb

@@ -2,7 +2,7 @@ require 'agent_orange/device'
 
 module AgentOrange
   DEBUG = true
-  DEBUG_LEVEL = 1
+  DEBUG_LEVEL = 2
   
   class UserAgent
     attr_accessor :user_agent_string
@@ -10,30 +10,23 @@ module AgentOrange
     attr_accessor :device
     
     def initialize(options = {}, &block)
-      @user_agent_string = options[:user_agent].to_s
-      self.parse(@user_agent_string)
+      self.parse(options[:user_agent].to_s)
       
       yield self if block_given?
     end
 
     def parse(user_agent)      
-      self.device = AgentOrange::Device.new(user_agent)
+      self.user_agent_string = user_agent
+      self.device = AgentOrange::Device.new(self.user_agent_string)
 
-      AgentOrange.debug "Device = #{self.device}"
-      AgentOrange.debug "  Is computer? #{self.is_computer?}"
-      AgentOrange.debug "  Is mobile? #{self.is_mobile?}"
-      if self.is_mobile?
-        AgentOrange.debug "    Is an iPhone? #{self.is_mobile? :iphone}"
-        AgentOrange.debug "    Is an iPad? #{self.is_mobile? :ipad}"
-        AgentOrange.debug "    Is an iPod? #{self.is_mobile? :ipod}"
-        AgentOrange.debug "    Is an Android? #{self.is_mobile? :android}"
-      end
-      AgentOrange.debug "  Is bot? #{self.is_bot?}"
-      AgentOrange.debug
-      
-      AgentOrange.debug "Engine = #{self.device.engine}"
-      AgentOrange.debug "Browser = #{self.device.engine.browser}"
+      AgentOrange.debug "Device   = #{self.device}"
+      AgentOrange.debug "Platform = #{self.device.platform}"
+      AgentOrange.debug "OS       = #{self.device.operating_system}"
+      AgentOrange.debug "Engine   = #{self.device.engine}"
+      AgentOrange.debug "Browser  = #{self.device.engine.browser}"
 
+      self.summary
+      
       AgentOrange.debug "", 2
       AgentOrange.debug "user_agent.to_s = #{self}", 2
     end
@@ -51,7 +44,7 @@ module AgentOrange
     end
 
     def to_s
-      [self.device, self.device.engine, self.device.engine.browser].compact.join(", ")
+      [self.device, self.device.platform, self.device.operating_system, self.device.engine, self.device.engine.browser].compact.join(", ")
     end
     
     def to_human_string
@@ -62,6 +55,20 @@ module AgentOrange
       end
     end
 
+    def summary
+      AgentOrange.debug
+      AgentOrange.debug "SUMMARY"
+      AgentOrange.debug "  Is computer? #{self.is_computer?}"
+      AgentOrange.debug "  Is mobile? #{self.is_mobile?}"
+      if self.is_mobile?
+        AgentOrange.debug "    Is an iPhone? #{self.is_mobile? :iphone}"
+        AgentOrange.debug "    Is an iPad? #{self.is_mobile? :ipad}"
+        AgentOrange.debug "    Is an iPod? #{self.is_mobile? :ipod}"
+        AgentOrange.debug "    Is an Android? #{self.is_mobile? :android}"
+      end
+      AgentOrange.debug "  Is bot? #{self.is_bot?}"
+      AgentOrange.debug
+    end
   end
   
   def self.debug(str="", level=1)

data/lib/agent_orange/version.rb

@@ -1,5 +1,5 @@
 module AgentOrange
-  VERSION = "0.0.2" # This is for the gem and does not conflict with the rest of the functionality
+  VERSION = "0.0.3" # This is for the gem and does not conflict with the rest of the functionality
   
   class Version
     attr_accessor :major, :minor, :patch_level, :build_number

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: agent_orange
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Kevin Elliott