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.
- checksums.yaml +7 -0
- data/CHANGELOG.md +1223 -164
- data/CONTRIBUTING.md +148 -0
- data/LICENSE +1 -1
- data/README.md +3531 -675
- data/UPGRADING.md +1851 -0
- data/grape.gemspec +26 -32
- data/grape.png +0 -0
- data/lib/grape/api/instance.rb +194 -0
- data/lib/grape/api.rb +110 -485
- data/lib/grape/content_types.rb +28 -0
- data/lib/grape/cookies.rb +32 -25
- data/lib/grape/declared_params_handler.rb +118 -0
- data/lib/grape/dry_types.rb +54 -0
- data/lib/grape/dsl/callbacks.rb +19 -0
- data/lib/grape/dsl/declared.rb +35 -0
- data/lib/grape/dsl/desc.rb +65 -0
- data/lib/grape/dsl/headers.rb +21 -0
- data/lib/grape/dsl/helpers.rb +103 -0
- data/lib/grape/dsl/inside_route.rb +293 -0
- data/lib/grape/dsl/logger.rb +19 -0
- data/lib/grape/dsl/middleware.rb +36 -0
- data/lib/grape/dsl/parameters.rb +239 -0
- data/lib/grape/dsl/request_response.rb +168 -0
- data/lib/grape/dsl/routing.rb +288 -0
- data/lib/grape/dsl/settings.rb +67 -0
- data/lib/grape/dsl/validations.rb +51 -0
- data/lib/grape/endpoint.rb +287 -386
- data/lib/grape/env.rb +20 -0
- data/lib/grape/error_formatter/base.rb +56 -19
- data/lib/grape/error_formatter/json.rb +18 -7
- data/lib/grape/error_formatter/serializable_hash.rb +7 -0
- data/lib/grape/error_formatter/txt.rb +14 -11
- data/lib/grape/error_formatter/xml.rb +5 -11
- data/lib/grape/error_formatter.rb +15 -0
- data/lib/grape/exceptions/base.rb +31 -47
- data/lib/grape/exceptions/incompatible_option_values.rb +11 -0
- data/lib/grape/exceptions/invalid_accept_header.rb +11 -0
- data/lib/grape/exceptions/invalid_formatter.rb +3 -5
- data/lib/grape/exceptions/invalid_message_body.rb +11 -0
- data/lib/grape/exceptions/invalid_response.rb +11 -0
- data/lib/grape/exceptions/invalid_version_header.rb +11 -0
- data/lib/grape/exceptions/invalid_versioner_option.rb +3 -6
- data/lib/grape/exceptions/invalid_with_option_for_represent.rb +3 -7
- data/lib/grape/exceptions/method_not_allowed.rb +11 -0
- data/lib/grape/exceptions/missing_group_type.rb +11 -0
- data/lib/grape/exceptions/missing_mime_type.rb +3 -6
- data/lib/grape/exceptions/missing_vendor_option.rb +3 -5
- data/lib/grape/exceptions/request_error.rb +11 -0
- data/lib/grape/exceptions/unknown_auth_strategy.rb +11 -0
- data/lib/grape/exceptions/unknown_parameter.rb +11 -0
- data/lib/grape/exceptions/unknown_params_builder.rb +11 -0
- data/lib/grape/exceptions/unknown_validator.rb +3 -4
- data/lib/grape/exceptions/unsupported_group_type.rb +11 -0
- data/lib/grape/exceptions/validation.rb +20 -8
- data/lib/grape/exceptions/validation_array_errors.rb +14 -0
- data/lib/grape/exceptions/validation_errors.rb +59 -0
- data/lib/grape/formatter/base.rb +9 -26
- data/lib/grape/formatter/json.rb +6 -7
- data/lib/grape/formatter/serializable_hash.rb +24 -20
- data/lib/grape/formatter/txt.rb +5 -7
- data/lib/grape/formatter/xml.rb +6 -7
- data/lib/grape/formatter.rb +17 -0
- data/lib/grape/json.rb +10 -0
- data/lib/grape/locale/en.yml +47 -20
- data/lib/grape/middleware/auth/base.rb +25 -0
- data/lib/grape/middleware/auth/dsl.rb +38 -0
- data/lib/grape/middleware/auth/strategies.rb +25 -0
- data/lib/grape/middleware/auth/strategy_info.rb +15 -0
- data/lib/grape/middleware/base.rb +73 -19
- data/lib/grape/middleware/error.rb +104 -44
- data/lib/grape/middleware/filter.rb +5 -3
- data/lib/grape/middleware/formatter.rb +115 -105
- data/lib/grape/middleware/globals.rb +14 -0
- data/lib/grape/middleware/stack.rb +110 -0
- data/lib/grape/middleware/versioner/accept_version_header.rb +11 -40
- data/lib/grape/middleware/versioner/base.rb +76 -0
- data/lib/grape/middleware/versioner/header.rb +61 -78
- data/lib/grape/middleware/versioner/param.rb +9 -21
- data/lib/grape/middleware/versioner/path.rb +16 -31
- data/lib/grape/middleware/versioner.rb +10 -15
- data/lib/grape/namespace.rb +39 -10
- data/lib/grape/params_builder/base.rb +20 -0
- data/lib/grape/params_builder/hash.rb +11 -0
- data/lib/grape/params_builder/hash_with_indifferent_access.rb +11 -0
- data/lib/grape/params_builder/hashie_mash.rb +11 -0
- data/lib/grape/params_builder.rb +15 -0
- data/lib/grape/parser/base.rb +9 -24
- data/lib/grape/parser/json.rb +8 -7
- data/lib/grape/parser/xml.rb +8 -7
- data/lib/grape/parser.rb +15 -0
- data/lib/grape/path.rb +76 -0
- data/lib/grape/presenters/presenter.rb +11 -0
- data/lib/grape/railtie.rb +9 -0
- data/lib/grape/request.rb +182 -0
- data/lib/grape/router/base_route.rb +48 -0
- data/lib/grape/router/greedy_route.rb +26 -0
- data/lib/grape/router/pattern.rb +67 -0
- data/lib/grape/router/route.rb +58 -0
- data/lib/grape/router.rb +167 -0
- data/lib/grape/serve_stream/file_body.rb +36 -0
- data/lib/grape/serve_stream/sendfile_response.rb +21 -0
- data/lib/grape/serve_stream/stream_response.rb +23 -0
- data/lib/grape/util/api_description.rb +58 -0
- data/lib/grape/util/base_inheritable.rb +46 -0
- data/lib/grape/util/cache.rb +18 -0
- data/lib/grape/util/deep_freeze.rb +35 -0
- data/lib/grape/util/endpoint_configuration.rb +8 -0
- data/lib/grape/util/header.rb +13 -0
- data/lib/grape/util/inheritable_setting.rb +107 -0
- data/lib/grape/util/inheritable_values.rb +29 -0
- data/lib/grape/util/lazy/block.rb +29 -0
- data/lib/grape/util/lazy/value.rb +38 -0
- data/lib/grape/util/lazy/value_array.rb +21 -0
- data/lib/grape/util/lazy/value_enumerable.rb +34 -0
- data/lib/grape/util/lazy/value_hash.rb +21 -0
- data/lib/grape/util/media_type.rb +70 -0
- data/lib/grape/util/registry.rb +27 -0
- data/lib/grape/util/reverse_stackable_values.rb +15 -0
- data/lib/grape/util/stackable_values.rb +36 -0
- data/lib/grape/util/translation.rb +42 -0
- data/lib/grape/validations/attributes_iterator.rb +77 -0
- data/lib/grape/validations/contract_scope.rb +28 -0
- data/lib/grape/validations/multiple_attributes_iterator.rb +13 -0
- data/lib/grape/validations/param_scope_tracker.rb +57 -0
- data/lib/grape/validations/params_documentation.rb +50 -0
- data/lib/grape/validations/params_scope.rb +529 -0
- data/lib/grape/validations/single_attribute_iterator.rb +26 -0
- data/lib/grape/validations/types/array_coercer.rb +60 -0
- data/lib/grape/validations/types/custom_type_coercer.rb +164 -0
- data/lib/grape/validations/types/custom_type_collection_coercer.rb +56 -0
- data/lib/grape/validations/types/dry_type_coercer.rb +59 -0
- data/lib/grape/validations/types/file.rb +31 -0
- data/lib/grape/validations/types/invalid_value.rb +17 -0
- data/lib/grape/validations/types/json.rb +71 -0
- data/lib/grape/validations/types/multiple_type_coercer.rb +57 -0
- data/lib/grape/validations/types/primitive_coercer.rb +46 -0
- data/lib/grape/validations/types/set_coercer.rb +35 -0
- data/lib/grape/validations/types/variant_collection_coercer.rb +51 -0
- data/lib/grape/validations/types.rb +198 -0
- data/lib/grape/validations/validators/all_or_none_of_validator.rb +19 -0
- data/lib/grape/validations/validators/allow_blank_validator.rb +25 -0
- data/lib/grape/validations/validators/as_validator.rb +14 -0
- data/lib/grape/validations/validators/at_least_one_of_validator.rb +18 -0
- data/lib/grape/validations/validators/base.rb +158 -0
- data/lib/grape/validations/validators/coerce_validator.rb +55 -0
- data/lib/grape/validations/validators/contract_scope_validator.rb +45 -0
- data/lib/grape/validations/validators/default_validator.rb +31 -0
- data/lib/grape/validations/validators/exactly_one_of_validator.rb +24 -0
- data/lib/grape/validations/validators/except_values_validator.rb +33 -0
- data/lib/grape/validations/validators/length_validator.rb +48 -0
- data/lib/grape/validations/validators/multiple_params_base.rb +34 -0
- data/lib/grape/validations/validators/mutually_exclusive_validator.rb +18 -0
- data/lib/grape/validations/validators/presence_validator.rb +17 -0
- data/lib/grape/validations/validators/regexp_validator.rb +24 -0
- data/lib/grape/validations/validators/same_as_validator.rb +20 -0
- data/lib/grape/validations/validators/values_validator.rb +68 -0
- data/lib/grape/validations.rb +10 -226
- data/lib/grape/version.rb +4 -1
- data/lib/grape/xml.rb +10 -0
- data/lib/grape.rb +79 -77
- metadata +160 -306
- data/.gitignore +0 -38
- data/.rspec +0 -2
- data/.travis.yml +0 -9
- data/.yardopts +0 -2
- data/Gemfile +0 -19
- data/Guardfile +0 -15
- data/Rakefile +0 -64
- data/lib/grape/exceptions/missing_option.rb +0 -13
- data/lib/grape/exceptions/unknown_options.rb +0 -14
- data/lib/grape/http/request.rb +0 -28
- data/lib/grape/middleware/auth/basic.rb +0 -30
- data/lib/grape/middleware/auth/digest.rb +0 -30
- data/lib/grape/middleware/auth/oauth2.rb +0 -72
- data/lib/grape/route.rb +0 -23
- data/lib/grape/util/content_types.rb +0 -17
- data/lib/grape/util/deep_merge.rb +0 -23
- data/lib/grape/util/hash_stack.rb +0 -120
- data/lib/grape/validations/coerce.rb +0 -62
- data/lib/grape/validations/default.rb +0 -24
- data/lib/grape/validations/presence.rb +0 -12
- data/lib/grape/validations/regexp.rb +0 -14
- data/spec/grape/api_spec.rb +0 -2129
- data/spec/grape/endpoint_spec.rb +0 -605
- data/spec/grape/entity_spec.rb +0 -281
- data/spec/grape/exceptions/invalid_formatter_spec.rb +0 -18
- data/spec/grape/exceptions/invalid_versioner_option_spec.rb +0 -18
- data/spec/grape/exceptions/missing_mime_type_spec.rb +0 -24
- data/spec/grape/exceptions/missing_option_spec.rb +0 -18
- data/spec/grape/exceptions/unknown_options_spec.rb +0 -18
- data/spec/grape/exceptions/unknown_validator_spec.rb +0 -18
- data/spec/grape/middleware/auth/basic_spec.rb +0 -31
- data/spec/grape/middleware/auth/digest_spec.rb +0 -47
- data/spec/grape/middleware/auth/oauth2_spec.rb +0 -90
- data/spec/grape/middleware/base_spec.rb +0 -63
- data/spec/grape/middleware/error_spec.rb +0 -49
- data/spec/grape/middleware/exception_spec.rb +0 -164
- data/spec/grape/middleware/formatter_spec.rb +0 -244
- data/spec/grape/middleware/versioner/accept_version_header_spec.rb +0 -121
- data/spec/grape/middleware/versioner/header_spec.rb +0 -277
- data/spec/grape/middleware/versioner/param_spec.rb +0 -58
- data/spec/grape/middleware/versioner/path_spec.rb +0 -44
- data/spec/grape/middleware/versioner_spec.rb +0 -22
- data/spec/grape/util/hash_stack_spec.rb +0 -133
- data/spec/grape/validations/coerce_spec.rb +0 -143
- data/spec/grape/validations/default_spec.rb +0 -67
- data/spec/grape/validations/presence_spec.rb +0 -144
- data/spec/grape/validations/regexp_spec.rb +0 -33
- data/spec/grape/validations/zh-CN.yml +0 -9
- data/spec/grape/validations_spec.rb +0 -217
- data/spec/shared/versioning_examples.rb +0 -121
- data/spec/spec_helper.rb +0 -25
- data/spec/support/basic_auth_encode_helpers.rb +0 -4
- data/spec/support/versioned_helpers.rb +0 -48
data/grape.gemspec
CHANGED
|
@@ -1,39 +1,33 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
require_relative 'lib/grape/version'
|
|
3
4
|
|
|
4
5
|
Gem::Specification.new do |s|
|
|
5
|
-
s.name =
|
|
6
|
+
s.name = 'grape'
|
|
6
7
|
s.version = Grape::VERSION
|
|
7
8
|
s.platform = Gem::Platform::RUBY
|
|
8
|
-
s.authors = [
|
|
9
|
-
s.email = [
|
|
10
|
-
s.homepage =
|
|
11
|
-
s.summary =
|
|
12
|
-
s.description =
|
|
13
|
-
s.license =
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
s.add_runtime_dependency 'multi_json', '>= 1.3.2'
|
|
22
|
-
s.add_runtime_dependency 'multi_xml', '>= 0.5.2'
|
|
23
|
-
s.add_runtime_dependency 'hashie', '>= 1.2.0'
|
|
24
|
-
s.add_runtime_dependency 'virtus'
|
|
25
|
-
s.add_runtime_dependency 'builder'
|
|
9
|
+
s.authors = ['Michael Bleigh']
|
|
10
|
+
s.email = ['michael@intridea.com']
|
|
11
|
+
s.homepage = 'https://github.com/ruby-grape/grape'
|
|
12
|
+
s.summary = 'A simple Ruby framework for building REST-like APIs.'
|
|
13
|
+
s.description = 'A Ruby framework for rapid API development with great conventions.'
|
|
14
|
+
s.license = 'MIT'
|
|
15
|
+
s.metadata = {
|
|
16
|
+
'bug_tracker_uri' => 'https://github.com/ruby-grape/grape/issues',
|
|
17
|
+
'changelog_uri' => "https://github.com/ruby-grape/grape/blob/v#{s.version}/CHANGELOG.md",
|
|
18
|
+
'documentation_uri' => "https://www.rubydoc.info/gems/grape/#{s.version}",
|
|
19
|
+
'source_code_uri' => "https://github.com/ruby-grape/grape/tree/v#{s.version}",
|
|
20
|
+
'rubygems_mfa_required' => 'true'
|
|
21
|
+
}
|
|
26
22
|
|
|
27
|
-
s.
|
|
28
|
-
s.
|
|
29
|
-
s.
|
|
30
|
-
s.
|
|
31
|
-
s.
|
|
32
|
-
s.
|
|
33
|
-
s.add_development_dependency 'bundler'
|
|
23
|
+
s.add_dependency 'activesupport', '>= 7.2'
|
|
24
|
+
s.add_dependency 'dry-configurable'
|
|
25
|
+
s.add_dependency 'dry-types', '>= 1.1'
|
|
26
|
+
s.add_dependency 'mustermann-grape', '~> 1.1.0'
|
|
27
|
+
s.add_dependency 'rack', '>= 2'
|
|
28
|
+
s.add_dependency 'zeitwerk'
|
|
34
29
|
|
|
35
|
-
s.files
|
|
36
|
-
s.
|
|
37
|
-
s.
|
|
38
|
-
s.require_paths = ["lib"]
|
|
30
|
+
s.files = Dir['lib/**/*', 'CHANGELOG.md', 'CONTRIBUTING.md', 'README.md', 'grape.png', 'UPGRADING.md', 'LICENSE', 'grape.gemspec']
|
|
31
|
+
s.require_paths = ['lib']
|
|
32
|
+
s.required_ruby_version = '>= 3.2'
|
|
39
33
|
end
|
data/grape.png
ADDED
|
Binary file
|
|
@@ -0,0 +1,194 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Grape
|
|
4
|
+
class API
|
|
5
|
+
# The API Instance class, is the engine behind Grape::API. Each class that inherits
|
|
6
|
+
# from this will represent a different API instance
|
|
7
|
+
class Instance
|
|
8
|
+
extend Grape::DSL::Settings
|
|
9
|
+
extend Grape::DSL::Desc
|
|
10
|
+
extend Grape::DSL::Validations
|
|
11
|
+
extend Grape::DSL::Callbacks
|
|
12
|
+
extend Grape::DSL::Logger
|
|
13
|
+
extend Grape::DSL::Middleware
|
|
14
|
+
extend Grape::DSL::RequestResponse
|
|
15
|
+
extend Grape::DSL::Routing
|
|
16
|
+
extend Grape::DSL::Helpers
|
|
17
|
+
extend Grape::Middleware::Auth::DSL
|
|
18
|
+
|
|
19
|
+
Boolean = Grape::API::Boolean
|
|
20
|
+
|
|
21
|
+
class << self
|
|
22
|
+
extend Forwardable
|
|
23
|
+
|
|
24
|
+
attr_accessor :configuration
|
|
25
|
+
|
|
26
|
+
def_delegators :@base, :to_s
|
|
27
|
+
|
|
28
|
+
def base=(grape_api)
|
|
29
|
+
@base = grape_api
|
|
30
|
+
grape_api.instances << self
|
|
31
|
+
end
|
|
32
|
+
|
|
33
|
+
def base_instance?
|
|
34
|
+
self == @base.base_instance
|
|
35
|
+
end
|
|
36
|
+
|
|
37
|
+
# A class-level lock to ensure the API is not compiled by multiple
|
|
38
|
+
# threads simultaneously within the same process.
|
|
39
|
+
LOCK = Mutex.new
|
|
40
|
+
|
|
41
|
+
# Clears all defined routes, endpoints, etc., on this API.
|
|
42
|
+
def reset!
|
|
43
|
+
reset_endpoints!
|
|
44
|
+
reset_routes!
|
|
45
|
+
reset_validations!
|
|
46
|
+
end
|
|
47
|
+
|
|
48
|
+
# This is the interface point between Rack and Grape; it accepts a request
|
|
49
|
+
# from Rack and ultimately returns an array of three values: the status,
|
|
50
|
+
# the headers, and the body. See [the rack specification]
|
|
51
|
+
# (http://www.rubydoc.info/github/rack/rack/master/file/SPEC) for more.
|
|
52
|
+
def call(env)
|
|
53
|
+
compile!
|
|
54
|
+
@instance.call(env)
|
|
55
|
+
end
|
|
56
|
+
|
|
57
|
+
def compile!
|
|
58
|
+
return if @instance
|
|
59
|
+
|
|
60
|
+
LOCK.synchronize { @instance ||= new }
|
|
61
|
+
end
|
|
62
|
+
|
|
63
|
+
# see Grape::Router#recognize_path
|
|
64
|
+
def recognize_path(path)
|
|
65
|
+
compile!
|
|
66
|
+
@instance.router.recognize_path(path)
|
|
67
|
+
end
|
|
68
|
+
|
|
69
|
+
# Wipe the compiled API so we can recompile after changes were made.
|
|
70
|
+
def change!
|
|
71
|
+
@instance = nil
|
|
72
|
+
end
|
|
73
|
+
|
|
74
|
+
protected
|
|
75
|
+
|
|
76
|
+
def inherit_settings(other_settings)
|
|
77
|
+
top_level_setting.inherit_from other_settings.point_in_time_copy
|
|
78
|
+
|
|
79
|
+
# Propagate any inherited params down to our endpoints, and reset any
|
|
80
|
+
# compiled routes.
|
|
81
|
+
endpoints.each do |e|
|
|
82
|
+
e.inherit_settings(top_level_setting.namespace_stackable)
|
|
83
|
+
e.reset_routes!
|
|
84
|
+
end
|
|
85
|
+
|
|
86
|
+
reset_routes!
|
|
87
|
+
end
|
|
88
|
+
|
|
89
|
+
private
|
|
90
|
+
|
|
91
|
+
def inherited(subclass)
|
|
92
|
+
super
|
|
93
|
+
subclass.reset!
|
|
94
|
+
subclass.logger logger.clone
|
|
95
|
+
end
|
|
96
|
+
end
|
|
97
|
+
|
|
98
|
+
attr_reader :router
|
|
99
|
+
|
|
100
|
+
# Builds the routes from the defined endpoints, effectively compiling
|
|
101
|
+
# this API into a usable form.
|
|
102
|
+
def initialize
|
|
103
|
+
@router = Router.new
|
|
104
|
+
add_head_not_allowed_methods_and_options_methods
|
|
105
|
+
self.class.endpoints.each do |endpoint|
|
|
106
|
+
endpoint.mount_in(@router)
|
|
107
|
+
end
|
|
108
|
+
|
|
109
|
+
@router.compile!
|
|
110
|
+
@router.freeze
|
|
111
|
+
end
|
|
112
|
+
|
|
113
|
+
# Handle a request. See Rack documentation for what `env` is.
|
|
114
|
+
def call(env)
|
|
115
|
+
status, headers, response = @router.call(env)
|
|
116
|
+
unless cascade?
|
|
117
|
+
headers = Grape::Util::Header.new.merge(headers)
|
|
118
|
+
headers.delete('X-Cascade')
|
|
119
|
+
end
|
|
120
|
+
|
|
121
|
+
[status, headers, response]
|
|
122
|
+
end
|
|
123
|
+
|
|
124
|
+
# Some requests may return a HTTP 404 error if grape cannot find a matching
|
|
125
|
+
# route. In this case, Grape::Router adds a X-Cascade header to the response
|
|
126
|
+
# and sets it to 'pass', indicating to grape's parents they should keep
|
|
127
|
+
# looking for a matching route on other resources.
|
|
128
|
+
#
|
|
129
|
+
# In some applications (e.g. mounting grape on rails), one might need to trap
|
|
130
|
+
# errors from reaching upstream. This is effectivelly done by unsetting
|
|
131
|
+
# X-Cascade. Default :cascade is true.
|
|
132
|
+
def cascade?
|
|
133
|
+
namespace_inheritable = self.class.inheritable_setting.namespace_inheritable
|
|
134
|
+
return namespace_inheritable[:cascade] if namespace_inheritable.key?(:cascade)
|
|
135
|
+
return namespace_inheritable[:version_options][:cascade] if namespace_inheritable[:version_options]&.key?(:cascade)
|
|
136
|
+
|
|
137
|
+
true
|
|
138
|
+
end
|
|
139
|
+
|
|
140
|
+
reset!
|
|
141
|
+
|
|
142
|
+
private
|
|
143
|
+
|
|
144
|
+
# For every resource add a 'OPTIONS' route that returns an HTTP 204 response
|
|
145
|
+
# with a list of HTTP methods that can be called. Also add a route that
|
|
146
|
+
# will return an HTTP 405 response for any HTTP method that the resource
|
|
147
|
+
# cannot handle.
|
|
148
|
+
def add_head_not_allowed_methods_and_options_methods
|
|
149
|
+
# The paths we collected are prepared (cf. Path#prepare), so they
|
|
150
|
+
# contain already versioning information when using path versioning.
|
|
151
|
+
all_routes = self.class.endpoints.flat_map(&:routes)
|
|
152
|
+
|
|
153
|
+
# Disable versioning so adding a route won't prepend versioning
|
|
154
|
+
# informations again.
|
|
155
|
+
without_root_prefix_and_versioning { collect_route_config_per_pattern(all_routes) }
|
|
156
|
+
end
|
|
157
|
+
|
|
158
|
+
def collect_route_config_per_pattern(all_routes)
|
|
159
|
+
routes_by_regexp = all_routes.group_by(&:pattern_regexp)
|
|
160
|
+
namespace_inheritable = self.class.inheritable_setting.namespace_inheritable
|
|
161
|
+
|
|
162
|
+
# Build the configuration based on the first endpoint and the collection of methods supported.
|
|
163
|
+
routes_by_regexp.each_value do |routes|
|
|
164
|
+
next if routes.any? { |route| route.request_method == '*' }
|
|
165
|
+
|
|
166
|
+
last_route = routes.last # Most of the configuration is taken from the last endpoint
|
|
167
|
+
allowed_methods = routes.map(&:request_method)
|
|
168
|
+
allowed_methods |= [Rack::HEAD] if !namespace_inheritable[:do_not_route_head] && allowed_methods.include?(Rack::GET)
|
|
169
|
+
|
|
170
|
+
allow_header = namespace_inheritable[:do_not_route_options] ? allowed_methods : [Rack::OPTIONS] | allowed_methods
|
|
171
|
+
last_route.app.options[:options_route_enabled] = true unless namespace_inheritable[:do_not_route_options] || allowed_methods.include?(Rack::OPTIONS)
|
|
172
|
+
|
|
173
|
+
greedy_route = Grape::Router::GreedyRoute.new(last_route.pattern, endpoint: last_route.app, allow_header:)
|
|
174
|
+
@router.associate_routes(greedy_route)
|
|
175
|
+
end
|
|
176
|
+
end
|
|
177
|
+
|
|
178
|
+
ROOT_PREFIX_VERSIONING_KEY = %i[version version_options root_prefix].freeze
|
|
179
|
+
private_constant :ROOT_PREFIX_VERSIONING_KEY
|
|
180
|
+
|
|
181
|
+
# Allows definition of endpoints that ignore the versioning configuration
|
|
182
|
+
# used by the rest of your API.
|
|
183
|
+
def without_root_prefix_and_versioning
|
|
184
|
+
inheritable_setting = self.class.inheritable_setting
|
|
185
|
+
deleted_values = inheritable_setting.namespace_inheritable.delete(*ROOT_PREFIX_VERSIONING_KEY)
|
|
186
|
+
yield
|
|
187
|
+
ensure
|
|
188
|
+
ROOT_PREFIX_VERSIONING_KEY.each_with_index do |key, index|
|
|
189
|
+
inheritable_setting.namespace_inheritable[key] = deleted_values[index]
|
|
190
|
+
end
|
|
191
|
+
end
|
|
192
|
+
end
|
|
193
|
+
end
|
|
194
|
+
end
|