gitlab 4.6.0 → 4.7.0

data/lib/gitlab/client/boards.rb

@@ -1,88 +1,90 @@
 # frozen_string_literal: true
 
-# Defines methods related to issue boards.
-# @see https://docs.gitlab.com/ce/api/boards.html
-module Boards
-  # Gets a list of project's boards.
-  #
-  # @example
-  #   Gitlab.boards(5)
-  #   Gitlab.boards({ per_page: 40 })
-  #
-  # @param  [Integer, String] project The ID or name of a project.
-  # @param  [Hash] options A customizable set of options.
-  # @option options [Integer] :page The page number.
-  # @option options [Integer] :per_page The number of results per page.
-  # @return [Array<Gitlab::ObjectifiedHash>]
-  def boards(project, options = {})
-    get("/projects/#{url_encode project}/boards", query: options)
-  end
+class Gitlab::Client
+  # Defines methods related to issue boards.
+  # @see https://docs.gitlab.com/ce/api/boards.html
+  module Boards
+    # Gets a list of project's boards.
+    #
+    # @example
+    #   Gitlab.boards(5)
+    #   Gitlab.boards({ per_page: 40 })
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [Integer] :page The page number.
+    # @option options [Integer] :per_page The number of results per page.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def boards(project, options = {})
+      get("/projects/#{url_encode project}/boards", query: options)
+    end
 
-  # Gets a board lists
-  #
-  # @example
-  #   Gitlab.board_lists(5, 42)
-  #
-  # @param  [Integer, String] project The ID or name of a project.
-  # @param  [Integer] id The ID of a board.
-  # @return [Gitlab::ObjectifiedHash]
-  def board_lists(project, id)
-    get("/projects/#{url_encode project}/boards/#{id}/lists")
-  end
+    # Gets a board lists
+    #
+    # @example
+    #   Gitlab.board_lists(5, 42)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of a board.
+    # @return [Gitlab::ObjectifiedHash]
+    def board_lists(project, id)
+      get("/projects/#{url_encode project}/boards/#{id}/lists")
+    end
 
-  #
-  # Gets a single board list
-  #
-  # @example
-  #   Gitlab.board_list(5, 42, 25)
-  #
-  # @param  [Integer, String] project The ID or name of a project.
-  # @param  [Integer] board_id The ID of a board.
-  # @param  [Integer] id The ID of a list.
-  # @return [Gitlab::ObjectifiedHash]
-  def board_list(project, board_id, id)
-    get("/projects/#{url_encode project}/boards/#{board_id}/lists/#{id}")
-  end
+    #
+    # Gets a single board list
+    #
+    # @example
+    #   Gitlab.board_list(5, 42, 25)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] board_id The ID of a board.
+    # @param  [Integer] id The ID of a list.
+    # @return [Gitlab::ObjectifiedHash]
+    def board_list(project, board_id, id)
+      get("/projects/#{url_encode project}/boards/#{board_id}/lists/#{id}")
+    end
 
-  # Creates a new board list.
-  # Only for admins and project owners
-  #
-  # @example
-  #   Gitlab.create_board_list(5, 42, 25)
-  #
-  # @param  [Integer, String] project The ID or name of a project.
-  # @param  [Integer] id The ID of a board.
-  # @param  [Integer] label_id The ID of a label.
-  # @return [Gitlab::ObjectifiedHash] Information about created list.
-  def create_board_list(project, board_id, label_id)
-    post("/projects/#{url_encode project}/boards/#{board_id}/lists", body: { label_id: label_id })
-  end
+    # Creates a new board list.
+    # Only for admins and project owners
+    #
+    # @example
+    #   Gitlab.create_board_list(5, 42, 25)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of a board.
+    # @param  [Integer] label_id The ID of a label.
+    # @return [Gitlab::ObjectifiedHash] Information about created list.
+    def create_board_list(project, board_id, label_id)
+      post("/projects/#{url_encode project}/boards/#{board_id}/lists", body: { label_id: label_id })
+    end
 
-  # Updates a board list.
-  # Only for admins and project owners
-  #
-  # @example
-  #   Gitlab.edit_board_list(6, 1, 12, 5)
-  #
-  # @param  [Integer, String] project The ID or name of a project.
-  # @param  [Integer] board_id The ID of a board.
-  # @param  [Integer] id The ID of a list.
-  # @return [Gitlab::ObjectifiedHash] Information about updated board list.
-  def edit_board_list(project, board_id, id, position)
-    put("/projects/#{url_encode project}/boards/#{board_id}/lists/#{id}", body: { position: position })
-  end
+    # Updates a board list.
+    # Only for admins and project owners
+    #
+    # @example
+    #   Gitlab.edit_board_list(6, 1, 12, 5)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] board_id The ID of a board.
+    # @param  [Integer] id The ID of a list.
+    # @return [Gitlab::ObjectifiedHash] Information about updated board list.
+    def edit_board_list(project, board_id, id, position)
+      put("/projects/#{url_encode project}/boards/#{board_id}/lists/#{id}", body: { position: position })
+    end
 
-  # Deletes  a board list.
-  # Only for admins and project owners
-  #
-  # @example
-  #   Gitlab.delete_board_list(3, 42, 32)
-  #
-  # @param  [Integer, String] project The ID or name of a project.
-  # @param  [Integer] board_id The ID of a board.
-  # @param  [Integer] id The ID of a list.
-  # @return [Gitlab::ObjectifiedHash] Information about deleted board list.
-  def delete_board_list(project, board_id, id)
-    delete("/projects/#{url_encode project}/boards/#{board_id}/lists/#{id}")
+    # Deletes  a board list.
+    # Only for admins and project owners
+    #
+    # @example
+    #   Gitlab.delete_board_list(3, 42, 32)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] board_id The ID of a board.
+    # @param  [Integer] id The ID of a list.
+    # @return [Gitlab::ObjectifiedHash] Information about deleted board list.
+    def delete_board_list(project, board_id, id)
+      delete("/projects/#{url_encode project}/boards/#{board_id}/lists/#{id}")
+    end
   end
 end

data/lib/gitlab/client/branches.rb

@@ -1,96 +1,98 @@
 # frozen_string_literal: true
 
-# Defines methods related to repositories.
-# @see https://docs.gitlab.com/ce/api/branches.html
-module Branches
-  # Gets a list of project repositiory branches.
-  #
-  # @example
-  #   Gitlab.branches(42)
-  #
-  # @param  [Integer, String] project The ID or name of a project.
-  # @param  [Hash] options A customizable set of options.
-  # @option options [Integer] :page The page number.
-  # @option options [Integer] :per_page The number of results per page.
-  # @return [Array<Gitlab::ObjectifiedHash>]
-  def branches(project, options = {})
-    get("/projects/#{url_encode project}/repository/branches", query: options)
-  end
-  alias repo_branches branches
+class Gitlab::Client
+  # Defines methods related to repositories.
+  # @see https://docs.gitlab.com/ce/api/branches.html
+  module Branches
+    # Gets a list of project repositiory branches.
+    #
+    # @example
+    #   Gitlab.branches(42)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [Integer] :page The page number.
+    # @option options [Integer] :per_page The number of results per page.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def branches(project, options = {})
+      get("/projects/#{url_encode project}/repository/branches", query: options)
+    end
+    alias repo_branches branches
 
-  # Gets information about a repository branch.
-  #
-  # @example
-  #   Gitlab.branch(3, 'api')
-  #   Gitlab.repo_branch(5, 'master')
-  #
-  # @param  [Integer, String] project The ID or name of a project.
-  # @param  [String] branch The name of the branch.
-  # @return [Gitlab::ObjectifiedHash]
-  def branch(project, branch)
-    get("/projects/#{url_encode project}/repository/branches/#{url_encode branch}")
-  end
-  alias repo_branch branch
+    # Gets information about a repository branch.
+    #
+    # @example
+    #   Gitlab.branch(3, 'api')
+    #   Gitlab.repo_branch(5, 'master')
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [String] branch The name of the branch.
+    # @return [Gitlab::ObjectifiedHash]
+    def branch(project, branch)
+      get("/projects/#{url_encode project}/repository/branches/#{url_encode branch}")
+    end
+    alias repo_branch branch
 
-  # Protects a repository branch.
-  #
-  # @example
-  #   Gitlab.protect_branch(3, 'api')
-  #   Gitlab.repo_protect_branch(5, 'master')
-  #   Gitlab.protect_branch(5, 'api', developers_can_push: true)
-  #
-  # To update options, call `protect_branch` again with new options (i.e. `developers_can_push: false`)
-  #
-  # @param  [Integer, String] project The ID or name of a project.
-  # @param  [String] branch The name of the branch.
-  # @param  [Hash] options A customizable set of options.
-  # @option options [Boolean] :developers_can_push True to allow developers to push to the branch (default = false)
-  # @option options [Boolean] :developers_can_merge True to allow developers to merge into the branch (default = false)
-  # @return [Gitlab::ObjectifiedHash] Details about the branch
-  def protect_branch(project, branch, options = {})
-    post("/projects/#{url_encode project}/protected_branches", body: { name: branch }.merge(options))
-  end
-  alias repo_protect_branch protect_branch
+    # Protects a repository branch.
+    #
+    # @example
+    #   Gitlab.protect_branch(3, 'api')
+    #   Gitlab.repo_protect_branch(5, 'master')
+    #   Gitlab.protect_branch(5, 'api', developers_can_push: true)
+    #
+    # To update options, call `protect_branch` again with new options (i.e. `developers_can_push: false`)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [String] branch The name of the branch.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [Boolean] :developers_can_push True to allow developers to push to the branch (default = false)
+    # @option options [Boolean] :developers_can_merge True to allow developers to merge into the branch (default = false)
+    # @return [Gitlab::ObjectifiedHash] Details about the branch
+    def protect_branch(project, branch, options = {})
+      post("/projects/#{url_encode project}/protected_branches", body: { name: branch }.merge(options))
+    end
+    alias repo_protect_branch protect_branch
 
-  # Unprotects a repository branch.
-  #
-  # @example
-  #   Gitlab.unprotect_branch(3, 'api')
-  #   Gitlab.repo_unprotect_branch(5, 'master')
-  #
-  # @param  [Integer, String] project The ID or name of a project.
-  # @param  [String] branch The name of the branch.
-  # @return [Gitlab::ObjectifiedHash] Details about the branch
-  def unprotect_branch(project, branch)
-    delete("/projects/#{url_encode project}/protected_branches/#{url_encode branch}")
-  end
-  alias repo_unprotect_branch unprotect_branch
+    # Unprotects a repository branch.
+    #
+    # @example
+    #   Gitlab.unprotect_branch(3, 'api')
+    #   Gitlab.repo_unprotect_branch(5, 'master')
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [String] branch The name of the branch.
+    # @return [Gitlab::ObjectifiedHash] Details about the branch
+    def unprotect_branch(project, branch)
+      delete("/projects/#{url_encode project}/protected_branches/#{url_encode branch}")
+    end
+    alias repo_unprotect_branch unprotect_branch
 
-  # Creates a repository branch.  Requires Gitlab >= 6.8.x
-  #
-  # @example
-  #   Gitlab.create_branch(3, 'api', 'feat/new-api')
-  #   Gitlab.repo_create_branch(5, 'master', 'develop')
-  #
-  # @param  [Integer, String] project The ID or name of a project.
-  # @param  [String] branch The name of the new branch.
-  # @param  [String] ref Create branch from commit sha or existing branch
-  # @return [Gitlab::ObjectifiedHash] Details about the branch
-  def create_branch(project, branch, ref)
-    post("/projects/#{url_encode project}/repository/branches", query: { branch: branch, ref: ref })
-  end
-  alias repo_create_branch create_branch
+    # Creates a repository branch.  Requires Gitlab >= 6.8.x
+    #
+    # @example
+    #   Gitlab.create_branch(3, 'api', 'feat/new-api')
+    #   Gitlab.repo_create_branch(5, 'master', 'develop')
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [String] branch The name of the new branch.
+    # @param  [String] ref Create branch from commit sha or existing branch
+    # @return [Gitlab::ObjectifiedHash] Details about the branch
+    def create_branch(project, branch, ref)
+      post("/projects/#{url_encode project}/repository/branches", query: { branch: branch, ref: ref })
+    end
+    alias repo_create_branch create_branch
 
-  # Deletes a repository branch.  Requires Gitlab >= 6.8.x
-  #
-  # @example
-  #   Gitlab.delete_branch(3, 'api')
-  #   Gitlab.repo_delete_branch(5, 'master')
-  #
-  # @param  [Integer, String] project The ID or name of a project.
-  # @param  [String] branch The name of the branch to delete
-  def delete_branch(project, branch)
-    delete("/projects/#{url_encode project}/repository/branches/#{url_encode branch}")
+    # Deletes a repository branch.  Requires Gitlab >= 6.8.x
+    #
+    # @example
+    #   Gitlab.delete_branch(3, 'api')
+    #   Gitlab.repo_delete_branch(5, 'master')
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [String] branch The name of the branch to delete
+    def delete_branch(project, branch)
+      delete("/projects/#{url_encode project}/repository/branches/#{url_encode branch}")
+    end
+    alias repo_delete_branch delete_branch
   end
-  alias repo_delete_branch delete_branch
 end

data/lib/gitlab/client/build_variables.rb

@@ -1,128 +1,130 @@
 # frozen_string_literal: true
 
-# Defines methods related to builds.
-# @see https://docs.gitlab.com/ce/api/build_variables.html
-# @see https://docs.gitlab.com/ee/api/group_level_variables.html
-module BuildVariables
-  # Gets a list of the project's build variables
-  #
-  # @example
-  #   Gitlab.variables(5)
-  #
-  # @param  [Integer, String] project The ID or name of a project.
-  # @return [Array<Gitlab::ObjectifiedHash>] The list of variables.
-  def variables(project)
-    get("/projects/#{url_encode project}/variables")
-  end
+class Gitlab::Client
+  # Defines methods related to builds.
+  # @see https://docs.gitlab.com/ce/api/build_variables.html
+  # @see https://docs.gitlab.com/ee/api/group_level_variables.html
+  module BuildVariables
+    # Gets a list of the project's build variables
+    #
+    # @example
+    #   Gitlab.variables(5)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @return [Array<Gitlab::ObjectifiedHash>] The list of variables.
+    def variables(project)
+      get("/projects/#{url_encode project}/variables")
+    end
 
-  # Gets details of a project's specific build variable.
-  #
-  # @example
-  #   Gitlab.variable(5, "TEST_VARIABLE_1")
-  #
-  # @param  [Integer, String] project The ID or name of a project.
-  # @param  [String] key The key of a variable.
-  # @return [Gitlab::ObjectifiedHash] The variable.
-  def variable(project, key)
-    get("/projects/#{url_encode project}/variables/#{key}")
-  end
+    # Gets details of a project's specific build variable.
+    #
+    # @example
+    #   Gitlab.variable(5, "TEST_VARIABLE_1")
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [String] key The key of a variable.
+    # @return [Gitlab::ObjectifiedHash] The variable.
+    def variable(project, key)
+      get("/projects/#{url_encode project}/variables/#{key}")
+    end
 
-  # Create a build variable for a project.
-  #
-  # @example
-  #   Gitlab.create_variable(5, "NEW_VARIABLE", "new value")
-  #
-  # @param  [Integer, String] project The ID or name of a project.
-  # @param  [String] key The key of a variable; must have no more than 255 characters; only `A-Z`, `a-z`, `0-9` and `_` are allowed
-  # @param  [String] value The value of a variable
-  # @return [Gitlab::ObjectifiedHash] The variable.
-  def create_variable(project, key, value)
-    post("/projects/#{url_encode project}/variables", body: { key: key, value: value })
-  end
+    # Create a build variable for a project.
+    #
+    # @example
+    #   Gitlab.create_variable(5, "NEW_VARIABLE", "new value")
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [String] key The key of a variable; must have no more than 255 characters; only `A-Z`, `a-z`, `0-9` and `_` are allowed
+    # @param  [String] value The value of a variable
+    # @return [Gitlab::ObjectifiedHash] The variable.
+    def create_variable(project, key, value)
+      post("/projects/#{url_encode project}/variables", body: { key: key, value: value })
+    end
 
-  # Update a project's build variable.
-  #
-  # @example
-  #   Gitlab.update_variable(5, "NEW_VARIABLE", "updated value")
-  #
-  # @param  [Integer, String] project The ID or name of a project.
-  # @param  [String] key The key of a variable
-  # @param  [String] value The value of a variable
-  # @return [Gitlab::ObjectifiedHash] The variable.
-  def update_variable(project, key, value)
-    put("/projects/#{url_encode project}/variables/#{key}", body: { value: value })
-  end
+    # Update a project's build variable.
+    #
+    # @example
+    #   Gitlab.update_variable(5, "NEW_VARIABLE", "updated value")
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [String] key The key of a variable
+    # @param  [String] value The value of a variable
+    # @return [Gitlab::ObjectifiedHash] The variable.
+    def update_variable(project, key, value)
+      put("/projects/#{url_encode project}/variables/#{key}", body: { value: value })
+    end
 
-  # Remove a project's build variable.
-  #
-  # @example
-  #   Gitlab.remove_variable(5, "VARIABLE_1")
-  #
-  # @param  [Integer, String] project The ID or name of a project.
-  # @param  [String] key The key of a variable.
-  # @return [Gitlab::ObjectifiedHash] The variable.
-  def remove_variable(project, key)
-    delete("/projects/#{url_encode project}/variables/#{key}")
-  end
+    # Remove a project's build variable.
+    #
+    # @example
+    #   Gitlab.remove_variable(5, "VARIABLE_1")
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [String] key The key of a variable.
+    # @return [Gitlab::ObjectifiedHash] The variable.
+    def remove_variable(project, key)
+      delete("/projects/#{url_encode project}/variables/#{key}")
+    end
 
-  # Gets a list of the group's build variables
-  #
-  # @example
-  #   Gitlab.group_variables(5)
-  #
-  # @param  [Integer, String] group The ID or name of a group.
-  # @return [Array<Gitlab::ObjectifiedHash>] The list of variables.
-  def group_variables(group)
-    get("/groups/#{url_encode group}/variables")
-  end
+    # Gets a list of the group's build variables
+    #
+    # @example
+    #   Gitlab.group_variables(5)
+    #
+    # @param  [Integer, String] group The ID or name of a group.
+    # @return [Array<Gitlab::ObjectifiedHash>] The list of variables.
+    def group_variables(group)
+      get("/groups/#{url_encode group}/variables")
+    end
 
-  # Gets details of a group's specific build variable.
-  #
-  # @example
-  #   Gitlab.group_variable(5, "TEST_VARIABLE_1")
-  #
-  # @param  [Integer, String] group The ID or name of a group.
-  # @param  [String] key The key of a variable.
-  # @return [Gitlab::ObjectifiedHash] The variable.
-  def group_variable(group, key)
-    get("/groups/#{url_encode group}/variables/#{key}")
-  end
+    # Gets details of a group's specific build variable.
+    #
+    # @example
+    #   Gitlab.group_variable(5, "TEST_VARIABLE_1")
+    #
+    # @param  [Integer, String] group The ID or name of a group.
+    # @param  [String] key The key of a variable.
+    # @return [Gitlab::ObjectifiedHash] The variable.
+    def group_variable(group, key)
+      get("/groups/#{url_encode group}/variables/#{key}")
+    end
 
-  # Create a build variable for a group.
-  #
-  # @example
-  #   Gitlab.create_group_variable(5, "NEW_VARIABLE", "new value")
-  #
-  # @param  [Integer, String] group The ID or name of a group.
-  # @param  [String] key The key of a variable; must have no more than 255 characters; only `A-Z`, `a-z`, `0-9` and `_` are allowed
-  # @param  [String] value The value of a variable
-  # @return [Gitlab::ObjectifiedHash] The variable.
-  def create_group_variable(group, key, value)
-    post("/groups/#{url_encode group}/variables", body: { key: key, value: value })
-  end
+    # Create a build variable for a group.
+    #
+    # @example
+    #   Gitlab.create_group_variable(5, "NEW_VARIABLE", "new value")
+    #
+    # @param  [Integer, String] group The ID or name of a group.
+    # @param  [String] key The key of a variable; must have no more than 255 characters; only `A-Z`, `a-z`, `0-9` and `_` are allowed
+    # @param  [String] value The value of a variable
+    # @return [Gitlab::ObjectifiedHash] The variable.
+    def create_group_variable(group, key, value)
+      post("/groups/#{url_encode group}/variables", body: { key: key, value: value })
+    end
 
-  # Update a group's build variable.
-  #
-  # @example
-  #   Gitlab.update_group_variable(5, "NEW_VARIABLE", "updated value")
-  #
-  # @param  [Integer, String] group The ID or name of a group.
-  # @param  [String] key The key of a variable
-  # @param  [String] value The value of a variable
-  # @return [Gitlab::ObjectifiedHash] The variable.
-  def update_group_variable(group, key, value)
-    put("/groups/#{url_encode group}/variables/#{key}", body: { value: value })
-  end
+    # Update a group's build variable.
+    #
+    # @example
+    #   Gitlab.update_group_variable(5, "NEW_VARIABLE", "updated value")
+    #
+    # @param  [Integer, String] group The ID or name of a group.
+    # @param  [String] key The key of a variable
+    # @param  [String] value The value of a variable
+    # @return [Gitlab::ObjectifiedHash] The variable.
+    def update_group_variable(group, key, value)
+      put("/groups/#{url_encode group}/variables/#{key}", body: { value: value })
+    end
 
-  # Remove a group's build variable.
-  #
-  # @example
-  #   Gitlab.remove_group_variable(5, "VARIABLE_1")
-  #
-  # @param  [Integer, String] group The ID or name of a group.
-  # @param  [String] key The key of a variable.
-  # @return [Gitlab::ObjectifiedHash] The variable.
-  def remove_group_variable(group, key)
-    delete("/groups/#{url_encode group}/variables/#{key}")
+    # Remove a group's build variable.
+    #
+    # @example
+    #   Gitlab.remove_group_variable(5, "VARIABLE_1")
+    #
+    # @param  [Integer, String] group The ID or name of a group.
+    # @param  [String] key The key of a variable.
+    # @return [Gitlab::ObjectifiedHash] The variable.
+    def remove_group_variable(group, key)
+      delete("/groups/#{url_encode group}/variables/#{key}")
+    end
   end
 end