pollster 0.1.0

data/.gitignore

@@ -0,0 +1,2 @@
+*.swp
+*.gem

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,18 @@
+PATH
+  remote: .
+  specs:
+    pollster (0.1.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    json (1.7.3)
+    rdoc (3.12)
+      json (~> 1.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  pollster!
+  rdoc

data/LICENSE

@@ -0,0 +1,23 @@
+Copyright (c) 2012, The Huffington Post
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+  1. Redistributions of source code must retain the above copyright notice,
+  this list of conditions and the following disclaimer.
+
+  2. Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,145 @@
+          :::::::::   ::::::::  :::        :::        :::::::: ::::::::::: :::::::::: :::::::::    |                   ,*
+         :+:    :+: :+:    :+: :+:        :+:       :+:    :+:    :+:     :+:        :+:    :+:    |                 ,*
+        +:+    +:+ +:+    +:+ +:+        +:+       +:+           +:+     +:+        +:+    +:+     |             ,*,*
+       +#++:++#+  +#+    +:+ +#+        +#+       +#++:++#++    +#+     +#++:++#   +#++:++#:       |     ,*,   ,*
+      +#+        +#+    +#+ +#+        +#+              +#+    +#+     +#+        +#+    +#+       |   ,*   *,*
+     #+#        #+#    #+# #+#        #+#       #+#    #+#    #+#     #+#        #+#    #+#        | ,*
+    ###         ########  ########## ########## ########     ###     ########## ###    ###         |*
+                                                                                                    - - - - - - - - - - - 
+  
+
+A Ruby wrapper for the [Pollster API](http://elections.huffingtonpost.com/pollster/api) 
+which provides access to political opinion polling data and trend estimates from The Huffington Post.
+
+The Pollster gem has been tested under Ruby 1.8.7, 1.9.2 and 1.9.3.
+
+## Installation
+
+    gem install pollster
+
+## Getting Started
+
+    require 'pollster'
+    include Pollster
+
+See the current estimate of the president's job approval
+
+    Chart.find('obama-job-approval').estimates
+
+List charts about 2012 senate races
+
+    Chart.where(:topic => '2012-senate')
+
+List charts about Wisconsin
+
+    Chart.where(:state => 'WI')
+
+Calculate the margin between Obama and Romney from a recent general election poll
+
+    poll = Poll.where(:chart => '2012-general-election-romney-vs-obama').first
+    question = poll.questions.detect { |question| question[:chart] == '2012-general-election-romney-vs-obama' }
+    obama = question[:responses].detect { |response| response[:choice] == "Obama" }
+    romney = question[:responses].detect { |response| response[:choice] == "Romney" }
+    obama[:value] - romney[:value]
+
+See the methodology used in recent polls about the Affordable Care Act
+
+    chart = Chart.find 'us-health-bill'
+    chart.polls.map { |poll| [poll.pollster, poll.method] }
+
+## Usage
+
+Pollster provides two classes:
+
+    Pollster::Chart
+
+represents the current estimates for a Pollster chart (e.g. [Romney vs. Obama](http://elections.huffingtonpost.com/pollster/2012-general-election-romney-vs-obama))
+
+    Pollster::Poll
+
+represents a specific poll conducted by a polling firm.
+
+### Accessing data
+
+List all the charts available from Pollster:
+
+    >> Pollster::Chart.all
+    => [<Pollster::Chart: 2012 Iowa GOP Primary>,
+        <Pollster::Chart: 2012 New Hampshire GOP Primary>,
+        <Pollster::Chart: 2012 South Carolina GOP Primary>,
+        <Pollster::Chart: 2012 Florida GOP Primary>,
+        <Pollster::Chart: 2012 Nevada GOP Primary>,
+        ...]
+
+This response is not paginated; all charts will be returned.
+
+A specific chart may be accessed using Pollster::Chart#find, giving the chart's slug as an argument:
+
+    >> Pollster::Chart.find('2012-iowa-gop-primary')
+    => <Pollster::Chart: 2012 Iowa GOP Primary>
+
+All the charts for a topic or state may be accessed using Pollster::Chart#where:
+
+    >> Pollster::Chart.where(:state => 'MD')
+    => [<Pollster::Chart: 2012 Maryland GOP Primary>,
+        <Pollster::Chart: 2012 Maryland House: 6th District>,
+        <Pollster::Chart: 2012 Maryland President: Romney vs. Obama>]
+
+    >> Pollster::Chart.where(:topic => '2012-senate')
+    => [<Pollster::Chart: 2012 Massachusetts Senate: Brown vs Warren>,
+        <Pollster::Chart: 2012 Ohio Senate: Brown vs Mandel>,
+        <Pollster::Chart: 2012 Arizona Senate: Flake vs. Carmona>,
+        <Pollster::Chart: 2012 Florida Senate: Mack vs. Nelson>,
+        ...]
+
+    >> Pollster::Chart.where(:topic => '2012-senate', :state => 'MA')
+    => [<Pollster::Chart: 2012 Massachusetts Senate: Brown vs Warren>]
+
+List the polls that were used to create the estimate for a specific chart:
+
+    >> chart = Pollster::Chart.find('2012-iowa-gop-primary')
+    >> chart.polls
+    => [#<Pollster::Poll:...
+      @end_date=#<Date: 2012-01-01 (4911855/2,0,2299161)>,
+      @id=12385,
+      @method="Automated Phone",
+      @pollster="InsiderAdvantage",
+      @questions=
+       [{:name=>"2012 Iowa GOP Primary",
+         :chart=>"2012-iowa-gop-primary",
+         :topic=>"2012-gop-primary",
+         :state=>"IA",
+         :responses=>
+          [{:choice=>"Undecided",
+            :value=>2,
+            :subpopulation=>"Likely Voters",
+            :number_of_observations=>729,
+            :margin_of_error=>nil},
+           {:choice=>"Bachmann",
+            :value=>6,
+            :subpopulation=>"Likely Voters",
+            :number_of_observations=>729,
+            :margin_of_error=>nil},
+           {:choice=>"Romney",
+            :value=>23,
+            :subpopulation=>"Likely Voters",
+            :number_of_observations=>729,
+            :margin_of_error=>nil},
+          ...]
+
+You may also list all polls available through Pollster:
+
+    >> Pollster::Poll.all
+
+This response is paginated, with 10 polls per page. To access subsequent pages, provide a page argument:
+
+    >> Pollster::Poll.all(:page => 5)
+
+## Authors
+
+- Aaron Bycoffe, bycoffe@huffingtonpost.com
+- Jay Boice, jay.boice@huffingtonpost.com
+
+## Copyright
+
+Copyright © 2012 The Huffington Post. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test

data/lib/pollster.rb

@@ -0,0 +1,3 @@
+require 'pollster/base'
+require 'pollster/chart'
+require 'pollster/poll'

data/lib/pollster/base.rb

@@ -0,0 +1,45 @@
+require 'json'
+require 'uri'
+require 'net/http'
+require 'date'
+require 'time'
+require 'zlib'
+
+module Pollster
+
+  class Base
+    API_SERVER = 'elections.huffingtonpost.com'
+    API_BASE = '/pollster/api'
+
+    class << self
+
+      private
+
+        def encode_params(params)
+          params.map { |k, v| "#{k}=#{v}" }.join('&')
+        end
+
+        def build_request_url(path, params={})
+          URI("http://#{API_SERVER}#{API_BASE}/#{path}#{params.size > 0 ? "?#{encode_params(params)}" : ''}")
+        end
+
+        def invoke(path, params={})
+          uri = build_request_url(path, params)
+          request = Net::HTTP::Get.new(uri.request_uri)
+          request['Accept-Encoding'] = 'gzip,deflate'
+          response = Net::HTTP.start(uri.host, uri.port) { |http| http.request(request) }
+          body = response.header['Content-Encoding'].eql?('gzip') ?
+                 Zlib::GzipReader.new(StringIO.new(response.body)).read() :
+                 response.body
+          raise Exception, JSON.parse(body)["errors"].join(', ') if response.code.eql?('400')
+          JSON.parse(body)
+        end
+
+        def hash_keys_to_sym(hash)
+          Hash[*hash.map { |k, v| [k.to_sym, v] }.flatten(1)]
+        end
+
+    end
+  end
+
+end

data/lib/pollster/chart.rb

@@ -0,0 +1,69 @@
+module Pollster
+
+  class Chart < Base
+
+    attr_reader :title, :slug, :poll_count, :last_updated, :url, :estimates, :estimates_by_date, :state, :topic
+
+    def initialize(params={})
+      params.each_pair do |k,v|
+        instance_variable_set("@#{k}", v)
+      end
+    end
+
+    # Get a list of polls for this chart.
+    def polls(params={})
+      Poll.where(params.merge({:chart => self.slug}))
+    end
+
+    # Get a list of all charts.
+    def self.all
+      invoke('charts').map { |chart| self.create(chart) }
+    end
+
+    # Get a chart based on its slug.
+    def self.find(slug)
+      self.create invoke("charts/#{slug}")
+    end
+
+    # Get a list of charts based on the given parameters.
+    # See API documentation for acceptable parameters.
+    def self.where(params={})
+      if params.empty?
+        raise "A search parameter is required"
+      end
+      invoke('charts', params).map { |chart| self.create(chart) }
+    end
+
+    def to_s
+      "#{self.class}: #{self.title}"
+    end
+
+    def inspect
+      "<#{self.class}: #{self.title}>"
+    end
+
+    def estimates_by_date
+      @estimates_by_date ||= Pollster::Chart.find(slug).estimates_by_date
+    end
+
+    private
+
+      def self.create(data)
+        data = Hash[*data.map { |k, v| [k.to_sym, v] }.flatten(1)]
+        data[:last_updated] = Time.parse(data[:last_updated])
+        data[:estimates].map! { |estimate| {:choice => estimate['choice'], :value => estimate['value']} }
+        if data[:estimates_by_date]
+          data[:estimates_by_date] = data[:estimates_by_date].map do |x|
+            estimate = hash_keys_to_sym(x)
+            estimate[:date] = Date.parse(estimate[:date])
+            estimate[:estimates] = estimate[:estimates].map { |e| hash_keys_to_sym(e) }
+            estimate
+          end
+        end
+        self.new(data)
+      end
+
+
+  end
+
+end

data/lib/pollster/poll.rb

@@ -0,0 +1,43 @@
+module Pollster
+
+  class Poll < Base
+
+    attr_reader :start_date, :end_date, :method, :pollster, :url, :source, :questions
+
+    def initialize(params={})
+      params.each_pair do |k,v|
+        instance_variable_set("@#{k}", v)
+      end
+    end
+
+    # Get a list of all polls.
+    # Polls are listed in pages of 25.
+    def self.all(params={})
+      page = params[:page] || 1
+      invoke('polls', {:page => page}).map { |poll| self.create(poll) }
+    end
+
+    # Get a list of polls based on the given parameters.
+    # See API documentation for acceptable parameters.
+    def self.where(params={})
+      if params.empty?
+        raise "A search parameter is required"
+      end
+      invoke('polls', params).map { |poll| self.create(poll) }
+    end
+
+    private
+
+      def self.create(data)
+        data = hash_keys_to_sym(data)
+        data[:questions] = data[:questions].map { |question| hash_keys_to_sym(question) }
+        data[:questions].each { |question| question[:responses] = question[:responses].map { |response| hash_keys_to_sym(response) } }
+        data[:start_date] = Date.parse(data[:start_date])
+        data[:end_date] = Date.parse(data[:end_date])
+        self.new(data)
+      end
+
+
+  end
+
+end

data/lib/pollster/version.rb

@@ -0,0 +1,3 @@
+module Pollster
+  VERSION = '0.1.0'
+end

data/pollster.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require 'pollster/version'
+
+Gem::Specification.new do |s|
+  s.name = 'pollster'
+  s.version = Pollster::VERSION
+  s.platform = Gem::Platform::RUBY
+  s.authors = ["Jay Boice", "Aaron Bycoffe"]
+  s.email = ["jay.boice@huffingtonpost.com", "bycoffe@huffingtonpost.com"]
+  s.homepage = "http://github.com/huffingtonpost/ruby-pollster"
+  s.summary = "Ruby library for accessing the Pollster API"
+  s.description = "A Ruby library for accessing the Pollster API."
+
+  s.files = `git ls-files`.split("\n")
+  s.require_paths = ['lib']
+
+  s.add_development_dependency "rdoc"
+end
+

data/test/test_pollster.rb

@@ -0,0 +1,26 @@
+require 'test/unit'
+require 'pollster'
+include Pollster
+
+class PollsterTest < Test::Unit::TestCase
+
+  def test_ge_chart
+    assert_equal "US", Chart.find('2012-general-election-romney-vs-obama').state
+  end
+
+  def test_poll_page_size
+    assert_equal 10, Poll.all.size
+  end
+
+  def test_invalid_chart_slug
+    assert_raise(Exception) { Chart.find('invalid-slug') }
+  end
+
+  def test_estimates_by_date
+    assert_block do
+      chart = Chart.all.first
+      chart.estimates_by_date.is_a?(Array)
+    end
+  end
+
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: pollster
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Jay Boice
+- Aaron Bycoffe
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Ruby library for accessing the Pollster API.
+email:
+- jay.boice@huffingtonpost.com
+- bycoffe@huffingtonpost.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/pollster.rb
+- lib/pollster/base.rb
+- lib/pollster/chart.rb
+- lib/pollster/poll.rb
+- lib/pollster/version.rb
+- pollster.gemspec
+- test/test_pollster.rb
+homepage: http://github.com/huffingtonpost/ruby-pollster
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Ruby library for accessing the Pollster API
+test_files: []
+has_rdoc: