campaign_cash 0.0.1

data/.gitignore

@@ -0,0 +1,3 @@
+pkg/*
+*.gem
+.bundle

data/Gemfile

@@ -0,0 +1,4 @@
+source :gemcutter
+
+# Specify your gem's dependencies in campaign_cash.gemspec
+gemspec

data/Rakefile

@@ -0,0 +1,21 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "campaign_cash #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/campaign_cash.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path("../lib/campaign_cash/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "campaign_cash"
+  s.version     = CampaignCash::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Derek Willis']
+  s.email       = ['dwillis@gmail.com']
+  s.homepage    = "http://rubygems.org/gems/campaign_cash"
+  s.summary     = "A thin client for The New York Times Campaign Finance API"
+  s.description = "Following the money."
+
+  s.required_rubygems_version = ">= 1.3.6"
+  s.rubyforge_project         = "campaign_cash"
+
+  s.add_development_dependency "bundler", ">= 1.0.0"
+
+  s.files        = `git ls-files`.split("\n")
+  s.executables  = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact
+  s.require_path = 'lib'
+end

data/lib/campaign_cash.rb

@@ -0,0 +1,11 @@
+$:.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"

data/lib/campaign_cash/base.rb

@@ -0,0 +1,81 @@
+require 'rubygems'
+require 'open-uri'
+require 'json'
+
+module CampaignCash
+  class Base
+  	API_SERVER = 'api.nytimes.com'
+  	API_VERSION = 'v3'
+  	API_NAME = 'elections/us'
+  	API_BASE = "/svc/#{API_NAME}/#{API_VERSION}/finances"
+
+  	@@api_key = nil
+  	@@copyright = nil
+
+  	class << self
+
+  		##
+  		# The copyright footer to be placed at the bottom of any data from the New York Times. Note this is only set after an API call.
+  		def copyright
+  			@@copyright
+  		end
+  		
+  		def cycle
+  		  @@cycle
+  		end
+  		
+  		def base_uri
+  		  @@base_uri
+  		end
+  		
+  		##
+  		# Set the API key used for operations. This needs to be called before any requests against the API. To obtain an API key, go to http://developer.nytimes.com/
+  		def api_key=(key)
+  			@@api_key = key
+  		end
+
+  		def api_key
+  			@@api_key
+  		end
+
+  		##
+  		# Builds a request URI to call the API server
+  		def build_request_url(path, params)
+  			URI::HTTP.build :host => API_SERVER,
+  											:path => "#{API_BASE}/#{path}.json",
+  											:query => params.map {|k,v| "#{k}=#{v}"}.join('&')
+  		end
+
+  		def invoke(path, params={})
+  			begin
+  				if @@api_key.nil?
+  					raise "You must initialize the API key before you run any API queries"
+  				end
+
+  				full_params = params.merge 'api-key' => @@api_key
+
+  				uri = build_request_url(path, full_params)
+
+  				reply = uri.read
+  				parsed_reply = JSON.parse reply
+
+  				if parsed_reply.nil?
+  					raise "Empty reply returned from API"
+  				end
+
+  				@@copyright = parsed_reply['copyright']
+  				@@cycle = parsed_reply['cycle']
+  				@@base_uri = parsed_reply['base_uri']
+
+  				parsed_reply
+  			rescue OpenURI::HTTPError => e
+  				if e.message =~ /^404/
+  					return nil
+  				end
+
+  				raise "Error connecting to URL #{uri} #{e}"
+  			end
+  		end
+  	end
+  end
+end

data/lib/campaign_cash/candidate.rb

@@ -0,0 +1,80 @@
+module CampaignCash
+  class Candidate < Base
+    
+    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, 
+                :total_from_pacs, :candidate_loans, :total_disbursements,
+                :total_refunds, :debts_owed, :begin_cash, :end_cash, :status,
+                :date_coverage_to, :date_coverage_from, :relative_uri
+    
+    def initialize(params={})
+      params.each_pair do |k,v|
+        instance_variable_set("@#{k}", v)
+      end
+    end
+    
+		def self.create_from_api(params={})
+			self.new :name => params['name'],
+							 :id => params['id'],
+							 :state => params['state'],
+							 :district => params['district'],
+							 :party => params['party'],
+							 :fec_uri => params['fec_uri'],
+							 :committee => params['committee'],
+							 :mailing_city => params['mailing_city'],
+							 :mailing_address => params['mailing_address'],
+							 :mailing_state => params['mailing_state'],
+							 :mailing_zip => params['mailing_zip'],
+							 :total_receipts => params['total_receipts'],
+							 :total_contributions => params['total_contributions'],
+							 :total_from_individuals => params['total_from_individuals'],
+							 :total_from_pacs => params['total_from_pacs'],
+							 :candidate_loans => params['candidate_loans'],
+							 :total_disbursements => params['total_disbursements'],
+							 :total_refunds => params['total_refunds'],
+							 :debts_owed => params['debts_owed'],
+							 :begin_cash => params['begin_cash'],
+							 :end_cash => params['end_cash'],
+							 :status => params['status'],
+							 :date_coverage_from => params['date_coverage_from'],
+							 :date_coverage_to => params['date_coverage_to'] 
+		end
+		
+		def self.create_from_api_search_results(params={})
+		  self.new :name => params['candidate']['name'],
+		           :id => params['candidate']['id'],
+		           :state => params['state'],
+		           :district => params['district'],
+		           :party => params['candidate']['party'],
+		           :relative_uri => params['candidate']['relative_uri'],
+		           :committee => params['committee']
+		  
+		end
+    
+    def self.find_by_fecid(cycle, fecid)
+			reply = invoke("#{cycle}/candidates/#{fecid}")
+			result = reply['results']
+			self.create_from_api(result.first) if result.first
+    end
+    
+    def self.leaders(cycle, category)
+			reply = invoke("#{cycle}/candidates/leaders/#{category}",{})
+			results = reply['results']
+      results.map{|c| self.create_from_api(c)}
+    end
+    
+    def self.search(cycle, name)
+			reply = invoke("#{cycle}/candidates/search", {:query => name})
+			results = reply['results']      
+      results.map{|c| self.create_from_api_search_results(c)}
+    end
+    
+    def self.new_candidates(cycle)
+			reply = invoke("#{cycle}/candidates/new",{})
+			results = reply['results']      
+      results.map{|c| self.create_from_api(c)}      
+    end
+    
+  end
+end

data/lib/campaign_cash/committee.rb

@@ -0,0 +1,74 @@
+module CampaignCash
+  class Committee < Base
+    
+    attr_reader :name, :id, :state, :district, :party, :fec_uri, :candidate, 
+                :city, :address, :state, :zip, :relative_uri,
+                :total_receipts, :total_contributions, :total_from_individuals, 
+                :total_from_pacs, :candidate_loans, :total_disbursements,
+                :total_refunds, :debts_owed, :begin_cash, :end_cash,
+                :date_coverage_to, :date_coverage_from
+    
+    def initialize(params={})
+      params.each_pair do |k,v|
+        instance_variable_set("@#{k}", v)
+      end
+    end
+    
+		def self.create_from_api(params={})
+			self.new :name => params['name'],
+							 :id => params['id'],
+							 :state => params['state'],
+							 :party => params['party'],
+							 :fec_uri => params['fec_uri'],
+							 :city => params['city'],
+							 :address => params['address'],
+							 :zip => params['zip'],
+							 :total_receipts => params['total_receipts'],
+							 :total_contributions => params['total_contributions'],
+							 :total_from_individuals => params['total_from_individuals'],
+							 :total_from_pacs => params['total_from_pacs'],
+							 :candidate_loans => params['candidate_loans'],
+							 :total_disbursements => params['total_disbursements'],
+							 :total_refunds => params['total_refunds'],
+							 :debts_owed => params['debts_owed'],
+							 :begin_cash => params['begin_cash'],
+							 :end_cash => params['end_cash'],
+							 :date_coverage_from => params['date_coverage_from'],
+							 :date_coverage_to => params['date_coverage_to'],
+							 :candidate => params['candidate']
+		end
+		
+		def self.create_from_api_search_results(params={})
+		  self.new :name => params['name'],
+		           :id => params['id'],
+		           :city => params['city'],
+		           :state => params['state'],
+		           :zip => params['zip'],
+		           :district => params['district'],
+		           :party => params['party'],
+		           :relative_uri => params['relative_uri'],
+		           :candidate => params['candidate'],
+		           :treasurer => params['treasurer']
+		  
+		end
+    
+    def self.find_by_fecid(cycle, fecid)
+			reply = invoke("#{cycle}/committees/#{fecid}")
+			result = reply['results']
+			self.create_from_api(result.first) if result.first
+    end
+    
+    def self.search(cycle, name)
+			reply = invoke("#{cycle}/committees/search", {:query => name})
+			results = reply['results']      
+      results.map{|c| self.create_from_api_search_results(c)}
+    end
+    
+    def self.new_candidates(cycle)
+			reply = invoke("#{cycle}/committees/new",{})
+			results = reply['results']      
+      results.map{|c| self.create_from_api(c)}      
+    end
+    
+  end
+end

data/lib/campaign_cash/version.rb

@@ -0,0 +1,3 @@
+module CampaignCash
+  VERSION = "0.0.1"
+end

data/test/campaign_cash/test_candidate.rb

@@ -0,0 +1,74 @@
+require File.dirname(__FILE__) + '/../test_helper.rb'
+
+class TestCampaignCash::TestCandidate < Test::Unit::TestCase
+	include CampaignCash
+	
+	context "Candidate.create_from_api" do
+		setup do
+		  reply = Base.invoke('2010/candidates/H4NY07011', {})
+			@result = reply['results'].first
+			@candidate = Candidate.create_from_api(@result)
+		end
+		
+		should "return an object of the Candidate type" do
+			assert_kind_of(Candidate, @candidate)
+		end
+		
+		%w(name id state district party fec_uri committee).each do |attr|
+			should "assign the value of the @#{attr} attribute from the '#{attr}' key in the hash" do
+				assert_equal(@result[attr], @candidate.send(attr))
+			end
+		end
+  end
+	
+	context "Candidate search" do
+	  setup do
+		  reply = Base.invoke('2010/candidates/search', {:query => "Udall"})
+			results = reply['results']
+	    @candidates = results.map{|c| Candidate.create_from_api_search_results(c)}
+	  end
+	  
+	  should "return two candidate objects" do
+	    assert_equal @candidates.size, 2
+	    assert_kind_of(Candidate, @candidates.first)
+	    assert_kind_of(Candidate, @candidates.last)
+	  end
+	end
+	
+	context "New Candidates" do
+	  setup do
+		  reply = Base.invoke('2010/candidates/new', {})
+			results = reply['results']
+	    @candidates = results.map{|c| Candidate.create_from_api(c)}
+	  end
+	  
+	  should "return 20 new candidates" do
+	    assert_equal @candidates.size, 20
+	    assert_kind_of(Candidate, @candidates.first)
+	    assert_kind_of(Candidate, @candidates.last)
+	  end
+	end
+	
+	context "candidate leaders" do
+	  setup do
+		  reply = Base.invoke('2010/candidates/leaders/end_cash', {})
+			results = reply['results']
+	    @candidates = results.map{|c| Candidate.create_from_api(c)}
+	  end
+	  
+	  should "return 20 candidates each with a greater end_cash value than the next" do
+	    assert (@candidates[0].end_cash >= @candidates[1].end_cash)
+	    assert (@candidates[1].end_cash >= @candidates[2].end_cash)
+	    assert (@candidates[2].end_cash >= @candidates[3].end_cash)
+	  end
+	end
+	
+	context "request with missing cycle" do
+	  should "return an error" do
+	    assert_raise RuntimeError do
+	      Base.invoke('/candidates/new', {})
+	    end
+	  end
+	end
+	
+end

data/test/campaign_cash/test_committee.rb

@@ -0,0 +1,59 @@
+require File.dirname(__FILE__) + '/../test_helper.rb'
+
+class TestCampaignCash::TestCommittee < Test::Unit::TestCase
+	include CampaignCash
+	
+	context "Committee.create_from_api" do
+		setup do
+		  reply = Base.invoke('2010/committees/C00312223', {})
+			@result = reply['results'].first
+			@committee = Committee.create_from_api(@result)
+		end
+		
+		should "return an object of the Committee type" do
+			assert_kind_of(Committee, @committee)
+		end
+		
+		%w(name id state party fec_uri candidate).each do |attr|
+			should "assign the value of the @#{attr} attribute from the '#{attr}' key in the hash" do
+				assert_equal(@result[attr], @committee.send(attr))
+			end
+		end
+	end
+	
+	context "Committee search" do
+	  setup do
+		  reply = Base.invoke('2010/committees/search', {:query => "Boeing"})
+			results = reply['results']
+	    @committees = results.map{|c| Committee.create_from_api_search_results(c)}
+	  end
+	  
+	  should "return two committee objects" do
+	    assert_equal @committees.size, 1
+	    assert_kind_of(Committee, @committees.first)
+	    assert_kind_of(Committee, @committees.last)
+	  end
+	end
+	
+	context "New Committees" do
+	  setup do
+		  reply = Base.invoke('2010/committees/new', {})
+			results = reply['results']
+	    @committees = results.map{|c| Committee.create_from_api_search_results(c)}
+	  end
+	  
+	  should "return 20 new committees" do
+	    assert_equal @committees.size, 20
+	    assert_kind_of(Committee, @committees.first)
+	    assert_kind_of(Committee, @committees.last)
+	  end
+	end
+
+	context "request with missing id" do
+	  should "return an error" do
+	    assert_raise RuntimeError do
+	      Base.invoke('2010/committees/', {})
+	    end
+	  end
+	end
+end

data/test/test_helper.rb

@@ -0,0 +1,22 @@
+require 'test/unit'
+require 'rubygems'
+require 'shoulda'
+require 'mocha'
+require 'json'
+
+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'
+
+# set your NYT Campaign Finance API key as an environment variable to run the tests
+API_KEY = ENV['NYT_CAMPFIN_API_KEY']
+CampaignCash::Base.api_key = API_KEY
+
+def api_url_for(path, params = {})
+	full_params = params.merge 'api-key' => API_KEY
+	CampaignCash::Base.build_request_url(path, full_params).to_s
+end
+
+module TestCampaignCash
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification 
+name: campaign_cash
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Derek Willis
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-03 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  version_requirements: *id001
+description: Following the money.
+email: 
+- dwillis@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Rakefile
+- campaign_cash.gemspec
+- lib/campaign_cash.rb
+- lib/campaign_cash/base.rb
+- lib/campaign_cash/candidate.rb
+- lib/campaign_cash/committee.rb
+- lib/campaign_cash/version.rb
+- test/campaign_cash/test_candidate.rb
+- test/campaign_cash/test_committee.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://rubygems.org/gems/campaign_cash
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: campaign_cash
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A thin client for The New York Times Campaign Finance API
+test_files: []
+