sinatra_resource 0.1.0 → 0.2.0

data/examples/datacatalog/test/resources/categories/categories_put_test.rb

@@ -18,12 +18,6 @@ class CategoriesPutResourceTest < ResourceTestCase
     @category.destroy
   end
   
-  shared "category unchanged" do
-    test "should not change category in database" do
-      assert_equal @category_copy, Category.find_by_id(@category.id)
-    end
-  end
-  
   context "put /:id" do
     context "anonymous" do
       before do
@@ -51,7 +45,7 @@ class CategoriesPutResourceTest < ResourceTestCase
           put "/#{@category.id}", valid_params_for(role).merge(invalid => 9)
         end
       
-        use "return 401 Unauthorized"
+        use "return 401 because the API key is unauthorized"
         use "category unchanged"
       end
     end
@@ -62,17 +56,17 @@ class CategoriesPutResourceTest < ResourceTestCase
           put "/#{@category.id}", valid_params_for(role).merge(erase => "")
         end
       
-        use "return 401 Unauthorized"
+        use "return 401 because the API key is unauthorized"
         use "category unchanged"
       end
     end
 
-    context "#{role} : put /:id with no parameters" do
+    context "#{role} : put /:id with no params" do
       before do
         put "/#{@category.id}", :api_key => api_key_for(role)
       end
 
-      use "return 401 Unauthorized"
+      use "return 401 because the API key is unauthorized"
       use "category unchanged"
     end
 
@@ -81,14 +75,14 @@ class CategoriesPutResourceTest < ResourceTestCase
         put "/#{@category.id}", valid_params_for(role)
       end
       
-      use "return 401 Unauthorized"
+      use "return 401 because the API key is unauthorized"
       use "category unchanged"
     end
   end
   
   %w(curator admin).each do |role|
     [:created_at, :updated_at, :sources].each do |invalid|
-      context "#{role} : put / but with #{invalid}" do
+      context "#{role} : put /:id but with #{invalid}" do
         before do
           put "/#{@category.id}", valid_params_for(role).merge(invalid => 9)
         end
@@ -100,7 +94,7 @@ class CategoriesPutResourceTest < ResourceTestCase
     end
 
     [:name].each do |erase|
-      context "#{role} : put / but blanking out #{erase}" do
+      context "#{role} : put /:id but blanking out #{erase}" do
         before do
           put "/#{@category.id}", valid_params_for(role).merge(erase => "")
         end
@@ -111,12 +105,12 @@ class CategoriesPutResourceTest < ResourceTestCase
       end
     end
 
-    context "#{role} : put /:id with no parameters" do
+    context "#{role} : put /:id with no params" do
       before do
         put "/#{@category.id}", :api_key => api_key_for(role)
       end
 
-      use "return 400 because no parameters were given"
+      use "return 400 because no params were given"
       use "category unchanged"
     end
 

data/examples/datacatalog/test/resources/categories_sources/categories_sources_delete_test.rb

@@ -0,0 +1,148 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../helpers/resource_test_helper')
+
+class CategoriesSourcesDeleteResourceTest < ResourceTestCase
+
+  include DataCatalog
+
+  def app; Categories end
+  
+  before do
+    @category = create_category
+    @source = create_source
+    @categorization = create_categorization(
+      :source_id   => @source.id,
+      :category_id => @category.id
+    )
+    @other_category = create_category
+    @other_source = create_source
+    @other_categorization = create_categorization(
+      :source_id   => @other_source.id,
+      :category_id => @other_category.id
+    )
+    @source_count = Source.all.length
+  end
+
+  after do
+    @other_categorization.destroy
+    @other_source.destroy
+    @other_category.destroy
+    @categorization.destroy
+    @source.destroy
+    @category.destroy
+  end
+
+  context "delete /:id/sources/:id" do
+    context "anonymous" do
+      before do
+        delete "/#{@category.id}/sources/#{@source.id}"
+      end
+    
+      use "return 401 because the API key is missing"
+    end
+  
+    context "incorrect API key" do
+      before do
+        delete "/#{@category.id}/sources/#{@source.id}", :api_key => BAD_API_KEY
+      end
+      
+      use "return 401 because the API key is invalid"
+    end
+  end
+
+  %w(basic).each do |role|
+    context "#{role} : delete /:fake_id/sources/:fake_id" do
+      before do
+        delete "/#{FAKE_ID}/sources/#{FAKE_ID}", :api_key => api_key_for(role)
+      end
+    
+      use "return 404 Not Found with empty response body"
+      use "no change in source count"
+    end
+    
+    context "#{role} : delete /:fake_id/sources/:id" do
+      before do
+        delete "/#{FAKE_ID}/sources/#{@source.id}", :api_key => api_key_for(role)
+      end
+    
+      use "return 404 Not Found with empty response body"
+      use "no change in source count"
+    end
+    
+    context "#{role} : delete /:id/sources/:fake_id" do
+      before do
+        delete "/#{@category.id}/sources/#{FAKE_ID}", :api_key => api_key_for(role)
+      end
+    
+      use "return 401 because the API key is unauthorized"
+      use "no change in source count"
+    end
+  
+    context "#{role} : delete /:id/sources/:not_related_id" do
+      before do
+        delete "/#{@category.id}/sources/#{@other_source.id}",
+          :api_key => api_key_for(role)
+      end
+      
+      use "return 401 because the API key is unauthorized"
+      use "no change in source count"
+    end
+  
+    context "#{role} : delete /:id/sources/:id" do
+      before do
+        delete "/#{@category.id}/sources/#{@source.id}", :api_key => api_key_for(role)
+      end
+      
+      use "return 401 because the API key is unauthorized"
+      use "no change in source count"
+    end
+  end
+  
+  %w(curator admin).each do |role|
+    context "#{role} : delete /:fake_id/sources/:fake_id" do
+      before do
+        delete "/#{FAKE_ID}/sources/#{FAKE_ID}", :api_key => api_key_for(role)
+      end
+    
+      use "return 404 Not Found with empty response body"
+      use "no change in source count"
+    end
+    
+    context "#{role} : delete /:fake_id/sources/:id" do
+      before do
+        delete "/#{FAKE_ID}/sources/#{@source.id}", :api_key => api_key_for(role)
+      end
+    
+      use "return 404 Not Found with empty response body"
+      use "no change in source count"
+    end
+    
+    context "#{role} : delete /:id/sources/:fake_id" do
+      before do
+        delete "/#{@category.id}/sources/#{FAKE_ID}", :api_key => api_key_for(role)
+      end
+    
+      use "return 404 Not Found with empty response body"
+      use "no change in source count"
+    end
+  
+    context "#{role} : delete /:id/sources/:not_related_id" do
+      before do
+        delete "/#{@category.id}/sources/#{@other_source.id}",
+          :api_key => api_key_for(role)
+      end
+      
+      use "return 404 Not Found with empty response body"
+      use "no change in source count"
+    end
+  
+    context "#{role} : delete /:id/sources/:id" do
+      before do
+        delete "/#{@category.id}/sources/#{@source.id}", :api_key => api_key_for(role)
+      end
+      
+      use "return 204 No Content"
+      use "one less source"
+    end
+  end
+  
+end

data/examples/datacatalog/test/resources/categories_sources/categories_sources_get_many_test.rb

@@ -0,0 +1,92 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../helpers/resource_test_helper')
+
+class CategoriesSourcesGetManyResourceTest < ResourceTestCase
+
+  include DataCatalog
+
+  def app; Categories end
+
+  before do
+    raise "Unexpected Source count" unless Source.count == 0
+    @category = create_category
+    @sources = 3.times.map do |i|
+      create_source(:title => "Source #{i}")
+    end
+    @categorizations = 3.times.map do |i|
+      create_categorization(
+        :source_id   => @sources[i].id,
+        :category_id => @category.id
+      )
+    end
+    # ----
+    @other_category = create_category(:name => 'Other Category')
+    @other_sources = 3.times.map do |i|
+      create_source(:title => "Other Source #{i}")
+    end
+    @other_categorizations = 3.times.map do |i|
+      create_categorization(
+        :source_id   => @other_sources[i].id,
+        :category_id => @other_category.id
+      )
+    end
+  end
+  
+  after do
+    @other_categorizations.each { |x| x.destroy }
+    @other_sources.each { |x| x.destroy }
+    @other_category.destroy
+    @categorizations.each { |x| x.destroy }
+    @sources.each { |x| x.destroy }
+    @category.destroy
+  end
+
+  SOURCES = ["Source 0", "Source 1", "Source 2"].sort
+
+  context "get /:id/sources/" do
+    context "anonymous" do
+      before do
+        get "/#{@category.id}/sources/"
+      end
+    
+      use "return 401 because the API key is missing"
+    end
+  
+    context "incorrect API key" do
+      before do
+        get "/#{@category.id}/sources/", :api_key => BAD_API_KEY
+      end
+      
+      use "return 401 because the API key is invalid"
+    end
+  end
+
+  %w(basic curator admin).each do |role|
+    context "#{role} : get /:fake_id/sources" do
+      before do
+        get "/#{FAKE_ID}/sources/", :api_key => api_key_for(role)
+      end
+    
+      use "return 404 Not Found with empty response body"
+    end
+
+    context "#{role} : get /:id/sources" do
+      before do
+        get "/#{@category.id}/sources/", :api_key => api_key_for(role)
+      end
+
+      use "return 200 Ok"
+
+      test "body should have 3 sources" do
+        assert_equal 3, parsed_response_body.length
+      end
+
+      test "body should have correct source titles" do
+        actual = parsed_response_body.map { |e| e["title"] }
+        assert_equal SOURCES, actual.sort
+      end
+      
+      docs_properties %w(title url raw id created_at updated_at)
+    end
+  end
+
+end

data/examples/datacatalog/test/resources/categories_sources/categories_sources_get_one_test.rb

@@ -0,0 +1,95 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../helpers/resource_test_helper')
+
+class CategoriesSourcesGetOneResourceTest < ResourceTestCase
+
+  include DataCatalog
+
+  def app; Categories end
+  
+  before do
+    @category = create_category
+    @source = create_source
+    @categorization = create_categorization(
+      :source_id   => @source.id,
+      :category_id => @category.id
+    )
+    @other_category = create_category
+    @other_source = create_source
+    @other_categorization = create_categorization(
+      :source_id   => @other_source.id,
+      :category_id => @other_category.id
+    )
+  end
+
+  after do
+    @other_categorization.destroy
+    @other_source.destroy
+    @other_category.destroy
+    @categorization.destroy
+    @source.destroy
+    @category.destroy
+  end
+
+  context "get /:id/sources/:id" do
+    context "anonymous" do
+      before do
+        get "/#{@category.id}/sources/#{@source.id}"
+      end
+    
+      use "return 401 because the API key is missing"
+    end
+  
+    context "incorrect API key" do
+      before do
+        get "/#{@category.id}/sources/#{@source.id}", :api_key => BAD_API_KEY
+      end
+      
+      use "return 401 because the API key is invalid"
+    end
+  end
+  
+  %w(basic curator admin).each do |role|
+    context "#{role} : get /:fake_id/sources/:fake_id" do
+      before do
+        get "/#{FAKE_ID}/sources/#{FAKE_ID}", :api_key => api_key_for(role)
+      end
+    
+      use "return 404 Not Found with empty response body"
+    end
+    
+    context "#{role} : get /:fake_id/sources/:id" do
+      before do
+        get "/#{FAKE_ID}/sources/#{@source.id}", :api_key => api_key_for(role)
+      end
+    
+      use "return 404 Not Found with empty response body"
+    end
+    
+    context "#{role} : get /:id/sources/:fake_id" do
+      before do
+        get "/#{@category.id}/sources/#{FAKE_ID}", :api_key => api_key_for(role)
+      end
+    
+      use "return 404 Not Found with empty response body"
+    end
+  
+    context "#{role} : get /:id/sources/:not_related_id" do
+      before do
+        get "/#{@category.id}/sources/#{@other_source.id}",
+          :api_key => api_key_for(role)
+      end
+      
+      use "return 404 Not Found with empty response body"
+    end
+  
+    context "#{role} : get /:id/sources/:id" do
+      before do
+        get "/#{@category.id}/sources/#{@source.id}", :api_key => api_key_for(role)
+      end
+      
+      use "return 200 Ok"
+      doc_properties %w(title url raw id created_at updated_at)
+    end
+  end
+  
+end

data/examples/datacatalog/test/resources/categories_sources/categories_sources_post_test.rb

@@ -0,0 +1,187 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../helpers/resource_test_helper')
+
+class CategoriesSourcesPostResourceTest < ResourceTestCase
+
+  include DataCatalog
+
+  def app; Categories end
+  
+  before do
+    @category = create_category
+    @source = create_source
+    @categorization = create_categorization(
+      :source_id   => @source.id,
+      :category_id => @category.id
+    )
+    @source_count = Source.all.length
+    @valid_params = {
+      :title   => "New Source",
+      :url     => "http://data.gov/details/123"
+    }
+    @extra_admin_params = { :raw => { "key" => "value" } }
+  end
+  
+  after do
+    @categorization.destroy
+    @source.destroy
+    @category.destroy
+  end
+  
+  context "post /:id/sources" do
+    context "anonymous" do
+      before do
+        post "/#{@category.id}/sources/"
+      end
+    
+      use "return 401 because the API key is missing"
+      use "no change in source count"
+    end
+  
+    context "incorrect API key" do
+      before do
+        post "/#{@category.id}/sources/", :api_key => BAD_API_KEY
+      end
+      
+      use "return 401 because the API key is invalid"
+      use "no change in source count"
+    end
+  end
+  
+  %w(basic).each do |role|
+    context "#{role} : post /:fake_id/sources" do
+      before do
+        post "/#{FAKE_ID}/sources/", :api_key => api_key_for(role)
+      end
+  
+      use "return 404 Not Found with empty response body"
+      use "no change in source count"
+    end
+  
+    context "#{role} : post /:id/sources" do
+      before do
+        post "/#{@category.id}/sources/", :api_key => api_key_for(role)
+      end
+    
+      use "return 401 because the API key is unauthorized"
+      use "no change in source count"
+    end
+  end
+
+  %w(curator).each do |role|
+    context "#{role} : post /:fake_id/sources" do
+      before do
+        post "/#{FAKE_ID}/sources/", :api_key => api_key_for(role)
+      end
+    
+      use "return 404 Not Found with empty response body"
+      use "no change in source count"
+    end
+  
+    [:title, :url].each do |missing|
+      context "#{role} : post /:id/sources/ but missing #{missing}" do
+        before do
+          post "/#{@category.id}/sources/",
+            valid_params_for(role).delete_if { |k, v| k == missing }
+        end
+        
+        use "return 400 Bad Request"
+        use "no change in source count"
+        missing_param missing
+      end
+    end
+
+    [:raw, :id, :created_at, :updated_at].each do |invalid|
+      context "#{role} : post /:id/sources/ but with #{invalid}" do
+        before do
+          post "/#{@category.id}/sources/", valid_params_for(role).
+            merge(invalid => 9)
+        end
+      
+        use "return 400 Bad Request"
+        use "no change in source count"
+        invalid_param invalid
+      end
+    end
+
+    context "#{role} : post /:id/sources with valid params" do
+      before do
+        post "/#{@category.id}/sources/", valid_params_for(role)
+      end
+
+      after do
+        Source.find_by_id(parsed_response_body["id"]).destroy
+      end
+      
+      use "return 201 Created"
+      location_header "sources"
+      use "one new source"
+      doc_properties %w(title url raw id created_at updated_at)
+      
+      test "source connected to category" do
+        source = Source.find_by_id(parsed_response_body["id"])
+        assert_equal [@category], source.categories
+      end
+    end
+  end
+
+  %w(admin).each do |role|
+    context "#{role} : post /:fake_id/sources" do
+      before do
+        post "/#{FAKE_ID}/sources/",
+          valid_params_for(role).merge(@extra_admin_params)
+      end
+    
+      use "return 404 Not Found with empty response body"
+      use "no change in source count"
+    end
+  
+    [:title, :url].each do |missing|
+      context "#{role} : post /:id/sources/ but missing #{missing}" do
+        before do
+          post "/#{@category.id}/sources/",
+            valid_params_for(role).merge(@extra_admin_params).
+              delete_if { |k, v| k == missing }
+        end
+        
+        use "return 400 Bad Request"
+        use "no change in source count"
+        missing_param missing
+      end
+    end
+
+    [:id, :created_at, :updated_at].each do |invalid|
+      context "#{role} : post /:id/sources/ but with #{invalid}" do
+        before do
+          post "/#{@category.id}/sources/", valid_params_for(role).
+            merge(@extra_admin_params).merge(invalid => 9)
+        end
+      
+        use "return 400 Bad Request"
+        use "no change in source count"
+        invalid_param invalid
+      end
+    end
+
+    context "#{role} : post /:id/sources with valid params" do
+      before do
+        post "/#{@category.id}/sources/",
+          valid_params_for(role).merge(@extra_admin_params)
+      end
+
+      after do
+        Source.find_by_id(parsed_response_body["id"]).destroy
+      end
+      
+      use "return 201 Created"
+      location_header "sources"
+      use "one new source"
+      doc_properties %w(title url raw id created_at updated_at)
+      
+      test "source connected to category" do
+        source = Source.find_by_id(parsed_response_body["id"])
+        assert_equal [@category], source.categories
+      end
+    end
+  end
+  
+end