jro_apps/redmine Commit - r3199:68a4cd38f543

XML REST API for Projects (#296)....

Jean-Philippe Lang -

r3199:68a4cd38f543

parent child

Context file:

r3199:68a4cd38f543

Collapse all files

app/views/projects/index.xml.builder created 644 +18 0

@@ -0,0 +1,18
	1	xml.instruct!
	2	xml.projects :type => 'array' do
	3	@projects.each do \|project\|
	4	xml.project :id => project.id do
	5	xml.name project.name
	6	xml.identifier project.identifier
	7	xml.description project.description
	8	xml.parent(:id => project.parent_id, :name => project.parent.name) unless project.parent.nil?
	9	xml.custom_fields do
	10	project.custom_field_values.each do \|custom_value\|
	11	xml.custom_field custom_value.value, :id => custom_value.custom_field_id, :name => custom_value.custom_field.name
	12	end
	13	end unless project.custom_field_values.empty?
	14	xml.created_on project.created_on
	15	xml.updated_on project.updated_on
	16	end
	17	end
	18	end

app/views/projects/show.xml.builder created 644 +16 0

@@ -0,0 +1,16
	1	xml.instruct!
	2	xml.project :id => @project.id do
	3	xml.name @project.name
	4	xml.identifier @project.identifier
	5	xml.description @project.description
	6	xml.homepage @project.homepage
	7
	8	xml.custom_fields do
	9	@project.custom_field_values.each do \|custom_value\|
	10	xml.custom_field custom_value.value, :id => custom_value.custom_field_id, :name => custom_value.custom_field.name
	11	end
	12	end unless @project.custom_field_values.empty?
	13
	14	xml.created_on @project.created_on
	15	xml.updated_on @project.updated_on
	16	end

test/integration/projects_api_test.rb created 644 +134 0

@@ -0,0 +1,134
	1	# Redmine - project management software
	2	# Copyright (C) 2006-2010 Jean-Philippe Lang
	3	#
	4	# This program is free software; you can redistribute it and/or
	5	# modify it under the terms of the GNU General Public License
	6	# as published by the Free Software Foundation; either version 2
	7	# of the License, or (at your option) any later version.
	8	#
	9	# This program is distributed in the hope that it will be useful,
	10	# but WITHOUT ANY WARRANTY; without even the implied warranty of
	11	# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	12	# GNU General Public License for more details.
	13	#
	14	# You should have received a copy of the GNU General Public License
	15	# along with this program; if not, write to the Free Software
	16	# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
	17
	18	require "#{File.dirname(__FILE__)}/../test_helper"
	19
	20	class ProjectsApiTest < ActionController::IntegrationTest
	21	fixtures :projects, :versions, :users, :roles, :members, :member_roles, :issues, :journals, :journal_details,
	22	:trackers, :projects_trackers, :issue_statuses, :enabled_modules, :enumerations, :boards, :messages,
	23	:attachments, :custom_fields, :custom_values, :time_entries
	24
	25	def setup
	26	Setting.rest_api_enabled = '1'
	27	end
	28
	29	def test_index_routing
	30	assert_routing(
	31	{:method => :get, :path => '/projects.xml'},
	32	:controller => 'projects', :action => 'index', :format => 'xml'
	33	)
	34	end
	35
	36	def test_index
	37	get '/projects.xml'
	38	assert_response :success
	39	assert_equal 'application/xml', @response.content_type
	40	end
	41
	42	def test_show_routing
	43	assert_routing(
	44	{:method => :get, :path => '/projects/1.xml'},
	45	:controller => 'projects', :action => 'show', :id => '1', :format => 'xml'
	46	)
	47	end
	48
	49	def test_show
	50	get '/projects/1.xml'
	51	assert_response :success
	52	assert_equal 'application/xml', @response.content_type
	53	end
	54
	55	def test_create_routing
	56	assert_routing(
	57	{:method => :post, :path => '/projects.xml'},
	58	:controller => 'projects', :action => 'add', :format => 'xml'
	59	)
	60	end
	61
	62	def test_create
	63	attributes = {:name => 'API test', :identifier => 'api-test'}
	64	assert_difference 'Project.count' do
	65	post '/projects.xml', {:project => attributes}, :authorization => credentials('admin')
	66	end
	67	assert_response :created
	68	assert_equal 'application/xml', @response.content_type
	69	project = Project.first(:order => 'id DESC')
	70	attributes.each do \|attribute, value\|
	71	assert_equal value, project.send(attribute)
	72	end
	73	end
	74
	75	def test_create_failure
	76	attributes = {:name => 'API test'}
	77	assert_no_difference 'Project.count' do
	78	post '/projects.xml', {:project => attributes}, :authorization => credentials('admin')
	79	end
	80	assert_response :unprocessable_entity
	81	assert_equal 'application/xml', @response.content_type
	82	assert_tag :errors, :child => {:tag => 'error', :content => "Identifier can't be blank"}
	83	end
	84
	85	def test_update_routing
	86	assert_routing(
	87	{:method => :put, :path => '/projects/1.xml'},
	88	:controller => 'projects', :action => 'edit', :id => '1', :format => 'xml'
	89	)
	90	end
	91
	92	def test_update
	93	attributes = {:name => 'API update'}
	94	assert_no_difference 'Project.count' do
	95	put '/projects/1.xml', {:project => attributes}, :authorization => credentials('jsmith')
	96	end
	97	assert_response :ok
	98	assert_equal 'application/xml', @response.content_type
	99	project = Project.find(1)
	100	attributes.each do \|attribute, value\|
	101	assert_equal value, project.send(attribute)
	102	end
	103	end
	104
	105	def test_update_failure
	106	attributes = {:name => ''}
	107	assert_no_difference 'Project.count' do
	108	put '/projects/1.xml', {:project => attributes}, :authorization => credentials('jsmith')
	109	end
	110	assert_response :unprocessable_entity
	111	assert_equal 'application/xml', @response.content_type
	112	assert_tag :errors, :child => {:tag => 'error', :content => "Name can't be blank"}
	113	end
	114
	115	def test_destroy_routing
	116	assert_routing(
	117	{:method => :delete, :path => '/projects/1.xml'},
	118	:controller => 'projects', :action => 'destroy', :id => '1', :format => 'xml'
	119	)
	120	end
	121
	122	def test_destroy
	123	assert_difference 'Project.count', -1 do
	124	delete '/projects/2.xml', {}, :authorization => credentials('admin')
	125	end
	126	assert_response :ok
	127	assert_equal 'application/xml', @response.content_type
	128	assert_nil Project.find_by_id(2)
	129	end
	130
	131	def credentials(user, password=nil)
	132	ActionController::HttpAuthentication::Basic.encode_credentials(user, password \|\| user)
	133	end
	134	end

app/controllers/application_controller.rb +1 0

               include Redmine::I18n
               layout 'base'
+              exempt_from_layout 'builder'
               # Remove broken cookie after upgrade from 0.8.x (#4292)
               # See https://rails.lighthouseapp.com/projects/8994/tickets/3360

app/controllers/projects_controller.rb +46 -10

                   format.html {
                     @projects = Project.visible.find(:all, :order => 'lft')
                   }
+                  format.xml  {
+                    @projects = Project.visible.find(:all, :order => 'lft')
+                  }
                   format.atom {
                     projects = Project.visible.find(:all, :order => 'created_on DESC',
                                                           :limit => Setting.feeds_limit.to_i)
                       m = Member.new(:user => User.current, :roles => [r])
                       @project.members << m
                     end
-                    flash[:notice] = l(:notice_successful_create)
+                    respond_to do |format|
-                    redirect_to :controller => 'projects', :action => 'settings', :id => @project
+                      format.html {
+                        flash[:notice] = l(:notice_successful_create)
+                        redirect_to :controller => 'projects', :action => 'settings', :id => @project
+                      }
+                      format.xml  { head :created, :location => url_for(:controller => 'projects', :action => 'show', :id => @project.id) }
+                    end
+                  else
+                    respond_to do |format|
+                      format.html
+                      format.xml  { render :xml => @project.errors, :status => :unprocessable_entity }
+                    end
                   end
                 end
               end
                                                :conditions => cond).to_f
                 end
                 @key = User.current.rss_key
+                respond_to do |format|
+                  format.html
+                  format.xml
+                end
               end
               def settings
               # Edit @project
               def edit
-                if request.post?
+                if request.get?
+                else
                   @project.attributes = params[:project]
                   if validate_parent_id && @project.save
                     @project.set_allowed_parent!(params[:project]['parent_id']) if params[:project].has_key?('parent_id')
-                    flash[:notice] = l(:notice_successful_update)
+                    respond_to do |format|
-                    redirect_to :action => 'settings', :id => @project
+                      format.html {
+                        flash[:notice] = l(:notice_successful_update)
+                        redirect_to :action => 'settings', :id => @project
+                      }
+                      format.xml  { head :ok }
+                    end
                   else
-                    settings
+                    respond_to do |format|
-                    render :action => 'settings'
+                      format.html {
+                        settings
+                        render :action => 'settings'
+                      }
+                      format.xml  { render :xml => @project.errors, :status => :unprocessable_entity }
+                    end
                   end
                 end
               end
               # Delete @project
               def destroy
                 @project_to_destroy = @project
-                if request.post? and params[:confirm]
+                if request.get?
-                  @project_to_destroy.destroy
+                  # display confirmation view
-                  redirect_to :controller => 'admin', :action => 'projects'
+                else
+                  if params[:format] == 'xml' || params[:confirm]
+                    @project_to_destroy.destroy
+                    respond_to do |format|
+                      format.html { redirect_to :controller => 'admin', :action => 'projects' }
+                      format.xml  { head :ok }
+                    end
+                  end
                 end
                 # hide project in layout
                 @project = nil

config/routes.rb +7 0

                   project_views.connect 'projects.:format', :action => 'index'
                   project_views.connect 'projects/new', :action => 'add'
                   project_views.connect 'projects/:id', :action => 'show'
+                  project_views.connect 'projects/:id.:format', :action => 'show'
                   project_views.connect 'projects/:id/:action', :action => /roadmap|destroy|settings/
                   project_views.connect 'projects/:id/files', :action => 'list_files'
                   project_views.connect 'projects/:id/files/new', :action => 'add_file'
                 projects.with_options :conditions => {:method => :post} do |project_actions|
                   project_actions.connect 'projects/new', :action => 'add'
                   project_actions.connect 'projects', :action => 'add'
+                  project_actions.connect 'projects.:format', :action => 'add', :format => /xml/
                   project_actions.connect 'projects/:id/:action', :action => /destroy|archive|unarchive/
                   project_actions.connect 'projects/:id/files/new', :action => 'add_file'
                   project_actions.connect 'projects/:id/versions/new', :action => 'add_version'
                   project_actions.connect 'projects/:id/activities/save', :action => 'save_activities'
                 end
+                projects.with_options :conditions => {:method => :put} do |project_actions|
+                  project_actions.conditions 'projects/:id.:format', :action => 'edit', :format => /xml/
+                end
                 projects.with_options :conditions => {:method => :delete} do |project_actions|
+                  project_actions.conditions 'projects/:id.:format', :action => 'destroy', :format => /xml/
                   project_actions.conditions 'projects/:id/reset_activities', :action => 'reset_activities'
                 end
               end

test/fixtures/custom_fields.yml +1 -1

               - Alpha
               - Planning
               id: 3
-              is_required: true
+              is_required: false
               field_format: list
               default_value: ""
               editable: true

General Comments 0

Write
Preview

You need to be logged in to leave comments. Login now

No TODOs yet

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages