Class | Fission::Response |
In: |
lib/fission/response.rb
|
Parent: | Object |
code | [RW] | Public: Gets/Sets the code (Integer). |
data | [RW] | Public: Gets/Sets the data (can be any of type as needed). |
message | [RW] | Public: Gets/Sets the message (String). |
Internal: Helper method to create a new Response object when using executing a command through Fission::Action::ShellExecutor.
shell_execute_result - This should be the result of running ‘execute’ on
a ShellExecutor object.
Examples:
Response.from_shell_executor shell_execute_result
Returns a Response. The code attribute of the Response will be set to the exit_status attribute of the provided process_status data. The message attribute of the Response will be set to the output of the provided data if, and only if, the Response is unsuccessful.
Public: Initialize a Response object.
args - Hash of arguments:
:code - Integer which denotes the code of the Response. This is similar in concept to command line exit codes. The convention is that 0 denotes success and any other value is unsuccessful (default: 1). :message - String which denotes the message of the Response. The convention is that this should only be used when the Response is unsuccessful (default: ''). :data - Any valid ruby object. This is used to convey any data that needs to be used by a caller. The convention is that this should only be used when the Response is successful (default nil).
Examples
Response.new :code => 0, :data => [1, 2, 3, 4] Response.new :code => 0, :data => true Response.new :code => 5, :message => 'Something went wrong'