garmin_connectr 0.0.1 → 0.0.2

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 aroth
+Copyright (c) 2009 Adam Roth
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -1,18 +1,7 @@
 = garmin_connectr
 
-Description goes here.
-
-== Note on Patches/Pull Requests
- 
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but
-   bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
+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.
 
 == Copyright
 
-Copyright (c) 2009 aroth. See LICENSE for details.
+Copyright (c) 2009 Adam Roth. See LICENSE for details.

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/examples/activity.rb

@@ -0,0 +1,11 @@
+require '../lib/garmin_connectr.rb'
+
+activity_id = 20733252
+
+gc = GarminConnectr.new
+activity = gc.load( activity_id )
+
+puts activity.name
+puts "  Activity : #{ activity.activity }"
+puts "  Distance : #{ activity.distance }"
+puts "  Start    : #{ activity.start_time }\n\n"

data/examples/activity_list.rb

@@ -0,0 +1,20 @@
+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
+}
+
+gc = GarminConnectr.new
+activities = gc.activities( username, password, opts )
+
+activities.each do |activity|
+  puts "#{ activity.name } (#{ activity.activity_id })"
+  activity.load!
+  puts "  Activity : #{ activity.activity }"
+  puts "  Distance : #{ activity.distance }"
+  puts "  Start    : #{ activity.start_time }\n\n"
+end

data/lib/garmin_connectr.rb

@@ -1,65 +1,101 @@
 require 'rubygems'
 require 'nokogiri'
 require 'open-uri'
+require 'mechanize'
 
 class GarminConnectr
   
-  attr_reader :name, :url, :device
-  attr_reader :start_time, :start_time_str, :activity, :event, :time, :distance, :calories
+  attr_reader :activity_list
   
-  def initialize( id )
-    @id = id
-    self.fetch
+  def initialize
+    @activity_list = []
   end
   
-  def fetch
-    @doc = Nokogiri::HTML(open("http://connect.garmin.com/activity/#{ @id }"))
+  ## Load a specific Garmin Connect activity. See GarminConnectActivity rdoc for more information.
+  def load( activity_id )
+    activity = GarminConnectActivity.new( activity_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 = []
+    limit = opts[:limit] || 50
     
-    ## Name & URL
-    @name = @doc.search('#activityName').inner_html
-    @url = "http://connect.garmin.com/activity/#{ @id }"
-    @device = @doc.search('.additionalInfoContent span').inner_html.gsub('Device: ','')
+    agent = WWW::Mechanize.new { |agent| agent.user_agent_alias = 'Mac Safari' }
+    page = agent.get('http://connect.garmin.com/signin')
+    form = page.form('login')
+    form.send('login:loginUsernameField', username)
+    form.send('login:password', password)
+    form.submit
     
-    ## Start 
-    @start_time_str = @doc.search('#activityStartDate').children[0].to_s.gsub(/[\n]+/,'')
-    @start_time = DateTime.parse( @start_time_str )
+    page = agent.get('http://connect.garmin.com/activities')
 
-    ## Summary Fields
-    @activity = @doc.search('#activityTypeValue').inner_html.gsub(/[\n]+/,'')
-    @event = @doc.search('#eventTypeValue').inner_html.gsub(/[\n]+/,'')
-    @time = @doc.css('#summaryTotalTime')[0].parent.children.search('.summaryField').inner_html
-    @distance = @doc.css('#summaryDistance')[0].parent.children.search('.summaryField').inner_html
-    @calories = @doc.css('#summaryCalories')[0].parent.children.search('.summaryField').inner_html
-    
-    ## Tabbed Fields
-    fields = []
-    fields << ['Avg Speed', 'Max Speed', 'Elevation Gain', 'Elevation Loss', 'Min Elevation', 'Max Elevation']
-    fields << ['Avg HR', 'Max HR', 'Avg Bike Cadence', 'Max Bike Cadence', 'Avg Temperature', 'Min Temperature']
-    fields << ['Max Temperature', 'Avg Pace', 'Best Pace']
-    fields.flatten!
-    
-    fields.each do |field|
-      name = field.downcase.gsub(' ','_')
-      (class << self; self; end).class_eval do
-        define_method name do
-          self.send :tab_data, field
-        end
-      end
+    doc = Nokogiri::HTML( page.body )
+    activities = doc.search('.activityNameLink')
+    activities[0, limit].each do |act|
+      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
     end
-    
+    @activity_list
   end
   
-  private
+end
+
+class GarminConnectActivity
+
+  attr_reader :activity_id, :loaded, :name, :url, :device, :start_time, :activity, :event, :time, :distance, :calories
+  attr_reader :avg_speed, :max_speed, :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', '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 tab_data( field_label )
-    field_label += ":" unless field_label.match(/:$/)
-    @doc.css('.label').to_a.delete_if { |e| e.inner_html != field_label }.first.parent.children.search('.field').inner_html rescue nil
+  def initialize( activity_id, name=nil )
+    @activity_id = activity_id
+    @name = name unless name.nil?
+    @loaded = false
+    @fields = ['name', 'url', 'device', 'start_time']
   end
   
-  def create_method( name, value )
-    class << self
-      self.send( :define_method, name ){ "a" }
+  ## 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( name ) )
     end
+
+    self
   end
+
+  private 
   
+  def tab_data( field_label )
+    field_label += ":" unless field_label.match(/:$/)
+    @doc.css('.label').to_a.delete_if { |e| e.inner_html != field_label }.first.parent.children.search('.field').inner_html.strip rescue nil
+  end
+    
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: garmin_connectr
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - aroth
@@ -61,3 +61,5 @@ specification_version: 3
 summary: Simple ruby lib to fetch data from Garmin Connect
 test_files: 
 - test/garmin_connectr_test.rb
+- examples/activity.rb
+- examples/activity_list.rb