Class: Grape::Middleware::Base

Inherits:
Object
  • Object
show all
Includes:
DSL::Headers
Defined in:
lib/grape/middleware/base.rb

Constant Summary collapse

TEXT_HTML =
'text/html'.freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from DSL::Headers

#header

Constructor Details

#initialize(app, **options) ⇒ Base

Returns a new instance of Base

Parameters:

  • app (Rack Application)

    The standard argument for a Rack middleware.

  • options (Hash)

    A hash of options, simply stored for use by subclasses.



13
14
15
16
17
# File 'lib/grape/middleware/base.rb', line 13

def initialize(app, **options)
  @app = app
  @options = default_options.merge(**options)
  @app_response = nil
end

Instance Attribute Details

#appObject (readonly)

Returns the value of attribute app



6
7
8
# File 'lib/grape/middleware/base.rb', line 6

def app
  @app
end

#envObject (readonly)

Returns the value of attribute env



6
7
8
# File 'lib/grape/middleware/base.rb', line 6

def env
  @env
end

#optionsObject (readonly)

Returns the value of attribute options



6
7
8
# File 'lib/grape/middleware/base.rb', line 6

def options
  @options
end

Instance Method Details

#afterResponse?

This method is abstract.

Called after the application is called in the middleware lifecycle.

Returns:

  • (Response, nil)

    a Rack SPEC response or nil to call the application afterwards.



53
# File 'lib/grape/middleware/base.rb', line 53

def after; end

#beforeObject

This method is abstract.

Called before the application is called in the middleware lifecycle.



48
# File 'lib/grape/middleware/base.rb', line 48

def before; end

#call(env) ⇒ Object



23
24
25
# File 'lib/grape/middleware/base.rb', line 23

def call(env)
  dup.call!(env)
end

#call!(env) ⇒ Object



27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
# File 'lib/grape/middleware/base.rb', line 27

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_typeObject



68
69
70
# File 'lib/grape/middleware/base.rb', line 68

def content_type
  content_type_for(env[Grape::Env::API_FORMAT] || options[:format]) || TEXT_HTML
end

#content_type_for(format) ⇒ Object



60
61
62
# File 'lib/grape/middleware/base.rb', line 60

def content_type_for(format)
  HashWithIndifferentAccess.new(content_types)[format]
end

#content_typesObject



64
65
66
# File 'lib/grape/middleware/base.rb', line 64

def content_types
  ContentTypes.content_types_for(options[:content_types])
end

#default_optionsObject



19
20
21
# File 'lib/grape/middleware/base.rb', line 19

def default_options
  {}
end

#mime_typesObject



72
73
74
75
76
77
78
# File 'lib/grape/middleware/base.rb', line 72

def mime_types
  types_without_params = {}
  content_types.each_pair do |k, v|
    types_without_params[v.split(';').first] = k
  end
  types_without_params
end

#responseObject



55
56
57
58
# File 'lib/grape/middleware/base.rb', line 55

def response
  return @app_response if @app_response.is_a?(Rack::Response)
  Rack::Response.new(@app_response[2], @app_response[0], @app_response[1])
end