json_schemer 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f44b977f6f07e9dfbb34d58681bc0b22059143bc761364b8c8edb81b5ba7fb16
-  data.tar.gz: f606d14d205b33bb4f1c221cb6526e79afee01d965d61883763c8f516fabd69e
+  metadata.gz: a8a7a9d5181f0da2becb05779a587291aaa9fdcdf1ce2eeb2745165f860ff4c4
+  data.tar.gz: a287a3ce5b40ad941b114e4c95c4ad613c3372b3aa30549078ce998b9405c913
 SHA512:
-  metadata.gz: 046d14ee062722084b3b7954c488b6e86ba89b5ba112879b53ecf173c3c969d183ec4baa381c2f30eca61f6595fbe199337cff5ecfbb4eb7226d1f662d4b80e9
-  data.tar.gz: 684807637dc7510c868fc173716a1846c35368db792bd8fa1a8e2de605d3e58901df668b451567610294bd989ea057a6fb28e02bd59c2bd4d1df0b4f7571d629
+  metadata.gz: cb6bb847b36e285d969c160462d0a42d3fb0ba1cce7f479f13b6bfe759df299591f86bb05d1f6a6e545a96508c27fb1cb48e828ec431e07c3b8036392dbc20c0
+  data.tar.gz: 53a14606a501034d0693f54e2dd56706a573d950c26fddc9950effcc9dbc4762eaf929756b1d609a9e7bf0c0a5507dd8913e5c6078fbf0ff5b68eae7b851a6e9

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    json_schemer (0.1.1)
+    json_schemer (0.1.2)
       ecma-re-validator (~> 0.1.2)
       hana (~> 1.3.3)
       uri_template (~> 0.7.0)

data/README.md

@@ -24,15 +24,47 @@ Or install it yourself as:
 require 'json_schemer'
 
 schema = {
-  'type' => 'integer'
+  'type' => 'object',
+  'properties' => {
+    'abc' => {
+      'type' => 'integer',
+      'minimum' => 11
+    }
+  }
 }
 schemer = JSONSchemer::Schema.new(schema)
 
-schemer.valid?(1)
+# true/false validation
+
+schemer.valid?({ 'abc' => 11 })
 # => true
 
-schemer.valid?(1.1)
+schemer.valid?({ 'abc' => 10 })
 # => false
+
+# error validation (`validate` returns an enumerator)
+
+schemer.validate({ 'abc' => 10 }).to_a
+# => [{"data"=>10, "schema"=>{"type"=>"integer", "minimum"=>11}, "pointer"=>"#/abc", "type"=>"minimum"}]
+```
+
+## Options
+
+```ruby
+JSONSchemer::Schema.new(
+  schema,
+
+  # validate `format` (https://tools.ietf.org/html/draft-handrews-json-schema-validation-00#section-7)
+  # true/false
+  # default: true
+  format: true,
+
+  # resolve external references
+  # 'net/http'/proc/lambda/respond_to?(:call)
+  # 'net/http': proc { |uri| JSON.parse(Net::HTTP.get(uri)) }
+  # default: proc { |uri| raise UnknownRef, uri.to_s }
+  ref_resolver: 'net/http'
+)
 ```
 
 ## Development

data/lib/json_schemer.rb

@@ -15,17 +15,29 @@ require "uri_template"
 
 module JSONSchemer
   class Schema
+    class InvalidMetaSchema < StandardError; end
+    class UnknownRef < StandardError; end
+
+    META_SCHEMA = 'http://json-schema.org/draft-07/schema#'
+    DEFAULT_REF_RESOLVER = proc { |uri| raise UnknownRef, uri.to_s }.freeze
+    NET_HTTP_REF_RESOLVER = proc { |uri| JSON.parse(Net::HTTP.get(uri)) }.freeze
     BOOLEANS = Set[true, false].freeze
 
-    def initialize(schema)
+    def initialize(schema, format: true, ref_resolver: DEFAULT_REF_RESOLVER)
+      if schema.is_a?(Hash) && schema.key?('$schema') && schema['$schema'] != META_SCHEMA
+        raise InvalidMetaSchema, "draft-07 is the only supported meta-schema (#{META_SCHEMA})"
+      end
+
       @root = schema
+      @format = format
+      @ref_resolver = ref_resolver == 'net/http' ? NET_HTTP_REF_RESOLVER : ref_resolver
     end
 
-    def valid?(data, schema = root, pointer = '#', parent_uri = nil)
+    def valid?(data, schema = root, pointer = '', parent_uri = nil)
       validate(data, schema, pointer, parent_uri).none?
     end
 
-    def validate(data, schema = root, pointer = '#', parent_uri = nil)
+    def validate(data, schema = root, pointer = '', parent_uri = nil)
       return enum_for(:validate, data, schema, pointer, parent_uri) unless block_given?
 
       return if schema == true
@@ -45,6 +57,7 @@ module JSONSchemer
       if_schema = schema['if']
       then_schema = schema['then']
       else_schema = schema['else']
+      format = schema['format']
       ref = schema['$ref']
       id = schema['$id']
 
@@ -55,6 +68,8 @@ module JSONSchemer
         return
       end
 
+      validate_format(data, schema, pointer, format, &Proc.new) if format && format?
+
       yield error(data, schema, pointer, 'enum') if enum && !enum.include?(data)
       yield error(data, schema, pointer, 'const') if schema.key?('const') && schema['const'] != data
 
@@ -91,7 +106,11 @@ module JSONSchemer
 
   private
 
-    attr_reader :root
+    attr_reader :root, :ref_resolver
+
+    def format?
+      !!@format
+    end
 
     def error(data, schema, pointer, type)
       {
@@ -144,19 +163,59 @@ module JSONSchemer
         if ref.start_with?('#')
           validate(data, ref_pointer.eval(root), pointer, pointer_uri(root, ref_pointer), &Proc.new)
         else
-          ref_root = JSON.parse(Net::HTTP.get(ref_uri))
+          ref_root = ref_resolver.call(ref_uri)
           ref_object = self.class.new(ref_root)
           ref_object.validate(data, ref_pointer.eval(ref_root), pointer, pointer_uri(ref_root, ref_pointer), &Proc.new)
         end
       elsif ids.key?(ref_uri.to_s)
         validate(data, ids.fetch(ref_uri.to_s), pointer, ref_uri, &Proc.new)
       else
-        ref_root = JSON.parse(Net::HTTP.get(ref_uri))
+        ref_root = ref_resolver.call(ref_uri)
         ref_object = self.class.new(ref_root)
         ref_object.validate(data, ref_object.ids.fetch(ref_uri.to_s, ref_root), pointer, ref_uri, &Proc.new)
       end
     end
 
+    def validate_format(data, schema, pointer, format)
+      valid = case format
+      when 'date-time'
+        valid_date_time?(data)
+      when 'date'
+        valid_date_time?("#{data}T04:05:06.123456789+07:00")
+      when 'time'
+        valid_date_time?("2001-02-03T#{data}")
+      when 'email'
+        data.ascii_only? && valid_email?(data)
+      when 'idn-email'
+        valid_email?(data)
+      when 'hostname'
+        data.ascii_only? && valid_hostname?(data)
+      when 'idn-hostname'
+        valid_hostname?(data)
+      when 'ipv4'
+        valid_ip?(data, :v4)
+      when 'ipv6'
+        valid_ip?(data, :v6)
+      when 'uri'
+        data.ascii_only? && valid_iri?(data)
+      when 'uri-reference'
+        data.ascii_only? && (valid_iri?(data) || valid_iri_reference?(data))
+      when 'iri'
+        valid_iri?(data)
+      when 'iri-reference'
+        valid_iri?(data) || valid_iri_reference?(data)
+      when 'uri-template'
+        valid_uri_template?(data)
+      when 'json-pointer'
+        valid_json_pointer?(data)
+      when 'relative-json-pointer'
+        valid_relative_json_pointer?(data)
+      when 'regex'
+        EcmaReValidator.valid?(data)
+      end
+      yield error(data, schema, pointer, 'format') unless valid
+    end
+
     def validate_numeric(data, schema, pointer)
       multiple_of = schema['multipleOf']
       maximum = schema['maximum']
@@ -202,7 +261,6 @@ module JSONSchemer
       max_length = schema['maxLength']
       min_length = schema['minLength']
       pattern = schema['pattern']
-      format = schema['format']
       content_encoding = schema['contentEncoding']
       content_media_type = schema['contentMediaType']
 
@@ -210,8 +268,6 @@ module JSONSchemer
       yield error(data, schema, pointer, 'minLength') if min_length && data.size < min_length
       yield error(data, schema, pointer, 'pattern') if pattern && Regexp.new(pattern) !~ data
 
-      validate_string_format(data, schema, pointer, format, &Proc.new) if format
-
       if content_encoding || content_media_type
         decoded_data = data
 
@@ -236,46 +292,6 @@ module JSONSchemer
       end
     end
 
-    def validate_string_format(data, schema, pointer, format)
-      valid = case format
-      when 'date-time'
-        valid_date_time?(data)
-      when 'date'
-        valid_date_time?("#{data}T04:05:06.123456789+07:00")
-      when 'time'
-        valid_date_time?("2001-02-03T#{data}")
-      when 'email'
-        data.ascii_only? && valid_email?(data)
-      when 'idn-email'
-        valid_email?(data)
-      when 'hostname'
-        data.ascii_only? && valid_hostname?(data)
-      when 'idn-hostname'
-        valid_hostname?(data)
-      when 'ipv4'
-        valid_ip?(data, :v4)
-      when 'ipv6'
-        valid_ip?(data, :v6)
-      when 'uri'
-        data.ascii_only? && valid_iri?(data)
-      when 'uri-reference'
-        data.ascii_only? && (valid_iri?(data) || valid_iri_reference?(data))
-      when 'iri'
-        valid_iri?(data)
-      when 'iri-reference'
-        valid_iri?(data) || valid_iri_reference?(data)
-      when 'uri-template'
-        valid_uri_template?(data)
-      when 'json-pointer'
-        valid_json_pointer?(data)
-      when 'relative-json-pointer'
-        valid_relative_json_pointer?(data)
-      when 'regex'
-        EcmaReValidator.valid?(data)
-      end
-      yield error(data, schema, pointer, 'format') unless valid
-    end
-
     def validate_array(data, schema, pointer, parent_uri, &block)
       unless data.is_a?(Array)
         yield error(data, schema, pointer, 'array')

data/lib/json_schemer/version.rb

@@ -1,3 +1,3 @@
 module JSONSchemer
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json_schemer
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - David Harsha
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-24 00:00:00.000000000 Z
+date: 2018-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler