Project

nike_v2

0.03
No commit activity in last 3 years
No release in over 3 years
There's a lot of open issues
Provides access to the Nike+ V2 Api
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
 Dependencies

Development

~> 4.2.0
~> 10.0.3
~> 2.12.0
~> 2.4.0
~> 1.9.0

Runtime

= 0.1.3
= 0.10.2
~> 0.3.37
 Project Readme

NikeV2

Build Status

Learn more about the Nike+ API at https://developer.nike.com/.

Installation

gem install nike_v2

Comming Soon

Once Nike releases the OAuth api this gem will include the ability to fetch the access token too

Examples

In order to utilize the Nike+ API in its current state, you'll need to do the following:

require 'nike_v2'

# Initialize a person
person = NikeV2::Person.new(access_token: 'a1b2c3d4')
# Fetch persons summary
person.summary
# Fetch a persons activities
person.activities
# Load more data for an activity
activity = person.activities.first
activity.fetch_data
# Fetch GPS Data for an activity
activity.gps_data

The activities api allows you to directly pass arguements to the Nike+ api. It also allows you to prefetch the metrics for each activity returned

#fetch 99 activities
person.activities(:count => 99)
#prefetch the metrics for activities
person.activities(:build_metrics => true)

We also smart load the metrics for activities now so you don't have to explicity load them

person.activities.total_fuel #fetches the metrics if they aren't already loaded
 => 394

As of version 0.3.0 you can cache calls to the Nike+ V2 api. We use the ApiCache (https://github.com/mloughran/api_cache) gem for this and all options in cache directive are passed to the api_cache config. Setting config.cache false disables the cache

# config/initializers/nike_v2.rb
NikeV2.configure do |config|
  config.cache = {
    :cache => 3600
  }
end

Possible options:

{
  :cache => 600,    # 10 minutes  After this time fetch new data
  :valid => 86400,  # 1 day       Maximum time to use old data
                    #             :forever is a valid option
  :period => 60,    # 1 minute    Maximum frequency to call API
  :timeout => 5     # 5 seconds   API response timeout
  :fail =>          # Value returned instead of exception on failure
}

Making it Better

  • Fork the project.
  • Make your feature addition or bug fix in a new topic branch within your repo.
  • Add specs for any new or modified functionality.
  • Commit and push your changes to Github
  • Send a pull request

Inspiration

I used Kevin Thompson's NikeApi gem as inspiration. Find it here: https://github.com/kevinthompson/nike_api

Copyright

Copyright (c) 2013 SmashTank Apps, LLC.

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.