nike_plus 0.0.1

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Adam Roth
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,52 @@
+# NikePlus
+
+A Ruby library for accessing Nike+ data.
+
+## Installation
+    gem install nike_plus
+
+## Documentation
+  [http://rdoc.info/gems/nike_plus][documentation]
+  
+  [documentation]: http://rdoc.info/gems/nike_plus
+
+## Usage Example
+    nike = NikePlus::Client.new( :email => 'test@nikeplus.com', :password => 'mypassword' )
+  
+    list = nike.activities
+    
+    list.each do |summary|
+      activity = nike.activity( summary.activityId )
+
+      puts "name      : #{ activity.name }"
+      puts "distance  : #{ activity.miles } miles"
+      puts "pace      : #{ activity.mpm } min/mile"
+      puts "waypoints : #{ activity.geo.waypoints.size } points" if activity.geo.waypoints.any?
+    end
+    
+## Contributing
+In the spirit of [free software][free-sw], **everyone** is encouraged to help
+improve this project.
+
+[free-sw]: http://www.fsf.org/licensing/essays/free-sw.html
+
+Here are some ways *you* can contribute:
+
+* by using alpha, beta, and prerelease versions
+* by reporting bugs
+* by suggesting new features
+* by writing or editing documentation
+* by writing specifications
+* by writing code (**no patch is too small**: fix typos, add comments, clean up
+  inconsistent whitespace)
+* by refactoring code
+* by fixing [issues][]
+* by reviewing patches
+
+[issues]: https://github.com/aroth/nike_plus/issues
+   
+## Copyright
+Copyright (c) 2012 Adam Roth
+See [LICENSE][] for details.
+
+[license]: https://github.com/aroth/nike_plus/blob/master/LICENSE.txt

data/README.rdoc

@@ -0,0 +1,19 @@
+= nike_plus
+
+Ruby library for accessing Nike+ data.
+
+== Contributing to nike_plus
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2012 Adam Roth. See LICENSE.txt for
+further details.
+

data/lib/nike_plus/activity.rb

@@ -0,0 +1,132 @@
+module NikePlus
+  # Nike+ returns a lot of data for an activity. Internally, Hashie is used to convert the parsed JSON data 
+  # into a pseduo-hash that behaves like an object. Below is a fairly complete list of the data returned for
+  # an activity logged with Nike+ in June 2012:
+  #  
+  #              name => "RUN ON: 06/21/12 06:28 PM",
+  #        activityId => "2003132748",
+  #      activityType => "RUN",
+  #          timeZone => "-04:00",
+  #        timeZoneId => "GMT-04:00",
+  #         dstOffset => "00:00",
+  #      startTimeUtc => "2012-06-21T18:28:45-04:00",
+  #            status => "complete",
+  #        activeTime => 0,
+  #               gps => true,
+  #          latitude => 41.765266,
+  #         longitude => -72.66858,
+  #         heartrate => false,
+  #        deviceType => "IPHONE",
+  #            prevId => "2000841465",
+  #          duration => 2140619,
+  #          calories => 393,
+  #              fuel => 1320,
+  #             steps => 0,
+  #          distance => 6.240550994873047,
+  #  averageHeartRate => 0.0,
+  #  minimumHeartRate => 0.0,
+  #  maximumHeartRate => 0.0,
+  #        isTopRoute => false,
+  #          syncDate => 1340320046000,
+  #         snapshots => { ... },
+  #               geo => { 
+  #                         coordinate => "41.762526, -72.66285",
+  #                          waypoints => [ ... ] 
+  #                      },
+  #           history => [ ... ]
+  #
+  #
+  # Usage:
+  #   activity = nike.activity( 1000001 )
+  #
+  #   activity.name           # => "RUN ON: 06/21/12 06:28 PM"
+  #   activity.deviceType     # => "IPHONE"
+  #
+  #   points = activity.geo.waypoints
+  #   points[0].lat           # => 41.75566
+  #   points[0].lon           # => -72.6529
+  #   points[0].ele           # => 10.86276
+  #
+  # It's a good idea to inspect the Activity object to determine exactly what data you may want. 
+  #
+  # Instance methods defined below manipulate this data into more useful forms.
+  
+  class Activity < Hashie::Mash
+    
+    KM_TO_MILE = 0.621371192
+    
+    # Return an array of waypoints in the form:  [ [lat, lon], [lat, lon], [lat, lon] ]
+    def waypoint_list
+      return [] unless self.geo and self.geo.waypoints
+      self.geo.waypoints.collect { |waypoint| [waypoint.lat, waypoint.lon] }
+    end
+    
+    # Return activity duration in the form HH:MM:SS. 
+    def time
+      a=[1, 1000, 60000, 3600000]*2
+      ms = duration
+      "%02d" % (ms / a[3]).to_s << ":" << 
+      "%02d" % (ms % a[3] / a[2]).to_s << ":" << 
+      "%02d" % (ms % a[2] / a[1]).to_s #<< "." << 
+      #"%03d" % (ms % a[1]).to_s
+    end
+    
+    ## Activity distance in kilometers.
+    def kilometers
+      self.distance
+    end
+    
+    ## Activity distance in miles.
+    def miles
+      self.distance * KM_TO_MILE
+    end
+
+    ## Activity speed in kilometers per hour.
+    def kmh
+      values = self.speed_values
+      return nil unless values and values.any?
+      
+      avg = sum = 0.0
+      values.each { |value| sum += value.to_f }
+      avg = sum / values.size
+    end
+
+    ## Activity speed in miles per hour.
+    def mph
+      return nil unless self.kmh
+      self.kmh * KM_TO_MILE
+    end
+    
+    ## Activity pace in minutes per kilometer.
+    def mpk
+      kmh = self.kmh
+      return nil unless kmh and kmh.is_a?(Float)
+      div = 60.0 / kmh
+      min = div.floor
+      sec = ( ( div - min ) * 60.0 ).round 
+      "#{ sprintf("%.2d", min ) }:#{ sprintf("%.2d", sec ) }"
+    end
+
+    ## Activity pace in minutes per mile.
+    def mpm
+      mph = self.mph
+      return nil unless mph and mph.is_a?(Float)
+      div = 60.0 / mph
+      min = div.floor
+      sec = ( ( div - min ) * 60.0 )
+      "#{ sprintf("%.2d", min ) }:#{ sprintf("%.2d", sec ) }"
+    end
+  
+    private
+    
+    def speed_values
+      return nil unless self.history
+      values = []
+      self.history.each do |data|
+        values = data['values'] if data.type == 'SPEED'
+      end
+      values
+    end
+
+  end
+end

data/lib/nike_plus/activity_summary.rb

@@ -0,0 +1,57 @@
+module NikePlus
+  # Calling NikePlus#activites returns an array of ActivitySummary objects.  ActivitySummary data does
+  # not include geographic or historical details (waypoints, speed, pacing intervals). Use NikePlus#activity to
+  # retrieve those. Below is a fairly complete list of the summary data returned for an activity logged 
+  # with Nike+ in June 2012:
+  #
+  #                name => "RUN ON: 06/21/12 06:28 PM",
+  #          activityId => "2003132748",
+  #        activityType => "RUN",
+  #            timeZone => "-04:00",
+  #          timeZoneId => "GMT-04:00",
+  #           dstOffset => "00:00",
+  #        startTimeUtc => "2012-06-21T18:28:45-04:00",
+  #              status => "complete",
+  #          activeTime => 0,
+  #                 gps => true,
+  #            latitude => 41.765266,
+  #           longitude => -72.66858,
+  #           heartrate => false,
+  #          deviceType => "IPHONE",
+  #          isTopRoute => false,
+  #                tags => {
+  #                           location => "outdoors",
+  #                           emotion  => "amped",
+  #                           weather  => "amped",
+  #                           terrain  => "amped"
+  #                        },
+  #             metrics => {
+  #                            averageHeartRate => 0.0,
+  #                            minimumHeartRate => 0.0,
+  #                            maximumHeartRate => 0.0,
+  #                            averagePace => 343017.62805217603,
+  #                            duration => 2140619,
+  #                            calories => 393,
+  #                            fuel => 1320,
+  #                            steps => 0,
+  #                            distance => 6.240550994873047
+  #                          }
+  #
+  # Usage:
+  #   # Summary
+  #   summary = nike.activities.first               # => NikePlus::ActivitySummary
+  #   summary.name                                  # => "RUN ON: 06/21/12 06:28 PM"
+  #   summary.metrics.calories                      # => 393
+  #
+  #   # Full details
+  #   activity = nike.activity( summary.activityId ) # => NikePlus::Activity
+  #   activity.geo.waypoints
+  #   activity.geo.mph 
+  #
+  # The fields above not gauranteed. For example, activities logged prior to the Nike+GPS app do not
+  # return GPS or tag data. It's a good idea to inspect the ActivitySummary object to determine exactly what data 
+  # you may want. 
+                    
+  class ActivitySummary < Hashie::Mash
+  end
+end

data/lib/nike_plus/client.rb

@@ -0,0 +1,94 @@
+require 'nike_plus/version'
+require 'nike_plus/activity'
+require 'nike_plus/activity_summary'
+
+module NikePlus
+  class Client
+
+    attr_reader :screenname, :user, :authorization_response
+
+    # Initializes a new NikePlus::Client object.
+    #
+    # Configuration options are:
+    # * +email+ - Nike+ account email address.
+    # * +password+ - Nike+ account password.
+    # * +debug+- Debug flag, set to true for debugging output.
+    #
+    # Example:
+    #   nike = NikePlus::Client.new( :email => 'test@nikeplus.com', :password => 'mypassword' )
+    def initialize( options={} )
+      @email = options[:email]
+      @password = options[:password]
+      @debug = options[:debug] 
+      
+      @agent = Mechanize.new
+
+      url = 'https://secure-nikeplus.nike.com/nsl/services/user/login?app=b31990e7-8583-4251-808f-9dc67b40f5d2&format=json&contentType=plaintext'
+      @authorization_response = post(url, { :email => @email, :password => @password })
+
+      if @authorization_response.serviceResponse.header.success == 'true'
+        @user = @authorization_response.serviceResponse.body.User
+        @screenname = @user.screenName
+      else
+        raise @authorization_response.serviceResponse.header.errorCodes.first.message
+      end
+    end
+
+    # Return an array of NikePlus::ActivitySummary objects. To get full details on the activity use the #activity method.
+    #
+    # Example:
+    #   activities = nike.activities # => [NikePlus::ActivitySummary, NikePlus::ActivitySummary]
+    #   activity = nike.activity( activities[0]activityId ) # => NikePlus::Activity
+    def activities
+      url = "http://nikeplus.nike.com/plus/activity/running/#{ @screenname }/lifetime/activities?indexStart=0&indexEnd=9999"
+      data = get(url)
+      activity_list = data.activities.any? ? data.activities.collect { |a| NikePlus::ActivitySummary.new( a.activity ) } : []
+    end
+
+    # Return full details on a specific activity.
+    #
+    # Params:
+    # * +id+ - Nike+ Activity ID
+    #
+    # Example:
+    #   nike.activity( 123456 ) # => NikePlus::Activity
+    def activity( id )
+      url = "http://nikeplus.nike.com/plus/running/ajax/#{ id }"
+      data = get(url)
+      activity = NikePlus::Activity.new( data.activity ) if data.activity
+    end
+
+    # Return an array of activity ids.
+    #
+    # Example:
+    #  nike.activity_ids # => [100, 101, 102, 103]
+    def activity_ids
+      self.activities.collect(&:activityId)
+    end
+        
+    private
+    
+    def get( path )
+      response = @agent.get( path )
+      parse( response )
+    end
+    
+    def post( path, params )
+      response = @agent.post( path, params )
+      parse( response )
+    end
+    
+    def parse( response )
+      hash = Hashie::Mash.new()
+      begin
+        json = JSON.parse( response.body )
+        hash = Hashie::Mash.new( json )
+      rescue
+        warn "[ERROR] #{ $! }" if @debug
+      end
+      hash
+    end
+  
+  end
+  
+end

data/lib/nike_plus/version.rb

@@ -0,0 +1,3 @@
+module NikePlus
+  VERSION = '0.0.1'
+end

data/lib/nike_plus.rb

@@ -0,0 +1,8 @@
+require 'mechanize'
+require 'json'
+require 'hashie'
+
+require 'nike_plus/client'
+
+module NikePlus
+end

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: nike_plus
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Adam Roth
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mechanize
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.5.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.5.1
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.3
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.3
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+description: Ruby library for accessing Nike+ data
+email: adamjroth@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+- README.rdoc
+files:
+- lib/nike_plus.rb
+- lib/nike_plus/activity.rb
+- lib/nike_plus/activity_summary.rb
+- lib/nike_plus/client.rb
+- lib/nike_plus/version.rb
+- LICENSE.txt
+- README.md
+- README.rdoc
+homepage: http://github.com/aroth/nike_plus
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 4523249482076616895
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.21
+signing_key: 
+specification_version: 3
+summary: Ruby library for accessing Nike+ data
+test_files: []