fec_results 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fec_results.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Derek Willis
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,63 @@
+# FecResults
+
+FecResults is a Ruby library that provides access to federal election results as published by the Federal Election Commission. Although it is primarily a campaign finance disclosure agency, the FEC also compiles election results on its site. This library provides ways to access summary and contest-specific information about elections for the U.S. House of Representatives, the U.S. Senate and President from 2000-2012. This data represents regularly-scheduled primary and general elections, plus special elections held on the date of general elections. It does not include special elections held outside the regularly scheduled election calendar. The results are race-wide only; they do not contain any geographic breakdowns such as county.
+
+Please be aware that there can be typos in some of the FEC results files, mainly in the FEC candidate IDs.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'fec_results'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fec_results
+
+## Usage
+
+FecResults can be used to retrieve both summary and contest-specific election results. Every instance of FecResults must include a year passed into the `new` method. For summary totals:
+
+```ruby
+require 'fec_results'
+s = FecResults::Summary.new(:year => 2012)
+general_votes = s.general_election_votes
+=> [<OpenStruct state="AL", presidential_votes=2074338, senate_votes=nil, house_votes=1933630>, <OpenStruct state="AK", presidential_votes=300495, senate_votes=nil, house_votes=289804>,...]
+general_votes.
+alabama = general_votes.first
+=> <OpenStruct state="AL", presidential_votes=2074338, senate_votes=nil, house_votes=1933630>
+alabama.house_votes
+=> 1933630
+```
+For specific congressional results, the file can take awhile to load, so try not to call `results` more than once, but rather save the output locally:
+
+```ruby
+c = FecResults::Congress.new(:year => 2012)
+results = c.results
+results.first
+=> <FecResults::Result:0x007fb46e297870 @year=2012, @chamber="H", @state="AL", @district="01", @fec_id="H2AL01077", @incumbent=true, @candidate_last="Bonner", @candidate_first="Jo", @candidate_name="Bonner, Jo", @party="R", @primary_votes=48702, @primary_pct=55.54959907839358, @primary_unopposed=false, @runoff_votes=nil, @runoff_pct=nil, @general_votes=196374, @general_pct=97.85624588889553, @general_unopposed=false, @general_runoff_votes=nil, @general_runoff_pct=nil, @general_combined_party_votes=nil, @general_combined_party_pct=nil, @general_winner=true, @notes=nil>
+```
+
+To filter either summary or results items by state, pass in the state in a hash:
+
+```ruby
+c = FecResults::Congress.new(:year => 2012)
+results = c.results({:state => 'AL'})
+results.first
+=> <FecResults::Result:0x007fb46e297870 @year=2012, @chamber="H", @state="AL", @district="01", @fec_id="H2AL01077", @incumbent=true, @candidate_last="Bonner", @candidate_first="Jo", @candidate_name="Bonner, Jo", @party="R", @primary_votes=48702, @primary_pct=55.54959907839358, @primary_unopposed=false, @runoff_votes=nil, @runoff_pct=nil, @general_votes=196374, @general_pct=97.85624588889553, @general_unopposed=false, @general_runoff_votes=nil, @general_runoff_pct=nil, @general_combined_party_votes=nil, @general_combined_party_pct=nil, @general_winner=true, @notes=nil>
+```
+
+
+	
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/api_routes.csv

@@ -0,0 +1 @@
+class,method,path,container,object,arg example

data/fec_results.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fec_results/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fec_results"
+  spec.version       = FecResults::VERSION
+  spec.authors       = ["Derek Willis"]
+  spec.email         = ["dwillis@gmail.com"]
+  spec.description   = %q{Parses FEC federal election results into Ruby objects}
+  spec.summary       = %q{House, Senate, Presidential results}
+  spec.homepage      = ""
+  spec.license       = "Apache"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_dependency "remote_table"
+  spec.add_dependency "american_date"
+end

data/lib/fec_results.rb

@@ -0,0 +1,40 @@
+require 'rubygems'
+require 'remote_table'
+require 'american_date'
+require 'ostruct'
+
+require "fec_results/version"
+require "fec_results/congress"
+require "fec_results/result"
+require "fec_results/summary"
+require "fec_results/president"
+
+module FecResults
+
+  SUMMARY_URLS = {
+    '2012' => 'http://www.fec.gov/pubrec/fe2012/tables2012.xls',
+    '2010' => 'http://www.fec.gov/pubrec/fe2010/tables10.xls',
+    '2008' => 'http://www.fec.gov/pubrec/fe2008/tables2008.xls',
+    '2006' => 'http://www.fec.gov/pubrec/fe2006/tables06.xls',
+    '2004' => 'http://www.fec.gov/pubrec/fe2004/tables.xls',
+    '2002' => 'http://www.fec.gov/pubrec/fe2002/2002fedresults.xls',
+    '2000' => 'http://www.fec.gov/pubrec/fe2000/tables.xls'
+  }
+
+  CONGRESS_URLS = {
+    '2012' => 'http://www.fec.gov/pubrec/fe2012/2012congresults.xls',
+    '2010' => 'http://www.fec.gov/pubrec/fe2010/results10.xls',
+    '2008' => 'http://www.fec.gov/pubrec/fe2008/2008congresults.xls',
+    '2006' => 'http://www.fec.gov/pubrec/fe2006/results06.xls',
+    '2004' => 'http://www.fec.gov/pubrec/fe2004/2004congresults.xls',
+    '2002' => 'http://www.fec.gov/pubrec/fe2002/2002fedresults.xls',
+    '2000' => [{'http://www.fec.gov/pubrec/fe2000/senate.xls' => 'Senate (with Totals & Percent) '}, {'http://www.fec.gov/pubrec/fe2000/house.xls' => 'House (with Totals & Percents)'}]
+  }
+
+  PRESIDENT_URLS = {
+    '2012' => 'http://www.fec.gov/pubrec/fe2012/2012pres.xls',
+    '2008' => 'http://www.fec.gov/pubrec/fe2008/2008pres.xls',
+    '2004' => 'http://www.fec.gov/pubrec/fe2004/2004pres.xls',
+    '2000' => ['http://www.fec.gov/pubrec/fe2000/presge.xls', 'http://www.fec.gov/pubrec/fe2000/presprim.xls']
+  }
+end

data/lib/fec_results/congress.rb

@@ -0,0 +1,323 @@
+module FecResults
+  class Congress
+
+    attr_reader :year, :url
+
+    # given a year and an optional chamber ('house' or 'senate') and state ('ar', 'az', etc.) 
+    # retrieves election results that fit the criteria
+    def initialize(params={})
+      params.each_pair do |k,v|
+       instance_variable_set("@#{k}", v)
+      end
+      @url = FecResults::CONGRESS_URLS[year.to_s]
+    end
+    
+    def results(options={})
+      send("process_#{year}", options)
+    end
+
+    def process_2012(options)
+      results = []
+      t = RemoteTable.new(url, :sheet => "2012 US House & Senate Resuts")
+      rows = t.entries
+      rows = rows.select{|r| r['D'] == options[:chamber]} if options[:chamber]
+      rows = rows.select{|r| r['STATE ABBREVIATION'] == options[:state]} if options[:state]
+      rows.each do |candidate|
+        c = {:year => year}
+        next if candidate['CANDIDATE NAME (Last)'].blank?
+        next if candidate['D'].blank?
+        # find the office_type
+        if candidate['FEC ID#'].first != 'n'
+          c[:chamber] = candidate['FEC ID#'].first
+        elsif candidate['D'].first == 'S'
+          c[:chamber] = "S"
+        else
+          c[:chamber] = 'H'
+        end
+        c[:state] = candidate['STATE ABBREVIATION']
+        c[:district] = candidate['D']
+        c[:party] = candidate['PARTY']
+        c[:incumbent] = candidate['(I)'] == '(I)' ? true : false
+        c[:fec_id] = candidate['FEC ID#']
+        c[:candidate_first] = candidate['CANDIDATE NAME (First)']
+        c[:candidate_last] = candidate['CANDIDATE NAME (Last)']
+        c[:candidate_name] = candidate['CANDIDATE NAME']
+
+        c = update_vote_tallies(c, candidate, 'PRIMARY VOTES', 'PRIMARY %', 'RUNOFF VOTES', 'RUNOFF %', 'GENERAL VOTES ', 'GENERAL %')
+        c = update_general_runoff(c, candidate, 'GE RUNOFF ELECTION VOTES (LA)', 'GE RUNOFF ELECTION % (LA)') if c[:state] == 'LA'
+        c = update_combined_totals(c, candidate, 'COMBINED GE PARTY TOTALS (CT, NY, SC)', 'COMBINED % (CT, NY, SC)') if ['CT', 'NY', 'SC'].include?(c[:state])
+
+        c[:general_winner] = candidate['GE WINNER INDICATOR'] == "W" ? true : false unless c[:general_pct].nil?
+
+        results << c
+      end
+      Result.create_from_results(results)
+    end
+
+    def process_2010(options)
+      results = []
+      t = RemoteTable.new(url, :sheet => "2010 US House & Senate Results")
+      rows = t.entries
+      rows = rows.select{|r| r['DISTRICT'] == options[:chamber]} if options[:chamber]
+      rows = rows.select{|r| r['STATE ABBREVIATION'] == options[:state]} if options[:state]
+      rows.each do |candidate|
+        c = {:year => year}
+        next if candidate['CANDIDATE NAME (Last)'].blank?
+        next if candidate['DISTRICT'].blank?
+        # find the office_type
+        if candidate['FEC ID#'].first != 'n'
+          c[:chamber] = candidate['FEC ID#'].first
+        elsif candidate['DISTRICT'].first == 'S'
+          c[:chamber] = "S"
+        else
+          c[:chamber] = 'H'
+        end
+        c[:state] = candidate['STATE ABBREVIATION']
+        c[:district] = candidate['DISTRICT']
+        c[:party] = candidate['PARTY']
+        c[:incumbent] = candidate['INCUMBENT INDICATOR (I)'] == '(I)' ? true : false
+        c[:fec_id] = candidate['FEC ID#']
+        c[:candidate_first] = candidate['CANDIDATE NAME (First)']
+        c[:candidate_last] = candidate['CANDIDATE NAME (Last)']
+        c[:candidate_name] = candidate['CANDIDATE NAME (Last, First)']
+
+        c = update_vote_tallies(c, candidate, 'PRIMARY', 'PRIMARY %', 'RUNOFF', 'RUNOFF %', 'GENERAL ', 'GENERAL %')
+        c = update_combined_totals(c, candidate) if ['CT', 'NY', 'SC'].include?(c[:state])
+
+        results << c
+      end
+      Result.create_from_results(results)
+    end
+
+    def process_2008(options)
+      results = []
+      t = RemoteTable.new(url, :sheet => "2008 House and Senate Results")
+      rows = t.entries
+      rows = rows.select{|r| r['DISTRICT'] == options[:chamber]} if options[:chamber]
+      rows = rows.select{|r| r['STATE ABBREVIATION'] == options[:state]} if options[:state]
+      rows.each do |candidate|
+        c = {:year => year}
+        next if candidate['Candidate Name (Last)'].blank?
+        next if candidate['DISTRICT'].blank?
+        # find the office_type
+        if candidate['FEC ID#'].first != 'n'
+          c[:chamber] = candidate['FEC ID#'].first
+        elsif candidate['DISTRICT'].first == 'S'
+          c[:chamber] = "S"
+        else
+          c[:chamber] = 'H'
+        end
+        c[:state] = candidate['STATE ABBREVIATION']
+        c[:district] = candidate['DISTRICT']
+        c[:party] = candidate['PARTY']
+        c[:incumbent] = candidate['INCUMBENT INDICATOR (I)'] == '(I)' ? true : false
+        c[:fec_id] = candidate['FEC ID#']
+        c[:candidate_first] = candidate['CANDIDATE NAME (First)']
+        c[:candidate_last] = candidate['CANDIDATE NAME (Last)']
+        c[:candidate_name] = candidate['CANDIDATE NAME']
+
+        c = update_vote_tallies(c, candidate, 'PRIMARY', 'PRIMARY %', 'RUNOFF', 'RUNOFF %', 'GENERAL ', 'GENERAL %')
+        c = update_general_runoff(c, candidate, 'GE RUNOFF', 'GE RUNOFF %') if c[:state] == 'LA'
+        c = update_combined_totals(c, candidate, 'COMBINED GE PARTY TOTALS (CT, NY)', 'COMBINED % (CT, NY)') if ['CT', 'NY'].include?(c[:state])
+
+        results << c
+      end
+      Result.create_from_results(results)
+    end
+
+    def process_2006(options)
+      results = []
+      t = RemoteTable.new(url, :sheet => "2006 US House & Senate Results")
+      rows = t.entries
+      rows = rows.select{|r| r['DISTRICT'] == options[:chamber]} if options[:chamber]
+      rows = rows.select{|r| r['STATE ABBREVIATION'] == options[:state]} if options[:state]
+      rows.each do |candidate|
+        c = {:year => year}
+        next if candidate['LAST NAME'].blank?
+        next if candidate['DISTRICT'].blank?
+        # find the office_type
+        if candidate['FEC ID'].first != 'n'
+          c[:chamber] = candidate['FEC ID'].first
+        elsif candidate['DISTRICT'].first == 'S'
+          c[:chamber] = "S"
+        else
+          c[:chamber] = 'H'
+        end
+        c[:state] = candidate['STATE ABBREVIATION']
+        c[:district] = candidate['DISTRICT']
+        c[:party] = candidate['PARTY']
+        c[:incumbent] = candidate['INCUMBENT INDICATOR'] == '(I)' ? true : false
+        c[:fec_id] = candidate['FEC ID#']
+        c[:candidate_first] = candidate['FIRST NAME']
+        c[:candidate_last] = candidate['LAST NAME']
+        c[:candidate_name] = candidate['LAST NAME, FIRST']
+
+        c = update_vote_tallies(c, candidate, 'PRIMARY', 'PRIMARY %', 'RUNOFF', 'RUNOFF %', 'GENERAL', 'GENERAL %')
+        c = update_general_runoff(c, candidate, 'GE RUNOFF', 'GE RUNOFF %') if c[:state] == 'LA'
+        c = update_combined_totals(c, candidate, 'COMBINED GE PARTY TOTALS (NY, SC)', 'COMBINED % (NY, SC)') if ['SC', 'NY'].include?(c[:state])
+
+        results << c
+      end
+      Result.create_from_results(results)
+    end
+
+    def process_2004(options)
+      results = []
+      t = RemoteTable.new(url, :sheet => "2004 US HOUSE & SENATE RESULTS")
+      rows = t.entries
+      rows = rows.select{|r| r['DISTRICT'] == options[:chamber]} if options[:chamber]
+      rows = rows.select{|r| r['STATE ABBREVIATION'] == options[:state]} if options[:state]
+      rows.each do |candidate|
+        c = {:year => year}
+        next if candidate['LAST NAME'].blank?
+        next if candidate['DISTRICT'].blank?
+        # find the office_type
+        if candidate['FEC ID'].first != 'n'
+          c[:chamber] = candidate['FEC ID'].first
+        elsif candidate['DISTRICT'].first == 'S'
+          c[:chamber] = "S"
+        else
+          c[:chamber] = 'H'
+        end
+        c[:state] = candidate['STATE ABBREVIATION']
+        c[:district] = candidate['DISTRICT']
+        c[:party] = candidate['PARTY']
+        c[:incumbent] = candidate['INCUMBENT INDICATOR'] == '(I)' ? true : false
+        c[:fec_id] = candidate['FEC ID#']
+        c[:candidate_first] = candidate['FIRST NAME']
+        c[:candidate_last] = candidate['LAST NAME']
+        c[:candidate_name] = candidate['LAST NAME, FIRST']
+
+        c = update_vote_tallies(c, candidate, 'PRIMARY', 'PRIMARY %', 'RUNOFF', 'RUNOFF %', 'GENERAL', 'GENERAL %')
+        c = update_general_runoff(c, candidate, 'GE RUNOFF', 'GE RUNOFF %') if c[:state] == 'LA'
+
+        results << c
+      end
+      Result.create_from_results(results)
+    end
+
+    def process_2002(options={})
+      results = []
+      t = RemoteTable.new(url, :sheet => "2002 House & Senate Results")
+      rows = t.entries
+      rows = rows.select{|r| r['DISTRICT'] == options[:chamber]} if options[:chamber]
+      rows = rows.select{|r| r['STATE'] == options[:state]} if options[:state]
+      rows.each do |candidate|
+        c = {:year => year}
+        next if candidate['LAST NAME'].blank?
+        next if candidate['DISTRICT'].blank?
+        # find the office_type
+        if candidate['FEC ID'].first != 'n'
+          c[:chamber] = candidate['FEC ID'].first
+        elsif candidate['DISTRICT'].first == 'S'
+          c[:chamber] = "S"
+        else
+          c[:chamber] = 'H'
+        end
+        c[:state] = candidate['STATE']
+        c[:district] = candidate['DISTRICT']
+        c[:party] = candidate['PARTY']
+        c[:incumbent] = candidate['INCUMBENT INDICATOR'] == '(I)' ? true : false
+        c[:fec_id] = candidate['FEC ID#']
+        c[:candidate_first] = candidate['FIRST NAME']
+        c[:candidate_last] = candidate['LAST NAME']
+        c[:candidate_name] = candidate['LAST NAME, FIRST']
+
+        c = update_vote_tallies(c, candidate, 'PRIMARY RESULTS', 'PRIMARY %', 'RUNOFF RESULTS', 'RUNOFF %', 'GENERAL RESULTS', 'GENERAL %')
+        c = update_combined_totals(c, candidate, 'COMBINED GE PARTY TOTALS (NY, SC)', 'COMBINED % (NY, SC)') if ['SC', 'NY'].include?(c[:state])
+
+        results << c
+      end
+      Result.create_from_results(results)
+    end
+
+    def process_2000(options={})
+      results = []
+      url.each do |u|
+        t = RemoteTable.new(u.keys.first, :sheet => u.values.first)
+        rows = t.entries
+        rows = rows.select{|r| r['STATE'] == options[:state]} if options[:state]
+        rows.each do |candidate|
+          c = {:year => year}
+          next if candidate['NAME'][0..4] == 'Total'
+          next if candidate['DISTRICT'].blank?
+          if candidate['DISTRICT'].first == 'S'
+            c[:chamber] = "S"
+          else
+            c[:chamber] = 'H'
+          end
+          c[:state] = candidate['STATE']
+          c[:district] = candidate['DISTRICT']
+          c[:party] = candidate['PARTY']
+          c[:incumbent] = candidate['INCUMBENT INDICATOR'] == '(I)' ? true : false
+          c[:candidate_first], c[:candidate_last] = candidate['NAME'].split(', ')
+          c[:candidate_name] = candidate['NAME']
+
+          c = update_vote_tallies(c, candidate, 'PRIMARY RESULTS', 'PRIMARY %', 'RUNOFF RESULTS', 'RUNOFF %', 'GENERAL RESULTS', 'GENERAL %')
+          c = update_general_runoff(c, candidate, 'GENERAL RUNOFF RESULTS', 'GENERAL RUNOFF %') if c[:state] == 'LA'
+
+          results << c
+        end
+      end
+      if options[:chamber] == 'H'
+        results = results.select{|r| r[:chamber] != 'S'}
+      elsif options[:chamber] == 'S'
+        results = results.select{|r| r[:chamber] == 'S'}
+      end
+      Result.create_from_results(results)
+    end
+
+
+    def update_vote_tallies(c, candidate, primary_votes, primary_pct, runoff_votes, runoff_pct, general_votes, general_pct)
+      if candidate[primary_votes] == 'Unopposed'
+        c[:primary_unopposed] = true
+        c[:primary_votes] = nil
+        c[:primary_pct] = 100.0
+      else
+        c[:primary_unopposed] = false
+        c[:primary_votes] = candidate[primary_votes].to_i
+        c[:primary_pct] = candidate[primary_pct].to_f*100.0
+      end
+
+      if candidate[runoff_votes].blank?
+        c[:runoff_votes] = nil
+        c[:runoff_pct] = nil
+      else
+        c[:runoff_votes] = candidate[runoff_votes].to_i
+        c[:runoff_pct] = candidate[runoff_pct].to_f*100.0
+      end
+
+      if candidate[general_votes] == 'Unopposed'
+        c[:general_unopposed] = true
+        c[:general_votes] = nil
+        c[:general_pct] = 100.0
+      elsif candidate[general_votes].blank?
+        c[:general_unopposed] = false
+        c[:general_votes] = nil
+        c[:general_pct] = nil
+      else
+        c[:general_unopposed] = false
+        c[:general_votes] = candidate[general_votes].to_i
+        c[:general_pct] = candidate[general_pct].to_f*100.0
+      end
+      c
+    end
+
+    def update_general_runoff(c, candidate, general_runoff_votes, general_runoff_pct)
+      unless candidate[general_runoff_votes].blank?
+        c[:general_runoff_votes] = candidate[general_runoff_votes].to_i
+        c[:general_runoff_pct] = candidate[general_runoff_pct].to_f*100.0
+      end
+      c
+    end
+
+    def update_combined_totals(c, candidate, general_combined_party_votes, general_combined_party_pct)
+      unless candidate[general_combined_party_votes].blank?
+        c[:general_combined_party_votes] = candidate[general_combined_party_votes].to_i
+        c[:general_combined_party_pct] = candidate[general_combined_party_pct].to_f*100.0
+      end
+      c
+    end
+
+  end
+end