BigW Consortium Gitlab

branches.rb 4.99 KB
Newer Older
1 2 3 4 5 6 7 8
require 'mime/types'

module API
  # Projects API
  class Branches < Grape::API
    before { authenticate! }
    before { authorize! :download_code, user_project }

9 10 11
    params do
      requires :id, type: String, desc: 'The ID of a project'
    end
12
    resource :projects do
13 14 15
      desc 'Get a project repository branches' do
        success Entities::RepoBranch
      end
16
      get ":id/repository/branches" do
17
        branches = user_project.repository.branches.sort_by(&:name)
18 19

        present branches, with: Entities::RepoBranch, project: user_project
20 21
      end

22 23 24 25 26 27 28 29 30
      desc 'Get a single branch' do
        success Entities::RepoBranch
      end
      params do
        requires :branch, type: String, regexp: /.+/, desc: 'The name of the branch'
      end
      get ':id/repository/branches/:branch' do
        branch = user_project.repository.find_branch(params[:branch])
        not_found!("Branch") unless branch
31

32
        present branch, with: Entities::RepoBranch, project: user_project
33 34
      end

35 36 37
      # 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`.
38 39 40 41 42 43 44 45 46
      desc 'Protect a single branch' do
        success Entities::RepoBranch
      end
      params do
        requires :branch, type: String, regexp: /.+/, desc: 'The name of the branch'
        optional :developers_can_push, type: Boolean, desc: 'Flag if developers can push to that branch'
        optional :developers_can_merge, type: Boolean, desc: 'Flag if developers can merge to that branch'
      end
      put ':id/repository/branches/:branch/protect' do
47 48
        authorize_admin_project

49 50 51 52
        branch = user_project.repository.find_branch(params[:branch])
        not_found!('Branch') unless branch

        protected_branch = user_project.protected_branches.find_by(name: branch.name)
53

54
        protected_branch_params = {
55 56 57
          name: branch.name,
          developers_can_push: params[:developers_can_push],
          developers_can_merge: params[:developers_can_merge]
58 59
        }

60
        service_args = [user_project, current_user, protected_branch_params]
61

62 63 64 65 66
        protected_branch = if protected_branch
                             ProtectedBranches::ApiUpdateService.new(*service_args).execute(protected_branch)
                           else
                             ProtectedBranches::ApiCreateService.new(*service_args).execute
                           end
67

68
        if protected_branch.valid?
69
          present branch, with: Entities::RepoBranch, project: user_project
70
        else
71
          render_api_error!(protected_branch.errors.full_messages, 422)
72
        end
73 74
      end

75 76 77 78 79 80 81
      desc 'Unprotect a single branch' do
        success Entities::RepoBranch
      end
      params do
        requires :branch, type: String, regexp: /.+/, desc: 'The name of the branch'
      end
      put ':id/repository/branches/:branch/unprotect' do
82 83
        authorize_admin_project

84 85 86
        branch = user_project.repository.find_branch(params[:branch])
        not_found!("Branch") unless branch
        protected_branch = user_project.protected_branches.find_by(name: branch.name)
87 88
        protected_branch.destroy if protected_branch

89
        present branch, with: Entities::RepoBranch, project: user_project
90
      end
91

92 93 94 95 96 97 98
      desc 'Create branch' do
        success Entities::RepoBranch
      end
      params do
        requires :branch_name, type: String, desc: 'The name of the branch'
        requires :ref, type: String, desc: 'Create branch from commit sha or existing branch'
      end
99 100
      post ":id/repository/branches" do
        authorize_push_project
101
        result = CreateBranchService.new(user_project, current_user).
102
                 execute(params[:branch_name], params[:ref])
103

104 105
        if result[:status] == :success
          present result[:branch],
106
                  with: Entities::RepoBranch,
107 108 109 110
                  project: user_project
        else
          render_api_error!(result[:message], 400)
        end
111
      end
112

113 114 115 116 117
      desc 'Delete a branch'
      params do
        requires :branch, type: String, regexp: /.+/, desc: 'The name of the branch'
      end
      delete ":id/repository/branches/:branch" do
118
        authorize_push_project
119

120
        result = DeleteBranchService.new(user_project, current_user).
121
                 execute(params[:branch])
122

123
        if result[:status] == :success
124 125 126
          {
            branch_name: params[:branch]
          }
127
        else
128
          render_api_error!(result[:message], result[:return_code])
129
        end
130
      end
131 132 133 134 135 136 137 138 139 140 141 142

      # Delete all merged branches
      #
      # Parameters:
      #   id (required) - The ID of a project
      # Example Request:
      #   DELETE /projects/:id/repository/branches/delete_merged
      delete ":id/repository/merged_branches" do
        DeleteMergedBranchesService.new(user_project, current_user).async_execute

        status(200)
      end
143 144 145
    end
  end
end