datacatalog 0.4.13 → 0.4.14

data/Rakefile

@@ -5,7 +5,7 @@ begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
     gem.name = "datacatalog"
-    gem.version = '0.4.13'
+    gem.version = '0.4.14'
     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.13"
+  s.version = "0.4.14"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Luigi Montanez", "David James"]
-  s.date = %q{2010-04-13}
+  s.date = %q{2010-04-28}
   s.description = %q{A Ruby client library for the National Data Catalog API}
   s.email = %q{luigi@sunlightfoundation.com}
   s.extra_rdoc_files = [
@@ -33,6 +33,8 @@ Gem::Specification.new do |s|
      "lib/resources/document.rb",
      "lib/resources/download.rb",
      "lib/resources/favorite.rb",
+     "lib/resources/importers.rb",
+     "lib/resources/imports.rb",
      "lib/resources/note.rb",
      "lib/resources/organization.rb",
      "lib/resources/rating.rb",
@@ -48,6 +50,8 @@ Gem::Specification.new do |s|
      "spec/document_spec.rb",
      "spec/download_spec.rb",
      "spec/favorite_spec.rb",
+     "spec/import_spec.rb",
+     "spec/importer_spec.rb",
      "spec/note_spec.rb",
      "spec/organization_spec.rb",
      "spec/rating_spec.rb",
@@ -76,6 +80,8 @@ Gem::Specification.new do |s|
      "spec/document_spec.rb",
      "spec/download_spec.rb",
      "spec/favorite_spec.rb",
+     "spec/import_spec.rb",
+     "spec/importer_spec.rb",
      "spec/note_spec.rb",
      "spec/organization_spec.rb",
      "spec/rating_spec.rb",

data/lib/resources/importers.rb

@@ -0,0 +1,33 @@
+module DataCatalog
+
+  class Importer < 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)
+      "/importers/#{id}"
+    end
+
+  end
+
+end

data/lib/resources/imports.rb

@@ -0,0 +1,33 @@
+module DataCatalog
+
+  class Import < 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)
+      "/imports/#{id}"
+    end
+
+  end
+
+end

data/spec/comment_spec.rb

@@ -8,17 +8,14 @@ describe Comment do
     clean_slate
     @user = User.create(
       :name  => "Ted Smith",
-      :email => "ted@email.com"
-    )
+      :email => "ted@email.com")
     @source = Source.create(
       :title       => "Some FCC Data",
       :url         => "http://fcc.gov/somedata.csv",
-      :source_type => "dataset"
-    )
+      :source_type => "dataset")
   end
   
   describe ".create" do
-
     it "should create a new comment when valid params are passed in" do
       DataCatalog.with_key(@user.primary_api_key) do
         @comment = Comment.create(:source_id => @source.id, :text => "The first comment.")
@@ -29,11 +26,9 @@ describe Comment do
       refreshed_source.comments.first.text.should == "The first comment."
       refreshed_source.comments.first.user.name.should == "Ted Smith"
     end
-
-  end # describe ".create"
+  end
 
   describe ".get" do
-
     before do
       DataCatalog.with_key(@user.primary_api_key) do
         @comment = Comment.create(:source_id => @source.id, :text => "The first comment.")
@@ -51,18 +46,17 @@ describe Comment do
         Comment.get(mangle(@comment.id))
       end.should raise_error(NotFound)
     end
-    
-  end # describe ".get"
+  end
 
   describe ".all" do
-
     before do
-      @john = User.create(:name  => "John Smith",
-                          :email => "john@email.com")
-      @data = Source.create(:title       => "Some FEC Data",
-                            :url         => "http://fec.gov/somedata.csv",
-                            :source_type => "dataset")
-                            
+      @john = User.create(
+        :name  => "John Smith",
+        :email => "john@email.com")
+      @data = Source.create(
+        :title       => "Some FEC Data",
+        :url         => "http://fec.gov/somedata.csv",
+        :source_type => "dataset")
       DataCatalog.with_key(@john.primary_api_key) do
         Comment.create(:source_id => @data.id, :text => "The first comment.")
         Comment.create(:source_id => @data.id, :text => "The second comment.")
@@ -76,11 +70,9 @@ describe Comment do
         comments[i].text.should == "The #{nth} comment."
       end
     end
-    
-  end # describe ".all"
+  end
 
   describe ".update" do
-
     before do
       DataCatalog.with_key(@user.primary_api_key) do
         @comment = Comment.create(:source_id => @source.id, :text => "The first comment.")
@@ -96,11 +88,9 @@ describe Comment do
       refreshed_source.comments.first.text.should == "The first comment, updated."
       refreshed_source.comments.first.user.name.should == "Ted Smith"
     end
-    
-  end # describe ".update" 
+  end
 
   describe ".destroy" do
-
     before do
       DataCatalog.with_key(@user.primary_api_key) do
         @comment = Comment.create(:source_id => @source.id, :text => "The first comment.")
@@ -122,7 +112,6 @@ describe Comment do
         Comment.destroy(mangle(@comment.id))
       end.should raise_error(NotFound)
     end
-    
-  end # describe ".destroy"
+  end
 
-end
+end

data/spec/download_spec.rb

@@ -24,16 +24,13 @@ describe Download do
   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"
+  end
   
   describe ".get" do
-  
     it "should return a download" do
       download = Download.get(@download.id)
       download.should be_an_instance_of(Download)
@@ -45,32 +42,26 @@ describe Download do
         Download.get(mangle(@download.id))
       end.should raise_error(NotFound)
     end
-    
-  end # describe ".get"
+  end
   
   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"
+  end
   
   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"
+  end
 
   describe ".destroy" do
-
     it "should destroy an existing download as an admin" do
       Download.destroy(@download.id).should be_true
     end
@@ -80,7 +71,6 @@ describe Download do
         Download.destroy(mangle(@download.id))
       end.should raise_error(NotFound)
     end
-    
-  end # describe ".destroy"
+  end
   
-end
+end

data/spec/import_spec.rb

@@ -0,0 +1,119 @@
+require File.dirname(__FILE__) + '/spec_helper'
+include DataCatalog
+
+describe Import do
+  
+  before do
+    setup_api
+    clean_slate
+    @user = User.create(
+      :name  => "Ted Smith",
+      :email => "ted@email.com"
+    )
+    @importer = Importer.create(
+      :name => "National Data Registry of Bats")
+    timestamp = Time.now
+    @imports = [
+      Import.create({
+        :importer_id => @importer.id,
+        :status      => 'success',
+        :started_at  => timestamp - 3645,
+        :finished_at => timestamp - 3600,
+      }),
+      Import.create({
+        :importer_id => @importer.id,
+        :status      => 'success',
+        :started_at  => timestamp - 45,
+        :finished_at => timestamp,
+      }),
+    ]
+  end
+
+  describe ".get" do
+    it "should return an import as a basic user" do
+      import = DataCatalog.with_key(@user.primary_api_key) do
+        Import.get(@imports[0].id)
+      end
+      import.should be_an_instance_of(Import)
+      import.id.should == @imports[0].id
+    end
+
+    it "should raise NotFound if no import exists" do
+      executing do
+        Import.get(mangle(@imports[0].id))
+      end.should raise_error(NotFound)
+    end
+  end
+
+  describe ".create" do
+    # (successful create is exercised in before block)
+
+    it "a basic user should be unauthorized" do
+      executing do
+        DataCatalog.with_key(@user.primary_api_key) do
+          Import.create(:name => "Idaho Data Catalog")
+        end
+      end.should raise_error(Unauthorized)
+    end
+
+    it "should fail with invalid params" do
+      executing do
+        Import.create(:cave => "The Batcave")
+      end.should raise_error(BadRequest)
+    end
+
+    it "should fail when missing params" do
+      executing do
+        Import.create()
+      end.should raise_error(BadRequest)
+    end
+  end
+  
+  describe ".all" do
+    it "should return an enumeration of 2 imports" do
+      imports = Import.all
+      imports.length.should == 2
+      imports.each do |o|
+        o.should be_an_instance_of(Import)
+      end
+    end
+  end
+
+  describe ".update" do
+    it "a basic user should be unauthorized" do
+      executing do
+        DataCatalog.with_key(@user.primary_api_key) do
+          Import.update(@imports[0].id, :status => 'failure')
+        end
+      end.should raise_error(Unauthorized)
+    end
+
+    it "should update an existing import with valid params" do
+      @imports[0].status.should == 'success'
+      Import.update(@imports[0].id, :status => 'failure')
+      import = Import.get(@imports[0].id)
+      import.status.should == 'failure'
+    end
+  end
+
+  describe ".destroy" do
+    it "should destroy an existing import as an admin" do
+      Import.destroy(@imports[0].id).should be_true
+    end
+    
+    it "should not destroy an existing import as a basic user" do
+      DataCatalog.with_key(@user.primary_api_key) do
+        executing do
+          Import.destroy(@imports[0].id)
+        end.should raise_error(Unauthorized)
+      end
+    end
+    
+    it "should raise NotFound when attempting to destroy non-existing import" do
+      executing do
+        Import.destroy(mangle(@imports[0].id))
+      end.should raise_error(NotFound)
+    end
+  end
+  
+end

data/spec/importer_spec.rb

@@ -0,0 +1,106 @@
+require File.dirname(__FILE__) + '/spec_helper'
+include DataCatalog
+
+describe Importer do
+  
+  before do
+    setup_api
+    clean_slate
+    @user = User.create(
+      :name  => "Ted Smith",
+      :email => "ted@email.com"
+    )
+    @importers = [
+      Importer.create(:name => "National Data Registry of Bats"),
+      Importer.create(:name => "Bat-Inspired Superheroes"),
+    ]
+  end
+
+  describe ".get" do
+    it "should return an importer as a basic user" do
+      importer = DataCatalog.with_key(@user.primary_api_key) do
+        Importer.get(@importers[0].id)
+      end
+      importer.should be_an_instance_of(Importer)
+      importer.id.should == @importers[0].id
+    end
+
+    it "should raise NotFound if no importer exists" do
+      executing do
+        Importer.get(mangle(@importers[0].id))
+      end.should raise_error(NotFound)
+    end
+  end
+
+  describe ".create" do
+    # (successful create is exercised in before block)
+
+    it "a basic user should be unauthorized" do
+      executing do
+        DataCatalog.with_key(@user.primary_api_key) do
+          Importer.create(:name => "Idaho Data Catalog")
+        end
+      end.should raise_error(Unauthorized)
+    end
+
+    it "should fail with invalid params" do
+      executing do
+        Importer.create(:cave => "The Batcave")
+      end.should raise_error(BadRequest)
+    end
+
+    it "should fail when missing params" do
+      executing do
+        Importer.create()
+      end.should raise_error(BadRequest)
+    end
+  end
+  
+  describe ".all" do
+    it "should return an enumeration of 2 importers" do
+      importers = Importer.all
+      importers.length.should == 2
+      importers.each do |o|
+        o.should be_an_instance_of(Importer)
+      end
+    end
+  end
+
+  describe ".update" do
+    it "a basic user should be unauthorized" do
+      executing do
+        DataCatalog.with_key(@user.primary_api_key) do
+          Importer.update(@importers[0].id, :name => "International Bat Registry")
+        end
+      end.should raise_error(Unauthorized)
+    end
+
+    it "should update an existing importer with valid params" do
+      @importers[0].name.should == "National Data Registry of Bats"
+      Importer.update(@importers[0].id, :name => "International Bat Registry")
+      importer = Importer.get(@importers[0].id)
+      importer.name.should == "International Bat Registry"
+    end
+  end
+
+  describe ".destroy" do
+    it "should destroy an existing importer as an admin" do
+      Importer.destroy(@importers[0].id).should be_true
+    end
+    
+    it "should not destroy an existing importer as a basic user" do
+      DataCatalog.with_key(@user.primary_api_key) do
+        executing do
+          Importer.destroy(@importers[0].id)
+        end.should raise_error(Unauthorized)
+      end
+    end
+    
+    it "should raise NotFound when attempting to destroy non-existing importer" do
+      executing do
+        Importer.destroy(mangle(@importers[0].id))
+      end.should raise_error(NotFound)
+    end
+  end
+  
+end

data/spec/spec_helper.rb

@@ -9,7 +9,9 @@ alias :executing :lambda
 
 KLASSES = [
   DataCatalog::Source,
-  DataCatalog::Organization
+  DataCatalog::Organization,
+  DataCatalog::Importer,
+  DataCatalog::Import,
 ]
 
 def clean_slate

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 4
-  - 13
-  version: 0.4.13
+  - 14
+  version: 0.4.14
 platform: ruby
 authors: 
 - Luigi Montanez
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-13 00:00:00 -04:00
+date: 2010-04-28 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -128,6 +128,8 @@ files:
 - lib/resources/document.rb
 - lib/resources/download.rb
 - lib/resources/favorite.rb
+- lib/resources/importers.rb
+- lib/resources/imports.rb
 - lib/resources/note.rb
 - lib/resources/organization.rb
 - lib/resources/rating.rb
@@ -143,6 +145,8 @@ files:
 - spec/document_spec.rb
 - spec/download_spec.rb
 - spec/favorite_spec.rb
+- spec/import_spec.rb
+- spec/importer_spec.rb
 - spec/note_spec.rb
 - spec/organization_spec.rb
 - spec/rating_spec.rb
@@ -194,6 +198,8 @@ test_files:
 - spec/document_spec.rb
 - spec/download_spec.rb
 - spec/favorite_spec.rb
+- spec/import_spec.rb
+- spec/importer_spec.rb
 - spec/note_spec.rb
 - spec/organization_spec.rb
 - spec/rating_spec.rb