fec_results_generator 0.1 → 0.5

data/README.md

@@ -2,6 +2,8 @@
 
 A Ruby gem that takes Federal Election Commission election results as retrieved by the FecResults gem and generates JSON files in a directory structure, suitable for producting a static API. You can see an example of the data at the [FecResults site](http://openelections.github.io/fec_results/api/2012/summary/general_election_votes.json).
 
+The resulting JSON API is designed to be used as both a reference for House, Senate and Presidential election results and also as a reconciliation service for connecting results produced by state authorities with federal data such as FEC candidate ids.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -18,7 +20,7 @@ Or install it yourself as:
 
 ## Usage
 
-In `irb`, create an instance of the JSONGenerator class:
+In `irb`, create an instance of the JsonGenerator class:
 
 ```ruby
 g = FecResultsGenerator::JsonGenerator.new(:year => 2000)
@@ -27,6 +29,16 @@ g.president # for presidential results
 g.summary  # for vote totals
 ```
 
+This will create the following directories and files:
+
+api/2000/congress
+
+api/2000/president
+
+api/2000/summary
+
+with one or more files in each. The same directories and files are created for any even-numbered year between 2000 and 2012. Some years do not have all of the data that others; those files are still generated but are empty arrays.
+
 
 ## Contributing
 

data/lib/fec_results_generator.rb

@@ -20,7 +20,7 @@ module FecResultsGenerator
         begin
           run(method, fec_results, 'summary')
         rescue NotImplementedError
-          next
+          run_empty(method, 'summary')
         end
       end
     end
@@ -28,11 +28,18 @@ module FecResultsGenerator
     def president
       fec_results = FecResults::President.new(:year => year)
       create_dir(year, 'president')
-      ['popular_vote_summary', 'state_electoral_and_popular_vote_summary', 'primary_party_summary', 'general_election_results', 'primary_election_results'].each do |method|
+      ['popular_vote_summary', 'state_electoral_and_popular_vote_summary', 'primary_party_summary'].each do |method|
         begin
           run(method, fec_results, 'president')
         rescue NotImplementedError, NoMethodError
-          next
+          run_empty(method, 'president')
+        end
+      end
+      ['general_election_results', 'primary_election_results'].each do |method|
+        begin
+          run_results(method, fec_results, 'president')
+        rescue NotImplementedError, NoMethodError
+          run_empty(method, 'president')
         end
       end
     end
@@ -40,7 +47,7 @@ module FecResultsGenerator
     def congress
       fec_results = FecResults::Congress.new(:year => year)
       create_dir(year, 'congress')
-      run_congress('results', fec_results, 'congress')
+      run_results('results', fec_results, 'congress')
     end
     
     def run(method, fec_results, type)
@@ -48,7 +55,7 @@ module FecResultsGenerator
       write_to_file("api/#{year}/#{type}","#{method}.json", data.map{|d| d['table'].to_json})
     end
     
-    def run_congress(method, fec_results, type)
+    def run_results(method, fec_results, type)
       data = generate_json(fec_results.send(method))
       write_to_file("api/#{year}/#{type}","#{method}.json", data.map{|d| d.to_json})
     end
@@ -57,6 +64,10 @@ module FecResultsGenerator
       data = results.map{|r| JSON.parse(r.to_json)}
     end
     
+    def run_empty(method, type)
+      write_to_file("api/#{year}/#{type}","#{method}.json", [])
+    end
+    
     def write_to_file(dir, file, json)
       File.open(File.join(dir, file), 'w') do |f|
         PP.pp(json,f)

data/lib/fec_results_generator/version.rb

@@ -1,3 +1,3 @@
 module FecResultsGenerator
-  VERSION = "0.1"
+  VERSION = "0.5"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fec_results_generator
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: '0.5'
   prerelease: 
 platform: ruby
 authors:
@@ -89,7 +89,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1909023395731726773
+      hash: -3269316768951065816
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -98,7 +98,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1909023395731726773
+      hash: -3269316768951065816
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25