rlyft 0.1.1 → 1.0.0

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

@@ -0,0 +1,234 @@
+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 }
+          )
+        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 }
+          )
+        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)
+          )
+        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 }
+          )
+        end
+        alias_method :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)
+          )
+        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 }
+          )
+        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.
+        #   Accepted values are 'lyft', 'lyft_line', 'lyft_plus', and 'lyft_suv'.
+        #
+        def set_ridetypes(args = {})
+          validate_sandboxed
+          make_request(
+            http_method: :put,
+            endpoint: path_for(:sandbox_ridetypes),
+            access_token: args.delete(:access_token),
+            options: { body: args.to_json }
+          )
+        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
+        #
+        def set_status(args = {})
+          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 }
+          )
+        end
+
+        ##
+        # Set the primetime percentage in area
+        #
+        # @example Set the prime time percentage.
+        #   client.rides.set_primetime(
+        #     access_token: 'my_token',
+        #     lat: 37.7833,
+        #     lng: -122.4167,
+        #     primetime_percentage: '25%'
+        #   )
+        #
+        # @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
+        #
+        def set_primetime(args = {})
+          validate_sandboxed
+          make_request(
+            http_method: :put,
+            endpoint: path_for(:sandbox_primetime),
+            access_token: args.delete(:access_token),
+            options: { body: args.to_json }
+          )
+        end
+
+        ##
+        # Set driver availability for a ride type in an
+        # area.
+        #
+        # @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 = {})
+          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 }
+          )
+        end
+
+        private
+
+        ##
+        # Validates if the current configuration is using lyft sandbox.
+        # @raise [RuntimeError] Raises if not in sandbox mode.
+        #
+        def validate_sandboxed
+          raise 'This method is only available in sandbox mode.' unless @configuration.sandbox?
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+module Lyft
+  class Client
+    module Api
+      class User < Lyft::Client::Api::Base
+        ENDPOINTS = {
+          history: "/#{API_VERSION}/rides",
+          profile: "/#{API_VERSION}/profile"
+        }
+
+        ##
+        # Get ride history
+        #
+        # @param [Hash] args
+        # @option args [String] :access_token (*required*)
+        # @option args [DateTime] :start_time (*required*)
+        # @option args [DateTime] :end_time
+        # @option args [Integer] :limit
+        #
+        def ride_history(args = {})
+          args.delete(:end_time) if args[:end_time].blank?
+          args.delete(:limit) if args[:limit].blank?
+
+          make_request(
+            http_method: :get,
+            endpoint: path_for(:history),
+            access_token: args.delete(:access_token),
+            options: { query: args }
+          )
+        end
+
+        ##
+        # Get user's profile
+        #
+        # @param [Hash] args
+        # @option args [String] :access_token (*required*)
+        #
+        def profile(args = {})
+          make_request(
+            http_method: :get,
+            endpoint: path_for(:profile),
+            access_token: args.delete(:access_token),
+            options: { query: args }
+          )
+        end
+      end
+    end
+  end
+end

data/lib/lyft/client/configuration.rb

@@ -0,0 +1,23 @@
+module Lyft
+  class Client
+    class Configuration
+      attr_reader :client_id, :client_secret, :debug_output, :use_sandbox
+
+      def initialize(args = {})
+        raise ArgumentError, ':client_id is missing' if args[:client_id].blank?
+        raise ArgumentError, ':client_secret is missing' if args[:client_secret].blank?
+
+        @client_id = args.fetch(:client_id)
+        @client_secret = args.fetch(:client_secret)
+        @use_sandbox = args.fetch(:use_sandbox, false)
+        @debug_output = args[:debug_output]
+
+        @client_secret = "SANDBOX-#{@client_secret}" if sandbox?
+      end
+
+      def sandbox?
+        @use_sandbox
+      end
+    end
+  end
+end

data/lib/lyft/client/mashed_parser.rb

@@ -0,0 +1,31 @@
+module Lyft
+  class Client
+    class MashedParser < HTTParty::Parser
+      protected
+
+      def xml
+        mashed super
+      end
+
+      def json
+        mashed super
+      end
+
+      def yaml
+        mashed super
+      end
+
+      private
+
+      def mashed(body)
+        if body.is_a? Hash
+          Hashie::Mash.new body
+        elsif body.is_a? Array
+          body.map(&method(:mashed))
+        else
+          body
+        end
+      end
+    end
+  end
+end

data/lib/lyft/client.rb

@@ -2,20 +2,72 @@ module Lyft
   ##
   # Client for making Lyft api requests
   #
-  # @attr [String] client_id The client id for lyft app.
-  # @attr [String] client_secret The client secret for lyft app.
-  #
   class Client
-    include Api::Oauth
-    include Api::Availability
-    include Api::Rides
-    include Api::Users
+    ##
+    # Keep track of what we are namespacing.
+    #
+    @@namespaces = []
+
+    attr_reader :configuration
+
+    ##
+    # Defines a method to access class instance.
+    #
+    # @example Create a namespace for availability
+    #   namespace :availability #=> Lyft::Client::Availability.new
+    #
+    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 }
+    end
+
+    ##
+    # Class to handle availability api calls.
+    # @return Lyft::Client::Api::Oauth
+    #
+    namespace :oauth
+
+    ##
+    # Class to handle availability api calls.
+    # @return Lyft::Client::Api::Availability
+    #
+    namespace :availability
+
+    ##
+    # Class to handle availability api calls.
+    # @return Lyft::Client::Api::Rides
+    #
+    namespace :rides
 
-    attr_accessor :client_id,
-                  :client_secret
+    ##
+    # Class to handle availability api calls.
+    # @return Lyft::Client::Api::User
+    #
+    namespace :user
 
-    def initialize
-      yield self
+    ##
+    # The initializer
+    #
+    # @param [Hash] args
+    # @option args [String] :client_id
+    # @option args [String] :client_secret
+    # @option args [Boolean] :debug_output
+    #
+    def initialize(args = {})
+      @configuration = Lyft::Client::Configuration.new args
+      @@config = @configuration
     end
   end
 end

data/lib/lyft/ride/status.rb

@@ -0,0 +1,13 @@
+module Lyft
+  module Ride
+    module Status
+      PENDING = 'pending'.freeze
+      ACCEPTED = 'accepted'.freeze
+      ARRIVED = 'arrived'.freeze
+      PICKED_UP = 'pickedUp'.freeze
+      DROPPED_OFF = 'droppedOff'.freeze
+      CANCELED = 'canceled'.freeze
+      UNKNOWN = 'unknown'.freeze
+    end
+  end
+end

data/lib/lyft/ride/type.rb

@@ -0,0 +1,10 @@
+module Lyft
+  module Ride
+    module Type
+      LYFT = 'lyft'.freeze
+      LYFT_LINE = 'lyft_line'.freeze
+      LYFT_PLUS = 'lyft_plus'.freeze
+      LYFT_SUV = 'lyft_suv'.freeze
+    end
+  end
+end

data/lib/lyft/ride.rb

@@ -0,0 +1,18 @@
+require 'lyft/ride/status'
+require 'lyft/ride/type'
+
+module Lyft
+  module Ride
+    ##
+    # List of values for ride types
+    # @return [Array<String>] A list of ride type values
+    #
+    RIDE_TYPES = Lyft::Ride::Type.constants.map { |c| Lyft::Ride::Type.const_get(c) }
+
+    ##
+    # List of values for ride status
+    # @return [Array<String>] A list of ride status values
+    #
+    RIDE_STATUSES = Lyft::Ride::Status.constants.map { |c| Lyft::Ride::Status.const_get(c) }
+  end
+end

data/lib/lyft/version.rb

@@ -1,3 +1,3 @@
 module Lyft
-  VERSION = "0.1.1"
+  VERSION = '1.0.0'
 end

data/lib/lyft.rb

@@ -1,14 +1,23 @@
+# Development gems
+require 'pry'
+
 # 3rd party Libraries
 require 'httparty'
 require 'active_support/all'
+require 'hashie'
+
+require 'lyft/ride'
+require 'lyft/version'
+
+require 'lyft/client/configuration'
+require 'lyft/client/mashed_parser'
 
-# Gem libraries
-Dir[File.dirname(__FILE__) + '/lyft/**/*.rb'].each { |file| require file }
+require 'lyft/client/api/base'
+require 'lyft/client/api/availability'
+require 'lyft/client/api/oauth'
+require 'lyft/client/api/rides'
+require 'lyft/client/api/user'
 
-module Lyft
-  API_URI = 'https://api.lyft.com'
+require 'lyft/client'
 
-  def self.endpoint(path)
-    API_URI + path
-  end
-end
+module Lyft; end

data/lyft.gemspec

@@ -29,10 +29,15 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency 'httparty'
   spec.add_runtime_dependency 'activesupport'
+  spec.add_runtime_dependency 'hashie'
 
   spec.add_development_dependency "bundler", "~> 1.11"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-its"
+  spec.add_development_dependency "rubocop", "~> 0.47.1"
   spec.add_development_dependency "pry"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "webmock"
   spec.add_development_dependency "yard"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rlyft
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Taylor Scott
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-05 00:00:00.000000000 Z
+date: 2017-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +94,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.47.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.47.1
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +136,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -116,6 +186,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-gemset"
+- ".ruby-version"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -123,19 +197,17 @@ files:
 - bin/console
 - bin/setup
 - lib/lyft.rb
-- lib/lyft/api/availability/cost.rb
-- lib/lyft/api/availability/eta.rb
-- lib/lyft/api/availability/nearby_drivers.rb
-- lib/lyft/api/availability/ride_types.rb
-- lib/lyft/api/oauth/public_token.rb
-- lib/lyft/api/rides/ride.rb
-- lib/lyft/api/rides/ride_cancel.rb
-- lib/lyft/api/rides/ride_details.rb
-- lib/lyft/api/rides/ride_rating_and_tipping.rb
-- lib/lyft/api/rides/ride_receipt.rb
-- lib/lyft/api/users/profile.rb
-- lib/lyft/api/users/ride_history.rb
 - lib/lyft/client.rb
+- lib/lyft/client/api/availability.rb
+- lib/lyft/client/api/base.rb
+- lib/lyft/client/api/oauth.rb
+- lib/lyft/client/api/rides.rb
+- lib/lyft/client/api/user.rb
+- lib/lyft/client/configuration.rb
+- lib/lyft/client/mashed_parser.rb
+- lib/lyft/ride.rb
+- lib/lyft/ride/status.rb
+- lib/lyft/ride/type.rb
 - lib/lyft/version.rb
 - lyft.gemspec
 homepage: https://github.com/skukx/lyft
@@ -163,4 +235,3 @@ signing_key:
 specification_version: 4
 summary: Ruby wrapper for Lyft API.
 test_files: []
-has_rdoc: