jro_apps/redmine Commit - r6056:21b37187445f

Adds REST API for issue relations (#7366)....

Jean-Philippe Lang -

r6056:21b37187445f

parent child

Context file:

r6056:21b37187445f

Collapse all files

app/views/issue_relations/show.api.rsb created 644 +7 0

@@ -0,0 +1,7
	1	api.relation do
	2	api.id @relation.id
	3	api.issue_id @relation.issue_from_id
	4	api.issue_to_id @relation.issue_to_id
	5	api.relation_type @relation.relation_type_for(@issue)
	6	api.delay @relation.delay
	7	end

test/integration/api_test/issue_relations_test.rb created 644 +83 0

@@ -0,0 +1,83
	1	# Redmine - project management software
	2	# Copyright (C) 2006-2011 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.expand_path('../../../test_helper', __FILE__)
	19
	20	class ApiTest::IssueRelationsTest < ActionController::IntegrationTest
	21	fixtures :all
	22
	23	def setup
	24	Setting.rest_api_enabled = '1'
	25	end
	26
	27	context "/issues/:issue_id/relations" do
	28	context "POST" do
	29	should "create a relation" do
	30	assert_difference('IssueRelation.count') do
	31	post '/issues/2/relations.xml', {:relation => {:issue_to_id => 7, :relation_type => 'relates'}}, :authorization => credentials('jsmith')
	32	end
	33
	34	relation = IssueRelation.first(:order => 'id DESC')
	35	assert_equal 2, relation.issue_from_id
	36	assert_equal 7, relation.issue_to_id
	37	assert_equal 'relates', relation.relation_type
	38
	39	assert_response :created
	40	assert_equal 'application/xml', @response.content_type
	41	assert_tag 'relation', :child => {:tag => 'id', :content => relation.id.to_s}
	42	end
	43
	44	context "with failure" do
	45	should "return the errors" do
	46	assert_no_difference('IssueRelation.count') do
	47	post '/issues/2/relations.xml', {:relation => {:issue_to_id => 7, :relation_type => 'foo'}}, :authorization => credentials('jsmith')
	48	end
	49
	50	assert_response :unprocessable_entity
	51	assert_tag :errors, :child => {:tag => 'error', :content => 'relation_type is not included in the list'}
	52	end
	53	end
	54	end
	55	end
	56
	57	context "/issues/:issue_id/relations/:id" do
	58	context "GET" do
	59	should "return the relation" do
	60	get '/issues/3/relations/2.xml', {}, :authorization => credentials('jsmith')
	61
	62	assert_response :success
	63	assert_equal 'application/xml', @response.content_type
	64	assert_tag 'relation', :child => {:tag => 'id', :content => '2'}
	65	end
	66	end
	67
	68	context "DELETE" do
	69	should "delete the relation" do
	70	assert_difference('IssueRelation.count', -1) do
	71	delete '/issues/3/relations/2.xml', {}, :authorization => credentials('jsmith')
	72	end
	73
	74	assert_response :ok
	75	assert_nil IssueRelation.find_by_id(2)
	76	end
	77	end
	78	end
	79
	80	def credentials(user, password=nil)
	81	ActionController::HttpAuthentication::Basic.encode_credentials(user, password \|\| user)
	82	end
	83	end

app/controllers/issue_relations_controller.rb +33 -10

-            # redMine - project management software
+            # Redmine - project management software
-            # Copyright (C) 2006-2007  Jean-Philippe Lang
+            # Copyright (C) 2006-2011  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
             class IssueRelationsController < ApplicationController
               before_filter :find_issue, :find_project_from_association, :authorize
+              accept_key_auth :show, :create, :destroy
-              def new
+              def show
+                @relation = @issue.find_relation(params[:id])
+                respond_to do |format|
+                  format.html { render :nothing => true }
+                  format.api
+                end
+              rescue ActiveRecord::RecordNotFound
+                render_404
+              end
+              verify :method => :post, :only => :create, :render => {:nothing => true, :status => :method_not_allowed }
+              def create
                 @relation = IssueRelation.new(params[:relation])
                 @relation.issue_from = @issue
                 if params[:relation] && m = params[:relation][:issue_to_id].to_s.match(/^#?(\d+)$/)
                   @relation.issue_to = Issue.visible.find_by_id(m[1].to_i)
                 end
-                @relation.save if request.post?
+                saved = @relation.save
                 respond_to do |format|
                   format.html { redirect_to :controller => 'issues', :action => 'show', :id => @issue }
                   format.js do
                       end
                     end
                   end
+                  format.api {
+                    if saved
+                      render :action => 'show', :status => :created, :location => issue_relation_url(@issue, @relation)
+                    else
+                      render_validation_errors(@relation)
+                    end
+                  }
                 end
               end
+              verify :method => :delete, :only => :destroy, :render => {:nothing => true, :status => :method_not_allowed }
               def destroy
-                relation = IssueRelation.find(params[:id])
+                relation = @issue.find_relation(params[:id])
-                if request.post? && @issue.relations.include?(relation)
+                relation.destroy
-                  relation.destroy
-                  @issue.reload
-                end
                 respond_to do |format|
                   format.html { redirect_to :controller => 'issues', :action => 'show', :id => @issue }
                   format.js {
-                    @relations = @issue.relations.select {|r| r.other_issue(@issue) && r.other_issue(@issue).visible? }
+                    @relations = @issue.reload.relations.select {|r| r.other_issue(@issue) && r.other_issue(@issue).visible? }
                     render(:update) {|page| page.replace_html "relations", :partial => 'issues/relations'}
                   }
+                  format.api { head :ok }
                 end
+              rescue ActiveRecord::RecordNotFound
+                render_404
               end
             private

app/models/issue.rb +5 0

               def relations
                 (relations_from + relations_to).sort
               end
+              # Finds an issue relation given its id.
+              def find_relation(relation_id)
+                IssueRelation.find(relation_id, :conditions => ["issue_to_id = ? OR issue_from_id = ?", id, id])
+              end
               def all_dependent_issues(except=[])
                 except << self

app/views/issues/_relations.rhtml +2 -2

             <td class="start_date"><%= format_date(relation.other_issue(@issue).start_date) %></td>
             <td class="due_date"><%= format_date(relation.other_issue(@issue).due_date) %></td>
             <td class="buttons"><%= link_to_remote(image_tag('link_break.png'), { :url => {:controller => 'issue_relations', :action => 'destroy', :issue_id => @issue, :id => relation},
-                                                              :method => :post
+                                                              :method => :delete
                                                             }, :title => l(:label_relation_delete)) if authorize_for('issue_relations', 'destroy') %></td>
             </tr>
             <% end %>
             <% end %>
             <% remote_form_for(:relation, @relation,
-                             :url => {:controller => 'issue_relations', :action => 'new', :issue_id => @issue},
+                             :url => {:controller => 'issue_relations', :action => 'create', :issue_id => @issue},
                              :method => :post,
                              :complete => "Form.Element.focus('relation_issue_to_id');",
                              :html => {:id => 'new-relation-form', :style => (@relation ? '' : 'display: none;')}) do |f| %>

app/views/issues/show.api.rsb +1 -1

               api.array :relations do
                 @relations.each do |relation|
-                  api.relation(:id => relation.id, :issue_id => relation.other_issue(@issue).id, :relation_type => relation.relation_type_for(@issue), :delay => relation.delay)
+                  api.relation(:id => relation.id, :issue_id => relation.issue_from_id, :issue_to_id => relation.issue_to_id, :relation_type => relation.relation_type_for(@issue), :delay => relation.delay)
                 end
               end if include_in_api_response?('relations') && @relations.present?

config/routes.rb +1 -6

               map.resources :issues, :member => { :edit => :post }, :collection => {} do |issues|
                 issues.resources :time_entries, :controller => 'timelog'
+                issues.resources :relations, :controller => 'issue_relations', :only => [:show, :create, :destroy]
               end
               map.resources :issues, :path_prefix => '/projects/:project_id', :collection => { :create => :post } do |issues|
                 issues.resources :time_entries, :controller => 'timelog'
               end
-              map.with_options  :controller => 'issue_relations', :conditions => {:method => :post} do |relations|
-                relations.connect 'issues/:issue_id/relations/:id', :action => 'new'
-                relations.connect 'issues/:issue_id/relations/:id/destroy', :action => 'destroy'
-              end
               map.connect 'projects/:id/members/new', :controller => 'members', :action => 'new'
               map.with_options :controller => 'users' do |users|
               map.connect 'projects/:project_id/boards/:action/:id', :controller => 'boards'
               map.connect 'boards/:board_id/topics/:action/:id', :controller => 'messages'
               map.connect 'wiki/:id/:page/:action', :page => nil, :controller => 'wiki'
-              map.connect 'issues/:issue_id/relations/:action/:id', :controller => 'issue_relations'
               map.connect 'projects/:project_id/news/:action', :controller => 'news'
               map.connect 'projects/:project_id/timelog/:action/:id', :controller => 'timelog', :project_id => /.+/
               map.with_options :controller => 'repositories' do |omap|

lib/redmine.rb +1 -1

                                               :reports => [:issue_report, :issue_report_details]}
                 map.permission :add_issues, {:issues => [:new, :create, :update_form]}
                 map.permission :edit_issues, {:issues => [:edit, :update, :bulk_edit, :bulk_update, :update_form], :journals => [:new]}
-                map.permission :manage_issue_relations, {:issue_relations => [:new, :destroy]}
+                map.permission :manage_issue_relations, {:issue_relations => [:show, :create, :destroy]}
                 map.permission :manage_subtasks, {}
                 map.permission :set_issues_private, {}
                 map.permission :set_own_issues_private, {}, :require => :loggedin

test/functional/issue_relations_controller_test.rb +28 -11

+            # Redmine - project management software
+            # Copyright (C) 2006-2011  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__)
             require 'issue_relations_controller'
                 User.current = nil
               end
-              def test_new
+              def test_create
                 assert_difference 'IssueRelation.count' do
                   @request.session[:user_id] = 3
-                  post :new, :issue_id => 1,
+                  post :create, :issue_id => 1,
                              :relation => {:issue_to_id => '2', :relation_type => 'relates', :delay => ''}
                 end
               end
-              def test_new_xhr
+              def test_create_xhr
                 assert_difference 'IssueRelation.count' do
                   @request.session[:user_id] = 3
-                  xhr :post, :new,
+                  xhr :post, :create,
                     :issue_id => 3,
                     :relation => {:issue_to_id => '1', :relation_type => 'relates', :delay => ''}
                   assert_select_rjs 'relations' do
                 end
               end
-              def test_new_should_accept_id_with_hash
+              def test_create_should_accept_id_with_hash
                 assert_difference 'IssueRelation.count' do
                   @request.session[:user_id] = 3
-                  post :new, :issue_id => 1,
+                  post :create, :issue_id => 1,
                              :relation => {:issue_to_id => '#2', :relation_type => 'relates', :delay => ''}
                 end
               end
-              def test_new_should_not_break_with_non_numerical_id
+              def test_create_should_not_break_with_non_numerical_id
                 assert_no_difference 'IssueRelation.count' do
                   assert_nothing_raised do
                     @request.session[:user_id] = 3
-                    post :new, :issue_id => 1,
+                    post :create, :issue_id => 1,
                                :relation => {:issue_to_id => 'foo', :relation_type => 'relates', :delay => ''}
                   end
                 end
                 assert_no_difference 'IssueRelation.count' do
                   @request.session[:user_id] = 3
-                  post :new, :issue_id => 1,
+                  post :create, :issue_id => 1,
                              :relation => {:issue_to_id => '4', :relation_type => 'relates', :delay => ''}
                 end
               end
               def test_destroy
                 assert_difference 'IssueRelation.count', -1 do
                   @request.session[:user_id] = 3
-                  post :destroy, :id => '2', :issue_id => '3'
+                  delete :destroy, :id => '2', :issue_id => '3'
                 end
               end
                 assert_difference 'IssueRelation.count', -1 do
                   @request.session[:user_id] = 3
-                  xhr :post, :destroy, :id => '2', :issue_id => '3'
+                  xhr :delete, :destroy, :id => '2', :issue_id => '3'
                   assert_select_rjs 'relations' do
                     assert_select 'table', 1
                     assert_select 'tr', 1 # relation left

test/integration/routing_test.rb +11 -2

@@ -118,8 +118,17 class RoutingTest < ActionController::IntegrationTest
118	end	118	end
119		119
120	context "issue relations" do	120	context "issue relations" do
121	should_route :post, "/issues/1/relations", :controller => 'issue_relations', :action => '~~new~~', :issue_id => '1'	121	should_route :post, "/issues/1/relations", :controller => 'issue_relations', :action => 'create', :issue_id => '1'
122	should_route :post, "/issues/1/relations~~/23/destroy~~", :controller => 'issue_relations', :action => '~~destroy~~', :issue_id => '1', :id => '23'	122	should_route :post, "/issues/1/relations.xml", :controller => 'issue_relations', :action => 'create', :issue_id => '1', :format => 'xml'
		123	should_route :post, "/issues/1/relations.json", :controller => 'issue_relations', :action => 'create', :issue_id => '1', :format => 'json'
		124
		125	should_route :get, "/issues/1/relations/23", :controller => 'issue_relations', :action => 'show', :issue_id => '1', :id => '23'
		126	should_route :get, "/issues/1/relations/23.xml", :controller => 'issue_relations', :action => 'show', :issue_id => '1', :id => '23', :format => 'xml'
		127	should_route :get, "/issues/1/relations/23.json", :controller => 'issue_relations', :action => 'show', :issue_id => '1', :id => '23', :format => 'json'
		128
		129	should_route :delete, "/issues/1/relations/23", :controller => 'issue_relations', :action => 'destroy', :issue_id => '1', :id => '23'
		130	should_route :delete, "/issues/1/relations/23.xml", :controller => 'issue_relations', :action => 'destroy', :issue_id => '1', :id => '23', :format => 'xml'
		131	should_route :delete, "/issues/1/relations/23.json", :controller => 'issue_relations', :action => 'destroy', :issue_id => '1', :id => '23', :format => 'json'
123	end	132	end
124		133
125	context "issue reports" do	134	context "issue reports" do

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