Module: Bart

Defined in:
lib/bart_api/connection_adapters/httparty_adapter.rb,
lib/bart_api.rb,
lib/bart_api/api.rb,
lib/bart_api/client.rb,
lib/bart_api/models.rb,
lib/bart_api/version.rb,
lib/bart_api/connection.rb,
lib/bart_api/models/stop.rb,
lib/bart_api/client/stops.rb,
lib/bart_api/models/route.rb,
lib/bart_api/client/routes.rb,
lib/bart_api/configuration.rb,
lib/bart_api/models/arrival.rb,
lib/bart_api/client/estimates.rb,
lib/bart_api/models/destination.rb

Overview

A Connection adapter using HTTParty as the network transport

Defined Under Namespace

Modules: Connection Classes: API, Arrival, Client, Configuration, Destination, Model, Route, Stop

Constant Summary collapse

VERSION = 
"1.0.0"

Class Method Summary collapse

Class Method Details

.configuration ⇒ Object

The current client configuration



21
22
23
 
# File 'lib/bart_api.rb', line 21

def configuration
  @configuration ||= Configuration.new
end

.configure(validate: true) {|configuration| ... } ⇒ Object

Allow users to set configuration options via a block. By default, the configuration will be validated after the block returns. This will raise an exception if any required configurations are not provided. This behavior can be skipped by passing ‘validate: false` as a parameter.

Yields:



29
30
31
32
33
 
# File 'lib/bart_api.rb', line 29

def configure validate: true
  yield configuration
  configuration.validate! if validate
  configuration
end

.new ⇒ Object

Alias for ‘Bart::Client.new`



16
17
18
 
# File 'lib/bart_api.rb', line 16

def new
  Client.new
end