Exception: Algolia::ApiError

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

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")


12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
# File 'lib/algolia/api_error.rb', line 12

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

    arg.each do |k, v|
      instance_variable_set("@#{k}", v)
    end
  else
    super
    @message = arg
  end
end

Instance Attribute Details

#codeObject (readonly)

Returns the value of attribute code.



5
6
7
# File 'lib/algolia/api_error.rb', line 5

def code
  @code
end

#response_bodyObject (readonly)

Returns the value of attribute response_body.



5
6
7
# File 'lib/algolia/api_error.rb', line 5

def response_body
  @response_body
end

#response_headersObject (readonly)

Returns the value of attribute response_headers.



5
6
7
# File 'lib/algolia/api_error.rb', line 5

def response_headers
  @response_headers
end

Instance Method Details

#messageObject



34
35
36
37
38
39
40
41
42
43
44
45
46
# File 'lib/algolia/api_error.rb', line 34

def message
  msg = if @message.nil?
    "Error message: the server returns an error"
  else
    @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_sObject

Override to_s to display a friendly error message



30
31
32
# File 'lib/algolia/api_error.rb', line 30

def to_s
  message
end