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,
  :parse_data => true
}
@@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.



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

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

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

  @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
  @validation_options[:clear_cache] = false if @options[:clear_cache] == false

  @@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]
    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
  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



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

def add_schema(schema)
  @@schemas[schema_key_for(schema.uri)] ||= schema
end

.cache_schemas=(val) ⇒ Object



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

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_cacheObject



301
302
303
# File 'lib/json-schema/validator.rb', line 301

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

.default_validatorObject



337
338
339
# File 'lib/json-schema/validator.rb', line 337

def default_validator
  @@default_validator
end

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



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

def deregister_format_validator(format, versions = ["draft1", "draft2", "draft3", "draft4", nil])
  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



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

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



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

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

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



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

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



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

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

.json_backendObject



391
392
393
394
395
396
397
# File 'lib/json-schema/validator.rb', line 391

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

.json_backend=(backend) ⇒ Object



399
400
401
402
403
404
405
406
407
408
409
410
411
# File 'lib/json-schema/validator.rb', line 399

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



442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
# File 'lib/json-schema/validator.rb', line 442

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



413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
# File 'lib/json-schema/validator.rb', line 413

def parse(s)
  if defined?(MultiJson)
    begin
      MultiJson.respond_to?(:adapter) ? MultiJson.load(s) : MultiJson.decode(s)
    rescue MultiJson::ParseError => e
      raise JSON::Schema::JsonParseError.new(e.message)
    end
  else
    case @@json_backend.to_s
    when 'json'
      begin
        JSON.parse(s, :quirks_mode => true)
      rescue JSON::ParserError => e
        raise JSON::Schema::JsonParseError.new(e.message)
      end
    when 'yajl'
      begin
        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")
      rescue Yajl::ParseError => e
        raise JSON::Schema::JsonParseError.new(e.message)
      end
    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



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

def register_default_validator(v)
  @@default_validator = v
end

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



372
373
374
375
376
377
# File 'lib/json-schema/validator.rb', line 372

def register_format_validator(format, validation_proc, versions = ["draft1", "draft2", "draft3", "draft4", nil])
  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



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

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

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



385
386
387
388
389
# File 'lib/json-schema/validator.rb', line 385

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

.schema_for_uri(uri) ⇒ Object



313
314
315
316
317
# File 'lib/json-schema/validator.rb', line 313

def schema_for_uri(uri)
  # We only store normalized uris terminated with fragment #, so we can try whether
  # normalization can be skipped
  @@schemas[uri] || @@schemas[schema_key_for(uri)]
end

.schema_key_for(uri) ⇒ Object



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

def schema_key_for(uri)
  key = Util::URI.normalized_uri(uri).to_s
  key.end_with?('#') ? key : "#{key}#"
end

.schema_loaded?(schema_uri) ⇒ Boolean

Returns:

  • (Boolean)


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

def schema_loaded?(schema_uri)
  !schema_for_uri(schema_uri).nil?
end

.schema_readerObject



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

def schema_reader
  @@schema_reader ||= JSON::Schema::Reader.new
end

.schema_reader=(reader) ⇒ Object



297
298
299
# File 'lib/json-schema/validator.rb', line 297

def schema_reader=(reader)
  @@schema_reader = reader
end

.schemasObject



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

def schemas
  @@schemas
end

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



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

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



258
259
260
261
262
# File 'lib/json-schema/validator.rb', line 258

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

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



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

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

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



265
266
267
# File 'lib/json-schema/validator.rb', line 265

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

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



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

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

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



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

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

.validator_for_name(schema_name) ⇒ Object



352
353
354
355
356
357
358
359
360
# File 'lib/json-schema/validator.rb', line 352

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



341
342
343
344
345
346
347
348
349
350
# File 'lib/json-schema/validator.rb', line 341

def validator_for_uri(schema_uri)
  return default_validator unless schema_uri
  u = JSON::Util::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

.validatorsObject



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

def validators
  @@validators
end

Instance Method Details

#absolutize_ref_uri(ref, parent_schema_uri) ⇒ Object



138
139
140
141
142
143
144
145
146
147
# File 'lib/json-schema/validator.rb', line 138

def absolutize_ref_uri(ref, parent_schema_uri)
  ref_uri = JSON::Util::URI.strip_fragment(ref)

  return ref_uri if ref_uri.absolute?
  # This is a self reference and thus the schema does not need to be re-loaded
  return parent_schema_uri if ref_uri.path.empty?

  uri = JSON::Util::URI.strip_fragment(parent_schema_uri.dup)
  Util::URI.normalized_uri(uri.join(ref_uri.path))
end

#build_schemas(parent_schema) ⇒ Object

Build all schemas with IDs, mapping out the namespace



150
151
152
153
154
155
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
# File 'lib/json-schema/validator.rb', line 150

def build_schemas(parent_schema)
  schema = parent_schema.schema

  # Build ref schemas if they exist
  if schema["$ref"]
    load_ref_schema(parent_schema, schema["$ref"])
  end

  case schema["extends"]
  when String
    load_ref_schema(parent_schema, schema["extends"])
  when Array
    schema['extends'].each do |type|
      handle_schema(parent_schema, type)
    end
  end

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

  # Schema properties whose values are objects, the values of which
  # are themselves schemas.
  %w[definitions properties patternProperties].each do |key|
    next unless value = schema[key]
    value.each do |k, inner_schema|
      handle_schema(parent_schema, inner_schema)
    end
  end

  # Schema properties whose values are themselves schemas.
  %w[additionalProperties additionalItems dependencies extends].each do |key|
    next unless schema[key].is_a?(Hash)
    handle_schema(parent_schema, schema[key])
  end

  # Schema properties whose values may be an array of schemas.
  %w[allOf anyOf oneOf not].each do |key|
    next unless value = schema[key]
    Array(value).each do |inner_schema|
      handle_schema(parent_schema, inner_schema)
    end
  end

  # Items are always schemas
  if schema["items"]
    items = schema["items"].clone
    items = [items] unless items.is_a?(Array)

    items.each do |item|
      handle_schema(parent_schema, item)
    end
  end

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

end

#handle_schema(parent_schema, obj) ⇒ Object

Either load a reference schema or create a new schema



219
220
221
222
223
224
225
226
227
228
# File 'lib/json-schema/validator.rb', line 219

def handle_schema(parent_schema, obj)
  if obj.is_a?(Hash)
    schema_uri = parent_schema.uri.dup
    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



129
130
131
132
133
134
135
136
# File 'lib/json-schema/validator.rb', line 129

def load_ref_schema(parent_schema, ref)
  schema_uri = absolutize_ref_uri(ref, parent_schema.uri)
  return true if self.class.schema_loaded?(schema_uri)

  schema = @options[:schema_reader].read(schema_uri)
  self.class.add_schema(schema)
  build_schemas(schema)
end

#schema_from_fragment(base_schema, fragment) ⇒ Object



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
107
108
109
110
# File 'lib/json-schema/validator.rb', line 75

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]
    base_schema.to_array_schema
  else
    base_schema
  end
end

#validateObject

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



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
# File 'lib/json-schema/validator.rb', line 113

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



230
231
232
# File 'lib/json-schema/validator.rb', line 230

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

#validation_errorsObject



234
235
236
# File 'lib/json-schema/validator.rb', line 234

def validation_errors
  @errors
end