Module: Openc::JsonSchema::Validator

Extended by:
Validator
Included in:
Validator
Defined in:
lib/openc/json_schema/validator.rb

Instance Method Summary collapse

Instance Method Details

#convert_error(error) ⇒ Object 



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/openc/json_schema/validator.rb', line 78

def convert_error(error)
  path = fragment_to_path(error[:fragment])
  extra_params = {}

  case error[:failed_attribute]
  when 'Required'
    match = error[:message].match(/required property of '(.*)'/)
    missing_property = match[1]
    path = fragment_to_path("#{error[:fragment]}/#{missing_property}")
    type = :missing
    message = "Missing required property: #{path}"
  when 'AdditionalProperties'
    match = error[:message].match(/contains additional properties \["(.*)"\] outside of the schema/)
    additional_property = match[1].split('", "')[0]
    path = fragment_to_path("#{error[:fragment]}/#{additional_property}")
    type = :additional
    message = "Disallowed additional property: #{path}"
  when 'OneOf'
    if error[:message].match(/did not match any/)
      type = :one_of_no_matches
      message = "No match for property: #{path}"
    else
      type = :one_of_many_matches
      message = "Multiple possible matches for property: #{path}"
    end
  when 'AnyOf'
    type = :any_of_no_matches
    message = "No match for property: #{path}"
  when 'MinLength'
    match = error[:message].match(/minimum string length of (\d+) in/)
    min_length = match[1].to_i
    type = :too_short
    message = "Property too short: #{path} (must be at least #{min_length} characters)"
    extra_params = {:length => min_length}
  when 'MaxLength'
    match = error[:message].match(/maximum string length of (\d+) in/)
    max_length = match[1].to_i
    type = :too_long
    message = "Property too long: #{path} (must be at most #{max_length} characters)"
    extra_params = {:length => max_length}
  when 'TypeV4'
    match = error[:message].match(/the following types?: ([\w\s,]+) in schema/)
    allowed_types = match[1].split(',').map(&:strip)
    type = :type_mismatch
    message = "Property of wrong type: #{path} (must be of type #{allowed_types.join(', ')})"
    extra_params = {:allowed_types => allowed_types}
  when 'Enum'
    match = error[:message].match(/the following values: ([\w\s,]+) in schema/)
    allowed_values = match[1].split(',').map(&:strip)
    type = :enum_mismatch
    if allowed_values.size == 1
      message = "Property must have value #{allowed_values[0]}: #{path}"
    else
      message = "Property not an allowed value: #{path} (must be one of #{allowed_values.join(', ')})"
    end
    extra_params = {:allowed_values => allowed_values}
  else
    if error[:message].match(/must be of format yyyy-mm-dd/)
      type = :format_mismatch
      message = "Property not of expected format: #{path} (must be of format yyyy-mm-dd)"
      extra_params = {:expected_format => 'yyyy-mm-dd'}
    else
      type = :unknown
      message = "Error of unknown type: #{path} (#{error[:message]})"
    end
  end

  {:type => type, :path => path, :message => message}.merge(extra_params)
end

#extract_error(error, record, validator) ⇒ Object 



17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/openc/json_schema/validator.rb', line 17

def extract_error(error, record, validator)
  if error[:failed_attribute] == 'OneOf'
    if error[:message].match(/did not match any/)
      path_elements = fragment_to_path(error[:fragment]).split('.')

      json_schema = Utils.extract_json_schema(validator)
      schema = json_schema.schema

      path_elements.each do |element|
        record = record[element]
        schema = schema['properties'][element]

        if (ref = schema['$ref'])
          schema_uri = validator.absolutize_ref_uri(ref, json_schema.uri)
          json_schema = JSON::Validator.schema_reader.read(schema_uri)
          schema = json_schema.schema
        end
      end

      one_of_schemas = schema['oneOf']

      schemas_for_type_with_ix = case record
      when Hash
        one_of_schemas.each_with_index.reject {|s, ix| s['properties'].nil?}
      when String
        one_of_schemas.each_with_index.select {|s, ix| s['type'] == 'string' || (s['type'].nil? && s['properties'].nil?)}
      when Integer
        one_of_schemas.each_with_index.select {|s, ix| s['type'] == 'integer'}
      when Array
        one_of_schemas.each_with_index.select {|s, ix| s['type'] == 'array'}
      else
        raise "Unexpected type: #{record}"
      end

      case schemas_for_type_with_ix.size
      when 0
        return error
      when 1
        ix = schemas_for_type_with_ix[0][1]
        return error[:errors][:"oneof_#{ix}"][0]
      else
        if record.is_a?(Hash)
          schemas_for_type_with_ix.each do |s, ix|
            s['properties'].each do |k, v|
              next if v['enum'].nil?

              if v['enum'].include?(record[k])
                return error[:errors][:"oneof_#{ix}"][0]
              end
            end
          end
        else
          return error
        end
      end
    end
  end

  error
end

#fragment_to_path(fragment) ⇒ Object 



148
149
150
 
# File 'lib/openc/json_schema/validator.rb', line 148

def fragment_to_path(fragment)
  fragment.sub(/^#?\/*/, '').gsub('/', '.')
end

#validate(schema_path, record) ⇒ Object 



6
7
8
9
10
11
12
13
14
15
 
# File 'lib/openc/json_schema/validator.rb', line 6

def validate(schema_path, record)
  validator = Utils.load_validator(schema_path, record)
  errors = validator.validate

  # For now, we just handle the first error.
  error = errors[0]
  return if error.nil?

  convert_error(extract_error(error, record, validator))
end