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
}
@@validators = 
{}
@@default_validator = 
nil
@@available_json_backends = 
[]
@@json_backend = 
'yajl'

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of Validator.



82
83
84
85
86
87
 
# File 'lib/json-schema/validator.rb', line 82

def initialize(schema_data, data, opts={})
  @options = @@default_opts.clone.merge(opts)
  @base_schema = initialize_schema(schema_data)
  @data = initialize_data(data)    
  build_schemas(@base_schema)
end

Class Method Details

.add_schema(schema) ⇒ Object 



221
222
223
 
# File 'lib/json-schema/validator.rb', line 221

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

.cache_schemas=(val) ⇒ Object 



225
226
227
 
# File 'lib/json-schema/validator.rb', line 225

def cache_schemas=(val)
  @@cache_schemas = val == true ? true : false
end

.clear_cache ⇒ Object 



213
214
215
 
# File 'lib/json-schema/validator.rb', line 213

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

.default_validator ⇒ Object 



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

def default_validator
  @@default_validator
end

.json_backend ⇒ Object 



245
246
247
 
# File 'lib/json-schema/validator.rb', line 245

def json_backend
  @@json_backend
end

.json_backend=(backend) ⇒ Object 



249
250
251
252
253
254
255
256
 
# File 'lib/json-schema/validator.rb', line 249

def json_backend=(backend)
  backend = backend.to_s
  if @@available_json_backend.include?(backend)
    @@json_backend = backend
  else
    raise JSON::Schema::JsonParseError.new("The JSON backend '#{backend}' could not be found.")
  end
end

.parse(s) ⇒ Object 



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

def parse(s)
  case @@json_backend.to_s
  when 'json'
    JSON.parse(s)
  when 'yajl'
    json = StringIO.new(s)
    parser = Yajl::Parser.new
    parser.parse(json)
  else
    raise JSON::Schema::JsonParseError.new("No supported JSON parsers found. The following parsers are suported:\n * yajl-ruby\n * json")
  end
end

.register_default_validator(v) ⇒ Object 



241
242
243
 
# File 'lib/json-schema/validator.rb', line 241

def register_default_validator(v)
  @@default_validator = v
end

.register_validator(v) ⇒ Object 



237
238
239
 
# File 'lib/json-schema/validator.rb', line 237

def register_validator(v)
  @@validators[v.to_s] = v
end

.schemas ⇒ Object 



217
218
219
 
# File 'lib/json-schema/validator.rb', line 217

def schemas
  @@schemas
end

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



197
198
199
200
201
202
203
204
205
 
# File 'lib/json-schema/validator.rb', line 197

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 



207
208
209
210
 
# File 'lib/json-schema/validator.rb', line 207

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

.validators ⇒ Object 



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

def validators
  @@validators
end

Instance Method Details

#build_schemas(parent_schema) ⇒ Object

Build all schemas with IDs, mapping out the namespace



140
141
142
143
144
145
146
147
148
149
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
 
# File 'lib/json-schema/validator.rb', line 140

def build_schemas(parent_schema)    
  # 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
    
  # All properties are schemas
  if parent_schema.schema["properties"]
    parent_schema.schema["properties"].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
  
  # 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



182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/json-schema/validator.rb', line 182

def handle_schema(parent_schema, obj)
  if obj['$ref']
     load_ref_schema(parent_schema, obj['$ref'])
   else
     schema_uri = parent_schema.uri.clone
     schema = JSON::Schema.new(obj,schema_uri)
     if obj['id']
       Validator.add_schema(schema)
     end
     build_schemas(schema)
   end
end

#load_ref_schema(parent_schema, ref) ⇒ Object 



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

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.path = (Pathname.new(parent_schema.uri.path).parent + path).cleanpath.to_s
    end
    uri.fragment = nil
  end
  
  if Validator.schemas[uri.to_s].nil?
    begin
      schema = JSON::Schema.new(JSON::Validator.parse(open(uri.to_s).read), uri)
      Validator.add_schema(schema)
      build_schemas(schema)
    rescue JSON::ParserError
      # Don't rescue this error, we want JSON formatting issues to bubble up
      raise $!
    rescue
      # Failures will occur when this URI cannot be referenced yet. Don't worry about it,
      # the proper error will fall out if the ref isn't ever defined
    end
  end
end

#validate ⇒ Object

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



91
92
93
94
95
96
97
98
99
 
# File 'lib/json-schema/validator.rb', line 91

def validate()
  begin
    @base_schema.validate(@data,[])
    Validator.clear_cache
  rescue JSON::Schema::ValidationError
    Validator.clear_cache
    raise $!
  end
end