class Gitlab::Request
@private
def self.decode(response)
def self.decode(response) response ? JSON.load(response) : {} rescue JSON::ParserError raise Error::Parsing, 'The response is not a valid JSON' end
def self.parse(body)
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
def authorization_header(options)
-
(Error::MissingCredentials)
- if private_token and auth_token are not set.
Options Hash:
(**options)
-
:unauthenticated
(Boolean
) -- true if the API call does not require user authentication.
Parameters:
-
options
(Hash
) -- A customizable set of options.
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
def httparty_config(options)
- See: https://github.com/jnunemaker/httparty -
def httparty_config(options) options.merge!(httparty) if httparty end
def request_defaults(sudo = nil)
-
(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
def validate(response)
Checks the response code for common errors.
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