campaign_cash 0.0.3 → 0.0.4

data/README.rdoc

@@ -13,15 +13,19 @@ Simple ruby wrapper for The New York Times Campaign Finance API[http://developer
 
 == USAGE:
 
+  require 'rubygems'
+  require 'campaign_cash'
+
 You'll want to set your API key as an environment variable in order to run the tests. Otherwise, you'll need to set it like so:
 
   Base.api_key = YOUR_API_KEY
   
 Currently there are methods to support retrieving candidates and committees, and every method requires at least one parameter,
-the election cycle. Some examples:
+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.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'
 
 Check out the tests for further examples.
 

data/campaign_cash.gemspec

@@ -13,6 +13,7 @@ Gem::Specification.new do |s|
 
   s.required_rubygems_version = ">= 1.3.6"
   s.rubyforge_project         = "campaign_cash"
+  s.add_runtime_dependency "json"
 
   s.add_development_dependency "bundler", ">= 1.0.0"
 

data/lib/campaign_cash/base.rb

@@ -1,6 +1,7 @@
 require 'rubygems'
 require 'open-uri'
 require 'json'
+require 'date'
 
 module CampaignCash
   class Base
@@ -37,6 +38,14 @@ module CampaignCash
   		def api_key
   			@@api_key
   		end
+  		
+  		def date_parser(date)
+  		  date ? Date.parse(date) : nil
+  		end
+  		
+  		def cycle_from_date(date=Date.today)
+  		  date.year.even? ? date.year : date.year+1
+  		end
 
   		##
   		# Builds a request URI to call the API server

data/lib/campaign_cash/filing.rb

@@ -0,0 +1,38 @@
+module CampaignCash
+  class Filing < Base
+    
+    attr_reader :committee_name, :date_coverage_from, :amended_uri, :fec_uri, :date_coverage_to, :committee, :report_title, :amended
+    
+    def initialize(params={})
+      params.each_pair do |k,v|
+        instance_variable_set("@#{k}", v)
+      end
+    end
+    
+		def self.create_from_api(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'],
+							 :fec_uri => params['fec_uri'],
+							 :amended => params['amended'],
+							 :amended_uri => params['amended_uri']
+		end
+		
+		def self.today
+		  cycle = cycle_from_date
+		  reply = Base.invoke("#{cycle}/filings", {})
+		  results = reply['results']
+			@filings = results.map{|c| Filing.create_from_api(c)}
+		end
+		
+		def self.ymd(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)}
+		end
+		
+  end
+end

data/lib/campaign_cash/version.rb

@@ -1,3 +1,3 @@
 module CampaignCash
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/campaign_cash.rb

@@ -1,11 +1,8 @@
 $:.unshift(File.dirname(__FILE__)) unless
   $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
 
-module CampaignCash
-  
-end
-
-require "#{File.dirname(__FILE__)}/campaign_cash/base"
-require "#{File.dirname(__FILE__)}/campaign_cash/version"
-require "#{File.dirname(__FILE__)}/campaign_cash/candidate"
-require "#{File.dirname(__FILE__)}/campaign_cash/committee"
+require "campaign_cash/base"
+require "campaign_cash/candidate"
+require "campaign_cash/committee"
+require "campaign_cash/filing"
+require "campaign_cash/version"

data/test/campaign_cash/test_filing.rb

@@ -0,0 +1,37 @@
+require File.dirname(__FILE__) + '/../test_helper.rb'
+
+class TestCampaignCash::TestFiling < Test::Unit::TestCase
+	include CampaignCash
+	
+	context "a day" do
+	  setup do
+	    month, day, year = "11", "27", "2010"
+		  reply = Base.invoke("2010/filings/#{year}/#{month}/#{day}", {})
+		  @results = reply['results']
+			@filings = @results.map{|c| Filing.create_from_api(c)}
+	  end
+	  
+		should "return a list of objects of the Filing type" do
+			assert_kind_of(Filing, @filings.first)
+		end
+		
+		%w(committee_name fec_uri committee amended).each do |attr|
+			should "assign the value of the @#{attr} attribute from the '#{attr}' key in the hash" do
+				assert_equal(@results.first[attr], @filings.first.send(attr))
+			end
+		end
+	end
+	
+	context "today's filings" do
+	  setup do
+		  reply = Base.invoke('2010/filings', {})
+		  @results = reply['results']
+			@filings = @results.map{|c| Filing.create_from_api(c)}
+	  end
+	  
+		should "return a list of objects of the Filing type" do
+			assert_kind_of(Filing, @filings.first)
+		end
+	end
+	
+end

data/test/test_helper.rb

@@ -8,6 +8,7 @@ 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/filing'
 
 # 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,13 @@
 --- !ruby/object:Gem::Specification 
 name: campaign_cash
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 23
   prerelease: false
   segments: 
   - 0
   - 0
-  - 3
-  version: 0.0.3
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - Derek Willis
@@ -19,9 +19,23 @@ date: 2010-12-03 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: bundler
+  name: json
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -33,7 +47,7 @@ dependencies:
         - 0
         version: 1.0.0
   type: :development
-  version_requirements: *id001
+  version_requirements: *id002
 description: A thin client for The New York Times Campaign Finance API
 email: 
 - dwillis@gmail.com
@@ -53,9 +67,11 @@ files:
 - lib/campaign_cash/base.rb
 - lib/campaign_cash/candidate.rb
 - lib/campaign_cash/committee.rb
+- lib/campaign_cash/filing.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/test_helper.rb
 has_rdoc: true
 homepage: http://rubygems.org/gems/campaign_cash