Module: TripSpark

Defined in:
lib/tripspark_api/connection_adapters/httparty_adapter.rb,
lib/tripspark_api.rb,
lib/tripspark_api/api.rb,
lib/tripspark_api/client.rb,
lib/tripspark_api/models.rb,
lib/tripspark_api/version.rb,
lib/tripspark_api/connection.rb,
lib/tripspark_api/models/gps.rb,
lib/tripspark_api/models/stop.rb,
lib/tripspark_api/models/route.rb,
lib/tripspark_api/client/routes.rb,
lib/tripspark_api/configuration.rb,
lib/tripspark_api/models/pattern.rb,
lib/tripspark_api/models/vehicle.rb,
lib/tripspark_api/client/patterns.rb,
lib/tripspark_api/client/vehicles.rb,
lib/tripspark_api/models/direction.rb,
lib/tripspark_api/models/pattern_point.rb

Overview

A Connection adapter using HTTParty as the network transport

Defined Under Namespace

Modules: Connection Classes: API, Client, Configuration, Direction, GPS, Model, Pattern, PatternPoint, Route, Stop, Vehicle

Constant Summary collapse

VERSION = 
"0.1.1"

Class Method Summary collapse

Class Method Details

.configuration ⇒ Object

The current client configuration



18
19
20
 
# File 'lib/tripspark_api.rb', line 18

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:



26
27
28
29
30
 
# File 'lib/tripspark_api.rb', line 26

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

.new ⇒ Object

Alias for ‘TripSpark::Client.new`



13
14
15
 
# File 'lib/tripspark_api.rb', line 13

def new
  Client.new
end