Class: Smartcar::Base

Inherits:

Object

• Object
• Smartcar::Base

Includes:

Utils

Defined in:

lib/smartcar/base.rb

Overview

The Base class for all of the other class. Let other classes inherit from here and put common methods here.

Direct Known Subclasses

Battery, Charge, EngineOil, Fuel, Location, Oauth, Odometer, Permissions, TirePressure, User, Vehicle, VehicleAttributes, Vin

Defined Under Namespace

Classes: InvalidParameterValue

Constant Summary

BEARER =

Constant for Bearer auth type

'BEARER'.freeze

BASIC =

Constant for Basic auth type

'BASIC'.freeze

Instance Attribute Summary

• #error ⇒ Object

  Returns the value of attribute error.

• #meta ⇒ Object

  Returns the value of attribute meta.

• #token ⇒ Object

  Returns the value of attribute token.

Instance Method Summary

• #fetch(path:, options: {}, auth: 'BEARER') ⇒ Object

  This requires a proc 'PATH' to be defined in the class.

Methods included from Utils

#get_config, #get_error, #initialize

Instance Attribute Details

#error ⇒ Object

Returns the value of attribute error.

# File 'lib/smartcar/base.rb', line 16

def error
  @error
end

#meta ⇒ Object

Returns the value of attribute meta.

# File 'lib/smartcar/base.rb', line 16

def meta
  @meta
end

#token ⇒ Object

Returns the value of attribute token.

# File 'lib/smartcar/base.rb', line 16

def token
  @token
end

Instance Method Details

#fetch(path:, options: {}, auth: 'BEARER') ⇒ Object

This requires a proc 'PATH' to be defined in the class

Parameters:

• path (String) —

  resource path

• options (Hash) (defaults to: {}) —

  query params

• auth (String) (defaults to: 'BEARER') —

  type of auth

Returns:

• (Object)

# File 'lib/smartcar/base.rb', line 50

def fetch(path: , options: {}, auth: 'BEARER')
  _path = path
  _path += "?#{URI.encode_www_form(options)}" unless options.empty?
  get(_path, {auth: auth})
end