strava-ruby-client 0.3.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 67660b1916a241d6029346ff2da15b8317dbb752974d1772faaba9a48a7441a8
-  data.tar.gz: 4dc208a403ee703bdeeca2c21d9af8fd37a9b3d7c9b851c4e328cbc382529962
+  metadata.gz: c405363163b2332c696362fcaecc55b27ebcc9cc36dc78bfff54059d4433a580
+  data.tar.gz: a555beb0bf2072cf7cfe40a8178e72d0d4bc846963446704a642e344d46f780e
 SHA512:
-  metadata.gz: 17e10865286fad7301c21d51feed1482b01cf8e1fe5345f1b0cbf4b8dd66cfe5ea9351658afd09d2d2bc7f46669914240d764201b1c20f82a32dc5cd310f895f
-  data.tar.gz: a165b273493382cee3b1160f5b3339fda53506110bad84737af77ba4f6505b996d5e1ae0f8562b1c6a17f2b8ac8babc0ae9e44be92b066d2c0cca92f6ad0f2d9
+  metadata.gz: ca090cb5fc5553cbf275f36e797e90cbede14cbe8c400520b79a4ddd061719878e3f1b38e13efbf948bab884f5ab62f8d5b5e49812cc154af155e78bd3601dfc
+  data.tar.gz: 662f42daf772d75c032a2f228f4d0a2f268c8de68a9ea91b95cae9840d0a185c3a159df5023b182026fd47deaa5909494b06d3b03e91cd85ac74bed66a249239

data/CHANGELOG.md

@@ -1,3 +1,25 @@
+### 0.4.2 (2021/10/03)
+
+* [#45](https://github.com/dblock/strava-ruby-client/pull/45): Added `Gear#frame_type` `#retired` `#weight` - [@deuber](https://github.com/deuber).
+
+### 0.4.1 (2021/07/11)
+
+* [#37](https://github.com/dblock/strava-ruby-client/pull/38): Added `Club#club_events` - [@simonneutert](https://github.com/simonneutert).
+* [#34](https://github.com/dblock/strava-ruby-client/pull/34): Added `Athlete#ftp` - [@virae](https://github.com/virae).
+
+### 0.4.0 (2020/05/09)
+
+* [#29](https://github.com/dblock/strava-ruby-client/pull/29): Cache `Faraday::Connection` for persistent adapters - [@dblock](https://github.com/dblock).
+* [#30](https://github.com/dblock/strava-ruby-client/pull/30): Require Faraday >= 1.0 - [@dblock](https://github.com/dblock).
+
+### 0.3.2 (2020/03/28)
+
+* [#26](https://github.com/dblock/strava-ruby-client/pull/26): Corrected `Strava::Webhooks.config.endpoint` - [@dblock](https://github.com/dblock).
+* Automatically convert `before` and `after` arguments of `Strava::Api::Client#athlete_activities` from `Time` to `Integer` - [@dblock](https://github.com/dblock).
+* [#18](https://github.com/dblock/strava-ruby-client/pull/18): Testing against Ruby 2.5.3 and 2.6.0 - [@lucianosousa](https://github.com/lucianosousa).
+* [#18](https://github.com/dblock/strava-ruby-client/pull/18): Upgraded Rubocop to 0.61.1 - [@lucianosousa](https://github.com/lucianosousa).
+* [#21](https://github.com/dblock/strava-ruby-client/pull/21): Include headers in error response - [@jameschevalier](https://github.com/jameschevalier).
+
 ### 0.3.1 (2018/12/05)
 
 * Added `Strava::Api::Client#activity_photos` - [@dblock](https://github.com/dblock).

data/README.md

@@ -29,6 +29,7 @@ Unlike other clients, including [strava-api-v3](https://github.com/jaredholdcrof
     - [Update Athlete](#update-athlete)
   - [Clubs](#clubs)
     - [List Club Activities](#list-club-activities)
+    - [List Club Events](#list-club-events)
     - [List Club Administrators](#list-club-administrators)
     - [Get Club](#get-club)
     - [List Club Members](#list-club-members)
@@ -63,6 +64,7 @@ Unlike other clients, including [strava-api-v3](https://github.com/jaredholdcrof
   - [OAuth](#oauth)
     - [OAuth Workflow](#oauth-workflow)
     - [Deauthorize](#deauthorize)
+    - [Command Line OAuth Workflow](#command-line-oauth-workflow)
   - [Webhooks](#webhooks)
 - [Configuration](#configuration)
   - [Web Client Options](#web-client-options)
@@ -72,6 +74,9 @@ Unlike other clients, including [strava-api-v3](https://github.com/jaredholdcrof
 - [Errors](#errors)
 - [Tools](#tools)
   - [Strava OAuth Token](#strava-oauth-token)
+- [Users](#users)
+- [Resources](#resources)
+- [Upgrading](#upgrading)
 - [Contributing](#contributing)
 - [Copyright and License](#copyright-and-license)
 
@@ -353,6 +358,20 @@ activity.name # => 'Afternoon Run'
 
 See [Strava::Models::Activity](lib/strava/models/activity.rb) for all available properties. Note that Strava does not return activity or athlete ID via this API.
 
+#### List Club Events
+
+Retrieve recent Events from a specific club.
+
+```ruby
+events = client.club_events(108605) # => Array[Strava::Models::ClubEvent]
+
+event = events.first # => Strava::Models::ClubEvent
+
+event.title # => 'First Group Event Ever! Yippieh!'
+```
+
+See [Strava::Models::ClubEvent](lib/strava/models/club_event.rb) for all available properties.
+
 #### List Club Administrators
 
 Returns a list of the administrators of a given club.
@@ -413,15 +432,19 @@ See [Strava::Models::Club](lib/strava/models/club.rb) for all available properti
 Returns an equipment using its identifier.
 
 ```ruby
-gear = client.gear('g3844087') # => Strava::Models::Gear
+gear = client.gear(id: 'b2338517') # => Strava::Models::Gear
 
-gear.id # => 'g3844087'
-gear.name # => 'Adidas Supernova ST'
+gear.id # => 'b2338517'
+gear.name # => 'Trek'
 gear.distance # => 380939.0
 gear.distance_s # => '380.94km'
-gear.brand_name # => 'Adidas'
-gear.model_name # => 'Supernova'
-gear.description # => 'My NYC TCS Marathon 2018 shoes.'
+gear.brand_name # => 'Trek'
+gear.model_name # => 'Madone'
+gear.description # => 'white'
+gear.primary # => 'false'
+gear.frame_type # => '3'
+gear.weight # => '9'
+gear.retired # => 'false'
 ```
 
 See [Strava::Models::Gear](lib/strava/models/gear.rb) for all available properties.
@@ -843,9 +866,15 @@ authorization = client.deauthorize
 authorization.access_token # => String, access token being revoked
 ```
 
+#### Command Line OAuth Workflow
+
+The OAuth process is web-based and you cannot obtain a token from a Strava client ID and secret without user intervention. You can, however, start a local web server to handle the OAuth redirect and open a browser from the command-line.
+
+See [strava-oauth-token](/bin/strava-oauth-token) or [strava-ruby-cli](https://github.com/dblock/strava-ruby-cli) for an example.
+
 ### Webhooks
 
-Strava provides a [Webhook Event API](https://developers.strava.com/docs/webhooks/) that requires special access obtained by emailing [developers@strava.com](mailto:developers@strava.com).
+Strava provides a [Webhook Event API](https://developers.strava.com/docs/webhooks/).
 
 A complete example that handles subscription creation, deletion and handling can be found in [strava-webhooks](bin/strava-webhooks). Run `strava-webhooks` to see current registrations, `strava-webhooks handle` to run an HTTP server that handles both challenges and event data, `strava-webhooks create [url]` to create a new subscription and `strava-webhooks delete [id]` to delete it.
 
@@ -1016,11 +1045,11 @@ setting             | description
 --------------------|------------
 client_id           | Application client ID.
 client_secret       | Application client secret.
-endpoint            | Defaults to `https://api.strava.com/api/v3`.
+endpoint            | Defaults to `https://www.strava.com/api/v3`.
 
 ## Errors
 
-All errors that return HTTP codes 400-600 result in either `Faraday::Error::ResourceNotFound`, `Faraday::Error::ConnectionFailed` or [Strava::Errors::Fault](lib/strava/errors/fault.rb) exceptions.
+All errors that return HTTP codes 400-600 result in either `Faraday::ResourceNotFound`, `Faraday::ConnectionFailed` or [Strava::Errors::Fault](lib/strava/errors/fault.rb) exceptions.
 
 ```ruby
 begin
@@ -1028,19 +1057,40 @@ begin
 rescue Strava::Errors::Fault => e
   e.message # => Bad Request
   e.errors # => [{ 'code' => 'invalid', 'field' => 'code', 'resource' => 'RequestToken' }]
+  e.headers # => { "status" => "403 Bad Request", "x-ratelimit-limit" => "600,30000", "x-ratelimit-usage" => "314,27536" }
 end
 ```
 
 ## 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.
+
 ### Strava OAuth Token
 
-Use [strava-oauth-token](bin/strava-outh-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.
+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
 ```
 
+## 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)
+
+## 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)
+
+## Upgrading
+
+See [UPGRADING](UPGRADING.md).
+
 ## Contributing
 
 See [CONTRIBUTING](CONTRIBUTING.md).

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

@@ -91,6 +91,9 @@ module Strava
         #   Number of items per page. Defaults to 30.
         #
         def athlete_activities(options = {}, &block)
+          options = options.dup if options.key?(:after) || options.key?(:before)
+          options[:after] = options[:after].to_i if options[:after]
+          options[:before] = options[:before].to_i if options[:before]
           paginate 'athlete/activities', options, Strava::Models::Activity, &block
         end
 

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

@@ -17,6 +17,21 @@ module Strava
           paginate "clubs/#{id}/activities", options, Strava::Models::Activity, &block
         end
 
+        #
+        # List club / group events.
+        #
+        # @option options [String] :id
+        #   Club id.
+        # @option options [Integer] :page
+        #   Page number.
+        # @option options [Integer] :per_page
+        #   Number of items per page. Defaults to 30.
+        #
+        def club_events(id_or_options, options = {}, &block)
+          id, options = parse_args(id_or_options, options)
+          paginate "clubs/#{id}/group_events", options, Strava::Models::ClubEvent, &block
+        end
+
         #
         # List club administrators.
         #

data/lib/strava/errors/fault.rb

@@ -5,6 +5,10 @@ module Strava
         response[:body]['message'] || super
       end
 
+      def headers
+        response[:headers]
+      end
+
       def errors
         response[:body]['errors']
       end

data/lib/strava/models/athlete.rb

@@ -27,6 +27,7 @@ module Strava
       property 'date_preference'
       property 'measurement_preference'
       property 'clubs', transform_with: ->(v) { v.map { |r| Strava::Models::Club.new(r) } }
+      property 'ftp'
       property 'weight'
       property 'bikes', transform_with: ->(v) { v.map { |r| Strava::Models::Gear.new(r) } }
       property 'shoes', transform_with: ->(v) { v.map { |r| Strava::Models::Gear.new(r) } }

data/lib/strava/models/club_event.rb

@@ -0,0 +1,28 @@
+module Strava
+  module Models
+    class ClubEvent < Model
+      property 'id'
+      property 'resource_state'
+      property 'title'
+      property 'club_id'
+      property 'club', transform_with: ->(c) { Strava::Models::Club.new(c) }
+      property 'organizing_athlete', transform_with: ->(oa) { Strava::Models::Athlete.new(oa) }
+      property 'activity_type'
+      property 'created_at', transform_with: ->(v) { Time.parse(v) }
+      property 'route_id'
+      property 'route', transform_with: ->(r) { Strava::Models::Route.new(r) }
+      property 'women_only'
+      property 'private'
+      property 'skill_levels'
+      property 'terrain'
+      property 'upcoming_occurrences', transform_with: ->(upcoming) { upcoming.map { |o| Time.parse(o) } }
+      property 'zone'
+      property 'address'
+      property 'start_latlng'
+
+      def strava_url
+        "https://www.strava.com/clubs/#{club_id}/group_events/#{id}"
+      end
+    end
+  end
+end

data/lib/strava/models/gear.rb

@@ -11,6 +11,9 @@ module Strava
       property 'brand_name'
       property 'model_name'
       property 'description'
+      property 'frame_type'
+      property 'weight'
+      property 'retired'
     end
   end
 end

data/lib/strava/version.rb

@@ -1,3 +1,3 @@
 module Strava
-  VERSION = '0.3.1'.freeze
+  VERSION = '0.4.2'.freeze
 end

data/lib/strava/web/connection.rb

@@ -8,26 +8,28 @@ module Strava
       end
 
       def connection
-        options = {
-          headers: headers.merge('Accept' => 'application/json; charset=utf-8')
-        }
+        @connection ||= begin
+          options = {
+            headers: headers.merge('Accept' => 'application/json; charset=utf-8')
+          }
 
-        options[:headers]['User-Agent'] = user_agent if user_agent
-        options[:proxy] = proxy if proxy
-        options[:ssl] = { ca_path: ca_path, ca_file: ca_file } if ca_path || ca_file
+          options[:headers]['User-Agent'] = user_agent if user_agent
+          options[:proxy] = proxy if proxy
+          options[:ssl] = { ca_path: ca_path, ca_file: ca_file } if ca_path || ca_file
 
-        request_options = {}
-        request_options[:timeout] = timeout if timeout
-        request_options[:open_timeout] = open_timeout if open_timeout
-        options[:request] = request_options if request_options.any?
+          request_options = {}
+          request_options[:timeout] = timeout if timeout
+          request_options[:open_timeout] = open_timeout if open_timeout
+          options[:request] = request_options if request_options.any?
 
-        ::Faraday::Connection.new(endpoint, options) do |connection|
-          connection.use ::Faraday::Request::Multipart
-          connection.use ::Faraday::Request::UrlEncoded
-          connection.use ::Strava::Web::Response::RaiseError
-          connection.use ::FaradayMiddleware::ParseJson, content_type: /\bjson$/
-          connection.response :logger, logger if logger
-          connection.adapter ::Faraday.default_adapter
+          ::Faraday::Connection.new(endpoint, options) do |connection|
+            connection.use ::Faraday::Request::Multipart
+            connection.use ::Faraday::Request::UrlEncoded
+            connection.use ::Strava::Web::Response::RaiseError
+            connection.use ::FaradayMiddleware::ParseJson, content_type: /\bjson$/
+            connection.response :logger, logger if logger
+            connection.adapter ::Faraday.default_adapter
+          end
         end
       end
     end

data/lib/strava/web/raise_error.rb

@@ -7,10 +7,10 @@ module Strava
         def on_complete(env)
           case env[:status]
           when 404
-            raise Faraday::Error::ResourceNotFound, response_values(env)
+            raise Faraday::ResourceNotFound, response_values(env)
           when 407
             # mimic the behavior that we get with proxy requests with HTTPS
-            raise Faraday::Error::ConnectionFailed, %(407 "Proxy Authentication Required ")
+            raise Faraday::ConnectionFailed, %(407 "Proxy Authentication Required ")
           when ClientErrorStatuses
             raise Strava::Errors::Fault, response_values(env)
           end

data/lib/strava/webhooks/config.rb

@@ -12,7 +12,7 @@ module Strava
       attr_accessor(*Config::ATTRIBUTES)
 
       def reset
-        self.endpoint = 'https://api.strava.com/api/v3'
+        self.endpoint = 'https://www.strava.com/api/v3'
         self.client_id = nil
         self.client_secret = nil
       end

data/lib/strava-ruby-client.rb

@@ -25,6 +25,7 @@ require_relative 'strava/models/map'
 require_relative 'strava/models/activity'
 require_relative 'strava/models/club'
 require_relative 'strava/models/club_admin'
+require_relative 'strava/models/club_event'
 require_relative 'strava/models/club_member'
 require_relative 'strava/models/segment_effort'
 require_relative 'strava/models/photos'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: strava-ruby-client
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.2
 platform: ruby
 authors:
 - Daniel Doubrovkine
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-12-05 00:00:00.000000000 Z
+date: 2021-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
@@ -66,7 +66,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email: dblock@dblock.org
 executables:
 - strava-oauth-token
@@ -105,6 +105,7 @@ files:
 - lib/strava/models/authorization.rb
 - lib/strava/models/club.rb
 - lib/strava/models/club_admin.rb
+- lib/strava/models/club_event.rb
 - lib/strava/models/club_member.rb
 - lib/strava/models/comment.rb
 - lib/strava/models/explorer_segment.rb
@@ -154,7 +155,7 @@ homepage: http://github.com/dblock/strava-ruby-client
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -169,9 +170,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.1.3
+signing_key:
 specification_version: 4
 summary: Strava API Ruby client.
 test_files: []