Class: Grape::Middleware::Base

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

Instance Attribute Summary collapse

Instance Method Summary collapse

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) (defaults to: {}) —

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



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

def initialize(app, options = {})
  @app = app
  @options = default_options.merge(options)
end

Instance Attribute Details

#app ⇒ Object (readonly)

Returns the value of attribute app.



9
10
11
 
# File 'lib/grape/middleware/base.rb', line 9

def app
  @app
end

#env ⇒ Object (readonly)

Returns the value of attribute env.



9
10
11
 
# File 'lib/grape/middleware/base.rb', line 9

def env
  @env
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



9
10
11
 
# File 'lib/grape/middleware/base.rb', line 9

def options
  @options
end

Instance Method Details

#after ⇒ Response?

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.



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

def after; end

#before ⇒ Object

This method is abstract.

Called before the application is called in the middleware lifecycle.



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

def before; end

#call(env) ⇒ Object 



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

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

#call!(env) ⇒ Object 



26
27
28
29
30
31
 
# File 'lib/grape/middleware/base.rb', line 26

def call!(env)
  @env = env
  before
  @app_response = @app.call(@env)
  after || @app_response
end

#content_type ⇒ Object 



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

def content_type
  content_type_for(env['api.format'] || options[:format]) || 'text/html'
end

#content_type_for(format) ⇒ Object 



49
50
51
 
# File 'lib/grape/middleware/base.rb', line 49

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

#content_types ⇒ Object 



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

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

#default_options ⇒ Object 



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

def default_options
  {}
end

#mime_types ⇒ Object 



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

def mime_types
  content_types.invert
end

#request ⇒ Object 



41
42
43
 
# File 'lib/grape/middleware/base.rb', line 41

def request
  Rack::Request.new(self.env)
end

#response ⇒ Object 



45
46
47
 
# File 'lib/grape/middleware/base.rb', line 45

def response
  Rack::Response.new(@app_response)
end