module Ohanakapa::Client::Locations

Methods for the Locations API

@see ohanapi.herokuapp.com/api/docs

Public Instance Methods

loc(id)
Alias for: location
location(id) click to toggle source

Get a single location based on its ID @see ohanapi.herokuapp.com/api/docs#!/api/GET-api-locations–id—format-_get_1

@param id [String] location ID. @return [Sawyer::Resource] @example

Ohanakapa.location('519c44065634241897000023')

@example

Ohanakapa.loc('519c44065634241897000023')
# File lib/ohanakapa/client/locations.rb, line 36
def location(id)
  get("locations/#{id}")
end
Also aliased as: loc
locations(options={}) click to toggle source

List all locations

This provides a dump of every location, in the order that they were uploaded to the Ohana DB.

@see ohanapi.herokuapp.com/api/docs#!/api/GET-api-locations—format-_get_0

@return [Array<Sawyer::Resource>] List of Locations.

@example

Ohanakapa.locations

@example

Ohanakapa.locs
# File lib/ohanakapa/client/locations.rb, line 22
def locations(options={})
  paginate "locations", options
end
Also aliased as: locs
locs(options={})
Alias for: locations
nearby(id, options={}) click to toggle source

Get nearby locations to an location, based on its ID

@param id [String] location ID. @param options [Hash] A customizable set of options. @option options [Float] :radius @return [Sawyer::Resource] Hash representing nearby locations. @example

Ohanakapa.nearby('519c44065634241897000023', :radius => 0.5)
# File lib/ohanakapa/client/locations.rb, line 49
def nearby(id, options={})
  get("locations/#{id}/nearby", options)
end
update_location(id, options) click to toggle source

Update a location

@param id [String] location ID. @param options [Hash] A customizable set of options. @option options [String] :kind @return [Sawyer::Resource] @example

Ohanakapa.update_location("521d33a01974fcdb2b0036a9", :kind => "entertainment")
# File lib/ohanakapa/client/locations.rb, line 61
def update_location(id, options)
  put "locations/#{id}", :query => options
end