https://github.com/arvida/runkeeper-activities

Unofficial ruby client for RunKeeper activities
https://github.com/arvida/runkeeper-activities

Last synced: 3 months ago
JSON representation

Unofficial ruby client for RunKeeper activities

• Host: GitHub
• URL: https://github.com/arvida/runkeeper-activities
• Owner: arvida
• License: mit
• Created: 2011-06-02T14:57:41.000Z (over 13 years ago)
• Default Branch: master
• Last Pushed: 2015-10-28T04:21:53.000Z (about 9 years ago)
• Last Synced: 2024-10-10T19:38:03.744Z (4 months ago)
• Language: Ruby
• Homepage: http://rnkpr-feed.herokuapp.com/
• Size: 155 KB
• Stars: 3
• Watchers: 1
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.rdoc
  • License: LICENSE

Awesome Lists containing this project

README

        
= RunKeeperActivities gem

The runkeeper-activities gem is a *unoffical* client for the {RunKeeper}[http://runkeeper.com] activity feed,

it is not endorsed by or affiliated with FitnessKeeper Inc. It basically do a bit of scraping of RunKeeper's

public profile pages and js-support files.

== Background

I have been using RunKeeper to track my running for about two years and really like the service. However there

is no official API or RSS-feed for your data yet, from their support forum it looks like it's planned for the future.

I started to feel the urge to be able to access my recent activites on RunKeeper via Ruby so I made this gem.

*Update* 7 June - {A ”graph” API is on the way}[http://developer.runkeeper.com]

== Installation

If your using Bundler add the gem to your Gemfile

    gem 'runkeeper-activities'

and do a 

    bundle install

Not using bundler? Just do a 

    gem install runkeeper-activities

and require the gem with

    require 'runkeeper-activities'

== Example

    require 'runkeeper-activities'

    user = RunKeeperActivities::User.find_by_username(YOUR_RUNKEEPER_USERNAME)

    activity = user.activities.first

    puts "On #{activity.start_time} #{user.name} completed a #{activity.distance} #{user.distance_unit} #{activity.type.downcase} activity"

=== Available data

On a +User+ instance you have access to +username+, +name+, +profile_url+, +profile_image_url+, +distance_unit+, +duration_unit+,

+pace_unit+, +speed_unit+, +calories_unit+, +elevation_unit+ and +activities+. 

On a +Activity+ instance you can access +start_time+, +end_time+, +distance+, +duration+, +pace+, +speed+, +calories+, +elevation+

+message+ and +summery+.

There is a bunch of more data available on RunKeeper that should be pretty easy to add support for. 

== Contribute

Found something that doens't work or want to add a feature? Add an {issue}[https://github.com/arvida/runkeeper-activities/issues] or do a {fork}[http://help.github.com/fork-a-repo/] and send a pull request.