datacatalog 0.4.16 → 0.4.17

data/Rakefile

@@ -5,7 +5,7 @@ begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
     gem.name = "datacatalog"
-    gem.version = '0.4.16'
+    gem.version = '0.4.17'
     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.16"
+  s.version = "0.4.17"
 
   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-08-10}
+  s.date = %q{2010-08-11}
   s.description = %q{A Ruby client library for the National Data Catalog API}
   s.email = %q{luigi@sunlightfoundation.com}
   s.extra_rdoc_files = [
@@ -46,6 +46,7 @@ Gem::Specification.new do |s|
      "spec/about_spec.rb",
      "spec/api_key_spec.rb",
      "spec/base_spec.rb",
+     "spec/broken_link_spec.rb",
      "spec/comment_spec.rb",
      "spec/datacatalog_spec.rb",
      "spec/document_spec.rb",
@@ -77,6 +78,7 @@ Gem::Specification.new do |s|
     "spec/about_spec.rb",
      "spec/api_key_spec.rb",
      "spec/base_spec.rb",
+     "spec/broken_link_spec.rb",
      "spec/comment_spec.rb",
      "spec/datacatalog_spec.rb",
      "spec/document_spec.rb",

data/lib/resources/broken_link.rb

@@ -14,6 +14,10 @@ module DataCatalog
       one(http_delete(uri(id)))
     end
 
+    def self.first(conditions={})
+      _first(http_get(uri, :query => query_hash(conditions)))
+    end
+
     def self.get(id)
       one(http_get(uri(id)))
     end

data/lib/resources/favorite.rb

@@ -14,6 +14,10 @@ module DataCatalog
       one(http_delete(uri(id)))
     end
 
+    def self.first(conditions={})
+      _first(http_get(uri, :query => query_hash(conditions)))
+    end
+
     def self.get(id)
       one(http_get(uri(id)))
     end

data/spec/about_spec.rb

@@ -19,7 +19,6 @@ describe DataCatalog do
   end
 
   describe ".version_at_least?" do
-
     it "should return false if below the actual version" do
       version_mock = mock(Object.new).version { '1.0.0' }
       mock(About).get { version_mock }

data/spec/base_spec.rb

@@ -3,6 +3,13 @@ include DataCatalog
 
 describe Base do
 
+  def make_response(body, code)
+    response = Object.new
+    stub(response).code { code }
+    stub(response).body { body }
+    response
+  end
+
   before do
     setup_api
   end
@@ -22,43 +29,39 @@ describe Base do
   end
 
   describe ".check_status" do
-    it "should return nil on 200 OK" do
-      response = HTTParty::Response.new(nil, '{"foo":"bar"}', 200, 'OK', {})
-      Base.check_status(response).should be_nil
+    it "should return response on 200 OK" do
+      response = make_response("{}", 200)
+      Base.check_status(response).should == response
     end
 
     it "should raise BadRequest on 400 Bad Request" do
-      response = HTTParty::Response.new(nil, '[]', 400, 'Bad Request', {})
       executing do
-        Base.check_status(response)
+        Base.check_status(make_response("{}", 400))
       end.should raise_error(BadRequest)
     end
 
     it "should raise Unauthorized on 401 Unauthorized" do
-      response = HTTParty::Response.new(nil, '', 401, 'Unauthorized', {})
       executing do
-        Base.check_status(response)
+        Base.check_status(make_response("{}", 401))
       end.should raise_error(Unauthorized)
     end
 
     it "should raise NotFound on 404 Not Found" do
-      response = HTTParty::Response.new(nil, '[]', 404, 'Not Found', {})
       executing do
-        Base.check_status(response)
+        Base.check_status(make_response("{}", 404))
       end.should raise_error(NotFound)
     end
 
     it "should raise InternalServerError on 500 Internal Server Error" do
-      response = HTTParty::Response.new(nil, '', 500, 'Internal Server Error', {})
       executing do
-        Base.check_status(response)
+        Base.check_status(make_response("{}", 500))
       end.should raise_error(InternalServerError)
     end
   end
-
+  
   describe ".error" do
-    it "should ... when body is blank" do
-      response = HTTParty::Response.new(nil, '', 404, 'Not Found', {})
+    it "should be correct when body is blank and code is 404" do
+      response = make_response('', 404)
       begin
         e = Base.error(NotFound, response)
       rescue NotFound => e
@@ -69,7 +72,7 @@ describe Base do
     end
 
     it "should be correct when body is an empty hash" do
-      response = HTTParty::Response.new(nil, '{}', 404, 'Not Found', {})
+      response = make_response('{}', 404)
       begin
         e = Base.error(NotFound, response).should == "Response was empty"
       rescue NotFound => e
@@ -80,7 +83,7 @@ describe Base do
     end
 
     it "should be correct when body is an empty array" do
-      response = HTTParty::Response.new(nil, '[]', 404, 'Not Found', {})
+      response = make_response('[]', 404)
       begin
         e = Base.error(NotFound, response)
       rescue NotFound => e
@@ -91,8 +94,7 @@ describe Base do
     end
 
     it "should be correct when body has errors hash" do
-      errors = '{"errors":["bad_error"]}'
-      response = HTTParty::Response.new(nil, errors, 400, 'Bad Request', {})
+      response = make_response('{"errors":["bad_error"]}', 400)
       begin
         e = Base.error(BadRequest, response)
       rescue BadRequest => e
@@ -103,8 +105,7 @@ describe Base do
     end
 
     it "should be correct when body has hash" do
-      errors = '{"foo":["bar"]}'
-      response = HTTParty::Response.new(nil, errors, 400, 'Bad Request', {})
+      response = make_response('{"foo":["bar"]}', 400)
       begin
         e = Base.error(BadRequest, response)
       rescue BadRequest => e

data/spec/broken_link_spec.rb

@@ -0,0 +1,101 @@
+require File.dirname(__FILE__) + '/spec_helper'
+include DataCatalog
+
+describe BrokenLink do
+
+  before do
+    setup_api
+    clean_slate
+    @user = User.create(
+      :name    => "Q. Rater",
+      :email   => "q_rater@email.com",
+      :curator => true
+    )
+    @source = Source.create(
+      :title       => "Some FCC Data",
+      :url         => "http://fcc.gov/somedata.csv",
+      :source_type => "dataset"
+    )
+    DataCatalog.with_key(@user.primary_api_key) do
+      @broken_link = BrokenLink.create({
+        :source_id       => @source.id,
+        :field           => "url",
+        :destination_url => "http://broken.gov/abx834",
+        :status          => 404,
+      })
+    end
+  end
+  
+  describe ".all" do
+    it "should return an enumeration of broken_links" do
+      broken_links = BrokenLink.all(:user_id => @user.id)
+      broken_links.each do |o|
+        o.should be_an_instance_of(BrokenLink)
+      end
+    end
+  end
+
+  describe ".create" do
+    # (successful create is exercised in before block)
+
+    it "should fail with invalid params" do
+      begin
+        BrokenLink.create(:mad => "hatter")
+      rescue BadRequest => e
+        e.errors.should == { "invalid_params" => ["mad"] }
+      end
+    end
+
+    it "should fail when missing params" do
+      begin
+        BrokenLink.create()
+      rescue BadRequest => e
+        e.errors.should == {
+          "destination_url" => ["can't be empty"],
+          "field"           => ["can't be empty"],
+          "status"          => ["can't be empty"],
+          "base"            => ["source_id or organization_id needed"]
+        }
+      end
+    end
+  end
+
+  describe ".destroy" do
+    it "should destroy an existing broken_link as an admin" do
+      BrokenLink.destroy(@broken_link.id).should be_true
+    end
+
+    it "should destroy an existing broken_link as the user" do
+      DataCatalog.with_key(@user.primary_api_key) do
+        BrokenLink.destroy(@broken_link.id).should be_true
+      end
+    end
+
+    it "should raise NotFound when attempting to destroy non-existing broken_link" do
+      executing do
+        BrokenLink.destroy(mangle(@broken_link.id))
+      end.should raise_error(NotFound)
+    end
+  end
+
+  describe ".first" do
+    it "should return the first BrokenLink" do
+      BrokenLink.first.id.should == @broken_link.id
+    end
+  end
+
+  describe ".get" do
+    it "should return a broken_link" do
+      broken_link = BrokenLink.get(@broken_link.id)
+      broken_link.should be_an_instance_of(BrokenLink)
+      broken_link.source_id.should == @source.id
+    end
+
+    it "should raise NotFound if no broken_link exists" do
+      executing do
+        BrokenLink.get(mangle(@broken_link.id))
+      end.should raise_error(NotFound)
+    end
+  end
+
+end

data/spec/comment_spec.rb

@@ -15,39 +15,6 @@ describe Comment do
       :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.")
-      end
-      @comment.should be_an_instance_of(Comment)
-
-      refreshed_source = Source.get(@source.id)
-      refreshed_source.comments.first.text.should == "The first comment."
-      refreshed_source.comments.first.user.name.should == "Ted Smith"
-    end
-  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.")
-      end
-    end
-
-    it "should return a comment" do
-      comment = Comment.get(@comment.id)
-      comment.should be_an_instance_of(Comment)
-      comment.text.should == "The first comment."
-    end
-
-    it "should raise NotFound if no comment exists" do
-      executing do
-        Comment.get(mangle(@comment.id))
-      end.should raise_error(NotFound)
-    end
-  end
-
   describe ".all" do
     before do
       @john = User.create(
@@ -72,20 +39,15 @@ describe Comment do
     end
   end
 
-  describe ".update" do
-    before do
+  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.")
       end
-    end
-
-    it "should update an existing comment with valid params" do
-      DataCatalog.with_key(@user.primary_api_key) do
-        Comment.update(@comment.id, :text => "The first comment, updated.")
-      end
+      @comment.should be_an_instance_of(Comment)
 
       refreshed_source = Source.get(@source.id)
-      refreshed_source.comments.first.text.should == "The first comment, updated."
+      refreshed_source.comments.first.text.should == "The first comment."
       refreshed_source.comments.first.user.name.should == "Ted Smith"
     end
   end
@@ -114,4 +76,42 @@ describe Comment do
     end
   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.")
+      end
+    end
+
+    it "should return a comment" do
+      comment = Comment.get(@comment.id)
+      comment.should be_an_instance_of(Comment)
+      comment.text.should == "The first comment."
+    end
+
+    it "should raise NotFound if no comment exists" do
+      executing do
+        Comment.get(mangle(@comment.id))
+      end.should raise_error(NotFound)
+    end
+  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.")
+      end
+    end
+
+    it "should update an existing comment with valid params" do
+      DataCatalog.with_key(@user.primary_api_key) do
+        Comment.update(@comment.id, :text => "The first comment, updated.")
+      end
+
+      refreshed_source = Source.get(@source.id)
+      refreshed_source.comments.first.text.should == "The first comment, updated."
+      refreshed_source.comments.first.user.name.should == "Ted Smith"
+    end
+  end
+
 end

data/spec/document_spec.rb

@@ -23,19 +23,43 @@ describe Document do
     end
   end
 
-  describe ".create" do
+  describe ".all" do
+    it "should return an enumeration of documents" do
+      documents = Document.all(:source_id => @source.id)
+      documents.each do |o|
+        o.should be_an_instance_of(Document)
+      end
+    end
+  end
 
+  describe ".create" do
     it "should create a document when valid params are passed in" do
       DataCatalog.with_key(@user.primary_api_key) do
         refreshed_source = Source.get(@source.id)
         refreshed_source.documents.first.text.should == "This is community documentation."
       end
     end
+  end
 
-  end # describe ".create"
+  describe ".destroy" do
+    it "should destroy an existing document as an admin" do
+      Document.destroy(@document.id).should be_true
+    end
 
-  describe ".get" do
+    it "should not destroy an existing document as the user" do
+      DataCatalog.with_key(@user.primary_api_key) do
+        executing { Document.destroy(@document.id) }.should raise_error(Unauthorized)
+      end
+    end
+
+    it "should raise NotFound when attempting to destroy non-existing document" do
+      executing do
+        Document.destroy(mangle(@document.id))
+      end.should raise_error(NotFound)
+    end
+  end
 
+  describe ".get" do
     it "should return a document" do
       document = Document.get(@document.id)
       document.should be_an_instance_of(Document)
@@ -47,22 +71,9 @@ describe Document do
         Document.get(mangle(@document.id))
       end.should raise_error(NotFound)
     end
-
-  end # describe ".get"
-
-  describe ".all" do
-
-    it "should return an enumeration of documents" do
-      documents = Document.all(:source_id => @source.id)
-      documents.each do |o|
-        o.should be_an_instance_of(Document)
-      end
-    end
-
-  end # describe ".all"
+  end
 
   describe ".update" do
-
     it "should update an existing document with valid params" do
       @document.previous_id.should be nil
       DataCatalog.with_key(@user.primary_api_key) do
@@ -73,27 +84,6 @@ describe Document do
       refreshed_document.text.should == "This is the updated document."
       refreshed_document.previous_id.should_not be nil
     end
+  end
 
-  end # describe ".update"
-
-  describe ".destroy" do
-
-    it "should destroy an existing document as an admin" do
-      Document.destroy(@document.id).should be_true
-    end
-
-    it "should not destroy an existing document as the user" do
-      DataCatalog.with_key(@user.primary_api_key) do
-        executing { Document.destroy(@document.id) }.should raise_error(Unauthorized)
-      end
-    end
-
-    it "should raise NotFound when attempting to destroy non-existing document" do
-      executing do
-        Document.destroy(mangle(@document.id))
-      end.should raise_error(NotFound)
-    end
-
-  end # describe ".destroy"
-
-end
+end