uaid 0.1.3

data/.gitignore

@@ -0,0 +1,4 @@
+*.sw?
+.DS_Store
+coverage
+pkg/

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Five Points Solutions, Inc.
+
+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

@@ -0,0 +1,10 @@
+uaid
+=========
+
+A small library useful to Rack-based Ruby applications for obtaining
+information about the user agent.
+
+COPYRIGHT
+=========
+
+Copyright (c) 2009 Five Points Solutions, Inc. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,34 @@
+require 'rake'
+require 'rake/rdoctask'
+require 'spec/rake/spectask'
+
+task :default => :spec
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "uaid"
+    s.summary = "A small library useful to Rack-based Ruby applications for obtaining information about the user agent"
+    s.email = "adam@thewilliams.ws"
+    s.homepage = "http://github.com/fivepointssolutions/uaid"
+    s.description = s.summary
+    s.authors = ["Adam Williams"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+desc "Run all specs"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.spec_opts = ['--options', 'spec/spec.opts']
+end
+
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'uaid'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION.yml

@@ -0,0 +1,5 @@
+--- 
+:patch: 3
+:build: 
+:major: 0
+:minor: 1

data/lib/uaid.rb

@@ -0,0 +1,6 @@
+require 'uaid/extractor'
+require 'uaid/user_agent'
+require 'uaid/helper'
+
+module Uaid
+end

data/lib/uaid/extractor.rb

@@ -0,0 +1,116 @@
+module Uaid
+  def Uaid.extractor
+    @extractor ||= Extractor.new
+  end
+  
+  def Uaid.extractor=(e)
+    @extractor = e
+  end
+  
+  class Extractor
+    def engines
+      @engines ||= %w(ie webkit gecko)
+    end
+    
+    def products
+      @products ||= product_extractions.collect {|product,| product}
+    end
+    
+    def extract(agent)
+      product = extract_product(agent)
+      engine = extract_engine(agent, product)
+      version = extract_version(agent, product, engine)
+      [engine, product, version]
+    end
+    
+    protected
+      def extract_product(agent)
+        find_match_in_extractions(agent, product_extractions) || 'unknown'
+      end
+      
+      def extract_engine(agent, product)
+        case extractions = engine_extractions(product)
+        when String: extractions
+        when Array:  find_match_in_extractions(agent, extractions) || 'unknown'
+        when nil:    'unknown'
+        end
+      end
+      
+      def extract_version(agent, product, engine)
+        case extractions = version_extractions(product)
+        when Array
+          match = extractions.detect {|version, regexp| agent =~ regexp}
+          match ? match[0] : 'x'
+        when nil: 'x'
+        end
+      end
+      
+      def product_extractions
+        @product_extractions ||= [
+          ['ie',           [/MSIE/]],
+          ['mobilesafari', [/iPhone.*?Version.*?Safari/]],
+          ['safari',       [/Version.*?Safari/]],
+          ['chrome',       [/Chrome.*?Safari/]],
+          ['firefox',      [/Firefox|BonEcho|Shiretoko/]],
+          ['android',      [/Android/]],
+          ['bot',          [/googlebot|msnbot|ia_archiver/i]],
+          ['noagent',      [/^$/]],
+        ]
+      end
+      
+      def engine_extractions(product)
+        @engine_extractions ||= {
+          'ie'           => 'ie',
+          'safari'       => 'webkit',
+          'mobilesafari' => 'webkit',
+          'chrome'       => 'webkit',
+          'firefox'      => 'gecko',
+          'android'      => 'webkit',
+        }
+        @engine_extractions[product]
+      end
+      
+      def version_extractions(product)
+        @version_extractions ||= {
+          'ie' => [
+            ['7', /MSIE 7/],
+            ['8', /MSIE 8/],
+            ['6', /MSIE 6/],
+          ],
+          'firefox' => [
+            ['3', /Firefox\/3|Shiretoko/],
+            ['2', /Firefox\/2|BonEcho\/2/],
+          ],
+          'safari' => [
+            ['3', /Version\/3/],
+            ['4', /Version\/4/],
+            ['5', /Version\/5/],
+          ],
+          'mobilesafari' => [
+            ['3', /Version\/3/],
+          ],
+          'chrome' => [
+            ['1', /Chrome\/[01]\./],
+          ],
+          'android' => [
+            ['0', /Android 0\./],
+          ]
+        }
+        @version_extractions[product]
+      end
+      
+      # Answers the first matching extraction. Keep this in mind when adding
+      # patterns!
+      #
+      def find_match_in_extractions(agent, extractions)
+        match = nil
+        extractions.each do |answer, patterns|
+          matches = patterns.inject(true) {|m,pattern| m && agent =~ pattern}
+          next unless matches
+          match = answer
+          break
+        end
+        match
+      end
+  end
+end

data/lib/uaid/helper.rb

@@ -0,0 +1,7 @@
+module Uaid
+  module Helper
+    def user_agent
+      @user_agent ||= UserAgent.new(request.headers['user-agent'])
+    end
+  end
+end

data/lib/uaid/user_agent.rb

@@ -0,0 +1,61 @@
+module Uaid
+  def Uaid.supported_agents
+    @supported ||= [
+      /safari [345]/,
+      /chrome/,
+      /firefox [23]/,
+      /ie [678]/,
+      /android/,
+      /bot/
+    ]
+  end
+  
+  # Define the set of supported agents. You may also concat to the existing
+  # list.
+  #
+  def Uaid.supported_agents=(s)
+    @supported = s
+  end
+  
+  class UserAgent
+    attr_reader :agent, :engine, :product, :version, :supported
+    
+    def initialize(agent, extractor = Uaid.extractor)
+      @agent, @extractor = agent, extractor
+      @engine, @product, @version = @extractor.extract(@agent ? @agent.strip : '')
+    end
+    
+    def identifier
+      [engine, product, product + version].join(' ')
+    end
+    
+    def supported?
+      !!Uaid.supported_agents.detect do |agent_match|
+        case agent_match
+        when Array: agent_match == [engine, product, version]
+        when Regexp: [engine, product, version].join(' ') =~ agent_match
+        end
+      end
+    end
+    
+    def unknown?
+      engine == 'unknown' || product == 'unknown' || version == 'x'
+    end
+    
+    def unsupported?
+      !supported?
+    end
+    
+    def version?(e)
+      version == e
+    end
+    
+    def method_missing(method, *args)
+      if method.to_s =~ /^(\w+)\?$/
+        engine == $1 || product == $1
+      else
+        super
+      end
+    end
+  end
+end

data/spec/extractor_spec.rb

@@ -0,0 +1,54 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper.rb')
+
+describe Uaid::Extractor do
+  before :all do
+    @extractor = Uaid::Extractor.new
+  end
+  
+  {
+    ["unknown", "unknown", "x"] => [nil, '', ' '],
+    ["webkit", "safari", "3"] => [
+      "Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10_5_2; en-us) AppleWebKit/526+ (KHTML, like Gecko) Version/3.1.1 Safari/525.18",
+      "Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US) AppleWebKit/525.18 (KHTML, like Gecko) Version/3.1.1 Safari/525.17"],
+    ["webkit", "chrome", "1"] => [
+      "Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US) AppleWebKit/525.13 (KHTML, like Gecko) Chrome/0.A.B.C Safari/525.13",
+      "Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US) AppleWebKit/525.19 (KHTML, like Gecko) Chrome/1.0.154.36 Safari/525.19"],
+    ["webkit", "safari", "4"] => [
+      "Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10_5_6; en-us) AppleWebKit/528.16 (KHTML, like Gecko) Version/4.0 Safari/528.16"],
+    ["webkit", "safari", "5"] => [
+      "Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10_6_3; en-us) AppleWebKit/533.16 (KHTML, like Gecko) Version/5.0 Safari/533.16"],
+    ["gecko", "firefox", "2"] => [
+      "Mozilla/5.0 (Macintosh; U; Intel Mac OS X; en-US; rv:1.8.1.14) Gecko/20080404 Firefox/2.0.0.14",
+      "Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.8.1.6) Gecko/20060601 Firefox/2.0.0.6 (Ubuntu-edgy)",
+      "Mozilla/5.0 (X11; U; Linux i686 (x86_64); en-US; rv:1.8.1.4) Gecko/20080721 BonEcho/2.0.0.4"],
+    ["gecko", "firefox", "3"] => [
+      "Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10.5; en-US; rv:1.9.0.1) Gecko/2008070206 Firefox/3.0.1",
+      "Mozilla/5.0 (X11; U; Linux x86_64; en-US; rv:1.9.1b3pre) Gecko/20090109 Shiretoko/3.1b3pre"],
+    ["ie", "ie", "8"] => [
+      "Mozilla/4.0 (compatible; MSIE 8.0; Windows NT 6.0; WOW64; SLCC1; .NET CLR 2.0.50727; .NET CLR 3.0.04506; Media Center PC 5.0; .NET CLR 1.1.4322)"],
+    ["ie", "ie", "7"] => [
+      "Mozilla/4.0 (compatible; MSIE 7.0; Windows NT 6.0; SLCC1; .NET CLR 2.0.50727; Media Center PC 5.0; .NET CLR 3.0.04506; InfoPath.1)",
+      "Mozilla/4.0 (compatible; MSIE 7.0; Windows NT 5.1; .NET CLR 1.1.4322; .NET CLR 2.0.50727)"],
+    ["ie", "ie", "6"] => [
+      "Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; SV1; .NET CLR 1.1.4322; .NET CLR 2.0.50727)"],
+    ["webkit", "mobilesafari", "3"] => [
+      "Mozilla/5.0 (iPhone; U; XXXXX like Mac OS X; en) AppleWebKit/420+ (KHTML, like Gecko) Version/3.0 Mobile/241 Safari/419.3"],
+    ["webkit", "android", "0"] => [
+      "Mozilla/5.0 (Linux; U; Android 0.5; en-us) AppleWebKit/522+ (KHTML, like Gecko) Safari/419.3"],
+    ["unknown", "unknown", "x"] => [
+      "Mozilla/4.0",
+      "VB Project"],
+    ["unknown", "bot", "x"] => [
+      "ia_archiver",
+      "Mozilla/5.0 (compatible; Googlebot/2.1; +http://www.google.com/bot.html)",
+      "Googlebot/2.1 (+http://www.googlebot.com/bot.html)",
+      "Googlebot/2.1 (+http://www.google.com/bot.html)",
+      "msnbot/1.0 (+http://search.msn.com/msnbot.htm)"]
+  }.each do |expected, agents| agents.each do |agent|
+      
+      it "should identify #{agent.inspect} as #{expected.inspect}" do
+        @extractor.extract(agent).should == expected
+      end
+      
+  end; end
+end

data/spec/helper_spec.rb

@@ -0,0 +1,14 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper.rb')
+require 'ostruct'
+
+describe Uaid::Helper do
+  include Uaid::Helper
+  
+  attr_reader :request
+  
+  it 'should provide a user_agent from the current request' do
+    @request = OpenStruct.new(:headers => {'user-agent' => 'whatever'})
+    user_agent.should_not be_nil
+    user_agent.product.should == 'unknown'
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,7 @@
+--colour
+--format
+progress
+--loadby
+mtime
+--reverse
+--backtrace

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+SPEC_ROOT = File.expand_path(File.dirname(__FILE__))
+$LOAD_PATH << (SPEC_ROOT + '/../lib')
+
+require 'rubygems'
+require 'rr'
+require 'spec'
+
+Spec::Runner.configure do |config|
+  config.mock_with :rr
+end
+
+require 'uaid'

data/spec/user_agent_spec.rb

@@ -0,0 +1,80 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper.rb')
+
+describe Uaid::UserAgent, 'identification questions' do
+  before do
+    @user_agent = Uaid::UserAgent.new('unknown')
+  end
+  
+  after do
+    Uaid.supported_agents = nil
+  end
+  
+  [
+    ['unknown', 'bot', '1'],
+    ['webkit', 'unknown', '1'],
+    ['webkit', 'bot', 'x'],
+  ].each do |attributes|
+    engine, product, version = attributes
+    it "should answer true for unknown when unknown as #{attributes.inspect}" do
+      user_agent = Uaid::UserAgent.new('unknown')
+      stub(@user_agent).engine { engine }
+      stub(@user_agent).product { product }
+      stub(@user_agent).version { version }
+      @user_agent.unknown?.should be_true
+    end
+  end
+  
+  it 'should answer false for unknown when all attributes are known' do
+    stub(@user_agent).engine { 'someengine' }
+    stub(@user_agent).product { 'someproduct' }
+    stub(@user_agent).version { '1' }
+    @user_agent.unknown?.should be_false
+  end
+  
+  it 'should answer for engine' do
+    stub(@user_agent).engine { 'someengine' }
+    @user_agent.someengine?.should be_true
+    @user_agent.otherengine?.should be_false
+  end
+  
+  it 'should answer for product' do
+    stub(@user_agent).product { 'someproduct' }
+    @user_agent.someproduct?.should be_true
+    @user_agent.otherproduct?.should be_false
+    
+    stub(@user_agent).product { 'noagent' }
+    @user_agent.bot?.should be_false
+  end
+  
+  it 'should answer for version' do
+    stub(@user_agent).version { '2' }
+    @user_agent.version?('2').should be_true
+  end
+  
+  it 'should answer an identifier which include the engine, product and version' do
+    stub(@user_agent).engine { 'someengine' }
+    stub(@user_agent).product { 'someproduct' }
+    stub(@user_agent).version { '1' }
+    @user_agent.identifier.should == 'someengine someproduct someproduct1'
+  end
+  
+  it 'should answer supported as true when all attributes match a supported agent' do
+    stub(@user_agent).engine { 'webkit' }
+    stub(@user_agent).product { 'safari' }
+    stub(@user_agent).version { '3' }
+    @user_agent.should be_supported
+  end
+  
+  it 'should answer supported when an entry in the supported list is a regular expression' do
+    Uaid.supported_agents = [/safari [34]/]
+    stub(@user_agent).product { 'safari' }
+    stub(@user_agent).version { '3' }
+    @user_agent.should be_supported
+    
+    stub(@user_agent).version { '4' }
+    @user_agent.should be_supported
+    
+    stub(@user_agent).version { '2' }
+    @user_agent.should_not be_supported
+  end
+end

data/uaid.gemspec

@@ -0,0 +1,58 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{uaid}
+  s.version = "0.1.3"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Adam Williams"]
+  s.date = %q{2010-06-17}
+  s.description = %q{A small library useful to Rack-based Ruby applications for obtaining information about the user agent}
+  s.email = %q{adam@thewilliams.ws}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README"
+  ]
+  s.files = [
+    ".gitignore",
+     "LICENSE",
+     "README",
+     "Rakefile",
+     "VERSION.yml",
+     "lib/uaid.rb",
+     "lib/uaid/extractor.rb",
+     "lib/uaid/helper.rb",
+     "lib/uaid/user_agent.rb",
+     "spec/extractor_spec.rb",
+     "spec/helper_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "spec/user_agent_spec.rb",
+     "uaid.gemspec"
+  ]
+  s.homepage = %q{http://github.com/fivepointssolutions/uaid}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{A small library useful to Rack-based Ruby applications for obtaining information about the user agent}
+  s.test_files = [
+    "spec/extractor_spec.rb",
+     "spec/helper_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/user_agent_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification 
+name: uaid
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 3
+  version: 0.1.3
+platform: ruby
+authors: 
+- Adam Williams
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-17 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: A small library useful to Rack-based Ruby applications for obtaining information about the user agent
+email: adam@thewilliams.ws
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README
+files: 
+- .gitignore
+- LICENSE
+- README
+- Rakefile
+- VERSION.yml
+- lib/uaid.rb
+- lib/uaid/extractor.rb
+- lib/uaid/helper.rb
+- lib/uaid/user_agent.rb
+- spec/extractor_spec.rb
+- spec/helper_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/user_agent_spec.rb
+- uaid.gemspec
+has_rdoc: true
+homepage: http://github.com/fivepointssolutions/uaid
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A small library useful to Rack-based Ruby applications for obtaining information about the user agent
+test_files: 
+- spec/extractor_spec.rb
+- spec/helper_spec.rb
+- spec/spec_helper.rb
+- spec/user_agent_spec.rb