fechell 0.1.9

data/Manifest

@@ -0,0 +1,75 @@
+fechell.gemspec
+lib/defs/3.00.csv
+lib/defs/5.00.csv
+lib/defs/5.1.csv
+lib/defs/5.2.csv
+lib/defs/5.3.csv
+lib/defs/6.1.csv
+lib/defs/6.2.csv
+lib/defs/6.3.csv
+lib/defs/6.4.csv
+lib/fechell/forms.rb
+lib/fechell.rb
+lib/tests/f3test.rb
+lib/tests/satest.rb
+lib/tests/sbtest.rb
+lib/tests/sc1test.rb
+lib/tests/sctest.rb
+lib/tests/testdata/F3-3.00-32564-SC1.fec
+lib/tests/testdata/F3-3.00-32777.fec
+lib/tests/testdata/F3-3.00-32909-SC.fec
+lib/tests/testdata/F3-3.00-32933-SB.fec
+lib/tests/testdata/F3-3.00-32933.fec
+lib/tests/testdata/F3-5.00-97348.fec
+lib/tests/testdata/F3-5.00-97424-SB.fec
+lib/tests/testdata/F3-5.00-97424-SC.fec
+lib/tests/testdata/F3-5.00-97424.fec
+lib/tests/testdata/F3-5.00-97986-SC1.fec
+lib/tests/testdata/F3-5.1-116177-SC1.fec
+lib/tests/testdata/F3-5.1-116437-SC2.fec
+lib/tests/testdata/F3-5.1-126642.fec
+lib/tests/testdata/F3-5.1-126655-SB.fec
+lib/tests/testdata/F3-5.1-126655-SC.fec
+lib/tests/testdata/F3-5.1-126655.fec
+lib/tests/testdata/F3-5.2-170434.fec
+lib/tests/testdata/F3-5.2-170443.fec
+lib/tests/testdata/F3-5.2-170775-SC.fec
+lib/tests/testdata/F3-5.2-170890-SC.fec
+lib/tests/testdata/F3-5.2-170890.fec
+lib/tests/testdata/F3-5.2-171146-SC1.fec
+lib/tests/testdata/F3-5.2-171146.fec
+lib/tests/testdata/F3-5.3-210119-SB.fec
+lib/tests/testdata/F3-5.3-210119.fec
+lib/tests/testdata/F3-5.3-210142-SC1.fec
+lib/tests/testdata/F3-5.3-210142.fec
+lib/tests/testdata/F3-5.3-210250.fec
+lib/tests/testdata/F3-5.3-212438-SC.fec
+lib/tests/testdata/F3-6.1-331453-SB.fec
+lib/tests/testdata/F3-6.1-331453.fec
+lib/tests/testdata/F3-6.1-332530-SC.fec
+lib/tests/testdata/F3-6.1-332675.fec
+lib/tests/testdata/F3-6.1-333405-SC1.fec
+lib/tests/testdata/F3-6.1-333405.fec
+lib/tests/testdata/F3-6.2-350353-SC.fec
+lib/tests/testdata/F3-6.2-350353.fec
+lib/tests/testdata/F3-6.2-350775-SB.fec
+lib/tests/testdata/F3-6.2-350775.fec
+lib/tests/testdata/F3-6.2-350844-SC1.fec
+lib/tests/testdata/F3-6.2-350844.fec
+lib/tests/testdata/F3-6.3-413014.fec
+lib/tests/testdata/F3-6.3-413060-SC.fec
+lib/tests/testdata/F3-6.3-413226-SB.fec
+lib/tests/testdata/F3-6.3-413226.fec
+lib/tests/testdata/F3-6.3-413284-SC1.fec
+lib/tests/testdata/F3-6.4-420048-SC.fec
+lib/tests/testdata/F3-6.4-420048.fec
+lib/tests/testdata/F3-6.4-420106.fec
+lib/tests/testdata/F3-6.4-423088-SC1.fec
+lib/tests/testdata/F3-6.4-423088.fec
+lib/tests/testdata/F3-6.4-424094.fec
+lib/tests/testdata/F3-6.4-424586-SB.fec
+lib/tests/testdata/F3-6.4-424586.fec
+lib/tests.rb
+Manifest
+Rakefile
+README.rdoc

data/README.rdoc

@@ -0,0 +1,130 @@
+= FECHell
+
+Parsing a loading electronically filed fundraising reports from the Federal Election Commission. FECHell uses format definition files from Watchdog.net (http://watchdog.net/data/crawl/fec/electronic/headers/). 
+
+== Install
+
+sudo gem install offensivepolitics-fechell
+
+== Usage
+
+	require 'rubygems'
+	require 'fechell'
+	require 'fechell/forms.rb'
+	require 'open-uri'
+
+	# convenience function to download a file from a URL and save it locally
+
+	def savefile(filename,url)
+	  File.open(filename,"w") do |file|
+	    file.puts open(url).read
+	  end
+	end
+
+	h = FECHell.new
+
+	# Grab the year-end fundraising reports by candidates for the 5th district of Virginia. This race was incredibly close and decided by less than 800 votes.
+
+	# fetch Goode for Congress F3, Year End 2008
+	savefile("goode.fec","http://query.nictusa.com/dcdev/posted/392684.fec")
+
+	# fetch Perriello for Congress F3, Year end 2008
+	savefile('perriello.fec',"http://query.nictusa.com/dcdev/posted/401630.fec")
+
+	# extract the financial summary of each campaign. we want total receipts this period and cycle to date, total disbursements this period and cycle to date, 
+	# and the cash position at the beginning and end of this reporting period
+	# note we're using the new FECForm.form_for function that takes any version FECHell parameter hash and returns a full ruby object
+	
+	['goode.fec','perriello.fec'].each do |filename|
+	    fec_version, original_form_type, form_type, values = h.header_lines(filrname)
+		next unless form_type == "F3" && fec_version.to_i >= 3
+		
+		f = FECForm.schedule_for(form_type, fec_version, values)
+		puts "For: #{}"
+	    puts "Total receipts this period: #{values['Column A 24. Total Receipts this Period']}"
+	    puts "Total receipts cycle-to-date: #{values['Column B 16. Total Receipts']}"
+	    puts "Total disbursements this period: #{values['Column A 26. Total Disbursements this Period']}"
+	    puts "Total disbursements cycle-to-date: #{values['Column B 22. Total Disbursements']}"
+	    puts "Cash-on-hand beginning of period: #{values['Column A 23. Cash Beginning Reporting Period']}"
+	    puts "Cash-on-hand end of period:  #{values['Column A 27. Cash on hand at Close Period']}"
+		
+		
+	  h.process(filename) do |v|
+	    schedule = v[0]
+	    values = v[1]
+	    next if schedule != 'F3'
+	    form = FECForm.form_for(form_type)
+	    puts "For '#{values['COMMITTEE NAME']}'"
+    
+    
+	    puts "Total receipts this period: #{values['Column A 24. Total Receipts this Period']}"
+	    puts "Total receipts cycle-to-date: #{values['Column B 16. Total Receipts']}"
+	    puts "Total disbursements this period: #{values['Column A 26. Total Disbursements this Period']}"
+	    puts "Total disbursements cycle-to-date: #{values['Column B 22. Total Disbursements']}"
+	    puts "Cash-on-hand beginning of period: #{values['Column A 23. Cash Beginning Reporting Period']}"
+	    puts "Cash-on-hand end of period:  #{values['Column A 27. Cash on hand at Close Period']}"
+	  puts "\n"
+	  end
+	end
+
+	# From this output we see that Rep Goode outspent Perriello by more than a million dollars, but still lost his seat by 727 votes.
+
+	puts "==="
+
+	# fetch HuckPac F3X, Post General, 2008
+	savefile('huckpac.fec','http://query.nictusa.com/dcdev/posted/407479.fec')
+	# extract disbursements (schedule B) made this period by HuckPAC with the expenditure purpose(key="EXPENDITURE PURPOPOSE DESCRIPTION") of "Payroll"
+	puts "TO,DATE,AMOUNT"
+	h.process("huckpac.fec") do |v|
+	  schedule = v[0]
+	  values = v[1]
+  
+	  next if schedule != 'SB'
+  
+	  next if values['EXPENDITURE PURPOSE DESCRIP'] != 'Payroll'
+  
+	  puts "#{values['PAYEE FIRST NAME']} #{values['PAYEE LAST NAME']},#{values['EXPENDITURE DATE']},#{values['EXPENDITURE AMOUNT']}"
+  
+	end
+
+	# From this we can see that HuckPAC keeps 5 full-time people on staff, including his daughter Sarah. 
+
+
+== Changes
+  0.1.9
+    Massive speedup in form-type detection
+    Dozens of changes to definition files 
+    Several bug-fixes for early format 5.0 files
+    Initial support for V3.0 files (circa early 2000)
+    Added FEC version-independent Form classes that can transform a FECHell hash into an actual class
+    Added monolithic unit test for every file version for the following schedules / forms: F3, SA, SB, SC, SC1
+    
+  0.1.8
+    Prepended "Column A" or "Column B" to forms F3,F3P,F3X,F3Z for all FEC DEF files to accommodate duplicate key names. 
+    Added HDR records to all the FEC DEF files
+	Updated schedule identifier to allow HDR (header) lines to pass through system
+
+  0.1.7 
+    Added support for the FEC header line (schedule=HDR) to format files 5.0-6.4 
+
+  0.1.6 
+    Fixed version numbers in FECHell::Versions
+
+  0.1.5 
+    Fixed optional 'options' parameter to FECHell::process() call
+
+  0.1.4
+    Added support for FEC file 6.4
+    
+  0.1.3
+    Removed extra files from distribution. 
+
+  0.1.2
+    Added fastercsv gem as an install dependency
+
+  0.1.1
+    Added support for version 6.3 FEC files
+
+== Todo
+  Add unit tests for Schedule C v2 (SC2)
+  Add Form class definition for missing form types (F1,F2,F3X,F3P)

data/Rakefile

@@ -0,0 +1,16 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('fechell', '0.1.9') do |p|
+  p.description    = "Parse electronically filed FEC reports."
+  p.url            = "http://offensivepolitics.net/fechell"
+  p.author         = "Jason Holt"
+  p.email          = "jjh@offensivepolitics.net"
+  p.ignore_pattern = ["tmp/*", "script/*", "./Manife*","pkg/*", "doc/*"]
+  p.development_dependencies = []
+  p.rdoc_pattern = ['README.rdoc']
+  p.runtime_dependencies = ['fastercsv']
+end
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }

data/fechell.gemspec

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{fechell}
+  s.version = "0.1.9"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jason Holt"]
+  s.date = %q{2010-03-22}
+  s.description = %q{Parse electronically filed FEC reports.}
+  s.email = %q{jjh@offensivepolitics.net}
+  s.extra_rdoc_files = ["README.rdoc"]
+  s.files = ["fechell.gemspec", "lib/defs/3.00.csv", "lib/defs/5.00.csv", "lib/defs/5.1.csv", "lib/defs/5.2.csv", "lib/defs/5.3.csv", "lib/defs/6.1.csv", "lib/defs/6.2.csv", "lib/defs/6.3.csv", "lib/defs/6.4.csv", "lib/fechell/forms.rb", "lib/fechell.rb", "lib/tests/f3test.rb", "lib/tests/satest.rb", "lib/tests/sbtest.rb", "lib/tests/sc1test.rb", "lib/tests/sctest.rb", "lib/tests/testdata/F3-3.00-32564-SC1.fec", "lib/tests/testdata/F3-3.00-32777.fec", "lib/tests/testdata/F3-3.00-32909-SC.fec", "lib/tests/testdata/F3-3.00-32933-SB.fec", "lib/tests/testdata/F3-3.00-32933.fec", "lib/tests/testdata/F3-5.00-97348.fec", "lib/tests/testdata/F3-5.00-97424-SB.fec", "lib/tests/testdata/F3-5.00-97424-SC.fec", "lib/tests/testdata/F3-5.00-97424.fec", "lib/tests/testdata/F3-5.00-97986-SC1.fec", "lib/tests/testdata/F3-5.1-116177-SC1.fec", "lib/tests/testdata/F3-5.1-116437-SC2.fec", "lib/tests/testdata/F3-5.1-126642.fec", "lib/tests/testdata/F3-5.1-126655-SB.fec", "lib/tests/testdata/F3-5.1-126655-SC.fec", "lib/tests/testdata/F3-5.1-126655.fec", "lib/tests/testdata/F3-5.2-170434.fec", "lib/tests/testdata/F3-5.2-170443.fec", "lib/tests/testdata/F3-5.2-170775-SC.fec", "lib/tests/testdata/F3-5.2-170890-SC.fec", "lib/tests/testdata/F3-5.2-170890.fec", "lib/tests/testdata/F3-5.2-171146-SC1.fec", "lib/tests/testdata/F3-5.2-171146.fec", "lib/tests/testdata/F3-5.3-210119-SB.fec", "lib/tests/testdata/F3-5.3-210119.fec", "lib/tests/testdata/F3-5.3-210142-SC1.fec", "lib/tests/testdata/F3-5.3-210142.fec", "lib/tests/testdata/F3-5.3-210250.fec", "lib/tests/testdata/F3-5.3-212438-SC.fec", "lib/tests/testdata/F3-6.1-331453-SB.fec", "lib/tests/testdata/F3-6.1-331453.fec", "lib/tests/testdata/F3-6.1-332530-SC.fec", "lib/tests/testdata/F3-6.1-332675.fec", "lib/tests/testdata/F3-6.1-333405-SC1.fec", "lib/tests/testdata/F3-6.1-333405.fec", "lib/tests/testdata/F3-6.2-350353-SC.fec", "lib/tests/testdata/F3-6.2-350353.fec", "lib/tests/testdata/F3-6.2-350775-SB.fec", "lib/tests/testdata/F3-6.2-350775.fec", "lib/tests/testdata/F3-6.2-350844-SC1.fec", "lib/tests/testdata/F3-6.2-350844.fec", "lib/tests/testdata/F3-6.3-413014.fec", "lib/tests/testdata/F3-6.3-413060-SC.fec", "lib/tests/testdata/F3-6.3-413226-SB.fec", "lib/tests/testdata/F3-6.3-413226.fec", "lib/tests/testdata/F3-6.3-413284-SC1.fec", "lib/tests/testdata/F3-6.4-420048-SC.fec", "lib/tests/testdata/F3-6.4-420048.fec", "lib/tests/testdata/F3-6.4-420106.fec", "lib/tests/testdata/F3-6.4-423088-SC1.fec", "lib/tests/testdata/F3-6.4-423088.fec", "lib/tests/testdata/F3-6.4-424094.fec", "lib/tests/testdata/F3-6.4-424586-SB.fec", "lib/tests/testdata/F3-6.4-424586.fec", "lib/tests.rb", "Manifest", "Rakefile", "README.rdoc"]
+  s.homepage = %q{http://offensivepolitics.net/fechell}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Fechell", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{fechell}
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Parse electronically filed FEC reports.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<fastercsv>, [">= 0"])
+    else
+      s.add_dependency(%q<fastercsv>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<fastercsv>, [">= 0"])
+  end
+end

data/lib/defs/3.00.csv

@@ -0,0 +1 @@
+HDR;FORM TYPE;FEC TAG;FEC File Version;Filing Software Name;Filing Software Version;Report ID;Report Number

data/lib/defs/5.00.csv

@@ -0,0 +1 @@
+HDR;FORM TYPE;FEC TAG;FEC File Version;Filing Software Name;Filing Software Version;Report ID;Report Number

data/lib/defs/5.1.csv

@@ -0,0 +1 @@
+HDR;FORM TYPE;FEC TAG;FEC File Version;Filing Software Name;Filing Software Version;Report ID;Report Number

data/lib/defs/5.2.csv

@@ -0,0 +1 @@
+HDR;FORM TYPE;FEC TAG;FEC File Version;Filing Software Name;Filing Software Version;Report ID;Report Number

data/lib/defs/5.3.csv

@@ -0,0 +1 @@
+HDR;FORM TYPE;FEC TAG;FEC File Version;Filing Software Name;Filing Software Version;Report ID;Report Number

data/lib/defs/6.1.csv

@@ -0,0 +1 @@
+HDR;FORM TYPE;FEC TAG;FEC File Version;Filing Software Name;Filing Software Version;Report ID;Report Number

data/lib/defs/6.2.csv

@@ -0,0 +1 @@
+HDR;FORM TYPE;FEC TAG;FEC File Version;Filing Software Name;Filing Software Version;Report ID;Report Number

data/lib/defs/6.3.csv

@@ -0,0 +1 @@
+HDR;FORM TYPE;FEC TAG;FEC File Version;Filing Software Name;Filing Software Version;Report ID;Report Number

data/lib/defs/6.4.csv

@@ -0,0 +1 @@
+HDR;FORM TYPE;FEC TAG;FEC File Version;Filing Software Name;Filing Software Version;Report ID;Report Number