kolan
/
Redmine
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

REST API for retrieving wiki pages (#7082). 

git-svn-id: svn+ssh://rubyforge.org/var/svn/redmine/trunk@10716 e93f8b46-1217-0410-a6f0-8f06a7374b81
This commit is contained in:
Jean-Philippe Lang 2012-10-25 19:44:04 +00:00
parent b2e035fa96
commit 9e31308720
8 changed files with 161 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
app/controllers/wiki_controller.rb
View File

@ -36,6 +36,7 @@ class WikiController < ApplicationController
before_filter :find_wiki, :authorize
before_filter :find_existing_or_new_page, :only => [:show, :edit, :update]
before_filter :find_existing_page, :only => [:rename, :protect, :history, :diff, :annotate, :add_attachment, :destroy, :destroy_version]
accept_api_auth :index, :show
helper :attachments
include AttachmentsHelper
@ -45,7 +46,13 @@ class WikiController < ApplicationController
# List of pages, sorted alphabetically and by parent (hierarchy)
def index
load_pages_for_index
@pages_by_parent_id = @pages.group_by(&:parent_id)
respond_to do |format|
format.html {
@pages_by_parent_id = @pages.group_by(&:parent_id)
}
format.api
end
end
# List of page, by last update
@ -57,7 +64,7 @@ class WikiController < ApplicationController
# display a page (in editing mode if it doesn't exist)
def show
if @page.new_record?
if User.current.allowed_to?(:edit_wiki_pages, @project) && editable?
if User.current.allowed_to?(:edit_wiki_pages, @project) && editable? && !api_request?
edit
render :action => 'edit'
else
@ -66,8 +73,7 @@ class WikiController < ApplicationController
return
end
if params[:version] && !User.current.allowed_to?(:view_wiki_edits, @project)
# Redirects user to the current version if he's not allowed to view previous versions
redirect_to :version => nil
deny_access
return
end
@content = @page.content_for_version(params[:version])
@ -89,7 +95,10 @@ class WikiController < ApplicationController
@content.current_version? &&
Redmine::WikiFormatting.supports_section_edit?
render :action => 'show'
respond_to do |format|
format.html
format.api
end
end
# edit an existing page or a new one
@ -321,6 +330,6 @@ private
end
def load_pages_for_index
@pages = @wiki.pages.with_updated_on.all(:order => 'title', :include => {:wiki => :project})
@pages = @wiki.pages.with_updated_on.order("#{WikiPage.table_name}.title").includes(:wiki => :project).includes(:parent).all
end
end

2
app/models/wiki_page.rb
View File

@ -50,7 +50,7 @@ class WikiPage < ActiveRecord::Base
# eager load information about last updates, without loading text
scope :with_updated_on, {
:select => "#{WikiPage.table_name}.*, #{WikiContent.table_name}.updated_on",
:select => "#{WikiPage.table_name}.*, #{WikiContent.table_name}.updated_on, #{WikiContent.table_name}.version",
:joins => "LEFT JOIN #{WikiContent.table_name} ON #{WikiContent.table_name}.page_id = #{WikiPage.table_name}.id"
}

13
app/views/wiki/index.api.rsb Normal file
View File

@ -0,0 +1,13 @@
api.array :wiki_pages do
@pages.each do |page|
api.wiki_page do
api.title page.title
if page.parent
api.parent :title => page.parent.title
end
api.version page.version
api.created_on page.created_on
api.updated_on page.updated_on
end
end
end

11
app/views/wiki/show.api.rsb Normal file
View File

@ -0,0 +1,11 @@
api.wiki_page do
api.title @page.title
if @page.parent
api.parent :title => @page.parent.title
end
api.text @content.text
api.version @content.version
api.author(:id => @content.author_id, :name => @content.author.name)
api.created_on @page.created_on
api.updated_on @content.updated_on
end

7
test/functional/wiki_controller_test.rb
View File

@ -75,6 +75,13 @@ class WikiControllerTest < ActionController::TestCase
assert_select 'a[href=?]', '/projects/ecookbook/wiki/CookBook_documentation', :text => /Current version/
end
def test_show_old_version_without_permission_should_be_denied
Role.anonymous.remove_permission! :view_wiki_edits
get :show, :project_id => 'ecookbook', :id => 'CookBook_documentation', :version => '2'
assert_redirected_to '/login?back_url=http%3A%2F%2Ftest.host%2Fprojects%2Fecookbook%2Fwiki%2FCookBook_documentation%2F2'
end
def test_show_first_version
get :show, :project_id => 'ecookbook', :id => 'CookBook_documentation', :version => '1'
assert_response :success

85
test/integration/api_test/wiki_pages_test.rb Normal file
View File

@ -0,0 +1,85 @@
# Redmine - project management software
# Copyright (C) 2006-2012 Jean-Philippe Lang
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
require File.expand_path('../../../test_helper', __FILE__)
class ApiTest::WikiPagesTest < ActionController::IntegrationTest
fixtures :projects, :users, :roles, :members, :member_roles,
:enabled_modules, :wikis, :wiki_pages, :wiki_contents,
:wiki_content_versions, :attachments
def setup
Setting.rest_api_enabled = '1'
end
test "GET /projects/:project_id/wiki/index.xml should return wiki pages" do
get '/projects/ecookbook/wiki/index.xml'
assert_response :success
assert_equal 'application/xml', response.content_type
assert_select 'wiki_pages[type=array]' do
assert_select 'wiki_page', :count => Wiki.find(1).pages.count
assert_select 'wiki_page' do
assert_select 'title', :text => 'CookBook_documentation'
assert_select 'version', :text => '3'
assert_select 'created_on'
assert_select 'updated_on'
end
end
end
test "GET /projects/:project_id/wiki/:title.xml should return wiki page" do
get '/projects/ecookbook/wiki/CookBook_documentation.xml'
assert_response :success
assert_equal 'application/xml', response.content_type
assert_select 'wiki_page' do
assert_select 'title', :text => 'CookBook_documentation'
assert_select 'version', :text => '3'
assert_select 'text'
assert_select 'author'
assert_select 'created_on'
assert_select 'updated_on'
end
end
test "GET /projects/:project_id/wiki/:title.xml with unknown title and edit permission should respond with 404" do
get '/projects/ecookbook/wiki/Invalid_Page.xml', {}, credentials('jsmith')
assert_response 404
assert_equal 'application/xml', response.content_type
end
test "GET /projects/:project_id/wiki/:title/:version.xml should return wiki page version" do
get '/projects/ecookbook/wiki/CookBook_documentation/2.xml'
assert_response :success
assert_equal 'application/xml', response.content_type
assert_select 'wiki_page' do
assert_select 'title', :text => 'CookBook_documentation'
assert_select 'version', :text => '2'
assert_select 'text'
assert_select 'author'
assert_select 'created_on'
assert_select 'updated_on'
end
end
test "GET /projects/:project_id/wiki/:title/:version.xml without permission should be denied" do
Role.anonymous.remove_permission! :view_wiki_edits
get '/projects/ecookbook/wiki/CookBook_documentation/2.xml'
assert_response 401
assert_equal 'application/xml', response.content_type
end
end

28
test/integration/routing/wiki_test.rb
View File

@ -33,6 +33,16 @@ class RoutingWikiTest < ActionController::IntegrationTest
{ :controller => 'wiki', :action => 'show', :project_id => '567',
:id => 'lalala', :format => 'pdf' }
)
assert_routing(
{ :method => 'get', :path => "/projects/567/wiki/lalala.xml" },
{ :controller => 'wiki', :action => 'show', :project_id => '567',
:id => 'lalala', :format => 'xml' }
)
assert_routing(
{ :method => 'get', :path => "/projects/567/wiki/lalala.json" },
{ :controller => 'wiki', :action => 'show', :project_id => '567',
:id => 'lalala', :format => 'json' }
)
assert_routing(
{ :method => 'get', :path => "/projects/1/wiki/CookBook_documentation/diff" },
{ :controller => 'wiki', :action => 'diff', :project_id => '1',
@ -43,6 +53,16 @@ class RoutingWikiTest < ActionController::IntegrationTest
{ :controller => 'wiki', :action => 'show', :project_id => '1',
:id => 'CookBook_documentation', :version => '2' }
)
assert_routing(
{ :method => 'get', :path => "/projects/1/wiki/CookBook_documentation/2.xml" },
{ :controller => 'wiki', :action => 'show', :project_id => '1',
:id => 'CookBook_documentation', :version => '2', :format => 'xml' }
)
assert_routing(
{ :method => 'get', :path => "/projects/1/wiki/CookBook_documentation/2.json" },
{ :controller => 'wiki', :action => 'show', :project_id => '1',
:id => 'CookBook_documentation', :version => '2', :format => 'json' }
)
assert_routing(
{ :method => 'get', :path => "/projects/1/wiki/CookBook_documentation/2/diff" },
{ :controller => 'wiki', :action => 'diff', :project_id => '1',
@ -72,6 +92,14 @@ class RoutingWikiTest < ActionController::IntegrationTest
{ :method => 'get', :path => "/projects/567/wiki/index" },
{ :controller => 'wiki', :action => 'index', :project_id => '567' }
)
assert_routing(
{ :method => 'get', :path => "/projects/567/wiki/index.xml" },
{ :controller => 'wiki', :action => 'index', :project_id => '567', :format => 'xml' }
)
assert_routing(
{ :method => 'get', :path => "/projects/567/wiki/index.json" },
{ :controller => 'wiki', :action => 'index', :project_id => '567', :format => 'json' }
)
end
def test_wiki_resources

1
test/unit/wiki_page_test.rb
View File

@ -130,6 +130,7 @@ class WikiPageTest < ActiveSupport::TestCase
assert_not_nil page.read_attribute(:updated_on)
assert_equal Time.gm(2007, 3, 6, 23, 10, 51), page.content.updated_on
assert_equal page.content.updated_on, page.updated_on
assert_not_nil page.read_attribute(:version)
end
def test_descendants