debian-mirror-gitlab/lib/api/branches.rb

161 lines
5.8 KiB
Ruby
Raw Normal View History

2014-09-02 18:07:02 +05:30
require 'mime/types'
module API
# Projects API
class Branches < Grape::API
before { authenticate! }
before { authorize! :download_code, user_project }
resource :projects do
# Get a project repository branches
#
# Parameters:
# id (required) - The ID of a project
# Example Request:
# GET /projects/:id/repository/branches
get ":id/repository/branches" do
2015-04-26 12:48:37 +05:30
branches = user_project.repository.branches.sort_by(&:name)
2016-08-24 12:49:21 +05:30
present branches, with: Entities::RepoBranch, project: user_project
2014-09-02 18:07:02 +05:30
end
# Get a single branch
#
# Parameters:
# id (required) - The ID of a project
# branch (required) - The name of the branch
# Example Request:
# GET /projects/:id/repository/branches/:branch
2016-08-24 12:49:21 +05:30
get ':id/repository/branches/:branch', requirements: { branch: /.+/ } do
2015-04-26 12:48:37 +05:30
@branch = user_project.repository.branches.find { |item| item.name == params[:branch] }
not_found!("Branch") unless @branch
2016-08-24 12:49:21 +05:30
present @branch, with: Entities::RepoBranch, project: user_project
2014-09-02 18:07:02 +05:30
end
# Protect a single branch
#
2016-09-13 17:45:13 +05:30
# Note: The internal data model moved from `developers_can_{merge,push}` to `allowed_to_{merge,push}`
# in `gitlab-org/gitlab-ce!5081`. The API interface has not been changed (to maintain compatibility),
# but it works with the changed data model to infer `developers_can_merge` and `developers_can_push`.
#
2014-09-02 18:07:02 +05:30
# Parameters:
# id (required) - The ID of a project
# branch (required) - The name of the branch
2016-08-24 12:49:21 +05:30
# developers_can_push (optional) - Flag if developers can push to that branch
# developers_can_merge (optional) - Flag if developers can merge to that branch
2014-09-02 18:07:02 +05:30
# Example Request:
# PUT /projects/:id/repository/branches/:branch/protect
put ':id/repository/branches/:branch/protect',
2016-08-24 12:49:21 +05:30
requirements: { branch: /.+/ } do
2014-09-02 18:07:02 +05:30
authorize_admin_project
@branch = user_project.repository.find_branch(params[:branch])
2016-08-24 12:49:21 +05:30
not_found!('Branch') unless @branch
2014-09-02 18:07:02 +05:30
protected_branch = user_project.protected_branches.find_by(name: @branch.name)
2016-09-13 17:45:13 +05:30
2016-08-24 12:49:21 +05:30
developers_can_merge = to_boolean(params[:developers_can_merge])
2016-09-13 17:45:13 +05:30
developers_can_push = to_boolean(params[:developers_can_push])
protected_branch_params = {
name: @branch.name
}
# If `developers_can_merge` is switched off, _all_ `DEVELOPER`
# merge_access_levels need to be deleted.
if developers_can_merge == false
protected_branch.merge_access_levels.where(access_level: Gitlab::Access::DEVELOPER).destroy_all
end
# If `developers_can_push` is switched off, _all_ `DEVELOPER`
# push_access_levels need to be deleted.
if developers_can_push == false
protected_branch.push_access_levels.where(access_level: Gitlab::Access::DEVELOPER).destroy_all
end
protected_branch_params.merge!(
merge_access_levels_attributes: [{
access_level: developers_can_merge ? Gitlab::Access::DEVELOPER : Gitlab::Access::MASTER
}],
push_access_levels_attributes: [{
access_level: developers_can_push ? Gitlab::Access::DEVELOPER : Gitlab::Access::MASTER
}]
)
2014-09-02 18:07:02 +05:30
2016-08-24 12:49:21 +05:30
if protected_branch
2016-09-13 17:45:13 +05:30
service = ProtectedBranches::UpdateService.new(user_project, current_user, protected_branch_params)
service.execute(protected_branch)
2016-08-24 12:49:21 +05:30
else
2016-09-13 17:45:13 +05:30
service = ProtectedBranches::CreateService.new(user_project, current_user, protected_branch_params)
service.execute
2016-08-24 12:49:21 +05:30
end
present @branch, with: Entities::RepoBranch, project: user_project
2014-09-02 18:07:02 +05:30
end
# Unprotect a single branch
#
# Parameters:
# id (required) - The ID of a project
# branch (required) - The name of the branch
# Example Request:
# PUT /projects/:id/repository/branches/:branch/unprotect
put ':id/repository/branches/:branch/unprotect',
2016-08-24 12:49:21 +05:30
requirements: { branch: /.+/ } do
2014-09-02 18:07:02 +05:30
authorize_admin_project
@branch = user_project.repository.find_branch(params[:branch])
2016-06-02 11:05:42 +05:30
not_found!("Branch") unless @branch
2014-09-02 18:07:02 +05:30
protected_branch = user_project.protected_branches.find_by(name: @branch.name)
protected_branch.destroy if protected_branch
2016-08-24 12:49:21 +05:30
present @branch, with: Entities::RepoBranch, project: user_project
2014-09-02 18:07:02 +05:30
end
# Create branch
#
# Parameters:
# id (required) - The ID of a project
# branch_name (required) - The name of the branch
# ref (required) - Create branch from commit sha or existing branch
# Example Request:
# POST /projects/:id/repository/branches
post ":id/repository/branches" do
authorize_push_project
2015-04-26 12:48:37 +05:30
result = CreateBranchService.new(user_project, current_user).
execute(params[:branch_name], params[:ref])
2014-09-02 18:07:02 +05:30
2015-04-26 12:48:37 +05:30
if result[:status] == :success
present result[:branch],
2016-08-24 12:49:21 +05:30
with: Entities::RepoBranch,
2015-04-26 12:48:37 +05:30
project: user_project
else
render_api_error!(result[:message], 400)
end
2014-09-02 18:07:02 +05:30
end
# Delete branch
#
# Parameters:
# id (required) - The ID of a project
# branch (required) - The name of the branch
# Example Request:
# DELETE /projects/:id/repository/branches/:branch
2015-04-26 12:48:37 +05:30
delete ":id/repository/branches/:branch",
2016-08-24 12:49:21 +05:30
requirements: { branch: /.+/ } do
2014-09-02 18:07:02 +05:30
authorize_push_project
2015-04-26 12:48:37 +05:30
result = DeleteBranchService.new(user_project, current_user).
execute(params[:branch])
2014-09-02 18:07:02 +05:30
2015-04-26 12:48:37 +05:30
if result[:status] == :success
{
branch_name: params[:branch]
}
2014-09-02 18:07:02 +05:30
else
2015-04-26 12:48:37 +05:30
render_api_error!(result[:message], result[:return_code])
2014-09-02 18:07:02 +05:30
end
end
end
end
end