enhancement: error.message should return a string.

[xiaoronglv]

Problem

Sentry is a popular exception monitoring tool for ruby, but it fails to
capture the error raised by checkr ruby gem.

After some investigation, I found the checkr sometime set an array to
the exception message.

Here is an example

exception.message
=> ["First name must only contain letters, numbers, spaces, hyphens, apostrophes, periods, and commas."]

Usually, ruby exception's message method should return a string as an
abstraction of error and developer save the detail information to
internal instance variable.

Solution

This PR is to convert the message variable to a string to avoid crashing
the monitoring tool.

Related PR

Sentry crashes when error message is an array.

getsentry/sentry-ruby#1879

[xiaoronglv]

Hi @akshay-8d66 ,

could you please help to review this bugfix when you get time?

[st0012]

I think the real question is: why does message need to be redefined?

This should also work while preserving the behavior of Exception#message

module Checkr
  class CheckrError < StandardError
    attr_reader :http_status
    attr_reader :http_body
    attr_reader :json_body

    def initialize(message=nil, http_status=nil, http_body=nil, json_body=nil)
      super(message)
      @http_status = http_status
      @http_body = http_body
      @json_body = json_body
    end
  end
end