steveh-browscap 0.3.0

data/lib/browscap.rb

@@ -0,0 +1,5 @@
+require "browscap/parser"
+require "browscap/browser"
+
+module Browscap
+end

data/lib/browscap/browser.rb

@@ -0,0 +1,19 @@
+module Browscap
+  class Browser
+
+    BOOLEAN_ATTRIBUTES = [:activex_controls, :alpha, :aol, :background_sounds,
+      :beta, :cookies, :crawler, :frames, :iframes, :banned, :mobile_device,
+      :syndication_reader, :java_applets, :javascript, :supports_css, :tables,
+      :vbscript, :win16, :win32, :win64]
+
+    OTHER_ATTRIBUTES = [:aol_version, :browser, :css_version, :major_ver,
+      :minor_ver, :platform, :version]
+
+    attr_accessor *(BOOLEAN_ATTRIBUTES + OTHER_ATTRIBUTES)
+
+    BOOLEAN_ATTRIBUTES.each do |attribute|
+      alias :"#{attribute}?" :"#{attribute}"
+    end
+
+  end
+end

data/lib/browscap/parser.rb

@@ -0,0 +1,112 @@
+require "inifile"
+
+module Browscap
+  class Parser
+
+    def initialize(filename = File.join(File.dirname(__FILE__), '../..', 'ini', 'default.ini'), opts={})
+      @@user_agent_properties ||= {}
+      @@user_agent_regexps ||= {}
+      @@match_cache ||= {}
+      @@encoding = opts[:encoding] || 'ISO-8859-1'
+
+      if @@user_agent_properties.empty? || @@user_agent_regexps.empty?
+        ini = IniFile.load(filename, :encoding => @@encoding)
+
+        # 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.banned = properties['isBanned'].downcase == 'true'
+          browser.mobile_device = properties['isMobileDevice'].downcase == 'true'
+          browser.syndication_reader = properties['isSyndicationReader'].downcase == 'true'
+          browser.crawler = properties['Crawler'].downcase == 'true'
+          browser.css_version = properties['CssVersion'].to_i
+          browser.supports_css = properties['supportsCSS'].downcase == 'true'
+          browser.aol_version = properties['aolVersion'].to_i
+          browser.aol = properties['AOL'].downcase == 'true'
+
+          @@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).force_encoding(@@encoding))
+        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
+end

data/lib/browscap/version.rb

@@ -0,0 +1,3 @@
+module Browscap
+  VERSION = "0.3.0"
+end

data/spec/browscap_spec.rb

@@ -0,0 +1,69 @@
+require "spec_helper"
+
+describe Browscap::Parser do
+
+  before(:each) do
+    @browscap = Browscap::Parser.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

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require "browscap"

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification 
+name: steveh-browscap
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.3.0
+platform: ruby
+authors: 
+- Henning Schroeder
+- Lukas Fittl
+- Jason Adams
+- Gilles Devaux
+- Steve Hoeksema
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-17 00:00:00 +12: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 
+        version: "0.4"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "2.6"
+  type: :development
+  version_requirements: *id002
+description: A simple library to parse the beloved browscap.ini file (ported to ruby from Henning Schroeder's python code by Lukas Fittl).
+email: 
+- steve@seven.net.nz
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.markdown
+- Rakefile
+- browscap.gemspec
+- ini/default.ini
+- lib/browscap.rb
+- lib/browscap/browser.rb
+- lib/browscap/parser.rb
+- lib/browscap/version.rb
+- spec/browscap_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: https://github.com/steveh/browscap
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: steveh-browscap
+rubygems_version: 1.5.0
+signing_key: 
+specification_version: 3
+summary: A simple library to parse the beloved browscap.ini file
+test_files: 
+- spec/browscap_spec.rb
+- spec/spec_helper.rb