forked from ruby-grape/grape
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathendpoint.rb
324 lines (268 loc) · 10.6 KB
/
endpoint.rb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
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
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
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
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
module Grape
# An Endpoint is the proxy scope in which all routing
# blocks are executed. In other words, any methods
# on the instance level of this class may be called
# from inside a `get`, `post`, etc.
class Endpoint
include Grape::DSL::Settings
attr_accessor :block, :source, :options
attr_reader :env, :request, :headers, :params
include Grape::DSL::InsideRoute
class << self
def before_each(new_setup = false, &block)
if new_setup == false
if block_given?
@before_each = block
else
return @before_each
end
else
@before_each = new_setup
end
end
# @api private
#
# Create an UnboundMethod that is appropriate for executing an endpoint
# route.
#
# The unbound method allows explicit calls to +return+ without raising a
# +LocalJumpError+. The method will be removed, but a +Proc+ reference to
# it will be returned. The returned +Proc+ expects a single argument: the
# instance of +Endpoint+ to bind to the method during the call.
#
# @param [String, Symbol] method_name
# @return [Proc]
# @raise [NameError] an instance method with the same name already exists
def generate_api_method(method_name, &block)
if instance_methods.include?(method_name.to_sym) || instance_methods.include?(method_name.to_s)
raise NameError.new("method #{method_name.inspect} already exists and cannot be used as an unbound method name")
end
define_method(method_name, &block)
method = instance_method(method_name)
remove_method(method_name)
proc { |endpoint_instance| method.bind(endpoint_instance).call }
end
end
def initialize(new_settings, options = {}, &block)
require_option(options, :path)
require_option(options, :method)
self.inheritable_setting = new_settings.point_in_time_copy
route_setting(:saved_declared_params, namespace_stackable(:declared_params))
route_setting(:saved_validations, namespace_stackable(:validations))
namespace_stackable(:representations, []) unless namespace_stackable(:representations)
namespace_inheritable(:default_error_status, 500) unless namespace_inheritable(:default_error_status)
@options = options
@options[:path] = Array(options[:path])
@options[:path] << '/' if options[:path].empty?
@options[:method] = Array(options[:method])
@options[:route_options] ||= {}
if block_given?
@source = block
@block = self.class.generate_api_method(method_name, &block)
end
end
def require_option(options, key)
raise Grape::Exceptions::MissingOption.new(key) unless options.key?(key)
end
def method_name
[options[:method],
Namespace.joined_space(namespace_stackable(:namespace)),
(namespace_stackable(:mount_path) || []).join('/'),
options[:path].join('/')
].join(" ")
end
def routes
@routes ||= endpoints ? endpoints.collect(&:routes).flatten : prepare_routes
end
def reset_routes!
endpoints.map(&:reset_routes!) if endpoints
@namespace = nil
@routes = nil
end
def mount_in(route_set)
if endpoints
endpoints.each { |e|
e.inheritable_setting.inherit_from inheritable_setting
e.mount_in(route_set)
}
else
@routes = nil
routes.each do |route|
methods = [route.route_method]
if !namespace_inheritable(:do_not_route_head) && route.route_method == "GET"
methods << "HEAD"
end
methods.each do |method|
route_set.add_route(self, {
path_info: route.route_compiled,
request_method: method
}, route_info: route)
end
end
end
end
def prepare_routes_requirements
endpoint_requirements = options[:route_options][:requirements] || {}
all_requirements = (namespace_stackable(:namespace).map(&:requirements) << endpoint_requirements)
all_requirements.reduce({}) do |base_requirements, single_requirements|
base_requirements.merge!(single_requirements)
end
end
def prepare_routes_path_params(path)
regex = Rack::Mount::RegexpWithNamedGroups.new(path)
path_params = {}
# named parameters in the api path
named_params = regex.named_captures.map { |nc| nc[0] } - %w(version format)
named_params.each { |named_param| path_params[named_param] = "" }
# route parameters declared via desc or appended to the api declaration
route_params = (options[:route_options][:params] || {})
path_params.merge!(route_params)
end
def prepare_routes
options[:method].map do |method|
options[:path].map do |path|
prepared_path = prepare_path(path)
anchor = options[:route_options].fetch(:anchor, true)
path = compile_path(prepared_path, anchor && !options[:app], prepare_routes_requirements)
request_method = (method.to_s.upcase unless method == :any)
Route.new(options[:route_options].clone.merge(
prefix: namespace_inheritable(:root_prefix),
version: namespace_inheritable(:version) ? namespace_inheritable(:version).join('|') : nil,
namespace: namespace,
method: request_method,
path: prepared_path,
params: prepare_routes_path_params(path),
compiled: path
))
end
end.flatten
end
def prepare_path(path)
path_settings = inheritable_setting.to_hash[:namespace_stackable].merge(inheritable_setting.to_hash[:namespace_inheritable])
Path.prepare(path, namespace, path_settings)
end
def namespace
@namespace ||= Namespace.joined_space_path(namespace_stackable(:namespace))
end
def compile_path(prepared_path, anchor = true, requirements = {})
endpoint_options = {}
endpoint_options[:version] = /#{namespace_inheritable(:version).join('|')}/ if namespace_inheritable(:version)
endpoint_options.merge!(requirements)
Rack::Mount::Strexp.compile(prepared_path, endpoint_options, %w( / . ? ), anchor)
end
def call(env)
dup.call!(env)
end
def call!(env)
extend helpers
env['api.endpoint'] = self
if options[:app]
options[:app].call(env)
else
builder = build_middleware
builder.run lambda { |arg| run(arg) }
builder.call(env)
end
end
# Return the collection of endpoints within this endpoint.
# This is the case when an Grape::API mounts another Grape::API.
def endpoints
if options[:app] && options[:app].respond_to?(:endpoints)
options[:app].endpoints
else
nil
end
end
protected
def run(env)
@env = env
@header = {}
@request = Grape::Request.new(env)
@params = @request.params
@headers = @request.headers
cookies.read(@request)
self.class.before_each.call(self) if self.class.before_each
run_filters befores
run_filters before_validations
# Retrieve validations from this namespace and all parent namespaces.
validation_errors = []
# require 'pry-byebug'; binding.pry
route_setting(:saved_validations).each do |validator|
begin
validator.validate!(params)
rescue Grape::Exceptions::Validation => e
validation_errors << e
end
end
if validation_errors.any?
raise Grape::Exceptions::ValidationErrors, errors: validation_errors
end
run_filters after_validations
response_text = @block ? @block.call(self) : nil
run_filters afters
cookies.write(header)
[status, header, [body || response_text]]
end
def build_middleware
b = Rack::Builder.new
b.use Rack::Head
b.use Grape::Middleware::Error,
format: namespace_inheritable(:format),
content_types: Grape::DSL::Configuration.stacked_hash_to_hash(namespace_stackable(:content_types)),
default_status: namespace_inheritable(:default_error_status),
rescue_all: namespace_inheritable(:rescue_all),
default_error_formatter: namespace_inheritable(:default_error_formatter),
error_formatters: Grape::DSL::Configuration.stacked_hash_to_hash(namespace_stackable(:error_formatters)),
rescue_options: Grape::DSL::Configuration.stacked_hash_to_hash(namespace_stackable(:rescue_options)) || {},
rescue_handlers: Grape::DSL::Configuration.stacked_hash_to_hash(namespace_stackable(:rescue_handlers)) || {},
base_only_rescue_handlers: Grape::DSL::Configuration.stacked_hash_to_hash(namespace_stackable(:base_only_rescue_handlers)) || {},
all_rescue_handler: namespace_inheritable(:all_rescue_handler)
(namespace_stackable(:middleware) || []).each do |m|
m = m.dup
block = m.pop if m.last.is_a?(Proc)
if block
b.use(*m, &block)
else
b.use(*m)
end
end
if namespace_inheritable(:version)
b.use Grape::Middleware::Versioner.using(namespace_inheritable(:version_options)[:using]),
versions: namespace_inheritable(:version) ? namespace_inheritable(:version).flatten : nil,
version_options: namespace_inheritable(:version_options),
prefix: namespace_inheritable(:root_prefix)
end
b.use Grape::Middleware::Formatter,
format: namespace_inheritable(:format),
default_format: namespace_inheritable(:default_format) || :txt,
content_types: Grape::DSL::Configuration.stacked_hash_to_hash(namespace_stackable(:content_types)),
formatters: Grape::DSL::Configuration.stacked_hash_to_hash(namespace_stackable(:formatters)),
parsers: Grape::DSL::Configuration.stacked_hash_to_hash(namespace_stackable(:parsers))
b
end
def helpers
mod = Module.new
(namespace_stackable(:helpers) || []).each do |mod_to_include|
mod.send :include, mod_to_include
end
mod
end
def run_filters(filters)
(filters || []).each do |filter|
instance_eval(&filter)
end
end
def befores
namespace_stackable(:befores) || []
end
def before_validations
namespace_stackable(:before_validations) || []
end
def after_validations
namespace_stackable(:after_validations) || []
end
def afters
namespace_stackable(:afters) || []
end
end
end