datacatalog 0.4.18 → 0.4.19

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    datacatalog (0.4.18)
+    datacatalog (0.4.19)
       activesupport (~> 3.0.0)
       httparty (~> 0.6.1)
       mash (~> 0.1.1)

data/Rakefile

@@ -4,7 +4,7 @@ begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
     gem.name = "datacatalog"
-    gem.version = '0.4.18'
+    gem.version = '0.4.19'
     gem.summary = %Q{Client for the National Data Catalog API}
     gem.description = %Q{A Ruby client library for the National Data Catalog API}
     gem.email = "luigi@sunlightfoundation.com"

data/datacatalog.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{datacatalog}
-  s.version = "0.4.18"
+  s.version = "0.4.19"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Luigi Montanez", "David James"]
@@ -33,6 +33,8 @@ Gem::Specification.new do |s|
      "lib/resources/about.rb",
      "lib/resources/api_key.rb",
      "lib/resources/broken_link.rb",
+     "lib/resources/categorization.rb",
+     "lib/resources/category.rb",
      "lib/resources/comment.rb",
      "lib/resources/document.rb",
      "lib/resources/download.rb",
@@ -50,6 +52,8 @@ Gem::Specification.new do |s|
      "spec/api_key_spec.rb",
      "spec/base_spec.rb",
      "spec/broken_link_spec.rb",
+     "spec/categorization_spec.rb",
+     "spec/category_spec.rb",
      "spec/comment_spec.rb",
      "spec/datacatalog_spec.rb",
      "spec/document_spec.rb",
@@ -81,6 +85,8 @@ Gem::Specification.new do |s|
      "spec/api_key_spec.rb",
      "spec/base_spec.rb",
      "spec/broken_link_spec.rb",
+     "spec/categorization_spec.rb",
+     "spec/category_spec.rb",
      "spec/comment_spec.rb",
      "spec/datacatalog_spec.rb",
      "spec/document_spec.rb",

data/lib/resources/categorization.rb

@@ -0,0 +1,33 @@
+module DataCatalog
+
+  class Categorization < Base
+
+    def self.all(conditions={})
+      cursor(uri, 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)
+      "/categorizations/#{id}"
+    end
+
+  end
+
+end

data/lib/resources/category.rb

@@ -0,0 +1,33 @@
+module DataCatalog
+
+  class Category < Base
+
+    def self.all(conditions={})
+      cursor(uri, 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)
+      "/categories/#{id}"
+    end
+
+  end
+
+end

data/lib/resources/document.rb

@@ -6,22 +6,22 @@ module DataCatalog
       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
 
+    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)

data/lib/resources/download.rb

@@ -6,22 +6,22 @@ module DataCatalog
       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
 
+    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)

data/lib/resources/note.rb

@@ -6,22 +6,22 @@ module DataCatalog
       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
 
+    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)

data/spec/categorization_spec.rb

@@ -0,0 +1,129 @@
+require File.dirname(__FILE__) + '/spec_helper'
+include DataCatalog
+
+describe Categorization do
+
+  before do
+    setup_api
+    clean_slate
+    @user = User.create(
+      :name  => "Ted Smith",
+      :email => "ted@email.com"
+    )
+    @sources = [
+      Source.create(
+        :title       => "Some Bat Data",
+        :url         => "http://bats.doi.gov/bat_data.csv",
+        :source_type => "dataset"
+      ),
+      Source.create(
+        :title       => "Bat Flying Simulation",
+        :url         => "http://bats.doi.gov/bat-sim",
+        :source_type => "interactive"
+      ),
+    ]
+    @category = Category.create(:name => "Bat Policy")
+    @categorizations = [
+      Categorization.create({
+        :source_id   => @sources[0].id,
+        :category_id => @category.id
+      }),
+      Categorization.create({
+        :source_id   => @sources[1].id,
+        :category_id => @category.id
+      })
+    ]
+  end
+
+  describe ".all" do
+    it "should return an enumeration of 2 categorizations" do
+      categorizations = Categorization.all
+      categorizations.length.should == 2
+      categorizations.each do |o|
+        o.should be_an_instance_of(Categorization)
+      end
+    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
+          Categorization.create(
+            :source_id   => @sources[0].id,
+            :category_id => @category.id
+          )
+        end
+      end.should raise_error(Unauthorized)
+    end
+
+    it "should fail with invalid params" do
+      executing do
+        Categorization.create(:cave => "The Batcave")
+      end.should raise_error(BadRequest)
+    end
+
+    it "should fail when missing params" do
+      executing do
+        Categorization.create()
+      end.should raise_error(BadRequest)
+    end
+  end
+
+  describe ".destroy" do
+    it "should destroy an existing categorization as an admin" do
+      Categorization.destroy(@categorizations[0].id).should be_true
+    end
+
+    it "should not destroy an existing categorization as a basic user" do
+      DataCatalog.with_key(@user.primary_api_key) do
+        executing do
+          Categorization.destroy(@categorizations[0].id)
+        end.should raise_error(Unauthorized)
+      end
+    end
+
+    it "should raise NotFound when attempting to destroy non-existing categorization" do
+      executing do
+        Categorization.destroy(mangle(@categorizations[0].id))
+      end.should raise_error(NotFound)
+    end
+  end
+
+  describe ".get" do
+    it "should return an categorization as a basic user" do
+      categorization = DataCatalog.with_key(@user.primary_api_key) do
+        Categorization.get(@categorizations[0].id)
+      end
+      categorization.should be_an_instance_of(Categorization)
+      categorization.id.should == @categorizations[0].id
+    end
+
+    it "should raise NotFound if no categorization exists" do
+      executing do
+        Categorization.get(mangle(@categorizations[0].id))
+      end.should raise_error(NotFound)
+    end
+  end
+
+  describe ".update" do
+    it "a basic user should be unauthorized" do
+      executing do
+        DataCatalog.with_key(@user.primary_api_key) do
+          Categorization.update(@categorizations[0].id, :name => "International Bat Registry")
+        end
+      end.should raise_error(Unauthorized)
+    end
+
+    it "should update an existing categorization with valid params" do
+      @categorizations[0].category_id.should == @category.id
+      new_category = Category.create(:name => "Wombat Policy")
+      Categorization.update(@categorizations[0].id, :category_id => new_category.id)
+      categorization = Categorization.get(@categorizations[0].id)
+      categorization.category_id == new_category.id
+    end
+  end
+
+end

data/spec/category_spec.rb

@@ -0,0 +1,106 @@
+require File.dirname(__FILE__) + '/spec_helper'
+include DataCatalog
+
+describe Category do
+
+  before do
+    setup_api
+    clean_slate
+    @user = User.create(
+      :name  => "Ted Smith",
+      :email => "ted@email.com"
+    )
+    @categories = [
+      Category.create(:name => "Bat Policy"),
+      Category.create(:name => "Bear Policy"),
+    ]
+  end
+
+  describe ".all" do
+    it "should return an enumeration of 2 categories" do
+      categories = Category.all
+      categories.length.should == 2
+      categories.each do |o|
+        o.should be_an_instance_of(Category)
+      end
+    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
+          Category.create(:name => "Wombat Policy")
+        end
+      end.should raise_error(Unauthorized)
+    end
+
+    it "should fail with invalid params" do
+      executing do
+        Category.create(:cave => "The Batcave")
+      end.should raise_error(BadRequest)
+    end
+
+    it "should fail when missing params" do
+      executing do
+        Category.create()
+      end.should raise_error(BadRequest)
+    end
+  end
+
+  describe ".destroy" do
+    it "should destroy an existing category as an admin" do
+      Category.destroy(@categories[0].id).should be_true
+    end
+
+    it "should not destroy an existing category as a basic user" do
+      DataCatalog.with_key(@user.primary_api_key) do
+        executing do
+          Category.destroy(@categories[0].id)
+        end.should raise_error(Unauthorized)
+      end
+    end
+
+    it "should raise NotFound when attempting to destroy non-existing category" do
+      executing do
+        Category.destroy(mangle(@categories[0].id))
+      end.should raise_error(NotFound)
+    end
+  end
+
+  describe ".get" do
+    it "should return an category as a basic user" do
+      category = DataCatalog.with_key(@user.primary_api_key) do
+        Category.get(@categories[0].id)
+      end
+      category.should be_an_instance_of(Category)
+      category.id.should == @categories[0].id
+    end
+
+    it "should raise NotFound if no category exists" do
+      executing do
+        Category.get(mangle(@categories[0].id))
+      end.should raise_error(NotFound)
+    end
+  end
+
+  describe ".update" do
+    it "a basic user should be unauthorized" do
+      executing do
+        DataCatalog.with_key(@user.primary_api_key) do
+          Category.update(@categories[0].id, :name => "International Bat Policy")
+        end
+      end.should raise_error(Unauthorized)
+    end
+
+    it "should update an existing category with valid params" do
+      @categories[0].name.should == "Bat Policy"
+      Category.update(@categories[0].id, :name => "International Bat Policy")
+      category = Category.get(@categories[0].id)
+      category.name.should == "International Bat Policy"
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -9,6 +9,8 @@ alias :executing :lambda
 
 KLASSES = [
   DataCatalog::BrokenLink,
+  DataCatalog::Category,
+  DataCatalog::Categorization,
   DataCatalog::Comment,
   DataCatalog::Document,
   DataCatalog::Download,

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: datacatalog
 version: !ruby/object:Gem::Version 
-  hash: 43
+  hash: 41
   prerelease: false
   segments: 
   - 0
   - 4
-  - 18
-  version: 0.4.18
+  - 19
+  version: 0.4.19
 platform: ruby
 authors: 
 - Luigi Montanez
@@ -173,6 +173,8 @@ files:
 - lib/resources/about.rb
 - lib/resources/api_key.rb
 - lib/resources/broken_link.rb
+- lib/resources/categorization.rb
+- lib/resources/category.rb
 - lib/resources/comment.rb
 - lib/resources/document.rb
 - lib/resources/download.rb
@@ -190,6 +192,8 @@ files:
 - spec/api_key_spec.rb
 - spec/base_spec.rb
 - spec/broken_link_spec.rb
+- spec/categorization_spec.rb
+- spec/category_spec.rb
 - spec/comment_spec.rb
 - spec/datacatalog_spec.rb
 - spec/document_spec.rb
@@ -249,6 +253,8 @@ test_files:
 - spec/api_key_spec.rb
 - spec/base_spec.rb
 - spec/broken_link_spec.rb
+- spec/categorization_spec.rb
+- spec/category_spec.rb
 - spec/comment_spec.rb
 - spec/datacatalog_spec.rb
 - spec/document_spec.rb