rlyft 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c0503db11b90ab5adce78f79a86c849857afb094
-  data.tar.gz: bbe410d1d2206df8a3d59e2329a23201a9da6ef8
+  metadata.gz: d1571d70c3a0cb544192c6d344b3bcf31082070b
+  data.tar.gz: 1aa7de7ac5b6506c9461f2122fbcd912f42cec6a
 SHA512:
-  metadata.gz: 4287be90d72943fc8fa5afe601c54eb81faf53c232701ef30f31600485afcd13ab4e9d90a65e993c23514e506091d6f203bf7fb8ff55f5d7794d574dbc41e538
-  data.tar.gz: c3c5d5ecd300568bbb0af195e06a3d6057c5b79e3c9ffa6450d0e40fb50a6f71ac9cc8bfd6b21be4be709cc2b76ae90ba2f847f88e0d237361c3ee040d08c84e
+  metadata.gz: 0ff7696a0fe03fd049cda9780597f036c0eb58fa1425e786385fdd983e95f2251c48e9863e2aaedc196316150bb18af874946f2107aa7cc88d42e45bed7948dd
+  data.tar.gz: 623c9b3143eaee11807dee1d2dbef78c8d8e19ee38c2af9926e59e26504e149c283ea73fbfbd4a902b95ec511709700fd60127a77e73a98044cc38f61546a72b

data/.gitignore

@@ -11,3 +11,6 @@ lyft_setup.rb
 
 # Ignore application configuration
 /config/application.yml
+
+# Ignore setup script
+/lyft_setup.rb

data/.rubocop.yml

@@ -8,8 +8,12 @@ AllCops:
   TargetRubyVersion: 2.3
 Metrics/BlockLength:
   Enabled: false
+Metrics/ClassLength:
+  Enabled: false
 Metrics/LineLength:
   Enabled: false
+Metrics/MethodLength:
+  Enabled: false
 Style/AccessorMethodName:
   Enabled: false
 Style/ClassVars:

data/README.md

@@ -1,14 +1,18 @@
-# Lyft
+# RLyft
+[![Gem Version](https://badge.fury.io/rb/rlyft.svg)](https://badge.fury.io/rb/rlyft)
 [![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.
 
+## Breaking Changes
+  See https://github.com/skukx/rlyft/pull/6
+
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'lyft', git: 'git@github.com:skukx/lyft.git'
+gem 'rlyft', require 'lyft'
 ```
 
 And then execute:
@@ -21,7 +25,6 @@ And then execute:
 client = Lyft::Client.new(
   client_id: 'client_id',
   client_secret: 'client_secret',
-  debug_output: STDOUT,
   use_sandbox: true
 )
 ```
@@ -31,62 +34,74 @@ Get Access Token:
 
 ```ruby
 # Public token
-client.authentication.retrieve_access_token
+client.oauth.retrieve_access_token
 
 # When using oauth.
-client.authentication.retrieve_access_token authorization_code: 'auth_code'
+client.oauth.retrieve_access_token authorization_code: 'auth_code'
 ```
 
 Calculate Lyft cost.
 
 ```ruby
-client.availability.cost access_token: 'access_token'
-                         start_lat: 37.7772,
-                         start_lng: -122.4233,
-                         end_lat: 37.7972,
-                         end_lng: -122.4533
+client.availability.cost access_token: 'access_token',
+                         params: {
+                           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.availability.eta access_token: 'token',
-                        lat: 37.7772,
-                        lng: -122.4233
+                        params: {
+                          lat: 37.7772,
+                          lng: -122.4233
+                        }
 ```
 
 Get the location of nearby drivers.
 
 ```ruby
 client.availability.nearby_drivers access_token: 'token',
-                                   lat: 37.7772,
-                                   lng: -122.4233
+                                   params: {
+                                     lat: 37.7772,
+                                     lng: -122.4233
+                                   }
 ```
 
 Get available ride types.
 
 ```ruby
 client.availability.ride_types access_token: 'token',
-                               lat: 37.7772,
-                               lng: -122.4233
+                               params: {
+                                 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'
+                     params: {
+                       origin: { lat: 37.7772, lng: -122.4233 },
+                       ride_type: Lyft::Ride::Type::LYFT
+                     }
 ```
 
 Cancel a ride
 ```ruby
 client.rides.cancel access_token: 'token',
-                    ride_id: '123'
+                    params: { ride_id: '123' }
 
 # When cancel_confirmation_token is needed.
 client.rides.cancel access_token: 'token',
-                    ride_id: '123',
-                    cancel_confirmation_token: 'cancellation_token'
+                    params: {
+                      ride_id: '123',
+                      cancel_confirmation_token: 'cancellation_token'
+                    }
 ```
 
 ## Using the Sandbox:
@@ -95,9 +110,14 @@ 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]
+  params: {
+    lat: 37.7833,
+    lng: -122.4167,
+    ride_types: [
+      Lyft::Ride::Type::LYFT,
+      Lyft::Ride::Type::LYFT_PLUS
+    ]
+  }
 )
 ```
 
@@ -105,8 +125,10 @@ Set ride status
 ```ruby
 client.rides.set_status(
   access_token: 'my_token',
-  ride_id: 'my_ride_id',
-  status: Lyft::Ride::Status::ACCEPTED
+  params: {
+    ride_id: 'my_ride_id',
+    status: Lyft::Ride::Status::ACCEPTED
+  }
 )
 ```
 
@@ -114,10 +136,12 @@ 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
+  params: {
+    ride_type: Lyft::Ride::Type::LYFT_SUV
+    lat: 37.7833,
+    lng: -122.4167,
+    driver_availability: true
+  }
 )
 ```
 
@@ -125,9 +149,11 @@ Set primetime percentage
 ```ruby
 client.rides.set_primetime(
   access_token: 'my_token',
-  lat: 37.7833,
-  lng: -122.4167,
-  primetime_percentage: '25%'
+  params: {
+    lat: 37.7833,
+    lng: -122.4167,
+    primetime_percentage: '25%'
+  }
 )
 ```
 
@@ -139,7 +165,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/lyft.
+Bug reports and pull requests are welcome on GitHub at https://github.com/skukx/lyft.
 
 
 ## License

data/lib/lyft.rb

@@ -1,23 +1,20 @@
-# Development gems
-require 'pry'
-
 # 3rd party Libraries
-require 'httparty'
 require 'active_support/all'
-require 'hashie'
+require 'faraday'
+require 'faraday_middleware'
 
+require 'lyft/response'
 require 'lyft/ride'
 require 'lyft/version'
 
-require 'lyft/client/configuration'
-require 'lyft/client/mashed_parser'
-
+require 'lyft/client/api'
 require 'lyft/client/api/base'
 require 'lyft/client/api/availability'
 require 'lyft/client/api/oauth'
+require 'lyft/client/api/oauth/grant_type'
+require 'lyft/client/api/oauth/scope'
 require 'lyft/client/api/rides'
 require 'lyft/client/api/user'
 
 require 'lyft/client'
-
-module Lyft; end
+require 'lyft/client/configuration'

data/lib/lyft/client.rb

@@ -4,12 +4,17 @@ module Lyft
   #
   class Client
     ##
-    # Keep track of what we are namespacing.
+    # The configuration for the Lyft Client
+    # @return [Lyft::Api::Configuration]
     #
-    @@namespaces = []
-
     attr_reader :configuration
 
+    ##
+    # Keep track of what we are namespacing.
+    #
+    @namespaces = []
+    @connection = nil
+
     ##
     # Defines a method to access class instance.
     #
@@ -19,18 +24,7 @@ module Lyft
     def self.namespace(name)
       converted = name.to_s.split('_').map(&:capitalize).join
       klass = Lyft::Client::Api.const_get(converted)
-      create_instance(klass)
-    end
-
-    ##
-    # Dynamically creates an attr_reader for each client space
-    # and sets it to the initalized values
-    #
-    def self.create_instance(klass)
-      reader = klass.to_s.split('::').last.underscore
-      @@namespaces << reader
-
-      define_method(reader.to_sym) { klass.new @@config }
+      @namespaces << klass
     end
 
     ##
@@ -67,7 +61,17 @@ module Lyft
     #
     def initialize(args = {})
       @configuration = Lyft::Client::Configuration.new args
-      @@config = @configuration
+      build_namespaces
+    end
+
+    private
+
+    def build_namespaces
+      namespaces = self.class.instance_variable_get(:@namespaces)
+      namespaces.each do |klass|
+        reader = klass.to_s.split('::').last.underscore
+        self.class.send(:define_method, reader.to_sym) { klass.new @configuration }
+      end
     end
   end
 end

data/lib/lyft/client/api.rb

@@ -0,0 +1,8 @@
+module Lyft
+  class Client
+    module Api
+      VERSION = ENV['LYFT_API_VERSION'] || 'v1'
+      BASE_URL = 'https://api.lyft.com'
+    end
+  end
+end

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

@@ -2,104 +2,93 @@ 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'
+        #     access_token: 'token',
+        #     params: {
+        #       start_lat: 37.7772,
+        #       start_lng: -122.4233,
+        #       end_lat: 37.7972,
+        #       end_lng: -122.4533
+        #     }
         #   )
         #
-        # @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*)
+        # @param access_token [String] The access_token (*required*)
+        # @param params [Hash] The lyft parameters.
+        # @option params [Float] :start_lat The latitude of starting point. (*required*)
+        # @option params [Float] :start_lng The longitude of starting point. (*required*)
+        # @option params [Float] :end_lat The latitude of the end point. (*required*)
+        # @option params [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 }
-          )
+        def cost(access_token:, params: {})
+          resp = connection(access_token).get do |req|
+            req.url "/#{Api::VERSION}/cost"
+            req.params = params
+          end
+          handle_response(resp)
         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'
+        #   client.availability.eta access_token: 'my_token',
+        #                           params: { 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*)
+        # @param access_token [String] The access_token (*required*)
+        # @param params [Hash] The lyft parameters.
+        # @option params [Float] :lat The latitude of pickup. (*required*)
+        # @option params [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 }
-          )
+        def eta(access_token:, params: {})
+          resp = connection(access_token).get do |req|
+            req.url "/#{Api::VERSION}/eta"
+            req.params = params
+          end
+          handle_response(resp)
         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'
+        #   client.availability.nearby_drivers access_token: 'my_token',
+        #                                      params: { 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*)
+        # @param access_token [String] The access_token (*required*)
+        # @param params [Hash] The lyft parameters.
+        # @option params [Float] :lat The latitude of pickup. (*required*)
+        # @option params [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 }
-          )
+        def nearby_drivers(access_token:, params: {})
+          resp = connection(access_token).get do |req|
+            req.url "/#{Api::VERSION}/drivers"
+            req.params = params
+          end
+          handle_response(resp)
         end
 
         ##
         # Get available lyft ride types
         #
         # @example Get available ride types for a location.
-        #   client.availability.ride_types lat: 37.7772,
-        #                                  lng: -122.4233
+        #   client.availability.ride_types access_token: 'my_token',
+        #                                  params: { 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*)
+        # @param access_token [String] The access_token (*required*)
+        # @param params [Hash] The lyft parameters.
+        # @option params [Float] :lat The latitude of pickup. (*required*)
+        # @option params [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 }
-          )
+        def ride_types(access_token:, params: {})
+          resp = connection(access_token).get do |req|
+            req.url "/#{Api::VERSION}/ridetypes"
+            req.params = params
+          end
+          handle_response(resp)
         end
       end
     end