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 else raise Error::Parsing, "Couldn't parse a response body" end end
def authorization_header
-
(Error::MissingCredentials)
- if private_token and auth_token are not set.
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
def httparty_config(options)
- See: https://github.com/jnunemaker/httparty -
def httparty_config(options) options.merge!(httparty) if httparty end
def jsonify_body_content(params)
Handle 'body_as_json' configuration option
def jsonify_body_content(params) # Only modify the content type if there is a body to process AND multipath # was not explicitly requested. There are no uses of multipart in this code # today, but file upload methods require it and someone might be manually # crafting a post call with it: return unless params[:body] && params[:multipart] != true # If the caller explicitly requested a Content-Type during the call, assume # they know best and have formatted the body as required: return if params[:headers]&.key?('Content-Type') # If we make it here, then we assume it is safe to JSON encode the body: params[:headers] ||= {} params[:headers]['Content-Type'] = 'application/json' params[:body] = params[:body].to_json end
def request_defaults(sudo = nil)
-
(Error::MissingCredentials)
- if endpoint not set.
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
def validate(response)
Checks the response code for common errors.
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