garmin_connectr 0.0.5 → 0.0.6

data/README.rdoc

@@ -2,6 +2,9 @@
 
 GarminConnectr is a simple Ruby library for accessing data from Garmin Connect. As of 12/2009, Garmin's own Connect API has yet to be released. Until then, this screen scraping lib does the job.
 
+CHANGELOG:
+  0.6: The Garmin Connect interface has been updated. I have rewritten most of garmin_connectr and added several cucumber tests. The API has changed. Please see the example usage below.
+  
 Install:
 
   gem install garmin_connectr
@@ -12,23 +15,28 @@ Usage:
   gc = GarminConnectr.new
 
   # Load a specific activity
-  activity = gc.load( ACTIVITY_ID )
+  activity = gc.load_activity( :id => ACTIVITY_ID )
   puts "#{ g.activity } / #{ g.name } / #{ g.time } / #{ g.distance }"
 
+  puts "Available fields for this activity: #{ g.fields.join(',') }"
+
+  puts "Splits for this activity:"
+  g.activity.splits.each do |split|
+    puts "#{ split.split } / #{ split.distance } / #{ split.time }"
+  end
+
+  puts "Split summary:"
+  puts "#{ activity.split_summary.time }"
+  
   # Load a list of my activities
-  list = gc.activities( garmin_connect_username, garmin_connect_password )
+  list = gc.load_activities( :username => garmin_connect_username, 
+                             :password => garmin_connect_password )
   list.each do |activity|
-    activity.load!
     puts "#{ activity.name } / #{ activity.start_time }"
   end
 
-  # Review activity split/lap data
-  activity.splits.each do |split|
-    puts "#{ split['split'] }: Distance: #{ split['distance'] }"
-  end
-
 See examples/*
 
 == Copyright
 
-Copyright (c) 2009 Adam Roth. See LICENSE for details.
+Copyright (c) 2010 Adam Roth. See LICENSE for details.

data/VERSION

@@ -1 +1 @@
-0.0.5
+0.0.6

data/examples/activity.rb

@@ -3,15 +3,14 @@ require '../lib/garmin_connectr.rb'
 activity_id = 21450277
 
 gc = GarminConnectr.new
-activity = gc.load( activity_id )
+activity = gc.load_activity( :id => activity_id )
 
 puts activity.name
-puts "  Activity : #{ activity.activity }"
+puts "  Activity : #{ activity.activity_type }"
 puts "  Distance : #{ activity.distance }"
-puts "  Start    : #{ activity.start_time }"
-puts "  Avg HR   : #{ activity.avg_hr }"
-puts "  Splits   : #{ activity.splits.count }"
+puts "  Start    : #{ activity.timestamp }"
+puts "  Splits   : #{ activity.split_count }"
 
 activity.splits.each do |split|
-  puts "\t#{ split['split'] } : Distance = #{ split['distance'] }"
+  puts "\t#{ split.split } : Distance = #{ split.distance }"
 end

data/examples/activity_list.rb

@@ -3,18 +3,16 @@ require '../lib/garmin_connectr.rb'
 username = 'garmin_connect_username'
 password = 'garmin_connect_password'
 
-opts = {
-  :preload => false,  ## Automatically fetch additional activity data
-  :limit => 10        ## Limit to last 10 activites
-}
+username = 'adamjroth'
+password = 'xcxcxc98'
 
 gc = GarminConnectr.new
-activities = gc.activities( username, password, opts )
+activities = gc.load_activity_list( :username => username, :password => password )
 
 activities.each do |activity|
-  puts "#{ activity.name } (#{ activity.activity_id })"
+  puts "#{ activity.name }"
   activity.load!
-  puts "  Activity : #{ activity.activity }"
+  puts "  Activity : #{ activity.activity_type }"
   puts "  Distance : #{ activity.distance }"
-  puts "  Start    : #{ activity.start_time }\n\n"
+  puts "  Start    : #{ activity.timestamp }\n\n"
 end

data/features/activity.feature

@@ -0,0 +1,109 @@
+Scenario: Load Activity
+  Given I have loaded activity 30051790
+  Then the name should be "MTB - Mesh RDL "
+  And the activity_type should be "Mountain Biking"
+  And the event_type should be "Training"
+  And the timestamp should be "Wed, Apr 14, 2010 1:46 PM"
+  And the time should be "00:55:15"
+  And the distance should be "5.26 mi"
+  And the elevation_gain should be "610 ft"
+  And the calories should be "433 C"
+  And the avg_temperature should be "74.4 °F"
+  And the moving_time should be "00:35:39"
+  And the elapsed_time should be "00:55:15"
+  And the avg_speed should be "5.7 mph"
+  And the avg_moving_speed should be "8.9 mph"
+  And the max_speed should be "27.1 mph"
+  And the avg_pace should be "10:30 min/mi"
+  And the avg_moving_pace should be "06:46 min/mi"
+  And the best_pace should be "02:12 min/mi"
+  And the elevation_loss should be "615 ft"
+  And the min_elevation should be "334 ft"
+  And the max_elevation should be "886 ft"
+  And the avg_hr_bpm should be "132 bpm"
+  And the max_hr_bpm should be "172 bpm"
+  And the avg_hr_pom should be "67 % of Max"
+  And the max_hr_pom should be "87 % of Max"  
+  And the avg_hr_hrzones should be "1.0 z"
+  And the max_hr_hrzones should be "3.9 z"
+  And the avg_bike_cadence should be "84 rpm"
+  And the max_bike_cadence should be "166 rpm"
+  And the avg_temperature should be "74.4 °F"
+  And the min_temperature should be "73.4 °F"
+  And the max_temperature should be "78.8 °F"
+  And the split_count should be "3"
+
+Scenario: Load Activity with Splits
+  Given I have loaded activity 30051790
+  Then the split_count should be "3"
+  
+  And the time for split 1 should be "00:08:51"
+  And the time for split 2 should be "00:26:16"
+  And the time for split 3 should be "00:20:07"
+  
+  And the moving_time for split 1 should be "00:05:42"
+  And the moving_time for split 2 should be "00:16:18"
+  And the moving_time for split 3 should be "00:13:39"
+  
+  And the distance for split 1 should be "1.55"
+  And the distance for split 2 should be "1.85"
+  And the distance for split 3 should be "1.87"
+  
+  And the elevation_gain for split 1 should be "44"
+  And the elevation_gain for split 2 should be "483"
+  And the elevation_gain for split 3 should be "82"
+  
+  And the elevation_loss for split 1 should be "368"
+  And the elevation_loss for split 2 should be "0"
+  And the elevation_loss for split 3 should be "247"
+  
+  And the avg_speed for split 1 should be "10.5"
+  And the avg_speed for split 2 should be "4.2"
+  And the avg_speed for split 3 should be "5.6"
+  
+  And the avg_moving_speed for split 1 should be "16.3"
+  And the avg_moving_speed for split 2 should be "6.8"
+  And the avg_moving_speed for split 3 should be "8.2"
+  
+  And the max_speed for split 1 should be "27.1"
+  And the max_speed for split 2 should be "13.2"
+  And the max_speed for split 3 should be "25.8"
+  
+  And the avg_hr for split 1 should be "111"
+  And the avg_hr for split 2 should be "141"
+  And the avg_hr for split 3 should be "131"
+  
+  And the max_hr for split 1 should be "135"
+  And the max_hr for split 2 should be "172"
+  And the max_hr for split 3 should be "166"
+  
+  And the avg_bike_cadence for split 1 should be "92"
+  And the avg_bike_cadence for split 2 should be "82"
+  And the avg_bike_cadence for split 3 should be "84"
+
+  And the max_bike_cadence for split 1 should be "146"
+  And the max_bike_cadence for split 2 should be "146"
+  And the max_bike_cadence for split 3 should be "166"
+
+  And the calories for split 1 should be "15"
+  And the calories for split 2 should be "266"
+  And the calories for split 3 should be "152"
+  
+  And the avg_temp for split 1 should be "75.6"
+  And the avg_temp for split 2 should be "74.7"
+  And the avg_temp for split 3 should be "73.4"
+
+  And the time for split summary should be "00:55:15"
+  And the moving_time for split summary should be "00:35:39"
+  And the distance for split summary should be "5.26"
+  And the elevation_gain for split summary should be "610"
+  And the elevation_loss for split summary should be "615"
+  And the avg_speed for split summary should be "5.7"
+  And the avg_moving_speed for split summary should be "8.9"
+  And the max_speed for split summary should be "27.1"
+  And the avg_hr for split summary should be "132"
+  And the max_hr for split summary should be "172"
+  And the avg_bike_cadence for split summary should be "84"
+  And the max_bike_cadence for split summary should be "166"
+  And the calories for split summary should be "433"
+  And the avg_temp for split summary should be "74.4"

data/features/activity_list.feature

@@ -0,0 +1,6 @@
+Scenario: Load Activity List
+  Given I have loaded the activity list for username USERNAME with password PASSWORD
+  Then the activity list should contain some activities
+  And the first activity should have a name
+  And the first activity should have a distance
+  And the first activity should have a activity_type

data/features/step_definitions/activity_list_steps.rb

@@ -0,0 +1,12 @@
+Given /^I have loaded the activity list for username ([\w]+) with password ([\w]+)$/ do |username, password|
+  @gc = GarminConnectr.new
+  @activities = @gc.load_activity_list( :username => username, :password => password )
+end
+
+Then /^the activity list should contain some activities$/ do
+  @activities.size.should_not == 0
+end
+
+Then /^the first activity should have a ([\w]+)$/ do |field|
+  @activities.first.send( field.to_sym ).should_not == nil
+end

data/features/step_definitions/activity_steps.rb

@@ -0,0 +1,17 @@
+Given /^I have loaded activity 30051790$/ do
+  @gc = GarminConnectr.new
+  @activity = @gc.load_activity( :id => 30051790 )
+end
+
+Then /^the ([\w_]+) should be "([^"]*)"$/ do |field, value|
+  value = value.to_i if field.to_s.match(/count/i)
+  @activity.send( field ).should == value
+end
+
+Then /^the ([\w_]+) for split ([\d\w]+) should be "([^\"]*)"$/ do |field, split, value|
+  if split == 'summary'
+    @activity.split_summary.send( field ).should == value  
+  else
+    @activity.splits[ split.to_i - 1 ].send( field ).should == value
+  end
+end

data/features/support/env.rb

@@ -0,0 +1 @@
+require 'lib/garmin_connectr.rb'

data/garmin_connectr.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{garmin_connectr}
-  s.version = "0.0.5"
+  s.version = "0.0.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["aroth"]
-  s.date = %q{2010-01-01}
+  s.date = %q{2010-04-17}
   s.description = %q{GarminConnectr is a simple Ruby library for accessing data from Garmin Connect.}
   s.email = %q{adamjroth@gmail.com}
   s.extra_rdoc_files = [
@@ -25,6 +25,11 @@ Gem::Specification.new do |s|
      "VERSION",
      "examples/activity.rb",
      "examples/activity_list.rb",
+     "features/activity.feature",
+     "features/activity_list.feature",
+     "features/step_definitions/activity_list_steps.rb",
+     "features/step_definitions/activity_steps.rb",
+     "features/support/env.rb",
      "garmin_connectr.gemspec",
      "lib/garmin_connectr.rb",
      "test/garmin_connectr_test.rb"
@@ -32,7 +37,7 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/aroth/garmin_connectr}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.5}
+  s.rubygems_version = %q{1.3.6}
   s.summary = %q{GarminConnectr is a simple Ruby library for accessing data from Garmin Connect.}
   s.test_files = [
     "test/garmin_connectr_test.rb",

data/lib/garmin_connectr.rb

@@ -1,32 +1,28 @@
 require 'rubygems'
 require 'nokogiri'
 require 'open-uri'
-require 'mechanize'
 require 'fastercsv'
+require 'simple-rss'
+require 'mechanize'
 
 class GarminConnectr
   
-  attr_reader :activity_list
-  
   def initialize
-    @activity_list = []
   end
   
-  ## Load a specific Garmin Connect activity. See GarminConnectActivity rdoc for more information.
-  def load( activity_id )
-    activity = GarminConnectActivity.new( activity_id )
+  def load_activity( opts )
+    id = opts[:id]
+    activity = GarminConnectrActivity.new( :id => id )
     activity.load!
   end
   
-  ## Returns an array of GarminActivity objects. 
-  ##
-  ## Options:
-  ##    :preload [true/false] - Automatically fetch additional activity data for each activity returned (slower)
-  ##    :limit - Limit the number of activites returned (default: 50)
-  def activities( username, password, opts={} )
-    @activity_list = []
+  def load_activity_list( opts )
+    username = opts[:username]
+    password = opts[:password]
     limit = opts[:limit] || 50
     
+    activity_list = []
+    
     agent = WWW::Mechanize.new { |agent| agent.user_agent_alias = 'Mac Safari' }
     page = agent.get('http://connect.garmin.com/signin')
     form = page.form('login')
@@ -42,112 +38,130 @@ class GarminConnectr
       name = act.search('span').inner_html
       act[:href].match(/\/([\d]+)$/)
       aid = $1
-      
-      activity = GarminConnectActivity.new( aid, name )
-      activity.load! if opts[:preload]
-      @activity_list << activity
+      activity = GarminConnectrActivity.new( :id => aid, :name => name )
+      activity_list << activity
     end
-    @activity_list
+    activity_list    
   end
   
 end
 
-class GarminConnectActivity
+class GarminConnectrActivity
+  attr_accessor :id, :data, :splits, :split_summary, :loaded
 
-  attr_reader :activity_id, :loaded, :name, :url, :device, :start_time, :activity, :event, :time, :distance, :calories
-  attr_reader :avg_speed, :max_speed, :avg_power, :max_power, :elevation_gain, :elevation_loss, :min_elevation, :max_elevation, :avg_hr, :max_hr, :avg_bike_cadence, :max_bike_cadence, :avg_temperature, :min_temperature, :max_temperature, :avg_pace, :best_pace
-  
-  FIELDS = ['Avg Speed', 'Max Speed', 'Avg Power', 'Max Power', 'Elevation Gain', 'Elevation Loss', 'Min Elevation', 'Max Elevation', 'Avg HR', 'Max HR', 'Avg Bike Cadence', 'Max Bike Cadence', 'Avg Temperature', 'Min Temperature', 'Max Temperature', 'Avg Pace', 'Best Pace']
-  
-  def initialize( activity_id, name=nil )
-    @activity_id = activity_id
-    @name = name unless name.nil?
-    @loaded = false
-    @fields = ['name', 'url', 'device', 'start_time']
+  def initialize( opts )
+    @id = opts[:id]
     @splits = []
-    @split_summary = {}
+    @data = {}
+    @data[:name] = opts[:name]
+    @loaded = false
   end
-  
-  ## Fetch activity details. This will happen automatically if using GarminConnect#load. You will have
-  ## call load! explicity on the activities returned by GarminConnect#activities unless the :preload option is set to true.
+    
   def load!
-    @doc = Nokogiri::HTML(open("http://connect.garmin.com/activity/#{ @activity_id }"))
-    @name = @doc.search('#activityName').inner_html
-    @url = "http://connect.garmin.com/activity/#{ @activity_id }"
-    @device = @doc.search('.additionalInfoContent span').inner_html.gsub('Device: ','')
-    @start_time = @doc.search('#activityStartDate').children[0].to_s.gsub(/[\n]+/,'')
-    @loaded = true
-
-    # Summary Fields (TODO: clean up)
-    @activity = @doc.search('#activityTypeValue').inner_html.gsub(/[\n]+/,'').strip rescue nil
-    @event = @doc.search('#eventTypeValue').inner_html.gsub(/[\n]+/,'').strip rescue nil
-    @time = @doc.css('#summaryTotalTime')[0].parent.children.search('.summaryField').inner_html.strip rescue nil
-    @distance = @doc.css('#summaryDistance')[0].parent.children.search('.summaryField').inner_html.strip rescue nil
-    @calories = @doc.css('#summaryCalories')[0].parent.children.search('.summaryField').inner_html.strip rescue nil
-        
-    # Tabbed Fields
-    FIELDS.each do |field|
-      name = field.downcase.gsub(' ','_')
-      self.instance_variable_set("@#{ name }", self.send( :tab_data, field ) )
-    end
-
-    # Splits - parse CSV
-    @doc = open("http://connect.garmin.com/csvExporter/#{ @activity_id }.csv")
-    @splits = []
-    @split_summary  = {}
+    url = "http://connect.garmin.com/activity/#{ @id }"
+    doc = Nokogiri::HTML(open(url))
     
-    @keys = []
-    @csv = FasterCSV.parse( @doc.read )
-    @csv[0].each do |key|
-      @keys.push key.downcase.gsub(' ','_') if key.is_a?(String)
+    # HR cell name manipulation
+    ['bpm', 'pom', 'hrZones'].each do |hr|
+      doc.css("##{ hr }Summary td").each do |e|
+        e.inner_html = "Max HR #{ hr.upcase }:" if e.inner_html =~ /Max HR/i
+        e.inner_html = "Avg HR #{ hr.upcase }:" if e.inner_html =~ /Avg HR/i
+      end
     end
-    ## Data Rows
-    @csv[1, @csv.length - 2].each_with_index do |row, index|
-      split = {}
-      @keys.each_with_index do |key, key_index|
-        split[ key ] = row[ key_index ]
+    
+    @scrape = {
+      :details => {
+        :name          => doc.css('#activityName').inner_html,
+        :activity_type => doc.css('#activityTypeValue').inner_html.gsub(/[\n\t]+/,''),
+        :event_type    => doc.css('#eventTypeValue').inner_html.gsub(/[\n\t]+/,''),
+        :timestamp     => doc.css('#timestamp').inner_html.gsub(/[\n\t]+/,''),
+        :embed         => doc.css('.detailsEmbedCode').attr('value').value
+      },
+      :summaries => {
+        :overall     => { :css => '#detailsOverallBox' },
+        :timing      => { :css => '#detailsTimingBox' },
+        :elevation   => { :css => '#detailsElevationBox' },
+        :heart_rate  => { :css => '#detailsHeartRateBox' },
+        :cadence     => { :css => '#detailsCadenceBox' },
+        :temperature => { :css => '#detailsTemperatureBox' },
+        :power       => { :css => '#detailsPowerBox' }
+      }
+    }
+    
+    @scrape[:details][:split_count] = doc.css('.detailsLapsNumber')[0].inner_html.to_i rescue 0
+    
+    @scrape[:details].each { |k,v| @data[k] = v }
+    @scrape[:summaries].each do |k,v|
+      doc.css("#{ v[:css] } td").each do |e|
+        if e.inner_html =~ /:[ ]?$/
+          key = e.inner_html.downcase.gsub(/ $/,'').gsub(/:/,'').gsub(' ','_').to_sym
+          @data[key] = e.next.next.inner_html.strip
+        end
       end
-      @splits << split
     end
-    ## Summary Row
-    @keys.each_with_index do |key, key_index|
-      @split_summary[ key ] = @csv.last[ key_index ]
+
+    ## Splits
+    if self.split_count > 0
+      load_splits!
     end
-    
+
+    @loaded = true
     self
   end
 
-  ## Returns an array of hashes detailing activity splits (laps). Attributes may include:
-  ##
-  ##  split
-  ##  time
-  ##  distance
-  ##  elevation_gain
-  ##  elevation_loss
-  ##  avg_speed
-  ##  max_speed
-  ##  avg_hr
-  ##  max_hr
-  ##  avg_bike_cadence
-  ##  max_bike_cadence
-  ##  calories
-  ##  avg_temp
-  ##  max_power
-  ##  avg_power
+  def fields
+    @data.keys
+  end
+  
   def splits
+    self.load! unless @loaded
     @splits
   end
+
+  private
+  
+  def load_splits!
+    doc = open("http://connect.garmin.com/csvExporter/#{ @id }.csv")
+
+    keys = []
+    csv = FasterCSV.parse( doc.read )
+    csv[0].each do |key|
+      keys.push key.downcase.gsub(' ','_') if key.is_a?(String)
+    end
+
+    csv[1, csv.length-1].each_with_index do |row, index|
+      split = GarminConnectrActivitySplit.new
+      keys.each_with_index do |key, key_index|
+        split.data[ key.to_sym ] = row[ key_index ].strip
+      end
+      index < csv.length - 2 ? @splits << split : @split_summary = split
+    end
+  end
   
-  ## Returns a hash of activity splits/laps summary. See splits rdoc for possible attributes.
-  def split_summary
-    @split_summary
+  def method_missing(name)
+    self.load! if !@data[name.to_sym] and !@loaded  # lazy loading
+    @data[name.to_sym]
   end
 
+end
+
+class GarminConnectrActivitySplit
+  
+  attr_reader :index, :data
+  
+  def initialize( opts={} )
+    @index = opts[:index]
+    @data = {}
+  end
+  
+  def fields
+    @data.keys
+  end
+  
   private
   
-  def tab_data( label )
-    label += ":" unless label.match(/:$/)
-    @doc.css('.label').to_a.delete_if { |e| e.inner_html != label }.first.parent.children.search('.field').inner_html.strip rescue nil
+  def method_missing(name)
+    @data[name.to_sym]
   end
-    
+  
 end

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: garmin_connectr
 version: !ruby/object:Gem::Version 
-  version: 0.0.5
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 6
+  version: 0.0.6
 platform: ruby
 authors: 
 - aroth
@@ -9,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-01 00:00:00 -05:00
+date: 2010-04-17 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -31,6 +36,11 @@ files:
 - VERSION
 - examples/activity.rb
 - examples/activity_list.rb
+- features/activity.feature
+- features/activity_list.feature
+- features/step_definitions/activity_list_steps.rb
+- features/step_definitions/activity_steps.rb
+- features/support/env.rb
 - garmin_connectr.gemspec
 - lib/garmin_connectr.rb
 - test/garmin_connectr_test.rb
@@ -47,18 +57,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: GarminConnectr is a simple Ruby library for accessing data from Garmin Connect.