useragent 0.0.4

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Joshua Peek
+
+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/README

@@ -0,0 +1,27 @@
+UserAgent
+=========
+
+UserAgent is a Ruby library that parses and compares HTTP User Agents.
+
+
+Install
+=======
+
+sudo gem install useragent --source http://gemcutter.org
+
+
+Example
+=======
+
+  Browser = Struct.new(:browser, :version)
+  SupportedBrowsers = [
+    Browser.new("Safari", "3.1.1"),
+    Browser.new("Firefox", "2.0.0.14"),
+    Browser.new("Internet Explorer", "7.0")
+  ]
+
+  user_agent = UserAgent.parse(request.user_agent)
+  SupportedBrowsers.detect { |browser| user_agent >= browser }
+
+
+Copyright (c) 2008 Joshua Peek, released under the MIT license

data/lib/user_agent.rb

@@ -0,0 +1,81 @@
+require 'user_agent/comparable'
+require 'user_agent/browsers'
+require 'user_agent/operating_systems'
+
+class UserAgent
+  # http://www.texsoft.it/index.php?m=sw.php.useragent
+  MATCHER = %r{
+    ^([^/\s]+)        # Product
+    /?([^\s]*)        # Version
+    (\s\(([^\)]*)\))? # Comment
+  }x.freeze unless defined? MATCHER
+
+  def self.parse(string)
+    agents = []
+    while m = string.match(MATCHER)
+      agent = new(m[1], m[2], m[4])
+      agents << agent
+      string = string.sub(m[0], '').strip
+    end
+    Browsers.extend(agents)
+    agents
+  end
+
+  attr_reader :product, :version, :comment
+
+  def initialize(product, version = nil, comment = nil)
+    if product
+      @product = product
+    else
+      raise ArgumentError, "expected a value for product"
+    end
+
+    if version && !version.empty?
+      @version = version
+    end
+
+    if comment.respond_to?(:split)
+      @comment = comment.split("; ")
+    else
+      @comment = comment
+    end
+  end
+
+  include Comparable
+
+  # Any comparsion between two user agents with different products will
+  # always return false.
+  def <=>(other)
+    if @product == other.product
+      if @version && other.version
+        @version <=> other.version
+      else
+        0
+      end
+    else
+      false
+    end
+  end
+
+  def eql?(other)
+    @product == other.product &&
+      @version == other.version &&
+      @comment == other.comment
+  end
+
+  def to_s
+    to_str
+  end
+
+  def to_str
+    if @product && @version && @comment
+      "#{@product}/#{@version} (#{@comment.join("; ")})"
+    elsif @product && @version
+      "#{@product}/#{@version}"
+    elsif @product && @comment
+      "#{@product} (#{@comment.join("; ")})"
+    else
+      @product
+    end
+  end
+end

data/lib/user_agent/browsers.rb

@@ -0,0 +1,26 @@
+require 'user_agent/browsers/all'
+require 'user_agent/browsers/gecko'
+require 'user_agent/browsers/internet_explorer'
+require 'user_agent/browsers/opera'
+require 'user_agent/browsers/webkit'
+
+class UserAgent
+  module Browsers
+    Security = {
+      "N" => :none,
+      "U" => :strong,
+      "I" => :weak
+    }.freeze unless defined? Security
+
+    def self.all
+      [InternetExplorer, Webkit, Opera, Gecko]
+    end
+
+    def self.extend(array)
+      array.extend(All)
+      all.each do |extension|
+        return array.extend(extension) if extension.extend?(array)
+      end
+    end
+  end
+end

data/lib/user_agent/browsers/all.rb

@@ -0,0 +1,53 @@
+class UserAgent
+  module Browsers
+    module All
+      include Comparable
+
+      def <=>(other)
+        if respond_to?(:browser) && other.respond_to?(:browser) &&
+            browser == other.browser
+          version <=> other.version
+        else
+          false
+        end
+      end
+
+      def eql?(other)
+        self == other
+      end
+
+      def to_s
+        to_str
+      end
+
+      def to_str
+        join(" ")
+      end
+
+      def application
+        first
+      end
+
+      def browser
+        application.product
+      end
+
+      def version
+        application.version
+      end
+
+      def respond_to?(symbol)
+        detect_product(symbol) ? true : super
+      end
+
+      def method_missing(method, *args, &block)
+        detect_product(method) || super
+      end
+
+      private
+        def detect_product(product)
+          detect { |useragent| useragent.product.to_s.downcase == product.to_s.downcase }
+        end
+    end
+  end
+end

data/lib/user_agent/browsers/gecko.rb

@@ -0,0 +1,38 @@
+class UserAgent
+  module Browsers
+    module Gecko
+      def self.extend?(agent)
+        agent.application && agent.application.product == "Mozilla"
+      end
+
+      GeckoBrowsers = %w(
+        Firefox
+        Camino
+      ).freeze unless defined? GeckoBrowsers
+
+      def browser
+        GeckoBrowsers.detect { |browser| respond_to?(browser) } || super
+      end
+
+      def version
+        send(browser).version || super
+      end
+
+      def platform
+        application.comment[0]
+      end
+
+      def security
+        Security[application.comment[1]]
+      end
+
+      def os
+        OperatingSystems.normalize_os(application.comment[2])
+      end
+
+      def localization
+        application.comment[3]
+      end
+    end
+  end
+end

data/lib/user_agent/browsers/internet_explorer.rb

@@ -0,0 +1,35 @@
+class UserAgent
+  module Browsers
+    module InternetExplorer
+      def self.extend?(agent)
+        agent.application &&
+          agent.application.comment &&
+          agent.application.comment[0] == "compatible"
+      end
+
+      def browser
+        "Internet Explorer"
+      end
+
+      def version
+        application.comment[1].to_s.sub("MSIE ", "")
+      end
+
+      def compatibility
+        application.comment[0]
+      end
+
+      def compatible?
+        compatibility == "compatible"
+      end
+
+      def platform
+        "Windows"
+      end
+
+      def os
+        OperatingSystems.normalize_os(application.comment[2])
+      end
+    end
+  end
+end

data/lib/user_agent/browsers/opera.rb

@@ -0,0 +1,41 @@
+class UserAgent
+  module Browsers
+    module Opera
+      def self.extend?(agent)
+        agent.application && agent.application.product == "Opera"
+      end
+
+      def platform
+        if application.comment[0] =~ /Windows/
+          "Windows"
+        else
+          application.comment[0]
+        end
+      end
+
+      def security
+        if platform == "Macintosh"
+          Security[application.comment[2]]
+        else
+          Security[application.comment[1]]
+        end
+      end
+
+      def os
+        if application.comment[0] =~ /Windows/
+          OperatingSystems.normalize_os(application.comment[0])
+        else
+          application.comment[1]
+        end
+      end
+
+      def localization
+        if platform == "Macintosh"
+          application.comment[3]
+        else
+          application.comment[2]
+        end
+      end
+    end
+  end
+end

data/lib/user_agent/browsers/webkit.rb

@@ -0,0 +1,62 @@
+class UserAgent
+  module Browsers
+    module Webkit
+      def self.extend?(agent)
+        agent.detect { |useragent| useragent.product == "Safari" }
+      end
+
+      def browser
+        if detect_product("Chrome")
+          "Chrome"
+        else
+          "Safari"
+        end
+      end
+
+      def build
+        safari.version
+      end
+
+      BuildVersions = {
+        "125.12" => "1.2.4",
+        "312.6" => "1.3.2",
+        "412.2.2" => "2.0",
+        "412.5" => "2.0.1",
+        "416.13" => "2.0.2",
+        "417.9.3" => "2.0.3",
+        "419.3" => "2.0.4"
+      }.freeze unless defined? BuildVersions
+
+      # Prior to Safari 3, the user agent did not include a version number
+      def version
+        if browser == "Chrome"
+          chrome.version
+        elsif product = detect_product("Version")
+          product.version
+        else
+          BuildVersions[build]
+        end
+      end
+
+      def platform
+        application.comment[0]
+      end
+
+      def webkit
+        detect { |useragent| useragent.product == "AppleWebKit" }
+      end
+
+      def security
+        Security[application.comment[1]]
+      end
+
+      def os
+        OperatingSystems.normalize_os(application.comment[2])
+      end
+
+      def localization
+        application.comment[3]
+      end
+    end
+  end
+end

data/lib/user_agent/comparable.rb

@@ -0,0 +1,25 @@
+class UserAgent
+  # A custom Comparable module that will always return false
+  # if the <=> returns false
+  module Comparable
+    def <(other)
+      (c = self <=> other) ? c == -1 : false
+    end
+
+    def <=(other)
+      (c = self <=> other) ? c == -1 || c == 0 : false
+    end
+
+    def ==(other)
+      (c = self <=> other) ? c == 0 : false
+    end
+
+    def >(other)
+      (c = self <=> other) ? c == 1 : false
+    end
+
+    def >=(other)
+      (c = self <=> other) ? c == 1 || c == 0 : false
+    end
+  end
+end

data/lib/user_agent/operating_systems.rb

@@ -0,0 +1,19 @@
+class UserAgent
+  module OperatingSystems
+    Windows = {
+      "Windows NT 6.0"  => "Windows Vista",
+      "Windows NT 5.2"  => "Windows XP x64 Edition",
+      "Windows NT 5.1"  => "Windows XP",
+      "Windows NT 5.01" => "Windows 2000, Service Pack 1 (SP1)",
+      "Windows NT 5.0"  => "Windows 2000",
+      "Windows NT 4.0"  => "Windows NT 4.0",
+      "Windows 98"      => "Windows 98",
+      "Windows 95"      => "Windows 95",
+      "Windows CE"      => "Windows CE"
+    }.freeze unless defined? Windows
+
+    def self.normalize_os(os)
+      Windows[os] || os
+    end
+  end
+end

data/lib/useragent.rb

@@ -0,0 +1 @@
+require 'user_agent'