gitlab 4.12.0 → 4.20.1

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.
@@ -74,21 +73,22 @@ module Gitlab::Help
     # Returns full namespace of a command (e.g. Gitlab::Client::Branches.cmd)
     def namespace(cmd)
       method_owners.select { |method| method[:name] == cmd }
-                   .map { |method| method[:owner] + '.' + method[:name] }
+                   .map { |method| "#{method[:owner]}.#{method[:name]}" }
                    .shift
     end
 
     # Massage output from 'ri'.
     def change_help_output!(cmd, output_str)
-      output_str.gsub!(/#{cmd}\((.*?)\)/m, cmd + ' \1')
-      output_str.gsub!(/\,[\s]*/, ' ')
+      output_str = +output_str
+      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/objectified_hash.rb

@@ -7,29 +7,45 @@ module Gitlab
     def initialize(hash)
       @hash = hash
       @data = hash.each_with_object({}) do |(key, value), data|
-        value = ObjectifiedHash.new(value) if value.is_a? Hash
+        value = self.class.new(value) if value.is_a? Hash
+        value = value.map { |v| v.is_a?(Hash) ? self.class.new(v) : v } if value.is_a? Array
         data[key.to_s] = value
       end
     end
 
     # @return [Hash] The original hash.
     def to_hash
-      @hash
+      hash
     end
     alias to_h to_hash
 
     # @return [String] Formatted string with the class name, object id and original hash.
     def inspect
-      "#<#{self.class}:#{object_id} {hash: #{@hash.inspect}}"
+      "#<#{self.class}:#{object_id} {hash: #{hash.inspect}}"
     end
 
-    # Delegate to ObjectifiedHash.
-    def method_missing(key)
-      @data.key?(key.to_s) ? @data[key.to_s] : super
+    def [](key)
+      data[key]
+    end
+
+    private
+
+    attr_reader :hash, :data
+
+    # Respond to messages for which `self.data` has a key
+    def method_missing(method_name, *args, &block)
+      if data.key?(method_name.to_s)
+        data[method_name.to_s]
+      elsif data.respond_to?(method_name)
+        warn 'WARNING: Please convert ObjectifiedHash object to hash before calling Hash methods on it.'
+        data.send(method_name, *args, &block)
+      else
+        super
+      end
     end
 
     def respond_to_missing?(method_name, include_private = false)
-      @hash.keys.map(&:to_sym).include?(method_name.to_sym) || super
+      hash.keys.map(&:to_sym).include?(method_name.to_sym) || super
     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
@@ -42,37 +43,24 @@ module Gitlab
       end
     end
 
-    def auto_paginate
-      response = block_given? ? nil : []
-      each_page do |page|
-        if block_given?
-          page.each do |item|
-            yield item
-          end
-        else
-          response += page
-        end
-      end
-      response
-    end
-
-    def paginate_with_limit(limit)
-      response = block_given? ? nil : []
-      count = 0
-      each_page do |page|
-        if block_given?
-          page.each do |item|
-            yield item
-            count += 1
-            break if count >= limit
-          end
-        else
-          response += page[0, limit - count]
-          count = response.length
-        end
-        break if count >= limit
-      end
-      response
+    def lazy_paginate
+      to_enum(:each_page).lazy.flat_map(&:to_ary)
+    end
+
+    def auto_paginate(&block)
+      return lazy_paginate.to_a unless block
+
+      lazy_paginate.each(&block)
+    end
+
+    def paginate_with_limit(limit, &block)
+      return lazy_paginate.take(limit).to_a unless block
+
+      lazy_paginate.take(limit).each(&block)
+    end
+
+    def total
+      @total.total
     end
 
     def last_page?
@@ -83,8 +71,7 @@ module Gitlab
     def last_page
       return nil if @client.nil? || !has_last_page?
 
-      path = @links.last.sub(/#{@client.endpoint}/, '')
-      @client.get(path)
+      @client.get(client_relative_path(@links.last))
     end
 
     def first_page?
@@ -95,8 +82,7 @@ module Gitlab
     def first_page
       return nil if @client.nil? || !has_first_page?
 
-      path = @links.first.sub(/#{@client.endpoint}/, '')
-      @client.get(path)
+      @client.get(client_relative_path(@links.first))
     end
 
     def next_page?
@@ -107,8 +93,7 @@ module Gitlab
     def next_page
       return nil if @client.nil? || !has_next_page?
 
-      path = @links.next.sub(/#{@client.endpoint}/, '')
-      @client.get(path)
+      @client.get(client_relative_path(@links.next))
     end
 
     def prev_page?
@@ -119,8 +104,12 @@ module Gitlab
     def prev_page
       return nil if @client.nil? || !has_prev_page?
 
-      path = @links.prev.sub(/#{@client.endpoint}/, '')
-      @client.get(path)
+      @client.get(client_relative_path(@links.prev))
+    end
+
+    def client_relative_path(link)
+      client_endpoint_path = URI.parse(@client.endpoint).request_uri # api/v4
+      URI.parse(link).request_uri.sub(client_endpoint_path, '')
     end
   end
 end

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) })
 
@@ -25,8 +26,6 @@ module Gitlab
         true
       elsif !body
         false
-      elsif body.nil?
-        false
       else
         raise Error::Parsing, "Couldn't parse a response body"
       end
@@ -39,18 +38,36 @@ 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 = {}|
-        httparty_config(options)
-        authorization_header(options)
-        validate self.class.send(method, @endpoint + path, options)
+        params = options.dup
+
+        httparty_config(params)
+
+        unless params[:unauthenticated]
+          params[:headers] ||= {}
+          params[:headers].merge!(authorization_header)
+        end
+
+        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
 
     # 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
@@ -62,28 +79,25 @@ module Gitlab
     # Sets a base_uri and default_params for requests.
     # @raise [Error::MissingCredentials] if endpoint not set.
     def request_defaults(sudo = nil)
-      self.class.default_params sudo: sudo
-      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?
     end
 
     private
 
-    # Sets a PRIVATE-TOKEN or Authorization header for requests.
+    # Returns an Authorization header hash
     #
-    # @param [Hash] options A customizable set of options.
-    # @option options [Boolean] :unauthenticated true if the API call does not require user authentication.
     # @raise [Error::MissingCredentials] if private_token and auth_token are not set.
-    def authorization_header(options)
-      return if options[:unauthenticated]
-      raise Error::MissingCredentials, 'Please provide a private_token or auth_token for user' unless @private_token
-
-      options[:headers] = if @private_token.size < 21
-                            { 'PRIVATE-TOKEN' => @private_token }
-                          else
-                            { 'Authorization' => "Bearer #{@private_token}" }
-                          end
+    def authorization_header
+      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 }
+      else
+        { 'Authorization' => "Bearer #{private_token}" }
+      end
     end
 
     # Set HTTParty configuration

data/lib/gitlab/shell_history.rb

@@ -42,10 +42,10 @@ class Gitlab::Shell
       File.expand_path(@file_path)
     end
 
-    def read_from_file
+    def read_from_file(&block)
       path = history_file_path
 
-      File.foreach(path) { |line| yield(line) } if File.exist?(path)
+      File.foreach(path, &block) if File.exist?(path)
     rescue StandardError => e
       warn "History file not loaded: #{e.message}"
     end

data/lib/gitlab/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Gitlab
-  VERSION = '4.12.0'
+  VERSION = '4.20.1'
 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'
@@ -21,11 +22,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)
+  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)
+      client.send(method, *args, &block)
+    end
   end
 
   # Delegate to Gitlab::Client
@@ -42,7 +50,10 @@ module Gitlab
   #
   # @return [Array<Symbol>]
   def self.actions
-    hidden = /endpoint|private_token|auth_token|user_agent|sudo|get|post|put|\Adelete\z|validate|request_defaults|httparty/
+    # rubocop:disable Layout/LineLength
+    hidden =
+      /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.12.0
+  version: 4.20.1
 platform: ruby
 authors:
 - Nihad Abbasov
@@ -9,35 +9,26 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-11 00:00:00.000000000 Z
+date: 2024-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.14.0
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '0.20'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.14.0
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '0.20'
 - !ruby/object:Gem::Dependency
   name: terminal-table
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.5'
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.5.1
@@ -45,26 +36,9 @@ 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
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -93,20 +67,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -152,12 +112,16 @@ files:
 - lib/gitlab/client/container_registry.rb
 - lib/gitlab/client/deployments.rb
 - lib/gitlab/client/environments.rb
+- lib/gitlab/client/epic_issues.rb
+- lib/gitlab/client/epics.rb
 - lib/gitlab/client/events.rb
 - lib/gitlab/client/features.rb
+- lib/gitlab/client/group_badges.rb
 - lib/gitlab/client/group_boards.rb
 - lib/gitlab/client/group_labels.rb
 - lib/gitlab/client/group_milestones.rb
 - lib/gitlab/client/groups.rb
+- lib/gitlab/client/issue_links.rb
 - lib/gitlab/client/issues.rb
 - lib/gitlab/client/jobs.rb
 - lib/gitlab/client/keys.rb
@@ -166,22 +130,27 @@ 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
 - 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
 - lib/gitlab/client/resource_label_events.rb
+- lib/gitlab/client/resource_state_events.rb
 - lib/gitlab/client/runners.rb
 - lib/gitlab/client/search.rb
 - lib/gitlab/client/services.rb
@@ -191,15 +160,17 @@ files:
 - lib/gitlab/client/tags.rb
 - lib/gitlab/client/templates.rb
 - lib/gitlab/client/todos.rb
+- lib/gitlab/client/user_snippets.rb
 - lib/gitlab/client/users.rb
 - lib/gitlab/client/versions.rb
 - lib/gitlab/client/wikis.rb
 - 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
@@ -208,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:
@@ -217,14 +193,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: A Ruby wrapper and CLI for the GitLab API

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