agent_orange 0.0.6 → 0.0.7

data/bin/agent_orange_example

@@ -29,6 +29,9 @@ def process_user_agent(ua_str)
   puts '='*120
 end
 
+AgentOrange::DEBUG = true
+AgentOrange::DEBUG_LEVEL = 2
+
 user_agent_strings.each do |ua_str|
   process_user_agent(ua_str)
 end

data/lib/agent_orange/base.rb

@@ -0,0 +1,58 @@
+module AgentOrange
+  class Base
+    
+    def initialize(user_agent)
+      self.parse(user_agent)
+    end
+    
+    def parse_user_agent_string_into_groups(user_agent)
+      results = user_agent.scan(/([^\/[:space:]]*)(\/([^[:space:]]*))?([[:space:]]*\[[a-zA-Z][a-zA-Z]\])?[[:space:]]*(\((([^()]|(\([^()]*\)))*)\))?[[:space:]]*/i)
+      groups = []
+      results.each do |result|
+        if result[0] != "" # Add the group of content if name isn't blank
+          groups << { :name => result[0], :version => result[2], :comment => result[5] }
+        end
+      end
+      groups
+    end
+    
+    def parse_comment(comment)
+      groups = []
+      comment.split('; ').each do |piece|
+        content = { :name => nil, :version => nil }
+        
+        # Remove 'like Mac OS X' or similar since it distracts from real results
+        piece = piece.scan(/(.+) like .+$/i)[0][0] if piece =~ /(.+) like (.+)$/i
+        
+        if piece =~ /(.+)[ \/]([\w.]+)$/i
+          chopped = piece.scan(/(.+)[ \/]([\w.]+)$/i)[0]
+          groups << { :name => chopped[0], :version => chopped[1] }
+        end
+      end
+      groups
+    end
+
+    def determine_type(types={}, content="")
+      # Determine type
+      type = nil
+      types.each do |key, value|
+        type = key if content =~ /(#{value})/i
+      end
+      type = "other" if type.nil?
+      type
+    end
+    
+    def debug_raw_content(content)
+      AgentOrange.debug "  Raw Name   : #{content[:name]}", 2
+      AgentOrange.debug "  Raw Version: #{content[:version]}", 2
+      AgentOrange.debug "  Raw Comment: #{content[:comment]}", 2
+    end
+    
+    def debug_content(content)
+      AgentOrange.debug "  Type: #{self.type}", 2
+      AgentOrange.debug "  Name: #{self.name}", 2
+      AgentOrange.debug "  Version: #{self.version}", 2
+    end
+    
+  end
+end

data/lib/agent_orange/browser.rb

@@ -1,7 +1,8 @@
+require 'agent_orange/base'
 require 'agent_orange/version'
 
 module AgentOrange
-  class Browser
+  class Browser < Base
     attr_accessor :type, :name, :version
     attr_accessor :security
     
@@ -12,53 +13,44 @@ module AgentOrange
       :safari   => 'Safari'
     }
     
-    def initialize(user_agent)
-      self.parse(user_agent)
-    end
-    
     def parse(user_agent)
       AgentOrange.debug "BROWSER 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 name =~ /(#{BROWSERS.collect{|cat,regex| regex}.join(')|(')})/i
-          # Found the browser          
-          AgentOrange.debug "  Got a browser 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 browser type
-          if name =~ /(#{BROWSERS[:ie]})/i
-            self.type = "ie"
-          elsif name =~ /(#{BROWSERS[:firefox]})/i
-            self.type = "firefox"
-          elsif name =~ /(#{BROWSERS[:safari]})/i
-            self.type = "safari"
-          elsif name =~ /(#{BROWSERS[:opera]})/i
-            self.type = "opera"
-          else
-            self.type = "other"
+      
+      groups = parse_user_agent_string_into_groups(user_agent)
+      groups.each_with_index do |content,i|
+        if content[:name] =~ /(#{BROWSERS.collect{|cat,regex| regex}.join(')|(')})/i
+          # Matched group against name
+          self.populate(content)
+        elsif content[:comment] =~ /(#{BROWSERS.collect{|cat,regex| regex}.join(')|(')})/i
+          # Matched group against comment
+          chosen_content = { :name => nil, :version => nil }
+          additional_groups = parse_comment(content[:comment])
+          additional_groups.each do |additional_content|
+            if additional_content[:name] =~ /(#{BROWSERS.collect{|cat,regex| regex}.join(')|(')})/i
+              chosen_content = additional_content
+            end
           end
-          
-          # Determine browser name
-          self.name = name
-          
-          # Determine device version
-          self.version = AgentOrange::Version.new(version)
-          
+            
+          self.populate(chosen_content)
         end
-
       end
       
+      self.analysis
+    end
+    
+    def populate(content={})
+      self.debug_raw_content(content)
+      AgentOrange.debug "", 2
+      
+      self.type = self.determine_type(BROWSERS, content[:name])
+      self.name = content[:name]
+      self.version = AgentOrange::Version.new(content[:version])
+      self
+    end
+    
+    def analysis
       AgentOrange.debug "BROWSER ANALYSIS", 2
-      AgentOrange.debug "  Type: #{self.type}", 2
-      AgentOrange.debug "  Name: #{self.name}", 2
-      AgentOrange.debug "  Version: #{self.version}", 2
+      self.debug_content(:type => self.type, :name => self.name, :version => self.version)
       AgentOrange.debug "", 2
     end
     

data/lib/agent_orange/device.rb

@@ -1,10 +1,11 @@
+require 'agent_orange/base'
 require 'agent_orange/platform'
 require 'agent_orange/operating_system'
 require 'agent_orange/engine'
 require 'agent_orange/version'
 
 module AgentOrange
-  class Device
+  class Device < Base
     attr_accessor :type, :name, :version
     attr_accessor :platform
     attr_accessor :operating_system
@@ -16,58 +17,40 @@ module AgentOrange
       :bot => 'bot'
     }
     
-    def initialize(user_agent)
-      self.parse(user_agent)
-    end
-    
     def parse(user_agent)
       AgentOrange.debug "DEVICE 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 =~ /(#{DEVICES.collect{|cat,regex| regex}.join(')|(')})/i
-          # Found the device
-          AgentOrange.debug "  Got a device in group #{i+1}!", 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
-          if comment =~ /(#{DEVICES[:computer]})/i
-            self.type = "computer"
-          end
-          if comment =~ /(#{DEVICES[:mobile]})/i
-            self.type = "mobile"
-          end
-          if comment =~ /(#{DEVICES[:bot]})/i
-            self.type = "bot"
-          end
-          
-          # Determine device name
-          self.name = self.type.capitalize
-          
-          # Determine device version
-          self.version = nil
-          
+      
+      groups = parse_user_agent_string_into_groups(user_agent)
+      groups.each_with_index do |content,i|
+        if content[:comment] =~ /(#{DEVICES.collect{|cat,regex| regex}.join(')|(')})/i
+          # Matched group against name
+          self.populate(content)
         end
-
       end
       
-      AgentOrange.debug "DEVICE ANALYSIS", 2
-      AgentOrange.debug "  Type: #{self.type}", 2
-      AgentOrange.debug "  Name: #{self.name}", 2
-      AgentOrange.debug "  Version: #{self.version}", 2
-      AgentOrange.debug "", 2
+      self.analysis
       
       self.platform = AgentOrange::Platform.new(user_agent)
       self.operating_system = AgentOrange::OperatingSystem.new(user_agent)
       self.engine = AgentOrange::Engine.new(user_agent)
     end
     
+    def populate(content={})
+      self.debug_raw_content(content)
+      AgentOrange.debug "", 2
+      
+      self.type = self.determine_type(DEVICES, content[:comment])
+      self.name = self.type.to_s.capitalize
+      self.version = nil
+      self
+    end
+    
+    def analysis
+      AgentOrange.debug "DEVICE ANALYSIS", 2
+      self.debug_content(:type => self.type, :name => self.name, :version => self.version)
+      AgentOrange.debug "", 2
+    end
+    
     def is_computer?(name=nil)
       if name
         case name

data/lib/agent_orange/engine.rb

@@ -1,9 +1,10 @@
+require 'agent_orange/base'
 require 'agent_orange/browser'
 require 'agent_orange/version'
 require 'pp'
 
 module AgentOrange
-  class Engine
+  class Engine < Base
     attr_accessor :type, :name, :version
     attr_accessor :browser
     
@@ -15,14 +16,10 @@ module AgentOrange
       :other => 'Other'
     }
     
-    def initialize(user_agent)
-      self.parse(user_agent)
-    end
-    
     def parse(user_agent)
       AgentOrange.debug "ENGINE PARSING", 2
-      results = user_agent.scan(/([^\/[:space:]]*)(\/([^[:space:]]*))?([[:space:]]*\[[a-zA-Z][a-zA-Z]\])?[[:space:]]*(\((([^()]|(\([^()]*\)))*)\))?[[:space:]]*/i)
-      groups = scan_results_into_groups(results)
+      
+      groups = parse_user_agent_string_into_groups(user_agent)
       groups.each_with_index do |content,i|
         if content[:name] =~ /(#{ENGINES.collect{|cat,regex| regex}.join(')|(')})/i
           # Matched group against name
@@ -45,45 +42,11 @@ module AgentOrange
       self.browser = AgentOrange::Browser.new(user_agent)
     end
     
-    def scan_results_into_groups(results)
-      groups = []
-      results.each do |result|
-        if result[0] != "" # Add the group of content if name isn't blank
-          groups << { :name => result[0], :version => result[2], :comment => result[5] }
-        end
-      end
-      groups
-    end
-    
-    def parse_comment(comment)
-      groups = []
-      comment.split('; ').each do |piece|
-        content = { :name => nil, :version => nil }
-        if piece =~ /(.+)[ \/]([\w.]+)$/i
-          chopped = piece.scan(/(.+)[ \/]([\w.]+)$/i)[0]
-          groups << { :name => chopped[0], :version => chopped[1] }
-        end
-      end
-      groups
-    end
-    
-    def determine_type(content="")
-      # Determine type
-      type = nil
-      ENGINES.each do |key, value|
-        type = key if content =~ /(#{value})/i
-      end
-      type = "other" if type.nil?
-      type
-    end
-    
     def populate(content={})
-      AgentOrange.debug "  Raw Name   : #{content[:name]}", 2
-      AgentOrange.debug "  Raw Version: #{content[:version]}", 2
-      AgentOrange.debug "  Raw Comment: #{content[:comment]}", 2
+      self.debug_raw_content(content)
       AgentOrange.debug "", 2
-                
-      self.type = self.determine_type(content[:name])
+      
+      self.type = self.determine_type(ENGINES, content[:name])
       self.name = ENGINES[self.type.to_sym]
       self.version = AgentOrange::Version.new(content[:version])
       self
@@ -91,9 +54,7 @@ module AgentOrange
     
     def analysis
       AgentOrange.debug "ENGINE ANALYSIS", 2
-      AgentOrange.debug "  Type: #{self.type}", 2
-      AgentOrange.debug "  Name: #{self.name}", 2
-      AgentOrange.debug "  Version: #{self.version}", 2
+      self.debug_content(:type => self.type, :name => self.name, :version => self.version)
       AgentOrange.debug "", 2
     end
     

data/lib/agent_orange/operating_system.rb

@@ -1,5 +1,7 @@
+require 'agent_orange/base'
+
 module AgentOrange
-  class OperatingSystem
+  class OperatingSystem < Base
     attr_accessor :type, :name, :version
     
     OPERATING_SYSTEMS = {
@@ -21,66 +23,45 @@ module AgentOrange
       :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"
+      
+      groups = parse_user_agent_string_into_groups(user_agent)
+      groups.each_with_index do |content,i|
+        if content[:comment] =~ /(#{OPERATING_SYSTEMS.collect{|cat,regex| regex}.join(')|(')})/i
+          # Matched group against comment
+          chosen_content = { :name => nil, :version => nil }
+          additional_groups = parse_comment(content[:comment])
+          additional_groups.each do |additional_content|
+            if additional_content[:name] =~ /(#{OPERATING_SYSTEMS.collect{|cat,regex| regex}.join(')|(')})/i
+              chosen_content = additional_content
+            end
           end
-
-          # Determine operating system name
-          self.name = OPERATING_SYSTEM_NAMES[self.type.to_sym]
-
-          # Determine operating system version
-          self.version = nil
+            
+          self.populate(chosen_content)
         end
-
       end
-
+      
+      self.analysis
+    end
+    
+    def populate(content={})
+      self.debug_raw_content(content)
+      AgentOrange.debug "", 2
+      
+      self.type = self.determine_type(OPERATING_SYSTEMS, content[:name])
+      self.name = OPERATING_SYSTEM_NAMES[self.type.to_sym]
+      self.version = AgentOrange::Version.new(content[:version])
+      self
+    end
+    
+    def analysis
       AgentOrange.debug "OPERATING SYSTEM ANALYSIS", 2
-      AgentOrange.debug "  Type: #{self.type}", 2
-      AgentOrange.debug "  Name: #{self.name}", 2
-      AgentOrange.debug "  Version: #{self.version}", 2
+      self.debug_content(:type => self.type, :name => self.name, :version => self.version)
       AgentOrange.debug "", 2
     end
-
+    
     def to_s
       [self.name, self.version].compact.join(' ')
     end

data/lib/agent_orange/platform.rb

@@ -1,5 +1,7 @@
+require 'agent_orange/base'
+
 module AgentOrange
-  class Platform
+  class Platform < Base
     attr_accessor :type, :name, :version
 
     PLATFORMS = {
@@ -16,11 +18,7 @@ module AgentOrange
       :pc => 'PC'
     }
     
-    def initialize(user_agent)
-      self.parse(user_agent)
-    end
-    
-    def parse(user_agent)
+    def old_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|
@@ -66,6 +64,36 @@ module AgentOrange
       AgentOrange.debug "", 2
     end
     
+    def parse(user_agent)
+      AgentOrange.debug "PLATFORM PARSING", 2
+      
+      groups = parse_user_agent_string_into_groups(user_agent)
+      groups.each_with_index do |content,i|
+        if content[:comment] =~ /(#{PLATFORMS.collect{|cat,regex| regex}.join(')|(')})/i
+          # Matched group against name
+          self.populate(content)
+        end
+      end
+      
+      self.analysis
+    end
+    
+    def populate(content={})
+      self.debug_raw_content(content)
+      AgentOrange.debug "", 2
+      
+      self.type = self.determine_type(PLATFORMS, content[:comment])
+      self.name = PLATFORM_NAMES[self.type.to_sym]
+      self.version = nil
+      self
+    end
+    
+    def analysis
+      AgentOrange.debug "PLATFORM ANALYSIS", 2
+      self.debug_content(:type => self.type, :name => self.name, :version => self.version)
+      AgentOrange.debug "", 2
+    end
+    
     def to_s
       [self.name, self.version].compact.join(' ')
     end

data/lib/agent_orange/version.rb

@@ -1,10 +1,11 @@
 module AgentOrange
-  VERSION = "0.0.6" # This is for the gem and does not conflict with the rest of the functionality
+  VERSION = "0.0.7" # 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
 
     def initialize(version_string)
+      version_string = sanitize_version_string(version_string)
       self.major = nil
       self.minor = nil
       self.patch_level = nil
@@ -22,5 +23,11 @@ module AgentOrange
     def to_s
       [self.major, self.minor, self.patch_level, self.build_number].compact.join('.')
     end
+    
+    private
+    
+    def sanitize_version_string(version_string)
+      version_string.gsub('_','.')
+    end
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: agent_orange
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: 
   segments: 
   - 0
   - 0
-  - 6
-  version: 0.0.6
+  - 7
+  version: 0.0.7
 platform: ruby
 authors: 
 - Kevin Elliott
@@ -35,6 +35,7 @@ files:
 - agent_orange.gemspec
 - bin/agent_orange_example
 - lib/agent_orange.rb
+- lib/agent_orange/base.rb
 - lib/agent_orange/browser.rb
 - lib/agent_orange/device.rb
 - lib/agent_orange/engine.rb