strava-ruby-client 0.2.0 → 0.3.0

data/lib/strava/api/endpoints/gears.rb

@@ -0,0 +1,18 @@
+module Strava
+  module Api
+    module Endpoints
+      module Gears
+        #
+        # Returns an equipment using its identifier.
+        #
+        # @option options [String] :id
+        #   Gear id.
+        #
+        def gear(id_or_options, options = {})
+          id, options = parse_args(id_or_options, options)
+          Strava::Models::Gear.new(get("gear/#{id}", options))
+        end
+      end
+    end
+  end
+end

data/lib/strava/api/endpoints/routes.rb

@@ -0,0 +1,55 @@
+module Strava
+  module Api
+    module Endpoints
+      module Routes
+        #
+        # Returns a GPX file of the route.
+        #
+        # @option options [String] :id
+        #   Route id.
+        #
+        def export_route_gpx(id_or_options, options = {})
+          id, options = parse_args(id_or_options, options)
+          get "routes/#{id}/export_gpx", options
+        end
+
+        #
+        # Returns a TCS file of the route.
+        #
+        # @option options [String] :id
+        #   Route id.
+        #
+        def export_route_tcx(id_or_options, options = {})
+          id, options = parse_args(id_or_options, options)
+          get "routes/#{id}/export_tcx", options
+        end
+
+        #
+        # Returns a route using its identifier.
+        #
+        # @option options [String] :id
+        #   Route id.
+        #
+        def route(id_or_options, options = {})
+          id, options = parse_args(id_or_options, options)
+          Strava::Models::Route.new(get("routes/#{id}", options))
+        end
+
+        #
+        # Returns a list of the routes created by the authenticated athlete using their athlete ID.
+        #
+        # @option options [Integer] :id
+        #   The identifier of the athlete.
+        # @option options [Integer] :page
+        #   Page number.
+        # @option options [Integer] :per_page
+        #   Number of items per page. Defaults to 30.
+        #
+        def athlete_routes(id_or_options, options = {}, &block)
+          id, options = parse_args(id_or_options, options)
+          paginate "athletes/#{id}/routes", options, Strava::Models::Route, &block
+        end
+      end
+    end
+  end
+end

data/lib/strava/api/endpoints/running_races.rb

@@ -0,0 +1,30 @@
+module Strava
+  module Api
+    module Endpoints
+      module RunningRaces
+        #
+        # Returns a running race for a given identifier.
+        #
+        # @option options [String] :id
+        #   The identifier of the running race.
+        #
+        def running_race(id_or_options, options = {})
+          id, options = parse_args(id_or_options, options)
+          Strava::Models::RunningRace.new(get("running_races/#{id}", options))
+        end
+
+        #
+        # Returns a list running races based on a set of search criteria.
+        #
+        # @option options [Integer] :year
+        #   Filters the list by a given year.
+        #
+        def running_races(options = {})
+          get('running_races', options).map do |row|
+            Strava::Models::RunningRace.new(row)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/strava/api/endpoints/segment_efforts.rb

@@ -0,0 +1,33 @@
+module Strava
+  module Api
+    module Endpoints
+      module SegmentEfforts
+        #
+        # Returns a segment effort from an activity that is owned by the authenticated athlete.
+        #
+        # @option options [String] :id
+        #   The identifier of the segment effort.
+        #
+        def segment_effort(id_or_options, options = {})
+          id, options = parse_args(id_or_options, options)
+          Strava::Models::SegmentEffort.new(get("segment_efforts/#{id}", options))
+        end
+
+        #
+        # Returns a set of the authenticated athlete's segment efforts for a given segment.
+        #
+        # @option options [Integer] :id
+        #   The identifier of the segment.
+        # @option options [Integer] :page
+        #   Page number.
+        # @option options [Integer] :per_page
+        #   Number of items per page. Defaults to 30.
+        #
+        def segment_efforts(id_or_options, options = {}, &block)
+          id, options = parse_args(id_or_options, options)
+          paginate "segments/#{id}/all_efforts", options, Strava::Models::SegmentEffort, &block
+        end
+      end
+    end
+  end
+end

data/lib/strava/api/endpoints/segments.rb

@@ -0,0 +1,111 @@
+module Strava
+  module Api
+    module Endpoints
+      module Segments
+        #
+        # Returns the top 10 segments matching a specified query.
+        #
+        # @option options [Array[Float]] :bounds
+        #   The latitude and longitude for two points describing a rectangular boundary for the search: [southwest corner latitude, southwest corner longitude, northeast corner latitude, northeast corner longitude].
+        # @option options [String] :activity_type
+        #   Desired activity type. May take one of the following values: running, riding.
+        # @option options [Integer] :min_cat
+        #   The minimum climbing category.
+        # @option options [Integer] :max_cat
+        #   The maximum climbing category.
+        #
+        def explore_segments(options = {})
+          throw ArgumentError.new('Required argument :bounds missing') if options[:bounds].nil?
+          bounds = options[:bounds]
+          bounds = bounds.map(&:to_s).join(',') if bounds.is_a?(Array)
+          get('segments/explore', options.merge(bounds: bounds))['segments'].map do |row|
+            Strava::Models::ExplorerSegment.new(row)
+          end
+        end
+
+        #
+        # Returns the specified segment leaderboard.
+        #
+        # @option options [Integer] :id
+        #   The identifier of the segment leaderboard.
+        # @option options [String] :gender
+        #   Filter by gender.
+        # @option options [String] :age_group
+        #   Filter by age group.
+        # @option options [String] :weight_class
+        #   Filter by weight class.
+        # @option options [Boolean] :following
+        #   Filter by friends of the authenticated athlete.
+        # @option options [Integer] :club_id
+        #   Filter by club.
+        # @option options [String] :date_range
+        #   Filter by date range.
+        # @option options [Integer] :context_entries
+        #   ?
+        # @option options [Integer] :page
+        #   Page number.
+        # @option options [Integer] :per_page
+        #   Number of items per page. Defaults to 30.
+        #
+        def segment_leaderboard(id_or_options, options = {})
+          id, options = parse_args(id_or_options, options)
+
+          if block_given?
+            next_page = 1
+            total_count = 0
+            loop do
+              query = options.merge(page: next_page)
+              response = Strava::Models::SegmentLeaderboard.new(get("segments/#{id}/leaderboard", query))
+              total_count += response.entries.count
+              break unless response.entries.any?
+
+              yield response
+              break if total_count >= response.entry_count
+
+              next_page += 1
+            end
+          else
+            Strava::Models::SegmentLeaderboard.new(get("segments/#{id}/leaderboard", options))
+          end
+        end
+
+        #
+        # List of the authenticated athlete's starred segments.
+        #
+        # @option options [Integer] :page
+        #   Page number.
+        # @option options [Integer] :per_page
+        #   Number of items per page. Defaults to 30.
+        #
+        def starred_segments(options = {}, &block)
+          paginate 'segments/starred', options, Strava::Models::Segment, &block
+        end
+
+        #
+        # Returns the specified segment.
+        #
+        # @option options [String] :id
+        #   The identifier of the segment.
+        #
+        def segment(id_or_options, options = {})
+          id, options = parse_args(id_or_options, options)
+          Strava::Models::Segment.new(get("segments/#{id}", options))
+        end
+
+        #
+        # Stars/Unstars the given segment for the authenticated athlete.
+        #
+        # @option options [String] :id
+        #   The identifier of the segment to star.
+        # @option options [Boolean] :starred
+        #   If true, star the segment; if false, unstar the segment.
+        #
+        def star_segment(id_or_options, options = {})
+          id, options = parse_args(id_or_options, options)
+          throw ArgumentError.new('Required argument :starred missing') if options[:starred].nil?
+          Strava::Models::Segment.new(put("segments/#{id}/starred", options))
+        end
+      end
+    end
+  end
+end

data/lib/strava/api/endpoints/streams.rb

@@ -0,0 +1,61 @@
+module Strava
+  module Api
+    module Endpoints
+      module Streams
+        #
+        # Returns the given activity's streams.
+        #
+        # @option options [String] :id
+        #   The identifier of the activity.
+        # @option options [Array[String]] :keys
+        #   Desired stream types.
+        # @option options [Boolean] :key_by_type
+        #   Must be true.
+        #
+        def activity_streams(id_or_options, options = {})
+          id, options = parse_args(id_or_options, options)
+          query = options.dup
+          query[:key_by_type] = true unless options.key?(:key_by_type)
+          query[:keys] = options[:keys].join(',') if options[:keys] && options[:keys].is_a?(Array)
+          Strava::Models::StreamSet.new(get("activities/#{id}/streams", query))
+        end
+
+        #
+        # Returns a set of streams for a segment effort completed by the authenticated athlete.
+        #
+        # @option options [String] :id
+        #   The identifier of the segment effort.
+        # @option options [Array[String]] :keys
+        #   The types of streams to return.
+        # @option options [Boolean] :key_by_type
+        #   Must be true.
+        #
+        def segment_effort_streams(id_or_options, options = {})
+          id, options = parse_args(id_or_options, options)
+          query = options.dup
+          query[:key_by_type] = true unless options.key?(:key_by_type)
+          query[:keys] = options[:keys].join(',') if options[:keys] && options[:keys].is_a?(Array)
+          Strava::Models::StreamSet.new(get("segment_efforts/#{id}/streams", query))
+        end
+
+        #
+        # Returns the given segment's streams.
+        #
+        # @option options [String] :id
+        #   The identifier of the segment.
+        # @option options [Array[String]] :keys
+        #   The types of streams to return.
+        # @option options [Boolean] :key_by_type
+        #   Must be true.
+        #
+        def segment_streams(id_or_options, options = {})
+          id, options = parse_args(id_or_options, options)
+          query = options.dup
+          query[:key_by_type] = true unless options.key?(:key_by_type)
+          query[:keys] = options[:keys].join(',') if options[:keys] && options[:keys].is_a?(Array)
+          Strava::Models::StreamSet.new(get("segments/#{id}/streams", query))
+        end
+      end
+    end
+  end
+end

data/lib/strava/api/endpoints/uploads.rb

@@ -0,0 +1,40 @@
+module Strava
+  module Api
+    module Endpoints
+      module Uploads
+        #
+        # Uploads a new data file to create an activity from.
+        #
+        # @option options [File] :file
+        #   The uploaded file.
+        # @option options [String] :name
+        #   The desired name of the resulting activity.
+        # @option options [String] :description
+        #   The desired description of the resulting activity.
+        # @option options [Boolean] :trainer
+        #   Whether the resulting activity should be marked as having been performed on a trainer.
+        # @option options [Boolean] :commute
+        #   Whether the resulting activity should be tagged as a commute.
+        # @option options [String] :data_type
+        #   The format of the uploaded file.
+        # @option options [String] :external_id
+        #   The desired external identifier of the resulting activity.
+        #
+        def create_upload(options = {})
+          Strava::Models::Upload.new(post('uploads', options))
+        end
+
+        #
+        # Returns an upload for a given identifier.
+        #
+        # @option options [String] :id
+        #   The identifier of the upload.
+        #
+        def upload(id_or_options, options = {})
+          id, options = parse_args(id_or_options, options)
+          Strava::Models::Upload.new(get("uploads/#{id}", options))
+        end
+      end
+    end
+  end
+end

data/lib/strava/logger.rb

@@ -2,7 +2,7 @@ require 'logger'
 
 module Strava
   class Logger < ::Logger
-    def self.default
+    def self.logger
       @logger ||= begin
         logger = new STDOUT
         logger.level = Logger::WARN

data/lib/strava/models/achievement.rb

@@ -0,0 +1,9 @@
+module Strava
+  module Models
+    class Achievement < Model
+      property 'rank'
+      property 'type'
+      property 'type_id'
+    end
+  end
+end

data/lib/strava/models/activity.rb

@@ -1,7 +1,7 @@
 module Strava
   module Models
     class Activity < Model
-      include Mixins::Distance
+      include Mixins::MetricDistance
       include Mixins::Time
       include Mixins::Elevation
 
@@ -65,10 +65,16 @@ module Strava
       property 'laps', transform_with: ->(v) { v.map { |r| Strava::Models::Lap.new(r) } }
       property 'gear', transform_with: ->(v) { Strava::Models::Gear.new(v) }
       property 'device_name'
-
-      def units
-        :metric
-      end
+      property 'average_cadence'
+      property 'average_temp'
+      property 'average_watts'
+      property 'weighted_average_watts'
+      property 'kilojoules'
+      property 'device_watts'
+      property 'max_watts'
+      property 'highlighted_kudosers', transform_with: ->(v) { v.map { |r| Strava::Models::Kudoser.new(r) } }
+      property 'segment_leaderboard_opt_out'
+      property 'leaderboard_opt_out'
 
       def distance_s
         if type == 'Swim'

data/lib/strava/models/activity_stats.rb

@@ -0,0 +1,17 @@
+module Strava
+  module Models
+    class ActivityStats < Model
+      property 'biggest_ride_distance'
+      property 'biggest_climb_elevation_gain'
+      property 'recent_ride_totals', transform_with: ->(v) { Strava::Models::ActivityTotal.new(v) }
+      property 'recent_run_totals', transform_with: ->(v) { Strava::Models::ActivityTotal.new(v) }
+      property 'recent_swim_totals', transform_with: ->(v) { Strava::Models::ActivityTotal.new(v) }
+      property 'ytd_ride_totals', transform_with: ->(v) { Strava::Models::ActivityTotal.new(v) }
+      property 'ytd_run_totals', transform_with: ->(v) { Strava::Models::ActivityTotal.new(v) }
+      property 'ytd_swim_totals', transform_with: ->(v) { Strava::Models::ActivityTotal.new(v) }
+      property 'all_ride_totals', transform_with: ->(v) { Strava::Models::ActivityTotal.new(v) }
+      property 'all_run_totals', transform_with: ->(v) { Strava::Models::ActivityTotal.new(v) }
+      property 'all_swim_totals', transform_with: ->(v) { Strava::Models::ActivityTotal.new(v) }
+    end
+  end
+end

data/lib/strava/models/activity_total.rb

@@ -0,0 +1,17 @@
+module Strava
+  module Models
+    class ActivityTotal < Model
+      include Mixins::MetricDistance
+      include Mixins::Time
+      include Mixins::Elevation
+
+      property 'count'
+      property 'achievement_count'
+      property 'elevation_gain'
+
+      def total_elevation_gain
+        elevation_gain
+      end
+    end
+  end
+end

data/lib/strava/models/athlete.rb

@@ -20,6 +20,16 @@ module Strava
       property 'follower'
       property 'friend'
       property 'summit'
+      property 'follower_count'
+      property 'friend_count'
+      property 'mutual_friend_count'
+      property 'athlete_type'
+      property 'date_preference'
+      property 'measurement_preference'
+      property 'clubs', transform_with: ->(v) { v.map { |r| Strava::Models::Club.new(r) } }
+      property 'weight'
+      property 'bikes', transform_with: ->(v) { v.map { |r| Strava::Models::Gear.new(r) } }
+      property 'shoes', transform_with: ->(v) { v.map { |r| Strava::Models::Gear.new(r) } }
 
       def name
         [firstname, lastname].compact.join(' ') if firstname || lastname