openc-json_schema 0.0.5 → 0.0.7

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MmM4OTcxOWE4NDM5YTcxYzQyYWMwYjNmYTczMzhkN2I2YjVjNDA2Nw==
+    MmI5ZTBkM2Q5MmNiNTc3M2QwNWRhZmU5ZDYzODA1MjBlOGEwYThhMg==
   data.tar.gz: !binary |-
-    MThkMzRkMTNjYWYxYTNhYmRlNGFjYjg1YjQ3ZDc4OGNmOTZlZDBiOA==
+    MWQ5ZGM5ZDUxYmM3NmM4ZjE2MTJiNTMyNDZhMDkyZjcwYWFiOGI4ZQ==
 SHA512:
   metadata.gz: !binary |-
-    MjJjZWMzMjZlOWI4ODk2NDc4OGIyMjgyMzg5Y2Y5ZTNjOTY5OTcyMWZhNDkz
-    Y2MwZTI5ZTQ2ZGZhYjc5MTc1ODkzZTRiOGQ0Y2UyNzlkZjIzYmUxYjg3YzAw
-    YTgzOTFiNzg2ZmZmNzdhYjliMDUwMDIzNjdlMjk2MmFiYzc2YzY=
+    OWM1ZGVkNDkyYzU5NzI5Mjg0NjcxNDY2MmM0ZDM1OTY2YzM4NjM0NDQxOGVi
+    ZDNiYTlkNTE3NzI3NTM2M2M3MzMzMzY3ZTliYjhiNGVmZjBkZjc4NzI1Zjdk
+    YmVlOTEyYzZjYmI2N2ZjYTQzNDZlNzIxYzY4MjkwYWQwMjE4NTg=
   data.tar.gz: !binary |-
-    ZjRjNDZhNTkyNGU5MGVhY2ExMTU4NzkyNGY0NTg2Mzc4N2UxYmFlZDdhMzFj
-    OTY1MjFlNDE4YzNlMGY4M2VhYjdhNjk2OGM2ZDE4OTIzM2MyMjYwZmUwYmVl
-    ZGFkMjcyOTZjNzU1YTZiMDNmYjVkMjgwOTgyZTk5MDQxYmNkMTI=
+    OGUxNDU0N2RmMWZmZDAyNmY0ZmUxNWNjZDg5OTdjMTI0ZmY4ZjMwN2I2NTI2
+    N2RjZmFjYWIxNDRjZDdkNDM1NTA5NDk4YjQ0NDRlNWVmNTU1MTQ4NGM2MWQ3
+    NGE5N2IwMGFhY2MzYWRkNTE0OTBkYjMyMzY2YjE3OWRlOTc5MzA=

data/Gemfile

@@ -3,6 +3,4 @@ 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,21 +1,16 @@
-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.5)
+    openc-json_schema (0.0.7)
+      json-schema-openc-fork (= 0.0.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
     addressable (2.3.7)
     diff-lcs (1.2.5)
+    json-schema-openc-fork (0.0.1)
+      addressable (~> 2.3)
     multi_json (1.10.1)
     rake (10.4.2)
     rspec (3.1.0)
@@ -40,7 +35,6 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 1.7)
-  json-schema!
   openc-json_schema!
   rake (~> 10.0)
   rspec (~> 3.0)

data/lib/openc/json_schema/validator.rb

@@ -76,46 +76,52 @@ module Openc
       end
 
       def convert_error(error)
+        path = fragment_to_path(error[:fragment])
+
         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}
+          "Missing required property: #{path}"
+        when 'AdditionalProperties'
+          match = error[:message].match(/contains additional properties \["(.*)"\] outside of the schema/)
+          additional_property = match[1].split('", "')[0]
+          path = fragment_to_path("#{error[:fragment]}/#{additional_property}")
+          "Disallowed additional property: #{path}"
         when 'OneOf'
           if error[:message].match(/did not match any/)
-            {:type => :one_of_no_matches, :path => fragment_to_path(error[:fragment])}
+            "No match for property: #{path}"
           else
-            {:type => :one_of_many_matches, :path => fragment_to_path(error[:fragment])}
+            "Multiple possible matches for property: #{path}"
           end
         when 'AnyOf'
-          {:type => :any_of_no_matches, :path => fragment_to_path(error[:fragment])}
+          "No match for property: #{path}"
         when 'MinLength'
           match = error[:message].match(/minimum string length of (\d+) in/)
           min_length = match[1].to_i
-          {:type => :too_short, :path => fragment_to_path(error[:fragment]), :length => min_length}
+          "Property too short: #{path} (must be at least #{min_length} characters)"
         when 'MaxLength'
           match = error[:message].match(/maximum string length of (\d+) in/)
           max_length = match[1].to_i
-          {:type => :too_long, :path => fragment_to_path(error[:fragment]), :length => max_length}
+          "Property too long: #{path} (must be at most #{max_length} characters)"
         when 'TypeV4'
           match = error[:message].match(/the following types?: ([\w\s,]+) in schema/)
           allowed_types = match[1].split(',').map(&:strip)
-          {:type => :type_mismatch, :path => fragment_to_path(error[:fragment]), :allowed_types => allowed_types}
+          "Property of wrong type: #{path} (must be of type #{allowed_types.join(', ')})"
         when 'Enum'
           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}
+          if allowed_values.size == 1
+            "Property must have value #{allowed_values[0]}: #{path}"
+          else
+            "Property not an allowed value: #{path} (must be one of #{allowed_values.join(', ')})"
+          end
         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'}
+            "Property not of expected format: #{path} (must be of format yyyy-mm-dd)"
           else
-            {:type => :unknown, :path => fragment_to_path(error[:fragment]), :failed_attribute => error[:failed_attribute], :message => error[:message]}
+            "Error of unknown type: #{path} (#{error[:message]})"
           end
         end
       end

data/lib/openc/json_schema/version.rb

@@ -1,5 +1,5 @@
 module Openc
   module JsonSchema
-    VERSION = '0.0.5'
+    VERSION = '0.0.7'
   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-openc-fork", "0.0.1"
 end

data/spec/openc_json_schema_spec.rb

@@ -20,11 +20,8 @@ describe Openc::JsonSchema do
         'required' => ['aaa'],
       }
       record = {}
-
-      expect([schema, record]).to fail_validation_with(
-        :type => :missing,
-        :path => 'aaa'
-      )
+      error = 'Missing required property: aaa'
+      expect([schema, record]).to fail_validation_with(error)
     end
 
     specify 'when required nested property missing' do
@@ -40,11 +37,24 @@ describe Openc::JsonSchema do
         }
       }
       record = {'aaa' => {}}
+      error = 'Missing required property: aaa.bbb'
+      expect([schema, record]).to fail_validation_with(error)
+    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 => :missing,
-        :path => 'aaa.bbb'
-      )
+      error = 'Disallowed additional property: bbb'
+      expect([schema, record]).to fail_validation_with(error)
     end
 
     context 'when none of oneOf options match' do
@@ -83,10 +93,8 @@ describe Openc::JsonSchema do
       
         record = {'aaa' => {'a_type' => 'a1', 'a_properties' => {}}}
 
-        expect([schema, record]).to fail_validation_with(
-          :type => :missing,
-          :path => 'aaa.a_properties.bbb'
-        )
+        error = 'Missing required property: aaa.a_properties.bbb'
+        expect([schema, record]).to fail_validation_with(error)
       end
 
       specify 'and we are switching on a nested enum field' do
@@ -128,10 +136,8 @@ describe Openc::JsonSchema do
 
         record = {'xxx' => {'aaa' => {'a_type' => 'a1', 'a_properties' => {}}}}
 
-        expect([schema, record]).to fail_validation_with(
-          :type => :missing,
-          :path => 'xxx.aaa.a_properties.bbb'
-        )
+        error = 'Missing required property: xxx.aaa.a_properties.bbb'
+        expect([schema, record]).to fail_validation_with(error)
       end
 
       specify 'and we are not switching on an enum field' do
@@ -163,10 +169,8 @@ describe Openc::JsonSchema do
       
         record = {'aaa' => {'bbb' => {}}}
 
-        expect([schema, record]).to fail_validation_with(
-          :type => :one_of_no_matches,
-          :path => 'aaa'
-        )
+        error = 'No match for property: aaa'
+        expect([schema, record]).to fail_validation_with(error)
       end
     end
 
@@ -180,11 +184,8 @@ describe Openc::JsonSchema do
       }
       record = {'aaa' => 'x'}
 
-      expect([schema, record]).to fail_validation_with(
-        :type => :too_short,
-        :path => 'aaa',
-        :length => 2
-      )
+      error = 'Property too short: aaa (must be at least 2 characters)'
+      expect([schema, record]).to fail_validation_with(error)
     end
 
     specify 'when nested property too short' do
@@ -202,11 +203,8 @@ describe Openc::JsonSchema do
       }
       record = {'aaa' => {'bbb' => 'x'}}
 
-      expect([schema, record]).to fail_validation_with(
-        :type => :too_short,
-        :path => 'aaa.bbb',
-        :length => 2
-      )
+      error = 'Property too short: aaa.bbb (must be at least 2 characters)'
+      expect([schema, record]).to fail_validation_with(error)
     end
 
     specify 'when property too long' do
@@ -219,11 +217,8 @@ describe Openc::JsonSchema do
       }
       record = {'aaa' => 'xxx'}
 
-      expect([schema, record]).to fail_validation_with(
-        :type => :too_long,
-        :path => 'aaa',
-        :length => 2
-      )
+      error = 'Property too long: aaa (must be at most 2 characters)'
+      expect([schema, record]).to fail_validation_with(error)
     end
 
     specify 'when property of wrong type and many types allowed' do
@@ -236,11 +231,8 @@ describe Openc::JsonSchema do
       }
       record = {'aaa' => ['xxx']}
 
-      expect([schema, record]).to fail_validation_with(
-        :type => :type_mismatch,
-        :path => 'aaa',
-        :allowed_types => ['number', 'string']
-      )
+      error = 'Property of wrong type: aaa (must be of type number, string)'
+      expect([schema, record]).to fail_validation_with(error)
     end
 
     specify 'when property of wrong type and single type allowed' do
@@ -253,14 +245,11 @@ describe Openc::JsonSchema do
       }
       record = {'aaa' => 'xxx'}
 
-      expect([schema, record]).to fail_validation_with(
-        :type => :type_mismatch,
-        :path => 'aaa',
-        :allowed_types => ['number']
-      )
+      error = 'Property of wrong type: aaa (must be of type number)'
+      expect([schema, record]).to fail_validation_with(error)
     end
 
-    specify 'when property not in enum' do
+    specify 'when property not in enum and many values allowed' do
       schema = {
         '$schema' => 'http://json-schema.org/draft-04/schema#',
         'type' => 'object',
@@ -270,30 +259,22 @@ describe Openc::JsonSchema do
       }
       record = {'aaa' => 'z'}
 
-      expect([schema, record]).to fail_validation_with(
-        :type => :enum_mismatch,
-        :path => 'aaa',
-        :allowed_values => ['a', 'b', 'c']
-      )
+      error = 'Property not an allowed value: aaa (must be one of a, b, c)'
+      expect([schema, record]).to fail_validation_with(error)
     end
 
-    specify 'when additional properties are present but disallowed' do
+    specify 'when property not in enum and single value allowed' do
       schema = {
         '$schema' => 'http://json-schema.org/draft-04/schema#',
         'type' => 'object',
         'properties' => {
-          'aaa' => {'type' => 'number'}
-        },
-        'additionalProperties' => false
+          'aaa' => {'enum' => ['a']}
+        }
       }
+      record = {'aaa' => 'z'}
 
-      record = {'aaa' => 1, 'bbb' => 2, 'ccc' => 3}
-
-      expect([schema, record]).to fail_validation_with(
-        :type => :extra_properties,
-        :path => '',
-        :extra_properties => ['bbb', 'ccc']
-      )
+      error = 'Property must have value a: aaa'
+      expect([schema, record]).to fail_validation_with(error)
     end
 
     specify 'when property of wrong format' do
@@ -306,11 +287,8 @@ describe Openc::JsonSchema do
       }
       record = {'aaa' => 'zzz'}
 
-      expect([schema, record]).to fail_validation_with(
-        :type => :format_mismatch,
-        :path => 'aaa',
-        :expected_format => 'yyyy-mm-dd'
-      )
+      error = 'Property not of expected format: aaa (must be of format yyyy-mm-dd)'
+      expect([schema, record]).to fail_validation_with(error)
     end
 
     specify 'when property with format is empty' do
@@ -323,11 +301,8 @@ describe Openc::JsonSchema do
       }
       record = {'aaa' => ''}
 
-      expect([schema, record]).to fail_validation_with(
-        :type => :format_mismatch,
-        :path => 'aaa',
-        :expected_format => 'yyyy-mm-dd'
-      )
+      error = 'Property not of expected format: aaa (must be of format yyyy-mm-dd)'
+      expect([schema, record]).to fail_validation_with(error)
     end
 
     context 'when schema includes $ref' do
@@ -340,11 +315,8 @@ describe Openc::JsonSchema do
       specify 'when data is invalid' do
         schema_path = 'spec/schemas/aaa.json'
         record = {'aaa' => 1, 'bbb' => {'BBB' => '10'}}
-        expect([schema_path, record]).to fail_validation_with(
-          :type => :type_mismatch,
-          :path => 'bbb.BBB',
-          :allowed_types => ['number']
-        )
+        error = 'Property of wrong type: bbb.BBB (must be of type number)'
+        expect([schema_path, record]).to fail_validation_with(error)
       end
     end
 
@@ -358,11 +330,8 @@ describe Openc::JsonSchema do
       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']
-        )
+        error = 'Property of wrong type: fff.ggg.hhh (must be of type number)'
+        expect([schema_path, record]).to fail_validation_with(error)
       end
 
       context 'and schema is an included schema' do
@@ -375,11 +344,8 @@ describe Openc::JsonSchema do
         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']
-          )
+          error = 'Property of wrong type: ggg.hhh (must be of type number)'
+          expect([schema_path, record]).to fail_validation_with(error)
         end
       end
 
@@ -393,11 +359,8 @@ describe Openc::JsonSchema do
         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']
-          )
+          error = 'Property of wrong type: iii.jjj.kkk (must be of type number)'
+          expect([schema_path, record]).to fail_validation_with(error)
         end
       end
     end
@@ -407,10 +370,8 @@ describe Openc::JsonSchema do
       record = {
         'mmm' => []
       }
-      expect([schema_path, record]).to fail_validation_with(
-        :type => :one_of_no_matches,
-        :path => 'mmm'
-      )
+      error = 'No match for property: mmm'
+      expect([schema_path, record]).to fail_validation_with(error)
     end
 
     specify 'when schema includes oneOfs which contain $refs indirectly' do
@@ -423,14 +384,11 @@ describe Openc::JsonSchema do
           }
         }
       }
-      expect([schema_path, record]).to fail_validation_with(
-        :type => :type_mismatch,
-        :path => 'ccc.ccc_properties.ddd',
-        :allowed_types => ['number'],
-      )
+      error = 'Property of wrong type: ccc.ccc_properties.ddd (must be of type number)'
+      expect([schema_path, record]).to fail_validation_with(error)
     end
 
-    specify '' do
+    specify 'when oneOf is used to dispatch on type' do
       schema = {
         '$schema' => 'http://json-schema.org/draft-04/schema#',
         'type' => 'object',
@@ -450,11 +408,8 @@ describe Openc::JsonSchema do
         }
       }
       record = {'aaa' => 'not-a-date'}
-      expect([schema, record]).to fail_validation_with(
-        :type => :format_mismatch,
-        :path => 'aaa',
-        :expected_format => 'yyyy-mm-dd'
-      )
+      error = 'Property not of expected format: aaa (must be of format yyyy-mm-dd)'
+      expect([schema, record]).to fail_validation_with(error)
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openc-json_schema
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.7
 platform: ruby
 authors:
 - OpenCorporates
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-16 00:00:00.000000000 Z
+date: 2015-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: json-schema-openc-fork
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.1
 description: 
 email: info@opencorporates.com
 executables: []