opensecrets 0.0.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,22 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+doc
+pkg
+.yardoc
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Glenn Rempe
+
+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/README.rdoc

@@ -0,0 +1,40 @@
+= opensecrets
+
+A Ruby wrapper around the OpenSecrets.org API.
+
+You will need to have an OpenSecrets.org API key before you can use this library.
+
+See the OpenSecrets API documentation at : http://www.opensecrets.org/action/api_doc.php
+
+This project was inspired by a project suggestion on the SunlightLabs.com website.  If you would
+like to contribute please see : http://sunlightlabs.com/projects/opensecrets-ruby/
+
+== Installation
+
+    [sudo] gem install opensecrets
+
+== Usage
+
+    require 'rubygems'
+    require 'opensecrets'
+    require 'crack'
+    require 'pp'
+
+    member = OpenSecrets::Member.new('YOUR OPEN SECRETS API KEY')
+    pp member.pfd({:cid => 'N00007360', :year => '2008'})["response"]
+
+    cand = OpenSecrets::Candidate.new('YOUR OPEN SECRETS API KEY')
+    pp cand.summary({:cid => 'N00007360'})["response"]
+
+== 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.
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 Glenn Rempe. See LICENSE for details.
+

data/Rakefile

@@ -0,0 +1,55 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "opensecrets"
+    gem.summary = %Q{OpenSecrets.org API Ruby Wrapper}
+    gem.description = %Q{OpenSecrets are the best kind. Created as a community service as requested by the Sunlight Foundation.}
+    gem.email = "glenn@rempe.us"
+    gem.homepage = "http://github.com/grempe/opensecrets"
+    gem.authors = ["Glenn Rempe"]
+    gem.add_dependency "httparty", ">= 0.4.5"
+    gem.add_dependency "crack", ">= 0.1.4"
+    gem.add_development_dependency "shoulda", ">= 0"
+    gem.add_development_dependency "yard", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/examples/example.rb

@@ -0,0 +1,37 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib')) # only when running from gem source dir
+require 'opensecrets'
+require 'crack'
+require 'pp'
+
+CID = 'N00007360' # Nancy Pelosi
+
+
+member = OpenSecrets::Member.new('YOUR API KEY')
+
+puts "\n\nMEMBER : PFD PROFILE\n\n"
+pp member.pfd({:cid => CID, :year => '2008'})["response"]
+
+puts "\n\nMEMBER : TRAVEL & TRIPS\n\n"
+pp member.trips({:cid => CID, :year => '2008'})["response"]
+
+
+cand = OpenSecrets::Candidate.new('YOUR API KEY')
+
+puts "\n\nCANDIDATE : SUMMARY\n\n"
+pp cand.summary({:cid => CID})["response"]
+
+puts "\n\nCANDIDATE : CONTRIBUTORS\n\n"
+pp cand.contributors({:cid => CID})["response"]
+
+puts "\n\nCANDIDATE : INDUSTRIES\n\n"
+pp cand.industries({:cid => CID})["response"]
+
+puts "\n\nCANDIDATE : CONTRIBUTIONS BY SPECIFIC INDUSTRY\n\n"
+pp cand.contributions_by_industry({:cid => CID, :indcode => 'K01'})["response"]
+
+puts "\n\nCANDIDATE : SECTOR\n\n"
+pp cand.sector({:cid => CID})["response"]
+

data/lib/opensecrets.rb

@@ -0,0 +1,135 @@
+require 'httparty'
+
+module OpenSecrets
+
+  class Member
+    include HTTParty
+    base_uri 'http://www.opensecrets.org/api'
+    default_params :output => 'xml'
+    format :xml
+
+    # OpenSecrets information about a Member of Congress.
+    #
+    # @option options [String] apikey ("") an OpenSecrets API Key
+    #
+    def initialize(apikey)
+      raise ArgumentError, 'You must provide an API Key' if apikey.blank?
+      self.class.default_params :apikey => apikey
+    end
+
+    # Returns Personal Financial Disclosure (PFD) information for a member of Congress.
+    #
+    # See : http://www.opensecrets.org/api/?method=memPFDprofile&output=doc
+    #
+    # @option options [String] :cid ("") a CRP CandidateID
+    # @option options [String] :year ("") Get data for specified year.
+    #
+    def pfd(options = {})
+      raise ArgumentError, 'You must provide a :cid option' if options[:cid].blank?
+      raise ArgumentError, 'You must provide a :year option' if options[:year].blank?
+      options.merge!({:method => 'memPFDprofile'})
+      self.class.get("/", :query => options)
+    end
+
+    # Provides a list of trips paid for by private organizations taken by a specified member or their staff.
+    #
+    # See : http://www.opensecrets.org/api/?method=memTravelTrips&output=doc
+    #
+    # @option options [String] :cid ("") a CRP CandidateID
+    # @option options [String] :year ("") Get data for specified year.
+    #
+    def trips(options = {})
+      raise ArgumentError, 'You must provide a :cid option' if options[:cid].blank?
+      raise ArgumentError, 'You must provide a :year option' if options[:year].blank?
+      options.merge!({:method => 'memTravelTrips'})
+      self.class.get("/", :query => options)
+    end
+
+  end
+
+  class Candidate
+    include HTTParty
+    base_uri 'http://www.opensecrets.org/api'
+    default_params :output => 'xml'
+    format :xml
+
+    # OpenSecrets information about a Candidate.
+    #
+    # @option options [String] apikey ("") an OpenSecrets API Key
+    #
+    def initialize(apikey)
+      raise ArgumentError, 'You must provide an API Key' if apikey.blank?
+      self.class.default_params :apikey => apikey
+    end
+
+    # Provides summary fundraising information for specified politician.
+    #
+    # See : http://www.opensecrets.org/api/?method=candSummary&output=doc
+    #
+    # @option options [String] :cid ("") a CRP CandidateID
+    # @option options [optional, String] :cycle ("") blank values returns current cycle.
+    #
+    def summary(options = {})
+      raise ArgumentError, 'You must provide a :cid option' if options[:cid].blank?
+      options.merge!({:method => 'candSummary'})
+      self.class.get("/", :query => options)
+    end
+
+    # Provides the top organizations contributing to specified politician.
+    #
+    # See : http://www.opensecrets.org/api/?method=candContrib&output=doc
+    #
+    # @option options [String] :cid ("") a CRP CandidateID
+    # @option options [optional, String] :cycle ("") 2008 or 2010.
+    #
+    def contributors(options = {})
+      raise ArgumentError, 'You must provide a :cid option' if options[:cid].blank?
+      options.merge!({:method => 'candContrib'})
+      self.class.get("/", :query => options)
+    end
+
+    # Provides the top industries contributing to a specified politician.
+    #
+    # See : http://www.opensecrets.org/api/?method=candIndustry&output=doc
+    #
+    # @option options [String] :cid ("") a CRP CandidateID
+    # @option options [optional, String] :cycle ("") blank values returns current cycle.
+    #
+    def industries(options = {})
+      raise ArgumentError, 'You must provide a :cid option' if options[:cid].blank?
+      options.merge!({:method => 'candIndustry'})
+      self.class.get("/", :query => options)
+    end
+
+    # Provides total contributed to specified candidate from specified industry for specified cycle.
+    #
+    # See : http://www.opensecrets.org/api/?method=candIndByInd&output=doc
+    #
+    # @option options [String] :cid ("") a CRP CandidateID
+    # @option options [String] :indcode ("") a a 3-character industry code
+    # @option options [optional, String] :cycle ("") 2010, 2008 allowed. leave blank for latest cycle.
+    #
+    def contributions_by_industry(options = {})
+      raise ArgumentError, 'You must provide a :cid option' if options[:cid].blank?
+      raise ArgumentError, 'You must provide a :indcode option' if options[:indcode].blank?
+      options.merge!({:method => 'candIndByInd'})
+      self.class.get("/", :query => options)
+    end
+
+    # Provides sector total of specified politician's receipts.
+    #
+    # See : http://www.opensecrets.org/api/?method=candSector&output=doc
+    #
+    # @option options [String] :cid ("") a CRP CandidateID
+    # @option options [optional, String] :cycle ("") blank values returns current cycle.
+    #
+    def sector(options = {})
+      raise ArgumentError, 'You must provide a :cid option' if options[:cid].blank?
+      options.merge!({:method => 'candSector'})
+      self.class.get("/", :query => options)
+    end
+
+  end
+
+end
+

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'opensecrets'
+
+class Test::Unit::TestCase
+end

data/test/test_opensecrets.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestOpensecrets < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification 
+name: opensecrets
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Glenn Rempe
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-04 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.4.5
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: crack
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.1.4
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: yard
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: OpenSecrets are the best kind. Created as a community service as requested by the Sunlight Foundation.
+email: glenn@rempe.us
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- examples/example.rb
+- lib/opensecrets.rb
+- test/helper.rb
+- test/test_opensecrets.rb
+has_rdoc: true
+homepage: http://github.com/grempe/opensecrets
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: OpenSecrets.org API Ruby Wrapper
+test_files: 
+- test/helper.rb
+- test/test_opensecrets.rb
+- examples/example.rb