class Grape::Middleware::Base

Constants

TEXT_HTML

Attributes

app[R]
env[R]
options[R]

Public Class Methods

new(app, *options) click to toggle source

@param [Rack Application] app The standard argument for a Rack middleware. @param [Hash] options A hash of options, simply stored for use by subclasses.

# File lib/grape/middleware/base.rb, line 15
def initialize(app, *options)
  @app = app
  @options = options.any? ? default_options.deep_merge(options.shift) : default_options
  @app_response = nil
end

Public Instance Methods

after() click to toggle source

@abstract Called after the application is called in the middleware lifecycle. @return [Response, nil] a Rack SPEC response or nil to call the application afterwards.

# File lib/grape/middleware/base.rb, line 55
def after; end
before() click to toggle source

@abstract Called before the application is called in the middleware lifecycle.

# File lib/grape/middleware/base.rb, line 50
def before; end
call(env) click to toggle source
# File lib/grape/middleware/base.rb, line 25
def call(env)
  dup.call!(env).to_a
end
call!(env) click to toggle source
# File lib/grape/middleware/base.rb, line 29
def call!(env)
  @env = env
  before
  begin
    @app_response = @app.call(@env)
  ensure
    begin
      after_response = after
    rescue StandardError => e
      warn "caught error of type #{e.class} in after callback inside #{self.class.name} : #{e.message}"
      raise e
    end
  end

  response = after_response || @app_response
  merge_headers response
  response
end
content_type() click to toggle source
# File lib/grape/middleware/base.rb, line 75
def content_type
  content_type_for(env[Grape::Env::API_FORMAT] || options[:format]) || TEXT_HTML
end
content_type_for(format) click to toggle source
# File lib/grape/middleware/base.rb, line 71
def content_type_for(format)
  content_types_indifferent_access[format]
end
content_types() click to toggle source
# File lib/grape/middleware/base.rb, line 63
def content_types
  @content_types ||= Grape::ContentTypes.content_types_for(options[:content_types])
end
default_options() click to toggle source
# File lib/grape/middleware/base.rb, line 21
def default_options
  {}
end
mime_types() click to toggle source
# File lib/grape/middleware/base.rb, line 67
def mime_types
  @mime_types ||= Grape::ContentTypes.mime_types_for(content_types)
end
response() click to toggle source
# File lib/grape/middleware/base.rb, line 57
def response
  return @app_response if @app_response.is_a?(Rack::Response)

  @app_response = Rack::Response.new(@app_response[2], @app_response[0], @app_response[1])
end

Private Instance Methods

content_types_indifferent_access() click to toggle source
# File lib/grape/middleware/base.rb, line 90
def content_types_indifferent_access
  @content_types_indifferent_access ||= content_types.with_indifferent_access
end
merge_headers(response) click to toggle source
# File lib/grape/middleware/base.rb, line 81
def merge_headers(response)
  return unless headers.is_a?(Hash)

  case response
  when Rack::Response then response.headers.merge!(headers)
  when Array          then response[1].merge!(headers)
  end
end