Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Wrapper for the Sunlight Transparency Data API

branch: master

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 lib
Octocat-spinner-32 test
Octocat-spinner-32 .gitignore
Octocat-spinner-32 LICENSE.md
Octocat-spinner-32 README.md
Octocat-spinner-32 Rakefile
Octocat-spinner-32 api.yml.example
Octocat-spinner-32 transparency_data.gemspec
README.md

TransparencyData.com Ruby Wrapper

By Wynn Netherland, Jeremy Hinegardner, and Luigi Montanez

Before using this library, please read the official TransparencyData.com API documentation. Query parameters and return formats are described there.

Setup

Get an API key from Sunlight Labs.

Required gems:

  • monster_mash
  • hashie

After a gem install transparency_data, you can do:

require 'transparency_data'
TransparencyData.api_key = 'YOUR_KEY_HERE'

Within a Rails app, create a config/initializers/transparency_data.rb and stick this in:

TransparencyData.configure do |config|
 config.api_key = 'YOUR_KEY_HERE'
end

Optionally, you can set TransparencyData.api_domain if you don't want to hit the production API at transparencydata.com.

Usage

See the official API docs for all parameters you can send in, and the schema docs for what you get back:

contributions = TransparencyData::Client.contributions(:contributor_ft => 'steve jobs')
contributions.each do |contribution|
  puts "Amount: #{contribution.amount}"
  puts "Date: #{contribution.date}"
end

lobbyings = TransparencyData::Client.lobbying(:client_ft => "apple inc")
lobbyings.each do |lobbying|
  puts "Amount: #{lobbying.amount}"
  puts "Year: #{lobbying.year}"
end

As described in the API docs, the TransparencyData.com API supports a special syntax as the parameter value for specifying ranges and sets on amount, cycle, year, and date. You can either pass in strings, or use a more Rubyish approach:

# contributions with an amount greater than or equal to $1000
TransparencyData::Client.contributions(:contributor_ft => 'steve jobs', :amount => {:gte => 1000})

# contributions with an amount less than or equal to $500
TransparencyData::Client.contributions(:contributor_ft => 'bill gates', :amount => {:lte => 500})

# contributions in the 2006 or 2008 cycle
TransparencyData::Client.contributions(:contributor_ft => 'eric schmidt', :cycle => [2006,2008]})

# contributions to Obama made between in Q1 2008
TransparencyData::Client.contributions(:recipient_ft => 'barack obama',
                                       :date => {:between => ['2008-01-01','2008-03-31']})

Contributing

Required gems for running tests:

  • mg
  • shoulda
  • jnunemaker-matchy
  • mocha
  • fakeweb
  • vcr

Run the test suite:

rake test
Something went wrong with that request. Please try again.