campaign_cash 0.0.5 → 1.0

data/README.rdoc

@@ -23,9 +23,9 @@ You'll want to set your API key as an environment variable in order to run the t
 Currently there are methods to support retrieving candidates and committees, and every method requires at least one parameter,
 the election cycle. Some examples (provided you've done include CampaignCash):
 
-  Candidate.find_by_fecid(2010,"H4NY07011")  # find Gary Ackerman's details for the 2010 cycle
-  Committee.search(2010, "Growth") # find all committees in the 2010 cycle with the word 'Growth' in the name.
-  Candidate.search(2010, "Udall") # find all candidates in the 2010 cycle with the name 'Udall'
+  Candidate.find("H4NY07011", 2010)  # find Gary Ackerman's details for the 2010 cycle
+  Committee.search("Growth", 2010) # find all committees in the 2010 cycle with the word 'Growth' in the name.
+  Candidate.search("Udall", 2010) # find all candidates in the 2010 cycle with the name 'Udall'
 
 Check out the tests for further examples.
 

data/lib/campaign_cash/base.rb

@@ -9,7 +9,7 @@ module CampaignCash
   	API_VERSION = 'v3'
   	API_NAME = 'elections/us'
   	API_BASE = "/svc/#{API_NAME}/#{API_VERSION}/finances"
-  	CURRENT_CYCLE = 2010
+  	CURRENT_CYCLE = 2012
 
   	@@api_key = nil
   	@@copyright = nil

data/lib/campaign_cash/candidate.rb

@@ -14,7 +14,7 @@ module CampaignCash
       end
     end
     
-		def self.create_from_api(params={})
+		def self.create(params={})
 			self.new :name => params['name'],
 							 :id => params['id'],
 							 :state => params['state'],
@@ -41,7 +41,7 @@ module CampaignCash
 							 :date_coverage_to => params['date_coverage_to'] 
 		end
 		
-		def self.create_from_api_search_results(params={})
+		def self.create_from_search_results(params={})
 		  self.new :name => params['candidate']['name'],
 		           :id => params['candidate']['id'],
 		           :state => params['state'],
@@ -55,32 +55,32 @@ module CampaignCash
     def self.find(fecid, cycle=CURRENT_CYCLE)
 			reply = invoke("#{cycle}/candidates/#{fecid}")
 			result = reply['results']
-			self.create_from_api(result.first) if result.first
+			self.create(result.first) if result.first
     end
     
     def self.leaders(category, cycle=CURRENT_CYCLE)
 			reply = invoke("#{cycle}/candidates/leaders/#{category}",{})
 			results = reply['results']
-      results.map{|c| self.create_from_api(c)}
+      results.map{|c| self.create(c)}
     end
     
     def self.search(name, cycle=CURRENT_CYCLE)
 			reply = invoke("#{cycle}/candidates/search", {:query => name})
 			results = reply['results']      
-      results.map{|c| self.create_from_api_search_results(c)}
+      results.map{|c| self.create_from_search_results(c)}
     end
     
     def self.new_candidates(cycle=CURRENT_CYCLE)
 			reply = invoke("#{cycle}/candidates/new",{})
 			results = reply['results']      
-      results.map{|c| self.create_from_api(c)}      
+      results.map{|c| self.create(c)}      
     end
     
     def self.state_chamber(state, chamber, district=nil, cycle=CURRENT_CYCLE)
       district ? path = "#{cycle}/seats/#{state}/#{chamber}/#{district}" : path = "#{cycle}/seats/#{state}/#{chamber}"
 			reply = invoke(path,{})
 			results = reply['results']
-      results.map{|c| self.create_from_api_search_results(c)}      
+      results.map{|c| self.create_from_search_results(c)}      
     end
     
   end

data/lib/campaign_cash/committee.rb

@@ -14,7 +14,7 @@ module CampaignCash
       end
     end
     
-		def self.create_from_api(params={})
+		def self.create(params={})
 			self.new :name => params['name'],
 							 :id => params['id'],
 							 :state => params['state'],
@@ -38,7 +38,7 @@ module CampaignCash
 							 :candidate => params['candidate']
 		end
 		
-		def self.create_from_api_search_results(params={})
+		def self.create_from_search_results(params={})
 		  self.new :name => params['name'],
 		           :id => params['id'],
 		           :city => params['city'],

data/lib/campaign_cash/contribution.rb

@@ -0,0 +1,26 @@
+module CampaignCash
+  class Contribution < Base
+    
+    attr_reader :date, :candidate_uri, :primary_general, :amount, :state, :name, :image_uri, :party, :district
+    
+    def initialize(params={})
+      params.each_pair do |k,v|
+        instance_variable_set("@#{k}", v)
+      end
+    end
+    
+		def self.create(cycle, committee, params={}, candidate = params['candidate'])
+		  self.new :date => date_parser(params[:date]),
+		           :candidate_uri => candidate,
+		           :committee_uri => committee,
+		           :primary_general => params[:primary_general],
+		           :amount => params[:amount],
+		           :state => params[:state],
+		           :name => params[:name],
+		           :image_uri => params[:image_uri],
+		           :party => params[:party],
+		           :district => params[:district],
+		           :cycle => cycle
+		end
+  end
+end

data/lib/campaign_cash/filing.rb

@@ -1,7 +1,7 @@
 module CampaignCash
   class Filing < Base
     
-    attr_reader :committee_name, :date_coverage_from, :amended_uri, :fec_uri, :date_coverage_to, :committee, :report_title, :amended
+    attr_reader :committee_name, :date_coverage_from, :amended_uri, :fec_uri, :date_coverage_to, :committee, :report_title, :amended, :date_filed, :cycle, :form_type
     
     def initialize(params={})
       params.each_pair do |k,v|
@@ -9,30 +9,50 @@ module CampaignCash
       end
     end
     
-		def self.create_from_api(params={})
+		def self.create(params={})
 			self.new :committee_name => params['committee_name'],
 							 :date_coverage_from => date_parser(params['date_coverage_from']),
 							 :date_coverage_to => date_parser(params['date_coverage_to']),
 							 :committee => params['committee'],
-							 :report_title => params['report_title'],
+							 :report_title => params['report_title'].strip,
 							 :fec_uri => params['fec_uri'],
 							 :amended => params['amended'],
-							 :amended_uri => params['amended_uri']
+							 :amended_uri => params['amended_uri'],
+							 :form_type => params['form_type']
 		end
 		
+		def self.create_from_filings(params={})
+			self.new :date_coverage_from => date_parser(params['date_coverage_from']),
+							 :date_coverage_to => date_parser(params['date_coverage_to']),
+							 :report_title => params['report_title'].strip,
+							 :fec_uri => params['fec_uri'],
+							 :amended => params['amended'],
+							 :amended_uri => params['amended_uri'],
+							 :cycle => params['cycle'],
+							 :form_type => params['form_type'],
+							 :date_filed => date_parser(params['date_filed'])
+		end
+		
+		
 		def self.today
 		  cycle=CURRENT_CYCLE
 		  reply = Base.invoke("#{cycle}/filings", {})
 		  results = reply['results']
-			@filings = results.map{|c| Filing.create_from_api(c)}
+			@filings = results.map{|c| Filing.create(c)}
 		end
 		
 		def self.date(year, month, day)
 		  cycle = cycle_from_date(Date.parse("#{month}/#{day}/#{year}"))
 		  reply = Base.invoke("#{cycle}/filings/#{year}/#{month}/#{day}", {})
 		  results = reply['results']
-			@filings = results.map{|c| Filing.create_from_api(c)}
+			@filings = results.map{|c| Filing.create(c)}
 		end
 		
-  end
+		def self.by_type(cycle, form_type)
+		  cycle = cycle
+		  reply = Base.invoke("#{cycle}/filings/types/#{form_type}")
+		  results = reply['results']
+			@filings = results.map{|c| Filing.create(c)}
+		end
+	end
 end

data/lib/campaign_cash/form.rb

@@ -0,0 +1,24 @@
+module CampaignCash
+  class Form < Base
+    
+    attr_reader :id, :name
+    
+    def initialize(params={})
+      params.each_pair do |k,v|
+        instance_variable_set("@#{k}", v)
+      end
+    end
+    
+    def self.create(params={})
+      self.new :id => params['id'],
+               :name => params['name']
+    end
+    
+    def self.form_types
+      reply = Base.invoke("#{Base::CURRENT_CYCLE}/filings/types")
+      results = reply['results']
+      @forms = results.map{|c| Form.create(c)}
+    end
+    
+  end
+end

data/lib/campaign_cash/version.rb

@@ -1,3 +1,3 @@
 module CampaignCash
-  VERSION = "0.0.5"
+  VERSION = "1.0"
 end

data/lib/campaign_cash.rb

@@ -4,5 +4,7 @@ $:.unshift(File.dirname(__FILE__)) unless
 require "campaign_cash/base"
 require "campaign_cash/candidate"
 require "campaign_cash/committee"
+require "campaign_cash/contribution"
 require "campaign_cash/filing"
+require "campaign_cash/form"
 require "campaign_cash/version"

data/test/campaign_cash/test_candidate.rb

@@ -3,11 +3,11 @@ require File.dirname(__FILE__) + '/../test_helper.rb'
 class TestCampaignCash::TestCandidate < Test::Unit::TestCase
 	include CampaignCash
 	
-	context "Candidate.create_from_api" do
+	context "Candidate.create" do
 		setup do
 		  reply = Base.invoke('2010/candidates/H4NY07011', {})
 			@result = reply['results'].first
-			@candidate = Candidate.create_from_api(@result)
+			@candidate = Candidate.create(@result)
 		end
 		
 		should "return an object of the Candidate type" do
@@ -25,7 +25,7 @@ class TestCampaignCash::TestCandidate < Test::Unit::TestCase
 	  setup do
 		  reply = Base.invoke('2010/candidates/search', {:query => "Udall"})
 			results = reply['results']
-	    @candidates = results.map{|c| Candidate.create_from_api_search_results(c)}
+	    @candidates = results.map{|c| Candidate.create_from_search_results(c)}
 	  end
 	  
 	  should "return two candidate objects" do
@@ -39,7 +39,7 @@ class TestCampaignCash::TestCandidate < Test::Unit::TestCase
 	  setup do
 		  reply = Base.invoke('2010/candidates/new', {})
 			results = reply['results']
-	    @candidates = results.map{|c| Candidate.create_from_api(c)}
+	    @candidates = results.map{|c| Candidate.create(c)}
 	  end
 	  
 	  should "return 20 new candidates" do
@@ -53,7 +53,7 @@ class TestCampaignCash::TestCandidate < Test::Unit::TestCase
 	  setup do
 		  reply = Base.invoke('2010/candidates/leaders/end_cash', {})
 			results = reply['results']
-	    @candidates = results.map{|c| Candidate.create_from_api(c)}
+	    @candidates = results.map{|c| Candidate.create(c)}
 	  end
 	  
 	  should "return 20 candidates each with a greater end_cash value than the next" do

data/test/campaign_cash/test_committee.rb

@@ -7,7 +7,7 @@ class TestCampaignCash::TestCommittee < Test::Unit::TestCase
 		setup do
 		  reply = Base.invoke('2010/committees/C00312223', {})
 			@result = reply['results'].first
-			@committee = Committee.create_from_api(@result)
+			@committee = Committee.create(@result)
 		end
 		
 		should "return an object of the Committee type" do
@@ -25,7 +25,7 @@ class TestCampaignCash::TestCommittee < Test::Unit::TestCase
 	  setup do
 		  reply = Base.invoke('2010/committees/search', {:query => "Boeing"})
 			results = reply['results']
-	    @committees = results.map{|c| Committee.create_from_api_search_results(c)}
+	    @committees = results.map{|c| Committee.create_from_search_results(c)}
 	  end
 	  
 	  should "return two committee objects" do
@@ -39,7 +39,7 @@ class TestCampaignCash::TestCommittee < Test::Unit::TestCase
 	  setup do
 		  reply = Base.invoke('2010/committees/new', {})
 			results = reply['results']
-	    @committees = results.map{|c| Committee.create_from_api_search_results(c)}
+	    @committees = results.map{|c| Committee.create_from_search_results(c)}
 	  end
 	  
 	  should "return 20 new committees" do
@@ -56,4 +56,48 @@ class TestCampaignCash::TestCommittee < Test::Unit::TestCase
 	    end
 	  end
 	end
+	
+	context "committee filings" do
+	  setup do
+	    reply = Base.invoke('2010/committees/C00312223/filings', {})
+	    results = reply['results']
+	    @filings = results.map{|f| Filing.create_from_filings(f)}
+	  end
+	  
+	  should "return 10 filings" do
+	    assert_equal @filings.size, 10
+	  end
+	end
+	
+	context "committee contributions" do
+	  setup do
+	    reply = Base.invoke('2010/committees/C00458588/contributions', {})
+	    results = reply['results']
+	    @committee = reply['committee']
+	    @num_records = reply['total_results']
+	    @total_amount = reply['total_amount']
+	    @contributions = results.map{|c| Contribution.create(@committee, c)}
+	  end
+	  
+	  should "return 125 total results" do
+	    assert_equal @num_records, 125
+	  end
+	end
+	
+	context "committee contributions to a candidate" do
+	  setup do
+	    reply = Base.invoke('2010/committees/C00458588/contributions/candidates/H0NC02059', {})
+	    results = reply['results']
+	    @cycle = reply['cycle']
+	    @committee = reply['committee']
+	    @candidate = reply['candidate']
+	    @total_amount = reply['total_amount']
+	    @contributions = results.map{|c| Contribution.create(@cycle, @committee, c, @candidate)}
+	  end
+	  
+	  should "return 2 results totaling $10,000" do
+	    assert_equal @contributions.size, 2
+	    assert_equal @total_amount, 10000
+	  end
+	end
 end

data/test/campaign_cash/test_filing.rb

@@ -24,4 +24,14 @@ class TestCampaignCash::TestFiling < Test::Unit::TestCase
 		end
 	end
 	
+	context "recent statements of organization" do
+	  setup do
+	    @filings = Filing.by_type(2012, "F1")
+	  end
+	  
+	  should "return a list of the 20 most recent Filings that are statements of organization" do
+	    assert_equal @filings.size, 20
+	    assert_equal @filings.first.report_title, "STATEMENT OF ORGANIZATION"
+	  end
+	end
 end

data/test/campaign_cash/test_form.rb

@@ -0,0 +1,15 @@
+require File.dirname(__FILE__) + '/../test_helper.rb'
+
+class TestCampaignCash::TestForm < Test::Unit::TestCase
+	include CampaignCash
+		
+	context "form types" do
+	  setup do
+			@forms = Form.form_types
+	  end
+	  
+		should "return a list of objects of the Filing type" do
+			assert_kind_of(Form, @forms.first)
+		end
+	end
+end

data/test/test_helper.rb

@@ -8,7 +8,9 @@ require File.dirname(__FILE__) + '/../lib/campaign_cash'
 require File.dirname(__FILE__) + '/../lib/campaign_cash/base'
 require File.dirname(__FILE__) + '/../lib/campaign_cash/candidate'
 require File.dirname(__FILE__) + '/../lib/campaign_cash/committee'
+require File.dirname(__FILE__) + '/../lib/campaign_cash/contribution'
 require File.dirname(__FILE__) + '/../lib/campaign_cash/filing'
+require File.dirname(__FILE__) + '/../lib/campaign_cash/form'
 
 # set your NYT Campaign Finance API key as an environment variable to run the tests
 API_KEY = ENV['NYT_CAMPFIN_API_KEY']

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: campaign_cash
 version: !ruby/object:Gem::Version 
-  hash: 21
-  prerelease: false
+  hash: 15
+  prerelease: 
   segments: 
+  - 1
   - 0
-  - 0
-  - 5
-  version: 0.0.5
+  version: "1.0"
 platform: ruby
 authors: 
 - Derek Willis
@@ -15,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-23 00:00:00 -05:00
+date: 2011-02-11 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -67,11 +66,14 @@ files:
 - lib/campaign_cash/base.rb
 - lib/campaign_cash/candidate.rb
 - lib/campaign_cash/committee.rb
+- lib/campaign_cash/contribution.rb
 - lib/campaign_cash/filing.rb
+- lib/campaign_cash/form.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_form.rb
 - test/test_helper.rb
 has_rdoc: true
 homepage: http://rubygems.org/gems/campaign_cash
@@ -105,7 +107,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: campaign_cash
-rubygems_version: 1.3.7
+rubygems_version: 1.4.1
 signing_key: 
 specification_version: 3
 summary: Following the money.