Class: Grape::Middleware::Error

Inherits:
Base
  • Object
show all
Includes:
Formats
Defined in:
lib/grape/middleware/error.rb

Instance Attribute Summary

Attributes inherited from Base

#app, #env, #options

Instance Method Summary collapse

Methods inherited from Base

#after, #before, #call, #initialize, #request, #response

Constructor Details

This class inherits a constructor from Grape::Middleware::Base

Instance Method Details

#call!(env) ⇒ Object 



39
40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/grape/middleware/error.rb', line 39

def call!(env)
  @env = env
  
  begin
    error_response(catch(:error){ 
      return @app.call(@env) 
    })
  rescue Exception => e
    raise unless options[:rescue_all] || (options[:rescued_errors] || []).include?(e.class)
    handler = options[:rescue_handlers][e.class] || options[:rescue_handlers][:all]
    handler.nil? ? handle_error(e) : self.instance_exec(e, &handler)
  end
  
end

#default_options ⇒ Object 



9
10
11
12
13
14
15
16
17
18
19
20
 
# File 'lib/grape/middleware/error.rb', line 9

def default_options
{ 
  :default_status => 403, # default status returned on error
  :default_message => "",
  :format => :txt,
  :formatters => {},
  :rescue_all => false, # true to rescue all exceptions        
  :rescue_options => { :backtrace => false }, # true to display backtrace
  :rescue_handlers => {}, # rescue handler blocks
  :rescued_errors => []
}
end

#encode_json(message, backtrace) ⇒ Object 



22
23
24
25
26
27
28
 
# File 'lib/grape/middleware/error.rb', line 22

def encode_json(message, backtrace)
  result = message.is_a?(Hash) ? message : { :error => message }
  if (options[:rescue_options] || {})[:backtrace] && backtrace && ! backtrace.empty?
    result = result.merge({ :backtrace => backtrace })
  end
  MultiJson.dump(result)
end

#encode_txt(message, backtrace) ⇒ Object 



30
31
32
33
34
35
36
37
 
# File 'lib/grape/middleware/error.rb', line 30

def encode_txt(message, backtrace)
  result = message.is_a?(Hash) ? MultiJson.dump(message) : message
  if (options[:rescue_options] || {})[:backtrace] && backtrace && ! backtrace.empty?
    result += "\r\n "
    result += backtrace.join("\r\n ")
  end
  result
end

#error_response(error = {}) ⇒ Object 



58
59
60
61
62
63
64
65
 
# File 'lib/grape/middleware/error.rb', line 58

def error_response(error = {})
  status = error[:status] || options[:default_status]
  message = error[:message] || options[:default_message]
  headers = {'Content-Type' => content_type}
  headers.merge!(error[:headers]) if error[:headers].is_a?(Hash)
  backtrace = error[:backtrace] || []
  rack_response(format_message(message, backtrace, status), status, headers)
end

#format_message(message, backtrace, status) ⇒ Object 



71
72
73
74
75
 
# File 'lib/grape/middleware/error.rb', line 71

def format_message(message, backtrace, status)
  formatter = formatter_for(options[:format])
  throw :error, :status => 406, :message => "The requested format #{options[:format]} is not supported." unless formatter
  formatter.call(message, backtrace)
end

#handle_error(e) ⇒ Object 



54
55
56
 
# File 'lib/grape/middleware/error.rb', line 54

def handle_error(e)
  error_response({ :message => e.message, :backtrace => e.backtrace })
end

#rack_response(message, status = , headers = { 'Content-Type' => content_type }) ⇒ Object 



67
68
69
 
# File 'lib/grape/middleware/error.rb', line 67

def rack_response(message, status = options[:default_status], headers = { 'Content-Type' => content_type })
  Rack::Response.new([ message ], status, headers).finish
end