grape 1.8.0 → 2.1.0

Sign up to get free protection for your applications and to get access to all the features.
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,56 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- describe Grape::Validations::SingleAttributeIterator do
4
- describe '#each' do
5
- subject(:iterator) { described_class.new(validator, scope, params) }
6
-
7
- let(:scope) { Grape::Validations::ParamsScope.new(api: Class.new(Grape::API)) }
8
- let(:validator) { double(attrs: %i[first second]) }
9
-
10
- context 'when params is a hash' do
11
- let(:params) do
12
- { first: 'string', second: 'string' }
13
- end
14
-
15
- it 'yields params and every single attribute from the list' do
16
- expect { |b| iterator.each(&b) }
17
- .to yield_successive_args([params, :first, false], [params, :second, false])
18
- end
19
- end
20
-
21
- context 'when params is an array' do
22
- let(:params) do
23
- [{ first: 'string1', second: 'string1' }, { first: 'string2', second: 'string2' }]
24
- end
25
-
26
- it 'yields every single attribute from the list for each of the array elements' do
27
- expect { |b| iterator.each(&b) }.to yield_successive_args(
28
- [params[0], :first, false], [params[0], :second, false],
29
- [params[1], :first, false], [params[1], :second, false]
30
- )
31
- end
32
-
33
- context 'empty values' do
34
- let(:params) { [{}, '', 10] }
35
-
36
- it 'marks params with empty values' do
37
- expect { |b| iterator.each(&b) }.to yield_successive_args(
38
- [params[0], :first, true], [params[0], :second, true],
39
- [params[1], :first, true], [params[1], :second, true],
40
- [params[2], :first, false], [params[2], :second, false]
41
- )
42
- end
43
- end
44
-
45
- context 'when missing optional value' do
46
- let(:params) { [Grape::DSL::Parameters::EmptyOptionalValue, 10] }
47
-
48
- it 'does not yield skipped values' do
49
- expect { |b| iterator.each(&b) }.to yield_successive_args(
50
- [params[1], :first, false], [params[1], :second, false]
51
- )
52
- end
53
- end
54
- end
55
- end
56
- end
@@ -1,33 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- describe Grape::Validations::Types::ArrayCoercer do
4
- subject { described_class.new(type) }
5
-
6
- describe '#call' do
7
- context 'an array of primitives' do
8
- let(:type) { Array[String] }
9
-
10
- it 'coerces elements in the array' do
11
- expect(subject.call([10, 20])).to eq(%w[10 20])
12
- end
13
- end
14
-
15
- context 'an array of arrays' do
16
- let(:type) { Array[Array[Integer]] }
17
-
18
- it 'coerces elements in the nested array' do
19
- expect(subject.call([%w[10 20]])).to eq([[10, 20]])
20
- expect(subject.call([['10'], ['20']])).to eq([[10], [20]])
21
- end
22
- end
23
-
24
- context 'an array of sets' do
25
- let(:type) { Array[Set[Integer]] }
26
-
27
- it 'coerces elements in the nested set' do
28
- expect(subject.call([%w[10 20]])).to eq([Set[10, 20]])
29
- expect(subject.call([['10'], ['20']])).to eq([Set[10], Set[20]])
30
- end
31
- end
32
- end
33
- end
@@ -1,150 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- describe Grape::Validations::Types::PrimitiveCoercer do
4
- subject { described_class.new(type, strict) }
5
-
6
- let(:strict) { false }
7
-
8
- describe '#call' do
9
- context 'BigDecimal' do
10
- let(:type) { BigDecimal }
11
-
12
- it 'coerces to BigDecimal' do
13
- expect(subject.call(5)).to eq(BigDecimal('5'))
14
- end
15
-
16
- it 'coerces an empty string to nil' do
17
- expect(subject.call('')).to be_nil
18
- end
19
- end
20
-
21
- context 'Boolean' do
22
- let(:type) { Grape::API::Boolean }
23
-
24
- [true, 'true', 1].each do |val|
25
- it "coerces '#{val}' to true" do
26
- expect(subject.call(val)).to be(true)
27
- end
28
- end
29
-
30
- [false, 'false', 0].each do |val|
31
- it "coerces '#{val}' to false" do
32
- expect(subject.call(val)).to be(false)
33
- end
34
- end
35
-
36
- it 'returns an error when the given value cannot be coerced' do
37
- expect(subject.call(123)).to be_instance_of(Grape::Validations::Types::InvalidValue)
38
- end
39
-
40
- it 'coerces an empty string to nil' do
41
- expect(subject.call('')).to be_nil
42
- end
43
- end
44
-
45
- context 'DateTime' do
46
- let(:type) { DateTime }
47
-
48
- it 'coerces an empty string to nil' do
49
- expect(subject.call('')).to be_nil
50
- end
51
- end
52
-
53
- context 'Float' do
54
- let(:type) { Float }
55
-
56
- it 'coerces an empty string to nil' do
57
- expect(subject.call('')).to be_nil
58
- end
59
- end
60
-
61
- context 'Integer' do
62
- let(:type) { Integer }
63
-
64
- it 'coerces an empty string to nil' do
65
- expect(subject.call('')).to be_nil
66
- end
67
-
68
- it 'accepts non-nil value' do
69
- expect(subject.call(42)).to be_a(Integer)
70
- end
71
- end
72
-
73
- context 'Numeric' do
74
- let(:type) { Numeric }
75
-
76
- it 'coerces an empty string to nil' do
77
- expect(subject.call('')).to be_nil
78
- end
79
-
80
- it 'accepts a non-nil value' do
81
- expect(subject.call(42)).to be_a(Numeric) # in fact Integer
82
- end
83
- end
84
-
85
- context 'Time' do
86
- let(:type) { Time }
87
-
88
- it 'coerces an empty string to nil' do
89
- expect(subject.call('')).to be_nil
90
- end
91
- end
92
-
93
- context 'String' do
94
- let(:type) { String }
95
-
96
- it 'coerces to String' do
97
- expect(subject.call(10)).to eq('10')
98
- end
99
-
100
- it 'does not coerce an empty string to nil' do
101
- expect(subject.call('')).to eq('')
102
- end
103
- end
104
-
105
- context 'Symbol' do
106
- let(:type) { Symbol }
107
-
108
- it 'coerces an empty string to nil' do
109
- expect(subject.call('')).to be_nil
110
- end
111
- end
112
-
113
- context 'a type unknown in Dry-types' do
114
- let(:type) { Complex }
115
-
116
- it 'raises error on init' do
117
- expect(DryTypes::Params.constants).not_to include(type.name.to_sym)
118
- expect { subject }.to raise_error(/type Complex should support coercion/)
119
- end
120
- end
121
-
122
- context 'the strict mode' do
123
- let(:strict) { true }
124
-
125
- context 'Boolean' do
126
- let(:type) { Grape::API::Boolean }
127
-
128
- it 'returns an error when the given value is not Boolean' do
129
- expect(subject.call(1)).to be_instance_of(Grape::Validations::Types::InvalidValue)
130
- end
131
-
132
- it 'returns a value as it is when the given value is Boolean' do
133
- expect(subject.call(true)).to be(true)
134
- end
135
- end
136
-
137
- context 'BigDecimal' do
138
- let(:type) { BigDecimal }
139
-
140
- it 'returns an error when the given value is not BigDecimal' do
141
- expect(subject.call(1)).to be_instance_of(Grape::Validations::Types::InvalidValue)
142
- end
143
-
144
- it 'returns a value as it is when the given value is BigDecimal' do
145
- expect(subject.call(BigDecimal('0'))).to eq(BigDecimal('0'))
146
- end
147
- end
148
- end
149
- end
150
- end
@@ -1,32 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- describe Grape::Validations::Types::SetCoercer do
4
- subject { described_class.new(type) }
5
-
6
- describe '#call' do
7
- context 'a set of primitives' do
8
- let(:type) { Set[String] }
9
-
10
- it 'coerces elements to the set' do
11
- expect(subject.call([10, 20])).to eq(Set['10', '20'])
12
- end
13
- end
14
-
15
- context 'a set of sets' do
16
- let(:type) { Set[Set[Integer]] }
17
-
18
- it 'coerces elements in the nested set' do
19
- expect(subject.call([%w[10 20]])).to eq(Set[Set[10, 20]])
20
- expect(subject.call([['10'], ['20']])).to eq(Set[Set[10], Set[20]])
21
- end
22
- end
23
-
24
- context 'a set of sets of arrays' do
25
- let(:type) { Set[Set[Array[Integer]]] }
26
-
27
- it 'coerces elements in the nested set' do
28
- expect(subject.call([[['10'], ['20']]])).to eq(Set[Set[Array[10], Array[20]]])
29
- end
30
- end
31
- end
32
- end
@@ -1,111 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- describe Grape::Validations::Types do
4
- module TypesSpec
5
- class FooType
6
- def self.parse(_); end
7
- end
8
-
9
- class BarType
10
- def self.parse; end
11
- end
12
- end
13
-
14
- describe '::primitive?' do
15
- [
16
- Integer, Float, Numeric, BigDecimal,
17
- Grape::API::Boolean, String, Symbol,
18
- Date, DateTime, Time
19
- ].each do |type|
20
- it "recognizes #{type} as a primitive" do
21
- expect(described_class).to be_primitive(type)
22
- end
23
- end
24
-
25
- it 'identifies unknown types' do
26
- expect(described_class).not_to be_primitive(Object)
27
- expect(described_class).not_to be_primitive(TypesSpec::FooType)
28
- end
29
- end
30
-
31
- describe '::structure?' do
32
- [
33
- Hash, Array, Set
34
- ].each do |type|
35
- it "recognizes #{type} as a structure" do
36
- expect(described_class).to be_structure(type)
37
- end
38
- end
39
- end
40
-
41
- describe '::special?' do
42
- [
43
- JSON, Array[JSON], File, Rack::Multipart::UploadedFile
44
- ].each do |type|
45
- it "provides special handling for #{type.inspect}" do
46
- expect(described_class).to be_special(type)
47
- end
48
- end
49
- end
50
-
51
- describe 'special types' do
52
- subject { described_class::SPECIAL[type] }
53
-
54
- context 'when JSON' do
55
- let(:type) { JSON }
56
-
57
- it { is_expected.to eq(Grape::Validations::Types::Json) }
58
- end
59
-
60
- context 'when Array[JSON]' do
61
- let(:type) { Array[JSON] }
62
-
63
- it { is_expected.to eq(Grape::Validations::Types::JsonArray) }
64
- end
65
-
66
- context 'when File' do
67
- let(:type) { File }
68
-
69
- it { is_expected.to eq(Grape::Validations::Types::File) }
70
- end
71
-
72
- context 'when Rack::Multipart::UploadedFile' do
73
- let(:type) { Rack::Multipart::UploadedFile }
74
-
75
- it { is_expected.to eq(Grape::Validations::Types::File) }
76
- end
77
- end
78
-
79
- describe '::custom?' do
80
- it 'returns false if the type does not respond to :parse' do
81
- expect(described_class).not_to be_custom(Object)
82
- end
83
-
84
- it 'returns true if the type responds to :parse with one argument' do
85
- expect(described_class).to be_custom(TypesSpec::FooType)
86
- end
87
-
88
- it 'returns false if the type\'s #parse method takes other than one argument' do
89
- expect(described_class).not_to be_custom(TypesSpec::BarType)
90
- end
91
- end
92
-
93
- describe '::build_coercer' do
94
- it 'has internal cache variables' do
95
- expect(described_class.instance_variable_get(:@__cache)).to be_a(Hash)
96
- expect(described_class.instance_variable_get(:@__cache_write_lock)).to be_a(Mutex)
97
- end
98
-
99
- it 'caches the result of the build_coercer method' do
100
- original_cache = described_class.instance_variable_get(:@__cache)
101
- described_class.instance_variable_set(:@__cache, {})
102
-
103
- a_coercer = described_class.build_coercer(Array[String])
104
- b_coercer = described_class.build_coercer(Array[String])
105
-
106
- expect(a_coercer.object_id).to eq(b_coercer.object_id)
107
-
108
- described_class.instance_variable_set(:@__cache, original_cache)
109
- end
110
- end
111
- end
@@ -1,162 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- describe Grape::Validations::Validators::AllOrNoneOfValidator do
4
- let_it_be(:app) do
5
- Class.new(Grape::API) do
6
- rescue_from Grape::Exceptions::ValidationErrors do |e|
7
- error!(e.errors.transform_keys! { |key| key.join(',') }, 400)
8
- end
9
-
10
- params do
11
- optional :beer, :wine, type: Grape::API::Boolean
12
- all_or_none_of :beer, :wine
13
- end
14
- post do
15
- end
16
-
17
- params do
18
- optional :beer, :wine, :other, type: Grape::API::Boolean
19
- all_or_none_of :beer, :wine
20
- end
21
- post 'mixed-params' do
22
- end
23
-
24
- params do
25
- optional :beer, :wine, type: Grape::API::Boolean
26
- all_or_none_of :beer, :wine, message: 'choose all or none'
27
- end
28
- post '/custom-message' do
29
- end
30
-
31
- params do
32
- requires :item, type: Hash do
33
- optional :beer, :wine, type: Grape::API::Boolean
34
- all_or_none_of :beer, :wine
35
- end
36
- end
37
- post '/nested-hash' do
38
- end
39
-
40
- params do
41
- requires :items, type: Array do
42
- optional :beer, :wine, type: Grape::API::Boolean
43
- all_or_none_of :beer, :wine
44
- end
45
- end
46
- post '/nested-array' do
47
- end
48
-
49
- params do
50
- requires :items, type: Array do
51
- requires :nested_items, type: Array do
52
- optional :beer, :wine, type: Grape::API::Boolean
53
- all_or_none_of :beer, :wine
54
- end
55
- end
56
- end
57
- post '/deeply-nested-array' do
58
- end
59
- end
60
- end
61
-
62
- describe '#validate!' do
63
- subject(:validate) { post path, params }
64
-
65
- context 'when all restricted params are present' do
66
- let(:path) { '/' }
67
- let(:params) { { beer: true, wine: true } }
68
-
69
- it 'does not return a validation error' do
70
- validate
71
- expect(last_response.status).to eq 201
72
- end
73
-
74
- context 'mixed with other params' do
75
- let(:path) { '/mixed-params' }
76
- let(:params) { { beer: true, wine: true, other: true } }
77
-
78
- it 'does not return a validation error' do
79
- validate
80
- expect(last_response.status).to eq 201
81
- end
82
- end
83
- end
84
-
85
- context 'when a subset of restricted params are present' do
86
- let(:path) { '/' }
87
- let(:params) { { beer: true } }
88
-
89
- it 'returns a validation error' do
90
- validate
91
- expect(last_response.status).to eq 400
92
- expect(JSON.parse(last_response.body)).to eq(
93
- 'beer,wine' => ['provide all or none of parameters']
94
- )
95
- end
96
- end
97
-
98
- context 'when custom message is specified' do
99
- let(:path) { '/custom-message' }
100
- let(:params) { { beer: true } }
101
-
102
- it 'returns a validation error' do
103
- validate
104
- expect(last_response.status).to eq 400
105
- expect(JSON.parse(last_response.body)).to eq(
106
- 'beer,wine' => ['choose all or none']
107
- )
108
- end
109
- end
110
-
111
- context 'when no restricted params are present' do
112
- let(:path) { '/' }
113
- let(:params) { { somethingelse: true } }
114
-
115
- it 'does not return a validation error' do
116
- validate
117
- expect(last_response.status).to eq 201
118
- end
119
- end
120
-
121
- context 'when restricted params are nested inside required hash' do
122
- let(:path) { '/nested-hash' }
123
- let(:params) { { item: { beer: true } } }
124
-
125
- it 'returns a validation error with full names of the params' do
126
- validate
127
- expect(last_response.status).to eq 400
128
- expect(JSON.parse(last_response.body)).to eq(
129
- 'item[beer],item[wine]' => ['provide all or none of parameters']
130
- )
131
- end
132
- end
133
-
134
- context 'when mutually exclusive params are nested inside array' do
135
- let(:path) { '/nested-array' }
136
- let(:params) { { items: [{ beer: true, wine: true }, { wine: true }] } }
137
-
138
- it 'returns a validation error with full names of the params' do
139
- validate
140
- expect(last_response.status).to eq 400
141
- expect(JSON.parse(last_response.body)).to eq(
142
- 'items[1][beer],items[1][wine]' => ['provide all or none of parameters']
143
- )
144
- end
145
- end
146
-
147
- context 'when mutually exclusive params are deeply nested' do
148
- let(:path) { '/deeply-nested-array' }
149
- let(:params) { { items: [{ nested_items: [{ beer: true }] }] } }
150
-
151
- it 'returns a validation error with full names of the params' do
152
- validate
153
- expect(last_response.status).to eq 400
154
- expect(JSON.parse(last_response.body)).to eq(
155
- 'items[0][nested_items][0][beer],items[0][nested_items][0][wine]' => [
156
- 'provide all or none of parameters'
157
- ]
158
- )
159
- end
160
- end
161
- end
162
- end