2013-05-14 12:33:31 +00:00
|
|
|
module API
|
2012-10-22 18:59:46 +00:00
|
|
|
# MergeRequest API
|
2012-10-21 11:00:27 +00:00
|
|
|
class MergeRequests < Grape::API
|
|
|
|
before { authenticate! }
|
2013-06-11 15:15:18 +00:00
|
|
|
before { Thread.current[:current_user] = current_user }
|
2012-10-21 11:00:27 +00:00
|
|
|
|
2013-09-05 11:46:34 +00:00
|
|
|
resource :projects, requirements: { id: /[a-zA-Z.0-9_\-]+\/[a-zA-Z.0-9_\-]+/ } do
|
2013-02-05 17:36:36 +00:00
|
|
|
helpers do
|
2013-03-05 22:43:05 +00:00
|
|
|
def handle_merge_request_errors!(errors)
|
|
|
|
if errors[:project_access].any?
|
|
|
|
error!(errors[:project_access], 422)
|
2013-03-07 13:51:56 +00:00
|
|
|
elsif errors[:branch_conflict].any?
|
|
|
|
error!(errors[:branch_conflict], 422)
|
2013-02-05 17:36:36 +00:00
|
|
|
end
|
2013-03-05 22:43:05 +00:00
|
|
|
not_found!
|
2013-02-05 17:36:36 +00:00
|
|
|
end
|
2013-07-17 15:23:36 +00:00
|
|
|
|
|
|
|
def not_fork?(target_project_id, user_project)
|
|
|
|
target_project_id.nil? || target_project_id == user_project.id.to_s
|
|
|
|
end
|
|
|
|
|
|
|
|
def target_matches_fork(target_project_id,user_project)
|
|
|
|
user_project.forked? && user_project.forked_from_project.id.to_s == target_project_id
|
|
|
|
end
|
2013-02-05 17:36:36 +00:00
|
|
|
end
|
|
|
|
|
2012-10-22 19:53:06 +00:00
|
|
|
# List merge requests
|
2012-11-29 20:10:07 +00:00
|
|
|
#
|
2012-10-22 19:53:06 +00:00
|
|
|
# Parameters:
|
2012-12-21 17:47:04 +00:00
|
|
|
# id (required) - The ID of a project
|
2012-10-22 19:53:06 +00:00
|
|
|
#
|
|
|
|
# Example:
|
2012-10-25 10:13:01 +00:00
|
|
|
# GET /projects/:id/merge_requests
|
2012-10-22 19:53:06 +00:00
|
|
|
#
|
2012-10-21 11:00:27 +00:00
|
|
|
get ":id/merge_requests" do
|
2012-10-21 13:13:39 +00:00
|
|
|
authorize! :read_merge_request, user_project
|
2012-11-29 20:10:07 +00:00
|
|
|
|
2012-10-22 19:53:06 +00:00
|
|
|
present paginate(user_project.merge_requests), with: Entities::MergeRequest
|
2012-10-21 11:00:27 +00:00
|
|
|
end
|
2012-11-29 20:10:07 +00:00
|
|
|
|
2012-10-22 19:53:06 +00:00
|
|
|
# Show MR
|
2012-11-29 20:10:07 +00:00
|
|
|
#
|
2012-10-22 19:53:06 +00:00
|
|
|
# Parameters:
|
2012-12-21 17:47:04 +00:00
|
|
|
# id (required) - The ID of a project
|
2012-10-22 19:53:06 +00:00
|
|
|
# merge_request_id (required) - The ID of MR
|
2012-11-29 20:10:07 +00:00
|
|
|
#
|
2012-10-22 19:53:06 +00:00
|
|
|
# Example:
|
2012-10-25 10:13:01 +00:00
|
|
|
# GET /projects/:id/merge_request/:merge_request_id
|
2012-10-22 19:53:06 +00:00
|
|
|
#
|
2012-10-21 11:00:27 +00:00
|
|
|
get ":id/merge_request/:merge_request_id" do
|
2012-10-21 13:13:39 +00:00
|
|
|
merge_request = user_project.merge_requests.find(params[:merge_request_id])
|
2012-11-29 20:10:07 +00:00
|
|
|
|
2012-10-21 13:13:39 +00:00
|
|
|
authorize! :read_merge_request, merge_request
|
2012-11-29 20:10:07 +00:00
|
|
|
|
2012-10-21 13:13:39 +00:00
|
|
|
present merge_request, with: Entities::MergeRequest
|
2012-10-21 11:00:27 +00:00
|
|
|
end
|
|
|
|
|
2012-10-22 19:53:06 +00:00
|
|
|
# Create MR
|
|
|
|
#
|
|
|
|
# Parameters:
|
|
|
|
#
|
2013-04-25 14:15:33 +00:00
|
|
|
# id (required) - The ID of a project - this will be the source of the merge request
|
2012-10-22 19:53:06 +00:00
|
|
|
# source_branch (required) - The source branch
|
|
|
|
# target_branch (required) - The target branch
|
2013-04-25 14:15:33 +00:00
|
|
|
# target_project - The target project of the merge request defaults to the :id of the project
|
2012-10-22 19:53:06 +00:00
|
|
|
# assignee_id - Assignee user ID
|
|
|
|
# title (required) - Title of MR
|
2012-11-29 20:10:07 +00:00
|
|
|
#
|
2012-10-22 19:53:06 +00:00
|
|
|
# Example:
|
2012-10-25 10:13:01 +00:00
|
|
|
# POST /projects/:id/merge_requests
|
2012-10-22 19:53:06 +00:00
|
|
|
#
|
2012-10-21 11:00:27 +00:00
|
|
|
post ":id/merge_requests" do
|
2012-10-25 10:38:55 +00:00
|
|
|
authorize! :write_merge_request, user_project
|
2013-02-27 16:50:30 +00:00
|
|
|
required_attributes! [:source_branch, :target_branch, :title]
|
2013-04-25 14:15:33 +00:00
|
|
|
attrs = attributes_for_keys [:source_branch, :target_branch, :assignee_id, :title, :target_project_id]
|
2012-10-21 12:33:02 +00:00
|
|
|
merge_request = user_project.merge_requests.new(attrs)
|
2012-10-21 11:41:06 +00:00
|
|
|
merge_request.author = current_user
|
2013-04-25 14:15:33 +00:00
|
|
|
merge_request.source_project = user_project
|
2013-06-03 20:20:50 +00:00
|
|
|
target_project_id = attrs[:target_project_id]
|
2013-07-17 15:23:36 +00:00
|
|
|
if not_fork?(target_project_id, user_project)
|
2013-04-25 14:15:33 +00:00
|
|
|
merge_request.target_project = user_project
|
2013-07-17 15:23:36 +00:00
|
|
|
else
|
|
|
|
if target_matches_fork(target_project_id,user_project)
|
|
|
|
merge_request.target_project = Project.find_by_id(attrs[:target_project_id])
|
|
|
|
else
|
|
|
|
render_api_error!('(Bad Request) Specified target project that is not the source project, or the source fork of the project.', 400)
|
|
|
|
end
|
2013-04-25 14:15:33 +00:00
|
|
|
end
|
2013-07-17 15:23:36 +00:00
|
|
|
|
2012-10-21 11:41:06 +00:00
|
|
|
if merge_request.save
|
|
|
|
merge_request.reload_code
|
|
|
|
present merge_request, with: Entities::MergeRequest
|
|
|
|
else
|
2013-03-05 22:43:05 +00:00
|
|
|
handle_merge_request_errors! merge_request.errors
|
2012-10-21 11:41:06 +00:00
|
|
|
end
|
2012-10-21 11:00:27 +00:00
|
|
|
end
|
|
|
|
|
2012-10-22 19:53:06 +00:00
|
|
|
# Update MR
|
|
|
|
#
|
|
|
|
# Parameters:
|
2012-12-21 17:47:04 +00:00
|
|
|
# id (required) - The ID of a project
|
2012-10-22 19:53:06 +00: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 09:07:49 +00:00
|
|
|
# state_event - Status of MR. (close|reopen|merge)
|
2012-10-22 19:53:06 +00:00
|
|
|
# Example:
|
2012-10-25 10:13:01 +00:00
|
|
|
# PUT /projects/:id/merge_request/:merge_request_id
|
2012-10-22 19:53:06 +00:00
|
|
|
#
|
2012-10-21 11:00:27 +00:00
|
|
|
put ":id/merge_request/:merge_request_id" do
|
2013-02-18 09:07:49 +00:00
|
|
|
attrs = attributes_for_keys [:source_branch, :target_branch, :assignee_id, :title, :state_event]
|
2012-10-21 12:33:02 +00:00
|
|
|
merge_request = user_project.merge_requests.find(params[:merge_request_id])
|
2012-11-29 20:10:07 +00:00
|
|
|
|
2012-10-21 13:13:39 +00:00
|
|
|
authorize! :modify_merge_request, merge_request
|
2012-11-29 20:10:07 +00:00
|
|
|
|
2012-10-21 11:59:50 +00:00
|
|
|
if merge_request.update_attributes attrs
|
|
|
|
merge_request.reload_code
|
|
|
|
merge_request.mark_as_unchecked
|
|
|
|
present merge_request, with: Entities::MergeRequest
|
|
|
|
else
|
2013-03-05 22:43:05 +00:00
|
|
|
handle_merge_request_errors! merge_request.errors
|
2012-10-21 11:59:50 +00:00
|
|
|
end
|
2012-10-21 11:00:27 +00:00
|
|
|
end
|
|
|
|
|
2012-10-22 19:53:06 +00:00
|
|
|
# Post comment to merge request
|
|
|
|
#
|
|
|
|
# Parameters:
|
2012-12-21 17:47:04 +00:00
|
|
|
# id (required) - The ID of a project
|
2012-10-22 19:53:06 +00:00
|
|
|
# merge_request_id (required) - ID of MR
|
|
|
|
# note (required) - Text of comment
|
2012-11-29 20:10:07 +00:00
|
|
|
# Examples:
|
2012-10-25 10:13:01 +00:00
|
|
|
# POST /projects/:id/merge_request/:merge_request_id/comments
|
2012-10-22 19:53:06 +00:00
|
|
|
#
|
2012-10-21 16:48:56 +00:00
|
|
|
post ":id/merge_request/:merge_request_id/comments" do
|
2013-02-27 16:50:30 +00:00
|
|
|
required_attributes! [:note]
|
2013-02-27 14:07:42 +00:00
|
|
|
|
2012-10-21 16:48:56 +00: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 10:38:55 +00:00
|
|
|
|
2012-10-21 16:48:56 +00:00
|
|
|
if note.save
|
2012-11-29 20:10:07 +00:00
|
|
|
present note, with: Entities::MRNote
|
2012-10-21 16:48:56 +00:00
|
|
|
else
|
|
|
|
not_found!
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2012-10-21 11:00:27 +00:00
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|