Class: WordsApi::FrequencyResponse

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/words_api/models/frequency_response.rb

Overview

This custom type contains response for frequency endpoint.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(word = nil, frequency = nil) ⇒ FrequencyResponse

Returns a new instance of FrequencyResponse.



38
39
40
41
 
# File 'lib/words_api/models/frequency_response.rb', line 38

def initialize(word = nil, frequency = nil)
  @word = word
  @frequency = frequency
end

Instance Attribute Details

#frequency ⇒ FrequencyDetails

This model contains frequency details of a specific word.

Returns:



18
19
20
 
# File 'lib/words_api/models/frequency_response.rb', line 18

def frequency
  @frequency
end

#word ⇒ String

The word that is searched.

Returns:

  • (String) 


14
15
16
 
# File 'lib/words_api/models/frequency_response.rb', line 14

def word
  @word
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/words_api/models/frequency_response.rb', line 44

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  word = hash.key?('word') ? hash['word'] : nil
  frequency = FrequencyDetails.from_hash(hash['frequency']) if hash['frequency']

  # Create object from extracted values.
  FrequencyResponse.new(word,
                        frequency)
end

.names ⇒ Object

A mapping from model property names to API property names.



21
22
23
24
25
26
 
# File 'lib/words_api/models/frequency_response.rb', line 21

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['word'] = 'word'
  @_hash['frequency'] = 'frequency'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



34
35
36
 
# File 'lib/words_api/models/frequency_response.rb', line 34

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



29
30
31
 
# File 'lib/words_api/models/frequency_response.rb', line 29

def self.optionals
  []
end