branches.rb 3.87 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
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
17
        present user_project.repository.branches.sort_by(&:name), with: Entities::RepoObject, project: user_project
18 19 20 21 22 23 24 25 26
      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
27
      get ':id/repository/branches/:branch', requirements: { branch: /.*/ } do
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
28
        @branch = user_project.repository.branches.find { |item| item.name == params[:branch] }
29 30 31 32 33 34 35 36 37 38 39
        not_found!("Branch does not exist") if @branch.nil?
        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
40 41 42
      put ':id/repository/branches/:branch/protect',
          requirements: { branch: /.*/ } do

43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59
        authorize_admin_project

        @branch = user_project.repository.find_branch(params[:branch])
        not_found! unless @branch
        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
60 61 62
      put ':id/repository/branches/:branch/unprotect',
          requirements: { branch: /.*/ } do

63 64 65 66 67 68 69 70 71
        authorize_admin_project

        @branch = user_project.repository.find_branch(params[:branch])
        not_found! unless @branch
        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
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
72 73 74 75 76 77 78 79 80 81 82

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

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

      # 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
      delete ":id/repository/branches/:branch" do
        authorize_push_project
104 105
        result = DeleteBranchService.new(user_project, current_user).
          execute(params[:branch])
106

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