datacatalog 0.1.0

data/.gitignore

@@ -0,0 +1,5 @@
+.DS_Store
+coverage
+setup.rb
+datacatalog*.gem
+sandbox_api.yml

data/CHANGES.md

@@ -0,0 +1,2 @@
+### 0.1.0 / 2009-08-15
+* Initial version

data/LICENSE.md

@@ -0,0 +1,11 @@
+Copyright (c) 2009, Sunlight Foundation. 
+
+All rights reserved.
+ 
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+ 
+  * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+  * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+  * Neither the name of Sunlight Foundation nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+ 
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,31 @@
+# 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
+    $ gem build datacatalog.gemspec
+    $ gem install 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](http://github.com/sunlightlabs/datacatalog-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](http://unicorn.bogomips.org/). 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.

data/Rakefile

@@ -0,0 +1,49 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "datacatalog"
+    gem.summary = %Q{Wrapper for the National Data Catalog API}
+    gem.description = %Q{Ruby library that wraps the National Data Catalog API}
+    gem.email = "luigi@sunlightfoundation.com"
+    gem.homepage = "http://github.com/sunlightlabs/datacatalog"
+    gem.authors = ["Luigi Montanez", "David James"]
+    gem.add_development_dependency "rspec"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "datacatalog #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/datacatalog.gemspec

@@ -0,0 +1,68 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{datacatalog}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Luigi Montanez", "David James"]
+  s.date = %q{2009-10-05}
+  s.description = %q{Ruby library that wraps the National Data Catalog API}
+  s.email = %q{luigi@sunlightfoundation.com}
+  s.extra_rdoc_files = [
+    "LICENSE.md",
+     "README.md"
+  ]
+  s.files = [
+    ".gitignore",
+     "CHANGES.md",
+     "LICENSE.md",
+     "README.md",
+     "Rakefile",
+     "VERSION",
+     "datacatalog.gemspec",
+     "doc/api_key_spec_for_rest_api.txt",
+     "doc/api_key_spec_for_ruby_api.rb",
+     "doc/mocking_options.md",
+     "lib/datacatalog.rb",
+     "lib/datacatalog/api_key.rb",
+     "lib/datacatalog/base.rb",
+     "lib/datacatalog/source.rb",
+     "lib/datacatalog/user.rb",
+     "sandbox_api.yml.example",
+     "spec/api_key_spec.rb",
+     "spec/base_spec.rb",
+     "spec/source_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "spec/user_spec.rb"
+  ]
+  s.homepage = %q{http://github.com/sunlightlabs/datacatalog}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Wrapper for the National Data Catalog API}
+  s.test_files = [
+    "spec/api_key_spec.rb",
+     "spec/base_spec.rb",
+     "spec/source_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/user_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 0"])
+  end
+end

data/doc/api_key_spec_for_rest_api.txt

@@ -0,0 +1,54 @@
+A user has a built-in, primary API key.
+A user also has secondary API keys.
+
+API keys fall into these categories:
+1. "primary" API key
+   - created and controlled by system
+   - cannot be deleted by users
+   - used by the Data Catalog Web Application
+   - can be rekeyed by user
+2. application keys
+   - created and controlled by users
+   - can be rekeyed by user
+   - do not provide user-specific credentials:
+     - favorites
+     - comments
+3. valet keys
+   - created and controlled by users
+   - can be rekeyed by user
+   - provide user-specific credentials
+     - favorites
+     - comments
+
+GET /users/1/api_keys
+# get all API keys
+:type => :primary
+:type => :application
+:type => :valet
+
+GET /users/1/api_keys?type=primary
+# just returns the primary key
+
+GET /users/1/api_keys?type=application
+# returns an array of application keys. [] if none.
+
+GET /users/1/api_keys?type=valet
+# returns an array of the valet keys. [] if none.
+
+POST /users/1/api_keys
+# create a new API key
+
+PUT /users/1/api_keys/12345
+# update an existing API key
+
+PUT /users/1/api_keys/12345?regenerate_api_key=true
+# rekey an API key
+
+DELETE /users/1/api_keys/12345
+# delete an existing API key
+# return 403 Forbidden if attempting to delete a primary key
+
+# -----
+
+POST /users
+A a primary key API should be generated automatically.

data/doc/api_key_spec_for_ruby_api.rb

@@ -0,0 +1,26 @@
+# I want to get a user's primary API key
+user = DataCatalog::User.find(user_id)
+user.primary_api_key
+user.application_api_keys
+user.valet_api_keys
+
+# I want to generate a new API key for a user
+user.generate_api_key!(:type => "application", :purpose => "To be awesome.") # sets user to the updated object
+
+# I want to update an API key
+user.update_api_key!("173f938237a93e9393b365c3", 
+                    :type => "application", 
+                    :purpose => "To be more awesome.") # sets user to the updated object
+
+# I want to delete an API key of a user
+user.delete_api_key!("173f938237a93e9393b365c3") # returns: true / exception
+
+# I want to get all API keys of a single user
+user.api_keys # returns: array of keys
+
+# ^^^^^^^^^^^^ DONE ^^^^^^^^^^^^^^^
+
+# vvvvvvvvvv NOT DONE vvvvvvvvvvvvv 
+
+# Given an API key, I want to see what user it corresponds to, if any.
+DataCatalog::User.find_by_api_key("7a93e93b365ca93e9393b365c3") # returns: User object

data/doc/mocking_options.md

@@ -0,0 +1,20 @@
+# Ruby wrapper API mocking options
+
+## 1. Machinist 
+
+* Use Machinist as an object factory for HTTParty::Response and DataCatalog::* objects.
+* Big question: Can HTTParty::Response object methods be appropriately mocked out by Machinist?
+* Will need to keep objects in sync with the live API
+
+## 2. FakeWeb
+
+* Use FakeWeb to fake out the HTTP responses
+* Will need to know the details of the JSON bodies, but HTTParty wraps all that for us.
+* Will need to keep the JSON output (and headers + status codes) in sync with the live API
+
+## 3. Local Sandbox API
+
+* Use a locally running sandbox API that mocks out the real API
+* Each spec will need to build up needed objects in the API, then tear them down at the end.
+* Much slower than in-memory solutions above.
+* To keep in sync with live API, just need to refresh API codebase. 

data/lib/datacatalog.rb

@@ -0,0 +1,28 @@
+require 'rubygems'
+require 'activesupport'
+require 'httparty'
+require 'mash'
+
+module DataCatalog
+  mattr_accessor :api_key, :base_uri
+  class Error                     < RuntimeError; end
+  class BadRequest                < Error; end # 400
+  class Unauthorized              < Error; end # 401
+  class Forbidden                 < Error; end # 403
+  class NotFound                  < Error; end # 404
+  class Conflict                  < Error; end # 409
+  class InternalServerError       < Error; end # 500
+  class ApiKeyNotConfigured       < Error; end
+  class CannotDeletePrimaryApiKey < Error; end
+  
+  def self.with_key(temp_key)
+    original_key = DataCatalog.api_key 
+    DataCatalog.api_key = temp_key
+    yield
+    DataCatalog.api_key = original_key
+  end
+  
+end
+
+require "#{File.dirname(__FILE__)}/datacatalog/base.rb"
+Dir["#{File.dirname(__FILE__)}/datacatalog/*.rb"].each { |source_file| require source_file }

data/lib/datacatalog/api_key.rb

@@ -0,0 +1,7 @@
+module DataCatalog
+
+  class ApiKey < DataCatalog::Base
+    
+  end # class ApiKey
+  
+end # module DataCatalog

data/lib/datacatalog/base.rb

@@ -0,0 +1,68 @@
+module DataCatalog
+
+  class Base < Mash
+  
+    include HTTParty
+    format :json
+    
+    def self.set_base_uri
+      default_options[:base_uri] = HTTParty.normalize_base_uri(DataCatalog.base_uri || 'api.nationaldatacatalog.com')
+    end
+    
+    def self.set_api_key
+      if DataCatalog.api_key.blank?
+        raise ApiKeyNotConfigured, "Use DataCatalog.api_key = '...'"
+      end
+      default_options[:default_params] = {} if default_options[:default_params].nil?
+      default_options[:default_params].merge!({ :api_key => DataCatalog.api_key })
+    end
+
+    def self.set_up!
+      set_base_uri
+      set_api_key
+    end
+
+    def self.check_status_code(response)
+      case response.code
+      when 400: raise BadRequest, error_message(response)
+      when 401: raise Unauthorized, error_message(response)
+      when 403: raise Forbidden, error_message(response)
+      when 404: raise NotFound, error_message(response)
+      when 409: raise Conflict, error_message(response)
+      when 500: raise InternalServerError, error_message(response)
+      end
+    end
+    
+    def self.error_message(response)
+      parsed_body = JSON.parse(response.body)
+      if parsed_body.empty?
+        "Response was empty"
+      elsif parsed_body["errors"]
+        parsed_body["errors"].inspect
+      else
+        response.body
+      end
+    rescue JSON::ParserError
+      "Unable to parse: #{response.body.inspect}"
+    end
+
+    def self.response_for
+      response = yield
+      check_status_code(response)
+      response
+    end
+
+    def self.build_object(response)
+      return nil if response.nil? || response.empty?
+      new(response)
+    end
+
+    def self.about
+      default_options[:default_params] = {}
+      set_base_uri
+      build_object(response_for { get('/') })
+    end
+
+  end # class Base
+
+end # module DataCatalog

data/lib/datacatalog/source.rb

@@ -0,0 +1,30 @@
+module DataCatalog
+
+  class Source < DataCatalog::Base
+    
+    def self.create(params={})
+      set_up!
+      build_object(response_for { post("/sources", :query => params) })
+    end
+    
+    def self.all
+      set_up!
+      response_for{ get("/sources") }.map do |source|
+        build_object(source)
+      end
+    end
+    
+    def self.update(source_id, params={})
+      set_up!
+      build_object(response_for { put("/sources/#{source_id}", :query => params) })
+    end
+  
+    def self.destroy(source_id)
+      set_up!
+      response = response_for { delete("/sources/#{source_id}") }
+      true
+    end
+    
+  end
+  
+end

data/lib/datacatalog/user.rb

@@ -0,0 +1,94 @@
+module DataCatalog
+
+  class User < DataCatalog::Base
+    
+    def self.all
+      set_up!
+      response_for{ get("/users") }.map do |user|
+        build_object(user)
+      end
+    end
+    
+    def self.find(id)
+      set_up!
+      user = build_object(response_for { get("/users/#{id}") })
+      user.api_keys = response_for { get("/users/#{id}/keys") }.map do |key|
+        DataCatalog::ApiKey.build_object(key)
+      end if user
+      user
+    end
+    
+    def self.find_by_api_key(api_key)
+      user = nil
+      DataCatalog.with_key(api_key) do
+        set_up!
+        checkup = build_object(response_for { get("/checkup") })
+        user = find(checkup.user_id)
+      end
+      user
+    end
+    
+    def self.create(params={})
+      set_up!
+      user = build_object(response_for { post("/users", :query => params) })
+      user.api_keys = response_for { get("/users/#{user.id}/keys") }.map do |key|
+        DataCatalog::ApiKey.build_object(key)
+      end if user
+      user
+    end
+
+    def self.update(user_id, params)
+      set_up!
+      build_object(response_for { put("/users/#{user_id}", :query => params) })
+    end
+    
+    def self.destroy(user_id)
+      set_up!
+      response = response_for { delete("/users/#{user_id}") }
+      true
+    end
+    
+    def generate_api_key!(params)
+      self.class.set_up!
+      
+      response = self.class.response_for do
+        self.class.post("/users/#{self.id}/keys", :query => params )
+      end
+      update_api_keys
+      true
+    end
+    
+    def delete_api_key!(api_key_id)
+      self.class.set_up!
+      
+      response = self.class.response_for do
+        self.class.delete("/users/#{self.id}/keys/#{api_key_id}")
+      end
+      update_api_keys
+      true
+    end
+    
+    def update_api_key!(api_key_id, params)
+      self.class.set_up!
+      
+      response = self.class.response_for do
+        self.class.put("/users/#{self.id}/keys/#{api_key_id}", :query => params)
+      end
+      update_api_keys
+      true
+    end
+    
+    private
+    
+    def update_api_keys
+      self.api_keys = self.class.response_for { self.class.get("/users/#{self.id}/keys") }.map do |key|
+        DataCatalog::ApiKey.build_object(key)
+      end
+      updated_user = DataCatalog::User.find(self.id)
+      self.application_api_keys = updated_user.application_api_keys
+      self.valet_api_keys = updated_user.valet_api_keys
+    end
+    
+  end # class User
+
+end # module DataCatalog

data/sandbox_api.yml.example

@@ -0,0 +1,2 @@
+api_key: d193d1523d49e4caf46297ef94d7a2c995d3b2cb # generate with rake db:ensure_admin on datacatalog-api
+base_uri: sandbox.dc-api.local

data/spec/api_key_spec.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + '/spec_helper'

data/spec/base_spec.rb

@@ -0,0 +1,184 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe DataCatalog do
+
+  describe "module accessors" do
+
+    it "should access the API Key" do
+      DataCatalog.api_key = 'flurfeneugen'
+      DataCatalog.api_key.should == 'flurfeneugen'
+    end
+
+    it "should access the base URI" do
+      DataCatalog.base_uri = 'somehost.com'
+      DataCatalog.base_uri.should == 'somehost.com'
+    end
+  
+  end # describe "accessors"
+
+  describe ".with_key" do
+    
+    it "should set the API key within the block" do
+      DataCatalog.api_key = 'flurfeneugen'
+      temp_value = 'not_temp_key'
+      
+      DataCatalog.with_key('temp_key') do
+        temp_value = DataCatalog.api_key
+      end
+      
+      temp_value.should == 'temp_key'
+      DataCatalog.api_key.should == 'flurfeneugen'
+    end
+    
+  end # describe ".with_key"
+  
+end # describe DataCatalog
+
+describe DataCatalog::Base do
+
+  before(:each) { setup_api }
+
+  describe ".set_base_uri" do
+
+    it "should set and normalize the base URI" do
+      DataCatalog.base_uri = 'notherhost.com'
+      DataCatalog::Base.set_base_uri
+      DataCatalog::Base.default_options[:base_uri].should == 'http://notherhost.com'
+    end
+    
+    it "should set the base URI to the default if it's not explicitly defined" do
+      DataCatalog.base_uri = nil
+      DataCatalog::Base.set_base_uri
+      DataCatalog::Base.default_options[:base_uri].should == 'http://api.nationaldatacatalog.com'
+    end
+  
+  end # describe ".set_base_uri"
+  
+  describe ".set_api_key" do
+
+    it "should set the API key" do
+      DataCatalog.api_key = 'flurfeneugen'
+      DataCatalog::Base.set_api_key
+      DataCatalog::Base.default_options[:default_params].should include(:api_key => 'flurfeneugen')
+    end
+
+    it "should raise exception when attempting to set the API key but none is set" do
+      DataCatalog.api_key = nil
+      executing do
+        DataCatalog::Base.set_api_key
+      end.should raise_error(DataCatalog::ApiKeyNotConfigured)
+    end
+    
+  end # describe ".set_default_params"
+
+  describe ".set_up!" do
+    
+    it "should set both the base URI and API key" do
+      DataCatalog.base_uri = 'somehost.com'
+      DataCatalog.api_key = 'flurfeneugen'
+      DataCatalog::Base.set_up!
+      DataCatalog::Base.default_options[:base_uri].should == 'http://somehost.com'
+      DataCatalog::Base.default_options[:default_params].should include(:api_key => 'flurfeneugen')
+    end
+    
+  end # describe ".set_up!"
+  
+  describe ".build_object" do
+    
+    it "should create an object when a filled hash is passed in" do
+      base_object = DataCatalog::Base.build_object(:name => "John Smith", :email => "john@email.com")
+      base_object.should be_an_instance_of(DataCatalog::Base)
+      base_object.email.should == "john@email.com"
+    end
+    
+    it "should return nil when an empty hash is passed in" do
+      base_object = DataCatalog::Base.build_object({})
+      base_object.should be_nil
+    end
+    
+    it "should return nil when nil is passed in" do
+      base_object = DataCatalog::Base.build_object(nil)
+      base_object.should be_nil
+    end
+    
+  end # describe ".build_object!"
+
+  describe ".about" do
+
+    it "should return information about the API" do
+      base_object = DataCatalog::Base.about
+      base_object.should be_an_instance_of(DataCatalog::Base)
+      base_object.name.should == "National Data Catalog API"
+    end
+
+  end # describe ".about"
+  
+  describe ".check_status_code" do
+    
+    it "should return nil on 200 OK" do
+      response = HTTParty::Response.new(nil, '{"foo":"bar"}', 200, 'OK', {})
+      DataCatalog::Base.check_status_code(response).should be_nil
+    end
+    
+    it "should raise BadRequest on 400 Bad Request" do
+      response = HTTParty::Response.new(nil, '[]', 400, 'Bad Request', {})
+      executing do
+        DataCatalog::Base.check_status_code(response)
+      end.should raise_error(DataCatalog::BadRequest)
+    end
+
+    it "should raise Unauthorized on 401 Unauthorized" do
+      response = HTTParty::Response.new(nil, '', 401, 'Unauthorized', {})
+      executing do
+        DataCatalog::Base.check_status_code(response)
+      end.should raise_error(DataCatalog::Unauthorized)
+    end
+
+    it "should raise NotFound on 404 Not Found" do
+      response = HTTParty::Response.new(nil, '[]', 404, 'Not Found', {})
+      executing do
+        DataCatalog::Base.check_status_code(response)
+      end.should raise_error(DataCatalog::NotFound)
+    end
+    
+    it "should raise InternalServerError on 500 Internal Server Error" do
+      response = HTTParty::Response.new(nil, '', 500, 'Internal Server Error', {})
+      executing do
+        DataCatalog::Base.check_status_code(response)
+      end.should raise_error(DataCatalog::InternalServerError)
+    end
+        
+  end # describe ".check_status_code"
+  
+  describe ".error_message" do
+    
+    it "should return an 'Unable to parse:' message when body is blank" do
+      response = HTTParty::Response.new(nil, '', 404, 'Not Found', {})
+      DataCatalog::Base.error_message(response).should == %(Unable to parse: "")
+    end
+    
+    it "should return 'Response was empty' when body is an empty JSON object" do
+      response = HTTParty::Response.new(nil, '{}', 404, 'Not Found', {})
+      DataCatalog::Base.error_message(response).should == "Response was empty"
+    end
+    
+    it "should return 'Response was empty' when body is an empty array" do
+      response = HTTParty::Response.new(nil, '[]', 404, 'Not Found', {})
+      DataCatalog::Base.error_message(response).should == "Response was empty"
+    end
+    
+    it "should return the contents of the errors hash when it exists" do
+      errors = '{"errors":["bad_error"]}'
+      response = HTTParty::Response.new(nil, errors, 400, 'Bad Request', {})
+      DataCatalog::Base.error_message(response).should == '["bad_error"]'
+    end
+    
+    it "should return the contents of the response body when no errors hash exists" do
+      errors = '{"foo":["bar"]}'
+      response = HTTParty::Response.new(nil, errors, 400, 'Bad Request', {})
+      DataCatalog::Base.error_message(response).should == '{"foo":["bar"]}'
+    end
+
+  end # describe ".error_message"
+
+end # describe DataCatalog::Base

data/spec/source_spec.rb

@@ -0,0 +1,101 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe DataCatalog::Source do
+
+  def create_source(params={})
+    valid_params = {
+      :title => "Some FCC Data",
+      :url   => "http://fcc.gov/somedata.csv"
+    }
+    DataCatalog::Source.create(valid_params.merge(params))
+  end
+  
+  before(:each) do
+    setup_api
+    clean_slate
+  end
+
+  describe ".all" do
+    before do
+      %w(FCC NASA DOE).each do |name|
+        DataCatalog::Source.create({
+          :title => "#{name} Data",
+          :url   => "http://#{name.downcase}.gov/data.xml"
+        })
+      end
+      @sources = DataCatalog::Source.all
+    end
+    
+    it "should return an enumeration of sources" do
+      @sources.each do |source|
+        source.should be_an_instance_of(DataCatalog::Source)
+      end
+    end
+    
+    it "should return correct titles" do
+      expected = ["FCC Data", "NASA Data", "DOE Data"]
+      @sources.map(&:title).sort.should == expected.sort
+    end
+  end # describe ".all"
+  
+  describe ".create" do
+    it "should create a new source from basic params" do
+      source = create_source
+      source.should be_an_instance_of(DataCatalog::Source)
+      source.url.should == "http://fcc.gov/somedata.csv"
+    end
+    
+    it "should create a new source from custom params" do
+      source = create_source({ :custom => {
+        "0" => {
+          :label       => "License",
+          :description => "License",
+          :type        => "string",
+          :value       => "Public Domain"
+        }
+      }})
+      source.should be_an_instance_of(DataCatalog::Source)
+      source.url.should == "http://fcc.gov/somedata.csv"
+      source.custom.should == {
+        "0" => {
+          "label"       => "License",
+          "description" => "License",
+          "type"        => "string",
+          "value"       => "Public Domain"
+        }
+      }
+    end
+  end # describe ".all"
+
+  describe ".update" do
+    before do
+      @source = create_source
+    end
+
+    it "should update an existing source from valid params" do
+      source = DataCatalog::Source.update(@source.id, {
+        :url => "http://fec.gov/newdata.csv"
+      })
+      source.should be_an_instance_of(DataCatalog::Source)
+      source.url.should == "http://fec.gov/newdata.csv"
+    end
+  end # describe ".all"  
+  
+  describe ".destroy" do
+    before do
+      @source = create_source
+    end
+
+    it "should destroy an existing source" do
+      result = DataCatalog::Source.destroy(@source.id)
+      result.should be_true
+    end
+    
+    it "should raise NotFound when attempting to destroy non-existing source" do
+      executing do
+        DataCatalog::Source.destroy(mangle(@source.id))
+      end.should raise_error(DataCatalog::NotFound)
+    end
+  end # describe ".destroy"
+  
+end

data/spec/spec.opts

@@ -0,0 +1,4 @@
+--color
+--timeout
+20
+--diff

data/spec/spec_helper.rb

@@ -0,0 +1,48 @@
+require File.dirname(__FILE__) + '/../lib/datacatalog'
+require 'yaml'
+
+Spec::Runner.configure do |config|
+  config.mock_with :rr
+end
+
+alias :executing :lambda
+
+def setup_api
+  config = YAML.load_file(File.dirname(__FILE__) + '/../sandbox_api.yml')
+  DataCatalog.api_key = config['api_key']
+  DataCatalog.base_uri = config['base_uri']
+end
+
+def clean_slate
+  DataCatalog::User.all.each do |u|
+    DataCatalog::User.destroy(u.id) unless u.name == "Primary Admin"
+  end
+  DataCatalog::Source.all.each do |s|
+    DataCatalog::Source.destroy(s.id)
+  end
+end
+
+if RUBY_VERSION >= "1.8.7"
+  # Converts a valid ID into a almost-but-not-quite valid one.
+  # Here is an example of what it does:
+  # From ... 4ac2520b25b7e7056600034e
+  # To   ... a42c25b0527b7e50660030e4
+  def mangle(string)
+    array = string.chars.to_a
+    sliced = []
+    array.each_slice(2) { |s| sliced << s.reverse }
+    result = sliced.flatten.join
+    raise "mangle failed" if result == string
+    result
+  end
+else
+  # Converts a valid ID into a almost-but-not-quite valid one.
+  # Here is an example of what it does:
+  # From ... 4ac2520b25b7e7056600034e
+  # To   ... e4300066507e7b52b0252ca4
+  def mangle(string)
+    result = string.reverse
+    raise "mangle failed" if result == string
+    result
+  end
+end

data/spec/user_spec.rb

@@ -0,0 +1,208 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe DataCatalog::User do
+
+  def create_user
+    DataCatalog::User.create({
+      :name  => "Ted Smith",
+      :email => "ted@email.com"
+    })
+  end  
+  
+  def create_user_with_2_keys
+    user = create_user
+    result = user.generate_api_key!(
+      :purpose  => "Civic hacking with my awesome app",
+      :key_type => "application"
+    )
+    raise "generate_api_key! failed" unless result
+    raise "incorrect number of keys" unless user.api_keys.length == 2
+    user
+  end
+  
+  before(:each) do
+    setup_api
+    clean_slate
+  end
+
+  describe ".all" do
+    before(:each) do
+      3.times do |n|
+        DataCatalog::User.create(
+          :name  => "User-#{n}",
+          :email => "user_#{n}@email.com"
+        )
+      end
+      @users = DataCatalog::User.all
+    end
+    
+    it "should return an enumeration of users" do
+      @users.each do |u|
+        u.should be_an_instance_of(DataCatalog::User)
+      end
+    end
+    
+    it "should include four users" do
+      names = @users.map(&:name)
+      names.should include("User-0")
+      names.should include("User-1")
+      names.should include("User-2")
+    end
+  end # describe ".all"
+
+  describe ".create" do
+    before do
+      @user = create_user
+    end
+
+    it "should create a new user when valid params are passed in" do
+      @user.should be_an_instance_of(DataCatalog::User)
+      @user.name.should == "Ted Smith"
+      @user.email.should == "ted@email.com"
+    end
+
+    it "should raise BadRequest when invalid params are passed in" do
+      executing do
+        DataCatalog::User.create({ :garbage_field => "junk" })
+      end.should raise_error(DataCatalog::BadRequest)
+    end
+  end # describe ".create"
+  
+  describe ".find" do
+    before do
+      @user = create_user
+    end
+
+    it "should return a user" do  
+      user = DataCatalog::User.find(@user.id)
+      user.should be_an_instance_of(DataCatalog::User)
+      user.email.should == "ted@email.com"
+    end
+    
+    it "should raise NotFound out if no user exists" do
+      executing do
+        DataCatalog::User.find(mangle(@user.id))
+      end.should raise_error(DataCatalog::NotFound)
+    end
+  end # describe ".find"
+  
+  describe ".find_by_api_key" do
+    before do
+      @user = create_user
+    end
+    
+    it "should return a user" do
+      user = DataCatalog::User.find_by_api_key(@user.primary_api_key)
+      user.should be_an_instance_of(DataCatalog::User)
+      user.email.should == "ted@email.com"
+    end
+  end # describe ".find_by_api_key"
+    
+  describe ".update" do
+    before do
+      @user = create_user
+    end
+    
+    it "should update a user when valid params are passed in" do
+      user = DataCatalog::User.update(@user.id, { :name => "Jane Smith" })
+      user.name.should == "Jane Smith"
+    end
+
+    it "should raise BadRequest when invalid params are passed in" do
+      executing do
+        DataCatalog::User.update(@user.id, { :garbage => "junk" })
+      end.should raise_error(DataCatalog::BadRequest)
+    end
+
+  end # describe ".update"
+  
+  describe ".destroy" do
+    before do
+      @user = create_user
+    end
+
+    it "should destroy an existing user" do
+      result = DataCatalog::User.destroy(@user.id)
+      result.should be_true
+    end
+    
+    it "should raise NotFound when non-existing user" do
+      executing do
+        DataCatalog::User.destroy(mangle(@user.id))
+      end.should raise_error(DataCatalog::NotFound)
+    end
+  end # describe ".destroy"
+
+  describe "#generate_api_key!" do
+    before do
+      @user = create_user
+    end
+
+    it "should generate a new key for the user" do
+      @user.api_keys.length.should == 1
+      @user.generate_api_key!({
+        :purpose  => "Civic hacking with my awesome app",
+        :key_type => "application"
+      }).should be_true
+      @user.api_keys.length.should == 2
+      @user.api_keys.last[:purpose].should == "Civic hacking with my awesome app"
+      @user.application_api_keys.length.should == 1
+    end
+    
+    it "should raise BadRequest when attempting to create a primary key" do
+      executing do
+        @user.generate_api_key!({
+          :purpose  => "Civic hacking with my awesome app",
+          :key_type => "primary"
+        })
+      end.should raise_error(DataCatalog::BadRequest)
+    end
+  end # describe "#generate_api_key!"
+  
+  describe "#update_api_key!" do
+    before do
+      @user = create_user_with_2_keys
+    end
+  
+    it "should update a key for the user" do      
+      @user.update_api_key!(@user.api_keys[1].id, {
+        :key_type => "valet",
+        :purpose  => "To be more awesome"
+      }).should be_true
+      @user.api_keys[1].purpose.should == "To be more awesome"
+    end
+    
+    it "should raise NotFound if updating a key that doesn't exist" do
+      executing do
+        @user.update_api_key!(mangle(@user.api_keys[1].id), {})
+      end.should raise_error(DataCatalog::NotFound)
+    end
+
+    it "should raise BadRequest if primary key's type is changed" do
+      executing do
+        @user.update_api_key!(@user.api_keys[0].id, {
+          :key_type => "valet"
+        })
+      end.should raise_error(DataCatalog::BadRequest)
+    end
+  end # describe "#update_api_key!"
+
+  describe "#delete_api_key!" do
+    before do
+      @user = create_user_with_2_keys
+    end
+    
+    it "should delete a key for the user" do
+      @user.delete_api_key!(@user.api_keys[1].id).should be_true
+      @user.api_keys.length.should == 1
+    end
+    
+    it "should raise Conflict if deleting the primary key" do
+      executing do
+        @user.delete_api_key!(@user.api_keys[0].id)
+      end.should raise_error(DataCatalog::Conflict)
+      @user.api_keys.length.should == 2
+    end
+  end # describe "#delete_api_key!"
+  
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification 
+name: datacatalog
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Luigi Montanez
+- David James
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-05 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Ruby library that wraps the National Data Catalog API
+email: luigi@sunlightfoundation.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.md
+- README.md
+files: 
+- .gitignore
+- CHANGES.md
+- LICENSE.md
+- README.md
+- Rakefile
+- VERSION
+- datacatalog.gemspec
+- doc/api_key_spec_for_rest_api.txt
+- doc/api_key_spec_for_ruby_api.rb
+- doc/mocking_options.md
+- lib/datacatalog.rb
+- lib/datacatalog/api_key.rb
+- lib/datacatalog/base.rb
+- lib/datacatalog/source.rb
+- lib/datacatalog/user.rb
+- sandbox_api.yml.example
+- spec/api_key_spec.rb
+- spec/base_spec.rb
+- spec/source_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/user_spec.rb
+has_rdoc: true
+homepage: http://github.com/sunlightlabs/datacatalog
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Wrapper for the National Data Catalog API
+test_files: 
+- spec/api_key_spec.rb
+- spec/base_spec.rb
+- spec/source_spec.rb
+- spec/spec_helper.rb
+- spec/user_spec.rb