Class: SiteimproveAPIClient::ReadabilityScorePage

Inherits:
Object
  • Object
show all
Defined in:
lib/siteimprove_api_client/models/readability_score_page.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ReadabilityScorePage

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/siteimprove_api_client/models/readability_score_page.rb', line 102

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#_siteimprove ⇒ Object

Returns the value of attribute _siteimprove.



51
52
53
 
# File 'lib/siteimprove_api_client/models/readability_score_page.rb', line 51

def _siteimprove
  @_siteimprove
end

#checking_now ⇒ Object

Is true if page is being checked now; otherwise false



28
29
30
 
# File 'lib/siteimprove_api_client/models/readability_score_page.rb', line 28

def checking_now
  @checking_now
end

#cms_url ⇒ Object

Url for the cms entry for editing the page.



31
32
33
 
# File 'lib/siteimprove_api_client/models/readability_score_page.rb', line 31

def cms_url
  @cms_url
end

#id ⇒ Object

The id of the page



19
20
21
 
# File 'lib/siteimprove_api_client/models/readability_score_page.rb', line 19

def id
  @id
end

#long_sentences ⇒ Object

The number of long sentences found on the page



34
35
36
 
# File 'lib/siteimprove_api_client/models/readability_score_page.rb', line 34

def long_sentences
  @long_sentences
end

#long_words ⇒ Object

The number of long words found on the page



37
38
39
 
# File 'lib/siteimprove_api_client/models/readability_score_page.rb', line 37

def long_words
  @long_words
end

#page_level ⇒ Object

Page level in site hierarchy.



40
41
42
 
# File 'lib/siteimprove_api_client/models/readability_score_page.rb', line 40

def page_level
  @page_level
end

#page_views ⇒ Object

Number of times this page has been viewed



43
44
45
 
# File 'lib/siteimprove_api_client/models/readability_score_page.rb', line 43

def page_views
  @page_views
end

#readability_score ⇒ Object

The readability score of the page



46
47
48
 
# File 'lib/siteimprove_api_client/models/readability_score_page.rb', line 46

def readability_score
  @readability_score
end

#title ⇒ Object

Title of the page



22
23
24
 
# File 'lib/siteimprove_api_client/models/readability_score_page.rb', line 22

def title
  @title
end

#url ⇒ Object

The URL of the page



25
26
27
 
# File 'lib/siteimprove_api_client/models/readability_score_page.rb', line 25

def url
  @url
end

#words ⇒ Object

The number of words found on the page



49
50
51
 
# File 'lib/siteimprove_api_client/models/readability_score_page.rb', line 49

def words
  @words
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



72
73
74
 
# File 'lib/siteimprove_api_client/models/readability_score_page.rb', line 72

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/siteimprove_api_client/models/readability_score_page.rb', line 54

def self.attribute_map
  {
    :'id' => :'id',
    :'title' => :'title',
    :'url' => :'url',
    :'checking_now' => :'checking_now',
    :'cms_url' => :'cms_url',
    :'long_sentences' => :'long_sentences',
    :'long_words' => :'long_words',
    :'page_level' => :'page_level',
    :'page_views' => :'page_views',
    :'readability_score' => :'readability_score',
    :'words' => :'words',
    :'_siteimprove' => :'_siteimprove'
  }
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



241
242
243
 
# File 'lib/siteimprove_api_client/models/readability_score_page.rb', line 241

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



95
96
97
98
 
# File 'lib/siteimprove_api_client/models/readability_score_page.rb', line 95

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

.openapi_types ⇒ Object

Attribute type mapping.



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/siteimprove_api_client/models/readability_score_page.rb', line 77

def self.openapi_types
  {
    :'id' => :'Integer',
    :'title' => :'String',
    :'url' => :'String',
    :'checking_now' => :'Boolean',
    :'cms_url' => :'String',
    :'long_sentences' => :'Integer',
    :'long_words' => :'Integer',
    :'page_level' => :'Integer',
    :'page_views' => :'Integer',
    :'readability_score' => :'Float',
    :'words' => :'Integer',
    :'_siteimprove' => :'Siteimprove'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/siteimprove_api_client/models/readability_score_page.rb', line 209

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      title == o.title &&
      url == o.url &&
      checking_now == o.checking_now &&
      cms_url == o.cms_url &&
      long_sentences == o.long_sentences &&
      long_words == o.long_words &&
      page_level == o.page_level &&
      page_views == o.page_views &&
      readability_score == o.readability_score &&
      words == o.words &&
      _siteimprove == o._siteimprove
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



272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/siteimprove_api_client/models/readability_score_page.rb', line 272

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 = SiteimproveAPIClient.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



343
344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/siteimprove_api_client/models/readability_score_page.rb', line 343

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



248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/siteimprove_api_client/models/readability_score_page.rb', line 248

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  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


228
229
230
 
# File 'lib/siteimprove_api_client/models/readability_score_page.rb', line 228

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



234
235
236
 
# File 'lib/siteimprove_api_client/models/readability_score_page.rb', line 234

def hash
  [id, title, url, checking_now, cms_url, long_sentences, long_words, page_level, page_views, readability_score, words, _siteimprove].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



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
 
# File 'lib/siteimprove_api_client/models/readability_score_page.rb', line 166

def list_invalid_properties
  invalid_properties = Array.new
  if @id.nil?
    invalid_properties.push('invalid value for "id", id cannot be nil.')
  end

  if @checking_now.nil?
    invalid_properties.push('invalid value for "checking_now", checking_now cannot be nil.')
  end

  if @long_sentences.nil?
    invalid_properties.push('invalid value for "long_sentences", long_sentences cannot be nil.')
  end

  if @long_words.nil?
    invalid_properties.push('invalid value for "long_words", long_words cannot be nil.')
  end

  if @readability_score.nil?
    invalid_properties.push('invalid value for "readability_score", readability_score cannot be nil.')
  end

  if @words.nil?
    invalid_properties.push('invalid value for "words", words cannot be nil.')
  end

  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



319
320
321
 
# File 'lib/siteimprove_api_client/models/readability_score_page.rb', line 319

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



325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/siteimprove_api_client/models/readability_score_page.rb', line 325

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



313
314
315
 
# File 'lib/siteimprove_api_client/models/readability_score_page.rb', line 313

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



197
198
199
200
201
202
203
204
205
 
# File 'lib/siteimprove_api_client/models/readability_score_page.rb', line 197

def valid?
  return false if @id.nil?
  return false if @checking_now.nil?
  return false if @long_sentences.nil?
  return false if @long_words.nil?
  return false if @readability_score.nil?
  return false if @words.nil?
  true
end