Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
really simple access to government data sets for ruby
Ruby
branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

README.rdoc

RGovData

RGovData is a ruby library for really simple access to government data. It aims to make consuming government data sets as easy as “gem install rgovdata”, letting you focus on what you are trying to achieve with the data, and happily ignore all the messy underlying details of transport protocols, authentication and so on.

It can be used as a command line tool, a library for ruby projects, and/or a library for rails projects.

More information is available at http://rgovdata.com along with examples of it's use.

Taking on the challenge of providing access to “all government data” is a somewhat quixotic quest for a single individual, but it could work with a community to support it! The library is open sourced under an MIT license, and the project hosted on GitHub. If you'd like to get involved, see the “Contributing to RGovData” section below.

Requirements

  • ruby 1.9

  • optional: rails 3.0.x

Resources

Objectives and Implementation Status

The following are the broad goals of the RGovData library, along with a simple statement of the current implementation status:

  • Support for discovery of data sets [status: limited to an internal registry at present. But it has a framework for adding discovery services as and when they are available ]

  • Support all countries that are actively publishing government data sets [status: very limited; currently just supporting some examples from SG and US]

  • Support the range of data formats used in government data sets [status: currently limited to CSV and OData, but with a framework to add more when available ]

  • Command line tool for discovery and access to data [status: basic features available]

  • Provide a common abstraction and simple API for data discovery and access from ruby projects [status: implemented]

  • Provide specific support for Rails ORM technologies (ActiveModel/ActiveRecord/ActiveResource) to make it easy and natural to use in Rails proejcts [status: no specific support yet, however the base ruby API works fine in Rails]

  • Provide a transparent caching mechanism for non-realtime data sets (e.g. csv files) [status: not yet implemented. If you require caching or batch downloading, it is something you currently must implement yourself]

Note that the current version is a very early implementation. It is likely that interfaces and capabilities may be refactored or changed in subsequent versions, and not necessarily preserving backward compatibility.

Getting Started

For more details and examples, see http://rgovdata.com

Installation - Basic Gem and Command Line Usage

Make sure you have a working ruby installation, then simply:

$ gem install rgovdata

When the installation is complete, try the command line:

$ rgd
rgovdata client v0.1.0. Type 'help' for info...
rgd://sg>

Installation - Rails

Add rgovdata to your Gemfile and run bundler:

$ cat Gemfile
...
gem 'rgovdata', '~> 0.1.0'
...
$ bundle install

Data Encumberance

Although it's all theoretically “our government data”, be aware that many of the data sets you can get to with RGovData are encumbered by copyright, commercial or other terms of use (yes, I know: wtf!).

It is up to you to ensure that your use of data complies with all the applicable restrictions. RGovData simply provides a mechanism for getting the data, and explicitly does not provide any rights enforcement or protection.

Contributing to RGovData

  • Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet

  • Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it

  • Fork the project

  • Start a feature/bugfix branch

  • Commit and push until you are happy with your contribution

  • Make sure to add tests for it. This is important so your changes don't get unintentionally broken in a future version.

  • Please try not to mess with the Rakefile, version, gemspec or changelog. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so the mater repository maintainer can cherry-pick around it.

Running Tests

RSpec is used for testing, and it is hooked into rake. Note that integration tests are not run by default.

  • rake - just runs unit tests

  • rake spec - same as rake

  • rake spec:integration - only runs integration tests

  • rake spec:all - run all unit and integration tests

When you do run integration tests, they make live calls on some real services, some of which require authentication. Integration tests will use an rgovdata.conf file in the root of the project for configuration.

Copyright

Copyright © 2011 Paul Gallagher and open-sourced under an MIT license. See LICENSE for further details.

Something went wrong with that request. Please try again.