agent_orange 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in agent_orange.gemspec
+gemspec

data/README.rdoc

@@ -0,0 +1,153 @@
+= agent_orange
+
+User Agent detection for Ruby. ActionController integration coming soon.
+
+== About
+
+There are quite a few User Agent parsing libraries already, but none of them make adequate
+detection of mobile browsers and clients. With such a significant number of requests
+coming from mobile users a library with the ability to detect what type of device a user
+is coming from is necessary.
+
+This library for Ruby will allow you to detect whether a user is on a computer, a mobile
+device, or is a bot (such as Google). It was composed by using techniques gathered from
+several other libraries/gems in an effort to be consistent and cover as many types
+of agents as possible.
+
+== Status
+
+=== Improvement stage.
+
+This library is not yet testable but does function. Please contact me if you'd like
+to participate.
+
+== Installation
+
+  gem install agent_orange
+
+If you're going to use it with Rails then add the gem to your Gemfile.
+
+== Example Usage
+
+=== Create new user agent parser
+
+  >> ua = AgentOrange::UserAgent.new(user_agent_string)
+
+=== Looking at the device
+
+  >> device = ua.device
+  => "iPhone 3G"
+  >> device.type
+  => "mobile"
+  >> device.manufacturer
+  => "Apple"
+  >> device.name
+  => "iPhone"
+  >> device.version
+  => nil
+
+=== Check to see if the device is mobile, a desktop/laptop/server computer, or a bot
+
+  >> device.is_mobile?
+  => true
+  >> device.is_computer?
+  => false
+  >> device.is_bot?
+  => false
+
+=== Use the proxies to check if the user is on a mobile device
+
+  >> ua.is_mobile?
+  => true
+
+=== Looking at the web engine
+
+  >> engine = ua.device.engine
+  => "WebKit 5.3"
+  >> engine.type
+  => "webkit"
+  >> engine.name
+  => "WebKit"
+  >> engine.version
+  => "5.3.1.2321"
+
+=== Looking at the browser
+
+  >> browser = ua.device.engine.browser
+  => "Internet Explorer 10"
+  >> browser.type
+  => "ie"
+  >> browser.name
+  => "Internet Explorer"
+  >> browser.version
+  => "10.0.112"
+
+=== Quickly get to the browser version
+
+  >> AgentOrange::UserAgent.new(user_agent_string).device.engine.browser.version
+  => "10.0.112"
+
+== General Class Definition
+
+This is not up to date or a reflection of the actual class structure. This will be updated eventually.
+
+AgentOrange::UserAgent
+  device
+  parse
+  is_computer?   # proxy
+  is_mobile?     # proxy
+  is_bot?        # proxy
+  to_s
+  
+AgentOrange::Device
+  parse
+  type
+  name
+  version
+  is_computer?(name=nil) # 
+  is_mobile?(name=nil)   # accepts a :symbol or "String"
+  is_bot?(name=nil)      #
+  to_s
+  
+AgentOrange::Engine
+  parse
+  type
+  name
+  version
+  to_s
+  
+AgentOrange::Version
+  parse
+  major
+  minor
+  patch_level
+  build_number
+  to_s
+  
+== Maintainer
+
+* Kevin Elliott - http://kevinelliott.net
+* WeLike - http://www.welikeinc.com - http://github.com/welike
+
+== License
+
+(The MIT License)
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/agent_orange.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "agent_orange/version"
+
+Gem::Specification.new do |s|
+  s.name        = "agent_orange"
+  s.version     = AgentOrange::VERSION
+  s.authors     = ["Kevin Elliott"]
+  s.email       = ["kevin@welikeinc.com"]
+  s.homepage    = "http://github.com/kevinelliott/agent_orange"
+  s.summary     = %q{Parse and process User Agents like a secret one}
+  s.description = %q{Parse and process User Agents like a secret one}
+
+  s.rubyforge_project = "agent_orange"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/bin/agent_orange_example

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+
+require "agent_orange/user_agent"
+
+def process_user_agent(ua_str)
+  puts
+  puts '='*120
+  puts "User-Agent:"
+  puts "  #{ua_str}"
+  puts
+  ua = AgentOrange::UserAgent.new(: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)

data/lib/agent_orange/browser.rb

@@ -0,0 +1,64 @@
+module AgentOrange
+  class Browser
+    attr_accessor :type, :name, :version
+    attr_accessor :security
+    
+    BROWSERS = {
+      :ie       => 'MSIE|Internet Explorer|IE',
+      :firefox  => 'Firefox',
+      :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"
+          else
+            self.type = "other"
+          end
+          
+          # Determine browser name
+          self.name = name
+          
+          # Determine device version
+          self.version = version
+          
+        end
+
+      end
+      
+      AgentOrange.debug "BROWSER 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
+      [self.name, self.version].compact.join(' ')
+    end
+  end
+end

data/lib/agent_orange/device.rb

@@ -0,0 +1,109 @@
+require 'agent_orange/engine'
+
+module AgentOrange
+  class Device
+    attr_accessor :type, :name, :version
+    attr_accessor :platform
+    attr_accessor :operating_system
+    attr_accessor :engine
+    
+    DEVICES = {
+      :computer => 'windows|macintosh|x11|linux',
+      :mobile => 'ipod|ipad|iphone|palm|android|opera mini|hiptop|windows ce|smartphone|mobile|treo|psp',
+      :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 "  Raw Name   : #{name}", 2
+          AgentOrange.debug "  Raw Version: #{version}", 2
+          AgentOrange.debug "  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 = comment.split(';')[0]
+          
+          # Determine device version
+          self.version = nil
+          
+        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.engine = AgentOrange::Engine.new(user_agent)
+    end
+    
+    def is_computer?(name=nil)
+      if name
+        case name
+        when String
+          return self.name.downcase.include?(name.downcase)
+        when Symbol
+          return self.name.downcase.include?(name.to_s.downcase)
+        end
+      else
+        (self.type == "computer")
+      end
+    end
+    
+    def is_mobile?(name=nil)
+      if name
+        case name
+        when String
+          return self.name.downcase.include?(name.downcase)
+        when Symbol
+          return self.name.downcase.include?(name.to_s.downcase)
+        end
+      else
+        self.type == "mobile"
+      end
+    end
+    
+    def is_bot?(name=nil)
+      if name
+        case name
+        when String
+          return self.name.downcase.include?(name.downcase)
+        when Symbol
+          return self.name.downcase.include?(name.to_s.downcase)
+        end
+      else
+        self.type == "bot"
+      end
+    end
+    
+    def to_s
+      [self.name, self.version].compact.join(' ')
+    end
+  end
+end

data/lib/agent_orange/engine.rb

@@ -0,0 +1,68 @@
+require 'agent_orange/browser'
+
+module AgentOrange
+  class Engine
+    attr_accessor :type, :name, :version
+    attr_accessor :browser
+    
+    ENGINES = {
+      :gecko  => 'Gecko',
+      :presto => 'Presto',
+      :webkit => 'AppleWebKit'
+    }
+    
+    def initialize(user_agent)
+      self.parse(user_agent)
+    end
+    
+    def parse(user_agent)
+      AgentOrange.debug "ENGINE 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 =~ /(#{ENGINES.collect{|cat,regex| regex}.join(')|(')})/i
+          # Found the engine
+          AgentOrange.debug "  Got an engine 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 engine type
+          if name =~ /(#{ENGINES[:gecko]})/i
+            self.type = "gecko"
+          end
+          if name =~ /(#{ENGINES[:presto]})/i
+            self.type = "presto"
+          end
+          if name =~ /(#{ENGINES[:webkit]})/i
+            self.type = "webkit"
+          end
+          
+          # Determine engine name
+          self.name = name
+          
+          # Determine device version
+          self.version = version
+          
+        end
+
+      end
+      
+      AgentOrange.debug "ENGINE ANALYSIS", 2
+      AgentOrange.debug "  Type: #{self.type}", 2
+      AgentOrange.debug "  Name: #{self.name}", 2
+      AgentOrange.debug "  Version: #{self.version}", 2
+      AgentOrange.debug "", 2
+      
+      self.browser = AgentOrange::Browser.new(user_agent)
+    end
+    
+    def to_s
+      [self.name, self.version].compact.join(' ')
+    end
+  end
+end

data/lib/agent_orange/operating_system.rb

@@ -0,0 +1,9 @@
+module AgentOrange
+  class OperatingSystem
+    attr_accessor :name, :version
+    
+    def to_s
+      "OS X 10.6"
+    end
+  end
+end

data/lib/agent_orange/platform.rb

@@ -0,0 +1,9 @@
+module AgentOrange
+  class Platform
+    attr_accessor :name, :version
+    
+    def to_s
+      "#{name} #{version}"
+    end
+  end
+end

data/lib/agent_orange/user_agent.rb

@@ -0,0 +1,71 @@
+require 'agent_orange/device'
+
+module AgentOrange
+  DEBUG = true
+  DEBUG_LEVEL = 1
+  
+  class UserAgent
+    attr_accessor :user_agent_string
+    attr_accessor :user_language
+    attr_accessor :device
+    
+    def initialize(options = {}, &block)
+      @user_agent_string = options[:user_agent].to_s
+      self.parse(@user_agent_string)
+      
+      yield self if block_given?
+    end
+
+    def parse(user_agent)      
+      self.device = AgentOrange::Device.new(user_agent)
+
+      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 "", 2
+      AgentOrange.debug "user_agent.to_s = #{self}", 2
+    end
+    
+    def is_computer?(type=nil)
+      self.device.is_computer?(type)
+    end
+
+    def is_mobile?(type=nil)
+      self.device.is_mobile?(type)
+    end
+
+    def is_bot?(type=nil)
+      self.device.is_bot?(type)
+    end
+
+    def to_s
+      [self.device, self.device.engine, self.device.engine.browser].compact.join(", ")
+    end
+    
+    def to_human_string
+      if self.device && self.device.engine && self.device.engine.browser
+        "User has a #{self.device} running #{self.device.engine.browser} (which is based on #{self.device.engine})."
+      else
+        "User has some kind of device that I've never seen."
+      end
+    end
+
+  end
+  
+  def self.debug(str="", level=1)
+    puts str if DEBUG && (DEBUG_LEVEL >= level)
+  end
+  
+end

data/lib/agent_orange/version.rb

@@ -0,0 +1,11 @@
+module AgentOrange
+  VERSION = "0.0.1" # 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 to_s
+      "#{self.major}.#{self.minor}"
+    end
+  end
+end

data/lib/agent_orange.rb

@@ -0,0 +1,8 @@
+require 'agent_orange/version'
+require 'agent_orange/user_agent'
+require 'agent_orange/device'
+require 'agent_orange/engine'
+require 'agent_orange/browser'
+
+module AgentOrange
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: agent_orange
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Kevin Elliott
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-09-11 00:00:00 Z
+dependencies: []
+
+description: Parse and process User Agents like a secret one
+email: 
+- kevin@welikeinc.com
+executables: 
+- agent_orange_example
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.rdoc
+- Rakefile
+- agent_orange.gemspec
+- bin/agent_orange_example
+- lib/agent_orange.rb
+- lib/agent_orange/browser.rb
+- lib/agent_orange/device.rb
+- lib/agent_orange/engine.rb
+- lib/agent_orange/operating_system.rb
+- lib/agent_orange/platform.rb
+- lib/agent_orange/user_agent.rb
+- lib/agent_orange/version.rb
+homepage: http://github.com/kevinelliott/agent_orange
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: agent_orange
+rubygems_version: 1.8.5
+signing_key: 
+specification_version: 3
+summary: Parse and process User Agents like a secret one
+test_files: []
+