grape 1.8.0 → 2.1.0

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 (210) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +65 -1
  3. data/README.md +377 -334
  4. data/UPGRADING.md +231 -6
  5. data/grape.gemspec +6 -10
  6. data/lib/grape/api/instance.rb +13 -10
  7. data/lib/grape/api.rb +17 -8
  8. data/lib/grape/content_types.rb +0 -2
  9. data/lib/grape/cookies.rb +2 -1
  10. data/lib/grape/dry_types.rb +0 -2
  11. data/lib/grape/dsl/desc.rb +23 -21
  12. data/lib/grape/dsl/headers.rb +1 -1
  13. data/lib/grape/dsl/inside_route.rb +47 -22
  14. data/lib/grape/dsl/parameters.rb +4 -3
  15. data/lib/grape/dsl/routing.rb +20 -4
  16. data/lib/grape/dsl/validations.rb +13 -0
  17. data/lib/grape/endpoint.rb +15 -10
  18. data/lib/grape/{util/env.rb → env.rb} +0 -5
  19. data/lib/grape/error_formatter/txt.rb +11 -10
  20. data/lib/grape/exceptions/base.rb +3 -3
  21. data/lib/grape/exceptions/missing_group_type.rb +1 -1
  22. data/lib/grape/exceptions/unsupported_group_type.rb +1 -1
  23. data/lib/grape/exceptions/validation.rb +0 -2
  24. data/lib/grape/exceptions/validation_array_errors.rb +1 -0
  25. data/lib/grape/exceptions/validation_errors.rb +1 -3
  26. data/lib/grape/extensions/hash.rb +5 -1
  27. data/lib/grape/http/headers.rb +18 -24
  28. data/lib/grape/{util/json.rb → json.rb} +1 -3
  29. data/lib/grape/locale/en.yml +3 -0
  30. data/lib/grape/middleware/auth/base.rb +0 -2
  31. data/lib/grape/middleware/auth/dsl.rb +0 -2
  32. data/lib/grape/middleware/auth/strategies.rb +1 -2
  33. data/lib/grape/middleware/base.rb +0 -2
  34. data/lib/grape/middleware/error.rb +55 -50
  35. data/lib/grape/middleware/formatter.rb +21 -18
  36. data/lib/grape/middleware/globals.rb +1 -3
  37. data/lib/grape/middleware/stack.rb +2 -3
  38. data/lib/grape/middleware/versioner/accept_version_header.rb +0 -2
  39. data/lib/grape/middleware/versioner/header.rb +17 -163
  40. data/lib/grape/middleware/versioner/param.rb +2 -4
  41. data/lib/grape/middleware/versioner/path.rb +1 -3
  42. data/lib/grape/namespace.rb +3 -4
  43. data/lib/grape/path.rb +24 -29
  44. data/lib/grape/railtie.rb +9 -0
  45. data/lib/grape/request.rb +3 -5
  46. data/lib/grape/router/base_route.rb +39 -0
  47. data/lib/grape/router/greedy_route.rb +20 -0
  48. data/lib/grape/router/pattern.rb +39 -30
  49. data/lib/grape/router/route.rb +22 -59
  50. data/lib/grape/router.rb +30 -36
  51. data/lib/grape/util/accept/header.rb +19 -0
  52. data/lib/grape/util/accept_header_handler.rb +105 -0
  53. data/lib/grape/util/base_inheritable.rb +4 -4
  54. data/lib/grape/util/cache.rb +0 -3
  55. data/lib/grape/util/endpoint_configuration.rb +1 -1
  56. data/lib/grape/util/header.rb +13 -0
  57. data/lib/grape/util/inheritable_values.rb +0 -2
  58. data/lib/grape/util/lazy/block.rb +29 -0
  59. data/lib/grape/util/lazy/object.rb +45 -0
  60. data/lib/grape/util/lazy/value.rb +38 -0
  61. data/lib/grape/util/lazy/value_array.rb +21 -0
  62. data/lib/grape/util/lazy/value_enumerable.rb +34 -0
  63. data/lib/grape/util/lazy/value_hash.rb +21 -0
  64. data/lib/grape/util/media_type.rb +70 -0
  65. data/lib/grape/util/reverse_stackable_values.rb +1 -6
  66. data/lib/grape/util/stackable_values.rb +1 -6
  67. data/lib/grape/util/strict_hash_configuration.rb +3 -3
  68. data/lib/grape/validations/attributes_doc.rb +38 -36
  69. data/lib/grape/validations/contract_scope.rb +71 -0
  70. data/lib/grape/validations/params_scope.rb +10 -9
  71. data/lib/grape/validations/types/array_coercer.rb +0 -2
  72. data/lib/grape/validations/types/build_coercer.rb +69 -71
  73. data/lib/grape/validations/types/dry_type_coercer.rb +1 -11
  74. data/lib/grape/validations/types/json.rb +0 -2
  75. data/lib/grape/validations/types/primitive_coercer.rb +0 -2
  76. data/lib/grape/validations/types/set_coercer.rb +0 -3
  77. data/lib/grape/validations/types.rb +0 -3
  78. data/lib/grape/validations/validators/base.rb +2 -1
  79. data/lib/grape/validations/validators/default_validator.rb +5 -1
  80. data/lib/grape/validations/validators/length_validator.rb +42 -0
  81. data/lib/grape/validations/validators/values_validator.rb +8 -3
  82. data/lib/grape/validations.rb +3 -7
  83. data/lib/grape/version.rb +1 -1
  84. data/lib/grape/{util/xml.rb → xml.rb} +1 -1
  85. data/lib/grape.rb +38 -269
  86. metadata +33 -274
  87. data/lib/grape/eager_load.rb +0 -20
  88. data/lib/grape/middleware/versioner/parse_media_type_patch.rb +0 -24
  89. data/lib/grape/router/attribute_translator.rb +0 -63
  90. data/lib/grape/util/lazy_block.rb +0 -27
  91. data/lib/grape/util/lazy_object.rb +0 -43
  92. data/lib/grape/util/lazy_value.rb +0 -91
  93. data/spec/grape/api/custom_validations_spec.rb +0 -213
  94. data/spec/grape/api/deeply_included_options_spec.rb +0 -56
  95. data/spec/grape/api/defines_boolean_in_params_spec.rb +0 -38
  96. data/spec/grape/api/documentation_spec.rb +0 -59
  97. data/spec/grape/api/inherited_helpers_spec.rb +0 -114
  98. data/spec/grape/api/instance_spec.rb +0 -103
  99. data/spec/grape/api/invalid_format_spec.rb +0 -45
  100. data/spec/grape/api/namespace_parameters_in_route_spec.rb +0 -38
  101. data/spec/grape/api/nested_helpers_spec.rb +0 -50
  102. data/spec/grape/api/optional_parameters_in_route_spec.rb +0 -43
  103. data/spec/grape/api/parameters_modification_spec.rb +0 -41
  104. data/spec/grape/api/patch_method_helpers_spec.rb +0 -79
  105. data/spec/grape/api/recognize_path_spec.rb +0 -21
  106. data/spec/grape/api/required_parameters_in_route_spec.rb +0 -37
  107. data/spec/grape/api/required_parameters_with_invalid_method_spec.rb +0 -26
  108. data/spec/grape/api/routes_with_requirements_spec.rb +0 -59
  109. data/spec/grape/api/shared_helpers_exactly_one_of_spec.rb +0 -41
  110. data/spec/grape/api/shared_helpers_spec.rb +0 -36
  111. data/spec/grape/api_remount_spec.rb +0 -509
  112. data/spec/grape/api_spec.rb +0 -4356
  113. data/spec/grape/dsl/callbacks_spec.rb +0 -45
  114. data/spec/grape/dsl/desc_spec.rb +0 -98
  115. data/spec/grape/dsl/headers_spec.rb +0 -62
  116. data/spec/grape/dsl/helpers_spec.rb +0 -100
  117. data/spec/grape/dsl/inside_route_spec.rb +0 -531
  118. data/spec/grape/dsl/logger_spec.rb +0 -24
  119. data/spec/grape/dsl/middleware_spec.rb +0 -60
  120. data/spec/grape/dsl/parameters_spec.rb +0 -180
  121. data/spec/grape/dsl/request_response_spec.rb +0 -225
  122. data/spec/grape/dsl/routing_spec.rb +0 -275
  123. data/spec/grape/dsl/settings_spec.rb +0 -261
  124. data/spec/grape/dsl/validations_spec.rb +0 -55
  125. data/spec/grape/endpoint/declared_spec.rb +0 -846
  126. data/spec/grape/endpoint_spec.rb +0 -1085
  127. data/spec/grape/entity_spec.rb +0 -336
  128. data/spec/grape/exceptions/base_spec.rb +0 -81
  129. data/spec/grape/exceptions/body_parse_errors_spec.rb +0 -185
  130. data/spec/grape/exceptions/invalid_accept_header_spec.rb +0 -358
  131. data/spec/grape/exceptions/invalid_formatter_spec.rb +0 -15
  132. data/spec/grape/exceptions/invalid_response_spec.rb +0 -11
  133. data/spec/grape/exceptions/invalid_versioner_option_spec.rb +0 -15
  134. data/spec/grape/exceptions/missing_group_type_spec.rb +0 -17
  135. data/spec/grape/exceptions/missing_mime_type_spec.rb +0 -17
  136. data/spec/grape/exceptions/missing_option_spec.rb +0 -15
  137. data/spec/grape/exceptions/unknown_options_spec.rb +0 -15
  138. data/spec/grape/exceptions/unknown_validator_spec.rb +0 -15
  139. data/spec/grape/exceptions/unsupported_group_type_spec.rb +0 -19
  140. data/spec/grape/exceptions/validation_errors_spec.rb +0 -92
  141. data/spec/grape/exceptions/validation_spec.rb +0 -19
  142. data/spec/grape/extensions/param_builders/hash_spec.rb +0 -83
  143. data/spec/grape/extensions/param_builders/hash_with_indifferent_access_spec.rb +0 -105
  144. data/spec/grape/extensions/param_builders/hashie/mash_spec.rb +0 -79
  145. data/spec/grape/grape_spec.rb +0 -9
  146. data/spec/grape/integration/global_namespace_function_spec.rb +0 -29
  147. data/spec/grape/integration/rack_sendfile_spec.rb +0 -48
  148. data/spec/grape/integration/rack_spec.rb +0 -51
  149. data/spec/grape/loading_spec.rb +0 -44
  150. data/spec/grape/middleware/auth/base_spec.rb +0 -31
  151. data/spec/grape/middleware/auth/dsl_spec.rb +0 -60
  152. data/spec/grape/middleware/auth/strategies_spec.rb +0 -120
  153. data/spec/grape/middleware/base_spec.rb +0 -221
  154. data/spec/grape/middleware/error_spec.rb +0 -85
  155. data/spec/grape/middleware/exception_spec.rb +0 -294
  156. data/spec/grape/middleware/formatter_spec.rb +0 -461
  157. data/spec/grape/middleware/globals_spec.rb +0 -30
  158. data/spec/grape/middleware/stack_spec.rb +0 -155
  159. data/spec/grape/middleware/versioner/accept_version_header_spec.rb +0 -122
  160. data/spec/grape/middleware/versioner/header_spec.rb +0 -345
  161. data/spec/grape/middleware/versioner/param_spec.rb +0 -171
  162. data/spec/grape/middleware/versioner/path_spec.rb +0 -62
  163. data/spec/grape/middleware/versioner_spec.rb +0 -21
  164. data/spec/grape/named_api_spec.rb +0 -19
  165. data/spec/grape/parser_spec.rb +0 -86
  166. data/spec/grape/path_spec.rb +0 -252
  167. data/spec/grape/presenters/presenter_spec.rb +0 -71
  168. data/spec/grape/request_spec.rb +0 -126
  169. data/spec/grape/util/inheritable_setting_spec.rb +0 -242
  170. data/spec/grape/util/inheritable_values_spec.rb +0 -79
  171. data/spec/grape/util/reverse_stackable_values_spec.rb +0 -134
  172. data/spec/grape/util/stackable_values_spec.rb +0 -128
  173. data/spec/grape/util/strict_hash_configuration_spec.rb +0 -38
  174. data/spec/grape/validations/attributes_doc_spec.rb +0 -153
  175. data/spec/grape/validations/instance_behaivour_spec.rb +0 -43
  176. data/spec/grape/validations/multiple_attributes_iterator_spec.rb +0 -38
  177. data/spec/grape/validations/params_scope_spec.rb +0 -1420
  178. data/spec/grape/validations/single_attribute_iterator_spec.rb +0 -56
  179. data/spec/grape/validations/types/array_coercer_spec.rb +0 -33
  180. data/spec/grape/validations/types/primitive_coercer_spec.rb +0 -150
  181. data/spec/grape/validations/types/set_coercer_spec.rb +0 -32
  182. data/spec/grape/validations/types_spec.rb +0 -111
  183. data/spec/grape/validations/validators/all_or_none_spec.rb +0 -162
  184. data/spec/grape/validations/validators/allow_blank_spec.rb +0 -575
  185. data/spec/grape/validations/validators/at_least_one_of_spec.rb +0 -205
  186. data/spec/grape/validations/validators/base_spec.rb +0 -38
  187. data/spec/grape/validations/validators/coerce_spec.rb +0 -1261
  188. data/spec/grape/validations/validators/default_spec.rb +0 -463
  189. data/spec/grape/validations/validators/exactly_one_of_spec.rb +0 -233
  190. data/spec/grape/validations/validators/except_values_spec.rb +0 -192
  191. data/spec/grape/validations/validators/mutual_exclusion_spec.rb +0 -214
  192. data/spec/grape/validations/validators/presence_spec.rb +0 -315
  193. data/spec/grape/validations/validators/regexp_spec.rb +0 -161
  194. data/spec/grape/validations/validators/same_as_spec.rb +0 -57
  195. data/spec/grape/validations/validators/values_spec.rb +0 -733
  196. data/spec/grape/validations/validators/zh-CN.yml +0 -10
  197. data/spec/grape/validations_spec.rb +0 -2030
  198. data/spec/integration/eager_load/eager_load_spec.rb +0 -15
  199. data/spec/integration/multi_json/json_spec.rb +0 -7
  200. data/spec/integration/multi_xml/xml_spec.rb +0 -7
  201. data/spec/shared/deprecated_class_examples.rb +0 -16
  202. data/spec/shared/versioning_examples.rb +0 -215
  203. data/spec/spec_helper.rb +0 -52
  204. data/spec/support/basic_auth_encode_helpers.rb +0 -11
  205. data/spec/support/chunks.rb +0 -14
  206. data/spec/support/content_type_helpers.rb +0 -15
  207. data/spec/support/endpoint_faker.rb +0 -25
  208. data/spec/support/file_streamer.rb +0 -13
  209. data/spec/support/integer_helpers.rb +0 -13
  210. data/spec/support/versioned_helpers.rb +0 -55
@@ -1,45 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Grape
4
- module DSL
5
- module CallbacksSpec
6
- class Dummy
7
- include Grape::DSL::Callbacks
8
- end
9
- end
10
-
11
- describe Callbacks do
12
- subject { Class.new(CallbacksSpec::Dummy) }
13
-
14
- let(:proc) { -> {} }
15
-
16
- describe '.before' do
17
- it 'adds a block to "before"' do
18
- expect(subject).to receive(:namespace_stackable).with(:befores, proc)
19
- subject.before(&proc)
20
- end
21
- end
22
-
23
- describe '.before_validation' do
24
- it 'adds a block to "before_validation"' do
25
- expect(subject).to receive(:namespace_stackable).with(:before_validations, proc)
26
- subject.before_validation(&proc)
27
- end
28
- end
29
-
30
- describe '.after_validation' do
31
- it 'adds a block to "after_validation"' do
32
- expect(subject).to receive(:namespace_stackable).with(:after_validations, proc)
33
- subject.after_validation(&proc)
34
- end
35
- end
36
-
37
- describe '.after' do
38
- it 'adds a block to "after"' do
39
- expect(subject).to receive(:namespace_stackable).with(:afters, proc)
40
- subject.after(&proc)
41
- end
42
- end
43
- end
44
- end
45
- end
@@ -1,98 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- describe Grape::DSL::Desc do
4
- subject { dummy_class }
5
-
6
- let(:dummy_class) do
7
- Class.new do
8
- extend Grape::DSL::Desc
9
- end
10
- end
11
-
12
- describe '.desc' do
13
- it 'sets a description' do
14
- desc_text = 'The description'
15
- options = { message: 'none' }
16
- subject.desc desc_text, options
17
- expect(subject.namespace_setting(:description)).to eq(options.merge(description: desc_text))
18
- expect(subject.route_setting(:description)).to eq(options.merge(description: desc_text))
19
- end
20
-
21
- it 'can be set with a block' do
22
- expected_options = {
23
- summary: 'summary',
24
- description: 'The description',
25
- detail: 'more details',
26
- params: { first: :param },
27
- entity: Object,
28
- default: { code: 400, message: 'Invalid' },
29
- http_codes: [[401, 'Unauthorized', 'Entities::Error']],
30
- named: 'My named route',
31
- body_name: 'My body name',
32
- headers: [
33
- XAuthToken: {
34
- description: 'Valdates your identity',
35
- required: true
36
- },
37
- XOptionalHeader: {
38
- description: 'Not really needed',
39
- required: false
40
- }
41
- ],
42
- hidden: false,
43
- deprecated: false,
44
- is_array: true,
45
- nickname: 'nickname',
46
- produces: %w[array of mime_types],
47
- consumes: %w[array of mime_types],
48
- tags: %w[tag1 tag2],
49
- security: %w[array of security schemes]
50
- }
51
-
52
- subject.desc 'The description' do
53
- summary 'summary'
54
- detail 'more details'
55
- params(first: :param)
56
- success Object
57
- default code: 400, message: 'Invalid'
58
- failure [[401, 'Unauthorized', 'Entities::Error']]
59
- named 'My named route'
60
- body_name 'My body name'
61
- headers [
62
- XAuthToken: {
63
- description: 'Valdates your identity',
64
- required: true
65
- },
66
- XOptionalHeader: {
67
- description: 'Not really needed',
68
- required: false
69
- }
70
- ]
71
- hidden false
72
- deprecated false
73
- is_array true
74
- nickname 'nickname'
75
- produces %w[array of mime_types]
76
- consumes %w[array of mime_types]
77
- tags %w[tag1 tag2]
78
- security %w[array of security schemes]
79
- end
80
-
81
- expect(subject.namespace_setting(:description)).to eq(expected_options)
82
- expect(subject.route_setting(:description)).to eq(expected_options)
83
- end
84
-
85
- it 'can be set with options and a block' do
86
- expect(ActiveSupport::Deprecation).to receive(:warn).with('Passing a options hash and a block to `desc` is deprecated. Move all hash options to block.')
87
-
88
- desc_text = 'The description'
89
- detail_text = 'more details'
90
- options = { message: 'none' }
91
- subject.desc desc_text, options do
92
- detail detail_text
93
- end
94
- expect(subject.namespace_setting(:description)).to eq(description: desc_text, detail: detail_text)
95
- expect(subject.route_setting(:description)).to eq(description: desc_text, detail: detail_text)
96
- end
97
- end
98
- end
@@ -1,62 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Grape
4
- module DSL
5
- module HeadersSpec
6
- class Dummy
7
- include Grape::DSL::Headers
8
- end
9
- end
10
- describe Headers do
11
- subject { HeadersSpec::Dummy.new }
12
-
13
- let(:header_data) do
14
- { 'First Key' => 'First Value',
15
- 'Second Key' => 'Second Value' }
16
- end
17
-
18
- context 'when headers are set' do
19
- describe '#header' do
20
- before do
21
- header_data.each { |k, v| subject.header(k, v) }
22
- end
23
-
24
- describe 'get' do
25
- it 'returns a specifc value' do
26
- expect(subject.header['First Key']).to eq 'First Value'
27
- expect(subject.header['Second Key']).to eq 'Second Value'
28
- end
29
-
30
- it 'returns all set headers' do
31
- expect(subject.header).to eq header_data
32
- expect(subject.headers).to eq header_data
33
- end
34
- end
35
-
36
- describe 'set' do
37
- it 'returns value' do
38
- expect(subject.header('Third Key', 'Third Value'))
39
- expect(subject.header['Third Key']).to eq 'Third Value'
40
- end
41
- end
42
-
43
- describe 'delete' do
44
- it 'deletes a header key-value pair' do
45
- expect(subject.header('First Key')).to eq header_data['First Key']
46
- expect(subject.header).not_to have_key('First Key')
47
- end
48
- end
49
- end
50
- end
51
-
52
- context 'when no headers are set' do
53
- describe '#header' do
54
- it 'returns nil' do
55
- expect(subject.header['First Key']).to be_nil
56
- expect(subject.header('First Key')).to be_nil
57
- end
58
- end
59
- end
60
- end
61
- end
62
- end
@@ -1,100 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Grape
4
- module DSL
5
- module HelpersSpec
6
- class Dummy
7
- include Grape::DSL::Helpers
8
-
9
- def self.mods
10
- namespace_stackable(:helpers)
11
- end
12
-
13
- def self.first_mod
14
- mods.first
15
- end
16
- end
17
- end
18
-
19
- module BooleanParam
20
- extend Grape::API::Helpers
21
-
22
- params :requires_toggle_prm do
23
- requires :toggle_prm, type: Boolean
24
- end
25
- end
26
-
27
- class Base < Grape::API
28
- helpers BooleanParam
29
- end
30
-
31
- class Child < Base; end
32
-
33
- describe Helpers do
34
- subject { Class.new(HelpersSpec::Dummy) }
35
-
36
- let(:proc) do
37
- lambda do |*|
38
- def test
39
- :test
40
- end
41
- end
42
- end
43
-
44
- describe '.helpers' do
45
- it 'adds a module with the given block' do
46
- expect(subject).to receive(:namespace_stackable).with(:helpers, kind_of(Grape::DSL::Helpers::BaseHelper)).and_call_original
47
- expect(subject).to receive(:namespace_stackable).with(:helpers).and_call_original
48
- subject.helpers(&proc)
49
-
50
- expect(subject.first_mod.instance_methods).to include(:test)
51
- end
52
-
53
- it 'uses provided modules' do
54
- mod = Module.new
55
-
56
- expect(subject).to receive(:namespace_stackable).with(:helpers, kind_of(Grape::DSL::Helpers::BaseHelper)).and_call_original.twice
57
- expect(subject).to receive(:namespace_stackable).with(:helpers).and_call_original
58
- subject.helpers(mod, &proc)
59
-
60
- expect(subject.first_mod).to eq mod
61
- end
62
-
63
- it 'uses many provided modules' do
64
- mod = Module.new
65
- mod2 = Module.new
66
- mod3 = Module.new
67
-
68
- expect(subject).to receive(:namespace_stackable).with(:helpers, kind_of(Grape::DSL::Helpers::BaseHelper)).and_call_original.exactly(4).times
69
- expect(subject).to receive(:namespace_stackable).with(:helpers).and_call_original.exactly(3).times
70
-
71
- subject.helpers(mod, mod2, mod3, &proc)
72
-
73
- expect(subject.mods).to include(mod)
74
- expect(subject.mods).to include(mod2)
75
- expect(subject.mods).to include(mod3)
76
- end
77
-
78
- context 'with an external file' do
79
- it 'sets Boolean as a Grape::API::Boolean' do
80
- subject.helpers BooleanParam
81
- expect(subject.first_mod::Boolean).to eq Grape::API::Boolean
82
- end
83
- end
84
-
85
- context 'in child classes' do
86
- it 'is available' do
87
- klass = Child
88
- expect do
89
- klass.instance_eval do
90
- params do
91
- use :requires_toggle_prm
92
- end
93
- end
94
- end.not_to raise_exception
95
- end
96
- end
97
- end
98
- end
99
- end
100
- end