pollster 0.2.3 → 2.0.0

data/lib/pollster/models/question.rb

@@ -0,0 +1,253 @@
+require 'date'
+
+module Pollster
+
+  class Question
+    # Unique Question identifier. For example: `obama-job-approval`. May contain spaces, symbols and capital letters.
+    attr_accessor :slug
+
+    # Gist of the question, phrased such that a journalist on the beat will understand what it represents. For example: `2016 West Virginia Governor: Cole vs. Justice`
+    attr_accessor :name
+
+    # All Tag slugs for Tags on this Question
+    attr_accessor :tags
+
+    # All Chart slugs for Charts built from this Question
+    attr_accessor :charts
+
+    # Date of the election pertaining to this Question, or `null` if the question does not pertain to an upcoming election
+    attr_accessor :election_date
+
+    # Number of Poll objects that ask this Question. Use the `polls` API endpoint with the `question` parameter for Poll details
+    attr_accessor :n_polls
+
+    # Date Pollster editors first created this Question
+    attr_accessor :created_at
+
+    # Responses Pollster editors decided upon. Individual polls have their own responses which often differ from these responses.
+    attr_accessor :responses
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'slug' => :'slug',
+        :'name' => :'name',
+        :'tags' => :'tags',
+        :'charts' => :'charts',
+        :'election_date' => :'election_date',
+        :'n_polls' => :'n_polls',
+        :'created_at' => :'created_at',
+        :'responses' => :'responses'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'slug' => :'String',
+        :'name' => :'String',
+        :'tags' => :'Array<String>',
+        :'charts' => :'Array<String>',
+        :'election_date' => :'Date',
+        :'n_polls' => :'Integer',
+        :'created_at' => :'DateTime',
+        :'responses' => :'Array<QuestionResponses>'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    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?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.has_key?(:'tags')
+        if (value = attributes[:'tags']).is_a?(Array)
+          self.tags = value
+        end
+      end
+
+      if attributes.has_key?(:'charts')
+        if (value = attributes[:'charts']).is_a?(Array)
+          self.charts = value
+        end
+      end
+
+      if attributes.has_key?(:'election_date')
+        self.election_date = attributes[:'election_date']
+      end
+
+      if attributes.has_key?(:'n_polls')
+        self.n_polls = attributes[:'n_polls']
+      end
+
+      if attributes.has_key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      end
+
+      if attributes.has_key?(:'responses')
+        if (value = attributes[:'responses']).is_a?(Array)
+          self.responses = value
+        end
+      end
+
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properies with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      return invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      return true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          slug == o.slug &&
+          name == o.name &&
+          tags == o.tags &&
+          charts == o.charts &&
+          election_date == o.election_date &&
+          n_polls == o.n_polls &&
+          created_at == o.created_at &&
+          responses == o.responses
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [slug, name, tags, charts, election_date, n_polls, created_at, responses].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    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
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    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
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    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
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    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
+
+  end
+
+end

data/lib/pollster/models/question_poll_responses_clean.rb

@@ -0,0 +1,93 @@
+require 'date'
+require 'ruby-immutable-struct'
+
+module Pollster
+  QuestionPollResponseClean = RubyImmutableStruct.new(
+    :responses,
+    :poll_slug,
+    :survey_house,
+    :start_date,
+    :end_date,
+    :question_text,
+    :sample_subpopulation,
+    :observations,
+    :margin_of_error,
+    :mode,
+    :partisanship,
+    :partisan_affiliation
+  ) do
+    def self.from_tsv_line_with_labels(tsv_line, labels)
+      if m = QuestionPollResponseClean::TsvLineRegex.match(tsv_line)
+        # split(..., -1) avoids omitting trailing blanks
+        values = m[:values].split(/\t/, -1).map{ |v| v.empty? ? nil : v.to_f }
+
+        if values.length != labels.length
+          raise ArgumentError.new("TSV line `#{tsv_line}` has #{values.length} values for #{labels.length} labels")
+        end
+
+        responses = {}
+        for i in 0...(labels.length)
+          responses[labels[i]] = values[i]
+        end
+
+        QuestionPollResponseClean.new(
+          responses,
+          m[:poll_slug],
+          m[:survey_house],
+          Date.parse(m[:start_date]),
+          Date.parse(m[:end_date]),
+          m[:question_text],
+          m[:sample_subpopulation],
+          m[:observations].empty? ? nil : m[:observations].to_i,
+          m[:margin_of_error].empty? ? nil : m[:margin_of_error].to_f,
+          m[:mode],
+          m[:partisanship],
+          m[:partisan_affiliation]
+        )
+      else
+        raise ArgumentError.new("TSV line `#{tsv_line}` is not a valid QuestionPollResponseClean line")
+      end
+    end
+  end
+  QuestionPollResponseClean::TsvLineRegex = %r{
+    \A
+    (?<values>(?:\d+(?:\.\d+)?)?(?:\t(?:\d+(?:\.\d+)?)?)*)\t
+    (?<poll_slug>[^\t]+)\t
+    (?<survey_house>[^\t]+)\t
+    (?<start_date>\d\d\d\d-\d\d-\d\d)\t
+    (?<end_date>\d\d\d\d-\d\d-\d\d)\t
+    (?<question_text>[^\t]*)\t
+    (?<sample_subpopulation>[^\t]+)\t
+    (?<observations>\d*)\t
+    (?<margin_of_error>(?:\d+(?:\.\d+)?)?)\t
+    (?<mode>[^\t]+)\t
+    (?<partisanship>[^\t]+)\t
+    (?<partisan_affiliation>[^\t]+)\b
+    # No \Z ... Pollster's API doesn't guarantee it won't add columns
+  }x
+
+  class QuestionPollResponsesClean
+    HeaderLineRegex = /\A(?<labels>[^\t]+(?:\t[^\t]+)*)\tpoll_slug\tsurvey_house\tstart_date\tend_date\tquestion_text\tsample_subpopulation\tobservations\tmargin_of_error\tmode\tpartisanship\tpartisan_affiliation\b/
+
+    include Enumerable
+
+    def initialize(array)
+      @array = array
+    end
+
+    def each(&block)
+      @array.each(&block)
+    end
+
+    def self.from_tsv(tsv)
+      lines = tsv.split(/(?:\r?\n)+/).reject(&:empty?)
+      if m = HeaderLineRegex.match(lines[0])
+        labels = m[:labels].split(/\t/)
+        rows = lines[1..-1].map { |tsv_line| QuestionPollResponseClean.from_tsv_line_with_labels(tsv_line, labels) }
+        QuestionPollResponsesClean.new(rows)
+      else
+        raise ArgumentError.new("First line of TSV is `#{lines[0]}`, which does not match Pollster::QuestionPollResponsesClean::HeaderLineRegex")
+      end
+    end
+  end
+end

data/lib/pollster/models/question_poll_responses_raw.rb

@@ -0,0 +1,86 @@
+require 'date'
+require 'ruby-immutable-struct'
+
+module Pollster
+  QuestionPollResponseRaw = RubyImmutableStruct.new(
+    :response_text,
+    :pollster_label,
+    :value,
+    :poll_slug,
+    :survey_house,
+    :start_date,
+    :end_date,
+    :question_text,
+    :sample_subpopulation,
+    :observations,
+    :margin_of_error,
+    :mode,
+    :partisanship,
+    :partisan_affiliation
+  ) do
+    def self.from_tsv_line(tsv_line)
+      if m = QuestionPollResponseRaw::TsvLineRegex.match(tsv_line)
+        QuestionPollResponseRaw.new(
+          m[:response_text],
+          m[:pollster_label],
+          m[:value].to_f,
+          m[:poll_slug],
+          m[:survey_house],
+          Date.parse(m[:start_date]),
+          Date.parse(m[:end_date]),
+          m[:question_text],
+          m[:sample_subpopulation],
+          m[:observations].empty? ? nil : m[:observations].to_i,
+          m[:margin_of_error].empty? ? nil : m[:margin_of_error].to_f,
+          m[:mode],
+          m[:partisanship],
+          m[:partisan_affiliation]
+        )
+      else
+        raise ArgumentError.new("TSV line `#{tsv_line}` is not a valid QuestionPollResponseRaw line")
+      end
+    end
+  end
+  QuestionPollResponseRaw::TsvLineRegex = %r{
+    \A
+    (?<response_text>[^\t]+)\t
+    (?<pollster_label>[^\t]*)\t
+    (?<value>\d+(?:\.\d+)?)\t
+    (?<poll_slug>[^\t]+)\t
+    (?<survey_house>[^\t]+)\t
+    (?<start_date>\d\d\d\d-\d\d-\d\d)\t
+    (?<end_date>\d\d\d\d-\d\d-\d\d)\t
+    (?<question_text>[^\t]*)\t
+    (?<sample_subpopulation>[^\t]+)\t
+    (?<observations>\d*)\t
+    (?<margin_of_error>(?:\d+(?:\.\d+)?)?)\t
+    (?<mode>[^\t]+)\t
+    (?<partisanship>[^\t]+)\t
+    (?<partisan_affiliation>[^\t]+)\b
+    # No \Z ... Pollster's API doesn't guarantee it won't add columns
+  }x
+
+  class QuestionPollResponsesRaw
+    HeaderLineRegex = /\Aresponse_text\tpollster_label\tvalue\tpoll_slug\tsurvey_house\tstart_date\tend_date\tquestion_text\tsample_subpopulation\tobservations\tmargin_of_error\tmode\tpartisanship\tpartisan_affiliation\b/
+
+    include Enumerable
+
+    def initialize(array)
+      @array = array
+    end
+
+    def each(&block)
+      @array.each(&block)
+    end
+
+    def self.from_tsv(tsv)
+      lines = tsv.split(/(?:\r?\n)+/).reject(&:empty?)
+      if m = HeaderLineRegex.match(lines[0])
+        rows = lines[1..-1].map { |tsv_line| QuestionPollResponseRaw.from_tsv_line(tsv_line) }
+        QuestionPollResponsesRaw.new(rows)
+      else
+        raise ArgumentError.new("First line of TSV is `#{lines[0]}`, which does not match Pollster::QuestionPollResponsesRaw::HeaderLineRegex")
+      end
+    end
+  end
+end

data/lib/pollster/models/question_responses.rb

@@ -0,0 +1,207 @@
+require 'date'
+
+module Pollster
+
+  class QuestionResponses
+    # More verbose description of the option, also unique to this Question. For people, this is usually a full name (e.g., `Hillary Clinton`); other response names are chosen on a case-by-case basis (e.g., `Other` or `Remain in the E.U.`)
+    attr_accessor :name
+
+    # Identifier for this response, succinct and unique to this Question. For example, `Clinton`. The canonical use case: the label is what one would write on a chart.
+    attr_accessor :label
+
+    # If this response is a candidate running for office, the name of the candidate's registered political party (e.g., `Republican`); otherwise `null`
+    attr_accessor :party
+
+    # If this response is a candidate running for re-election to the same office, `true`; otherwise `false`.
+    attr_accessor :incumbent
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'name' => :'name',
+        :'label' => :'label',
+        :'party' => :'party',
+        :'incumbent' => :'incumbent'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'name' => :'String',
+        :'label' => :'String',
+        :'party' => :'String',
+        :'incumbent' => :'BOOLEAN'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    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?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.has_key?(:'label')
+        self.label = attributes[:'label']
+      end
+
+      if attributes.has_key?(:'party')
+        self.party = attributes[:'party']
+      end
+
+      if attributes.has_key?(:'incumbent')
+        self.incumbent = attributes[:'incumbent']
+      end
+
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properies with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      return invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      return true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          name == o.name &&
+          label == o.label &&
+          party == o.party &&
+          incumbent == o.incumbent
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [name, label, party, incumbent].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    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
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    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
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    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
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    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
+
+  end
+
+end