wurfl 1.0.2 → 1.1.0

data/.gitignore

@@ -1,2 +1,3 @@
 *.swp
 pkg/*
+rdoc/*

data/README.rdoc

@@ -6,14 +6,16 @@ WURFL is a collection of libraries and command line tools for using and manipula
 
 == Tools
 
-=== wurflloader.rb
+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.
 
-=== wurflinspector.rb
+=== 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
@@ -24,12 +26,15 @@ examples section for 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.
-"wurflinspector.rb -d pstorehandsets.db -s '{ |hand| hand["colors"].to_i > 2 }'"
+
+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
+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
@@ -37,24 +42,27 @@ 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
-"wurflinspector.rb -d pstorehandsets.db -s '{|hand| puts
-"#{hand["brand_name"]} #{hand["model_name"]}" if hand["colors"].to_i >
-2}' | sort | uniq"
+
+  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
+A command to query the handset with the id sonyericsson_t300_ver1
 for all of its' capabilities:
-"wurflinspector.rb -d pstorehandsets.db -i sonyericsson_t300_ver1"
 
-*) A command to query the handset with the id sonyericsson_t300_ver1 for
+  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:
-"wurflinspector.rb -d pstorehandsets.db -i sonyericsson_t300_ver1 -q
-backlight"
 
-=== wurflsanitycheck.rb
+  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.
@@ -62,14 +70,14 @@ 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.
 
-=== wurflcomparator.rb
+=== 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.rb
+=== 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
@@ -97,12 +105,12 @@ the UAProfToWurfl class later.
 
 A simple usage is:
 
-  ruby uaproftowurfl.rb sampleprofile.xml
+  wurfltools.rb uaproftowurfl sampleprofile.xml
 
 Example use from a bash shell with many profiles:
 
   for i in `ls profiles`; do 
-    ruby uaproftowurfl.rb profiles/$i >output/$i.wurfl 
+    wurfltools.rb uaproftowurfl profiles/$i >output/$i.wurfl 
     2> output/$i.parser.err; 
   done
 
@@ -110,7 +118,7 @@ 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.rb
+=== uaprofwurflcomparator
 
 Is a program that compares UAProfiles against the equivalent WURFL
 entries. It takes a file that contains an UAProfile URL and an
@@ -126,12 +134,13 @@ 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
-uaprofwurflcomparator.rb -d ./profiles -f all-profile.2003-08.log -c -w wurfl.db
+
+  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)
+* Zev Blut (Original Author)
+* Paul McMahon (gem installer, refactorings)
 
 == Copyright
 

data/VERSION

@@ -1 +1 @@
-1.0.2
+1.1.0

data/bin/wurfltools.rb

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH << File.join(File.dirname(__FILE__), '..',  'lib')
+
+def usage
+  puts "usage: wurfltools.rb command options"
+  path = "#{File.dirname(__FILE__)}/../lib/wurfl/command/*"
+  a = Dir.glob(path).map {|s| File.basename(s,".rb")}
+  puts "available commands:"
+  puts a
+  exit
+end
+
+usage if ARGV.size < 1
+
+command = ARGV.shift
+
+require "wurfl/command/#{command}"
+
+c = Wurfl::Command.const_get(command.capitalize).new
+c.execute

data/lib/wurfl/command.rb

@@ -0,0 +1,4 @@
+module Wurfl
+  class Command
+  end
+end

data/lib/wurfl/command/comparator.rb

@@ -0,0 +1,86 @@
+require "wurfl/command"
+require "getoptlong"
+require "wurfl/handset"
+require "wurfl/utils"
+
+class Wurfl::Command::Comparator < Wurfl::Command
+  include Wurfl::Utils
+
+  def usage
+    puts "Usage: wurfltools.rb comparator wurfl_pstore1_db wurfl_pstore2_db  "
+    exit 1
+  end
+
+  def execute
+    if ARGV.size != 2
+      usage
+    end
+
+    # load the wurfl databases
+    wurfl1 = wurfl2 = nil
+    begin
+      wurfl1, = load_wurfl_pstore(ARGV[0])
+      wurfl2, = load_wurfl_pstore(ARGV[1])
+    rescue => err
+      efile = ""
+      if wurfl1.nil?
+        efile = ARGV[0]
+      else
+        efile = ARGV[1]
+      end
+      STDERR.puts "Error with file #{efile}"
+      STDERR.puts err.message
+      exit 1
+    end
+
+    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]]
+        end
+      else
+        notfound<< handset
+      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 }
+    different.each do |hand1,hand2|
+      puts "-------------------------------------"
+      puts "Handset: #{hand1.user_agent} :ID: #{hand1.wurfl_id}"
+      diffkeys = hand1.compare(hand2)
+      diffkeys.each do |key,oval,oid|
+        next if hand1[key].nil? || hand2[key].nil?
+        puts "Key:#{key}"
+        puts "h1>:#{hand1[key]}"
+        puts "h2<:#{hand2[key]}"
+      end
+      puts "-------------------------------------"
+    end
+
+    puts "||||||||||||||||||||||||||||||||||||"
+  end
+end

data/lib/wurfl/command/inspector.rb

@@ -0,0 +1,142 @@
+require "wurfl/command"
+
+require "getoptlong"
+require "wurfl/handset"
+require "wurfl/utils"
+
+class Wurfl::Command::Inspector < Wurfl::Command
+=begin
+  A class that lists wurfl handsets that match user specified search 
+  criteria.
+=end
+  class WurflInspector
+
+    # Constructor
+    # Parameters:
+    # handsets: A hashtable of wurfl handsets indexed by wurfl_id.
+    def initialize(handsets)
+      @handsets = handsets
+    end
+    
+    # A method to get the WurflHandset that matches the passed wurfl_id.
+    # Parameters:
+    # id: is the wurfl_id of the WurflHandset to get.
+    # Returns:
+    # The WurflHandset that has the requested wurfl_id.  If the wurfl_id
+    # is not found, then nil is returned.
+    def get_handset(id)
+      return @handsets[id]
+    end
+
+    # A method to retrieve a list of the inspector's handsets that match
+    # the passed search criteria.
+    # Parameters:
+    # proc: is a Proc object that defines a function that returns 
+    # true or false from an evaluattion with a WurflHandset.
+    # Returns:
+    # An Array of all WurflHandsets that match the proc evaluation.
+    def search_handsets(proc)
+      rez = @handsets.values.select do |hand|  
+        x = proc.call(hand)       
+      end
+      return rez if rez != nil
+      return Array::new
+    end
+
+  end
+
+
+  include Wurfl::Utils
+
+  def usage
+    puts "Usage: wurfltools.rb inspector  [-s rubyblock] [-i handsetid [-q attributename]]  -d pstorefile"
+    puts "Examples:"
+    puts "wurfltools.rb inspector -d pstorehandsets.db -s '{ |hand| hand[\"colors\"].to_i > 2 }'"
+    puts "wurfltools inspector -d pstorehandsets.db -i sonyericsson_t300_ver1"
+    puts "wurfltools inspector -d pstorehandsets.db -i sonyericsson_t300_ver1 -q backlight"
+    exit 1
+  end
+
+  def execute
+    pstorefile = nil
+    procstr = nil 
+    handset = nil
+    query = nil
+    begin
+      opt = GetoptLong.new(
+                           ["-d","--database", GetoptLong::REQUIRED_ARGUMENT],
+                           ["-s","--search", GetoptLong::REQUIRED_ARGUMENT],
+                           ["-i","--id", GetoptLong::REQUIRED_ARGUMENT],
+                           ["-q","--query", GetoptLong::REQUIRED_ARGUMENT]
+                           )
+      
+      opt.each do |arg,val|
+        case arg
+        when "-d"
+          pstorefile = val
+        when "-s"
+          procstr = val.strip
+        when "-i"
+          handset = 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)    
+      insp = WurflInspector.new(handsets)
+    rescue => err
+      STDERR.puts "Error with file #{pstorefile}"
+      STDERR.puts err.message
+      exit 1
+    end
+
+    if procstr
+      pr = nil
+      eval("pr = proc#{procstr}")
+      
+      if pr.class != Proc
+        puts "You must pass a valid ruby block!"
+        exit 1
+      end
+      
+      puts "--------- Searching handsets -----------"
+      res = insp.search_handsets(pr)
+      puts "Number of results: #{res.size}"
+      
+      res.each { |handset| puts handset.wurfl_id }
+      exit 0
+    end
+
+
+    if handset
+      handset = insp.get_handset(handset)
+      puts "Handset user agent: #{handset.user_agent}"
+      if query
+        puts "Result of handset query: #{query}"
+        rez = handset.get_value_and_owner(query)
+        puts "#{rez[0]} from #{rez[1]}"
+      else
+        puts "Attributes of handset"
+        keys = handset.keys
+        keys.each do |key|
+          rez = handset.get_value_and_owner(key)
+          puts "Attr:#{key} Val:#{rez[0]} from #{rez[1]}"
+        end
+      end
+      exit 0
+    end
+  end
+end

data/lib/wurfl/command/loader.rb

@@ -0,0 +1,129 @@
+require "wurfl/command"
+
+require "getoptlong"
+require "wurfl/utils"
+require "wurfl/loader"
+
+class Wurfl::Command::Loader < Wurfl::Command
+  include Wurfl::Utils
+
+  def usage
+    puts "Usage: wurfltools.rb loader [-p -v -h -e patchfile] -f wurflfile"
+    puts "       --file, -f (wurflfile): The master WURFL file to load."
+    puts "       --extension, -e (patchfile): A patch file to extend the traits of the master WURLF file."
+    puts "       --print, -p : Prints out handsets."
+    puts "       --verbose, -v : Verbose output."
+    puts "       --help, -h : Prints this message."
+    puts "       --database, -d (databasename): Makes a PStore database for quick loading of data with other tools."
+    puts "       --load, -l (databasename): Loads handsets from a PStore database instead of XML file."
+    exit 1
+  end
+
+  def execute
+    print = false
+    insert = false
+    verbose = false
+    wurflfile = nil
+    patchfile = nil
+    pstorefile = nil
+    pstoreload = false
+
+    begin
+      options = GetoptLong.new(
+                               ["-p","--print", GetoptLong::NO_ARGUMENT],
+                               ["-h","--help", GetoptLong::NO_ARGUMENT],
+                               ["-v","--verbose", GetoptLong::NO_ARGUMENT],
+                               ["-f","--file", GetoptLong::REQUIRED_ARGUMENT],
+                               ["-e","--extension", GetoptLong::REQUIRED_ARGUMENT],
+                               ["-d","--database", GetoptLong::REQUIRED_ARGUMENT],
+                               ["-l","--load", GetoptLong::REQUIRED_ARGUMENT]
+                               )
+      
+      options.each do |opt,arg|
+        case opt
+        when "-p"
+          print = true
+        when "-v" 
+          verbose = true
+        when "-h"
+          usage
+          exit 1
+        when "-f"
+          wurflfile = arg
+        when "-e"
+          patchfile = arg
+        when "-d"
+          pstorefile = arg
+        when "-l"
+          pstorefile = arg
+          pstoreload = true
+        else
+          STDERR.puts "Unknown argument #{opt}"
+          usage
+        exit 1
+        end    
+      end
+    rescue => err
+      STDERR.puts "Error: #{err}"
+      usage
+      exit 1
+    end
+
+    wurfll = Wurfl::Loader.new
+    hands = nil
+    fallbacks = nil
+
+    if pstorefile && pstoreload
+      begin
+        puts "Loading  data from #{pstorefile}"
+        hands, fallbacks = load_wurfl_pstore(pstorefile)
+        puts "Loaded"
+      rescue => err
+        STDERR.puts "Error: Cannot load PStore file."
+        STDERR.puts err.message
+        exit 1
+      end
+    else    
+      if !wurflfile 
+        STDERR.puts "You must pass a wurflfile if you want to do more."
+        usage
+        exit 1
+      end
+      
+      starttime = Time.now
+      puts "Loading wurfl file #{wurflfile}" 
+      
+      wurfll.verbose = verbose
+
+      hands, fallbacks = wurfll.load_wurfl(wurflfile)
+      restime = Time.now - starttime
+      
+      puts "Done loading wurfl.  Load took #{restime} seconds." 
+
+      if patchfile
+        starttime = Time.now
+        puts "Loading Patch file #{patchfile}"
+        hands, fallbacks = wurfll.load_wurfl(patchfile)
+        restime = Time.now - starttime
+        puts "Done loading patchfile.  Load took #{restime} seconds." 
+      end
+      
+    end
+
+    if pstorefile && !pstoreload
+      begin
+        puts "Saving data into #{pstorefile}"
+        save_wurfl_pstore(pstorefile, hands, fallbacks)
+        puts "Saved"
+      rescue => err
+        STDERR.puts "Error: Cannot creat PStore file."
+        STDERR.puts err.message
+      end
+    end
+
+    if print 
+      wurfll.print_wurfl hands
+    end
+      
+  end
+end