gitlab 4.16.1 → 4.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 797a89bf7bdc146d8381fcf6a6bada7909b70d694f5b9b5c4a7781c69396a6d7
-  data.tar.gz: d564a8c8d0840f7ed4517f39d17b8a9a8138079b1fbbc7b9576de4b7159626e0
+  metadata.gz: 3265eea0b2b8d118d2a8dc9e135a1e5eac505072d2291afeab157902c4d7d50c
+  data.tar.gz: a99c3230eb2d20f4c6f8ff198351944698a7a554632b5252646962371cc6885c
 SHA512:
-  metadata.gz: abb59a55e8a113155818e1531bb4c22578b27a520ac1bea7d9f932a49c8d7be8c0ee4d3e3f42cc5ee870a143553aae3192dc693c7ad8c74b2d7079c6c85cb94e
-  data.tar.gz: c48dc657cf576f747c8a1153114b72681a4c6a5285259a7ef0534a8afdd85c67907dca98c63c1d6450d7766c9692879365b0411985574a570ce209b533a90a91
+  metadata.gz: c115e9436d6214665e17c66e74e80730180bfb92e41b33dbc63c91c7de4d80883e7b0f0c8e27d806ac55c816640463219f12ff53ed4278cce7141b0e5ec72399
+  data.tar.gz: 3297df4d90a5de774d532c8ebf349a9b60907c110810bb4a258ae326376cbb4810231dbc1203e3743ddf9e81b97d869bed1952f59235c1d8ccf01bb9c3ea8be1

data/README.md

@@ -27,7 +27,7 @@ gem 'gitlab'
 # gem 'gitlab', github: 'NARKOZ/gitlab'
 ```
 
-Mac OS users can install using Homebrew:
+Mac OS users can install using Homebrew (may not be the latest version):
 
 ```sh
 brew install gitlab-gem

data/lib/gitlab/api.rb

@@ -10,6 +10,7 @@ module Gitlab
 
     # Creates a new API.
     # @raise [Error:MissingCredentials]
+    # rubocop:disable Lint/MissingSuper
     def initialize(options = {})
       options = Gitlab.options.merge(options)
       (Configuration::VALID_OPTIONS_KEYS + [:auth_token]).each do |key|
@@ -18,5 +19,6 @@ module Gitlab
       request_defaults(sudo)
       self.class.headers 'User-Agent' => user_agent
     end
+    # rubocop:enable Lint/MissingSuper
   end
 end

data/lib/gitlab/cli.rb

@@ -17,10 +17,10 @@ class Gitlab::CLI
   # @param [Array] args The command and it's optional arguments.
   def self.start(args)
     command = begin
-                args.shift.strip
-              rescue StandardError
-                'help'
-              end
+      args.shift.strip
+    rescue StandardError
+      'help'
+    end
     run(command, args)
   end
 

data/lib/gitlab/cli_helpers.rb

@@ -111,7 +111,7 @@ class Gitlab::CLI
       else
         hash_result = case data
                       when Gitlab::ObjectifiedHash, Gitlab::FileResponse
-                        record_hash([data], cmd, args, true)
+                        record_hash([data], cmd, args, single_value: true)
                       when Gitlab::PaginatedResponse
                         record_hash(data, cmd, args)
                       else
@@ -162,7 +162,7 @@ class Gitlab::CLI
     # @param  [Array]  args         Options passed to the API call
     # @param  [bool]   single_value If set to true, a single result should be returned
     # @return [Hash]   Result hash
-    def record_hash(data, cmd, args, single_value = false)
+    def record_hash(data, cmd, args, single_value: false)
       if data.empty?
         result = nil
       else

data/lib/gitlab/client.rb

@@ -23,6 +23,7 @@ module Gitlab
     include Epics
     include Events
     include Features
+    include GroupBadges
     include GroupBoards
     include GroupLabels
     include GroupMilestones
@@ -52,6 +53,7 @@ module Gitlab
     include RepositoryFiles
     include RepositorySubmodules
     include ResourceLabelEvents
+    include ResourceStateEvents
     include Runners
     include Search
     include Services
@@ -80,7 +82,7 @@ module Gitlab
     #
     # @return [String]
     def url_encode(url)
-      url.to_s.b.gsub(/[^a-zA-Z0-9_\-.~]/n) { |m| sprintf('%%%02X', m.unpack1('C')) } # rubocop:disable Style/FormatString, Style/FormatStringToken
+      url.to_s.b.gsub(/[^a-zA-Z0-9_\-.~]/n) { |m| sprintf('%%%02X', m.unpack1('C')) } # rubocop:disable Style/FormatString
     end
 
     private

data/lib/gitlab/client/commits.rb

@@ -59,9 +59,30 @@ class Gitlab::Client
     # @param  [Integer, String] project The ID or name of a project.
     # @param  [String] sha The commit hash or name of a repository branch or tag
     # @param  [String] branch The name of the branch
+    # @param  [Hash] options A customizable set of options.
+    # @option options [Boolean] :dry_run Don't commit any changes
     # @return [Gitlab::ObjectifiedHash]
-    def cherry_pick_commit(project, sha, branch)
-      post("/projects/#{url_encode project}/repository/commits/#{sha}/cherry_pick", body: { branch: branch })
+    def cherry_pick_commit(project, sha, branch, options = {})
+      options[:branch] = branch
+
+      post("/projects/#{url_encode project}/repository/commits/#{sha}/cherry_pick", body: options)
+    end
+
+    # Reverts a commit in a given branch.
+    #
+    # @example
+    #   Gitlab.revert_commit(42, '6104942438c14ec7bd21c6cd5bd995272b3faff6', 'master')
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [String] sha The commit hash or name of a repository branch or tag
+    # @param  [String] branch The name of the branch
+    # @param  [Hash] options A customizable set of options.
+    # @option options [Boolean] :dry_run Don't commit any changes
+    # @return [Gitlab::ObjectifiedHash]
+    def revert_commit(project, sha, branch, options = {})
+      options[:branch] = branch
+
+      post("/projects/#{url_encode project}/repository/commits/#{sha}/revert", body: options)
     end
 
     # Get the diff of a commit in a project.
@@ -145,7 +166,7 @@ class Gitlab::Client
     # @option options [String] :name Filter by status name, eg. jenkins
     # @option options [String] :target_url The target URL to associate with this status
     def update_commit_status(project, sha, state, options = {})
-      post("/projects/#{url_encode project}/statuses/#{sha}", query: options.merge(state: state))
+      post("/projects/#{url_encode project}/statuses/#{sha}", body: options.merge(state: state))
     end
     alias repo_update_commit_status update_commit_status
 

data/lib/gitlab/client/container_registry.rb

@@ -79,7 +79,7 @@ class Gitlab::Client
     # @option options [String] :older_than(required) Tags to delete that are older than the given time, written in human readable form 1h, 1d, 1month.
     # @return [void] This API call returns an empty response body.
     def bulk_delete_registry_repository_tags(project, repository_id, options = {})
-      delete("/projects/#{url_encode project}/registry/repositories/#{repository_id}/tags", query: options)
+      delete("/projects/#{url_encode project}/registry/repositories/#{repository_id}/tags", body: options)
     end
   end
 end

data/lib/gitlab/client/group_badges.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+class Gitlab::Client
+  # Defines methods related to group badges.
+  # @see https://docs.gitlab.com/ee/api/group_badges.html
+  module GroupBadges
+    # Gets a list of a groups badges.
+    #
+    # @example
+    #   Gitlab.group_badges(5)
+    #   Gitlab.group_badges(5, 'Coverage')
+    #
+    # @param [Integer, String] group(required) The ID or URL-encoded path of the group owned by the authenticated user.
+    # @param [String] name(optional) Name of the badges to return (case-sensitive).
+    # @return [Array<Gitlab::ObjectifiedHash>] List of all badges of a group
+    def group_badges(group, name = nil)
+      query = { name: name } if name
+      get("/groups/#{url_encode group}/badges", query: query)
+    end
+
+    # Gets a badge of a group.
+    #
+    # @example
+    #   Gitlab.group_badge(5, 42)
+    #
+    # @param [Integer, String] group(required) The ID or URL-encoded path of the group owned by the authenticated user.
+    # @param [Integer] badge_id(required) The badge ID.
+    # @return [Gitlab::ObjectifiedHash] Information about the requested badge
+    def group_badge(group, badge_id)
+      get("/groups/#{url_encode group}/badges/#{badge_id}")
+    end
+
+    # Adds a badge to a group.
+    #
+    # @example
+    #   Gitlab.add_group_badge(5, { link_url: 'https://abc.com/gitlab/gitlab-ce/commits/master', image_url: 'https://shields.io/my/badge1' })
+    #
+    # @param [Integer, String] group(required) The ID or URL-encoded path of the group owned by the authenticated user.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :link_url(required) URL of the badge link
+    # @option options [String] :image_url(required) URL of the badge image
+    # @return [Gitlab::ObjectifiedHash] Information about the added group badge.
+    def add_group_badge(group, options = {})
+      post("/groups/#{url_encode group}/badges", body: options)
+    end
+
+    # Updates a badge of a group.
+    #
+    # @example
+    #   Gitlab.edit_group_badge(5, 1, { link_url: 'https://abc.com/gitlab/gitlab-ce/commits/master', image_url: 'https://shields.io/my/badge1' })
+    #
+    # @param [Integer, String] group(required) The ID or URL-encoded path of the group owned by the authenticated user.
+    # @param [Integer] badge_id(required) The badge ID.
+    # @param [Hash] options A customizable set of options.
+    # @option options [String] :link_url(optional) URL of the badge link
+    # @option options [String] :image_url(optional) URL of the badge image
+    # @return [Gitlab::ObjectifiedHash] Information about the updated group badge.
+    def edit_group_badge(group, badge_id, options = {})
+      put("/groups/#{url_encode group}/badges/#{badge_id}", body: options)
+    end
+
+    # Removes a badge from a group.
+    #
+    # @example
+    #   Gitlab.remove_group_badge(5, 42)
+    #
+    # @param [Integer, String] group(required) The ID or URL-encoded path of the group owned by the authenticated user.
+    # @param [Integer] badge_id(required) The badge ID.
+    # @return [nil] This API call returns an empty response body.
+    def remove_group_badge(group, badge_id)
+      delete("/groups/#{url_encode group}/badges/#{badge_id}")
+    end
+
+    # Preview a badge from a group.
+    #
+    # @example
+    #   Gitlab.preview_group_badge(3, 'https://abc.com/gitlab/gitlab-ce/commits/master', 'https://shields.io/my/badge1')
+    #
+    # @param [Integer, String] group(required) The ID or URL-encoded path of the group owned by the authenticated user.
+    # @param [String] :link_url(required) URL of the badge link
+    # @param [String] :image_url(required) URL of the badge image
+    # @return [Gitlab::ObjectifiedHash] Returns how the link_url and image_url final URLs would be after resolving the placeholder interpolation.
+    def preview_group_badge(group, link_url, image_url)
+      query = { link_url: link_url, image_url: image_url }
+      get("/groups/#{url_encode group}/badges/render", query: query)
+    end
+  end
+end

data/lib/gitlab/client/group_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_group_label(group, name)
-      delete("/groups/#{url_encode group}/labels", body: { name: name })
+      delete("/groups/#{url_encode group}/labels/#{name}")
     end
 
     # Subscribes the user to a group label to receive notifications

data/lib/gitlab/client/groups.rb

@@ -71,6 +71,21 @@ class Gitlab::Client
       get("/groups/#{url_encode id}/members", query: options)
     end
 
+    # Get a list of group members that are billable.
+    #
+    # @example
+    #   Gitlab.group_billable_members(1)
+    #   Gitlab.group_billable_members(1, { per_page: 40 })
+    #
+    # @param  [Integer] id The ID of a group.
+    # @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 group_billable_members(id, options = {})
+      get("/groups/#{url_encode id}/billable_members", query: options)
+    end
+
     # Get details of a single group member.
     #
     # @example

data/lib/gitlab/client/jobs.rb

@@ -36,6 +36,21 @@ class Gitlab::Client
       get("/projects/#{url_encode project_id}/pipelines/#{pipeline_id}/jobs", query: options)
     end
 
+    # Gets a list of Bridge Jobs from a pipeline
+    #
+    # @example
+    #   Gitlab.pipeline_bridges(1, 2)
+    #   Gitlab.pipeline_bridges("project", 2)
+    #
+    # @param  [Integer, String] The ID or name of a project.
+    # @param  [Integer]  the id of the pipeline
+    # @param  [Hash] options A customizable set of options.
+    # @option options [Array] :scope The scope of bridge jobs to show, one or array of: created, pending, running, failed, success, canceled, skipped, manual; showing all bridge jobs if none provided.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def pipeline_bridges(project_id, pipeline_id, options = {})
+      get("/projects/#{url_encode project_id}/pipelines/#{pipeline_id}/bridges", query: options)
+    end
+
     # Gets a single job
     #
     # @example
@@ -70,16 +85,70 @@ class Gitlab::Client
     #   Gitlab.job_artifacts_download(1, "master", "release")
     #   Gitlab.job_artifacts_download("project", "master", "release")
     #
-    # @param  [Integer, String] id, The ID or name of a project.
-    # @param  [String]  ref, Ref Name
-    # @param  [String]  job, jobname
-    # @return [Array<Gitlab::ObjectifiedHash>]
+    # @param  [Integer, String] project_id The ID or name of a project.
+    # @param  [String]  ref Ref Name
+    # @param  [String]  job jobname
+    # @return [Gitlab::FileResponse]
     def job_artifacts_download(project_id, ref_name, job_name)
-      get("/projects/#{url_encode project_id}/jobs/artifacts/#{ref_name}/download", query: { job: job_name },
-                                                                                    format: nil,
-                                                                                    headers: { Accept: 'text/plain' },
-                                                                                    parser: ::Gitlab::Request::Parser)
+      get("/projects/#{url_encode project_id}/jobs/artifacts/#{ref_name}/download",
+          query: { job: job_name },
+          format: nil,
+          headers: { Accept: 'application/octet-stream' },
+          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
+
+    # Download a single artifact file by job ID
+    #
+    # @example
+    #   Gitlab.download_job_artifact_file(1, 5, "some/release/file.pdf")
+    #
+    # @param  [Integer, String] project_id(required) The ID or name of a project.
+    # @param  [String]  job_id(required) The unique job identifier.
+    # @param  [String]  artifact_path(required) Path to a file inside the artifacts archive.
+    # @return [Gitlab::FileResponse]
+    def download_job_artifact_file(project_id, job_id, artifact_path)
+      get("/projects/#{url_encode project_id}/jobs/#{job_id}/artifacts/#{artifact_path}",
+          format: nil,
+          headers: { Accept: 'application/octet-stream' },
+          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
+
+    # Download a single artifact file from specific tag or branch
+    #
+    # @example
+    #   Gitlab.download_branch_artifact_file(1, "master", "some/release/file.pdf", 'pdf')
+    #
+    # @param  [Integer, String] project_id(required) The ID or name of a project.
+    # @param  [String]  ref_name(required) Branch or tag name in repository. HEAD or SHA references are not supported.
+    # @param  [String]  artifact_path(required) Path to a file inside the artifacts archive.
+    # @param  [String]  job(required) The name of the job.
+    # @return [Gitlab::FileResponse]
+    def download_branch_artifact_file(project_id, ref_name, artifact_path, job)
+      get("/projects/#{url_encode project_id}/jobs/artifacts/#{ref_name}/raw/#{artifact_path}",
+          query: { job: job },
+          format: nil,
+          headers: { Accept: 'application/octet-stream' },
+          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
+    alias download_tag_artifact_file download_branch_artifact_file
 
     # Get Job Trace
     #

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/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)

data/lib/gitlab/error.rb

@@ -34,6 +34,17 @@ module Gitlab
         @response.parsed_response.message
       end
 
+      # Additional error context returned by some API endpoints
+      #
+      # @return [String]
+      def error_code
+        if @response.respond_to?(:error_code)
+          @response.error_code
+        else
+          ''
+        end
+      end
+
       private
 
       # Human friendly message.

data/lib/gitlab/help.rb

@@ -74,14 +74,14 @@ module Gitlab::Help
     # Returns full namespace of a command (e.g. Gitlab::Client::Branches.cmd)
     def namespace(cmd)
       method_owners.select { |method| method[:name] == cmd }
-                   .map { |method| method[:owner] + '.' + method[:name] }
+                   .map { |method| "#{method[:owner]}.#{method[:name]}" }
                    .shift
     end
 
     # Massage output from 'ri'.
     def change_help_output!(cmd, output_str)
       output_str = +output_str
-      output_str.gsub!(/#{cmd}\((.*?)\)/m, cmd + ' \1')
+      output_str.gsub!(/#{cmd}\((.*?)\)/m, "#{cmd} \1")
       output_str.gsub!(/,\s*/, ' ')
 
       # Ensure @option descriptions are on a single line

data/lib/gitlab/paginated_response.rb

@@ -43,17 +43,17 @@ module Gitlab
     end
 
     def lazy_paginate
-      to_enum(:each_page).lazy.flat_map(&:to_ary)
+      to_enum(:each_page).lazy.flat_map(&:to_ary) # rubocop:disable Lint/ToEnumArguments
     end
 
     def auto_paginate(&block)
-      return lazy_paginate.to_a unless block_given?
+      return lazy_paginate.to_a unless block
 
       lazy_paginate.each(&block)
     end
 
     def paginate_with_limit(limit, &block)
-      return lazy_paginate.take(limit).to_a unless block_given?
+      return lazy_paginate.take(limit).to_a unless block
 
       lazy_paginate.take(limit).each(&block)
     end

data/lib/gitlab/request.rb

@@ -25,8 +25,6 @@ module Gitlab
         true
       elsif !body
         false
-      elsif body.nil?
-        false
       else
         raise Error::Parsing, "Couldn't parse a response body"
       end

data/lib/gitlab/shell_history.rb

@@ -42,10 +42,10 @@ class Gitlab::Shell
       File.expand_path(@file_path)
     end
 
-    def read_from_file
+    def read_from_file(&block)
       path = history_file_path
 
-      File.foreach(path) { |line| yield(line) } if File.exist?(path)
+      File.foreach(path, &block) if File.exist?(path)
     rescue StandardError => e
       warn "History file not loaded: #{e.message}"
     end

data/lib/gitlab/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Gitlab
-  VERSION = '4.16.1'
+  VERSION = '4.17.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gitlab
 version: !ruby/object:Gem::Version
-  version: 4.16.1
+  version: 4.17.0
 platform: ruby
 authors:
 - Nihad Abbasov
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-12 00:00:00.000000000 Z
+date: 2020-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -17,20 +17,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: '0.18'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: '0.18'
 - !ruby/object:Gem::Dependency
   name: terminal-table
   requirement: !ruby/object:Gem::Requirement
@@ -128,6 +122,7 @@ files:
 - lib/gitlab/client/epics.rb
 - lib/gitlab/client/events.rb
 - lib/gitlab/client/features.rb
+- lib/gitlab/client/group_badges.rb
 - lib/gitlab/client/group_boards.rb
 - lib/gitlab/client/group_labels.rb
 - lib/gitlab/client/group_milestones.rb
@@ -157,6 +152,7 @@ files:
 - lib/gitlab/client/repository_files.rb
 - lib/gitlab/client/repository_submodules.rb
 - lib/gitlab/client/resource_label_events.rb
+- lib/gitlab/client/resource_state_events.rb
 - lib/gitlab/client/runners.rb
 - lib/gitlab/client/search.rb
 - lib/gitlab/client/services.rb
@@ -200,7 +196,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: A Ruby wrapper and CLI for the GitLab API