Module: OxfordDictionary::Endpoints::EntryEndpoint

Includes:
Request
Included in:
Client
Defined in:
lib/oxford_dictionary/endpoints/entry_endpoint.rb

Overview

Interface to ‘/entries’ endpoint

Constant Summary collapse

ENDPOINT = 
'entries'.freeze

Constants included from Request

Request::ACCEPT_TYPE, Request::ADVANCED_FILTERS, Request::BASE

Instance Method Summary collapse

Methods included from Request

#advanced_query, #build_advanced_url, #build_url, #create_query_string, #error_message, #finish_url, #hash_element?, #options, #query_from_hash, #request, #request_headers, #search_endpoint_url

Instance Method Details

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



11
12
13
 
# File 'lib/oxford_dictionary/endpoints/entry_endpoint.rb', line 11

def entry(query, params = {})
  entry_request(query, params)
end

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



35
36
37
38
 
# File 'lib/oxford_dictionary/endpoints/entry_endpoint.rb', line 35

def entry_antonyms(query, params = {})
  params[:end] = 'antonyms'
  entry_request(query, params)
end

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



45
46
47
48
 
# File 'lib/oxford_dictionary/endpoints/entry_endpoint.rb', line 45

def entry_antonyms_synonyms(query, params = {})
  params[:end] = 'synonyms;antonyms'
  entry_request(query, params)
end

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



15
16
17
18
 
# File 'lib/oxford_dictionary/endpoints/entry_endpoint.rb', line 15

def entry_definitions(query, params = {})
  params[:end] = 'definitions'
  entry_request(query, params)
end

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



20
21
22
23
 
# File 'lib/oxford_dictionary/endpoints/entry_endpoint.rb', line 20

def entry_examples(query, params = {})
  params[:end] = 'examples'
  entry_request(query, params)
end

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



25
26
27
28
 
# File 'lib/oxford_dictionary/endpoints/entry_endpoint.rb', line 25

def entry_pronunciations(query, params = {})
  params[:end] = 'pronunciations'
  entry_request(query, params)
end

#entry_request(query, params) ⇒ Object 



55
56
57
 
# File 'lib/oxford_dictionary/endpoints/entry_endpoint.rb', line 55

def entry_request(query, params)
  EntryResponse.new(request(ENDPOINT, query, params)['results'][0])
end

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



30
31
32
33
 
# File 'lib/oxford_dictionary/endpoints/entry_endpoint.rb', line 30

def entry_sentences(query, params = {})
  params[:end] = 'sentences'
  entry_request(query, params)
end

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



40
41
42
43
 
# File 'lib/oxford_dictionary/endpoints/entry_endpoint.rb', line 40

def entry_synonyms(query, params = {})
  params[:end] = 'synonyms'
  entry_request(query, params)
end

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



50
51
52
53
 
# File 'lib/oxford_dictionary/endpoints/entry_endpoint.rb', line 50

def entry_translations(query, params = {})
  params.key?(:translations) || params[:translations] = 'es'
  entry_request(query, params)
end