Codebase list ruby-gitlab / c321896 lib / gitlab / request.rb
c321896

Tree @c321896 (Download .tar.gz)

request.rb @c321896raw · history · blame

require 'httparty'
require 'json'

module Gitlab
  # @private
  class Request
    include HTTParty
    format :json
    headers 'Accept' => 'application/json', 'Content-Type' => 'application/x-www-form-urlencoded'
    parser proc { |body, _| parse(body) }

    attr_accessor :private_token, :endpoint

    # Converts the response body to an ObjectifiedHash.
    def self.parse(body)
      body = decode(body)

      if body.is_a? Hash
        ObjectifiedHash.new body
      elsif body.is_a? Array
        PaginatedResponse.new(body.collect! { |e| ObjectifiedHash.new(e) })
      elsif body
        true
      elsif !body
        false
      elsif body.nil?
        false
      else
        raise Error::Parsing, "Couldn't parse a response body"
      end
    end

    # Decodes a JSON response into Ruby object.
    def self.decode(response)
      return 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)
      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

      raise error_klass, response if error_klass

      parsed = response.parsed_response
      parsed.client = self if parsed.respond_to?(:client=)
      parsed.parse_headers!(response.headers) if parsed.respond_to?(:parse_headers!)
      parsed
    end

    # 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
      self.class.default_params.delete(:sudo) if sudo.nil?
    end

    private

    # Sets a PRIVATE-TOKEN or Authorization header for requests.
    #
    # @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
    end

    # Set HTTParty configuration
    # @see https://github.com/jnunemaker/httparty
    def httparty_config(options)
      options.merge!(httparty) if httparty
    end
  end
end