rlyft 0.1.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e30ad205ab2786789b29d6628a7e019b728c4004
-  data.tar.gz: 52ef840de85b6ab593e847be586a2293dc0c404c
+  metadata.gz: c0503db11b90ab5adce78f79a86c849857afb094
+  data.tar.gz: bbe410d1d2206df8a3d59e2329a23201a9da6ef8
 SHA512:
-  metadata.gz: 7547028ed225fb54fa166120af7901097552b5ea6d5e538389197b63414a45cb4f58d9c75e56d458511d6cb021cdcd3360d576192c9ed7ae5d6c505f6e25cc21
-  data.tar.gz: 5b9742fff70a7d6e6c47017edda5f35ba3b83eb56cd3726fe7a9139bf9fa0eb8bbe96bbba8075e45843262db6ec0b8bc0e1bccaa60896bc6a858cf05b5912da3
+  metadata.gz: 4287be90d72943fc8fa5afe601c54eb81faf53c232701ef30f31600485afcd13ab4e9d90a65e993c23514e506091d6f203bf7fb8ff55f5d7794d574dbc41e538
+  data.tar.gz: c3c5d5ecd300568bbb0af195e06a3d6057c5b79e3c9ffa6450d0e40fb50a6f71ac9cc8bfd6b21be4be709cc2b76ae90ba2f847f88e0d237361c3ee040d08c84e

data/.gitignore

@@ -8,3 +8,6 @@
 /spec/reports/
 /tmp/
 lyft_setup.rb
+
+# Ignore application configuration
+/config/application.yml

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--format documentation

data/.rubocop.yml

@@ -0,0 +1,22 @@
+AllCops:
+  Exclude:
+    - bin/**/*
+    - spec/**/*
+    - lyft_setup.rb
+    - lyft.gemspec
+    - Rakefile
+  TargetRubyVersion: 2.3
+Metrics/BlockLength:
+  Enabled: false
+Metrics/LineLength:
+  Enabled: false
+Style/AccessorMethodName:
+  Enabled: false
+Style/ClassVars:
+  Enabled: false
+Style/Documentation:
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  Enabled: false
+Style/MutableConstant:
+  Enabled: false

data/.ruby-gemset

@@ -0,0 +1 @@
+rlyft

data/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/README.md

@@ -1,4 +1,5 @@
 # Lyft
+[![CircleCI](https://circleci.com/gh/skukx/rlyft.svg?style=shield)](https://circleci.com/gh/skukx/rlyft)
 
 Simple wrapper for interacting with Lyft's public api.
 
@@ -17,41 +18,117 @@ And then execute:
 ## Setup
 
 ```ruby
-client = Lyft::Client.new do |c|
-  c.client_id = 'client_id'
-  c.client_secret = 'client_secret'
-end
+client = Lyft::Client.new(
+  client_id: 'client_id',
+  client_secret: 'client_secret',
+  debug_output: STDOUT,
+  use_sandbox: true
+)
 ```
 
 ## Using Public Api
+Get Access Token:
+
+```ruby
+# Public token
+client.authentication.retrieve_access_token
+
+# When using oauth.
+client.authentication.retrieve_access_token authorization_code: 'auth_code'
+```
+
 Calculate Lyft cost.
 
 ```ruby
-client.cost start_lat: 37.7772,
-            start_lng: -122.4233,
-            end_lat: 37.7972,
-            end_lng: -122.4533
+client.availability.cost access_token: 'access_token'
+                         start_lat: 37.7772,
+                         start_lng: -122.4233,
+                         end_lat: 37.7972,
+                         end_lng: -122.4533
 ```
 
 Time for nearest driver to reach location.
 
 ```ruby
-client.eta lat: 37.7772,
-           lng: -122.4233
+client.availability.eta access_token: 'token',
+                        lat: 37.7772,
+                        lng: -122.4233
 ```
 
 Get the location of nearby drivers.
 
 ```ruby
-client.nearby_drivers lat: 37.7772,
-                      lng: -122.4233
+client.availability.nearby_drivers access_token: 'token',
+                                   lat: 37.7772,
+                                   lng: -122.4233
 ```
 
 Get available ride types.
 
 ```ruby
-client.ride_types lat: 37.7772,
-                  lng: -122.4233
+client.availability.ride_types access_token: 'token',
+                               lat: 37.7772,
+                               lng: -122.4233
+```
+
+Request a ride
+```ruby
+client.rides.request access_token: 'token',
+                     origin: { lat: 37.7772, lng: -122.4233 },
+                     ride_type: 'lyft'
+```
+
+Cancel a ride
+```ruby
+client.rides.cancel access_token: 'token',
+                    ride_id: '123'
+
+# When cancel_confirmation_token is needed.
+client.rides.cancel access_token: 'token',
+                    ride_id: '123',
+                    cancel_confirmation_token: 'cancellation_token'
+```
+
+## Using the Sandbox:
+
+Set available ride types
+```ruby
+client.rides.set_ridetypes(
+  access_token: 'my_token',
+  lat: 37.7833,
+  lng: -122.4167,
+  ride_types: [Lyft::Ride::Type::LYFT, Lyft::Ride::Type::LYFT_PLUS]
+)
+```
+
+Set ride status
+```ruby
+client.rides.set_status(
+  access_token: 'my_token',
+  ride_id: 'my_ride_id',
+  status: Lyft::Ride::Status::ACCEPTED
+)
+```
+
+Set driver availability
+```ruby
+client.rides.set_driver_availability(
+  access_token: 'my_token',
+  ride_type: Lyft::Ride::Type::LYFT_SUV
+  lat: 37.7833,
+  lng: -122.4167,
+  driver_availability: true
+)
+```
+
+Set primetime percentage
+```ruby
+client.rides.set_primetime(
+  access_token: 'my_token',
+  lat: 37.7833,
+  lng: -122.4167,
+  primetime_percentage: '25%'
+)
 ```
 
 ## Development

data/Rakefile

@@ -1,2 +1,10 @@
 require "bundler/gem_tasks"
-task :default => :spec
+require 'rspec/core/rake_task'
+
+begin
+  RSpec::Core::RakeTask.new(:spec)
+
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

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

@@ -0,0 +1,107 @@
+module Lyft
+  class Client
+    module Api
+      class Availability < Lyft::Client::Api::Base
+        ENDPOINTS = {
+          cost: "/#{API_VERSION}/cost",
+          eta: "/#{API_VERSION}/eta",
+          nearby_drivers: "/#{API_VERSION}/drivers",
+          ride_types: "/#{API_VERSION}/ridetypes"
+        }
+
+        ##
+        # Get the estimated cost of ride.
+        #
+        # @example Get the estimated cost of a ride.
+        #   client.availability.cost(
+        #     start_lat: 37.7772,
+        #     start_lng: -122.4233,
+        #     end_lat: 37.7972,
+        #     end_lng: -122.4533,
+        #     access_token: 'token'
+        #   )
+        #
+        # @param [Hash] args
+        # @option args [String] :access_token (*required*)
+        # @option args [Float] :start_lat The latitude of starting point. (*required*)
+        # @option args [Float] :start_lng The longitude of starting point. (*required*)
+        # @option args [Float] :end_lat The latitude of the end point. (*required*)
+        # @option args [Float] :end_lng The longitude of the end point. (*required*)
+        #
+        def cost(args = {})
+          make_request(
+            http_method: :get,
+            endpoint: path_for(:cost),
+            access_token: args.delete(:access_token),
+            options: { query: args }
+          )
+        end
+
+        ##
+        # Get eta for lyft driver to reach location
+        #
+        # @example Get lyft eta to a specified location.
+        #   client.availability.eta lat: 37.7772,
+        #                           lng: -122.4233
+        #                           access_token: 'token'
+        #
+        # @param [Hash] args
+        # @option args [String] :access_token (*required*)
+        # @option args [Float] :lat The latitude of pickup. (*required*)
+        # @option args [Float] :lng The longitude of pickup. (*required*)
+        #
+        def eta(args = {})
+          make_request(
+            http_method: :get,
+            endpoint: path_for(:eta),
+            access_token: args.delete(:access_token),
+            options: { query: args }
+          )
+        end
+
+        ##
+        # Get positions of nearby drivers
+        #
+        # @example Get location of nearby drivers.
+        #   client.availability.nearby_drivers lat: 37.7772,
+        #                                      lng: -122.4233,
+        #                                      access_token: 'token'
+        #
+        # @param [Hash] args
+        # @option args [String] :access_token (*required*)
+        # @option args [Float] :lat The latitude of pickup. (*required*)
+        # @option args [Float] :lng The longitude of pickup. (*required*)
+        #
+        def nearby_drivers(args = {})
+          make_request(
+            http_method: :get,
+            endpoint: path_for(:nearby_drivers),
+            access_token: args.delete(:access_token),
+            options: { query: args }
+          )
+        end
+
+        ##
+        # Get available lyft ride types
+        #
+        # @example Get available ride types for a location.
+        #   client.availability.ride_types lat: 37.7772,
+        #                                  lng: -122.4233
+        #
+        # @param [Hash] args
+        # @option args [String] :access_token (*required*)
+        # @option args [Float] :lat The latitude of pickup. (*required*)
+        # @option args [Float] :lng The longitude of pickup. (*required*)
+        #
+        def ride_types(args = {})
+          make_request(
+            http_method: :get,
+            endpoint: path_for(:nearby_drivers),
+            access_token: args.delete(:access_token),
+            options: { query: args }
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,95 @@
+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
+
+        def initialize(configuration)
+          @configuration = configuration
+          set_debug_output
+        end
+
+        def set_debug_output
+          self.class.default_options[:debug_output] = @configuration.debug_output
+        end
+
+        protected
+
+        ##
+        # 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, {})
+
+          set_authorization_header(access_token)
+          self.class.send(http_method, endpoint, options)
+        end
+
+        def set_authorization_header(access_token)
+          self.class.default_options[:headers] ||= {}
+          self.class
+              .default_options[:headers]
+              .merge! Authorization: "Bearer #{access_token}"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,73 @@
+module Lyft
+  class Client
+    module Api
+      ##
+      # Client for making authentication related requests to the
+      # 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.
+        #
+        # @example Get public access token.
+        #   resp = client.authentication.retrieve_access_token
+        #   resp.success?
+        #
+        # @example Get access token from authorization_code.
+        #   resp = client.authentication.retrieve_access_token authorization_code: 'auth_code'
+        #   resp.success?
+        #
+        # @param [String] authorization_code
+        # @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)
+        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')
+          body = {}
+          body[:grant_type] = grant_type
+          body[:scope] = scope unless authorization_code.present?
+          body[:code] = authorization_code if authorization_code.present?
+
+          body
+        end
+
+        def set_default_headers
+          self.class.default_options[:headers].delete(:Authorization)
+          self.class.basic_auth @configuration.client_id, @configuration.client_secret
+        end
+      end
+    end
+  end
+end