WURFL and Ruby
Downloads
Ruby Tools
Details
Fallback Browser
UAProfToWurfl Details
UAProfWurflComparator Usage
WurflInspector Examples
by Zev Blut (zb at ubit.com)
This is a collection of libraries and command line tools written in Ruby for using and manipulating the WURFL. Ruby is an Object Oriented Scripting Language, for more information about the language see the Ruby home page. Hopefully, these applications and libraries will illustrate the power and simplicity of the WURFL and Ruby. If you have any ideas or suggestions on how to improve the tools, please feel free to help!
Tools
Most of the applications provided do not require you to use Ruby in your own applications. Many of the tools are simply applications for learning more details about the handsets in the WURFL. The applications available are:
- uaproftowurfl.rb
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.
Details - uaprofwurflcomparator.rb
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 - wurflinspector.rb
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. Examples - wurflcomparator.rb
A 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. - wurflloader.rb
A tool 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 listed here. - wurflsanitycheck.rb
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. - fallbackdotgenerator.rb
a program that creates dot (www.graphviz.org) commands to generate a graph of a wurfl id's fallback hierarchy. The user can then run dot, circo or twopi to get a visual output of the graph. - Fallback Browser
Details
Libraries
- wurflhandset.rb
The Ruby class representation of a WURFL handset. It is the core of the Ruby WURFL tools and is what you may want to use in your own applications. - wurflutils.rb
A module that handles the loading and saving of WURFL handsets in a Ruby PStore database.
wurflinspector Examples
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 }'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
wurflinspector.rb -d pstorehandsets.db -s '{|hand| puts "#{hand["brand_name"]} #{hand["model_name"]}" if hand["colors"].to_i > 2}' | sort | uniq
- 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
backlight capability:
wurflinspector.rb -d pstorehandsets.db -i sonyericsson_t300_ver1 -q backlight
uaproftowurfl details
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.
How to use:
A simple usage is:ruby uaproftowurfl.rb sampleprofile.xmlExample use from a bash shell with many profiles:
for i in `ls profiles`; do ruby uaproftowurfl.rb profiles/$i >output/$i.wurfl 2> output/$i.parser.err; doneThis 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 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 executionuaprofwurflcomparator.rb -d ./profiles -f all-profile.2003-08.log -c -w wurfl.db