rlyft 1.0.0 → 2.0.0

data/lib/lyft/client/api/base.rb

@@ -2,92 +2,42 @@ module Lyft
   class Client
     module Api
       class Base
-        include HTTParty
-        base_uri 'https://api.lyft.com'
-        parser Lyft::Client::MashedParser
-
-        API_VERSION = ENV['LYFT_API_VERSION'] || 'v1'
-
-        ENDPOINTS = {}
-        DEFAULT_VALIDATES = [:access_token]
-
-        ##
-        # Constructs path for endpoint.
-        #
-        # @example Get path for product stock changes.
-        #   Products.path_for(:stock_changes) # '/products/stock_changes'
-        #
-        # @example Get path for product with sku.
-        #   Products.path_for(:product, { sku: '123' })
-        #   #=> Converts '/products/{{sku}}' to '/products/123'
-        #
-        # @param [Symbol] key The key for ENDPOINTS.
-        # @param [Hash] args A hash which maps values to variables.
-        #
-        # @return [String] The constructed path.
-        #
-        def self.path_for(key, args = {})
-          # Must call dup because gsub! works with the reference
-          # and will change the constant ENDPOINTS which is bad.
-          path = self::ENDPOINTS.fetch(key.to_sym).dup
-          args.each do |arg_key, value|
-            path.gsub!("{{#{arg_key}}}", value.to_s)
-          end
-
-          path
-        end
-
-        ##
-        # Resolve path for ENDPOINTS[key]
-        #
-        # @example Get path for product stock changes.
-        #   client.products.path_for(:stock_changes) # '/products/stock_changes'
-        #
-        # @example Get path for product with sku.
-        #   client.products.path_for(:product, { sku: '123' })
-        #   #=> Converts '/products/{{sku}}' to '/products/123'
-        #
-        # @return [String] The constructed path.
-        #
-        def path_for(key, args = {})
-          self.class.path_for(key, args)
-        end
+        attr_reader :configuration
 
         def initialize(configuration)
           @configuration = configuration
-          set_debug_output
         end
 
-        def set_debug_output
-          self.class.default_options[:debug_output] = @configuration.debug_output
-        end
+        def connection(access_token = nil)
+          Faraday.new(url: BASE_URL) do |conn|
+            # Headers
+            conn.headers = configuration.headers
 
-        protected
+            if access_token
+              conn.authorization :Bearer, access_token
+            else
+              conn.basic_auth(
+                configuration.client_id,
+                configuration.client_secret
+              )
+            end
+
+            # Request
+            conn.request :json
 
-        ##
-        # Make a request
-        #
-        # @param [Hash] args
-        # @option args [String, Symbol] :http_method The http request method.
-        # @option args [String] :endpoint The path to send request to.
-        # @option args [String] :access_token The access_token provided by lyft api.
-        # @option args [Hash] :options Options for HTTParty
-        #
-        def make_request(args = {})
-          http_method = args.fetch(:http_method)
-          endpoint = args.fetch(:endpoint, '')
-          access_token = args.fetch(:access_token, '')
-          options = args.fetch(:options, {})
+            # Response
+            conn.response :json
+            conn.response :logger
 
-          set_authorization_header(access_token)
-          self.class.send(http_method, endpoint, options)
+            conn.adapter  Faraday.default_adapter
+          end
         end
 
-        def set_authorization_header(access_token)
-          self.class.default_options[:headers] ||= {}
-          self.class
-              .default_options[:headers]
-              .merge! Authorization: "Bearer #{access_token}"
+        protected
+
+        def handle_response(response)
+          # Wrap in our own response class
+          Lyft::Response.new response
         end
       end
     end

data/lib/lyft/client/api/oauth.rb

@@ -6,21 +6,6 @@ module Lyft
       # lyft api
       #
       class Oauth < Lyft::Client::Api::Base
-        ##
-        # Authentication Endpoints
-        #
-        ENDPOINTS = {
-          access_token: '/oauth/token'
-        }
-
-        headers 'Content-Type': 'application/json',
-                'Accept': 'application/json'
-
-        def initialize(config)
-          super
-          set_default_headers
-        end
-
         ##
         # Retrieves access token from the server.
         #
@@ -33,39 +18,32 @@ module Lyft
         #   resp.success?
         #
         # @param [String] authorization_code
+        # @param [String] scope
         # @return [HTTParty::Response]
         #
-        def retrieve_access_token(authorization_code: nil)
-          path = path_for(:access_token)
-
-          grant_type = get_grant_type(authorization_code.present?)
-          body = request_body(
-            grant_type: grant_type,
-            authorization_code: authorization_code
-          )
-
-          self.class.post(path, body: body.to_json)
+        def retrieve_access_token(authorization_code: nil, scope: Scope::PUBLIC)
+          body = build_auth_body(authorization_code, scope)
+          resp = connection.post '/oauth/token', body
+          handle_response(resp)
         end
 
         private
 
-        def get_grant_type(has_auth_code)
-          return 'authorization_code' if has_auth_code
-          'client_credentials'
-        end
-
-        def request_body(grant_type:, authorization_code:, scope: 'public')
+        def build_auth_body(authorization_code, scope)
           body = {}
-          body[:grant_type] = grant_type
-          body[:scope] = scope unless authorization_code.present?
-          body[:code] = authorization_code if authorization_code.present?
+          body[:grant_type] = grant_type(authorization_code)
+          if authorization_code.present?
+            body[:code] = authorization_code
+          else
+            body[:scope] = scope
+          end
 
           body
         end
 
-        def set_default_headers
-          self.class.default_options[:headers].delete(:Authorization)
-          self.class.basic_auth @configuration.client_id, @configuration.client_secret
+        def grant_type(authorization_code)
+          return GrantType::AUTHORIZATION_CODE if authorization_code
+          GrantType::CLIENT_CREDENTIALS
         end
       end
     end

data/lib/lyft/client/api/oauth/grant_type.rb

@@ -0,0 +1,12 @@
+module Lyft
+  class Client
+    module Api
+      class Oauth < Lyft::Client::Api::Base
+        class GrantType
+          AUTHORIZATION_CODE = 'authorization_code'
+          CLIENT_CREDENTIALS = 'client_credentials'
+        end
+      end
+    end
+  end
+end

data/lib/lyft/client/api/oauth/scope.rb

@@ -0,0 +1,18 @@
+module Lyft
+  class Client
+    module Api
+      class Oauth < Lyft::Client::Api::Base
+        ##
+        # @see https://developer.lyft.com/v1/docs/authentication#section-scopes
+        #
+        class Scope
+          PUBLIC = 'public'
+          READ_RIDES = 'rides.read'
+          OFFLINE = 'offline'
+          REQUEST_RIDES = 'rides.request'
+          PROFILE = 'profile'
+        end
+      end
+    end
+  end
+end

data/lib/lyft/client/api/rides.rb

@@ -2,169 +2,155 @@ module Lyft
   class Client
     module Api
       class Rides < Lyft::Client::Api::Base
-        headers 'Content-Type': 'application/json'
-
-        ENDPOINTS = {
-          request: "/#{API_VERSION}/rides",
-          details: "/#{API_VERSION}/rides/{{ride_id}}",
-          cancel: "/#{API_VERSION}/rides/{{ride_id}}/cancel",
-          rating: "/#{API_VERSION}/rides/{{ride_id}}/rating",
-          receipt: "/#{API_VERSION}/rides/{{ride_id}}/receipt",
-          destination: "/#{API_VERSION}/rides/{{ride_id}}/destination",
-          sandbox_primetime: "/#{API_VERSION}/sandbox/primetime",
-          sandbox_rides: "/#{API_VERSION}/sandbox/rides/{{ride_id}}",
-          sandbox_ridetypes: "/#{API_VERSION}/sandbox/ridetypes/{{ride_type}}"
-        }
-
         ##
         # Cancel a ride request.
         # @see https://developer.lyft.com/docs/request-cancel
         #
-        # @param [Hash] args
-        # @option args [String] :access_token (*required*)
-        # @option args [String] :ride_id (*required*)
-        # @option args [String] :cancel_confirmation_token
-        #
-        def cancel(args = {})
-          make_request(
-            http_method: :post,
-            endpoint: path_for(:cancel, ride_id: args.delete(:ride_id)),
-            access_token: args.delete(:access_token),
-            options: { body: args.to_json }
-          )
+        # @param access_token [String] The access_token (*required*)
+        # @param params [Hash] The lyft parameters.
+        # @option params [String] :ride_id (*required*)
+        # @option params [String] :cancel_confirmation_token
+        #
+        def cancel(access_token:, params: {})
+          ride_id = require_ride_id(params)
+          resp = connection(access_token).post  do |req|
+            req.url "/#{Api::VERSION}/rides/#{ride_id}/cancel"
+            req.body = params
+          end
+          handle_response(resp)
         end
 
         ##
         # Update the ride destination
         # @see https://developer.lyft.com/docs/request-destination
         #
-        # @param [Hash] args
-        # @option args [String] :access_token (*required*)
-        # @option args [String] :ride_id (*required*)
-        # @option args [Float] :lat (*required*)
-        # @option args [Float] :lng (*required*)
-        # @option args [String] :address
-        #
-        def destination(args = {})
-          make_request(
-            http_method: :put,
-            endpoint: path_for(:destination, ride_id: args.delete(:ride_id)),
-            access_token: args.delete(:access_token),
-            options: { body: args.to_json }
-          )
+        # @param access_token [String] The access_token (*required*)
+        # @param params [Hash] The lyft parameters.
+        # @option params [String] :ride_id (*required*)
+        # @option params [Float] :lat (*required*)
+        # @option params [Float] :lng (*required*)
+        # @option params [String] :address
+        #
+        def destination(access_token:, params: {})
+          ride_id = require_ride_id(params)
+          resp = connection(access_token).put do |req|
+            req.url "/#{Api::VERSION}/rides/#{ride_id}/destination"
+            req.body = params
+          end
+          handle_response(resp)
         end
 
         ##
         # Get details of a ride.
         # @see https://developer.lyft.com/docs/ride-request-details
         #
-        # @param [Hash] args
-        # @option args [String] :access_token (*required*)
-        # @option args [String] :ride_id The ride id. (*required*)
-        #
-        def details(args = {})
-          make_request(
-            http_method: :get,
-            endpoint: path_for(:details, ride_id: args.delete(:ride_id)),
-            access_token: args.delete(:access_token)
-          )
+        # @param access_token [String] The access_token (*required*)
+        # @param params [Hash] The lyft parameters.
+        # @option params [String] :ride_id The ride id. (*required*)
+        #
+        def details(access_token:, params: {})
+          ride_id = require_ride_id(params)
+          resp = connection(access_token).get do |req|
+            req.url "/#{Api::VERSION}/rides/#{ride_id}"
+            req.body = params
+          end
+          handle_response(resp)
         end
 
         ##
         # Rate a ride and/or provide a tip.
         # @see https://developer.lyft.com/docs/ride-request-rating-and-tipping
         #
-        # @param [Hash] args
-        # @option args [String] :access_token (*required*)
-        # @option args [String] :ride_id (*required*)
-        # @option args [Integer] :rating Rating should be between 1 and 5 inclusive. (*required*)
-        # @option args [Hash] :tip The tip should include :amount and :currency.
-        # @option args [String] :feedback
-        #
-        def rate(args = {})
-          make_request(
-            http_method: :put,
-            endpoint: path_for(:rating, ride_id: args.delete(:ride_id)),
-            access_token: args.delete(:access_token),
-            options: { body: args.to_json }
-          )
+        # @param access_token [String] The access_token (*required*)
+        # @param params [Hash] The lyft parameters.
+        # @option params [String] :ride_id (*required*)
+        # @option params [Integer] :rating Rating should be between 1 and 5 inclusive. (*required*)
+        # @option params [Hash] :tip The tip should include :amount and :currency.
+        # @option params [String] :feedback
+        #
+        def rate(access_token:, params: {})
+          ride_id = require_ride_id(params)
+          resp = connection(access_token).put do |req|
+            req.url "/#{Api::VERSION}/rides/#{ride_id}/rating"
+            req.body = params
+          end
+          handle_response(resp)
         end
-        alias_method :tip, :rate
+        alias tip rate
 
         ##
         # Get receipt for ride
         # @see https://developer.lyft.com/docs/request-receipt
         #
-        # @param [Hash] args
-        # @option args [String] :access_token (*required*)
-        # @option args [String] :ride_id (*required*)
-        #
-        def receipt(args = {})
-          make_request(
-            http_method: :get,
-            endpoint: path_for(:receipt, ride_id: args.delete(:ride_id)),
-            access_token: args.delete(:access_token)
-          )
+        # @param access_token [String] The access_token (*required*)
+        # @param params [Hash] The lyft parameters.
+        # @option params [String] :ride_id (*required*)
+        #
+        def receipt(access_token:, params: {})
+          ride_id = require_ride_id(params)
+          resp = connection(access_token).get do |req|
+            req.url "/#{Api::VERSION}/rides/#{ride_id}/receipt"
+            req.params = params
+          end
+          handle_response(resp)
         end
 
         ##
         # Request a ride.
         # @see https://developer.lyft.com/docs/request
         #
-        # @param [Hash] args
-        # @option args [String] :access_token (*required*)
-        # @option args [Hash] :origin The origin should contain :lat and :lng
-        # @option args [Hash] :destination The destination should contain :lat and :lng.
-        # @option args [String] :ride_type
-        # @option args [String] :primetime_confirmation_token
-        #
-        def request(args = {})
-          make_request(
-            http_method: :post,
-            endpoint: path_for(:request),
-            access_token: args.delete(:access_token),
-            options: { body: args.to_json }
-          )
+        # @param access_token [String] The access_token (*required*)
+        # @param params [Hash] The lyft parameters.
+        # @option params [Hash] :origin The origin should contain :lat and :lng
+        # @option params [Hash] :destination The destination should contain :lat and :lng.
+        # @option params [String] :ride_type
+        # @option params [String] :primetime_confirmation_token
+        #
+        def request(access_token:, params: {})
+          resp = connection(access_token).post do |req|
+            req.url "/#{Api::VERSION}/rides"
+            req.body = params
+          end
+          handle_response(resp)
         end
 
         ##
         # Preset the ridetypes in area.
         #
         # @raise [RuntimeError] Raises if not in sandbox mode.
-        # @param [Hash] args
-        # @option args [String] :access_token (*required*)
-        # @option args [Float] :lat (*required*)
-        # @option args [Float] :lng (*required*)
-        # @option args [Array<String>] :ride_types The ride types to make available.
+        # @param access_token [String] The access_token (*required*)
+        # @param params [Hash] The lyft parameters.
+        # @option params [Float] :lat (*required*)
+        # @option params [Float] :lng (*required*)
+        # @option params [Array<String>] :ride_types The ride types to make available.
         #   Accepted values are 'lyft', 'lyft_line', 'lyft_plus', and 'lyft_suv'.
         #
-        def set_ridetypes(args = {})
+        def set_ridetypes(access_token:, params: {})
           validate_sandboxed
-          make_request(
-            http_method: :put,
-            endpoint: path_for(:sandbox_ridetypes),
-            access_token: args.delete(:access_token),
-            options: { body: args.to_json }
-          )
+          resp = connection(access_token).put do |req|
+            req.url "/#{Api::VERSION}/sandbox/ridetypes"
+            req.body = params
+          end
+          handle_response(resp)
         end
 
         ##
         # Propogate ride through different states.
         #
         # @raise [RuntimeError] Raises if not in sandbox mode.
-        # @param [Hash] args
-        # @option args [String] :access_token (*required*)
-        # @option args [String] :ride_id (*required*)
-        # @option args [String] :status The status of the ride
+        # @param access_token [String] The access_token (*required*)
+        # @param params [Hash] The lyft parameters.
+        # @option params [String] :ride_id (*required*)
+        # @option params [String] :status The status of the ride
         #
-        def set_status(args = {})
+        def set_status(access_token:, params: {})
           validate_sandboxed
-          make_request(
-            http_method: :put,
-            endpoint: path_for(:sandbox_rides, ride_id: args.delete(:ride_id)),
-            access_token: args.delete(:access_token),
-            options: { body: args.to_json }
-          )
+          ride_id = require_ride_id(params)
+          resp = connection(access_token).put do |req|
+            req.url "/#{Api::VERSION}/sandbox/rides/#{ride_id}"
+            req.body = params
+          end
+          handle_response(resp)
         end
 
         ##
@@ -179,20 +165,19 @@ module Lyft
         #   )
         #
         # @raise [RuntimeError] Raises if not in sandbox mode.
-        # @param [Hash] args
-        # @option args [String] :access_token (*required*)
-        # @option args [Float] :lat (*required*)
-        # @option args [Float] :lng (*required*)
-        # @option args [String] :primetime_percentage
+        # @param access_token [String] The access_token (*required*)
+        # @param params [Hash] The lyft parameters.
+        # @option params [Float] :lat (*required*)
+        # @option params [Float] :lng (*required*)
+        # @option params [String] :primetime_percentage
         #
-        def set_primetime(args = {})
+        def set_primetime(access_token:, params: {})
           validate_sandboxed
-          make_request(
-            http_method: :put,
-            endpoint: path_for(:sandbox_primetime),
-            access_token: args.delete(:access_token),
-            options: { body: args.to_json }
-          )
+          resp = connection(access_token).put do |req|
+            req.url "/#{Api::VERSION}/sandbox/primetime"
+            req.body = params
+          end
+          handle_response(resp)
         end
 
         ##
@@ -201,22 +186,21 @@ module Lyft
         #
         # @raise [RuntimeError] Raises if not in sandbox mode.
         # @raise [ArgumentError] Raises if invalid ride type.
-        # @option args [String] :access_token (*required*)
-        # @option args [String] :ride_type (*required*)
-        # @option args [Float] :lat (*required*)
-        # @option args [Float] :lng (*required*)
-        # @option args [Boolean] :driver_availability
-        #
-        def set_driver_availability(args = {})
+        # @param access_token [String] The access_token (*required*)
+        # @param params [Hash] The lyft parameters.
+        # @option params [String] :ride_type (*required*)
+        # @option params [Float] :lat (*required*)
+        # @option params [Float] :lng (*required*)
+        # @option params [Boolean] :driver_availability
+        #
+        def set_driver_availability(access_token:, params: {})
           validate_sandboxed
-          raise ArgumentError, 'Invalid Ride Type' unless Lyft::Ride::RIDE_TYPES.include? args[:ride_type]
-
-          make_request(
-            http_method: :put,
-            endpoint: path_for(:sandbox_ridetypes, ride_type: args.delete(:ride_type)),
-            access_token: args.delete(:access_token),
-            options: { body: args.to_json }
-          )
+          ride_type = require_ride_type(params)
+          resp = connection(access_token).put do |req|
+            req.url "/#{Api::VERSION}/sandbox/ridetypes/#{ride_type}"
+            req.body = params
+          end
+          handle_response(resp)
         end
 
         private
@@ -226,7 +210,26 @@ module Lyft
         # @raise [RuntimeError] Raises if not in sandbox mode.
         #
         def validate_sandboxed
-          raise 'This method is only available in sandbox mode.' unless @configuration.sandbox?
+          raise 'This method is only available in sandbox mode.' unless configuration.sandbox?
+        end
+
+        def validate_ride_type(params)
+          return if Lyft::Ride::RIDE_TYPES.include?(params[:ride_type])
+          raise ArgumentError, 'Invalid Ride Type'
+        end
+
+        def require_key(params, key)
+          value = params.delete(key.to_sym)
+          raise ArgumentError, "Missing param :#{key}" if value.blank?
+          value
+        end
+
+        def require_ride_id(params)
+          require_key(params, :ride_id)
+        end
+
+        def require_ride_type(params)
+          require_key(params, :ride_type)
         end
       end
     end