Class: AylienNewsApi::Story

Inherits:
Object
  • Object
show all
Defined in:
lib/aylien_news_api/models/story.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Story

Initializes the object



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
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
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/aylien_news_api/models/story.rb', line 155

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `AylienNewsApi::Story` 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 `AylienNewsApi::Story`. 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?(:'author')
    self.author = attributes[:'author']
  end

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

  if attributes.key?(:'categories')
    if (value = attributes[:'categories']).is_a?(Array)
      self.categories = value
    end
  end

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

  if attributes.key?(:'clusters')
    if (value = attributes[:'clusters']).is_a?(Array)
      self.clusters = value
    end
  end

  if attributes.key?(:'entities')
    if (value = attributes[:'entities']).is_a?(Array)
      self.entities = value
    end
  end

  if attributes.key?(:'hashtags')
    if (value = attributes[:'hashtags']).is_a?(Array)
      self.hashtags = value
    end
  end

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

  if attributes.key?(:'keywords')
    if (value = attributes[:'keywords']).is_a?(Array)
      self.keywords = value
    end
  end

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

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

  if attributes.key?(:'media')
    if (value = attributes[:'media']).is_a?(Array)
      self.media = value
    end
  end

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'industries')
    if (value = attributes[:'industries']).is_a?(Array)
      self.industries = value
    end
  end
end

Instance Attribute Details

#author ⇒ Object

Returns the value of attribute author.



17
18
19
 
# File 'lib/aylien_news_api/models/story.rb', line 17

def author
  @author
end

#body ⇒ Object

Body of the story



20
21
22
 
# File 'lib/aylien_news_api/models/story.rb', line 20

def body
  @body
end

#categories ⇒ Object

Suggested categories for the story



23
24
25
 
# File 'lib/aylien_news_api/models/story.rb', line 23

def categories
  @categories
end

#characters_count ⇒ Object

Character count of the story body



26
27
28
 
# File 'lib/aylien_news_api/models/story.rb', line 26

def characters_count
  @characters_count
end

#clusters ⇒ Object

An array of clusters the story is associated with



29
30
31
 
# File 'lib/aylien_news_api/models/story.rb', line 29

def clusters
  @clusters
end

#entities ⇒ Object

An array of entities



32
33
34
 
# File 'lib/aylien_news_api/models/story.rb', line 32

def entities
  @entities
end

#hashtags ⇒ Object

An array of suggested Story hashtags



35
36
37
 
# File 'lib/aylien_news_api/models/story.rb', line 35

def hashtags
  @hashtags
end

#id ⇒ Object

ID of the story which is a unique identification



38
39
40
 
# File 'lib/aylien_news_api/models/story.rb', line 38

def id
  @id
end

#industries ⇒ Object

An array of industries categories



83
84
85
 
# File 'lib/aylien_news_api/models/story.rb', line 83

def industries
  @industries
end

#keywords ⇒ Object

Extracted keywords mentioned in the story title or body



41
42
43
 
# File 'lib/aylien_news_api/models/story.rb', line 41

def keywords
  @keywords
end

#language ⇒ Object

Language of the story



44
45
46
 
# File 'lib/aylien_news_api/models/story.rb', line 44

def language
  @language
end

#license_type ⇒ Object

License type of the story



80
81
82
 
# File 'lib/aylien_news_api/models/story.rb', line 80

def license_type
  @license_type
end

#links ⇒ Object

Returns the value of attribute links.



46
47
48
 
# File 'lib/aylien_news_api/models/story.rb', line 46

def links
  @links
end

#media ⇒ Object

An array of extracted media such as images and videos



49
50
51
 
# File 'lib/aylien_news_api/models/story.rb', line 49

def media
  @media
end

#paragraphs_count ⇒ Object

Paragraph count of the story body



52
53
54
 
# File 'lib/aylien_news_api/models/story.rb', line 52

def paragraphs_count
  @paragraphs_count
end

#published_at ⇒ Object

Acquisition time of the story



58
59
60
 
# File 'lib/aylien_news_api/models/story.rb', line 58

def published_at
  @published_at
end

#published_datetime ⇒ Object

Publication time of the story, if available, otherwise time of acquisition



55
56
57
 
# File 'lib/aylien_news_api/models/story.rb', line 55

def published_datetime
  @published_datetime
end

#sentences_count ⇒ Object

Sentence count of the story body



61
62
63
 
# File 'lib/aylien_news_api/models/story.rb', line 61

def sentences_count
  @sentences_count
end

#sentiment ⇒ Object

Returns the value of attribute sentiment.



63
64
65
 
# File 'lib/aylien_news_api/models/story.rb', line 63

def sentiment
  @sentiment
end

#social_shares_count ⇒ Object

Returns the value of attribute social_shares_count.



65
66
67
 
# File 'lib/aylien_news_api/models/story.rb', line 65

def social_shares_count
  @social_shares_count
end

#source ⇒ Object

Returns the value of attribute source.



67
68
69
 
# File 'lib/aylien_news_api/models/story.rb', line 67

def source
  @source
end

#summary ⇒ Object

Returns the value of attribute summary.



69
70
71
 
# File 'lib/aylien_news_api/models/story.rb', line 69

def summary
  @summary
end

#title ⇒ Object

Title of the story



72
73
74
 
# File 'lib/aylien_news_api/models/story.rb', line 72

def title
  @title
end

#translations ⇒ Object

Returns the value of attribute translations.



74
75
76
 
# File 'lib/aylien_news_api/models/story.rb', line 74

def translations
  @translations
end

#words_count ⇒ Object

Word count of the story body



77
78
79
 
# File 'lib/aylien_news_api/models/story.rb', line 77

def words_count
  @words_count
end

Class Method Details

.attribute_map ⇒ Object

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



86
87
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
 
# File 'lib/aylien_news_api/models/story.rb', line 86

def self.attribute_map
  {
    :'author' => :'author',
    :'body' => :'body',
    :'categories' => :'categories',
    :'characters_count' => :'characters_count',
    :'clusters' => :'clusters',
    :'entities' => :'entities',
    :'hashtags' => :'hashtags',
    :'id' => :'id',
    :'keywords' => :'keywords',
    :'language' => :'language',
    :'links' => :'links',
    :'media' => :'media',
    :'paragraphs_count' => :'paragraphs_count',
    :'published_datetime' => :'published_datetime',
    :'published_at' => :'published_at',
    :'sentences_count' => :'sentences_count',
    :'sentiment' => :'sentiment',
    :'social_shares_count' => :'social_shares_count',
    :'source' => :'source',
    :'summary' => :'summary',
    :'title' => :'title',
    :'translations' => :'translations',
    :'words_count' => :'words_count',
    :'license_type' => :'license_type',
    :'industries' => :'industries'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



343
344
345
 
# File 'lib/aylien_news_api/models/story.rb', line 343

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



148
149
150
151
 
# File 'lib/aylien_news_api/models/story.rb', line 148

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

.openapi_types ⇒ Object

Attribute type mapping.



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/aylien_news_api/models/story.rb', line 117

def self.openapi_types
  {
    :'author' => :'Author',
    :'body' => :'String',
    :'categories' => :'Array<Category>',
    :'characters_count' => :'Integer',
    :'clusters' => :'Array<Integer>',
    :'entities' => :'Array<Entity>',
    :'hashtags' => :'Array<String>',
    :'id' => :'Integer',
    :'keywords' => :'Array<String>',
    :'language' => :'String',
    :'links' => :'StoryLinks',
    :'media' => :'Array<Media>',
    :'paragraphs_count' => :'Integer',
    :'published_datetime' => :'DateTime',
    :'published_at' => :'DateTime',
    :'sentences_count' => :'Integer',
    :'sentiment' => :'Sentiments',
    :'social_shares_count' => :'ShareCounts',
    :'source' => :'Source',
    :'summary' => :'Summary',
    :'title' => :'String',
    :'translations' => :'StoryTranslations',
    :'words_count' => :'Integer',
    :'license_type' => :'Integer',
    :'industries' => :'Array<Category>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/aylien_news_api/models/story.rb', line 298

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      author == o.author &&
      body == o.body &&
      categories == o.categories &&
      characters_count == o.characters_count &&
      clusters == o.clusters &&
      entities == o.entities &&
      hashtags == o.hashtags &&
      id == o.id &&
      keywords == o.keywords &&
      language == o.language &&
      links == o.links &&
      media == o.media &&
      paragraphs_count == o.paragraphs_count &&
      published_datetime == o.published_datetime &&
      published_at == o.published_at &&
      sentences_count == o.sentences_count &&
      sentiment == o.sentiment &&
      social_shares_count == o.social_shares_count &&
      source == o.source &&
      summary == o.summary &&
      title == o.title &&
      translations == o.translations &&
      words_count == o.words_count &&
      license_type == o.license_type &&
      industries == o.industries
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
 
# File 'lib/aylien_news_api/models/story.rb', line 371

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    AylienNewsApi.const_get(type).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



440
441
442
443
444
445
446
447
448
449
450
451
452
 
# File 'lib/aylien_news_api/models/story.rb', line 440

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



350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
 
# File 'lib/aylien_news_api/models/story.rb', line 350

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if 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 # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

See Also:

  • `==` method


330
331
332
 
# File 'lib/aylien_news_api/models/story.rb', line 330

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



336
337
338
 
# File 'lib/aylien_news_api/models/story.rb', line 336

def hash
  [author, body, categories, characters_count, clusters, entities, hashtags, id, keywords, language, links, media, paragraphs_count, published_datetime, published_at, sentences_count, sentiment, social_shares_count, source, summary, title, translations, words_count, license_type, industries].hash
end

#list_invalid_properties ⇒ Object

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



285
286
287
288
 
# File 'lib/aylien_news_api/models/story.rb', line 285

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



416
417
418
 
# File 'lib/aylien_news_api/models/story.rb', line 416

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



422
423
424
425
426
427
428
429
430
431
432
433
434
 
# File 'lib/aylien_news_api/models/story.rb', line 422

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



410
411
412
 
# File 'lib/aylien_news_api/models/story.rb', line 410

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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



292
293
294
 
# File 'lib/aylien_news_api/models/story.rb', line 292

def valid?
  true
end