openc-json_schema 0.0.3 → 0.0.4

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    OWJiYzM4NmZlYzYxNzU5MmNjODQ0NTI3ODhmODcyNTAyZGU2MTZhNQ==
+    YmE0MDA3M2IxMWZhMTlhZGU5MDdhNmMzNzJmMjA3MzYzZGI5MjE5Mg==
   data.tar.gz: !binary |-
-    NzFhYzk0MGQ0ODZlMWQ4Mjg4Njg0YjZkNWVlYWZiZDcyMGVhZjQzNw==
+    YjQyN2Q2YWYyMjgyYmJiZWJlN2YxMDk3MzU4ZWUzM2E5ZWMzZGI5ZA==
 SHA512:
   metadata.gz: !binary |-
-    NjM0ZTVlZDRjZGVlY2NkMWQyZjQ1YWNiZDdmYzg1MmJjNTllZmNhOTgwYWNj
-    M2NlNGE0OGM0MzJhY2I5MmE0ZDRmZWIzMDQzZjkwYjYwZmJmNTA5YzRlMzk1
-    OGQyZjZmZDdjMGI4YWE1ODYzM2JkZGNmOWM5OGIwMTllY2VmNDE=
+    MTBjYTFhZTIyOWMyNzUzOTZkNTJkZTI5OTU2NzY4NWU0N2FiNzkxNWJiNjQ3
+    MTViOTg0ODVjZjg0YTY3MjdiMzExMzZjMjQxNDQyOWE2ZDJlNzI1NTk4Mjg2
+    ODI3YmRkZGJlMzg3NmMzZTBkNmM5ZTFmYTJkOTI0MmI4Njc5Yjg=
   data.tar.gz: !binary |-
-    NTE0OWZhNWMwNTJkOGYxOGFmN2M0NWY2NzJlZWViYzczODM4YWZiMjc2YzE1
-    MTgwZmQ0MTc0ZGNiYjBhZDFhNzI4NDM1NWQ0ZTlkMTA4MDRiZmM4MTljMWY3
-    YTFkOWFhYWFmOWMxY2UzOGE3NzY2OWEwNGM4NjdiYThkZTg5YjU=
+    OTBjNjliN2EzOWUzZmRhMDcyMzk0ZDkyMzc4OWFkNzZjMzFhNjUxYTM0ZTNh
+    MjFiODNlYTVlMTVkYzdhMDgxNjY0MzllMThjZTRkOGFjM2ZhYTMxMWQ4NTA1
+    N2RmNmVjNWJlYWJkNmRkMGM2N2VhZTZlNzMwYjQ0YWFhMjk1ZWQ=

data/.gitignore

@@ -1 +1,2 @@
 spec/tmp/*.json
+coverage

data/Gemfile

@@ -2,3 +2,7 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in openc-json-schema.gemspec
 gemspec
+
+gem 'json-schema', :git => 'git://github.com/ruby-json-schema/json-schema.git', :ref => 'aded4d798a48545184dae7ae0a3bb41ec2794c88'
+
+gem 'simplecov', :require => false

data/Gemfile.lock

@@ -1,16 +1,22 @@
+GIT
+  remote: git://github.com/ruby-json-schema/json-schema.git
+  revision: aded4d798a48545184dae7ae0a3bb41ec2794c88
+  ref: aded4d798a48545184dae7ae0a3bb41ec2794c88
+  specs:
+    json-schema (2.5.0)
+      addressable (~> 2.3)
+
 PATH
   remote: .
   specs:
-    openc-json_schema (0.0.3)
-      json-schema (= 2.5.0)
+    openc-json_schema (0.0.4)
 
 GEM
   remote: https://rubygems.org/
   specs:
     addressable (2.3.7)
     diff-lcs (1.2.5)
-    json-schema (2.5.0)
-      addressable (~> 2.3)
+    multi_json (1.10.1)
     rake (10.4.2)
     rspec (3.1.0)
       rspec-core (~> 3.1.0)
@@ -24,12 +30,18 @@ GEM
     rspec-mocks (3.1.3)
       rspec-support (~> 3.1.0)
     rspec-support (3.1.2)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler (~> 1.7)
+  json-schema!
   openc-json_schema!
   rake (~> 10.0)
   rspec (~> 3.0)
+  simplecov

data/lib/openc/json_schema.rb

@@ -7,8 +7,8 @@ module Openc
   module JsonSchema
     extend self
 
-    def validate(schema_or_filename, schema_dir, record)
-      Validator.validate(schema_or_filename, schema_dir, record)
+    def validate(schema_path, record)
+      Validator.validate(schema_path, record)
     end
   end
 end

data/lib/openc/json_schema/validator.rb

@@ -3,64 +3,100 @@ module Openc
     module Validator
       extend self
 
-      def validate(schema_or_filename, schema_dir, record)
-        case schema_or_filename
-        when Hash
-          schema = schema_or_filename
-        when String
-          filename = schema_or_filename
-          schema = JSON.parse(File.read(File.join(schema_dir, filename)))
-        else
-          raise TypeError.new("Unexpected value for schema_or_filename: #{schema_or_filename.class}")
-        end
-
-        # We must change directory for the relative paths in schemas to make sense.
-        errors = Dir.chdir(schema_dir) do
-          JSON::Validator.fully_validate(schema, record, :errors_as_objects => true)
-        end
+      def validate(schema_path, record)
+        validator = JSON::Validator.new(
+          schema_path,
+          record,
+          :record_errors => true,
+          :errors_as_objects => true,
+          :validate_schema => true
+        )
+        errors = validator.validate
 
         # For now, we just handle the first error.
         error = errors[0]
         return if error.nil?
 
-        case error[:failed_attribute]
-        when 'Required'
-          match = error[:message].match(/required property of '(.*)'/)
-          missing_property = match[1]
-          path = fragment_to_path("#{error[:fragment]}/#{missing_property}")
+        convert_error(extract_error(error, record, validator))
+      end
 
-          {:type => :missing, :path => path}
-        when 'OneOf'
+      def extract_error(error, record, validator)
+        if error[:failed_attribute] == 'OneOf'
           if error[:message].match(/did not match any/)
             path_elements = fragment_to_path(error[:fragment]).split('.')
 
-            record_fragment = record
-            schema_fragment = schema
+            json_schema = validator.instance_variable_get(:@base_schema)
+            schema = json_schema.schema
 
             path_elements.each do |element|
-              record_fragment = record_fragment[element]
-              schema_fragment = schema_fragment['properties'][element]
+              record = record[element]
+              schema = schema['properties'][element]
+
+              if (ref = schema['$ref'])
+                schema_uri = validator.absolutize_ref_uri(ref, json_schema.uri)
+                json_schema = JSON::Validator.schema_reader.read(schema_uri)
+                schema = json_schema.schema
+              end
             end
 
-            one_of_schemas = schema_fragment['oneOf']
+            one_of_schemas = schema['oneOf']
 
-            unless one_of_schemas.nil?
-              one_of_schemas.each do |s|
-                s['properties'].each do |k, v|
-                  next if v['enum'].nil?
+            schemas_for_type_with_ix = case record
+            when Hash
+              one_of_schemas.each_with_index.reject {|s, ix| s['properties'].nil?}
+            when String
+              one_of_schemas.each_with_index.select {|s, ix| s['type'] == 'string' || (s['type'].nil? && s['properties'].nil?)}
+            when Integer
+              one_of_schemas.each_with_index.select {|s, ix| s['type'] == 'integer'}
+            when Array
+              one_of_schemas.each_with_index.select {|s, ix| s['type'] == 'array'}
+            else
+              raise "Unexpected type: #{record}"
+            end
 
-                  if v['enum'].include?(record_fragment[k])
-                    error1 = validate(s, schema_dir, record_fragment)
-                    return error1.merge(:path => "#{path_elements.join('.')}.#{error1[:path]}")
+            case schemas_for_type_with_ix.size
+            when 0
+              return error
+            when 1
+              ix = schemas_for_type_with_ix[0][1]
+              return error[:errors][:"oneof_#{ix}"][0]
+            else
+              if record.is_a?(Hash)
+                schemas_for_type_with_ix.each do |s, ix|
+                  s['properties'].each do |k, v|
+                    next if v['enum'].nil?
+
+                    if v['enum'].include?(record[k])
+                      return error[:errors][:"oneof_#{ix}"][0]
+                    end
                   end
                 end
+              else
+                return error
               end
             end
+          end
+        end
+
+        error
+      end
+
+      def convert_error(error)
+        case error[:failed_attribute]
+        when 'Required'
+          match = error[:message].match(/required property of '(.*)'/)
+          missing_property = match[1]
+          path = fragment_to_path("#{error[:fragment]}/#{missing_property}")
 
+          {:type => :missing, :path => path}
+        when 'OneOf'
+          if error[:message].match(/did not match any/)
             {:type => :one_of_no_matches, :path => fragment_to_path(error[:fragment])}
           else
             {:type => :one_of_many_matches, :path => fragment_to_path(error[:fragment])}
           end
+        when 'AnyOf'
+          {:type => :any_of_no_matches, :path => fragment_to_path(error[:fragment])}
         when 'MinLength'
           match = error[:message].match(/minimum string length of (\d+) in/)
           min_length = match[1].to_i
@@ -77,6 +113,10 @@ module Openc
           match = error[:message].match(/the following values: ([\w\s,]+) in schema/)
           allowed_values = match[1].split(',').map(&:strip)
           {:type => :enum_mismatch, :path => fragment_to_path(error[:fragment]), :allowed_values => allowed_values}
+        when 'AdditionalProperties'
+          match = error[:message].match(/contains additional properties \["(.*)"\] outside of the schema/)
+          extra_properties = match[1].split('", "')
+          {:type => :extra_properties, :path => fragment_to_path(error[:fragment]), :extra_properties => extra_properties}
         else
           if error[:message].match(/must be of format yyyy-mm-dd/)
             {:type => :format_mismatch, :path => fragment_to_path(error[:fragment]), :expected_format => 'yyyy-mm-dd'}

data/lib/openc/json_schema/version.rb

@@ -1,5 +1,5 @@
 module Openc
   module JsonSchema
-    VERSION = '0.0.3'
+    VERSION = '0.0.4'
   end
 end

data/openc-json_schema.gemspec

@@ -21,5 +21,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
 
-  spec.add_dependency "json-schema", "2.5.0"
+#  spec.add_dependency "json-schema", "2.5.0"
 end

data/spec/openc_json_schema_spec.rb

@@ -277,6 +277,25 @@ describe Openc::JsonSchema do
       )
     end
 
+    specify 'when additional properties are present but disallowed' do
+      schema = {
+        '$schema' => 'http://json-schema.org/draft-04/schema#',
+        'type' => 'object',
+        'properties' => {
+          'aaa' => {'type' => 'number'}
+        },
+        'additionalProperties' => false
+      }
+
+      record = {'aaa' => 1, 'bbb' => 2, 'ccc' => 3}
+
+      expect([schema, record]).to fail_validation_with(
+        :type => :extra_properties,
+        :path => '',
+        :extra_properties => ['bbb', 'ccc']
+      )
+    end
+
     specify 'when property of wrong format' do
       schema = {
         '$schema' => 'http://json-schema.org/draft-04/schema#',
@@ -329,7 +348,72 @@ describe Openc::JsonSchema do
       end
     end
 
-    specify 'when schema includes oneOfs which contain $refs' do
+    context 'when schema includes nested $refs' do
+      specify 'when data is valid' do
+        schema_path = 'spec/schemas/fff.json'
+        record = {'fff' => {'ggg' => {'hhh' => 123}}}
+        expect([schema_path, record]).to be_valid
+      end
+
+      specify 'when data is invalid' do
+        schema_path = 'spec/schemas/fff.json'
+        record = {'fff' => {'ggg' => {'hhh' => '123'}}}
+        expect([schema_path, record]).to fail_validation_with(
+          :type => :type_mismatch,
+          :path => 'fff.ggg.hhh',
+          :allowed_types => ['number']
+        )
+      end
+
+      context 'and schema is an included schema' do
+        specify 'when data is valid' do
+          schema_path = 'spec/schemas/includes/ggg.json'
+          record = {'ggg' => {'hhh' => 123}}
+          expect([schema_path, record]).to be_valid
+        end
+
+        specify 'when data is invalid' do
+          schema_path = 'spec/schemas/includes/ggg.json'
+          record = {'ggg' => {'hhh' => '123'}}
+          expect([schema_path, record]).to fail_validation_with(
+            :type => :type_mismatch,
+            :path => 'ggg.hhh',
+            :allowed_types => ['number']
+          )
+        end
+      end
+
+      context 'and there is a $ref to something in an outer directory' do
+        specify 'when data is valid' do
+          schema_path = 'spec/schemas/iii.json'
+          record = {'iii' => {'jjj' => {'kkk' => 123}}}
+          expect([schema_path, record]).to be_valid
+        end
+
+        specify 'when data is invalid' do
+          schema_path = 'spec/schemas/iii.json'
+          record = {'iii' => {'jjj' => {'kkk' => '123'}}}
+          expect([schema_path, record]).to fail_validation_with(
+            :type => :type_mismatch,
+            :path => 'iii.jjj.kkk',
+            :allowed_types => ['number']
+          )
+        end
+      end
+    end
+
+    specify 'when schema includes oneOfs which contain $refs directly' do
+      schema_path = 'spec/schemas/lll.json'
+      record = {
+        'mmm' => []
+      }
+      expect([schema_path, record]).to fail_validation_with(
+        :type => :one_of_no_matches,
+        :path => 'mmm'
+      )
+    end
+
+    specify 'when schema includes oneOfs which contain $refs indirectly' do
       schema_path = 'spec/schemas/ccc.json'
       record = {
         'ccc' => {
@@ -345,5 +429,32 @@ describe Openc::JsonSchema do
         :allowed_types => ['number'],
       )
     end
+
+    specify '' do
+      schema = {
+        '$schema' => 'http://json-schema.org/draft-04/schema#',
+        'type' => 'object',
+        'properties' => {
+          'aaa' => {
+            'oneOf' => [
+              {
+                'type' => 'string',
+                'format' => 'date'
+              },
+              {
+                'type' => 'integer',
+                'maxLength' => 2
+              }
+            ]
+          }
+        }
+      }
+      record = {'aaa' => 'not-a-date'}
+      expect([schema, record]).to fail_validation_with(
+        :type => :format_mismatch,
+        :path => 'aaa',
+        :expected_format => 'yyyy-mm-dd'
+      )
+    end
   end
 end

data/spec/schemas/fff.json

@@ -0,0 +1,7 @@
+{
+	"$schema": "http://json-schema.org/draft-04/schema#",
+	"type": "object",
+	"properties": {
+		"fff": {"$ref": "includes/ggg.json"}
+	}
+}

data/spec/schemas/iii.json

@@ -0,0 +1,7 @@
+{
+	"$schema": "http://json-schema.org/draft-04/schema#",
+	"type": "object",
+	"properties": {
+		"iii": {"$ref": "includes/jjj.json"}
+	}
+}

data/spec/schemas/includes/ggg.json

@@ -0,0 +1,6 @@
+{
+	"type": "object",
+	"properties": {
+		"ggg": {"$ref": "hhh.json"}
+	}
+}

data/spec/schemas/includes/hhh.json

@@ -0,0 +1,8 @@
+{
+	"type": "object",
+	"properties": {
+		"hhh": {
+			"type": "number"
+		}
+	}
+}

data/spec/schemas/includes/jjj.json

@@ -0,0 +1,6 @@
+{
+	"type": "object",
+	"properties": {
+		"jjj": {"$ref": "../kkk.json"}
+	}
+}

data/spec/schemas/includes/mmm.json

@@ -0,0 +1,6 @@
+{
+	"oneOf": [
+		{"type": "integer"},
+		{"type": "string"}
+	]
+}

data/spec/schemas/kkk.json

@@ -0,0 +1,8 @@
+{
+	"type": "object",
+	"properties": {
+		"kkk": {
+			"type": "number"
+		}
+	}
+}

data/spec/schemas/lll.json

@@ -0,0 +1,11 @@
+{
+	"$schema": "http://json-schema.org/draft-04/schema#",
+	"type": "object",
+	"properties": {
+		"mmm": {
+			"$ref": "includes/mmm.json"
+		}
+	},
+	"additionalProperties": false
+}
+

data/spec/spec_helper.rb

@@ -1,3 +1,6 @@
+require 'simplecov'
+SimpleCov.start
+
 require 'openc/json_schema'
 
 def get_error(schema_or_path, record)
@@ -5,17 +8,15 @@ def get_error(schema_or_path, record)
   when Hash
     json_data = schema_or_path.to_json
     filename = Digest::MD5.hexdigest(json_data) + '.json'
-    schema_dir = "spec/tmp"
-    File.open(File.join(schema_dir, filename), 'w') {|f| f.write(json_data)}
-    schema_or_filename = schema_or_path
+    schema_path = File.join('spec', 'tmp', filename)
+    File.open(schema_path, 'w') {|f| f.write(json_data)}
   when String
-    schema_or_filename = File.basename(schema_or_path)
-    schema_dir = File.dirname(schema_or_path)
+    schema_path = schema_or_path
   else
     raise
   end
 
-  error = Openc::JsonSchema.validate(schema_or_filename, schema_dir, record)
+  error = Openc::JsonSchema.validate(schema_path, record)
 end
 
 RSpec::Matchers.define(:fail_validation_with) do |expected|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openc-json_schema
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - OpenCorporates
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-05 00:00:00.000000000 Z
+date: 2015-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,20 +52,6 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: json-schema
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 2.5.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 2.5.0
 description: 
 email: info@opencorporates.com
 executables: []
@@ -87,9 +73,17 @@ files:
 - spec/openc_json_schema_spec.rb
 - spec/schemas/aaa.json
 - spec/schemas/ccc.json
+- spec/schemas/fff.json
+- spec/schemas/iii.json
 - spec/schemas/includes/bbb.json
 - spec/schemas/includes/ddd.json
 - spec/schemas/includes/eee.json
+- spec/schemas/includes/ggg.json
+- spec/schemas/includes/hhh.json
+- spec/schemas/includes/jjj.json
+- spec/schemas/includes/mmm.json
+- spec/schemas/kkk.json
+- spec/schemas/lll.json
 - spec/spec_helper.rb
 - spec/tmp/.gitkeep
 homepage: 
@@ -120,9 +114,17 @@ test_files:
 - spec/openc_json_schema_spec.rb
 - spec/schemas/aaa.json
 - spec/schemas/ccc.json
+- spec/schemas/fff.json
+- spec/schemas/iii.json
 - spec/schemas/includes/bbb.json
 - spec/schemas/includes/ddd.json
 - spec/schemas/includes/eee.json
+- spec/schemas/includes/ggg.json
+- spec/schemas/includes/hhh.json
+- spec/schemas/includes/jjj.json
+- spec/schemas/includes/mmm.json
+- spec/schemas/kkk.json
+- spec/schemas/lll.json
 - spec/spec_helper.rb
 - spec/tmp/.gitkeep
 has_rdoc: