gitlab 4.18.0 → 4.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a9218b2e2622283ff16c91d001d99d9f81e9ee7c6acd285a640553c8c8fd24f
-  data.tar.gz: 7603515dec3c85ea53cbef33acc9131d21605d9eab8f668476c36afa58837b76
+  metadata.gz: 020a259d1d6822f810e1dc2c112d59bf46d453b7cf1840299c0f4d7208f4ac97
+  data.tar.gz: 791cce56832e0089a9dc1c25efedf2d5fe1569e43b40f820ab4c935dede9222b
 SHA512:
-  metadata.gz: ec5e891011991391aaa42a86ef3c2506a1541c0c63526c820e1b67bafa17a743d7ce4f00531a074cf982be7b35d2d3a37eeb1ebab8cd619af67680c882dac708
-  data.tar.gz: 7ef86a70f12613923fa0dd59a87164f16cc50d4ebf114fb8bed9756a55b4ddb7363d26c9e3c2f4034c0e32ecda9805bc5577f006cfbb49f6c0d9530e196c7e04
+  metadata.gz: cebd397716351c091a448af4305e81f9ca188df3c966291d1d55e5b9cc01a0ba534c65716acd5f121017e09a87209bffcf688976e36deffe1385b81360d29dd0
+  data.tar.gz: b972182f6edb9d0418f850172652585397d1601713e8c5e171342f382f73a1169c0c79fd068b48cecf21deddc5be933daeb20b75d1b31329e9eb82e94c3c1965

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/workflow/status/NARKOZ/gitlab/CI/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/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

data/lib/gitlab/client/merge_requests.rb

@@ -332,6 +332,18 @@ 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 diff versions
     #
     # @example

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/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/users.rb

@@ -110,6 +110,17 @@ class Gitlab::Client
       post("/users/#{user_id}/unblock")
     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

data/lib/gitlab/client.rb

@@ -40,6 +40,7 @@ module Gitlab
     include Milestones
     include Namespaces
     include Notes
+    include Packages
     include PipelineSchedules
     include PipelineTriggers
     include Pipelines
@@ -89,7 +90,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/request.rb

@@ -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.19.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gitlab
 version: !ruby/object:Gem::Version
-  version: 4.18.0
+  version: 4.19.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: 2022-07-10 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
@@ -133,6 +133,7 @@ files:
 - 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
@@ -175,7 +176,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 +190,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:
   - - ">="