strava-ruby-client 2.1.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b7cecf53fa55d912d8f4a4e2c8d62621f3f4aa386315745de5792bfe45328ae
-  data.tar.gz: f9ee4eaea70ead74645748d557e9f316346aca2fc49ec0e5c37b55e5ba4ae0ee
+  metadata.gz: cf5d841beeb197335a49b5f4ae7fa7bd79b3bf80c1a89cb3aa5bc30cfebfb2c6
+  data.tar.gz: bd93eaa177d2d0a8cb246044b85a925bf41048b52a3302d79c96a7457165c9d2
 SHA512:
-  metadata.gz: c9bb8c36fa560060cd2ee5ea7f4cda88bb4d2a9b4f5b2a278dc39a99260c56727ce90cb1c09b17ccb9dfad624829934ae10049ff05d58a06009559e7b2ed6161
-  data.tar.gz: 05f4a34f12d7e9691c0f7446e0381bf52bbda3f55fdaad57c018eb128e30f8938784f1a5b327de2dcb8fd3b32841946b495883a8b1a27fbfdba84e958d0f71ce
+  metadata.gz: 0e043d78ea904e7c8b9f52b657ba78e10acfed435e6b29101091ba62f0eb45b1594ce9b52c51b7ca3d7b7ddf3a080d2dd95c141f3a6aa99dacc21a35466fd809
+  data.tar.gz: d5d736e51985381b95e30a5893bb15b0e37e1d41d71b8eab0e5e580a83ce2c95930a821e16b6621ff41d1f70bc3ec62d26b3c4fc09f0be6a96124279c24b5733

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+### 2.3.0 (2025/10/16)
+
+* [#91](https://github.com/dblock/strava-ruby-client/pull/91): Respects `Faraday::Response::RaiseError::DEFAULT_OPTIONS` when raising errors - [@dblock](https://github.com/dblock).
+* [#87](https://github.com/dblock/strava-ruby-client/pull/87): Prepares v2.3.0 by improving the event specs - [@simonneutert](https://github.com/simonneutert).
+* [#86](https://github.com/dblock/strava-ruby-client/pull/86): Adds description to club event model - [@tobiaszwaszak](https://github.com/tobiaszwaszak).
+
+### 2.2.0 (2024/9/17)
+
+* [#83](https://github.com/dblock/strava-ruby-client/pull/83): Adds back activity photos - [@dillon-co](https://github.com/dillon-co).
+* [#84](https://github.com/dblock/strava-ruby-client/pull/84): Adds back activity photos (finished PR #83) - [@simonneutert](https://github.com/simonneutert).
+* [#85](https://github.com/dblock/strava-ruby-client/pull/85): Lays groundwork to v3.0.0 of the gem (ruby3, newest rubocop, rubocop-rake and rubocop-rspec) - [@simonneutert](https://github.com/simonneutert).
+
 ### 2.1.0 (2024/3/20)
 
 * [#80](https://github.com/dblock/strava-ruby-client/pull/80): Removes default values for Faraday's SSL settings `ca_file` and `ca_path` - [@dblock](https://github.com/dblock).

data/README.md

@@ -14,6 +14,7 @@ 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)
@@ -96,6 +97,23 @@ Use an access token obtained from [My API Application](https://www.strava.com/se
 client = Strava::Api::Client.new(
   access_token: "12345678987654321"
 )
+
+client.athlete # => Strava::Models::Athlete
+```
+
+Note that the token from the Strava website does not have enough permissions to retrieve your own activities. Use the [strava-oauth-token tool](#strava-oauth-token) to obtain a short lived with more access scopes.
+
+```bash
+export STRAVA_CLIENT_ID=...
+export STRAVA_CLIENT_SECRET=...
+bundle exec ruby bin/strava-oauth-token
+```
+
+Note the `access_token` from the browser window.
+
+```bash
+export STRAVA_ACCESS_TOKEN=...
+bundle exec ruby bin/strava-activities.rb
 ```
 
 ### Activities
@@ -136,19 +154,51 @@ See [Strava::Models::Activity](lib/strava/models/activity.rb) for all available
 Use `map.summary_polyline` and combine with [polylines](https://github.com/joshuaclayton/polylines) to parse the activity map and to construct a Google maps URL with start and end markers.
 
 ```ruby
+require 'cgi'
+require 'polylines'
+
 map = activity.map # => Strava::Models::Map
 
 decoded_summary_polyline = Polylines::Decoder.decode_polyline(map.summary_polyline)
 start_latlng = decoded_summary_polyline[0]
 end_latlng = decoded_summary_polyline[-1]
 
+# Google Maps Static API
 google_maps_api_key = ENV['GOOGLE_STATIC_MAPS_API_KEY']
+google_image_url = "https://maps.googleapis.com/maps/api/staticmap?maptype=roadmap&path=enc:#{CGI.escape(map.summary_polyline)}&size=800x800&markers=color:yellow|label:S|#{start_latlng[0]},#{start_latlng[1]}&markers=color:green|label:F|#{end_latlng[0]},#{end_latlng[1]}&key=#{google_maps_api_key}"
 
-google_image_url = "https://maps.googleapis.com/maps/api/staticmap?maptype=roadmap&path=enc:#{map.summary_polyline}&key=#{google_maps_api_key}&size=800x800&markers=color:yellow|label:S|#{start_latlng[0]},#{start_latlng[1]}&markers=color:green|label:F|#{end_latlng[0]},#{end_latlng[1]}"
+# MapBox Static API
+mapbox_access_token = ENV['MAPBOX_ACCESS_TOKEN']
+mapbox_image_url = "https://api.mapbox.com/styles/v1/mapbox/streets-v11/static/path-5+787af2-1.0(#{CGI.escape(map.summary_polyline)}),pin-s-s+e5b22e(#{start_latlng[1]},#{start_latlng[0]}),pin-s-f+89ae00(#{end_latlng[1]},#{end_latlng[0]})/auto/800x800?access_token=#{mapbox_access_token}"
 ```
 
 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 in Strava's docs. But there is a discussion in the [strava community hub](https://communityhub.strava.com/t5/developer-discussions/download-all-photos-of-my-own-activities/m-p/11262).
+
+```ruby
+photos = client.activity_photos(1982980795) # => Array[Strava::Models::Photo]
+# in order to request a certain size (by default it will return the biggest size possible):
+# photos = client.activity_photos(1982980795, {size: 1920}) # => 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.
@@ -1072,6 +1122,12 @@ rescue Strava::Errors::Fault => e
 end
 ```
 
+Faraday can optionally exclude HTTP method, path and query params from the errors raised. The client implementation options will now default to `Faraday::Response::RaiseError::DEFAULT_OPTIONS` with `include_request` set to `true`. You can change this behavior by setting `Strava::Web::RaiseResponseError::DEFAULT_OPTIONS`.
+
+```ruby
+Strava::Web::RaiseResponseError::DEFAULT_OPTIONS = { include_request: false }
+```
+
 ## Tools
 
 For a complete set of command-line tools, check out [strava-ruby-cli](https://github.com/dblock/strava-ruby-cli) built on top of this gem.

data/bin/strava-activities.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'strava-ruby-client'
+
+access_token = ENV['STRAVA_ACCESS_TOKEN'] || raise("Missing ENV['STRAVA_ACCESS_TOKEN'].")
+
+client = Strava::Api::Client.new(
+  access_token: access_token
+)
+
+client.athlete_activities.each do |activity|
+  puts activity.name
+end

data/bin/strava-webhooks

@@ -5,7 +5,7 @@ require 'dotenv/load'
 require 'webrick'
 require 'strava-ruby-client'
 
-logger = ::Logger.new($stdout)
+logger = Logger.new($stdout)
 logger.level = Logger::INFO
 
 client = Strava::Webhooks::Client.new(

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

@@ -37,6 +37,22 @@ 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)
+          options[:size] = 5000 unless options[:size] # to retrieve full size photos
+          paginate "activities/#{id}/photos", options, Strava::Models::Photo, &block
+        end
+
         #
         # List activity kudoers.
         #

data/lib/strava/api/pagination.rb

@@ -48,8 +48,8 @@ module Strava
 
       private
 
-      def method_missing(method_symbol, *args, &block)
-        @collection.send(method_symbol, *args, &block)
+      def method_missing(method_symbol, ...)
+        @collection.send(method_symbol, ...)
       end
 
       def respond_to_missing?(method_name, include_private = false)

data/lib/strava/errors/ratelimit_error.rb

@@ -3,17 +3,11 @@
 module Strava
   module Errors
     class RatelimitError < ::Faraday::ClientError
-      attr_reader :http_response, :ratelimit, :error_message
+      attr_reader :ratelimit
 
-      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
-        })
+      def initialize(env, response)
+        @ratelimit = Strava::Api::Ratelimit.new(env.response)
+        super(response)
       end
 
       def message

data/lib/strava/models/club_event.rb

@@ -6,6 +6,7 @@ module Strava
       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) }

data/lib/strava/version.rb

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

data/lib/strava/web/raise_response_error.rb

@@ -3,7 +3,8 @@
 module Strava
   module Web
     class RaiseResponseError < ::Faraday::Middleware
-      CLIENT_ERROR_STATUSES = (400...600).freeze
+      DEFAULT_OPTIONS = Faraday::Response::RaiseError::DEFAULT_OPTIONS
+      CLIENT_ERROR_STATUSES = (400...600)
 
       def on_complete(env)
         case env[:status]
@@ -13,18 +14,38 @@ module Strava
           # 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')
+          raise Strava::Errors::RatelimitError.new(env, response_values(env))
         when CLIENT_ERROR_STATUSES
           raise Strava::Errors::Fault, response_values(env)
         end
       end
 
       def response_values(env)
-        {
+        response = {
           status: env.status,
           headers: env.response_headers,
           body: env.body
         }
+
+        # Include the request data by default. If the middleware was explicitly
+        # configured to _not_ include request data, then omit it.
+        return response unless options[:include_request]
+
+        response.merge(
+          request: {
+            method: env.method,
+            url: env.url,
+            url_path: env.url.path,
+            params: query_params(env),
+            headers: env.request_headers,
+            body: env.request_body
+          }
+        )
+      end
+
+      def query_params(env)
+        env.request.params_encoder ||= Faraday::Utils.default_params_encoder
+        env.params_encoder.decode(env.url.query)
       end
     end
   end

data/lib/strava/web/response.rb

@@ -51,10 +51,10 @@ module Strava
       # @raise [NoMethodError]
       # @return [any]
       #
-      def operate_on_response_body!(method_symbol, *args, &block)
+      def operate_on_response_body!(method_symbol, ...)
         case @response.body
         when Hash
-          @response.body.send(method_symbol, *args, &block)
+          @response.body.send(method_symbol, ...)
         else
           raise NoMethodError
         end
@@ -75,12 +75,12 @@ module Strava
         end
       end
 
-      def method_missing(method_symbol, *args, &block)
+      def method_missing(method_symbol, ...)
         case @response
         when Array
-          @response.send(method_symbol, *args, &block)
+          @response.send(method_symbol, ...)
         else
-          operate_on_response_body!(method_symbol, *args, &block)
+          operate_on_response_body!(method_symbol, ...)
         end
       end
 

data/lib/strava/webhooks/client.rb

@@ -13,7 +13,7 @@ module Strava
       end
 
       def request(method, path, options)
-        super method, path, { client_id: client_id, client_secret: client_secret }.merge(options)
+        super(method, path, { client_id: client_id, client_secret: client_secret }.merge(options))
       end
 
       #

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: strava-ruby-client
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Daniel Doubrovkine
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-20 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -66,7 +65,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
 email: dblock@dblock.org
 executables:
 - strava-oauth-token
@@ -77,6 +75,7 @@ files:
 - CHANGELOG.md
 - LICENSE.md
 - README.md
+- bin/strava-activities.rb
 - bin/strava-oauth-token
 - bin/strava-webhooks
 - lib/strava-ruby-client.rb
@@ -164,7 +163,6 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -172,15 +170,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.6
+      version: '2.5'
 requirements: []
-rubygems_version: 3.3.7
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Strava API Ruby client.
 test_files: []