strava-ruby-client 0.4.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f1fd53d322d249bebc5d46c0edaaf9fd6d8831ba2c23134c0450203e078965d6
-  data.tar.gz: fa26523a8f6d1987700b414131bd0a754154f734cdf7f21be6988de2fd1a1271
+  metadata.gz: b80a0bbc9fed0fa22baa2beaa23d59492d26766295539f05eaf7e38c6b6abed3
+  data.tar.gz: f118e373ce17c7add5a1919b7e1b0936836e268a2bcc0c3349a548dccbf16fa7
 SHA512:
-  metadata.gz: 65e071fafa80e86f019290774a902a53837bc9a6f4aa15f50306bdf0807fdd929a509638832109cfe2e4380dfa921a4e205623252b4651ab780d6109dfd1f3a7
-  data.tar.gz: d0cada36caa3cd5beac43605a3efc55ea79f4603184fdfa1df614418a6b9a59e6b8cff7365b0e6f9bc59ddf036d288480d18d81e5165f35f69b2c912502759b7
+  metadata.gz: 3f6a9ed96fd697e3906afaea168495e2313dce12d9cb125e3ec63e72d007fbba42f424578482982606bcc0e94ae722fd4c22dd7a669ae0566838a8c08374ed3c
+  data.tar.gz: 8a7c832f863941ea132c0f3ef9d327b439038ac12334ebc87ac221ddf6a392371536eb59413cb6dfcac31ed1ecb6554085079d5c284059d0a51a5b74b3a3fd8c

data/CHANGELOG.md

@@ -1,8 +1,19 @@
+### 1.0.0 (2022/12/29)
+
+* [#48](https://github.com/dblock/strava-ruby-client/pull/55): Removed `client.running_races` - [@simonneutert](https://github.com/simonneutert).
+* [#56](https://github.com/dblock/strava-ruby-client/pull/56): Removed `client.segment_leaderboard` - [@simonneutert](https://github.com/simonneutert).
+* [#58](https://github.com/dblock/strava-ruby-client/pull/58): Update Faraday to `>= 2.0` - [@schinery](https://github.com/schinery).
+* [#58](https://github.com/dblock/strava-ruby-client/pull/58): Removed support for Ruby 2.5 and 2.6 - [@schinery](https://github.com/schinery).
+* [#58](https://github.com/dblock/strava-ruby-client/pull/58): Upgraded Robocop to 1.3.0 - [@schinery](https://github.com/schinery).
+* [#59](https://github.com/dblock/strava-ruby-client/pull/59): Removed deprecated `athlete.email` field - [@francordie](https://github.com/francordie).
+* [#63](https://github.com/dblock/strava-ruby-client/pull/63): Added `activity.sport_type` for Strava API V3 specifications - [@simonneutert](https://github.com/simonneutert).
+* [#61](https://github.com/dblock/strava-ruby-client/pull/61): Adds ratelimit as a property of model(s) - [@simonneutert](https://github.com/simonneutert), [@adamwolf](https://github.com/adamwolf).
+
 ### 0.4.3 (2022/03/21)
 
 * [#51](https://github.com/dblock/strava-ruby-client/pull/51): Ensure support for large Integer IDs - [@simonneutert](https://github.com/simonneutert).
 * [#53](https://github.com/dblock/strava-ruby-client/pull/53): Upgraded to RuboCop 1.26.0 - [@dblock](https://github.com/dblock).
-* [#46](https://github.com/dblock/strava-ruby-client/pull/46): Add missing `activity:read` scope from `strava-oauth-token` - [@xaviershay](https://github.com/xaviershay).
+* [#46](https://github.com/dblock/strava-ruby-client/pull/46): Added missing `activity:read` scope from `strava-oauth-token` - [@xaviershay](https://github.com/xaviershay).
 
 ### 0.4.2 (2021/10/03)
 

data/README.md

@@ -1,5 +1,4 @@
-Strava Ruby Client
-==================
+# Strava Ruby Client
 
 [![Gem Version](https://badge.fury.io/rb/strava-ruby-client.svg)](https://badge.fury.io/rb/strava-ruby-client)
 [![Test](https://github.com/dblock/strava-ruby-client/actions/workflows/test.yml/badge.svg?branch=master)](https://github.com/dblock/strava-ruby-client/actions/workflows/test.yml)
@@ -43,13 +42,11 @@ Unlike other clients, including [strava-api-v3](https://github.com/jaredholdcrof
     - [List Athlete Routes](#list-athlete-routes)
   - [Running Races](#running-races)
     - [Get Running Race](#get-running-race)
-    - [List Running Races](#list-running-races)
   - [Segment Efforts](#segment-efforts)
     - [List Segment Efforts](#list-segment-efforts)
     - [Get Segment Effort](#get-segment-effort)
   - [Segments](#segments)
     - [Explore Segments](#explore-segments)
-    - [Get Segment Leaderboard](#get-segment-leaderboard)
     - [List Starred Segments](#list-starred-segments)
     - [Get Segment](#get-segment)
     - [Star Segment](#star-segment)
@@ -66,6 +63,7 @@ Unlike other clients, including [strava-api-v3](https://github.com/jaredholdcrof
     - [Deauthorize](#deauthorize)
     - [Command Line OAuth Workflow](#command-line-oauth-workflow)
   - [Webhooks](#webhooks)
+  - [Ratelimit](#ratelimit)
 - [Configuration](#configuration)
   - [Web Client Options](#web-client-options)
   - [API Client Options](#api-client-options)
@@ -109,7 +107,7 @@ Creates a manual activity for an athlete.
 ```ruby
 activity = client.create_activity(
   name: 'Afternoon Run',
-  type: 'Run',
+  sport_type: 'Run',
   start_date_local: Time.now,
   elapsed_time: 1234, # in seconds
   description: 'Test run.',
@@ -217,7 +215,6 @@ lap.name # => 'Lap 1'
 
 See [Strava::Models::Lap](lib/strava/models/lap.rb) for all available properties.
 
-
 #### List Athlete Activities
 
 Returns the currently logged-in athlete's activities.
@@ -230,6 +227,7 @@ 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'
 activity.elapsed_time_in_hours_s # => '3h42m13s'
@@ -272,7 +270,7 @@ Update an activity.
 activity = client.update_activity(
   id: 1982980795,
   name: 'Afternoon Run (Updated)',
-  type: 'Run',
+  sport_type: 'Run',
   description: 'It was cold.'
 )
 
@@ -530,23 +528,6 @@ running_race.website_url # => 'https://www.rundisney.com/disneyworld-marathon/'
 
 See [Strava::Models::RunningRace](lib/strava/models/running_race.rb) for all available properties.
 
-#### List Running Races
-
-Returns a list running races based on a set of search criteria.
-
-```ruby
-running_races = client.running_races
-
-running_race = running_races.first # => Strava::Models::RunningRace
-
-running_race.name # => 'Walt Disney World Half Marathon'
-running_race.distance # => 21_097.0
-running_race.measurement_preference # => 'feet'
-running_race.distance_s # => '13.11mi'
-```
-
-See [Strava::Models::RunningRace](lib/strava/models/running_race.rb) for all available properties.
-
 ### Segment Efforts
 
 #### List Segment Efforts
@@ -616,37 +597,6 @@ segment.elev_difference # => 9.6
 
 See [Strava::Models::ExplorerSegment](lib/strava/models/explorer_segment.rb) for all available properties.
 
-#### Get Segment Leaderboard
-
-Returns the specified segment leaderboard.
-
-```ruby
-segment_leaderboard = client.segment_leaderboard(1109718) # => Strava::Models::SegmentLeaderboard
-
-segment_leaderboard.effort_count # => 204
-segment_leaderboard.entry_count # => 204
-segment_leaderboard.kom_type # => 'kom'
-segment_leaderboard.entries # => Enumerable
-
-entry = segment_leaderboard.entries.first # => Strava::Models::SegmentLeaderboardEntry
-entry.athlete_name # => 'Etan B.'
-entry.moving_time_in_hours_s # => '1m32s'
-entry.start_date # => Time
-entry.start_date_local # => Time
-entry.rank # => 1
-```
-
-This API supports pagination through the entire segment leaderboard but wraps entries into a [Strava::Models::SegmentLeaderboard](lib/strava/models/segment_leaderboard.rb) object.
-
-```ruby
-client.segment_leaderboard(1109718) do |row|
-  row # => Strava::Models::SegmentLeaderboard
-  row.entries # => Array[Strava::Models::SegmentLeaderboardEntry]
-end
-```
-
-See [Strava::Models::SegmentLeaderboard](lib/strava/models/segment_leaderboard.rb) and [Strava::Models::SegmentLeaderboardEntry](lib/strava/models/segment_leaderboard_entry.rb) for all available properties.
-
 #### List Starred Segments
 
 List of the authenticated athlete's starred segments.
@@ -898,7 +848,7 @@ event # => Strava::Webhooks::Models::Event
 event.object_type # => 'activity'
 event.object_id # => 1991813808
 event.aspect_type # => 'update'
-event.updates # => { 'type' => 'Walk' }
+event.updates # => { 'sport_type' => 'Walk' }
 event.owner_id # => 29323238
 event.subscription_id # => 131302
 event.event_time # => DateTime
@@ -945,6 +895,58 @@ Delete an existing subscription.
 client.delete_push_subscription(131300) # => nil
 ```
 
+### Ratelimit
+
+Every API call's HTTP Reponse Content, be it a single Model or a list (via pagination), can be accessed by using `#http_response`.
+
+`client.athlete` #=> `Strava::Models::Athlete#http_response`
+
+`client.activity_comments(id: 1234567)` #=> `Array<Strava::Models::Comment>#http_response`
+
+`http_response` itself is a `Strava::Web::ApiResponse` class. Ratelimits are accessed via this class using `Strava::Web::ApiResponse#ratelimit`. See the examples given below:
+
+```ruby
+comments = client.activity_comments(id: 123_456_789)
+
+# comments == Array<Strava::Models::Comment>
+comments.http_response.ratelimit.to_h
+```
+
+```ruby
+athlete = client.athlete # => Strava::Models::Athlete
+athlete.http_response.ratelimit
+```
+
+The following properties are available on Strava::Api::Ratelimit.
+
+- `limit`
+- `limit?`
+- `usage`
+- `fifteen_minutes`
+- `fifteen_minutes_usage`
+- `fifteen_minutes_remaining`
+- `total_day`
+- `total_day_usage`
+- `total_day_remaining`
+- `to_h`
+- `to_s`
+
+You can access the Hash containing all limits by calling `to_h`.
+
+```ruby
+# athlete.http_response.ratelimit.to_h
+{
+  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
+}
+```
+
 ## Configuration
 
 ### Web Client Options
@@ -959,15 +961,15 @@ end
 
 The following settings are supported.
 
-setting             | description
---------------------|------------
-user_agent          | User-agent, defaults to _Strava Ruby Client/version_.
-proxy               | Optional HTTP proxy.
-ca_path             | Optional SSL certificates path.
-ca_file             | Optional SSL certificates file.
-logger              | Optional `Logger` instance that logs HTTP requests.
-timeout             | Optional open/read timeout in seconds.
-open_timeout        | Optional connection open timeout in seconds.
+| setting      | description                                           |
+| ------------ | ----------------------------------------------------- |
+| user_agent   | User-agent, defaults to _Strava Ruby Client/version_. |
+| proxy        | Optional HTTP proxy.                                  |
+| ca_path      | Optional SSL certificates path.                       |
+| ca_file      | Optional SSL certificates file.                       |
+| logger       | Optional `Logger` instance that logs HTTP requests.   |
+| timeout      | Optional open/read timeout in seconds.                |
+| open_timeout | Optional connection open timeout in seconds.          |
 
 ### API Client Options
 
@@ -988,10 +990,10 @@ client = Strava::API::Client.new(
 
 The following settings are supported.
 
-setting             | description
---------------------|------------
-access_token        | Access token to pass in the `Authorization` header.
-endpoint            | Defaults to `https://www.strava.com/api/v3`.
+| setting      | description                                         |
+| ------------ | --------------------------------------------------- |
+| access_token | Access token to pass in the `Authorization` header. |
+| endpoint     | Defaults to `https://www.strava.com/api/v3`.        |
 
 ### OAuth Client Options
 
@@ -1014,11 +1016,11 @@ client = Strava::OAuth::Client.new(
 
 The following settings are supported.
 
-setting             | description
---------------------|------------
-client_id           | Application client ID.
-client_secret       | Application client secret.
-endpoint            | Defaults to `https://www.strava.com/oauth`.
+| setting       | description                                 |
+| ------------- | ------------------------------------------- |
+| client_id     | Application client ID.                      |
+| client_secret | Application client secret.                  |
+| endpoint      | Defaults to `https://www.strava.com/oauth`. |
 
 ### Webhooks Client Options
 
@@ -1041,11 +1043,11 @@ client = Strava::Webhooks::Client.new(
 
 The following settings are supported.
 
-setting             | description
---------------------|------------
-client_id           | Application client ID.
-client_secret       | Application client secret.
-endpoint            | Defaults to `https://www.strava.com/api/v3`.
+| setting       | description                                  |
+| ------------- | -------------------------------------------- |
+| client_id     | Application client ID.                       |
+| client_secret | Application client secret.                   |
+| endpoint      | Defaults to `https://www.strava.com/api/v3`. |
 
 ## Errors
 
@@ -1070,22 +1072,22 @@ For a complete set of command-line tools, check out [strava-ruby-cli](https://gi
 Use [strava-oauth-token](bin/strava-oauth-token) to obtain a token from the command-line. This will open a new browser window, navigate to Strava, request the appropriate permissions, then handle OAuth in a local redirect. The token type, refresh token, access token and token expiration will be displayed in the browser.
 
 ```bash
-$ STRAVA_CLIENT_ID=... STRAVA_CLIENT_SECRET=... strava-oauth-token
+STRAVA_CLIENT_ID=... STRAVA_CLIENT_SECRET=... strava-oauth-token
 ```
 
 ## Users
 
-* [Slava: Strava integration with Slack](https://slava.playplay.io), [source](https://github.com/dblock/slack-strava).
-* [Jekyll Blog at run.dblock.org](https://run.dblock.org), [source](https://github.com/dblock/run.dblock.org)
-* [Secret Strava](https://steele.blue/secret-strava/), [source](https://github.com/mattdsteele/secret-strava)
+- [Slava: Strava integration with Slack](https://slava.playplay.io), [source](https://github.com/dblock/slack-strava).
+- [Jekyll Blog at run.dblock.org](https://run.dblock.org), [source](https://github.com/dblock/run.dblock.org)
+- [Secret Strava](https://steele.blue/secret-strava/), [source](https://github.com/mattdsteele/secret-strava)
 
 ## Resources
 
-* [Strava API Documentation](https://developers.strava.com)
-* [Writing a New Strava API Ruby Client](https://code.dblock.org/2018/11/27/writing-a-new-strava-api-ruby-client.html)
-* [Dealing with Strava API OAuth Token Migration](https://code.dblock.org/2018/11/17/dealing-with-strava-api-token-migration.html)
-* [Auto-Publishing Strava Runs to Github Pages](https://code.dblock.org/2018/02/17/auto-publishing-strava-runs-to-github-pages.html)
-* [Strava Command-Line Client](https://github.com/dblock/strava-ruby-cli)
+- [Strava API Documentation](https://developers.strava.com)
+- [Writing a New Strava API Ruby Client](https://code.dblock.org/2018/11/27/writing-a-new-strava-api-ruby-client.html)
+- [Dealing with Strava API OAuth Token Migration](https://code.dblock.org/2018/11/17/dealing-with-strava-api-token-migration.html)
+- [Auto-Publishing Strava Runs to Github Pages](https://code.dblock.org/2018/02/17/auto-publishing-strava-runs-to-github-pages.html)
+- [Strava Command-Line Client](https://github.com/dblock/strava-ruby-cli)
 
 ## Upgrading
 

data/bin/strava-oauth-token

@@ -12,8 +12,8 @@ trap 'INT' do
 end
 
 client = Strava::OAuth::Client.new(
-  client_id: ENV['STRAVA_CLIENT_ID'],
-  client_secret: ENV['STRAVA_CLIENT_SECRET']
+  client_id: ENV.fetch('STRAVA_CLIENT_ID', nil),
+  client_secret: ENV.fetch('STRAVA_CLIENT_SECRET', nil)
 )
 
 server.mount_proc '/' do |req, res|

data/bin/strava-webhooks

@@ -9,8 +9,8 @@ logger = ::Logger.new($stdout)
 logger.level = Logger::INFO
 
 client = Strava::Webhooks::Client.new(
-  client_id: ENV['STRAVA_CLIENT_ID'],
-  client_secret: ENV['STRAVA_CLIENT_SECRET'],
+  client_id: ENV.fetch('STRAVA_CLIENT_ID', nil),
+  client_secret: ENV.fetch('STRAVA_CLIENT_SECRET', nil),
   logger: logger
 )
 

data/lib/strava/api/client.rb

@@ -40,18 +40,37 @@ module Strava
 
       private
 
+      #
+      # paginates requests
+      #
+      # @param [String] path url for request
+      # @param [Hash] options hash containing settings
+      # @param [Class] model by Class
+      #
+      # @example
+      #   paginate("athlete/activities", {per_page: 72}, Strava::Models::Activity)
+      #
+      # @return [Strava::Api::Pagination]
+      #
       def paginate(path, options, model)
+        collection = []
+        web_response = nil
         if block_given?
           Cursor.new(self, path, options).each do |page|
+            web_response = page # response of the last request made
             page.each do |row|
-              yield model.new(row)
+              m = model.new(row)
+              yield m
+              collection << m
             end
           end
         else
-          get(path, options).map do |row|
+          web_response = get(path, options)
+          collection = web_response.map do |row|
             model.new(row)
           end
         end
+        Pagination.new(collection, web_response)
       end
     end
   end

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

@@ -12,7 +12,7 @@ module Strava
         #
         def export_route_gpx(id_or_options, options = {})
           id, options = parse_args(id_or_options, options)
-          get "routes/#{id}/export_gpx", options
+          get("routes/#{id}/export_gpx", options).response
         end
 
         #
@@ -23,7 +23,7 @@ module Strava
         #
         def export_route_tcx(id_or_options, options = {})
           id, options = parse_args(id_or_options, options)
-          get "routes/#{id}/export_tcx", options
+          get("routes/#{id}/export_tcx", options).response
         end
 
         #

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

@@ -14,18 +14,6 @@ module Strava
           id, options = parse_args(id_or_options, options)
           Strava::Models::RunningRace.new(get("running_races/#{id}", options))
         end
-
-        #
-        # Returns a list running races based on a set of search criteria.
-        #
-        # @option options [Integer] :year
-        #   Filters the list by a given year.
-        #
-        def running_races(options = {})
-          get('running_races', options).map do |row|
-            Strava::Models::RunningRace.new(row)
-          end
-        end
       end
     end
   end

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

@@ -25,52 +25,6 @@ module Strava
           end
         end
 
-        #
-        # Returns the specified segment leaderboard.
-        #
-        # @option options [Integer] :id
-        #   The identifier of the segment leaderboard.
-        # @option options [String] :gender
-        #   Filter by gender.
-        # @option options [String] :age_group
-        #   Filter by age group.
-        # @option options [String] :weight_class
-        #   Filter by weight class.
-        # @option options [Boolean] :following
-        #   Filter by friends of the authenticated athlete.
-        # @option options [Integer] :club_id
-        #   Filter by club.
-        # @option options [String] :date_range
-        #   Filter by date range.
-        # @option options [Integer] :context_entries
-        #   ?
-        # @option options [Integer] :page
-        #   Page number.
-        # @option options [Integer] :per_page
-        #   Number of items per page. Defaults to 30.
-        #
-        def segment_leaderboard(id_or_options, options = {})
-          id, options = parse_args(id_or_options, options)
-
-          if block_given?
-            next_page = 1
-            total_count = 0
-            loop do
-              query = options.merge(page: next_page)
-              response = Strava::Models::SegmentLeaderboard.new(get("segments/#{id}/leaderboard", query))
-              total_count += response.entries.count
-              break unless response.entries.any?
-
-              yield response
-              break if total_count >= response.entry_count
-
-              next_page += 1
-            end
-          else
-            Strava::Models::SegmentLeaderboard.new(get("segments/#{id}/leaderboard", options))
-          end
-        end
-
         #
         # List of the authenticated athlete's starred segments.
         #

data/lib/strava/api/pagination.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Strava
+  module Api
+    #
+    # Wrapper Class around pagination results which are an Array of Models.
+    #
+    # This class exists to provide a way to provide a high-level abstraction, like
+    # access to API request/response data (i.e. ratelimits) for paginated results.
+    #
+    class Pagination
+      include Enumerable
+      include Strava::DeepCopyable
+
+      attr_reader :collection
+
+      #
+      # @param [Array<Strava::Models::>] collection of Models
+      # @param [Strava::Web::Response] web_response
+      #
+      def initialize(collection, web_response)
+        @collection = collection
+        @web_response = web_response
+      end
+
+      #
+      # getter method that calculates on access
+      #
+      # @return [Strava::Web::ApiResponse]
+      #
+      def http_response
+        @http_response ||=
+          Strava::Web::ApiResponse.new(deep_copy(@web_response).http_response)
+      end
+
+      #
+      # delegates `size` to @collection
+      #
+      # @return [Integer]
+      #
+      def size
+        @collection.size
+      end
+
+      def each
+        @collection.each { |c| yield c if block_given? }
+      end
+
+      private
+
+      def method_missing(method_symbol, *args, &block)
+        @collection.send(method_symbol, *args, &block)
+      end
+
+      def respond_to_missing?(method_name, include_private = false)
+        super
+      end
+    end
+  end
+end