Merge branch '22132-rename-branch-name-params-to-branch' into 'master'

Standardize branch name params as `branch` on V4 API

Closes #22132

See merge request !8936

6 files changed, 355 insertions, 11 deletions

diff --git a/lib/api/api.rb b/lib/api/api.rb
index 2e51be9fff3..a0282ff8deb 100644
--- a/lib/api/api.rb
+++ b/lib/api/api.rb
@@ -7,7 +7,9 @@ module API
     version 'v3', using: :path do
       mount ::API::V3::Boards
       mount ::API::V3::Branches
+      mount ::API::V3::Commits
       mount ::API::V3::DeployKeys
+      mount ::API::V3::Files
       mount ::API::V3::Issues
       mount ::API::V3::Labels
       mount ::API::V3::Members
diff --git a/lib/api/branches.rb b/lib/api/branches.rb
index 9d1f5a28ef6..c65de90cca2 100644
--- a/lib/api/branches.rb
+++ b/lib/api/branches.rb
@@ -97,13 +97,13 @@ module API
         success Entities::RepoBranch
       end
       params do
-        requires :branch_name, type: String, desc: 'The name of the branch'
+        requires :branch, type: String, desc: 'The name of the branch'
         requires :ref, type: String, desc: 'Create branch from commit sha or existing branch'
       end
       post ":id/repository/branches" do
         authorize_push_project
         result = CreateBranchService.new(user_project, current_user).
-                 execute(params[:branch_name], params[:ref])
+                 execute(params[:branch], params[:ref])
 
         if result[:status] == :success
           present result[:branch],
@@ -126,7 +126,7 @@ module API
 
         if result[:status] == :success
           {
-            branch_name: params[:branch]
+            branch: params[:branch]
           }
         else
           render_api_error!(result[:message], result[:return_code])
diff --git a/lib/api/commits.rb b/lib/api/commits.rb
index 3b314c89c6e..0cd817f9352 100644
--- a/lib/api/commits.rb
+++ b/lib/api/commits.rb
@@ -41,7 +41,7 @@ module API
         detail 'This feature was introduced in GitLab 8.13'
       end
       params do
-        requires :branch_name, type: String, desc: 'The name of branch'
+        requires :branch, type: String, desc: 'The name of branch'
         requires :commit_message, type: String, desc: 'Commit message'
         requires :actions, type: Array[Hash], desc: 'Actions to perform in commit'
         optional :author_email, type: String, desc: 'Author email for commit'
@@ -50,9 +50,8 @@ module API
       post ":id/repository/commits" do
         authorize! :push_code, user_project
 
-        attrs = declared_params
-        attrs[:start_branch] = attrs[:branch_name]
-        attrs[:target_branch] = attrs[:branch_name]
+        attrs = declared_params.merge(start_branch: declared_params[:branch], target_branch: declared_params[:branch])
+
         attrs[:actions].map! do |action|
           action[:action] = action[:action].to_sym
           action[:file_path].slice!(0) if action[:file_path] && action[:file_path].start_with?('/')
diff --git a/lib/api/files.rb b/lib/api/files.rb
index 6e16ccd2fd8..500f9d3c787 100644
--- a/lib/api/files.rb
+++ b/lib/api/files.rb
@@ -4,8 +4,8 @@ module API
       def commit_params(attrs)
         {
           file_path: attrs[:file_path],
-          start_branch: attrs[:branch_name],
-          target_branch: attrs[:branch_name],
+          start_branch: attrs[:branch],
+          target_branch: attrs[:branch],
           commit_message: attrs[:commit_message],
           file_content: attrs[:content],
           file_content_encoding: attrs[:encoding],
@@ -17,13 +17,13 @@ module API
       def commit_response(attrs)
         {
           file_path: attrs[:file_path],
-          branch_name: attrs[:branch_name]
+          branch: attrs[:branch]
         }
       end
 
       params :simple_file_params do
         requires :file_path, type: String, desc: 'The path to new file. Ex. lib/class.rb'
-        requires :branch_name, type: String, desc: 'The name of branch'
+        requires :branch, type: String, desc: 'The name of branch'
         requires :commit_message, type: String, desc: 'Commit Message'
         optional :author_email, type: String, desc: 'The email of the author'
         optional :author_name, type: String, desc: 'The name of the author'
diff --git a/lib/api/v3/commits.rb b/lib/api/v3/commits.rb
new file mode 100644
index 00000000000..477e22fd25e
--- /dev/null
+++ b/lib/api/v3/commits.rb
@@ -0,0 +1,205 @@
+require 'mime/types'
+
+module API
+  module V3
+    class Commits < Grape::API
+      include PaginationParams
+
+      before { authenticate! }
+      before { authorize! :download_code, user_project }
+
+      params do
+        requires :id, type: String, desc: 'The ID of a project'
+      end
+      resource :projects do
+        desc 'Get a project repository commits' do
+          success ::API::Entities::RepoCommit
+        end
+        params do
+          optional :ref_name, type: String, desc: 'The name of a repository branch or tag, if not given the default branch is used'
+          optional :since,    type: DateTime, desc: 'Only commits after or in this date will be returned'
+          optional :until,    type: DateTime, desc: 'Only commits before or in this date will be returned'
+          optional :page,     type: Integer, default: 0, desc: 'The page for pagination'
+          optional :per_page, type: Integer, default: 20, desc: 'The number of results per page'
+          optional :path,     type: String, desc: 'The file path'
+        end
+        get ":id/repository/commits" do
+          ref = params[:ref_name] || user_project.try(:default_branch) || 'master'
+          offset = params[:page] * params[:per_page]
+
+          commits = user_project.repository.commits(ref,
+                                                    path: params[:path],
+                                                    limit: params[:per_page],
+                                                    offset: offset,
+                                                    after: params[:since],
+                                                    before: params[:until])
+
+          present commits, with: ::API::Entities::RepoCommit
+        end
+
+        desc 'Commit multiple file changes as one commit' do
+          success ::API::Entities::RepoCommitDetail
+          detail 'This feature was introduced in GitLab 8.13'
+        end
+        params do
+          requires :branch_name, type: String, desc: 'The name of branch'
+          requires :commit_message, type: String, desc: 'Commit message'
+          requires :actions, type: Array[Hash], desc: 'Actions to perform in commit'
+          optional :author_email, type: String, desc: 'Author email for commit'
+          optional :author_name, type: String, desc: 'Author name for commit'
+        end
+        post ":id/repository/commits" do
+          authorize! :push_code, user_project
+
+          attrs = declared_params.dup
+          branch = attrs.delete(:branch_name)
+          attrs.merge!(branch: branch, start_branch: branch, target_branch: branch)
+
+          attrs[:actions].map! do |action|
+            action[:action] = action[:action].to_sym
+            action[:file_path].slice!(0) if action[:file_path] && action[:file_path].start_with?('/')
+            action[:previous_path].slice!(0) if action[:previous_path] && action[:previous_path].start_with?('/')
+            action
+          end
+
+          result = ::Files::MultiService.new(user_project, current_user, attrs).execute
+
+          if result[:status] == :success
+            commit_detail = user_project.repository.commits(result[:result], limit: 1).first
+            present commit_detail, with: ::API::Entities::RepoCommitDetail
+          else
+            render_api_error!(result[:message], 400)
+          end
+        end
+
+        desc 'Get a specific commit of a project' do
+          success ::API::Entities::RepoCommitDetail
+          failure [[404, 'Not Found']]
+        end
+        params do
+          requires :sha, type: String, desc: 'A commit sha, or the name of a branch or tag'
+        end
+        get ":id/repository/commits/:sha" do
+          commit = user_project.commit(params[:sha])
+
+          not_found! "Commit" unless commit
+
+          present commit, with: ::API::Entities::RepoCommitDetail
+        end
+
+        desc 'Get the diff for a specific commit of a project' do
+          failure [[404, 'Not Found']]
+        end
+        params do
+          requires :sha, type: String, desc: 'A commit sha, or the name of a branch or tag'
+        end
+        get ":id/repository/commits/:sha/diff" do
+          commit = user_project.commit(params[:sha])
+
+          not_found! "Commit" unless commit
+
+          commit.raw_diffs.to_a
+        end
+
+        desc "Get a commit's comments" do
+          success ::API::Entities::CommitNote
+          failure [[404, 'Not Found']]
+        end
+        params do
+          use :pagination
+          requires :sha, type: String, desc: 'A commit sha, or the name of a branch or tag'
+        end
+        get ':id/repository/commits/:sha/comments' do
+          commit = user_project.commit(params[:sha])
+
+          not_found! 'Commit' unless commit
+          notes = Note.where(commit_id: commit.id).order(:created_at)
+
+          present paginate(notes), with: ::API::Entities::CommitNote
+        end
+
+        desc 'Cherry pick commit into a branch' do
+          detail 'This feature was introduced in GitLab 8.15'
+          success ::API::Entities::RepoCommit
+        end
+        params do
+          requires :sha, type: String, desc: 'A commit sha to be cherry picked'
+          requires :branch, type: String, desc: 'The name of the branch'
+        end
+        post ':id/repository/commits/:sha/cherry_pick' do
+          authorize! :push_code, user_project
+
+          commit = user_project.commit(params[:sha])
+          not_found!('Commit') unless commit
+
+          branch = user_project.repository.find_branch(params[:branch])
+          not_found!('Branch') unless branch
+
+          commit_params = {
+            commit: commit,
+            create_merge_request: false,
+            source_project: user_project,
+            source_branch: commit.cherry_pick_branch_name,
+            target_branch: params[:branch]
+          }
+
+          result = ::Commits::CherryPickService.new(user_project, current_user, commit_params).execute
+
+          if result[:status] == :success
+            branch = user_project.repository.find_branch(params[:branch])
+            present user_project.repository.commit(branch.dereferenced_target), with: ::API::Entities::RepoCommit
+          else
+            render_api_error!(result[:message], 400)
+          end
+        end
+
+        desc 'Post comment to commit' do
+          success ::API::Entities::CommitNote
+        end
+        params do
+          requires :sha, type: String, regexp: /\A\h{6,40}\z/, desc: "The commit's SHA"
+          requires :note, type: String, desc: 'The text of the comment'
+          optional :path, type: String, desc: 'The file path'
+          given :path do
+            requires :line, type: Integer, desc: 'The line number'
+            requires :line_type, type: String, values: ['new', 'old'], default: 'new', desc: 'The type of the line'
+          end
+        end
+        post ':id/repository/commits/:sha/comments' do
+          commit = user_project.commit(params[:sha])
+          not_found! 'Commit' unless commit
+
+          opts = {
+            note: params[:note],
+            noteable_type: 'Commit',
+            commit_id: commit.id
+          }
+
+          if params[:path]
+            commit.raw_diffs(all_diffs: true).each do |diff|
+              next unless diff.new_path == params[:path]
+              lines = Gitlab::Diff::Parser.new.parse(diff.diff.each_line)
+
+              lines.each do |line|
+                next unless line.new_pos == params[:line] && line.type == params[:line_type]
+                break opts[:line_code] = Gitlab::Diff::LineCode.generate(diff.new_path, line.new_pos, line.old_pos)
+              end
+
+              break if opts[:line_code]
+            end
+
+            opts[:type] = LegacyDiffNote.name if opts[:line_code]
+          end
+
+          note = ::Notes::CreateService.new(user_project, current_user, opts).execute
+
+          if note.save
+            present note, with: ::API::Entities::CommitNote
+          else
+            render_api_error!("Failed to save note #{note.errors.messages}", 400)
+          end
+        end
+      end
+    end
+  end
+end
diff --git a/lib/api/v3/files.rb b/lib/api/v3/files.rb
new file mode 100644
index 00000000000..4f8d58d37c8
--- /dev/null
+++ b/lib/api/v3/files.rb
@@ -0,0 +1,138 @@
+module API
+  module V3
+    class Files < Grape::API
+      helpers do
+        def commit_params(attrs)
+          {
+            file_path: attrs[:file_path],
+            start_branch: attrs[:branch],
+            target_branch: attrs[:branch],
+            commit_message: attrs[:commit_message],
+            file_content: attrs[:content],
+            file_content_encoding: attrs[:encoding],
+            author_email: attrs[:author_email],
+            author_name: attrs[:author_name]
+          }
+        end
+
+        def commit_response(attrs)
+          {
+            file_path: attrs[:file_path],
+            branch: attrs[:branch]
+          }
+        end
+
+        params :simple_file_params do
+          requires :file_path, type: String, desc: 'The path to new file. Ex. lib/class.rb'
+          requires :branch_name, type: String, desc: 'The name of branch'
+          requires :commit_message, type: String, desc: 'Commit Message'
+          optional :author_email, type: String, desc: 'The email of the author'
+          optional :author_name, type: String, desc: 'The name of the author'
+        end
+
+        params :extended_file_params do
+          use :simple_file_params
+          requires :content, type: String, desc: 'File content'
+          optional :encoding, type: String, values: %w[base64], desc: 'File encoding'
+        end
+      end
+
+      params do
+        requires :id, type: String, desc: 'The project ID'
+      end
+      resource :projects do
+        desc 'Get a file from repository'
+        params do
+          requires :file_path, type: String, desc: 'The path to the file. Ex. lib/class.rb'
+          requires :ref, type: String, desc: 'The name of branch, tag, or commit'
+        end
+        get ":id/repository/files" do
+          authorize! :download_code, user_project
+
+          commit = user_project.commit(params[:ref])
+          not_found!('Commit') unless commit
+
+          repo = user_project.repository
+          blob = repo.blob_at(commit.sha, params[:file_path])
+          not_found!('File') unless blob
+
+          blob.load_all_data!(repo)
+          status(200)
+
+          {
+            file_name: blob.name,
+            file_path: blob.path,
+            size: blob.size,
+            encoding: "base64",
+            content: Base64.strict_encode64(blob.data),
+            ref: params[:ref],
+            blob_id: blob.id,
+            commit_id: commit.id,
+            last_commit_id: repo.last_commit_id_for_path(commit.sha, params[:file_path])
+          }
+        end
+
+        desc 'Create new file in repository'
+        params do
+          use :extended_file_params
+        end
+        post ":id/repository/files" do
+          authorize! :push_code, user_project
+
+          file_params = declared_params(include_missing: false)
+          file_params[:branch] = file_params.delete(:branch_name)
+
+          result = ::Files::CreateService.new(user_project, current_user, commit_params(file_params)).execute
+
+          if result[:status] == :success
+            status(201)
+            commit_response(file_params)
+          else
+            render_api_error!(result[:message], 400)
+          end
+        end
+
+        desc 'Update existing file in repository'
+        params do
+          use :extended_file_params
+        end
+        put ":id/repository/files" do
+          authorize! :push_code, user_project
+
+          file_params = declared_params(include_missing: false)
+          file_params[:branch] = file_params.delete(:branch_name)
+
+          result = ::Files::UpdateService.new(user_project, current_user, commit_params(file_params)).execute
+
+          if result[:status] == :success
+            status(200)
+            commit_response(file_params)
+          else
+            http_status = result[:http_status] || 400
+            render_api_error!(result[:message], http_status)
+          end
+        end
+
+        desc 'Delete an existing file in repository'
+        params do
+          use :simple_file_params
+        end
+        delete ":id/repository/files" do
+          authorize! :push_code, user_project
+
+          file_params = declared_params(include_missing: false)
+          file_params[:branch] = file_params.delete(:branch_name)
+
+          result = ::Files::DestroyService.new(user_project, current_user, commit_params(file_params)).execute
+
+          if result[:status] == :success
+            status(200)
+            commit_response(file_params)
+          else
+            render_api_error!(result[:message], 400)
+          end
+        end
+      end
+    end
+  end
+end