class TflApi::Client::BikePoint

This class communicates with the TFL “/BikePoint” API to obtain details about bike points locations based upon their IDs or by their latitude and longitude values.

Public Class Methods

new(client) click to toggle source

Initialize the BikePoint object and store the reference to Client object

@param client [Client] the client object

@return [BikePoint] the BikePoint object

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

Public Instance Methods

location(id) click to toggle source

Returns the all details known by the TFL service for the given BikePoint id.

@param id [String] the TFL BikePoint id

@return [hash] A hash containing the details of the given BikePoint

# File lib/tfl_api_client/bike_point.rb, line 59
def location(id)
  @client.get("/BikePoint/#{id}")
end
locations() click to toggle source

Returns all BikePoint locations known by the TFL service

@return [Array] An array of hashes containing all BikePoints and their details

# File lib/tfl_api_client/bike_point.rb, line 48
def locations
  @client.get('/BikePoint')
end
locations_within_bounding_box(sw_latitude, sw_longitude, ne_latitude, ne_longitude) click to toggle source

Returns all BikePoint locations known by the TFL service within a the given box based upon it's defined corner locations.

@param sw_latitude [String] the south-west latitude positional value of the bounding box @param sw_longitude [String] the south-west longitude positional value of the bounding box @param ne_latitude [String] the north-east latitude positional value of the bounding box @param ne_longitude [String] the north-east longitude positional value of the bounding box

@return [Array] An array of hashes containing all BikePoints and their details

# File lib/tfl_api_client/bike_point.rb, line 87
def locations_within_bounding_box(sw_latitude, sw_longitude, ne_latitude, ne_longitude)
  uri_params = { swLat: sw_latitude, swLon: sw_longitude, neLat: ne_latitude, neLon: ne_longitude }
  @client.get('/BikePoint', uri_params)
end
locations_within_locus(latitude, longitude, radius) click to toggle source

Returns all BikePoint locations known by the TFL service within a particular position or place (a locus).

@param latitude [String] the latitude value @param longitude [String] the longitude value @param radius [String] the radius of the area to cover

@return [Array] An array of hashes containing all BikePoints and their details

# File lib/tfl_api_client/bike_point.rb, line 72
def locations_within_locus(latitude, longitude, radius)
  uri_params = { lat: latitude, lon: longitude, radius: radius }
  @client.get('/BikePoint', uri_params)
end