class TflApi::Client::Journey

This class communicates with the TFL “/Journey” API to obtain details about taxis and minicabs contact information.

Public Class Methods

new(client) click to toggle source

Initialize the Journey object and store the reference to Client object

@param client [Client] the client object

@return [Journey] the Journey object

# File lib/tfl_api_client/journey.rb, line 39
def initialize(client)
  @client = client
end

Public Instance Methods

modes() click to toggle source

Gets a list of all of the available journey planner modes.

@return [Array] An array of all available journey planner modes

# File lib/tfl_api_client/journey.rb, line 47
def modes
  @client.get('/Journey/Meta/Modes')
end
planner(from, to, params={}) click to toggle source

Perform a Journey Planner search from the parameters specified in simple types.

@param from [String] the origin of the journey @param to [String] the destination of the journey

@return [Hash] A hash of planner journey results

# File lib/tfl_api_client/journey.rb, line 59
def planner(from, to, params={})
  @client.get("/Journey/JourneyResults/#{from}/to/#{to}", params)
end