campaign_cash 0.0.1 → 0.0.3

data/README.rdoc

@@ -0,0 +1,61 @@
+= campaign_cash
+
+* Docs[http://dwillis.github.com/campaign_cash/]
+* Source[http://github.com/dwillis/campaign_cash]
+
+== DESCRIPTION:
+
+Simple ruby wrapper for The New York Times Campaign Finance API[http://developer.nytimes.com/docs/read/campaign_finance_api]. You'll need an API key.
+
+== INSTALL:
+
+* <tt>sudo gem install campaign_cash</tt>
+
+== USAGE:
+
+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:
+
+  > 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.
+
+Check out the tests for further examples.
+
+== Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2010 Derek Willis
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/campaign_cash.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |s|
   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.description = "A thin client for The New York Times Campaign Finance API"
+  s.summary     = "Following the money."
 
   s.required_rubygems_version = ">= 1.3.6"
   s.rubyforge_project         = "campaign_cash"

data/lib/campaign_cash/candidate.rb

@@ -51,7 +51,7 @@ module CampaignCash
 		           :committee => params['committee']
 		  
 		end
-    
+
     def self.find_by_fecid(cycle, fecid)
 			reply = invoke("#{cycle}/candidates/#{fecid}")
 			result = reply['results']
@@ -76,5 +76,12 @@ module CampaignCash
       results.map{|c| self.create_from_api(c)}      
     end
     
+    def self.state_chamber(cycle, state, chamber, district=nil)
+      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)}      
+    end
+    
   end
 end

data/lib/campaign_cash/version.rb

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

data/test/campaign_cash/test_candidate.rb

@@ -71,4 +71,13 @@ class TestCampaignCash::TestCandidate < Test::Unit::TestCase
 	  end
 	end
 	
+	context "state candidates" do
+	  setup do
+		  @candidates = Candidate.state_chamber(2010, 'RI', 'house')
+	  end
+	  
+	  should "return 29 House candidates from Rhode Island" do
+	    assert_equal @candidates.size, 29
+	  end
+	end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: campaign_cash
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Derek Willis
@@ -34,7 +34,7 @@ dependencies:
         version: 1.0.0
   type: :development
   version_requirements: *id001
-description: Following the money.
+description: A thin client for The New York Times Campaign Finance API
 email: 
 - dwillis@gmail.com
 executables: []
@@ -46,6 +46,7 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - Gemfile
+- README.rdoc
 - Rakefile
 - campaign_cash.gemspec
 - lib/campaign_cash.rb
@@ -91,6 +92,6 @@ 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
+summary: Following the money.
 test_files: []