user_agent_parser 0.1.0

data/lib/user_agent_parser.rb

@@ -0,0 +1,25 @@
+require 'user_agent_parser/parser'
+require 'user_agent_parser/user_agent'
+require 'user_agent_parser/version'
+require 'user_agent_parser/operating_system'
+
+module UserAgentParser
+
+  # Path to the ua-parser regexes pattern database
+  def self.patterns_path
+    @patterns_path
+  end
+  
+  # Sets the path to the ua-parser regexes pattern database
+  def self.patterns_path=(path)
+    @patterns_path = path
+  end
+  
+  self.patterns_path = File.join(File.dirname(__FILE__), "../vendor/ua-parser/regexes.yaml")
+
+  # Parse the given +user_agent_string+, returning a +UserAgent+
+  def self.parse user_agent_string
+    Parser.new.parse user_agent_string
+  end
+
+end

data/lib/user_agent_parser/operating_system.rb

@@ -0,0 +1,28 @@
+module UserAgentParser
+
+  class OperatingSystem
+  
+    attr_accessor :name, :version
+  
+    def initialize(name="Other", version=nil)
+      self.name = name
+      self.version = version
+    end
+  
+    def to_s
+      s = name
+      s += " #{version}" if version
+      s
+    end
+  
+    def inspect
+      "#<#{self.class} #{to_s}>"
+    end
+  
+    def ==(other)
+      name == other.name && version == other.version
+    end
+  
+  end
+
+end

data/lib/user_agent_parser/parser.rb

@@ -0,0 +1,87 @@
+require 'yaml'
+
+module UserAgentParser
+
+  class Parser
+
+    def parse user_agent
+      ua = parse_ua(user_agent)
+      ua.os = parse_os(user_agent)
+      ua
+    end
+  
+  private
+
+    def all_patterns
+      @all_patterns ||= YAML.load(File.read(UserAgentParser.patterns_path))
+    end
+
+    def patterns type
+      @patterns ||= {}
+      @patterns[type] ||= begin
+        all_patterns[type].each do |p|
+          p["regex"] = Regexp.new(p["regex"])
+        end
+      end
+    end
+  
+    def parse_ua user_agent
+      pattern, match = first_pattern_match(patterns("user_agent_parsers"), user_agent)
+      if match
+        user_agent_from_pattern_match(pattern, match)
+      else
+        UserAgent.new
+      end
+    end
+  
+    def parse_os user_agent
+      pattern, match = first_pattern_match(patterns("os_parsers"), user_agent)
+      if match
+        os_from_pattern_match(pattern, match)
+      else
+        OperatingSystem.new
+      end
+    end
+
+    def first_pattern_match patterns, value
+      for p in patterns
+        if m = p["regex"].match(value)
+          return [p, m]
+        end
+      end
+      nil
+    end
+
+    def user_agent_from_pattern_match pattern, match
+      family, v1, v2, v3 = match[1], match[2], match[3], match[4]
+      if pattern["family_replacement"]
+        family = pattern["family_replacement"].sub('$1', family || '')
+      end
+      v1 = pattern["v1_replacement"].sub('$1', v1 || '') if pattern["v1_replacement"]
+      v2 = pattern["v2_replacement"].sub('$1', v2 || '') if pattern["v2_replacement"]
+      v3 = pattern["v3_replacement"].sub('$1', v3 || '') if pattern["v3_replacement"] 
+      ua = UserAgent.new(family)
+      ua.version = version_from_segments(v1, v2, v3)
+      ua
+    end
+  
+    def os_from_pattern_match pattern, match
+      os, v1, v2, v3, v4 = match[1], match[2], match[3], match[4], match[5]
+      os = pattern["os_replacement"].sub('$1', os || '') if pattern["os_replacement"]
+      v1 = pattern["v1_replacement"].sub('$1', v1 || '') if pattern["v1_replacement"]
+      v2 = pattern["v2_replacement"].sub('$1', v2 || '') if pattern["v2_replacement"]
+      v3 = pattern["v3_replacement"].sub('$1', v3 || '') if pattern["v3_replacement"]
+      v4 = pattern["v3_replacement"].sub('$1', v3 || '') if pattern["v4_replacement"]
+      os = OperatingSystem.new(os)
+      os.version = version_from_segments(v1, v2, v3, v4)
+      os
+    end
+  
+    def version_from_segments(*segments)
+      version_string = segments.compact.join(".")
+      version_string.empty? ? nil : Version.new(version_string)
+    end
+  
+  end
+
+end

data/lib/user_agent_parser/user_agent.rb

@@ -0,0 +1,32 @@
+module UserAgentParser
+
+  class UserAgent
+
+    attr_accessor :family, :version, :os
+
+    def initialize(family="Other", version=nil, os=nil)
+      self.family = family
+      self.version = version
+      self.os = os
+    end
+
+    def to_s
+      s = family
+      s += " #{version}" if version
+      s += " (#{os})" if os
+      s
+    end
+
+    def inspect
+      "#<#{self.class} #{to_s}>"
+    end
+    
+    def ==(other)
+      family == other.family &&
+        version == other.version &&
+        os == other.os
+    end
+
+  end
+  
+end

data/lib/user_agent_parser/version.rb

@@ -0,0 +1,32 @@
+module UserAgentParser
+  
+  class Version
+
+    attr_accessor :version
+    alias :to_s :version
+
+    def initialize(version)
+      self.version = version.to_s.strip
+    end
+
+    def segments
+      version.scan(/\d+\-\d+|\d+[a-zA-Z]+$|\d+|[A-Za-z][0-9A-Za-z-]*$/).map do |s|
+        /^\d+$/ =~ s ? s.to_i : s
+      end
+    end
+
+    def [](segment)
+      segments[segment]
+    end
+  
+    def inspect
+      "#<#{self.class} #{to_s}>"
+    end
+    
+    def ==(other)
+      version == other.version
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: user_agent_parser
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Tim Lucas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-02 00:00:00.000000000 Z
+dependencies: []
+description: A simple, comprehensive Ruby gem for parsing user agent strings with
+  the help of BrowserScope's UA database
+email: t@toolmantim.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/user_agent_parser.rb
+- lib/user_agent_parser/operating_system.rb
+- lib/user_agent_parser/parser.rb
+- lib/user_agent_parser/user_agent.rb
+- lib/user_agent_parser/version.rb
+homepage: http://github.com/toolmantim/user_agent_parser
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2720701220446018537
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A simple, comprehensive Ruby gem for parsing user agent strings with the
+  help of BrowserScope's UA database
+test_files: []