sinatra_resource 0.1.0

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

@@ -0,0 +1,184 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../helpers/resource_test_helper')
+
+class SourcesPostResourceTest < ResourceTestCase
+  
+  include DataCatalog
+
+  def app; Sources end
+  
+  before do
+    @source_count = Source.all.length
+    @valid_params = {
+      :title   => "New Source",
+      :url     => "http://data.gov/details/123"
+    }
+    @extra_admin_params = { :raw => { "key" => "value" } }
+  end
+
+  shared "no new sources" do
+    test "should not change number of source documents in database" do
+      assert_equal @source_count, Source.all.length
+    end
+  end
+
+  shared "one new source" do
+    test "should add one source document to database" do
+      assert_equal @source_count + 1, Source.all.length
+    end
+  end
+  
+  shared "correct Location header" do
+    test "should set Location header correctly" do
+      base_uri = Config.environment_config["base_uri"]
+      path = %(/sources/#{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 sources"
+    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 sources"
+    end
+  end
+
+  %w(basic).each do |role|
+    [:title, :url].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 sources"
+      end
+    end
+
+    [:id, :created_at, :updated_at, :categories].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 sources"
+      end
+    end
+  
+    context "#{role} : post / with valid params" do
+      before do
+        post "/", valid_params_for(role)
+      end
+      
+      use "return 401 Unauthorized"
+      use "no new sources"
+    end
+  end
+  
+  %w(curator).each do |role|
+    [:title, :url].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 sources"
+        missing_param missing
+      end
+    end
+
+    [:raw, :id, :created_at, :updated_at, :categories].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 sources"
+        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 source"
+      doc_properties %w(title url raw id created_at updated_at categories)
+
+      test "should set all fields in database" do
+        source = Source.find_by_id(parsed_response_body["id"])
+        raise "Cannot find source" unless source
+        @valid_params.each_pair do |key, value|
+          assert_equal value, source[key]
+        end
+      end
+    end
+  end
+
+  %w(admin).each do |role|
+    [:title, :url].each do |missing|
+      context "#{role} : post / but missing #{missing}" do
+        before do
+          post "/", valid_params_for(role).
+            merge(@extra_admin_params).delete_if { |k, v| k == missing }
+        end
+
+        use "return 400 Bad Request"
+        use "no new sources"
+        missing_param missing
+      end
+    end
+
+    [:id, :created_at, :updated_at, :categories].each do |invalid|
+      context "#{role} : post / but with #{invalid}" do
+        before do
+          post "/", valid_params_for(role).
+            merge(@extra_admin_params).merge(invalid => 9)
+        end
+  
+        use "return 400 Bad Request"
+        use "no new sources"
+        invalid_param invalid
+      end
+    end
+  
+    context "#{role} : post / with valid params" do
+      before do
+        post "/", valid_params_for(role).merge(@extra_admin_params)
+      end
+  
+      use "return 201 Created"
+      use "correct Location header"
+      use "one new source"
+      doc_properties %w(title url raw id created_at updated_at categories)
+
+      test "should set all fields in database" do
+        source = Source.find_by_id(parsed_response_body["id"])
+        raise "Cannot find source" unless source
+        @valid_params.merge(@extra_admin_params).each_pair do |key, value|
+          assert_equal value, source[key]
+        end
+      end
+    end
+  end
+
+end

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

@@ -0,0 +1,227 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../helpers/resource_test_helper')
+
+class SourcesPutResourceTest < ResourceTestCase
+
+  include DataCatalog
+
+  def app; Sources end
+
+  before do
+    @source = create_source
+    @source_copy = @source.dup
+    @valid_params = {
+      :title   => "Changed Source",
+      :url     => "http://updated.com/details/7"
+    }
+    @extra_admin_params = { :raw => { "key" => "value" } }
+  end
+
+  after do
+    @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
+        put "/#{@source.id}", @valid_params
+      end
+    
+      use "return 401 because the API key is missing"
+      use "source unchanged"
+    end
+  
+    context "incorrect API key" do
+      before do
+        put "/#{@source.id}", @valid_params.merge(:api_key => BAD_API_KEY)
+      end
+  
+      use "return 401 because the API key is invalid"
+      use "source unchanged"
+    end
+  end
+  
+  %w(basic).each do |role|
+    [:id, :created_at, :updated_at, :categories].each do |invalid|
+      context "#{role} : put / but with #{invalid}" do
+        before do
+          put "/#{@source.id}", valid_params_for(role).merge(invalid => 9)
+        end
+  
+        use "return 401 Unauthorized"
+        use "source unchanged"
+      end
+    end
+  
+    [:title, :url].each do |erase|
+      context "#{role} : put / but blanking out #{erase}" do
+        before do
+          put "/#{@source.id}", valid_params_for(role).merge(erase => "")
+        end
+  
+        use "return 401 Unauthorized"
+        use "source unchanged"
+      end
+    end
+  
+    [:title, :url].each do |missing|
+      context "#{role} : put /:id without #{missing}" do
+        before do
+          put "/#{@source.id}", valid_params_for(role).delete_if { |k, v| k == missing }
+        end
+  
+        use "return 401 Unauthorized"
+        use "source unchanged"
+      end
+    end
+  
+    context "#{role} : put /:id with valid params" do
+      before do
+        put "/#{@source.id}", valid_params_for(role)
+      end
+      
+      use "return 401 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
+        before do
+          put "/#{@source.id}", valid_params_for(role).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 / but blanking out #{erase}" do
+        before do
+          put "/#{@source.id}", valid_params_for(role).merge(erase => "")
+        end
+      
+        use "return 400 Bad Request"
+        use "source unchanged"
+        missing_param erase
+      end
+    end  
+
+    [:title, :url].each do |missing|
+      context "#{role} : put /:id without #{missing}" do
+        before do
+          put "/#{@source.id}", valid_params_for(role).delete_if { |k, v| k == missing }
+        end
+      
+        use "return 200 Ok"
+        doc_properties %w(title url raw id created_at updated_at categories)
+
+        test "should change correct fields in database" do
+          source = Source.find_by_id(@source.id)
+          @valid_params.each_pair do |key, value|
+            assert_equal(value, source[key]) if key != missing
+          end
+          assert_equal @source_copy[missing], source[missing]
+        end
+      end
+    end
+
+    context "#{role} : put /:id with valid params" do
+      before do
+        put "/#{@source.id}", valid_params_for(role)
+      end
+      
+      use "return 200 Ok"
+      doc_properties %w(title url raw id created_at updated_at categories)
+
+      test "should change correct fields in database" do
+        source = Source.find_by_id(@source.id)
+        @valid_params.each_pair do |key, value|
+          assert_equal value, source[key]
+        end
+      end
+    end
+  end
+  
+  %w(admin).each do |role|
+    [:created_at, :updated_at, :categories].each do |invalid|
+      context "#{role} : put / but with #{invalid}" do
+        before do
+          put "/#{@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 / but blanking out #{erase}" do
+        before do
+          put "/#{@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 with no parameters" do
+      before do
+        put "/#{@source.id}", :api_key => api_key_for(role)
+      end
+
+      use "return 400 because no parameters were given"
+      use "source unchanged"
+    end
+
+    [:title, :url].each do |missing|
+      context "#{role} : put /:id without #{missing}" do
+        before do
+          put "/#{@source.id}", valid_params_for(role).
+            merge(@extra_admin_params).delete_if { |k, v| k == missing }
+        end
+      
+        use "return 200 Ok"
+        doc_properties %w(title url raw id created_at updated_at categories)
+
+        test "should change correct fields in database" do
+          source = Source.find_by_id(@source.id)
+          @valid_params.merge(@extra_admin_params).each_pair do |key, value|
+            assert_equal(value, source[key]) if key != missing
+          end
+          assert_equal @source_copy[missing], source[missing]
+        end
+      end
+    end
+
+    context "#{role} : put /:id with valid params" do
+      before do
+        put "/#{@source.id}", valid_params_for(role).merge(@extra_admin_params)
+      end
+      
+      use "return 200 Ok"
+      doc_properties %w(title url raw id created_at updated_at categories)
+
+      test "should change all fields in database" do
+        source = Source.find_by_id(@source.id)
+        @valid_params.merge(@extra_admin_params).each_pair do |key, value|
+          assert_equal value, source[key]
+        end
+      end
+    end
+  end
+
+end

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

@@ -0,0 +1,134 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../helpers/resource_test_helper')
+
+class UsersDeleteResourceTest < ResourceTestCase
+
+  include DataCatalog
+
+  def app; Users end
+
+  before do
+    @user = create_user
+    @user_count = User.all.length
+  end
+
+  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
+      before do
+        delete "/#{@user.id}"
+      end
+    
+      use "return 401 because the API key is missing"
+      use "no change in user count"
+    end
+
+    context "incorrect API key" do
+      before do
+        delete "/#{@user.id}", :api_key => BAD_API_KEY
+      end
+      
+      use "return 401 because the API key is invalid"
+      use "no change in user count"
+    end
+  end
+  
+  %w(basic curator).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 user count"
+    end
+  
+    context "#{role} : delete /:id" do
+      before do
+        delete "/#{@user.id}",
+          :api_key => api_key_for(role),
+          :key     => "value"
+      end
+      
+      use "return 401 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 "no change in user count"
+    end
+  end
+
+  context "owner" do
+    context "delete /:id" do
+      before do
+        delete "/#{@user.id}",
+          :api_key => @user._api_key,
+          :key     => "value"
+      end
+      
+      use "return 400 because parameters were not empty"
+      use "no change in user count"
+    end
+
+    context "delete /:id" do
+      before do
+        delete "/#{@user.id}", :api_key => @user._api_key
+      end
+      
+      use "return 204 No Content"
+      use "one less user"
+    end
+  end
+  
+  %(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 user count"
+    end
+
+    context "#{role} : delete /:id" do
+      before do
+        delete "/#{@user.id}",
+          :api_key => api_key_for(role),
+          :key     => "value"
+      end
+      
+      use "return 400 because parameters 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)
+      end
+      
+      use "return 204 No Content"
+      use "one less user"
+    end
+  end
+  
+end

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

@@ -0,0 +1,111 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../helpers/resource_test_helper')
+
+class UsersGetManyResourceTest < ResourceTestCase
+
+  def app; DataCatalog::Users end
+
+  before do
+    @users = 3.times.map do |i|
+      create_user(
+        :name  => "User #{i}",
+        :email => "user-#{i}@inter.net"
+      )
+    end
+  end
+  
+  after do
+    @users.each { |x| x.destroy }
+  end
+  
+  NAMES = [
+    "admin User",
+    "basic User",
+    "curator User",
+    "User 0",
+    "User 1",
+    "User 2"
+  ].sort
+  
+  EMAILS = %w(
+    admin-user@inter.net
+    basic-user@inter.net
+    curator-user@inter.net
+    user-0@inter.net
+    user-1@inter.net
+    user-2@inter.net
+  ).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).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 6 users" do
+        assert_equal 6, parsed_response_body.length
+      end
+      
+      test "body should have correct names" do
+        actual = parsed_response_body.map { |e| e["name"] }
+        assert_equal NAMES, actual.sort
+      end
+
+      test "body elements should be correct" do
+        parsed_response_body.each do |element|
+          if element["id"] == user_for(role).id
+            assert_properties(%w(name email role _api_key id created_at updated_at), element)
+          else
+            assert_properties(%w(name id created_at updated_at), element)
+          end
+        end
+      end
+    end
+  end
+  
+  %w(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 6 users" do
+        assert_equal 6, parsed_response_body.length
+      end
+      
+      test "body should have correct names" do
+        actual = parsed_response_body.map { |e| e["name"] }
+        assert_equal NAMES, actual.sort
+      end
+  
+      test "body should have correct emails" do
+        actual = parsed_response_body.map { |e| e["email"] }
+        assert_equal EMAILS, actual.sort
+      end
+      
+      docs_properties %w(name email role _api_key id created_at updated_at)
+    end
+  end
+  
+end