summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEric Davis <edavis@littlestreamsoftware.com>2009-12-23 06:27:33 +0000
committerEric Davis <edavis@littlestreamsoftware.com>2009-12-23 06:27:33 +0000
commitbaa1ad42560fb9bfd6f99cd3374c4b5c1e7ae668 (patch)
tree62d7d38c3590ccd75e7be6080a1791f2cc518a4e
parentaa9951b38b27c7465a313fc72b73b819b292e9b2 (diff)
downloadredmine-baa1ad42560fb9bfd6f99cd3374c4b5c1e7ae668.tar.gz
redmine-baa1ad42560fb9bfd6f99cd3374c4b5c1e7ae668.zip
Allow authenticating with an API token via XML or JSON. (#3920)
git-svn-id: svn+ssh://rubyforge.org/var/svn/redmine/trunk@3218 e93f8b46-1217-0410-a6f0-8f06a7374b81
-rw-r--r--app/controllers/application_controller.rb8
-rw-r--r--app/controllers/news_controller.rb2
-rw-r--r--test/integration/api_token_login_test.rb73
3 files changed, 82 insertions, 1 deletions
diff --git a/app/controllers/application_controller.rb b/app/controllers/application_controller.rb
index 75f7121f2..40adff4bc 100644
--- a/app/controllers/application_controller.rb
+++ b/app/controllers/application_controller.rb
@@ -70,6 +70,8 @@ class ApplicationController < ActionController::Base
elsif params[:format] == 'atom' && params[:key] && accept_key_auth_actions.include?(params[:action])
# RSS key authentication does not start a session
User.find_by_rss_key(params[:key])
+ elsif ['xml', 'json'].include?(params[:format]) && params[:key] && accept_key_auth_actions.include?(params[:action])
+ User.find_by_api_key(params[:key])
end
end
@@ -114,7 +116,11 @@ class ApplicationController < ActionController::Base
else
url = url_for(:controller => params[:controller], :action => params[:action], :id => params[:id], :project_id => params[:project_id])
end
- redirect_to :controller => "account", :action => "login", :back_url => url
+ respond_to do |format|
+ format.html { redirect_to :controller => "account", :action => "login", :back_url => url }
+ format.xml { head :unauthorized }
+ format.json { head :unauthorized }
+ end
return false
end
true
diff --git a/app/controllers/news_controller.rb b/app/controllers/news_controller.rb
index 394b5182e..53e0addf2 100644
--- a/app/controllers/news_controller.rb
+++ b/app/controllers/news_controller.rb
@@ -31,6 +31,8 @@ class NewsController < ApplicationController
:order => "#{News.table_name}.created_on DESC"
respond_to do |format|
format.html { render :layout => false if request.xhr? }
+ format.xml { render :xml => @newss.to_xml }
+ format.json { render :json => @newss.to_json }
format.atom { render_feed(@newss, :title => (@project ? @project.name : Setting.app_title) + ": #{l(:label_news_plural)}") }
end
end
diff --git a/test/integration/api_token_login_test.rb b/test/integration/api_token_login_test.rb
new file mode 100644
index 000000000..4077403e6
--- /dev/null
+++ b/test/integration/api_token_login_test.rb
@@ -0,0 +1,73 @@
+require "#{File.dirname(__FILE__)}/../test_helper"
+
+class ApiTokenLoginTest < ActionController::IntegrationTest
+ fixtures :all
+
+ # Using the NewsController because it's a simple API.
+ context "get /news.xml" do
+
+ context "in :xml format" do
+ context "with a valid api token" do
+ setup do
+ @user = User.generate_with_protected!
+ @token = Token.generate!(:user => @user, :action => 'api')
+ get "/news.xml?key=#{@token.value}"
+ end
+
+ should_respond_with :success
+ should_respond_with_content_type :xml
+ should "login as the user" do
+ assert_equal @user, User.current
+ end
+ end
+
+ context "with an invalid api token (on a protected site)" do
+ setup do
+ Setting.login_required = '1'
+ @user = User.generate_with_protected!
+ @token = Token.generate!(:user => @user, :action => 'feeds')
+ get "/news.xml?key=#{@token.value}"
+ end
+
+ should_respond_with :unauthorized
+ should_respond_with_content_type :xml
+ should "not login as the user" do
+ assert_equal User.anonymous, User.current
+ end
+ end
+ end
+
+ context "in :json format" do
+ context "with a valid api token" do
+ setup do
+ @user = User.generate_with_protected!
+ @token = Token.generate!(:user => @user, :action => 'api')
+ get "/news.json?key=#{@token.value}"
+ end
+
+ should_respond_with :success
+ should_respond_with_content_type :json
+ should "login as the user" do
+ assert_equal @user, User.current
+ end
+ end
+
+ context "with an invalid api token (on a protected site)" do
+ setup do
+ Setting.login_required = '1'
+ @user = User.generate_with_protected!
+ @token = Token.generate!(:user => @user, :action => 'feeds')
+ get "/news.json?key=#{@token.value}"
+ end
+
+ should_respond_with :unauthorized
+ should_respond_with_content_type :json
+ should "not login as the user" do
+ assert_equal User.anonymous, User.current
+ end
+ end
+ end
+
+ end
+
+end