Class: Pollster::Chart

Inherits:
Object
  • Object
show all
Defined in:
lib/pollster/models/chart.rb

Overview

A Chart that appears on the Pollster website. See ‘chart.question.responses` for the list of potential response labels. Sometimes a chart omits one of the labels that appears in `chart.question.responses`; see `chart.pollster_estimates.values` for all the response labels that aren’t omitted.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Chart

Initializes the object

Parameters:

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

    Model attributes in the form of hash



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/pollster/models/chart.rb', line 54

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}

  if attributes.has_key?(:'slug')
    self.slug = attributes[:'slug']
  end

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

  if attributes.has_key?(:'created_at')
    self.created_at = attributes[:'created_at']
  end

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

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

  if attributes.has_key?(:'pollster_estimate_summary')
    self.pollster_estimate_summary = attributes[:'pollster_estimate_summary']
  end

  if attributes.has_key?(:'question')
    self.question = attributes[:'question']
  end

end

Instance Attribute Details

#created_at ⇒ Object

Date Pollster editors first created this Chart



13
14
15
 
# File 'lib/pollster/models/chart.rb', line 13

def created_at
  @created_at
end

#pollster_estimate_summary ⇒ Object

Returns the value of attribute pollster_estimate_summary.



21
22
23
 
# File 'lib/pollster/models/chart.rb', line 21

def pollster_estimate_summary
  @pollster_estimate_summary
end

#pollster_estimates ⇒ Object

Pollster-generated estimates. Intuitively, "what the polls suggest". These estimates are produced by algorithms. We publish the output of one or more algorithms. This Array always has at least one entry, and that entry is Pollster’s best guess as to "what the polls suggest". Branding-wise, you may call these "Pollster Estimates" if you publish ‘chart.pollster_estimates.values`.



19
20
21
 
# File 'lib/pollster/models/chart.rb', line 19

def pollster_estimates
  @pollster_estimates
end

#question ⇒ Object

Returns the value of attribute question.



23
24
25
 
# File 'lib/pollster/models/chart.rb', line 23

def question
  @question
end

#slug ⇒ Object

Unique Chart identifier. For example: ‘obama-job-approval`.



7
8
9
 
# File 'lib/pollster/models/chart.rb', line 7

def slug
  @slug
end

#tags ⇒ Object

Tag slugs that pertain to this Chart. Includes Tags that pertain to this Chart’s Question.



16
17
18
 
# File 'lib/pollster/models/chart.rb', line 16

def tags
  @tags
end

#url ⇒ Object

URL where Pollster has published this Chart (for end-users, not API users).



10
11
12
 
# File 'lib/pollster/models/chart.rb', line 10

def url
  @url
end

Class Method Details

.attribute_map ⇒ Object

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



27
28
29
30
31
32
33
34
35
36
37
 
# File 'lib/pollster/models/chart.rb', line 27

def self.attribute_map
  {
    :'slug' => :'slug',
    :'url' => :'url',
    :'created_at' => :'created_at',
    :'tags' => :'tags',
    :'pollster_estimates' => :'pollster_estimates',
    :'pollster_estimate_summary' => :'pollster_estimate_summary',
    :'question' => :'question'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/pollster/models/chart.rb', line 40

def self.swagger_types
  {
    :'slug' => :'String',
    :'url' => :'String',
    :'created_at' => :'DateTime',
    :'tags' => :'Array<String>',
    :'pollster_estimates' => :'Array<ChartEstimate>',
    :'pollster_estimate_summary' => :'ChartPollsterEstimateSummary',
    :'question' => :'Question'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/pollster/models/chart.rb', line 109

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      slug == o.slug &&
      url == o.url &&
      created_at == o.created_at &&
      tags == o.tags &&
      pollster_estimates == o.pollster_estimates &&
      pollster_estimate_summary == o.pollster_estimate_summary &&
      question == o.question
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



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
 
# File 'lib/pollster/models/chart.rb', line 157

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
    temp_model = Pollster.const_get(type).new
    temp_model.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



223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/pollster/models/chart.rb', line 223

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



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/pollster/models/chart.rb', line 136

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the 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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


123
124
125
 
# File 'lib/pollster/models/chart.rb', line 123

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



129
130
131
 
# File 'lib/pollster/models/chart.rb', line 129

def hash
  [slug, url, created_at, tags, pollster_estimates, pollster_estimate_summary, question].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properies with the reasons



96
97
98
99
 
# File 'lib/pollster/models/chart.rb', line 96

def list_invalid_properties
  invalid_properties = Array.new
  return 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



203
204
205
 
# File 'lib/pollster/models/chart.rb', line 203

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



209
210
211
212
213
214
215
216
217
 
# File 'lib/pollster/models/chart.rb', line 209

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



197
198
199
 
# File 'lib/pollster/models/chart.rb', line 197

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



103
104
105
 
# File 'lib/pollster/models/chart.rb', line 103

def valid?
  return true
end