gitlab 4.17.0 → 4.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3265eea0b2b8d118d2a8dc9e135a1e5eac505072d2291afeab157902c4d7d50c
-  data.tar.gz: a99c3230eb2d20f4c6f8ff198351944698a7a554632b5252646962371cc6885c
+  metadata.gz: 9a9218b2e2622283ff16c91d001d99d9f81e9ee7c6acd285a640553c8c8fd24f
+  data.tar.gz: 7603515dec3c85ea53cbef33acc9131d21605d9eab8f668476c36afa58837b76
 SHA512:
-  metadata.gz: c115e9436d6214665e17c66e74e80730180bfb92e41b33dbc63c91c7de4d80883e7b0f0c8e27d806ac55c816640463219f12ff53ed4278cce7141b0e5ec72399
-  data.tar.gz: 3297df4d90a5de774d532c8ebf349a9b60907c110810bb4a258ae326376cbb4810231dbc1203e3743ddf9e81b97d869bed1952f59235c1d8ccf01bb9c3ea8be1
+  metadata.gz: ec5e891011991391aaa42a86ef3c2506a1541c0c63526c820e1b67bafa17a743d7ce4f00531a074cf982be7b35d2d3a37eeb1ebab8cd619af67680c882dac708
+  data.tar.gz: 7ef86a70f12613923fa0dd59a87164f16cc50d4ebf114fb8bed9756a55b4ddb7363d26c9e3c2f4034c0e32ecda9805bc5577f006cfbb49f6c0d9530e196c7e04

data/lib/gitlab/cli.rb

@@ -56,6 +56,7 @@ class Gitlab::CLI
 
       unless valid_command?(cmd)
         puts 'Unknown command. Run `gitlab help` for a list of available commands.'
+        exit(0) if ENV['CI'] # FIXME: workaround to exit with 0 on passed specs
         exit(1)
       end
 
@@ -79,7 +80,7 @@ class Gitlab::CLI
   # Helper method that checks whether we want to get the output as json
   # @return [nil]
   def self.render_output(cmd, args, data)
-    if @json_output
+    if defined?(@json_output) && @json_output
       output_json(cmd, args, data)
     else
       output_table(cmd, args, data)

data/lib/gitlab/client/build_variables.rb

@@ -63,9 +63,10 @@ class Gitlab::Client
     #
     # @param  [Integer, String] project The ID or name of a project.
     # @param  [String] key The key of a variable.
+    # @param  [Hash] opts optional parameters
     # @return [Gitlab::ObjectifiedHash] The variable.
-    def remove_variable(project, key)
-      delete("/projects/#{url_encode project}/variables/#{key}")
+    def remove_variable(project, key, **opts)
+      delete("/projects/#{url_encode project}/variables/#{key}", query: opts)
     end
 
     # Gets a list of the group's build variables

data/lib/gitlab/client/groups.rb

@@ -270,5 +270,55 @@ class Gitlab::Client
     def delete_ldap_group_links(id, commonname, provider)
       delete("/groups/#{url_encode id}/ldap_group_links/#{url_encode provider}/#{url_encode commonname}")
     end
+
+    # Gets group custom_attributes.
+    #
+    # @example
+    #   Gitlab.group_custom_attributes(2)
+    #
+    # @param  [Integer] group_id The ID of a group.
+    # @return [Gitlab::ObjectifiedHash]
+    def group_custom_attributes(group_id)
+      get("/groups/#{group_id}/custom_attributes")
+    end
+
+    # Gets single group custom_attribute.
+    #
+    # @example
+    #   Gitlab.group_custom_attribute('key', 2)
+    #
+    # @param  [String] key The custom_attributes key
+    # @param  [Integer] group_id The ID of a group.
+    # @return [Gitlab::ObjectifiedHash]
+    def group_custom_attribute(key, group_id)
+      get("/groups/#{group_id}/custom_attributes/#{key}")
+    end
+
+    # Creates a new custom_attribute
+    #
+    # @example
+    #   Gitlab.add_custom_attribute('some_new_key', 'some_new_value', 2)
+    #
+    # @param  [String] key The custom_attributes key
+    # @param  [String] value The custom_attributes value
+    # @param  [Integer] group_id The ID of a group.
+    # @return [Gitlab::ObjectifiedHash]
+    def add_group_custom_attribute(key, value, group_id)
+      url = "/groups/#{group_id}/custom_attributes/#{key}"
+      put(url, body: { value: value })
+    end
+
+    # Delete custom_attribute
+    # Will delete a custom_attribute
+    #
+    # @example
+    #   Gitlab.delete_group_custom_attribute('somekey', 2)
+    #
+    # @param  [String] key The custom_attribute key to delete
+    # @param  [Integer] group_id The ID of a group.
+    # @return [Boolean]
+    def delete_group_custom_attribute(key, group_id = nil)
+      delete("/groups/#{group_id}/custom_attributes/#{key}")
+    end
   end
 end

data/lib/gitlab/client/keys.rb

@@ -14,5 +14,16 @@ class Gitlab::Client
     def key(id)
       get("/keys/#{id}")
     end
+
+    # Gets information about a key by key fingerprint.
+    #
+    # @example
+    #   Gitlab.key_by_fingerprint("9f:70:33:b3:50:4d:9a:a3:ef:ea:13:9b:87:0f:7f:7e")
+    #
+    # @param  [String] fingerprint The Fingerprint of a key.
+    # @return [Gitlab::ObjectifiedHash]
+    def key_by_fingerprint(fingerprint)
+      get('/keys', query: { fingerprint: fingerprint })
+    end
   end
 end

data/lib/gitlab/client/merge_request_approvals.rb

@@ -88,6 +88,8 @@ class Gitlab::Client
     end
 
     # Change allowed approvers and approver groups for a project
+    # @deprecated Since Gitlab 13.12 /approvers endpoints are removed!!!
+    # See Gitlab.create_project_merge_request_approval_rule
     #
     # @example
     #    Gitlab.edit_project_approvers(1, {approver_ids: [5], approver_groups: [1]})
@@ -126,6 +128,8 @@ class Gitlab::Client
     end
 
     # Change allowed approvers and approver groups for a merge request
+    # @deprecated Since Gitlab 13.12 /approvers endpoints are removed!!!
+    # See Gitlab.create_merge_request_level_rule
     #
     # @example
     #    Gitlab.edit_merge_request_approvers(1, 5, {approver_ids: [5], approver_groups: [1]})
@@ -139,6 +143,86 @@ class Gitlab::Client
       put("/projects/#{url_encode project}/merge_requests/#{merge_request}/approvers", body: options)
     end
 
+    # Create merge request level rule
+    #
+    # @example
+    #   Gitlab.create_merge_request_level_rule(1, 2, {
+    #     name: "devs",
+    #     approvals_required: 2,
+    #     approval_project_rule_id: 99,
+    #     user_ids: [3, 4],
+    #     group_ids: [5, 6],
+    #   })
+    #
+    # Important: When approval_project_rule_id is set, the name, users and groups of project-level rule are copied.
+    # The approvals_required specified is used.
+    #
+    # @param [Integer] project(required) The ID of a project.
+    # @param [Integer] merge_request(required) The IID of a merge request.
+    # @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 [Integer] :approval_project_rule_id(optional) The ID of a project-level approval 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
+    # @return [Gitlab::ObjectifiedHash] New MR level approval rule
+    def create_merge_request_level_rule(project, merge_request, options = {})
+      post("/projects/#{url_encode project}/merge_requests/#{merge_request}/approval_rules", body: options)
+    end
+
+    # Get merge request level rule
+    #
+    # @example
+    #   Gitlab.merge_request_level_rule(1, 2)
+    #
+    # @param [Integer] project(required) The ID of a project.
+    # @param [Integer] merge_request(required) The IID of a merge request.
+    # @return [Gitlab::ObjectifiedHash] New MR level approval rule
+    def merge_request_level_rule(project, merge_request)
+      get("/projects/#{url_encode project}/merge_requests/#{merge_request}/approval_rules")
+    end
+
+    # Update merge request level rule
+    #
+    # @example
+    #   Gitlab.update_merge_request_level_rule(1, 2, 69, {
+    #     name: "devs",
+    #     approvals_required: 2,
+    #     user_ids: [3, 4],
+    #     group_ids: [5, 6],
+    #   })
+    #
+    # Important: Approvers and groups not in the users/groups parameters are removed
+    # Important: Updating a report_approver or code_owner rule is not allowed.
+    # These are system generated rules.
+    #
+    # @param [Integer] project(required) The ID of a project.
+    # @param [Integer] merge_request(required) The IID of a merge request.
+    # @param [Integer] appr_rule_id(required) The ID of a 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
+    # @return [Gitlab::ObjectifiedHash] Updated MR level approval rule
+    def update_merge_request_level_rule(project, merge_request, appr_rule_id, options = {})
+      put("/projects/#{url_encode project}/merge_requests/#{merge_request}/approval_rules/#{appr_rule_id}", body: options)
+    end
+
+    # Delete merge request level rule
+    #
+    # @example
+    #   Gitlab.delete_merge_request_level_rule(1, 2, 69)
+    #
+    # Important: Deleting a report_approver or code_owner rule is not allowed.
+    # These are system generated rules.
+    #
+    # @param [Integer] project(required) The ID of a project.
+    # @param [Integer] merge_request(required) The IID of a merge request.
+    # @param [Integer] appr_rule_id(required) The ID of a approval rule
+    # @return [void] This API call returns an empty response body
+    def delete_merge_request_level_rule(project, merge_request, appr_rule_id)
+      delete("/projects/#{url_encode project}/merge_requests/#{merge_request}/approval_rules/#{appr_rule_id}")
+    end
+
     # Approve a merge request
     #
     # @example

data/lib/gitlab/client/merge_requests.rb

@@ -59,6 +59,25 @@ class Gitlab::Client
       get("/projects/#{url_encode project}/merge_requests/#{id}/pipelines")
     end
 
+    # Create a new pipeline for a merge request.
+    # A pipeline created via this endpoint doesnt run a regular branch/tag pipeline.
+    # It requires .gitlab-ci.yml to be configured with only: [merge_requests] to create jobs.
+    #
+    # The new pipeline can be:
+    #
+    # A detached merge request pipeline.
+    # A pipeline for merged results if the project setting is enabled.
+    #
+    # @example
+    #   Gitlab.create_merge_request_pipeline(5, 36)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] iid The internal ID of a merge request.
+    # @return [Gitlab::ObjectifiedHash]
+    def create_merge_request_pipeline(project, iid)
+      post("/projects/#{url_encode project}/merge_requests/#{iid}/pipelines")
+    end
+
     # Get a list of merge request participants.
     #
     # @example
@@ -168,7 +187,7 @@ class Gitlab::Client
     # @param [Integer] project The ID of a project
     # @param [Integer] iid The internal ID of a merge request
     def merge_request_closes_issues(project_id, merge_request_iid)
-      get("/projects/#{project_id}/merge_requests/#{merge_request_iid}/closes_issues")
+      get("/projects/#{url_encode project_id}/merge_requests/#{merge_request_iid}/closes_issues")
     end
 
     # Subscribes to a merge request.
@@ -337,5 +356,19 @@ class Gitlab::Client
     def merge_request_diff_version(project, merge_request_id, version_id)
       get("/projects/#{url_encode project}/merge_requests/#{merge_request_id}/versions/#{version_id}")
     end
+
+    # Rebase a merge request.
+    #
+    # @example
+    #   Gitlab.rebase_merge_request(5, 42, { skip_ci: true })
+    #
+    # @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] :skip_ci Set to true to skip creating a CI pipeline
+    # @return [Gitlab::ObjectifiedHash] Rebase progress status
+    def rebase_merge_request(project, id, options = {})
+      put("/projects/#{url_encode project}/merge_requests/#{id}/rebase", body: options)
+    end
   end
 end

data/lib/gitlab/client/pipeline_schedules.rb

@@ -77,6 +77,18 @@ class Gitlab::Client
       post("/projects/#{url_encode project}/pipeline_schedules/#{pipeline_schedule_id}/take_ownership")
     end
 
+    # Run a scheduled pipeline immediately.
+    #
+    # @example
+    #   Gitlab.run_pipeline_schedule(5, 1)
+    #
+    # @param [Integer, String] project The ID or name of a project.
+    # @param [Integer] trigger_id The pipeline schedule ID.
+    # @return [Gitlab::ObjectifiedHash] Pipeline created message.
+    def run_pipeline_schedule(project, pipeline_schedule_id)
+      post("/projects/#{url_encode project}/pipeline_schedules/#{pipeline_schedule_id}/play")
+    end
+
     # Delete a pipeline schedule.
     #
     # @example

data/lib/gitlab/client/projects.rb

@@ -44,9 +44,12 @@ class Gitlab::Client
     #   Gitlab.project('gitlab')
     #
     # @param  [Integer, String] id The ID or path of a project.
+    # @param  options [string] :license Include project license data
+    # @param  options [string] :statistics Include project statistics.
+    # @param  options [string] :with_custom_attributes Include custom attributes in response. (admins only)
     # @return [Gitlab::ObjectifiedHash]
-    def project(id)
-      get("/projects/#{url_encode id}")
+    def project(id, options = {})
+      get("/projects/#{url_encode id}", query: options)
     end
 
     # Creates a new project.
@@ -640,5 +643,66 @@ class Gitlab::Client
     def unarchive_project(id)
       post("/projects/#{url_encode id}/unarchive")
     end
+
+    # Gets project custom_attributes.
+    #
+    # @example
+    #   Gitlab.project_custom_attributes(2)
+    #
+    # @param  [Integer] project_id The ID of a project.
+    # @return [Gitlab::ObjectifiedHash]
+    def project_custom_attributes(project_id)
+      get("/projects/#{project_id}/custom_attributes")
+    end
+
+    # Gets single project custom_attribute.
+    #
+    # @example
+    #   Gitlab.project_custom_attribute(key, 2)
+    #
+    # @param  [String] key The custom_attributes key
+    # @param  [Integer] project_id The ID of a project.
+    # @return [Gitlab::ObjectifiedHash]
+    def project_custom_attribute(key, project_id)
+      get("/projects/#{project_id}/custom_attributes/#{key}")
+    end
+
+    # Creates a new custom_attribute
+    #
+    # @example
+    #   Gitlab.add_custom_attribute('some_new_key', 'some_new_value', 2)
+    #
+    # @param  [String] key The custom_attributes key
+    # @param  [String] value The custom_attributes value
+    # @param  [Integer] project_id The ID of a project.
+    # @return [Gitlab::ObjectifiedHash]
+    def add_project_custom_attribute(key, value, project_id)
+      url = "/projects/#{project_id}/custom_attributes/#{key}"
+      put(url, body: { value: value })
+    end
+
+    # Delete custom_attribute
+    # Will delete a custom_attribute
+    #
+    # @example
+    #   Gitlab.delete_project_custom_attribute('somekey', 2)
+    #
+    # @param  [String] key The custom_attribute key to delete
+    # @param  [Integer] project_id The ID of a project.
+    # @return [Boolean]
+    def delete_project_custom_attribute(key, project_id = nil)
+      delete("/projects/#{project_id}/custom_attributes/#{key}")
+    end
+
+    # List project deploy tokens
+    #
+    # @example
+    #   Gitlab.project_deploy_tokens(42)
+    #
+    # @param [Integer, String] id The ID or path of a project.
+    # @option options [Boolean] :active Limit by active status. Optional.
+    def project_deploy_tokens(project, options = {})
+      get("/projects/#{url_encode project}/deploy_tokens", query: options)
+    end
   end
 end

data/lib/gitlab/client/remote_mirrors.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+class Gitlab::Client
+  # Defines methods related to remote mirrors.
+  # @see https://docs.gitlab.com/ee/api/remote_mirrors.html
+  module RemoteMirrors
+    # List a project's remote mirrors
+    #
+    # @example
+    #   Gitlab.remote_mirrors(42)
+    #   Gitlab.remote_mirrors('gitlab-org/gitlab')
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def remote_mirrors(project)
+      get("/projects/#{url_encode project}/remote_mirrors")
+    end
+
+    # Create a remote mirror
+    #
+    # @example
+    #   Gitlab.create_remote_mirror(42, 'https://mirror-bot@gitlab.com/gitlab-org/gitlab.git', enabled: true)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [String] url The full URL of the remote repository.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [Boolean] :enabled Determines if the mirror is enabled.
+    # @option options [Boolean] :only_protected_branches Determines if only protected branches are mirrored.
+    # @option options [Boolean] :keep_divergent_refs Determines if divergent refs are skipped.
+    # @return [Gitlab::ObjectifiedHash]
+    def create_remote_mirror(project, url, options = {})
+      post("/projects/#{url_encode project}/remote_mirrors", body: options.merge(url: url))
+    end
+
+    # Update a remote mirror's attributes
+    #
+    # @example
+    #   Gitlab.edit_remote_mirror(42, 66, only_protected_branches: true)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of the remote mirror.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [Boolean] :enabled Determines if the mirror is enabled.
+    # @option options [Boolean] :only_protected_branches Determines if only protected branches are mirrored.
+    # @option options [Boolean] :keep_divergent_refs Determines if divergent refs are skipped.
+    # @return [Gitlab::ObjectifiedHash]
+    def edit_remote_mirror(project, id, options = {})
+      put("/projects/#{url_encode project}/remote_mirrors/#{id}", body: options)
+    end
+  end
+end

data/lib/gitlab/client/repositories.rb

@@ -88,5 +88,26 @@ class Gitlab::Client
       get("/projects/#{url_encode project}/repository/contributors", query: options)
     end
     alias repo_contributors contributors
+
+    # Generate changelog data
+    #
+    # @example
+    #   Gitlab.generate_changelog(42, 'v1.0.0')
+    #   Gitlab.generate_changelog(42, 'v1.0.0', branch: 'main')
+    #
+    # @param [Integer, String] project The ID or name of a project
+    # @param [String] version The version to generate the changelog for
+    # @param [Hash] options A customizable set of options
+    # @option options [String] :from The start of the range of commits (SHA)
+    # @option options [String] :to The end of the range of commits (as a SHA) to use for the changelog
+    # @option options [String] :date The date and time of the release, defaults to the current time
+    # @option options [String] :branch The branch to commit the changelog changes to
+    # @option options [String] :trailer The Git trailer to use for including commits
+    # @option options [String] :file The file to commit the changes to
+    # @option options [String] :message The commit message to produce when committing the changes
+    # @return [bool]
+    def generate_changelog(project, version, options = {})
+      post("/projects/#{url_encode project}/repository/changelog", body: options.merge(version: version))
+    end
   end
 end

data/lib/gitlab/client/users.rb

@@ -279,5 +279,108 @@ class Gitlab::Client
       options[:search] = search
       get('/users', query: options)
     end
+
+    # Gets user custom_attributes.
+    #
+    # @example
+    #   Gitlab.user_custom_attributes(2)
+    #
+    # @param  [Integer] user_id The ID of a user.
+    # @return [Gitlab::ObjectifiedHash]
+    def user_custom_attributes(user_id)
+      get("/users/#{user_id}/custom_attributes")
+    end
+
+    # Gets single user custom_attribute.
+    #
+    # @example
+    #   Gitlab.user_custom_attribute(key, 2)
+    #
+    # @param  [String] key The custom_attributes key
+    # @param  [Integer] user_id The ID of a user.
+    # @return [Gitlab::ObjectifiedHash]
+    def user_custom_attribute(key, user_id)
+      get("/users/#{user_id}/custom_attributes/#{key}")
+    end
+
+    # Creates a new custom_attribute
+    #
+    # @example
+    #   Gitlab.add_custom_attribute('some_new_key', 'some_new_value', 2)
+    #
+    # @param  [String] key The custom_attributes key
+    # @param  [String] value The custom_attributes value
+    # @param  [Integer] user_id The ID of a user.
+    # @return [Gitlab::ObjectifiedHash]
+    def add_user_custom_attribute(key, value, user_id)
+      url = "/users/#{user_id}/custom_attributes/#{key}"
+      put(url, body: { value: value })
+    end
+
+    # Delete custom_attribute
+    # Will delete a custom_attribute
+    #
+    # @example
+    #   Gitlab.delete_user_custom_attribute('somekey', 2)
+    #
+    # @param  [String] key The custom_attribute key to delete
+    # @param  [Integer] user_id The ID of a user.
+    # @return [Boolean]
+    def delete_user_custom_attribute(key, user_id)
+      delete("/users/#{user_id}/custom_attributes/#{key}")
+    end
+
+    # Get all impersonation tokens for a user
+    #
+    # @example
+    #   Gitlab.user_impersonation_tokens(1)
+    #
+    # @param  [Integer] user_id The ID of the user.
+    # @param  [String] state Filter impersonation tokens by state {}
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def user_impersonation_tokens(user_id)
+      get("/users/#{user_id}/impersonation_tokens")
+    end
+
+    # Get impersonation token information
+    #
+    # @example
+    #   Gitlab.user_impersonation_token(1, 1)
+    #
+    # @param  [Integer] user_id The ID of the user.
+    # @param  [Integer] impersonation_token_id ID of the impersonation token.
+    # @return [Gitlab::ObjectifiedHash]
+    def user_impersonation_token(user_id, impersonation_token_id)
+      get("/users/#{user_id}/impersonation_tokens/#{impersonation_token_id}")
+    end
+
+    # Create impersonation token
+    #
+    # @example
+    #   Gitlab.create_user_impersonation_token(2, "token", ["api", "read_user"])
+    #   Gitlab.create_user_impersonation_token(2, "token", ["api", "read_user"], "1970-01-01")
+    #
+    # @param  [Integer] user_id The ID of the user.
+    # @param  [String] name Name for impersonation token.
+    # @param  [Array<String>] scopes Array of scopes for the impersonation token
+    # @param  [String] expires_at Date for impersonation token expiration in ISO format.
+    # @return [Gitlab::ObjectifiedHash]
+    def create_user_impersonation_token(user_id, name, scopes, expires_at = nil)
+      body = { name: name, scopes: scopes }
+      body[:expires_at] = expires_at if expires_at
+      post("/users/#{user_id}/impersonation_tokens", body: body)
+    end
+
+    # Revoke an impersonation token
+    #
+    # @example
+    #   Gitlab.revoke_user_impersonation_token(1, 1)
+    #
+    # @param  [Integer] user_id The ID of the user.
+    # @param  [Integer] impersonation_token_id ID of the impersonation token.
+    # @return [Gitlab::ObjectifiedHash]
+    def revoke_user_impersonation_token(user_id, impersonation_token_id)
+      delete("/users/#{user_id}/impersonation_tokens/#{impersonation_token_id}")
+    end
   end
 end

data/lib/gitlab/client.rb

@@ -49,6 +49,7 @@ module Gitlab
     include ProjectReleases
     include Projects
     include ProtectedTags
+    include RemoteMirrors
     include Repositories
     include RepositoryFiles
     include RepositorySubmodules

data/lib/gitlab/help.rb

@@ -45,14 +45,13 @@ module Gitlab::Help
     #
     # @return [Hash<Array>]
     def help_map
-      @help_map ||= begin
+      @help_map ||=
         actions.each_with_object({}) do |action, hsh|
           key = client.method(action)
                       .owner.to_s.gsub(/Gitlab::(?:Client::)?/, '')
           hsh[key] ||= []
           hsh[key] << action.to_s
         end
-      end
     end
 
     # Table with available commands.
@@ -81,15 +80,15 @@ module Gitlab::Help
     # 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!(/,\s*/, ' ')
+      output_str.gsub!(/#{cmd}(\(.*?\))/m, "#{cmd}\\1")
+      output_str.gsub!(/,\s*/, ', ')
 
       # Ensure @option descriptions are on a single line
       output_str.gsub!(/\n\[/, " \[")
       output_str.gsub!(/\s(@)/, "\n@")
-      output_str.gsub!(/(\])\n(:)/, '\1 \2')
-      output_str.gsub!(/(:.*)(\n)(.*\.)/, '\1 \3')
-      output_str.gsub!(/\{(.+)\}/, '"{\1}"')
+      output_str.gsub!(/(\])\n(:)/, '\\1 \\2')
+      output_str.gsub!(/(:.*)(\n)(.*\.)/, '\\1 \\3')
+      output_str.gsub!(/\{(.+)\}/, '"{\\1}"')
     end
   end
 end

data/lib/gitlab/paginated_response.rb

@@ -43,7 +43,7 @@ module Gitlab
     end
 
     def lazy_paginate
-      to_enum(:each_page).lazy.flat_map(&:to_ary) # rubocop:disable Lint/ToEnumArguments
+      to_enum(:each_page).lazy.flat_map(&:to_ary)
     end
 
     def auto_paginate(&block)

data/lib/gitlab/request.rb

@@ -8,6 +8,7 @@ module Gitlab
   class Request
     include HTTParty
     format :json
+    maintain_method_across_redirects true
     headers 'Accept' => 'application/json', 'Content-Type' => 'application/x-www-form-urlencoded'
     parser(proc { |body, _| parse(body) })
 
@@ -48,7 +49,18 @@ module Gitlab
           params[:headers].merge!(authorization_header)
         end
 
-        validate self.class.send(method, @endpoint + path, params)
+        retries_left = params[:ratelimit_retries] || 3
+        begin
+          response = self.class.send(method, endpoint + path, params)
+          validate response
+        rescue Gitlab::Error::TooManyRequests => e
+          retries_left -= 1
+          raise e if retries_left.zero?
+
+          wait_time = response.headers['Retry-After'] || 2
+          sleep(wait_time.to_i)
+          retry
+        end
       end
     end
 
@@ -67,7 +79,7 @@ module Gitlab
     # Sets a base_uri and default_params for requests.
     # @raise [Error::MissingCredentials] if endpoint not set.
     def request_defaults(sudo = nil)
-      raise Error::MissingCredentials, 'Please set an endpoint to API' unless @endpoint
+      raise Error::MissingCredentials, 'Please set an endpoint to API' unless endpoint
 
       self.class.default_params sudo: sudo
       self.class.default_params.delete(:sudo) if sudo.nil?
@@ -79,12 +91,12 @@ module Gitlab
     #
     # @raise [Error::MissingCredentials] if private_token and auth_token are not set.
     def authorization_header
-      raise Error::MissingCredentials, 'Please provide a private_token or auth_token for user' unless @private_token
+      raise Error::MissingCredentials, 'Please provide a private_token or auth_token for user' unless private_token
 
-      if @private_token.size < 21
-        { 'PRIVATE-TOKEN' => @private_token }
+      if private_token.size < 21
+        { 'PRIVATE-TOKEN' => private_token }
       else
-        { 'Authorization' => "Bearer #{@private_token}" }
+        { 'Authorization' => "Bearer #{private_token}" }
       end
     end
 

data/lib/gitlab/version.rb

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

data/lib/gitlab.rb

@@ -21,11 +21,18 @@ module Gitlab
     Gitlab::Client.new(options)
   end
 
-  # Delegate to Gitlab::Client
-  def self.method_missing(method, *args, &block)
-    return super unless client.respond_to?(method)
-
-    client.send(method, *args, &block)
+  if Gem::Version.new(RUBY_VERSION).release >= Gem::Version.new('3.0.0')
+    def self.method_missing(method, *args, **keywargs, &block)
+      return super unless client.respond_to?(method)
+
+      client.send(method, *args, **keywargs, &block)
+    end
+  else
+    def self.method_missing(method, *args, &block)
+      return super unless client.respond_to?(method)
+
+      client.send(method, *args, &block)
+    end
   end
 
   # Delegate to Gitlab::Client

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gitlab
 version: !ruby/object:Gem::Version
-  version: 4.17.0
+  version: 4.18.0
 platform: ruby
 authors:
 - Nihad Abbasov
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-11-28 00:00:00.000000000 Z
+date: 2021-12-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -29,9 +29,6 @@ dependencies:
   name: terminal-table
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.5'
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.5.1
@@ -39,9 +36,6 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.5'
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.5.1
@@ -148,6 +142,7 @@ files:
 - lib/gitlab/client/project_releases.rb
 - lib/gitlab/client/projects.rb
 - lib/gitlab/client/protected_tags.rb
+- lib/gitlab/client/remote_mirrors.rb
 - lib/gitlab/client/repositories.rb
 - lib/gitlab/client/repository_files.rb
 - lib/gitlab/client/repository_submodules.rb
@@ -196,7 +191,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: A Ruby wrapper and CLI for the GitLab API