grape 0.5.0 → 3.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (215) hide show
  1. checksums.yaml +7 -0
  2. data/CHANGELOG.md +1223 -164
  3. data/CONTRIBUTING.md +148 -0
  4. data/LICENSE +1 -1
  5. data/README.md +3531 -675
  6. data/UPGRADING.md +1851 -0
  7. data/grape.gemspec +26 -32
  8. data/grape.png +0 -0
  9. data/lib/grape/api/instance.rb +194 -0
  10. data/lib/grape/api.rb +110 -485
  11. data/lib/grape/content_types.rb +28 -0
  12. data/lib/grape/cookies.rb +32 -25
  13. data/lib/grape/declared_params_handler.rb +118 -0
  14. data/lib/grape/dry_types.rb +54 -0
  15. data/lib/grape/dsl/callbacks.rb +19 -0
  16. data/lib/grape/dsl/declared.rb +35 -0
  17. data/lib/grape/dsl/desc.rb +65 -0
  18. data/lib/grape/dsl/headers.rb +21 -0
  19. data/lib/grape/dsl/helpers.rb +103 -0
  20. data/lib/grape/dsl/inside_route.rb +293 -0
  21. data/lib/grape/dsl/logger.rb +19 -0
  22. data/lib/grape/dsl/middleware.rb +36 -0
  23. data/lib/grape/dsl/parameters.rb +239 -0
  24. data/lib/grape/dsl/request_response.rb +168 -0
  25. data/lib/grape/dsl/routing.rb +288 -0
  26. data/lib/grape/dsl/settings.rb +67 -0
  27. data/lib/grape/dsl/validations.rb +51 -0
  28. data/lib/grape/endpoint.rb +287 -386
  29. data/lib/grape/env.rb +20 -0
  30. data/lib/grape/error_formatter/base.rb +56 -19
  31. data/lib/grape/error_formatter/json.rb +18 -7
  32. data/lib/grape/error_formatter/serializable_hash.rb +7 -0
  33. data/lib/grape/error_formatter/txt.rb +14 -11
  34. data/lib/grape/error_formatter/xml.rb +5 -11
  35. data/lib/grape/error_formatter.rb +15 -0
  36. data/lib/grape/exceptions/base.rb +31 -47
  37. data/lib/grape/exceptions/incompatible_option_values.rb +11 -0
  38. data/lib/grape/exceptions/invalid_accept_header.rb +11 -0
  39. data/lib/grape/exceptions/invalid_formatter.rb +3 -5
  40. data/lib/grape/exceptions/invalid_message_body.rb +11 -0
  41. data/lib/grape/exceptions/invalid_response.rb +11 -0
  42. data/lib/grape/exceptions/invalid_version_header.rb +11 -0
  43. data/lib/grape/exceptions/invalid_versioner_option.rb +3 -6
  44. data/lib/grape/exceptions/invalid_with_option_for_represent.rb +3 -7
  45. data/lib/grape/exceptions/method_not_allowed.rb +11 -0
  46. data/lib/grape/exceptions/missing_group_type.rb +11 -0
  47. data/lib/grape/exceptions/missing_mime_type.rb +3 -6
  48. data/lib/grape/exceptions/missing_vendor_option.rb +3 -5
  49. data/lib/grape/exceptions/request_error.rb +11 -0
  50. data/lib/grape/exceptions/unknown_auth_strategy.rb +11 -0
  51. data/lib/grape/exceptions/unknown_parameter.rb +11 -0
  52. data/lib/grape/exceptions/unknown_params_builder.rb +11 -0
  53. data/lib/grape/exceptions/unknown_validator.rb +3 -4
  54. data/lib/grape/exceptions/unsupported_group_type.rb +11 -0
  55. data/lib/grape/exceptions/validation.rb +20 -8
  56. data/lib/grape/exceptions/validation_array_errors.rb +14 -0
  57. data/lib/grape/exceptions/validation_errors.rb +59 -0
  58. data/lib/grape/formatter/base.rb +9 -26
  59. data/lib/grape/formatter/json.rb +6 -7
  60. data/lib/grape/formatter/serializable_hash.rb +24 -20
  61. data/lib/grape/formatter/txt.rb +5 -7
  62. data/lib/grape/formatter/xml.rb +6 -7
  63. data/lib/grape/formatter.rb +17 -0
  64. data/lib/grape/json.rb +10 -0
  65. data/lib/grape/locale/en.yml +47 -20
  66. data/lib/grape/middleware/auth/base.rb +25 -0
  67. data/lib/grape/middleware/auth/dsl.rb +38 -0
  68. data/lib/grape/middleware/auth/strategies.rb +25 -0
  69. data/lib/grape/middleware/auth/strategy_info.rb +15 -0
  70. data/lib/grape/middleware/base.rb +73 -19
  71. data/lib/grape/middleware/error.rb +104 -44
  72. data/lib/grape/middleware/filter.rb +5 -3
  73. data/lib/grape/middleware/formatter.rb +115 -105
  74. data/lib/grape/middleware/globals.rb +14 -0
  75. data/lib/grape/middleware/stack.rb +110 -0
  76. data/lib/grape/middleware/versioner/accept_version_header.rb +11 -40
  77. data/lib/grape/middleware/versioner/base.rb +76 -0
  78. data/lib/grape/middleware/versioner/header.rb +61 -78
  79. data/lib/grape/middleware/versioner/param.rb +9 -21
  80. data/lib/grape/middleware/versioner/path.rb +16 -31
  81. data/lib/grape/middleware/versioner.rb +10 -15
  82. data/lib/grape/namespace.rb +39 -10
  83. data/lib/grape/params_builder/base.rb +20 -0
  84. data/lib/grape/params_builder/hash.rb +11 -0
  85. data/lib/grape/params_builder/hash_with_indifferent_access.rb +11 -0
  86. data/lib/grape/params_builder/hashie_mash.rb +11 -0
  87. data/lib/grape/params_builder.rb +15 -0
  88. data/lib/grape/parser/base.rb +9 -24
  89. data/lib/grape/parser/json.rb +8 -7
  90. data/lib/grape/parser/xml.rb +8 -7
  91. data/lib/grape/parser.rb +15 -0
  92. data/lib/grape/path.rb +76 -0
  93. data/lib/grape/presenters/presenter.rb +11 -0
  94. data/lib/grape/railtie.rb +9 -0
  95. data/lib/grape/request.rb +182 -0
  96. data/lib/grape/router/base_route.rb +48 -0
  97. data/lib/grape/router/greedy_route.rb +26 -0
  98. data/lib/grape/router/pattern.rb +67 -0
  99. data/lib/grape/router/route.rb +58 -0
  100. data/lib/grape/router.rb +167 -0
  101. data/lib/grape/serve_stream/file_body.rb +36 -0
  102. data/lib/grape/serve_stream/sendfile_response.rb +21 -0
  103. data/lib/grape/serve_stream/stream_response.rb +23 -0
  104. data/lib/grape/util/api_description.rb +58 -0
  105. data/lib/grape/util/base_inheritable.rb +46 -0
  106. data/lib/grape/util/cache.rb +18 -0
  107. data/lib/grape/util/deep_freeze.rb +35 -0
  108. data/lib/grape/util/endpoint_configuration.rb +8 -0
  109. data/lib/grape/util/header.rb +13 -0
  110. data/lib/grape/util/inheritable_setting.rb +107 -0
  111. data/lib/grape/util/inheritable_values.rb +29 -0
  112. data/lib/grape/util/lazy/block.rb +29 -0
  113. data/lib/grape/util/lazy/value.rb +38 -0
  114. data/lib/grape/util/lazy/value_array.rb +21 -0
  115. data/lib/grape/util/lazy/value_enumerable.rb +34 -0
  116. data/lib/grape/util/lazy/value_hash.rb +21 -0
  117. data/lib/grape/util/media_type.rb +70 -0
  118. data/lib/grape/util/registry.rb +27 -0
  119. data/lib/grape/util/reverse_stackable_values.rb +15 -0
  120. data/lib/grape/util/stackable_values.rb +36 -0
  121. data/lib/grape/util/translation.rb +42 -0
  122. data/lib/grape/validations/attributes_iterator.rb +77 -0
  123. data/lib/grape/validations/contract_scope.rb +28 -0
  124. data/lib/grape/validations/multiple_attributes_iterator.rb +13 -0
  125. data/lib/grape/validations/param_scope_tracker.rb +57 -0
  126. data/lib/grape/validations/params_documentation.rb +50 -0
  127. data/lib/grape/validations/params_scope.rb +529 -0
  128. data/lib/grape/validations/single_attribute_iterator.rb +26 -0
  129. data/lib/grape/validations/types/array_coercer.rb +60 -0
  130. data/lib/grape/validations/types/custom_type_coercer.rb +164 -0
  131. data/lib/grape/validations/types/custom_type_collection_coercer.rb +56 -0
  132. data/lib/grape/validations/types/dry_type_coercer.rb +59 -0
  133. data/lib/grape/validations/types/file.rb +31 -0
  134. data/lib/grape/validations/types/invalid_value.rb +17 -0
  135. data/lib/grape/validations/types/json.rb +71 -0
  136. data/lib/grape/validations/types/multiple_type_coercer.rb +57 -0
  137. data/lib/grape/validations/types/primitive_coercer.rb +46 -0
  138. data/lib/grape/validations/types/set_coercer.rb +35 -0
  139. data/lib/grape/validations/types/variant_collection_coercer.rb +51 -0
  140. data/lib/grape/validations/types.rb +198 -0
  141. data/lib/grape/validations/validators/all_or_none_of_validator.rb +19 -0
  142. data/lib/grape/validations/validators/allow_blank_validator.rb +25 -0
  143. data/lib/grape/validations/validators/as_validator.rb +14 -0
  144. data/lib/grape/validations/validators/at_least_one_of_validator.rb +18 -0
  145. data/lib/grape/validations/validators/base.rb +158 -0
  146. data/lib/grape/validations/validators/coerce_validator.rb +55 -0
  147. data/lib/grape/validations/validators/contract_scope_validator.rb +45 -0
  148. data/lib/grape/validations/validators/default_validator.rb +31 -0
  149. data/lib/grape/validations/validators/exactly_one_of_validator.rb +24 -0
  150. data/lib/grape/validations/validators/except_values_validator.rb +33 -0
  151. data/lib/grape/validations/validators/length_validator.rb +48 -0
  152. data/lib/grape/validations/validators/multiple_params_base.rb +34 -0
  153. data/lib/grape/validations/validators/mutually_exclusive_validator.rb +18 -0
  154. data/lib/grape/validations/validators/presence_validator.rb +17 -0
  155. data/lib/grape/validations/validators/regexp_validator.rb +24 -0
  156. data/lib/grape/validations/validators/same_as_validator.rb +20 -0
  157. data/lib/grape/validations/validators/values_validator.rb +68 -0
  158. data/lib/grape/validations.rb +10 -226
  159. data/lib/grape/version.rb +4 -1
  160. data/lib/grape/xml.rb +10 -0
  161. data/lib/grape.rb +79 -77
  162. metadata +160 -306
  163. data/.gitignore +0 -38
  164. data/.rspec +0 -2
  165. data/.travis.yml +0 -9
  166. data/.yardopts +0 -2
  167. data/Gemfile +0 -19
  168. data/Guardfile +0 -15
  169. data/Rakefile +0 -64
  170. data/lib/grape/exceptions/missing_option.rb +0 -13
  171. data/lib/grape/exceptions/unknown_options.rb +0 -14
  172. data/lib/grape/http/request.rb +0 -28
  173. data/lib/grape/middleware/auth/basic.rb +0 -30
  174. data/lib/grape/middleware/auth/digest.rb +0 -30
  175. data/lib/grape/middleware/auth/oauth2.rb +0 -72
  176. data/lib/grape/route.rb +0 -23
  177. data/lib/grape/util/content_types.rb +0 -17
  178. data/lib/grape/util/deep_merge.rb +0 -23
  179. data/lib/grape/util/hash_stack.rb +0 -120
  180. data/lib/grape/validations/coerce.rb +0 -62
  181. data/lib/grape/validations/default.rb +0 -24
  182. data/lib/grape/validations/presence.rb +0 -12
  183. data/lib/grape/validations/regexp.rb +0 -14
  184. data/spec/grape/api_spec.rb +0 -2129
  185. data/spec/grape/endpoint_spec.rb +0 -605
  186. data/spec/grape/entity_spec.rb +0 -281
  187. data/spec/grape/exceptions/invalid_formatter_spec.rb +0 -18
  188. data/spec/grape/exceptions/invalid_versioner_option_spec.rb +0 -18
  189. data/spec/grape/exceptions/missing_mime_type_spec.rb +0 -24
  190. data/spec/grape/exceptions/missing_option_spec.rb +0 -18
  191. data/spec/grape/exceptions/unknown_options_spec.rb +0 -18
  192. data/spec/grape/exceptions/unknown_validator_spec.rb +0 -18
  193. data/spec/grape/middleware/auth/basic_spec.rb +0 -31
  194. data/spec/grape/middleware/auth/digest_spec.rb +0 -47
  195. data/spec/grape/middleware/auth/oauth2_spec.rb +0 -90
  196. data/spec/grape/middleware/base_spec.rb +0 -63
  197. data/spec/grape/middleware/error_spec.rb +0 -49
  198. data/spec/grape/middleware/exception_spec.rb +0 -164
  199. data/spec/grape/middleware/formatter_spec.rb +0 -244
  200. data/spec/grape/middleware/versioner/accept_version_header_spec.rb +0 -121
  201. data/spec/grape/middleware/versioner/header_spec.rb +0 -277
  202. data/spec/grape/middleware/versioner/param_spec.rb +0 -58
  203. data/spec/grape/middleware/versioner/path_spec.rb +0 -44
  204. data/spec/grape/middleware/versioner_spec.rb +0 -22
  205. data/spec/grape/util/hash_stack_spec.rb +0 -133
  206. data/spec/grape/validations/coerce_spec.rb +0 -143
  207. data/spec/grape/validations/default_spec.rb +0 -67
  208. data/spec/grape/validations/presence_spec.rb +0 -144
  209. data/spec/grape/validations/regexp_spec.rb +0 -33
  210. data/spec/grape/validations/zh-CN.yml +0 -9
  211. data/spec/grape/validations_spec.rb +0 -217
  212. data/spec/shared/versioning_examples.rb +0 -121
  213. data/spec/spec_helper.rb +0 -25
  214. data/spec/support/basic_auth_encode_helpers.rb +0 -4
  215. data/spec/support/versioned_helpers.rb +0 -48
@@ -1,154 +1,130 @@
1
+ # frozen_string_literal: true
2
+
1
3
  module Grape
2
4
  # An Endpoint is the proxy scope in which all routing
3
5
  # blocks are executed. In other words, any methods
4
6
  # on the instance level of this class may be called
5
7
  # from inside a `get`, `post`, etc.
6
8
  class Endpoint
7
- attr_accessor :block, :source, :options, :settings
8
- attr_reader :env, :request
9
+ extend Forwardable
10
+ include Grape::DSL::Settings
11
+ include Grape::DSL::Headers
12
+ include Grape::DSL::InsideRoute
13
+
14
+ attr_reader :env, :request, :source, :options, :endpoints
15
+
16
+ def_delegators :request, :params, :headers, :cookies
17
+ def_delegator :cookies, :response_cookies
9
18
 
10
19
  class << self
11
- # @api private
12
- #
13
- # Create an UnboundMethod that is appropriate for executing an endpoint
14
- # route.
15
- #
16
- # The unbound method allows explicit calls to +return+ without raising a
17
- # +LocalJumpError+. The method will be removed, but a +Proc+ reference to
18
- # it will be returned. The returned +Proc+ expects a single argument: the
19
- # instance of +Endpoint+ to bind to the method during the call.
20
- #
21
- # @param [String, Symbol] method_name
22
- # @return [Proc]
23
- # @raise [NameError] an instance method with the same name already exists
24
- def generate_api_method(method_name, &block)
25
- if instance_methods.include?(method_name.to_sym) || instance_methods.include?(method_name.to_s)
26
- raise NameError.new("method #{method_name.inspect} already exists and cannot be used as an unbound method name")
20
+ def before_each(new_setup = false, &block)
21
+ @before_each ||= []
22
+ if new_setup == false
23
+ return @before_each unless block
24
+
25
+ @before_each << block
26
+ elsif new_setup
27
+ @before_each = [new_setup]
28
+ else
29
+ @before_each.clear
27
30
  end
28
- define_method(method_name, &block)
29
- method = instance_method(method_name)
30
- remove_method(method_name)
31
- proc { |endpoint_instance| method.bind(endpoint_instance).call }
32
31
  end
33
- end
34
32
 
35
- def initialize(settings, options = {}, &block)
36
- @settings = settings
37
- if block_given?
38
- method_name = [
39
- options[:method],
40
- Namespace.joined_space(settings),
41
- settings.gather(:mount_path).join("/"),
42
- Array(options[:path]).join("/")
43
- ].join(" ")
44
- @source = block
45
- @block = self.class.generate_api_method(method_name, &block)
33
+ def run_before_each(endpoint)
34
+ superclass.run_before_each(endpoint) unless self == Endpoint
35
+ before_each.each { |blk| blk.call(endpoint) }
46
36
  end
37
+
38
+ def block_to_unbound_method(block)
39
+ return unless block
40
+
41
+ define_method :temp_unbound_method, block
42
+ method = instance_method(:temp_unbound_method)
43
+ remove_method :temp_unbound_method
44
+ method
45
+ end
46
+ end
47
+
48
+ # Create a new endpoint.
49
+ # @param new_settings [InheritableSetting] settings to determine the params,
50
+ # validations, and other properties from.
51
+ # @param options [Hash] attributes of this endpoint
52
+ # @option options path [String or Array] the path to this endpoint, within
53
+ # the current scope.
54
+ # @option options method [String or Array] which HTTP method(s) can be used
55
+ # to reach this endpoint.
56
+ # @option options route_options [Hash]
57
+ # @note This happens at the time of API definition, so in this context the
58
+ # endpoint does not know if it will be mounted under a different endpoint.
59
+ # @yield a block defining what your API should do when this endpoint is hit
60
+ def initialize(new_settings, **options, &block)
61
+ self.inheritable_setting = new_settings.point_in_time_copy
62
+
63
+ # now +namespace_stackable(:declared_params)+ contains all params defined for
64
+ # this endpoint and its parents, but later it will be cleaned up,
65
+ # see +reset_validations!+ in lib/grape/dsl/validations.rb
66
+ inheritable_setting.route[:declared_params] = inheritable_setting.namespace_stackable[:declared_params].flatten
67
+ inheritable_setting.route[:saved_validations] = inheritable_setting.namespace_stackable[:validations]
68
+
69
+ inheritable_setting.namespace_stackable[:representations] ||= []
70
+ inheritable_setting.namespace_inheritable[:default_error_status] ||= 500
71
+
47
72
  @options = options
48
73
 
49
- raise Grape::Exceptions::MissingOption.new(:path) unless options.key?(:path)
50
- options[:path] = Array(options[:path])
51
- options[:path] = ['/'] if options[:path].empty?
74
+ @options[:path] = Array(@options[:path])
75
+ @options[:path] << '/' if @options[:path].empty?
76
+ @options[:method] = Array(@options[:method])
77
+
78
+ @status = nil
79
+ @stream = nil
80
+ @body = nil
81
+ @source = self.class.block_to_unbound_method(block)
82
+ @before_filter_passed = false
83
+ @endpoints = @options[:app].endpoints if @options[:app].respond_to?(:endpoints)
84
+ end
52
85
 
53
- raise Grape::Exceptions::MissingOption.new(:method) unless options.key?(:method)
54
- options[:method] = Array(options[:method])
86
+ # Update our settings from a given set of stackable parameters. Used when
87
+ # the endpoint's API is mounted under another one.
88
+ def inherit_settings(namespace_stackable)
89
+ parent_validations = namespace_stackable[:validations]
90
+ inheritable_setting.route[:saved_validations].concat(parent_validations) if parent_validations.any?
91
+ parent_declared_params = namespace_stackable[:declared_params]
92
+ inheritable_setting.route[:declared_params].concat(parent_declared_params.flatten) if parent_declared_params.any?
55
93
 
56
- options[:route_options] ||= {}
94
+ endpoints&.each { |e| e.inherit_settings(namespace_stackable) }
57
95
  end
58
96
 
59
97
  def routes
60
- @routes ||= endpoints ? endpoints.collect(&:routes).flatten : prepare_routes
98
+ @routes ||= endpoints&.flat_map(&:routes) || to_routes
61
99
  end
62
100
 
63
- def mount_in(route_set)
64
- if endpoints
65
- endpoints.each { |e| e.mount_in(route_set) }
66
- else
67
- routes.each do |route|
68
- methods = [ route.route_method ]
69
- if ! settings[:do_not_route_head] && route.route_method == "GET"
70
- methods << "HEAD"
71
- end
72
- methods.each do |method|
73
- route_set.add_route(self, {
74
- :path_info => route.route_compiled,
75
- :request_method => method,
76
- }, { :route_info => route })
77
- end
78
- end
79
- end
101
+ def reset_routes!
102
+ endpoints&.each(&:reset_routes!)
103
+ @namespace = nil
104
+ @routes = nil
80
105
  end
81
106
 
82
- def prepare_routes
83
- routes = []
84
- options[:method].each do |method|
85
- options[:path].each do |path|
86
- prepared_path = prepare_path(path)
87
-
88
- anchor = options[:route_options][:anchor]
89
- anchor = anchor.nil? ? true : anchor
107
+ def mount_in(router)
108
+ if endpoints
109
+ compile!
110
+ return endpoints.each { |e| e.mount_in(router) }
111
+ end
90
112
 
91
- endpoint_requirements = options[:route_options][:requirements] || {}
92
- all_requirements = (settings.gather(:namespace).map(&:requirements) << endpoint_requirements)
93
- requirements = all_requirements.reduce({}) do |base_requirements, single_requirements|
94
- base_requirements.merge!(single_requirements)
95
- end
113
+ reset_routes!
114
+ compile!
115
+ routes.each do |route|
116
+ router.append(route.apply(self))
117
+ next if inheritable_setting.namespace_inheritable[:do_not_route_head] || route.request_method != Rack::GET
96
118
 
97
- path = compile_path(prepared_path, anchor && !options[:app], requirements)
98
- regex = Rack::Mount::RegexpWithNamedGroups.new(path)
99
- path_params = {}
100
- # named parameters in the api path
101
- named_params = regex.named_captures.map { |nc| nc[0] } - [ 'version', 'format' ]
102
- named_params.each { |named_param| path_params[named_param] = "" }
103
- # route parameters declared via desc or appended to the api declaration
104
- route_params = (options[:route_options][:params] || {})
105
- path_params.merge!(route_params)
106
- request_method = (method.to_s.upcase unless method == :any)
107
- routes << Route.new(options[:route_options].clone.merge({
108
- :prefix => settings[:root_prefix],
109
- :version => settings[:version] ? settings[:version].join('|') : nil,
110
- :namespace => namespace,
111
- :method => request_method,
112
- :path => prepared_path,
113
- :params => path_params,
114
- :compiled => path,
115
- })
116
- )
119
+ route.dup.then do |head_route|
120
+ head_route.convert_to_head_request!
121
+ router.append(head_route.apply(self))
117
122
  end
118
123
  end
119
- routes
120
- end
121
-
122
- def prepare_path(path)
123
- parts = []
124
- parts << settings[:mount_path].to_s.split("/") if settings[:mount_path]
125
- parts << settings[:root_prefix].to_s.split("/") if settings[:root_prefix]
126
-
127
- uses_path_versioning = settings[:version] && settings[:version_options][:using] == :path
128
- namespace_is_empty = namespace && (namespace.to_s =~ /^\s*$/ || namespace.to_s == '/')
129
- path_is_empty = path && (path.to_s =~ /^\s*$/ || path.to_s == '/')
130
-
131
- parts << ':version' if uses_path_versioning
132
- if ! uses_path_versioning || (! namespace_is_empty || ! path_is_empty)
133
- parts << namespace.to_s if namespace
134
- parts << path.to_s if path
135
- format_suffix = '(.:format)'
136
- else
137
- format_suffix = '(/.:format)'
138
- end
139
- parts = parts.flatten.select { |part| part != '/' }
140
- Rack::Mount::Utils.normalize_path(parts.join('/') + format_suffix)
141
124
  end
142
125
 
143
126
  def namespace
144
- @namespace ||= Namespace.joined_space_path(settings)
145
- end
146
-
147
- def compile_path(prepared_path, anchor = true, requirements = {})
148
- endpoint_options = {}
149
- endpoint_options[:version] = /#{settings[:version].join('|')}/ if settings[:version]
150
- endpoint_options.merge!(requirements)
151
- Rack::Mount::Strexp.compile(prepared_path, endpoint_options, %w( / . ? ), anchor)
127
+ @namespace ||= Namespace.joined_space_path(inheritable_setting.namespace_stackable[:namespace])
152
128
  end
153
129
 
154
130
  def call(env)
@@ -156,325 +132,250 @@ module Grape
156
132
  end
157
133
 
158
134
  def call!(env)
159
- env['api.endpoint'] = self
160
- if options[:app]
161
- options[:app].call(env)
162
- else
163
- builder = build_middleware
164
- builder.run options[:app] || lambda{|env| self.run(env) }
165
- builder.call(env)
166
- end
135
+ env[Grape::Env::API_ENDPOINT] = self
136
+ @env = env
137
+ # this adds the helpers only to the instance
138
+ singleton_class.include(@helpers) if @helpers
139
+ @app.call(env)
167
140
  end
168
141
 
169
- # The parameters passed into the request as
170
- # well as parsed from URL segments.
171
- def params
172
- @params ||= @request.params
142
+ def ==(other)
143
+ other.is_a?(self.class) &&
144
+ options == other.options &&
145
+ inheritable_setting.to_hash == other.inheritable_setting.to_hash
173
146
  end
147
+ alias eql? ==
174
148
 
175
- # A filtering method that will return a hash
176
- # consisting only of keys that have been declared by a
177
- # `params` statement.
178
- #
179
- # @param params [Hash] The initial hash to filter. Usually this will just be `params`
180
- # @param options [Hash] Can pass `:include_missing` and `:stringify` options.
181
- def declared(params, options = {}, declared_params = settings[:declared_params])
182
- options[:include_missing] = true unless options.key?(:include_missing)
183
-
184
- unless declared_params
185
- raise ArgumentError, "Tried to filter for declared parameters but none exist."
186
- end
149
+ # The purpose of this override is solely for stripping internals when an error occurs while calling
150
+ # an endpoint through an api. See https://github.com/ruby-grape/grape/issues/2398
151
+ # Otherwise, it calls super.
152
+ def inspect
153
+ return super unless env
187
154
 
188
- if params.is_a? Array
189
- params.map do |param|
190
- declared(param || {}, options, declared_params)
191
- end
192
- else
193
- declared_params.inject({}) do |hash, key|
194
- key = { key => nil } unless key.is_a? Hash
195
-
196
- key.each_pair do |parent, children|
197
- output_key = options[:stringify] ? parent.to_s : parent.to_sym
198
- if params.key?(parent) || options[:include_missing]
199
- hash[output_key] = if children
200
- declared(params[parent] || {}, options, Array(children))
201
- else
202
- params[parent]
203
- end
204
- end
155
+ "#{self.class} in '#{route.origin}' endpoint"
156
+ end
157
+
158
+ protected
159
+
160
+ def run
161
+ ActiveSupport::Notifications.instrument('endpoint_run.grape', endpoint: self, env:) do
162
+ @request = Grape::Request.new(env, build_params_with: inheritable_setting.namespace_inheritable[:build_params_with])
163
+ begin
164
+ self.class.run_before_each(self)
165
+ run_filters befores, :before
166
+ @before_filter_passed = true
167
+
168
+ if env.key?(Grape::Env::GRAPE_ALLOWED_METHODS)
169
+ header['Allow'] = env[Grape::Env::GRAPE_ALLOWED_METHODS].join(', ')
170
+ raise Grape::Exceptions::MethodNotAllowed.new(header) unless options?
171
+
172
+ header 'Allow', header['Allow']
173
+ response_object = ''
174
+ status 204
175
+ else
176
+ run_filters before_validations, :before_validation
177
+ run_validators(request:)
178
+ run_filters after_validations, :after_validation
179
+ response_object = execute
205
180
  end
206
181
 
207
- hash
208
- end
209
- end
210
- end
182
+ run_filters afters, :after
183
+ build_response_cookies
211
184
 
212
- # The API version as specified in the URL.
213
- def version; env['api.version'] end
185
+ # status verifies body presence when DELETE
186
+ @body ||= response_object
214
187
 
215
- # End the request and display an error to the
216
- # end user with the specified message.
217
- #
218
- # @param message [String] The message to display.
219
- # @param status [Integer] the HTTP Status Code. Defaults to 403.
220
- def error!(message, status=403)
221
- throw :error, :message => message, :status => status
222
- end
188
+ # The body commonly is an Array of Strings, the application instance itself, or a Stream-like object
189
+ response_object = stream || [body]
223
190
 
224
- # Redirect to a new url.
225
- #
226
- # @param url [String] The url to be redirect.
227
- # @param options [Hash] The options used when redirect.
228
- # :permanent, default true.
229
- def redirect(url, options = {})
230
- merged_options = {:permanent => false }.merge(options)
231
- if merged_options[:permanent]
232
- status 301
233
- else
234
- if env['HTTP_VERSION'] == 'HTTP/1.1' && request.request_method.to_s.upcase != "GET"
235
- status 303
236
- else
237
- status 302
191
+ [status, header, response_object]
192
+ ensure
193
+ run_filters finallies, :finally
238
194
  end
239
195
  end
240
- header "Location", url
241
- body ""
242
196
  end
243
197
 
244
- # Set or retrieve the HTTP status code.
245
- #
246
- # @param status [Integer] The HTTP Status Code to return for this request.
247
- def status(status = nil)
248
- if status
249
- @status = status
250
- else
251
- return @status if @status
252
- case request.request_method.to_s.upcase
253
- when 'POST'
254
- 201
255
- else
256
- 200
257
- end
258
- end
259
- end
198
+ def execute
199
+ return unless source
260
200
 
261
- # Set an individual header or retrieve
262
- # all headers that have been set.
263
- def header(key = nil, val = nil)
264
- if key
265
- val ? @header[key.to_s] = val : @header.delete(key.to_s)
266
- else
267
- @header
201
+ ActiveSupport::Notifications.instrument('endpoint_render.grape', endpoint: self) do
202
+ source.bind_call(self)
268
203
  end
269
204
  end
270
205
 
271
- # Retrieves all available request headers.
272
- def headers
273
- @headers ||= @request.headers
274
- end
206
+ def run_validators(request:)
207
+ validators = inheritable_setting.route[:saved_validations]
208
+ return if validators.empty?
209
+
210
+ validation_errors = []
211
+
212
+ Grape::Validations::ParamScopeTracker.track do
213
+ ActiveSupport::Notifications.instrument('endpoint_run_validators.grape', endpoint: self, validators:, request:) do
214
+ validators.each do |validator|
215
+ validator.validate(request)
216
+ rescue Grape::Exceptions::Validation => e
217
+ validation_errors << e
218
+ break if validator.fail_fast?
219
+ rescue Grape::Exceptions::ValidationArrayErrors => e
220
+ validation_errors.concat e.errors
221
+ break if validator.fail_fast?
222
+ end
223
+ end
224
+ end
275
225
 
276
- # Set response content-type
277
- def content_type(val)
278
- header('Content-Type', val)
226
+ raise(Grape::Exceptions::ValidationErrors.new(errors: validation_errors, headers: header)) if validation_errors.any?
279
227
  end
280
228
 
281
- # Set or get a cookie
282
- #
283
- # @example
284
- # cookies[:mycookie] = 'mycookie val'
285
- # cookies['mycookie-string'] = 'mycookie string val'
286
- # cookies[:more] = { :value => '123', :expires => Time.at(0) }
287
- # cookies.delete :more
288
- #
289
- def cookies
290
- @cookies ||= Cookies.new
291
- end
229
+ def run_filters(filters, type = :other)
230
+ return unless filters
292
231
 
293
- # Allows you to define the response body as something other than the
294
- # return value.
295
- #
296
- # @example
297
- # get '/body' do
298
- # body "Body"
299
- # "Not the Body"
300
- # end
301
- #
302
- # GET /body # => "Body"
303
- def body(value = nil)
304
- if value
305
- @body = value
306
- else
307
- @body
232
+ ActiveSupport::Notifications.instrument('endpoint_run_filters.grape', endpoint: self, filters:, type:) do
233
+ filters.each { |filter| instance_eval(&filter) }
308
234
  end
309
235
  end
310
236
 
311
- # Allows you to make use of Grape Entities by setting
312
- # the response body to the serializable hash of the
313
- # entity provided in the `:with` option. This has the
314
- # added benefit of automatically passing along environment
315
- # and version information to the serialization, making it
316
- # very easy to do conditional exposures. See Entity docs
317
- # for more info.
318
- #
319
- # @example
320
- #
321
- # get '/users/:id' do
322
- # present User.find(params[:id]),
323
- # :with => API::Entities::User,
324
- # :admin => current_user.admin?
325
- # end
326
- def present(*args)
327
- options = args.count > 1 ? args.extract_options! : {}
328
- key, object = if args.count == 2 && args.first.is_a?(Symbol)
329
- args
330
- else
331
- [nil, args.first]
332
- end
333
- entity_class = options.delete(:with)
334
-
335
- # auto-detect the entity from the first object in the collection
336
- object_instance = object.respond_to?(:first) ? object.first : object
337
-
338
- object_instance.class.ancestors.each do |potential|
339
- entity_class ||= (settings[:representations] || {})[potential]
237
+ %i[befores before_validations after_validations afters finallies].each do |method|
238
+ define_method method do
239
+ inheritable_setting.namespace_stackable[method]
340
240
  end
341
-
342
- entity_class ||= object_instance.class.const_get(:Entity) if object_instance.class.const_defined?(:Entity)
343
-
344
- root = options.delete(:root)
345
-
346
- representation = if entity_class
347
- embeds = {:env => env}
348
- embeds[:version] = env['api.version'] if env['api.version']
349
- entity_class.represent(object, embeds.merge(options))
350
- else
351
- object
352
- end
353
-
354
- representation = { root => representation } if root
355
- representation = (@body || {}).merge({key => representation}) if key
356
- body representation
357
- end
358
-
359
- # Returns route information for the current request.
360
- #
361
- # @example
362
- #
363
- # desc "Returns the route description."
364
- # get '/' do
365
- # route.route_description
366
- # end
367
- def route
368
- env["rack.routing_args"][:route_info]
369
241
  end
370
242
 
371
- protected
372
-
373
- # Return the collection of endpoints within this endpoint.
374
- # This is the case when an Grape::API mounts another Grape::API.
375
- def endpoints
376
- if options[:app] && options[:app].respond_to?(:endpoints)
377
- options[:app].endpoints
378
- else
379
- nil
380
- end
243
+ def options?
244
+ options[:options_route_enabled] &&
245
+ env[Rack::REQUEST_METHOD] == Rack::OPTIONS
381
246
  end
382
247
 
383
- def run(env)
384
- @env = env
385
- @header = {}
386
- @request = Grape::Request.new(@env)
248
+ private
387
249
 
388
- self.extend helpers
389
- cookies.read(@request)
250
+ attr_reader :before_filter_passed
390
251
 
391
- run_filters befores
252
+ def compile!
253
+ @app = options[:app] || build_stack
254
+ @helpers = build_helpers
255
+ end
392
256
 
393
- # Retieve validations from this namespace and all parent namespaces.
394
- settings.gather(:validations).each do |validator|
395
- validator.validate!(params)
257
+ def to_routes
258
+ route_options = options[:route_options]
259
+ default_route_options = prepare_default_route_attributes(route_options)
260
+ complete_route_options = route_options.merge(default_route_options)
261
+ path_settings = prepare_default_path_settings
262
+
263
+ options[:method].flat_map do |method|
264
+ options[:path].map do |path|
265
+ prepared_path = Path.new(path, default_route_options[:namespace], path_settings)
266
+ pattern = Grape::Router::Pattern.new(
267
+ origin: prepared_path.origin,
268
+ suffix: prepared_path.suffix,
269
+ anchor: default_route_options[:anchor],
270
+ params: route_options[:params],
271
+ format: options[:format],
272
+ version: default_route_options[:version],
273
+ requirements: default_route_options[:requirements]
274
+ )
275
+ Grape::Router::Route.new(self, method, pattern, complete_route_options)
276
+ end
396
277
  end
278
+ end
397
279
 
398
- run_filters after_validations
280
+ def prepare_default_route_attributes(route_options)
281
+ {
282
+ namespace:,
283
+ version: prepare_version(inheritable_setting.namespace_inheritable[:version]),
284
+ requirements: prepare_routes_requirements(route_options[:requirements]),
285
+ prefix: inheritable_setting.namespace_inheritable[:root_prefix],
286
+ anchor: route_options.fetch(:anchor, true),
287
+ settings: inheritable_setting.route.except(:declared_params, :saved_validations),
288
+ forward_match: options[:forward_match]
289
+ }
290
+ end
399
291
 
400
- response_text = @block ? @block.call(self) : nil
401
- run_filters afters
402
- cookies.write(header)
292
+ def prepare_default_path_settings
293
+ namespace_stackable_hash = inheritable_setting.namespace_stackable.to_hash
294
+ namespace_inheritable_hash = inheritable_setting.namespace_inheritable.to_hash
295
+ namespace_stackable_hash.merge!(namespace_inheritable_hash)
296
+ end
403
297
 
404
- [status, header, [body || response_text]]
298
+ def prepare_routes_requirements(route_options_requirements)
299
+ namespace_requirements = inheritable_setting.namespace_stackable[:namespace].filter_map(&:requirements)
300
+ namespace_requirements << route_options_requirements if route_options_requirements.present?
301
+ namespace_requirements.reduce({}, :merge)
405
302
  end
406
303
 
407
- def build_middleware
408
- b = Rack::Builder.new
409
-
410
- b.use Rack::Head
411
- b.use Grape::Middleware::Error,
412
- :format => settings[:format],
413
- :default_status => settings[:default_error_status] || 403,
414
- :rescue_all => settings[:rescue_all],
415
- :rescued_errors => aggregate_setting(:rescued_errors),
416
- :default_error_formatter => settings[:default_error_formatter],
417
- :error_formatters => settings[:error_formatters],
418
- :rescue_options => settings[:rescue_options],
419
- :rescue_handlers => merged_setting(:rescue_handlers)
420
-
421
- aggregate_setting(:middleware).each do |m|
422
- m = m.dup
423
- block = m.pop if m.last.is_a?(Proc)
424
- if block
425
- b.use *m, &block
426
- else
427
- b.use *m
428
- end
429
- end
304
+ def prepare_version(namespace_inheritable_version)
305
+ return if namespace_inheritable_version.blank?
430
306
 
431
- b.use Rack::Auth::Basic, settings[:auth][:realm], &settings[:auth][:proc] if settings[:auth] && settings[:auth][:type] == :http_basic
432
- b.use Rack::Auth::Digest::MD5, settings[:auth][:realm], settings[:auth][:opaque], &settings[:auth][:proc] if settings[:auth] && settings[:auth][:type] == :http_digest
307
+ namespace_inheritable_version.length == 1 ? namespace_inheritable_version.first : namespace_inheritable_version
308
+ end
433
309
 
434
- if settings[:version]
435
- b.use Grape::Middleware::Versioner.using(settings[:version_options][:using]), {
436
- :versions => settings[:version],
437
- :version_options => settings[:version_options],
438
- :prefix => settings[:root_prefix]
439
- }
310
+ def build_stack
311
+ stack = Grape::Middleware::Stack.new
312
+
313
+ content_types = inheritable_setting.namespace_stackable_with_hash(:content_types)
314
+ format = inheritable_setting.namespace_inheritable[:format]
315
+
316
+ stack.use Rack::Head
317
+ stack.use Rack::Lint if lint?
318
+ stack.use Grape::Middleware::Error,
319
+ format:,
320
+ content_types:,
321
+ default_status: inheritable_setting.namespace_inheritable[:default_error_status],
322
+ rescue_all: inheritable_setting.namespace_inheritable[:rescue_all],
323
+ rescue_grape_exceptions: inheritable_setting.namespace_inheritable[:rescue_grape_exceptions],
324
+ default_error_formatter: inheritable_setting.namespace_inheritable[:default_error_formatter],
325
+ error_formatters: inheritable_setting.namespace_stackable_with_hash(:error_formatters),
326
+ rescue_options: inheritable_setting.namespace_stackable_with_hash(:rescue_options),
327
+ rescue_handlers:,
328
+ base_only_rescue_handlers: inheritable_setting.namespace_stackable_with_hash(:base_only_rescue_handlers),
329
+ all_rescue_handler: inheritable_setting.namespace_inheritable[:all_rescue_handler],
330
+ grape_exceptions_rescue_handler: inheritable_setting.namespace_inheritable[:grape_exceptions_rescue_handler]
331
+
332
+ stack.concat inheritable_setting.namespace_stackable[:middleware]
333
+
334
+ if inheritable_setting.namespace_inheritable[:version].present?
335
+ stack.use Grape::Middleware::Versioner.using(inheritable_setting.namespace_inheritable[:version_options][:using]),
336
+ versions: inheritable_setting.namespace_inheritable[:version].flatten,
337
+ version_options: inheritable_setting.namespace_inheritable[:version_options],
338
+ prefix: inheritable_setting.namespace_inheritable[:root_prefix],
339
+ mount_path: inheritable_setting.namespace_stackable[:mount_path].first
440
340
  end
441
341
 
442
- b.use Grape::Middleware::Formatter,
443
- :format => settings[:format],
444
- :default_format => settings[:default_format] || :txt,
445
- :content_types => settings[:content_types],
446
- :formatters => settings[:formatters],
447
- :parsers => settings[:parsers]
342
+ stack.use Grape::Middleware::Formatter,
343
+ format:,
344
+ default_format: inheritable_setting.namespace_inheritable[:default_format] || :txt,
345
+ content_types:,
346
+ formatters: inheritable_setting.namespace_stackable_with_hash(:formatters),
347
+ parsers: inheritable_setting.namespace_stackable_with_hash(:parsers)
448
348
 
449
- b
349
+ builder = stack.build
350
+ builder.run ->(env) { env[Grape::Env::API_ENDPOINT].run }
351
+ builder.to_app
450
352
  end
451
353
 
452
- def helpers
453
- m = Module.new
454
- settings.stack.each{|frame| m.send :include, frame[:helpers] if frame[:helpers]}
455
- m
354
+ def build_helpers
355
+ helpers = inheritable_setting.namespace_stackable[:helpers]
356
+ return if helpers.empty?
357
+
358
+ Module.new { helpers.each { |mod_to_include| include mod_to_include } }
456
359
  end
457
360
 
458
- def aggregate_setting(key)
459
- settings.stack.inject([]) do |aggregate, frame|
460
- aggregate += (frame[key] || [])
361
+ def build_response_cookies
362
+ response_cookies do |name, value|
363
+ cookie_value = value.is_a?(Hash) ? value : { value: }
364
+ Rack::Utils.set_cookie_header! header, name, cookie_value
461
365
  end
462
366
  end
463
367
 
464
- def merged_setting(key)
465
- settings.stack.inject({}) do |merged, frame|
466
- merged.merge(frame[key] || {})
467
- end
368
+ def lint?
369
+ inheritable_setting.namespace_inheritable[:lint] || Grape.config.lint
468
370
  end
469
371
 
470
- def run_filters(filters)
471
- (filters || []).each do |filter|
472
- instance_eval &filter
372
+ def rescue_handlers
373
+ rescue_handlers = inheritable_setting.namespace_reverse_stackable[:rescue_handlers]
374
+ return if rescue_handlers.blank?
375
+
376
+ rescue_handlers.each_with_object({}) do |rescue_handler, result|
377
+ result.merge!(rescue_handler) { |_k, s1, _s2| s1 }
473
378
  end
474
379
  end
475
-
476
- def befores; aggregate_setting(:befores) end
477
- def after_validations; aggregate_setting(:after_validations) end
478
- def afters; aggregate_setting(:afters) end
479
380
  end
480
381
  end