Class: Grape::Middleware::Base
- Inherits:
-
Object
- Object
- Grape::Middleware::Base
- Includes:
- DSL::Headers
- Defined in:
- lib/grape/middleware/base.rb
Direct Known Subclasses
Error, Filter, Formatter, Globals, Versioner::AcceptVersionHeader, Versioner::Header, Versioner::Param, Versioner::Path
Constant Summary collapse
- TEXT_HTML =
'text/html'.freeze
Instance Attribute Summary collapse
-
#app ⇒ Object
readonly
Returns the value of attribute app.
-
#env ⇒ Object
readonly
Returns the value of attribute env.
-
#options ⇒ Object
readonly
Returns the value of attribute options.
Instance Method Summary collapse
-
#after ⇒ Response?
abstract
Called after the application is called in the middleware lifecycle.
-
#before ⇒ Object
abstract
Called before the application is called in the middleware lifecycle.
- #call(env) ⇒ Object
- #call!(env) ⇒ Object
- #content_type ⇒ Object
- #content_type_for(format) ⇒ Object
- #content_types ⇒ Object
- #default_options ⇒ Object
-
#initialize(app, **options) ⇒ Base
constructor
A new instance of Base.
- #mime_types ⇒ Object
- #response ⇒ Object
Methods included from DSL::Headers
Constructor Details
#initialize(app, **options) ⇒ Base
Returns a new instance of Base.
13 14 15 16 17 |
# File 'lib/grape/middleware/base.rb', line 13 def initialize(app, **) @app = app @options = .merge(**) @app_response = nil end |
Instance Attribute Details
#app ⇒ Object (readonly)
Returns the value of attribute app.
6 7 8 |
# File 'lib/grape/middleware/base.rb', line 6 def app @app end |
#env ⇒ Object (readonly)
Returns the value of attribute env.
6 7 8 |
# File 'lib/grape/middleware/base.rb', line 6 def env @env end |
#options ⇒ Object (readonly)
Returns the value of attribute options.
6 7 8 |
# File 'lib/grape/middleware/base.rb', line 6 def @options end |
Instance Method Details
#after ⇒ Response?
This method is abstract.
Called after the application is called in the middleware lifecycle.
53 |
# File 'lib/grape/middleware/base.rb', line 53 def after; end |
#before ⇒ Object
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.}" raise e end end response = after_response || @app_response merge_headers response response end |
#content_type ⇒ Object
68 69 70 |
# File 'lib/grape/middleware/base.rb', line 68 def content_type content_type_for(env[Grape::Env::API_FORMAT] || [: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_types ⇒ Object
64 65 66 |
# File 'lib/grape/middleware/base.rb', line 64 def content_types ContentTypes.content_types_for([:content_types]) end |
#default_options ⇒ Object
19 20 21 |
# File 'lib/grape/middleware/base.rb', line 19 def {} end |
#mime_types ⇒ Object
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 |