json_schema 0.0.13 → 0.0.14

data/bin/validate-schema

@@ -1,6 +1,5 @@
 #!/usr/bin/env ruby
 
-require "json"
 require "optparse"
 require_relative "../lib/commands/validate_schema"
 

data/lib/commands/validate_schema.rb

@@ -1,3 +1,5 @@
+require "json"
+require "yaml"
 require_relative "../json_schema"
 
 module Commands
@@ -28,8 +30,9 @@ module Commands
       return false if argv.count < 1
 
       argv.each do |data_file|
-        return false if !check_file(data_file)
-        data = JSON.parse(File.read(data_file))
+        if !(data = read_file(data_file))
+          return false
+        end
 
         if detect
           if !(schema_uri = data["$schema"])
@@ -57,15 +60,6 @@ module Commands
 
     private
 
-    def check_file(file)
-      if !File.exists?(file)
-        @errors = ["#{file}: No such file or directory."]
-        false
-      else
-        true
-      end
-    end
-
     def initialize_store
       @store = JsonSchema::DocumentStore.new
       extra_schemas.each do |extra_schema|
@@ -83,10 +77,12 @@ module Commands
     end
 
     def parse(file)
-      return nil if !check_file(file)
+      if !(schema_data = read_file(file))
+        return nil
+      end
 
       parser = JsonSchema::Parser.new
-      if !(schema = parser.parse(JSON.parse(File.read(file))))
+      if !(schema = parser.parse(schema_data))
         @errors = map_schema_errors(file, parser.errors)
         return nil
       end
@@ -99,5 +95,25 @@ module Commands
 
       schema
     end
+
+    def read_file(file)
+      contents = File.read(file)
+      if File.extname(file) == ".yaml"
+        YAML.load(contents)
+      else
+        JSON.load(contents)
+      end
+    rescue Errno::ENOENT
+      @errors = ["#{file}: No such file or directory."]
+      nil
+    rescue JSON::ParserError
+      # Ruby's parsing exceptions aren't too helpful, just point user to
+      # a better tool
+      @errors = ["#{file}: Invalid JSON. Try to validate using `jsonlint`."]
+      nil
+    rescue Psych::SyntaxError
+      @errors = ["#{file}: Invalid YAML."]
+      nil
+    end
   end
 end

data/lib/json_schema/parser.rb

@@ -170,6 +170,7 @@ module JsonSchema
           link.parent      = schema
 
           link.description = l["description"]
+          link.enc_type    = l["encType"]
           link.href        = l["href"]
           link.method      = l["method"] ? l["method"].downcase.to_sym : nil
           link.rel         = l["rel"]
@@ -179,6 +180,11 @@ module JsonSchema
             link.schema = parse_data(l["schema"], schema, "links/#{i}/schema")
           end
 
+          if l["targetSchema"]
+            link.target_schema =
+              parse_data(l["schema"], schema, "links/#{i}/targetSchema")
+          end
+
           link
         }
       end

data/lib/json_schema/reference_expander.rb

@@ -144,7 +144,6 @@ module JsonSchema
         schema.any_of.each { |s| yielder << s }
         schema.one_of.each { |s| yielder << s }
         schema.definitions.each { |_, s| yielder << s }
-        schema.links.map { |l| l.schema }.compact.each { |s| yielder << s }
         schema.pattern_properties.each { |_, s| yielder << s }
         schema.properties.each { |_, s| yielder << s }
 
@@ -173,6 +172,12 @@ module JsonSchema
         schema.dependencies.values.
           select { |s| s.is_a?(Schema) }.
           each { |s| yielder << s }
+
+        # schemas contained inside hyper-schema links objects
+        schema.links.map { |l| [l.schema, l.target_schema] }.
+          flatten.
+          compact.
+          each { |s| yielder << s }
       end
     end
 

data/lib/json_schema/schema.rb

@@ -283,11 +283,17 @@ module JsonSchema
 
       # schema attributes
       attr_accessor :description
+      attr_accessor :enc_type
       attr_accessor :href
       attr_accessor :method
       attr_accessor :rel
       attr_accessor :schema
+      attr_accessor :target_schema
       attr_accessor :title
+
+      def enc_type
+        @enc_type || "application/json"
+      end
     end
 
     # Media type subobject for a hyperschema.

data/test/data_scaffold.rb

@@ -213,6 +213,9 @@ module DataScaffold
                   "$ref" => "#/definitions/app/definitions/name"
                 },
               }
+            },
+            "targetSchema" => {
+              "$ref" => "#/definitions/app"
             }
           ],
           "media" => {

data/test/json_schema/parser_test.rb

@@ -148,6 +148,7 @@ describe JsonSchema::Parser do
     pointer("#/definitions/app").merge!(
       "links" => [
         "description" => "Create a new app.",
+        "encType"    => "application/x-www-form-urlencoded",
         "href" => "/apps",
         "method" => "POST",
         "rel" => "create",
@@ -157,6 +158,9 @@ describe JsonSchema::Parser do
               "$ref" => "#/definitions/app/definitions/name"
             },
           }
+        },
+        "targetSchema" => {
+          "$ref" => "#/definitions/app"
         }
       ]
     )
@@ -164,6 +168,7 @@ describe JsonSchema::Parser do
     link = schema.links[0]
     assert_equal schema, link.parent
     assert_equal "Create a new app.", link.description
+    assert_equal "application/x-www-form-urlencoded", link.enc_type
     assert_equal "/apps", link.href
     assert_equal :post, link.method
     assert_equal "create", link.rel

data/test/json_schema/reference_expander_test.rb

@@ -116,6 +116,13 @@ describe JsonSchema::ReferenceExpander do
     assert_equal ["string"], schema.type
   end
 
+  it "will expand hyperschema link targetSchemas" do
+    expand
+    assert_equal [], errors
+    schema = @schema.properties["app"].links[0].target_schema.properties["name"]
+    assert_equal ["string"], schema.type
+  end
+
   it "will perform multiple passes to resolve all references" do
     pointer("#/properties").merge!(
       "app0" => { "$ref" => "#/properties/app1" },

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: json_schema
 version: !ruby/object:Gem::Version
-  version: 0.0.13
+  version: 0.0.14
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-22 00:00:00.000000000 Z
+date: 2014-05-23 00:00:00.000000000 Z
 dependencies: []
 description: 
 email:
@@ -21,7 +21,6 @@ extra_rdoc_files: []
 files:
 - README.md
 - bin/validate-schema
-- schemas/heroku-hyper-schema.json
 - schemas/hyper-schema.json
 - schemas/schema.json
 - lib/commands/validate_schema.rb

data/schemas/heroku-hyper-schema.json

@@ -1,96 +0,0 @@
-{
-    "$schema": "http://json-schema.org/draft-04/heroku-hyper-schema#",
-    "id": "http://json-schema.org/draft-04/heroku-hyper-schema#",
-    "title": "Heroku JSON Hyper-Schema",
-    "allOf": [
-        {
-            "$ref": "http://json-schema.org/draft-04/hyper-schema#"
-        }
-    ],
-    "definitions": {
-        "entity": {
-            "anyOf": [
-                {
-                    "$ref": "#/definitions/entityWithPatternProperties"
-                },
-                {
-                    "$ref": "#/definitions/entityWithProperties"
-                }
-            ]
-        },
-        "entityWithPatternProperties": {
-            "required": [
-                "definitions",
-                "description",
-                "id",
-                "links",
-                "patternProperties",
-                "title",
-                "type"
-            ]
-        },
-        "entityWithProperties": {
-            "properties": {
-                "definitions": {
-                    "additionalProperties": {
-                        "$ref": "#/definitions/property"
-                    },
-                    "properties": {
-                        "identity": {
-                            "$ref": "#/definitions/identity"
-                        }
-                    },
-                    "required": ["identity"]
-                }
-            },
-            "required": [
-                "definitions",
-                "description",
-                "id",
-                "links",
-                "properties",
-                "title",
-                "type"
-            ]
-        },
-        "identity": {
-            "additionalProperties": false,
-            "properties": {
-                "anyOf": {
-                    "additionalProperties": {
-                        "$ref": "#/definitions/ref"
-                    }
-                }
-            },
-            "required": ["anyOf"]
-        },
-        "property": {
-            "required": ["description", "type"]
-        },
-        "ref": {
-            "required": ["$ref"]
-        }
-    },
-    "properties": {
-        "definitions": {
-            "additionalProperties": {
-                "$ref": "#/definitions/entity"
-            }
-        },
-        "properties": {
-            "additionalProperties": {
-                "$ref": "#/definitions/ref"
-            }
-        }
-    },
-    "required": [
-        "$schema",
-        "definitions",
-        "description",
-        "id",
-        "links",
-        "properties",
-        "title",
-        "type"
-    ]
-}