Class: Apidiesel::Request
- Inherits:
-
Object
- Object
- Apidiesel::Request
- Defined in:
- lib/apidiesel/request.rb
Overview
Wrapper for API requests
Instance Attribute Summary collapse
-
#action ⇒ Object
Returns the value of attribute action.
-
#action_arguments ⇒ Object
Returns the value of attribute action_arguments.
-
#http_request ⇒ Object
Returns the value of attribute http_request.
-
#http_response ⇒ Object
Returns the value of attribute http_response.
-
#metadata ⇒ Object
Returns the value of attribute metadata.
-
#parameters ⇒ Object
Returns the value of attribute parameters.
-
#response_body ⇒ Object
Returns the value of attribute response_body.
-
#result ⇒ Object
Returns the value of attribute result.
-
#url ⇒ Object
Returns the value of attribute url.
Instance Method Summary collapse
-
#initialize(action:, action_arguments:, parameters:, metadata: {}) ⇒ Request
constructor
A new instance of Request.
- #process_response ⇒ Object
- #to_s ⇒ Object
Constructor Details
#initialize(action:, action_arguments:, parameters:, metadata: {}) ⇒ Request
Returns a new instance of Request.
11 12 13 14 15 16 |
# File 'lib/apidiesel/request.rb', line 11 def initialize(action:, action_arguments:, parameters:, metadata: {}) @action = action @action_arguments = action_arguments @parameters = parameters @metadata = end |
Instance Attribute Details
#action ⇒ Object
Returns the value of attribute action.
5 6 7 |
# File 'lib/apidiesel/request.rb', line 5 def action @action end |
#action_arguments ⇒ Object
Returns the value of attribute action_arguments.
5 6 7 |
# File 'lib/apidiesel/request.rb', line 5 def action_arguments @action_arguments end |
#http_request ⇒ Object
Returns the value of attribute http_request.
5 6 7 |
# File 'lib/apidiesel/request.rb', line 5 def http_request @http_request end |
#http_response ⇒ Object
Returns the value of attribute http_response.
5 6 7 |
# File 'lib/apidiesel/request.rb', line 5 def http_response @http_response end |
#metadata ⇒ Object
Returns the value of attribute metadata.
5 6 7 |
# File 'lib/apidiesel/request.rb', line 5 def @metadata end |
#parameters ⇒ Object
Returns the value of attribute parameters.
5 6 7 |
# File 'lib/apidiesel/request.rb', line 5 def parameters @parameters end |
#response_body ⇒ Object
Returns the value of attribute response_body.
5 6 7 |
# File 'lib/apidiesel/request.rb', line 5 def response_body @response_body end |
#result ⇒ Object
Returns the value of attribute result.
5 6 7 |
# File 'lib/apidiesel/request.rb', line 5 def result @result end |
#url ⇒ Object
Returns the value of attribute url.
5 6 7 |
# File 'lib/apidiesel/request.rb', line 5 def url @url end |
Instance Method Details
#process_response ⇒ Object
22 23 24 25 26 27 28 29 30 31 |
# File 'lib/apidiesel/request.rb', line 22 def process_response # Reraise ResponseErrors to include ourselves. Not # pretty, but I can't think of anything nicer right now begin @result = action.process_response(response_body) rescue ResponseError => e e.request = self raise e end end |
#to_s ⇒ Object
33 34 35 36 37 38 39 40 41 |
# File 'lib/apidiesel/request.rb', line 33 def to_s [ "Apidiesel::Request", action.http_method.to_s.upcase, url.try(:to_s), action.endpoint, parameters.collect { |key, value| "#{key}: #{value}"}.join(',') ].join(' ') end |