useragent-no-extends 0.6.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d48b50d3a1469dc8126b326ce8eefbbfc86a5867
+  data.tar.gz: 2f59350ea745b69a399085e3adc049987ea7c392
+SHA512:
+  metadata.gz: f94b8d409b9580fa551d774f8aa43916602d38c25c195d7a2558b798bf1f8d7f86b2ce3e2dcbbf34bed0fa4828d00f88b1de63d0c0afb72b13db5999ba49cc62
+  data.tar.gz: 294e86a5068a9fd25a0ecbc9066337112bd8b647bb3e3ef6d3e1aaf4bbf6395acece7263b550ab621bf6b97a532980ded9c66616ed110c2975624e64cb13f3f1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2013 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.rdoc

@@ -0,0 +1,37 @@
+= UserAgent
+
+UserAgent is a Ruby library that parses and compares HTTP User Agents.
+
+This fork removes all of the class extends and replaces them with subclass includes. This results in a performance improvement that is noticed when calling .parse tens of thousands of times. 
+
+=== Installation
+
+  gem install useragent-no-extends
+
+=== Examples
+
+==== Reporting
+
+  string = 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_6_8) AppleWebKit/536.5 (KHTML, like Gecko) Chrome/19.0.1084.56 Safari/536.5'
+  user_agent = UserAgent.parse(string)
+  user_agent.browser
+  # => 'Chrome'
+  user_agent.version
+  # => '19.0.1084.56'
+  user_agent.platform
+  # => 'Macintosh'
+
+==== Comparison
+
+  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) 2013 Joshua Peek, released under the MIT license

data/lib/user_agent.rb

@@ -0,0 +1,90 @@
+require 'user_agent/comparable'
+require 'user_agent/browsers'
+require 'user_agent/operating_systems'
+require 'user_agent/version'
+
+class UserAgent
+
+  # http://www.texsoft.it/index.php?m=sw.php.useragent
+  MATCHER = %r{
+    ^([^/\s]+)        # Product
+    /?([^\s]*)        # Version
+    (\s\(([^\)]*)\))? # Comment
+  }x.freeze
+
+  DEFAULT_USER_AGENT = "Mozilla/4.0 (compatible)"
+
+  def self.parse(string)
+    if string.nil? || string == ""
+      string = DEFAULT_USER_AGENT
+    end
+
+    agents = BrowserArray.new
+    while m = string.to_s.match(MATCHER)
+      agents << new(m[1], m[2], m[4])
+      string = string[m[0].length..-1].strip
+    end
+    agents = 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.new(version)
+    else
+      @version = nil
+    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,45 @@
+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
+
+    def self.extend(array)
+
+      return InternetExplorerBrowsers.new(array) if InternetExplorer.extend?(array)
+      return WebkitBrowsers.new(array) if Webkit.extend?(array)
+      return OperaBrowsers.new(array) if Opera.extend?(array)
+      return GeckoBrowsers.new(array) if Gecko.extend?(array)
+      return array
+
+    end
+  end
+
+  class BrowserArray < Array
+    include Browsers::All
+  end
+
+  class WebkitBrowsers < BrowserArray
+    include Browsers::Webkit
+  end
+
+  class InternetExplorerBrowsers < BrowserArray
+    include Browsers::InternetExplorer
+  end
+
+  class OperaBrowsers < BrowserArray
+    include Browsers::Opera
+  end
+
+  class GeckoBrowsers < BrowserArray
+    include Browsers::Gecko
+  end
+end

data/lib/user_agent/browsers/all.rb

@@ -0,0 +1,106 @@
+class UserAgent
+  module Browsers
+    module All
+      include Comparable
+
+      def <=>(other)
+        if respond_to?(:browser) && other.respond_to?(:browser) &&
+            browser == other.browser
+          version <=> Version.new(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 && application.product
+      end
+
+      def version
+        application && application.version
+      end
+
+      def platform
+        nil
+      end
+
+      def os
+        nil
+      end
+
+      def respond_to?(symbol)
+        detect_product(symbol) ? true : super
+      end
+
+      def method_missing(method, *args, &block)
+        detect_product(method) || super
+      end
+
+      def webkit?
+        false
+      end
+
+      def mobile?
+        if browser == 'webOS'
+          true
+        elsif platform == 'Symbian'
+          true
+        elsif detect_product('Mobile') || detect_comment('Mobile')
+          true
+        elsif os =~ /Android/
+          true
+        elsif application && application.comment &&
+            application.comment.detect { |k, v| k =~ /^IEMobile/ }
+          true
+        else
+          false
+        end
+      end
+
+      def bot?
+        # If UA has no application type, its probably generated by a
+        # shitty bot.
+        if application.nil?
+          true
+
+        # Match common case when bots refer to themselves as bots in
+        # the application comment. There are no standards for how bots
+        # should call themselves so its not an exhaustive method.
+        #
+        # If you want to expand the scope, override the method and
+        # provide your own regexp. Any patches to future extend this
+        # list will be rejected.
+        elsif comment = application.comment
+          comment.any? { |c| c =~ /bot/i }
+        else
+          false
+        end
+      end
+
+      private
+        def detect_product(product)
+          detect { |useragent| useragent.product.to_s.downcase == product.to_s.downcase }
+        end
+
+        def detect_comment(comment)
+          detect { |useragent| useragent.comment && useragent.comment.include?(comment) }
+        end
+    end
+  end
+end

data/lib/user_agent/browsers/gecko.rb

@@ -0,0 +1,60 @@
+class UserAgent
+  module Browsers
+    module Gecko
+      def self.extend?(agent)
+        agent.application && agent.application.product == "Mozilla"
+      end
+
+      GeckoBrowsers = %w(
+        Firefox
+        Camino
+        Iceweasel
+        Seamonkey
+      ).freeze
+
+      def browser
+        GeckoBrowsers.detect { |browser| respond_to?(browser) } || super
+      end
+
+      def version
+        send(browser).version || super
+      end
+
+      def platform
+        if comment = application.comment
+          if comment[0] == 'compatible'
+            nil
+          elsif /^Windows / =~ comment[0]
+            'Windows'
+          else
+            comment[0]
+          end
+        end
+      end
+
+      def security
+        Security[application.comment[1]] || :strong
+      end
+
+      def os
+        if comment = application.comment
+          i = if comment[1] == 'U'
+            2
+          elsif /^Windows / =~ comment[0]
+            0
+          else
+            1
+          end
+
+          OperatingSystems.normalize_os(comment[i])
+        end
+      end
+
+      def localization
+        if comment = application.comment
+          comment[3]
+        end
+      end
+    end
+  end
+end

data/lib/user_agent/browsers/internet_explorer.rb

@@ -0,0 +1,50 @@
+class UserAgent
+  module Browsers
+    module InternetExplorer
+      def self.extend?(agent)
+        agent.application &&
+          agent.application.comment &&
+          agent.application.comment[0] == "compatible" &&
+          agent.application.comment[1] =~ /MSIE/
+      end
+
+      def browser
+        "Internet Explorer"
+      end
+
+      def version
+        Version.new(application.comment[1].sub("MSIE ", ""))
+      end
+
+      def compatibility
+        application.comment[0]
+      end
+
+      def compatible?
+        compatibility == "compatible"
+      end
+
+      def compatibility_view?
+        version == "7.0" && application.comment.detect { |c| c['Trident/'] }
+      end
+
+      # Before version 4.0, Chrome Frame declared itself (unversioned) in a comment;
+      # as of 4.0 it can declare itself versioned in a comment
+      # or as a separate product with a version
+      def chromeframe
+        cf = application.comment.include?("chromeframe") || detect_product("chromeframe")
+        return cf if cf
+        cf_comment = application.comment.detect { |c| c['chromeframe/'] }
+        cf_comment ? UserAgent.new(*cf_comment.split('/', 2)) : nil
+      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,57 @@
+class UserAgent
+  module Browsers
+    module Opera
+      def self.extend?(agent)
+        agent.application && agent.application.product == "Opera"
+      end
+
+      def version
+        if product = detect_product('Version')
+          product.version
+        else
+          super
+        end
+      end
+
+      def platform
+        if application.comment.nil?
+          nil
+        elsif application.comment[0] =~ /Windows/
+          "Windows"
+        else
+          application.comment[0]
+        end
+      end
+
+      def security
+        if application.comment.nil?
+          :strong
+        elsif platform == "Macintosh"
+          Security[application.comment[2]]
+        else
+          Security[application.comment[1]]
+        end
+      end
+
+      def os
+        if application.comment.nil?
+          nil
+        elsif application.comment[0] =~ /Windows/
+          OperatingSystems.normalize_os(application.comment[0])
+        else
+          application.comment[1]
+        end
+      end
+
+      def localization
+        if application.comment.nil?
+          nil
+        elsif platform == "Macintosh"
+          application.comment[3]
+        else
+          application.comment[2]
+        end
+      end
+    end
+  end
+end

data/lib/user_agent/browsers/webkit.rb

@@ -0,0 +1,135 @@
+class UserAgent
+  module Browsers
+    module Webkit
+      def self.extend?(agent)
+        agent.detect { |useragent| useragent.product == 'AppleWebKit' }
+      end
+
+      def webkit?
+        true
+      end
+
+      def browser
+        if detect_product('Chrome')
+          'Chrome'
+        elsif os =~ /Android/
+          'Android'
+        elsif platform == 'webOS' || platform == 'BlackBerry'  || platform == 'Symbian'
+          platform
+        else
+          'Safari'
+        end
+      end
+
+      def build
+        webkit.version
+      end
+
+      BuildVersions = {
+        "85.7"     => "1.0",
+        "85.8.5"   => "1.0.3",
+        "85.8.2"   => "1.0.3",
+        "124"      => "1.2",
+        "125.2"    => "1.2.2",
+        "125.4"    => "1.2.3",
+        "125.5.5"  => "1.2.4",
+        "125.5.6"  => "1.2.4",
+        "125.5.7"  => "1.2.4",
+        "312.1.1"  => "1.3",
+        "312.1"    => "1.3",
+        "312.5"    => "1.3.1",
+        "312.5.1"  => "1.3.1",
+        "312.5.2"  => "1.3.1",
+        "312.8"    => "1.3.2",
+        "312.8.1"  => "1.3.2",
+        "412"      => "2.0",
+        "412.6"    => "2.0",
+        "412.6.2"  => "2.0",
+        "412.7"    => "2.0.1",
+        "416.11"   => "2.0.2",
+        "416.12"   => "2.0.2",
+        "417.9"    => "2.0.3",
+        "418"      => "2.0.3",
+        "418.8"    => "2.0.4",
+        "418.9"    => "2.0.4",
+        "418.9.1"  => "2.0.4",
+        "419"      => "2.0.4",
+        "425.13"   => "2.2",
+        "534.52.7" => "5.1.2"
+      }.freeze
+
+      # Prior to Safari 3, the user agent did not include a version number
+      def version
+        str = if os =~ /CPU (?:iPhone |iPod )?OS ([\d_]+) like Mac OS X/
+          $1.gsub(/_/, '.')
+        elsif product = detect_product('Version')
+          product.version
+        elsif browser == 'Chrome'
+          chrome.version
+        else
+          BuildVersions[build.to_s]
+        end
+
+        Version.new(str) if str
+      end
+
+      def application
+         self.reject { |agent| agent.comment.nil? || agent.comment.empty? }.first
+      end
+
+      def platform
+        if application.nil?
+          nil
+        elsif application.comment[0] =~ /Symbian/
+          'Symbian'
+        elsif application.comment[0] =~ /webOS/
+          'webOS'
+        elsif application.comment[0] =~ /Windows/
+          'Windows'
+        elsif application.comment[0] == 'BB10'
+          'BlackBerry'
+        else
+          application.comment[0]
+        end
+      end
+
+      def webkit
+        detect { |useragent| useragent.product == "AppleWebKit" }
+      end
+
+      def security
+        Security[application.comment[1]]
+      end
+
+      def os
+        if platform == 'webOS'
+          "Palm #{last.product} #{last.version}"
+        elsif platform == 'Symbian'
+          application.comment[0]
+        elsif application
+          if application.comment[0] =~ /Windows NT/
+            OperatingSystems.normalize_os(application.comment[0])
+          elsif application.comment[2].nil?
+            OperatingSystems.normalize_os(application.comment[1])
+          elsif application.comment[1] =~ /Android/
+            OperatingSystems.normalize_os(application.comment[1])
+          else
+            OperatingSystems.normalize_os(application.comment[2])
+          end
+        else
+          nil
+        end
+      end
+
+      def localization
+        if application.nil?
+          nil
+        elsif platform == 'webOS'
+          application.comment[2]
+        else
+          application.comment[3]
+        end
+      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,33 @@
+class UserAgent
+  module OperatingSystems
+    Windows = {
+      "Windows NT 6.2"  => "Windows 8",
+      "Windows NT 6.1"  => "Windows 7",
+      "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
+
+    def self.normalize_os(os)
+      Windows[os] || normalize_mac_os_x(os) || os
+    end
+
+    private
+      def self.normalize_mac_os_x(os)
+        if os =~ /(?:Intel|PPC) Mac OS X\s*([0-9_\.]+)?/
+          if $1.nil?
+            "OS X"
+          else
+            version = $1.gsub('_', '.')
+            "OS X #{version}"
+          end
+        end
+      end
+  end
+end

data/lib/user_agent/version.rb

@@ -0,0 +1,90 @@
+class UserAgent
+  class Version
+    include ::Comparable
+
+    def self.new(obj)
+      case obj
+      when Version
+        obj
+      when String
+        super
+      else
+        raise ArgumentError, "invalid value for Version: #{obj.inspect}"
+      end
+    end
+
+    def initialize(str)
+      @str = str
+
+      if str =~ /^\d+$/ || str =~ /^\d+\./
+        @sequences  = str.scan(/\d+|[A-Za-z][0-9A-Za-z-]*$/).map { |s| s =~ /^\d+$/ ? s.to_i : s }
+        @comparable = true
+      else
+        @sequences  = [str]
+        @comparable = false
+      end
+    end
+
+    def to_a
+      @sequences.dup
+    end
+
+    def to_str
+      @str.dup
+    end
+
+    def eql?(other)
+      other.is_a?(self.class) && to_s == other.to_s
+    end
+
+    def ==(other)
+      case other
+      when Version
+        eql?(other)
+      when String
+        eql?(self.class.new(other))
+      else
+        false
+      end
+    end
+
+    def <=>(other)
+      case other
+      when Version
+        if @comparable
+          ([0]*6).zip(to_a, other.to_a).each do |dump, a, b|
+            a ||= 0
+            b ||= 0
+
+            if a.is_a?(String) && b.is_a?(Integer)
+              return -1
+            elsif a.is_a?(Integer) && b.is_a?(String)
+              return 1
+            elsif a == b
+              next
+            else
+              return a <=> b
+            end
+          end
+          0
+        elsif to_s == other.to_s
+          return 0
+        else
+          return -1
+        end
+      when String
+        self <=> self.class.new(other)
+      else
+        nil
+      end
+    end
+
+    def to_s
+      to_str
+    end
+
+    def inspect
+      "#<#{self.class} #{to_s}>"
+    end
+  end
+end

data/lib/useragent.rb

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

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: useragent-no-extends
+version: !ruby/object:Gem::Version
+  version: 0.6.1
+platform: ruby
+authors:
+- Joshua Peek
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! '    HTTP User Agent parser
+
+'
+email: josh@joshpeek.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/user_agent.rb
+- lib/user_agent/browsers.rb
+- lib/user_agent/browsers/all.rb
+- lib/user_agent/browsers/gecko.rb
+- lib/user_agent/browsers/internet_explorer.rb
+- lib/user_agent/browsers/opera.rb
+- lib/user_agent/browsers/webkit.rb
+- lib/user_agent/comparable.rb
+- lib/user_agent/operating_systems.rb
+- lib/user_agent/version.rb
+- lib/useragent.rb
+- LICENSE
+- README.rdoc
+homepage: http://github.com/jpwinans/useragent-no-extends
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.7
+signing_key: 
+specification_version: 4
+summary: HTTP User Agent parser without extends
+test_files: []