Skip to content

O
OHR Support
Commit 4b1dd334 authored by Eric Davis's avatar Eric Davis
Browse files
Options

Allow key authentication when creating issues (with tests) #6447 

git-svn-id: svn+ssh://rubyforge.org/var/svn/redmine/trunk@4365 e93f8b46-1217-0410-a6f0-8f06a7374b81
parent c967899b
Hide whitespace changes
Inline Side-by-side
Showing with 84 additions and 56 deletions
app/controllers/issues_controller.rb
View file @ 4b1dd334
...@@ -27,7 +27,7 @@ class IssuesController < ApplicationController ...@@ -27,7 +27,7 @@ class IssuesController < ApplicationController
before_filter :find_optional_project, :only => [:index] before_filter :find_optional_project, :only => [:index]
before_filter :check_for_default_issue_status, :only => [:new, :create] before_filter :check_for_default_issue_status, :only => [:new, :create]
before_filter :build_new_issue_from_params, :only => [:new, :create] before_filter :build_new_issue_from_params, :only => [:new, :create]
accept_key_auth :index, :show accept_key_auth :index, :show, :create
rescue_from Query::StatementInvalid, :with => :query_statement_invalid rescue_from Query::StatementInvalid, :with => :query_statement_invalid
......
test/integration/api_test/issues_test.rb
View file @ 4b1dd334
...@@ -91,69 +91,70 @@ class ApiTest::IssuesTest < ActionController::IntegrationTest ...@@ -91,69 +91,70 @@ class ApiTest::IssuesTest < ActionController::IntegrationTest
end end
context "POST /issues.xml" do context "POST /issues.xml" do
setup do should_allow_api_authentication(:post,
@issue_count = Issue.count '/issues.xml',
@attributes = {:project_id => 1, :subject => 'API test', :tracker_id => 2, :status_id => 3} {:issue => {:project_id => 1, :subject => 'API test', :tracker_id => 2, :status_id => 3}},
post '/issues.xml', {:issue => @attributes}, :authorization => credentials('jsmith') {:success_code => :created})
end
should_respond_with :created
should_respond_with_content_type 'application/xml'
should "create an issue with the attributes" do should "create an issue with the attributes" do
assert_equal Issue.count, @issue_count + 1 assert_difference('Issue.count') do
post '/issues.xml', {:issue => {:project_id => 1, :subject => 'API test', :tracker_id => 2, :status_id => 3}}, :authorization => credentials('jsmith')
issue = Issue.first(:order => 'id DESC')
@attributes.each do |attribute, value|
assert_equal value, issue.send(attribute)
end end
issue = Issue.first(:order => 'id DESC')
assert_equal 1, issue.project_id
assert_equal 2, issue.tracker_id
assert_equal 3, issue.status_id
assert_equal 'API test', issue.subject
end end
end end
context "POST /issues.xml with failure" do context "POST /issues.xml with failure" do
setup do should_allow_api_authentication(:post,
@attributes = {:project_id => 1} '/issues.xml',
post '/issues.xml', {:issue => @attributes}, :authorization => credentials('jsmith') {:issue => {:project_id => 1}},
end {:success_code => :unprocessable_entity})
should_respond_with :unprocessable_entity
should_respond_with_content_type 'application/xml'
should "have an errors tag" do should "have an errors tag" do
assert_no_difference('Issue.count') do
post '/issues.xml', {:issue => {:project_id => 1}}, :authorization => credentials('jsmith')
end
assert_tag :errors, :child => {:tag => 'error', :content => "Subject can't be blank"} assert_tag :errors, :child => {:tag => 'error', :content => "Subject can't be blank"}
end end
end end
context "POST /issues.json" do context "POST /issues.json" do
setup do should_allow_api_authentication(:post,
@issue_count = Issue.count '/issues.json',
@attributes = {:project_id => 1, :subject => 'API test', :tracker_id => 2, :status_id => 3} {:issue => {:project_id => 1, :subject => 'API test', :tracker_id => 2, :status_id => 3}},
post '/issues.json', {:issue => @attributes}, :authorization => credentials('jsmith') {:success_code => :created})
end
should_respond_with :created
should_respond_with_content_type 'application/json'
should "create an issue with the attributes" do should "create an issue with the attributes" do
assert_equal Issue.count, @issue_count + 1 assert_difference('Issue.count') do
post '/issues.json', {:issue => {:project_id => 1, :subject => 'API test', :tracker_id => 2, :status_id => 3}}, :authorization => credentials('jsmith')
issue = Issue.first(:order => 'id DESC')
@attributes.each do |attribute, value|
assert_equal value, issue.send(attribute)
end end
issue = Issue.first(:order => 'id DESC')
assert_equal 1, issue.project_id
assert_equal 2, issue.tracker_id
assert_equal 3, issue.status_id
assert_equal 'API test', issue.subject
end end
end end
context "POST /issues.json with failure" do context "POST /issues.json with failure" do
setup do should_allow_api_authentication(:post,
@attributes = {:project_id => 1} '/issues.json',
post '/issues.json', {:issue => @attributes}, :authorization => credentials('jsmith') {:issue => {:project_id => 1}},
end {:success_code => :unprocessable_entity})
should_respond_with :unprocessable_entity
should_respond_with_content_type 'application/json'
should "have an errors element" do should "have an errors element" do
assert_no_difference('Issue.count') do
post '/issues.json', {:issue => {:project_id => 1}}, :authorization => credentials('jsmith')
end
json = ActiveSupport::JSON.decode(response.body) json = ActiveSupport::JSON.decode(response.body)
assert_equal "can't be blank", json.first['subject'] assert_equal "can't be blank", json.first['subject']
end end
......
test/test_helper.rb
View file @ 4b1dd334
...@@ -195,10 +195,13 @@ class ActiveSupport::TestCase ...@@ -195,10 +195,13 @@ class ActiveSupport::TestCase
# @param [Symbol] http_method the HTTP method for request (:get, :post, :put, :delete) # @param [Symbol] http_method the HTTP method for request (:get, :post, :put, :delete)
# @param [String] url the request url # @param [String] url the request url
# @param [optional, Hash] parameters additional request parameters # @param [optional, Hash] parameters additional request parameters
def self.should_allow_api_authentication(http_method, url, parameters={}) # @param [optional, Hash] options additional options
should_allow_http_basic_auth_with_username_and_password(http_method, url, parameters) # @option options [Symbol] :success_code Successful response code (:success)
should_allow_http_basic_auth_with_key(http_method, url, parameters) # @option options [Symbol] :failure_code Failure response code (:unauthorized)
should_allow_key_based_auth(http_method, url, parameters) def self.should_allow_api_authentication(http_method, url, parameters={}, options={})
should_allow_http_basic_auth_with_username_and_password(http_method, url, parameters, options)
should_allow_http_basic_auth_with_key(http_method, url, parameters, options)
should_allow_key_based_auth(http_method, url, parameters, options)
end end
# Test that a request allows the username and password for HTTP BASIC # Test that a request allows the username and password for HTTP BASIC
...@@ -206,7 +209,13 @@ class ActiveSupport::TestCase ...@@ -206,7 +209,13 @@ class ActiveSupport::TestCase
# @param [Symbol] http_method the HTTP method for request (:get, :post, :put, :delete) # @param [Symbol] http_method the HTTP method for request (:get, :post, :put, :delete)
# @param [String] url the request url # @param [String] url the request url
# @param [optional, Hash] parameters additional request parameters # @param [optional, Hash] parameters additional request parameters
def self.should_allow_http_basic_auth_with_username_and_password(http_method, url, parameters={}) # @param [optional, Hash] options additional options
# @option options [Symbol] :success_code Successful response code (:success)
# @option options [Symbol] :failure_code Failure response code (:unauthorized)
def self.should_allow_http_basic_auth_with_username_and_password(http_method, url, parameters={}, options={})
success_code = options[:success_code] || :success
failure_code = options[:failure_code] || :unauthorized
context "should allow http basic auth using a username and password for #{http_method} #{url}" do context "should allow http basic auth using a username and password for #{http_method} #{url}" do
context "with a valid HTTP authentication" do context "with a valid HTTP authentication" do
setup do setup do
...@@ -215,7 +224,7 @@ class ActiveSupport::TestCase ...@@ -215,7 +224,7 @@ class ActiveSupport::TestCase
send(http_method, url, parameters, {:authorization => @authorization}) send(http_method, url, parameters, {:authorization => @authorization})
end end
should_respond_with :success should_respond_with success_code
should_respond_with_content_type_based_on_url(url) should_respond_with_content_type_based_on_url(url)
should "login as the user" do should "login as the user" do
assert_equal @user, User.current assert_equal @user, User.current
...@@ -229,7 +238,7 @@ class ActiveSupport::TestCase ...@@ -229,7 +238,7 @@ class ActiveSupport::TestCase
send(http_method, url, parameters, {:authorization => @authorization}) send(http_method, url, parameters, {:authorization => @authorization})
end end
should_respond_with :unauthorized should_respond_with failure_code
should_respond_with_content_type_based_on_url(url) should_respond_with_content_type_based_on_url(url)
should "not login as the user" do should "not login as the user" do
assert_equal User.anonymous, User.current assert_equal User.anonymous, User.current
...@@ -241,7 +250,7 @@ class ActiveSupport::TestCase ...@@ -241,7 +250,7 @@ class ActiveSupport::TestCase
send(http_method, url, parameters, {:authorization => ''}) send(http_method, url, parameters, {:authorization => ''})
end end
should_respond_with :unauthorized should_respond_with failure_code
should_respond_with_content_type_based_on_url(url) should_respond_with_content_type_based_on_url(url)
should "include_www_authenticate_header" do should "include_www_authenticate_header" do
assert @controller.response.headers.has_key?('WWW-Authenticate') assert @controller.response.headers.has_key?('WWW-Authenticate')
...@@ -256,7 +265,13 @@ class ActiveSupport::TestCase ...@@ -256,7 +265,13 @@ class ActiveSupport::TestCase
# @param [Symbol] http_method the HTTP method for request (:get, :post, :put, :delete) # @param [Symbol] http_method the HTTP method for request (:get, :post, :put, :delete)
# @param [String] url the request url # @param [String] url the request url
# @param [optional, Hash] parameters additional request parameters # @param [optional, Hash] parameters additional request parameters
def self.should_allow_http_basic_auth_with_key(http_method, url, parameters={}) # @param [optional, Hash] options additional options
# @option options [Symbol] :success_code Successful response code (:success)
# @option options [Symbol] :failure_code Failure response code (:unauthorized)
def self.should_allow_http_basic_auth_with_key(http_method, url, parameters={}, options={})
success_code = options[:success_code] || :success
failure_code = options[:failure_code] || :unauthorized
context "should allow http basic auth with a key for #{http_method} #{url}" do context "should allow http basic auth with a key for #{http_method} #{url}" do
context "with a valid HTTP authentication using the API token" do context "with a valid HTTP authentication using the API token" do
setup do setup do
...@@ -266,7 +281,7 @@ class ActiveSupport::TestCase ...@@ -266,7 +281,7 @@ class ActiveSupport::TestCase
send(http_method, url, parameters, {:authorization => @authorization}) send(http_method, url, parameters, {:authorization => @authorization})
end end
should_respond_with :success should_respond_with success_code
should_respond_with_content_type_based_on_url(url) should_respond_with_content_type_based_on_url(url)
should_be_a_valid_response_string_based_on_url(url) should_be_a_valid_response_string_based_on_url(url)
should "login as the user" do should "login as the user" do
...@@ -282,7 +297,7 @@ class ActiveSupport::TestCase ...@@ -282,7 +297,7 @@ class ActiveSupport::TestCase
send(http_method, url, parameters, {:authorization => @authorization}) send(http_method, url, parameters, {:authorization => @authorization})
end end
should_respond_with :unauthorized should_respond_with failure_code
should_respond_with_content_type_based_on_url(url) should_respond_with_content_type_based_on_url(url)
should "not login as the user" do should "not login as the user" do
assert_equal User.anonymous, User.current assert_equal User.anonymous, User.current
...@@ -296,7 +311,13 @@ class ActiveSupport::TestCase ...@@ -296,7 +311,13 @@ class ActiveSupport::TestCase
# @param [Symbol] http_method the HTTP method for request (:get, :post, :put, :delete) # @param [Symbol] http_method the HTTP method for request (:get, :post, :put, :delete)
# @param [String] url the request url, without the key=ZXY parameter # @param [String] url the request url, without the key=ZXY parameter
# @param [optional, Hash] parameters additional request parameters # @param [optional, Hash] parameters additional request parameters
def self.should_allow_key_based_auth(http_method, url, parameters={}) # @param [optional, Hash] options additional options
# @option options [Symbol] :success_code Successful response code (:success)
# @option options [Symbol] :failure_code Failure response code (:unauthorized)
def self.should_allow_key_based_auth(http_method, url, parameters={}, options={})
success_code = options[:success_code] || :success
failure_code = options[:failure_code] || :unauthorized
context "should allow key based auth using key=X for #{http_method} #{url}" do context "should allow key based auth using key=X for #{http_method} #{url}" do
context "with a valid api token" do context "with a valid api token" do
setup do setup do
...@@ -311,7 +332,7 @@ class ActiveSupport::TestCase ...@@ -311,7 +332,7 @@ class ActiveSupport::TestCase
send(http_method, request_url, parameters) send(http_method, request_url, parameters)
end end
should_respond_with :success should_respond_with success_code
should_respond_with_content_type_based_on_url(url) should_respond_with_content_type_based_on_url(url)
should_be_a_valid_response_string_based_on_url(url) should_be_a_valid_response_string_based_on_url(url)
should "login as the user" do should "login as the user" do
...@@ -323,10 +344,16 @@ class ActiveSupport::TestCase ...@@ -323,10 +344,16 @@ class ActiveSupport::TestCase
setup do setup do
@user = User.generate_with_protected! @user = User.generate_with_protected!
@token = Token.generate!(:user => @user, :action => 'feeds') @token = Token.generate!(:user => @user, :action => 'feeds')
send(http_method, url + "?key=#{@token.value}") # Simple url parse to add on ?key= or &key=
request_url = if url.match(/\?/)
url + "&key=#{@token.value}"
else
url + "?key=#{@token.value}"
end
send(http_method, request_url, parameters)
end end
should_respond_with :unauthorized should_respond_with failure_code
should_respond_with_content_type_based_on_url(url) should_respond_with_content_type_based_on_url(url)
should "not login as the user" do should "not login as the user" do
assert_equal User.anonymous, User.current assert_equal User.anonymous, User.current
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment