Class: JSON::Validator

Inherits:
Object
  • Object
show all
Defined in:
lib/json-schema/validator.rb

Constant Summary collapse

@@schemas = 
{}
@@cache_schemas = 
false
@@default_opts = 
{
  :list => false,
  :version => nil,
  :validate_schema => false,
  :record_errors => false,
  :errors_as_objects => false,
  :insert_defaults => false,
  :clear_cache => true,
  :strict => false
}
@@validators = 
{}
@@default_validator = 
nil
@@available_json_backends = 
[]
@@json_backend = 
'yajl'
@@serializer = 
lambda{|o| YAML.dump(o) }
@@mutex = 
Mutex.new

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(schema_data, data, opts = {}) ⇒ Validator

Returns a new instance of Validator.



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
 
# File 'lib/json-schema/validator.rb', line 36

def initialize(schema_data, data, opts={})
  @options = @@default_opts.clone.merge(opts)
  @errors = []

  validator = JSON::Validator.validator_for_name(@options[:version])
  @options[:version] = validator

  @validation_options = @options[:record_errors] ? {:record_errors => true} : {}
  @validation_options[:insert_defaults] = true if @options[:insert_defaults]
  @validation_options[:strict] = true if @options[:strict] == true

  @@mutex.synchronize { @base_schema = initialize_schema(schema_data) }
  @original_data = data
  @data = initialize_data(data)
  @@mutex.synchronize { build_schemas(@base_schema) }

  # validate the schema, if requested
  if @options[:validate_schema]
    begin
      if @base_schema.schema["$schema"]
        base_validator = JSON::Validator.validator_for_name(@base_schema.schema["$schema"])
      end
      metaschema = base_validator ? base_validator.metaschema : validator.metaschema
      # Don't clear the cache during metaschema validation!
      meta_validator = JSON::Validator.new(metaschema, @base_schema.schema, {:clear_cache => false})
      meta_validator.validate
    rescue JSON::Schema::ValidationError, JSON::Schema::SchemaError
      raise $!
    end
  end

  # If the :fragment option is set, try and validate against the fragment
  if opts[:fragment]
    @base_schema = schema_from_fragment(@base_schema, opts[:fragment])
  end
end

Class Method Details

.add_schema(schema) ⇒ Object 



320
321
322
 
# File 'lib/json-schema/validator.rb', line 320

def add_schema(schema)
  @@schemas[schema.uri.to_s] = schema if @@schemas[schema.uri.to_s].nil?
end

.cache_schemas=(val) ⇒ Object 



324
325
326
327
 
# File 'lib/json-schema/validator.rb', line 324

def cache_schemas=(val)
  warn "[DEPRECATION NOTICE] Schema caching is now a validation option. Schemas will still be cached if this is set to true, but this method will be removed in version >= 3. Please use the :clear_cache validation option instead."
  @@cache_schemas = val == true ? true : false
end

.clear_cache ⇒ Object 



312
313
314
 
# File 'lib/json-schema/validator.rb', line 312

def clear_cache
  @@schemas = {} if @@cache_schemas == false
end

.default_validator ⇒ Object 



333
334
335
 
# File 'lib/json-schema/validator.rb', line 333

def default_validator
  @@default_validator
end

.deregister_format_validator(format, versions = ["draft1", "draft2", "draft3", "draft4"]) ⇒ Object 



375
376
377
378
379
 
# File 'lib/json-schema/validator.rb', line 375

def deregister_format_validator(format, versions = ["draft1", "draft2", "draft3", "draft4"])
  validators_for_names(versions).each do |validator|
    validator.formats[format.to_s] = validator.default_formats[format.to_s]
  end
end

.fully_validate(schema, data, opts = {}) ⇒ Object 



292
293
294
295
296
 
# File 'lib/json-schema/validator.rb', line 292

def fully_validate(schema, data, opts={})
  opts[:record_errors] = true
  validator = JSON::Validator.new(schema, data, opts)
  validator.validate
end

.fully_validate_json(schema, data, opts = {}) ⇒ Object 



304
305
306
 
# File 'lib/json-schema/validator.rb', line 304

def fully_validate_json(schema, data, opts={})
  fully_validate(schema, data, opts.merge(:json => true))
end

.fully_validate_schema(schema, opts = {}) ⇒ Object 



298
299
300
301
302
 
# File 'lib/json-schema/validator.rb', line 298

def fully_validate_schema(schema, opts={})
  data = schema
  schema = JSON::Validator.validator_for_name(opts[:version]).metaschema
  fully_validate(schema, data, opts)
end

.fully_validate_uri(schema, data, opts = {}) ⇒ Object 



308
309
310
 
# File 'lib/json-schema/validator.rb', line 308

def fully_validate_uri(schema, data, opts={})
  fully_validate(schema, data, opts.merge(:uri => true))
end

.json_backend ⇒ Object 



387
388
389
390
391
392
393
 
# File 'lib/json-schema/validator.rb', line 387

def json_backend
  if defined?(MultiJson)
    MultiJson.respond_to?(:adapter) ? MultiJson.adapter : MultiJson.engine
  else
    @@json_backend
  end
end

.json_backend=(backend) ⇒ Object 



395
396
397
398
399
400
401
402
403
404
405
406
407
 
# File 'lib/json-schema/validator.rb', line 395

def json_backend=(backend)
  if defined?(MultiJson)
    backend = backend == 'json' ? 'json_gem' : backend
    MultiJson.respond_to?(:use) ? MultiJson.use(backend) : MultiJson.engine = backend
  else
    backend = backend.to_s
    if @@available_json_backends.include?(backend)
      @@json_backend = backend
    else
      raise JSON::Schema::JsonParseError.new("The JSON backend '#{backend}' could not be found.")
    end
  end
end

.merge_missing_values(source, destination) ⇒ Object 



426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
 
# File 'lib/json-schema/validator.rb', line 426

def merge_missing_values(source, destination)
  case destination
  when Hash
    source.each do |key, source_value|
      destination_value = destination[key] || destination[key.to_sym]
      if destination_value.nil?
        destination[key] = source_value
      else
        merge_missing_values(source_value, destination_value)
      end
    end
  when Array
    source.each_with_index do |source_value, i|
      destination_value = destination[i]
      merge_missing_values(source_value, destination_value)
    end
  end
end

.parse(s) ⇒ Object 



409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
 
# File 'lib/json-schema/validator.rb', line 409

def parse(s)
  if defined?(MultiJson)
    MultiJson.respond_to?(:adapter) ? MultiJson.load(s) : MultiJson.decode(s)
  else
    case @@json_backend.to_s
    when 'json'
      JSON.parse(s)
    when 'yajl'
      json = StringIO.new(s)
      parser = Yajl::Parser.new
      parser.parse(json) or raise JSON::Schema::JsonParseError.new("The JSON could not be parsed by yajl")
    else
      raise JSON::Schema::JsonParseError.new("No supported JSON parsers found. The following parsers are suported:\n * yajl-ruby\n * json")
    end
  end
end

.register_default_validator(v) ⇒ Object 



364
365
366
 
# File 'lib/json-schema/validator.rb', line 364

def register_default_validator(v)
  @@default_validator = v
end

.register_format_validator(format, validation_proc, versions = ["draft1", "draft2", "draft3", "draft4"]) ⇒ Object 



368
369
370
371
372
373
 
# File 'lib/json-schema/validator.rb', line 368

def register_format_validator(format, validation_proc, versions = ["draft1", "draft2", "draft3", "draft4"])
  custom_format_validator = JSON::Schema::CustomFormat.new(validation_proc)
  validators_for_names(versions).each do |validator|
    validator.formats[format.to_s] = custom_format_validator
  end
end

.register_validator(v) ⇒ Object 



360
361
362
 
# File 'lib/json-schema/validator.rb', line 360

def register_validator(v)
  @@validators["#{v.uri.scheme}://#{v.uri.host}#{v.uri.path}"] = v
end

.restore_default_formats(versions = ["draft1", "draft2", "draft3", "draft4"]) ⇒ Object 



381
382
383
384
385
 
# File 'lib/json-schema/validator.rb', line 381

def restore_default_formats(versions = ["draft1", "draft2", "draft3", "draft4"])
  validators_for_names(versions).each do |validator|
    validator.formats = validator.default_formats.clone
  end
end

.schemas ⇒ Object 



316
317
318
 
# File 'lib/json-schema/validator.rb', line 316

def schemas
  @@schemas
end

.validate(schema, data, opts = {}) ⇒ Object 



259
260
261
262
263
264
265
266
267
 
# File 'lib/json-schema/validator.rb', line 259

def validate(schema, data,opts={})
  begin
    validator = JSON::Validator.new(schema, data, opts)
    validator.validate
    return true
  rescue JSON::Schema::ValidationError, JSON::Schema::SchemaError
    return false
  end
end

.validate!(schema, data, opts = {}) ⇒ Object Also known as: validate2 



277
278
279
280
281
 
# File 'lib/json-schema/validator.rb', line 277

def validate!(schema, data,opts={})
  validator = JSON::Validator.new(schema, data, opts)
  validator.validate
  return true
end

.validate_json(schema, data, opts = {}) ⇒ Object 



269
270
271
 
# File 'lib/json-schema/validator.rb', line 269

def validate_json(schema, data, opts={})
  validate(schema, data, opts.merge(:json => true))
end

.validate_json!(schema, data, opts = {}) ⇒ Object 



284
285
286
 
# File 'lib/json-schema/validator.rb', line 284

def validate_json!(schema, data, opts={})
  validate!(schema, data, opts.merge(:json => true))
end

.validate_uri(schema, data, opts = {}) ⇒ Object 



273
274
275
 
# File 'lib/json-schema/validator.rb', line 273

def validate_uri(schema, data, opts={})
  validate(schema, data, opts.merge(:uri => true))
end

.validate_uri!(schema, data, opts = {}) ⇒ Object 



288
289
290
 
# File 'lib/json-schema/validator.rb', line 288

def validate_uri!(schema, data, opts={})
  validate!(schema, data, opts.merge(:uri => true))
end

.validator_for_name(schema_name) ⇒ Object 



348
349
350
351
352
353
354
355
356
 
# File 'lib/json-schema/validator.rb', line 348

def validator_for_name(schema_name)
  return default_validator unless schema_name
  validator = validators_for_names([schema_name]).first
  if validator.nil?
    raise JSON::Schema::SchemaError.new("The requested JSON schema version is not supported")
  else
    validator
  end
end

.validator_for_uri(schema_uri) ⇒ Object Also known as: validator_for 



337
338
339
340
341
342
343
344
345
346
 
# File 'lib/json-schema/validator.rb', line 337

def validator_for_uri(schema_uri)
  return default_validator unless schema_uri
  u = URI.parse(schema_uri)
  validator = validators["#{u.scheme}://#{u.host}#{u.path}"]
  if validator.nil?
    raise JSON::Schema::SchemaError.new("Schema not found: #{schema_uri}")
  else
    validator
  end
end

.validators ⇒ Object 



329
330
331
 
# File 'lib/json-schema/validator.rb', line 329

def validators
  @@validators
end

Instance Method Details

#build_schemas(parent_schema) ⇒ Object

Build all schemas with IDs, mapping out the namespace



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/json-schema/validator.rb', line 156

def build_schemas(parent_schema)
  # Build ref schemas if they exist
  if parent_schema.schema["$ref"]
    load_ref_schema(parent_schema, parent_schema.schema["$ref"])
  end
  if parent_schema.schema["extends"]
    if parent_schema.schema["extends"].is_a?(String)
      load_ref_schema(parent_schema, parent_schema.schema["extends"])
    elsif parent_schema.schema["extends"].is_a?(Array)
      parent_schema.schema["extends"].each do |type|
        handle_schema(parent_schema, type)
      end
    end
  end

  # handle validations that always contain schemas
  ["allOf", "anyOf", "oneOf", "not"].each do |key|
    if parent_schema.schema.has_key?(key)
      validations = parent_schema.schema[key]
      validations = [validations] unless validations.is_a?(Array)
      validations.each {|v| handle_schema(parent_schema, v) }
    end
  end

  # Check for schemas in union types
  ["type", "disallow"].each do |key|
    if parent_schema.schema[key] && parent_schema.schema[key].is_a?(Array)
      parent_schema.schema[key].each_with_index do |type,i|
        if type.is_a?(Hash)
          handle_schema(parent_schema, type)
        end
      end
    end
  end

  # "definitions" are schemas in V4
  if parent_schema.schema["definitions"]
    parent_schema.schema["definitions"].each do |k,v|
      handle_schema(parent_schema, v)
    end
  end

  # All properties are schemas
  if parent_schema.schema["properties"]
    parent_schema.schema["properties"].each do |k,v|
      handle_schema(parent_schema, v)
    end
  end
  if parent_schema.schema["patternProperties"]
    parent_schema.schema["patternProperties"].each do |k,v|
      handle_schema(parent_schema, v)
    end
  end

  # Items are always schemas
  if parent_schema.schema["items"]
    items = parent_schema.schema["items"].clone
    single = false
    if !items.is_a?(Array)
      items = [items]
      single = true
    end
    items.each_with_index do |item,i|
      handle_schema(parent_schema, item)
    end
  end

  # Convert enum to a ArraySet
  if parent_schema.schema["enum"] && parent_schema.schema["enum"].is_a?(Array)
    parent_schema.schema["enum"] = ArraySet.new(parent_schema.schema["enum"])
  end

  # Each of these might be schemas
  ["additionalProperties", "additionalItems", "dependencies", "extends"].each do |key|
    if parent_schema.schema[key].is_a?(Hash)
      handle_schema(parent_schema, parent_schema.schema[key])
    end
  end

end

#handle_schema(parent_schema, obj) ⇒ Object

Either load a reference schema or create a new schema



238
239
240
241
242
243
244
245
246
247
 
# File 'lib/json-schema/validator.rb', line 238

def handle_schema(parent_schema, obj)
  if obj.is_a?(Hash)
    schema_uri = parent_schema.uri.clone
    schema = JSON::Schema.new(obj,schema_uri,parent_schema.validator)
    if obj['id']
      Validator.add_schema(schema)
    end
    build_schemas(schema)
  end
end

#load_ref_schema(parent_schema, ref) ⇒ Object 



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/json-schema/validator.rb', line 126

def load_ref_schema(parent_schema,ref)
  uri = URI.parse(ref)
  if uri.relative?
    uri = parent_schema.uri.clone

    # Check for absolute path
    path = ref.split("#")[0]

    # This is a self reference and thus the schema does not need to be re-loaded
    if path.nil? || path == ''
      return
    end

    if path && path[0,1] == '/'
      uri.path = Pathname.new(path).cleanpath.to_s
    else
      uri = parent_schema.uri.merge(path)
    end
    uri.fragment = ''
  end

  if Validator.schemas[uri.to_s].nil?
    schema = JSON::Schema.new(JSON::Validator.parse(open(uri.to_s).read), uri, @options[:version])
    Validator.add_schema(schema)
    build_schemas(schema)
  end
end

#schema_from_fragment(base_schema, fragment) ⇒ Object 



73
74
75
76
77
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
 
# File 'lib/json-schema/validator.rb', line 73

def schema_from_fragment(base_schema, fragment)
  schema_uri = base_schema.uri
  fragments = fragment.split("/")

  # ensure the first element was a hash, per the fragment spec
  if fragments.shift != "#"
    raise JSON::Schema::SchemaError.new("Invalid fragment syntax in :fragment option")
  end

  fragments.each do |f|
    if base_schema.is_a?(JSON::Schema) #test if fragment is a JSON:Schema instance
      if !base_schema.schema.has_key?(f)
        raise JSON::Schema::SchemaError.new("Invalid fragment resolution for :fragment option")
      end
      base_schema = base_schema.schema[f]
    elsif base_schema.is_a?(Hash)
      if !base_schema.has_key?(f)
        raise JSON::Schema::SchemaError.new("Invalid fragment resolution for :fragment option")
      end
      base_schema = JSON::Schema.new(base_schema[f],schema_uri,@options[:version])
    elsif base_schema.is_a?(Array)
      if base_schema[f.to_i].nil?
        raise JSON::Schema::SchemaError.new("Invalid fragment resolution for :fragment option")
      end
      base_schema = JSON::Schema.new(base_schema[f.to_i],schema_uri,@options[:version])
    else
      raise JSON::Schema::SchemaError.new("Invalid schema encountered when resolving :fragment option")
    end
  end
  if @options[:list] #check if the schema is validating a list
    base_schema.schema = schema_to_list(base_schema.schema)
  end
  base_schema
end

#validate ⇒ Object

Run a simple true/false validation of data against a schema



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/json-schema/validator.rb', line 109

def validate()
  @base_schema.validate(@data,[],self,@validation_options)
  if @options[:errors_as_objects]
    return @errors.map{|e| e.to_hash}
  else
    return @errors.map{|e| e.to_string}
  end
ensure
  if @validation_options[:clear_cache] == true
    Validator.clear_cache
  end
  if @validation_options[:insert_defaults]
    JSON::Validator.merge_missing_values(@data, @original_data)
  end
end

#validation_error(error) ⇒ Object 



249
250
251
 
# File 'lib/json-schema/validator.rb', line 249

def validation_error(error)
  @errors.push(error)
end

#validation_errors ⇒ Object 



253
254
255
 
# File 'lib/json-schema/validator.rb', line 253

def validation_errors
  @errors
end