robworley-browscap 0.3.0

data/lib/browscap.rb

@@ -0,0 +1,144 @@
+# Browscap Ruby Gem - A simple library to parse the beloved browscap.ini file.
+# Copyright (C) 2010
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+#
+# Original python code by Henning Schroeder
+# Ported to Ruby by Lukas Fittl
+#
+
+require 'inifile'
+
+class Browscap
+  def initialize(filename = File.join(File.dirname(__FILE__), '..', 'ini', 'default.ini'))
+    @@user_agent_properties ||= {}
+    @@user_agent_regexps ||= {}
+    @@match_cache ||= {}
+
+    if @@user_agent_properties.empty? || @@user_agent_regexps.empty?
+      ini = IniFile.load(filename)
+
+      # Remote meta sections
+      ini.delete_section '*'
+      ini.delete_section 'GJK_Browscap_Version'
+
+      # Create a list of non-parent sections
+      child_sections = ini.sections.dup
+      ini.sections.each do |section|
+        child_sections.delete ini[section]["Parent"]
+      end
+
+      # Populate user_agent_properties and user_agent_regexps
+      child_sections.each do |section|
+        properties = get_browser_props(ini, section)
+
+        browser = Browser.new
+        browser.browser = properties['Browser']
+        browser.version = properties['Version']
+        browser.major_ver = properties['MajorVer'].to_i
+        browser.minor_ver = properties['MinorVer'].to_i
+        browser.platform = properties['Platform']
+        browser.alpha = properties['Alpha'].downcase == 'true'
+        browser.beta = properties['Beta'].downcase == 'true'
+        browser.win16 = properties['Win16'].downcase == 'true'
+        browser.win32 = properties['Win32'].downcase == 'true'
+        browser.win64 = properties['Win64'].downcase == 'true'
+        browser.frames = properties['Frames'].downcase == 'true'
+        browser.iframes = properties['IFrames'].downcase == 'true'
+        browser.tables = properties['Tables'].downcase == 'true'
+        browser.cookies = properties['Cookies'].downcase == 'true'
+        browser.background_sounds = properties['BackgroundSounds'].downcase == 'true'
+        browser.javascript = properties['JavaScript'].downcase == 'true'
+        browser.vbscript = properties['VBScript'].downcase == 'true'
+        browser.java_applets = properties['JavaApplets'].downcase == 'true'
+        browser.activex_controls = properties['ActiveXControls'].downcase == 'true'
+        browser.is_banned = properties['isBanned'].downcase == 'true'
+        browser.is_mobile_device = properties['isMobileDevice'].downcase == 'true'
+        browser.is_syndication_reader = properties['isSyndicationReader'].downcase == 'true'
+        browser.crawler = properties['Crawler'].downcase == 'true'
+        browser.css_version = properties['CssVersion'].to_i
+        browser.aol_version = properties['aolVersion'].to_i
+
+        @@user_agent_properties[section] = browser
+
+        # Convert .ini file regexp syntax into ruby regexp syntax
+        regexp = section.dup
+        regexp.gsub! /([\^\$\(\)\[\]\.\-])/, "\\\\\\1"
+        regexp.gsub! "?", "."
+        regexp.gsub! "*", ".*?"
+
+        @@user_agent_regexps[section] = Regexp.new("^%s$" % regexp)
+      end
+    end
+  end
+
+  # Looks up the given user agent string and returns a dictionary containing information on this browser or bot.
+  def query(user_agent)
+    section = match(user_agent)
+    @@user_agent_properties[section]
+  end
+  alias =~ query
+
+  protected
+
+  def match(user_agent)
+    return @@match_cache[user_agent] if @@match_cache[user_agent]
+
+    matching_section = ''
+
+    @@user_agent_regexps.each do |section, regexp|
+      # Find the longest regexp that matches the given user_agent_string. The length check is needed since multiple reg-exps may match the user_agent_string.
+      if regexp.match(user_agent) && section.length > matching_section.length
+        matching_section = section
+      end
+    end
+
+    @@match_cache[user_agent] = matching_section
+    matching_section
+  end
+
+  # Recursively traverses the properties tree (based on 'parent' attribute of each section) and
+  # returns a dictionary of all browser properties for the given section name. The properties lower
+  # in the tree override those higher in the tree.
+  def get_browser_props(ini, section)
+    data = {}
+
+    if parent = ini[section]["Parent"]
+      data.merge! get_browser_props(ini, parent)
+    end
+
+    data.merge! ini[section]
+    data
+  end
+end
+
+class Browser
+  attr_accessor :activex_controls, :alpha, :aol_version, :background_sounds, :beta,
+    :browser, :cookies, :crawler, :css_version, :frames, :iframes, :is_banned, :is_mobile_device,
+    :is_syndication_reader, :java_applets, :javascript, :major_ver, :minor_ver, :platform,
+    :css_version, :tables, :vbscript, :version, :win16, :win32, :win64
+
+  [
+    :activex_controls, :alpha, :aol_version, :background_sounds, :beta, :cookies, :crawler, :frames,
+    :iframes, :is_banned, :is_mobile_device, :is_syndication_reader, :java_applets, :javascript,
+    :css_version, :tables, :vbscript, :win16, :win32, :win64
+  ].each do |method_name|
+    class_eval %{
+      def #{method_name}?
+        @#{method_name}
+      end
+    }
+  end
+end

data/spec/browscap_spec.rb

@@ -0,0 +1,70 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'browscap'
+
+describe Browscap do
+  before(:each) do
+    @browscap = Browscap.new
+  end
+
+  it "should detect Konqueror 3.5 on Linux" do
+    konq35 = @browscap.query "Mozilla/5.0 (compatible; Konqueror/3.5; Linux; X11; de) KHTML/3.5.2 (like Gecko) Kubuntu 6.06 Dapper"
+    konq35.browser.should == 'Konqueror'
+    konq35.version.should == '3.5'
+    konq35.platform.should == 'Linux'
+  end
+
+  it "should detect Firefox 1.5 on Linux" do
+    ff15 = @browscap.query "Mozilla/5.0 (X11; U; Linux i686; de; rv:1.8.0.5) Gecko/20060731 Ubuntu/dapper-security Firefox/1.5.0.5"
+    ff15.browser.should == 'Firefox'
+    ff15.version.should == '1.5'
+    ff15.platform.should == 'Linux'
+  end
+
+  it "should detect Mozilla 1.7 on Linux" do
+    moz17 = @browscap.query "Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.7.12) Gecko/20060216 Debian/1.7.12-1.1ubuntu2"
+    moz17.browser.should == 'Mozilla'
+    moz17.version.should == '1.7'
+    moz17.platform.should == 'Linux'
+  end
+
+  it "should detect Firefox 1.5 on Linux (2)" do
+    ff15 = @browscap.query "Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.8.0.5) Gecko/20060731 Ubuntu/dapper-security Epiphany/2.14 Firefox/1.5.0.5"
+    ff15.browser.should == 'Firefox'
+    ff15.version.should == '1.5'
+    ff15.platform.should == 'Linux'
+  end
+
+  it "should detect Opera 9.0 on Linux" do
+    opera90 = @browscap.query "Opera/9.00 (X11; Linux i686; U; en)"
+    opera90.browser.should == 'Opera'
+    opera90.version.should == '9.0'
+    opera90.platform.should == 'Linux'
+  end
+
+  it "shouldn't detect Kazehakase" do
+    @browscap.query("Mozilla/5.0 (X11; Linux i686; U;) Gecko/20051128 Kazehakase/0.3.3 Debian/0.3.3-1").should be_nil
+  end
+
+  it "should detect MSIE 6.0 on Windows 98" do
+    ie6 = @browscap.query "Mozilla/4.0 (compatible; MSIE 6.0; Windows 98)"
+    ie6.browser.should == 'IE'
+    ie6.version.should == '6.0'
+    ie6.platform.should == 'Win98'
+  end
+
+  it "should detect Wget as crawler" do
+    wget = @browscap.query "Wget/1.10.2"
+    wget.crawler.should == true
+  end
+
+  it "should detect Googlebot as crawler" do
+    google = @browscap.query "Mozilla/5.0 (compatible; Googlebot/2.1; +http://www.google.com/bot.html)"
+    google.crawler.should == true
+  end
+
+  it "should detect Yahoo! bot as crawler" do
+    yahoo = @browscap.query "Mozilla/5.0 (compatible; Yahoo! Slurp; http://help.yahoo.com/help/us/ysearch/slurp)"
+    yahoo.crawler.should == true
+  end
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification 
+name: robworley-browscap
+version: !ruby/object:Gem::Version 
+  hash: 19
+  prerelease: 
+  segments: 
+  - 0
+  - 3
+  - 0
+  version: 0.3.0
+platform: ruby
+authors: 
+- Henning Schroeder
+- Lukas Fittl
+- Jason Adams
+- Rob Worley
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-01 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: inifile
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 0
+        - 3
+        - 0
+        version: 0.3.0
+  type: :runtime
+  version_requirements: *id001
+description: A simple library to parse the beloved browscap.ini file (ported to ruby from Henning Schroeder's python code by Lukas Fittl).
+email: 
+- lukas@fittl.com
+- jasonmadams@gmail.com
+- robert.worley@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- browscap.gemspec
+- ini/default.ini
+- lib/browscap.rb
+- spec/browscap_spec.rb
+has_rdoc: true
+homepage: http://github.com/robworley/browscap
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: 
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: A simple library to parse the beloved browscap.ini file
+test_files: 
+- spec/browscap_spec.rb