class Sonarqube::Request

@private

Attributes

endpoint[RW]
private_token[RW]

Public Class Methods

decode(response) click to toggle source

Decodes a JSON response into Ruby object.

# File lib/sonarqube/request.rb, line 34
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/sonarqube/request.rb, line 17
def self.parse(body)
  body = decode(body)

  if body.is_a? Hash
    ObjectifiedHash.new body
  elsif body
    true
  elsif !body
    false
  elsif body.nil?
    false
  else
    raise Error::Parsing, "Couldn't parse a response body"
  end
end

Public Instance Methods

request_defaults() click to toggle source

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

# File lib/sonarqube/request.rb, line 69
def request_defaults
  raise Error::MissingCredentials, 'Please set an endpoint to API' unless @endpoint

  self.class.default_params
end
validate(response) click to toggle source

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

# File lib/sonarqube/request.rb, line 57
def validate(response)
  error_klass = Error::STATUS_MAPPINGS[response.code]
  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/sonarqube/request.rb, line 80
def authorization_header
  raise Error::MissingCredentials, 'Please provide a private_token for user' unless @private_token

  { 'Authorization' => "Basic #{Base64.encode64("#{private_token}:")}" }
end
httparty_config(options) click to toggle source

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

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