BigW Consortium Gitlab

branches.rb 3.96 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
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
17 18
        branches = user_project.repository.branches.sort_by(&:name)
        present branches, with: Entities::RepoObject, project: user_project
19 20 21 22 23 24 25 26 27
      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
28
      get ':id/repository/branches/:branch', requirements: { branch: /.*/ } do
Dmitriy Zaporozhets committed
29
        @branch = user_project.repository.branches.find { |item| item.name == params[:branch] }
30
        not_found!("Branch") unless @branch
31 32 33 34 35 36 37 38 39 40
        present @branch, with: Entities::RepoObject, project: user_project
      end

      # Protect 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/protect
41 42 43
      put ':id/repository/branches/:branch/protect',
          requirements: { branch: /.*/ } do

44 45 46
        authorize_admin_project

        @branch = user_project.repository.find_branch(params[:branch])
47
        not_found!("Branch") unless @branch
48 49 50 51 52 53 54 55 56 57 58 59 60
        protected_branch = user_project.protected_branches.find_by(name: @branch.name)
        user_project.protected_branches.create(name: @branch.name) unless protected_branch

        present @branch, with: Entities::RepoObject, project: user_project
      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
61 62 63
      put ':id/repository/branches/:branch/unprotect',
          requirements: { branch: /.*/ } do

64 65 66
        authorize_admin_project

        @branch = user_project.repository.find_branch(params[:branch])
67
        not_found!("Branch does not exist") unless @branch
68 69 70 71 72
        protected_branch = user_project.protected_branches.find_by(name: @branch.name)
        protected_branch.destroy if protected_branch

        present @branch, with: Entities::RepoObject, project: user_project
      end
73 74 75 76 77 78 79 80 81 82 83

      # 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
84 85
        result = CreateBranchService.new(user_project, current_user).
          execute(params[:branch_name], params[:ref])
86

87 88 89 90 91 92 93
        if result[:status] == :success
          present result[:branch],
                  with: Entities::RepoObject,
                  project: user_project
        else
          render_api_error!(result[:message], 400)
        end
94
      end
95 96 97 98 99 100 101 102

      # 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
Dan Tudor committed
103
      delete ":id/repository/branches/:branch",
104
          requirements: { branch: /.*/ } do
105
        authorize_push_project
106
        result = DeleteBranchService.new(user_project, current_user).
107
          execute(params[:branch])
108

109
        if result[:status] == :success
110 111 112
          {
            branch_name: params[:branch]
          }
113
        else
114
          render_api_error!(result[:message], result[:return_code])
115
        end
116
      end
117 118 119
    end
  end
end