Exception: ScreenshotScout::APIError

Inherits:
Error
  • Object
show all
Defined in:
lib/screenshotscout/errors.rb,
sig/screenshotscout.rbs

Overview

Raised for every non-2xx response returned by the Screenshot Scout API.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(raw_response:, response_body_available:, response_body: nil, error_code: nil, error_message: nil, errors: nil) ⇒ APIError

Returns a new instance of APIError.



27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/screenshotscout/errors.rb', line 27

def initialize(
  raw_response:,
  response_body_available:,
  response_body: nil,
  error_code: nil,
  error_message: nil,
  errors: nil
)
  super(error_message || "Screenshot Scout API request failed with status #{raw_response.status}.")
  @status = raw_response.status
  @error_code = error_code
  @error_message = error_message
  @errors = errors
  @response_body_available = response_body_available
  @response_body = response_body
  @raw_response = raw_response
end

Instance Attribute Details

#error_code ⇒ String? (readonly)

Returns the value of attribute error_code.

Returns:

  • (String, nil) 


25
26
27
 
# File 'lib/screenshotscout/errors.rb', line 25

def error_code
  @error_code
end

#error_message ⇒ String? (readonly)

Returns the value of attribute error_message.

Returns:

  • (String, nil) 


25
26
27
 
# File 'lib/screenshotscout/errors.rb', line 25

def error_message
  @error_message
end

#errors ⇒ Array[json_value]? (readonly)

Returns the value of attribute errors.

Returns:

  • (Array[json_value], nil) 


25
26
27
 
# File 'lib/screenshotscout/errors.rb', line 25

def errors
  @errors
end

#raw_response ⇒ RawResponse (readonly)

Returns the value of attribute raw_response.

Returns:



25
26
27
 
# File 'lib/screenshotscout/errors.rb', line 25

def raw_response
  @raw_response
end

#response_body ⇒ json_value (readonly)

Returns the value of attribute response_body.

Returns:

  • (json_value) 


25
26
27
 
# File 'lib/screenshotscout/errors.rb', line 25

def response_body
  @response_body
end

#status ⇒ Integer (readonly)

Returns the value of attribute status.

Returns:

  • (Integer) 


25
26
27
 
# File 'lib/screenshotscout/errors.rb', line 25

def status
  @status
end

Instance Method Details

#response_body? ⇒ Boolean

Returns:

  • (Boolean) 


45
46
47
 
# File 'lib/screenshotscout/errors.rb', line 45

def response_body?
  @response_body_available
end