2013-05-14 08:33:31 -04:00
|
|
|
module API
|
2012-10-22 14:59:46 -04:00
|
|
|
# MergeRequest API
|
2012-10-21 07:00:27 -04:00
|
|
|
class MergeRequests < Grape::API
|
|
|
|
before { authenticate! }
|
|
|
|
|
2013-09-21 17:46:36 -04:00
|
|
|
resource :projects do
|
2013-02-05 12:36:36 -05:00
|
|
|
helpers do
|
2013-03-05 17:43:05 -05:00
|
|
|
def handle_merge_request_errors!(errors)
|
|
|
|
if errors[:project_access].any?
|
|
|
|
error!(errors[:project_access], 422)
|
2013-03-07 08:51:56 -05:00
|
|
|
elsif errors[:branch_conflict].any?
|
|
|
|
error!(errors[:branch_conflict], 422)
|
2013-02-05 12:36:36 -05:00
|
|
|
end
|
2013-03-05 17:43:05 -05:00
|
|
|
not_found!
|
2013-02-05 12:36:36 -05:00
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2012-10-22 15:53:06 -04:00
|
|
|
# List merge requests
|
2012-11-29 15:10:07 -05:00
|
|
|
#
|
2012-10-22 15:53:06 -04:00
|
|
|
# Parameters:
|
2012-12-21 12:47:04 -05:00
|
|
|
# id (required) - The ID of a project
|
2012-10-22 15:53:06 -04:00
|
|
|
#
|
|
|
|
# Example:
|
2012-10-25 06:13:01 -04:00
|
|
|
# GET /projects/:id/merge_requests
|
2012-10-22 15:53:06 -04:00
|
|
|
#
|
2012-10-21 07:00:27 -04:00
|
|
|
get ":id/merge_requests" do
|
2012-10-21 09:13:39 -04:00
|
|
|
authorize! :read_merge_request, user_project
|
2012-11-29 15:10:07 -05:00
|
|
|
|
2012-10-22 15:53:06 -04:00
|
|
|
present paginate(user_project.merge_requests), with: Entities::MergeRequest
|
2012-10-21 07:00:27 -04:00
|
|
|
end
|
2012-11-29 15:10:07 -05:00
|
|
|
|
2012-10-22 15:53:06 -04:00
|
|
|
# Show MR
|
2012-11-29 15:10:07 -05:00
|
|
|
#
|
2012-10-22 15:53:06 -04:00
|
|
|
# Parameters:
|
2012-12-21 12:47:04 -05:00
|
|
|
# id (required) - The ID of a project
|
2012-10-22 15:53:06 -04:00
|
|
|
# merge_request_id (required) - The ID of MR
|
2012-11-29 15:10:07 -05:00
|
|
|
#
|
2012-10-22 15:53:06 -04:00
|
|
|
# Example:
|
2012-10-25 06:13:01 -04:00
|
|
|
# GET /projects/:id/merge_request/:merge_request_id
|
2012-10-22 15:53:06 -04:00
|
|
|
#
|
2012-10-21 07:00:27 -04:00
|
|
|
get ":id/merge_request/:merge_request_id" do
|
2012-10-21 09:13:39 -04:00
|
|
|
merge_request = user_project.merge_requests.find(params[:merge_request_id])
|
2012-11-29 15:10:07 -05:00
|
|
|
|
2012-10-21 09:13:39 -04:00
|
|
|
authorize! :read_merge_request, merge_request
|
2012-11-29 15:10:07 -05:00
|
|
|
|
2012-10-21 09:13:39 -04:00
|
|
|
present merge_request, with: Entities::MergeRequest
|
2012-10-21 07:00:27 -04:00
|
|
|
end
|
|
|
|
|
2012-10-22 15:53:06 -04:00
|
|
|
# Create MR
|
|
|
|
#
|
|
|
|
# Parameters:
|
|
|
|
#
|
2013-04-25 10:15:33 -04:00
|
|
|
# id (required) - The ID of a project - this will be the source of the merge request
|
2012-10-22 15:53:06 -04:00
|
|
|
# source_branch (required) - The source branch
|
|
|
|
# target_branch (required) - The target branch
|
2013-04-25 10:15:33 -04:00
|
|
|
# target_project - The target project of the merge request defaults to the :id of the project
|
2012-10-22 15:53:06 -04:00
|
|
|
# assignee_id - Assignee user ID
|
|
|
|
# title (required) - Title of MR
|
2014-03-04 02:08:39 -05:00
|
|
|
# description - Description of MR
|
2012-11-29 15:10:07 -05:00
|
|
|
#
|
2012-10-22 15:53:06 -04:00
|
|
|
# Example:
|
2012-10-25 06:13:01 -04:00
|
|
|
# POST /projects/:id/merge_requests
|
2012-10-22 15:53:06 -04:00
|
|
|
#
|
2012-10-21 07:00:27 -04:00
|
|
|
post ":id/merge_requests" do
|
2014-04-02 14:51:53 -04:00
|
|
|
authorize! :write_merge_request, user_project
|
|
|
|
required_attributes! [:source_branch, :target_branch, :title]
|
|
|
|
attrs = attributes_for_keys [:source_branch, :target_branch, :assignee_id, :title, :target_project_id, :description]
|
|
|
|
merge_request = ::MergeRequests::CreateService.new(user_project, current_user, attrs).execute
|
2013-07-17 11:23:36 -04:00
|
|
|
|
2014-04-02 14:51:53 -04:00
|
|
|
if merge_request.valid?
|
|
|
|
present merge_request, with: Entities::MergeRequest
|
|
|
|
else
|
|
|
|
handle_merge_request_errors! merge_request.errors
|
2012-10-21 07:41:06 -04:00
|
|
|
end
|
2012-10-21 07:00:27 -04:00
|
|
|
end
|
|
|
|
|
2012-10-22 15:53:06 -04:00
|
|
|
# Update MR
|
|
|
|
#
|
|
|
|
# Parameters:
|
2012-12-21 12:47:04 -05:00
|
|
|
# id (required) - The ID of a project
|
2012-10-22 15:53:06 -04:00
|
|
|
# merge_request_id (required) - ID of MR
|
|
|
|
# source_branch - The source branch
|
|
|
|
# target_branch - The target branch
|
|
|
|
# assignee_id - Assignee user ID
|
|
|
|
# title - Title of MR
|
2013-02-18 04:07:49 -05:00
|
|
|
# state_event - Status of MR. (close|reopen|merge)
|
2014-03-04 02:08:39 -05:00
|
|
|
# description - Description of MR
|
2012-10-22 15:53:06 -04:00
|
|
|
# Example:
|
2012-10-25 06:13:01 -04:00
|
|
|
# PUT /projects/:id/merge_request/:merge_request_id
|
2012-10-22 15:53:06 -04:00
|
|
|
#
|
2012-10-21 07:00:27 -04:00
|
|
|
put ":id/merge_request/:merge_request_id" do
|
2014-04-02 14:51:53 -04:00
|
|
|
attrs = attributes_for_keys [:source_branch, :target_branch, :assignee_id, :title, :state_event, :description]
|
|
|
|
merge_request = user_project.merge_requests.find(params[:merge_request_id])
|
|
|
|
authorize! :modify_merge_request, merge_request
|
|
|
|
merge_request = ::MergeRequests::UpdateService.new(user_project, current_user, attrs).execute(merge_request)
|
2012-11-29 15:10:07 -05:00
|
|
|
|
2014-04-02 14:51:53 -04:00
|
|
|
if merge_request.valid?
|
|
|
|
present merge_request, with: Entities::MergeRequest
|
|
|
|
else
|
|
|
|
handle_merge_request_errors! merge_request.errors
|
2012-10-21 07:59:50 -04:00
|
|
|
end
|
2012-10-21 07:00:27 -04:00
|
|
|
end
|
|
|
|
|
2014-03-19 14:07:51 -04:00
|
|
|
# Get a merge request's comments
|
|
|
|
#
|
|
|
|
# Parameters:
|
|
|
|
# id (required) - The ID of a project
|
|
|
|
# merge_request_id (required) - ID of MR
|
|
|
|
# Examples:
|
|
|
|
# GET /projects/:id/merge_request/:merge_request_id/comments
|
|
|
|
#
|
|
|
|
get ":id/merge_request/:merge_request_id/comments" do
|
|
|
|
merge_request = user_project.merge_requests.find(params[:merge_request_id])
|
|
|
|
|
|
|
|
authorize! :read_merge_request, merge_request
|
|
|
|
|
|
|
|
present paginate(merge_request.notes), with: Entities::MRNote
|
|
|
|
end
|
|
|
|
|
2012-10-22 15:53:06 -04:00
|
|
|
# Post comment to merge request
|
|
|
|
#
|
|
|
|
# Parameters:
|
2012-12-21 12:47:04 -05:00
|
|
|
# id (required) - The ID of a project
|
2012-10-22 15:53:06 -04:00
|
|
|
# merge_request_id (required) - ID of MR
|
|
|
|
# note (required) - Text of comment
|
2012-11-29 15:10:07 -05:00
|
|
|
# Examples:
|
2012-10-25 06:13:01 -04:00
|
|
|
# POST /projects/:id/merge_request/:merge_request_id/comments
|
2012-10-22 15:53:06 -04:00
|
|
|
#
|
2012-10-21 12:48:56 -04:00
|
|
|
post ":id/merge_request/:merge_request_id/comments" do
|
2013-10-04 15:11:50 -04:00
|
|
|
set_current_user_for_thread do
|
|
|
|
required_attributes! [:note]
|
2013-02-27 09:07:42 -05:00
|
|
|
|
2013-10-04 15:11:50 -04:00
|
|
|
merge_request = user_project.merge_requests.find(params[:merge_request_id])
|
|
|
|
note = merge_request.notes.new(note: params[:note], project_id: user_project.id)
|
|
|
|
note.author = current_user
|
2012-10-25 06:38:55 -04:00
|
|
|
|
2013-10-04 15:11:50 -04:00
|
|
|
if note.save
|
|
|
|
present note, with: Entities::MRNote
|
|
|
|
else
|
|
|
|
not_found!
|
|
|
|
end
|
2012-10-21 12:48:56 -04:00
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2012-10-21 07:00:27 -04:00
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|