strava-ruby-client 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eae71d27881be5526b289574a16cbb6897d987008f4941d8b32172f7e40971d2
-  data.tar.gz: 8643756679123f7f0ddcd29f4755358eb27534ce48bdb0be085c080ba76c8d13
+  metadata.gz: cf5d841beeb197335a49b5f4ae7fa7bd79b3bf80c1a89cb3aa5bc30cfebfb2c6
+  data.tar.gz: bd93eaa177d2d0a8cb246044b85a925bf41048b52a3302d79c96a7457165c9d2
 SHA512:
-  metadata.gz: 92743308394842b6b9a8d6c975141537c14dd3dc857ba5085a050dc0622855e9454b8bee9a4a3ba5e4747daf206d715e16dd75b67112a152b72a011564c99453
-  data.tar.gz: 493fc2d1558ad057c1ed78ef77df83f175d47dd23e97cfd9502c4b11249f84e8651c8a9319552a7c16ec5ba8369ee70d7d6ed567eddd94cb1e4ea6e9fecc4979
+  metadata.gz: 0e043d78ea904e7c8b9f52b657ba78e10acfed435e6b29101091ba62f0eb45b1594ce9b52c51b7ca3d7b7ddf3a080d2dd95c141f3a6aa99dacc21a35466fd809
+  data.tar.gz: d5d736e51985381b95e30a5893bb15b0e37e1d41d71b8eab0e5e580a83ce2c95930a821e16b6621ff41d1f70bc3ec62d26b3c4fc09f0be6a96124279c24b5733

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+### 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).

data/README.md

@@ -97,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
@@ -137,15 +154,22 @@ 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.
@@ -1098,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/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.2.0'
+  VERSION = '2.3.0'
 end

data/lib/strava/web/raise_response_error.rb

@@ -3,6 +3,7 @@
 module Strava
   module Web
     class RaiseResponseError < ::Faraday::Middleware
+      DEFAULT_OPTIONS = Faraday::Response::RaiseError::DEFAULT_OPTIONS
       CLIENT_ERROR_STATUSES = (400...600)
 
       def on_complete(env)
@@ -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

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: strava-ruby-client
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Daniel Doubrovkine
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-17 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
@@ -179,8 +177,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '2.5'
 requirements: []
-rubygems_version: 3.5.11
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Strava API Ruby client.
 test_files: []