Class: Lyft::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/lyft/client.rb,
lib/lyft/client/api.rb,
lib/lyft/client/api/base.rb,
lib/lyft/client/api/user.rb,
lib/lyft/client/api/oauth.rb,
lib/lyft/client/api/rides.rb,
lib/lyft/client/configuration.rb,
lib/lyft/client/api/oauth/scope.rb,
lib/lyft/client/api/availability.rb,
lib/lyft/client/api/oauth/grant_type.rb

Overview

Client for making Lyft api requests

Defined Under Namespace

Modules: Api Classes: Configuration

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(args = {}) ⇒ Client

The initializer

Parameters:

  • args (Hash) (defaults to: {})

Options Hash (args):

  • :client_id (String)
  • :client_secret (String)
  • :debug_output (Boolean) 


62
63
64
65
 
# File 'lib/lyft/client.rb', line 62

def initialize(args = {})
  @configuration = Lyft::Client::Configuration.new args
  build_namespaces
end

Instance Attribute Details

#configuration ⇒ Lyft::Api::Configuration (readonly)

The configuration for the Lyft Client

Returns:

  • (Lyft::Api::Configuration) 


10
11
12
 
# File 'lib/lyft/client.rb', line 10

def configuration
  @configuration
end

Class Method Details

.namespace(name) ⇒ Object

Defines a method to access class instance.

Examples:

Create a namespace for availability

namespace :availability #=> Lyft::Client::Availability.new


24
25
26
27
28
 
# File 'lib/lyft/client.rb', line 24

def self.namespace(name)
  converted = name.to_s.split('_').map(&:capitalize).join
  klass = Lyft::Client::Api.const_get(converted)
  @namespaces << klass
end

Instance Method Details

#availability ⇒ Object

Class to handle availability api calls.

Returns:

  • Lyft::Client::Api::Availability



40
 
# File 'lib/lyft/client.rb', line 40

namespace :availability

#oauth ⇒ Object

Class to handle availability api calls.

Returns:

  • Lyft::Client::Api::Oauth



34
 
# File 'lib/lyft/client.rb', line 34

namespace :oauth

#rides ⇒ Object

Class to handle availability api calls.

Returns:

  • Lyft::Client::Api::Rides



46
 
# File 'lib/lyft/client.rb', line 46

namespace :rides

#user ⇒ Object

Class to handle availability api calls.

Returns:

  • Lyft::Client::Api::User



52
 
# File 'lib/lyft/client.rb', line 52

namespace :user