wurfl 1.1.2 → 1.2.0

data/README.rdoc

@@ -1,153 +1,167 @@
-= WURFL
-
-WURFL is a collection of libraries and command line tools for using and manipulating the WURFL.  To start using it, simply install the gem:
-
-  sudo gem install wurfl
-
-== Tools
-
-All tools are run via wurfltools.rb
-
-=== loader
-
-Is used to parse and load a WURFL XML file into memory or save a
-PStore database that is used by most of the other tools.  This
-application creates WURFL PStore databases that are essential for use
-with the other Ruby applications.
-
-=== inspector
-
-Is a tool that will let you do various searches and queries on the
-WURFL.  This is a very simple, yet powerful program for finding
-information about the handsets in the WURFL.  See the wurflinspector
-examples section for usage.
-
-==== Usage
-
-The command below will search through all handsets and return the ids
-of handsets that match the passed Ruby boolean evaluation
-
-This command will return all handsets that have more than 2 colors.
-
-  wurfltools.rb inspector -d pstorehandsets.db -s '{ |hand| hand["colors"].to_i > 2 }'"
-
-The Ruby query must go in between the single quote marks and needs to
-declare the WurflHandset instance variable name.
-
-This command shows you how you can cheat with the current design of
-the wurflinspector and print more user friendly results.  This example
-assumes you have the command line programs sort and uniq, but that is
-only to make the output look better. This example does the same as the
-above, except that it prints out the brand name and model name of the
-matching handsets instead of the WURFL id.
-
-Note: this should all go into one command line call
-
-  wurfltools.rb inspector -d pstorehandsets.db -s '{|hand| puts
-  "#{hand["brand_name"]} #{hand["model_name"]}" if hand["colors"].to_i >
-  2}' | sort | uniq"
-
-
-The following individual handset query commands will tell the value of
-capabilities and from where it obtained the setting.
-
-A command to query the handset with the id sonyericsson_t300_ver1
-for all of its' capabilities:
-
-  wurfltools.rb inspector -d pstorehandsets.db -i sonyericsson_t300_ver1
-
-A command to query the handset with the id sonyericsson_t300_ver1 for
-backlight capability:
-
-  wurfltools.rb inspector -d pstorehandsets.db -i sonyericsson_t300_ver1 -q
-  backlight
-
-=== sanitycheck
-
-Is a partial WURFL validating program.  It does a few simple
-checks to make sure the XML structure is parse-able by the wurflloader.
-If you receive loading errors by the wurflloader, then you can run the
-wurflsanitycheck program to find the lines in the XML file that might
-be causing the problem.
-
-=== comparator
-
-Is a another simple program that will find the differences from two
-WURFL Ruby PStore databases. This is another way of finding changes
-from the different versions of the WURFL without running a diff on the
-XML files.
-
-=== uaproftowurfl
-
-Is a program that takes UAProfiles and creates an equivalent WURFL
-entry.  It holds all of the mappings used to convert a UAProfile to a
-WURFL entry.  This program alone makes using the Ruby tools worth it.
-
-The mappings are not fully complete and can certainly use your input
-in improving them.
-
-About the source code:
-The main piece of code to read are the methods under the 
-"UAProfile Mappings" comment.
-
-For now you can ignore the details above this comment.
-Basically each method is the name of a UAProfifle component.
-When you parse a UAProfile file it will call each UAProfile
-component's method name.  
-
-So you can simply look at UAProfile component's method to see 
-how it maps to the WURFL.
-If a component is not found as a method it will be logged to 
-Standard Error.  For this log one can then add the method to
-the UAProfToWurfl class later.
-
-==== Usage
-
-A simple usage is:
-
-  wurfltools.rb uaproftowurfl sampleprofile.xml
-
-Example use from a bash shell with many profiles:
-
-  for i in `ls profiles`; do 
-    wurfltools.rb uaproftowurfl profiles/$i >output/$i.wurfl 
-    2> output/$i.parser.err; 
-  done
-
-This assumes that you have a profiles directory with all of the UAProf
-file you wish to parse and a output directory to place the results and
-errors.
-
-=== uaprofwurflcomparator
-
-Is a program that compares UAProfiles against the equivalent WURFL
-entries. It takes a file that contains an UAProfile URL and an
-User-Agent per line, in addition to a Ruby Wurfl PStore database. It
-then compares the UAProfile against the Wurfl that matches the same
-User Agent.  The output is a list of the differences and a WURFL
-formatted entry showing the differences.
-
-==== Usage
-
-You pass the program a directory to save the UAProfile files taken
-from the given URL, a file that holds the UAProfil URL and User-Agent
-mappings, and the Ruby PStore database that holds the WURFL. 
-
-The following is a simple example of execution
-
-  wurfltools.rb uaprofwurflcomparator -d ./profiles -f all-profile.2003-08.log -c -w wurfl.db
-
-== Authors
-
-* Zev Blut (Original Author)
-* Paul McMahon (gem installer, refactorings)
-
-== Copyright
-
-Copyright (c) 2009, mobalean (http://www.mobalean.com/)
-
-Copyright (c) 2003, Ubiquitous Business Technology (http://ubit.com)
-All rights reserved.
-
-Send enquiries to: mailto:info@mobalean.com
-
+= WURFL
+
+WURFL is a collection of libraries and command line tools for using and manipulating the WURFL.  To start using it, simply install the gem:
+
+  sudo gem install wurfl
+
+== Tools
+
+All tools are run via wurfltools.rb
+
+=== loader
+
+Is used to parse and load a WURFL XML file into memory or save a
+PStore database that is used by most of the other tools.  This
+application creates WURFL PStore databases that are essential for use
+with the other Ruby applications.
+
+=== inspector
+
+Is a tool that will let you do various searches and queries on the
+WURFL.  This is a very simple, yet powerful program for finding
+information about the handsets in the WURFL.  See the wurflinspector
+examples section for usage.
+
+==== Usage
+
+The command below will search through all handsets and return the ids
+of handsets that match the passed Ruby boolean evaluation
+
+This command will return all handsets that have more than 2 colors.
+
+  wurfltools.rb inspector -d pstorehandsets.db -s '{ |hand| hand["colors"].to_i > 2 }'"
+
+The Ruby query must go in between the single quote marks and needs to
+declare the WurflHandset instance variable name.
+
+This command shows you how you can cheat with the current design of
+the wurflinspector and print more user friendly results.  This example
+assumes you have the command line programs sort and uniq, but that is
+only to make the output look better. This example does the same as the
+above, except that it prints out the brand name and model name of the
+matching handsets instead of the WURFL id.
+
+Note: this should all go into one command line call
+
+  wurfltools.rb inspector -d pstorehandsets.db -s '{|hand| puts
+  "#{hand["brand_name"]} #{hand["model_name"]}" if hand["colors"].to_i >
+  2}' | sort | uniq"
+
+
+The following individual handset query commands will tell the value of
+capabilities and from where it obtained the setting.
+
+A command to query the handset with the id sonyericsson_t300_ver1
+for all of its' capabilities:
+
+  wurfltools.rb inspector -d pstorehandsets.db -i sonyericsson_t300_ver1
+
+A command to query the handset with the id sonyericsson_t300_ver1 for
+backlight capability:
+
+  wurfltools.rb inspector -d pstorehandsets.db -i sonyericsson_t300_ver1 -q
+  backlight
+
+=== uamatch
+
+Is a tool that will let you do various searches and queries on the
+WURFL based on user-agent strings.  This is a very simple, yet powerful 
+program for finding information about the handsets in the WURFL.  
+See the uamatch examples section for usage.
+
+The uamatcher will retrieve the handset descriptions with the closest 
+Levenshtein distance (also called the edit distance) to the user-agent
+string you pass as argument.  
+
+For details see:  http://en.wikipedia.org/wiki/Levenshtein_distance
+
+When more than one handset has the same distance to the user agent string queried,
+the command will iterate over the result set and print the result for each handset.
+
+The found wurfl_ids can serve as input to the inspector command.  
+You can also specifically query for a certain capability. 
+
+==== Usage
+
+The following individual handset query commands will tell the value of
+capabilities and from where it obtained the setting.
+
+A command to query the handset with the user-agent SL55 for all of its capabilities:
+
+  wurfltools.rb uamatch -d pstorehandsets.db -u SL55
+
+A command to query the handset with the id SL55 for the wallpaper_jpg capability:
+
+  wurfltools.rb uamatch -d pstorehandsets.db -u SL55 -q wallpaper_jpg
+
+=== sanitycheck
+
+Is a partial WURFL validating program.  It does a few simple
+checks to make sure the XML structure is parse-able by the wurflloader.
+If you receive loading errors by the wurflloader, then you can run the
+wurflsanitycheck program to find the lines in the XML file that might
+be causing the problem.
+
+=== comparator
+
+Is a another simple program that will find the differences from two
+WURFL Ruby PStore databases. This is another way of finding changes
+from the different versions of the WURFL without running a diff on the
+XML files.
+
+=== uaproftowurfl
+
+Is a program that takes UAProfiles and creates an equivalent WURFL
+entry.  It holds all of the mappings used to convert a UAProfile to a
+WURFL entry.  This program alone makes using the Ruby tools worth it.
+
+The mappings are not fully complete and can certainly use your input
+in improving them.
+
+About the source code:
+The main piece of code to read are the methods under the 
+"UAProfile Mappings" comment.
+
+For now you can ignore the details above this comment.
+Basically each method is the name of a UAProfifle component.
+When you parse a UAProfile file it will call each UAProfile
+component's method name.  
+
+So you can simply look at UAProfile component's method to see 
+how it maps to the WURFL.
+If a component is not found as a method it will be logged to 
+Standard Error.  For this log one can then add the method to
+the UAProfToWurfl class later.
+
+==== Usage
+
+A simple usage is:
+
+  wurfltools.rb uaproftowurfl sampleprofile.xml
+
+Example use from a bash shell with many profiles:
+
+  for i in `ls profiles`; do 
+    wurfltools.rb uaproftowurfl profiles/$i >output/$i.wurfl 
+    2> output/$i.parser.err; 
+  done
+
+This assumes that you have a profiles directory with all of the UAProf
+file you wish to parse and a output directory to place the results and
+errors.
+
+== Authors
+
+* Zev Blut (Original Author)
+* Paul McMahon (gem installer, refactorings)
+* Kai W. Zimmermann (uamatch)
+
+== Copyright
+
+Copyright (c) 2009, mobalean (http://www.mobalean.com/)
+
+Copyright (c) 2003, Ubiquitous Business Technology (http://ubit.com)
+All rights reserved.
+
+Send enquiries to: mailto:info@mobalean.com
+

data/VERSION

@@ -1 +1 @@
-1.1.2
+1.2.0

data/lib/wurfl/command/comparator.rb

@@ -13,10 +13,11 @@ class Wurfl::Command::Comparator < Wurfl::Command
 
   def display_differences(hand1, hand2)
     puts "-------------------------------------"
-    puts "Handset: #{hand1.user_agent} :ID: #{hand1.wurfl_id}"
-    hand1.keys.each do |key|
+    puts "WURFL_ID: #{hand1.wurfl_id}" 
+    puts "Handset 1: #{hand1.user_agent}"
+    puts "Handset 2: #{hand2.user_agent}"
+    hand1.differences(hand2).each do |key|
       v1, v2 = hand1[key], hand2[key]
-      next if v1.nil? || v2.nil? || v1 == v2
       puts "Key:#{key}"
       puts "h1>:#{hand1[key]}"
       puts "h2<:#{hand2[key]}"
@@ -49,40 +50,22 @@ class Wurfl::Command::Comparator < Wurfl::Command
     puts "Comparing files: #{ARGV[0]} and #{ARGV[1]}"
     puts "-------------------------------------"
 
-    if wurfl1.size > wurfl2.size
-      mwurfl = wurfl1
-      lwurfl = wurfl2    
-    else
-      mwurfl = wurfl2
-      lwurfl = wurfl1
-    end
-
-    notfound = Array.new
-    different = Array.new
-    mwurfl.each do |key,handset|
-      if lwurfl.key?(key)
-        if handset != lwurfl[key]
-          different << [handset,lwurfl[key]]
-          display_differences(handset,lwurfl[key])
-        end
-      else
-        notfound<< handset
+    wurfl1_unknown, wurfl2_unknown, different = [],[],[]
+    (wurfl1.keys | wurfl2.keys).each do |key|
+      handset1, handset2 = wurfl1[key], wurfl2[key]
+      if !handset1
+        wurfl1_unknown << key
+      elsif !handset2
+        wurfl2_unknown << key
+      elsif handset1 != handset2
+        display_differences(handset1,handset2)
       end
     end
 
 
     puts "Comparision complete."
 
-    puts "Not Found Handsets: #{notfound.size}"
-    puts "||||||||||||||||||||||||||||||||||||"
-    notfound = notfound.sort { |x,y| y.wurfl_id <=> x.wurfl_id }
-    notfound.each { |hand| puts hand.wurfl_id }           
-    puts "||||||||||||||||||||||||||||||||||||"
-
-    puts "Different handsets: #{different.size}"
-    puts "||||||||||||||||||||||||||||||||||||"
-    different = different.sort { |x,y| y.first.wurfl_id <=> x.first.wurfl_id }
-
-    puts "||||||||||||||||||||||||||||||||||||"
+    puts "Handsets not found in wurfl1: #{wurfl1_unknown.inspect}"
+    puts "Handsets not found in wurfl2: #{wurfl2_unknown.inspect}"
   end
 end

data/lib/wurfl/command/uamatch.rb

@@ -0,0 +1,82 @@
+require "wurfl/command"
+require "wurfl/utils"
+require "wurfl/handset"
+require "wurfl/user_agent_matcher"
+require "getoptlong"
+
+=begin
+  The uamatch command itself is based on the inspector command found in this
+  library.
+  
+  Author:  Kai W. Zimmermann (kwz@kai-zimmermann.de)
+=end
+class Wurfl::Command::Uamatch < Wurfl::Command
+  include Wurfl::Utils
+
+  def usage
+    puts "Usage: wurfltools.rb uamatch [-u user_agent [-q attributename]] -d pstorefile"
+    puts "Examples:"
+    puts "wurfltools.rb uamatch -d pstorehandsets.db -u SL55"
+    puts "wurfltools.rb uamatch -d pstorehandsets.db -u SL55 -q wallpaper_jpg"
+    exit 1
+  end
+
+  def execute
+    pstorefile = nil
+    useragent = nil
+    query = nil
+    begin
+      opt = GetoptLong.new(
+                           ["-d","--database", GetoptLong::REQUIRED_ARGUMENT],
+                           ["-u","--useragent", GetoptLong::REQUIRED_ARGUMENT],
+                           ["-q","--query", GetoptLong::REQUIRED_ARGUMENT]
+                           )
+      
+      opt.each do |arg,val|
+        case arg
+        when "-d"
+          pstorefile = val
+        when "-u"
+          useragent = val
+        when "-q"
+          query = val
+        else
+          usage
+        end
+      end
+
+    rescue => err
+      usage
+    end
+
+    if !pstorefile
+      puts "You must specify a Wurfl PStore db"
+      usage
+    end
+
+    begin
+      handsets, = load_wurfl_pstore(pstorefile)    
+      puts "Number of Handsets: #{handsets.length}"
+      uamatch = Wurfl::UserAgentMatcher.new(handsets)
+    rescue => err
+      STDERR.puts "Error with file #{pstorefile}"
+      STDERR.puts err.message
+      exit 1
+    end
+
+    if useragent 
+      matches, distance = uamatch.match_handsets(useragent)
+      puts "Shortest distance #{distance}, #{matches.length} match#{'es' if (matches.length!=1)}" 
+      matches.each do |handset|
+        puts "Handset wurfl id: #{handset.wurfl_id}"
+        puts "User_agent found: #{handset.user_agent}"
+        if query
+          puts "Result of handset query: #{query}"
+          rez = handset.get_value_and_owner(query)
+          puts "#{rez[0]} from #{rez[1]}"
+        end
+      end
+      exit 0
+    end
+  end
+end

data/lib/wurfl/handset.rb

@@ -86,24 +86,9 @@ class Wurfl::Handset
       other.keys.all? {|key| other[key] == self[key] }
   end
 
-  # A method to compare a handset's values against another handset.
-  # Parameters:
-  # other: is the another WurflHandset to compare against
-  # Returns:
-  # An array of the different values.
-  # Each entry in the Array is an Array of three values.
-  # The first value is the key in which both handsets have different values.
-  # The second is the other handset's value for the key.
-  # The third is the handset id from where the other handset got it's value.
-  def compare(other)
-    differences = Array.new
-    self.keys.each do |key|
-      oval,oid = other.get_value_and_owner(key)
-      if @capabilityhash[key].to_s != oval.to_s
-	differences << [key,oval,oid]
-      end
-    end
-    differences
+  def differences(other)
+    keys = (self.keys | other.keys)
+    keys.find_all {|k| self[k] != other[k]}
   end
 
   class NullHandset

data/lib/wurfl/user_agent_matcher.rb

@@ -0,0 +1,142 @@
+module Wurfl; end
+
+=begin
+  A class that lists wurfl handsets that match user_agents using the shortest 
+  Levenshtein distance, also sometimes called the edit distance, 
+  see http://en.wikipedia.org/wiki/Levenshtein_distance
+
+  The implementation of the Levenshtein distance used here is based on the
+  algorithm found in the Text gem originally written by Paul Battley
+  (pbattley@gmail.com)
+   
+  The implementation given here makes heavy use of optimizations based on 
+  the estimation of the lower bound that can be achieved.  Depending on the 
+  length of the user agent this brought an over all increase by a factor of
+  about 40, although it renders the code slightly unreadable.  In general the
+  longer the user agent string and the greater the result distance, the longer
+  the computation takes.  
+  
+  Author:  Kai W. Zimmermann (kwz@kai-zimmermann.de)
+=end
+class Wurfl::UserAgentMatcher
+  # Constructor
+  # Parameters:
+  # handsets: A hashtable of wurfl handsets indexed by wurfl_id.
+  def initialize(handsets)
+    @handsets = handsets
+    @longest_user_agent_length = @handsets.values.inject(0) do |m,hand| 
+      hand.user_agent.length > m ? hand.user_agent.length : m
+    end
+    @d=(0..@longest_user_agent_length).to_a
+  end
+
+  # A method to retrieve a list of the uamatcher's handsets that match
+  # the passed user_agent closest using the Levenshtein distance.
+  # Parameters:
+  # user_agent: is a user_agent string to be matched
+  # Returns:
+  # An Array of all WurflHandsets that match the user_agent closest with the 
+  # same distance
+  # The Levenshtein distance for these matches
+  def match_handsets(user_agent)
+    rez = []
+    shortest_distance = [user_agent.length, @longest_user_agent_length].max
+    s = user_agent.unpack(unpack_rule)
+
+    @handsets.values.each do |hand|    
+      distance = levenshtein_distance(user_agent, hand.user_agent, shortest_distance, s)
+      # found a shorter distance match, flush old results 
+      rez.clear if shortest_distance > distance
+
+      if shortest_distance >= distance
+        # always add the first handset matched and each that has the same 
+        # distance as the shortest distance so far 
+        rez << hand
+        shortest_distance = distance
+      end
+
+      break if shortest_distance == 0
+    end
+
+    return rez, shortest_distance 
+  end
+
+  private
+  
+  # A method to estimate and compute the Levenshtein distance (LD) based on the
+  # implementation from the Text gem. The implementation given here applies 
+  # known upper and lower bounds as found at: 
+  # http://en.wikipedia.org/wiki/Levenshtein_distance 
+  # LD is always at least the difference of the sizes of the two strings.
+  #  -> We can safely discard the handset if the least distance is longer than 
+  #     the current shortest distance
+  # LD is zero if and only if the strings are identical.
+  #  -> We can optimize the test for equality and stop searching after an exact
+  #     match
+  # Parameters:
+  # str1: is the user-agent to look up
+  # str2: is the user-agent to compare against
+  # min: is the minimum distance found so far
+  # s: the unpacked version of the user-agent string we look up
+  # Returns:
+  # It returns the least bound estimation if the least bound is already greater
+  # than the current minimum distance
+  # Otherwise it will compute the Levenshtein distance of str1 and str2
+  # It optimizes the check for equality
+  def levenshtein_distance(str1, str2, min, s)
+    diff = (str1.length - str2.length).abs
+    return 0 if diff == 0 && str1 == str2
+    return diff if diff > min
+    t = str2.unpack(unpack_rule)
+    distance(s, t, min)
+  end
+
+  # Compute the Levenshtein distance or stop if the minimum found so far will 
+  # be exceeded.
+  # Optimizations:  Avoid GC, where possible reuse array
+  # The distance computation in the outer loop is monotonously decreasing thus
+  # we can safely stop if the estimated possible minimum exceeds the current
+  # minimum
+  # Parameters:
+  # s: is the first string, already unpacked
+  # t: is the second string, already unpacked
+  # min: is the minimum distance found so far
+  # Returns:
+  # The routine returns the computed distance or the minimum found so far if the  # distance 
+  # computed so far exceeds the minimum
+  def distance(s, t, min)
+    n = s.length
+    m = t.length
+    return m if 0 == n
+    return n if 0 == m
+
+    d = @d # Optimization: Avoid GC by reusing array
+    (0...m).each do |j|
+      d[j] = j
+    end
+
+    x = 0
+    (0...n).each do |i|
+      e = i+1
+      (0...m).each do |j|
+        cost = (s[i] == t[j]) ? 0 : 1
+        x = d[j+1] + 1 # insertion
+        y = e+1
+        x = y if y < x # deletion
+        z = d[j] + cost
+        x = z if z < x # substitution
+        d[j] = e
+        e = x
+      end
+      d[m] = x
+      # estimate the minimum LD that still can be achieved, this will be
+      # increasing monotonously stop once we exceed the current minimum
+      return x - n + i + 1 if x - n + i + 1 > min
+    end
+    x
+  end
+
+  def unpack_rule
+    $KCODE =~ /^U/i ? 'U*' : 'C*'
+  end
+end

data/test/handset_test.rb

@@ -6,6 +6,9 @@ class TestHandset < Test::Unit::TestCase
   def setup
     @f = Wurfl::Handset.new("f", "f", nil)
     @h = Wurfl::Handset.new("h", "h", @f)
+    
+    @f2 = Wurfl::Handset.new("f2", "f2_ua", nil)
+    @h2 = Wurfl::Handset.new("h2","h2_ua", @f2)
   end
 
   def test_f
@@ -51,20 +54,34 @@ class TestHandset < Test::Unit::TestCase
     assert @h == h2
   end
 
-  def test_compare
-    f2 = Wurfl::Handset.new("f2", "f2", nil)
-    h2 = Wurfl::Handset.new("h2","h2", f2)
-    assert @h.compare(@f).empty?
+  def test_differences_handset_with_unmodified_fallback
+    assert @h.differences(@f).empty?
+  end
+
+  def test_differences_handset_with_identical_handset
+    assert @h.differences(@h2).empty?
+  end
+
+  def test_differences_handset_that_has_extra_key
     @h["k"] = "v"
+    assert_equal ["k"], @h.differences(@h2)
+  end
 
-    assert_equal [["k", nil, nil]], @h.compare(h2)
+  def test_differences_other_handset_that_has_extra_key
+    @h2["k"] = "v"
+    assert_equal ["k"], @h.differences(@h2)
+  end
 
-    h2["k"] = "v2"
-    assert_equal [["k", "v2", "h2"]], @h.compare(h2)
+  def test_differences_handset_that_has_differing_key_value
+    @h["k"] = "v"
+    @h2["k"] = "v2"
+    assert_equal ["k"], @h.differences(@h2)
+  end
 
+  def test_differences_handsets_with_differening_fallback_key_value
     @f["j"] = "1"
-    f2["j"] = "2"
-    assert_equal [["k", "v2", "h2"], ["j", "2", "f2"]], @h.compare(h2)
+    @f2["j"] = "2"
+    assert_equal ["j"], @h.differences(@h2)
   end
 
 end

data/test/user_agent_matcher_test.rb

@@ -0,0 +1,34 @@
+$LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'lib')
+require 'wurfl/user_agent_matcher'
+require 'wurfl/loader'
+require 'test/unit'
+
+class UserAgentMatcherTest < Test::Unit::TestCase
+  def setup
+    loader = Wurfl::Loader.new
+    handsets, fallbacks = loader.load_wurfl(File.join(File.dirname(__FILE__), "data", "wurfl.simple.xml"))
+    @matcher = Wurfl::UserAgentMatcher.new(handsets)
+  end
+
+  def test_empty_user_agent
+    a, shortest_distance = @matcher.match_handsets("")
+    assert_equal 1, a.size
+    assert_equal "generic_xhtml", a.first.wurfl_id
+    assert_equal 4, shortest_distance
+  end
+
+  def test_matching_user_agent
+    a, shortest_distance = @matcher.match_handsets("generic")
+    assert_equal 1, a.size
+    assert_equal "generic", a.first.wurfl_id
+    assert_equal 0, shortest_distance
+  end
+
+  def test_iphone
+    s = "Mozilla/5.0 (iPhone; U; CPU like Mac OS X; en)"
+    a, shortest_distance = @matcher.match_handsets(s)
+    assert_equal 1, a.size
+    assert_equal "apple_generic", a.first.wurfl_id
+    assert_equal 26, shortest_distance
+  end
+end

data/wurfl.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{wurfl}
-  s.version = "1.1.2"
+  s.version = "1.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Paul McMahon", "Zev Blut"]
-  s.date = %q{2009-07-13}
+  s.date = %q{2009-07-22}
   s.default_executable = %q{wurfltools.rb}
   s.description = %q{TODO}
   s.email = %q{info@mobalean.com}
@@ -27,15 +27,17 @@ Gem::Specification.new do |s|
      "lib/wurfl/command/inspector.rb",
      "lib/wurfl/command/loader.rb",
      "lib/wurfl/command/sanitycheck.rb",
+     "lib/wurfl/command/uamatch.rb",
      "lib/wurfl/command/uaproftowurfl.rb",
-     "lib/wurfl/command/uaprofwurflcomparator.rb",
      "lib/wurfl/handset.rb",
      "lib/wurfl/loader.rb",
      "lib/wurfl/uaproftowurfl.rb",
+     "lib/wurfl/user_agent_matcher.rb",
      "lib/wurfl/utils.rb",
      "test/data/wurfl.simple.xml",
      "test/handset_test.rb",
      "test/loader_test.rb",
+     "test/user_agent_matcher_test.rb",
      "test/utils_test.rb",
      "wurfl.gemspec"
   ]
@@ -49,7 +51,8 @@ Gem::Specification.new do |s|
   s.test_files = [
     "test/loader_test.rb",
      "test/handset_test.rb",
-     "test/utils_test.rb"
+     "test/utils_test.rb",
+     "test/user_agent_matcher_test.rb"
   ]
 
   if s.respond_to? :specification_version then

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: wurfl
 version: !ruby/object:Gem::Version 
-  version: 1.1.2
+  version: 1.2.0
 platform: ruby
 authors: 
 - Paul McMahon
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-13 00:00:00 +09:00
+date: 2009-07-22 00:00:00 +09:00
 default_executable: wurfltools.rb
 dependencies: []
 
@@ -35,15 +35,17 @@ files:
 - lib/wurfl/command/inspector.rb
 - lib/wurfl/command/loader.rb
 - lib/wurfl/command/sanitycheck.rb
+- lib/wurfl/command/uamatch.rb
 - lib/wurfl/command/uaproftowurfl.rb
-- lib/wurfl/command/uaprofwurflcomparator.rb
 - lib/wurfl/handset.rb
 - lib/wurfl/loader.rb
 - lib/wurfl/uaproftowurfl.rb
+- lib/wurfl/user_agent_matcher.rb
 - lib/wurfl/utils.rb
 - test/data/wurfl.simple.xml
 - test/handset_test.rb
 - test/loader_test.rb
+- test/user_agent_matcher_test.rb
 - test/utils_test.rb
 - wurfl.gemspec
 has_rdoc: true
@@ -76,3 +78,4 @@ test_files:
 - test/loader_test.rb
 - test/handset_test.rb
 - test/utils_test.rb
+- test/user_agent_matcher_test.rb

data/lib/wurfl/command/uaprofwurflcomparator.rb

@@ -1,224 +0,0 @@
-require "wurfl/command"
-require "getoptlong"
-require "net/http"
-
-require "wurfl/uaproftowurfl"
-require "wurfl/handset"
-require "wurfl/utils"
-include Wurfl::Utils
-
-# An addition to the UAProf to Wurfl to generate a WurflHandset from the UAProf.      
-class Wurfl::UAProfToWURLF
-  def make_wurfl_handset
-    hand = Wurfl::Handset.new("UAProf",@wurfl["user_agent"])
-    @wurflgroups.each do |group|
-      @wurfl[group].sort.each do |key,value|
-	hand[key] =  value
-      end
-    end
-    return hand
-  end
-end
-
-
-class Wurfl::Command::Uaprofwurflcomparator
-  def parse_mapping_file(file)
-    if !File.exist?(file)
-      $stderr.puts "Mapping File does not exist.  File passed was #{file}."
-      return Array.new
-    end
-    mappings = Array.new
-    f = File.new(file)
-    f.each do |line|
-      if m = /^"(.*)" "(.*)"$/.match(line.strip)
-        uaprof = m[1]
-        useragent = m[2]
-        mappings<< [uaprof,useragent]
-      else
-        $stderr.puts "Irregular format for line: #{line}" if line.strip != ""
-      end
-    end
-    f.close
-
-    return mappings
-  end
-
-  def get_uaprofile(uaprof,profiledir,check=false)
-    file = strip_uaprof(uaprof)
-    if File.exists?("#{profiledir}/#{file}") && check
-      return file
-    end
-    
-    get_and_save_uaprof_file(uaprof,profiledir)
-    return file
-  end
-
-  def strip_uaprof(uaprof)
-    uaprof_file = nil
-    if m = /([^\/]*)$/.match(uaprof)
-      uaprof_file = m[1]
-    else
-      $stderr.puts "Cannot find the base UAProf file in URI: #{uaprof}"
-    end
-    return uaprof_file
-  end
-
-  def load_pstore(pstorefile)
-    hands = Hash.new
-    begin
-      handsid, = load_wurfl_pstore(pstorefile)
-      handsid.each { |id,val| hands[val.user_agent] = val }
-    rescue => err
-      $stderr.puts "Error: Cannot load PStore file. #{pstorefile}"
-      $stderr.puts err.message
-      exit 1
-    end
-    return hands
-  end
-
-  def get_and_save_uaprof_file(uaprof_url,savedirectory,limit=0)
-    base,path,port = parse_url(uaprof_url)
-    
-    raise "Too many redirects from original url" if limit > 3
-    raise "Unparseable URL: #{url}" if base.nil?
-
-    port = 80 if port.nil?
-    http = Net::HTTP.new(base,port)
-    begin
-      resp, data = http.get(path)
-      if resp.code == "301"
-        # get location and call self again
-        http.finish
-        limit += 1
-        get_and_save_uaprof_file(resp['location'],savedirectory,limit)
-        return
-      elsif resp.code != "200"
-        raise "Unexpected HTTP Response code:#{resp.code} for #{uaprof_url}"
-      end
-    rescue => err
-      raise
-    end
-
-    f = File.new("#{savedirectory}/#{strip_uaprof(path)}","w")
-    f.write(data)  
-    f.close
-    
-  end
-
-  def parse_url(url)
-    m = /(http:\/\/)?(.*?)(:(\d*))?\/(.*)/i.match(url.strip)
-    
-    return nil if m.nil?
-    return m[2],"/#{m[5]}",m[4]
-  end
-
-  def usage
-    puts "Usage: wurfltools.rb uaprofwurflcomparator -d profiledirectory -f mappingfile [-w wurfldb] [-c] [-h | --help]"
-    puts "Examples:"
-    puts "wurfltools.rb uaprofwurflcomparator -d ./profiles -f all-profile.2003-08.log -c -w wurfl.db"
-    exit 1
-  end
-
-  def help
-    puts "-d --directory : The directory to store the UA Profiles found in the log file."
-    puts "-f --file : The log file that has a UAProfile to User-Agent mapping per line."
-    puts "-c --check : A flag that will make sure to check if the profile is already in the directory or not.  If it is not then it will download it."
-    puts "-w --wurfldb : A Ruby PStore Database of the WURFL, that is used to compare against the UAProfiles."
-    puts "-h --help : This message."
-    exit 1
-  end
-
-  def execute
-    profiledirectory = mappingfile = pstorefile = nil
-    existancecheck = false
-    begin
-      opt = GetoptLong.new(
-                           ["-d","--directory", GetoptLong::REQUIRED_ARGUMENT],
-                           ["-f","--file", GetoptLong::REQUIRED_ARGUMENT],
-                           ["-c","--check", GetoptLong::NO_ARGUMENT],
-                           ["-h","--help", GetoptLong::NO_ARGUMENT],
-                           ["-w","--wurfldb", GetoptLong::REQUIRED_ARGUMENT]
-                           )
-      
-      opt.each { |arg,val|
-        case arg
-        when "-d"
-          profiledirectory = val.strip
-        when "-f"
-          mappingfile = val.strip
-        when "-c"
-          existancecheck = true
-        when "-h"
-          help
-        when "-w"
-          pstorefile = val.strip
-        else
-          usage
-        end
-      }
-      usage if mappingfile.nil? || profiledirectory.nil?
-    rescue => err
-      usage
-    end
-
-    profiles = Hash.new
-    duplicates = Hash.new
-    mappings = parse_mapping_file(mappingfile)
-    mappings.each do |uaprof,useragent|
-      begin
-        prof_file = get_uaprofile(uaprof,profiledirectory,existancecheck)
-        uaprof_mapper = UAProfToWURLF.new
-        if profiles.key?(useragent)
-          duplicates[useragent] = Array.new if !duplicates.key?(useragent)
-          duplicates[useragent]<<uaprof
-          next
-        end
-        uaprof_mapper.parse_UAProf("#{profiledirectory}/#{prof_file}")
-        profiles[useragent] = uaprof_mapper
-      rescue => err
-        $stderr.puts "Error: File #{prof_file}; User-Agent:#{useragent}"
-        $stderr.puts "Error:#{err.message}"      
-      end  
-    end
-
-    duplicates.each do |key,profs|
-      $stderr.puts "Duplicates exist for #{key}"
-      profs.each {|prof| $stderr.puts "-- #{prof}" }
-    end
-
-    exit 0 if !pstorefile
-
-    wurflhandsets = load_pstore(pstorefile)
-
-    puts "Comparing WURFL Handsets"
-    profiles.each do |key,val|
-      puts "",""
-      
-      if !wurflhandsets.key?(key)
-        puts "UAProf has a new Handset: #{key}"
-        puts "--------------------------------"
-        val.output_WURFL
-        puts "--------------------------------"
-      else
-        uahand = val.make_wurfl_handset                   
-        res = uahand.compare(wurflhandsets[key])
-        if res.size > 0
-          puts "#{key} : For UAProf and WURFL differ"
-          res.each do |dkey,dval,did|
-            next if did == "generic"
-            #Key UAPROF Value WURFL Value WURFL source id
-            puts "  Key:#{dkey}; UVAL:#{uahand[dkey]}; WVAL:#{dval}; WSRCID:#{did}"
-          end
-          #val["user_agent"] = key
-          puts ""
-          puts "WURFL Changes are:"
-          puts ""	  
-          val.output_WURFL(res.map {|entry| entry[0]})
-        else
-          puts "#{key} : For UAProf and WURFL match"
-        end
-      end
-    end
-  end
-end
-