sinatra_resource 0.1.0 → 0.2.0

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/examples/datacatalog/lib/resource.rb

@@ -9,11 +9,11 @@ module DataCatalog
         include SinatraResource::Resource
       end
       includee.helpers do
-        def before_authorization(action, role)
+        def before_authorization(action, role, resource_config)
           unless role
             error 401, convert(body_for(:errors, ["invalid_api_key"]))
           end
-          if role == :anonymous && minimum_role(action) != :anonymous
+          if role == :anonymous && minimum_role(action, resource_config) != :anonymous
             error 401, convert(body_for(:errors, ["missing_api_key"]))
           end
         end

data/examples/datacatalog/lib/roles.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/../../../lib/sinatra_resource'
+require File.expand_path(File.dirname(__FILE__) + '/../../../lib/sinatra_resource')
 
 module DataCatalog
   

data/examples/datacatalog/resources/categories_sources.rb

@@ -0,0 +1,43 @@
+module DataCatalog
+
+  class CategoriesSources < Base
+    include Resource
+
+    parent Categories
+    child_association :sources
+    model Source
+    path "sources"
+
+    relation :create do |parent, child|
+      Categorization.create(
+        :category_id => parent.id,
+        :source_id   => child.id
+      )
+    end
+    
+    relation :delete do |parent, child|
+      Categorization.find(:conditions => {
+        :category_id => parent.id,
+        :source_id   => child.id
+      }).destroy
+    end
+
+    # == Permissions
+
+    roles Roles
+    permission :read   => :basic
+    permission :modify => :curator
+    
+    # == Properties
+
+    property :title
+    property :url
+    property :raw, :w => :admin
+
+    # == Callbacks
+    
+  end
+  
+  CategoriesSources.build
+
+end

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

@@ -2,8 +2,6 @@ module RequestHelpers
 
   def parsed_response_body
     s = last_response.body
-    # puts "\n== parsed_response_body"
-    # puts "s : #{s.inspect}"
     if s == ""
       nil
     else
@@ -48,6 +46,16 @@ module RequestHelpers
         assert_include "can't be empty", parsed_response_body["errors"][s.to_s]
       end
     end
+
+    def location_header(path)
+      test "should set Location header correctly" do
+        base_uri = Config.environment_config["base_uri"]
+        path = %(#{path}/#{parsed_response_body["id"]})
+        expected = URI.join(base_uri, path).to_s
+        assert_equal expected, last_response.headers['Location']
+      end
+    end
+
   end
   
 end

data/examples/datacatalog/test/helpers/resource_test_helper.rb

@@ -1,5 +1,5 @@
 require File.dirname(__FILE__) + '/test_helper'
-require File.dirname(__FILE__) + '/../../app'
+require File.expand_path(File.dirname(__FILE__) + '/../../app')
 
 BAD_API_KEY = "123400005678"
 FAKE_ID = Mongo::ObjectID.new.to_s

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

@@ -1,18 +1,18 @@
 class ResourceTestCase
 
-  shared "return 400 because no parameters were given" do
+  shared "return 400 because no params were given" do
     use "return 400 Bad Request"
     
-    test "body should say no parameters were given" do
+    test "body should say no params were given" do
       assert_include "errors", parsed_response_body
       assert_include "no_params", parsed_response_body["errors"]
     end
   end
 
-  shared "return 400 because parameters were not empty" do
+  shared "return 400 because params were not empty" do
     use "return 400 Bad Request"
     
-    test "body should say parameters were non-empty" do
+    test "body should say params were non-empty" do
       assert_include "errors", parsed_response_body
       assert_include "non_empty_params", parsed_response_body["errors"]
     end

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

@@ -0,0 +1,81 @@
+class ResourceTestCase
+  
+  # == categories
+
+  shared "no change in category count" do
+    test "should not change number of category documents in database" do
+      assert_equal @category_count, DataCatalog::Category.all.length
+    end
+  end
+
+  shared "one less category" do
+    test "should remove one category document from database" do
+      assert_equal @category_count - 1, DataCatalog::Category.all.length
+    end
+  end
+  
+  shared "one new category" do
+    test "should add one category document to database" do
+      assert_equal @category_count + 1, DataCatalog::Category.all.length
+    end
+  end
+
+  shared "category unchanged" do
+    test "should not change category in database" do
+      assert_equal @category_copy, DataCatalog::Category.find_by_id(@category.id)
+    end
+  end
+
+  # == sources
+
+  shared "no change in source count" do
+    test "should not change number of source documents in database" do
+      assert_equal @source_count, DataCatalog::Source.all.length
+    end
+  end
+
+  shared "one less source" do
+    test "should remove one source document from database" do
+      assert_equal @source_count - 1, DataCatalog::Source.all.length
+    end
+  end
+
+  shared "one new source" do
+    test "should add one source document to database" do
+      assert_equal @source_count + 1, DataCatalog::Source.all.length
+    end
+  end
+
+  shared "source unchanged" do
+    test "should not change source in database" do
+      assert_equal @source_copy, DataCatalog::Source.find_by_id(@source.id)
+    end
+  end
+
+  # == users
+
+  shared "no change in user count" do
+    test "should not change number of user documents in database" do
+      assert_equal @user_count, DataCatalog::User.all.length
+    end
+  end
+
+  shared "one less user" do
+    test "should remove one user document from database" do
+      assert_equal @user_count - 1, DataCatalog::User.all.length
+    end
+  end
+
+  shared "one new user" do
+    test "should add one user document to database" do
+      assert_equal @user_count + 1, DataCatalog::User.all.length
+    end
+  end
+
+  shared "user unchanged" do
+    test "should not change user in database" do
+      assert_equal @user_copy, DataCatalog::User.find_by_id(@user.id)
+    end
+  end
+
+end

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

@@ -23,9 +23,7 @@ class ResourceTestCase
       assert_equal 204, last_response.status
     end
     
-    test "body should be empty" do
-      assert_equal "", last_response.body
-    end
+    use "return an empty response body"
   end
 
   shared "return 400 Bad Request" do
@@ -52,6 +50,12 @@ class ResourceTestCase
     end
   end
 
+  shared "return 404 Not Found with empty response body" do
+    use "return 404 Not Found"
+    
+    use "return an empty response body"
+  end
+
   shared "return 409 Conflict" do
     test "status should be 409 Conflict" do
       assert_equal 409, last_response.status

data/examples/datacatalog/test/helpers/test_helper.rb

@@ -20,17 +20,10 @@ Dir.glob(base + '/test_cases/*.rb').each { |f| require f }
 Dir.glob(base + '/assertions/*.rb').each { |f| require f }
 Dir.glob(base + '/shared/*.rb'    ).each { |f| require f }
 
-require File.dirname(__FILE__) + '/../../config/config'
+require File.expand_path(base + '/../../config/config')
 Config.environment = 'test'
-
 class Test::Unit::TestCase
   include RR::Adapters::TestUnit
 end
 
-# If you use `rake test` the database will automatically get dropped.
-# But if you are running inside TextMate, it is handy to automatically drop the
-# database here:
-if ENV["TM_APP_PATH"]
-  puts "TextMate environment detected. Dropping test database..."
-  Config.drop_database
-end
+Config.drop_database

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

@@ -15,18 +15,6 @@ class CategoriesDeleteResourceTest < ResourceTestCase
     @category.destroy
   end
 
-  shared "no change in category count" do
-    test "should not change number of category documents in database" do
-      assert_equal @category_count, Category.all.length
-    end
-  end
-
-  shared "one less category" do
-    test "should remove one category document from database" do
-      assert_equal @category_count - 1, Category.all.length
-    end
-  end
-  
   context "delete /:id" do
     context "anonymous" do
       before do
@@ -53,7 +41,7 @@ class CategoriesDeleteResourceTest < 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 category count"
     end
 
@@ -64,7 +52,7 @@ class CategoriesDeleteResourceTest < ResourceTestCase
           :key     => "value"
       end
       
-      use "return 401 Unauthorized"
+      use "return 401 because the API key is unauthorized"
       use "no change in category count"
     end
 
@@ -73,7 +61,7 @@ class CategoriesDeleteResourceTest < ResourceTestCase
         delete "/#{@category.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 category count"
     end
   end
@@ -84,7 +72,7 @@ class CategoriesDeleteResourceTest < 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 category count"
     end
 
@@ -95,7 +83,7 @@ class CategoriesDeleteResourceTest < ResourceTestCase
           :key     => "value"
       end
       
-      use "return 400 because parameters were not empty"
+      use "return 400 because params were not empty"
       use "no change in category count"
     end
 

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

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

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

@@ -2,7 +2,9 @@ require File.expand_path(File.dirname(__FILE__) + '/../../helpers/resource_test_
 
 class CategoriesGetOneResourceTest < ResourceTestCase
 
-  def app; DataCatalog::Categories end
+  include DataCatalog
+
+  def app; Categories end
   
   before do
     @category = create_category
@@ -36,8 +38,7 @@ class CategoriesGetOneResourceTest < 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/categories/categories_post_test.rb

@@ -13,27 +13,6 @@ class CategoriesPostResourceTest < ResourceTestCase
     }
   end
 
-  shared "no new categories" do
-    test "should not change number of category documents in database" do
-      assert_equal @category_count, Category.all.length
-    end
-  end
-
-  shared "one new category" do
-    test "should add one category document to database" do
-      assert_equal @category_count + 1, Category.all.length
-    end
-  end
-
-  shared "correct Location header" do
-    test "should set Location header correctly" do
-      base_uri = Config.environment_config["base_uri"]
-      path = %(/categories/#{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
@@ -41,7 +20,7 @@ class CategoriesPostResourceTest < ResourceTestCase
       end
     
       use "return 401 because the API key is missing"
-      use "no new categories"
+      use "no change in category count"
     end
 
     context "incorrect API key" do
@@ -50,78 +29,83 @@ class CategoriesPostResourceTest < ResourceTestCase
       end
   
       use "return 401 because the API key is invalid"
-      use "no new categories"
+      use "no change in category count"
     end
   end
-
+  
   %w(basic).each do |role|
     [:name].each do |missing|
       context "#{role} : post / but missing #{missing}" do
         before do
           post "/", valid_params_for(role).delete_if { |k, v| k == missing }
         end
-
-        use "return 401 Unauthorized"
-        use "no new categories"
+  
+        use "return 401 because the API key is unauthorized"
+        use "no change in category count"
       end
     end
-
+  
     [:id, :created_at, :updated_at, :sources].each do |invalid|
       context "#{role} : post / but with #{invalid}" do
         before do
           post "/", valid_params_for(role).merge(invalid => 9)
         end
   
-        use "return 401 Unauthorized"
-        use "no new categories"
+        use "return 401 because the API key is unauthorized"
+        use "no change in category count"
       end
     end
-
+  
     context "#{role} : post / with valid params" do
       before do
         post "/", valid_params_for(role)
       end
       
-      use "return 401 Unauthorized"
-      use "no new categories"
+      use "return 401 because the API key is unauthorized"
+      use "no change in category count"
     end
   end
 
-  %w(curator admin).each do |role|
+  %w(curator).each do |role|
+  # %w(curator admin).each do |role|
     [:name].each do |missing|
       context "#{role} : post / but missing #{missing}" do
         before do
           post "/", valid_params_for(role).delete_if { |k, v| k == missing }
         end
-
+  
         use "return 400 Bad Request"
-        use "no new categories"
+        use "no change in category count"
         missing_param missing
       end
     end
-
+  
     [:id, :created_at, :updated_at, :sources].each do |invalid|
       context "#{role} : post / but with #{invalid}" do
         before do
           post "/", valid_params_for(role).merge(invalid => 9)
         end
-  
+      
         use "return 400 Bad Request"
-        use "no new categories"
+        use "no change in category count"
         invalid_param invalid
       end
     end
-
+      
     context "#{role} : post / with valid params" do
       before do
         post "/", valid_params_for(role)
       end
-  
+      
+      after do
+        Category.find_by_id(parsed_response_body["id"]).destroy
+      end
+      
       use "return 201 Created"
-      use "correct Location header"
+      location_header "categories"
       use "one new category"
       doc_properties %w(name id created_at updated_at sources)
-
+      
       test "should set all fields in database" do
         category = Category.find_by_id(parsed_response_body["id"])
         raise "Cannot find category" unless category