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

data/lib/strava/models/meta_athlete.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Strava
+  module Models
+    # https://developers.strava.com/docs/reference/#api-models-MetaAthlete
+    class MetaAthlete < Strava::Models::Response
+      property 'id'
+      # undocumented
+      property 'resource_state'
+      property 'firstname'
+      property 'lastname'
+    end
+  end
+end

data/lib/strava/models/meta_club.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Strava
+  module Models
+    # https://developers.strava.com/docs/reference/#api-models-MetaClub
+    class MetaClub < Strava::Models::Response
+      property 'id'
+      property 'resource_state'
+      property 'name'
+    end
+  end
+end

data/lib/strava/models/mixins/{time.rb → average_speed.rb}

@@ -3,26 +3,16 @@
 module Strava
   module Models
     module Mixins
-      module Time
+      module AverageSpeed
         extend ActiveSupport::Concern
 
         included do
-          property 'moving_time'
-          property 'elapsed_time'
           property 'average_speed'
         end
 
         # always in meters per second, even in imperial splits
         def average_speed_meters_per_second
-          elapsed_time
-        end
-
-        def moving_time_in_hours_s
-          time_in_hours_s moving_time
-        end
-
-        def elapsed_time_in_hours_s
-          time_in_hours_s elapsed_time
+          average_speed
         end
 
         def pace_per_mile_s
@@ -41,37 +31,24 @@ module Strava
           convert_meters_per_second_to_pace average_speed, :km
         end
 
-        def kilometer_per_hour_s
+        def average_speed_kilometer_per_hour_s
           return unless average_speed&.positive?
 
           format('%.1fkm/h', average_speed * 3.6)
         end
 
-        def miles_per_hour_s
+        def average_speed_miles_per_hour_s
           return unless average_speed&.positive?
 
           format('%.1fmph', average_speed * 2.23694)
         end
 
-        def speed_s
-          kilometer_per_hour_s
+        def average_speed_s
+          average_speed_kilometer_per_hour_s
         end
 
         private
 
-        def time_in_hours_s(time)
-          return unless time
-
-          hours = time / 3600 % 24
-          minutes = time / 60 % 60
-          seconds = time % 60
-          [
-            hours.to_i.positive? ? format('%dh', hours) : nil,
-            minutes.to_i.positive? ? format('%dm', minutes) : nil,
-            seconds.to_i.positive? ? format('%ds', seconds) : nil
-          ].compact.join
-        end
-
         # Convert speed (m/s) to pace (min/mile or min/km) in the format of 'x:xx'
         # http://yizeng.me/2017/02/25/convert-speed-to-pace-programmatically-using-ruby
         def convert_meters_per_second_to_pace(speed, unit = :mi)

data/lib/strava/models/mixins/elapsed_time.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Strava
+  module Models
+    module Mixins
+      module ElapsedTime
+        extend ActiveSupport::Concern
+        include TimeInHours
+
+        included do
+          property 'elapsed_time'
+        end
+
+        def elapsed_time_in_hours_s
+          time_in_hours_s elapsed_time
+        end
+      end
+    end
+  end
+end

data/lib/strava/models/mixins/elevation_difference.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Strava
+  module Models
+    module Mixins
+      module ElevationDifference
+        extend ActiveSupport::Concern
+
+        included do
+          property 'elevation_difference'
+        end
+
+        def elevation_difference_in_feet
+          elevation_difference * 3.28084
+        end
+
+        def elevation_difference_in_meters
+          elevation_difference
+        end
+
+        def elevation_difference_in_meters_s
+          return if elevation_difference.nil?
+
+          format('%gm', format('%.1f', elevation_difference_in_meters))
+        end
+
+        def elevation_difference_in_feet_s
+          return if elevation_difference.nil?
+
+          format('%gft', format('%.1f', elevation_difference_in_feet))
+        end
+
+        def elevation_difference_s
+          elevation_difference_in_meters_s
+        end
+      end
+    end
+  end
+end

data/lib/strava/models/mixins/elevation_gain.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Strava
+  module Models
+    module Mixins
+      module ElevationGain
+        extend ActiveSupport::Concern
+
+        included do
+          property 'elevation_gain'
+        end
+
+        def elevation_gain_in_feet
+          elevation_gain * 3.28084
+        end
+
+        def elevation_gain_in_meters
+          elevation_gain
+        end
+
+        def elevation_gain_in_meters_s
+          return if elevation_gain.nil?
+
+          format('%gm', format('%.1f', elevation_gain_in_meters))
+        end
+
+        def elevation_gain_in_feet_s
+          return if elevation_gain.nil?
+
+          format('%gft', format('%.1f', elevation_gain_in_feet))
+        end
+
+        def elevation_gain_s
+          elevation_gain_in_meters_s
+        end
+      end
+    end
+  end
+end

data/lib/strava/models/mixins/estimated_moving_time.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Strava
+  module Models
+    module Mixins
+      module EstimatedMovingTime
+        extend ActiveSupport::Concern
+        include TimeInHours
+
+        included do
+          property 'estimated_moving_time'
+        end
+
+        def estimated_moving_time_in_hours_s
+          time_in_hours_s estimated_moving_time
+        end
+      end
+    end
+  end
+end

data/lib/strava/models/mixins/moving_time.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Strava
+  module Models
+    module Mixins
+      module MovingTime
+        extend ActiveSupport::Concern
+        include TimeInHours
+
+        included do
+          property 'moving_time'
+        end
+
+        def moving_time_in_hours_s
+          time_in_hours_s moving_time
+        end
+      end
+    end
+  end
+end

data/lib/strava/models/mixins/sport_type.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module Strava
+  module Models
+    module Mixins
+      module SportType
+        extend ActiveSupport::Concern
+
+        included do
+          # deprecated, property 'type'
+          property 'sport_type'
+        end
+
+        def distance_s
+          if sport_type == 'Swim'
+            distance_in_meters_s
+          else
+            distance_in_kilometers_s
+          end
+        end
+
+        def pace_s
+          case sport_type
+          when 'Swim'
+            pace_per_100_meters_s
+          else
+            pace_per_kilometer_s
+          end
+        end
+
+        def sport_type_emoji
+          case sport_type
+          when 'AlpineSki' then '⛷️'
+          when 'BackcountrySki' then '🎿️'
+          # when "Canoeing" then ''
+          # when "Crossfit" then ''
+          # when "Elliptical" then ''
+          when 'Golf' then '🏌️'
+          # when "Handcycle" then ''
+          when 'Hike' then '🥾'
+          when 'IceSkate' then '⛸'
+          when 'InlineSkate' then "\u{1F6FC}"
+          # when "Kayaking" then ''
+          # when "Kitesurf" then ''
+          when 'MountainBikeRide', 'EMountainBikeRide' then '🚵'
+          # when "NordicSki" then ''
+          when 'Ride', 'EBikeRide', 'VirtualRide', 'GravelRide' then '🚴'
+          when 'RockClimbing' then '🧗'
+          # when 'RollerSki' then ''
+          when 'Rowing' then '🚣'
+          when 'Run', 'VirtualRun', 'TrailRun' then '🏃'
+          when 'Sail' then '⛵️'
+          when 'Skateboard' then '🛹'
+          when 'Snowboard' then '🏂'
+          # when 'Snowshoe' then ''
+          when 'Soccer' then '⚽️'
+          # when 'StairStepper' then ''
+          # when 'StandUpPaddling' then ''
+          when 'Surfing' then '🏄'
+          when 'Swim' then '🏊'
+          # when 'Velomobile' then ''
+          when 'Walk' then '🚶'
+          when 'WeightTraining' then '🏋️'
+          when 'Wheelchair' then '♿'
+          # when 'Windsurf' then ''
+          # when 'Workout' then ''
+          when 'Yoga' then '🧘'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/strava/models/mixins/time_in_hours.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Strava
+  module Models
+    module Mixins
+      module TimeInHours
+        extend ActiveSupport::Concern
+
+        private
+
+        def time_in_hours_s(time)
+          return unless time
+
+          hours = time / 3600 % 24
+          minutes = time / 60 % 60
+          seconds = time % 60
+          [
+            hours.to_i.positive? ? format('%dh', hours) : nil,
+            minutes.to_i.positive? ? format('%dm', minutes) : nil,
+            seconds.to_i.positive? ? format('%ds', seconds) : nil
+          ].compact.join
+        end
+      end
+    end
+  end
+end

data/lib/strava/models/mixins/{elevation.rb → total_elevation_gain.rb}

@@ -3,7 +3,7 @@
 module Strava
   module Models
     module Mixins
-      module Elevation
+      module TotalElevationGain
         extend ActiveSupport::Concern
 
         included do

data/lib/strava/models/photos_summary.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Strava
+  module Models
+    # https://developers.strava.com/docs/reference/#api-models-PhotosSummary
+    class PhotosSummary < Strava::Models::Response
+      property 'count'
+      property 'use_primary_photo' # undocumented
+      property 'primary', transform_with: ->(v) { Strava::Models::PhotosSummaryPrimary.new(v) }
+    end
+  end
+end

data/lib/strava/models/photos_summary_primary.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Strava
+  module Models
+    # https://developers.strava.com/docs/reference/#api-models-PhotosSummary_primary
+    class PhotosSummaryPrimary < Strava::Models::Response
+      property 'id'
+      property 'source'
+      property 'unique_id'
+      property 'urls'
+      # undocumented
+      property 'media_type'
+    end
+  end
+end

data/lib/strava/models/power_zone_ranges.rb

@@ -2,6 +2,7 @@
 
 module Strava
   module Models
+    # https://developers.strava.com/docs/reference/#api-models-PowerZoneRanges
     class PowerZoneRanges < Strava::Models::Response
       property 'zones', transform_with: ->(v) { v.map { |r| Strava::Models::ZoneRange.new(r) } }
     end

data/lib/strava/models/route.rb

@@ -2,28 +2,29 @@
 
 module Strava
   module Models
+    # https://developers.strava.com/docs/reference/#api-models-Route
     class Route < Strava::Models::Response
+      property 'athlete', transform_with: ->(v) { Strava::Models::SummaryAthlete.new(v) }
+      property 'description'
       include Mixins::Distance
-      include Mixins::Elevation
-      include Mixins::Time
-
+      include Mixins::ElevationGain
       property 'id'
-      property 'athlete', transform_with: ->(v) { Strava::Models::Athlete.new(v) }
-      property 'name'
-      property 'description'
-      property 'total_elevation_gain', from: 'elevation_gain'
+      property 'id_str'
       property 'map', transform_with: ->(v) { Strava::Models::Map.new(v) }
+      property 'name'
       property 'private'
-      property 'resource_state'
       property 'starred'
-      property 'sub_type'
       property 'timestamp', transform_with: ->(v) { Time.at(v) }
+      property 'type'
+      property 'sub_type'
       property 'created_at', transform_with: ->(v) { Time.parse(v) }
       property 'updated_at', transform_with: ->(v) { Time.parse(v) }
-      property 'type'
-      property 'estimated_moving_time'
-      property 'moving_time', from: 'estimated_moving_time'
-      property 'segments', transform_with: ->(v) { v.map { |r| Strava::Models::Segment.new(r) } }
+      include Mixins::EstimatedMovingTime
+      property 'segments', transform_with: ->(v) { v.map { |r| Strava::Models::SummarySegment.new(r) } }
+      property 'waypoints', transform_with: ->(v) { v.map { |r| Strava::Models::Waypoint.new(r) } }
+      # undocumented
+      property 'map_urls'
+      property 'resource_state'
     end
   end
 end

data/lib/strava/models/similar_activities.rb

@@ -2,6 +2,7 @@
 
 module Strava
   module Models
+    # Undocumented
     class SimilarActivities < Strava::Models::Response
       property 'average_speed'
       property 'resource_state'
@@ -14,6 +15,7 @@ module Strava
       property 'min_speed'
       property 'speeds'
       property 'trend', transform_with: ->(v) { Strava::Models::Trend.new(v) }
+      property 'pr_rank'
     end
   end
 end

data/lib/strava/models/split.rb

@@ -2,16 +2,18 @@
 
 module Strava
   module Models
+    # https://developers.strava.com/docs/reference/#api-models-Split
     class Split < Strava::Models::Response
+      include Mixins::AverageSpeed
       include Mixins::Distance
-      include Mixins::Time
-      include Mixins::Elevation
-
-      property 'elevation_difference'
-      property 'total_elevation_gain', from: 'elevation_difference'
+      include Mixins::ElapsedTime
+      include Mixins::ElevationDifference
+      property 'pace_zone'
+      include Mixins::MovingTime
       property 'split'
+      # undocumented
+      property 'average_grade_adjusted_speed'
       property 'average_heartrate'
-      property 'pace_zone'
     end
   end
 end

data/lib/strava/models/stats_visibility.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Strava
+  module Models
+    # Undocumented
+    class StatsVisibility < Strava::Models::Response
+      property 'type'
+      property 'visibility'
+    end
+  end
+end

data/lib/strava/models/stream_set.rb

@@ -2,9 +2,10 @@
 
 module Strava
   module Models
+    # https://developers.strava.com/docs/reference/#api-models-StreamSet
     class StreamSet < Strava::Models::Response
-      property 'distance', transform_with: ->(v) { Strava::Models::Stream.new(v) }
       property 'time', transform_with: ->(v) { Strava::Models::Stream.new(v) }
+      property 'distance', transform_with: ->(v) { Strava::Models::Stream.new(v) }
       property 'latlng', transform_with: ->(v) { Strava::Models::Stream.new(v) }
       property 'altitude', transform_with: ->(v) { Strava::Models::Stream.new(v) }
       property 'velocity_smooth', transform_with: ->(v) { Strava::Models::Stream.new(v) }

data/lib/strava/models/summary_activity.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Strava
+  module Models
+    # https://developers.strava.com/docs/reference/#api-models-SummaryActivity
+    class SummaryActivity < Strava::Models::Response
+      property 'id'
+      property 'external_id'
+      property 'upload_id'
+      property 'athlete', transform_with: ->(v) { Strava::Models::MetaAthlete.new(v) }
+      property 'name'
+      include Mixins::Distance
+      include Mixins::MovingTime
+      include Mixins::ElapsedTime
+      include Mixins::TotalElevationGain
+      property 'elev_high'
+      property 'elev_low'
+      include Mixins::SportType
+      property 'start_date', transform_with: ->(v) { Time.parse(v) }
+      include Mixins::StartDateLocal
+      property 'timezone'
+      property 'start_latlng', transform_with: ->(v) { Strava::Models::LatLng.new(v) }
+      property 'end_latlng', transform_with: ->(v) { Strava::Models::LatLng.new(v) }
+      property 'achievement_count'
+      property 'kudos_count'
+      property 'comment_count'
+      property 'athlete_count'
+      property 'photo_count'
+      property 'total_photo_count'
+      property 'map', transform_with: ->(v) { Strava::Models::Map.new(v) }
+      property 'trainer'
+      property 'commute'
+      property 'manual'
+      property 'private'
+      property 'flagged'
+      property 'workout_type'
+      property 'upload_id_str'
+      property 'average_speed'
+      property 'max_speed'
+      property 'has_kudoed'
+      property 'hide_from_home'
+      property 'gear_id'
+      property 'kilojoules'
+      property 'average_watts'
+      property 'device_watts'
+      property 'max_watts'
+      property 'weighted_average_watts'
+      # undocumented
+      property 'resource_state'
+      property 'visibility'
+      property 'utc_offset'
+      property 'location_city'
+      property 'location_state'
+      property 'location_country'
+      property 'average_cadence'
+      property 'average_temp'
+      property 'has_heartrate'
+      property 'average_heartrate'
+      property 'max_heartrate'
+      property 'heartrate_opt_out'
+      property 'display_hide_heartrate_option'
+      property 'from_accepted_tag'
+      property 'pr_count'
+      property 'suffer_score'
+
+      def strava_url
+        "https://www.strava.com/activities/#{id}"
+      end
+    end
+  end
+end

data/lib/strava/models/summary_athlete.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Strava
+  module Models
+    # https://developers.strava.com/docs/reference/#api-models-SummaryAthlete
+    class SummaryAthlete < Strava::Models::Response
+      property 'id'
+      property 'resource_state'
+      property 'firstname'
+      property 'lastname'
+      property 'profile_medium'
+      property 'profile'
+      property 'city'
+      property 'state'
+      property 'country'
+      property 'sex'
+      property 'premium'
+      property 'summit'
+      property 'created_at', transform_with: ->(v) { Time.parse(v) }
+      property 'updated_at', transform_with: ->(v) { Time.parse(v) }
+
+      def name
+        [firstname, lastname].compact.join(' ') if firstname || lastname
+      end
+
+      def strava_url
+        "https://www.strava.com/athletes/#{id}"
+      end
+    end
+  end
+end

data/lib/strava/models/summary_club.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Strava
+  module Models
+    # https://developers.strava.com/docs/reference/#api-models-SummaryClub
+    class SummaryClub < Strava::Models::Response
+      property 'id'
+      property 'resource_state'
+      property 'name'
+      property 'profile_medium'
+      property 'cover_photo'
+      property 'cover_photo_small'
+      property 'sport_type'
+      property 'activity_types'
+      property 'city'
+      property 'state'
+      property 'country'
+      property 'private'
+      property 'member_count'
+      property 'featured'
+      property 'verified'
+      property 'url'
+      # undocumented
+      property 'profile'
+      property 'activity_types_icon'
+      property 'dimensions'
+      property 'localized_sport_type'
+
+      def strava_url
+        "https://www.strava.com/clubs/#{url || id}"
+      end
+    end
+  end
+end

data/lib/strava/models/summary_gear.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Strava
+  module Models
+    # https://developers.strava.com/docs/reference/#api-models-SummaryGear
+    class SummaryGear < Strava::Models::Response
+      property 'id'
+      property 'resource_state'
+      property 'primary'
+      property 'name'
+      include Mixins::Distance
+      # undocumented
+      property 'nickname'
+      property 'retired'
+      property 'converted_distance'
+    end
+  end
+end

data/lib/strava/models/summary_pr_segment_effort.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Strava
+  module Models
+    # https://developers.strava.com/docs/reference/#api-models-SummaryPRSegmentEffort
+    class SummaryPRSegmentEffort < Strava::Models::Response
+      property 'pr_activity_id'
+      property 'pr_elapsed_time'
+      property 'pr_date', transform_with: ->(v) { Date.parse(v) }
+      property 'effort_count'
+      # undocumented
+      property 'pr_visibility'
+      property 'pr_activity_visibility'
+    end
+  end
+end