class Gitlab::Request
@private
Attributes
Public Class Methods
Source
# 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
Decodes a JSON response into Ruby object.
Source
# 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
Converts the response body to an ObjectifiedHash
.
Public Instance Methods
Source
# File lib/gitlab/request.rb, line 83 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
Sets a base_uri and default_params for requests. @raise [Error::MissingCredentials] if endpoint not set.
Source
# File lib/gitlab/request.rb, line 71 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
Checks the response code for common errors. Returns parsed response for successful requests.
Private Instance Methods
Source
# File lib/gitlab/request.rb, line 116 def httparty_config(options) options.merge!(httparty) if httparty end
Set HTTParty configuration @see github.com/jnunemaker/httparty
Source
# File lib/gitlab/request.rb, line 122 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
Handle ‘body_as_json’ configuration option Modifies passed params in place.