gitlab 4.14.0 → 4.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c77e29621138a7c5468d44f3753d6bb7e6ead353b384d2e10ed7230999323651
-  data.tar.gz: 44831812bcb2d53fb7adad0762a7822ba00f0a0dc064afa0ae7a3cc53d9b3eb4
+  metadata.gz: 3265eea0b2b8d118d2a8dc9e135a1e5eac505072d2291afeab157902c4d7d50c
+  data.tar.gz: a99c3230eb2d20f4c6f8ff198351944698a7a554632b5252646962371cc6885c
 SHA512:
-  metadata.gz: bfb8f5b817ce9e73c35de24e28a9d5f98fdcdf2a1071f06cefaa238aec71f7e33eff9b5611f1d7cb0eac33a70baa87410a37536c1015a1d4663392dafb1fcca2
-  data.tar.gz: 937c02a461ec9c6b472542ce4576296afe660c3797533fd6ad0d3dc93b5f78b44809bbdc2acfe1ba800125cb8e26d063a56bceca3b4f62d4bd2bacb95be09fcb
+  metadata.gz: c115e9436d6214665e17c66e74e80730180bfb92e41b33dbc63c91c7de4d80883e7b0f0c8e27d806ac55c816640463219f12ff53ed4278cce7141b0e5ec72399
+  data.tar.gz: 3297df4d90a5de774d532c8ebf349a9b60907c110810bb4a258ae326376cbb4810231dbc1203e3743ddf9e81b97d869bed1952f59235c1d8ccf01bb9c3ea8be1

data/README.md

@@ -1,7 +1,6 @@
 # Gitlab
 
-[![Build Status](https://img.shields.io/travis/NARKOZ/gitlab.svg)](https://travis-ci.org/NARKOZ/gitlab)
-[![Maintainability](https://api.codeclimate.com/v1/badges/2e310b334b1b5db4a7e1/maintainability)](https://codeclimate.com/github/NARKOZ/gitlab)
+[![Build Status](https://img.shields.io/github/workflow/status/NARKOZ/gitlab/CI/master)](https://github.com/NARKOZ/gitlab/actions?query=workflow%3ARuby)
 [![Inline docs](https://inch-ci.org/github/NARKOZ/gitlab.svg)](https://inch-ci.org/github/NARKOZ/gitlab)
 [![Gem version](https://img.shields.io/gem/v/gitlab.svg)](https://rubygems.org/gems/gitlab)
 [![License](https://img.shields.io/badge/license-BSD-red.svg)](https://github.com/NARKOZ/gitlab/blob/master/LICENSE.txt)
@@ -28,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.rb

@@ -42,7 +42,8 @@ module Gitlab
   #
   # @return [Array<Symbol>]
   def self.actions
-    hidden = /endpoint|private_token|auth_token|user_agent|sudo|get|post|put|\Adelete\z|validate|request_defaults|httparty/
+    hidden =
+      /endpoint|private_token|auth_token|user_agent|sudo|get|post|put|\Adelete\z|validate\z|request_defaults|httparty/
     (Gitlab::Client.instance_methods - Object.methods).reject { |e| e[hidden] }
   end
 end

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
@@ -206,14 +206,10 @@ class Gitlab::CLI
 
     # Helper function to call Gitlab commands with args.
     def gitlab_helper(cmd, args = [])
-      begin
-        data = args.any? ? Gitlab.send(cmd, *args) : Gitlab.send(cmd)
-      rescue StandardError => e
-        puts e.message
-        yield if block_given?
-      end
-
-      data
+      args.any? ? Gitlab.send(cmd, *args) : Gitlab.send(cmd)
+    rescue StandardError => e
+      puts e.message
+      yield if block_given?
     end
 
     # Convert a hash (recursively) to use symbol hash keys
@@ -221,11 +217,9 @@ class Gitlab::CLI
     def symbolize_keys(hash)
       if hash.is_a?(Hash)
         hash = hash.each_with_object({}) do |(key, value), new_hash|
-          begin
-            new_hash[key.to_sym] = symbolize_keys(value)
-          rescue NoMethodError
-            raise "Error: cannot convert hash key to symbol: #{key}"
-          end
+          new_hash[key.to_sym] = symbolize_keys(value)
+        rescue NoMethodError
+          raise "Error: cannot convert hash key to symbol: #{key}"
         end
       end
 

data/lib/gitlab/client.rb

@@ -19,9 +19,11 @@ module Gitlab
     include ContainerRegistry
     include Deployments
     include Environments
+    include EpicIssues
     include Epics
     include Events
     include Features
+    include GroupBadges
     include GroupBoards
     include GroupLabels
     include GroupMilestones
@@ -51,6 +53,7 @@ module Gitlab
     include RepositoryFiles
     include RepositorySubmodules
     include ResourceLabelEvents
+    include ResourceStateEvents
     include Runners
     include Search
     include Services
@@ -61,6 +64,7 @@ module Gitlab
     include Templates
     include Todos
     include Users
+    include UserSnippets
     include Versions
     include Wikis
 
@@ -78,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/epic_issues.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+class Gitlab::Client
+  # Defines methods related to issues.
+  # @see https://docs.gitlab.com/ee/api/epic_issues.html
+  module EpicIssues
+    # List issues for an epic.
+    # Gets all issues that are assigned to an epic and the authenticated user has access to..
+    # @example
+    #   Gitlab.epic_issues(5, 7)
+    #   Gitlab.epic_issues(5, 7, { per_page: 40 })
+    #
+    # @param  [Integer, String] group The ID or name of a group.
+    # @param  [Integer] epic The iid of an epic.
+    # @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 epic_issues(group, epic, options = {})
+      get("/groups/#{url_encode group}/epics/#{epic}/issues", query: 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
     #