Class: Bling::API::Response

Inherits:
Object
  • Object
show all
Defined in:
lib/bling/api/response.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(http_response, klass_name) ⇒ Response

Returns a new instance of Response.

Parameters:

  • http_response (Net::HTTPResponse) —

    The response object returned by Net::HTTP.


9
10
11
12
 
# File 'lib/bling/api/response.rb', line 9

def initialize(http_response, klass_name)
  @http_response = http_response
  @klass_name = klass_name
end

Instance Attribute Details

#http_response ⇒ Net::HTTPResponse (readonly)

Returns The response object returned by Net::HTTP.

Returns:

  • (Net::HTTPResponse) —

    The response object returned by Net::HTTP.


6
7
8
 
# File 'lib/bling/api/response.rb', line 6

def http_response
  @http_response
end

Instance Method Details

#body ⇒ String

Returns The raw body of the response object.

Returns:

  • (String) —

    The raw body of the response object.


15
16
17
 
# File 'lib/bling/api/response.rb', line 15

def body
  @http_response.body
end

#http_failure? ⇒ Boolean

Returns Whether or not the HTTP request was a success.

Returns:

  • (Boolean) —

    Whether or not the HTTP request was a success.


25
26
27
 
# File 'lib/bling/api/response.rb', line 25

def http_failure?
  !@http_response.is_a?(Net::HTTPSuccess)
end

#records ⇒ Array

Returns with parsed response body.

Returns:

  • (Array) —

    with parsed response body.


30
31
32
 
# File 'lib/bling/api/response.rb', line 30

def records
  parsed_response.records if success?
end

#success? ⇒ Boolean

Returns Whether or not the request was successful.

Returns:

  • (Boolean) —

    Whether or not the request was successful.


20
21
22
 
# File 'lib/bling/api/response.rb', line 20

def success?
  !http_failure? && without_errors
end