Exception: SignWell::ApiError

Inherits:
StandardError
  • Object
show all
Defined in:
lib/signwell_sdk/api_error.rb

Overview

Base error class for all SignWell errors.

Direct Known Subclasses

ApiConnectionError, ApiStatusError

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(arg = nil) ⇒ ApiError

Usage examples: ApiError.new ApiError.new("message") ApiError.new(:code => 500, :response_headers => {}, :response_body => "") ApiError.new(:code => 404, :message => "Not Found")



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/signwell_sdk/api_error.rb', line 23

def initialize(arg = nil)
  if arg.is_a? Hash
    if arg.key?(:message) || arg.key?('message')
      super(arg[:message] || arg['message'])
    else
      super arg
    end

    arg.each do |k, v|
      instance_variable_set "@#{k}", v
    end

    # Parse the response body as JSON if present
    if @response_body.is_a?(String) && !@response_body.empty?
      begin
        @body = JSON.parse(@response_body, symbolize_names: true)
      rescue JSON::ParserError
        @body = nil
      end
    end
  else
    super arg
    @message = arg
  end
end

Instance Attribute Details

#body ⇒ Object (readonly)

Returns the value of attribute body.



16
17
18
 
# File 'lib/signwell_sdk/api_error.rb', line 16

def body
  @body
end

#code ⇒ Object (readonly)

Returns the value of attribute code.



16
17
18
 
# File 'lib/signwell_sdk/api_error.rb', line 16

def code
  @code
end

#response_body ⇒ Object (readonly)

Returns the value of attribute response_body.



16
17
18
 
# File 'lib/signwell_sdk/api_error.rb', line 16

def response_body
  @response_body
end

#response_headers ⇒ Object (readonly)

Returns the value of attribute response_headers.



16
17
18
 
# File 'lib/signwell_sdk/api_error.rb', line 16

def response_headers
  @response_headers
end

Instance Method Details

#message ⇒ Object 



54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/signwell_sdk/api_error.rb', line 54

def message
  if @message.nil?
    msg = "Error message: the server returns an error"
  else
    msg = @message
  end

  msg += "\nHTTP status code: #{code}" if code
  msg += "\nResponse headers: #{response_headers}" if response_headers
  msg += "\nResponse body: #{response_body}" if response_body

  msg
end

#to_s ⇒ Object

Override to_s to display a friendly error message



50
51
52
 
# File 'lib/signwell_sdk/api_error.rb', line 50

def to_s
  message
end