gitlab 4.18.0 → 4.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a9218b2e2622283ff16c91d001d99d9f81e9ee7c6acd285a640553c8c8fd24f
-  data.tar.gz: 7603515dec3c85ea53cbef33acc9131d21605d9eab8f668476c36afa58837b76
+  metadata.gz: 1f389659769cea087b957d51a996f1cb7de58b26a839b254bd110cef3ea7c8c5
+  data.tar.gz: b33dde60af1a08e93da7e97e12b8ba2715bd2e12f3d857080ef39dc114f42d03
 SHA512:
-  metadata.gz: ec5e891011991391aaa42a86ef3c2506a1541c0c63526c820e1b67bafa17a743d7ce4f00531a074cf982be7b35d2d3a37eeb1ebab8cd619af67680c882dac708
-  data.tar.gz: 7ef86a70f12613923fa0dd59a87164f16cc50d4ebf114fb8bed9756a55b4ddb7363d26c9e3c2f4034c0e32ecda9805bc5577f006cfbb49f6c0d9530e196c7e04
+  metadata.gz: 9577ff13278017671a7c72b5eb41d48de9aac067c5417eddccb0d51ee8c86922c462e4e75d5aeeed22be83827ebdc9678d50ab1d494042849f0f191698826c5c
+  data.tar.gz: 2661411c9b542b36b81ba8629310e75d89e9353a7be9bb7c077ce9ae0d0e649c6d9412edb47ce5709fa76630102307e2b7a55c2c3f380d9535015cb4dce4f69b

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2012-2020 Nihad Abbasov <nihad@42na.in>
+Copyright (c) 2012-2022 Nihad Abbasov <nihad@42na.in>
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

data/README.md

@@ -1,7 +1,6 @@
 # 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)
+[![Build Status](https://img.shields.io/github/actions/workflow/status/NARKOZ/gitlab/ci.yml?branch=master)](https://github.com/NARKOZ/gitlab/actions/workflows/ci.yml)
 [![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)
 
@@ -9,8 +8,7 @@
 [documentation](https://www.rubydoc.info/gems/gitlab/frames) |
 [gitlab-live](https://github.com/NARKOZ/gitlab-live)
 
-Gitlab is a Ruby wrapper and CLI for the [GitLab API](https://docs.gitlab.com/ce/api/README.html).  
-As of version `4.0.0` this gem only supports GitLab API v4.
+Gitlab is a Ruby wrapper and CLI for the [GitLab API](https://docs.gitlab.com/ee/api/index.html).
 
 ## Installation
 
@@ -97,6 +95,10 @@ Gitlab.sudo = 'other_user'
 Gitlab.sudo = nil
 # => nil
 
+# set the private token to an empty string to make unauthenticated API requests
+Gitlab.private_token = ''
+# => ""
+
 # a paginated response
 projects = Gitlab.projects(per_page: 5)
 
@@ -121,8 +123,9 @@ For more information, refer to [documentation](https://www.rubydoc.info/gems/git
 
 It is possible to use this gem as a command line interface to GitLab. In order to make that work you need to set a few environment variables:
 ```sh
-export GITLAB_API_ENDPOINT=https://gitlab.yourcompany.com/api/v4
-export GITLAB_API_PRIVATE_TOKEN=<your private token from /profile/account or /profile/personal_access_tokens in newer version>
+export GITLAB_API_ENDPOINT=https://gitlab.example.com/api/v4
+export GITLAB_API_PRIVATE_TOKEN=<your private token from /profile/personal_access_tokens>
+
 # This one is optional and can be used to set any HTTParty option you may need
 # using YAML hash syntax. For example, this is how you would disable SSL
 # verification (useful if using a self-signed cert).
@@ -131,21 +134,21 @@ export GITLAB_API_HTTPARTY_OPTIONS="{verify: false}"
 
 Usage:
 
-When you want to know which CLI commands are supported, take a look at the client [commands implemented in this gem](https://www.rubydoc.info/gems/gitlab/4.5.0/Gitlab/Client). Any of those methods can be called as a command by passing the parameters of the commands as parameters of the CLI.
+When you want to know which CLI commands are supported, take a look at the client [commands implemented in this gem](https://www.rubydoc.info/gems/gitlab/4.18.0/Gitlab/Client). Any of those methods can be called as a command by passing the parameters of the commands as parameters of the CLI.
 
 Usage examples:
 
 ```sh
 # list users
-# see: https://www.rubydoc.info/gems/gitlab/4.5.0/Gitlab/Client/Users#users-instance_method
+# see: https://www.rubydoc.info/gems/gitlab/Gitlab/Client/Users#users-instance_method
 gitlab users
 
 # get current user
-# see: https://www.rubydoc.info/gems/gitlab/4.5.0/Gitlab/Client/Users#user-instance_method
+# see: https://www.rubydoc.info/gems/gitlab/Gitlab/Client/Users#user-instance_method
 gitlab user
 
 # get a user
-# see: https://www.rubydoc.info/gems/gitlab/4.5.0/Gitlab/Client/Users#user-instance_method
+# see: https://www.rubydoc.info/gems/gitlab/Gitlab/Client/Users#user-instance_method
 gitlab user 2
 
 # filter output
@@ -157,7 +160,7 @@ gitlab user --except=email,bio
 gitlab user 2 --json
 
 # passing options hash to a command (use YAML)
-# see: https://www.rubydoc.info/gems/gitlab/4.5.0/Gitlab/Client/MergeRequests#create_merge_request-instance_method
+# see: https://www.rubydoc.info/gems/gitlab/Gitlab/Client/MergeRequests#create_merge_request-instance_method
 gitlab create_merge_request 4 "New merge request" "{source_branch: 'new_branch', target_branch: 'master', assignee_id: 42}"
 
 ```

data/lib/gitlab/cli_helpers.rb

@@ -20,7 +20,7 @@ class Gitlab::CLI
     #
     # @return [Gitlab::Client]
     def client
-      @client ||= Gitlab::Client.new(endpoint: (Gitlab.endpoint || ''))
+      @client ||= Gitlab::Client.new(endpoint: Gitlab.endpoint || '')
     end
 
     # Returns method names and their owners

data/lib/gitlab/client/groups.rb

@@ -71,6 +71,40 @@ class Gitlab::Client
       get("/groups/#{url_encode id}/members", query: options)
     end
 
+    # Gets a list of all group members including inherited members.
+    #
+    # @example
+    #   Gitlab.all_group_members(1)
+    #   Gitlab.all_group_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 all_group_members(id, options = {})
+      get("/groups/#{url_encode id}/members/all", query: options)
+    end
+
+    # Get a list of descendant groups of a group.
+    #
+    # @example
+    #   Gitlab.group_descendants(42)
+    #
+    # @param [Integer] id the ID of a group
+    # @param [Hash] options A customizable set of options.
+    # @option options [String] :skip_groups Skip the group IDs passed.
+    # @option options [String] :all_available Show all the groups you have access to (defaults to false for authenticated users).
+    # @option options [String] :search Return the list of authorized groups matching the search criteria.
+    # @option options [String] :order_by Order groups by name or path. Default is name.
+    # @option options [String] :sort Order groups in asc or desc order. Default is asc.
+    # @option options [String] :statistics Include group statistics (admins only).
+    # @option options [String] :owned Limit to groups owned by the current user.
+    # @return [Array<Gitlab::ObjectifiedHash>] List of all subgroups under a group
+    def group_descendants(id, options = {})
+      get("/groups/#{url_encode id}/descendant_groups", query: options)
+    end
+
     # Get a list of group members that are billable.
     #
     # @example
@@ -320,5 +354,99 @@ class Gitlab::Client
     def delete_group_custom_attribute(key, group_id = nil)
       delete("/groups/#{group_id}/custom_attributes/#{key}")
     end
+
+    # List all the specified groups hooks
+    #
+    # @example
+    #   Gitlab.list_group_hooks(3)
+    #
+    # @param  [Integer] group_id The ID of a group.
+    # @return [Gitlab::PaginatedResponse] List of registered hooks https://docs.gitlab.com/ee/api/groups.html#hooks
+    def list_group_hooks(group_id)
+      get("/groups/#{group_id}/hooks")
+    end
+
+    # get specified group hook
+    #
+    # @example
+    #   Gitlab.group_hook(3, 1)
+    #
+    # @param  [Integer] group_id The ID of a group.
+    # @param  [Integer] hook_id The ID of the hook.
+    # @return [Gitlab::ObjectifiedHash] The hook https://docs.gitlab.com/ee/api/groups.html#get-group-hook
+    def group_hook(group_id, hook_id)
+      get("/groups/#{group_id}/hooks/#{hook_id}")
+    end
+
+    # Add a new group hook
+    #
+    # @example
+    #   Gitlab.add_group_hook(3, "https://example.com/my-hook-receiver", {token: "verify me"})
+    #
+    # @param  [Integer] group_id The ID of a group.
+    # @param  [String] the hook url which will receive the selected events
+    # @option options [Boolean] :name The name of the group.
+    # @option options [Boolean] :push_events Trigger hook on push events
+    # @potion options [String] :push_events_branch_filter	Trigger hook on push events for matching branches only.
+    # @option options [Boolean] :issues_events Trigger hook on issues events
+    # @option options [Boolean] :confidential_issues_events Trigger hook on confidential issues events
+    # @option options [Boolean] :merge_requests_events Trigger hook on merge requests events
+    # @option options [Boolean] :tag_push_events Trigger hook on tag push events
+    # @option options [Boolean] :note_events Trigger hook on note events
+    # @option options [Boolean] :confidential_note_events Trigger hook on confidential note events
+    # @option options [Boolean] :job_events Trigger hook on job events
+    # @option options [Boolean] :pipeline_events Trigger hook on pipeline events
+    # @option options [Boolean] :wiki_page_events Trigger hook on wiki page events
+    # @option options [Boolean] :deployment_events Trigger hook on deployment events
+    # @option options [Boolean] :releases_events Trigger hook on release events
+    # @option options [Boolean] :subgroup_events Trigger hook on subgroup events
+    # @option options [Boolean] :enable_ssl_verification Do SSL verification when triggering the hook
+    # @option options [String] :token	Secret token to validate received payloads; not returned in the response
+    # @return [Gitlab::ObjectifiedHash] Response body matches https://docs.gitlab.com/ee/api/groups.html#get-group-hook
+    def add_group_hook(group_id, url, options = {})
+      post("/groups/#{group_id}/hooks", body: options.merge(url: url))
+    end
+
+    # Edit a group hook
+    #
+    # @example
+    #   Gitlab.edit_group_hook(3, 1, "https://example.com/my-hook-receiver", {token: "verify me"})
+    #
+    # @param  [Integer] group_id The ID of a group.
+    # @param  [Integer] hook_id The ID of a group.
+    # @param  [String] the hook url which will receive the selected events
+    # @option options [Boolean] :name The name of the group.
+    # @option options [Boolean] :push_events Trigger hook on push events
+    # @potion options [String] :push_events_branch_filter	Trigger hook on push events for matching branches only.
+    # @option options [Boolean] :issues_events Trigger hook on issues events
+    # @option options [Boolean] :confidential_issues_events Trigger hook on confidential issues events
+    # @option options [Boolean] :merge_requests_events Trigger hook on merge requests events
+    # @option options [Boolean] :tag_push_events Trigger hook on tag push events
+    # @option options [Boolean] :note_events Trigger hook on note events
+    # @option options [Boolean] :confidential_note_events Trigger hook on confidential note events
+    # @option options [Boolean] :job_events Trigger hook on job events
+    # @option options [Boolean] :pipeline_events Trigger hook on pipeline events
+    # @option options [Boolean] :wiki_page_events Trigger hook on wiki page events
+    # @option options [Boolean] :deployment_events Trigger hook on deployment events
+    # @option options [Boolean] :releases_events Trigger hook on release events
+    # @option options [Boolean] :subgroup_events Trigger hook on subgroup events
+    # @option options [Boolean] :enable_ssl_verification Do SSL verification when triggering the hook
+    # @option options [String] :token	Secret token to validate received payloads; not returned in the response
+    # @return [Gitlab::ObjectifiedHash] Response body matches https://docs.gitlab.com/ee/api/groups.html#edit-group-hook
+    def edit_group_hook(group_id, hook_id, url, options = {})
+      post("/groups/#{group_id}/hooks/#{hook_id}", body: options.merge(url: url))
+    end
+
+    # Delete a group hook
+    #
+    # @example
+    #   Gitlab.delete_group_hook(3, 1)
+    #
+    # @param  [Integer] group_id The ID of a group.
+    # @param  [Integer] hook_id The ID of a group.
+    # @return [Gitlab::ObjectifiedHash] no body, will evaluate to an empty hash. https://docs.gitlab.com/ee/api/groups.html#delete-group-hook
+    def delete_group_hook(group_id, hook_id)
+      delete("/groups/#{group_id}/hooks/#{hook_id}")
+    end
   end
 end

data/lib/gitlab/client/issues.rb

@@ -227,5 +227,16 @@ class Gitlab::Client
     def merge_requests_closing_issue_on_merge(project, id)
       get("/projects/#{url_encode project}/issues/#{id}/closed_by")
     end
+
+    # List related merge requests
+    #
+    # @example
+    #   Gitlab.related_merge_requests(3, 42)
+    #
+    # @param [Integer, String] project The ID or name of a project.
+    # @param [Integer] id The ID of an issue.
+    def related_merge_requests(project, id)
+      get("/projects/#{url_encode project}/issues/#{id}/related_merge_requests")
+    end
   end
 end

data/lib/gitlab/client/merge_requests.rb

@@ -332,6 +332,30 @@ class Gitlab::Client
       delete("/projects/#{url_encode project}/merge_requests/#{merge_request_id}/discussions/#{discussion_id}/notes/#{note_id}")
     end
 
+    # Delete a merge request
+    #
+    # @example
+    #   Gitlab.delete_merge_request(5, 1)
+    #   Gitlab.delete_merge_request('gitlab', 1)
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of a merge request.
+    # @return [Gitlab::ObjectifiedHash] An empty response.
+    def delete_merge_request(project, merge_request_id)
+      delete("/projects/#{url_encode project}/merge_requests/#{merge_request_id}")
+    end
+
+    # Gets a list of merge request diffs
+    #
+    # @example
+    #   Gitlab.merge_request_diffs(5, 1)
+    #   Gitlab.merge_request_diffs('gitlab', 1)
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of a merge request.
+    # @return [Gitlab::ObjectifiedHash] A list of the merge request diffs.
+    def merge_request_diffs(project, merge_request_id)
+      get("/projects/#{url_encode project}/merge_requests/#{merge_request_id}/diffs")
+    end
+
     # Gets a list of merge request diff versions
     #
     # @example

data/lib/gitlab/client/merge_trains.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+class Gitlab::Client
+  # Defines methods related to merge trains.
+  # @see https://docs.gitlab.com/ee/api/merge_trains.html
+  module MergeTrains
+    # Get list of merge trains for a project.
+    #
+    # @example
+    #  Gitlab.merge_trains(1, scope: :active, sort: :asc)
+    #
+    # @param [Integer, String] project The ID or name of a project.
+    # @param [Hash] options A customizable set of options.
+    # @option options [String] :scope The scope of merge trains to return, one of: :active, :complete
+    # @option options [String] :sort Sort by created_at either 'asc' or 'desc'
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def merge_trains(project, options = {})
+      get("/projects/#{url_encode project}/merge_trains", query: options)
+    end
+
+    # Get all merge requests added to a merge train for the requested target branch.
+    #
+    # @param [Integer, String] project The ID or name of a project.
+    # @param [String] target_branch The target branch of the merge train.
+    # @param [Hash] options A customizable set of options.
+    # @option options [String] :scope The scope of merge trains to return, one of: :active, :complete
+    # @option options [String] :sort Sort by created_at either 'asc' or 'desc'
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def merge_train_merge_requests(project, target_branch, options = {})
+      get("/projects/#{url_encode project}/merge_trains/#{target_branch}", query: options)
+    end
+
+    # Get merge train information for the requested merge request.
+    #
+    # @param [Integer, String] project The ID or name of a project.
+    # @param [Integer] merge_request_iid The IID of the merge request.
+    # @return [Gitlab::ObjectifiedHash]
+    def merge_train_status(project, merge_request_iid)
+      get("/projects/#{url_encode project}/merge_trains/merge_requests/#{merge_request_iid}")
+    end
+
+    # Add a merge request to the merge train targeting the merge request’s target branch.
+    #
+    # @param [Integer, String] project The ID or name of a project.
+    # @param [Integer] merge_request_iid The IID of the merge request.
+    # @param [Hash] options A customizable set of options.
+    # @option options [Boolean] :when_pipeline_succeeds Add merge request to merge train when pipeline succeeds.
+    # @option options [String] :sha If present, the SHA must match the HEAD of the source branch, otherwise the merge fails.
+    # @option options [Boolean] :squash If true, the commits are squashed into a single commit on merge.
+    # @return [Array<Gitlab::ObjectifiedHash>] <description>
+    def add_merge_request_to_merge_train(project, merge_request_iid, options = {})
+      post("/projects/#{url_encode project}/merge_trains/merge_requests/#{merge_request_iid}", query: options)
+    end
+  end
+end

data/lib/gitlab/client/packages.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+class Gitlab::Client
+  # Defines methods related to GitLab Packages.
+  # @see https://docs.gitlab.com/ee/api/packages.html
+  module Packages
+    # Gets a list of project packages.
+    #
+    # @example
+    #   Gitlab.project_packages(5)
+    #   Gitlab.project_packages(5, { package_type: 'npm', sort: 'desc' })
+    #
+    # @param   [Integer, String] :project the ID or name of a project.
+    # @param   [Hash] options A customizable set of options.
+    # @options options [String] :order_by The field to use as order. One of created_at (default), name, version, or type.
+    # @options options [String] :sort The direction of the order, either asc (default) for ascending order or desc for descending order.
+    # @options options [String] :package_type Filter the returned packages by type. One of conan, maven, npm, pypi, composer, nuget, helm, terraform_module, or golang.
+    # @options options [String] :package_name Filter the project packages with a fuzzy search by name.
+    # @options options [String] :include_versionless When set to true, versionless packages are included in the response.
+    # @options options [String] :status Filter the returned packages by status. One of default (default), hidden, processing, error, or pending_destruction.
+    # @return  [Array<Gitlab::ObjectifiedHash>]
+    def project_packages(project, options = {})
+      get("/projects/#{url_encode project}/packages", query: options)
+    end
+
+    # Gets a list of project packages.
+    #
+    # @example
+    #   Gitlab.group_packages(5)
+    #   Gitlab.group_packages(5, { package_type: 'npm', sort: 'desc' })
+    #
+    # @param   [Integer, String] project the ID or name of a project.
+    # @param   [Hash] options A customizable set of options.
+    # @options options [String] :exclude_subgroups If the parameter is included as true, packages from projects from subgroups are not listed. Default is false.
+    # @options options [String] :order_by The field to use as order. One of created_at (default), name, version, or type.
+    # @options options [String] :sort The direction of the order, either asc (default) for ascending order or desc for descending order.
+    # @options options [String] :package_type Filter the returned packages by type. One of conan, maven, npm, pypi, composer, nuget, helm, terraform_module, or golang.
+    # @options options [String] :package_name Filter the project packages with a fuzzy search by name.
+    # @options options [String] :include_versionless When set to true, versionless packages are included in the response.
+    # @options options [String] :status Filter the returned packages by status. One of default (default), hidden, processing, error, or pending_destruction.
+    # @return  [Array<Gitlab::ObjectifiedHash>]
+    def group_packages(group, options = {})
+      get("/groups/#{url_encode group}/packages", query: options)
+    end
+
+    # Get a single project package.
+    #
+    # @example
+    #   Gitlab.project_package(5, 3)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id ID of a package.
+    # @return [Gitlab::ObjectifiedHash]
+    def project_package(project, id)
+      get("/projects/#{url_encode project}/packages/#{id}")
+    end
+
+    # Get a list of package files of a single package.
+    #
+    # @example
+    #   Gitlab.project_package_files(5, 3)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id ID of a package.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def project_package_files(project, id)
+      get("/projects/#{url_encode project}/packages/#{id}/package_files")
+    end
+
+    # Deletes a project package.
+    #
+    # @example
+    #   Gitlab.delete_project_package(5, 3)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id ID of a package.
+    # @return [void] This API call returns an empty response body.
+    def delete_project_package(project, id)
+      delete("/projects/#{url_encode project}/packages/#{id}")
+    end
+
+    # Delete a package file.
+    #
+    # @example
+    #   Gitlab.delete_project_file(5, 3, 1)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] package_id ID of a package.
+    # @param  [Integer] file_id ID of a package file.
+    # @return [void] This API call returns an empty response body.
+    def delete_project_package_file(project, package_id, file_id)
+      delete("/projects/#{url_encode project}/packages/#{package_id}/package_files/#{file_id}")
+    end
+  end
+end

data/lib/gitlab/client/pipelines.rb

@@ -43,6 +43,18 @@ class Gitlab::Client
       get("/projects/#{url_encode project}/pipelines/#{id}/test_report")
     end
 
+    # Gets a single pipeline's variables.
+    #
+    # @example
+    #   Gitlab.pipeline_variables(5, 36)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of a pipeline.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def pipeline_variables(project, id)
+      get("/projects/#{url_encode project}/pipelines/#{id}/variables")
+    end
+
     # Create a pipeline.
     #
     # @example
@@ -101,5 +113,18 @@ class Gitlab::Client
     def delete_pipeline(project, id)
       delete("/projects/#{url_encode project}/pipelines/#{id}")
     end
+
+    # Update a pipeline metadata
+    #
+    # @example
+    #   Gitlab.update_pipeline_metadata(5, 1, name: 'new name')
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of a pipeline.
+    # @option options [String] :name The new name of the pipeline.
+    # @return [Gitlab::ObjectifiedHash]
+    def update_pipeline_metadata(project, id, options = {})
+      put("/projects/#{url_encode project}/pipelines/#{id}/metadata", body: options)
+    end
   end
 end

data/lib/gitlab/client/project_exports.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+class Gitlab::Client
+  # Defines methods related to project exports.
+  # @see https://docs.gitlab.com/ce/api/project_import_export.html
+  module ProjectExports
+    # Start a new export
+    #
+    # @example
+    #   Gitlab.export_project(2)
+    #
+    # @param [Integer, String] id The ID or path of a project.
+    # @param [Hash] options A customizable set of options.
+    # @option options [String] description(optional) Overrides the project description
+    # @option options [hash] upload(optional) Hash that contains the information to upload the exported project to a web server
+    # @option options [String] upload[url] TThe URL to upload the project
+    # @option options [String] upload[http_method](optional) The HTTP method to upload the exported project. Only PUT and POST methods allowed. Default is PUT
+    # @return [Gitlab::ObjectifiedHash]
+    def export_project(id, options = {})
+      post("/projects/#{url_encode id}/export", body: options)
+    end
+
+    # Get the status of export
+    #
+    # @example
+    #   Gitlab.export_project_status(2)
+    #
+    # @param [Integer, String] id The ID or path of a project.
+    # @return [Gitlab::ObjectifiedHash]
+    def export_project_status(id)
+      get("/projects/#{url_encode id}/export")
+    end
+
+    # Download the finished export
+    #
+    # @example
+    #   Gitlab.exported_project_download(2)
+    #
+    # @param [Integer, String] id The ID or path of a project.
+    # @return [Gitlab::FileResponse]
+    def exported_project_download(id)
+      get("/projects/#{url_encode id}/export/download",
+          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
+  end
+end

data/lib/gitlab/client/project_releases.rb

@@ -75,5 +75,16 @@ class Gitlab::Client
     def delete_project_release(project, tag_name)
       delete("/projects/#{url_encode project}/releases/#{tag_name}")
     end
+
+    # Gets Latest Release
+    #
+    # @example
+    #   Gitlab.project_latest_release(5)
+    #
+    # @param [Integer, String] project The ID or name of a project
+    # @return [Gitlab::ObjectifiedHash] Information about the release
+    def project_latest_release(project)
+      get("/projects/#{url_encode project}/releases/permalink/latest")
+    end
   end
 end

data/lib/gitlab/client/repositories.rb

@@ -109,5 +109,22 @@ class Gitlab::Client
     def generate_changelog(project, version, options = {})
       post("/projects/#{url_encode project}/repository/changelog", body: options.merge(version: version))
     end
+
+    # Get changelog data
+    #
+    # @example
+    #   Gitlab.get_changelog(42, 'v1.0.0')
+    #
+    # @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] :trailer The Git trailer to use for including commits
+    # @return [Gitlab::ObjectifiedHash]
+    def get_changelog(project, version, options = {})
+      get("/projects/#{url_encode project}/repository/changelog", body: options.merge(version: version))
+    end
   end
 end

data/lib/gitlab/client/runners.rb

@@ -207,5 +207,72 @@ class Gitlab::Client
       body = { token: token }
       post('/runners/verify', body: body)
     end
+
+    # Creates a new group runner with the new Gitlab approach (v16.0+) and returns the id/token information
+    # https://docs.gitlab.com/ee/api/users.html#create-a-runner
+    # You must use an access token with the create_runner scope
+    #
+    # @example
+    #   Gitlab.create_group_runner(9, tag_list: ['one', 'two'])
+    #   Gitlab.create_group_runner(9, paused: false, description: 'A note', run_untagged: true)
+    #
+    # @param  [String] group(required) Group ID.
+    # @param  [Hash] options A customizable set of options.
+    # @return <Gitlab::ObjectifiedHash> Response against runner registration
+    def create_group_runner(group, options = {})
+      create_runner({ runner_type: 'group_type', group_id: group }.merge(options))
+    end
+
+    # Creates a new project runner with the new Gitlab approach (v16.0+) and returns the id/token information
+    # https://docs.gitlab.com/ee/api/users.html#create-a-runner
+    # You must use an access token with the create_runner scope
+    #
+    # @example
+    #   Gitlab.create_project_runner(12, tag_list: ['one', 'two'])
+    #   Gitlab.create_project_runner(12, paused: false, description: 'A note', run_untagged: true)
+    #
+    # @param  [String] project(required) Project ID.
+    # @param  [Hash] options A customizable set of options.
+    # @return <Gitlab::ObjectifiedHash> Response against runner registration
+    def create_project_runner(project, options = {})
+      create_runner({ runner_type: 'project_type', project_id: project }.merge(options))
+    end
+
+    # Creates a new instance runner with the new Gitlab approach (v16.0+) and returns the id/token information
+    # You must be an administrator of the GitLab instance
+    # You must use an access token with the create_runner scope
+    # https://docs.gitlab.com/ee/api/users.html#create-a-runner
+    #
+    # @example
+    #   Gitlab.create_instance_runner(tag_list: ['one', 'two'])
+    #   Gitlab.create_instance_runner(paused: false, description: 'A note', run_untagged: true)
+    #
+    # @param  [String] group(required) Project ID.
+    # @param  [Hash] options A customizable set of options.
+    # @return <Gitlab::ObjectifiedHash> Response against runner registration
+    def create_instance_runner(options = {})
+      create_runner({ runner_type: 'instance_type' }.merge(options))
+    end
+
+    private
+
+    # Creates a runner linked to the current user.
+    # You must use an access token with the create_runner scope
+    # https://docs.gitlab.com/ee/api/users.html#create-a-runner
+    #
+    # @param  [Hash] options(required) A customizable set of options.
+    # @option options [String] :description(optional) Runner description.
+    # @option options [Hash] :info(optional) Runner metadata.
+    # @option options [Boolean] :paused(optional) Whether the Runner ignores new jobs.
+    # @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 [String] :access_level(optional) 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.
+    # @option options [String] :maintenance_note(optional) Free-form maintenance notes for the runner (1024 characters).
+    # @return <Gitlab::ObjectifiedHash> Response against runner registration {"id": 1, "token": foo "token_expires_at": null}
+    def create_runner(options)
+      post('/user/runners', body: options)
+    end
   end
 end

data/lib/gitlab/client/users.rb

@@ -58,6 +58,22 @@ class Gitlab::Client
       post('/users', body: body)
     end
 
+    # Creates a service account.
+    # Requires authentication from an admin account.
+    #
+    # @example
+    #   Gitlab.create_service_account('service_account_6018816a18e515214e0c34c2b33523fc', 'Service account user')
+    #
+    # @param  [String] name (required) The email of the service account.
+    # @param  [String] username (required) The username of the service account.
+    # @return [Gitlab::ObjectifiedHash] Information about created service account.
+    def create_service_account(*args)
+      raise ArgumentError, 'Missing required parameters' unless args[1]
+
+      body = { name: args[0], username: args[1] }
+      post('/service_accounts', body: body)
+    end
+
     # Updates a user.
     #
     # @example
@@ -110,6 +126,39 @@ class Gitlab::Client
       post("/users/#{user_id}/unblock")
     end
 
+    # Deactivates the specified user. Available only for admin.
+    #
+    # @example
+    #   Gitlab.deactivate_user(15)
+    #
+    # @param [Integer] user_id The Id of user
+    # @return [Boolean] success or not
+    def deactivate_user(user_id)
+      post("/users/#{user_id}/deactivate")
+    end
+
+    # Activate the specified user. Available only for admin.
+    #
+    # @example
+    #   Gitlab.activate_user(15)
+    #
+    # @param [Integer] user_id The Id of user
+    # @return [Boolean] success or not
+    def activate_user(user_id)
+      post("/users/#{user_id}/activate")
+    end
+
+    # Approves the specified user. Available only for admin.
+    #
+    # @example
+    #   Gitlab.approve_user(15)
+    #
+    # @param [Integer] user_id The Id of user
+    # @return [Boolean] success or not
+    def approve_user(user_id)
+      post("/users/#{user_id}/approve")
+    end
+
     # Creates a new user session.
     #
     # @example
@@ -265,7 +314,7 @@ class Gitlab::Client
       delete(url)
     end
 
-    # Search for groups by name
+    # Search for users by name
     #
     # @example
     #   Gitlab.user_search('gitlab')
@@ -280,6 +329,19 @@ class Gitlab::Client
       get('/users', query: options)
     end
 
+    # Get user by username
+    #
+    # @example
+    #   Gitlab.user_by_username('gitlab')
+    #
+    # @param  [String] username A username to get.
+    # @param  [Hash] options A customizable set of options.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def user_by_username(username, options = {})
+      options[:username] = username
+      get('/users', query: options)
+    end
+
     # Gets user custom_attributes.
     #
     # @example
@@ -371,6 +433,47 @@ class Gitlab::Client
       post("/users/#{user_id}/impersonation_tokens", body: body)
     end
 
+    # Get all personal access tokens for a user
+    #
+    # @example
+    #   Gitlab.user_personal_access_tokens(1)
+    #
+    # @param  [Integer] user_id The ID of the user.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def user_personal_access_tokens(user_id)
+      get("/personal_access_tokens?user_id=#{user_id}")
+    end
+
+    # Create personal access token
+    #
+    # @example
+    #   Gitlab.create_personal_access_token(2, "token", ["api", "read_user"])
+    #   Gitlab.create_personal_access_token(2, "token", ["api", "read_user"], "1970-01-01")
+    #
+    # @param  [Integer] user_id The ID of the user.
+    # @param  [String] name Name of the personal access 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_personal_access_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}/personal_access_tokens", body: body)
+    end
+
+    # Rotate a personal access token
+    #
+    # @example
+    #   Gitlab.rotate_personal_access_token(1)
+    #
+    # @param  [Integer] personal_access_token_id ID of the personal access token.
+    # @return [Gitlab::ObjectifiedHash]
+    def rotate_personal_access_token(personal_access_token_id, expires_at = nil)
+      body = {}
+      body[:expires_at] = expires_at if expires_at
+      post("/personal_access_tokens/#{personal_access_token_id}/rotate", body: body)
+    end
+
     # Revoke an impersonation token
     #
     # @example
@@ -382,5 +485,37 @@ class Gitlab::Client
     def revoke_user_impersonation_token(user_id, impersonation_token_id)
       delete("/users/#{user_id}/impersonation_tokens/#{impersonation_token_id}")
     end
+
+    # Lists all projects and groups a user is a member of
+    #
+    # @example
+    #   Gitlab.memberships(2)
+    #
+    # @param  [Integer] user_id The ID of the user.
+    def memberships(user_id)
+      get("/users/#{user_id}/memberships")
+    end
+
+    # Revoke a personal access token
+    #
+    # @example
+    #   Gitlab.revoke_personal_access_token(1)
+    #
+    # @param  [Integer] personal_access_token_id ID of the personal access token.
+    # @return [Gitlab::ObjectifiedHash]
+    def revoke_personal_access_token(personal_access_token_id)
+      delete("/personal_access_tokens/#{personal_access_token_id}")
+    end
+
+    # Disables two factor authentication (2FA) for the specified user.
+    #
+    # @example
+    #   Gitlab.disable_two_factor(1)
+    #
+    # @param [Integer] id The ID of a user.
+    # @return [Gitlab::ObjectifiedHash]
+    def disable_two_factor(user_id)
+      patch("/users/#{user_id}/disable_two_factor")
+    end
   end
 end

data/lib/gitlab/client.rb

@@ -37,9 +37,11 @@ module Gitlab
     include Markdown
     include MergeRequestApprovals
     include MergeRequests
+    include MergeTrains
     include Milestones
     include Namespaces
     include Notes
+    include Packages
     include PipelineSchedules
     include PipelineTriggers
     include Pipelines
@@ -89,7 +91,7 @@ module Gitlab
     private
 
     def only_show_last_four_chars(token)
-      "#{'*' * (token.size - 4)}#{token[-4..-1]}"
+      "#{'*' * (token.size - 4)}#{token[-4..]}"
     end
   end
 end

data/lib/gitlab/error.rb

@@ -135,6 +135,9 @@ module Gitlab
     # Raised when API endpoint returns the HTTP status code 503.
     class ServiceUnavailable < ResponseError; end
 
+    # Raised when API endpoint returns the HTTP status code 522.
+    class ConnectionTimedOut < ResponseError; end
+
     # HTTP status codes mapped to error classes.
     STATUS_MAPPINGS = {
       400 => BadRequest,
@@ -148,7 +151,20 @@ module Gitlab
       429 => TooManyRequests,
       500 => InternalServerError,
       502 => BadGateway,
-      503 => ServiceUnavailable
+      503 => ServiceUnavailable,
+      522 => ConnectionTimedOut
     }.freeze
+
+    # Returns error class that should be raised for this response. Returns nil
+    # if the response status code is not 4xx or 5xx.
+    #
+    # @param  [HTTParty::Response] response The response object.
+    # @return [Class<Error::ResponseError>, nil]
+    def self.klass(response)
+      error_klass = STATUS_MAPPINGS[response.code]
+      return error_klass if error_klass
+
+      ResponseError if response.server_error? || response.client_error?
+    end
   end
 end

data/lib/gitlab/headers/page_links.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Gitlab
+  module Headers
+    # Parses link header.
+    #
+    # @private
+    class PageLinks
+      HEADER_LINK = 'Link'
+      DELIM_LINKS = ','
+      LINK_REGEX = /<([^>]+)>; rel="([^"]+)"/.freeze
+      METAS = %w[last next first prev].freeze
+
+      attr_accessor(*METAS)
+
+      def initialize(headers)
+        link_header = headers[HEADER_LINK]
+
+        extract_links(link_header) if link_header && link_header =~ /(next|first|last|prev)/
+      end
+
+      private
+
+      def extract_links(header)
+        header.split(DELIM_LINKS).each do |link|
+          LINK_REGEX.match(link.strip) do |match|
+            url = match[1]
+            meta = match[2]
+            next if !url || !meta || METAS.index(meta).nil?
+
+            send("#{meta}=", url)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/headers/total.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Gitlab
+  module Headers
+    # Parses total header.
+    #
+    # @private
+    class Total
+      HEADER_TOTAL = 'x-total'
+      TOTAL_REGEX = /^\d+$/.freeze
+
+      attr_accessor :total
+
+      def initialize(headers)
+        header_total = headers[HEADER_TOTAL]
+
+        extract_total(header_total) if header_total
+      end
+
+      private
+
+      def extract_total(header_total)
+        TOTAL_REGEX.match(header_total.strip) do |match|
+          @total = match[0]
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/paginated_response.rb

@@ -30,7 +30,8 @@ module Gitlab
     end
 
     def parse_headers!(headers)
-      @links = PageLinks.new headers
+      @links = Headers::PageLinks.new headers
+      @total = Headers::Total.new headers
     end
 
     def each_page
@@ -58,6 +59,10 @@ module Gitlab
       lazy_paginate.take(limit).each(&block)
     end
 
+    def total
+      @total.total
+    end
+
     def last_page?
       !(@links.nil? || @links.last.nil?)
     end

data/lib/gitlab/request.rb

@@ -38,7 +38,7 @@ module Gitlab
       raise Error::Parsing, 'The response is not a valid JSON'
     end
 
-    %w[get post put delete].each do |method|
+    %w[get post put patch delete].each do |method|
       define_method method do |path, options = {}|
         params = options.dup
 
@@ -67,7 +67,7 @@ module Gitlab
     # Checks the response code for common errors.
     # Returns parsed response for successful requests.
     def validate(response)
-      error_klass = Error::STATUS_MAPPINGS[response.code]
+      error_klass = Error.klass(response)
       raise error_klass, response if error_klass
 
       parsed = response.parsed_response

data/lib/gitlab/version.rb

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

data/lib/gitlab.rb

@@ -4,7 +4,8 @@ require 'gitlab/version'
 require 'gitlab/objectified_hash'
 require 'gitlab/configuration'
 require 'gitlab/error'
-require 'gitlab/page_links'
+require 'gitlab/headers/page_links'
+require 'gitlab/headers/total'
 require 'gitlab/paginated_response'
 require 'gitlab/file_response'
 require 'gitlab/request'
@@ -49,8 +50,10 @@ module Gitlab
   #
   # @return [Array<Symbol>]
   def self.actions
+    # rubocop:disable Layout/LineLength
     hidden =
-      /endpoint|private_token|auth_token|user_agent|sudo|get|post|put|\Adelete\z|validate\z|request_defaults|httparty/
+      /endpoint|private_token|auth_token|user_agent|sudo|get|post|put|patch|\Adelete\z|validate\z|request_defaults|httparty/
+    # rubocop:enable Layout/LineLength
     (Gitlab::Client.instance_methods - Object.methods).reject { |e| e[hidden] }
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gitlab
 version: !ruby/object:Gem::Version
-  version: 4.18.0
+  version: 4.20.0
 platform: ruby
 authors:
 - Nihad Abbasov
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-12-26 00:00:00.000000000 Z
+date: 2024-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.18'
+        version: '0.20'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.18'
+        version: '0.20'
 - !ruby/object:Gem::Dependency
   name: terminal-table
   requirement: !ruby/object:Gem::Requirement
@@ -130,14 +130,17 @@ files:
 - lib/gitlab/client/markdown.rb
 - lib/gitlab/client/merge_request_approvals.rb
 - lib/gitlab/client/merge_requests.rb
+- lib/gitlab/client/merge_trains.rb
 - lib/gitlab/client/milestones.rb
 - lib/gitlab/client/namespaces.rb
 - lib/gitlab/client/notes.rb
+- lib/gitlab/client/packages.rb
 - lib/gitlab/client/pipeline_schedules.rb
 - lib/gitlab/client/pipeline_triggers.rb
 - lib/gitlab/client/pipelines.rb
 - lib/gitlab/client/project_badges.rb
 - lib/gitlab/client/project_clusters.rb
+- lib/gitlab/client/project_exports.rb
 - lib/gitlab/client/project_release_links.rb
 - lib/gitlab/client/project_releases.rb
 - lib/gitlab/client/projects.rb
@@ -164,9 +167,10 @@ files:
 - lib/gitlab/configuration.rb
 - lib/gitlab/error.rb
 - lib/gitlab/file_response.rb
+- lib/gitlab/headers/page_links.rb
+- lib/gitlab/headers/total.rb
 - lib/gitlab/help.rb
 - lib/gitlab/objectified_hash.rb
-- lib/gitlab/page_links.rb
 - lib/gitlab/paginated_response.rb
 - lib/gitlab/request.rb
 - lib/gitlab/shell.rb
@@ -175,7 +179,12 @@ files:
 homepage: https://github.com/NARKOZ/gitlab
 licenses:
 - BSD-2-Clause
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/NARKOZ/gitlab
+  source_code_uri: https://github.com/NARKOZ/gitlab
+  bug_tracker_uri: https://github.com/NARKOZ/gitlab/issues
+  changelog_uri: https://github.com/NARKOZ/gitlab/releases
+  funding_uri: https://github.com/NARKOZ/SponsorMe
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -184,7 +193,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/gitlab/page_links.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-module Gitlab
-  # Parses link header.
-  #
-  # @private
-  class PageLinks
-    HEADER_LINK = 'Link'
-    DELIM_LINKS = ','
-    LINK_REGEX = /<([^>]+)>; rel="([^"]+)"/.freeze
-    METAS = %w[last next first prev].freeze
-
-    attr_accessor(*METAS)
-
-    def initialize(headers)
-      link_header = headers[HEADER_LINK]
-
-      extract_links(link_header) if link_header && link_header =~ /(next|first|last|prev)/
-    end
-
-    private
-
-    def extract_links(header)
-      header.split(DELIM_LINKS).each do |link|
-        LINK_REGEX.match(link.strip) do |match|
-          url = match[1]
-          meta = match[2]
-          next if !url || !meta || METAS.index(meta).nil?
-
-          send("#{meta}=", url)
-        end
-      end
-    end
-  end
-end