class Gitlab::Request

@private

Attributes

endpoint[RW]
pat_prefix[RW]
private_token[RW]

Public Class Methods

decode(response) click to toggle source

Decodes a JSON response into Ruby object.

# File lib/gitlab/request.rb, line 35
def self.decode(response)
  response ? JSON.load(response) : {}
rescue JSON::ParserError
  raise Error::Parsing, 'The response is not a valid JSON'
end
parse(body) click to toggle source

Converts the response body to an ObjectifiedHash.

# File lib/gitlab/request.rb, line 18
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
  else
    raise Error::Parsing, "Couldn't parse a response body"
  end
end

Public Instance Methods

request_defaults(sudo = nil) click to toggle source

Sets a base_uri and default_params for requests. @raise [Error::MissingCredentials] if endpoint not set.

# File lib/gitlab/request.rb, line 81
def request_defaults(sudo = nil)
  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
validate(response) click to toggle source

Checks the response code for common errors. Returns parsed response for successful requests.

# File lib/gitlab/request.rb, line 69
def validate(response)
  error_klass = Error.klass(response)
  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

Private Instance Methods

authorization_header() click to toggle source

Returns an Authorization header hash

@raise [Error::MissingCredentials] if private_token and auth_token are not set.

# File lib/gitlab/request.rb, line 93
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
httparty_config(options) click to toggle source

Set HTTParty configuration @see github.com/jnunemaker/httparty

# File lib/gitlab/request.rb, line 114
def httparty_config(options)
  options.merge!(httparty) if httparty
end