sinatra_resource 0.1.0 → 0.2.0

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

@@ -0,0 +1,323 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../helpers/resource_test_helper')
+
+class CategoriesSourcesPutResourceTest < ResourceTestCase
+
+  include DataCatalog
+
+  def app; Categories end
+  
+  before do
+    @category = create_category
+    @source = create_source
+    @source_copy = @source.dup
+    @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
+    )
+    @valid_params = {
+      :title   => "Changed Source",
+      :url     => "http://updated.com/details/7"
+    }
+    @extra_admin_params = { :raw => { "key" => "value" } }
+  end
+
+  after do
+    @other_categorization.destroy
+    @other_source.destroy
+    @other_category.destroy
+    @categorization.destroy
+    @source.destroy
+    @category.destroy
+  end
+
+  context "put /:id/sources/:id" do
+    context "anonymous" do
+      before do
+        put "/#{@category.id}/sources/#{@source.id}"
+      end
+    
+      use "return 401 because the API key is missing"
+      use "source unchanged"
+    end
+  
+    context "incorrect API key" do
+      before do
+        put "/#{@category.id}/sources/#{@source.id}", :api_key => BAD_API_KEY
+      end
+      
+      use "return 401 because the API key is invalid"
+      use "source unchanged"
+    end
+  end
+
+  %w(basic).each do |role|
+    context "#{role} : put /:fake_id/sources/:fake_id" do
+      before do
+        put "/#{FAKE_ID}/sources/#{FAKE_ID}", :api_key => api_key_for(role)
+      end
+    
+      use "return 404 Not Found with empty response body"
+      use "source unchanged"
+    end
+    
+    context "#{role} : put /:fake_id/sources/:id" do
+      before do
+        put "/#{FAKE_ID}/sources/#{@source.id}", :api_key => api_key_for(role)
+      end
+    
+      use "return 404 Not Found with empty response body"
+      use "source unchanged"
+    end
+    
+    context "#{role} : put /:id/sources/:fake_id" do
+      before do
+        put "/#{@category.id}/sources/#{FAKE_ID}", :api_key => api_key_for(role)
+      end
+    
+      use "return 401 because the API key is unauthorized"
+      use "source unchanged"
+    end
+  
+    context "#{role} : put /:id/sources/:not_related_id" do
+      before do
+        put "/#{@category.id}/sources/#{@other_source.id}",
+          :api_key => api_key_for(role)
+      end
+      
+      use "return 401 because the API key is unauthorized"
+      use "source unchanged"
+    end
+  
+    context "#{role} : put /:id/sources/:id" do
+      before do
+        put "/#{@category.id}/sources/#{@source.id}", :api_key => api_key_for(role)
+      end
+      
+      use "return 401 because the API key is unauthorized"
+      use "source unchanged"
+    end
+  end
+
+  %w(curator).each do |role|
+    context "#{role} : put /:fake_id/sources/:fake_id" do
+      before do
+        put "/#{FAKE_ID}/sources/#{FAKE_ID}", :api_key => api_key_for(role)
+      end
+    
+      use "return 404 Not Found with empty response body"
+      use "source unchanged"
+    end
+    
+    context "#{role} : put /:fake_id/sources/:id" do
+      before do
+        put "/#{FAKE_ID}/sources/#{@source.id}", :api_key => api_key_for(role)
+      end
+    
+      use "return 404 Not Found with empty response body"
+      use "source unchanged"
+    end
+    
+    context "#{role} : put /:id/sources/:fake_id" do
+      before do
+        put "/#{@category.id}/sources/#{FAKE_ID}", :api_key => api_key_for(role)
+      end
+    
+      use "return 404 Not Found with empty response body"
+      use "source unchanged"
+    end
+  
+    context "#{role} : put /:id/sources/:not_related_id" do
+      before do
+        put "/#{@category.id}/sources/#{@other_source.id}",
+          :api_key => api_key_for(role)
+      end
+      
+      use "return 404 Not Found with empty response body"
+      use "source unchanged"
+    end
+
+    [:raw, :created_at, :updated_at].each do |invalid|
+      context "#{role} : put /:id/sources/:id with #{invalid}" do
+        before do
+          put "/#{@category.id}/sources/#{@source.id}",
+            valid_params_for(role).merge(invalid => 9)
+        end
+  
+        use "return 400 Bad Request"
+        use "source unchanged"
+        invalid_param invalid
+      end
+    end
+
+    [:title, :url].each do |erase|
+      context "#{role} : put /:id/sources/:id but blanking out #{erase}" do
+        before do
+          put "/#{@category.id}/sources/#{@source.id}",
+            valid_params_for(role).merge(erase => "")
+        end
+      
+        use "return 400 Bad Request"
+        use "source unchanged"
+        missing_param erase
+      end
+    end
+
+    [:title, :url].each do |missing|
+      context "#{role} : put /:id/sources/:id without #{missing}" do
+        before do
+          put "/#{@category.id}/sources/#{@source.id}",
+            valid_params_for(role).delete_if { |k, v| k == missing }
+        end
+      
+        use "return 200 Ok"
+        doc_properties %w(title url raw id created_at updated_at)
+
+        test "should change correct fields in database" do
+          source = Source.find_by_id(@source.id)
+          @valid_params.each_pair do |key, value|
+            assert_equal(value, source[key]) if key != missing
+          end
+          assert_equal @source_copy[missing], source[missing]
+        end
+      end
+    end
+  
+    context "#{role} : put /:id/sources/:id with valid params" do
+      before do
+        put "/#{@category.id}/sources/#{@source.id}", valid_params_for(role)
+      end
+
+      use "return 200 Ok"
+      doc_properties %w(title url raw id created_at updated_at)
+          
+      test "should change correct fields in database" do
+        source = Source.find_by_id(@source.id)
+        @valid_params.each_pair do |key, value|
+          assert_equal value, source[key]
+        end
+      end
+    end
+  end
+
+  %w(admin).each do |role|
+    context "#{role} : put /:fake_id/sources/:fake_id" do
+      before do
+        put "/#{FAKE_ID}/sources/#{FAKE_ID}",
+          valid_params_for(role).merge(@extra_admin_params)
+      end
+    
+      use "return 404 Not Found with empty response body"
+      use "source unchanged"
+    end
+    
+    context "#{role} : put /:fake_id/sources/:id" do
+      before do
+        put "/#{FAKE_ID}/sources/#{@source.id}",
+          valid_params_for(role).merge(@extra_admin_params)
+      end
+    
+      use "return 404 Not Found with empty response body"
+      use "source unchanged"
+    end
+    
+    context "#{role} : put /:id/sources/:fake_id" do
+      before do
+        put "/#{@category.id}/sources/#{FAKE_ID}",
+          valid_params_for(role).merge(@extra_admin_params)
+      end
+    
+      use "return 404 Not Found with empty response body"
+      use "source unchanged"
+    end
+      
+    context "#{role} : put /:id/sources/:not_related_id" do
+      before do
+        put "/#{@category.id}/sources/#{@other_source.id}",
+          valid_params_for(role).merge(@extra_admin_params)
+      end
+      
+      use "return 404 Not Found with empty response body"
+      use "source unchanged"
+    end
+    
+    [:created_at, :updated_at].each do |invalid|
+      context "#{role} : put /:id/sources/:id but with #{invalid}" do
+        before do
+          put "/#{@category.id}/sources/#{@source.id}",
+            valid_params_for(role).merge(@extra_admin_params).merge(invalid => 9)
+        end
+      
+        use "return 400 Bad Request"
+        use "source unchanged"
+        invalid_param invalid
+      end
+    end
+    
+    [:title, :url].each do |erase|
+      context "#{role} : put /:id/sources/:id but blanking out #{erase}" do
+        before do
+          put "/#{@category.id}/sources/#{@source.id}",
+            valid_params_for(role).merge(@extra_admin_params).merge(erase => "")
+        end
+      
+        use "return 400 Bad Request"
+        use "source unchanged"
+        missing_param erase
+      end
+    end
+
+    context "#{role} : put /:id/sources/:id with no params" do
+      before do
+        put "/#{@category.id}/sources/#{@source.id}", 
+          :api_key => api_key_for(role)
+      end
+    
+      use "return 400 because no params were given"
+      use "source unchanged"
+    end
+
+    [:title, :url].each do |missing|
+      context "#{role} : put /:id/sources/:id without #{missing}" do
+        before do
+          put "/#{@category.id}/sources/#{@source.id}",
+            valid_params_for(role).merge(@extra_admin_params).delete_if { |k, v| k == missing }
+        end
+      
+        use "return 200 Ok"
+        doc_properties %w(title url raw id created_at updated_at)
+    
+        test "should change correct fields in database" do
+          source = Source.find_by_id(@source.id)
+          @valid_params.merge(@extra_admin_params).each_pair do |key, value|
+            assert_equal(value, source[key]) if key != missing
+          end
+          assert_equal @source_copy[missing], source[missing]
+        end
+      end
+    end
+
+    context "#{role} : put /:id/sources/:id" do
+      before do
+        put "/#{@category.id}/sources/#{@source.id}",
+          valid_params_for(role).merge(@extra_admin_params)
+      end
+      
+      use "return 200 Ok"
+      doc_properties %w(title url raw id created_at updated_at)
+      
+      test "should change all fields in database" do
+        source = Source.find_by_id(@source.id)
+        @valid_params.merge(@extra_admin_params).each_pair do |key, value|
+          assert_equal value, source[key]
+        end
+      end
+    end
+  end
+  
+end

data/examples/datacatalog/test/resources/sources/sources_delete_test.rb

@@ -14,18 +14,6 @@ class SourcesDeleteResourceTest < ResourceTestCase
   after do
     @source.destroy
   end
-
-  shared "no change in source count" do
-    test "should not change number of source documents in database" do
-      assert_equal @source_count, Source.all.length
-    end
-  end
-
-  shared "one less source" do
-    test "should remove one source document from database" do
-      assert_equal @source_count - 1, Source.all.length
-    end
-  end
   
   context "delete /:id" do
     context "anonymous" do
@@ -53,7 +41,7 @@ class SourcesDeleteResourceTest < ResourceTestCase
         delete "/#{FAKE_ID}", :api_key => api_key_for(role)
       end
       
-      use "return 401 Unauthorized"
+      use "return 401 because the API key is unauthorized"
       use "no change in source count"
     end
 
@@ -64,7 +52,7 @@ class SourcesDeleteResourceTest < ResourceTestCase
           :key     => "value"
       end
       
-      use "return 401 Unauthorized"
+      use "return 401 because the API key is unauthorized"
       use "no change in source count"
     end
 
@@ -73,7 +61,7 @@ class SourcesDeleteResourceTest < ResourceTestCase
         delete "/#{@source.id}", :api_key => api_key_for(role)
       end
       
-      use "return 401 Unauthorized"
+      use "return 401 because the API key is unauthorized"
       use "no change in source count"
     end
   end
@@ -84,7 +72,7 @@ class SourcesDeleteResourceTest < ResourceTestCase
         delete "/#{FAKE_ID}", :api_key => api_key_for(role)
       end
       
-      use "return 404 Not Found"
+      use "return 404 Not Found with empty response body"
       use "no change in source count"
     end
 
@@ -95,7 +83,7 @@ class SourcesDeleteResourceTest < ResourceTestCase
           :key     => "value"
       end
       
-      use "return 400 because parameters were not empty"
+      use "return 400 because params were not empty"
       use "no change in source count"
     end
 

data/examples/datacatalog/test/resources/sources/sources_get_many_test.rb

@@ -2,16 +2,19 @@ require File.expand_path(File.dirname(__FILE__) + '/../../helpers/resource_test_
 
 class SourcesGetManyResourceTest < ResourceTestCase
 
-  def app; DataCatalog::Sources end
+  include DataCatalog
+
+  def app; Sources end
 
   before do
+    raise "Unexpected Source count" unless Source.count == 0
     @sources = 3.times.map do |i|
       create_source(:title => "Source #{i}")
     end
   end
   
   after do
-    @sources.each { |x| x.destroy }
+    @sources.each { |x| x.destroy } if @sources
   end
   
   SOURCES = ["Source 0", "Source 1", "Source 2"].sort

data/examples/datacatalog/test/resources/sources/sources_get_one_test.rb

@@ -2,7 +2,9 @@ require File.expand_path(File.dirname(__FILE__) + '/../../helpers/resource_test_
 
 class SourcesGetOneResourceTest < ResourceTestCase
 
-  def app; DataCatalog::Sources end
+  include DataCatalog
+
+  def app; Sources end
   
   before do
     @source = create_source
@@ -36,8 +38,7 @@ class SourcesGetOneResourceTest < ResourceTestCase
         get "/#{FAKE_ID}", :api_key => api_key_for(role)
       end
     
-      use "return 404 Not Found"
-      use "return an empty response body"
+      use "return 404 Not Found with empty response body"
     end
 
     context "#{role} : get /:id" do

data/examples/datacatalog/test/resources/sources/sources_post_test.rb

@@ -15,27 +15,6 @@ class SourcesPostResourceTest < ResourceTestCase
     @extra_admin_params = { :raw => { "key" => "value" } }
   end
 
-  shared "no new sources" do
-    test "should not change number of source documents in database" do
-      assert_equal @source_count, Source.all.length
-    end
-  end
-
-  shared "one new source" do
-    test "should add one source document to database" do
-      assert_equal @source_count + 1, Source.all.length
-    end
-  end
-  
-  shared "correct Location header" do
-    test "should set Location header correctly" do
-      base_uri = Config.environment_config["base_uri"]
-      path = %(/sources/#{parsed_response_body["id"]})
-      expected = URI.join(base_uri, path).to_s
-      assert_equal expected, last_response.headers['Location']
-    end
-  end
-  
   context "post /" do
     context "anonymous" do
       before do
@@ -43,7 +22,7 @@ class SourcesPostResourceTest < ResourceTestCase
       end
     
       use "return 401 because the API key is missing"
-      use "no new sources"
+      use "no change in source count"
     end
 
     context "incorrect API key" do
@@ -52,7 +31,7 @@ class SourcesPostResourceTest < ResourceTestCase
       end
   
       use "return 401 because the API key is invalid"
-      use "no new sources"
+      use "no change in source count"
     end
   end
 
@@ -63,8 +42,8 @@ class SourcesPostResourceTest < ResourceTestCase
           post "/", valid_params_for(role).delete_if { |k, v| k == missing }
         end
 
-        use "return 401 Unauthorized"
-        use "no new sources"
+        use "return 401 because the API key is unauthorized"
+        use "no change in source count"
       end
     end
 
@@ -74,8 +53,8 @@ class SourcesPostResourceTest < ResourceTestCase
           post "/", valid_params_for(role).merge(invalid => 9)
         end
   
-        use "return 401 Unauthorized"
-        use "no new sources"
+        use "return 401 because the API key is unauthorized"
+        use "no change in source count"
       end
     end
   
@@ -84,8 +63,8 @@ class SourcesPostResourceTest < ResourceTestCase
         post "/", valid_params_for(role)
       end
       
-      use "return 401 Unauthorized"
-      use "no new sources"
+      use "return 401 because the API key is unauthorized"
+      use "no change in source count"
     end
   end
   
@@ -97,7 +76,7 @@ class SourcesPostResourceTest < ResourceTestCase
         end
 
         use "return 400 Bad Request"
-        use "no new sources"
+        use "no change in source count"
         missing_param missing
       end
     end
@@ -109,7 +88,7 @@ class SourcesPostResourceTest < ResourceTestCase
         end
   
         use "return 400 Bad Request"
-        use "no new sources"
+        use "no change in source count"
         invalid_param invalid
       end
     end
@@ -118,9 +97,13 @@ class SourcesPostResourceTest < ResourceTestCase
       before do
         post "/", valid_params_for(role)
       end
+
+      after do
+        Source.find_by_id(parsed_response_body["id"]).destroy
+      end
   
       use "return 201 Created"
-      use "correct Location header"
+      location_header "sources"
       use "one new source"
       doc_properties %w(title url raw id created_at updated_at categories)
 
@@ -143,7 +126,7 @@ class SourcesPostResourceTest < ResourceTestCase
         end
 
         use "return 400 Bad Request"
-        use "no new sources"
+        use "no change in source count"
         missing_param missing
       end
     end
@@ -156,7 +139,7 @@ class SourcesPostResourceTest < ResourceTestCase
         end
   
         use "return 400 Bad Request"
-        use "no new sources"
+        use "no change in source count"
         invalid_param invalid
       end
     end
@@ -165,9 +148,13 @@ class SourcesPostResourceTest < ResourceTestCase
       before do
         post "/", 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"
-      use "correct Location header"
+      location_header "sources"
       use "one new source"
       doc_properties %w(title url raw id created_at updated_at categories)