gitlabhq/lib/api/merge_requests.rb

138 lines
4.3 KiB
Ruby
Raw Normal View History

2012-10-21 13:00:27 +02:00
module Gitlab
2012-10-22 20:59:46 +02:00
# MergeRequest API
2012-10-21 13:00:27 +02:00
class MergeRequests < Grape::API
before { authenticate! }
resource :projects do
helpers do
# If an error occurred this helper method provides an appropriate status code
#
# Parameters:
# merge_request_errors (required) - The errors collection of MR
#
def handle_merge_request_error(merge_request_errors)
if merge_request_errors[:target_branch].any?
error!(merge_request_errors[:target_branch], 400)
elsif merge_request_errors[:source_branch].any?
error!(merge_request_errors[:source_branch], 400)
elsif merge_request_errors[:base].any?
error!(merge_request_errors[:base], 422)
end
end
end
2012-10-22 21:53:06 +02:00
# List merge requests
#
2012-10-22 21:53:06 +02:00
# Parameters:
# id (required) - The ID of a project
2012-10-22 21:53:06 +02:00
#
# Example:
2012-10-25 12:13:01 +02:00
# GET /projects/:id/merge_requests
2012-10-22 21:53:06 +02:00
#
2012-10-21 13:00:27 +02:00
get ":id/merge_requests" do
2012-10-21 15:13:39 +02:00
authorize! :read_merge_request, user_project
2012-10-22 21:53:06 +02:00
present paginate(user_project.merge_requests), with: Entities::MergeRequest
2012-10-21 13:00:27 +02:00
end
2012-10-22 21:53:06 +02:00
# Show MR
#
2012-10-22 21:53:06 +02:00
# Parameters:
# id (required) - The ID of a project
2012-10-22 21:53:06 +02:00
# merge_request_id (required) - The ID of MR
#
2012-10-22 21:53:06 +02:00
# Example:
2012-10-25 12:13:01 +02:00
# GET /projects/:id/merge_request/:merge_request_id
2012-10-22 21:53:06 +02:00
#
2012-10-21 13:00:27 +02:00
get ":id/merge_request/:merge_request_id" do
2012-10-21 15:13:39 +02:00
merge_request = user_project.merge_requests.find(params[:merge_request_id])
2012-10-21 15:13:39 +02:00
authorize! :read_merge_request, merge_request
2012-10-21 15:13:39 +02:00
present merge_request, with: Entities::MergeRequest
2012-10-21 13:00:27 +02:00
end
2012-10-22 21:53:06 +02:00
# Create MR
#
# Parameters:
#
# id (required) - The ID of a project
2012-10-22 21:53:06 +02:00
# source_branch (required) - The source branch
# target_branch (required) - The target branch
# assignee_id - Assignee user ID
# title (required) - Title of MR
#
2012-10-22 21:53:06 +02:00
# Example:
2012-10-25 12:13:01 +02:00
# POST /projects/:id/merge_requests
2012-10-22 21:53:06 +02:00
#
2012-10-21 13:00:27 +02:00
post ":id/merge_requests" do
2012-10-25 12:38:55 +02:00
authorize! :write_merge_request, user_project
2012-10-21 13:41:06 +02:00
attrs = attributes_for_keys [:source_branch, :target_branch, :assignee_id, :title]
2012-10-21 14:33:02 +02:00
merge_request = user_project.merge_requests.new(attrs)
2012-10-21 13:41:06 +02:00
merge_request.author = current_user
2012-10-21 13:41:06 +02:00
if merge_request.save
merge_request.reload_code
present merge_request, with: Entities::MergeRequest
else
handle_merge_request_error(merge_request.errors)
2012-10-21 13:41:06 +02:00
not_found!
end
2012-10-21 13:00:27 +02:00
end
2012-10-22 21:53:06 +02:00
# Update MR
#
# Parameters:
# id (required) - The ID of a project
2012-10-22 21:53:06 +02: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
# closed - Status of MR. true - closed
# Example:
2012-10-25 12:13:01 +02:00
# PUT /projects/:id/merge_request/:merge_request_id
2012-10-22 21:53:06 +02:00
#
2012-10-21 13:00:27 +02:00
put ":id/merge_request/:merge_request_id" do
2012-10-21 13:59:50 +02:00
attrs = attributes_for_keys [:source_branch, :target_branch, :assignee_id, :title, :closed]
2012-10-21 14:33:02 +02:00
merge_request = user_project.merge_requests.find(params[:merge_request_id])
2012-10-21 15:13:39 +02:00
authorize! :modify_merge_request, merge_request
2012-10-21 13:59:50 +02:00
if merge_request.update_attributes attrs
merge_request.reload_code
merge_request.mark_as_unchecked
present merge_request, with: Entities::MergeRequest
else
handle_merge_request_error(merge_request.errors)
2012-10-21 13:59:50 +02:00
not_found!
end
2012-10-21 13:00:27 +02:00
end
2012-10-22 21:53:06 +02:00
# Post comment to merge request
#
# Parameters:
# id (required) - The ID of a project
2012-10-22 21:53:06 +02:00
# merge_request_id (required) - ID of MR
# note (required) - Text of comment
# Examples:
2012-10-25 12:13:01 +02:00
# POST /projects/:id/merge_request/:merge_request_id/comments
2012-10-22 21:53:06 +02:00
#
2012-10-21 18:48:56 +02:00
post ":id/merge_request/:merge_request_id/comments" do
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 12:38:55 +02:00
2012-10-21 18:48:56 +02:00
if note.save
present note, with: Entities::MRNote
2012-10-21 18:48:56 +02:00
else
not_found!
end
end
2012-10-21 13:00:27 +02:00
end
end
end