datacatalog 0.3.5 → 0.3.6

data/Rakefile

@@ -5,7 +5,7 @@ begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
     gem.name = "datacatalog"
-    gem.version = '0.3.5'
+    gem.version = '0.3.6'
     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.5"
+  s.version = "0.3.6"
 
   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-13}
+  s.date = %q{2009-11-17}
   s.description = %q{A Ruby client library for the National Data Catalog API}
   s.email = %q{luigi@sunlightfoundation.com}
   s.extra_rdoc_files = [
@@ -28,7 +28,11 @@ Gem::Specification.new do |s|
      "lib/resources/about.rb",
      "lib/resources/api_key.rb",
      "lib/resources/comment.rb",
+     "lib/resources/document.rb",
+     "lib/resources/favorite.rb",
+     "lib/resources/note.rb",
      "lib/resources/organization.rb",
+     "lib/resources/rating.rb",
      "lib/resources/source.rb",
      "lib/resources/user.rb",
      "sandbox_api.yml.example",
@@ -37,7 +41,11 @@ Gem::Specification.new do |s|
      "spec/base_spec.rb",
      "spec/comment_spec.rb",
      "spec/datacatalog_spec.rb",
+     "spec/document_spec.rb",
+     "spec/favorite_spec.rb",
+     "spec/note_spec.rb",
      "spec/organization_spec.rb",
+     "spec/rating_spec.rb",
      "spec/setup_api.rb",
      "spec/source_spec.rb",
      "spec/spec.opts",
@@ -59,7 +67,11 @@ Gem::Specification.new do |s|
      "spec/base_spec.rb",
      "spec/comment_spec.rb",
      "spec/datacatalog_spec.rb",
+     "spec/document_spec.rb",
+     "spec/favorite_spec.rb",
+     "spec/note_spec.rb",
      "spec/organization_spec.rb",
+     "spec/rating_spec.rb",
      "spec/setup_api.rb",
      "spec/source_spec.rb",
      "spec/spec_helper.rb",

data/lib/resources/document.rb

@@ -0,0 +1,33 @@
+module DataCatalog
+
+  class Document < Base
+    
+    def self.all(conditions={})      
+      many(http_get(uri, :query => 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)
+      "/documents/#{id}"
+    end
+
+  end
+
+end

data/lib/resources/favorite.rb

@@ -0,0 +1,29 @@
+module DataCatalog
+
+  class Favorite < 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
+
+    # == Helpers
+    
+    def self.uri(id=nil)
+      "/favorites/#{id}"
+    end
+
+  end
+
+end

data/lib/resources/note.rb

@@ -0,0 +1,33 @@
+module DataCatalog
+
+  class Note < Base
+    
+    def self.all(conditions={})      
+      many(http_get(uri, :query => 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)
+      "/notes/#{id}"
+    end
+
+  end
+
+end

data/lib/resources/rating.rb

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

data/spec/document_spec.rb

@@ -0,0 +1,96 @@
+require File.dirname(__FILE__) + '/spec_helper'
+include DataCatalog
+
+describe Document 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")
+    
+    DataCatalog.with_key(@user.primary_api_key) do
+      @document = Document.create(:source_id => @source.id, :text => "This is community documentation.")
+    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 # describe ".create"
+  
+  describe ".get" do
+  
+    it "should return a document" do
+      document = Document.get(@document.id)
+      document.should be_an_instance_of(Document)
+      document.source_id.should == @source.id
+    end
+    
+    it "should raise NotFound if no document exists" do
+      executing do
+        Document.get(mangle(@document.id))
+      end.should raise_error(NotFound)
+    end
+    
+  end # describe ".get"
+  
+  describe ".all" do
+  
+    it "should return a collection of all the source's documents" do
+      documents = Document.all(:source_id => @source.id)
+  
+      documents.should be_an_instance_of(Array)
+      documents[0].should be_an_instance_of(Document)
+    end
+    
+  end # describe ".all"
+  
+  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
+        Document.update(@document.id, :text => "This is the updated document.")
+      end
+      
+      refreshed_document = Document.get(@document.id)
+      refreshed_document.text.should == "This is the updated document."
+      refreshed_document.previous_id.should_not be nil
+    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

data/spec/favorite_spec.rb

@@ -0,0 +1,80 @@
+require File.dirname(__FILE__) + '/spec_helper'
+include DataCatalog
+
+describe Favorite 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")
+    
+    DataCatalog.with_key(@user.primary_api_key) do
+      @favorite = Favorite.create(:source_id => @source.id)
+    end
+    
+  end
+  
+  describe ".create" do
+
+    it "should create a favorite when valid params are passed in" do      
+      refreshed_user = User.get(@user.id)
+      refreshed_user.favorites.first.title.should == "Some FCC Data"
+    end
+    
+  end # describe ".create"
+  
+  describe ".get" do
+  
+    it "should return a favorite" do
+      favorite = Favorite.get(@favorite.id)
+      favorite.should be_an_instance_of(Favorite)
+      favorite.user_id.should == @user.id
+    end
+    
+    it "should raise NotFound if no favorite exists" do
+      executing do
+        Favorite.get(mangle(@favorite.id))
+      end.should raise_error(NotFound)
+    end
+    
+  end # describe ".get"
+  
+  describe ".all" do
+  
+    it "should return a collection of all the user's favorites" do
+      favorites = Favorite.all(:user_id => @user.id)
+  
+      favorites.should be_an_instance_of(Array)
+      favorites[0].should be_an_instance_of(Favorite)
+    end
+    
+  end # describe ".all"
+
+  
+  describe ".destroy" do
+
+    it "should destroy an existing favorite as an admin" do
+      Favorite.destroy(@favorite.id).should be_true
+    end
+    
+    it "should destroy an existing favorite as the user" do
+      DataCatalog.with_key(@user.primary_api_key) do
+        Favorite.destroy(@favorite.id).should be_true
+      end
+    end
+    
+    it "should raise NotFound when attempting to destroy non-existing favorite" do
+      executing do
+        Favorite.destroy(mangle(@favorite.id))
+      end.should raise_error(NotFound)
+    end
+    
+  end # describe ".destroy"
+  
+end

data/spec/note_spec.rb

@@ -0,0 +1,94 @@
+require File.dirname(__FILE__) + '/spec_helper'
+include DataCatalog
+
+describe Note 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")
+    
+    DataCatalog.with_key(@user.primary_api_key) do
+      @note = Note.create(:source_id => @source.id, :text => "This is my note.")
+    end
+    
+  end
+  
+  describe ".create" do
+
+    it "should create a note when valid params are passed in" do
+      DataCatalog.with_key(@user.primary_api_key) do
+        refreshed_source = Source.get(@source.id)
+        refreshed_source.notes.first.text.should == "This is my note."
+      end
+    end
+    
+  end # describe ".create"
+  
+  describe ".get" do
+  
+    it "should return a note" do
+      note = Note.get(@note.id)
+      note.should be_an_instance_of(Note)
+      note.user_id.should == @user.id
+    end
+    
+    it "should raise NotFound if no note exists" do
+      executing do
+        Note.get(mangle(@note.id))
+      end.should raise_error(NotFound)
+    end
+    
+  end # describe ".get"
+  
+  describe ".all" do
+  
+    it "should return a collection of all the user's notes" do
+      notes = Note.all(:user_id => @user.id)
+  
+      notes.should be_an_instance_of(Array)
+      notes[0].should be_an_instance_of(Note)
+    end
+    
+  end # describe ".all"
+  
+  describe ".update" do
+
+    it "should update an existing note with valid params" do
+      DataCatalog.with_key(@user.primary_api_key) do
+        Note.update(@note.id, :text => "This is my updated note.")
+      end
+      
+      refreshed_note = Note.get(@note.id)
+      refreshed_note.text.should == "This is my updated note."
+    end
+    
+  end # describe ".update"
+
+  describe ".destroy" do
+
+    it "should destroy an existing note as an admin" do
+      Note.destroy(@note.id).should be_true
+    end
+    
+    it "should destroy an existing note as the user" do
+      DataCatalog.with_key(@user.primary_api_key) do
+        Note.destroy(@note.id).should be_true
+      end
+    end
+    
+    it "should raise NotFound when attempting to destroy non-existing note" do
+      executing do
+        Note.destroy(mangle(@note.id))
+      end.should raise_error(NotFound)
+    end
+    
+  end # describe ".destroy"
+  
+end

data/spec/rating_spec.rb

@@ -0,0 +1,139 @@
+require File.dirname(__FILE__) + '/spec_helper'
+include DataCatalog
+
+describe Rating do
+  
+  before do
+    setup_api
+    clean_slate
+    
+    @user = User.create(:name  => "Ted Smith",
+                        :email => "ted@email.com")
+    @user2 = User.create(:name  => "Chad Johnson",
+                        :email => "chad@email.com")
+    
+    @source = Source.create(:title       => "Some FCC Data",
+                            :url         => "http://fcc.gov/somedata.csv",
+                            :source_type => "dataset")
+    
+    DataCatalog.with_key(@user.primary_api_key) do
+      @comment = Comment.create(:source_id => @source.id, :text => "This is a useful comment.")
+    end
+  end
+  
+  describe ".create" do
+
+    it "should create a source rating when valid params are passed in" do
+      DataCatalog.with_key(@user.primary_api_key) do
+        @rating = Rating.create(:kind => "source", :source_id => @source.id, :value => 5)
+      end
+      
+      refreshed_source = Source.get(@source.id)
+      refreshed_source.rating_stats.average.should == 5
+      refreshed_source.rating_stats.total.should == 5
+    end
+    
+    it "should create a comment rating when valid params are passed in" do
+      DataCatalog.with_key(@user2.primary_api_key) do
+        @rating = Rating.create(:kind => "comment", :comment_id => @comment.id, :value => 1)
+      end
+      
+      refreshed_comment = Comment.get(@comment.id)
+      refreshed_comment.rating_stats.average.should == 1
+      refreshed_comment.rating_stats.total.should == 1
+    end
+    
+  end # describe ".create"
+  
+  describe ".get" do
+
+    before do
+      DataCatalog.with_key(@user.primary_api_key) do
+        @rating = Rating.create(:kind => "source", :source_id => @source.id, :value => 5)
+      end
+    end
+
+    it "should return a rating" do
+      rating = Rating.get(@rating.id)
+      rating.should be_an_instance_of(Rating)
+      rating.value.should == 5
+    end
+    
+    it "should raise NotFound if no rating exists" do
+      executing do
+        Rating.get(mangle(@rating.id))
+      end.should raise_error(NotFound)
+    end
+    
+  end # describe ".get"
+
+  describe ".all" do
+
+    before do
+      DataCatalog.with_key(@user.primary_api_key) do
+        @rating = Rating.create(:kind => "source", :source_id => @source.id, :value => 5)
+      end
+
+      DataCatalog.with_key(@user2.primary_api_key) do
+        @rating = Rating.create(:kind => "source", :source_id => @source.id, :value => 3)
+      end
+
+    end
+
+    it "should return a collection of all the source's ratings" do
+      ratings = Rating.all(:source_id => @source.id)
+
+      ratings[0].should be_an_instance_of(Rating)
+      ratings[0].value.should == 5
+      ratings[1].value.should == 3
+    end
+    
+  end # describe ".all"
+  
+  describe ".update" do
+
+    before do
+      DataCatalog.with_key(@user.primary_api_key) do
+        @rating = Rating.create(:kind => "source", :source_id => @source.id, :value => 5)
+      end
+    end
+  
+    it "should update an existing rating with valid params" do
+      DataCatalog.with_key(@user.primary_api_key) do
+        Rating.update(@rating.id, :value => 3)
+      end
+      
+      refreshed_rating = Rating.get(@rating.id)
+      refreshed_rating.value.should == 3
+      refreshed_rating.previous_value.should == 5
+    end
+    
+  end # describe ".update"
+  
+  describe ".destroy" do
+
+    before do
+      DataCatalog.with_key(@user.primary_api_key) do
+        @rating = Rating.create(:kind => "source", :source_id => @source.id, :value => 5)
+      end
+    end
+  
+    it "should destroy an existing rating as an admin" do
+      Rating.destroy(@rating.id).should be_true
+    end
+    
+    it "should destroy an existing rating as the user" do
+      DataCatalog.with_key(@user.primary_api_key) do
+        Rating.destroy(@rating.id).should be_true
+      end
+    end
+    
+    it "should raise NotFound when attempting to destroy non-existing rating" do
+      executing do
+        Rating.destroy(mangle(@rating.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.5
+  version: 0.3.6
 platform: ruby
 authors: 
 - Luigi Montanez
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-13 00:00:00 -05:00
+date: 2009-11-17 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -94,7 +94,11 @@ files:
 - lib/resources/about.rb
 - lib/resources/api_key.rb
 - lib/resources/comment.rb
+- lib/resources/document.rb
+- lib/resources/favorite.rb
+- lib/resources/note.rb
 - lib/resources/organization.rb
+- lib/resources/rating.rb
 - lib/resources/source.rb
 - lib/resources/user.rb
 - sandbox_api.yml.example
@@ -103,7 +107,11 @@ files:
 - spec/base_spec.rb
 - spec/comment_spec.rb
 - spec/datacatalog_spec.rb
+- spec/document_spec.rb
+- spec/favorite_spec.rb
+- spec/note_spec.rb
 - spec/organization_spec.rb
+- spec/rating_spec.rb
 - spec/setup_api.rb
 - spec/source_spec.rb
 - spec/spec.opts
@@ -146,7 +154,11 @@ test_files:
 - spec/base_spec.rb
 - spec/comment_spec.rb
 - spec/datacatalog_spec.rb
+- spec/document_spec.rb
+- spec/favorite_spec.rb
+- spec/note_spec.rb
 - spec/organization_spec.rb
+- spec/rating_spec.rb
 - spec/setup_api.rb
 - spec/source_spec.rb
 - spec/spec_helper.rb