Class: Bandwidth::ApiResponse

Inherits:
Object
  • Object
show all
Defined in:
lib/bandwidth/http/api_response.rb

Overview

Http response received.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(http_response, data: nil, errors: nil) ⇒ ApiResponse

The constructor

Parameters:

  • The (HttpResponse) —

    original, raw response from the api.

  • The (Object) —

    data field specified for the response.

  • Any (Array<String>) —

    errors returned by the server.



16
17
18
19
20
21
22
23
24
25
26
 
# File 'lib/bandwidth/http/api_response.rb', line 16

def initialize(http_response,
               data: nil,
               errors: nil)
  @status_code = http_response.status_code
  @reason_phrase = http_response.reason_phrase
  @headers = http_response.headers
  @raw_body = http_response.raw_body
  @request = http_response.request
  @data = data
  @errors = errors
end

Instance Attribute Details

#data ⇒ Object (readonly)

Returns the value of attribute data.



9
10
11
 
# File 'lib/bandwidth/http/api_response.rb', line 9

def data
  @data
end

#errors ⇒ Object (readonly)

Returns the value of attribute errors.



9
10
11
 
# File 'lib/bandwidth/http/api_response.rb', line 9

def errors
  @errors
end

#headers ⇒ Object (readonly)

Returns the value of attribute headers.



9
10
11
 
# File 'lib/bandwidth/http/api_response.rb', line 9

def headers
  @headers
end

#raw_body ⇒ Object (readonly)

Returns the value of attribute raw_body.



9
10
11
 
# File 'lib/bandwidth/http/api_response.rb', line 9

def raw_body
  @raw_body
end

#reason_phrase ⇒ Object (readonly)

Returns the value of attribute reason_phrase.



9
10
11
 
# File 'lib/bandwidth/http/api_response.rb', line 9

def reason_phrase
  @reason_phrase
end

#request ⇒ Object (readonly)

Returns the value of attribute request.



9
10
11
 
# File 'lib/bandwidth/http/api_response.rb', line 9

def request
  @request
end

#status_code ⇒ Object (readonly)

Returns the value of attribute status_code.



9
10
11
 
# File 'lib/bandwidth/http/api_response.rb', line 9

def status_code
  @status_code
end

Instance Method Details

#error? ⇒ Boolean

returns true if status_code is between 400-600

Returns:

  • (Boolean) 


34
35
36
 
# File 'lib/bandwidth/http/api_response.rb', line 34

def error?
  status_code >= 400 && status_code < 600
end

#success? ⇒ Boolean

returns true if status_code is between 200-300

Returns:

  • (Boolean) 


29
30
31
 
# File 'lib/bandwidth/http/api_response.rb', line 29

def success?
  status_code >= 200 && status_code < 300
end