Module: Ohanakapa::Client::Search

Included in:

Ohanakapa::Client

Defined in:

lib/ohanakapa/client/search.rb

Overview

Methods for the Search API

See Also:

• http://ohanapi.herokuapp.com/api/docs#!/api/GET-api-search---format-_get_11

Instance Method Summary

• #search(path, options = {}) ⇒ Sawyer::Resource

  Performs a query of the API.

Instance Method Details

#search(path, options = {}) ⇒ Sawyer::Resource

Performs a query of the API

Parameters:

• options (Hash) (defaults to: {}) —

  Search term and qualifiers

Options Hash (options):

• :keyword (String) —

  Keyword search term

• :location (String) —

  Location search term

• :radius (Float) —

  Distance in miles from Location

• :language (String) —

  Language spoken at Location

• :page (Fixnum) —

  Page of paginated results

Returns:

• (Sawyer::Resource) —

  Search results object

# File 'lib/ohanakapa/client/search.rb', line 17

def search(path, options = {})
  paginate path, options
end