Module: OxfordDictionary::Endpoints::SearchEndpoint

Includes:
DeprecatedRequest
Included in:
Client
Defined in:
lib/oxford_dictionary/endpoints/search_endpoint.rb

Overview

Interface to ‘/search’ endpoint

Constant Summary collapse

ENDPOINT = 
'search'.freeze

Constants included from DeprecatedRequest

DeprecatedRequest::ACCEPT_TYPE, DeprecatedRequest::ADVANCED_FILTERS, DeprecatedRequest::BASE, DeprecatedRequest::HTTP_OK

Instance Method Summary collapse

Methods included from DeprecatedRequest

#request

Instance Method Details

#search(query, params = {}) ⇒ Object 



11
12
13
14
15
16
17
18
19
20
21
22
23
 
# File 'lib/oxford_dictionary/endpoints/search_endpoint.rb', line 11

def search(query, params = {})
  warn '''
  Client#search without using named parameters is DEPRECATED and will
  become non-functional on June 30, 2019 (it uses the V1 interface which
  Oxford Dictionaries is taking offline). Reference
  https://github.com/swcraig/oxford-dictionary/pull/15 for more
  information. Check out OxfordDictionary::Endpoints::Search for the
  interface to use.
  '''

  params[:q] = query
  ListResponse.new(request(ENDPOINT, query, params))
end