sinatra_resource 0.3.2 → 0.3.3

data/VERSION

@@ -1 +1 @@
-0.3.2
+0.3.3

data/examples/datacatalog/models/source.rb

@@ -17,6 +17,7 @@ module DataCatalog
 
     # == Associations
 
+    many :usages
     many :categorizations
 
     def categories

data/examples/datacatalog/models/usage.rb

@@ -0,0 +1,31 @@
+module DataCatalog
+
+  class Usage
+  
+    include MongoMapper::EmbeddedDocument
+
+    # == Attributes
+
+    key :title,       String
+    key :url,         String
+    key :description, String
+
+    # == Indices
+
+    # == Associations
+
+    # == Validations
+
+    # TODO: As of 2009-10-29, MongoMapper does not support validations on
+    # EmbeddedDocuments.
+    # 
+    # validates_presence_of :title
+    # validates_presence_of :url
+  
+    # == Class Methods
+
+    # == Various Instance Methods
+
+  end
+
+end

data/examples/datacatalog/resources/sources_usages.rb

@@ -0,0 +1,32 @@
+module DataCatalog
+
+  class SourcesUsages < Base
+    include Resource
+
+    parent Sources
+    child_association :usages
+    model Usage
+    path "usages"
+
+    # == Permissions
+
+    roles Roles
+    permission :list   => :basic
+    permission :read   => :basic
+    permission :create => :curator
+    permission :update => :curator
+    permission :delete => :curator
+    
+    # == Properties
+
+    property :title
+    property :url
+    property :description
+
+    # == Callbacks
+    
+  end
+  
+  SourcesUsages.build
+
+end

data/examples/datacatalog/test/helpers/lib/model_factories.rb

@@ -34,6 +34,16 @@ module ModelFactories
       :role  => "basic",
     })
   end
+  
+  # -----
+  
+  def new_usage(custom={})
+    new_model!(DataCatalog::Usage, custom, {
+      :title       => "Sample Usage",
+      :url         => "http://inter.net/article/100",
+      :description => "Citation from the internet",
+    })
+  end
 
   protected
 

data/examples/datacatalog/test/helpers/lib/request_helpers.rb

@@ -55,6 +55,19 @@ module RequestHelpers
         assert_equal expected, last_response.headers['Location']
       end
     end
+    
+    def nested_location_header(parent_path, parent_ivar, child_path)
+      test "should set Location header correctly" do
+        base_uri = Config.environment_config["base_uri"]
+        parent = instance_variable_get("@#{parent_ivar}")
+        raise Error unless parent
+        path = parent_path + '/' + parent.id + '/' + child_path + '/' +
+          parsed_response_body["id"]
+        expected = URI.join(base_uri, path).to_s
+        assert_equal expected, last_response.headers['Location']
+      end
+    end
+    
 
   end
   

data/examples/datacatalog/test/helpers/shared/model_counts.rb

@@ -78,6 +78,38 @@ class ResourceTestCase
     end
   end
 
+  # == usages
+
+  shared "no change in usage count" do
+    test "should not change number of user documents in database" do
+      source = DataCatalog::Source.find_by_id(@source.id)
+      assert_equal @usage_count, source.usages.length
+    end
+  end
+
+  shared "one less usage" do
+    test "should remove one user document from database" do
+      source = DataCatalog::Source.find_by_id(@source.id)
+      assert_equal @usage_count - 1, source.usages.length
+    end
+  end
+
+  shared "one new usage" do
+    test "should add one user document to database" do
+      source = DataCatalog::Source.find_by_id(@source.id)
+      assert_equal @usage_count + 1, source.usages.length
+    end
+  end
+
+  shared "usage unchanged" do
+    test "should not change usage in database" do
+      source = DataCatalog::Source.find_by_id(@source.id)
+      usage = source.usages.detect { |x| x.id == @usage_id }
+      assert @usage_copy
+      assert_equal @usage_copy, usage
+    end
+  end
+
   # == users
 
   shared "no change in user count" do

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

@@ -43,10 +43,10 @@ class CategoriesSourcesGetManyResourceTest < ResourceTestCase
     @category.destroy
   end
 
-  context "get /:id/sources/" do
+  context "get /:id/sources" do
     context "anonymous" do
       before do
-        get "/#{@category.id}/sources/"
+        get "/#{@category.id}/sources"
       end
     
       use "return 401 because the API key is missing"
@@ -54,7 +54,7 @@ class CategoriesSourcesGetManyResourceTest < ResourceTestCase
   
     context "incorrect API key" do
       before do
-        get "/#{@category.id}/sources/", :api_key => BAD_API_KEY
+        get "/#{@category.id}/sources", :api_key => BAD_API_KEY
       end
       
       use "return 401 because the API key is invalid"
@@ -64,7 +64,7 @@ class CategoriesSourcesGetManyResourceTest < ResourceTestCase
   %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)
+        get "/#{FAKE_ID}/sources", :api_key => api_key_for(role)
       end
     
       use "return 404 Not Found with empty response body"
@@ -72,7 +72,7 @@ class CategoriesSourcesGetManyResourceTest < ResourceTestCase
 
     context "#{role} : get /:id/sources" do
       before do
-        get "/#{@category.id}/sources/", :api_key => api_key_for(role)
+        get "/#{@category.id}/sources", :api_key => api_key_for(role)
       end
 
       use "return 200 Ok"

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

@@ -30,7 +30,7 @@ class CategoriesSourcesPostResourceTest < ResourceTestCase
   context "post /:id/sources" do
     context "anonymous" do
       before do
-        post "/#{@category.id}/sources/"
+        post "/#{@category.id}/sources"
       end
     
       use "return 401 because the API key is missing"
@@ -39,7 +39,7 @@ class CategoriesSourcesPostResourceTest < ResourceTestCase
   
     context "incorrect API key" do
       before do
-        post "/#{@category.id}/sources/", :api_key => BAD_API_KEY
+        post "/#{@category.id}/sources", :api_key => BAD_API_KEY
       end
       
       use "return 401 because the API key is invalid"
@@ -50,7 +50,7 @@ class CategoriesSourcesPostResourceTest < ResourceTestCase
   %w(basic).each do |role|
     context "#{role} : post /:fake_id/sources" do
       before do
-        post "/#{FAKE_ID}/sources/", :api_key => api_key_for(role)
+        post "/#{FAKE_ID}/sources", :api_key => api_key_for(role)
       end
   
       use "return 404 Not Found with empty response body"
@@ -59,7 +59,7 @@ class CategoriesSourcesPostResourceTest < ResourceTestCase
   
     context "#{role} : post /:id/sources" do
       before do
-        post "/#{@category.id}/sources/", :api_key => api_key_for(role)
+        post "/#{@category.id}/sources", :api_key => api_key_for(role)
       end
     
       use "return 401 because the API key is unauthorized"
@@ -70,7 +70,7 @@ class CategoriesSourcesPostResourceTest < ResourceTestCase
   %w(curator).each do |role|
     context "#{role} : post /:fake_id/sources" do
       before do
-        post "/#{FAKE_ID}/sources/", :api_key => api_key_for(role)
+        post "/#{FAKE_ID}/sources", :api_key => api_key_for(role)
       end
     
       use "return 404 Not Found with empty response body"
@@ -78,9 +78,9 @@ class CategoriesSourcesPostResourceTest < ResourceTestCase
     end
   
     [:title, :url].each do |missing|
-      context "#{role} : post /:id/sources/ but missing #{missing}" do
+      context "#{role} : post /:id/sources but missing #{missing}" do
         before do
-          post "/#{@category.id}/sources/",
+          post "/#{@category.id}/sources",
             valid_params_for(role).delete_if { |k, v| k == missing }
         end
         
@@ -91,9 +91,9 @@ class CategoriesSourcesPostResourceTest < ResourceTestCase
     end
 
     [:raw, :id, :created_at, :updated_at, :junk].each do |invalid|
-      context "#{role} : post /:id/sources/ but with #{invalid}" do
+      context "#{role} : post /:id/sources but with #{invalid}" do
         before do
-          post "/#{@category.id}/sources/", valid_params_for(role).
+          post "/#{@category.id}/sources", valid_params_for(role).
             merge(invalid => 9)
         end
       
@@ -105,7 +105,7 @@ class CategoriesSourcesPostResourceTest < ResourceTestCase
 
     context "#{role} : post /:id/sources with valid params" do
       before do
-        post "/#{@category.id}/sources/", valid_params_for(role)
+        post "/#{@category.id}/sources", valid_params_for(role)
       end
 
       after do
@@ -113,7 +113,7 @@ class CategoriesSourcesPostResourceTest < ResourceTestCase
       end
       
       use "return 201 Created"
-      location_header "sources"
+      nested_location_header "categories", :category, "sources"
       use "one new source"
       doc_properties %w(title url raw id created_at updated_at)
       
@@ -127,7 +127,7 @@ class CategoriesSourcesPostResourceTest < ResourceTestCase
   %w(admin).each do |role|
     context "#{role} : post /:fake_id/sources" do
       before do
-        post "/#{FAKE_ID}/sources/",
+        post "/#{FAKE_ID}/sources",
           valid_params_for(role).merge(@extra_admin_params)
       end
     
@@ -136,9 +136,9 @@ class CategoriesSourcesPostResourceTest < ResourceTestCase
     end
   
     [:title, :url].each do |missing|
-      context "#{role} : post /:id/sources/ but missing #{missing}" do
+      context "#{role} : post /:id/sources but missing #{missing}" do
         before do
-          post "/#{@category.id}/sources/",
+          post "/#{@category.id}/sources",
             valid_params_for(role).merge(@extra_admin_params).
               delete_if { |k, v| k == missing }
         end
@@ -150,9 +150,9 @@ class CategoriesSourcesPostResourceTest < ResourceTestCase
     end
 
     [:id, :created_at, :updated_at, :junk].each do |invalid|
-      context "#{role} : post /:id/sources/ but with #{invalid}" do
+      context "#{role} : post /:id/sources but with #{invalid}" do
         before do
-          post "/#{@category.id}/sources/", valid_params_for(role).
+          post "/#{@category.id}/sources", valid_params_for(role).
             merge(@extra_admin_params).merge(invalid => 9)
         end
       
@@ -164,7 +164,7 @@ class CategoriesSourcesPostResourceTest < ResourceTestCase
 
     context "#{role} : post /:id/sources with valid params" do
       before do
-        post "/#{@category.id}/sources/",
+        post "/#{@category.id}/sources",
           valid_params_for(role).merge(@extra_admin_params)
       end
 
@@ -173,7 +173,7 @@ class CategoriesSourcesPostResourceTest < ResourceTestCase
       end
       
       use "return 201 Created"
-      location_header "sources"
+      nested_location_header "categories", :category, "sources"
       use "one new source"
       doc_properties %w(title url raw id created_at updated_at)
       

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

@@ -245,32 +245,6 @@ class CategoriesSourcesPutResourceTest < ResourceTestCase
       use "return 404 Not Found with empty response body"
       use "source unchanged"
     end
-    
-    [:created_at, :updated_at, :junk].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
@@ -281,7 +255,7 @@ class CategoriesSourcesPutResourceTest < ResourceTestCase
       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
@@ -302,6 +276,32 @@ class CategoriesSourcesPutResourceTest < ResourceTestCase
       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
+
+    [:created_at, :updated_at, :junk].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
+
     context "#{role} : put /:id/sources/:id" do
       before do
         put "/#{@category.id}/sources/#{@source.id}",

data/examples/datacatalog/test/resources/sources_usages/sources_usages_delete_test.rb

@@ -0,0 +1,145 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../helpers/resource_test_helper')
+
+class SourcesUsagesDeleteResourceTest < ResourceTestCase
+
+  include DataCatalog
+
+  def app; Sources end
+  
+  before do
+    @source = create_source
+    @source.usages << new_usage
+    @source.save
+    @usage_id = @source.usages[0].id
+    @usage_count = @source.usages.length
+
+    @other_source = create_source
+    @other_source.usages << new_usage
+    @other_source.save
+    @other_usage_id = @other_source.usages[0].id
+  end
+
+  context "delete /:id/usages/:id" do
+    context "anonymous" do
+      before do
+        delete "/#{@source.id}/usages/#{@usage_id}"
+      end
+    
+      use "return 401 because the API key is missing"
+    end
+  
+    context "incorrect API key" do
+      before do
+        delete "/#{@source.id}/usages/#{@usage_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/usages/:fake_id" do
+      before do
+        delete "/#{FAKE_ID}/usages/#{FAKE_ID}",
+          :api_key => api_key_for(role)
+      end
+    
+      use "return 404 Not Found with empty response body"
+      use "no change in usage count"
+    end
+    
+    context "#{role} : delete /:fake_id/usages/:id" do
+      before do
+        delete "/#{FAKE_ID}/usages/#{@usage_id}",
+          :api_key => api_key_for(role)
+      end
+    
+      use "return 404 Not Found with empty response body"
+      use "no change in usage count"
+    end
+    
+    context "#{role} : delete /:id/usages/:fake_id" do
+      before do
+        delete "/#{@source.id}/usages/#{FAKE_ID}", :api_key => api_key_for(role)
+      end
+    
+      use "return 401 because the API key is unauthorized"
+      use "no change in usage count"
+    end
+  
+    context "#{role} : delete /:id/usages/:not_related_id" do
+      before do
+        delete "/#{@source.id}/usages/#{@other_usage_id}",
+          :api_key => api_key_for(role)
+      end
+      
+      use "return 401 because the API key is unauthorized"
+      use "no change in usage count"
+    end
+  
+    context "#{role} : delete /:id/usages/:id" do
+      before do
+        delete "/#{@source.id}/usages/#{@usage_id}",
+          :api_key => api_key_for(role)
+      end
+      
+      use "return 401 because the API key is unauthorized"
+      use "no change in usage count"
+    end
+  end
+  
+  %w(curator).each do |role|
+  # %w(curator admin).each do |role|
+    context "#{role} : delete /:fake_id/usages/:fake_id" do
+      before do
+        delete "/#{FAKE_ID}/usages/#{FAKE_ID}",
+          :api_key => api_key_for(role)
+      end
+    
+      use "return 404 Not Found with empty response body"
+      use "no change in usage count"
+    end
+    
+    context "#{role} : delete /:fake_id/usages/:id" do
+      before do
+        delete "/#{FAKE_ID}/usages/#{@usage_id}",
+          :api_key => api_key_for(role)
+      end
+    
+      use "return 404 Not Found with empty response body"
+      use "no change in usage count"
+    end
+    
+    context "#{role} : delete /:id/usages/:fake_id" do
+      before do
+        delete "/#{@source.id}/usages/#{FAKE_ID}",
+          :api_key => api_key_for(role)
+      end
+    
+      use "return 404 Not Found with empty response body"
+      use "no change in usage count"
+    end
+  
+    context "#{role} : delete /:id/usages/:not_related_id" do
+      before do
+        delete "/#{@source.id}/usages/#{@other_usage_id}",
+          :api_key => api_key_for(role)
+      end
+      
+      use "return 404 Not Found with empty response body"
+      use "no change in usage count"
+    end
+  
+    context "#{role} : delete /:id/usages/:id" do
+      before do
+        delete "/#{@source.id}/usages/#{@usage_id}",
+          :api_key => api_key_for(role)
+      end
+      
+      use "return 204 No Content"
+      use "one less usage"
+    end
+  end
+  
+end

data/examples/datacatalog/test/resources/sources_usages/sources_usages_get_many_test.rb

@@ -0,0 +1,76 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../helpers/resource_test_helper')
+
+class SourcesUsagesGetManyResourceTest < ResourceTestCase
+
+  include DataCatalog
+
+  def app; Sources end
+
+  before do
+    @source = create_source(:title => "Source A")
+    3.times do |i|
+      @source.usages << new_usage(:title => "Usage #{i}A")
+    end
+    @source.save
+    @usage_titles = ["Usage 0A", "Usage 1A", "Usage 2A"].sort
+
+    @other_source = create_source(:title => "Source B")
+    3.times do |i|
+      @other_source.usages << new_usage(:title => "Usage #{i}B")
+    end
+    @other_source.save
+  end
+  
+  after do
+    @other_source.destroy
+    @source.destroy
+  end
+
+  context "get /:id/usages" do
+    context "anonymous" do
+      before do
+        get "/#{@source.id}/usages"
+      end
+      
+      use "return 401 because the API key is missing"
+    end
+  
+    context "incorrect API key" do
+      before do
+        get "/#{@source.id}/usages", :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/usages" do
+      before do
+        get "/#{FAKE_ID}/usages", :api_key => api_key_for(role)
+      end
+    
+      use "return 404 Not Found with empty response body"
+    end
+  
+    context "#{role} : get /:id/usages" do
+      before do
+        get "/#{@source.id}/usages", :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 @usage_titles, actual.sort
+      end
+      
+      docs_properties %w(title url description id)
+    end
+  end
+
+end