browscapper 0.0.1

data/.gitignore

@@ -0,0 +1,12 @@
+*.orig
+.*.swp
+.*.swo
+*.tmp
+*.patch
+*.kpf
+*~
+.DS_Store
+Thumbs.db
+pkg/
+doc/
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 J Smith <dark.panda@gmail.com>
+
+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,43 @@
+
+= Browscapper
+
+I suppose this could also be called Yet Another Browscap.ini Reader.
+
+  Browscapper.load('path/to/browscap.ini')
+  Browscapper.match('Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10.6; en-US; rv:1.9.2.8) Gecko/20100722 Firefox/3.6.8')
+  #=> Browscapper::UserAgent
+
+  Browscapper.matches
+  #=> Array of Browscapper::UserAgents, in order of best-to-worst matches.
+
+== File Formats
+
+The most widely used browscap.ini file is probably Gary Keith's, found at
+https://browsers.garykeith.com/downloads . For the sake of convenience and
+compatibiilty, Browscapper.load will look in the current directory for
+a browscap.ini file. However, Browscapper can also read in browscap.csv
+files as well, which are also available from Gary's site, as well as YAML
+files and files written in Ruby's own Marshal'd file format. In fact, for the
+sake of performance and speed, you may want to consider dumping browscap.ini
+files into the Marshal'd format, which loads much faster than any of the
+other file formats. For the sake of comparison, here are some benchmarks from
+on my current development laptop (MacBook Pro 10,1 with a solid state drive):
+
+  bench_csv  1.111839s
+  bench_ini  3.801561s
+  bench_marshal  0.081942s
+
+These are just the averages from a few runs, but the result is pretty clear
+all the same: the Marshal'd format is by far quicker. (The YAML parser
+currently has some problems with some messed up encodings and isn't
+really recommended for prime time.)
+
+To dump Browscapper into a Marshal'd format, you can either call
+Browscapper.dump and write the results to a file or you can use the provided
+rake task thusly:
+
+  rake browscapper:dump IN=browscap.ini OUT=browscap.dump
+
+== License
+
+See the MIT-LICENSE file for details.

data/Rakefile

@@ -0,0 +1,55 @@
+# -*- ruby -*-
+
+require 'rubygems'
+
+gem 'rdoc', '~> 3.12'
+
+require 'rubygems/package_task'
+require 'rake/testtask'
+require 'rdoc/task'
+require 'bundler/gem_tasks'
+
+if RUBY_VERSION >= '1.9'
+  begin
+    gem 'psych'
+  rescue Exception => e
+    # it's okay, fall back on the bundled psych
+  end
+end
+
+$:.push 'lib'
+
+version = Browscapper::VERSION
+
+desc 'Test browscapper library'
+Rake::TestTask.new(:test) do |t|
+  t.test_files = FileList['test/**/*_tests.rb']
+  t.verbose = !!ENV['VERBOSE_TESTS']
+  t.warning = !!ENV['WARNINGS']
+end
+
+desc 'Build docs'
+Rake::RDocTask.new do |t|
+  t.title = "browscapper #{version}"
+  t.main = 'README.rdoc'
+  t.rdoc_dir = 'doc'
+  t.rdoc_files.include('README.rdoc', 'MIT-LICENSE', 'lib/**/*.rb')
+end
+
+desc "Converts a browscap file to another format"
+task "browscapper:dump" do
+  require File.join(File.dirname(__FILE__), %w{ lib browscapper })
+
+  if !ENV['IN'] || !ENV['OUT']
+    puts "Usage: IN=browscap OUT=browscap.dump"
+    puts
+    puts "Converts a browscap file to a ruby Marshal'd format. These files"
+    puts "are much quicker to load than CSV or INI files."
+    exit
+  end
+
+  Browscapper.load(ENV['IN'])
+  File.open(ENV['OUT'], 'wb') do |fp|
+    fp.write(Marshal.dump(Browscapper.entries))
+  end
+end

data/browscapper.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+
+require File.expand_path('../lib/browscapper/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name = %q{browscapper}
+  s.version = Browscapper::VERSION
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["J Smith"]
+  s.description = "A browscap file parser and matcher."
+  s.summary = s.description
+  s.email = "dark.panda@gmail.com"
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = `git ls-files`.split($\)
+  s.executables = s.files.grep(%r{^bin/}).map { |f| File.basename(f) }
+  s.test_files = s.files.grep(%r{^(test|spec|features)/})
+  s.homepage = "http://github.com/dark-panda/browscapper"
+  s.require_paths = ["lib"]
+
+  s.add_dependency("rdoc")
+  s.add_dependency("rake", ["~> 0.9"])
+  s.add_dependency("minitest")
+  s.add_dependency("inifile")
+end
+

data/lib/browscapper/reader/csv_reader.rb

@@ -0,0 +1,63 @@
+# encoding: BINARY
+
+if RUBY_VERSION.to_f < 1.9
+  require 'fastercsv'
+else
+  require 'csv'
+end
+
+module Browscapper
+  module CSVReader
+    CSV_ENGINE = if defined?(FasterCSV)
+      FasterCSV
+    else
+      CSV
+    end
+
+    class << self
+      include Reader
+
+      def load(file)
+        csv = CSV_ENGINE.open(file, 'rb')
+
+        # skip header
+        2.times { csv.shift }
+        headers = csv.shift
+
+        entries = Hash.new
+
+        csv.each do |l|
+          entry = UserAgent.new
+          headers.each_with_index do |v, i|
+            entry[v] = case l[i]
+              when 'false'
+                false
+              when 'true'
+                true
+              when /^\d+$/
+                l[i].to_i
+              else
+                l[i]
+            end
+          end
+
+          entry.user_agent = if entry.user_agent
+            entry.user_agent.sub!(/^\[(.+)\]$/, '\1')
+          elsif entry.browser
+            entry.browser
+          end
+
+          entry.pattern = pattern_to_regexp(entry.user_agent.to_s)
+
+          if entries[entry.parent]
+            entry.merge!(entries[entry.parent])
+          end
+
+          entries[entry.user_agent] = entry
+        end
+
+        entries
+      end
+    end
+  end
+end

data/lib/browscapper/reader/ini_reader.rb

@@ -0,0 +1,47 @@
+# encoding: BINARY
+
+require 'inifile'
+
+module Browscapper
+  module INIReader
+    class << self
+      include Reader
+
+      def load(file)
+        ini = IniFile.load(file, :encoding => 'BINARY')
+        ini.delete_section('GJK_Browscap_Version')
+
+        injector = proc { |memo, section|
+          unless memo[section]
+            entry = UserAgent.new
+            ini[section].each do |k, v|
+              entry[k] = case v
+                when 'false'
+                  false
+                when 'true'
+                  true
+                when /^\d+$/
+                  v.to_i
+                else
+                  v
+              end
+            end
+            entry.user_agent = section
+            entry.pattern = pattern_to_regexp(entry.user_agent)
+
+            memo[section] = entry
+
+            if entry.parent
+              memo = injector.call(memo, entry.parent)
+              entry.merge!(memo[entry.parent])
+            end
+          end
+
+          memo
+        }
+
+        ini.sections.inject({}, &injector)
+      end
+    end
+  end
+end

data/lib/browscapper/reader/marshal_reader.rb

@@ -0,0 +1,13 @@
+# encoding: BINARY
+
+module Browscapper
+  module MarshalReader
+    class << self
+      include Reader
+
+      def load(file)
+        Marshal.load(File.open(file, 'rb').read)
+      end
+    end
+  end
+end

data/lib/browscapper/reader/yaml_reader.rb

@@ -0,0 +1,13 @@
+# encoding: BINARY
+
+require 'yaml'
+
+module Browscapper
+  module YAMLReader
+    class << self
+      def load(file)
+        YAML.load(File.open(file, 'rb'))
+      end
+    end
+  end
+end

data/lib/browscapper/reader.rb

@@ -0,0 +1,20 @@
+# encoding: BINARY
+
+module Browscapper
+  module Reader
+    def pattern_to_regexp(pattern)
+      pattern = pattern.dup
+
+      if pattern.respond_to?(:force_encoding)
+        pattern.force_encoding('BINARY')
+      end
+
+      pattern.downcase!
+      pattern.gsub!(/([\^\$\(\)\[\]\.\-])/, "\\\\\\1")
+      pattern.gsub!('?', '.')
+      pattern.gsub!('*', '.*?')
+
+      Regexp.new("^#{pattern}$")
+    end
+  end
+end

data/lib/browscapper/user_agent.rb

@@ -0,0 +1,98 @@
+# encoding: BINARY
+
+module Browscapper
+  class UserAgent
+    include Enumerable
+
+    ACCESSORS = [
+      :parent, :user_agent, :comment, :browser, :version, :major_version,
+      :minor_version, :platform, :platform_version, :alpha, :beta, :win16, :win32, :win64,
+      :frames, :iframes, :tables, :cookies, :background_sounds, :vbscript,
+      :javascript, :java_applets, :activex_controls, :banned, :mobile_device,
+      :syndication_reader, :crawler, :css_version, :aol_version, :user_agent_id,
+      :css, :cdf, :aol, :device_name, :device_maker, :rendering_engine_name,
+      :rendering_engine_version, :rendering_engine_description
+    ]
+
+    ACCESSORS.each do |accessor|
+      self.class_eval do
+        attr_accessor accessor
+      end
+    end
+
+    attr_accessor :pattern
+
+    MAP = {
+      'useragent'            => :user_agent,
+      'version'              => :version,
+      'majorver'             => :major_version,
+      'minorver'             => :minor_version,
+      'majorversion'         => :major_version,
+      'minorversion'         => :minor_version,
+      'backgroundsounds'     => :background_sounds,
+      'javaapplets'          => :java_applets,
+      'activexcontrols'      => :activex_controls,
+      'isbanned'             => :banned,
+      'ismobiledevice'       => :mobile_device,
+      'mobiledevice'         => :mobile_device,
+      'issyndicationreader'  => :syndication_reader,
+      'syndicationreader'    => :syndication_reader,
+      'cssversion'           => :css_version,
+      'aolversion'           => :aol_version,
+      'useragentid'          => :user_agent_id,
+      'supportscss'          => :css,
+      'renderingengine_name' => :rendering_engine_name,
+      'renderingengine_version' => :rendering_engine_version,
+      'renderingengine_description' => :rendering_engine_description
+    }
+
+    def initialize(hash = {})
+      self.merge!(hash)
+    end
+
+    def each
+      self.to_hash.each do |k, v|
+        yield k, v
+      end
+    end
+
+    def to_hash
+      @to_hash ||= ACCESSORS.inject({}) do |memo, accessor|
+        memo[accessor] = self.send(accessor)
+        memo
+      end
+    end
+
+    def []=(key, value)
+      key = key.to_s.downcase
+      key = "#{MAP[key] || key}="
+      self.send(key, value) if self.respond_to?(key)
+    end
+
+    def [](key)
+      key = key.to_s.downcase
+      key = MAP[key] || key
+      self.send(key) if self.respond_to?(key)
+    end
+
+    def merge!(parent)
+      parent = parent.to_hash if parent.is_a?(UserAgent)
+      ACCESSORS.each do |k, v|
+        if parent.has_key?(k)
+          val = self.send(k)
+          if val == 'default' || val.nil?
+            self.send("#{k}=", parent[k])
+          end
+        end
+      end
+      self
+    end
+
+    def ==(other)
+      ACCESSORS.each do |accessor|
+        return false if self.send(accessor) != other.send(accessor)
+      end
+      true
+    end
+  end
+end

data/lib/browscapper/version.rb

@@ -0,0 +1,6 @@
+# encoding: BINARY
+
+module Browscapper
+  VERSION = "0.0.1"
+end
+

data/lib/browscapper.rb

@@ -0,0 +1,71 @@
+# encoding: BINARY
+
+module Browscapper
+  autoload :UserAgent,  'browscapper/user_agent'
+  autoload :Reader,     'browscapper/reader'
+  autoload :CSVReader,  'browscapper/reader/csv_reader'
+  autoload :YAMLReader, 'browscapper/reader/yaml_reader'
+  autoload :INIReader,  'browscapper/reader/ini_reader'
+  autoload :MarshalReader,  'browscapper/reader/marshal_reader'
+
+  class << self
+    attr_reader :entries, :file
+    MATCH_CACHE = Hash.new
+
+    def load(file = File.join(%w{ . browscap.ini }))
+      if !File.exists?(file)
+        raise ArgumentError.new("File #{file} not found.")
+      end
+
+      reader = case file.downcase
+        when /\.csv$/
+          CSVReader
+        when /\.ya?ml$/
+          YAMLReader
+        when /\.ini$/
+          INIReader
+        else
+          MarshalReader
+      end
+
+      @file = file
+      @entries = reader.load(file)
+      self
+    end
+
+    def dump(format = :marshal)
+      @entries or Browscapper.load
+
+      Marshal.dump(@entries)
+    end
+
+    def clear_cache
+      MATCH_CACHE.clear
+    end
+
+    def matches(ua)
+      @entries or self.load
+
+      ua_str = ua.downcase
+      ua_len = ua.length
+
+      MATCH_CACHE[ua] ||= @entries.select { |k, v|
+        v[:pattern] =~ ua_str if v
+      }.sort_by { |(k, v)|
+        ua_len - v[:user_agent].gsub(/[?*]/, '').length
+      }.collect { |(k, v)|
+        v
+      }
+    end
+
+    def match(ua)
+      if MATCH_CACHE[ua] && !MATCH_CACHE[ua].empty?
+        MATCH_CACHE[ua].first
+      else
+        m = self.matches(ua)
+        m.first if !m.empty?
+      end
+    end
+    alias :query :match
+  end
+end

data/test/browscapper_tests.rb

@@ -0,0 +1,57 @@
+# encoding: BINARY
+
+$: << './lib'
+
+require 'rubygems'
+require 'minitest/autorun'
+require './lib/browscapper'
+
+class BrowscapperTest < MiniTest::Unit::TestCase
+  FIREFOX_ON_OSX = Browscapper::UserAgent.new({
+    :activex_controls => false,
+    :alpha => false,
+    :aol_version => 0,
+    :background_sounds => false,
+    :beta => false,
+    :browser => "Firefox",
+    :comment => "Firefox 3.6",
+    :cookies => true,
+    :crawler => false,
+    :css_version => 3,
+    :device_name => "unknown",
+    :device_maker => "unknown",
+    :frames => true,
+    :iframes => true,
+    :java_applets => true,
+    :javascript => true,
+    :major_version => 3,
+    :minor_version => 6,
+    :mobile_device => false,
+    :parent => "Firefox 3.6",
+    :platform => "MacOSX",
+    :platform_version => "unknown",
+    :rendering_engine_name => "Gecko",
+    :rendering_engine_version => "unknown",
+    :rendering_engine_description => "For Firefox, Camino, K-Meleon, SeaMonkey, Netscape, and other Gecko-based browsers.",
+    :syndication_reader => false,
+    :tables => true,
+    :user_agent => "Mozilla/5.0 (Macintosh; *; *Mac OS X*; *; rv:1.9.2*) Gecko/* Firefox/3.6*",
+    :user_agent_id => nil,
+    :vbscript => false,
+    :version => "3.6",
+    :win16 => false,
+    :win32 => false,
+    :win64 => false,
+  })
+
+  FIREFOX_ON_OSX.pattern = /^mozilla\/5\.0 \(macintosh; .*; .*mac os x.*; .*; rv:1\.9\.2.*\) gecko\/.* firefox\/3\.6.*$/
+
+  def test_browscap_ini
+    Browscapper.load(File.join('vendor', 'browscap.dump'))
+    match = Browscapper.match('Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10.6; en-US; rv:1.9.2.8) Gecko/20100722 Firefox/3.6.8')
+
+    FIREFOX_ON_OSX.each do |k, v|
+      assert(v == match[k], " Expected #{v.inspect} for #{k}, got #{match[k].inspect}")
+    end
+  end
+end

data/test/reader_tests.rb

@@ -0,0 +1,37 @@
+
+# encoding: BINARY
+
+$: << './lib'
+
+require 'rubygems'
+require 'minitest/autorun'
+require 'minitest/benchmark' if ENV['BENCH']
+require './lib/browscapper'
+require 'benchmark'
+
+class ReaderTests < MiniTest::Unit::TestCase
+  def bench_csv
+    assert_performance_constant do |n|
+      Browscapper.load('vendor/browscap.csv')
+    end
+  end
+
+  def bench_yaml
+    assert_performance_constant do |n|
+      Browscapper.load('vendor/browscap.yml')
+    end
+  end
+
+  def bench_ini
+    assert_performance_constant do |n|
+      Browscapper.load('vendor/browscap.ini')
+    end
+  end
+
+  def bench_marshal
+    assert_performance_constant do |n|
+      Browscapper.load('vendor/browscap.dump')
+    end
+  end
+end
+

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: browscapper
+version: !ruby/object:Gem::Version
+  version: !binary |-
+    MC4wLjE=
+  prerelease: 
+platform: ruby
+authors:
+- J Smith
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: inifile
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A browscap file parser and matcher.
+email: dark.panda@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+files:
+- .gitignore
+- Gemfile
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- browscapper.gemspec
+- lib/browscapper.rb
+- lib/browscapper/reader.rb
+- lib/browscapper/reader/csv_reader.rb
+- lib/browscapper/reader/ini_reader.rb
+- lib/browscapper/reader/marshal_reader.rb
+- lib/browscapper/reader/yaml_reader.rb
+- lib/browscapper/user_agent.rb
+- lib/browscapper/version.rb
+- test/browscapper_tests.rb
+- test/reader_tests.rb
+homepage: http://github.com/dark-panda/browscapper
+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: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A browscap file parser and matcher.
+test_files:
+- test/browscapper_tests.rb
+- test/reader_tests.rb