committee 5.6.3 → 5.7.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 (49) hide show
  1. checksums.yaml +4 -4
  2. data/lib/committee/drivers/open_api_2/driver.rb +16 -0
  3. data/lib/committee/drivers/open_api_2/link.rb +2 -0
  4. data/lib/committee/drivers/open_api_3/schema.rb +6 -1
  5. data/lib/committee/drivers.rb +15 -8
  6. data/lib/committee/middleware/options/response_validation.rb +4 -2
  7. data/lib/committee/middleware/response_validation.rb +37 -10
  8. data/lib/committee/middleware/stub.rb +1 -1
  9. data/lib/committee/request_unpacker.rb +19 -9
  10. data/lib/committee/schema_locations.rb +96 -0
  11. data/lib/committee/schema_validator/hyper_schema/request_validator.rb +1 -1
  12. data/lib/committee/schema_validator/hyper_schema/response_validator.rb +14 -4
  13. data/lib/committee/schema_validator/hyper_schema.rb +5 -4
  14. data/lib/committee/schema_validator/open_api_3/operation_wrapper.rb +76 -40
  15. data/lib/committee/schema_validator/open_api_3/parameter_deserializer.rb +66 -20
  16. data/lib/committee/schema_validator/open_api_3/request_validator.rb +2 -3
  17. data/lib/committee/schema_validator/open_api_3/response_validator.rb +2 -1
  18. data/lib/committee/schema_validator/open_api_3/router.rb +1 -3
  19. data/lib/committee/schema_validator/open_api_3.rb +26 -18
  20. data/lib/committee/schema_validator/option.rb +2 -1
  21. data/lib/committee/schema_validator.rb +1 -5
  22. data/lib/committee/test/except_parameter.rb +4 -4
  23. data/lib/committee/test/methods.rb +14 -1
  24. data/lib/committee/test/schema_coverage.rb +11 -2
  25. data/lib/committee/utils.rb +6 -0
  26. data/lib/committee/validation_error.rb +1 -1
  27. data/lib/committee/version.rb +1 -1
  28. data/lib/committee.rb +1 -0
  29. data/test/drivers/open_api_2/driver_test.rb +13 -0
  30. data/test/drivers_test.rb +39 -8
  31. data/test/middleware/options/response_validation_test.rb +15 -0
  32. data/test/middleware/request_validation_open_api_3_test.rb +670 -8
  33. data/test/middleware/request_validation_test.rb +50 -0
  34. data/test/middleware/response_validation_open_api_3_test.rb +162 -0
  35. data/test/middleware/response_validation_test.rb +134 -0
  36. data/test/middleware/stub_test.rb +10 -0
  37. data/test/request_unpacker_test.rb +34 -0
  38. data/test/schema_location_test.rb +111 -0
  39. data/test/schema_validator/hyper_schema/response_validator_test.rb +16 -0
  40. data/test/schema_validator/open_api_3/operation_wrapper_test.rb +95 -0
  41. data/test/schema_validator/open_api_3/parameter_deserializer_test.rb +145 -8
  42. data/test/schema_validator/open_api_3_test.rb +27 -0
  43. data/test/schema_validator_test.rb +10 -0
  44. data/test/test/methods_test.rb +200 -0
  45. data/test/test/schema_coverage_test.rb +34 -0
  46. data/test/test_helper.rb +23 -0
  47. data/test/utils_test.rb +28 -0
  48. data/test/validation_error_test.rb +1 -1
  49. metadata +22 -4
@@ -12,15 +12,18 @@ module Committee
12
12
  class ParameterDeserializer
13
13
  # @param [OpenAPIParser::RequestOperation] request_operation
14
14
  def initialize(request_operation)
15
- @request_operation = request_operation
16
15
  @parameters = request_operation.operation_object.parameters || []
16
+ if request_operation.respond_to?(:path_item) && request_operation.path_item
17
+ @parameters = (@parameters + (request_operation.path_item.parameters || [])).uniq { |param| [param.in, param.name] }
18
+ end
17
19
  end
18
20
 
19
21
  # Deserialize query parameters
20
22
  # @param [Hash] raw_params Raw query parameters from Rack
23
+ # @param [Hash] query_values Query parameters with repeated keys preserved
21
24
  # @return [Hash] Deserialized parameters according to OpenAPI schema
22
- def deserialize_query_params(raw_params)
23
- deserialize_params_by_location(raw_params, 'query')
25
+ def deserialize_query_params(raw_params, query_values = {})
26
+ deserialize_params_by_location(raw_params, 'query', query_values)
24
27
  end
25
28
 
26
29
  # Deserialize path parameters
@@ -34,6 +37,11 @@ module Committee
34
37
  # @param [Hash] raw_headers Raw headers
35
38
  # @return [Hash] Deserialized headers according to OpenAPI schema
36
39
  def deserialize_headers(raw_headers)
40
+ return raw_headers if raw_headers.nil? || raw_headers.empty?
41
+
42
+ raw_headers = raw_headers.transform_keys do |name|
43
+ @parameters.find { |param| param.in == 'header' && param.name.casecmp?(name.to_s) }&.name || name
44
+ end
37
45
  deserialize_params_by_location(raw_headers, 'header')
38
46
  end
39
47
 
@@ -42,8 +50,9 @@ module Committee
42
50
  # Deserialize parameters for a specific location (query, path, header)
43
51
  # @param [Hash] raw_params Raw parameters
44
52
  # @param [String] location Parameter location ('query', 'path', 'header')
53
+ # @param [Hash] query_values Query parameters with repeated keys preserved
45
54
  # @return [Hash] Deserialized parameters
46
- def deserialize_params_by_location(raw_params, location)
55
+ def deserialize_params_by_location(raw_params, location, query_values = {})
47
56
  return raw_params if raw_params.nil? || raw_params.empty?
48
57
 
49
58
  result = Committee::Utils.indifferent_hash
@@ -52,7 +61,7 @@ module Committee
52
61
  # If no parameters are defined for this location, return raw params as-is
53
62
  return raw_params if params_for_location.empty?
54
63
 
55
- raw_params = normalize_raw_params(raw_params, location, params_for_location)
64
+ raw_params = normalize_raw_params(raw_params, location, params_for_location, query_values)
56
65
 
57
66
  # Collect parameter names that will be deserialized
58
67
  # This includes both the parameter name and any properties (for exploded objects)
@@ -71,7 +80,7 @@ module Committee
71
80
  deserialized_keys.add(param_def.name)
72
81
 
73
82
  # For form-style exploded objects, mark the property keys as deserialized
74
- if param_def.schema&.type == 'object' &&
83
+ if Committee::Utils.schema_type(param_def.schema) == 'object' &&
75
84
  (param_def.style.nil? || param_def.style == 'form') &&
76
85
  (param_def.explode.nil? || param_def.explode)
77
86
  param_def.schema.properties&.each_key do |prop_name|
@@ -107,15 +116,39 @@ module Committee
107
116
  Committee::Utils.indifferent_hash.merge(hash)
108
117
  end
109
118
 
110
- # Normalize Rack-style nested query hashes into bracket notation when the
111
- # schema expects bracket-named params or deepObject query params.
119
+ # Restore repeated array values and normalize Rack-style nested query hashes
120
+ # when the schema expects bracket-named params or deepObject query params.
112
121
  # Example: { "filter" => { "slug" => "/test" } } => { "filter[slug]" => "/test" }
113
122
  # @param [Hash] raw_params
114
123
  # @param [String] location
115
124
  # @param [Array<OpenAPIParser::Schemas::Parameter>] params_for_location
125
+ # @param [Hash] query_values Query parameters with repeated keys preserved
116
126
  # @return [Hash]
117
- def normalize_raw_params(raw_params, location, params_for_location)
127
+ def normalize_raw_params(raw_params, location, params_for_location, query_values)
118
128
  return raw_params unless location == 'query'
129
+
130
+ normalized = raw_params
131
+ params_for_location.each do |param_def|
132
+ next unless Committee::Utils.schema_type(param_def.schema) == 'array'
133
+
134
+ style = param_def.style || default_style(location)
135
+ explode = param_def.explode.nil? ? default_explode(style) : param_def.explode
136
+
137
+ if explode && query_values[param_def.name].is_a?(Array)
138
+ normalized = raw_params.dup if normalized.equal?(raw_params)
139
+ normalized[param_def.name] = query_values[param_def.name]
140
+ end
141
+
142
+ next unless param_def.name.end_with?('[]')
143
+
144
+ raw_name = param_def.name.delete_suffix('[]')
145
+ next unless normalized[raw_name].is_a?(Array)
146
+
147
+ normalized = raw_params.dup if normalized.equal?(raw_params)
148
+ normalized[param_def.name] = normalized.delete(raw_name)
149
+ end
150
+
151
+ raw_params = normalized
119
152
  return raw_params unless raw_params.values.any? { |value| value.is_a?(Hash) }
120
153
  return raw_params unless requires_query_param_flattening?(params_for_location)
121
154
 
@@ -229,7 +262,7 @@ module Committee
229
262
  schema = param_def.schema
230
263
  return nil unless schema
231
264
 
232
- case schema.type
265
+ case Committee::Utils.schema_type(schema)
233
266
  when 'object'
234
267
  deserialize_form_object(param_name, schema, raw_params, explode)
235
268
  when 'array'
@@ -270,8 +303,7 @@ module Committee
270
303
  return nil unless value
271
304
 
272
305
  if explode
273
- # explode=true: Rack already collects ?id=1&id=2 into an array
274
- # Just ensure it's an array
306
+ # Repeated query values are collected before deserialization.
275
307
  Array(value)
276
308
  else
277
309
  # explode=false: comma-separated values
@@ -352,7 +384,7 @@ module Committee
352
384
  schema = param_def.schema
353
385
  return value unless schema
354
386
 
355
- case schema.type
387
+ case Committee::Utils.schema_type(schema)
356
388
  when 'array'
357
389
  # Both explode true/false use comma separation for simple style
358
390
  # Example: "1,2,3" → ["1", "2", "3"]
@@ -386,7 +418,7 @@ module Committee
386
418
  schema = param_def.schema
387
419
  return value unless schema
388
420
 
389
- case schema.type
421
+ case Committee::Utils.schema_type(schema)
390
422
  when 'array'
391
423
  if explode
392
424
  # explode=true: .3.4.5 → ["3", "4", "5"]
@@ -421,12 +453,22 @@ module Committee
421
453
  schema = param_def.schema
422
454
  return value unless schema
423
455
 
424
- case schema.type
456
+ case Committee::Utils.schema_type(schema)
425
457
  when 'array'
426
458
  if explode
427
- # explode=true: ;id=3;id=4 (multiple occurrences)
428
- # Rack should have already collected these into an array
429
- Array(value)
459
+ if value.is_a?(String)
460
+ prefix = "#{param_name}="
461
+ return [] if value == ";#{param_name}"
462
+ raise ArgumentError, 'invalid matrix array' unless value.start_with?(";#{prefix}")
463
+
464
+ value.split(';', -1).drop(1).map do |part|
465
+ raise ArgumentError, 'invalid matrix array' unless part.start_with?(prefix)
466
+
467
+ part.delete_prefix(prefix)
468
+ end
469
+ else
470
+ Array(value)
471
+ end
430
472
  else
431
473
  # explode=false: ;id=3,4,5
432
474
  extract_matrix_array_compact(value, param_name)
@@ -450,12 +492,14 @@ module Committee
450
492
  # @param [String] param_name Parameter name
451
493
  # @return [Array] Extracted array
452
494
  def extract_matrix_array_compact(value, param_name)
495
+ return [] if value == ";#{param_name}"
496
+
453
497
  # ;id=3,4,5 → ["3", "4", "5"]
454
498
  prefix = ";#{param_name}="
455
499
  if value.start_with?(prefix)
456
500
  value[prefix.length..-1].split(',')
457
501
  else
458
- []
502
+ raise ArgumentError, 'invalid matrix array'
459
503
  end
460
504
  end
461
505
 
@@ -482,12 +526,14 @@ module Committee
482
526
  # @param [String] param_name Parameter name
483
527
  # @return [Hash] Extracted object
484
528
  def extract_matrix_object_compact(value, param_name)
529
+ return {} if value == ";#{param_name}"
530
+
485
531
  # ;id=role,admin,status,active → { "role" => "admin", "status" => "active" }
486
532
  prefix = ";#{param_name}="
487
533
  if value.start_with?(prefix)
488
534
  parse_comma_separated_object(value[prefix.length..-1])
489
535
  else
490
- {}
536
+ raise ArgumentError, 'invalid matrix object'
491
537
  end
492
538
  end
493
539
 
@@ -21,8 +21,7 @@ module Committee
21
21
  private
22
22
 
23
23
  def check_content_type(request, content_type)
24
- # support post, put, patch, options only
25
- return true unless request.post? || request.put? || request.patch? || request.options?
24
+ return true unless @operation_object.body_method?
26
25
  return true if @operation_object.valid_request_content_type?(content_type)
27
26
  return true if @operation_object.optional_body? && empty_request?(request)
28
27
 
@@ -43,7 +42,7 @@ module Committee
43
42
  return true if !request.body
44
43
 
45
44
  data = request.body.read
46
- request.body.rewind
45
+ request.body.rewind if request.body.respond_to?(:rewind)
47
46
  data.empty?
48
47
  end
49
48
  end
@@ -14,6 +14,7 @@ module Committee
14
14
  @check_header = validator_option.check_header
15
15
  @allow_empty_date_and_datetime = validator_option.allow_empty_date_and_datetime
16
16
  @coerce_response_values = validator_option.coerce_response_values
17
+ @strict_response_content_type = validator_option.strict_response_content_type
17
18
  end
18
19
 
19
20
  def call(status, headers, response_data, strict)
@@ -21,7 +22,7 @@ module Committee
21
22
 
22
23
  validator_options = { allow_empty_date_and_datetime: @allow_empty_date_and_datetime, coerce_value: @coerce_response_values }
23
24
 
24
- operation_wrapper.validate_response_params(status, headers, response_data, strict, check_header, validator_options: validator_options)
25
+ operation_wrapper.validate_response_params(status, headers, response_data, strict, check_header, strict_response_content_type: @strict_response_content_type, validator_options: validator_options)
25
26
  end
26
27
 
27
28
  def validate?(status)
@@ -27,9 +27,7 @@ module Committee
27
27
  path = request.path
28
28
  path = path.gsub(@prefix_regexp, '') if @prefix_regexp
29
29
 
30
- request_method = request.request_method.downcase
31
-
32
- @schema.operation_object(path, request_method)
30
+ @schema.operation_object(path, request.request_method)
33
31
  end
34
32
 
35
33
  private
@@ -21,10 +21,11 @@ module Committee
21
21
  end
22
22
 
23
23
  def response_validate(status, headers, response, test_method = false, custom_body_parser = nil)
24
- full_body = +""
25
- response.each do |chunk|
26
- full_body << chunk
27
- end
24
+ full_body = if response.is_a?(String)
25
+ response
26
+ else
27
+ response.each_with_object(String.new(encoding: Encoding::BINARY)) { |chunk, body| body << chunk.b }.force_encoding(Encoding::UTF_8)
28
+ end
28
29
 
29
30
  parse_to_json = if validator_option.parse_response_by_content_type
30
31
  content_type_key = headers.keys.detect { |k| k.casecmp?('Content-Type') }
@@ -50,12 +51,17 @@ module Committee
50
51
  !@operation_object.nil?
51
52
  end
52
53
 
54
+ # Expose the operation matched for the request, or nil if none matched
55
+ # @return [Committee::SchemaValidator::OpenAPI3::OperationWrapper, nil]
56
+ attr_reader :operation_object
57
+
53
58
  private
54
59
 
55
60
  attr_reader :validator_option
56
61
 
57
- def coerce_path_params
58
- Committee::RequestUnpacker.indifferent_params(@operation_object.coerce_path_parameter(@validator_option))
62
+ def coerce_path_params(deserializer)
63
+ path_params = deserializer&.deserialize_path_params(@operation_object.path_params)
64
+ Committee::RequestUnpacker.indifferent_params(@operation_object.coerce_path_parameter(@validator_option, path_params))
59
65
  end
60
66
 
61
67
  def request_schema_validation(request)
@@ -82,25 +88,26 @@ module Committee
82
88
  end
83
89
 
84
90
  def request_unpack(request)
85
- unpacker = Committee::RequestUnpacker.new(allow_empty_date_and_datetime: validator_option.allow_empty_date_and_datetime, allow_form_params: validator_option.allow_form_params, allow_get_body: validator_option.allow_get_body, allow_query_params: validator_option.allow_query_params, allow_non_get_query_params: validator_option.allow_non_get_query_params, optimistic_json: validator_option.optimistic_json,)
91
+ media_type = @operation_object.request_operation.operation_object.request_body&.select_media_type(request.media_type)
92
+ allow_json_array = media_type&.schema&.type == 'array'
93
+ unpacker = Committee::RequestUnpacker.new(allow_empty_date_and_datetime: validator_option.allow_empty_date_and_datetime, allow_form_params: validator_option.allow_form_params, allow_get_body: validator_option.allow_get_body, allow_raw_body: true, allow_json_array: allow_json_array, allow_query_params: validator_option.allow_query_params, allow_non_get_query_params: validator_option.allow_non_get_query_params, optimistic_json: validator_option.optimistic_json,)
86
94
 
87
95
  request.env[validator_option.headers_key] = unpacker.unpack_headers(request)
88
96
 
89
97
  request_param, _is_form_params = unpacker.unpack_request_params(request)
90
98
  request.env[validator_option.request_body_hash_key] = request_param
91
- request.env[validator_option.path_hash_key] = coerce_path_params
99
+ deserializer = ParameterDeserializer.new(@operation_object.request_operation) if validator_option.deserialize_parameters
100
+ request.env[validator_option.path_hash_key] = coerce_path_params(deserializer)
92
101
 
93
102
  query_param = unpacker.unpack_query_params(request)
94
- query_param.merge!(request_param) if request.get? && validator_option.allow_get_body
95
-
96
- if @operation_object && validator_option.deserialize_parameters
97
- deserializer = ParameterDeserializer.new(@operation_object.request_operation)
98
-
99
- query_param = deserializer.deserialize_query_params(query_param)
103
+ query_param.merge!(request_param) if request.get? && validator_option.allow_get_body && request_param.is_a?(Hash)
100
104
 
101
- path_param = request.env[validator_option.path_hash_key]
102
- path_param = deserializer.deserialize_path_params(path_param)
103
- request.env[validator_option.path_hash_key] = path_param
105
+ if deserializer
106
+ query_values = validator_option.allow_query_params ? Rack::Utils.parse_query(request.query_string, '&') : {}
107
+ # Do not restore query values that were overridden by the request body.
108
+ query_values.reject! { |name, _| request.POST.key?(name) } if validator_option.allow_non_get_query_params
109
+ query_values.reject! { |name, _| request_param.key?(name) } if request.get? && validator_option.allow_get_body && request_param.is_a?(Hash)
110
+ query_param = deserializer.deserialize_query_params(query_param, query_values)
104
111
 
105
112
  headers = request.env[validator_option.headers_key]
106
113
  headers = deserializer.deserialize_headers(headers)
@@ -121,7 +128,8 @@ module Committee
121
128
 
122
129
  request.env[validator_option.params_key] = Committee::Utils.indifferent_hash
123
130
  order.each do |key|
124
- request.env[validator_option.params_key].merge!(Committee::Utils.deep_copy(request.env[key]))
131
+ value = request.env[key]
132
+ request.env[validator_option.params_key].merge!(Committee::Utils.deep_copy(value)) if value.is_a?(Hash)
125
133
  end
126
134
  end
127
135
  end
@@ -4,7 +4,7 @@ module Committee
4
4
  module SchemaValidator
5
5
  class Option
6
6
  # Boolean Options
7
- attr_reader :allow_blank_structures, :allow_empty_date_and_datetime, :allow_form_params, :allow_get_body, :allow_query_params, :allow_non_get_query_params, :check_content_type, :check_header, :coerce_date_times, :coerce_form_params, :coerce_path_params, :coerce_query_params, :coerce_recursive, :coerce_response_values, :deserialize_parameters, :optimistic_json, :validate_success_only, :parse_response_by_content_type, :parameter_overwrite_by_rails_rule, :strict_query_params
7
+ attr_reader :allow_blank_structures, :allow_empty_date_and_datetime, :allow_form_params, :allow_get_body, :allow_query_params, :allow_non_get_query_params, :check_content_type, :check_header, :coerce_date_times, :coerce_form_params, :coerce_path_params, :coerce_query_params, :coerce_recursive, :coerce_response_values, :deserialize_parameters, :optimistic_json, :validate_success_only, :parse_response_by_content_type, :parameter_overwrite_by_rails_rule, :strict_query_params, :strict_response_content_type
8
8
 
9
9
  # Non-boolean options:
10
10
  attr_reader :headers_key, :params_key, :query_hash_key, :request_body_hash_key, :path_hash_key, :prefix
@@ -32,6 +32,7 @@ module Committee
32
32
  @optimistic_json = options.fetch(:optimistic_json, false)
33
33
  @parse_response_by_content_type = options.fetch(:parse_response_by_content_type, true)
34
34
  @strict_query_params = options.fetch(:strict_query_params, false)
35
+ @strict_response_content_type = options.fetch(:strict_response_content_type, false)
35
36
 
36
37
  @parameter_overwrite_by_rails_rule =
37
38
  if options.key?(:parameter_overwite_by_rails_rule)
@@ -19,11 +19,7 @@ module Committee
19
19
  def build_prefix_regexp(prefix)
20
20
  return nil unless prefix
21
21
 
22
- if prefix == "/" || prefix.end_with?("/")
23
- /\A#{Regexp.escape(prefix)}/.freeze
24
- else
25
- /\A#{Regexp.escape(prefix)}(?=\/|\z)/.freeze
26
- end
22
+ /\A#{Regexp.escape(prefix.chomp("/"))}(?=\/|\z)/.freeze
27
23
  end
28
24
  end
29
25
  end
@@ -60,7 +60,7 @@ module Committee
60
60
  path = path.gsub(Regexp.new("\\A#{Regexp.escape(prefix)}"), '')
61
61
  end
62
62
 
63
- schema.operation_object(path, @request.request_method.downcase)
63
+ schema.operation_object(path, @request.request_method)
64
64
  end
65
65
 
66
66
  # Find the OpenAPI3 schema object for a parameter by name and location.
@@ -89,7 +89,7 @@ module Committee
89
89
  return "dummy-#{key}" unless param_schema
90
90
  return param_schema.enum.first.to_s if param_schema.enum&.any?
91
91
 
92
- case param_schema.type
92
+ case Committee::Utils.schema_type(param_schema)
93
93
  when 'integer', 'number' then '0'
94
94
  when 'boolean' then 'true'
95
95
  when 'array' then ['0']
@@ -367,7 +367,7 @@ module Committee
367
367
 
368
368
  return prop_schema.enum.first if prop_schema.enum&.any?
369
369
 
370
- case prop_schema.type
370
+ case Committee::Utils.schema_type(prop_schema)
371
371
  when 'integer' then 0
372
372
  when 'number' then 0.0
373
373
  when 'boolean' then false
@@ -387,7 +387,7 @@ module Committee
387
387
 
388
388
  return prop_schema.enum.first.to_s if prop_schema.enum&.any?
389
389
 
390
- case prop_schema.type
390
+ case Committee::Utils.schema_type(prop_schema)
391
391
  when 'integer', 'number' then '0'
392
392
  when 'boolean' then 'true'
393
393
  when 'array' then ['0']
@@ -25,6 +25,8 @@ module Committee
25
25
  end
26
26
 
27
27
  increment_assertion_count
28
+ rescue Committee::InvalidRequest, Committee::BadRequest => e
29
+ handle_test_failure(e)
28
30
  end
29
31
 
30
32
  def assert_response_schema_confirm(expected_status = nil)
@@ -50,6 +52,8 @@ module Committee
50
52
  schema_validator.response_validate(status, headers, [body], true) if validate_response?(status)
51
53
 
52
54
  increment_assertion_count
55
+ rescue Committee::InvalidResponse => e
56
+ handle_test_failure(e)
53
57
  end
54
58
 
55
59
  def committee_options
@@ -77,7 +81,7 @@ module Committee
77
81
  end
78
82
 
79
83
  def schema_validator
80
- @schema_validator ||= router.build_schema_validator(request_object)
84
+ router.build_schema_validator(request_object)
81
85
  end
82
86
 
83
87
  def schema_coverage
@@ -94,6 +98,15 @@ module Committee
94
98
 
95
99
  private
96
100
 
101
+ # Passes a validation failure to the test_failure_handler option instead of
102
+ # raising it, so that the test framework can report it as a failure.
103
+ def handle_test_failure(error)
104
+ handler = committee_options.fetch(:test_failure_handler, nil)
105
+ raise error unless handler
106
+
107
+ handler.call(error)
108
+ end
109
+
97
110
  # assert_*_schema_confirm signal failure by raising, not via `assert`,
98
111
  # so Minitest would report "Test is missing assertions" on success.
99
112
  # Bump the counter explicitly; no-op outside Minitest (e.g. RSpec).
@@ -46,7 +46,7 @@ module Committee
46
46
  end
47
47
 
48
48
  def update_response_coverage!(path, method, response_status)
49
- method = method.to_s.downcase
49
+ method = coverage_method(path, method)
50
50
  response_status = response_status.to_s
51
51
 
52
52
  @covered[path] ||= {}
@@ -63,7 +63,8 @@ module Committee
63
63
  path_item._openapi_all_child_objects.each do |object_name, object|
64
64
  next unless object.is_a?(OpenAPIParser::Schemas::Operation)
65
65
 
66
- method = object_name.split('/').last&.downcase
66
+ # JSON Pointer segment (RFC 6901), so `SYNC~V2` appears as `SYNC~0V2`
67
+ method = object_name.split('/').last&.gsub('~1', '/')&.gsub('~0', '~')
67
68
  next unless method
68
69
 
69
70
  report[path_name][method] ||= {}
@@ -90,6 +91,14 @@ module Committee
90
91
  def report_flatten
91
92
  self.class.flatten_report(report)
92
93
  end
94
+
95
+ private
96
+
97
+ # an exact additionalOperations key keeps its case; anything else is a lowercase standard method
98
+ def coverage_method(path, method)
99
+ method = method.to_s
100
+ schema.open_api.paths.path[path]&.additional_operations&.key?(method) ? method : method.downcase
101
+ end
93
102
  end
94
103
  end
95
104
  end
@@ -24,5 +24,11 @@ module Committee
24
24
 
25
25
  return from
26
26
  end
27
+
28
+ # OpenAPI 3.1 allows `type: [x, "null"]`; returns the first non-null type.
29
+ def self.schema_type(schema)
30
+ type = schema&.type
31
+ type.is_a?(Array) ? (type - ['null']).first : type
32
+ end
27
33
  end
28
34
  end
@@ -18,7 +18,7 @@ module Committee
18
18
  def render
19
19
  [
20
20
  status,
21
- { "Content-Type" => "application/json" },
21
+ { "content-type" => "application/json" },
22
22
  [JSON.generate(error_body)]
23
23
  ]
24
24
  end
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Committee
4
- VERSION = '5.6.3'.freeze
4
+ VERSION = '5.7.0'.freeze
5
5
  end
data/lib/committee.rb CHANGED
@@ -28,6 +28,7 @@ module Committee
28
28
  end
29
29
 
30
30
  require_relative "committee/utils"
31
+ require_relative "committee/schema_locations"
31
32
  require_relative "committee/drivers"
32
33
  require_relative "committee/errors"
33
34
  require_relative "committee/validation_error"
@@ -44,6 +44,19 @@ describe Committee::Drivers::OpenAPI2::Driver do
44
44
  end
45
45
  end
46
46
 
47
+ it "resolves references to reusable parameters" do
48
+ schema_data = schema_data_with_responses({ '200' => { 'description' => 'ok' } })
49
+ schema_data['parameters'] = { 'limit' => { 'name' => 'limit', 'in' => 'query', 'type' => 'integer' }, 'authorization' => { 'name' => 'Authorization', 'in' => 'header', 'type' => 'string' }, }
50
+ schema_data['paths']['/foos']['get']['parameters'] = [{ '$ref' => '#/parameters/limit' }, { '$ref' => '#/parameters/authorization' },]
51
+
52
+ schema = @driver.parse(schema_data)
53
+
54
+ link = schema.routes['GET'][0][1]
55
+ assert_equal ['limit'], link.schema.properties.keys
56
+ assert_equal ['integer'], link.schema.properties['limit'].type
57
+ assert_equal ['Authorization'], link.header_schema.properties.keys
58
+ end
59
+
47
60
  it "names capture groups into href regexes" do
48
61
  schema = @driver.parse(open_api_2_data)
49
62
  assert_equal %r{^\/api\/pets\/(?<id>[^\/]+)$}.inspect, schema.routes["DELETE"][0][0].inspect
data/test/drivers_test.rb CHANGED
@@ -45,11 +45,14 @@ describe Committee::Drivers do
45
45
  assert_kind_of Committee::Drivers::OpenAPI3::Schema, s
46
46
  end
47
47
 
48
- it 'fails to load OpenAPI 3.1+' do
49
- e = assert_raises(Committee::OpenAPI3Unsupported) do
50
- Committee::Drivers.load_from_file(open_api_3_1_schema_path, parser_options: { strict_reference_validation: true })
51
- end
52
- assert_equal 'Committee does not support OpenAPI 3.1+ yet', e.message
48
+ it 'loads OpenAPI 3.1' do
49
+ s = Committee::Drivers.load_from_file(open_api_3_1_schema_path, parser_options: { strict_reference_validation: true })
50
+ assert_kind_of Committee::Drivers::OpenAPI3::Schema, s
51
+ end
52
+
53
+ it 'loads OpenAPI 3.2' do
54
+ s = Committee::Drivers.load_from_file(open_api_3_2_schema_path, parser_options: { strict_reference_validation: true })
55
+ assert_kind_of Committee::Drivers::OpenAPI3::Schema, s
53
56
  end
54
57
 
55
58
  it 'fails to load OpenAPI 3 with invalid reference' do
@@ -164,11 +167,39 @@ describe Committee::Drivers do
164
167
  assert_kind_of Committee::Drivers::HyperSchema::Schema, s
165
168
  end
166
169
 
167
- it 'fails to load OpenAPI 3.1+' do
170
+ it 'loads OpenAPI 3.1' do
171
+ s = Committee::Drivers.load_from_data(open_api_3_1_data, nil, parser_options: { strict_reference_validation: true })
172
+ assert_kind_of Committee::Drivers::OpenAPI3::Schema, s
173
+ end
174
+
175
+ it 'loads OpenAPI 3.2' do
176
+ s = Committee::Drivers.load_from_data(open_api_3_2_data, nil, parser_options: { strict_reference_validation: true })
177
+ assert_kind_of Committee::Drivers::OpenAPI3::Schema, s
178
+ end
179
+
180
+ it 'loads an OpenAPI 3.2 prerelease' do
181
+ s = Committee::Drivers.load_from_data(open_api_3_2_data.merge('openapi' => '3.2.0-rc1'), nil, parser_options: { strict_reference_validation: true })
182
+ assert_kind_of Committee::Drivers::OpenAPI3::Schema, s
183
+ end
184
+
185
+ it 'fails to load OpenAPI 3.3+' do
168
186
  e = assert_raises(Committee::OpenAPI3Unsupported) do
169
- Committee::Drivers.load_from_data(open_api_3_1_data)
187
+ Committee::Drivers.load_from_data(open_api_3_2_data.merge('openapi' => '3.3.0'))
188
+ end
189
+ assert_equal 'Committee does not support OpenAPI 3.3+ yet', e.message
190
+ end
191
+
192
+ it 'fails to load an OpenAPI 3.3 prerelease' do
193
+ assert_raises(Committee::OpenAPI3Unsupported) do
194
+ Committee::Drivers.load_from_data(open_api_3_2_data.merge('openapi' => '3.3.0-rc1'))
195
+ end
196
+ end
197
+
198
+ it 'loads OpenAPI 3.1 without a patch version or as a YAML number' do
199
+ ['3.1', 3.1].each do |version|
200
+ s = Committee::Drivers.load_from_data(open_api_3_1_data.merge('openapi' => version), nil, parser_options: { strict_reference_validation: true })
201
+ assert_kind_of Committee::Drivers::OpenAPI3::Schema, s
170
202
  end
171
- assert_equal 'Committee does not support OpenAPI 3.1+ yet', e.message
172
203
  end
173
204
  end
174
205
  end
@@ -94,6 +94,16 @@ describe Committee::Middleware::Options::ResponseValidation do
94
94
  end
95
95
  assert_equal "streaming_content_parsers must be a Hash", e.message
96
96
  end
97
+
98
+ it "sets strict_response_content_type option with default false" do
99
+ options = Committee::Middleware::Options::ResponseValidation.new(schema: hyper_schema)
100
+ assert_equal false, options.strict_response_content_type
101
+ end
102
+
103
+ it "sets strict_response_content_type option when provided" do
104
+ options = Committee::Middleware::Options::ResponseValidation.new(schema: hyper_schema, strict_response_content_type: true)
105
+ assert_equal true, options.strict_response_content_type
106
+ end
97
107
  end
98
108
 
99
109
  describe "#to_h" do
@@ -103,6 +113,11 @@ describe Committee::Middleware::Options::ResponseValidation do
103
113
  assert_equal true, hash[:strict]
104
114
  assert_equal false, hash[:validate_success_only]
105
115
  end
116
+
117
+ it "includes strict_response_content_type in hash" do
118
+ options = Committee::Middleware::Options::ResponseValidation.new(schema: hyper_schema, strict_response_content_type: true)
119
+ assert_equal true, options.to_h[:strict_response_content_type]
120
+ end
106
121
  end
107
122
 
108
123
  describe ".from" do