strava-ruby-client 0.4.3 → 1.0.0

data/lib/strava/web/client.rb

@@ -3,8 +3,8 @@
 module Strava
   module Web
     class Client
-      include Web::Connection
-      include Web::Request
+      include Strava::Web::Connection
+      include Strava::Web::Request
 
       attr_accessor(*Config::ATTRIBUTES)
 

data/lib/strava/web/connection.rb

@@ -25,10 +25,10 @@ module Strava
           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.request :multipart
+            connection.request :url_encoded
+            connection.use Strava::Web::RaiseResponseError
+            connection.response :json
             connection.response :logger, logger if logger
             connection.adapter ::Faraday.default_adapter
           end

data/lib/strava/web/raise_response_error.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Strava
+  module Web
+    class RaiseResponseError < ::Faraday::Middleware
+      CLIENT_ERROR_STATUSES = (400...600).freeze
+
+      def on_complete(env)
+        case env[:status]
+        when 404
+          raise Faraday::ResourceNotFound, response_values(env)
+        when 407
+          # mimic the behavior that we get with proxy requests with HTTPS
+          raise Faraday::ConnectionFailed, %(407 "Proxy Authentication Required ")
+        when CLIENT_ERROR_STATUSES
+          raise Strava::Errors::Fault, response_values(env)
+        end
+      end
+
+      def response_values(env)
+        {
+          status: env.status,
+          headers: env.response_headers,
+          body: env.body
+        }
+      end
+    end
+  end
+end

data/lib/strava/web/request.rb

@@ -25,7 +25,7 @@ module Strava
         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|
+        http_response = connection.send(method) do |request|
           case method
           when :get, :delete
             request.url(path, options)
@@ -35,7 +35,8 @@ module Strava
           end
           request.options.merge!(options.delete(:request)) if options.key?(:request)
         end
-        response.body
+
+        Strava::Web::Response.new(http_response)
       end
     end
   end

data/lib/strava/web/response.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module Strava
+  module Web
+    #
+    # wrapper class as abstraction for API response returned from the Faraday Adapter
+    # working with a deep copy, in order to not mutate the original request itself
+    #
+    class Response
+      include Strava::DeepCopyable
+
+      attr_reader :http_response, :response
+
+      #
+      # @param [Faraday::Response] http_response
+      #
+      def initialize(http_response)
+        @http_response = deep_copy(http_response)
+        @response = conditional_response_upgrade!(http_response)
+      end
+
+      private
+
+      #
+      # returns a modified deep copy of the Faraday::Response
+      #
+      # @param [Faraday::Response] http_response
+      #
+      # @return [Array, Hash{String => any}]
+      #
+      def conditional_response_upgrade!(http_response)
+        response = deep_copy(http_response)
+
+        case response.body
+        when Array
+          upgrade_array_body!(response)
+        when Hash
+          response.body['http_response'] = response
+        else
+          response.body
+        end
+      end
+
+      #
+      # mutates the response when body is_a? Hash
+      #
+      # @param [Symbol] method_symbol
+      # @param [any] *args
+      # @param [Proc] &block
+      #
+      # @raise [NoMethodError]
+      # @return [any]
+      #
+      def operate_on_response_body!(method_symbol, *args, &block)
+        case @response.body
+        when Hash
+          @response.body.send(method_symbol, *args, &block)
+        else
+          raise NoMethodError
+        end
+      end
+
+      #
+      # mutates all responses in the body
+      #
+      # @param [Faraday::Response] response from the Strava API
+      #
+      # @return [Array<Faraday::Response>]
+      #
+      def upgrade_array_body!(response)
+        response.body.map! do |body_elem|
+          body_elem ||= {}
+          body_elem['http_response'] = response
+          body_elem
+        end
+      end
+
+      def method_missing(method_symbol, *args, &block)
+        case @response
+        when Array
+          @response.send(method_symbol, *args, &block)
+        else
+          operate_on_response_body!(method_symbol, *args, &block)
+        end
+      end
+
+      def respond_to_missing?(method_name, include_private = false)
+        super
+      end
+    end
+  end
+end

data/lib/strava/webhooks/models/subscription.rb

@@ -3,7 +3,7 @@
 module Strava
   module Webhooks
     module Models
-      class Subscription < Hashie::Trash
+      class Subscription < Strava::Models::Response
         property 'id'
         property 'application_id'
         property 'callback_url'

data/lib/strava-ruby-client.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'faraday'
-require 'faraday_middleware'
+require 'faraday/multipart'
 require 'json'
 require 'logger'
 require 'hashie'
@@ -14,15 +14,18 @@ require 'active_support/concern'
 
 require_relative 'strava/version'
 require_relative 'strava/logger'
+require_relative 'strava/deep_copyable'
 
 require_relative 'strava/errors/fault'
 
+require_relative 'strava/models/mixins/http_response'
 require_relative 'strava/models/mixins/distance'
 require_relative 'strava/models/mixins/elevation'
 require_relative 'strava/models/mixins/time'
 require_relative 'strava/models/mixins/start_date_local'
 
 require_relative 'strava/models/model'
+require_relative 'strava/models/response'
 require_relative 'strava/models/token'
 require_relative 'strava/models/athlete'
 require_relative 'strava/models/map'
@@ -54,19 +57,19 @@ require_relative 'strava/models/kudoser'
 require_relative 'strava/models/running_race'
 require_relative 'strava/models/achievement'
 require_relative 'strava/models/segment_stats'
-require_relative 'strava/models/segment_leaderboard'
-require_relative 'strava/models/segment_leaderboard_entry'
 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/raise_response_error'
 require_relative 'strava/web/connection'
+require_relative 'strava/web/api_response'
 require_relative 'strava/web/request'
 require_relative 'strava/web/config'
 require_relative 'strava/web/client'
+require_relative 'strava/web/response'
 
 require_relative 'strava/oauth/config'
 require_relative 'strava/oauth/client'
@@ -79,6 +82,7 @@ require_relative 'strava/webhooks/models/event'
 
 require_relative 'strava/api/config'
 require_relative 'strava/api/cursor'
+require_relative 'strava/api/ratelimit'
 
 require_relative 'strava/api/endpoints/activities'
 require_relative 'strava/api/endpoints/athletes'
@@ -92,4 +96,5 @@ require_relative 'strava/api/endpoints/streams'
 require_relative 'strava/api/endpoints/uploads'
 require_relative 'strava/api/endpoints/oauth'
 
+require_relative 'strava/api/pagination'
 require_relative 'strava/api/client'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: strava-ruby-client
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 1.0.0
 platform: ruby
 authors:
 - Daniel Doubrovkine
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-21 00:00:00.000000000 Z
+date: 2022-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -30,28 +30,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: faraday_middleware
+  name: faraday-multipart
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +94,9 @@ files:
 - lib/strava/api/endpoints/segments.rb
 - lib/strava/api/endpoints/streams.rb
 - lib/strava/api/endpoints/uploads.rb
+- lib/strava/api/pagination.rb
+- lib/strava/api/ratelimit.rb
+- lib/strava/deep_copyable.rb
 - lib/strava/errors/fault.rb
 - lib/strava/logger.rb
 - lib/strava/models/achievement.rb
@@ -116,18 +119,18 @@ files:
 - lib/strava/models/map.rb
 - lib/strava/models/mixins/distance.rb
 - lib/strava/models/mixins/elevation.rb
+- lib/strava/models/mixins/http_response.rb
 - lib/strava/models/mixins/start_date_local.rb
 - lib/strava/models/mixins/time.rb
 - lib/strava/models/model.rb
 - lib/strava/models/photo.rb
 - lib/strava/models/photos.rb
 - lib/strava/models/power_zone_ranges.rb
+- lib/strava/models/response.rb
 - lib/strava/models/route.rb
 - lib/strava/models/running_race.rb
 - lib/strava/models/segment.rb
 - lib/strava/models/segment_effort.rb
-- lib/strava/models/segment_leaderboard.rb
-- lib/strava/models/segment_leaderboard_entry.rb
 - lib/strava/models/segment_stats.rb
 - lib/strava/models/similar_activities.rb
 - lib/strava/models/split.rb
@@ -142,11 +145,13 @@ files:
 - lib/strava/oauth/client.rb
 - lib/strava/oauth/config.rb
 - lib/strava/version.rb
+- lib/strava/web/api_response.rb
 - lib/strava/web/client.rb
 - lib/strava/web/config.rb
 - lib/strava/web/connection.rb
-- lib/strava/web/raise_error.rb
+- lib/strava/web/raise_response_error.rb
 - lib/strava/web/request.rb
+- lib/strava/web/response.rb
 - lib/strava/webhooks/client.rb
 - lib/strava/webhooks/config.rb
 - lib/strava/webhooks/models/challenge.rb
@@ -165,14 +170,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubygems_version: 3.1.3
+rubygems_version: 3.2.33
 signing_key:
 specification_version: 4
 summary: Strava API Ruby client.

data/lib/strava/models/segment_leaderboard.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-module Strava
-  module Models
-    class SegmentLeaderboard < Model
-      property 'effort_count'
-      property 'entry_count'
-      property 'kom_type'
-      property 'entries', transform_with: ->(v) { v.map { |r| SegmentLeaderboardEntry.new(r) } }
-    end
-  end
-end

data/lib/strava/models/segment_leaderboard_entry.rb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-module Strava
-  module Models
-    class SegmentLeaderboardEntry < Model
-      include Mixins::Time
-      include Mixins::StartDateLocal
-
-      property 'athlete_name'
-      property 'start_date', transform_with: ->(v) { Time.parse(v) }
-      property 'rank'
-    end
-  end
-end

data/lib/strava/web/raise_error.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-module Strava
-  module Web
-    module Response
-      class RaiseError < ::Faraday::Response::Middleware
-        CLIENT_ERROR_STATUSES = (400...600).freeze
-
-        def on_complete(env)
-          case env[:status]
-          when 404
-            raise Faraday::ResourceNotFound, response_values(env)
-          when 407
-            # mimic the behavior that we get with proxy requests with HTTPS
-            raise Faraday::ConnectionFailed, %(407 "Proxy Authentication Required ")
-          when CLIENT_ERROR_STATUSES
-            raise Strava::Errors::Fault, response_values(env)
-          end
-        end
-
-        def response_values(env)
-          {
-            status: env.status,
-            headers: env.response_headers,
-            body: env.body
-          }
-        end
-      end
-    end
-  end
-end