strava-ruby-client 1.0.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a5e44d1ea369bd76dcb67ad565ca9fcec2d08ec9b23d36fc4fa0adb7778e1369
-  data.tar.gz: 3ac1ef728ebab982443e70ed8952bbd4c23f9e4e1b1669a05aca7382e600c98e
+  metadata.gz: dce678ec9f5b6b9bfca53c7c40f11557a4f779949ccf1bcc08b0aab2c5dff911
+  data.tar.gz: 656ed8118cd0983e7f259f509d756e80bcc8fe40da7396e2b8be443cd794191b
 SHA512:
-  metadata.gz: 5ca82022fa51f2b3426b86fc3479f81f57bb64bebafa61390797094579528ee8e071ffb23b8407591109ee5091aaa09cfb151216b9e080d9087fecd3e3fc3a20
-  data.tar.gz: c1ef1cce00c099c33b77b74981d3d7121c8577ad15f5dc135a56eb7da7ba1543356001efc2285a474ab66c15486d5a6bab898b6ca602857530f540dcbfcf5907
+  metadata.gz: 1674b1059b314e60baa3b404df1f37d9c968e340985b00385b4ee33a66730b55f55ca096263498e438101deaefe218e7146ab3ac83b1931c48c59619064375f7
+  data.tar.gz: 5292d8c10f1a41128dc746df559fb8d3ec2fc62920710acea8b402a8160b701441e36a51b3bfb81471ddf06489d4437016ab7ff30382fb8952cdd4d9518cabe5

data/CHANGELOG.md

@@ -1,6 +1,11 @@
-### 1.0.1 (2023/02/11)
-
-* [#73](https://github.com/dblock/strava-ruby-client/pull/73): Fixes serialization causing `stack level too deep` - [@simonneutert](https://github.com/simonneutert).
+### 2.0.0 (2023/6/22)
+
+* [#77](https://github.com/dblock/strava-ruby-client/pull/77): Drops unsupported endpoint/method `activity_photos` - [@simonneutert](https://github.com/simonneutert).
+* [#62](https://github.com/dblock/strava-ruby-client/pull/68): Drops `Activity#type` attribute as it is being deprecated by Strava, dropping `Activity#type_emoji` with it - [@simonneutert](https://github.com/simonneutert).
+* [#23](https://github.com/dblock/strava-ruby-client/pull/23): Failed uploads raise Strava::Errors::UploadError - [@ylecuyer](https://github.com/ylecuyer), [@simonneutert](https://github.com/simonneutert).
+* [#69](https://github.com/dblock/strava-ruby-client/pull/69): Raises `Strava::Api::RatelimitError`, when API ratelimit exceeded - [@simonneutert](https://github.com/simonneutert).
+* [#74](https://github.com/dblock/strava-ruby-client/pull/74): Fixes serialization causing `stack level too deep` - [@simonneutert](https://github.com/simonneutert).
+* [#75](https://github.com/dblock/strava-ruby-client/pull/75): Fixes DangerBot deprecation warning for `check` of TOC - [@simonneutert](https://github.com/simonneutert).
 
 ### 1.0.0 (2022/12/29)
 

data/README.md

@@ -14,7 +14,6 @@ Unlike other clients, including [strava-api-v3](https://github.com/jaredholdcrof
   - [Activities](#activities)
     - [Create an Activity](#create-an-activity)
     - [Get Activity](#get-activity)
-    - [List Activity Photos](#list-activity-photos)
     - [List Activity Comments](#list-activity-comments)
     - [List Activity Kudoers](#list-activity-kudoers)
     - [List Activity Laps](#list-activity-laps)
@@ -64,6 +63,7 @@ Unlike other clients, including [strava-api-v3](https://github.com/jaredholdcrof
     - [Command Line OAuth Workflow](#command-line-oauth-workflow)
   - [Webhooks](#webhooks)
   - [Ratelimit](#ratelimit)
+    - [Exceeded Ratelimit](#exceeded-ratelimit)
 - [Configuration](#configuration)
   - [Web Client Options](#web-client-options)
   - [API Client Options](#api-client-options)
@@ -149,29 +149,6 @@ google_image_url = "https://maps.googleapis.com/maps/api/staticmap?maptype=roadm
 
 See [Strava::Models::Map](lib/strava/models/map.rb) for all available properties.
 
-#### List Activity Photos
-
-Returns the photos on the given activity. This API is undocumented.
-
-```ruby
-photos = client.activity_photos(1982980795) # => Array[Strava::Models::Photo]
-
-photo = photos.first # => Strava::Models::Photo
-
-photo.id # => nil
-photo.unique_id # => '65889142-538D-4EE5-96F5-3DC3B773B1E3'
-photo.urls # => { '0' => 'https://dgtzuqphqg23d.cloudfront.net/eb4DMJ2hJW3k_g9URZEMfaJ8rZfHagrNlZRuEZz0osU-29x64.jpg' }
-photo.athlete_id # => 26_462_176
-photo.activity_id # => 1_946_417_534
-photo.activity_name # => 'TCS NYC Marathon 2018'
-photo.created_at # => Time
-photo.uploaded_at # => Time
-photo.sizes # => { '0' => [29, 64] }
-photo.default_photo # => false
-```
-
-See [Strava::Models::Photo](lib/strava/models/photo.rb) for all available properties.
-
 #### List Activity Comments
 
 Returns the comments on the given activity.
@@ -226,7 +203,6 @@ activity = activities.first # => Strava::Models::Activity
 
 activity.name # => 'NYC TCS Marathon 2018'
 activity.strava_url # => 'https://www.strava.com/activities/1477353766'
-activity.type_emoji # => '🏃'
 activity.sport_type_emoji # => '🏃'
 activity.distance_s # => '42.2km'
 activity.moving_time_in_hours_s # => '3h38m5s'
@@ -711,7 +687,7 @@ See [Strava::Models::StreamSet](lib/strava/models/stream_set.rb) and [Strava::Mo
 
 #### Upload Activity
 
-Uploads a new data file to create an activity from.
+Uploads a new data file to create an activity from. To check the processing status of the uploaded file, see [Get Upload](#get-upload).
 
 ```ruby
 upload = client.create_upload(
@@ -733,9 +709,10 @@ See [Strava::Models::Upload](lib/strava/models/upload.rb) for all available prop
 
 #### Get Upload
 
-Returns an upload for a given identifier.
+Returns an upload for a given identifier. Raises `Strava::Errors::UploadError` if the upload was faulty and did not result in a created activity. `Strava::Errors::UploadError#upload` contains `Strava::Models::Upload` for further inspection.
 
 ```ruby
+# happy path
 upload = client.upload(2136460097) # => Strava::Models::Upload
 
 upload.id # => 2_136_460_097
@@ -745,7 +722,29 @@ upload.status # => 'Your activity is ready.'
 upload.activity_id # => 1_998_557_443
 ```
 
-See [Strava::Models::Upload](lib/strava/models/upload.rb) for all available properties.
+```ruby
+# with error after upload
+upload = client.upload(2136460097) 
+begin
+  while upload.processing?
+    sleep 1
+    upload = client.upload(2136460097)
+  end
+rescue Strava::Errors::UploadError => upload_error
+  upload_error.status # => 200
+  upload_error.error_status # => 'There was an error processing your activity.'
+  upload_error.message # => '17611540601.tcx duplicate of activity 8309312818'
+  
+  upload_error.upload.external_id # => nil
+  upload_error.upload.activity_id # => nil
+  upload_error.upload.status # => 'There was an error processing your activity.'
+  upload_error.upload.error # => '17611540601.tcx duplicate of activity 8309312818'
+  upload_error.upload.class # => Strava::Models::UploadFailed
+end
+```
+
+See [Strava::Models::Upload](lib/strava/models/upload.rb) for all available properties.  
+See [Strava::Errors::UploadError](lib/strava/errors/upload_failed_error.rb) for all available properties.
 
 ### Pagination
 
@@ -947,6 +946,16 @@ You can access the Hash containing all limits by calling `to_h`.
 }
 ```
 
+#### Exceeded Ratelimit
+
+Strava answers with HTTP status code 429, when ratelimits are exceeded. This will in return raise `Strava::Errors::RatelimitError`.
+
+```ruby
+error.is_a?(Strava::Errors::RatelimitError) #=> true
+error.ratelimit.is_a?(Strava::Api::Ratelimit) #=> true
+# see Strava::Api::Ratelimit
+```
+
 ## Configuration
 
 ### Web Client Options

data/bin/strava-oauth-token

@@ -2,8 +2,8 @@
 # frozen_string_literal: true
 
 require 'dotenv/load'
-require 'strava-ruby-client'
 require 'webrick'
+require 'strava-ruby-client'
 
 server = WEBrick::HTTPServer.new(Port: 4242)
 

data/bin/strava-webhooks

@@ -2,8 +2,8 @@
 # frozen_string_literal: true
 
 require 'dotenv/load'
-require 'strava-ruby-client'
 require 'webrick'
+require 'strava-ruby-client'
 
 logger = ::Logger.new($stdout)
 logger.level = Logger::INFO

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

@@ -37,21 +37,6 @@ module Strava
           paginate "activities/#{id}/comments", options, Strava::Models::Comment, &block
         end
 
-        #
-        # List activity photos.
-        #
-        # @option options [String] :id
-        #   Activity id.
-        # @option options [Integer] :page
-        #   Page number.
-        # @option options [Integer] :per_page
-        #   Number of items per page. Defaults to 30.
-        #
-        def activity_photos(id_or_options, options = {}, &block)
-          id, options = parse_args(id_or_options, options)
-          paginate "activities/#{id}/photos", options, Strava::Models::Photo, &block
-        end
-
         #
         # List activity kudoers.
         #
@@ -125,7 +110,7 @@ module Strava
         #   The description of the activity.
         # @option options [String] :name
         #   The name of the activity.
-        # @option options [String] :type
+        # @option options [String] :sport_type
         #   Activity type.
         # @option options [String] :gear_id
         #   Identifier for the gear associated with the activity. Specifying "none" clears gear from activity.

data/lib/strava/api/ratelimit.rb

@@ -9,6 +9,20 @@ module Strava
         @body = response.body
       end
 
+      def exceeded
+        return false unless limit?
+
+        @exceeded ||= if fifteen_minutes_remaining && fifteen_minutes_remaining <= 0
+                        { fifteen_minutes_remaining: fifteen_minutes_remaining }
+                      elsif total_day_remaining && total_day_remaining <= 0
+                        { total_day_remaining: total_day_remaining }
+                      end
+      end
+
+      def exceeded?
+        !!exceeded
+      end
+
       def to_s
         to_h.map do |k, v|
           "#{k}: #{v}"

data/lib/strava/errors/ratelimit_error.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Strava
+  module Errors
+    class RatelimitError < ::Faraday::ClientError
+      attr_reader :http_response, :ratelimit, :error_message
+
+      def initialize(http_response, error_message = nil)
+        @response = http_response.response
+        @ratelimit = Strava::Api::Ratelimit.new(@response)
+        @error_message = error_message || message
+        super({
+          status: http_response.status,
+          headers: http_response.response_headers,
+          body: http_response.body
+        })
+      end
+
+      def message
+        response[:body]['message'] || super
+      end
+
+      def headers
+        response[:headers]
+      end
+
+      def errors
+        response[:body]['errors']
+      end
+    end
+  end
+end

data/lib/strava/errors/upload_error.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Strava
+  module Errors
+    class UploadError < ::Faraday::ClientError
+      def status
+        response[:status]
+      end
+
+      def headers
+        response[:headers]
+      end
+
+      def message
+        body[:error] || super
+      end
+
+      def error_status
+        body[:status]
+      end
+
+      def upload
+        @upload ||= Strava::Models::Upload.new(body)
+      end
+
+      private
+
+      def body
+        (response[:body] || {}).with_indifferent_access
+      end
+    end
+  end
+end

data/lib/strava/models/activity.rb

@@ -13,7 +13,6 @@ module Strava
       property 'athlete', transform_with: ->(v) { Strava::Models::Athlete.new(v) }
       property 'name'
       property 'description'
-      property 'type' # deprecated
       property 'sport_type'
       property 'workout_type'
       property 'id'
@@ -80,7 +79,7 @@ module Strava
       property 'leaderboard_opt_out'
 
       def distance_s
-        if type == 'Swim'
+        if sport_type == 'Swim'
           distance_in_meters_s
         else
           distance_in_kilometers_s
@@ -88,7 +87,7 @@ module Strava
       end
 
       def pace_s
-        case type
+        case sport_type
         when 'Swim'
           pace_per_100_meters_s
         else
@@ -139,44 +138,6 @@ module Strava
         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 '🏃'
-        when 'Ride', 'EBikeRide', 'VirtualRide' then '🚴'
-        when 'Swim' then '🏊'
-        when 'Walk' then '🚶'
-        when 'AlpineSki' then '⛷️'
-        when 'BackcountrySki' then '🎿️'
-        # when 'Canoeing' then ''
-        # when 'Crossfit' then ''
-        # when 'Elliptical' then ''
-        # when 'Hike' then ''
-        when 'IceSkate' then '⛸️'
-        # when 'InlineSkate' then ''
-        # when 'Kayaking' then ''
-        # when 'Kitesurf' then ''
-        # when 'NordicSki' then ''
-        when 'RockClimbing' then '🧗'
-        when 'RollerSki' then ''
-        when 'Rowing' then '🚣'
-        when 'Snowboard' then '🏂'
-        # when 'Snowshoe' then ''
-        # when 'StairStepper' then ''
-        # when 'StandUpPaddling' then ''
-        when 'Surfing' then '🏄'
-        when 'WeightTraining' then '🏋️'
-        # when 'Windsurf' then ''
-        when 'Wheelchair' then '♿'
-          # when 'Workout' then ''
-          # when 'Yoga'' then ''
-        end
-      end
     end
   end
 end

data/lib/strava/models/upload.rb

@@ -8,6 +8,40 @@ module Strava
       property 'error'
       property 'status'
       property 'activity_id'
+
+      def processing?
+        validate!
+        activity_id.nil?
+      end
+
+      def processed?
+        !processing?
+      end
+
+      private
+
+      def validate!
+        raise_when_background_job_failed!
+      end
+
+      def raise_when_background_job_failed!
+        response = http_response.response
+        return unless response_contains_error_message?(response)
+
+        raise Strava::Errors::UploadError, response_values(response)
+      end
+
+      def response_contains_error_message?(response)
+        response.status == 200 && response.body['error'].present?
+      end
+
+      def response_values(response)
+        {
+          status: response.status,
+          headers: response.headers,
+          body: response.body
+        }
+      end
     end
   end
 end

data/lib/strava/version.rb

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

data/lib/strava/web/raise_response_error.rb

@@ -12,6 +12,8 @@ module Strava
         when 407
           # mimic the behavior that we get with proxy requests with HTTPS
           raise Faraday::ConnectionFailed, %(407 "Proxy Authentication Required ")
+        when 429
+          raise Strava::Errors::RatelimitError.new(env, 'Too Many Requests')
         when CLIENT_ERROR_STATUSES
           raise Strava::Errors::Fault, response_values(env)
         end

data/lib/strava-ruby-client.rb

@@ -17,11 +17,13 @@ require_relative 'strava/logger'
 require_relative 'strava/deep_copyable'
 
 require_relative 'strava/errors/fault'
+require_relative 'strava/errors/upload_error'
+require_relative 'strava/errors/ratelimit_error'
 
-require_relative 'strava/models/mixins/http_response'
+require_relative 'strava/models/mixins/time'
 require_relative 'strava/models/mixins/distance'
 require_relative 'strava/models/mixins/elevation'
-require_relative 'strava/models/mixins/time'
+require_relative 'strava/models/mixins/http_response'
 require_relative 'strava/models/mixins/start_date_local'
 
 require_relative 'strava/models/model'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: strava-ruby-client
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Daniel Doubrovkine
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-11 00:00:00.000000000 Z
+date: 2023-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -98,6 +98,8 @@ files:
 - lib/strava/api/ratelimit.rb
 - lib/strava/deep_copyable.rb
 - lib/strava/errors/fault.rb
+- lib/strava/errors/ratelimit_error.rb
+- lib/strava/errors/upload_error.rb
 - lib/strava/logger.rb
 - lib/strava/models/achievement.rb
 - lib/strava/models/activity.rb
@@ -177,7 +179,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.4.12
 signing_key:
 specification_version: 4
 summary: Strava API Ruby client.