Module: Grape::DSL::InsideRoute

Extended by:
ActiveSupport::Concern
Includes:
Headers, Settings
Included in:
Endpoint
Defined in:
lib/grape/dsl/inside_route.rb

Defined Under Namespace

Modules: PostBeforeFilter Classes: MethodNotYetAvailable

Instance Attribute Summary

Attributes included from Settings

#inheritable_setting, #top_level_setting

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Headers

#header

Methods included from Settings

#api_class_setting, #get_or_set, #global_setting, #namespace_end, #namespace_inheritable, #namespace_inheritable_to_nil, #namespace_reverse_stackable, #namespace_reverse_stackable_with_hash, #namespace_setting, #namespace_stackable, #namespace_stackable_with_hash, #namespace_start, #route_end, #route_setting, #unset, #unset_api_class_setting, #unset_global_setting, #unset_namespace_inheritable, #unset_namespace_setting, #unset_namespace_stackable, #unset_route_setting, #within_namespace

Class Method Details

.post_filter_methods(type) ⇒ Module

Returns A module containing method overrides suitable for the position in the filter evaluation sequence denoted by type. This defaults to an empty module if no overrides are defined for the given filter type.

Parameters:

  • type (Symbol) —

    The type of filter for which evaluation has been completed

Returns:

  • (Module) —

    A module containing method overrides suitable for the position in the filter evaluation sequence denoted by type. This defaults to an empty module if no overrides are defined for the given filter type.



20
21
22
23
 
# File 'lib/grape/dsl/inside_route.rb', line 20

def self.post_filter_methods(type)
  @post_filter_modules ||= { before: PostBeforeFilter }
  @post_filter_modules[type]
end

Instance Method Details

#body(value = nil) ⇒ Object

Allows you to define the response body as something other than the return value.

Examples:

get '/body' do
  body "Body"
  "Not the Body"
end

GET /body # => "Body"


283
284
285
286
287
288
289
290
291
292
 
# File 'lib/grape/dsl/inside_route.rb', line 283

def body(value = nil)
  if value
    @body = value
  elsif value == false
    @body = ''
    status 204
  else
    instance_variable_defined?(:@body) ? @body : nil
  end
end

#configuration ⇒ Object 



158
159
160
 
# File 'lib/grape/dsl/inside_route.rb', line 158

def configuration
  options[:for].configuration.evaluate
end

#content_type(val = nil) ⇒ Object

Set response content-type



253
254
255
256
257
258
259
 
# File 'lib/grape/dsl/inside_route.rb', line 253

def content_type(val = nil)
  if val
    header(Rack::CONTENT_TYPE, val)
  else
    header[Rack::CONTENT_TYPE]
  end
end

#context ⇒ Object 



472
473
474
 
# File 'lib/grape/dsl/inside_route.rb', line 472

def context
  self
end

#cookies ⇒ Object

Set or get a cookie

Examples:

cookies[:mycookie] = 'mycookie val'
cookies['mycookie-string'] = 'mycookie string val'
cookies[:more] = { value: '123', expires: Time.at(0) }
cookies.delete :more


269
270
271
 
# File 'lib/grape/dsl/inside_route.rb', line 269

def cookies
  @cookies ||= Cookies.new
end

#declared ⇒ Object

A filtering method that will return a hash consisting only of keys that have been declared by a ‘params` statement against the current/target endpoint or parent namespaces.

options. ‘:include_parent_namespaces` defaults to true, hence must be set to false if you want only to return params declared against the current/target endpoint.

Parameters:

  • params (Hash) —

    The initial hash to filter. Usually this will just be ‘params`

  • options (Hash) —

    Can pass ‘:include_missing`, `:stringify` and `:include_parent_namespaces`

Raises:

See Also:

  • Grape::DSL::InsideRoute.+PostBeforeFilter+PostBeforeFilter#declared+


149
150
151
 
# File 'lib/grape/dsl/inside_route.rb', line 149

def declared(*)
  raise MethodNotYetAvailable, '#declared is not available prior to parameter validation.'
end

#entity_class_for_obj(object, options) ⇒ Class

Attempt to locate the Entity class for a given object, if not given explicitly. This is done by looking for the presence of Klass::Entity, where Klass is the class of the ‘object` parameter, or one of its ancestors.

Parameters:

  • object (Object) —

    the object to locate the Entity class for

  • options (Hash)

Options Hash (options):

  • :with (Class) —

    the explicit entity class to use

Returns:

  • (Class) —

    the located Entity class, or nil if none is found



439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
 
# File 'lib/grape/dsl/inside_route.rb', line 439

def entity_class_for_obj(object, options)
  entity_class = options.delete(:with)

  if entity_class.nil?
    # entity class not explicitly defined, auto-detect from relation#klass or first object in the collection
    object_class = if object.respond_to?(:klass)
                     object.klass
                   else
                     object.respond_to?(:first) ? object.first.class : object.class
                   end

    object_class.ancestors.each do |potential|
      entity_class ||= (namespace_stackable_with_hash(:representations) || {})[potential]
    end

    entity_class ||= object_class.const_get(:Entity) if object_class.const_defined?(:Entity) && object_class.const_get(:Entity).respond_to?(:represent)
  end

  entity_class
end

#entity_representation_for(entity_class, object, options) ⇒ Object

Returns the representation of the given object as done through the given entity_class.

Returns:

  • the representation of the given object as done through the given entity_class.



462
463
464
465
466
 
# File 'lib/grape/dsl/inside_route.rb', line 462

def entity_representation_for(entity_class, object, options)
  embeds = { env: env }
  embeds[:version] = env[Grape::Env::API_VERSION] if env.key?(Grape::Env::API_VERSION)
  entity_class.represent(object, **embeds.merge(options))
end

#error!(message, status = nil, additional_headers = nil, backtrace = nil, original_exception = nil) ⇒ Object

End the request and display an error to the end user with the specified message.

Parameters:

  • message (String) —

    The message to display.

  • status (Integer) (defaults to: nil) —

    The HTTP Status Code. Defaults to default_error_status, 500 if not set.

  • additional_headers (Hash) (defaults to: nil) —

    Addtional headers for the response.

  • backtrace (Array<String>) (defaults to: nil) —

    The backtrace of the exception that caused the error.

  • original_exception (Exception) (defaults to: nil) —

    The original exception that caused the error.



170
171
172
173
174
175
176
177
178
179
 
# File 'lib/grape/dsl/inside_route.rb', line 170

def error!(message, status = nil, additional_headers = nil, backtrace = nil, original_exception = nil)
  status = self.status(status || namespace_inheritable(:default_error_status))
  headers = additional_headers.present? ? header.merge(additional_headers) : header
  throw :error,
        message: message,
        status: status,
        headers: headers,
        backtrace: backtrace,
        original_exception: original_exception
end

#file(value = nil) ⇒ Object

Deprecated method to send files to the client. Use ‘sendfile` or `stream`



309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/grape/dsl/inside_route.rb', line 309

def file(value = nil)
  if value.is_a?(String)
    Grape.deprecator.warn('Use sendfile or stream to send files.')
    sendfile(value)
  elsif !value.is_a?(NilClass)
    Grape.deprecator.warn('Use stream to use a Stream object.')
    stream(value)
  else
    Grape.deprecator.warn('Use sendfile or stream to send files.')
    sendfile
  end
end

#http_version ⇒ Object 



468
469
470
 
# File 'lib/grape/dsl/inside_route.rb', line 468

def http_version
  env['HTTP_VERSION'] || env[Rack::SERVER_PROTOCOL]
end

#present(*args) ⇒ Object

Allows you to make use of Grape Entities by setting the response body to the serializable hash of the entity provided in the ‘:with` option. This has the added benefit of automatically passing along environment and version information to the serialization, making it very easy to do conditional exposures. See Entity docs for more info.

Examples:


get '/users/:id' do
  present User.find(params[:id]),
    with: API::Entities::User,
    admin: current_user.admin?
end


389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
 
# File 'lib/grape/dsl/inside_route.rb', line 389

def present(*args)
  options = args.count > 1 ? args.extract_options! : {}
  key, object = if args.count == 2 && args.first.is_a?(Symbol)
                  args
                else
                  [nil, args.first]
                end
  entity_class = entity_class_for_obj(object, options)

  root = options.delete(:root)

  representation = if entity_class
                     entity_representation_for(entity_class, object, options)
                   else
                     object
                   end

  representation = { root => representation } if root

  if key
    representation = (body || {}).merge(key => representation)
  elsif entity_class.present? && body
    raise ArgumentError, "Representation of type #{representation.class} cannot be merged." unless representation.respond_to?(:merge)

    representation = body.merge(representation)
  end

  body representation
end

#rack_response(message, status = 200, headers = { Rack::CONTENT_TYPE => content_type }) ⇒ Object

Creates a Rack response based on the provided message, status, and headers. The content type in the headers is set to the default content type unless provided. The message is HTML-escaped if the content type is ‘text/html’.

Returns: A Rack::Response object containing the specified message, status, and headers.

Parameters:

  • message (String) —

    The content of the response.

  • status (Integer) (defaults to: 200) —

    The HTTP status code.



193
194
195
196
197
 
# File 'lib/grape/dsl/inside_route.rb', line 193

def rack_response(message, status = 200, headers = { Rack::CONTENT_TYPE => content_type })
  Grape.deprecator.warn('The rack_response method has been deprecated, use error! instead.')
  message = Rack::Utils.escape_html(message) if headers[Rack::CONTENT_TYPE] == 'text/html'
  Rack::Response.new(Array.wrap(message), Rack::Utils.status_code(status), headers)
end

#redirect(url, permanent: false, body: nil, **_options) ⇒ Object

Redirect to a new url.

Parameters:

  • url (String) —

    The url to be redirect.

  • options (Hash) —

    The options used when redirect. :permanent, default false. :body, default a short message including the URL.



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/grape/dsl/inside_route.rb', line 205

def redirect(url, permanent: false, body: nil, **_options)
  body_message = body
  if permanent
    status 301
    body_message ||= "This resource has been moved permanently to #{url}."
  elsif http_version == 'HTTP/1.1' && !request.get?
    status 303
    body_message ||= "An alternate resource is located at #{url}."
  else
    status 302
    body_message ||= "This resource has been moved temporarily to #{url}."
  end
  header Grape::Http::Headers::LOCATION, url
  content_type 'text/plain'
  body body_message
end

#return_no_content ⇒ Object

Allows you to explicitly return no content.

Examples:

delete :id do
  return_no_content
  "not returned"
end

DELETE /12 # => 204 No Content, ""


303
304
305
306
 
# File 'lib/grape/dsl/inside_route.rb', line 303

def return_no_content
  status 204
  body false
end

#route ⇒ Object

Returns route information for the current request.

Examples:


desc "Returns the route description."
get '/' do
  route.description
end


427
428
429
 
# File 'lib/grape/dsl/inside_route.rb', line 427

def route
  env[Grape::Env::GRAPE_ROUTING_ARGS][:route_info]
end

#sendfile(value = nil) ⇒ Object

Allows you to send a file to the client via sendfile.

Examples:

get '/file' do
  sendfile FileStreamer.new(...)
end

GET /file # => "contents of file"


330
331
332
333
334
335
336
337
338
339
 
# File 'lib/grape/dsl/inside_route.rb', line 330

def sendfile(value = nil)
  if value.is_a?(String)
    file_body = Grape::ServeStream::FileBody.new(value)
    @stream = Grape::ServeStream::StreamResponse.new(file_body)
  elsif !value.is_a?(NilClass)
    raise ArgumentError, 'Argument must be a file path'
  else
    stream
  end
end

#status(status = nil) ⇒ Object

Set or retrieve the HTTP status code.

Parameters:

  • status (Integer) (defaults to: nil) —

    The HTTP Status Code to return for this request.



225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/grape/dsl/inside_route.rb', line 225

def status(status = nil)
  case status
  when Symbol
    raise ArgumentError, "Status code :#{status} is invalid." unless Rack::Utils::SYMBOL_TO_STATUS_CODE.key?(status)

    @status = Rack::Utils.status_code(status)
  when Integer
    @status = status
  when nil
    return @status if instance_variable_defined?(:@status) && @status

    if request.post?
      201
    elsif request.delete?
      if instance_variable_defined?(:@body) && @body.present?
        200
      else
        204
      end
    else
      200
    end
  else
    raise ArgumentError, 'Status code must be Integer or Symbol.'
  end
end

#stream(value = nil) ⇒ Object

Allows you to define the response as a streamable object.

If Content-Length and Transfer-Encoding are blank (among other conditions), Rack assumes this response can be streamed in chunks.

See:

Examples:

get '/stream' do
  stream FileStreamer.new(...)
end

GET /stream # => "chunked contents of file"


356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
 
# File 'lib/grape/dsl/inside_route.rb', line 356

def stream(value = nil)
  return if value.nil? && @stream.nil?

  header Rack::CONTENT_LENGTH, nil
  header Grape::Http::Headers::TRANSFER_ENCODING, nil
  header Rack::CACHE_CONTROL, 'no-cache' # Skips ETag generation (reading the response up front)
  if value.is_a?(String)
    file_body = Grape::ServeStream::FileBody.new(value)
    @stream = Grape::ServeStream::StreamResponse.new(file_body)
  elsif value.respond_to?(:each)
    @stream = Grape::ServeStream::StreamResponse.new(value)
  elsif !value.is_a?(NilClass)
    raise ArgumentError, 'Stream object must respond to :each.'
  else
    @stream
  end
end

#version ⇒ Object

The API version as specified in the URL.



154
155
156
 
# File 'lib/grape/dsl/inside_route.rb', line 154

def version
  env[Grape::Env::API_VERSION]
end