apivore 1.2.0 → 1.3.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZTY5MzQ3OWRhNjY2OWE2ZTA2MDQyZTNmODFlY2UzYzJmYjcwNWNkNQ==
+    MjNiMDNhZmRhOTE1Mzc3NTMxZDYwOTU4OThhODlmMTIxYzBjYTViYg==
   data.tar.gz: !binary |-
-    YjY3NmI1NjJkYTI4YWRmMDAwNzY5NjkyNDkxM2YzMmZiZTU1ZWE2Mg==
+    MDFlZmRlZjMwOWI4ZWFkZGI3YmRmYzYxZWE1ZjdmZWUwNTY2MDFkOA==
 SHA512:
   metadata.gz: !binary |-
-    YzNjZTE0OGUxZjE0NDRlMDdiYjViMzUwY2ViMWE1MDQ4YmNjMWZmNDhlODBk
-    ZDE5NjIzNDMzZjQyZWIzNDIwMWEyNjNhYWEwYjkxNWU5N2MzZDA3MmEyNmY3
-    ZjllNWU3ODdkZjhlMDE2ZjZiZDFjNTk2NGVkN2Q0NDVjNjMyZjU=
+    MTNmOGNkNTYxYzUzZjUxMmY5MDZiZDI4ZDZlNmY5N2VlY2I3YWQwODFhMTkw
+    YzVmZjQ4ODljNTdlZjZiZTJkZmRjNjhiZDY0MGUxOGE0ZTZhNWU2MWI4NDI0
+    YzYyMWU3MGNhNWE1NWU3MDljMjliYzU4MzBhZDRkNDJkYWI2MmI=
   data.tar.gz: !binary |-
-    NDMzZWJmMWM3MGUwMjQyN2UxZjlhZGExMDM1ZWUxYTg4ZmIxOGUyYzljODQ5
-    YjcyMmU3Nzk2NTY5ZDc3ZTE2ODcxOTUxN2NmMDc2ODhjZTRiNTAyZDdhZGM2
-    YWU5NjMxNzZjODQ5Y2Q4NDViZDQ4OWUyZjBkMzUzN2ExN2JlMzg=
+    YTExN2IzN2Q0NWIyNDBhZjRlZjljOTI4Y2QxNWIwNWY5OWQxYTA1NDA1NzA1
+    ZGM0MDA5MjI4MzkxZjE4NzU3ZGMyZWVmNTIzNjI3N2RmNmY2MWEzNzBiMjIw
+    NjVlMmQ5MzY1ZDdkNWZiOWRmYzlkODNhZGUxY2ZjYTEyNGViNTI=

data/data/custom_schemata/westfield_api_standards.json

@@ -0,0 +1,26 @@
+{
+  "title": "Westfield API Standards",
+
+  "type": "object",
+  "properties": {
+    "definitions": {
+      "description": "All entities defined in the 'definitions' section must include an explicit 'type: object' attribute. This forces the entity to be validated.",
+      "type": "object",
+      "additionalProperties": {
+        "$ref": "#/definitions/schemaObject"
+      }
+    }
+  },
+  "definitions": {
+    "schemaObject": {
+      "type": "object",
+      "required": [ "type" ],
+      "properties": {
+        "type": {
+          "type": "string",
+          "enum": [ "object" ]
+        }
+      }
+    }
+  }
+}

data/data/swagger_2.0_schema.json

@@ -27,9 +27,8 @@
     },
     "host": {
       "type": "string",
-      "format": "uri",
       "pattern": "^[^{}/ :\\\\]+(?::\\d+)?$",
-      "description": "The fully qualified URI to the host of the API."
+      "description": "The host (name or ip) of the API. Example: 'swagger.io'"
     },
     "basePath": {
       "type": "string",
@@ -101,7 +100,7 @@
         },
         "description": {
           "type": "string",
-          "description": "A longer description of the API. Should be different from the title.  Github-flavored markdown is allowed."
+          "description": "A longer description of the API. Should be different from the title.  GitHub Flavored Markdown is allowed."
         },
         "termsOfService": {
           "type": "string",
@@ -134,6 +133,11 @@
           "description": "The email address of the contact person/organization.",
           "format": "email"
         }
+      },
+      "patternProperties": {
+        "^x-": {
+          "$ref": "#/definitions/vendorExtension"
+        }
       }
     },
     "license": {
@@ -152,6 +156,11 @@
           "description": "The URL pointing to the license.",
           "format": "uri"
         }
+      },
+      "patternProperties": {
+        "^x-": {
+          "$ref": "#/definitions/vendorExtension"
+        }
       }
     },
     "paths": {
@@ -203,14 +212,16 @@
           "type": "string",
           "format": "uri"
         }
+      },
+      "patternProperties": {
+        "^x-": {
+          "$ref": "#/definitions/vendorExtension"
+        }
       }
     },
     "examples": {
       "type": "object",
-      "patternProperties": {
-        "^[a-z0-9-]+/[a-z0-9\\-+]+$": {}
-      },
-      "additionalProperties": false
+      "additionalProperties": true
     },
     "mimeType": {
       "type": "string",
@@ -241,14 +252,14 @@
         },
         "description": {
           "type": "string",
-          "description": "A longer description of the operation, github-flavored markdown is allowed."
+          "description": "A longer description of the operation, GitHub Flavored Markdown is allowed."
         },
         "externalDocs": {
           "$ref": "#/definitions/externalDocs"
         },
         "operationId": {
           "type": "string",
-          "description": "A friendly name of the operation"
+          "description": "A unique identifier of the operation."
         },
         "produces": {
           "description": "A list of MIME types the API can produce.",
@@ -357,7 +368,14 @@
           "type": "string"
         },
         "schema": {
-          "$ref": "#/definitions/schema"
+          "oneOf": [
+            {
+              "$ref": "#/definitions/schema"
+            },
+            {
+              "$ref": "#/definitions/fileSchema"
+            }
+          ]
         },
         "headers": {
           "$ref": "#/definitions/headers"
@@ -366,7 +384,12 @@
           "$ref": "#/definitions/examples"
         }
       },
-      "additionalProperties": false
+      "additionalProperties": false,
+      "patternProperties": {
+        "^x-": {
+          "$ref": "#/definitions/vendorExtension"
+        }
+      }
     },
     "headers": {
       "type": "object",
@@ -442,6 +465,11 @@
         "description": {
           "type": "string"
         }
+      },
+      "patternProperties": {
+        "^x-": {
+          "$ref": "#/definitions/vendorExtension"
+        }
       }
     },
     "vendorExtension": {
@@ -464,7 +492,7 @@
       "properties": {
         "description": {
           "type": "string",
-          "description": "A brief description of the parameter. This could contain examples of use.  Github-flavored markdown is allowed."
+          "description": "A brief description of the parameter. This could contain examples of use.  GitHub Flavored Markdown is allowed."
         },
         "name": {
           "type": "string",
@@ -510,7 +538,7 @@
         },
         "description": {
           "type": "string",
-          "description": "A brief description of the parameter. This could contain examples of use.  Github-flavored markdown is allowed."
+          "description": "A brief description of the parameter. This could contain examples of use.  GitHub Flavored Markdown is allowed."
         },
         "name": {
           "type": "string",
@@ -598,7 +626,7 @@
         },
         "description": {
           "type": "string",
-          "description": "A brief description of the parameter. This could contain examples of use.  Github-flavored markdown is allowed."
+          "description": "A brief description of the parameter. This could contain examples of use.  GitHub Flavored Markdown is allowed."
         },
         "name": {
           "type": "string",
@@ -691,7 +719,7 @@
         },
         "description": {
           "type": "string",
-          "description": "A brief description of the parameter. This could contain examples of use.  Github-flavored markdown is allowed."
+          "description": "A brief description of the parameter. This could contain examples of use.  GitHub Flavored Markdown is allowed."
         },
         "name": {
           "type": "string",
@@ -770,6 +798,9 @@
           "$ref": "#/definitions/vendorExtension"
         }
       },
+      "required": [
+        "required"
+      ],
       "properties": {
         "required": {
           "type": "boolean",
@@ -787,7 +818,7 @@
         },
         "description": {
           "type": "string",
-          "description": "A brief description of the parameter. This could contain examples of use.  Github-flavored markdown is allowed."
+          "description": "A brief description of the parameter. This could contain examples of use.  GitHub Flavored Markdown is allowed."
         },
         "name": {
           "type": "string",
@@ -955,7 +986,15 @@
           "$ref": "http://json-schema.org/draft-04/schema#/properties/enum"
         },
         "additionalProperties": {
-          "$ref": "http://json-schema.org/draft-04/schema#/properties/additionalProperties"
+          "anyOf": [
+            {
+              "$ref": "#/definitions/schema"
+            },
+            {
+              "type": "boolean"
+            }
+          ],
+          "default": {}
         },
         "type": {
           "$ref": "http://json-schema.org/draft-04/schema#/properties/type"
@@ -1006,6 +1045,47 @@
       },
       "additionalProperties": false
     },
+    "fileSchema": {
+      "type": "object",
+      "description": "A deterministic version of a JSON Schema object.",
+      "patternProperties": {
+        "^x-": {
+          "$ref": "#/definitions/vendorExtension"
+        }
+      },
+      "properties": {
+        "format": {
+          "type": "string"
+        },
+        "title": {
+          "$ref": "http://json-schema.org/draft-04/schema#/properties/title"
+        },
+        "description": {
+          "$ref": "http://json-schema.org/draft-04/schema#/properties/description"
+        },
+        "default": {
+          "$ref": "http://json-schema.org/draft-04/schema#/properties/default"
+        },
+        "required": {
+          "$ref": "http://json-schema.org/draft-04/schema#/definitions/stringArray"
+        },
+        "type": {
+          "type": "string",
+          "enum": [
+            "file"
+          ]
+        },
+        "readOnly": {
+          "type": "boolean",
+          "default": false
+        },
+        "externalDocs": {
+          "$ref": "#/definitions/externalDocs"
+        },
+        "example": {}
+      },
+      "additionalProperties": false
+    },
     "primitivesItems": {
       "type": "object",
       "additionalProperties": false,
@@ -1068,6 +1148,11 @@
         "multipleOf": {
           "$ref": "#/definitions/multipleOf"
         }
+      },
+      "patternProperties": {
+        "^x-": {
+          "$ref": "#/definitions/vendorExtension"
+        }
       }
     },
     "security": {
@@ -1108,6 +1193,11 @@
           "type": "boolean",
           "default": false
         }
+      },
+      "patternProperties": {
+        "^x-": {
+          "$ref": "#/definitions/vendorExtension"
+        }
       }
     },
     "tag": {
@@ -1484,6 +1574,9 @@
     },
     "jsonReference": {
       "type": "object",
+      "required": [
+        "$ref"
+      ],
       "additionalProperties": false,
       "properties": {
         "$ref": {

data/lib/apivore/custom_schema_validator.rb

@@ -0,0 +1,23 @@
+module Apivore
+  class CustomSchemaValidator
+    # This constant is an example custom schema included with the gem
+    WF_SCHEMA = File.expand_path("../../data/custom_schemata/westfield_api_standards.json", File.dirname(__FILE__))
+
+    def initialize(custom_schema)
+      @schema = custom_schema
+    end
+
+    def matches?(swagger_checker)
+      @results = JSON::Validator.fully_validate(@schema, swagger_checker.swagger)
+      @results.empty?
+    end
+
+    def description
+      "additionally conforms to #{@schema}"
+    end
+
+    def failure_message
+      @results.join("\n")
+    end
+  end
+end

data/lib/apivore/rspec_helpers.rb

@@ -1,5 +1,6 @@
 require 'apivore/validator'
 require 'apivore/all_routes_tested_validator'
+require 'apivore/custom_schema_validator'
 
 module Apivore
   module RspecHelpers
@@ -7,6 +8,10 @@ module Apivore
       Validator.new(method, path, response_code, params)
     end
 
+    def conform_to(custom_schema)
+      CustomSchemaValidator.new(custom_schema)
+    end
+
     def validate_all_paths
       AllRoutesTestedValidator.new
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apivore
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Charles Horn
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-20 00:00:00.000000000 Z
+date: 2015-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json-schema
@@ -157,10 +157,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- data/custom_schemata/westfield_api_standards.json
 - data/draft04_schema.json
 - data/swagger_2.0_schema.json
 - lib/apivore.rb
 - lib/apivore/all_routes_tested_validator.rb
+- lib/apivore/custom_schema_validator.rb
 - lib/apivore/fragment.rb
 - lib/apivore/rspec_helpers.rb
 - lib/apivore/rspec_matchers.rb