Class: Zaius::ZaiusResponse
- Inherits:
-
Object
- Object
- Zaius::ZaiusResponse
- Defined in:
- lib/zaius/zaius_response.rb
Overview
ZaiusResponse encapsulates some vitals of a response that came back from the Zaius API.
Instance Attribute Summary collapse
-
#data ⇒ Object
The data contained by the HTTP body of the response deserialized from JSON.
-
#http_body ⇒ Object
The raw HTTP body of the response.
-
#http_headers ⇒ Object
A Hash of the HTTP headers of the response.
-
#http_status ⇒ Object
The integer HTTP status code of the response.
Class Method Summary collapse
-
.from_faraday_hash(http_resp) ⇒ Object
Initializes a ZaiusResponse object from a Hash like the kind returned as part of a Faraday exception.
-
.from_faraday_response(http_resp) ⇒ Object
Initializes a ZaiusResponse object from a Faraday HTTP response object.
Instance Attribute Details
#data ⇒ Object
The data contained by the HTTP body of the response deserialized from JSON.
9 10 11 |
# File 'lib/zaius/zaius_response.rb', line 9 def data @data end |
#http_body ⇒ Object
The raw HTTP body of the response.
12 13 14 |
# File 'lib/zaius/zaius_response.rb', line 12 def http_body @http_body end |
#http_headers ⇒ Object
A Hash of the HTTP headers of the response.
15 16 17 |
# File 'lib/zaius/zaius_response.rb', line 15 def http_headers @http_headers end |
#http_status ⇒ Object
The integer HTTP status code of the response.
18 19 20 |
# File 'lib/zaius/zaius_response.rb', line 18 def http_status @http_status end |
Class Method Details
.from_faraday_hash(http_resp) ⇒ Object
Initializes a ZaiusResponse object from a Hash like the kind returned as part of a Faraday exception.
This may throw JSON::ParserError if the response body is not valid JSON.
24 25 26 27 28 29 30 31 |
# File 'lib/zaius/zaius_response.rb', line 24 def self.from_faraday_hash(http_resp) resp = ZaiusResponse.new resp.data = JSON.parse(http_resp[:body], symbolize_names: true) resp.http_body = http_resp[:body] resp.http_headers = http_resp[:headers] resp.http_status = http_resp[:status] resp end |
.from_faraday_response(http_resp) ⇒ Object
Initializes a ZaiusResponse object from a Faraday HTTP response object.
This may throw JSON::ParserError if the response body is not valid JSON.
36 37 38 39 40 41 42 43 |
# File 'lib/zaius/zaius_response.rb', line 36 def self.from_faraday_response(http_resp) resp = ZaiusResponse.new resp.data = JSON.parse(http_resp.body, symbolize_names: true) resp.http_body = http_resp.body resp.http_headers = http_resp.headers resp.http_status = http_resp.status resp end |