campaign_cash 1.0 → 1.1

data/lib/campaign_cash.rb

@@ -1,10 +1,15 @@
+# A Ruby wrapper for [The New York Times Campaign Finance API](http://developer.nytimes.com/docs/read/campaign_finance_api).
+
 $:.unshift(File.dirname(__FILE__)) unless
   $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
 
 require "campaign_cash/base"
+# [Candidate methods](candidate.html)
 require "campaign_cash/candidate"
+# [Committee methods](committee.html)
 require "campaign_cash/committee"
-require "campaign_cash/contribution"
+# [Filing methods](filing.html)
 require "campaign_cash/filing"
+require "campaign_cash/contribution"
 require "campaign_cash/form"
 require "campaign_cash/version"

data/lib/campaign_cash/base.rb

@@ -44,6 +44,7 @@ module CampaignCash
   		  date ? Date.parse(date) : nil
   		end
   		
+  		# Returns the election cycle (even-numbered) from a date.
   		def cycle_from_date(date=Date.today)
   		  date.year.even? ? date.year : date.year+1
   		end

data/lib/campaign_cash/candidate.rb

@@ -1,6 +1,9 @@
 module CampaignCash
   class Candidate < Base
     
+    # Represents a candidate object based on the FEC's candidate and candidate summary files.
+    # A candidate is a person seeking a particular office within a particular two-year election
+    # cycle. Each candidate is assigned a unique ID within a cycle.
     attr_reader :name, :id, :state, :district, :party, :fec_uri, :committee, 
                 :mailing_city, :mailing_address, :mailing_state, :mailing_zip,
                 :total_receipts, :total_contributions, :total_from_individuals, 
@@ -14,6 +17,7 @@ module CampaignCash
       end
     end
     
+    # Creates a new candidate object from a JSON API response.
 		def self.create(params={})
 			self.new :name => params['name'],
 							 :id => params['id'],
@@ -51,31 +55,42 @@ module CampaignCash
 		           :committee => params['committee']
 		  
 		end
-
+		
+		# Retrieve a candidate object via its FEC candidate id within a cycle.
+		# Defaults to the current cycle.
     def self.find(fecid, cycle=CURRENT_CYCLE)
 			reply = invoke("#{cycle}/candidates/#{fecid}")
 			result = reply['results']
 			self.create(result.first) if result.first
     end
     
+    # Returns leading candidates for given categories from campaign filings within a cycle.
+    # See [the API docs](http://developer.nytimes.com/docs/read/campaign_finance_api#h3-candidate-leaders) for
+    # a list of acceptable categories to pass in. Defaults to the current cycle.
     def self.leaders(category, cycle=CURRENT_CYCLE)
 			reply = invoke("#{cycle}/candidates/leaders/#{category}",{})
 			results = reply['results']
       results.map{|c| self.create(c)}
     end
     
+    # Returns an array of candidates matching a search term within a cycle. Defaults to the
+    # current cycle.
     def self.search(name, cycle=CURRENT_CYCLE)
 			reply = invoke("#{cycle}/candidates/search", {:query => name})
 			results = reply['results']      
       results.map{|c| self.create_from_search_results(c)}
     end
     
+    # Returns an array of newly created FEC candidates within a current cycle. Defaults to the
+    # current cycle.
     def self.new_candidates(cycle=CURRENT_CYCLE)
 			reply = invoke("#{cycle}/candidates/new",{})
 			results = reply['results']      
       results.map{|c| self.create(c)}      
     end
     
+    # Returns an array of candidates for a given state and chamber within a cycle, with an optional
+    # district parameter. For example, House candidates from New York. Defaults to the current cycle.
     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,{})

data/lib/campaign_cash/committee.rb

@@ -64,7 +64,7 @@ module CampaignCash
       results.map{|c| self.create_from_api_search_results(c)}
     end
     
-    def self.new_candidates(cycle=CURRENT_CYCLE)
+    def self.new_committees(cycle=CURRENT_CYCLE)
 			reply = invoke("#{cycle}/committees/new",{})
 			results = reply['results']      
       results.map{|c| self.create_from_api(c)}      

data/lib/campaign_cash/version.rb

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

metadata

@@ -1,12 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: campaign_cash
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 13
   prerelease: 
   segments: 
   - 1
-  - 0
-  version: "1.0"
+  - 1
+  version: "1.1"
 platform: ruby
 authors: 
 - Derek Willis
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-11 00:00:00 -05:00
+date: 2011-05-14 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -107,7 +107,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: campaign_cash
-rubygems_version: 1.4.1
+rubygems_version: 1.4.2
 signing_key: 
 specification_version: 3
 summary: Following the money.