/congress

Ruby wrapper for the Sunlight Congress API

Primary LanguageRubyBSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause

Ruby wrapper for the Sunlight Congress API

Gem Version Build Status Dependency Status Code Climate Coverage Status

The Sunlight Congress API is a live JSON API for the people and work of Congress, provided by the Sunlight Foundation.

Installation

gem install congress

Documentation

[http://rdoc.info/gems/congress][documentation] [documentation]: http://rdoc.info/gems/congress

Authentication

All requests to the Congress API require a Sunlight API key. An API key is free to register and has no usage limits.

Usage Examples

Setup
require 'congress'
client = Congress::Client.new(YOUR_SUNLIGHT_API_KEY)
Fetch current legislators' names, IDs, biography, and social media
client.legislators
Fetch representatives and senators for a latitude/longitude or zip code
client.legislators_locate(37.775, -122.418)
client.legislators_locate('94107')
Fetch congressional districts for a latitude/longitude or zip code
client.districts_locate(37.775, -122.418)
client.districts_locate('94107')
Fetch current committees, subcommittees, and their membership
client.committees
Fetch legislation in the House and Senate
client.bills
Fetch legislation related to health care
client.bills_search(:query => "health care")
Fetch roll call votes in Congress
client.votes
Fetch to-the-minute updates from the floor of the House and Senate
client.floor_updates
Fetch committee hearings in Congress
client.hearings
Fetch bills scheduled for debate in the future, as announced by party leadership
client.upcoming_bills

Supported Ruby Versions

This library aims to support and is tested against the following Ruby implementations:

  • Ruby 1.9.3
  • Ruby 2.0.0
  • Ruby 2.1
  • Ruby 2.2
  • JRuby 1.7
  • JRuby 9.0.0.0

If something doesn't work on one of these interpreters, it should be considered a bug.

This library may inadvertently work (or seem to work) on other Ruby implementations, however support will only be provided for the versions listed above.

If you would like this library to support another Ruby version, you may volunteer to be a maintainer. Being a maintainer entails making sure all tests run and pass on that implementation. When something breaks on your implementation, you will be personally responsible for providing patches in a timely fashion. If critical issues for a particular implementation exist at the time of a major release, support for that Ruby version may be dropped.

Copyright

Copyright (c) 2011-2015, Code for America. See LICENSE for details.