strava-api-v2 0.1

data/.gitignore

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

data/.rvmrc

@@ -0,0 +1,60 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
+# Only full ruby name is supported here, for short names use:
+#     echo "rvm use 1.9.3" > .rvmrc
+environment_id="ruby-1.9.3-p392@strava_api"
+
+# Uncomment the following lines if you want to verify rvm version per project
+# rvmrc_rvm_version="1.19.6 ()" # 1.10.1 seams as a safe start
+# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
+#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
+#   return 1
+# }
+
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments"
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+  for __hook in "${rvm_path:-$HOME/.rvm}/hooks/after_use"*
+  do
+    if [[ -f "${__hook}" && -x "${__hook}" && -s "${__hook}" ]]
+    then \. "${__hook}" || true
+    fi
+  done
+  unset __hook
+  if (( ${rvm_use_flag:=1} >= 2 )) # display only when forced
+  then
+    if [[ $- == *i* ]] # check for interactive shells
+    then echo "Using: \E[32m$GEM_HOME\E[0m" # show the user the ruby and gemset they are using in green
+    else echo "Using: $GEM_HOME" # don't use colors in non-interactive shells
+    fi
+  fi
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  rvm --create  "$environment_id" || {
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  }
+fi
+
+# If you use bundler, this might be useful to you:
+# if [[ -s Gemfile ]] && {
+#   ! builtin command -v bundle >/dev/null ||
+#   builtin command -v bundle | GREP_OPTIONS= \grep $rvm_path/bin/bundle >/dev/null
+# }
+# then
+#   printf "%b" "The rubygem 'bundler' is not installed. Installing it now.\n"
+#   gem install bundler
+# fi
+# if [[ -s Gemfile ]] && builtin command -v bundle >/dev/null
+# then
+#   bundle install | GREP_OPTIONS= \grep -vE '^Using|Your bundle is complete'
+# fi

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Luke StClair
+
+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,100 @@
+# Strava::Api::V2
+
+API for accessing the strava V2 API - (http://bit.ly/161qmXg)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'strava-api-v2'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install strava-api-v2
+
+## Usage
+
+This module includes both versions of the API (at least the sparse parts I was interested in putting
+together. The confusing thing is that you'll probably have to mix and match to get things done that you care about.
+
+## Getting a connection
+
+The connection object is used to interact with Strava's servers.
+
+    $ connection_v1 = Strava::V1::Connection.new
+    $ connection_v2 = Strava::V2::Connection.new
+
+## Fetching rides
+
+Get a random sampling of all rides
+
+    $ rides = connection_v1.rides
+
+Or you can pass in parameters to get a more useful subset of rides.
+
+For instance, to get the top rides from a club
+    $ rides = connection_v1.rides(:club_id => 15)
+
+Or get the rides for a given athlete
+    $ rides = connection_v1.rides(:athlete_id = > 7679)
+
+Other parameters include :athlete_name, :start_date, :end_date, :start_id, and :offset (http://bit.ly/18CrfCa)
+
+## Streams
+
+Get the stream information about a ride, including heart rates, coordinates, times, distances, altitudes of points
+sampled on a ride.
+
+    $ stream = connection_v1.stream(ride_id)
+
+## Efforts for segment
+
+You can find all the efforts for a segment in the following way
+
+    $ segment = connection_v1.segment_with_efforts(segment_id, params)
+    $ efforts = segment.efforts
+
+The efforts can be search by different parameters, including :club_id, :athlete_id, :athlete_name, :start_date,
+:end_date, :start_id, :best => true
+
+## Getting clubs
+
+Search for club by name
+
+    $ clubs = connection_v1.rides(:name => "Mission Cycling")
+
+## Authenticating
+
+See http://bit.ly/18Ctky9 for more details - this also enables you to retrieve tokens and athlete information.
+
+    $ auth = connection_v2.login("email@example.com", "password")
+    $ token = auth.token
+    $ athlete = auth.athlete
+
+## Segments for a given ride
+
+See http://bit.ly/125MoTh for more details - this allows you to look up the segments for a given ride
+
+    $ segments = connection_v2.segments_for_ride(ride_id)
+    $ first_segment_efforts = segments[0].efforts
+
+## All efforts for a given ride
+
+See http://bit.ly/125MoTh - looks up all efforts put out in a given ride.
+
+    $ segments = connection_v2.segments_and_efforts_for_ride(ride_id)
+    $ first_effort = segments[0].efforts[0]
+
+## Issues
+
+## 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,9 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+ t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test

data/lib/strava/base_connection.rb

@@ -0,0 +1,29 @@
+require 'httparty'
+require 'strava/exceptions'
+
+module Strava
+  module BaseConnection
+    def fetch(relative_uri, options)
+      response = nil
+      begin
+        response = self.class.get("/#{relative_uri}", :query => options)
+      rescue HTTParty::UnsupportedFormat, HTTParty::UnsupportedURIScheme, HTTParty::ResponseError, HTTParty::RedirectionTooDeep
+        # if it's something we understand, it's probably a bad request.
+        raise RequestError.new
+      rescue Exception => e
+        # anything else is presumably not from HTTParty - throw generic network error.
+        raise NetworkError.new(e)
+      end
+
+      case response.code
+        when 500...600
+          raise StravaError.new
+        when 404
+          raise '404ed'
+        when 200
+          return response.parsed_response
+      end
+      raise NetworkError.new('Bad status ' + response.code.to_s)
+    end
+  end
+end

data/lib/strava/exceptions.rb

@@ -0,0 +1,7 @@
+module Strava
+  class StravaError < StandardError; end
+
+  class RequestError < StandardError; end
+
+  class NetworkError < StandardError; end
+end

data/lib/strava/strava_response.rb

@@ -0,0 +1,5 @@
+class StravaResponse
+  def initialize(key_value_map)
+
+  end
+end

data/lib/strava/v1/clubs_request.rb

@@ -0,0 +1,20 @@
+require 'strava/v1/models/club'
+
+module Strava
+  module V1
+    module ClubsRequest
+      def clubs_path
+        'clubs'
+      end
+
+      def clubs(name)
+        all_clubs = []
+        self.fetch(clubs_path, {:name => name})["clubs"].each { |club_json|
+          all_clubs.push(Club.new(club_json))
+        }
+        all_clubs
+      end
+    end
+  end
+end
+

data/lib/strava/v1/connection.rb

@@ -0,0 +1,22 @@
+require 'httparty'
+require 'strava/base_connection'
+require 'strava/v1/rides_request'
+require 'strava/v1/streams_request'
+require 'strava/v1/segments_request'
+require 'strava/v1/clubs_request'
+
+module Strava
+  module V1
+    class Connection
+      include HTTParty
+      include Strava::V1::RidesRequest
+      include Strava::V1::StreamRequest
+      include Strava::V1::SegmentRequest
+      include Strava::V1::ClubsRequest
+      include Strava::BaseConnection
+
+      base_uri 'http://www.strava.com/api/v1'
+      format :json
+    end
+  end
+end

data/lib/strava/v1/models/athlete.rb

@@ -0,0 +1,15 @@
+require 'strava/strava_response'
+
+module Strava
+  module V1
+    class Athlete < StravaResponse
+      attr_reader :id, :username, :name
+
+      def initialize(jb = {})
+        @id = jb["id"]
+        @username = jb["username"]
+        @name = jb["name"]
+      end
+    end
+  end
+end

data/lib/strava/v1/models/club.rb

@@ -0,0 +1,14 @@
+require 'strava/strava_response'
+
+module Strava
+  module V1
+    class Club < StravaResponse
+      attr_reader :id, :name
+
+      def initialize(jb)
+        @id = jb["id"]
+        @name = jb["name"]
+      end
+    end
+  end
+end

data/lib/strava/v1/models/effort.rb

@@ -0,0 +1,17 @@
+require 'strava/strava_response'
+require 'strava/v1/models/segment'
+require 'strava/v1/models/athlete'
+
+module Strava
+  module V1
+    class Effort < StravaResponse
+      attr_reader :id, :elapsed_time, :athlete
+
+      def initialize(js)
+        @id = js["id"]
+        @elapsed_time = js["elapsed_time"]
+        @athlete = Athlete.new(js["athlete"]) if !js["athlete"].nil?
+      end
+    end
+  end
+end

data/lib/strava/v1/models/ride.rb

@@ -0,0 +1,23 @@
+require 'strava/strava_response'
+require 'strava/v1/models/athlete'
+
+module Strava
+  module V1
+    class Ride < StravaResponse
+      attr_reader :id, :name, :distance, :moving_time, :average_speed, :average_watts, :name, :elevation_gain, :athlete
+      attr_accessor :segments
+
+      def initialize(json)
+        @id = json["id"]
+        @name = json["name"]
+        @distance = json["distance"]
+        @moving_time = json["moving_time"]
+        @average_speed = json["average_speed"]
+        @average_watts = json["average_watts"]
+        @name = json["name"]
+        @elevation_gain = json["elevationGain"]
+        @athlete = Athlete.new(json["athlete"]) if !json["athlete"].nil?
+      end
+    end
+  end
+end

data/lib/strava/v1/models/segment.rb

@@ -0,0 +1,19 @@
+require 'strava/strava_response'
+
+module Strava
+  module V1
+    class Segment
+      attr_reader :id, :name, :efforts
+
+      # ejb - efforts json, in list form
+      def initialize(jb, ejb)
+        @id = jb["id"]
+        @name = jb["name"]
+        @efforts = []
+        ejb.each { |effort_json|
+          @efforts.push(Effort.new(effort_json))
+        }
+      end
+    end
+  end
+end

data/lib/strava/v1/models/stream.rb

@@ -0,0 +1,17 @@
+require 'strava/strava_response'
+
+module Strava
+  module V1
+    class Stream < StravaResponse
+      attr_reader :coordinates, :heartrates, :times, :distances, :altitudes
+
+      def initialize(jb)
+        @coordinates = jb["latlng"]
+        @heartrates = jb["heartrate"]
+        @times = jb["time"]
+        @distances = jb["distance"]
+        @altitudes = jb["altitude"]
+      end
+    end
+  end
+end

data/lib/strava/v1/rides_request.rb

@@ -0,0 +1,60 @@
+require 'strava/v1/models/ride'
+require 'strava/v1/models/effort'
+
+module Strava
+  module V1
+    module RidesRequest
+      RIDES_PARAMS_MAP = {
+        :club_id => :clubId,
+        :athlete_id => :athleteId,
+        :athlete_name => :athleteName,
+        :start_date => :startDate,
+        :end_date => :endDate,
+        :start_id => :startId,
+        :offset => :offset
+      }
+
+      def rides_path
+        "rides"
+      end
+
+      def ride_path(id)
+        "rides/#{id}"
+      end
+
+      def rides_with_efforts_path(id)
+        rides_path + "/#{id}/efforts"
+      end
+
+      def rides(params = {})
+        final_params = {}
+        params.each_pair do |key, value|
+          raise RequestError.new if RIDES_PARAMS_MAP[key].nil?
+          final_params[RIDES_PARAMS_MAP[key]] = value
+        end
+
+        all_rides = []
+        rides_array = self.fetch(rides_path(), final_params)["rides"]
+        rides_array.each { |ride_json|
+          all_rides.push(Ride.new(ride_json))
+        }
+        all_rides
+      end
+
+      def ride_with_efforts(ride_id)
+        all_json = self.fetch(rides_with_efforts_path(ride_id), {})
+        ride = Ride.new(all_json["ride"])
+        all_segments = []
+        all_json["efforts"].each { |effort_json|
+          all_segments.push(Segment.new(effort_json["segment"], [effort_json]))
+        }
+        ride.segments = all_segments
+        ride
+      end
+
+      def ride(ride_id)
+        Ride.new(self.fetch(ride_path(ride_id), {})["ride"])
+      end
+    end
+  end
+end