gitlab 4.5.0 → 4.6.0

data/lib/gitlab/client/repositories.rb

@@ -1,59 +1,72 @@
-class Gitlab::Client
-  # Defines methods related to repositories.
-  # @see https://docs.gitlab.com/ce/api/repositories.html
-  module Repositories
-    # Get file tree project (root level).
-    #
-    # @example
-    #   Gitlab.tree(42)
-    #   Gitlab.tree(42, { path: 'Gemfile' })
-    #
-    # @param  [Integer, String] project The ID or name of a project.
-    # @param  [Hash] options A customizable set of options.
-    # @option options [String] :path The path inside repository.
-    # @option options [String] :ref_name The name of a repository branch or tag.
-    # @return [Gitlab::ObjectifiedHash]
-    def tree(project, options={})
-      get("/projects/#{url_encode project}/repository/tree", query: options)
-    end
-    alias_method :repo_tree, :tree
+# frozen_string_literal: true
 
-    # Get project repository archive
-    #
-    # @example
-    #   Gitlab.repo_archive(42)
-    #   Gitlab.repo_archive(42, 'deadbeef')
-    #
-    # @param  [Integer, String] project The ID or name of a project.
-    # @param  [String] ref The commit sha, branch, or tag to download.
-    # @return [Gitlab::FileResponse]
-    def repo_archive(project, ref = 'master')
-      get("/projects/#{url_encode project}/repository/archive",
-          format: nil,
-          headers: { Accept: 'application/octet-stream' },
-          query: { sha: ref },
-          parser: proc { |body, _|
-            if body.encoding == Encoding::ASCII_8BIT # binary response
-              ::Gitlab::FileResponse.new StringIO.new(body, 'rb+')
-            else # error with json response
-              ::Gitlab::Request.parse(body)
-            end
-          })
-    end
+# Defines methods related to repositories.
+# @see https://docs.gitlab.com/ce/api/repositories.html
+module Repositories
+  # Get file tree project (root level).
+  #
+  # @example
+  #   Gitlab.tree(42)
+  #   Gitlab.tree(42, { path: 'Gemfile' })
+  #
+  # @param  [Integer, String] project The ID or name of a project.
+  # @param  [Hash] options A customizable set of options.
+  # @option options [String] :path The path inside repository.
+  # @option options [String] :ref_name The name of a repository branch or tag.
+  # @return [Gitlab::ObjectifiedHash]
+  def tree(project, options = {})
+    get("/projects/#{url_encode project}/repository/tree", query: options)
+  end
+  alias repo_tree tree
+
+  # Get project repository archive
+  #
+  # @example
+  #   Gitlab.repo_archive(42)
+  #   Gitlab.repo_archive(42, 'deadbeef')
+  #
+  # @param  [Integer, String] project The ID or name of a project.
+  # @param  [String] ref The commit sha, branch, or tag to download.
+  # @return [Gitlab::FileResponse]
+  def repo_archive(project, ref = 'master')
+    get("/projects/#{url_encode project}/repository/archive",
+        format: nil,
+        headers: { Accept: 'application/octet-stream' },
+        query: { sha: ref },
+        parser: proc { |body, _|
+          if body.encoding == Encoding::ASCII_8BIT # binary response
+            ::Gitlab::FileResponse.new StringIO.new(body, 'rb+')
+          else # error with json response
+            ::Gitlab::Request.parse(body)
+          end
+        })
+  end
+
+  # Compares branches, tags or commits.
+  #
+  # @example
+  #   Gitlab.compare(42, 'master', 'feature/branch')
+  #   Gitlab.repo_compare(42, 'master', 'feature/branch')
+  #
+  # @param [Integer] project The ID of a project.
+  # @param [String] from The commit SHA or branch name of from branch.
+  # @param [String] to The commit SHA or branch name of to branch.
+  # @return [Gitlab::ObjectifiedHash]
+  def compare(project, from, to)
+    get("/projects/#{url_encode project}/repository/compare", query: { from: from, to: to })
+  end
+  alias repo_compare compare
 
-    # Compares branches, tags or commits.
-    #
-    # @example
-    #   Gitlab.compare(42, 'master', 'feature/branch')
-    #   Gitlab.repo_compare(42, 'master', 'feature/branch')
-    #
-    # @param [Integer] project The ID of a project.
-    # @param [String] from The commit SHA or branch name of from branch.
-    # @param [String] to The commit SHA or branch name of to branch.
-    # @return [Gitlab::ObjectifiedHash]
-    def compare(project, from, to)
-      get("/projects/#{url_encode project}/repository/compare", query: { from: from, to: to })
-    end
-    alias_method :repo_compare, :compare
+  # Get the common ancestor for 2 refs (commit SHAs, branch names or tags).
+  #
+  # @example
+  #   Gitlab.merge_base(42, ['master', 'feature/branch'])
+  #   Gitlab.merge_base(42, ['master', 'feature/branch'])
+  #
+  # @param [Integer, String] project The ID or URL-encoded path of the project.
+  # @param [Array] refs Array containing 2 commit SHAs, branch names, or tags.
+  # @return [Gitlab::ObjectifiedHash]
+  def merge_base(project, refs)
+    get("/projects/#{url_encode project}/repository/merge_base", query: { refs: refs })
   end
 end

data/lib/gitlab/client/repository_files.rb

@@ -1,113 +1,113 @@
+# frozen_string_literal: true
+
 require 'base64'
 
-class Gitlab::Client
-  # Defines methods related to repository files.
-  # @see https://docs.gitlab.com/ce/api/repository_files.html
-  module RepositoryFiles
-    # Get the contents of a file
-    #
-    # @example
-    #   Gitlab.file_contents(42, 'Gemfile')
-    #   Gitlab.repo_file_contents(3, 'Gemfile', 'ed899a2f4b50b4370feeea94676502b42383c746')
-    #
-    # @param  [Integer, String] project The ID or name of a project.
-    # @param  [String] filepath The relative path of the file in the repository
-    # @param  [String] ref The name of a repository branch or tag or if not given the default branch.
-    # @return [String]
-    def file_contents(project, filepath, ref='master')
-      get "/projects/#{url_encode project}/repository/files/#{url_encode filepath}/raw",
-          query: { ref: ref},
-          format: nil,
-          headers: { Accept: 'text/plain' },
-          parser: ::Gitlab::Request::Parser
-    end
-    alias_method :repo_file_contents, :file_contents
+# Defines methods related to repository files.
+# @see https://docs.gitlab.com/ce/api/repository_files.html
+module RepositoryFiles
+  # Get the contents of a file
+  #
+  # @example
+  #   Gitlab.file_contents(42, 'Gemfile')
+  #   Gitlab.repo_file_contents(3, 'Gemfile', 'ed899a2f4b50b4370feeea94676502b42383c746')
+  #
+  # @param  [Integer, String] project The ID or name of a project.
+  # @param  [String] filepath The relative path of the file in the repository
+  # @param  [String] ref The name of a repository branch or tag or if not given the default branch.
+  # @return [String]
+  def file_contents(project, filepath, ref = 'master')
+    get "/projects/#{url_encode project}/repository/files/#{url_encode filepath}/raw",
+        query: { ref: ref },
+        format: nil,
+        headers: { Accept: 'text/plain' },
+        parser: ::Gitlab::Request::Parser
+  end
+  alias repo_file_contents file_contents
 
-    # Gets a repository file.
-    #
-    # @example
-    #   Gitlab.get_file(42, "README.md", "master")
-    #
-    # @param  [Integer, String] project The ID or name of a project.
-    # @param  [String] file_path The full path of the file.
-    # @param  [String] ref The name of branch, tag or commit.
-    # @return [Gitlab::ObjectifiedHash]
-    def get_file(project, file_path, ref)
-      get("/projects/#{url_encode project}/repository/files/#{url_encode file_path}", query: {
-            ref: ref
-          })
-    end
+  # Gets a repository file.
+  #
+  # @example
+  #   Gitlab.get_file(42, "README.md", "master")
+  #
+  # @param  [Integer, String] project The ID or name of a project.
+  # @param  [String] file_path The full path of the file.
+  # @param  [String] ref The name of branch, tag or commit.
+  # @return [Gitlab::ObjectifiedHash]
+  def get_file(project, file_path, ref)
+    get("/projects/#{url_encode project}/repository/files/#{url_encode file_path}", query: {
+          ref: ref
+        })
+  end
 
-    # Creates a new repository file.
-    #
-    # @example
-    #   Gitlab.create_file(42, "path", "branch", "content", "commit message")
-    #
-    # @param  [Integer, String] project The ID or name of a project.
-    # @param  [String] path full path to new file.
-    # @param  [String] branch the name of the branch.
-    # @param  [String] content file content.
-    # @param  [String] commit_message ...commit message.
-    # @param  [Hash] options Optional additional details for commit
-    # @option options [String] :author_name Commit author's name
-    # @option options [String] :author_email Commit author's email address
-    # @return [Gitlab::ObjectifiedHash]
-    def create_file(project, path, branch, content, commit_message, options = {})
-      post("/projects/#{url_encode project}/repository/files/#{url_encode path}", body: {
-        branch: branch,
-        commit_message: commit_message
-      }.merge(options).merge(encoded_content_attributes(content)))
-    end
+  # Creates a new repository file.
+  #
+  # @example
+  #   Gitlab.create_file(42, "path", "branch", "content", "commit message")
+  #
+  # @param  [Integer, String] project The ID or name of a project.
+  # @param  [String] path full path to new file.
+  # @param  [String] branch the name of the branch.
+  # @param  [String] content file content.
+  # @param  [String] commit_message ...commit message.
+  # @param  [Hash] options Optional additional details for commit
+  # @option options [String] :author_name Commit author's name
+  # @option options [String] :author_email Commit author's email address
+  # @return [Gitlab::ObjectifiedHash]
+  def create_file(project, path, branch, content, commit_message, options = {})
+    post("/projects/#{url_encode project}/repository/files/#{url_encode path}", body: {
+      branch: branch,
+      commit_message: commit_message
+    }.merge(options).merge(encoded_content_attributes(content)))
+  end
 
-    # Edits an existing repository file.
-    #
-    # @example
-    #   Gitlab.edit_file(42, "path", "branch", "content", "commit message")
-    #
-    # @param  [Integer, String] project The ID or name of a project.
-    # @param  [String] path full path of file to update.
-    # @param  [String] branch the name of the branch to commit changes to.
-    # @param  [String] content new file content.
-    # @param  [String] commit_message ...commit message.
-    # @param  [Hash] options Optional additional details for commit
-    # @option options [String] :author_name Commit author's name
-    # @option options [String] :author_email Commit author's email address
-    # @return [Gitlab::ObjectifiedHash]
-    def edit_file(project, path, branch, content, commit_message, options = {})
-      put("/projects/#{url_encode project}/repository/files/#{url_encode path}", body: {
-        branch: branch,
-        commit_message: commit_message
-      }.merge(options).merge(encoded_content_attributes(content)))
-    end
+  # Edits an existing repository file.
+  #
+  # @example
+  #   Gitlab.edit_file(42, "path", "branch", "content", "commit message")
+  #
+  # @param  [Integer, String] project The ID or name of a project.
+  # @param  [String] path full path of file to update.
+  # @param  [String] branch the name of the branch to commit changes to.
+  # @param  [String] content new file content.
+  # @param  [String] commit_message ...commit message.
+  # @param  [Hash] options Optional additional details for commit
+  # @option options [String] :author_name Commit author's name
+  # @option options [String] :author_email Commit author's email address
+  # @return [Gitlab::ObjectifiedHash]
+  def edit_file(project, path, branch, content, commit_message, options = {})
+    put("/projects/#{url_encode project}/repository/files/#{url_encode path}", body: {
+      branch: branch,
+      commit_message: commit_message
+    }.merge(options).merge(encoded_content_attributes(content)))
+  end
 
-    # Removes an existing repository file.
-    #
-    # @example
-    #   Gitlab.remove_file(42, "path", "branch", "commit message")
-    #
-    # @param  [Integer, String] project The ID or name of a project.
-    # @param  [String] path full path of file to delete.
-    # @param  [String] branch the name of the branch to commit the deletion to.
-    # @param  [String] commit_message ...a commit message ;)
-    # @param  [Hash] options Optional additional details for commit
-    # @option options [String] :author_name Commit author's name
-    # @option options [String] :author_email Commit author's email address
-    # @return [Gitlab::ObjectifiedHash]
-    def remove_file(project, path, branch, commit_message, options = {})
-      delete("/projects/#{url_encode project}/repository/files/#{url_encode path}",
-             body: {
-               branch: branch,
-               commit_message: commit_message
-             }.merge(options))
-    end
+  # Removes an existing repository file.
+  #
+  # @example
+  #   Gitlab.remove_file(42, "path", "branch", "commit message")
+  #
+  # @param  [Integer, String] project The ID or name of a project.
+  # @param  [String] path full path of file to delete.
+  # @param  [String] branch the name of the branch to commit the deletion to.
+  # @param  [String] commit_message ...a commit message ;)
+  # @param  [Hash] options Optional additional details for commit
+  # @option options [String] :author_name Commit author's name
+  # @option options [String] :author_email Commit author's email address
+  # @return [Gitlab::ObjectifiedHash]
+  def remove_file(project, path, branch, commit_message, options = {})
+    delete("/projects/#{url_encode project}/repository/files/#{url_encode path}",
+           body: {
+             branch: branch,
+             commit_message: commit_message
+           }.merge(options))
+  end
 
-    private
+  private
 
-    def encoded_content_attributes(content)
-      {
-        encoding: 'base64',
-        content: Base64.encode64(content)
-      }
-    end
+  def encoded_content_attributes(content)
+    {
+      encoding: 'base64',
+      content: Base64.encode64(content)
+    }
   end
 end

data/lib/gitlab/client/runners.rb

@@ -1,126 +1,124 @@
-class Gitlab::Client
-  # Defines methods related to runners.
-  # @see https://docs.gitlab.com/ce/api/runners.html
-  module Runners
+# frozen_string_literal: true
 
-    # Get a list of specific runners available to the user.
-    # @see https://docs.gitlab.com/ce/api/runners.html#list-owned-runners
-    #
-    # @example
-    #   Gitlab.runners
-    #   Gitlab.runners(:active)
-    #   Gitlab.runners(:paused)
-    #
-    # @param  [Hash] options A customizable set of options.
-    # @option options [String] :scope The scope of specific runners to show, one of: active, paused, online; showing all runners if none provided
-    # @return [Array<Gitlab::ObjectifiedHash>]
-    def runners(options = {})
-      get("/runners", query: options)
-    end
-
-    # Get a list of all runners in the GitLab instance (specific and shared). Access is restricted to users with admin privileges.
-    # @see https://docs.gitlab.com/ce/api/runners.html#list-all-runners
-    #
-    # @example
-    #   Gitlab.all_runners
-    #
-    # @param  [Hash] options A customizable set of options.
-    # @option options [String] :scope The scope of runners to show, one of: specific, shared, active, paused, online; showing all runners if none provided
-    # @return [Array<Gitlab::ObjectifiedHash>]
-    def all_runners(options = {})
-      get("/runners/all", query: options)
-    end
+# Defines methods related to runners.
+# @see https://docs.gitlab.com/ce/api/runners.html
+module Runners
+  # Get a list of specific runners available to the user.
+  # @see https://docs.gitlab.com/ce/api/runners.html#list-owned-runners
+  #
+  # @example
+  #   Gitlab.runners
+  #   Gitlab.runners(:active)
+  #   Gitlab.runners(:paused)
+  #
+  # @param  [Hash] options A customizable set of options.
+  # @option options [String] :scope The scope of specific runners to show, one of: active, paused, online; showing all runners if none provided
+  # @return [Array<Gitlab::ObjectifiedHash>]
+  def runners(options = {})
+    get('/runners', query: options)
+  end
 
-    # Get details of a runner..
-    # @see https://docs.gitlab.com/ce/api/runners.html#get-runners-details
-    #
-    # @example
-    #   Gitlab.runner(42)
-    #
-    # @param  [Integer, String] id The ID of a runner
-    # @return <Gitlab::ObjectifiedHash>
-    def runner(id)
-      get("/runners/#{id}")
-    end
+  # Get a list of all runners in the GitLab instance (specific and shared). Access is restricted to users with admin privileges.
+  # @see https://docs.gitlab.com/ce/api/runners.html#list-all-runners
+  #
+  # @example
+  #   Gitlab.all_runners
+  #
+  # @param  [Hash] options A customizable set of options.
+  # @option options [String] :scope The scope of runners to show, one of: specific, shared, active, paused, online; showing all runners if none provided
+  # @return [Array<Gitlab::ObjectifiedHash>]
+  def all_runners(options = {})
+    get('/runners/all', query: options)
+  end
 
-    # Update details of a runner.
-    # @see https://docs.gitlab.com/ce/api/runners.html#update-runners-details
-    #
-    # @example
-    #   Gitlab.update_runner(42, { description: 'Awesome runner' })
-    #   Gitlab.update_runner(42, { active: false })
-    #   Gitlab.update_runner(42, { tag_list: [ 'awesome', 'runner' ] })
-    #
-    # @param  [Integer, String] id The ID of a runner
-    # @param  [Hash] options A customizable set of options.
-    # @option options [String] :active The state of a runner; can be set to true or false.
-    # @option options [String] :tag_list The list of tags for a runner; put array of tags, that should be finally assigned to a runner
-    # @return <Gitlab::ObjectifiedHash>
-    def update_runner(id, options={})
-      put("/runners/#{id}", query: options)
-    end
+  # Get details of a runner..
+  # @see https://docs.gitlab.com/ce/api/runners.html#get-runners-details
+  #
+  # @example
+  #   Gitlab.runner(42)
+  #
+  # @param  [Integer, String] id The ID of a runner
+  # @return <Gitlab::ObjectifiedHash>
+  def runner(id)
+    get("/runners/#{id}")
+  end
 
-    # Remove a runner.
-    # @see https://docs.gitlab.com/ce/api/runners.html#remove-a-runner
-    #
-    # @example
-    #   Gitlab.delete_runner(42)
-    #
-    # @param  [Integer, String] id The ID of a runner
-    # @return <Gitlab::ObjectifiedHash>
-    def delete_runner(id)
-      delete("/runners/#{id}")
-    end
+  # Update details of a runner.
+  # @see https://docs.gitlab.com/ce/api/runners.html#update-runners-details
+  #
+  # @example
+  #   Gitlab.update_runner(42, { description: 'Awesome runner' })
+  #   Gitlab.update_runner(42, { active: false })
+  #   Gitlab.update_runner(42, { tag_list: [ 'awesome', 'runner' ] })
+  #
+  # @param  [Integer, String] id The ID of a runner
+  # @param  [Hash] options A customizable set of options.
+  # @option options [String] :active The state of a runner; can be set to true or false.
+  # @option options [String] :tag_list The list of tags for a runner; put array of tags, that should be finally assigned to a runner
+  # @return <Gitlab::ObjectifiedHash>
+  def update_runner(id, options = {})
+    put("/runners/#{id}", query: options)
+  end
 
-    # Gets a list of Jobs for a Runner
-    #
-    # @example
-    #   Gitlab.runner_jobs(1)
-    #
-    # @param  [Integer] id The ID of a runner.
-    # @return [Array<Gitlab::ObjectifiedHash>]
-    def runner_jobs(runner_id)
-      get("/runners/#{url_encode runner_id}/jobs")
-    end
+  # Remove a runner.
+  # @see https://docs.gitlab.com/ce/api/runners.html#remove-a-runner
+  #
+  # @example
+  #   Gitlab.delete_runner(42)
+  #
+  # @param  [Integer, String] id The ID of a runner
+  # @return <Gitlab::ObjectifiedHash>
+  def delete_runner(id)
+    delete("/runners/#{id}")
+  end
 
-    # List all runners (specific and shared) available in the project. Shared runners are listed if at least one shared runner is defined and shared runners usage is enabled in the project's settings.
-    # @see https://docs.gitlab.com/ce/api/runners.html#list-projects-runners
-    #
-    # @example
-    #   Gitlab.project_runners(42)
-    #
-    # @param  [Integer, String] id The ID or name of a project.
-    # @return [Array<Gitlab::ObjectifiedHash>]
-    def project_runners(project_id)
-      get("/projects/#{url_encode project_id}/runners")
-    end
+  # Gets a list of Jobs for a Runner
+  #
+  # @example
+  #   Gitlab.runner_jobs(1)
+  #
+  # @param  [Integer] id The ID of a runner.
+  # @return [Array<Gitlab::ObjectifiedHash>]
+  def runner_jobs(runner_id)
+    get("/runners/#{url_encode runner_id}/jobs")
+  end
 
-    # Enable an available specific runner in the project.
-    # @see https://docs.gitlab.com/ce/api/runners.html#enable-a-runner-in-project
-    #
-    # @example
-    #   Gitlab.project_enable_runner(2, 42)
-    #
-    # @param  [Integer, String] id The ID or name of a project.
-    # @param  [Integer, String] id The ID of a runner.
-    # @return <Gitlab::ObjectifiedHash>
-    def project_enable_runner(project_id, id)
-      body = { runner_id: id }
-      post("/projects/#{url_encode project_id}/runners", body: body)
-    end
+  # List all runners (specific and shared) available in the project. Shared runners are listed if at least one shared runner is defined and shared runners usage is enabled in the project's settings.
+  # @see https://docs.gitlab.com/ce/api/runners.html#list-projects-runners
+  #
+  # @example
+  #   Gitlab.project_runners(42)
+  #
+  # @param  [Integer, String] id The ID or name of a project.
+  # @return [Array<Gitlab::ObjectifiedHash>]
+  def project_runners(project_id)
+    get("/projects/#{url_encode project_id}/runners")
+  end
 
-    # Disable a specific runner from the project. It works only if the project isn't the only project associated with the specified runner.
-    # @see https://docs.gitlab.com/ce/api/runners.html#disable-a-runner-from-project
-    #
-    # @example
-    #   Gitlab.project_disable_runner(2, 42)
-    #
-    # @param  [Integer, String] id The ID or name of a project.
-    # @param  [Integer, String] runner_id The ID of a runner.
-    # @return <Gitlab::ObjectifiedHash>
-    def project_disable_runner(id, runner_id)
-      delete("/projects/#{url_encode id}/runners/#{runner_id}")
-    end
+  # Enable an available specific runner in the project.
+  # @see https://docs.gitlab.com/ce/api/runners.html#enable-a-runner-in-project
+  #
+  # @example
+  #   Gitlab.project_enable_runner(2, 42)
+  #
+  # @param  [Integer, String] id The ID or name of a project.
+  # @param  [Integer, String] id The ID of a runner.
+  # @return <Gitlab::ObjectifiedHash>
+  def project_enable_runner(project_id, id)
+    body = { runner_id: id }
+    post("/projects/#{url_encode project_id}/runners", body: body)
+  end
 
+  # Disable a specific runner from the project. It works only if the project isn't the only project associated with the specified runner.
+  # @see https://docs.gitlab.com/ce/api/runners.html#disable-a-runner-from-project
+  #
+  # @example
+  #   Gitlab.project_disable_runner(2, 42)
+  #
+  # @param  [Integer, String] id The ID or name of a project.
+  # @param  [Integer, String] runner_id The ID of a runner.
+  # @return <Gitlab::ObjectifiedHash>
+  def project_disable_runner(id, runner_id)
+    delete("/projects/#{url_encode id}/runners/#{runner_id}")
   end
 end