campaign_cash 2.0.8 → 2.1.0

data/.gitignore

@@ -1,3 +1,4 @@
 pkg/*
 *.gem
 .bundle
+*nyt_api_key.rb

data/README.rdoc

@@ -12,11 +12,11 @@ Simple ruby wrapper for The New York Times Campaign Finance API[http://developer
 
 == News
 
+* Feb. 8, 2012: Version 2.1.0 released. Added better support for independent expenditures and FilingSummary class for presidential candidate filings.
+* Jan. 28, 2012: Version 2.0.8 released. Bugfix for Candidate#search. Thanks to @benjaminjackson for patch.
 * Jan. 24, 2012: Version 2.0.7 released. Added candidate_name attribute accessor to IndependentExpenditure objects.
 * Jan. 19, 2012: Version 2.0.6 released. Added transaction_id param to IndependentExpenditure objects.
 * Jan. 19, 2012: Version 2.0.5 released. Bugfix to add amendment param to IndependentExpenditure objects.
-* Jan. 18, 2012: Version 2.0.4 released. Bugfix to handle offsets better.
-* Jan. 14, 2012: Version 2.0.3 released. Bugfix so that President.detail returns 1 object, not an array.
 
 == INSTALL:
 
@@ -203,6 +203,7 @@ The IE responses also accept an optional offset argument, using multiples of 20.
 * Derek Willis, dwillis@nytimes.com
 * Al Shaw, almshaw@gmail.com
 * Jason Holt, jjh@offensivepolitics.net
+* Benjamin Jackson, http://twitter.com/benjaminjackson
 
 == Copyright
 

data/lib/campaign_cash.rb

@@ -1,3 +1,3 @@
-%w(base candidate committee contribution filing form independent_expenditure president).each do |f|
+%w(base candidate committee contribution individual_contribution filing filing_summary form independent_expenditure president).each do |f|
   require File.join(File.dirname(__FILE__), '../lib/campaign_cash', f)
 end

data/lib/campaign_cash/contribution.rb

@@ -52,7 +52,6 @@ module CampaignCash
         reply = invoke("#{cycle}/committees/#{fecid}/contributions")
         all_candidates(reply)
       end
-    end
-    
+    end    
   end
 end

data/lib/campaign_cash/filing.rb

@@ -59,7 +59,6 @@ module CampaignCash
 		end
 		
 		def self.by_type(cycle, form_type)
-		  cycle = cycle
 		  reply = Base.invoke("#{cycle}/filings/types/#{form_type}")
 		  results = reply['results']
 			results.map{|c| Filing.create(c)}

data/lib/campaign_cash/filing_summary.rb

@@ -0,0 +1,23 @@
+module CampaignCash
+  class FilingSummary < Base
+    
+    attr_reader :pac_contributions_period, :contributions_2300, :party_contributions_cycle, :fundraising_offsets_period, :primary_general, :pac_refunds_cycle, :created_at, :party_refunds_cycle, :fundraising_expenses_period, :net_party_contributions, :num_contributions_200_499, :individual_refunds_cycle, :candidate_contributions_period, :legal_offsets_cycle, :num_contributions_500_1499, :net_operating_expenses, :total_debts_owed, :refunds_200_499, :refunds_1500_2299, :transfers_out_period, :net_primary, :liquidate_period, :contributions_200_499, :operating_offsets_cycle, :num_contributions_1500_2299, :candidate_loan_repayments_period, :committee_uri, :federal_funds_cycle, :net_candidate_contributions, :candidate_loans_period, :filing_id, :net_pac_contributions, :num_refunds_200_499, :candidate_loan_repayments_cycle, :total_offsets_cycle, :party_contributions_period, :net_individual_contributions, :num_refunds_1500_2299, :net_general, :total_receipts_cycle, :federal_funds_period, :transfers_out_cycle, :cycle, :other_loan_repayments_period, :contributions_500_1499, :legal_offsets_period, :date_coverage_from, :contributions_less_than_200, :fec_form_type, :candidate_contributions_cycle, :cash_on_hand_beginning, :individual_refunds_period, :updated_at, :fundraising_expenses_cycle, :num_refunds_500_1499, :cash_on_hand_close, :num_contributions_less_than_200, :total_loans_cycle, :candidate_uri, :contributions_1500_2299, :refunds_2300, :flag_most_current_report, :total_loan_repayments_period, :other_loans_period, :operating_expenditures_cycle, :other_disbursements_period, :total_loans_period, :transfers_in_period, :transfers_in_cycle, :report, :legal_expenses_period, :candidate_loans_cycle, :individual_contributions_period, :other_disbursements_cycle, :total_disbursements_period, :other_loans_cycle, :net_transfers_in, :net_disbursements, :operating_expenditures_period, :fundraising_offsets_cycle, :date_coverage_to, :total_loan_repayments_cycle, :total_disbursements_cycle, :party_refunds_period, :individual_contributions_cycle, :net_total_contributions, :other_loan_repayments_cycle, :total_refunds_cycle, :total_receipts_period, :total_offsets_period, :total_contributions_period, :total_contributions_cycle, :refunds_500_1499, :pac_refunds_period, :flag_valid_report, :legal_expenses_cycle, :num_refunds_less_than_200, :refunds_less_than_200, :pac_contributions_cycle, :net_legal_expenses, :net_fundraising_expenses, :num_contributions_2300, :total_refunds_period, :operating_offsets_period, :num_refunds_2300
+    
+    def initialize(params={})
+      params.each_pair do |k,v|
+        instance_variable_set("@#{k}", v)
+      end
+    end
+    
+		def self.create(params={})
+			self.new(params)
+		end
+		
+		def self.by_id(id)
+      cycle = CURRENT_CYCLE
+      result = FilingSummary.create(Base.invoke("#{cycle}/filings/#{id}")["results"]["filing_summary"])
+    end
+  end
+end
+
+

data/lib/campaign_cash/independent_expenditure.rb

@@ -14,7 +14,7 @@ module CampaignCash
                :committee_name => params['fec_committee_name'],
                :candidate => parse_candidate(params['fec_candidate']),
                :office => params['office'],
-               :state => params['state'].strip,
+               :state => params['state'] ? params['state'].strip : nil,
                :district => params['district'],
                :date => date_parser(params['date']),
                :support_or_oppose => params['support_or_oppose'],
@@ -25,7 +25,9 @@ module CampaignCash
                :date_received => date_parser(params['date_received']),
                :amendment => params['amendment'],
                :transaction_id => params['transaction_id'],
-               :candidate_name => params['candidate_name']
+               :candidate_name => params['candidate_name'],
+               # hash is a SHA1 of committee_id, date and transaction_id
+               :hash => params['hash']
     end
     
     def self.latest(offset=nil)

data/lib/campaign_cash/individual_contribution.rb

@@ -0,0 +1,35 @@
+module CampaignCash
+  class IndividualContribution < Base
+    
+    attr_reader :zip5, :system_code, :occupation, :conduit_zip, :conduit_address_two, :city, :zip, :increased_limit, :donor_candidate, :conduit_name, :conduit_city, :prefix, :memo_text, :back_ref_tran_id, :aggregate_amount, :filing_id, :donor_office, :back_ref_sched_name, :address_two, :pac_name, :exclude, :conduit_address_one, :amount, :transaction_type, :lng, :flag_orgind, :date, :fec_form_type, :donor_state, :donor_cand_id, :last_name, :full_name, :employer, :donor_district, :conduit_state, :address_one, :tran_id, :suffix, :donor_cmte_id, :display_name, :transaction_description, :prigen, :memo_code, :linenumber, :lat, :amended_cd, :state, :middle_name, :first_name
+    
+    def initialize(params={})
+      params.each_pair do |k,v|
+        instance_variable_set("@#{k}", v)
+      end
+    end
+    
+    def self.create(params={})
+      self.new(params)
+    end
+    
+    def self.committee(fecid, offset=nil)
+      cycle = CURRENT_CYCLE
+      results = invoke("#{cycle}/contributions/committee/#{fecid}", {:offset => offset})['results']
+      results.map{|c| IndividualContribution.create(c["contribution"]) }
+    end
+    
+    def self.filing(form_id, offset=nil)
+      cycle = CURRENT_CYCLE
+      results = invoke("#{cycle}/contributions/filing/#{form_id}", {:offset => offset})['results']
+      results.map{|c| IndividualContribution.create(c["contribution"]) }
+    end
+    
+    def self.candidate(fecid, offset=nil)
+      cycle = CURRENT_CYCLE
+      results = invoke("#{cycle}/contributions/candidate/#{fecid}", {:offset => offset})['results']
+      results.map{|c| IndividualContribution.create(c["contribution"]) }
+    end
+    
+  end
+end

data/lib/campaign_cash/president.rb

@@ -1,23 +1,24 @@
 module CampaignCash
   class President < Base
-      
-    attr_reader :committee_id, :name, :id, :party, :date_coverage_from, :date_coverage_to, :total_receipts, :total_disbursements,
-                :end_cash, :total_refunds, :total_contributions, :net_individual_contributions, :net_pac_contributions, 
+
+    attr_reader :committee_id, :name, :id, :party, :office, :date_coverage_from, :date_coverage_to, :total_receipts, :total_disbursements,
+                :end_cash, :total_refunds, :total_contributions, :net_individual_contributions, :net_pac_contributions,
                 :net_party_contributions, :net_candidate_contributions, :net_primary_contributions, :net_general_contributions,
                 :federal_funds, :contributions_less_than_200, :contributions_200_499, :contributions_500_1499, :contributions_1500_2499,
                 :contributions_max
-      
+
     def initialize(params={})
       params.each_pair do |k,v|
         instance_variable_set("@#{k}", v)
       end
     end
-    
+
     # Creates a new president summary object from a JSON API presidential response.
 		def self.create_summary(params={})
 			self.new :name => params['name'],
 							 :id => params['candidate_id'],
-							 :party => params['party'],
+               :party => get_party(params['party']),
+							 :office => 'president',
 							 :committee_id => params['committee_id'],
 							 :total_receipts => params['total_receipts'],
 							 :total_disbursements => params['total_disbursements'],
@@ -25,12 +26,13 @@ module CampaignCash
 							 :date_coverage_from => params['date_coverage_from'],
 							 :date_coverage_to => params['date_coverage_to']
 		end
-		
+
 		# Creates a detailed president object
 		def self.create_detail(params={})
 			self.new :name => params['candidate_name'],
 							 :id => params['candidate_id'],
-							 :party => params['party'],
+               :party => get_party(params['party']),
+							 :office => 'president',
 							 :committee_id => params['committee_id'],
 							 :total_receipts => params['total_receipts'],
 							 :total_contributions => params['total_contributions'],
@@ -39,20 +41,20 @@ module CampaignCash
 							 :date_coverage_from => params['date_coverage_from'],
 							 :date_coverage_to => params['date_coverage_to'],
 						   :total_refunds => params['total_refunds'],
-						   :net_individual_contributions => params['net_individual_contributions'], 
-						   :net_pac_contributions => params['net_pac_contributions'], 
-               :net_party_contributions => params['net_party_contributions'], 
-               :net_candidate_contributions => params['net_candidate_contributions'], 
-               :net_primary_contributions => params['net_primary_contributions'], 
+						   :net_individual_contributions => params['net_individual_contributions'],
+						   :net_pac_contributions => params['net_pac_contributions'],
+               :net_party_contributions => params['net_party_contributions'],
+               :net_candidate_contributions => params['net_candidate_contributions'],
+               :net_primary_contributions => params['net_primary_contributions'],
                :net_general_contributions => params['net_general_contributions'],
-               :federal_funds => params['federal_funds'], 
-               :contributions_less_than_200 => params['total_contributions_less_than_200'], 
-               :contributions_200_499 => params['contributions_200_499'], 
-               :contributions_500_1499 => params['contributions_500_1499'], 
+               :federal_funds => params['federal_funds'],
+               :contributions_less_than_200 => params['total_contributions_less_than_200'],
+               :contributions_200_499 => params['contributions_200_499'],
+               :contributions_500_1499 => params['contributions_500_1499'],
                :contributions_1500_2499 => params['contributions_1500_2499'],
                :contributions_max => params['total_contributions_max']
 		end
-    
+
     # Returns an array of presidential candidates for a given cycle, defaults to the current cycle.
     # Only returns candidates that The New York Times is tracking for financial activity.
     def self.summary(cycle=CURRENT_CYCLE)
@@ -60,7 +62,7 @@ module CampaignCash
       results = reply['results']
       results.map{|c| self.create_summary(c)}
     end
-    
+
     # Returns a President object for a given presidential candidate in a given cycle, defaults to the current cycle.
     # Only returns candidates tracked by The New York Times.
     def self.detail(id, cycle=CURRENT_CYCLE)
@@ -68,5 +70,13 @@ module CampaignCash
       results = reply['results'].first
       create_detail(results)
     end
+
+    private
+
+    def self.get_party party_identifier
+       return "DEM" if party_identifier == "D"
+       return "REP" if party_identifier == "R"
+       party_identifier
+    end
   end
 end

data/lib/campaign_cash/version.rb

@@ -1,3 +1,3 @@
 module CampaignCash
-  VERSION = "2.0.8"
+  VERSION = "2.1.0"
 end

data/test/campaign_cash/test_filing.rb

@@ -37,5 +37,5 @@ class TestCampaignCash::TestFiling < Test::Unit::TestCase
 	    assert_equal @filings.size, 20
 	    assert_equal @filings.first.report_title, "STATEMENT OF ORGANIZATION"
 	  end
-	end
+	end	
 end

data/test/campaign_cash/test_filing_summary.rb

@@ -0,0 +1,14 @@
+require 'test_helper'
+
+class TestCampaignCash::TestFilingSummary < Test::Unit::TestCase
+	include CampaignCash
+	
+	context "filing summaries" do
+	  setup do
+	    @filing_summary = FilingSummary.by_id(751678)
+    end
+    should "get a filing by form id" do
+      assert_kind_of(FilingSummary, @filing_summary)
+    end
+  end	
+end

data/test/campaign_cash/test_individual_contribution.rb

@@ -0,0 +1,22 @@
+require 'test_helper'
+
+class TestCampaignCash::TestIndividualContribution < Test::Unit::TestCase
+	include CampaignCash
+  
+	context "get contributions" do
+	  objs_collection = []
+	  objs_collection << IndividualContribution.committee("C00496497")
+	  objs_collection << IndividualContribution.filing("724196")
+	  objs_collection << IndividualContribution.candidate("P80003353")
+	  
+	  objs_collection.each do |objs|
+	    should "return a list of objects of the IndividualContribution type or an empty list" do
+  		  if objs.size > 0
+  			  assert_kind_of(IndividualContribution, objs.first)
+  			else
+  			  assert_equal([], objs)
+  			end
+  		end
+    end
+  end  	
+end

data/test/campaign_cash/test_president.rb

@@ -2,7 +2,7 @@ require 'test_helper'
 
 class TestCampaignCash::TestPresident < Test::Unit::TestCase
 	include CampaignCash
-	
+
 	context "President.summary" do
 		setup do
 		  reply = Base.invoke('2012/president/totals', {})
@@ -10,33 +10,56 @@ class TestCampaignCash::TestPresident < Test::Unit::TestCase
 			@summaries = @results.map{|r| President.create_summary(r)}
 			@summary = @summaries.first
 		end
-		
+
 		should "return an array of objects of the President type" do
 			assert_kind_of(President, @summary)
 		end
-		
-		%w(name total_contributions party total_receipts).each do |attr|
+
+		%w(name total_contributions total_receipts).each do |attr|
 			should "assign the value of the @#{attr} attribute from the '#{attr}' key in the hash" do
 				assert_equal(@results.first[attr], @summary.send(attr))
 			end
 		end
+
+		should "assign the office to 'president'" do
+			assert_equal('president', @summary.office)
+		end
+
+		should "assign the party to 'REP' if the candidate is republican or 'DEM' if democrat" do
+		    party = @results.first['party']
+		    party = "REP" if party == "R"
+		    party = "DEM" if party == "D"
+		    assert_equal(party, @summary.party)
+		end
+
   end
-  
+
 	context "President.detail" do
 		setup do
 		  reply = Base.invoke('2012/president/candidates/C00496034', {})
 			@results = reply['results']
 			@detail = President.create_detail(@results.first)
 		end
-		
+
 		should "return an array of objects of the President type" do
 			assert_kind_of(President, @detail)
 		end
-		
-		%w(net_primary_contributions party total_refunds).each do |attr|
+
+		%w(net_primary_contributions total_refunds).each do |attr|
 			should "assign the value of the @#{attr} attribute from the '#{attr}' key in the hash" do
 				assert_equal(@results.first[attr], @detail.send(attr))
 			end
 		end
-  end
+
+		should "assign the office to 'president'" do
+			assert_equal('president', @detail.office)
+		end
+
+		should "assign the party to 'REP' if the candidate is republican or 'DEM' if democrat" do
+		    party = @results.first['party']
+		    party = "REP" if party == "R"
+		    party = "DEM" if party == "D"
+		    assert_equal(party, @detail.party)
+		end
+    end
 end

data/test/test_helper.rb

@@ -4,7 +4,7 @@ require 'shoulda'
 require 'json'
 require 'ostruct'
 
-%w(base candidate committee contribution filing form independent_expenditure president).each do |f|
+%w(base candidate committee contribution individual_contribution filing filing_summary form independent_expenditure president).each do |f|
   require File.join(File.dirname(__FILE__), '../lib/campaign_cash', f)
 end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: campaign_cash
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 11
   prerelease: 
   segments: 
   - 2
+  - 1
   - 0
-  - 8
-  version: 2.0.8
+  version: 2.1.0
 platform: ruby
 authors: 
 - Derek Willis
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-01-28 00:00:00 -05:00
+date: 2012-02-08 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -101,15 +101,19 @@ files:
 - lib/campaign_cash/committee.rb
 - lib/campaign_cash/contribution.rb
 - lib/campaign_cash/filing.rb
+- lib/campaign_cash/filing_summary.rb
 - lib/campaign_cash/form.rb
 - lib/campaign_cash/independent_expenditure.rb
+- lib/campaign_cash/individual_contribution.rb
 - lib/campaign_cash/president.rb
 - lib/campaign_cash/version.rb
 - test/campaign_cash/test_candidate.rb
 - test/campaign_cash/test_committee.rb
 - test/campaign_cash/test_filing.rb
+- test/campaign_cash/test_filing_summary.rb
 - test/campaign_cash/test_form.rb
 - test/campaign_cash/test_independent_expenditure.rb
+- test/campaign_cash/test_individual_contribution.rb
 - test/campaign_cash/test_president.rb
 - test/test_helper.rb
 has_rdoc: true
@@ -152,7 +156,9 @@ test_files:
 - test/campaign_cash/test_candidate.rb
 - test/campaign_cash/test_committee.rb
 - test/campaign_cash/test_filing.rb
+- test/campaign_cash/test_filing_summary.rb
 - test/campaign_cash/test_form.rb
 - test/campaign_cash/test_independent_expenditure.rb
+- test/campaign_cash/test_individual_contribution.rb
 - test/campaign_cash/test_president.rb
 - test/test_helper.rb