gitlab 5.0.0 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e2ac5f300e0abf6ff5039f696b6558be356564e50a0f4f9b3705c21ebceddaf9
-  data.tar.gz: 18338d4e23c87679ba75e68155dc5f015bf5a70b88b836723a43398b80f0eda3
+  metadata.gz: e1453623fe0d87a006492342f5726338aba971afcc6b693295f537a037d7e2e9
+  data.tar.gz: ab5e4e4d81bdeeef8802dc03bc8b7c912c6b41f1d4ac25ab5ca752b4af53121b
 SHA512:
-  metadata.gz: 3037f0c16308dd121a312c67d9011775d4bc0bb053fe5a4b38787554e925fbfe62197186550aefef42fb329769cb625676de16f84bc65a1fe318f2442c065d55
-  data.tar.gz: f20e8a0e6c7235723d13c7beb9294cf04d81b59558b301acd9abeb0832c4e18b2211032299e2fafa67ed07ce190b31ca9a45996d9482e015d9d7b6d4a4dcb25b
+  metadata.gz: 54dae253ce896dcbf3e612fdd4bb3e092373557e5959292e5a949108679d4ead1ac69e34e45f9d15c795e826d19b55175ad234598aa68f2e51c8384289af7267
+  data.tar.gz: 14ab36332c58d98f43216df49bfa6e1cbe8aa6a540ef83cb4b1d2090cad66c9eb8351172f1d13feb369f7f32b8d65503094be358d855b1d5636f01418b129f4f

data/lib/gitlab/client/merge_requests.rb

@@ -59,6 +59,18 @@ class Gitlab::Client
       get("/projects/#{url_encode project}/merge_requests/#{id}/pipelines")
     end
 
+    # Shows information about the merge request dependencies that must be resolved before merging.
+    #
+    # @example
+    #   Gitlab.merge_request_dependencies(5, 36)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of a merge request.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def merge_request_dependencies(project, id)
+      get("/projects/#{url_encode project}/merge_requests/#{id}/blocks")
+    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.
@@ -223,9 +235,11 @@ class Gitlab::Client
     #   Gitlab.merge_request_discussions('gitlab', 1)
     # @param  [Integer, String] project The ID or name of a project.
     # @param  [Integer] id The ID of a merge request.
+    # @option options [Integer] :page The page number.
+    # @option options [Integer] :per_page The number of results per page.
     # @return [Gitlab::ObjectifiedHash] List of the merge request discussions.
-    def merge_request_discussions(project, merge_request_id)
-      get("/projects/#{url_encode project}/merge_requests/#{merge_request_id}/discussions")
+    def merge_request_discussions(project, merge_request_id, options = {})
+      get("/projects/#{url_encode project}/merge_requests/#{merge_request_id}/discussions", query: options)
     end
 
     # Get single merge request discussion

data/lib/gitlab/client/pipeline_schedules.rb

@@ -30,6 +30,18 @@ class Gitlab::Client
       get("/projects/#{url_encode project}/pipeline_schedules/#{id}")
     end
 
+    # Get all pipelines triggered by a pipeline schedule
+    #
+    # @example
+    #   Gitlab.pipelines_by_pipeline_schedule(5, 3)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of the pipeline schedule.
+    # @return  [Array<Gitlab::ObjectifiedHash>]
+    def pipelines_by_pipeline_schedule(project, id)
+      get("/projects/#{url_encode project}/pipeline_schedules/#{id}/pipelines")
+    end
+
     # Create a pipeline schedule.
     #
     # @example

data/lib/gitlab/client/projects.rb

@@ -3,7 +3,7 @@
 class Gitlab::Client
   # Defines methods related to projects.
   # @see https://docs.gitlab.com/ce/api/projects.html
-  module Projects
+  module Projects # rubocop:disable Metrics/ModuleLength
     # Gets a list of projects owned by the authenticated user.
     #
     # @example
@@ -704,5 +704,85 @@ class Gitlab::Client
     def project_deploy_tokens(project, options = {})
       get("/projects/#{url_encode project}/deploy_tokens", query: options)
     end
+
+    # Get languages used with percentage value
+    #
+    # @example
+    #   Gitlab.project_languages(42)
+    #
+    # @param [Integer, String] id The ID or path of a project.
+    # @return [Gitlab::ObjectifiedHash]
+    def project_languages(project)
+      get("/projects/#{url_encode project}/languages")
+    end
+
+    # List all project access tokens.
+    #
+    # @example
+    #   Gitlab.project_access_tokens(42)
+    #
+    # @param [Integer, String] project The ID or path of a project.
+    # @option options [String] :state Limit by active/inactive state. Optional.
+    #
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def project_access_tokens(project, options = {})
+      get("/projects/#{url_encode project}/access_tokens", query: options)
+    end
+
+    # Get a specific project access token.
+    #
+    # @example
+    #   Gitlab.project_access_token(42, 1234)
+    #
+    # @param [Integer, String] project The ID or path of a project.
+    # @param [Integer] token_id The ID of the project access token.
+    #
+    # @return [Gitlab::ObjectifiedHash] Information about the specified project access token.
+    def project_access_token(project, token_id)
+      get("/projects/#{url_encode project}/access_tokens/#{token_id}")
+    end
+
+    # Creates a new project access token.
+    #
+    # @example
+    #   Gitlab.create_project_access_token(42, 'My Token', ['api'], '2024-12-12', access_level: 40)
+    #
+    # @param  [Integer, String] project The ID or path of a project.
+    # @param  [String] name The name of the project access token.
+    # @param  [Array] scopes List of scopes of the project access token.
+    # @param  [String] expires_at A date string in the format YYYY-MM-DD.
+    # @option options [Integer] :access_level Access level. Optional. Defaults to 40.
+    #
+    # @return [Gitlab::ObjectifiedHash] Information about the created project access token.
+    def create_project_access_token(project, name, scopes, expires_at, options = {})
+      post("/projects/#{url_encode project}/access_tokens", body: { name: name, scopes: scopes, expires_at: expires_at }.merge(options))
+    end
+
+    # Rotate a project access token.
+    #
+    # @example
+    #   Gitlab.rotate_project_access_token(42, 1234)
+    #
+    # @param [Integer, String] project The ID or path of a project.
+    # @param [Integer] token_id The ID of the project access token.
+    # @option options [String] :expires_at A date string in the format YEAR-MONTH-DAY.
+    #
+    # @return [Gitlab::ObjectifiedHash] Information about the specified project access token.
+    def rotate_project_access_token(project, token_id, options = {})
+      post("/projects/#{url_encode project}/access_tokens/#{token_id}/rotate", query: options)
+    end
+
+    # Revoke a project access token.
+    #
+    # @example
+    #   Gitlab.revoke_project_access_token(42, 1234)
+    #
+    # @param [Integer, String] project The ID or path of a project.
+    # @param [Integer] token_id The ID of the project access token.
+    #
+    # @return [Gitlab::ObjectifiedHash]
+    def revoke_project_access_token(project, token_id)
+      delete("/projects/#{url_encode project}/access_tokens/#{token_id}")
+    end
   end
 end

data/lib/gitlab/client.rb

@@ -77,7 +77,7 @@ module Gitlab
     # @return [String]
     def inspect
       inspected = super
-      inspected.sub! @private_token, only_show_last_four_chars(@private_token) if @private_token
+      inspected = redact_private_token(inspected, @private_token) if @private_token
       inspected
     end
 
@@ -91,7 +91,14 @@ module Gitlab
 
     private
 
+    def redact_private_token(inspected, private_token)
+      redacted = only_show_last_four_chars(private_token)
+      inspected.sub %(@private_token="#{private_token}"), %(@private_token="#{redacted}")
+    end
+
     def only_show_last_four_chars(token)
+      return '****' if token.size <= 4
+
       "#{'*' * (token.size - 4)}#{token[-4..]}"
     end
   end

data/lib/gitlab/configuration.rb

@@ -5,7 +5,7 @@ module Gitlab
   # Defines constants and methods related to configuration.
   module Configuration
     # An array of valid keys in the options hash when configuring a Gitlab::API.
-    VALID_OPTIONS_KEYS = %i[endpoint private_token user_agent sudo httparty].freeze
+    VALID_OPTIONS_KEYS = %i[endpoint private_token user_agent sudo httparty pat_prefix].freeze
 
     # The user agent that will be sent to the API endpoint if none is set.
     DEFAULT_USER_AGENT = "Gitlab Ruby Gem #{Gitlab::VERSION}"
@@ -37,6 +37,7 @@ module Gitlab
     def reset
       self.endpoint       = ENV['GITLAB_API_ENDPOINT'] || ENV['CI_API_V4_URL']
       self.private_token  = ENV['GITLAB_API_PRIVATE_TOKEN'] || ENV['GITLAB_API_AUTH_TOKEN']
+      self.pat_prefix     = nil
       self.httparty       = get_httparty_config(ENV['GITLAB_API_HTTPARTY_OPTIONS'])
       self.sudo           = nil
       self.user_agent     = DEFAULT_USER_AGENT

data/lib/gitlab/request.rb

@@ -12,7 +12,7 @@ module Gitlab
     headers 'Accept' => 'application/json', 'Content-Type' => 'application/x-www-form-urlencoded'
     parser(proc { |body, _| parse(body) })
 
-    attr_accessor :private_token, :endpoint
+    attr_accessor :private_token, :endpoint, :pat_prefix
 
     # Converts the response body to an ObjectifiedHash.
     def self.parse(body)
@@ -93,10 +93,19 @@ module Gitlab
     def authorization_header
       raise Error::MissingCredentials, 'Please provide a private_token or auth_token for user' unless private_token
 
-      if private_token.size < 21
+      # The Personal Access Token prefix can be at most 20 characters, and the
+      # generated part is of length 20 characters. Personal Access Tokens, thus
+      # can have a maximum size of 40 characters. GitLab uses
+      # `Doorkeeper::OAuth::Helpers::UniqueToken.generate` for generating
+      # OAuth2 tokens, and specified `hex` as token generator method. Thus, the
+      # OAuth2 tokens are of length more than 64. If the token length is below
+      # that, it is probably a Personal Access Token or CI_JOB_TOKEN.
+      if private_token.size >= 64
+        { 'Authorization' => "Bearer #{private_token}" }
+      elsif private_token.start_with?(pat_prefix.to_s)
         { 'PRIVATE-TOKEN' => private_token }
       else
-        { 'Authorization' => "Bearer #{private_token}" }
+        { 'JOB-TOKEN' => private_token }
       end
     end
 

data/lib/gitlab/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gitlab
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 5.1.0
 platform: ruby
 authors:
 - Nihad Abbasov
@@ -9,8 +9,22 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-06-22 00:00:00.000000000 Z
+date: 2024-10-29 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
@@ -200,7 +214,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.5.16
 signing_key: 
 specification_version: 4
 summary: A Ruby wrapper and CLI for the GitLab API