gitlab 4.5.0 → 5.1.0

data/lib/gitlab/configuration.rb

@@ -1,17 +1,19 @@
+# frozen_string_literal: true
+
 require 'gitlab/cli_helpers'
 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}".freeze
+    DEFAULT_USER_AGENT = "Gitlab Ruby Gem #{Gitlab::VERSION}"
 
     # @private
     attr_accessor(*VALID_OPTIONS_KEYS)
     # @private
-    alias_method :auth_token=, :private_token=
+    alias auth_token= private_token=
 
     # Sets all configuration options to their default values
     # when this module is extended.
@@ -33,8 +35,9 @@ module Gitlab
 
     # Resets all configuration options to the defaults.
     def reset
-      self.endpoint       = ENV['GITLAB_API_ENDPOINT']
+      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
@@ -44,11 +47,11 @@ module Gitlab
 
     # Allows HTTParty config to be specified in ENV using YAML hash.
     def get_httparty_config(options)
-      return options if options.nil?
+      return if options.nil?
 
       httparty = Gitlab::CLI::Helpers.yaml_load(options)
-
       raise ArgumentError, 'HTTParty config should be a Hash.' unless httparty.is_a? Hash
+
       Gitlab::CLI::Helpers.symbolize_keys httparty
     end
   end

data/lib/gitlab/error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   module Error
     # Custom error class for rescuing from all Gitlab errors.
@@ -11,7 +13,7 @@ module Gitlab
 
     # Custom error class for rescuing from HTTP response errors.
     class ResponseError < Error
-      POSSIBLE_MESSAGE_KEYS = %i(message error_description error)
+      POSSIBLE_MESSAGE_KEYS = %i[message error_description error].freeze
 
       def initialize(response)
         @response = response
@@ -32,13 +34,24 @@ module Gitlab
         @response.parsed_response.message
       end
 
+      # Additional error context returned by some API endpoints
+      #
+      # @return [String]
+      def error_code
+        if @response.respond_to?(:error_code)
+          @response.error_code
+        else
+          ''
+        end
+      end
+
       private
 
       # Human friendly message.
       #
       # @return [String]
       def build_error_message
-        parsed_response = @response.parsed_response
+        parsed_response = classified_response
         message = check_error_keys(parsed_response)
         "Server responded with code #{@response.code}, message: " \
         "#{handle_message(message)}. " \
@@ -52,12 +65,31 @@ module Gitlab
         key ? resp.send(key) : resp
       end
 
+      # Parse the body based on the classification of the body content type
+      #
+      # @return parsed response
+      def classified_response
+        if @response.respond_to?('headers')
+          @response.headers['content-type'] == 'text/plain' ? { message: @response.to_s } : @response.parsed_response
+        else
+          @response.parsed_response
+        end
+      rescue Gitlab::Error::Parsing
+        # Return stringified response when receiving a
+        # parsing error to avoid obfuscation of the
+        # api error.
+        #
+        # note: The Gitlab API does not always return valid
+        # JSON when there are errors.
+        @response.to_s
+      end
+
       # Handle error response message in case of nested hashes
       def handle_message(message)
         case message
         when Gitlab::ObjectifiedHash
           message.to_h.sort.map do |key, val|
-            "'#{key}' #{(val.is_a?(Hash) ? val.sort.map { |k, v| "(#{k}: #{v.join(' ')})" } : val).join(' ')}"
+            "'#{key}' #{(val.is_a?(Hash) ? val.sort.map { |k, v| "(#{k}: #{v.join(' ')})" } : [val].flatten).join(' ')}"
           end.join(', ')
         when Array
           message.join(' ')
@@ -82,12 +114,18 @@ module Gitlab
     # Raised when API endpoint returns the HTTP status code 405.
     class MethodNotAllowed < ResponseError; end
 
+    # Raised when API endpoint returns the HTTP status code 406.
+    class NotAcceptable < ResponseError; end
+
     # Raised when API endpoint returns the HTTP status code 409.
     class Conflict < ResponseError; end
 
     # Raised when API endpoint returns the HTTP status code 422.
     class Unprocessable < ResponseError; end
 
+    # Raised when API endpoint returns the HTTP status code 429.
+    class TooManyRequests < ResponseError; end
+
     # Raised when API endpoint returns the HTTP status code 500.
     class InternalServerError < ResponseError; end
 
@@ -96,5 +134,37 @@ 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,
+      401 => Unauthorized,
+      403 => Forbidden,
+      404 => NotFound,
+      405 => MethodNotAllowed,
+      406 => NotAcceptable,
+      409 => Conflict,
+      422 => Unprocessable,
+      429 => TooManyRequests,
+      500 => InternalServerError,
+      502 => BadGateway,
+      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/file_response.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module Gitlab
   # Wrapper class of file response.
   class FileResponse
-    HEADER_CONTENT_DISPOSITION = 'Content-Disposition'.freeze
+    HEADER_CONTENT_DISPOSITION = 'Content-Disposition'
 
     attr_reader :filename
 
@@ -18,7 +20,7 @@ module Gitlab
     def to_hash
       { filename: @filename, data: @file }
     end
-    alias_method :to_h, :to_hash
+    alias to_h to_hash
 
     # @return [String] Formatted string with the class name, object id and filename.
     def inspect

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="([^"]+)"/
+      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+$/
+
+      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/help.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'gitlab'
 require 'gitlab/cli_helpers'
 
@@ -32,9 +34,7 @@ module Gitlab::Help
     # @return [String]
     def ri_cmd
       which_ri = `which ri`.chomp
-      if which_ri.empty?
-        raise "'ri' tool not found in $PATH. Please install it to use the help."
-      end
+      raise "'ri' tool not found in $PATH. Please install it to use the help." if which_ri.empty?
 
       which_ri
     end
@@ -45,20 +45,19 @@ 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::)?/, '')
+          key = client.method(action)
+                      .owner.to_s.gsub(/Gitlab::(?:Client::)?/, '')
           hsh[key] ||= []
           hsh[key] << action.to_s
         end
-      end
     end
 
     # Table with available commands.
     #
     # @return [Terminal::Table]
-    def actions_table(topic=nil)
+    def actions_table(topic = nil)
       rows = topic ? help_map[topic] : help_map.keys
       table do |t|
         t.title = topic || 'Help Topics'
@@ -73,22 +72,23 @@ 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] }.
-        shift
+      method_owners.select { |method| method[:name] == cmd }
+                   .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

@@ -1,34 +1,51 @@
+# frozen_string_literal: true
+
 module Gitlab
   # Converts hashes to the objects.
   class ObjectifiedHash
     # Creates a new ObjectifiedHash object.
     def initialize(hash)
       @hash = hash
-      @data = hash.inject({}) do |data, (key, value)|
-        value = ObjectifiedHash.new(value) if value.is_a? Hash
+      @data = hash.each_with_object({}) do |(key, value), data|
+        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
-        data
       end
     end
 
     # @return [Hash] The original hash.
     def to_hash
-      @hash
+      hash
     end
-    alias_method :to_h, :to_hash
+    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
+
+    def [](key)
+      data[key]
     end
 
-    # Delegate to ObjectifiedHash.
-    def method_missing(key)
-      @data.key?(key.to_s) ? @data[key.to_s] : nil
+    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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   # Wrapper class of paginated response.
   class PaginatedResponse
@@ -28,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
@@ -40,58 +43,73 @@ 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
+    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 has_last_page?
+    def total
+      @total.total
+    end
+
+    def last_page?
       !(@links.nil? || @links.last.nil?)
     end
+    alias has_last_page? last_page?
 
     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 has_first_page?
+    def first_page?
       !(@links.nil? || @links.first.nil?)
     end
+    alias has_first_page? first_page?
 
     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 has_next_page?
+    def next_page?
       !(@links.nil? || @links.next.nil?)
     end
+    alias has_next_page? next_page?
 
     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 has_prev_page?
+    def prev_page?
       !(@links.nil? || @links.prev.nil?)
     end
+    alias has_prev_page? prev_page?
 
     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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'httparty'
 require 'json'
 
@@ -6,10 +8,11 @@ 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) }
+    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)
@@ -23,8 +26,6 @@ module Gitlab
         true
       elsif !body
         false
-      elsif body.nil?
-        false
       else
         raise Error::Parsing, "Couldn't parse a response body"
       end
@@ -32,35 +33,41 @@ module Gitlab
 
     # Decodes a JSON response into Ruby object.
     def self.decode(response)
-      return response ? JSON.load(response) : {}     
+      response ? JSON.load(response) : {}
     rescue JSON::ParserError
       raise Error::Parsing, 'The response is not a valid JSON'
     end
 
-    %w(get post put delete).each do |method|
-      define_method method do |path, options={}|
-        httparty_config(options)
-        authorization_header(options)
-        validate self.class.send(method, @endpoint + path, options)
+    %w[get post put patch delete].each do |method|
+      define_method method do |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 = case response.code
-                    when 400 then Error::BadRequest
-                    when 401 then Error::Unauthorized
-                    when 403 then Error::Forbidden
-                    when 404 then Error::NotFound
-                    when 405 then Error::MethodNotAllowed
-                    when 409 then Error::Conflict
-                    when 422 then Error::Unprocessable
-                    when 500 then Error::InternalServerError
-                    when 502 then Error::BadGateway
-                    when 503 then Error::ServiceUnavailable
-                    end
-
+      error_klass = Error.klass(response)
       raise error_klass, response if error_klass
 
       parsed = response.parsed_response
@@ -71,28 +78,35 @@ module Gitlab
 
     # Sets a base_uri and default_params for requests.
     # @raise [Error::MissingCredentials] if endpoint not set.
-    def request_defaults(sudo=nil)
+    def request_defaults(sudo = nil)
+      raise Error::MissingCredentials, 'Please set an endpoint to API' unless endpoint
+
       self.class.default_params sudo: sudo
-      raise Error::MissingCredentials, 'Please set an endpoint to API' unless @endpoint
       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
+
+      # 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
+        { 'JOB-TOKEN' => private_token }
+      end
     end
 
     # Set HTTParty configuration