strava-ruby-client 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a1b298638723dd74bcfe279fcaacb537f5026db4ecb2e92e990381b5dafded1
-  data.tar.gz: 7186ed4468c5d027cac4a3dec6874f27e5d19ff0067b5a84cbd004d069d22127
+  metadata.gz: 67660b1916a241d6029346ff2da15b8317dbb752974d1772faaba9a48a7441a8
+  data.tar.gz: 4dc208a403ee703bdeeca2c21d9af8fd37a9b3d7c9b851c4e328cbc382529962
 SHA512:
-  metadata.gz: 5355242600a38d9d72156a11b80f7e86b4c08d59696ace79db384d99819ca4358fc562e658f15f14e2bbd4c3a4ed42776fd828569972fef8da90ff396e74819e
-  data.tar.gz: 485676cac51d01d18071132be42ff798dc12dfa127c8b4552baa7eb2f1189dd637869320b039057d1e6295ec2c81c71b6e45b101068d6dd691943c5bf13f12d0
+  metadata.gz: 17e10865286fad7301c21d51feed1482b01cf8e1fe5345f1b0cbf4b8dd66cfe5ea9351658afd09d2d2bc7f46669914240d764201b1c20f82a32dc5cd310f895f
+  data.tar.gz: a165b273493382cee3b1160f5b3339fda53506110bad84737af77ba4f6505b996d5e1ae0f8562b1c6a17f2b8ac8babc0ae9e44be92b066d2c0cca92f6ad0f2d9

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+### 0.3.1 (2018/12/05)
+
+* Added `Strava::Api::Client#activity_photos` - [@dblock](https://github.com/dblock).
+* [#2](https://github.com/dblock/strava-ruby-client/issues/2): Added `Strava::Api::Client#deauthorize` - [@dblock](https://github.com/dblock).
+* [#15](https://github.com/dblock/strava-ruby-client/issues/15): Added `strava-oauth-token` and `strava-webhooks` to gem executables - [@dblock](https://github.com/dblock).
+* Fix: `Strava::Models::Activity#total_elevation_gain` no returns blank for negative and zero elevation differences - [@dblock](https://github.com/dblock).
+* Fix: `Strava::Models::Split#distance` and `total_elevation_gain` incorrect for `Strava::Models::Activity#splits_standard` - [@dblock](https://github.com/dblock).
+
 ### 0.3.0 (2018/12/03)
 
 * Added webhooks support - [@dblock](https://github.com/dblock).

data/README.md

@@ -15,6 +15,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)
@@ -60,6 +61,8 @@ Unlike other clients, including [strava-api-v3](https://github.com/jaredholdcrof
     - [Get Upload](#get-upload)
   - [Pagination](#pagination)
   - [OAuth](#oauth)
+    - [OAuth Workflow](#oauth-workflow)
+    - [Deauthorize](#deauthorize)
   - [Webhooks](#webhooks)
 - [Configuration](#configuration)
   - [Web Client Options](#web-client-options)
@@ -143,6 +146,29 @@ 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.
@@ -760,7 +786,9 @@ end
 
 ### OAuth
 
-Obtain a redirect URL.
+#### OAuth Workflow
+
+Obtain a redirect URL using an instance of `Strava::OAuth::Client`.
 
 ```ruby
 client = Strava::OAuth::Client.new(
@@ -800,16 +828,26 @@ response = client.oauth_token(
   grant_type: 'refresh_token'
 )
 
-response.access_token # new access token
-response.refresh_token # new refresh token
-response.expires_at # new timestamp when the access token expires
+response.access_token # => String, new access token
+response.refresh_token # => String, new refresh token
+response.expires_at # => Time, new timestamp when the access token expires
+```
+
+#### Deauthorize
+
+Revoke access to an athlete's data using an instance of `Strava::API::Client`.
+
+```ruby
+authorization = client.deauthorize
+
+authorization.access_token # => String, access token being revoked
 ```
 
 ### 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).
 
-A complete example that handles subscription creation, deletion and handling can be found in [strava-webhooks.rb](bin/strava-webhooks.rb). 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.
+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.
 
 Before creating a webhook subscription you must implement and run an HTTP server that will handle a `GET` challenge at the subscription URL.
 
@@ -997,7 +1035,7 @@ end
 
 ### Strava OAuth Token
 
-Use [strava-oauth-token](bin/strava-outh-token.rb) 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-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.
 
 ```bash
 $ STRAVA_CLIENT_ID=... STRAVA_CLIENT_SECRET=... strava-oauth-token

data/lib/strava-ruby-client.rb

@@ -55,6 +55,7 @@ require_relative 'strava/models/explorer_segment'
 require_relative 'strava/models/stream_set'
 require_relative 'strava/models/stream'
 require_relative 'strava/models/upload'
+require_relative 'strava/models/authorization'
 
 require_relative 'strava/web/raise_error'
 require_relative 'strava/web/connection'
@@ -84,5 +85,6 @@ require_relative 'strava/api/endpoints/segment_efforts'
 require_relative 'strava/api/endpoints/segments'
 require_relative 'strava/api/endpoints/streams'
 require_relative 'strava/api/endpoints/uploads'
+require_relative 'strava/api/endpoints/oauth'
 
 require_relative 'strava/api/client'

data/lib/strava/api/client.rb

@@ -11,6 +11,7 @@ module Strava
       include Endpoints::Segments
       include Endpoints::Streams
       include Endpoints::Uploads
+      include Endpoints::OAuth
 
       attr_accessor(*Config::ATTRIBUTES)
 

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

@@ -35,6 +35,21 @@ 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.
         #

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

@@ -0,0 +1,14 @@
+module Strava
+  module Api
+    module Endpoints
+      module OAuth
+        #
+        # Revoke access to an athlete's data.
+        #
+        def deauthorize(options = {})
+          Strava::Models::Authorization.new(post('deauthorize', { endpoint: Strava::OAuth.config.endpoint }.merge(options)))
+        end
+      end
+    end
+  end
+end

data/lib/strava/models/activity.rb

@@ -1,7 +1,7 @@
 module Strava
   module Models
     class Activity < Model
-      include Mixins::MetricDistance
+      include Mixins::Distance
       include Mixins::Time
       include Mixins::Elevation
 
@@ -60,8 +60,8 @@ module Strava
       property 'similar_activities', transform_with: ->(v) { Strava::Models::SimilarActivities.new(v) }
       property 'embed_token'
       property 'available_zones'
-      property 'splits_metric', transform_with: ->(v) { v.map { |r| Strava::Models::Split::Metric.new(r) } }
-      property 'splits_standard', transform_with: ->(v) { v.map { |r| Strava::Models::Split::Standard.new(r) } }
+      property 'splits_metric', transform_with: ->(v) { v.map { |r| Strava::Models::Split.new(r) } }
+      property 'splits_standard', transform_with: ->(v) { v.map { |r| Strava::Models::Split.new(r) } }
       property 'laps', transform_with: ->(v) { v.map { |r| Strava::Models::Lap.new(r) } }
       property 'gear', transform_with: ->(v) { Strava::Models::Gear.new(v) }
       property 'device_name'
@@ -78,30 +78,18 @@ module Strava
 
       def distance_s
         if type == 'Swim'
-          case units
-          when :metric then distance_in_meters_s
-          when :imperial then distance_in_yards_s
-          end
+          distance_in_meters_s
         else
-          case units
-          when :metric then distance_in_kilometers_s
-          when :imperial then distance_in_miles_s
-          end
+          distance_in_kilometers_s
         end
       end
 
       def pace_s
         case type
         when 'Swim'
-          case units
-          when :metric then pace_per_100_meters_s
-          when :imperial then pace_per_100_yards_s
-          end
+          pace_per_100_meters_s
         else
-          case units
-          when :metric then pace_per_kilometer_s
-          when :imperial then pace_per_mile_s
-          end
+          pace_per_kilometer_s
         end
       end
 

data/lib/strava/models/activity_total.rb

@@ -1,7 +1,7 @@
 module Strava
   module Models
     class ActivityTotal < Model
-      include Mixins::MetricDistance
+      include Mixins::Distance
       include Mixins::Time
       include Mixins::Elevation
 

data/lib/strava/models/authorization.rb

@@ -0,0 +1,7 @@
+module Strava
+  module Models
+    class Authorization < Model
+      property 'access_token'
+    end
+  end
+end

data/lib/strava/models/explorer_segment.rb

@@ -1,7 +1,7 @@
 module Strava
   module Models
     class ExplorerSegment < Model
-      include Mixins::MetricDistance
+      include Mixins::Distance
 
       property 'id'
       property 'resource_state'

data/lib/strava/models/gear.rb

@@ -1,7 +1,7 @@
 module Strava
   module Models
     class Gear < Model
-      include Mixins::MetricDistance
+      include Mixins::Distance
 
       property 'id'
       property 'resource_state'

data/lib/strava/models/mixins/distance.rb

@@ -9,24 +9,15 @@ module Strava
         end
 
         def distance_in_meters
-          case units
-          when :metric then distance
-          when :imperial then distance / 3.28084
-          end
+          distance
         end
 
         def distance_in_feet
-          case units
-          when :metric then distance * 3.28084
-          when :imperial then distance
-          end
+          distance * 3.28084
         end
 
         def distance_in_miles
-          case units
-          when :metric then distance_in_meters * 0.00062137
-          when :imperial then distance_in_feet / 5280
-          end
+          distance_in_meters * 0.00062137
         end
 
         def distance_in_miles_s
@@ -62,28 +53,7 @@ module Strava
         end
 
         def distance_s
-          case units
-          when :metric then distance_in_kilometers_s
-          when :imperial then distance_in_miles_s
-          end
-        end
-      end
-
-      module MetricDistance
-        extend ActiveSupport::Concern
-        include Strava::Models::Mixins::Distance
-
-        def units
-          :metric
-        end
-      end
-
-      module ImperialDistance
-        extend ActiveSupport::Concern
-        include Strava::Models::Mixins::Distance
-
-        def units
-          :imperial
+          distance_in_kilometers_s
         end
       end
     end

data/lib/strava/models/mixins/elevation.rb

@@ -9,36 +9,27 @@ module Strava
         end
 
         def total_elevation_gain_in_feet
-          case units
-          when :metric then total_elevation_gain * 3.28084
-          when :imperial then total_elevation_gain
-          end
+          total_elevation_gain * 3.28084
         end
 
         def total_elevation_gain_in_meters
-          case units
-          when :metric then total_elevation_gain
-          when :imperial then total_elevation_gain / 3.28084
-          end
+          total_elevation_gain
         end
 
         def total_elevation_gain_in_meters_s
-          return unless total_elevation_gain && total_elevation_gain.positive?
+          return if total_elevation_gain.nil?
 
           format('%gm', format('%.1f', total_elevation_gain_in_meters))
         end
 
         def total_elevation_gain_in_feet_s
-          return unless total_elevation_gain && total_elevation_gain.positive?
+          return if total_elevation_gain.nil?
 
           format('%gft', format('%.1f', total_elevation_gain_in_feet))
         end
 
         def total_elevation_gain_s
-          case units
-          when :metric then total_elevation_gain_in_meters_s
-          when :imperial then total_elevation_gain_in_feet_s
-          end
+          total_elevation_gain_in_meters_s
         end
       end
     end

data/lib/strava/models/mixins/time.rb

@@ -52,10 +52,7 @@ module Strava
         end
 
         def speed_s
-          case units
-          when :metric then kilometer_per_hour_s
-          when :imperial then miles_per_hour_s
-          end
+          kilometer_per_hour_s
         end
 
         private

data/lib/strava/models/photo.rb

@@ -5,6 +5,16 @@ module Strava
       property 'unique_id'
       property 'urls'
       property 'source'
+      property 'athlete_id'
+      property 'activity_id'
+      property 'activity_name'
+      property 'resource_state'
+      property 'caption'
+      property 'created_at', transform_with: ->(v) { Time.parse(v) }
+      property 'created_at_local', transform_with: ->(v) { Time.parse(v) }
+      property 'uploaded_at', transform_with: ->(v) { Time.parse(v) }
+      property 'sizes'
+      property 'default_photo'
     end
   end
 end

data/lib/strava/models/route.rb

@@ -1,7 +1,7 @@
 module Strava
   module Models
     class Route < Model
-      include Mixins::MetricDistance
+      include Mixins::Distance
       include Mixins::Elevation
       include Mixins::Time
 

data/lib/strava/models/running_race.rb

@@ -1,7 +1,7 @@
 module Strava
   module Models
     class RunningRace < Model
-      include Mixins::MetricDistance
+      include Mixins::Distance
 
       property 'id'
       property 'resource_state'

data/lib/strava/models/segment.rb

@@ -1,7 +1,7 @@
 module Strava
   module Models
     class Segment < Model
-      include Mixins::MetricDistance
+      include Mixins::Distance
       include Mixins::Elevation
       include Mixins::Time
 

data/lib/strava/models/segment_effort.rb

@@ -1,7 +1,7 @@
 module Strava
   module Models
     class SegmentEffort < Model
-      include Mixins::MetricDistance
+      include Mixins::Distance
       include Mixins::Time
 
       property 'id'

data/lib/strava/models/split.rb

@@ -10,20 +10,6 @@ module Strava
       property 'split'
       property 'average_heartrate'
       property 'pace_zone'
-
-      class Standard < Split
-        private
-
-        def units
-          :imperial
-        end
-      end
-
-      class Metric < Split
-        def units
-          :metric
-        end
-      end
     end
   end
 end

data/lib/strava/version.rb

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

data/lib/strava/web/request.rb

@@ -20,7 +20,9 @@ module Strava
       private
 
       def request(method, path, options)
-        path = [endpoint, path].join('/')
+        options = options.dup if options.key?(:request) || options.key?(:endpoint)
+        root = options.delete(:endpoint) || endpoint
+        path = [root, path].join('/')
         response = connection.send(method) do |request|
           case method
           when :get, :delete

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: strava-ruby-client
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Daniel Doubrovkine
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-04 00:00:00.000000000 Z
+date: 2018-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -68,15 +68,17 @@ dependencies:
         version: '0'
 description: 
 email: dblock@dblock.org
-executables: []
+executables:
+- strava-oauth-token
+- strava-webhooks
 extensions: []
 extra_rdoc_files: []
 files:
 - CHANGELOG.md
 - LICENSE.md
 - README.md
-- bin/strava-oauth-token.rb
-- bin/strava-webhooks.rb
+- bin/strava-oauth-token
+- bin/strava-webhooks
 - lib/strava-ruby-client.rb
 - lib/strava/api/client.rb
 - lib/strava/api/config.rb
@@ -85,6 +87,7 @@ files:
 - lib/strava/api/endpoints/athletes.rb
 - lib/strava/api/endpoints/clubs.rb
 - lib/strava/api/endpoints/gears.rb
+- lib/strava/api/endpoints/oauth.rb
 - lib/strava/api/endpoints/routes.rb
 - lib/strava/api/endpoints/running_races.rb
 - lib/strava/api/endpoints/segment_efforts.rb
@@ -99,6 +102,7 @@ files:
 - lib/strava/models/activity_total.rb
 - lib/strava/models/activity_zone.rb
 - lib/strava/models/athlete.rb
+- lib/strava/models/authorization.rb
 - lib/strava/models/club.rb
 - lib/strava/models/club_admin.rb
 - lib/strava/models/club_member.rb