datacatalog 0.4.3 → 0.4.4

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/Rakefile

@@ -5,7 +5,7 @@ begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
     gem.name = "datacatalog"
-    gem.version = '0.4.3'
+    gem.version = '0.4.4'
     gem.rubyforge_project = "datacatalog"
     gem.summary = %Q{Client for the National Data Catalog API}
     gem.description = %Q{A Ruby client library for the National Data Catalog API}

data/datacatalog.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{datacatalog}
-  s.version = "0.4.3"
+  s.version = "0.4.4"
 
   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-12-09}
+  s.date = %q{2009-12-10}
   s.description = %q{A Ruby client library for the National Data Catalog API}
   s.email = %q{luigi@sunlightfoundation.com}
   s.extra_rdoc_files = [
@@ -30,6 +30,7 @@ Gem::Specification.new do |s|
      "lib/resources/api_key.rb",
      "lib/resources/comment.rb",
      "lib/resources/document.rb",
+     "lib/resources/download.rb",
      "lib/resources/favorite.rb",
      "lib/resources/note.rb",
      "lib/resources/organization.rb",
@@ -69,6 +70,7 @@ Gem::Specification.new do |s|
      "spec/comment_spec.rb",
      "spec/datacatalog_spec.rb",
      "spec/document_spec.rb",
+     "spec/download_spec.rb",
      "spec/favorite_spec.rb",
      "spec/note_spec.rb",
      "spec/organization_spec.rb",

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/lib/resources/download.rb

@@ -0,0 +1,33 @@
+module DataCatalog
+
+  class Download < Base
+    
+    def self.all(conditions={})
+      cursor(uri, query_hash(conditions))
+    end
+
+    def self.get(id)
+      one(http_get(uri(id)))
+    end
+
+    def self.create(params={})
+      one(http_post(uri, :body => params))
+    end
+
+    def self.update(id, params={})
+      one(http_put(uri(id), :body => params))
+    end
+
+    def self.destroy(id)
+      one(http_delete(uri(id)))
+    end
+
+    # == Helpers
+    
+    def self.uri(id=nil)
+      "/downloads/#{id}"
+    end
+
+  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/datacatalog_spec.rb

@@ -1,36 +1,36 @@
-require File.dirname(__FILE__) + '/spec_helper'
-include DataCatalog
-
-describe DataCatalog do
-
-  describe "module accessors" do
-    it "should access the API Key" do
-      DataCatalog.api_key = "4159179f32ff8fefd2c6d48b7e675e7736bf1357"
-      DataCatalog.api_key.should == "4159179f32ff8fefd2c6d48b7e675e7736bf1357"
-    end
-
-    it "should access the base URI" do
-      DataCatalog.base_uri = 'http://somehost.com'
-      DataCatalog.base_uri.should == 'http://somehost.com'
-    end
-  end
-
-  describe ".with_key" do
-    it "should set the API key within the block" do
-      regular_key = '4159179f32ff8fefd2c6d48b7e675e7736bf1357'
-      DataCatalog.api_key = regular_key
-      temporary_key = '0000123400001234000012340000123400001234'
-      DataCatalog.with_key(temporary_key) do
-        DataCatalog.api_key.should == temporary_key
-      end
-      DataCatalog.api_key.should == regular_key
-    end
-    
-    it "should return the last value in the block" do
-      DataCatalog.with_key("0000444400004444") do
-        42
-      end.should == 42
-    end
-  end
-
-end
+require File.dirname(__FILE__) + '/spec_helper'
+include DataCatalog
+
+describe DataCatalog do
+
+  describe "module accessors" do
+    it "should access the API Key" do
+      DataCatalog.api_key = "4159179f32ff8fefd2c6d48b7e675e7736bf1357"
+      DataCatalog.api_key.should == "4159179f32ff8fefd2c6d48b7e675e7736bf1357"
+    end
+
+    it "should access the base URI" do
+      DataCatalog.base_uri = 'http://somehost.com'
+      DataCatalog.base_uri.should == 'http://somehost.com'
+    end
+  end
+
+  describe ".with_key" do
+    it "should set the API key within the block" do
+      regular_key = '4159179f32ff8fefd2c6d48b7e675e7736bf1357'
+      DataCatalog.api_key = regular_key
+      temporary_key = '0000123400001234000012340000123400001234'
+      DataCatalog.with_key(temporary_key) do
+        DataCatalog.api_key.should == temporary_key
+      end
+      DataCatalog.api_key.should == regular_key
+    end
+    
+    it "should return the last value in the block" do
+      DataCatalog.with_key("0000444400004444") do
+        42
+      end.should == 42
+    end
+  end
+
+end

data/spec/download_spec.rb

@@ -0,0 +1,86 @@
+require File.dirname(__FILE__) + '/spec_helper'
+include DataCatalog
+
+describe Download do
+  
+  before do
+    setup_api
+    clean_slate
+    @user = User.create(
+      :name  => "Ted Smith",
+      :email => "ted@email.com"
+    )
+    @source = Source.create(
+      :title       => "Some FCC Data",
+      :url         => "http://fcc.gov/somedata.csv",
+      :source_type => "dataset"
+    )
+    @download = Download.create(
+      :source_id  => @source.id,
+      :format     => "CSV",        
+      :url        => "http://somedata.gov/test.csv",
+      :preview    => "1,2,3,4,5"
+    )
+  end
+  
+  describe ".create" do
+
+    it "should create a download when valid params are passed in" do
+      refreshed_source = Source.get(@source.id)
+      refreshed_source.downloads.first.url.should == "http://somedata.gov/test.csv"
+    end
+    
+  end # describe ".create"
+  
+  describe ".get" do
+  
+    it "should return a download" do
+      download = Download.get(@download.id)
+      download.should be_an_instance_of(Download)
+      download.source_id.should == @source.id
+    end
+    
+    it "should raise NotFound if no download exists" do
+      executing do
+        Download.get(mangle(@download.id))
+      end.should raise_error(NotFound)
+    end
+    
+  end # describe ".get"
+  
+  describe ".all" do
+  
+    it "should return an enumeration of downloads" do
+      downloads = Download.all(:source_id => @source.id)
+      downloads.each do |o|
+        o.should be_an_instance_of(Download)
+      end
+    end
+    
+  end # describe ".all"
+  
+  describe ".update" do
+  
+    it "should update an existing download with valid params" do
+      Download.update(@download.id, :preview => "10,11,12,13")      
+      refreshed_download = Download.get(@download.id)
+      refreshed_download.preview.should == "10,11,12,13"
+    end
+    
+  end # describe ".update"
+
+  describe ".destroy" do
+
+    it "should destroy an existing download as an admin" do
+      Download.destroy(@download.id).should be_true
+    end
+    
+    it "should raise NotFound when attempting to destroy non-existing download" do
+      executing do
+        Download.destroy(mangle(@download.id))
+      end.should raise_error(NotFound)
+    end
+    
+  end # describe ".destroy"
+  
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: datacatalog
 version: !ruby/object:Gem::Version 
-  version: 0.4.3
+  version: 0.4.4
 platform: ruby
 authors: 
 - Luigi Montanez
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-09 00:00:00 -05:00
+date: 2009-12-10 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -96,6 +96,7 @@ files:
 - lib/resources/api_key.rb
 - lib/resources/comment.rb
 - lib/resources/document.rb
+- lib/resources/download.rb
 - lib/resources/favorite.rb
 - lib/resources/note.rb
 - lib/resources/organization.rb
@@ -156,6 +157,7 @@ test_files:
 - spec/comment_spec.rb
 - spec/datacatalog_spec.rb
 - spec/document_spec.rb
+- spec/download_spec.rb
 - spec/favorite_spec.rb
 - spec/note_spec.rb
 - spec/organization_spec.rb