CivicInformation

A ruby wrapper for the Google Civic Information API

Add this line to your application's Gemfile:

gem 'civic_information'

And then execute:

$ bundle

Or install it yourself as:

$ gem install civic_information

You will need to register for an API key with Google.

If you intend to use this gem in a rails project, you should add the following in config/initializers/civic_information.rb

CivicInformation.configure do |config|
  config.google_api_key ='yourkeyhere'
end

If your project is not rails based, you just need to include the above configuration somewhere in your ruby environment with single change.

CivicInformation.configure do |config|
  config.google_api_key ='yourkeyhere'
end

After configuration, you can do the following things.

https://developers.google.com/civic-information/docs/v2/representatives

CivicInformation::RepresentativesResource.
  where(address: '55555', roles: ['legislatorLowerBody', 'legislatorUpperBody']).
  officials.map(&:name)

After checking out the repo, run bin/setup to install dependencies. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Bug reports and pull requests are welcome on GitHub at https://github.com/frankolson/ruby-civic-information. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

The gem is available as open source under the terms of the MIT License.

Everyone interacting in the CivicInformation project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.