sinatra_resource 0.1.0 → 0.2.0

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

@@ -20,12 +20,6 @@ class SourcesPutResourceTest < ResourceTestCase
     @source.destroy
   end
   
-  shared "source unchanged" do
-    test "should not change source in database" do
-      assert_equal @source_copy, Source.find_by_id(@source.id)
-    end
-  end
-  
   context "put /:id" do
     context "anonymous" do
       before do
@@ -48,23 +42,23 @@ class SourcesPutResourceTest < ResourceTestCase
   
   %w(basic).each do |role|
     [:id, :created_at, :updated_at, :categories].each do |invalid|
-      context "#{role} : put / but with #{invalid}" do
+      context "#{role} : put /:id but with #{invalid}" do
         before do
           put "/#{@source.id}", valid_params_for(role).merge(invalid => 9)
         end
   
-        use "return 401 Unauthorized"
+        use "return 401 because the API key is unauthorized"
         use "source unchanged"
       end
     end
   
     [:title, :url].each do |erase|
-      context "#{role} : put / but blanking out #{erase}" do
+      context "#{role} : put /:id but blanking out #{erase}" do
         before do
           put "/#{@source.id}", valid_params_for(role).merge(erase => "")
         end
   
-        use "return 401 Unauthorized"
+        use "return 401 because the API key is unauthorized"
         use "source unchanged"
       end
     end
@@ -75,7 +69,7 @@ class SourcesPutResourceTest < ResourceTestCase
           put "/#{@source.id}", valid_params_for(role).delete_if { |k, v| k == missing }
         end
   
-        use "return 401 Unauthorized"
+        use "return 401 because the API key is unauthorized"
         use "source unchanged"
       end
     end
@@ -85,14 +79,14 @@ class SourcesPutResourceTest < ResourceTestCase
         put "/#{@source.id}", valid_params_for(role)
       end
       
-      use "return 401 Unauthorized"
+      use "return 401 because the API key is unauthorized"
       use "source unchanged"
     end
   end
   
   %w(curator).each do |role|
     [:raw, :created_at, :updated_at, :categories].each do |invalid|
-      context "#{role} : put / but with #{invalid}" do
+      context "#{role} : put /:id but with #{invalid}" do
         before do
           put "/#{@source.id}", valid_params_for(role).merge(invalid => 9)
         end
@@ -104,7 +98,7 @@ class SourcesPutResourceTest < ResourceTestCase
     end
 
     [:title, :url].each do |erase|
-      context "#{role} : put / but blanking out #{erase}" do
+      context "#{role} : put /:id but blanking out #{erase}" do
         before do
           put "/#{@source.id}", valid_params_for(role).merge(erase => "")
         end
@@ -153,7 +147,7 @@ class SourcesPutResourceTest < ResourceTestCase
   
   %w(admin).each do |role|
     [:created_at, :updated_at, :categories].each do |invalid|
-      context "#{role} : put / but with #{invalid}" do
+      context "#{role} : put /:id but with #{invalid}" do
         before do
           put "/#{@source.id}", valid_params_for(role).
             merge(@extra_admin_params).merge(invalid => 9)
@@ -166,7 +160,7 @@ class SourcesPutResourceTest < ResourceTestCase
     end
 
     [:title, :url].each do |erase|
-      context "#{role} : put / but blanking out #{erase}" do
+      context "#{role} : put /:id but blanking out #{erase}" do
         before do
           put "/#{@source.id}", valid_params_for(role).
             merge(@extra_admin_params).merge(erase => "")
@@ -178,12 +172,12 @@ class SourcesPutResourceTest < ResourceTestCase
       end
     end  
 
-    context "#{role} : put /:id with no parameters" do
+    context "#{role} : put /:id with no params" do
       before do
         put "/#{@source.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 "source unchanged"
     end
 

data/examples/datacatalog/test/resources/users/users_delete_test.rb

@@ -14,18 +14,6 @@ class UsersDeleteResourceTest < ResourceTestCase
   after do
     @user.destroy
   end
-
-  shared "no change in user count" do
-    test "should not change number of user documents in database" do
-      assert_equal @user_count, User.all.length
-    end
-  end
-
-  shared "one less user" do
-    test "should remove one user document from database" do
-      assert_equal @user_count - 1, User.all.length
-    end
-  end
   
   context "delete /:id" do
     context "anonymous" do
@@ -53,7 +41,7 @@ class UsersDeleteResourceTest < 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 user count"
     end
   
@@ -64,16 +52,16 @@ class UsersDeleteResourceTest < ResourceTestCase
           :key     => "value"
       end
       
-      use "return 401 Unauthorized"
+      use "return 401 because the API key is unauthorized"
       use "no change in user count"
     end
-  
+      
     context "#{role} : delete /:id" do
       before do
         delete "/#{@user.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 user count"
     end
   end
@@ -86,10 +74,10 @@ class UsersDeleteResourceTest < ResourceTestCase
           :key     => "value"
       end
       
-      use "return 400 because parameters were not empty"
+      use "return 400 because params were not empty"
       use "no change in user count"
     end
-
+  
     context "delete /:id" do
       before do
         delete "/#{@user.id}", :api_key => @user._api_key
@@ -106,10 +94,10 @@ class UsersDeleteResourceTest < 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 user count"
     end
-
+  
     context "#{role} : delete /:id" do
       before do
         delete "/#{@user.id}",
@@ -117,10 +105,10 @@ class UsersDeleteResourceTest < ResourceTestCase
           :key     => "value"
       end
       
-      use "return 400 because parameters were not empty"
+      use "return 400 because params were not empty"
       use "no change in user count"
     end
-
+  
     context "#{role} : delete /:id" do
       before do
         delete "/#{@user.id}", :api_key => api_key_for(role)

data/examples/datacatalog/test/resources/users/users_get_many_test.rb

@@ -2,9 +2,12 @@ require File.expand_path(File.dirname(__FILE__) + '/../../helpers/resource_test_
 
 class UsersGetManyResourceTest < ResourceTestCase
 
-  def app; DataCatalog::Users end
+  include DataCatalog
+
+  def app; Users end
 
   before do
+    raise "Unexpected Source count" unless User.count == 3
     @users = 3.times.map do |i|
       create_user(
         :name  => "User #{i}",
@@ -14,7 +17,7 @@ class UsersGetManyResourceTest < ResourceTestCase
   end
   
   after do
-    @users.each { |x| x.destroy }
+    @users.each { |x| x.destroy } if @users
   end
   
   NAMES = [

data/examples/datacatalog/test/resources/users/users_get_one_test.rb

@@ -2,7 +2,9 @@ require File.expand_path(File.dirname(__FILE__) + '/../../helpers/resource_test_
 
 class UsersGetOneResourceTest < ResourceTestCase
 
-  def app; DataCatalog::Users end
+  include DataCatalog
+
+  def app; Users end
   
   before do
     @user = create_user
@@ -36,8 +38,7 @@ class UsersGetOneResourceTest < 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
   end
 

data/examples/datacatalog/test/resources/users/users_post_test.rb

@@ -18,27 +18,6 @@ class UsersPostResourceTest < ResourceTestCase
     }
   end
 
-  shared "no new users" do
-    test "should not change number of user documents in database" do
-      assert_equal @user_count, User.all.length
-    end
-  end
-
-  shared "one new user" do
-    test "should add one user document to database" do
-      assert_equal @user_count + 1, User.all.length
-    end
-  end
-
-  shared "correct Location header" do
-    test "should set Location header correctly" do
-      base_uri = Config.environment_config["base_uri"]
-      path = %(/users/#{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
@@ -46,7 +25,7 @@ class UsersPostResourceTest < ResourceTestCase
       end
     
       use "return 401 because the API key is missing"
-      use "no new users"
+      use "no change in user count"
     end
 
     context "incorrect API key" do
@@ -55,7 +34,7 @@ class UsersPostResourceTest < ResourceTestCase
       end
   
       use "return 401 because the API key is invalid"
-      use "no new users"
+      use "no change in user count"
     end
   end
 
@@ -66,8 +45,8 @@ class UsersPostResourceTest < ResourceTestCase
           post "/", valid_params_for(role).delete_if { |k, v| k == missing }
         end
   
-        use "return 401 Unauthorized"
-        use "no new users"
+        use "return 401 because the API key is unauthorized"
+        use "no change in user count"
       end
     end
   
@@ -77,8 +56,8 @@ class UsersPostResourceTest < ResourceTestCase
           post "/", valid_params_for(role).merge(invalid => 9)
         end
   
-        use "return 401 Unauthorized"
-        use "no new users"
+        use "return 401 because the API key is unauthorized"
+        use "no change in user count"
       end
     end
   
@@ -87,8 +66,8 @@ class UsersPostResourceTest < ResourceTestCase
         post "/", valid_params_for(role)
       end
       
-      use "return 401 Unauthorized"
-      use "no new users"
+      use "return 401 because the API key is unauthorized"
+      use "no change in user count"
     end
   end
 
@@ -101,7 +80,7 @@ class UsersPostResourceTest < ResourceTestCase
         end
         
         use "return 400 Bad Request"
-        use "no new users"
+        use "no change in user count"
         missing_param missing
       end
     end
@@ -114,7 +93,7 @@ class UsersPostResourceTest < ResourceTestCase
         end
   
         use "return 400 Bad Request"
-        use "no new users"
+        use "no change in user count"
         invalid_param invalid
       end
     end
@@ -123,9 +102,13 @@ class UsersPostResourceTest < ResourceTestCase
       before do
         post "/", valid_params_for(role).merge(@extra_admin_params)
       end
+
+      after do
+        User.find_by_id(parsed_response_body["id"]).destroy
+      end
   
       use "return 201 Created"
-      use "correct Location header"
+      location_header "users"
       use "one new user"
       doc_properties %w(name email role _api_key id created_at updated_at)
 

data/examples/datacatalog/test/resources/users/users_put_test.rb

@@ -22,12 +22,6 @@ class UsersPutResourceTest < ResourceTestCase
     @user.destroy
   end
   
-  shared "user unchanged" do
-    test "should not change user in database" do
-      assert_equal @user_copy, User.find_by_id(@user.id)
-    end
-  end
-  
   context "put /:id" do
     context "anonymous" do
       before do
@@ -50,25 +44,23 @@ class UsersPutResourceTest < ResourceTestCase
   
   %w(basic curator).each do |role|
     [:created_at, :updated_at].each do |invalid|
-      context "#{role} : put / but with #{invalid}" do
+      context "#{role} : put /:id but with #{invalid}" do
         before do
-          put "/#{@user.id}", valid_params_for(role).
-            merge(@extra_admin_params).merge(invalid => 9)
+          put "/#{@user.id}", valid_params_for(role).merge(invalid => 9)
         end
   
-        use "return 401 Unauthorized"
+        use "return 401 because the API key is unauthorized"
         use "user unchanged"
       end
     end
 
     [:name, :role].each do |erase|
-      context "#{role} : put / but blanking out #{erase}" do
+      context "#{role} : put /:id but blanking out #{erase}" do
         before do
-          put "/#{@user.id}", valid_params_for(role).
-            merge(@extra_admin_params).merge(erase => "")
+          put "/#{@user.id}", valid_params_for(role).merge(erase => "")
         end
       
-        use "return 401 Unauthorized"
+        use "return 401 because the API key is unauthorized"
         use "user unchanged"
       end
     end
@@ -77,27 +69,27 @@ class UsersPutResourceTest < ResourceTestCase
       context "#{role} : put /:id without #{missing}" do
         before do
           put "/#{@user.id}", valid_params_for(role).
-            merge(@extra_admin_params).delete_if { |k, v| k == missing }
+            delete_if { |k, v| k == missing }
         end
       
-        use "return 401 Unauthorized"
+        use "return 401 because the API key is unauthorized"
         use "user unchanged"
       end
     end
 
     context "#{role} : put /:id with valid params" do
       before do
-        put "/#{@user.id}", valid_params_for(role).merge(@extra_admin_params)
+        put "/#{@user.id}", valid_params_for(role)
       end
-
-      use "return 401 Unauthorized"
+    
+      use "return 401 because the API key is unauthorized"
       use "user unchanged"
     end
   end
 
   %w(admin).each do |role|
     [:created_at, :updated_at].each do |invalid|
-      context "#{role} : put / but with #{invalid}" do
+      context "#{role} : put /:id but with #{invalid}" do
         before do
           put "/#{@user.id}", valid_params_for(role).
             merge(@extra_admin_params).merge(invalid => 9)
@@ -110,7 +102,7 @@ class UsersPutResourceTest < ResourceTestCase
     end
 
     [:name, :role].each do |erase|
-      context "#{role} : put / but blanking out #{erase}" do
+      context "#{role} : put /:id but blanking out #{erase}" do
         before do
           put "/#{@user.id}", valid_params_for(role).
             merge(@extra_admin_params).merge(erase => "")
@@ -122,12 +114,12 @@ class UsersPutResourceTest < ResourceTestCase
       end
     end
 
-    context "#{role} : put /:id with no parameters" do
+    context "#{role} : put /:id with no params" do
       before do
         put "/#{@user.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 "user unchanged"
     end
 

data/lib/builder/action_definitions.rb

@@ -0,0 +1,60 @@
+module SinatraResource
+  
+  class Builder
+
+    module ActionDefinitions
+
+      def document_for_get_one(role, model, resource_config, leaf, id, parent_document, association)
+        check_permission(:read, role, resource_config)
+        if resource_config[:parent]
+          check_related?(parent_document, association, id)
+        end
+        check_params(:read, role, resource_config, leaf)
+        find_document!(model, id)
+      end
+      
+      def documents_for_get_many(role, model, resource_config, leaf, parent_document, association)
+        check_permission(:read, role, resource_config)
+        check_params(:read, role, resource_config, leaf)
+        documents = find_documents!(model)
+        # TODO: A more performant approach would be to modify find_documents!
+        # so that it returns the correct results in one query.
+        if resource_config[:parent]
+          documents = select_related(parent_document, association, documents)
+        end
+        documents
+      end
+      
+      def document_for_post(role, model, resource_config, leaf, parent_document, association)
+        check_permission(:create, role, resource_config)
+        check_params(:create, role, resource_config, leaf)
+        document = create_document!(model)
+        if resource_config[:parent]
+          make_related(parent_document, document, resource_config)
+        end
+        document
+      end
+      
+      def document_for_put(role, model, resource_config, leaf, id, parent_document, association)
+        check_permission(:update, role, resource_config)
+        if resource_config[:parent]
+          check_related?(parent_document, association, id)
+        end
+        check_params(:update, role, resource_config, leaf)
+        update_document!(model, id)
+      end
+      
+      def document_for_delete(role, model, resource_config, leaf, id, parent_document, association)
+        check_permission(:delete, role, resource_config)
+        if resource_config[:parent]
+          check_related?(parent_document, association, id)
+        end
+        check_params(:delete, role, resource_config, leaf)
+        delete_document!(model, id)
+      end
+
+    end
+    
+  end
+  
+end