datacatalog 0.2.4 → 0.3.0

data/CHANGES.md

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

data/LICENSE.md

@@ -1,11 +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.
+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

@@ -1,34 +1,34 @@
-# 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](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.
+# 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](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/VERSION

@@ -1 +1 @@
-0.2.4
+0.3.0

data/datacatalog.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{datacatalog}
-  s.version = "0.2.4"
+  s.version = "0.3.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-10}
+  s.date = %q{2009-10-14}
   s.description = %q{A Ruby client library for the National Data Catalog API}
   s.email = %q{luigi@sunlightfoundation.com}
   s.extra_rdoc_files = [

data/lib/base.rb

@@ -1,77 +1,77 @@
-module DataCatalog
-
-  class Base < Mash
-    
-    DEFAULT_BASE_URI = 'http://api.nationaldatacatalog.com'
-
-    include HTTParty
-
-    format :json
-    base_uri DEFAULT_BASE_URI
-    
-    class << self
-      alias_method :_delete, :delete
-      alias_method :_get,    :get
-      alias_method :_post,   :post
-      alias_method :_put,    :put
-      
-      undef_method :delete
-      undef_method :get
-      undef_method :post
-      undef_method :put
-    end
-    
-    def self.http_delete(path, options={})
-      check_status(_delete(path, options))
-    end
-    
-    def self.http_get(path, options={})
-      check_status(_get(path, options))
-    end
-
-    def self.http_post(path, options={})
-      check_status(_post(path, options))
-    end
-
-    def self.http_put(path, options={})
-      check_status(_put(path, options))
-    end
-
-    # == protected
-    
-    def self.check_status(response)
-      case response.code
-      when 400: raise BadRequest,          error(response)
-      when 401: raise Unauthorized,        error(response)
-      when 403: raise Forbidden,           error(response)
-      when 404: raise NotFound,            error(response)
-      when 409: raise Conflict,            error(response)
-      when 500: raise InternalServerError, error(response)
-      end
-      response
-    end
-    
-    def self.error(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.many(response)
-      response.map { |item| new(item) }
-    end
-
-    def self.one(response)
-      response.blank? ? nil : new(response)
-    end
-
-  end
-
-end
+module DataCatalog
+
+  class Base < Mash
+    
+    DEFAULT_BASE_URI = 'http://api.nationaldatacatalog.com'
+
+    include HTTParty
+
+    format :json
+    base_uri DEFAULT_BASE_URI
+    
+    class << self
+      alias_method :_delete, :delete
+      alias_method :_get,    :get
+      alias_method :_post,   :post
+      alias_method :_put,    :put
+      
+      undef_method :delete
+      undef_method :get
+      undef_method :post
+      undef_method :put
+    end
+    
+    def self.http_delete(path, options={})
+      check_status(_delete(path, options))
+    end
+    
+    def self.http_get(path, options={})
+      check_status(_get(path, options))
+    end
+
+    def self.http_post(path, options={})
+      check_status(_post(path, options))
+    end
+
+    def self.http_put(path, options={})
+      check_status(_put(path, options))
+    end
+
+    # == protected
+    
+    def self.check_status(response)
+      case response.code
+      when 400: raise BadRequest,          error(response)
+      when 401: raise Unauthorized,        error(response)
+      when 403: raise Forbidden,           error(response)
+      when 404: raise NotFound,            error(response)
+      when 409: raise Conflict,            error(response)
+      when 500: raise InternalServerError, error(response)
+      end
+      response
+    end
+    
+    def self.error(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.many(response)
+      response.map { |item| new(item) }
+    end
+
+    def self.one(response)
+      response.blank? ? nil : new(response)
+    end
+
+  end
+
+end

data/lib/datacatalog.rb

@@ -1,8 +1,8 @@
-require 'rubygems'
-require 'activesupport'
-require 'httparty'
-require 'mash'
-
-require File.dirname(__FILE__) + '/main'
-require File.dirname(__FILE__) + '/base'
-Dir.glob(File.dirname(__FILE__) + '/resources/*.rb').each { |f| require f }
+require 'rubygems'
+require 'activesupport'
+require 'httparty'
+require 'mash'
+
+require File.dirname(__FILE__) + '/main'
+require File.dirname(__FILE__) + '/base'
+Dir.glob(File.dirname(__FILE__) + '/resources/*.rb').each { |f| require f }

data/lib/main.rb

@@ -1,41 +1,41 @@
-module DataCatalog
-  
-  # == Exceptions
-  
-  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
-  
-  # == Accessors
-  
-  def self.api_key
-    Base.default_params[:api_key]
-  end
-  
-  def self.api_key=(key)
-    Base.default_params :api_key => key
-  end
-  
-  def self.base_uri
-    Base.base_uri
-  end
-  
-  def self.base_uri=(uri)
-    Base.base_uri(uri.blank? ? Base::DEFAULT_BASE_URI : uri)
-  end
-  
-  def self.with_key(temp_key)
-    original_key = DataCatalog.api_key
-    DataCatalog.api_key = temp_key
-    result = yield
-    DataCatalog.api_key = original_key
-    result
-  end
-
-end
+module DataCatalog
+  
+  # == Exceptions
+  
+  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
+  
+  # == Accessors
+  
+  def self.api_key
+    Base.default_params[:api_key]
+  end
+  
+  def self.api_key=(key)
+    Base.default_params :api_key => key
+  end
+  
+  def self.base_uri
+    Base.base_uri
+  end
+  
+  def self.base_uri=(uri)
+    Base.base_uri(uri.blank? ? Base::DEFAULT_BASE_URI : uri)
+  end
+  
+  def self.with_key(temp_key)
+    original_key = DataCatalog.api_key
+    DataCatalog.api_key = temp_key
+    result = yield
+    DataCatalog.api_key = original_key
+    result
+  end
+
+end

data/sandbox_api.yml.example

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

data/spec/about_spec.rb

@@ -1,21 +1,21 @@
-require File.dirname(__FILE__) + '/spec_helper'
-include DataCatalog
-
-describe DataCatalog do
-
-  describe ".about" do
-    before do
-      setup_api
-    end
-
-    it "should return information about the API" do
-      about = About.get
-      about.should be_an_instance_of(About)
-      about.name.should == "National Data Catalog API"
-      about.project_page.should == {
-        "href" => "http://sunlightlabs.com/projects/datacatalog/"
-      }
-    end
-  end
-
-end
+require File.dirname(__FILE__) + '/spec_helper'
+include DataCatalog
+
+describe DataCatalog do
+
+  describe ".about" do
+    before do
+      setup_api
+    end
+
+    it "should return information about the API" do
+      about = About.get
+      about.should be_an_instance_of(About)
+      about.name.should == "National Data Catalog API"
+      about.project_page.should == {
+        "href" => "http://sunlightlabs.com/projects/datacatalog/"
+      }
+    end
+  end
+
+end

data/spec/api_key_spec.rb

@@ -1,145 +1,145 @@
-require File.dirname(__FILE__) + '/spec_helper'
-include DataCatalog
-
-module ApiKeyHelpers
-  def create_user
-    User.create({
-      :name  => "Ted Smith",
-      :email => "ted@email.com"
-    })
-  end
-  
-  def create_user_with_2_keys
-    user = create_user
-    ApiKey.create(user.id, {
-      :purpose  => "Civic hacking",
-      :key_type => "application"
-    })
-    User.get(user.id)
-  end
-end
-
-describe ApiKey do
-  include ApiKeyHelpers
-
-  before do
-    setup_api
-    clean_slate
-  end
-
-  describe ".all" do
-    before do
-      @user = create_user_with_2_keys
-      @api_keys = ApiKey.all(@user.id)
-    end
-  
-    it "should return an enumeration of API keys" do
-      @api_keys.each do |api_key|
-        api_key.should be_an_instance_of(ApiKey)
-      end
-    end
-  
-    it "should return correct titles" do
-      @api_keys.map(&:key_type).should == %w(primary application)
-    end
-  end
-
-  describe ".all with conditions" do
-    before do
-      @user = create_user_with_2_keys
-      @api_keys = ApiKey.all(@user.id, :key_type => "application")
-    end
-    
-    it "should return an enumeration of API keys" do
-      @api_keys.each do |api_key|
-        api_key.should be_an_instance_of(ApiKey)
-      end
-    end
-    
-    it "should return correct titles" do
-      @api_keys.map(&:key_type).should == %w(application)
-    end
-  end
-
-  describe ".create" do
-    it "should create a new API key from basic params" do
-      user = create_user_with_2_keys
-      api_key = ApiKey.create(user.id, {
-        :purpose  => "Data wrangling",
-        :key_type => "valet"
-      })
-      api_key.should be_an_instance_of(ApiKey)
-      api_key.key_type.should == "valet"
-    end
-  end
-
-  describe ".first" do
-    before do
-      @user = create_user_with_2_keys
-    end
-  
-    it "should return an API key" do
-      api_key = ApiKey.first(@user.id, :purpose => "Civic hacking")
-      api_key.should be_an_instance_of(ApiKey)
-      api_key.purpose.should == "Civic hacking"
-    end
-    
-    it "should return nil if nothing found" do
-      api_key = ApiKey.first(@user.id, :purpose => "Evil")
-      api_key.should be_nil
-    end
-  end
-
-  describe ".get" do
-    before do
-      @user = create_user_with_2_keys
-      @api_key = @user.api_keys[1]
-    end
-  
-    it "should return an API key" do
-      api_key = ApiKey.get(@user.id, @api_key.id)
-      api_key.should be_an_instance_of(ApiKey)
-      api_key.purpose.should == "Civic hacking"
-    end
-    
-    it "should raise NotFound if no API key exists" do
-      executing do
-        ApiKey.get(@user.id, mangle(@api_key.id))
-      end.should raise_error(NotFound)
-    end
-  end
-
-  describe ".update" do
-    before do
-      @user = create_user_with_2_keys
-      @api_key = @user.api_keys[1]
-    end
-  
-    it "should update an existing source from valid params" do
-      api_key = ApiKey.update(@user.id, @api_key.id, {
-        :purpose => "Local Government Reporting"
-      })
-      api_key.should be_an_instance_of(ApiKey)
-      api_key.purpose.should == "Local Government Reporting"
-    end
-  end
-
-  describe ".destroy" do
-    before do
-      @user = create_user_with_2_keys
-      @api_key = @user.api_keys[1]
-    end
-  
-    it "should destroy an existing source" do
-      result = ApiKey.destroy(@user.id, @api_key.id)
-      result.should be_true
-    end
-    
-    it "should raise NotFound if API key does not exist" do
-      executing do
-        ApiKey.destroy(@user.id, mangle(@api_key.id))
-      end.should raise_error(NotFound)
-    end
-  end
-
-end
+require File.dirname(__FILE__) + '/spec_helper'
+include DataCatalog
+
+module ApiKeyHelpers
+  def create_user
+    User.create({
+      :name  => "Ted Smith",
+      :email => "ted@email.com"
+    })
+  end
+  
+  def create_user_with_2_keys
+    user = create_user
+    ApiKey.create(user.id, {
+      :purpose  => "Civic hacking",
+      :key_type => "application"
+    })
+    User.get(user.id)
+  end
+end
+
+describe ApiKey do
+  include ApiKeyHelpers
+
+  before do
+    setup_api
+    clean_slate
+  end
+
+  describe ".all" do
+    before do
+      @user = create_user_with_2_keys
+      @api_keys = ApiKey.all(@user.id)
+    end
+  
+    it "should return an enumeration of API keys" do
+      @api_keys.each do |api_key|
+        api_key.should be_an_instance_of(ApiKey)
+      end
+    end
+  
+    it "should return correct titles" do
+      @api_keys.map(&:key_type).should == %w(primary application)
+    end
+  end
+
+  describe ".all with conditions" do
+    before do
+      @user = create_user_with_2_keys
+      @api_keys = ApiKey.all(@user.id, :key_type => "application")
+    end
+    
+    it "should return an enumeration of API keys" do
+      @api_keys.each do |api_key|
+        api_key.should be_an_instance_of(ApiKey)
+      end
+    end
+    
+    it "should return correct titles" do
+      @api_keys.map(&:key_type).should == %w(application)
+    end
+  end
+
+  describe ".create" do
+    it "should create a new API key from basic params" do
+      user = create_user_with_2_keys
+      api_key = ApiKey.create(user.id, {
+        :purpose  => "Data wrangling",
+        :key_type => "valet"
+      })
+      api_key.should be_an_instance_of(ApiKey)
+      api_key.key_type.should == "valet"
+    end
+  end
+
+  describe ".first" do
+    before do
+      @user = create_user_with_2_keys
+    end
+  
+    it "should return an API key" do
+      api_key = ApiKey.first(@user.id, :purpose => "Civic hacking")
+      api_key.should be_an_instance_of(ApiKey)
+      api_key.purpose.should == "Civic hacking"
+    end
+    
+    it "should return nil if nothing found" do
+      api_key = ApiKey.first(@user.id, :purpose => "Evil")
+      api_key.should be_nil
+    end
+  end
+
+  describe ".get" do
+    before do
+      @user = create_user_with_2_keys
+      @api_key = @user.api_keys[1]
+    end
+  
+    it "should return an API key" do
+      api_key = ApiKey.get(@user.id, @api_key.id)
+      api_key.should be_an_instance_of(ApiKey)
+      api_key.purpose.should == "Civic hacking"
+    end
+    
+    it "should raise NotFound if no API key exists" do
+      executing do
+        ApiKey.get(@user.id, mangle(@api_key.id))
+      end.should raise_error(NotFound)
+    end
+  end
+
+  describe ".update" do
+    before do
+      @user = create_user_with_2_keys
+      @api_key = @user.api_keys[1]
+    end
+  
+    it "should update an existing source from valid params" do
+      api_key = ApiKey.update(@user.id, @api_key.id, {
+        :purpose => "Local Government Reporting"
+      })
+      api_key.should be_an_instance_of(ApiKey)
+      api_key.purpose.should == "Local Government Reporting"
+    end
+  end
+
+  describe ".destroy" do
+    before do
+      @user = create_user_with_2_keys
+      @api_key = @user.api_keys[1]
+    end
+  
+    it "should destroy an existing source" do
+      result = ApiKey.destroy(@user.id, @api_key.id)
+      result.should be_true
+    end
+    
+    it "should raise NotFound if API key does not exist" do
+      executing do
+        ApiKey.destroy(@user.id, mangle(@api_key.id))
+      end.should raise_error(NotFound)
+    end
+  end
+
+end