nike 0.2.2

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in nike.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Alex Skryl
+
+MIT License
+
+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,136 @@
+# Nike
+
+A Ruby client for the Nike+ API
+
+## Features
+
+* Run Stats
+* Heart Rate Stats
+* GPS Data
+* Automatic Unit Conversion
+* Data Set Caching
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'nike'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nike
+
+## Basic Usage
+
+Initialize the client
+
+    $ c = Nike::Client.new('your_email', 'your_password')
+
+A summary of all activities by type (type is :run by default)
+
+    $ c.activities                      # get all runs
+
+    $ c.activities(type: :hr)           # get all heart rate activities
+
+Full activity data (Slow if you have alot of data, use c.activity to fetch a detailed data set for a single activity)
+
+    $ c.detailed_activities             # get detailed data for all runs
+
+    $ c.detailed_activities(type: :hr)  # get detailed data for all hr activity
+
+Detailed data for a single activity (The id can be found in using the summary calls above)
+
+    $ c.activity(id)
+
+Lifetime stats
+
+    $ c.lifetime_totals                 # lifetime running totals
+
+    $ c.lifetime_totals(type: :hr)      # lifetime hr totals
+
+More metrics
+
+    $ c.time_span_metrics               # run metrics
+
+    $ c.time_span_metrics               # hr metrics
+
+Distance by time of day
+
+    $ c.time_of_day_metrics
+
+Distance by terrain
+
+    $ c.terrains
+
+Pace data
+
+    $ c.paces
+
+Basic stats that appear on the Nike+ homepage
+
+    $ c.homepage_stats
+
+## GPS Data
+
+Cheking if an activity includes GPS data
+
+    $ a = @c.activity(#######)
+
+    $ a.gps                             # => true
+
+Getting to the GPS data
+
+    $ a.geo.waypoints                   # list all GPS waypoints
+
+    $ a.geo.waypoints.first             # => {"lat"=>42.115833, "lon"=>-87.776344, "ele"=>181.78954}
+    $ a.geo.waypoints.first.lat         # => 42.115833
+
+## Automatic Unit Conversion
+
+Check to see which conversion helpers are available for a specific data set
+
+    $ a = @c.activity(#######)
+
+    $ a.conversion_helpers              # => [:distance_in_kilometers, :distance_in_miles, :duration_inseconds,
+                                              :duration_in_minutes, :duration_in_hours, :duration_in_hms,
+                                              :speed_in_mph, :speed_in_kph]
+
+Examples
+
+    $ a.duration                        # => 6402672
+    $ a.duration_in_seconds             # => 6402.672
+    $ a.duration_in_minutes             # => 106.7112
+    $ a.duration_in_hours               # => 1.77852
+    $ a.duration_in_hms                 # => "01:46:42"
+                                              
+All time fields are automatically converted to Ruby Time objects
+
+    $ a.start_time_utc.class            # => Time
+
+## Caching
+
+Toggle caching during client initialization
+
+    $ c = Nike::Client.new('your_email', 'your_password', caching: true)
+
+Toggle caching after client initialization
+
+    $ c.caching = false
+
+Perform the HTTP request for a particular call even if caching is enabled. This
+will have the side-effect of refreshing the cache.
+
+    $ c.activities!
+    
+
+## 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

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/nike/client.rb

@@ -0,0 +1,135 @@
+require_relative 'core_ext/hash.rb'
+
+require 'httparty'
+require 'hashie'
+require 'active_support/core_ext/string/inflections'
+
+class Nike::Client
+  include HTTParty
+  # debug_output $stdout
+
+  LOGIN_URL     = 'https://secure-nikeplus.nike.com/nsl/services/user/login'
+  BASE_URL      = 'http://nikeplus.nike.com/plus'
+  APP_KEY       = 'b31990e7-8583-4251-808f-9dc67b40f5d2' 
+  FORMAT        = :json
+
+  # service urls
+  #
+  RUN_ACTIVITIES_URL = '/activity/running/[user_id]/lifetime/activities'
+  HR_ACTIVITIES_URL  = '/activity/running/[user_id]/heartrate/lifetime/activities'
+  ACTIVITY_URL       = '/running/ajax'
+
+  ACTIVITIES_URLS        = {
+    run:   RUN_ACTIVITIES_URL,
+    hr:    HR_ACTIVITIES_URL
+  }
+
+  format FORMAT
+  base_uri BASE_URL
+  default_params format: FORMAT, app: APP_KEY
+
+  attr_accessor :caching
+
+  def initialize(email, password, opts = {})
+    @email, @password, @user_id = email, password, nil
+    @caching, @cache = opts[:caching] || true, {}
+  end
+
+  def activity(id)
+    fetch_activity_data(id.to_s).activity
+  end
+
+  def activities(opts = {})
+    fetch_user_data(opts).activities.map { |a| a.activity }
+  end
+
+  def detailed_activities(opts = {})
+    activities(opts).map { |a| activity(a.activity_id) }
+  end
+
+  [:lifetime_totals, :time_span_metrics, :time_of_day_metrics, :terrains, :paces, :homepage_stats].each do |m|
+    eval %(
+      def #{m}(opts = {})
+        fetch_user_data(opts).send(:#{m})
+      end
+    )
+  end
+
+  def method_missing(method_name, *args, &block)
+    if /(.*)!$/ === method_name && self.respond_to?(method_name.to_s.chop)
+      no_cache { self.send($1, *args, &block) }
+    else super
+    end
+  end
+
+  def respond_to_missing?(method_name, include_private = false)
+    method_name.to_s.end_with?('!') && self.respond_to?(method_name.to_s.chop)
+  end  
+
+private
+
+# data
+
+  def fetch_activity_data(id)
+    cache(id) do 
+      wrap get_authorized(ACTIVITY_URL + "/#{id}")
+    end
+  end
+
+  def fetch_user_data(opts)
+    type = opts[:type].to_sym || :run
+    cache(type) do
+      wrap get_authorized(ACTIVITIES_URLS[type], query: { indexStart: 0, indexEnd: 999999})
+    end
+  end
+
+# auth
+
+  def get_authorized(url, opts = {})
+    login_if_unauthenticated
+    raise "Authentication failed!" unless logged_in?
+    self.class.get(personify_url(url), opts).to_hash
+  end
+
+  def login_if_unauthenticated
+    return if logged_in?
+    response = self.class.login(@email, @password) 
+    @user_id = response['serviceResponse']['body']['User']['screenName']
+  end
+
+  def self.login(email, password)
+    response = post(LOGIN_URL, query: { email: email, password: password }) 
+    self.default_cookies.add_cookies(response.headers['set-cookie'])
+    response
+  end
+
+  def logged_in?
+    !@user_id.nil? && !self.class.cookies[:slCheck].nil?
+  end
+
+# caching
+
+  def cache(key)
+    @caching ? @cache[key] ||= yield : yield
+  end
+
+  def no_cache
+    caching = @caching
+    @caching = false
+    yield
+  ensure
+    @caching = caching
+  end
+
+# helpers
+
+  def personify_url(url)
+    vars = url.scan(/\[[^\]]*\]/)
+    vars.inject(url){ |u, v| u.gsub(v, self.instance_variable_get("@#{v[1..-2]}").to_s) }
+  end
+
+  def wrap(response)
+    Nike::Mash.new(response.underscore_keys)
+  end
+
+end

data/lib/nike/core_ext/hash.rb

@@ -0,0 +1,34 @@
+class Hash
+
+  def deep_merge(other_hash)
+    dup.deep_merge!(other_hash)
+  end
+
+  def deep_merge!(other_hash)
+    other_hash.each_pair do |k,v|
+      tv = self[k]
+      self[k] = \
+        if tv.is_a?(Hash) && v.is_a?(Hash) 
+          tv.deep_merge(v)
+        elsif tv.is_a?(Array) && v.is_a?(Array)  
+          tv + v
+        else v
+        end
+    end
+    self
+  end
+
+  def underscore_keys
+    self.inject({}) do |h, (k,v)|
+      h[k.to_s.underscore] = \
+        case v
+        when Hash
+          v.underscore_keys
+        when Array
+          v.map { |i| i.is_a?(Hash) ? i.underscore_keys : i }
+        else v
+        end; h
+    end
+  end
+
+end

data/lib/nike/mash.rb

@@ -0,0 +1,99 @@
+require 'hashie'
+
+class Nike::Mash < Hashie::Mash
+  KM_TO_MILE = 0.621371192
+
+  CONVERTER_AVAILABILITY = {
+    distance: [:distance_in_kilometers, :distance_in_miles, :speed_in_mph, :speed_in_kph],
+    duration: [:duration_in_seconds, :duration_in_minutes, :duration_in_hours, :duration_in_hms],
+    pace:     [:pace_in_mpk, :pace_in_mpm]
+  }
+
+  CONVERTER_LOOKUP = {
+    distance_in_kilometers: :distance_to_kilometers,
+    distance_in_miles: :distance_to_miles,
+    duration_in_seconds: :duration_to_seconds,
+    duration_in_minutes: :duration_to_minutes,
+    duration_in_hours: :duration_to_hours,
+    duration_in_hms: :duration_to_hms,
+    speed_in_mph: :speed_to_mph,
+    speed_in_kph: :speed_to_kph,
+    pace_in_mpk: :pace_to_mpk,
+    pace_in_mpm: :pace_to_mpm,
+  }
+
+  def method_missing(method, *args, &block)
+    case method.to_s
+    when /_time$|_time_utc$/
+      Time.parse(super)
+    else
+      converter = CONVERTER_LOOKUP[method]
+      converter ? self.send(converter) : super
+    end
+  end
+
+  def respond_to_missing?(method, include_private = false)
+    conversion_helpers.include?(method)
+  end
+
+  def conversion_helpers
+    CONVERTER_AVAILABILITY.inject([]) do |a, (m, converters)|
+      self.include?(m.to_s) ? a += converters : a
+    end
+  end
+
+private
+
+# distance
+
+  def distance_to_kilometers
+    distance
+  end
+
+  def distance_to_miles
+    distance * KM_TO_MILE
+  end
+
+# duration
+
+  def duration_to_seconds
+    duration.to_f / 1000
+  end
+
+  def duration_to_minutes
+    duration.to_f / 60000
+  end
+
+  def duration_to_hours
+    duration.to_f / 3600000
+  end
+
+  def duration_to_hms
+    Time.at(duration_to_seconds).gmtime.strftime('%R:%S')
+  end
+
+# speed
+
+  def speed_to_mph
+    distance_in_miles && duration_in_hours &&
+    distance_in_miles / duration_in_hours
+  end
+
+  def speed_to_kph
+    distance_in_kilometers && duration_in_hours &&
+    distance_in_kilometers / duration_in_hours
+  end
+  
+# speed
+
+  def pace_to_mpk
+    distnace_in_kilometers && duration_in_minutes &&
+    duration_in_minutes / distance_in_kilometers
+  end
+
+  def pace_to_mpm
+    distnace_in_miles && duration_in_minutes &&
+    duration_in_minutes / distance_in_miles
+  end
+
+end

data/lib/nike/version.rb

@@ -0,0 +1,3 @@
+module Nike
+  VERSION = "0.2.2"
+end

data/lib/nike.rb

@@ -0,0 +1,5 @@
+module Nike; end
+
+require 'nike/version'
+require 'nike/mash'
+require 'nike/client'

data/nike.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'nike/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "nike"
+  gem.version       = Nike::VERSION
+  gem.authors       = ["Alex Skryl"]
+  gem.email         = ["rut216@gmail.com"]
+  gem.summary       = %q{A Ruby client for the Nike+ API}
+  gem.description   = %q{A Ruby client for the Nike+ API with support for Run/GPS/HR Data}
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency(%q<hashie>, [">= 1.2.0"])
+  gem.add_dependency(%q<activesupport>, [">= 3.2.0"])
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: nike
+version: !ruby/object:Gem::Version
+  version: 0.2.2
+  prerelease: 
+platform: ruby
+authors:
+- Alex Skryl
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-13 00:00:00.000000000 Z
+dependencies:
+- !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: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+description: A Ruby client for the Nike+ API with support for Run/GPS/HR Data
+email:
+- rut216@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/nike.rb
+- lib/nike/client.rb
+- lib/nike/core_ext/hash.rb
+- lib/nike/mash.rb
+- lib/nike/version.rb
+- nike.gemspec
+homepage: 
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A Ruby client for the Nike+ API
+test_files: []
+has_rdoc: