class Grape::Middleware::Error
Public Class Methods
new(app, **options)
click to toggle source
Calls superclass method
Grape::Middleware::Base.new
# File lib/grape/middleware/error.rb, line 28 def initialize(app, **options) super self.class.send(:include, @options[:helpers]) if @options[:helpers] end
Public Instance Methods
call!(env)
click to toggle source
# File lib/grape/middleware/error.rb, line 33 def call!(env) @env = env begin error_response(catch(:error) do return @app.call(@env) end) rescue Exception => error # rubocop:disable Lint/RescueException handler = rescue_handler_for_base_only_class(error.class) || rescue_handler_for_class_or_its_ancestor(error.class) || rescue_handler_for_grape_exception(error.class) || rescue_handler_for_any_class(error.class) || raise run_rescue_handler(handler, error) end end
default_options()
click to toggle source
# File lib/grape/middleware/error.rb, line 7 def default_options { default_status: 500, # default status returned on error default_message: '', format: :txt, helpers: nil, formatters: {}, error_formatters: {}, rescue_all: false, # true to rescue all exceptions rescue_grape_exceptions: false, rescue_subclasses: true, # rescue subclasses of exceptions listed rescue_options: { backtrace: false, # true to display backtrace, true to let Grape handle Grape::Exceptions original_exception: false, # true to display exception }, rescue_handlers: {}, # rescue handler blocks base_only_rescue_handlers: {}, # rescue handler blocks rescuing only the base class all_rescue_handler: nil # rescue handler block to rescue from all exceptions } end
default_rescue_handler(e)
click to toggle source
# File lib/grape/middleware/error.rb, line 57 def default_rescue_handler(e) error_response(message: e.message, backtrace: e.backtrace, original_exception: e) end
error!(message, status = options[:default_status], headers = {}, backtrace = [], original_exception = nil)
click to toggle source
# File lib/grape/middleware/error.rb, line 52 def error!(message, status = options[:default_status], headers = {}, backtrace = [], original_exception = nil) headers = headers.reverse_merge(Grape::Http::Headers::CONTENT_TYPE => content_type) rack_response(format_message(message, backtrace, original_exception), status, headers) end
error_response(error = {})
click to toggle source
TODO: This method is deprecated. Refactor out.
# File lib/grape/middleware/error.rb, line 62 def error_response(error = {}) status = error[:status] || options[:default_status] message = error[:message] || options[:default_message] headers = { Grape::Http::Headers::CONTENT_TYPE => content_type } headers.merge!(error[:headers]) if error[:headers].is_a?(Hash) backtrace = error[:backtrace] || error[:original_exception] && error[:original_exception].backtrace || [] original_exception = error.is_a?(Exception) ? error : error[:original_exception] || nil rack_response(format_message(message, backtrace, original_exception), status, headers) end
format_message(message, backtrace, original_exception = nil)
click to toggle source
# File lib/grape/middleware/error.rb, line 79 def format_message(message, backtrace, original_exception = nil) format = env[Grape::Env::API_FORMAT] || options[:format] formatter = Grape::ErrorFormatter.formatter_for(format, options) throw :error, status: 406, message: "The requested format '#{format}' is not supported.", backtrace: backtrace, original_exception: original_exception unless formatter formatter.call(message, backtrace, options, env, original_exception) end
rack_response(message, status = options[:default_status], headers = { Grape::Http::Headers::CONTENT_TYPE => content_type })
click to toggle source
# File lib/grape/middleware/error.rb, line 72 def rack_response(message, status = options[:default_status], headers = { Grape::Http::Headers::CONTENT_TYPE => content_type }) if headers[Grape::Http::Headers::CONTENT_TYPE] == TEXT_HTML message = ERB::Util.html_escape(message) end Rack::Response.new([message], status, headers).finish end
Private Instance Methods
rescue_handler_for_any_class(klass)
click to toggle source
# File lib/grape/middleware/error.rb, line 116 def rescue_handler_for_any_class(klass) return unless klass <= StandardError return unless options[:rescue_all] || options[:rescue_grape_exceptions] options[:all_rescue_handler] || :default_rescue_handler end
rescue_handler_for_base_only_class(klass)
click to toggle source
# File lib/grape/middleware/error.rb, line 92 def rescue_handler_for_base_only_class(klass) error, handler = options[:base_only_rescue_handlers].find { |err, _handler| klass == err } return unless error handler || :default_rescue_handler end
rescue_handler_for_class_or_its_ancestor(klass)
click to toggle source
# File lib/grape/middleware/error.rb, line 100 def rescue_handler_for_class_or_its_ancestor(klass) error, handler = options[:rescue_handlers].find { |err, _handler| klass <= err } return unless error handler || :default_rescue_handler end
rescue_handler_for_grape_exception(klass)
click to toggle source
# File lib/grape/middleware/error.rb, line 108 def rescue_handler_for_grape_exception(klass) return unless klass <= Grape::Exceptions::Base return :error_response if klass == Grape::Exceptions::InvalidVersionHeader return unless options[:rescue_grape_exceptions] || !options[:rescue_all] :error_response end
run_rescue_handler(handler, error)
click to toggle source
# File lib/grape/middleware/error.rb, line 123 def run_rescue_handler(handler, error) if handler.instance_of?(Symbol) raise NoMethodError, "undefined method `#{handler}'" unless respond_to?(handler) handler = public_method(handler) end handler.arity.zero? ? instance_exec(&handler) : instance_exec(error, &handler) end