pollster 0.2.3 → 2.0.0

data/lib/pollster/models/chart_estimate_lowess_parameters.rb

@@ -0,0 +1,197 @@
+require 'date'
+
+module Pollster
+  # Only present if `algorithm` is `lowess`. Shows [parameters](https://stat.ethz.ch/R-manual/R-devel/library/stats/html/lowess.html) to lowess.
+  class ChartEstimateLowessParameters
+    # `f` lowess parameter
+    attr_accessor :f
+
+    # `delta` lowess parameter
+    attr_accessor :delta
+
+    # `iter` lowess parameter
+    attr_accessor :iter
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'f' => :'f',
+        :'delta' => :'delta',
+        :'iter' => :'iter'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'f' => :'Float',
+        :'delta' => :'Float',
+        :'iter' => :'Integer'
+      }
+    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?(:'f')
+        self.f = attributes[:'f']
+      end
+
+      if attributes.has_key?(:'delta')
+        self.delta = attributes[:'delta']
+      end
+
+      if attributes.has_key?(:'iter')
+        self.iter = attributes[:'iter']
+      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 &&
+          f == o.f &&
+          delta == o.delta &&
+          iter == o.iter
+    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
+      [f, delta, iter].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/chart_pollster_estimate_summary.rb

@@ -0,0 +1,217 @@
+require 'date'
+
+module Pollster
+  # Pollster-generated summary of the chart. Pollster uses this to generate a sentence on the chart page such as, \"The polls suggest X leads Y, with a likelihood of Z%.\" If Pollster does not generate a chart summary, this value will be `null`. 
+  class ChartPollsterEstimateSummary
+    # Response label
+    attr_accessor :behind
+
+    # `chart.pollster_estimates[0].datetime`
+    attr_accessor :datetime
+
+    # Response label
+    attr_accessor :ahead
+
+    # Probability (between 0.5 and 1) that the response label `ahead` is ahead of `behind`
+    attr_accessor :probability
+
+    # `chart.pollster_estimates[0].created_at`
+    attr_accessor :created_at
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'behind' => :'behind',
+        :'datetime' => :'datetime',
+        :'ahead' => :'ahead',
+        :'probability' => :'probability',
+        :'created_at' => :'created_at'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'behind' => :'String',
+        :'datetime' => :'DateTime',
+        :'ahead' => :'String',
+        :'probability' => :'Float',
+        :'created_at' => :'DateTime'
+      }
+    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?(:'behind')
+        self.behind = attributes[:'behind']
+      end
+
+      if attributes.has_key?(:'datetime')
+        self.datetime = attributes[:'datetime']
+      end
+
+      if attributes.has_key?(:'ahead')
+        self.ahead = attributes[:'ahead']
+      end
+
+      if attributes.has_key?(:'probability')
+        self.probability = attributes[:'probability']
+      end
+
+      if attributes.has_key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      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 &&
+          behind == o.behind &&
+          datetime == o.datetime &&
+          ahead == o.ahead &&
+          probability == o.probability &&
+          created_at == o.created_at
+    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
+      [behind, datetime, ahead, probability, created_at].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/chart_pollster_trendlines.rb

@@ -0,0 +1,41 @@
+require 'date'
+require 'ruby-immutable-struct'
+
+module Pollster
+  ChartPollsterTrendlinePoint = RubyImmutableStruct.new(:label, :date, :value, :low, :high) do
+    def self.from_tsv_line(tsv_line)
+      if m = ChartPollsterTrendlinePoint::TsvLineRegex.match(tsv_line)
+        ChartPollsterTrendlinePoint.new(
+          m[:label],
+          Date.parse(m[:date]),
+          m[:value].to_f,
+          m[:low].empty? ? nil : m[:low].to_f,
+          m[:high].empty? ? nil : m[:high].to_f
+        )
+      else
+        raise ArgumentError.new("TSV line `#{tsv_line}` is not a valid ChartPollsterTrendlinePoint line")
+      end
+    end
+  end
+  ChartPollsterTrendlinePoint::TsvLineRegex = /\A(?<label>[^\t]+)\t(?<date>\d\d\d\d-\d\d-\d\d)\t(?<value>\d+(?:\.\d+)?)\t(?<low>(?:\d+(?:\.\d+)?)?)\t(?<high>(?:\d+(?:\.\d+)?)?)/
+
+  ChartPollsterTrendlines = RubyImmutableStruct.new(:points) do
+    ExpectedHeaderLine = "label\tdate\tvalue\tlow\thigh"
+
+    def by_label
+      ret = points.group_by(&:label)
+      ret.values.each { |arr| arr.sort_by!(&:date) }
+      ret
+    end
+
+    def self.from_tsv(tsv)
+      lines = tsv.split(/(?:\r?\n)+/).reject(&:empty?)
+      if /\A#{ExpectedHeaderLine}/ !~ lines[0]
+        raise ArgumentError.new("First line of TSV is `#{lines[0]}`; expected `#{ExpectedHeaderLine}`")
+      else
+        points = lines[1..-1].map { |tsv_line| ChartPollsterTrendlinePoint.from_tsv_line(tsv_line) }
+        ChartPollsterTrendlines.new(points)
+      end
+    end
+  end
+end