sunlightlabs / ruby-datacatalog

This URL has Read+Write access

name age
history
message
file .gitignore Sat Oct 10 08:27:38 -0700 2009 Ignoring rdoc/* [djsun]
file LICENSE.md Tue Aug 04 14:39:13 -0700 2009 Initial skeleton for the gem. [luigi]
file README.md Tue Oct 06 12:21:10 -0700 2009 Tiny tweak to README [djsun]
file Rakefile Tue Dec 15 12:03:10 -0800 2009 Version 0.4.8 [luigi]
file datacatalog.gemspec Tue Dec 15 12:03:10 -0800 2009 Version 0.4.8 [luigi]
directory lib/ Tue Dec 15 11:30:38 -0800 2009 use 'and' for compound filter queries [djsun]
file sandbox_api.yml.example Tue Sep 29 10:51:56 -0700 2009 Whitespace, formatting [djsun]
directory spec/ Tue Dec 15 12:02:10 -0800 2009 Fix expectation on filter spec. [luigi]
directory tasks/ Thu Dec 10 12:39:58 -0800 2009 Require version 0.4.4 of the DataCatalog API [djsun]
README.md

Ruby Gem for the National Data Catalog API

Under heavy development.

Installation

For now, the gem will not be packaged. Instead, install it manually:

$ git clone git clone git://github.com/sunlightlabs/ruby-datacatalog.git 
$ cd ruby-datacatalog
$ rake check_dependencies
$ rake build
$ rake install # uses sudo
# Or, instead of the line above:
$ gem install pkg/datacatalog-0.1.0.gem

Usage

require 'rubygems'
require 'datacatalog'

DataCatalog.api_key = 'c40505247a5e308a24d70a0118f76534b543795b'

Running Specs

We're not mocking out any of the web API calls in the specs. Instead, we expect developers who wish to run the specs to download and run a local sandbox instance of the Data Catalog API, a Sinatra app:

git clone git://github.com/sunlightlabs/datacatalog-api.git

Get the app running like any normal Sinatra app, so you can choose to use thin or Passenger or new hotness like Unicorn. Some special considerations:

  1. We recommend creating a sandbox entry in datacatalog-api's config.yml.
  2. Run RACK_ENV=sandbox rake db:ensure_admin in the datacatalog-api project to create a super admin for the API instance.
  3. Back here in ruby-datacatalog, use the example file in spec/ to create your own spec/sandbox_api.yml with the API key of the admin and your local URI.