Mmf

A Ruby REST Client for the MapMyFitness API. Here is how I use it.

Installation

Add this line to your application's Gemfile:

gem 'mmf'

And then execute:

$ bundle

Or install it yourself as:

$ gem install mmf

Authentication Tokens

Mmf uses Oauth2 to authenticate with the MapMyFitness API. Please go here to create a developer account and get your client keys. Then go here to generate an access token.

Usage

You can provide your credentials during initialization.

client=Mmf::Client.newdo |config|
config.client_key='YOUR_CLIENT_KEY'config.client_secret='YOUR_CLIENT_SECRET'config.access_token='YOUR_ACCESS_TOKEN'end

To see which API calls are supported, run the following from irb.

client.api

The output will show a mapping between method calls and API calls. See the API docs for details on each API call or use the MapMyFitness I/O docs to play with the API from your browser.

client.me => [get] v7.0/user/self
client.deactivate => [post] v7.0/user_deactivation
client.user => [get] v7.0/user/:user_id
client.create_user => [post] v7.0/user
client.update_user => [put] v7.0/user/:user_id
client.user_photo => [get] v7.0/user_profile_photo/:user_id
client.user_stats => [get] v7.0/user_stats/:user_id
client.achievement => [get] v7.0/acievement/:achievement_id
client.achievements => [get] v7.0/user_acievement
client.friends => [get] v7.0/user
client.suggested_friends => [get] v7.0/user
client.add_friend => [post] v7.0/frendship
client.remove_friend => [delete] v7.0/friendship/:friendship_id
client.approve_friend => [put] v7.0/friendship/:friendship_id
client.friend_requests => [get] v7.0/friendship
client.activity_types => [get] v7.0/activity_type
client.activity_type => [get] v7.0/activity_type/:activity_type_id
client.privacy_options => [get] v7.0/privacy_option
client.privacy_option => [get] v7.0/privacy_option/:privacy_option_id
client.add_workout => [post] v7.0/workout
client.workouts => [get] v7.0/workout
client.workout => [get] v7.0/workout/:workout_id
client.course_leaderboard => [get] v7.0/course_leaderboard/:course_id
client.search_courses => [get] v7.0/course
client.course => [get] v7.0/course/:course_id
client.route => [get] v7.0/route/:route_id
client.routes => [get] v7.0/route
client.nearby_routes => [get] v7.0/route
client.add_route => [post] v7.0/route
client.update_route => [put] v7.0/route/:route_id
client.remove_route => [delete] v7.0/route/:route_id
client.bookmarks => [get] v7.0/route_bookmark
client.add_bookmark => [post] v7.0/route_bookmark/:route_id
client.remove_bookmark => [delete] v7.0/route_bookmark/:route_bookmark_id

All client methods take an optional params hash.

Examples

Get all workouts for the authenticated user.

client.workouts(user: client.me['id'])

Get a single workout with time-series data (distance/heartrate/speed) included.

client.workout(workout_id: 456955773,field_set: 'time_series')

Contributing

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request