json-schema 2.8.0 → 5.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 598f5a11313e53a8a719936d8bbe08bddb6d07b3
-  data.tar.gz: d9a1cde316718f0fdfd042f737bcb3d1b637d313
+SHA256:
+  metadata.gz: 9c842fa3f98c7ebbdde9ebdbceb44bb1eab1f282f6a5c6c0008e0aac0eca92b6
+  data.tar.gz: d6f98215e98ce89c007d158594078d7135574543c10a82e953dcb3feed6dc9fb
 SHA512:
-  metadata.gz: e28327d9e15a145572c347c2124a9645a4e303cbad1641dde72dad47536f2071eb0fcc9628b439bb24d6f109cf1fd146d8cba2728236d2a88717a29db20fe875
-  data.tar.gz: b414849b2f9e74d7bfcfb0198ff11739caeb08eebd4929a5bd6e445b1a89c3b79c916b453f2c3d9cde05719f997e5b6eac0835534cbacc2bdb9016c296c8228f
+  metadata.gz: f744aa3ddcf37191afd16c7424b97d4e610f5da6f0c5ccbdad8fdcc10ee95f1d130f165142da95394ea09a758907b6bf6157343a1796477ed75a340c17217b65
+  data.tar.gz: 1a0d01bfb3595f4286603e9c31d3c578aff55b4abc37952c41e448d02a7ea22c37a7ba5bc8cbb85809f4395992b0da8c73ec79109e6d15338b8802cf96465dbb

data/README.md

@@ -1,13 +1,16 @@
-[![Gem Version](https://badge.fury.io/rb/json-schema.svg)](https://badge.fury.io/rb/json-schema)
-[![Travis](https://travis-ci.org/ruby-json-schema/json-schema.svg?branch=master)](https://travis-ci.org/ruby-json-schema/json-schema)
-[![Code Climate](https://codeclimate.com/github/ruby-json-schema/json-schema/badges/gpa.svg)](https://codeclimate.com/github/ruby-json-schema/json-schema)
+# Ruby JSON Schema Validator
 
-Ruby JSON Schema Validator
-==========================
+[![License](https://img.shields.io/github/license/voxpupuli/json-schema.svg)](https://github.com/voxpupuli/json-schema/blob/master/LICENSE.md)
+[![Test](https://github.com/voxpupuli/json-schema/actions/workflows/test.yml/badge.svg)](https://github.com/voxpupuli/json-schema/actions/workflows/test.yml)
+[![Release](https://github.com/voxpupuli/json-schema/actions/workflows/release.yml/badge.svg)](https://github.com/voxpupuli/json-schema/actions/workflows/release.yml)
+[![RubyGem Version](https://img.shields.io/gem/v/json-schema.svg)](https://rubygems.org/gems/json-schema)
+[![RubyGem Downloads](https://img.shields.io/gem/dt/json-schema.svg)](https://rubygems.org/gems/json-schema)
+[![Donated by Iain Beeston](https://img.shields.io/badge/donated%20by-Iain%20Beeston-fb7047.svg)](#transfer-notice)
 
 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
+6](https://tools.ietf.org/html/draft-wright-json-schema-01). Legacy support for
+[JSON Schema Draft 4](http://tools.ietf.org/html/draft-zyp-json-schema-04),
 [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
@@ -17,7 +20,7 @@ Additional Resources
 --------------------
 
 - [Google Groups](https://groups.google.com/forum/#!forum/ruby-json-schema)
-- #ruby-json-schema on chat.freenode.net
+- #voxpupuli on irc.libera.chat
 
 Version 2.0.0 Upgrade Notes
 ---------------------------
@@ -27,6 +30,14 @@ 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.
 
+Version 3.0.0 Upgrade Notes
+---------------------------
+
+All individual changes are documented in the CHANGELOG.md. The biggest change
+is that the new version only supports Ruby 2.5 and newer. Take a look into the
+gemspec file to see the currently supported Ruby version and also
+`.github/workflows/test.yml` to see the Ruby versions we test on.
+
 Installation
 ------------
 
@@ -39,8 +50,8 @@ gem install json-schema
 From the git repo:
 
 ```sh
-$ gem build json-schema.gemspec
-$ gem install json-schema-2.5.2.gem
+gem build json-schema.gemspec
+gem install json-schema-*.gem
 ```
 
 Validation
@@ -69,7 +80,7 @@ that the `$schema` attribute takes precedence over the `:version` option during
 parsing and validation.
 
 For further information on json schema itself refer to <a
-href="http://spacetelescope.github.io/understanding-json-schema/">Understanding
+href="https://json-schema.org/understanding-json-schema">Understanding
 JSON Schema</a>.
 
 Basic Usage
@@ -166,7 +177,7 @@ JSON::Validator.validate(schema, [{"a" => 1}, {"a" => 2}, {"a" => 3}])
 JSON::Validator.fully_validate(schema, { "a" => "taco" }, :errors_as_objects => true)
 
 #
-# with the `:strict` option, all properties are condisidered to have `"required": true` and all objects `"additionalProperties": false`
+# with the `:strict` option, all properties are considered to have `"required": true` and all objects `"additionalProperties": false`
 #
 
 # => true
@@ -230,6 +241,19 @@ JSON::Validator.validate(schema, { "a" => 1 }, :parse_data => false)
 # => false
 JSON::Validator.validate(schema, '{ "a": 1 }', :parse_data => false)
 
+#
+# with the `:parse_integer` option set to false, the integer value given as string will not be parsed.
+#
+
+# => true
+JSON::Validator.validate({type: "integer"}, "23")
+# => false
+JSON::Validator.validate({type: "integer"}, "23", parse_integer: false)
+# => true
+JSON::Validator.validate({type: "string"}, "123", parse_integer: false)
+# => false
+JSON::Validator.validate({type: "string"}, "123")
+
 #
 # with the `:json` option, the json must be an unparsed json text (not a hash, a uri or a file path)
 #
@@ -375,6 +399,33 @@ schema = {
 errors = JSON::Validator.fully_validate(schema, {"a" => "23"})
 ```
 
+Validating a JSON Schema
+------------------------
+
+To validate that a JSON Schema conforms to the JSON Schema standard,
+you need to validate your schema against the metaschema for the appropriate
+JSON Schema Draft. All of the normal validation methods can be used
+for this. First retrieve the appropriate metaschema from the internal
+cache (using `JSON::Validator.validator_for_name()` or
+`JSON::Validator.validator_for_uri()`) and then simply validate your
+schema against it.
+
+
+```ruby
+require "json-schema"
+
+schema = {
+  "type" => "object",
+  "properties" => {
+    "a" => {"type" => "integer"}
+  }
+}
+
+metaschema = JSON::Validator.validator_for_name("draft4").metaschema
+# => true
+JSON::Validator.validate(metaschema, schema)
+```
+
 Controlling Remote Schema Reading
 ---------------------------------
 
@@ -445,3 +496,23 @@ 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.
+
+# Transfer Notice
+
+This plugin was originally authored by [Iain Beeston](https://github.com/iainbeeston).
+The maintainer preferred that [Vox Pupuli](https://voxpupuli.org/) take ownership of the module for future improvement and maintenance.
+Existing pull requests and issues were transferred, please fork and continue to contribute [here](https://github.com/voxpupuli/json-schema).
+
+# License
+
+This gem is licensed under the [MIT license](LICENSE.md).
+
+## Release information
+
+To make a new release, please do:
+* update the version in VERSION.yml
+* Install gems with `bundle install --with release --path .vendor`
+* generate the changelog with `bundle exec rake changelog`
+* Check if the new version matches the closed issues/PRs in the changelog
+* Create a PR with it
+* After it got merged, push a tag. GitHub actions will do the actual release to rubygems and GitHub Packages

data/lib/json-schema/attribute.rb

@@ -3,8 +3,7 @@ require 'json-schema/errors/validation_error'
 module JSON
   class Schema
     class Attribute
-      def self.validate(current_schema, data, fragments, processor, validator, options = {})
-      end
+      def self.validate(current_schema, data, fragments, processor, validator, options = {}); end
 
       def self.build_fragment(fragments)
         "#/#{fragments.join('/')}"
@@ -24,14 +23,14 @@ module JSON
       end
 
       TYPE_CLASS_MAPPINGS = {
-        "string" => String,
-        "number" => Numeric,
-        "integer" => Integer,
-        "boolean" => [TrueClass, FalseClass],
-        "object" => Hash,
-        "array" => Array,
-        "null" => NilClass,
-        "any" => Object
+        'string' => String,
+        'number' => Numeric,
+        'integer' => Integer,
+        'boolean' => [TrueClass, FalseClass],
+        'object' => Hash,
+        'array' => Array,
+        'null' => NilClass,
+        'any' => Object,
       }
 
       def self.data_valid_for_type?(data, type)
@@ -41,11 +40,11 @@ module JSON
 
       # Lookup Schema type of given class instance
       def self.type_of_data(data)
-        type, _ = TYPE_CLASS_MAPPINGS.map { |k,v| [k,v] }.sort_by { |(_, v)|
+        type, = TYPE_CLASS_MAPPINGS.map { |k, v| [k, v] }.sort_by do |(_, v)|
           -Array(v).map { |klass| klass.ancestors.size }.max
-        }.find { |(_, v)|
-          Array(v).any? { |klass| data.kind_of?(klass) }
-        }
+        end.find do |(_, v)|
+          Array(v).any? { |klass| data.is_a?(klass) }
+        end
         type
       end
     end

data/lib/json-schema/attributes/additionalitems.rb

@@ -19,6 +19,7 @@ module JSON
           additional_items_schema = JSON::Schema.new(schema['additionalItems'], current_schema.uri, validator)
           data.each_with_index do |item, i|
             next if i < schema['items'].length
+
             additional_items_schema.validate(item, fragments + [i.to_s], processor, options)
           end
         end

data/lib/json-schema/attributes/additionalproperties.rb

@@ -33,11 +33,9 @@ module JSON
           extra_properties = extra_properties - schema['properties'].keys
         end
 
-        if schema['patternProperties']
-          schema['patternProperties'].each_key do |key|
-            regexp = Regexp.new(key)
-            extra_properties.reject! { |prop| regexp.match(prop) }
-          end
+        schema['patternProperties']&.each_key do |key|
+          regexp = Regexp.new(key)
+          extra_properties.reject! { |prop| regexp.match(prop) }
         end
 
         if extended_schemas = schema['extends']
@@ -52,7 +50,6 @@ module JSON
 
         extra_properties
       end
-
     end
   end
 end

data/lib/json-schema/attributes/allof.rb

@@ -7,18 +7,20 @@ module JSON
         # Create an hash to hold errors that are generated during validation
         errors = Hash.new { |hsh, k| hsh[k] = [] }
         valid = true
+        message = nil
 
         current_schema.schema['allOf'].each_with_index do |element, schema_index|
-          schema = JSON::Schema.new(element,current_schema.uri,validator)
+          schema = JSON::Schema.new(element, current_schema.uri, validator)
 
           # We're going to add a little cruft here to try and maintain any validation errors that occur in the allOf
           # We'll handle this by keeping an error count before and after validation, extracting those errors and pushing them onto an error array
           pre_validation_error_count = validation_errors(processor).count
 
           begin
-            schema.validate(data,fragments,processor,options)
-          rescue ValidationError
+            schema.validate(data, fragments, processor, options)
+          rescue ValidationError => e
             valid = false
+            message = e.message
           end
 
           diff = validation_errors(processor).count - pre_validation_error_count
@@ -29,7 +31,7 @@ module JSON
         end
 
         if !valid || !errors.empty?
-          message = "The property '#{build_fragment(fragments)}' of type #{type_of_data(data)} did not match all of the required schemas"
+          message ||= "The property '#{build_fragment(fragments)}' of type #{type_of_data(data)} did not match all of the required schemas"
           validation_error(processor, message, fragments, current_schema, self, options[:record_errors])
           validation_errors(processor).last.sub_errors = errors
         end

data/lib/json-schema/attributes/anyof.rb

@@ -11,14 +11,14 @@ module JSON
         original_data = data.is_a?(Hash) ? data.clone : data
 
         current_schema.schema['anyOf'].each_with_index do |element, schema_index|
-          schema = JSON::Schema.new(element,current_schema.uri,validator)
+          schema = JSON::Schema.new(element, current_schema.uri, validator)
 
           # We're going to add a little cruft here to try and maintain any validation errors that occur in the anyOf
           # We'll handle this by keeping an error count before and after validation, extracting those errors and pushing them onto a union error
           pre_validation_error_count = validation_errors(processor).count
 
           begin
-            schema.validate(data,fragments,processor,options)
+            schema.validate(data, fragments, processor, options)
             valid = true
           rescue ValidationError
             # We don't care that these schemas don't validate - we only care that one validated

data/lib/json-schema/attributes/const.rb

@@ -0,0 +1,15 @@
+require 'json-schema/attribute'
+
+module JSON
+  class Schema
+    class ConstAttribute < Attribute
+      def self.validate(current_schema, data, fragments, processor, validator, options = {})
+        const_value = current_schema.schema['const']
+        unless const_value == data
+          message = "The property '#{build_fragment(fragments)}' value #{data.inspect} did not match constant '#{const_value}'"
+          validation_error(processor, message, fragments, current_schema, self, options[:record_errors])
+        end
+      end
+    end
+  end
+end

data/lib/json-schema/attributes/dependencies.rb

@@ -26,6 +26,7 @@ module JSON
 
       def self.validate_dependency(schema, data, property, value, fragments, processor, attribute, options)
         return if data.key?(value.to_s)
+
         message = "The property '#{build_fragment(fragments)}' has a property '#{property}' that depends on a missing property '#{value}'"
         validation_error(processor, message, fragments, schema, attribute, options[:record_errors])
       end
@@ -34,11 +35,5 @@ module JSON
         value.is_a?(String) || value.is_a?(Array) || value.is_a?(Hash)
       end
     end
-
-    class DependenciesV4Attribute < DependenciesAttribute
-      def self.accept_value?(value)
-        value.is_a?(Array) || value.is_a?(Hash)
-      end
-    end
   end
 end

data/lib/json-schema/attributes/dependencies_v4.rb

@@ -0,0 +1,11 @@
+require 'json-schema/attributes/dependencies'
+
+module JSON
+  class Schema
+    class DependenciesV4Attribute < DependenciesAttribute
+      def self.accept_value?(value)
+        value.is_a?(Array) || value.is_a?(Hash)
+      end
+    end
+  end
+end

data/lib/json-schema/attributes/disallow.rb

@@ -5,7 +5,8 @@ module JSON
     class DisallowAttribute < Attribute
       def self.validate(current_schema, data, fragments, processor, validator, options = {})
         return unless type = validator.attributes['type']
-        type.validate(current_schema, data, fragments, processor, validator, options.merge(:disallow => true))
+
+        type.validate(current_schema, data, fragments, processor, validator, options.merge(disallow: true))
       end
     end
   end

data/lib/json-schema/attributes/divisibleby.rb

@@ -12,7 +12,7 @@ module JSON
 
         factor = current_schema.schema[keyword]
 
-        if factor == 0 || factor == 0.0 || (BigDecimal.new(data.to_s) % BigDecimal.new(factor.to_s)).to_f != 0
+        if factor == 0 || factor == 0.0 || (BigDecimal(data.to_s) % BigDecimal(factor.to_s)).to_f != 0
           message = "The property '#{build_fragment(fragments)}' was not divisible by #{factor}"
           validation_error(processor, message, fragments, current_schema, self, options[:record_errors])
         end

data/lib/json-schema/attributes/enum.rb

@@ -7,14 +7,14 @@ module JSON
         enum = current_schema.schema['enum']
         return if enum.include?(data)
 
-        values = enum.map { |val|
+        values = enum.map do |val|
           case val
           when nil   then 'null'
           when Array then 'array'
           when Hash  then 'object'
           else val.to_s
           end
-        }.join(', ')
+        end.join(', ')
 
         message = "The property '#{build_fragment(fragments)}' value #{data.inspect} did not match one of the following values: #{values}"
         validation_error(processor, message, fragments, current_schema, self, options[:record_errors])

data/lib/json-schema/attributes/extends.rb

@@ -8,11 +8,11 @@ module JSON
         schemas = current_schema.schema['extends']
         schemas = [schemas] if !schemas.is_a?(Array)
         schemas.each do |s|
-          uri,schema = get_extended_uri_and_schema(s, current_schema, validator)
+          uri, schema = get_extended_uri_and_schema(s, current_schema, validator)
           if schema
             schema.validate(data, fragments, processor, options)
           elsif uri
-            message = "The extended schema '#{uri.to_s}' cannot be found"
+            message = "The extended schema '#{uri}' cannot be found"
             validation_error(processor, message, fragments, current_schema, self, options[:record_errors])
           else
             message = "The property '#{build_fragment(fragments)}' was not a valid schema"
@@ -22,15 +22,15 @@ module JSON
       end
 
       def self.get_extended_uri_and_schema(s, current_schema, validator)
-        uri,schema = nil,nil
+        uri, schema = nil, nil
 
         if s.is_a?(Hash)
           uri = current_schema.uri
           if s['$ref']
-            ref_uri,ref_schema = JSON::Schema::RefAttribute.get_referenced_uri_and_schema(s, current_schema, validator)
+            ref_uri, ref_schema = JSON::Schema::RefAttribute.get_referenced_uri_and_schema(s, current_schema, validator)
             if ref_schema
               if s.size == 1 # Check if anything else apart from $ref
-                uri,schema = ref_uri,ref_schema
+                uri, schema = ref_uri, ref_schema
               else
                 s = s.dup
                 s.delete '$ref'
@@ -38,10 +38,10 @@ module JSON
               end
             end
           end
-          schema ||= JSON::Schema.new(s,uri,validator)
+          schema ||= JSON::Schema.new(s, uri, validator)
         end
 
-        [uri,schema]
+        [uri, schema]
       end
     end
   end

data/lib/json-schema/attributes/format.rb

@@ -5,9 +5,10 @@ module JSON
     class FormatAttribute < Attribute
       def self.validate(current_schema, data, fragments, processor, validator, options = {})
         return unless data_valid_for_type?(data, current_schema.schema['type'])
+
         format = current_schema.schema['format'].to_s
         validator = validator.formats[format]
-        validator.validate(current_schema, data, fragments, processor, validator, options) unless validator.nil?
+        validator&.validate(current_schema, data, fragments, processor, validator, options)
       end
     end
   end

data/lib/json-schema/attributes/formats/custom.rb

@@ -1,4 +1,4 @@
-require 'json-schema/attribute'
+require 'json-schema/attributes/format'
 require 'json-schema/errors/custom_format_error'
 
 module JSON

data/lib/json-schema/attributes/formats/date.rb

@@ -1,4 +1,4 @@
-require 'json-schema/attribute'
+require 'json-schema/attributes/format'
 
 module JSON
   class Schema
@@ -13,6 +13,7 @@ module JSON
               Date.parse(data)
             rescue ArgumentError => e
               raise e unless e.message == 'invalid date'
+
               validation_error(processor, error_message, fragments, current_schema, self, options[:record_errors])
             end
           else

data/lib/json-schema/attributes/formats/date_time.rb

@@ -1,4 +1,4 @@
-require 'json-schema/attribute'
+require 'json-schema/attributes/format'
 
 module JSON
   class Schema
@@ -10,12 +10,13 @@ module JSON
         if data.is_a?(String)
           error_message = "The property '#{build_fragment(fragments)}' must be a date/time in the ISO-8601 format of YYYY-MM-DDThh:mm:ssZ or YYYY-MM-DDThh:mm:ss.ssZ"
           if (m = REGEXP.match(data))
-            parts = data.split("T")
+            parts = data.split('T')
 
             begin
               Date.parse(parts[0])
             rescue ArgumentError => e
               raise e unless e.message == 'invalid date'
+
               validation_error(processor, error_message, fragments, current_schema, self, options[:record_errors])
               return
             end

data/lib/json-schema/attributes/formats/date_time_v4.rb

@@ -1,10 +1,11 @@
-require 'json-schema/attribute'
+require 'json-schema/attributes/format'
 
 module JSON
   class Schema
     class DateTimeV4Format < FormatAttribute
       def self.validate(current_schema, data, fragments, processor, validator, options = {})
         return unless data.is_a?(String)
+
         DateTime.rfc3339(data)
       rescue ArgumentError
         error_message = "The property '#{build_fragment(fragments)}' must be a valid RFC3339 date/time string"

data/lib/json-schema/attributes/formats/ip.rb

@@ -11,7 +11,7 @@ module JSON
         begin
           ip = IPAddr.new(data)
         rescue ArgumentError => e
-          raise e unless e.message == 'invalid address'
+          raise e unless e.message.start_with?('invalid address')
         end
 
         family = ip_version == 6 ? Socket::AF_INET6 : Socket::AF_INET

data/lib/json-schema/attributes/formats/time.rb

@@ -1,4 +1,4 @@
-require 'json-schema/attribute'
+require 'json-schema/attributes/format'
 
 module JSON
   class Schema

data/lib/json-schema/attributes/formats/uri.rb

@@ -1,4 +1,4 @@
-require 'json-schema/attribute'
+require 'json-schema/attributes/format'
 require 'json-schema/errors/uri_error'
 
 module JSON
@@ -6,6 +6,7 @@ module JSON
     class UriFormat < FormatAttribute
       def self.validate(current_schema, data, fragments, processor, validator, options = {})
         return unless data.is_a?(String)
+
         error_message = "The property '#{build_fragment(fragments)}' must be a valid URI"
         begin
           JSON::Util::URI.parse(data)

data/lib/json-schema/attributes/items.rb

@@ -17,6 +17,7 @@ module JSON
         when Array
           items.each_with_index do |item_schema, i|
             break if i >= data.length
+
             schema = JSON::Schema.new(item_schema, current_schema.uri, validator)
             schema.validate(data[i], fragments + [i.to_s], processor, options)
           end