strava-ruby-client 0.4.3 → 1.0.0

data/lib/strava/api/ratelimit.rb

@@ -0,0 +1,159 @@
+# frozen_string_literal: true
+
+module Strava
+  module Api
+    class Ratelimit
+      def initialize(response)
+        @response = response
+        @headers = response.headers
+        @body = response.body
+      end
+
+      def to_s
+        to_h.map do |k, v|
+          "#{k}: #{v}"
+        end.join(', ')
+      end
+
+      #
+      # represents all valid ratelimits in a Hash
+      #
+      # @return [Hash] of ratelimits
+      #
+      def to_h
+        if limit?
+          {
+            limit: limit,
+            usage: usage,
+            total_day: total_day,
+            total_day_usage: total_day_usage,
+            total_day_remaining: total_day_remaining,
+            fifteen_minutes: fifteen_minutes,
+            fifteen_minutes_usage: fifteen_minutes_usage,
+            fifteen_minutes_remaining: fifteen_minutes_remaining
+          }
+        else
+          {}
+        end
+      end
+
+      #
+      # checks for presence of the header, as it is i.e. not included when
+      # asking for a token.
+      #
+      # @return [TrueClass]
+      #
+      def limit?
+        @headers.key?('x-ratelimit-limit')
+      end
+
+      #
+      # returns a string containing the ratelimit for 15 minutes before the comma and
+      # the daily ratelimit after the comma
+      #
+      # @return [String] of the ratelimits for 15 minutes and per day separated by comma
+      #
+      # @example
+      #   ```ruby
+      #   "600,30000"
+      #   ```
+      #
+      def limit
+        @headers['x-ratelimit-limit']
+      end
+
+      #
+      # returns a string containing the used ratelimit for 15 minutes before the comma and
+      # the daily ratelimit after the comma
+      #
+      # @return [String] of the used ratelimits for 15 minutes and per day separated by comma
+      #
+      # @example
+      #   ```ruby
+      #   "333,11337"
+      #   ```
+      #
+      def usage
+        @headers['x-ratelimit-usage']
+      end
+
+      #
+      # fifteen minute ratelimit
+      #
+      # @return [NilClass] if no ratelimit in http headers
+      # @return [Integer] representing the ratelimit
+      #
+      def fifteen_minutes
+        limit? ? extract_ratelimit!(limit).first : nil
+      end
+
+      #
+      # total day ratelimit
+      #
+      # @return [NilClass] if no ratelimit in http headers
+      # @return [Integer] representing the ratelimit
+      #
+      def total_day
+        limit? ? extract_ratelimit!(limit).last : nil
+      end
+
+      #
+      # fifteen minute ratelimit used
+      #
+      # @return [NilClass] if no ratelimit in http headers
+      # @return [Integer] representing the ratelimit
+      #
+      def fifteen_minutes_usage
+        limit? ? extract_ratelimit!(usage).first : nil
+      end
+
+      #
+      # total day ratelimit used
+      #
+      # @return [NilClass] if no ratelimit in http headers
+      # @return [Integer] representing the ratelimit
+      #
+      def total_day_usage
+        limit? ? extract_ratelimit!(usage).last : nil
+      end
+
+      #
+      # fifteen minute ratelimit remaining
+      #
+      # @return [NilClass] if no ratelimit in http headers
+      # @return [Integer] representing the ratelimit
+      #
+      def fifteen_minutes_remaining
+        return nil unless fifteen_minutes && fifteen_minutes_usage
+
+        fifteen_minutes - fifteen_minutes_usage
+      end
+
+      #
+      # total day ratelimit remaining
+      #
+      # @return [NilClass] if no ratelimit in http headers
+      # @return [Integer] representing the ratelimit
+      #
+      def total_day_remaining
+        return nil unless total_day && total_day_usage
+
+        total_day - total_day_usage
+      end
+
+      private
+
+      #
+      # ratelimit comes as a String of two Integers separated by comma
+      #
+      # @param [String] ratelimit
+      #
+      # @return [Array<Integer>]
+      #
+      def extract_ratelimit!(ratelimit)
+        @lookup_table_ratelimits ||= {}
+        @lookup_table_ratelimits[ratelimit] ||= ratelimit.split(',').map(&:to_i)
+      end
+    end
+  end
+end

data/lib/strava/deep_copyable.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Strava
+  module DeepCopyable
+    #
+    # Ruby's way of creating a true deep copy/clone
+    #
+    # @param [Object] obj of any kind
+    #
+    # @return [Object] deep clone of what was passed into
+    #
+    def deep_copy(obj)
+      Marshal.load(Marshal.dump(obj))
+    end
+  end
+end

data/lib/strava/models/achievement.rb

@@ -2,7 +2,7 @@
 
 module Strava
   module Models
-    class Achievement < Model
+    class Achievement < Strava::Models::Response
       property 'rank'
       property 'type'
       property 'type_id'

data/lib/strava/models/activity.rb

@@ -2,7 +2,7 @@
 
 module Strava
   module Models
-    class Activity < Model
+    class Activity < Strava::Models::Response
       include Mixins::Time
       include Mixins::Distance
       include Mixins::Elevation
@@ -13,7 +13,8 @@ module Strava
       property 'athlete', transform_with: ->(v) { Strava::Models::Athlete.new(v) }
       property 'name'
       property 'description'
-      property 'type'
+      property 'type' # deprecated
+      property 'sport_type'
       property 'workout_type'
       property 'id'
       property 'external_id'
@@ -99,6 +100,51 @@ module Strava
         "https://www.strava.com/activities/#{id}"
       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
+
+      #
+      # @deprecated Use {#sport_type_emoji} instead.
+      #
+      # @return [String] precisely an emoji
+      #
       def type_emoji
         case type
         when 'Run', 'VirtualRun' then '🏃'

data/lib/strava/models/activity_stats.rb

@@ -2,7 +2,7 @@
 
 module Strava
   module Models
-    class ActivityStats < Model
+    class ActivityStats < Strava::Models::Response
       property 'biggest_ride_distance'
       property 'biggest_climb_elevation_gain'
       property 'recent_ride_totals', transform_with: ->(v) { Strava::Models::ActivityTotal.new(v) }

data/lib/strava/models/activity_total.rb

@@ -2,7 +2,7 @@
 
 module Strava
   module Models
-    class ActivityTotal < Model
+    class ActivityTotal < Strava::Models::Response
       include Mixins::Distance
       include Mixins::Time
       include Mixins::Elevation

data/lib/strava/models/activity_zone.rb

@@ -2,7 +2,7 @@
 
 module Strava
   module Models
-    class ActivityZone < Model
+    class ActivityZone < Strava::Models::Response
       property 'score'
       property 'distribution_buckets', transform_with: ->(v) { v.map { |r| Strava::Models::TimedZoneRange.new(r) } }
       property 'type'

data/lib/strava/models/athlete.rb

@@ -2,7 +2,7 @@
 
 module Strava
   module Models
-    class Athlete < Model
+    class Athlete < Strava::Models::Response
       property 'id'
       property 'username'
       property 'resource_state'
@@ -18,7 +18,6 @@ module Strava
       property 'badge_type_id'
       property 'profile'
       property 'profile_medium'
-      property 'email'
       property 'follower'
       property 'friend'
       property 'summit'

data/lib/strava/models/authorization.rb

@@ -2,7 +2,7 @@
 
 module Strava
   module Models
-    class Authorization < Model
+    class Authorization < Strava::Models::Response
       property 'access_token'
     end
   end

data/lib/strava/models/club.rb

@@ -2,7 +2,7 @@
 
 module Strava
   module Models
-    class Club < Model
+    class Club < Strava::Models::Response
       property 'id'
       property 'resource_state'
       property 'name'

data/lib/strava/models/club_admin.rb

@@ -2,7 +2,7 @@
 
 module Strava
   module Models
-    class ClubAdmin < Model
+    class ClubAdmin < Strava::Models::Response
       property 'resource_state'
       property 'firstname'
       property 'lastname'

data/lib/strava/models/club_event.rb

@@ -2,7 +2,7 @@
 
 module Strava
   module Models
-    class ClubEvent < Model
+    class ClubEvent < Strava::Models::Response
       property 'id'
       property 'resource_state'
       property 'title'

data/lib/strava/models/club_member.rb

@@ -2,7 +2,7 @@
 
 module Strava
   module Models
-    class ClubMember < Model
+    class ClubMember < Strava::Models::Response
       property 'resource_state'
       property 'firstname'
       property 'lastname'

data/lib/strava/models/comment.rb

@@ -2,7 +2,7 @@
 
 module Strava
   module Models
-    class Comment < Model
+    class Comment < Strava::Models::Response
       property 'id'
       property 'activity_id'
       property 'resource_state'

data/lib/strava/models/explorer_segment.rb

@@ -2,7 +2,7 @@
 
 module Strava
   module Models
-    class ExplorerSegment < Model
+    class ExplorerSegment < Strava::Models::Response
       include Mixins::Distance
 
       property 'id'

data/lib/strava/models/gear.rb

@@ -2,7 +2,7 @@
 
 module Strava
   module Models
-    class Gear < Model
+    class Gear < Strava::Models::Response
       include Mixins::Distance
 
       property 'id'

data/lib/strava/models/heart_rate_zone_ranges.rb

@@ -2,7 +2,7 @@
 
 module Strava
   module Models
-    class HeartRateZoneRanges < Model
+    class HeartRateZoneRanges < Strava::Models::Response
       property 'custom_zones'
       property 'zones', transform_with: ->(v) { v.map { |r| Strava::Models::ZoneRange.new(r) } }
     end

data/lib/strava/models/kudoser.rb

@@ -2,7 +2,7 @@
 
 module Strava
   module Models
-    class Kudoser < Model
+    class Kudoser < Strava::Models::Response
       property 'destination_url'
       property 'display_name'
       property 'avatar_url'

data/lib/strava/models/lap.rb

@@ -2,7 +2,7 @@
 
 module Strava
   module Models
-    class Lap < Model
+    class Lap < Strava::Models::Response
       include Mixins::Time
       include Mixins::Distance
       include Mixins::Elevation

data/lib/strava/models/map.rb

@@ -2,7 +2,7 @@
 
 module Strava
   module Models
-    class Map < Model
+    class Map < Strava::Models::Response
       property 'id'
       property 'summary_polyline'
       property 'resource_state'

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Strava
+  module Models
+    module Mixins
+      module HttpResponse
+        extend ActiveSupport::Concern
+
+        included do
+          property 'http_response', transform_with: ->(v) { Strava::Web::ApiResponse.new(v) }
+        end
+      end
+    end
+  end
+end

data/lib/strava/models/photo.rb

@@ -2,7 +2,7 @@
 
 module Strava
   module Models
-    class Photo < Model
+    class Photo < Strava::Models::Response
       property 'id'
       property 'unique_id'
       property 'urls'

data/lib/strava/models/photos.rb

@@ -2,7 +2,7 @@
 
 module Strava
   module Models
-    class Photos < Model
+    class Photos < Strava::Models::Response
       property 'primary', transform_with: ->(v) { Strava::Models::Photo.new(v) }
       property 'use_primary_photo'
       property 'count'

data/lib/strava/models/power_zone_ranges.rb

@@ -2,7 +2,7 @@
 
 module Strava
   module Models
-    class PowerZoneRanges < Model
+    class PowerZoneRanges < Strava::Models::Response
       property 'zones', transform_with: ->(v) { v.map { |r| Strava::Models::ZoneRange.new(r) } }
     end
   end

data/lib/strava/models/response.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Strava
+  module Models
+    class Response < Model
+      include Mixins::HttpResponse
+    end
+  end
+end

data/lib/strava/models/route.rb

@@ -2,7 +2,7 @@
 
 module Strava
   module Models
-    class Route < Model
+    class Route < Strava::Models::Response
       include Mixins::Distance
       include Mixins::Elevation
       include Mixins::Time

data/lib/strava/models/running_race.rb

@@ -2,7 +2,7 @@
 
 module Strava
   module Models
-    class RunningRace < Model
+    class RunningRace < Strava::Models::Response
       include Mixins::Distance
 
       property 'id'

data/lib/strava/models/segment.rb

@@ -2,7 +2,7 @@
 
 module Strava
   module Models
-    class Segment < Model
+    class Segment < Strava::Models::Response
       include Mixins::Distance
       include Mixins::Elevation
       include Mixins::Time

data/lib/strava/models/segment_effort.rb

@@ -2,7 +2,7 @@
 
 module Strava
   module Models
-    class SegmentEffort < Model
+    class SegmentEffort < Strava::Models::Response
       include Mixins::Distance
       include Mixins::Time
       include Mixins::StartDateLocal

data/lib/strava/models/segment_stats.rb

@@ -2,7 +2,7 @@
 
 module Strava
   module Models
-    class SegmentStats < Model
+    class SegmentStats < Strava::Models::Response
       include Mixins::Time
 
       property 'pr_elapsed_time'

data/lib/strava/models/similar_activities.rb

@@ -2,7 +2,7 @@
 
 module Strava
   module Models
-    class SimilarActivities < Model
+    class SimilarActivities < Strava::Models::Response
       property 'average_speed'
       property 'resource_state'
       property 'effort_count'

data/lib/strava/models/split.rb

@@ -2,7 +2,7 @@
 
 module Strava
   module Models
-    class Split < Model
+    class Split < Strava::Models::Response
       include Mixins::Distance
       include Mixins::Time
       include Mixins::Elevation

data/lib/strava/models/stream.rb

@@ -2,7 +2,7 @@
 
 module Strava
   module Models
-    class Stream < Model
+    class Stream < Strava::Models::Response
       property 'original_size'
       property 'resolution'
       property 'series_type'

data/lib/strava/models/stream_set.rb

@@ -2,7 +2,7 @@
 
 module Strava
   module Models
-    class StreamSet < Model
+    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 'latlng', transform_with: ->(v) { Strava::Models::Stream.new(v) }

data/lib/strava/models/timed_zone_range.rb

@@ -2,7 +2,7 @@
 
 module Strava
   module Models
-    class TimedZoneRange < Model
+    class TimedZoneRange < Strava::Models::Response
       property 'max'
       property 'min'
       property 'time'

data/lib/strava/models/token.rb

@@ -2,7 +2,7 @@
 
 module Strava
   module Models
-    class Token < Model
+    class Token < Strava::Models::Response
       property 'token_type'
       property 'access_token'
       property 'refresh_token'

data/lib/strava/models/trend.rb

@@ -2,7 +2,7 @@
 
 module Strava
   module Models
-    class Trend < Model
+    class Trend < Strava::Models::Response
       property 'speeds'
       property 'current_activity_index'
       property 'min_speed'

data/lib/strava/models/upload.rb

@@ -2,7 +2,7 @@
 
 module Strava
   module Models
-    class Upload < Model
+    class Upload < Strava::Models::Response
       property 'id'
       property 'external_id'
       property 'error'

data/lib/strava/models/zone_range.rb

@@ -2,7 +2,7 @@
 
 module Strava
   module Models
-    class ZoneRange < Model
+    class ZoneRange < Strava::Models::Response
       property 'max'
       property 'min'
     end

data/lib/strava/models/zones.rb

@@ -2,7 +2,7 @@
 
 module Strava
   module Models
-    class Zones < Model
+    class Zones < Strava::Models::Response
       property 'heart_rate', transform_with: ->(v) { Strava::Models::HeartRateZoneRanges.new(v) }
       property 'power', transform_with: ->(v) { Strava::Models::PowerZoneRanges.new(v) }
     end

data/lib/strava/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Strava
-  VERSION = '0.4.3'
+  VERSION = '1.0.0'
 end

data/lib/strava/web/api_response.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Strava
+  module Web
+    class ApiResponse
+      attr_accessor :response, :ratelimit
+
+      #
+      # @param [Faraday::Response] http_response
+      #
+      def initialize(http_response)
+        @response = http_response
+        @ratelimit = Strava::Api::Ratelimit.new(@response)
+      end
+    end
+  end
+end