json-schema 2.6.0 → 2.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a58ce34e91bb60549bef3c7018d69636c87052a8
-  data.tar.gz: 22573ae4c67684bc8e180876fe7485cf24baed19
+  metadata.gz: 12af76aabf22ca3fd21620ba445eec49e02bb148
+  data.tar.gz: e337dd929041aa42efbda91fd360caf0cb854035
 SHA512:
-  metadata.gz: 074129e7c341baadf05037ef05b9bc3a7c72f0414e420d92b74f4e25acbb6a42da478bfb7d658e4150887156455cb71575e3a02d877be50a0a482210ef08c6e5
-  data.tar.gz: c05121d91c8cd2f2a0d3a21e91fccb4a902b24b30bf8f594c6ef3f3c434b586422565cb526894632c10f91ea0248c9ca062d8b1afb8048ae64843bfaac7b9b01
+  metadata.gz: aa0037193fa2bb35abc47c05d51ad54f2d7c6f185e04ecd16332ca3b1749e67439429a69a1dbf73c15de1aa31fa21c603ea5d626c4fd6d788d3a64d4e14fc75d
+  data.tar.gz: a73e2d48d350b12c6a2b2108027845c9063de99a61ace81b7a0120cb22f55a39b769cf90b11c91fa58fed780215f6b6e66eb8c0a9b8311806fa86f2dd51b7b2a

data/{README.textile → README.md}

@@ -1,48 +1,79 @@
-!https://travis-ci.org/ruby-json-schema/json-schema.svg?branch=master!:https://travis-ci.org/ruby-json-schema/json-schema
-!https://codeclimate.com/github/ruby-json-schema/json-schema/badges/gpa.svg!:https://codeclimate.com/github/ruby-json-schema/json-schema
+![https://travis-ci.org/ruby-json-schema/json-schema](https://travis-ci.org/ruby-json-schema/json-schema.svg?branch=master)
+![https://codeclimate.com/github/ruby-json-schema/json-schema](https://codeclimate.com/github/ruby-json-schema/json-schema/badges/gpa.svg)
 
-h1. Ruby JSON Schema Validator
+Ruby JSON Schema Validator
+==========================
 
-This library is intended to provide Ruby with an interface for validating JSON objects against a JSON schema conforming to "JSON Schema Draft 4":http://tools.ietf.org/html/draft-zyp-json-schema-04. Legacy support for "JSON Schema Draft 3":http://tools.ietf.org/html/draft-zyp-json-schema-03, "JSON Schema Draft 2":http://tools.ietf.org/html/draft-zyp-json-schema-02, and "JSON Schema Draft 1":http://tools.ietf.org/html/draft-zyp-json-schema-01 is also included.
+This library is intended to provide Ruby with an interface for validating JSON
+objects against a JSON schema conforming to [JSON Schema Draft
+4](http://tools.ietf.org/html/draft-zyp-json-schema-04). Legacy support for
+[JSON Schema Draft 3](http://tools.ietf.org/html/draft-zyp-json-schema-03),
+[JSON Schema Draft 2](http://tools.ietf.org/html/draft-zyp-json-schema-02), and
+[JSON Schema Draft 1](http://tools.ietf.org/html/draft-zyp-json-schema-01) is
+also included.
 
-h2. Additional Resources
+Additional Resources
+--------------------
 
-* "Google Groups":https://groups.google.com/forum/#!forum/ruby-json-schema
-* #ruby-json-schema on chat.freenode.net
+- [Google Groups](https://groups.google.com/forum/#!forum/ruby-json-schema)
+- #ruby-json-schema on chat.freenode.net
 
-h2. Version 2.0.0 Upgrade Notes
+Version 2.0.0 Upgrade Notes
+---------------------------
 
-Please be aware that the upgrade to version 2.0.0 will use Draft-04 *by default*, so schemas that do not declare a validator using the <code>$schema</code> keyword will use Draft-04 now instead of Draft-03. This is the reason for the major version upgrade.
+Please be aware that the upgrade to version 2.0.0 will use Draft-04 **by
+default**, so schemas that do not declare a validator using the `$schema`
+keyword will use Draft-04 now instead of Draft-03. This is the reason for the
+major version upgrade.
 
-h2. Installation
+Installation
+------------
 
 From rubygems.org:
 
-<pre>
+```sh
 gem install json-schema
-</pre>
+```
 
 From the git repo:
 
-<pre>
+```sh
 $ gem build json-schema.gemspec
 $ gem install json-schema-2.5.2.gem
-</pre>
+```
 
+Usage
+-----
 
-h2. Usage
+Three base validation methods exist: 
 
-Three base validation methods exist: <code>validate</code>, <code>validate!</code>, and <code>fully_validate</code>. The first returns a boolean on whether a validation attempt passes and the second will throw a <code>JSON::Schema::ValidationError</code> with an appropriate message/trace on where the validation failed. The third validation method does not immediately fail upon a validation error and instead builds an array of validation errors return when validation is complete.
+1. `validate`: returns a boolean on whether a validation attempt passes
+2. `validate!`: throws a `JSON::Schema::ValidationError` with an appropriate message/trace on where the validation failed
+3. `fully_validate`: builds an array of validation errors return when validation is complete
 
-All methods take two arguments, which can be either a JSON string, a file containing JSON, or a Ruby object representing JSON data. The first argument to these methods is always the schema, the second is always the data to validate. An optional third options argument is also accepted; available options are used in the examples below.
+All methods take two arguments, which can be either a JSON string, a file
+containing JSON, or a Ruby object representing JSON data. The first argument to
+these methods is always the schema, the second is always the data to validate.
+An optional third options argument is also accepted; available options are used
+in the examples below.
 
-By default, the validator uses the "JSON Schema Draft 4":http://tools.ietf.org/html/draft-zyp-json-schema-04 specification for validation; however, the user is free to specify additional specifications or extend existing ones. Legacy support for Draft 1, Draft 2, and Draft 3 is included by either passing an optional <code>:version</code> parameter to the <code>validate</code> method (set either as <code>:draft1</code> or <code>draft2</code>), or by declaring the <code>$schema</code> attribute in the schema and referencing the appropriate specification URI. Note that the <code>$schema</code> attribute takes precedence over the <code>:version</code> option during parsing and validation.
+By default, the validator uses the [JSON Schema Draft
+4](http://tools.ietf.org/html/draft-zyp-json-schema-04) specification for
+validation; however, the user is free to specify additional specifications or
+extend existing ones. Legacy support for Draft 1, Draft 2, and Draft 3 is
+included by either passing an optional `:version` parameter to the `validate`
+method (set either as `:draft1` or `draft2`), or by declaring the `$schema`
+attribute in the schema and referencing the appropriate specification URI. Note
+that the `$schema` attribute takes precedence over the `:version` option during
+parsing and validation.
 
-h3. Validate Ruby objects against a Ruby schema
+### Validate Ruby objects against a Ruby schema
 
-For further information on json schema itself refer to <a href="http://spacetelescope.github.io/understanding-json-schema/">Understanding JSON Schema</a>.
+For further information on json schema itself refer to <a
+href="http://spacetelescope.github.io/understanding-json-schema/">Understanding
+JSON Schema</a>.
 
-<pre>
+```rb
 require 'rubygems'
 require 'json-schema'
 
@@ -59,32 +90,35 @@ data = {
 }
 
 JSON::Validator.validate(schema, data)
-</pre>
+```
 
-h3. Validate a JSON string against a JSON schema file
+### Validate a JSON string against a JSON schema file
 
-<pre>
+```rb
 require 'rubygems'
 require 'json-schema'
 
 JSON::Validator.validate('schema.json', '{"a" : 5}')
-</pre>
+```
 
-h3. Validate a list of objects against a schema that represents the individual objects
+### Validate a list of objects against a schema that represents the individual objects
 
-<pre>
+```rb
 require 'rubygems'
 require 'json-schema'
 
 data = ['user','user','user']
 JSON::Validator.validate('user.json', data, :list => true)
-</pre>
+```
 
-h3. Strictly validate an object's properties
+### Strictly validate an object's properties
 
-With the <code>:strict</code> option, validation fails when an object contains properties that are not defined in the schema's property list or doesn't match the <code>additionalProperties</code> property. Furthermore, all properties are treated as <code>required</code> regardless of <code>required</code> properties set in the schema.
+With the `:strict` option, validation fails when an object contains properties
+that are not defined in the schema's property list or doesn't match the
+`additionalProperties` property. Furthermore, all properties are treated as
+`required` regardless of `required` properties set in the schema.
 
-<pre>
+```rb
 require 'rubygems'
 require 'json-schema'
 
@@ -99,11 +133,11 @@ schema = {
 JSON::Validator.validate(schema, {"a" => 1, "b" => 2}, :strict => true)            # ==> true
 JSON::Validator.validate(schema, {"a" => 1, "b" => 2, "c" => 3}, :strict => true)  # ==> false
 JSON::Validator.validate(schema, {"a" => 1}, :strict => true)                      # ==> false
-</pre>
+```
 
-h3. Catch a validation error and print it out
+### Catch a validation error and print it out
 
-<pre>
+```rb
 require 'rubygems'
 require 'json-schema'
 
@@ -124,12 +158,11 @@ begin
 rescue JSON::Schema::ValidationError
   puts $!.message
 end
-</pre>
+```
 
+### Fully validate against a schema and catch all errors
 
-h3. Fully validate against a schema and catch all errors
-
-<pre>
+```rb
 require 'rubygems'
 require 'json-schema'
 
@@ -149,11 +182,11 @@ data = {
 errors = JSON::Validator.fully_validate(schema, data)
 
 # ["The property '#/a' of type String did not match the following type: integer in schema 03179a21-197e-5414-9611-e9f63e8324cd#", "The property '#/' did not contain a required property of 'b' in schema 03179a21-197e-5414-9611-e9f63e8324cd#"]
-</pre>
+```
 
-h3. Fully validate against a schema and catch all errors as objects
+### Fully validate against a schema and catch all errors as objects
 
-<pre>
+```rb
 require 'rubygems'
 require 'json-schema'
 
@@ -172,41 +205,40 @@ data = {
 
 errors = JSON::Validator.fully_validate(schema, data, :errors_as_objects => true)
 
-# [{:message=>"The property '#/a' of type String did not match the following type: integer in schema 03179a21-197e-5414-9611-e9f63e8324cd#", :schema=>#<URI::Generic:0x103a76198 URL:03179a21-197e-5414-9611-e9f63e8324cd#>, :failed_attribute=>"Type", :fragment=>"#/a"}, {:message=>"The property '#/' did not contain a required property of 'b' in schema 03179a21-197e-5414-9611-e9f63e8324cd#", :schema=>#<URI::Generic:0x103a76198 URL:03179a21-197e-5414-9611-e9f63e8324cd#>, :failed_attribute=>"Properties", :fragment=>"#/"}]
-
-</pre>
+# [{:message=>"The property '#/a' of type String did not match the following type: integer in schema 03179a21-197e-5414-9611-e9f63e8324cd#", :schema=>#, :failed_attribute=>"Type", :fragment=>"#/a"}, {:message=>"The property '#/' did not contain a required property of 'b' in schema 03179a21-197e-5414-9611-e9f63e8324cd#", :schema=>#, :failed_attribute=>"Properties", :fragment=>"#/"}]
+```
 
-h3. Validate against a fragment of a supplied schema
+### Validate against a fragment of a supplied schema
 
-<pre>
-  require 'rubygems'
-  require 'json-schema'
+```rb
+require 'rubygems'
+require 'json-schema'
 
-  schema = {
-    "type" => "object",
-    "required" => ["a","b"],
-    "properties" => {
-      "a" => {"type" => "integer"},
-      "b" => {"type" => "string"},
-      "c" => {
-        "type" => "object",
-        "properties" => {
-          "z" => {"type" => "integer"}
-        }
+schema = {
+  "type" => "object",
+  "required" => ["a","b"],
+  "properties" => {
+    "a" => {"type" => "integer"},
+    "b" => {"type" => "string"},
+    "c" => {
+      "type" => "object",
+      "properties" => {
+        "z" => {"type" => "integer"}
       }
     }
   }
+}
 
-  data = {
-    "z" => 1
-  }
+data = {
+  "z" => 1
+}
 
-  JSON::Validator.validate(schema, data, :fragment => "#/properties/c")
-</pre>
+JSON::Validator.validate(schema, data, :fragment => "#/properties/c")
+```
 
-h3. Validate a JSON object against a JSON schema object, while also validating the schema itself
+### Validate a JSON object against a JSON schema object, while also validating the schema itself
 
-<pre>
+```rb
 require 'rubygems'
 require 'json-schema'
 
@@ -223,14 +255,16 @@ data = {
 }
 
 JSON::Validator.validate(schema, data, :validate_schema => true)
-</pre>
+```
 
-h3. Validate a JSON object against a JSON schema object, while inserting default values from the schema
+### Validate a JSON object against a JSON schema object, while inserting default values from the schema
 
-With the :insert_defaults option set to true any missing property that has a
-default value specified in the schema will be inserted into the validated data. The inserted default value is validated hence catching a schema that specifies an invalid default value.
+With the `:insert_defaults` option set to true any missing property that has a
+default value specified in the schema will be inserted into the validated data.
+The inserted default value is validated hence catching a schema that specifies
+an invalid default value.
 
-<pre>
+```rb
 require 'rubygems'
 require 'json-schema'
 
@@ -258,11 +292,11 @@ JSON::Validator.validate(schema, data, :insert_defaults => true)
 #   "a" => 42,
 #   "b" => 5
 # }
+```
 
-</pre>
-h3. Validate an object against a JSON Schema Draft 2 schema
+### Validate an object against a JSON Schema Draft 2 schema
 
-<pre>
+```rb
 require 'rubygems'
 require 'json-schema'
 
@@ -278,15 +312,23 @@ data = {
 }
 
 JSON::Validator.validate(schema, data, :version => :draft2)
-</pre>
+```
 
-h3. Explicitly specifying the type of the data
+### Explicitly specifying the type of the data
 
-By default, json-schema accepts a variety of different types for the data parameter, and it will try to work out what to do with it dynamically. You can pass it a string uri (in which case it will download the json from that location before validating), a string of JSON text, or simply a ruby object (such as an array or hash representing parsed json). However, sometimes the nature of the data is ambiguous (for example, is "http://github.com" just a string, or is it a uri?). In other situations, you have already parsed your JSON, and you don't need to re-parse it.
+By default, json-schema accepts a variety of different types for the data
+parameter, and it will try to work out what to do with it dynamically. You can
+pass it a string uri (in which case it will download the json from that location
+before validating), a string of JSON text, or simply a ruby object (such as an
+array or hash representing parsed json). However, sometimes the nature of the
+data is ambiguous (for example, is "http://github.com" just a string, or is it a
+uri?). In other situations, you have already parsed your JSON, and you don't
+need to re-parse it.
 
-If you want to be explict about what kind of data is being parsed, JSON schema supports a number of options:
+If you want to be explict about what kind of data is being parsed, JSON schema
+supports a number of options:
 
-<pre>
+```rb
 require 'rubygems'
 require 'json-schema'
 
@@ -305,13 +347,15 @@ JSON::Validator.validate(schema, '"https://api.github.com"', :json => true) # re
 
 # loads data from the uri
 JSON::Validator.validate(schema, 'https://api.github.com', :uri => true) # returns false
-</pre>
+```
 
-h3. Extend an existing schema and validate against it
+### Extend an existing schema and validate against it
 
-For this example, we are going to extend the "JSON Schema Draft 3":http://tools.ietf.org/html/draft-zyp-json-schema-03 specification by adding a 'bitwise-and' property for validation.
+For this example, we are going to extend the [JSON Schema Draft
+3](http://tools.ietf.org/html/draft-zyp-json-schema-03) specification by adding
+a 'bitwise-and' property for validation.
 
-<pre>
+```rb
 require 'rubygems'
 require 'json-schema'
 
@@ -357,13 +401,18 @@ data = {"a" => 1, "b" => 5}
 JSON::Validator.validate(schema,data) # => false
 data = {"a" => 0, "b" => "taco"}
 JSON::Validator.validate(schema,data) # => false
-</pre>
+```
 
-h3. Custom format validation
+### Custom format validation
 
-The JSON schema standard allows custom formats in schema definitions which should be ignored by validators that do not support them. JSON::Schema allows registering procs as custom format validators which receive the value to be checked as parameter and must raise a <code>JSON::Schema::CustomFormatError</code> to indicate a format violation. The error message will be prepended by the property name, e.g. "The property '#a'":
+The JSON schema standard allows custom formats in schema definitions which
+should be ignored by validators that do not support them. JSON::Schema allows
+registering procs as custom format validators which receive the value to be
+checked as parameter and must raise a `JSON::Schema::CustomFormatError` to
+indicate a format violation. The error message will be prepended by the property
+name, e.g. [The property '#a']()
 
-<pre>
+```rb
 require 'rubygems'
 require 'json-schema'
 
@@ -396,21 +445,26 @@ schema = {
   }
 }
 errors = JSON::Validator.fully_validate(schema, {"a" => "23"})
+```
 
-</pre>
-
-h2. Controlling Remote Schema Reading
+Controlling Remote Schema Reading
+---------------------------------
 
-In some cases, you may wish to prevent the JSON Schema library from making HTTP calls or reading local files in order to resolve <code>$ref</code> schemas. If you fully control all schemas which should be used by validation, this could be accomplished by registering all referenced schemas with the validator in advance:
+In some cases, you may wish to prevent the JSON Schema library from making HTTP
+calls or reading local files in order to resolve `$ref` schemas. If you fully
+control all schemas which should be used by validation, this could be
+accomplished by registering all referenced schemas with the validator in
+advance:
 
-<pre>
+```rb
 schema = JSON::Schema.new(some_schema_definition, Addressable::URI.parse('http://example.com/my-schema'))
 JSON::Validator.add_schema(schema)
-</pre>
+```
 
-If more extensive control is necessary, the <code>JSON::Schema::Reader</code> instance used can be configured in a few ways:
+If more extensive control is necessary, the `JSON::Schema::Reader` instance used
+can be configured in a few ways:
 
-<pre>
+```rb
 # Change the default schema reader used
 JSON::Validator.schema_reader = JSON::Schema::Reader.new(:accept_uri => true, :accept_file => false)
 
@@ -419,34 +473,47 @@ schema_reader = JSON::Schema::Reader.new(
   :accept_uri => proc { |uri| uri.host == 'my-website.com' }
 )
 JSON::Validator.validate(some_schema, some_object, :schema_reader => schema_reader)
-</pre>
+```
 
-The <code>JSON::Schema::Reader</code> interface requires only an object which responds to <code>read(string)</code> and returns a <code>JSON::Schema</code> instance. See the "API documentation":http://www.rubydoc.info/github/ruby-json-schema/json-schema/master/JSON/Schema/Reader for more information.
+The `JSON::Schema::Reader` interface requires only an object which responds to
+`read(string)` and returns a `JSON::Schema` instance. See the [API
+documentation](http://www.rubydoc.info/github/ruby-json-schema/json-schema/master/JSON/Schema/Reader)
+for more information.
 
-h2. JSON Backends
+JSON Backends
+-------------
 
-The JSON Schema library currently supports the <code>json</code> and <code>yajl-ruby</code> backend JSON parsers. If either of these libraries are installed, they will be automatically loaded and used to parse any JSON strings supplied by the user.
+The JSON Schema library currently supports the `json` and `yajl-ruby` backend
+JSON parsers. If either of these libraries are installed, they will be
+automatically loaded and used to parse any JSON strings supplied by the user.
 
-If more than one of the supported JSON backends are installed, the <code>yajl-ruby</code> parser is used by default. This can be changed by issuing the following before validation:
+If more than one of the supported JSON backends are installed, the `yajl-ruby`
+parser is used by default. This can be changed by issuing the following before
+validation:
 
-<pre>
+```rb
 JSON::Validator.json_backend = :json
-</pre>
+```
 
-Optionally, the JSON Schema library supports using the MultiJSON library for selecting JSON backends. If the MultiJSON library is installed, it will be autoloaded.
+Optionally, the JSON Schema library supports using the MultiJSON library for
+selecting JSON backends. If the MultiJSON library is installed, it will be
+autoloaded.
 
-h2. Notes
+Notes
+-----
 
 The 'format' attribute is only validated for the following values:
 
-* date-time
-* date
-* time
-* ip-address (IPv4 address in draft1, draft2 and draft3)
-* ipv4 (IPv4 address in draft4)
-* ipv6
-* uri
-
-All other 'format' attribute values are simply checked to ensure the instance value is of the correct datatype (e.g., an instance value is validated to be an integer or a float in the case of 'utc-millisec').
+- date-time
+- date
+- time
+- ip-address (IPv4 address in draft1, draft2 and draft3)
+- ipv4 (IPv4 address in draft4)
+- ipv6
+- uri
+
+All other 'format' attribute values are simply checked to ensure the instance
+value is of the correct datatype (e.g., an instance value is validated to be an
+integer or a float in the case of 'utc-millisec').
 
 Additionally, JSON::Validator does not handle any json hyperschema attributes.

data/lib/json-schema/validator.rb

@@ -569,7 +569,7 @@ module JSON
         end
         Validator.add_schema(schema)
       else
-        raise SchemaParseError, "Invalid schema - must be either a string or a hash"
+        raise JSON::Schema::SchemaParseError, "Invalid schema - must be either a string or a hash"
       end
 
       schema

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json-schema
 version: !ruby/object:Gem::Version
-  version: 2.6.0
+  version: 2.6.1
 platform: ruby
 authors:
 - Kenny Hoxworth
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-08 00:00:00.000000000 Z
+date: 2016-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -85,11 +85,11 @@ email: hoxworth@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files:
-- README.textile
+- README.md
 - LICENSE.md
 files:
 - LICENSE.md
-- README.textile
+- README.md
 - lib/json-schema.rb
 - lib/json-schema/attribute.rb
 - lib/json-schema/attributes/additionalitems.rb