Class: HelpScoutDocs::Result

Inherits:
Object
  • Object
show all
Defined in:
lib/help_scout_docs/result.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(response) ⇒ Result

Initialize a new Response, throw exception for fatal errors

Parameters:

  • result (Hash) 


8
9
10
 
# File 'lib/help_scout_docs/result.rb', line 8

def initialize(response)
  @response = response
end

Instance Attribute Details

#response ⇒ Object (readonly)

Returns the value of attribute response.



3
4
5
 
# File 'lib/help_scout_docs/result.rb', line 3

def response
  @response
end

Instance Method Details

#error? ⇒ Boolean

Was there an error?

Returns:

  • (Boolean) 


22
23
24
 
# File 'lib/help_scout_docs/result.rb', line 22

def error?
  response.is_a?(Hash) ? response.has_key?(:status) : false
end

#message ⇒ Object 



26
27
28
29
 
# File 'lib/help_scout_docs/result.rb', line 26

def message
  return unless error?
  response.fetch(:message)
end

#success? ⇒ Boolean

Was it successful?

Returns:

  • (Boolean) 


15
16
17
 
# File 'lib/help_scout_docs/result.rb', line 15

def success?
  !error?
end