gitlab 4.14.0 → 4.17.0

data/lib/gitlab/client/labels.rb

@@ -58,7 +58,7 @@ class Gitlab::Client
     # @param  [String] name The name of a label.
     # @return [Gitlab::ObjectifiedHash] Information about deleted label.
     def delete_label(project, name)
-      delete("/projects/#{url_encode project}/labels", body: { name: name })
+      delete("/projects/#{url_encode project}/labels/#{name}")
     end
 
     # Subscribes the user to a label to receive notifications

data/lib/gitlab/client/merge_request_approvals.rb

@@ -31,6 +31,62 @@ class Gitlab::Client
       post("/projects/#{url_encode project}/approvals", body: options)
     end
 
+    # Gets MR Approval Rules for a project
+    #
+    # @example
+    #   Gitlab.project_merge_request_approval_rules(1)
+    #
+    # @param [Integer] project The ID of a project.
+    # @return [Gitlab::ObjectifiedHash] MR approval rules for the project
+    def project_merge_request_approval_rules(project)
+      get("/projects/#{url_encode project}/approval_rules")
+    end
+
+    # Create MR Approval Rule for a project
+    #
+    # @example
+    #   Gitlab.create_project_merge_request_approval_rule(1, {name: "security", approvals_required: 1})
+    #
+    # @param [Integer] project(required) The ID of a project.
+    # @option options [String] :name(required) The name of the approval rule
+    # @option options [Integer] :approvals_required(required) The number of required approvals for this rule
+    # @option options [Array] :user_ids(optional) The ids of users as approvers
+    # @option options [Array] :group_ids(optional) The ids of groups as approvers
+    # @option options [Array] :protected_branch_ids(optional) The ids of protected branches to scope the rule by
+    # @return [Gitlab::ObjectifiedHash] New MR approval rule
+    def create_project_merge_request_approval_rule(project, options = {})
+      post("/projects/#{url_encode project}/approval_rules", body: options)
+    end
+
+    # Update MR Approval Rule for a project
+    #
+    # @example
+    #   Gitlab.update_project_merge_request_approval_rule(1, {name: "security", approvals_required: 2})
+    #
+    # @param [Integer] project(required) The ID of a project.
+    # @param [Integer] approval_rule_id(required) The ID of a project Approval Rule
+    # @option options [String] :name(required) The name of the approval rule
+    # @option options [Integer] :approvals_required(required) The number of required approvals for this rule
+    # @option options [Array] :user_ids(optional) The ids of users as approvers
+    # @option options [Array] :group_ids(optional) The ids of groups as approvers
+    # @option options [Array] :protected_branch_ids(optional) The ids of protected branches to scope the rule by
+    # @return [Gitlab::ObjectifiedHash] Updated MR approval rule
+    def update_project_merge_request_approval_rule(project, approval_rule_id, options = {})
+      put("/projects/#{url_encode project}/approval_rules/#{approval_rule_id}", body: options)
+    end
+
+    # Delete MR Approval Rule for a project
+    #
+    # @example
+    #   Gitlab.delete_project_merge_request_approval_rule(1, 1)
+    #
+    # @param [Integer] project(required) The ID of a project.
+    # @param [Integer] approval_rule_id(required) The ID of a approval rule
+    # @return [void] This API call returns an empty response body
+    def delete_project_merge_request_approval_rule(project, approval_rule_id)
+      delete("/projects/#{url_encode project}/approval_rules/#{approval_rule_id}")
+    end
+
     # Change allowed approvers and approver groups for a project
     #
     # @example
@@ -109,5 +165,17 @@ class Gitlab::Client
     def unapprove_merge_request(project, merge_request, options = {})
       post("/projects/#{url_encode project}/merge_requests/#{merge_request}/unapprove", body: options)
     end
+
+    # Get the approval state of merge requests
+    #
+    # @example
+    #   Gitlab.merge_request_approval_state(5, 36)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of a merge request.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def merge_request_approval_state(project, id)
+      get("/projects/#{url_encode project}/merge_requests/#{id}/approval_state")
+    end
   end
 end

data/lib/gitlab/client/merge_requests.rb

@@ -35,12 +35,16 @@ class Gitlab::Client
     #
     # @example
     #   Gitlab.merge_request(5, 36)
+    #   Gitlab.merge_request(5, 36, { include_diverged_commits_count: true })
     #
     # @param  [Integer, String] project The ID or name of a project.
     # @param  [Integer] id The ID of a merge request.
+    # @option options [Boolean] :render_html If true response includes rendered HTML for title and description.
+    # @option options [Boolean] :include_diverged_commits_count If true response includes the commits behind the target branch.
+    # @option options [Boolean] :include_rebase_in_progress If true response includes whether a rebase operation is in progress.
     # @return <Gitlab::ObjectifiedHash]
-    def merge_request(project, id)
-      get("/projects/#{url_encode project}/merge_requests/#{id}")
+    def merge_request(project, id, options = {})
+      get("/projects/#{url_encode project}/merge_requests/#{id}", query: options)
     end
 
     # Gets a list of merge request pipelines.
@@ -81,8 +85,14 @@ class Gitlab::Client
     # @option options [String] :source_branch (required) The source branch name.
     # @option options [String] :target_branch (required) The target branch name.
     # @option options [Integer] :assignee_id (optional) The ID of a user to assign merge request.
+    # @option options [Array<Integer>] :assignee_ids (optional) The ID of the user(s) to assign the MR to. Set to 0 or provide an empty value to unassign all assignees.
+    # @option options [String] :description (optional) Description of MR. Limited to 1,048,576 characters.
     # @option options [Integer] :target_project_id (optional) The target project ID.
     # @option options [String] :labels (optional) Labels as a comma-separated list.
+    # @option options [Integer] :milestone_id (optional) The global ID of a milestone
+    # @option options [Boolean] :remove_source_branch (optional) Flag indicating if a merge request should remove the source branch when merging
+    # @option options [Boolean] :allow_collaboration (optional) Allow commits from members who can merge to the target branch
+    # @option options [Boolean] :squash (optional) Squash commits into a single commit when merging
     # @return [Gitlab::ObjectifiedHash] Information about created merge request.
     def create_merge_request(project, title, options = {})
       body = { title: title }.merge(options)
@@ -115,7 +125,12 @@ class Gitlab::Client
     # @param  [Integer, String] project The ID or name of a project.
     # @param  [Integer] id The ID of a merge request.
     # @param  [Hash] options A customizable set of options.
-    # @option options [String] :merge_commit_message Custom merge commit message
+    # @option options [String] :merge_commit_message(optional) Custom merge commit message
+    # @option options [String] :squash_commit_message(optional) Custom squash commit message
+    # @option options [Boolean] :squash(optional) if true the commits will be squashed into a single commit on merge
+    # @option options [Boolean] :should_remove_source_branch(optional) if true removes the source branch
+    # @option options [Boolean] :merge_when_pipeline_succeeds(optional) if true the MR is merged when the pipeline succeeds
+    # @option options [String] :sha(optional) if present, then this SHA must match the HEAD of the source branch, otherwise the merge will fail
     # @return [Gitlab::ObjectifiedHash] Information about updated merge request.
     def accept_merge_request(project, id, options = {})
       put("/projects/#{url_encode project}/merge_requests/#{id}/merge", body: options)

data/lib/gitlab/client/notes.rb

@@ -60,6 +60,20 @@ class Gitlab::Client
     end
     alias merge_request_comments merge_request_notes
 
+    # Gets a list of notes for an epic.
+    #
+    # @example
+    #   Gitlab.epic_notes(5, 10)
+    #
+    # @param [Integer] project The ID of a group.
+    # @param [Integer] epic The ID of an epic.
+    # @option options [Integer] :page The page number.
+    # @option options [Integer] :per_page The number of results per page.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def epic_notes(group, epic, options = {})
+      get("/groups/#{url_encode group}/epics/#{epic}/notes", query: options)
+    end
+
     # Gets a single wall note.
     #
     # @example
@@ -162,6 +176,19 @@ class Gitlab::Client
     end
     alias create_merge_request_comment create_merge_request_note
 
+    # Creates a new epic note.
+    #
+    # @example
+    #   Gitlab.create_epic_note(6, 1, 'Adding a note to my epic.')
+    #
+    # @param  [Integer, String] group The ID or name of a group.
+    # @param  [Integer] epic The ID of an epic.
+    # @param  [String] body The body of a note.
+    # @return [Gitlab::ObjectifiedHash] Information about created note.
+    def create_epic_note(group, epic, body)
+      post("/groups/#{url_encode group}/epics/#{epic}/notes", body: { body: body })
+    end
+
     # Deletes a wall note.
     #
     # @example

data/lib/gitlab/client/pipeline_schedules.rb

@@ -44,7 +44,7 @@ class Gitlab::Client
     # @option options [Boolean] :active The activation of pipeline schedule. If false is set, the pipeline schedule will deactivated initially (default: true).
     # @return [Array<Gitlab::ObjectifiedHash>]
     def create_pipeline_schedule(project, options = {})
-      post("/projects/#{url_encode project}/pipeline_schedules", query: options)
+      post("/projects/#{url_encode project}/pipeline_schedules", body: options)
     end
 
     # Updates the pipeline schedule of a project.
@@ -62,7 +62,7 @@ class Gitlab::Client
     # @option options [Boolean] :active The activation of pipeline schedule. If false is set, the pipeline schedule will deactivated initially (default: true).
     # @return [Array<Gitlab::ObjectifiedHash>] The updated pipeline schedule.
     def edit_pipeline_schedule(project, pipeline_schedule_id, options = {})
-      put("/projects/#{url_encode project}/pipeline_schedules/#{pipeline_schedule_id}", query: options)
+      put("/projects/#{url_encode project}/pipeline_schedules/#{pipeline_schedule_id}", body: options)
     end
 
     # Take ownership of a pipeline schedule.
@@ -101,7 +101,7 @@ class Gitlab::Client
     # @option options [String] :value The value of a variable
     # @return [Array<Gitlab::ObjectifiedHash>] The created pipeline schedule variable.
     def create_pipeline_schedule_variable(project, pipeline_schedule_id, options = {})
-      post("/projects/#{url_encode project}/pipeline_schedules/#{pipeline_schedule_id}/variables", query: options)
+      post("/projects/#{url_encode project}/pipeline_schedules/#{pipeline_schedule_id}/variables", body: options)
     end
 
     # Updates the variable of a pipeline schedule.
@@ -116,7 +116,7 @@ class Gitlab::Client
     # @option options [String] :value The value of a variable.
     # @return [Array<Gitlab::ObjectifiedHash>] The updated pipeline schedule variable.
     def edit_pipeline_schedule_variable(project, pipeline_schedule_id, key, options = {})
-      put("/projects/#{url_encode project}/pipeline_schedules/#{pipeline_schedule_id}/variables/#{url_encode key}", query: options)
+      put("/projects/#{url_encode project}/pipeline_schedules/#{pipeline_schedule_id}/variables/#{url_encode key}", body: options)
     end
 
     # Delete the variable of a pipeline schedule

data/lib/gitlab/client/pipelines.rb

@@ -31,6 +31,18 @@ class Gitlab::Client
       get("/projects/#{url_encode project}/pipelines/#{id}")
     end
 
+    # Gets a single pipeline's test report.
+    #
+    # @example
+    #   Gitlab.pipeline_test_report(5, 36)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of a pipeline.
+    # @return [Gitlab::ObjectifiedHash]
+    def pipeline_test_report(project, id)
+      get("/projects/#{url_encode project}/pipelines/#{id}/test_report")
+    end
+
     # Create a pipeline.
     #
     # @example

data/lib/gitlab/client/projects.rb

@@ -102,6 +102,22 @@ class Gitlab::Client
       get("/projects/#{url_encode project}/members", query: options)
     end
 
+    # Gets a list of all project team members including inherited members.
+    #
+    # @example
+    #   Gitlab.all_members(42)
+    #   Gitlab.all_members('gitlab')
+    #
+    # @param  [Integer, String] project The ID or path of a project.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :query The search query.
+    # @option options [Integer] :page The page number.
+    # @option options [Integer] :per_page The number of results per page.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def all_members(project, options = {})
+      get("/projects/#{url_encode project}/members/all", query: options)
+    end
+
     # Gets a project team member.
     #
     # @example
@@ -519,6 +535,25 @@ class Gitlab::Client
       delete("/projects/#{url_encode id}/star")
     end
 
+    # Get a list of visible projects that the given user has starred.
+    # @see https://docs.gitlab.com/ee/api/projects.html#list-projects-starred-by-a-user
+    #
+    # @example
+    #   Gitlab.user_starred_projects(1)
+    #   Gitlab.user_starred_projects(1, { order_by: 'last_activity_at' })
+    #   Gitlab.user_starred_projects('username', { order_by: 'name', sort: 'asc' })
+    #
+    # @param  [Integer, String] user_id The ID or username of the user.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :per_page Number of projects to return per page
+    # @option options [String] :page The page to retrieve
+    # @option options [String] :order_by Return projects ordered by id, name, path, created_at, updated_at, or last_activity_at fields.
+    # @option options [String] :sort Return projects sorted in asc or desc order.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def user_starred_projects(user_id, options = {})
+      get("/users/#{url_encode user_id}/starred_projects", query: options)
+    end
+
     # Get a list of visible projects for the given user.
     # @see https://docs.gitlab.com/ee/api/projects.html#list-user-projects
     #

data/lib/gitlab/client/resource_state_events.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+class Gitlab::Client
+  # Defines methods related to resource state events.
+  # @see https://docs.gitlab.com/ee/api/resource_state_events.html
+  module ResourceStateEvents
+    # Gets a list of all state events for a single issue.
+    #
+    # @example
+    #   Gitlab.issue_state_events(5, 42)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] issue_iid The IID of an issue.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def issue_state_events(project, issue_iid)
+      get("/projects/#{url_encode project}/issues/#{issue_iid}/resource_state_events")
+    end
+
+    # Returns a single state event for a specific project issue
+    #
+    # @example
+    #   Gitlab.issue_state_event(5, 42, 1)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] issue_iid The IID of an issue.
+    # @param  [Integer] id The ID of a resource event.
+    # @return Gitlab::ObjectifiedHash
+    def issue_state_event(project, issue_iid, id)
+      get("/projects/#{url_encode project}/issues/#{issue_iid}/resource_state_events/#{id}")
+    end
+
+    # Gets a list of all state events for a single merge request.
+    #
+    # @example
+    #   Gitlab.merge_request_state_events(5, 42)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] merge_request_iid The IID of a merge request.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def merge_request_state_events(project, merge_request_iid)
+      get("/projects/#{url_encode project}/merge_requests/#{merge_request_iid}/resource_state_events")
+    end
+
+    # Returns a single state event for a specific project merge request
+    #
+    # @example
+    #   Gitlab.merge_request_state_event(5, 42, 1)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] merge_request_iid The IID of an merge request.
+    # @param  [Integer] id The ID of a state event.
+    # @return Gitlab::ObjectifiedHash
+    def merge_request_state_event(project, merge_request_iid, id)
+      get("/projects/#{url_encode project}/merge_requests/#{merge_request_iid}/resource_state_events/#{id}")
+    end
+  end
+end

data/lib/gitlab/client/runners.rb

@@ -9,11 +9,13 @@ class Gitlab::Client
     #
     # @example
     #   Gitlab.runners
-    #   Gitlab.runners(:active)
-    #   Gitlab.runners(:paused)
+    #   Gitlab.runners(type: 'instance_type', status: 'active')
+    #   Gitlab.runners(tag_list: 'tag1,tag2')
     #
     # @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
+    # @option options [String] :type(optional) The type of runners to show, one of: instance_type, group_type, project_type
+    # @option options [String] :status(optional) The status of runners to show, one of: active, paused, online, offline
+    # @option options [String] :tag_list(optional) List of the runners tags (separated by comma)
     # @return [Array<Gitlab::ObjectifiedHash>]
     def runners(options = {})
       get('/runners', query: options)
@@ -24,9 +26,13 @@ class Gitlab::Client
     #
     # @example
     #   Gitlab.all_runners
+    #   Gitlab.all_runners(type: 'instance_type', status: 'active')
+    #   Gitlab.all_runners(tag_list: 'tag1,tag2')
     #
     # @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
+    # @option options [String] :type(optional) The type of runners to show, one of: instance_type, group_type, project_type
+    # @option options [String] :status(optional) The status of runners to show, one of: active, paused, online, offline
+    # @option options [String] :tag_list(optional) List of the runners tags (separated by comma)
     # @return [Array<Gitlab::ObjectifiedHash>]
     def all_runners(options = {})
       get('/runners/all', query: options)
@@ -50,15 +56,19 @@ class Gitlab::Client
     # @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
+    # @option options [String] :description(optional) The description of a runner
+    # @option options [Boolean] :active(optional) The state of a runner; can be set to true or false
+    # @option options [String] :tag_list(optional) The list of tags for a runner; put array of tags, that should be finally assigned to a runner(separated by comma)
+    # @option options [Boolean] :run_untagged(optional) Flag indicating the runner can execute untagged jobs
+    # @option options [Boolean] :locked(optional) Flag indicating the runner is locked
+    # @option options [String] :access_level(optional) The access_level of the runner; not_protected or ref_protected
+    # @option options [Integer] :maximum_timeout(optional) Maximum timeout set when this runner will handle the job
     # @return <Gitlab::ObjectifiedHash>
     def update_runner(id, options = {})
-      put("/runners/#{id}", query: options)
+      put("/runners/#{id}", body: options)
     end
 
     # Remove a runner.
@@ -68,19 +78,23 @@ class Gitlab::Client
     #   Gitlab.delete_runner(42)
     #
     # @param  [Integer, String] id The ID of a runner
-    # @return <Gitlab::ObjectifiedHash>
+    # @return [nil] This API call returns an empty response body.
     def delete_runner(id)
       delete("/runners/#{id}")
     end
 
-    # Gets a list of Jobs for a Runner
+    # List jobs that are being processed or were processed by specified runner.
     #
     # @example
     #   Gitlab.runner_jobs(1)
+    #   Gitlab.runner_jobs(1, status: 'success')
+    #   Gitlab.runner_jobs(1, sort: 'desc')
     #
     # @param  [Integer] id The ID of a runner.
     # @param  [Hash] options A customizable set of options.
-    # @option options [String] :status Status of the job; one of: running, success, failed, canceled
+    # @option options [String] :status(optional) Status of the job; one of: running, success, failed, canceled
+    # @option options [String] :order_by(optional) Order jobs by id.
+    # @option options [String] :sort(optional) Sort jobs in asc or desc order (default: desc)
     # @return [Array<Gitlab::ObjectifiedHash>]
     def runner_jobs(runner_id, options = {})
       get("/runners/#{url_encode runner_id}/jobs", query: options)
@@ -91,11 +105,17 @@ class Gitlab::Client
     #
     # @example
     #   Gitlab.project_runners(42)
+    #   Gitlab.project_runners(42, type: 'instance_type', status: 'active')
+    #   Gitlab.project_runners(42, tag_list: 'tag1,tag2')
     #
     # @param  [Integer, String] id The ID or name of a project.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :type(optional) The type of runners to show, one of: instance_type, group_type, project_type
+    # @option options [String] :status(optional) The status of runners to show, one of: active, paused, online, offline
+    # @option options [String] :tag_list(optional) List of the runners tags (separated by comma)
     # @return [Array<Gitlab::ObjectifiedHash>]
-    def project_runners(project_id)
-      get("/projects/#{url_encode project_id}/runners")
+    def project_runners(project_id, options = {})
+      get("/projects/#{url_encode project_id}/runners", query: options)
     end
 
     # Enable an available specific runner in the project.
@@ -125,21 +145,39 @@ class Gitlab::Client
       delete("/projects/#{url_encode id}/runners/#{runner_id}")
     end
 
+    # List all runners (specific and shared) available in the group as well its ancestor groups. Shared runners are listed if at least one shared runner is defined.
+    # @see https://docs.gitlab.com/ee/api/runners.html#list-groups-runners
+    #
+    # @example
+    #   Gitlab.group_runners(9)
+    #   Gitlab.group_runners(9, type: 'instance_type', status: 'active')
+    #   Gitlab.group_runners(9, tag_list: 'tag1,tag2')
+    #
+    # @param  [Integer, String] id The ID or name of a project.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :type(optional) The type of runners to show, one of: instance_type, group_type, project_type
+    # @option options [String] :status(optional) The status of runners to show, one of: active, paused, online, offline
+    # @option options [String] :tag_list(optional) List of the runners tags (separated by comma)
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def group_runners(group, options = {})
+      get("/groups/#{url_encode group}/runners", query: options)
+    end
+
     # Register a new Runner for the instance.
     #
     # @example
     #   Gitlab.register_runner('9142c16ea169eaaea3d752313a434a6e')
     #   Gitlab.register_runner('9142c16ea169eaaea3d752313a434a6e', description: 'Some Description', active: true, locked: false)
     #
-    # @param  [String] token Registration token.
+    # @param  [String] token(required) Registration token.
     # @param  [Hash] options A customizable set of options.
-    # @option options [String] :description Runner description.
-    # @option options [Hash] :info Runner metadata.
-    # @option options [Boolean] :active Whether the Runner is active.
-    # @option options [Boolean] :locked Whether the Runner should be locked for current project.
-    # @option options [Boolean] :run_untagged Whether the Runner should handle untagged jobs.
-    # @option options [Array<String>] :tag_list List of Runner tags.
-    # @option options [Integer] :maximum_timeout Maximum timeout set when this Runner will handle the job.
+    # @option options [String] :description(optional) Runner description.
+    # @option options [Hash] :info(optional) Runner metadata.
+    # @option options [Boolean] :active(optional) Whether the Runner is active.
+    # @option options [Boolean] :locked(optional) Whether the Runner should be locked for current project.
+    # @option options [Boolean] :run_untagged(optional) Whether the Runner should handle untagged jobs.
+    # @option options [Array<String>] :tag_list(optional) List of Runner tags.
+    # @option options [Integer] :maximum_timeout(optional) Maximum timeout set when this Runner will handle the job.
     # @return <Gitlab::ObjectifiedHash> Response against runner registration
     def register_runner(token, options = {})
       body = { token: token }.merge(options)