Module: Grape::DSL::InsideRoute

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

Instance Attribute Summary

Attributes included from Settings

#inheritable_setting, #top_level_setting

Instance Method Summary collapse

Methods included from Settings

#api_class_setting, #get_or_set, #global_setting, #namespace_end, #namespace_inheritable, #namespace_inheritable_to_nil, #namespace_setting, #namespace_stackable, #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

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"


150
151
152
153
154
155
156
157
158
159
# File 'lib/grape/dsl/inside_route.rb', line 150

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

#content_type(val = nil) ⇒ Object

Set response content-type



120
121
122
123
124
125
126
# File 'lib/grape/dsl/inside_route.rb', line 120

def content_type(val = nil)
  if val
    header('Content-Type', val)
  else
    header['Content-Type']
  end
end

#cookiesObject

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


136
137
138
# File 'lib/grape/dsl/inside_route.rb', line 136

def cookies
  @cookies ||= Cookies.new
end

#declared(params, options = {}, declared_params = nil) ⇒ 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) (defaults to: {})

    Can pass :include_missing, :stringify and :include_parent_namespaces



18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
# File 'lib/grape/dsl/inside_route.rb', line 18

def declared(params, options = {}, declared_params = nil)
  options[:include_missing] = true unless options.key?(:include_missing)
  options[:include_parent_namespaces] = true unless options.key?(:include_parent_namespaces)
  if declared_params.nil?
    declared_params = (!options[:include_parent_namespaces] ? route_setting(:declared_params) :
        (route_setting(:saved_declared_params) || [])).flatten(1) || []
  end

  unless declared_params
    fail ArgumentError, 'Tried to filter for declared parameters but none exist.'
  end

  if params.is_a? Array
    params.map do |param|
      declared(param || {}, options, declared_params)
    end
  else
    declared_params.inject({}) do |hash, key|
      key = { key => nil } unless key.is_a? Hash

      key.each_pair do |parent, children|
        output_key = options[:stringify] ? parent.to_s : parent.to_sym

        next unless options[:include_missing] || children || params[parent]

        if params.key?(parent) || options[:include_missing]
          hash[output_key] = if children
                               declared(params[parent] || {}, options, Array(children))
                             else
                               params[parent]
                             end
        end
      end

      hash
    end
  end
end

#entity_class_for_obj(object, options) ⇒ Object



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
# File 'lib/grape/dsl/inside_route.rb', line 217

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

  if entity_class.nil?
    # entity class not explicitely 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 ||= (Grape::DSL::Configuration.stacked_hash_to_hash(namespace_stackable(: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

#error!(message, status = nil, headers = 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.



67
68
69
70
# File 'lib/grape/dsl/inside_route.rb', line 67

def error!(message, status = nil, headers = nil)
  self.status(status || namespace_inheritable(:default_error_status))
  throw :error, message: message, status: self.status, headers: headers
end

#header(key = nil, val = nil) ⇒ Object

Set an individual header or retrieve all headers that have been set.



111
112
113
114
115
116
117
# File 'lib/grape/dsl/inside_route.rb', line 111

def header(key = nil, val = nil)
  if key
    val ? @header[key.to_s] = val : @header.delete(key.to_s)
  else
    @header
  end
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


176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
# File 'lib/grape/dsl/inside_route.rb', line 176

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
                     embeds = { env: env }
                     embeds[:version] = env['api.version'] if env['api.version']
                     entity_class.represent(object, embeds.merge(options))
                   else
                     object
                   end

  representation = { root => representation } if root
  if key
    representation = (@body || {}).merge(key => representation)
  elsif entity_class.present? && representation.respond_to?('merge')
    representation = (@body || {}).merge(representation)
  end

  body representation
end

#redirect(url, options = {}) ⇒ Object

Redirect to a new url.

Parameters:

  • url (String)

    The url to be redirect.

  • options (Hash) (defaults to: {})

    The options used when redirect. :permanent, default false.



77
78
79
80
81
82
83
84
85
86
87
88
89
90
# File 'lib/grape/dsl/inside_route.rb', line 77

def redirect(url, options = {})
  merged_options = { permanent: false }.merge(options)
  if merged_options[:permanent]
    status 301
  else
    if env['HTTP_VERSION'] == 'HTTP/1.1' && request.request_method.to_s.upcase != 'GET'
      status 303
    else
      status 302
    end
  end
  header 'Location', url
  body ''
end

#routeObject

Returns route information for the current request.

Examples:


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


213
214
215
# File 'lib/grape/dsl/inside_route.rb', line 213

def route
  env['rack.routing_args'][:route_info]
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.



95
96
97
98
99
100
101
102
103
104
105
106
107
# File 'lib/grape/dsl/inside_route.rb', line 95

def status(status = nil)
  if status
    @status = status
  else
    return @status if @status
    case request.request_method.to_s.upcase
    when 'POST'
      201
    else
      200
    end
  end
end

#versionObject

The API version as specified in the URL.



58
59
60
# File 'lib/grape/dsl/inside_route.rb', line 58

def version
  env['api.version']
end