sinatra_resource 0.1.0

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

@@ -0,0 +1,58 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../helpers/resource_test_helper')
+
+class CategoriesGetManyResourceTest < ResourceTestCase
+
+  def app; DataCatalog::Categories end
+
+  before do
+    @categories = 3.times.map do |i|
+      create_category(:name => "Category #{i}")
+    end
+  end
+  
+  after do
+    @categories.each { |x| x.destroy }
+  end
+  
+  CATEGORIES = ["Category 0", "Category 1", "Category 2"].sort
+
+  context "get /" do
+    context "anonymous" do
+      before do
+        get "/"
+      end
+    
+      use "return 401 because the API key is missing"
+    end
+  
+    context "incorrect API key" do
+      before do
+        get "/", :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 /" do
+      before do
+        get "/", :api_key => api_key_for(role)
+      end
+  
+      use "return 200 Ok"
+      
+      test "body should have 3 categories" do
+        assert_equal 3, parsed_response_body.length
+      end
+      
+      test "body should have correct category names" do
+        actual = parsed_response_body.map { |e| e["name"] }
+        assert_equal CATEGORIES, actual.sort
+      end
+      
+      docs_properties %w(name sources id created_at updated_at)
+    end
+  end
+
+end

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

@@ -0,0 +1,75 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../helpers/resource_test_helper')
+
+class CategoriesGetOneResourceTest < ResourceTestCase
+
+  def app; DataCatalog::Categories end
+  
+  before do
+    @category = create_category
+  end
+  
+  after do
+    @category.destroy
+  end
+
+  context "get /:id" do
+    context "anonymous" do
+      before do
+        get "/#{@category.id}"
+      end
+    
+      use "return 401 because the API key is missing"
+    end
+
+    context "incorrect API key" do
+      before do
+        get "/#{@category.id}", :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" do
+      before do
+        get "/#{FAKE_ID}", :api_key => api_key_for(role)
+      end
+    
+      use "return 404 Not Found"
+      use "return an empty response body"
+    end
+
+    context "#{role} : get /:id" do
+      before do
+        @source = create_source
+        @categorization = create_categorization(
+          :source_id   => @source.id,
+          :category_id => @category.id
+        )
+        get "/#{@category.id}", :api_key => api_key_for(role)
+      end
+      
+      after do
+        @source.destroy
+        @categorization.destroy
+      end
+
+      use "return 200 Ok"
+      doc_properties %w(name id created_at updated_at sources)
+      
+      test "body should have correct sources" do
+        expected = [
+          {
+            "id"    => @source.id,
+            "href"  => "/sources/#{@source.id}",
+            "title" => @source.title,
+            "url"   => @source.url,
+          }
+        ]
+        assert_equal expected, parsed_response_body["sources"]
+      end
+    end
+  end
+
+end

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

@@ -0,0 +1,135 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../helpers/resource_test_helper')
+
+class CategoriesPostResourceTest < ResourceTestCase
+
+  include DataCatalog
+
+  def app; Categories end
+
+  before do
+    @category_count = Category.all.length
+    @valid_params = {
+      :name => "New Category"
+    }
+  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
+        post "/", @valid_params
+      end
+    
+      use "return 401 because the API key is missing"
+      use "no new categories"
+    end
+
+    context "incorrect API key" do
+      before do
+        post "/", @valid_params.merge(:api_key => BAD_API_KEY)
+      end
+  
+      use "return 401 because the API key is invalid"
+      use "no new categories"
+    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"
+      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"
+      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"
+    end
+  end
+
+  %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"
+        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"
+        invalid_param invalid
+      end
+    end
+
+    context "#{role} : post / with valid params" do
+      before do
+        post "/", valid_params_for(role)
+      end
+  
+      use "return 201 Created"
+      use "correct Location header"
+      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
+        @valid_params.each_pair do |key, value|
+          assert_equal value, category[key]
+        end
+      end
+    end
+  end
+
+end

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

@@ -0,0 +1,140 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../helpers/resource_test_helper')
+
+class CategoriesPutResourceTest < ResourceTestCase
+
+  include DataCatalog
+
+  def app; Categories end
+
+  before do
+    @category = create_category
+    @category_copy = @category.dup
+    @valid_params = {
+      :name => "Changed Category"
+    }
+  end
+
+  after do
+    @category.destroy
+  end
+  
+  shared "category unchanged" do
+    test "should not change category in database" do
+      assert_equal @category_copy, Category.find_by_id(@category.id)
+    end
+  end
+  
+  context "put /:id" do
+    context "anonymous" do
+      before do
+        put "/#{@category.id}", @valid_params
+      end
+    
+      use "return 401 because the API key is missing"
+      use "category unchanged"
+    end
+  
+    context "incorrect API key" do
+      before do
+        put "/#{@category.id}", @valid_params.merge(:api_key => BAD_API_KEY)
+      end
+  
+      use "return 401 because the API key is invalid"
+      use "category unchanged"
+    end
+  end
+
+  %w(basic).each do |role|
+    [:created_at, :updated_at, :sources].each do |invalid|
+      context "#{role} : put /:id but with #{invalid}" do
+        before do
+          put "/#{@category.id}", valid_params_for(role).merge(invalid => 9)
+        end
+      
+        use "return 401 Unauthorized"
+        use "category unchanged"
+      end
+    end
+
+    [:name].each do |erase|
+      context "#{role} : put /:id but blanking out #{erase}" do
+        before do
+          put "/#{@category.id}", valid_params_for(role).merge(erase => "")
+        end
+      
+        use "return 401 Unauthorized"
+        use "category unchanged"
+      end
+    end
+
+    context "#{role} : put /:id with no parameters" do
+      before do
+        put "/#{@category.id}", :api_key => api_key_for(role)
+      end
+
+      use "return 401 Unauthorized"
+      use "category unchanged"
+    end
+
+    context "#{role} : put /:id with valid params" do
+      before do
+        put "/#{@category.id}", valid_params_for(role)
+      end
+      
+      use "return 401 Unauthorized"
+      use "category unchanged"
+    end
+  end
+  
+  %w(curator admin).each do |role|
+    [:created_at, :updated_at, :sources].each do |invalid|
+      context "#{role} : put / but with #{invalid}" do
+        before do
+          put "/#{@category.id}", valid_params_for(role).merge(invalid => 9)
+        end
+      
+        use "return 400 Bad Request"
+        use "category unchanged"
+        invalid_param invalid
+      end
+    end
+
+    [:name].each do |erase|
+      context "#{role} : put / but blanking out #{erase}" do
+        before do
+          put "/#{@category.id}", valid_params_for(role).merge(erase => "")
+        end
+      
+        use "return 400 Bad Request"
+        use "category unchanged"
+        missing_param erase
+      end
+    end
+
+    context "#{role} : put /:id with no parameters" do
+      before do
+        put "/#{@category.id}", :api_key => api_key_for(role)
+      end
+
+      use "return 400 because no parameters were given"
+      use "category unchanged"
+    end
+
+    context "#{role} : put /:id with valid params" do
+      before do
+        put "/#{@category.id}", valid_params_for(role)
+      end
+      
+      use "return 200 Ok"
+      doc_properties %w(name id created_at updated_at sources)
+    
+      test "should change all fields in database" do
+        category = Category.find_by_id(@category.id)
+        @valid_params.each_pair do |key, value|
+          assert_equal value, category[key]
+        end
+      end
+    end
+  end
+
+end

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

@@ -0,0 +1,112 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../helpers/resource_test_helper')
+
+class SourcesDeleteResourceTest < ResourceTestCase
+
+  include DataCatalog
+
+  def app; Sources end
+
+  before do
+    @source = create_source
+    @source_count = Source.all.length
+  end
+
+  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
+      before do
+        delete "/#{@source.id}"
+      end
+    
+      use "return 401 because the API key is missing"
+      use "no change in source count"
+    end
+
+    context "incorrect API key" do
+      before do
+        delete "/#{@source.id}", :api_key => BAD_API_KEY
+      end
+      
+      use "return 401 because the API key is invalid"
+      use "no change in source 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 source count"
+    end
+
+    context "#{role} : delete /:id" do
+      before do
+        delete "/#{@source.id}",
+          :api_key => api_key_for(role),
+          :key     => "value"
+      end
+      
+      use "return 401 Unauthorized"
+      use "no change in source count"
+    end
+
+    context "#{role} : delete /:id" do
+      before do
+        delete "/#{@source.id}", :api_key => api_key_for(role)
+      end
+      
+      use "return 401 Unauthorized"
+      use "no change in source 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 source count"
+    end
+
+    context "#{role} : delete /:id" do
+      before do
+        delete "/#{@source.id}",
+          :api_key => api_key_for(role),
+          :key     => "value"
+      end
+      
+      use "return 400 because parameters were not empty"
+      use "no change in source count"
+    end
+
+    context "#{role} : delete /:id" do
+      before do
+        delete "/#{@source.id}", :api_key => api_key_for(role)
+      end
+      
+      use "return 204 No Content"
+      use "one less source"
+    end
+  end
+  
+end

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

@@ -0,0 +1,58 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../helpers/resource_test_helper')
+
+class SourcesGetManyResourceTest < ResourceTestCase
+
+  def app; DataCatalog::Sources end
+
+  before do
+    @sources = 3.times.map do |i|
+      create_source(:title => "Source #{i}")
+    end
+  end
+  
+  after do
+    @sources.each { |x| x.destroy }
+  end
+  
+  SOURCES = ["Source 0", "Source 1", "Source 2"].sort
+
+  context "get /" do
+    context "anonymous" do
+      before do
+        get "/"
+      end
+    
+      use "return 401 because the API key is missing"
+    end
+  
+    context "incorrect API key" do
+      before do
+        get "/", :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 /" do
+      before do
+        get "/", :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 SOURCES, actual.sort
+      end
+      
+      docs_properties %w(title url raw categories id created_at updated_at)
+    end
+  end
+
+end

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

@@ -0,0 +1,74 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../helpers/resource_test_helper')
+
+class SourcesGetOneResourceTest < ResourceTestCase
+
+  def app; DataCatalog::Sources end
+  
+  before do
+    @source = create_source
+  end
+
+  after do
+    @source.destroy
+  end
+
+  context "get /:id" do
+    context "anonymous" do
+      before do
+        get "/#{@source.id}"
+      end
+    
+      use "return 401 because the API key is missing"
+    end
+
+    context "incorrect API key" do
+      before do
+        get "/#{@source.id}", :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" do
+      before do
+        get "/#{FAKE_ID}", :api_key => api_key_for(role)
+      end
+    
+      use "return 404 Not Found"
+      use "return an empty response body"
+    end
+
+    context "#{role} : get /:id" do
+      before do
+        @category = create_category
+        @categorization = create_categorization(
+          :source_id   => @source.id,
+          :category_id => @category.id
+        )
+        get "/#{@source.id}", :api_key => api_key_for(role)
+      end
+
+      after do
+        @category.destroy
+        @categorization.destroy
+      end
+
+      use "return 200 Ok"
+      doc_properties %w(title url raw categories id created_at updated_at)
+
+      test "body should have correct categories" do
+        expected = [
+          {
+            "id"   => @category.id,
+            "href" => "/categories/#{@category.id}",
+            "name" => @category.name,
+          }
+        ]
+        assert_equal expected, parsed_response_body["categories"]
+      end
+    end
+  end
+
+end