Class: FinnhubRuby::News

Inherits:
Object
  • Object
show all
Defined in:
lib/finnhub_ruby/models/news.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ News

Initializes the object

Parameters:

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

    Model attributes in the form of hash



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/finnhub_ruby/models/news.rb', line 88

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `FinnhubRuby::News` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `FinnhubRuby::News`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'category')
    self.category = attributes[:'category']
  end

  if attributes.key?(:'datetime')
    self.datetime = attributes[:'datetime']
  end

  if attributes.key?(:'headline')
    self.headline = attributes[:'headline']
  end

  if attributes.key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.key?(:'image')
    self.image = attributes[:'image']
  end

  if attributes.key?(:'related')
    self.related = attributes[:'related']
  end

  if attributes.key?(:'source')
    self.source = attributes[:'source']
  end

  if attributes.key?(:'summary')
    self.summary = attributes[:'summary']
  end

  if attributes.key?(:'url')
    self.url = attributes[:'url']
  end
end

Instance Attribute Details

#category ⇒ Object

News category.



19
20
21
 
# File 'lib/finnhub_ruby/models/news.rb', line 19

def category
  @category
end

#datetime ⇒ Object

Published time in UNIX timestamp.



22
23
24
 
# File 'lib/finnhub_ruby/models/news.rb', line 22

def datetime
  @datetime
end

#headline ⇒ Object

News headline.



25
26
27
 
# File 'lib/finnhub_ruby/models/news.rb', line 25

def headline
  @headline
end

#id ⇒ Object

News ID. This value can be used for minId params to get the latest news only.



28
29
30
 
# File 'lib/finnhub_ruby/models/news.rb', line 28

def id
  @id
end

#image ⇒ Object

Thumbnail image URL.



31
32
33
 
# File 'lib/finnhub_ruby/models/news.rb', line 31

def image
  @image
end

#related ⇒ Object

Related stocks and companies mentioned in the article.



34
35
36
 
# File 'lib/finnhub_ruby/models/news.rb', line 34

def related
  @related
end

#source ⇒ Object

News source.



37
38
39
 
# File 'lib/finnhub_ruby/models/news.rb', line 37

def source
  @source
end

#summary ⇒ Object

News summary.



40
41
42
 
# File 'lib/finnhub_ruby/models/news.rb', line 40

def summary
  @summary
end

#url ⇒ Object

URL of the original article.



43
44
45
 
# File 'lib/finnhub_ruby/models/news.rb', line 43

def url
  @url
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



61
62
63
 
# File 'lib/finnhub_ruby/models/news.rb', line 61

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/finnhub_ruby/models/news.rb', line 46

def self.attribute_map
  {
    :'category' => :'category',
    :'datetime' => :'datetime',
    :'headline' => :'headline',
    :'id' => :'id',
    :'image' => :'image',
    :'related' => :'related',
    :'source' => :'source',
    :'summary' => :'summary',
    :'url' => :'url'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



182
183
184
 
# File 'lib/finnhub_ruby/models/news.rb', line 182

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



81
82
83
84
 
# File 'lib/finnhub_ruby/models/news.rb', line 81

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/finnhub_ruby/models/news.rb', line 66

def self.openapi_types
  {
    :'category' => :'String',
    :'datetime' => :'Integer',
    :'headline' => :'String',
    :'id' => :'Integer',
    :'image' => :'String',
    :'related' => :'String',
    :'source' => :'String',
    :'summary' => :'String',
    :'url' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/finnhub_ruby/models/news.rb', line 153

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      category == o.category &&
      datetime == o.datetime &&
      headline == o.headline &&
      id == o.id &&
      image == o.image &&
      related == o.related &&
      source == o.source &&
      summary == o.summary &&
      url == o.url
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/finnhub_ruby/models/news.rb', line 212

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = FinnhubRuby.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/finnhub_ruby/models/news.rb', line 283

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/finnhub_ruby/models/news.rb', line 189

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


169
170
171
 
# File 'lib/finnhub_ruby/models/news.rb', line 169

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



175
176
177
 
# File 'lib/finnhub_ruby/models/news.rb', line 175

def hash
  [category, datetime, headline, id, image, related, source, summary, url].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



140
141
142
143
 
# File 'lib/finnhub_ruby/models/news.rb', line 140

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



259
260
261
 
# File 'lib/finnhub_ruby/models/news.rb', line 259

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/finnhub_ruby/models/news.rb', line 265

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



253
254
255
 
# File 'lib/finnhub_ruby/models/news.rb', line 253

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



147
148
149
 
# File 'lib/finnhub_ruby/models/news.rb', line 147

def valid?
  true
end