prmd 0.3.2 → 0.4.0

data/schemas/schema.json

@@ -0,0 +1,150 @@
+{
+    "id": "http://json-schema.org/draft-04/schema#",
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "description": "Core schema meta-schema",
+    "definitions": {
+        "schemaArray": {
+            "type": "array",
+            "minItems": 1,
+            "items": { "$ref": "#" }
+        },
+        "positiveInteger": {
+            "type": "integer",
+            "minimum": 0
+        },
+        "positiveIntegerDefault0": {
+            "allOf": [ { "$ref": "#/definitions/positiveInteger" }, { "default": 0 } ]
+        },
+        "simpleTypes": {
+            "enum": [ "array", "boolean", "integer", "null", "number", "object", "string" ]
+        },
+        "stringArray": {
+            "type": "array",
+            "items": { "type": "string" },
+            "minItems": 1,
+            "uniqueItems": true
+        }
+    },
+    "type": "object",
+    "properties": {
+        "id": {
+            "type": "string",
+            "format": "uri"
+        },
+        "$schema": {
+            "type": "string",
+            "format": "uri"
+        },
+        "title": {
+            "type": "string"
+        },
+        "description": {
+            "type": "string"
+        },
+        "default": {},
+        "multipleOf": {
+            "type": "number",
+            "minimum": 0,
+            "exclusiveMinimum": true
+        },
+        "maximum": {
+            "type": "number"
+        },
+        "exclusiveMaximum": {
+            "type": "boolean",
+            "default": false
+        },
+        "minimum": {
+            "type": "number"
+        },
+        "exclusiveMinimum": {
+            "type": "boolean",
+            "default": false
+        },
+        "maxLength": { "$ref": "#/definitions/positiveInteger" },
+        "minLength": { "$ref": "#/definitions/positiveIntegerDefault0" },
+        "pattern": {
+            "type": "string",
+            "format": "regex"
+        },
+        "additionalItems": {
+            "anyOf": [
+                { "type": "boolean" },
+                { "$ref": "#" }
+            ],
+            "default": {}
+        },
+        "items": {
+            "anyOf": [
+                { "$ref": "#" },
+                { "$ref": "#/definitions/schemaArray" }
+            ],
+            "default": {}
+        },
+        "maxItems": { "$ref": "#/definitions/positiveInteger" },
+        "minItems": { "$ref": "#/definitions/positiveIntegerDefault0" },
+        "uniqueItems": {
+            "type": "boolean",
+            "default": false
+        },
+        "maxProperties": { "$ref": "#/definitions/positiveInteger" },
+        "minProperties": { "$ref": "#/definitions/positiveIntegerDefault0" },
+        "required": { "$ref": "#/definitions/stringArray" },
+        "additionalProperties": {
+            "anyOf": [
+                { "type": "boolean" },
+                { "$ref": "#" }
+            ],
+            "default": {}
+        },
+        "definitions": {
+            "type": "object",
+            "additionalProperties": { "$ref": "#" },
+            "default": {}
+        },
+        "properties": {
+            "type": "object",
+            "additionalProperties": { "$ref": "#" },
+            "default": {}
+        },
+        "patternProperties": {
+            "type": "object",
+            "additionalProperties": { "$ref": "#" },
+            "default": {}
+        },
+        "dependencies": {
+            "type": "object",
+            "additionalProperties": {
+                "anyOf": [
+                    { "$ref": "#" },
+                    { "$ref": "#/definitions/stringArray" }
+                ]
+            }
+        },
+        "enum": {
+            "type": "array",
+            "minItems": 1,
+            "uniqueItems": true
+        },
+        "type": {
+            "anyOf": [
+                { "$ref": "#/definitions/simpleTypes" },
+                {
+                    "type": "array",
+                    "items": { "$ref": "#/definitions/simpleTypes" },
+                    "minItems": 1,
+                    "uniqueItems": true
+                }
+            ]
+        },
+        "allOf": { "$ref": "#/definitions/schemaArray" },
+        "anyOf": { "$ref": "#/definitions/schemaArray" },
+        "oneOf": { "$ref": "#/definitions/schemaArray" },
+        "not": { "$ref": "#" }
+    },
+    "dependencies": {
+        "exclusiveMaximum": [ "maximum" ],
+        "exclusiveMinimum": [ "minimum" ]
+    },
+    "default": {}
+}

data/test/commands/verify_test.rb

@@ -0,0 +1,187 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'helpers'))
+
+require "json_pointer"
+
+class InteragentHyperSchemaVerifyTest < Minitest::Test
+  def test_verifies
+    assert_equal [], verify
+  end
+
+  #
+  # api (root)
+  #
+
+  def test_api_required
+    data.delete("title")
+    errors = verify
+    assert_equal 1, errors.count
+    assert_match %r{^#: }, errors[0]
+    assert_match %r{Missing required keys "title" in object}, errors[0]
+  end
+
+  def test_api_property_format
+    pointer("#/properties").merge!({
+      "app" => {}
+    })
+    errors = verify
+    assert_match %r{^#/properties/app: }, errors[0]
+    assert_match %r{Missing required keys "\$ref" in object}, errors[0]
+  end
+
+  #
+  # resource
+  #
+
+  def test_resource_required
+    pointer("#/definitions/app").delete("title")
+    errors = verify
+    assert_equal 1, errors.count
+    assert_match %r{^#/definitions/app: }, errors[0]
+    assert_match %r{Missing required keys "title" in object}, errors[0]
+  end
+
+  def test_resource_identity_format
+    pointer("#/definitions/app/definitions/identity").merge!({
+      "type" => "string"
+    })
+    errors = verify
+    assert_equal 1, errors.count
+    assert_match %r{^#/definitions/app/definitions/identity: }, errors[0]
+    assert_match %r{any subschema of "anyOf" condition.}, errors[0]
+  end
+
+  # an empty schema can be specified to bypass the identity check
+  def test_resource_identity_format_empty
+    pointer("#/definitions/app/definitions").merge!({
+      "identity" => {}
+    })
+    assert_equal [], verify
+  end
+
+  # "my-property" does match fit our regex of lowercase letters and underscores only
+  def test_resource_property_format
+    pointer("#/definitions/app/properties").merge!({
+      "my-property" => {}
+    })
+    errors = verify
+    assert_equal 1, errors.count
+    assert_match %r{^#/definitions/app/properties: }, errors[0]
+    assert_match %r{Extra keys in object: my-property}, errors[0]
+  end
+
+  def test_resource_strict_properties
+    pointer("#/definitions/app").merge!({
+      "strictProperties" => false
+    })
+    errors = verify
+    assert_equal 1, errors.count
+    assert_match %r{^#/definitions/app/strictProperties: }, errors[0]
+    assert_match %r{to be a member of enum \[true\], value was: false}, errors[0]
+  end
+
+  #
+  # resource definition
+  #
+
+  def test_resource_definition_no_links
+    pointer("#/definitions/app/definitions/name").merge!({
+      "links" => []
+    })
+    errors = verify
+    assert_equal 1, errors.count
+    assert_match %r{^#/definitions/app/definitions/name: }, errors[0]
+    assert_match %r{Data matched subschema of "not" condition}, errors[0]
+  end
+
+  def test_resource_definition_required
+    pointer("#/definitions/app/definitions/name").delete("description")
+    errors = verify
+    assert_equal 1, errors.count
+    assert_match %r{^#/definitions/app/definitions/name: }, errors[0]
+    assert_match %r{Missing required keys "description" in object}, errors[0]
+  end
+
+  #
+  # resource link
+  #
+
+  def test_resource_link_href_format
+    pointer("#/definitions/app/links/0").merge!({
+      "href" => "/my_apps"
+    })
+    errors = verify
+    assert_equal 1, errors.count
+    assert_match %r{^#/definitions/app/links/0/href: }, errors[0]
+    assert_match %r{Expected string to match pattern}, errors[0]
+  end
+
+  def test_resource_link_required
+    pointer("#/definitions/app/links/0").delete("method")
+    errors = verify
+    assert_equal 1, errors.count
+    assert_match %r{^#/definitions/app/links/0: }, errors[0]
+    assert_match %r{Missing required keys "method" in object}, errors[0]
+  end
+
+  private
+
+  def data
+    @data ||= {
+      "$schema"     => "http://interagent.github.io/interagent-hyper-schema",
+      "description" => "My simple example API.",
+      "id"          => "http://example.com/schema",
+      "title"       => "Example API",
+      "definitions" => {
+        "app" => {
+          "description" => "An app in our PaaS ecosystem.",
+          "title" => "App",
+          "type" => "object",
+          "definitions" => {
+            "identity" => {
+              "anyOf" => [
+                {
+                  "$ref" => "#/definitions/app/definitions/name"
+                }
+              ]
+            },
+            "name" => {
+              "description" => "The app's name.",
+              "type"        => "string"
+            }
+          },
+          "links" => [
+            {
+              "description" => "Create a new app.",
+              "href" => "/apps",
+              "method" => "POST",
+              "rel" => "create",
+              "title" => "Create App"
+            }
+          ],
+          "properties" => {
+          }
+        }
+      },
+      "links" => [
+        {
+          "href" => "https://example.com",
+          "rel" => "self"
+        }
+      ],
+      "properties" => {
+        "app" => {
+          "$ref" => "#/definitions/app"
+        }
+      },
+      "type" => "object"
+    }
+  end
+
+  def pointer(path)
+    JsonPointer.evaluate(data, path)
+  end
+
+  def verify
+    Prmd.verify(data)
+  end
+end

data/test/helpers.rb

@@ -1,3 +1,4 @@
+require "minitest"
 require "minitest/autorun"
 require "prmd"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prmd
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - geemus
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-22 00:00:00.000000000 Z
+date: 2014-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erubis
@@ -24,6 +24,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: json_schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -92,11 +106,19 @@ files:
 - lib/prmd/commands/render.rb
 - lib/prmd/commands/verify.rb
 - lib/prmd/schema.rb
+- lib/prmd/template.rb
 - lib/prmd/templates/link_schema_properties.erb
 - lib/prmd/templates/schema.erb
 - lib/prmd/templates/schemata.erb
+- lib/prmd/templates/schemata/helper.erb
+- lib/prmd/templates/schemata/link.erb
+- lib/prmd/templates/schemata/link_curl_example.erb
 - lib/prmd/version.rb
 - prmd.gemspec
+- schemas/hyper-schema.json
+- schemas/interagent-hyper-schema.json
+- schemas/schema.json
+- test/commands/verify_test.rb
 - test/helpers.rb
 - test/schema_test.rb
 - test/schemata/input/meta.json
@@ -126,6 +148,7 @@ signing_key:
 specification_version: 4
 summary: JSON Schema tooling
 test_files:
+- test/commands/verify_test.rb
 - test/helpers.rb
 - test/schema_test.rb
 - test/schemata/input/meta.json