datacatalog 0.3.3 → 0.3.4

data/Rakefile

@@ -5,7 +5,7 @@ begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
     gem.name = "datacatalog"
-    gem.version = '0.3.3'
+    gem.version = '0.3.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.3.3"
+  s.version = "0.3.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-11-03}
+  s.date = %q{2009-11-04}
   s.description = %q{A Ruby client library for the National Data Catalog API}
   s.email = %q{luigi@sunlightfoundation.com}
   s.extra_rdoc_files = [
@@ -27,6 +27,7 @@ Gem::Specification.new do |s|
      "lib/main.rb",
      "lib/resources/about.rb",
      "lib/resources/api_key.rb",
+     "lib/resources/comment.rb",
      "lib/resources/organization.rb",
      "lib/resources/source.rb",
      "lib/resources/user.rb",
@@ -34,6 +35,7 @@ Gem::Specification.new do |s|
      "spec/about_spec.rb",
      "spec/api_key_spec.rb",
      "spec/base_spec.rb",
+     "spec/comment_spec.rb",
      "spec/datacatalog_spec.rb",
      "spec/organization_spec.rb",
      "spec/setup_api.rb",
@@ -55,6 +57,7 @@ Gem::Specification.new do |s|
     "spec/about_spec.rb",
      "spec/api_key_spec.rb",
      "spec/base_spec.rb",
+     "spec/comment_spec.rb",
      "spec/datacatalog_spec.rb",
      "spec/organization_spec.rb",
      "spec/setup_api.rb",

data/lib/resources/comment.rb

@@ -0,0 +1,33 @@
+module DataCatalog
+
+  class Comment < Base
+    
+    def self.all(conditions={})      
+      many(http_get(uri, :query => query_hash(conditions)))
+    end
+
+    def self.create(params={})
+      one(http_post(uri, :body => params))
+    end
+
+    def self.destroy(id)
+      one(http_delete(uri(id)))
+    end
+    
+    def self.get(id)
+      one(http_get(uri(id)))
+    end
+    
+    def self.update(id, params={})
+      one(http_put(uri(id), :body => params))
+    end
+
+    # == Helpers
+    
+    def self.uri(id=nil)
+      "/comments/#{id}"
+    end
+
+  end
+
+end

data/spec/comment_spec.rb

@@ -0,0 +1,126 @@
+require File.dirname(__FILE__) + '/spec_helper'
+include DataCatalog
+
+describe Comment 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")
+  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 ".create"
+
+  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 ".get"
+
+  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")
+                            
+      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.")
+      end
+    end
+
+    it "should return a set of all user's comments" do
+      comments = Comment.all(:user_id => @john.id)
+      comments.first.should be_an_instance_of(Comment)
+      ["first", "second"].each_with_index do |nth, i|
+        comments[i].text.should == "The #{nth} comment."
+      end
+    end
+    
+  end # describe ".all"
+
+  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 # describe ".update" 
+
+  describe ".destroy" 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 destroy an existing comment as an admin" do
+      Comment.destroy(@comment.id).should be_true
+    end
+    
+    it "should destroy an existing comment as the user" do
+      DataCatalog.with_key(@user.primary_api_key) do
+        Comment.destroy(@comment.id).should be_true
+      end
+    end
+    
+    it "should raise NotFound when attempting to destroy non-existing comment" do
+      executing do
+        Comment.destroy(mangle(@comment.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.3.3
+  version: 0.3.4
 platform: ruby
 authors: 
 - Luigi Montanez
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-03 00:00:00 -05:00
+date: 2009-11-04 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -93,6 +93,7 @@ files:
 - lib/main.rb
 - lib/resources/about.rb
 - lib/resources/api_key.rb
+- lib/resources/comment.rb
 - lib/resources/organization.rb
 - lib/resources/source.rb
 - lib/resources/user.rb
@@ -100,6 +101,7 @@ files:
 - spec/about_spec.rb
 - spec/api_key_spec.rb
 - spec/base_spec.rb
+- spec/comment_spec.rb
 - spec/datacatalog_spec.rb
 - spec/organization_spec.rb
 - spec/setup_api.rb
@@ -142,6 +144,7 @@ test_files:
 - spec/about_spec.rb
 - spec/api_key_spec.rb
 - spec/base_spec.rb
+- spec/comment_spec.rb
 - spec/datacatalog_spec.rb
 - spec/organization_spec.rb
 - spec/setup_api.rb