Exception: MaxBotApi::ApiError

Inherits:
Error
  • Object
show all
Defined in:
lib/max_bot_api/errors.rb

Overview

Raised when the API responds with a non-200 status code.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(code:, message:, details: nil) ⇒ ApiError

Returns a new instance of ApiError.

Parameters:

  • code (Integer) —

    HTTP status code

  • message (String) —

    error message

  • details (String, nil) (defaults to: nil) —

    optional details



19
20
21
22
23
24
 
# File 'lib/max_bot_api/errors.rb', line 19

def initialize(code:, message:, details: nil)
  @code = code
  @message = message
  @details = details
  super(build_message)
end

Instance Attribute Details

#code ⇒ Object (readonly)

Returns the value of attribute code.



14
15
16
 
# File 'lib/max_bot_api/errors.rb', line 14

def code
  @code
end

#details ⇒ Object (readonly)

Returns the value of attribute details.



14
15
16
 
# File 'lib/max_bot_api/errors.rb', line 14

def details
  @details
end

#message ⇒ Object (readonly)

Returns the value of attribute message.



14
15
16
 
# File 'lib/max_bot_api/errors.rb', line 14

def message
  @message
end

Instance Method Details

#==(other) ⇒ Object 



26
27
28
 
# File 'lib/max_bot_api/errors.rb', line 26

def ==(other)
  other.is_a?(ApiError) && other.code == code
end

#attachment_not_ready? ⇒ Boolean

Returns:

  • (Boolean) 


30
31
32
 
# File 'lib/max_bot_api/errors.rb', line 30

def attachment_not_ready?
  message == 'attachment.not.ready'
end