gooby 1.1.0 → 1.2.0

data/README

@@ -1,8 +1,8 @@
 = Gooby = Google APIs + Ruby 
 
-Version: 1.1.0 - 2007/06/10
+Version: 1.2.0 - 2007/07/22
 
-Gooby = Google APIs + Ruby.  Release 1.1.0 generates Google maps from GPS data
+Gooby = Google APIs + Ruby.  Release 1.2.0 generates Google maps from GPS data
 exported by your Garmin Forerunner GPS unit, or manually edited CSV file.
 Please see the README file.  Feedback is requested.  
 
@@ -12,6 +12,9 @@ http://www.joakim-systems.com:8219/gmap/ccc_half_2005
 http://www.joakim-systems.com:8219/gmap/nashville_marathon_2005
 http://www.joakim-systems.com:8219/gmap/phoenix_marathon_2006
 
+This README document is available at:
+http://www.joakim-systems.com:8219/gooby/readme
+
 ---
 
 This gem contains 'Gooby', a set of Ruby code to assist you with using and
@@ -28,7 +31,7 @@ as created in one of the following three ways.
 
 Google maps are applicable really to any outdoor activity for which GPS data 
 can be obtained.  The focus of Gooby is on running, because the author is a 
-marathon runner, and the Garmin Forerunner (I use both models 201 and 205) 
+marathon runner, and the Garmin Forerunner (I use models 201, 205, and 305) 
 is primarily intended for running.  Other activities, such as cycling, hiking, 
 walking, driving, and even golfing are also well suited for Gooby.  Please let
 me know how you use Gooby!  Feedback is requested.
@@ -39,7 +42,7 @@ and Rails integration may be done in a later release.
 = General
 
 Author::   Chris Joakim <chris@joakim-systems.com>
-Requires:: Ruby 1.8.0 or later
+Requires:: Ruby 1.8.4 or later
 License::  Copyright 2007 by Chris Joakim.
            GNU General Public License (GPL) license.
            See http://www.gnu.org/copyleft/gpl.html
@@ -58,7 +61,7 @@ The latest version of gooby can be found at
 Gooby is packaged and installed as a ruby 'gem'.  Download the latest gem to 
 your computer, then run the following command from your download directory.
 
-gem install gooby-1.1.0.gem
+gem install gooby-1.2.0.gem
 
 == Online Resources
 
@@ -73,7 +76,35 @@ gem install gooby-1.1.0.gem
    http://www.joakim-systems.com:8219/gmap/phoenix_marathon_2006
    http://www.joakim-systems.com:8219/gmap/gps_data_capture
 
-== This Release - 1.1.0
+
+== This Release - 1.2.0
+
+*  Added support for the Garmin 305 Heartbeat monitor.  
+   - Heartbeat values are captured in the XML parsing process.
+   - CSV file format expanded to include heartbeat.
+   - Database DDL modified to add the heartbeat column.
+   - Generated Google Maps now have heartbeat in the popup windows.
+   - Legacy Garmin 201 and Garmin 205 CSV files and Google Maps simply
+     omit the heartbeat information.
+   - Heartbeat is displayed, if data is present, in the new Gooby 1.1.0 
+     "been_there" reports.  This may be interesting for hill-climbers
+     and interval-trainers.
+
+*  Added support for the English (miles) or Metric (kilometers) systems.
+   - Either 'mi' or 'km' is specified in the XML parsing process.
+   - mi or km unit-of-measure is retained in the CSV files.
+   - Generated Google Maps now generate markers at either integer
+     miles or kilometers, depending on the input CSV file.
+   - Generated Google Map popup windows display the unit-of-measure.
+
+     Special thanks to Karl Otto Emanuelsson for his suggestion to add
+     metric system support.
+
+*  Refactored the codebase into individual class and module files, rather
+   than the previous monolithic gooby.rb file.
+
+
+== Previous Release - 1.1.0
 
 *  Greatly simplify usage and command-line argument handling.
    See the shell scripts and ruby files in the /bin directory for examples.
@@ -126,9 +157,14 @@ gem install gooby-1.1.0.gem
    Internet Explorer at times.  Script error after loading the map background,
    but before the map route is drawn.
 
+   Note: The Google Map v2 code seems to have been significantly improved for
+   Windows Explorer during Q2 2007, as the Gooby-generated Google Maps now
+   display properly in IE.
+
 *  Add Rails support for realtime dynamic map/content generation.
 
-*  Parse cadence and heartbeat information from Garmin export file for cyclists.
+*  Parse cadence information from Garmin export file for cyclists.
+   Note: Please provide me a sample file.
 
 *  Add other Google APIs (earth, search, sitemaps, froogle, etc).
 
@@ -141,16 +177,59 @@ a bug, on the Tracker page.
 
 = Usage
 
-See the shell scripts and corresponding ruby files in the /bin directory for examples.
+See the 'run_xxx.sh' shell scripts and corresponding ruby files in the /bin directory 
+for actual working examples used during Gooby development and testing.
+
 The following in-line text shows both the shell and ruby code.
 
-Function 1 - Garmin XML/TCX file splitting:
+Function 1 - Gooby Version Information
+-------------------------------------------
+	shell:
+	
+	ruby /devtools/workspace/RF_Gooby/bin/gooby_version.rb 
+    
+	ruby:
+
+	require 'rubygems' 
+	require 'gooby'
+	include REXML
+
+	config_filename = '/devtools/workspace/RF_Gooby/config/gooby_config.yaml'
+
+	gooby = Gooby::GoobyCommand.new(config_filename)
+	gooby.display_version
+	
+	
+Function 2 - Gooby Configuration YAML Contents
+----------------------------------------------
+	shell:
+
+	ruby /devtools/workspace/RF_Gooby/bin/gooby_config.rb
+
+	ruby:
+
+	require 'rubygems' 
+	require 'gooby'
+	include REXML
+
+	config_filename = '/devtools/workspace/RF_Gooby/config/gooby_config.yaml'
+
+	gooby = Gooby::GoobyCommand.new(config_filename)
+	gooby.display_configuration
+
+
+Function 3 - Garmin XML/TCX file splitting:
 -------------------------------------------
 	shell:
 	
+	rm   /temp/splits/*.*
+
 	ruby /devtools/workspace/RF_Gooby/bin/gooby_splitter.rb  garmin201  /devtools/workspace/RF_Gooby/data/raw/forerunner_201_2007.xml  /temp/splits
 	ruby /devtools/workspace/RF_Gooby/bin/gooby_splitter.rb  garmin205  /devtools/workspace/RF_Gooby/data/raw/forerunner_205_2007.tcx  /temp/splits
+	ruby /devtools/workspace/RF_Gooby/bin/gooby_splitter.rb  garmin305  /devtools/workspace/RF_Gooby/data/raw/forerunner_305_2007.tcx  /temp/splits
 
+	ls -al /temp/splits
+	
     ruby:
 
 	require 'rubygems' 
@@ -162,18 +241,15 @@ Function 1 - Garmin XML/TCX file splitting:
 	gooby = Gooby::GoobyCommand.new(config_filename)
 	gooby.display_version
 	gooby.split_garmin_export_file(ARGV)
-
-
-Function 2 - Garmin XML/TCX file parsing:
+	
+	
+Function 4 - Garmin XML/TCX file parsing:
 -----------------------------------------
     shell:
 
-	ruby /devtools/workspace/RF_Gooby/bin/gooby_parser.rb  garmin201  /devtools/workspace/RF_Gooby/data/raw/forerunner_201_2007.xml  > 
-        	/devtools/workspace/RF_Gooby/data/2007_g201.csv
-	ruby /devtools/workspace/RF_Gooby/bin/gooby_parser.rb  garmin205  /devtools/workspace/RF_Gooby/data/raw/forerunner_205_2007.tcx  >
-        /devtools/workspace/RF_Gooby/data/2007_g205.csv
-	ruby /devtools/workspace/RF_Gooby/bin/gooby_parser.rb  garmin201  /devtools/workspace/RF_Gooby/data/20060115_phoenix_marathon.xml  >
-        /devtools/workspace/RF_Gooby/data/20060115_phoenix_marathon.csv
+	ruby /devtools/workspace/RF_Gooby/bin/gooby_parser.rb garmin201 mi /devtools/workspace/RF_Gooby/data/20060115_phoenix_marathon.xml   > /devtools/workspace/RF_Gooby/data/20060115_phoenix_marathon.csv
+
+	ruby /devtools/workspace/RF_Gooby/bin/gooby_parser.rb garmin205 km /devtools/workspace/RF_Gooby/data/20070505_davidson_5k.xml        > /devtools/workspace/RF_Gooby/data/20070505_davidson_5k_km.csv
 
 	ruby:
 
@@ -185,14 +261,62 @@ Function 2 - Garmin XML/TCX file parsing:
 
 	gooby = Gooby::GoobyCommand.new(config_filename)
 	gooby.parse_garmin_xml_file(ARGV)
-	
 
-Function 3 - "been_there":
+
+Function 5 - CSV File Validation
+--------------------------------
+	shell:
+
+	ruby /devtools/workspace/RF_Gooby/bin/gooby_csv_validation.rb
+
+    ruby:
+
+	require 'rubygems' 
+	require 'gooby'
+	include REXML
+
+	config_filename = '/devtools/workspace/RF_Gooby/config/gooby_config.yaml'
+
+	full_files = false
+
+	list = Array.new
+	list << '/devtools/workspace/RF_Gooby/data/hrm1.csv'
+	list << '/devtools/workspace/RF_Gooby/data/20050305_corporate_cup_hm.csv'
+	list << '/devtools/workspace/RF_Gooby/data/20050430_nashville_marathon_km.csv'
+	list << '/devtools/workspace/RF_Gooby/data/20060115_phoenix_marathon.csv'
+	list << '/devtools/workspace/RF_Gooby/data/20070101_davidson_11m.csv'
+	list << '/devtools/workspace/RF_Gooby/data/20070505_davidson_5k_km.csv'
+
+	list << '/devtools/workspace/RF_Gooby/data/2007_g201.csv'  if full_files
+	list << '/devtools/workspace/RF_Gooby/data/2007_g205.csv'  if full_files
+	list << '/devtools/workspace/RF_Gooby/data/2007_g305.csv'  if full_files
+
+	gooby = Gooby::GoobyCommand.new(config_filename)
+	@csv_points    = gooby.read_csv_files(list)
+	@csv_col_names = gooby.csv_col_names
+
+	puts "#{@csv_points.size} points read from csv file(s)."
+	puts "#{@csv_col_names.size} fields per line."
+
+	index = 0
+	@csv_col_names.each {|col_name| 
+	  puts sprintf("--    %s   %2s   [%s]", col_name.ljust(16), index, @csv_points[-1].tokens[index])
+	  index = index + 1
+	}
+
+	@csv_points.each {|csv_point| 
+	  puts csv_point.rawdata if csv_point.token_count != 15  
+	}
+
+
+Function 6 - "been_there":
 --------------------------
 	shell:
 	
 	ruby /devtools/workspace/RF_Gooby/bin/gooby_been_there.rb > /devtools/workspace/RF_Gooby/samples/been_there.txt
 
+	ruby /devtools/workspace/RF_Gooby/bin/gooby_been_there.rb
+	
 	ruby:
 	
 	require 'rubygems' 
@@ -204,14 +328,10 @@ Function 3 - "been_there":
 	gooby = Gooby::GoobyCommand.new(config_filename)
 
 	# first read the csv file(s) parsed from your Garmin export tcx/xml files.
-	csv_list = Array.new
-	csv_list << "/devtools/workspace/RF_Gooby/data/2007_g201.csv"  # csv file produced from Garmin 201
-	csv_list << "/devtools/workspace/RF_Gooby/data/2007_g205.csv"  # csv file produced from Garmin 205
-
-	#  read_csv_files has an optional second arg to display the specified formatted record number (i.e. - (csv_list,3) ).
-	gooby.read_csv_files(csv_list, 3)   
-
-	gooby.been_there('333', 0.0025)  # course 333 doesn't exist
+	list = Array.new
+	list << '/devtools/workspace/RF_Gooby/data/20070101_davidson_11m.csv'
+	list << '/devtools/workspace/RF_Gooby/data/hrm1.csv'
+	gooby.read_csv_files(list)   
 
 	# first arg to 'been_there' is the course number, second arg is the 'proximity' specified as
 	# 'degrees difference'.  Degrees difference is defined as the absolute value of lat1 - lat2, 
@@ -220,18 +340,16 @@ Function 3 - "been_there":
 
 	gooby.been_there('1', 0.0025) 
 	gooby.been_there('2', 0.0025) 
-	gooby.been_there('3', 0.0025) 
-	gooby.been_there('4', 0.0025) 
-	gooby.been_there('10', 0.0025)
+	gooby.been_there('999', 0.0005)
 
 
-Function 4 - Google Map Generation:
+Function 7 - Google Map Generation:
 -----------------------------------
-
 	shell:
 	
-	ruby /devtools/workspace/RF_Gooby/bin/gooby_gen_gmap.rb  /devtools/workspace/RF_Gooby/data/20050430_nashville_marathon.csv  >
-        /devtools/workspace/RF_Gooby/samples/20050430_nashville_marathon.html 
+	ruby /devtools/workspace/RF_Gooby/bin/gooby_gen_gmap.rb  /devtools/workspace/RF_Gooby/data/20060115_phoenix_marathon.csv      > /devtools/workspace/RF_Gooby/samples/20060115_phoenix_marathon.html
+
+	ruby /devtools/workspace/RF_Gooby/bin/gooby_gen_gmap.rb  /devtools/workspace/RF_Gooby/data/20070505_davidson_5k_km.csv        > /devtools/workspace/RF_Gooby/samples/20070505_davidson_5k.html
 
 	ruby:
 
@@ -245,6 +363,53 @@ Function 4 - Google Map Generation:
 	gooby.generate_google_map(ARGV)
 		
 
+    Note: The input file passed to the Google Map generation process is the CSV file, not the Garmin XML file.
+
+
+Function 8 - Extract First Trackpoints as (potential) Points-of-Interest (POI)
+------------------------------------------------------------------------------
+	shell:
+
+	ruby /devtools/workspace/RF_Gooby/bin/gooby_first_trackpoints_as_poi.rb 
+
+	ruby:
+
+	require 'rubygems' 
+	require 'gooby'
+	include REXML
+
+	config_filename = '/devtools/workspace/RF_Gooby/config/gooby_config.yaml'
+
+	gooby = Gooby::GoobyCommand.new(config_filename)
+
+	# first read the csv file(s) parsed from your Garmin export tcx/xml files.
+	list = Array.new
+	list << '/devtools/workspace/RF_Gooby/data/hrm1.csv'
+	list << '/devtools/workspace/RF_Gooby/data/20050305_corporate_cup_hm.csv'
+	list << '/devtools/workspace/RF_Gooby/data/20050430_nashville_marathon_km.csv'
+	list << '/devtools/workspace/RF_Gooby/data/20060115_phoenix_marathon.csv'
+	list << '/devtools/workspace/RF_Gooby/data/20070101_davidson_11m.csv'
+	list << '/devtools/workspace/RF_Gooby/data/20070505_davidson_5k_km.csv'
+	gooby.read_csv_files(list)
+
+	# optional first arg is the date of the run, otherwise the all dates.
+	gooby.first_trackpoints_as_poi(ARGV[0])
+
+
+Function 9 - Create a MySQL database table for your parsed CSV data
+-------------------------------------------------------------------
+	shell:
+	
+	/usr/local/mysql/bin/mysql < /devtools/workspace/RF_Gooby/sql/gooby.ddl -u <your_db_id> -p		
+
+
+Function 10 - Populate the MySQL database table with your parsed CSV data
+-------------------------------------------------------------------------
+	shell:
+
+	/usr/local/mysql/bin/mysql < /devtools/workspace/RF_Gooby/sql/gooby_load.dml -u <your_db_id> -p	
+
+	
 == Warranty
 
 This software is provided "as is" and without any express or implied warranties, 

data/bin/code_scan.rb

@@ -1,11 +1,9 @@
 =begin
 
+Gooby = Google APIs + Ruby
 Gooby - Copyright 2007 by Chris Joakim.
 Gooby is available under GNU General Public License (GPL) license.
 
-Example command line:
-ruby bin/code_scan.rb
-
 =end
 
 # The following prefixes ../lib to the active ruby load path

data/bin/gooby_been_there.rb

@@ -1,10 +1,14 @@
+=begin
+
+Gooby = Google APIs + Ruby
+Gooby - Copyright 2007 by Chris Joakim.
+Gooby is available under GNU General Public License (GPL) license.
+
+=end
 
 # The following prefixes ../lib to the active ruby load path
 $:.unshift File.join(File.dirname(__FILE__), "..", "lib")
 
-# Example usage:
-# ruby bin/gooby_been_there.rb > been_there.txt
-
 require 'rubygems' 
 require 'gooby'
 include REXML
@@ -14,14 +18,10 @@ config_filename = '/devtools/workspace/RF_Gooby/config/gooby_config.yaml'
 gooby = Gooby::GoobyCommand.new(config_filename)
 
 # first read the csv file(s) parsed from your Garmin export tcx/xml files.
-csv_list = Array.new
-csv_list << "/devtools/workspace/RF_Gooby/data/2007_g201.csv"  # csv file produced from Garmin 201
-csv_list << "/devtools/workspace/RF_Gooby/data/2007_g205.csv"  # csv file produced from Garmin 205
-
-#  read_csv_files has an optional second arg to display the specified formatted record number (i.e. - (csv_list,3) ).
-gooby.read_csv_files(csv_list, 3)   
-
-gooby.been_there('333', 0.0025)  # course 333 doesn't exist
+list = Array.new
+list << '/devtools/workspace/RF_Gooby/data/20070101_davidson_11m.csv'
+list << '/devtools/workspace/RF_Gooby/data/hrm1.csv'
+gooby.read_csv_files(list)   
 
 # first arg to 'been_there' is the course number, second arg is the 'proximity' specified as
 # 'degrees difference'.  Degrees difference is defined as the absolute value of lat1 - lat2, 
@@ -30,6 +30,4 @@ gooby.been_there('333', 0.0025)  # course 333 doesn't exist
 
 gooby.been_there('1', 0.0025) 
 gooby.been_there('2', 0.0025) 
-gooby.been_there('3', 0.0025) 
-gooby.been_there('4', 0.0025) 
-gooby.been_there('10', 0.0025) 
+gooby.been_there('999', 0.0005) 

data/bin/gooby_config.rb

@@ -1,3 +1,10 @@
+=begin
+
+Gooby = Google APIs + Ruby
+Gooby - Copyright 2007 by Chris Joakim.
+Gooby is available under GNU General Public License (GPL) license.
+
+=end
 
 # The following prefixes ../lib to the active ruby load path
 $:.unshift File.join(File.dirname(__FILE__), "..", "lib")
@@ -9,8 +16,9 @@ include REXML
 config_filename = '/devtools/workspace/RF_Gooby/config/gooby_config.yaml'
 
 gooby = Gooby::GoobyCommand.new(config_filename)
-puts gooby.configuration.to_s
-puts gooby.configuration.get_poi('1')
-gooby.configuration.get_course('2').dump
+gooby.display_configuration
+
+#puts gooby.configuration.get_poi('1')
+#gooby.configuration.get_course('2').dump
 
   

data/bin/gooby_csv_validation.rb

@@ -0,0 +1,50 @@
+=begin
+
+Gooby = Google APIs + Ruby
+Gooby - Copyright 2007 by Chris Joakim.
+Gooby is available under GNU General Public License (GPL) license.
+
+=end
+
+# The following prefixes ../lib to the active ruby load path
+$:.unshift File.join(File.dirname(__FILE__), "..", "lib")
+
+require 'rubygems' 
+require 'gooby'
+include REXML
+
+config_filename = '/devtools/workspace/RF_Gooby/config/gooby_config.yaml'
+
+full_files = false
+
+list = Array.new
+list << '/devtools/workspace/RF_Gooby/data/hrm1.csv'
+list << '/devtools/workspace/RF_Gooby/data/20050305_corporate_cup_hm.csv'
+list << '/devtools/workspace/RF_Gooby/data/20050430_nashville_marathon_km.csv'
+list << '/devtools/workspace/RF_Gooby/data/20060115_phoenix_marathon.csv'
+list << '/devtools/workspace/RF_Gooby/data/20070101_davidson_11m.csv'
+list << '/devtools/workspace/RF_Gooby/data/20070505_davidson_5k_km.csv'
+
+list << '/devtools/workspace/RF_Gooby/data/2007_g201.csv'  if full_files
+list << '/devtools/workspace/RF_Gooby/data/2007_g205.csv'  if full_files
+list << '/devtools/workspace/RF_Gooby/data/2007_g305.csv'  if full_files
+
+gooby = Gooby::GoobyCommand.new(config_filename)
+@csv_points    = gooby.read_csv_files(list)
+@csv_col_names = gooby.csv_col_names
+
+puts "#{@csv_points.size} points read from csv file(s)."
+puts "#{@csv_col_names.size} fields per line."
+
+index = 0
+@csv_col_names.each {|col_name| 
+  puts sprintf("--    %s   %2s   [%s]", col_name.ljust(16), index, @csv_points[-1].tokens[index])
+  index = index + 1
+}
+
+@csv_points.each {|csv_point| 
+  puts csv_point.rawdata if csv_point.token_count != 15  
+}
+
+
+