sinatra_resource 0.1.0

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

@@ -0,0 +1,49 @@
+module ModelFactories
+  
+  def create_source(custom={})
+    create_model!(DataCatalog::Source, custom, {
+      :title => "Healthcare Spending Data",
+      :url   => "http://data.gov/details/23",
+    })
+  end
+  
+  def create_category(custom={})
+    create_model!(DataCatalog::Category, custom, {
+      :name => "Sample Category",
+    })
+  end
+  
+  def create_categorization(custom={})
+    create_model!(DataCatalog::Categorization, custom, {
+      :source_id   => "",
+      :category_id => "",
+    })
+  end
+
+  def create_user(custom={})
+    create_model!(DataCatalog::User, custom, {
+      :name  => "Sample User",
+      :email => "sample.user@inter.net",
+      :role  => "basic",
+    })
+  end
+
+  protected
+
+  def create_model!(klass, custom, required)
+    model = klass.create(required.merge(custom))
+    unless model.valid?
+      raise "Invalid #{klass}: #{model.errors.errors.inspect}"
+    end
+    model
+  end
+
+  def new_model!(klass, custom, required)
+    model = klass.new(required.merge(custom))
+    unless model.valid?
+      raise "Invalid #{klass}: #{model.errors.errors.inspect}"
+    end
+    model
+  end
+  
+end

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

@@ -0,0 +1,30 @@
+module ModelHelpers
+
+  def self.included(includee)
+    includee.extend(ClassMethods)
+  end
+  
+  module ClassMethods
+
+    # Is a document (looked up from +symbol+) missing +key+?
+    #
+    # @param [Symbol] document
+    #
+    # @param [Symbol] missing
+    def missing_key(symbol, key)
+      test "should be invalid" do
+        document = instance_variable_get("@#{symbol}")
+        assert_equal false, document.valid?
+      end
+
+      test "should have errors" do
+        document = instance_variable_get("@#{symbol}")
+        document.valid?
+        expected = "can't be empty"
+        assert_include expected, document.errors.errors[key]
+      end
+    end
+
+  end
+
+end

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

@@ -0,0 +1,53 @@
+module RequestHelpers
+
+  def parsed_response_body
+    s = last_response.body
+    # puts "\n== parsed_response_body"
+    # puts "s : #{s.inspect}"
+    if s == ""
+      nil
+    else
+      Crack::JSON.parse(s)
+    end
+  end
+  
+  def assert_properties(correct, parsed_document)
+    correct.each do |property|
+      assert_include property, parsed_document
+    end
+    assert_equal [], parsed_document.keys - correct
+  end
+
+  def self.included(includee)
+    includee.extend(ClassMethods)
+  end
+  
+  module ClassMethods
+    def doc_properties(correct)
+      test "document should only have correct attributes" do
+        assert_properties(correct, parsed_response_body)
+      end
+    end
+
+    def docs_properties(correct)
+      test "documents should only have correct attributes" do
+        parsed_response_body.each do |parsed|
+          assert_properties(correct, parsed)
+        end
+      end
+    end
+    
+    def invalid_param(s)
+      test "should report #{s} as invalid" do
+        assert_include s.to_s, parsed_response_body["errors"]["invalid_params"]
+      end
+    end
+    
+    def missing_param(s)
+      test "should report missing #{s}" do
+        assert_include "can't be empty", parsed_response_body["errors"][s.to_s]
+      end
+    end
+  end
+  
+end

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

@@ -0,0 +1,5 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+Config.setup_mongomapper
+base = File.dirname(__FILE__)
+Dir.glob(base + '/../../models/*.rb').each { |f| require f }

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

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

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

@@ -0,0 +1,48 @@
+class ResourceTestCase
+
+  shared "return 400 because no parameters were given" do
+    use "return 400 Bad Request"
+    
+    test "body should say no parameters 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
+    use "return 400 Bad Request"
+    
+    test "body should say parameters were non-empty" do
+      assert_include "errors", parsed_response_body
+      assert_include "non_empty_params", parsed_response_body["errors"]
+    end
+  end
+  
+  shared "return 401 because the API key is invalid" do
+    use "return 401 Unauthorized"
+    
+    test "body should say the API key is invalid" do
+      assert_include "errors", parsed_response_body
+      assert_include "invalid_api_key", parsed_response_body["errors"]
+    end
+  end
+  
+  shared "return 401 because the API key is missing" do
+    use "return 401 Unauthorized"
+    
+    test "body should say the API key is missing" do
+      assert_include "errors", parsed_response_body
+      assert_include "missing_api_key", parsed_response_body["errors"]
+    end
+  end
+  
+  shared "return 401 because the API key is unauthorized" do
+    use "return 401 Unauthorized"
+    
+    test "body should say the API key is unauthorized" do
+      assert_include "errors", parsed_response_body
+      assert_include "unauthorized_api_key", parsed_response_body["errors"]
+    end
+  end
+
+end

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

@@ -0,0 +1,15 @@
+class ResourceTestCase
+
+  shared "return an empty response body" do
+    test "should return nil" do
+      assert_equal nil, parsed_response_body
+    end
+  end
+
+  shared "return an empty list response body" do
+    test "should return []" do
+      assert_equal [], parsed_response_body
+    end
+  end
+
+end

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

@@ -0,0 +1,61 @@
+class ResourceTestCase
+  
+  shared "return 200 Ok" do
+    test "status should be 200 Ok" do
+      assert_equal 200, last_response.status
+    end
+  end
+
+  shared "return 201 Created" do
+    test "status should be 201 Created" do
+      assert_equal 201, last_response.status
+    end
+    
+    test "location header should start with http://localhost" do
+      assert_include "Location", last_response.headers
+      generic_uri = %r{^http://localhost}
+      assert_match generic_uri, last_response.headers["Location"]
+    end
+  end
+
+  shared "return 204 No Content" do
+    test "status should be 204 No Content" do
+      assert_equal 204, last_response.status
+    end
+    
+    test "body should be empty" do
+      assert_equal "", last_response.body
+    end
+  end
+
+  shared "return 400 Bad Request" do
+    test "status should be 400 Bad Request" do
+      assert_equal 400, last_response.status
+    end
+  end
+
+  shared "return 401 Unauthorized" do
+    test "status should be 401 Unauthorized" do
+      assert_equal 401, last_response.status
+    end
+  end
+
+  shared "return 403 Forbidden" do
+    test "status should be 403 Forbidden" do
+      assert_equal 403, last_response.status
+    end
+  end
+
+  shared "return 404 Not Found" do
+    test "status should be 404 Not Found" do
+      assert_equal 404, last_response.status
+    end
+  end
+
+  shared "return 409 Conflict" do
+    test "status should be 409 Conflict" do
+      assert_equal 409, last_response.status
+    end
+  end
+
+end

data/examples/datacatalog/test/helpers/test_cases/model_test_case.rb

@@ -0,0 +1,6 @@
+class ModelTestCase < Test::Unit::TestCase
+
+  include ModelFactories
+  include ModelHelpers
+
+end

data/examples/datacatalog/test/helpers/test_cases/resource_test_case.rb

@@ -0,0 +1,36 @@
+class ResourceTestCase < Test::Unit::TestCase
+
+  include Rack::Test::Methods
+  include RequestHelpers
+  include ModelFactories
+
+  before :all do
+    @users_by_role = {}
+    %w(basic curator admin).map do |role|
+      @users_by_role[role] = create_user(
+        :name  => "#{role} User",
+        :email => "#{role}-user@inter.net",
+        :role  => role
+      )
+    end
+  end
+  
+  after :all do
+    @users_by_role.each_pair { |role, user| user.destroy }
+  end
+  
+  def user_for(role)
+    @users_by_role[role]
+  end
+  
+  def api_key_for(role)
+    key = @users_by_role[role]._api_key
+    raise "API key not found" unless key
+    key
+  end
+
+  def valid_params_for(role)
+    @valid_params.merge(:api_key => api_key_for(role))
+  end
+  
+end

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

@@ -0,0 +1,36 @@
+require 'rubygems'
+
+require 'test/unit'
+
+require 'rack/test'
+require 'rr'
+
+gem 'crack', '>= 0.1.4'
+require 'crack/json'
+
+gem 'djsun-context', '>= 0.5.6'
+require 'context'
+
+gem 'jeremymcanally-pending', '>= 0.1'
+require 'pending'
+
+base = File.dirname(__FILE__)
+Dir.glob(base + '/lib/*.rb'       ).each { |f| require f }
+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'
+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

data/examples/datacatalog/test/models/categorization_test.rb

@@ -0,0 +1,40 @@
+require File.expand_path(File.dirname(__FILE__) + '/../helpers/model_test_helper')
+
+class CategorizationTest < ModelTestCase
+  
+  include DataCatalog
+  
+  context "Categorization" do
+    before do
+      @source = create_source
+      @category = create_category
+      @categorization = create_categorization(
+        :source_id   => @source.id,
+        :category_id => @category.id
+      )
+    end
+    
+    after do
+      @source.destroy
+      @category.destroy
+      @categorization.destroy
+    end
+    
+    test "Categorization#source is correct" do
+      assert_equal @source, @categorization.source
+    end
+
+    test "Categorization#category is correct" do
+      assert_equal @category, @categorization.category
+    end
+    
+    test "Source#categorization is correct" do
+      assert_equal [@categorization], @source.categorizations
+    end
+
+    test "Category#categorization is correct" do
+      assert_equal [@categorization], @category.categorizations
+    end
+  end
+
+end

data/examples/datacatalog/test/models/category_test.rb

@@ -0,0 +1,35 @@
+require File.expand_path(File.dirname(__FILE__) + '/../helpers/model_test_helper')
+
+class CategoryTest < ModelTestCase
+  
+  include DataCatalog
+
+  context "Category" do
+    before do
+      @required = {
+        :name => "Science & Technology"
+      }
+    end
+  
+    context "correct params" do
+      before do
+        @category = Category.new(@required)
+      end
+      
+      test "should be valid" do
+        assert_equal true, @category.valid?
+      end
+    end
+    
+    [:name].each do |missing|
+      context "missing #{missing}" do
+        before do
+          @category = Category.new(@required.delete_if { |k, v| k == missing })
+        end
+        
+        missing_key(:category, missing)
+      end
+    end
+  end
+  
+end

data/examples/datacatalog/test/models/source_test.rb

@@ -0,0 +1,37 @@
+require File.expand_path(File.dirname(__FILE__) + '/../helpers/model_test_helper')
+
+class SourceTest < ModelTestCase
+  
+  include DataCatalog
+
+  context "Source" do
+    before do
+      @required = {
+        :title => "Treasury 2009 Summary",
+        :url   => "http://moneybags.gov/data/2009"
+      }
+    end
+  
+    context "correct params" do
+      before do
+        @source = Source.new(@required)
+      end
+      
+      test "should be valid" do
+        assert_equal true, @source.valid?
+      end
+    end
+
+    [:title, :url].each do |missing|
+      context "missing #{missing}" do
+        before do
+          @source = Source.new(@required.delete_if { |k, v| k == missing })
+        end
+        
+        missing_key(:source, missing)
+      end
+    end
+
+  end
+  
+end

data/examples/datacatalog/test/models/user_test.rb

@@ -0,0 +1,77 @@
+require File.expand_path(File.dirname(__FILE__) + '/../helpers/model_test_helper')
+
+class UserTest < ModelTestCase
+  
+  include DataCatalog
+
+  context "User#new" do
+    before do
+      @required = {
+        :name => "Sample User",
+        :role => "basic"
+      }
+    end
+  
+    context "correct params" do
+      before do
+        @user = User.new(@required)
+      end
+      
+      test "should be valid" do
+        assert_equal true, @user.valid?
+      end
+      
+      test "should not set api_key" do
+        assert_equal nil, @user._api_key
+      end
+    end
+    
+    [:name, :role].each do |missing|
+      context "missing #{missing}" do
+        before do
+          @user = User.new(@required.delete_if { |k, v| k == missing })
+        end
+        
+        missing_key(:user, missing)
+      end
+    end
+
+    context "invalid role" do
+      before do
+        @user = User.new(@required.merge(:role => "owner"))
+        # owner is not a 'fixed' role, it is a 'relative' role
+      end
+    
+      test "should be invalid" do
+        assert_equal false, @user.valid?
+      end
+
+      test "should have errors" do
+        @user.valid?
+        expected = %(must be in ["basic", "curator", "admin"])
+        assert_include expected, @user.errors.errors[:role]
+      end
+    end
+
+    context "User#create" do
+      context "correct params" do
+        before do
+          @user = User.create(@required)
+        end
+        
+        after do
+          @user.destroy
+        end
+    
+        test "should be valid" do
+          assert_equal true, @user.valid?
+        end
+    
+        test "should set api_key" do
+          assert_not_equal nil, @user._api_key
+        end
+      end
+    end
+  end
+  
+end

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

@@ -0,0 +1,112 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../helpers/resource_test_helper')
+
+class CategoriesDeleteResourceTest < ResourceTestCase
+
+  include DataCatalog
+
+  def app; Categories end
+
+  before do
+    @category = create_category
+    @category_count = Category.all.length
+  end
+
+  after do
+    @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
+        delete "/#{@category.id}"
+      end
+    
+      use "return 401 because the API key is missing"
+      use "no change in category count"
+    end
+
+    context "incorrect API key" do
+      before do
+        delete "/#{@category.id}", :api_key => BAD_API_KEY
+      end
+      
+      use "return 401 because the API key is invalid"
+      use "no change in category count"
+    end
+  end
+  
+  %w(basic).each do |role|
+    context "#{role} : delete /:fake_id" do
+      before do
+        delete "/#{FAKE_ID}", :api_key => api_key_for(role)
+      end
+      
+      use "return 401 Unauthorized"
+      use "no change in category count"
+    end
+
+    context "#{role} : delete /:id" do
+      before do
+        delete "/#{@category.id}",
+          :api_key => api_key_for(role),
+          :key     => "value"
+      end
+      
+      use "return 401 Unauthorized"
+      use "no change in category count"
+    end
+
+    context "#{role} : delete /:id" do
+      before do
+        delete "/#{@category.id}", :api_key => api_key_for(role)
+      end
+      
+      use "return 401 Unauthorized"
+      use "no change in category count"
+    end
+  end
+
+  %w(curator admin).each do |role|
+    context "#{role} : delete /:fake_id" do
+      before do
+        delete "/#{FAKE_ID}", :api_key => api_key_for(role)
+      end
+      
+      use "return 404 Not Found"
+      use "no change in category count"
+    end
+
+    context "#{role} : delete /:id" do
+      before do
+        delete "/#{@category.id}",
+          :api_key => api_key_for(role),
+          :key     => "value"
+      end
+      
+      use "return 400 because parameters were not empty"
+      use "no change in category count"
+    end
+
+    context "#{role} : delete /:id" do
+      before do
+        delete "/#{@category.id}", :api_key => api_key_for(role)
+      end
+      
+      use "return 204 No Content"
+      use "one less category"
+    end
+  end
+  
+end