strava-ruby-client 2.3.0 → 3.0.0.pre.1

data/lib/strava/api/client.rb

@@ -8,7 +8,6 @@ module Strava
       include Endpoints::Clubs
       include Endpoints::Gears
       include Endpoints::Routes
-      include Endpoints::RunningRaces
       include Endpoints::SegmentEfforts
       include Endpoints::Segments
       include Endpoints::Streams
@@ -41,7 +40,7 @@ module Strava
       private
 
       #
-      # paginates requests
+      # Paginates requests using per_page.
       #
       # @param [String] path url for request
       # @param [Hash] options hash containing settings
@@ -52,21 +51,62 @@ module Strava
       #
       # @return [Strava::Api::Pagination]
       #
-      def paginate(path, options, model)
+      def paginate(path, options, model, &block)
+        raise ArgumentError, 'per_page' if options.key(:page_size)
+
+        paginate_with_cursor(path, options, model, &block)
+      end
+
+      #
+      # Paginates requests using a cursor, using per_page or page_size.
+      #
+      # @param [String] path url for request
+      # @param [Hash] options hash containing settings
+      # @param [Class] model by Class
+      #
+      # @example
+      #   paginate("activity/comments", {page_size: 72}, Strava::Models::Comment)
+      #   paginate("athlete/activities", {per_page: 72}, Strava::Models::Activity)
+      #
+      # @return [Strava::Api::Pagination]
+      #
+      def paginate_with_cursor(path, options, model)
+        # avoid retrieving unnecessary items
+        if options.key?(:limit)
+          if options.key?(:per_page) && options[:per_page] > options[:limit]
+            options = options.merge(per_page: options[:limit])
+          elsif options.key?(:page_size) && options[:page_size] > options[:limit]
+            options = options.merge(page_size: options[:limit])
+          end
+        end
+
         collection = []
         web_response = nil
-        if block_given?
+
+        if block_given? || options.key?(:page_size) || options.key?(:per_page)
           Cursor.new(self, path, options).each do |page|
             web_response = page # response of the last request made
             page.each do |row|
+              break if options.key?(:limit) && collection.size >= options[:limit]
+
               m = model.new(row)
-              yield m
+              yield m if block_given?
               collection << m
             end
+            break if options.key?(:limit) && collection.size >= options[:limit]
           end
         else
-          web_response = get(path, options)
+          page_options = if options.key?(:limit)
+                           options.dup.tap do |copy|
+                             copy[:page_size] = copy.delete(:limit)
+                           end
+                         else
+                           options
+                         end
+          web_response = get(path, page_options)
           collection = web_response.map do |row|
+            break if options.key?(:limit) && collection.size >= options[:limit]
+
             model.new(row)
           end
         end

data/lib/strava/api/cursor.rb

@@ -10,10 +10,16 @@ module Strava
       def initialize(client, path, params = {})
         @client = client
         @path = path
-        @params = params
+        @params = params.key?(:limit) ? params.dup.tap { |p| p.delete :limit } : params
       end
 
-      def each
+      def each(&block)
+        params[:page_size] ? each_cursor(&block) : each_page(&block)
+      end
+
+      private
+
+      def each_page
         next_page = 1
         loop do
           query = params.merge(page: next_page)
@@ -24,6 +30,24 @@ module Strava
           next_page += 1
         end
       end
+
+      def each_cursor
+        cursor = nil
+        query = params
+        loop do
+          response = client.get(path, query)
+          break unless response.any?
+
+          yield response
+
+          break if response.size < params[:page_size]
+
+          cursor = response.last&.[]('cursor')
+          break unless cursor.present?
+
+          query = params.merge(after_cursor: cursor)
+        end
+      end
     end
   end
 end

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

@@ -8,7 +8,7 @@ module Strava
         # Create an activity.
         #
         def create_activity(options = {})
-          Strava::Models::Activity.new(post('activities', options))
+          Strava::Models::DetailedActivity.new(post('activities', options))
         end
 
         #
@@ -19,7 +19,7 @@ module Strava
         #
         def activity(id_or_options, options = {})
           id, options = parse_args(id_or_options, options)
-          Strava::Models::Activity.new(get("activities/#{id}", options))
+          Strava::Models::DetailedActivity.new(get("activities/#{id}", options))
         end
 
         #
@@ -29,12 +29,15 @@ module Strava
         #   Activity id.
         # @option options [Integer] :page
         #   Page number.
+        # @option options [Integer] :page_size
+        #   Number of items per page. Defaults to 30.
         # @option options [Integer] :per_page
         #   Number of items per page. Defaults to 30.
+        #   @deprecated use {page_size}
         #
         def activity_comments(id_or_options, options = {}, &block)
           id, options = parse_args(id_or_options, options)
-          paginate "activities/#{id}/comments", options, Strava::Models::Comment, &block
+          paginate_with_cursor "activities/#{id}/comments", options, Strava::Models::Comment, &block
         end
 
         #
@@ -50,7 +53,7 @@ module Strava
         def activity_photos(id_or_options, options = {}, &block)
           id, options = parse_args(id_or_options, options)
           options[:size] = 5000 unless options[:size] # to retrieve full size photos
-          paginate "activities/#{id}/photos", options, Strava::Models::Photo, &block
+          paginate "activities/#{id}/photos", options, Strava::Models::DetailedPhoto, &block
         end
 
         #
@@ -65,7 +68,7 @@ module Strava
         #
         def activity_kudos(id_or_options, options = {}, &block)
           id, options = parse_args(id_or_options, options)
-          paginate "activities/#{id}/kudos", options, Strava::Models::Athlete, &block
+          paginate "activities/#{id}/kudos", options, Strava::Models::SummaryAthlete, &block
         end
 
         #
@@ -97,7 +100,7 @@ module Strava
           options = options.dup if options.key?(:after) || options.key?(:before)
           options[:after] = options[:after].to_i if options[:after]
           options[:before] = options[:before].to_i if options[:before]
-          paginate 'athlete/activities', options, Strava::Models::Activity, &block
+          paginate 'athlete/activities', options, Strava::Models::SummaryActivity, &block
         end
 
         #
@@ -133,7 +136,7 @@ module Strava
         #
         def update_activity(id_or_options, options = {})
           id, options = parse_args(id_or_options, options)
-          Strava::Models::Activity.new(put("activities/#{id}", options))
+          Strava::Models::DetailedActivity.new(put("activities/#{id}", options))
         end
       end
     end

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

@@ -8,7 +8,7 @@ module Strava
         # Returns the currently authenticated athlete.
         #
         def athlete
-          Strava::Models::Athlete.new(get('athlete'))
+          Strava::Models::DetailedAthlete.new(get('athlete'))
         end
 
         #
@@ -36,7 +36,7 @@ module Strava
         #   The weight of the athlete in kilograms.
         #
         def update_athlete(options = {})
-          Strava::Models::Athlete.new(put('athlete', options))
+          Strava::Models::DetailedAthlete.new(put('athlete', options))
         end
       end
     end

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

@@ -16,7 +16,7 @@ module Strava
         #
         def club_activities(id_or_options, options = {}, &block)
           id, options = parse_args(id_or_options, options)
-          paginate "clubs/#{id}/activities", options, Strava::Models::Activity, &block
+          paginate "clubs/#{id}/activities", options, Strava::Models::ClubActivity, &block
         end
 
         #
@@ -46,7 +46,7 @@ module Strava
         #
         def club_admins(id_or_options, options = {}, &block)
           id, options = parse_args(id_or_options, options)
-          paginate "clubs/#{id}/admins", options, Strava::Models::ClubAdmin, &block
+          paginate "clubs/#{id}/admins", options, Strava::Models::ClubAthlete, &block
         end
 
         #
@@ -57,7 +57,7 @@ module Strava
         #
         def club(id_or_options, options = {})
           id, options = parse_args(id_or_options, options)
-          Strava::Models::Club.new(get("clubs/#{id}", options))
+          Strava::Models::DetailedClub.new(get("clubs/#{id}", options))
         end
 
         #
@@ -72,7 +72,7 @@ module Strava
         #
         def club_members(id_or_options, options = {}, &block)
           id, options = parse_args(id_or_options, options)
-          paginate "clubs/#{id}/members", options, Strava::Models::ClubMember, &block
+          paginate "clubs/#{id}/members", options, Strava::Models::ClubAthlete, &block
         end
 
         #
@@ -84,7 +84,7 @@ module Strava
         #   Number of items per page. Defaults to 30.
         #
         def athlete_clubs(options = {}, &block)
-          paginate 'athlete/clubs', options, Strava::Models::Club, &block
+          paginate 'athlete/clubs', options, Strava::Models::SummaryClub, &block
         end
       end
     end

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

@@ -12,7 +12,7 @@ module Strava
         #
         def gear(id_or_options, options = {})
           id, options = parse_args(id_or_options, options)
-          Strava::Models::Gear.new(get("gear/#{id}", options))
+          Strava::Models::DetailedGear.new(get("gear/#{id}", options))
         end
       end
     end

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

@@ -12,7 +12,7 @@ module Strava
         #
         def segment_effort(id_or_options, options = {})
           id, options = parse_args(id_or_options, options)
-          Strava::Models::SegmentEffort.new(get("segment_efforts/#{id}", options))
+          Strava::Models::DetailedSegmentEffort.new(get("segment_efforts/#{id}", options))
         end
 
         #
@@ -27,7 +27,7 @@ module Strava
         #
         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
+          paginate "segments/#{id}/all_efforts", options, Strava::Models::DetailedSegmentEffort, &block
         end
       end
     end

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

@@ -34,7 +34,7 @@ module Strava
         #   Number of items per page. Defaults to 30.
         #
         def starred_segments(options = {}, &block)
-          paginate 'segments/starred', options, Strava::Models::Segment, &block
+          paginate 'segments/starred', options, Strava::Models::SummarySegment, &block
         end
 
         #
@@ -45,7 +45,7 @@ module Strava
         #
         def segment(id_or_options, options = {})
           id, options = parse_args(id_or_options, options)
-          Strava::Models::Segment.new(get("segments/#{id}", options))
+          Strava::Models::DetailedSegment.new(get("segments/#{id}", options))
         end
 
         #
@@ -59,7 +59,7 @@ module Strava
         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))
+          Strava::Models::DetailedSegment.new(put("segments/#{id}/starred", options))
         end
       end
     end

data/lib/strava/api/pagination.rb

@@ -29,8 +29,7 @@ module Strava
       # @return [Strava::Web::ApiResponse]
       #
       def http_response
-        @http_response ||=
-          Strava::Web::ApiResponse.new(deep_copy(@web_response).http_response)
+        @http_response ||= Strava::Web::ApiResponse.new(deep_copy(@web_response).http_response)
       end
 
       #

data/lib/strava/models/achievement.rb

@@ -2,6 +2,7 @@
 
 module Strava
   module Models
+    # Undocumented
     class Achievement < Strava::Models::Response
       property 'rank'
       property 'type'

data/lib/strava/models/activity_stats.rb

@@ -2,6 +2,7 @@
 
 module Strava
   module Models
+    # https://developers.strava.com/docs/reference/#api-models-ActivityStats
     class ActivityStats < Strava::Models::Response
       property 'biggest_ride_distance'
       property 'biggest_climb_elevation_gain'

data/lib/strava/models/activity_total.rb

@@ -2,18 +2,14 @@
 
 module Strava
   module Models
+    # https://developers.strava.com/docs/reference/#api-models-ActivityTotal
     class ActivityTotal < Strava::Models::Response
-      include Mixins::Distance
-      include Mixins::Time
-      include Mixins::Elevation
-
       property 'count'
+      include Mixins::Distance
+      include Mixins::MovingTime
+      include Mixins::ElapsedTime
+      include Mixins::ElevationGain
       property 'achievement_count'
-      property 'elevation_gain'
-
-      def total_elevation_gain
-        elevation_gain
-      end
     end
   end
 end

data/lib/strava/models/activity_zone.rb

@@ -2,14 +2,17 @@
 
 module Strava
   module Models
+    # https://developers.strava.com/docs/reference/#api-models-ActivityZone
     class ActivityZone < Strava::Models::Response
       property 'score'
       property 'distribution_buckets', transform_with: ->(v) { v.map { |r| Strava::Models::TimedZoneRange.new(r) } }
       property 'type'
-      property 'resource_state'
       property 'sensor_based'
       property 'points'
       property 'custom_zones'
+      property 'max'
+      # undocumented
+      property 'resource_state'
     end
   end
 end

data/lib/strava/models/base_stream.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Strava
+  module Models
+    # https://developers.strava.com/docs/reference/#api-models-BaseStream
+    class BaseStream < Strava::Models::Response
+      property 'original_size'
+      property 'resolution'
+      property 'series_type'
+    end
+  end
+end

data/lib/strava/models/club_activity.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Strava
+  module Models
+    # https://developers.strava.com/docs/reference/#api-models-ClubActivity
+    class ClubActivity < Strava::Models::Response
+      include Mixins::ElevationGain
+      include Mixins::SportType
+
+      property 'athlete', transform_with: ->(v) { Strava::Models::MetaAthlete.new(v) }
+      property 'name'
+      include Mixins::Distance
+      include Mixins::MovingTime
+      include Mixins::ElapsedTime
+      include Mixins::TotalElevationGain
+      include Mixins::SportType
+      property 'workout_type'
+      # undocumented
+      property 'resource_state'
+    end
+  end
+end

data/lib/strava/models/{club_member.rb → club_athlete.rb}

@@ -2,12 +2,15 @@
 
 module Strava
   module Models
-    class ClubMember < Strava::Models::Response
+    # https://developers.strava.com/docs/reference/#api-models-ClubAthlete
+    class ClubAthlete < Strava::Models::Response
       property 'resource_state'
       property 'firstname'
       property 'lastname'
-      property 'owner'
+      property 'member'
       property 'admin'
+      property 'owner'
+      # undocumented
       property 'membership'
 
       def name

data/lib/strava/models/club_event.rb

@@ -2,16 +2,17 @@
 
 module Strava
   module Models
+    # Unodcumented
     class ClubEvent < Strava::Models::Response
       property 'id'
       property 'resource_state'
       property 'title'
       property 'description'
       property 'club_id'
-      property 'club', transform_with: ->(c) { Strava::Models::Club.new(c) }
-      property 'organizing_athlete', transform_with: ->(oa) { Strava::Models::Athlete.new(oa) }
+      property 'club', transform_with: ->(c) { Strava::Models::SummaryClub.new(c) }
+      property 'organizing_athlete', transform_with: ->(oa) { Strava::Models::SummaryAthlete.new(oa) }
       property 'activity_type'
-      property 'created_at', transform_with: ->(v) { Time.parse(v) }
+      property 'created_at', transform_with: ->(v) { Time.parse(v) if v&.length&.positive? }
       property 'route_id'
       property 'route', transform_with: ->(r) { Strava::Models::Route.new(r) }
       property 'women_only'
@@ -21,7 +22,8 @@ module Strava
       property 'upcoming_occurrences', transform_with: ->(upcoming) { upcoming.map { |o| Time.parse(o) } }
       property 'zone'
       property 'address'
-      property 'start_latlng'
+      property 'joined'
+      property 'start_latlng', transform_with: ->(v) { Strava::Models::LatLng.new(v) }
 
       def strava_url
         "https://www.strava.com/clubs/#{club_id}/group_events/#{id}"

data/lib/strava/models/comment.rb

@@ -5,10 +5,15 @@ module Strava
     class Comment < Strava::Models::Response
       property 'id'
       property 'activity_id'
-      property 'resource_state'
       property 'text'
       property 'created_at', transform_with: ->(v) { Time.parse(v) }
-      property 'athlete', transform_with: ->(v) { Strava::Models::Athlete.new(v) }
+      property 'athlete', transform_with: ->(v) { Strava::Models::SummaryAthlete.new(v) }
+      # undocumented
+      property 'post_id'
+      property 'resource_state'
+      property 'mentions_metadata'
+      property 'reaction_count'
+      property 'has_reacted'
     end
   end
 end

data/lib/strava/models/destination.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Strava
+  module Models
+    # Undocumented
+    class Destination < Strava::Models::Response
+      property 'href'
+      property 'type'
+      property 'name'
+    end
+  end
+end