json_schema_validator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2947d38d89812315d76877ad1029245ba4538476
+  data.tar.gz: 48f564c42e4c67e9de81ad93fd4d9510157e9a7e
+SHA512:
+  metadata.gz: 5c57cf69a540fa51ac2e2eb1345c84f7c91a0c7b54c1461648c460fa724040435d9bcfb2188a428ce85618edb69213daa874f795ec912d3cabc9fa37ff873c28
+  data.tar.gz: 6ec318030a2695311fc3075379fe69b7bd8e3df0ca47667c24d3cdfa0a629fa5e4759bf9692259c9b768b3d364e77591d9a5cb99f9e072bed0a456d0813c081a

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.4

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+# Specify your gem's dependencies in json_schema_validator.gemspec
+gemspec

data/README.md

@@ -0,0 +1,69 @@
+# JsonSchemaValidator
+
+This gem provides methods to run a schema, through any available Schema 
+Validators for Ruby.
+
+They should be valid according to draft-4 ...
+
+The schema validators currently being considered are:
+
+* https://github.com/ruby-json-schema/json-schema
+* https://github.com/brandur/json_schema (note the underscore!)
+* https://github.com/Soylent/jschema
+
+These are the three currently available ruby validators that support draft-4. (According to json-schema.org).
+
+Each validator gem has its quirks, we'll try to:
+
+* use each to validate a schema against the json-schema meta-schema
+* try to load each given schema as a schema for validation.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'json_schema_validator'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install json_schema_validator
+
+## Usage
+
+In your tests you can validate your schemas against the meta-schema with: 
+
+```ruby
+schema_path = /path/to/my/schemas
+errors = JsonSchemaValidator.validate_schemas(schema_path)
+# each schema validator adds his own error message
+errors.each do |name, error|
+  expect(error).to be_empty
+end
+```
+
+## TODO
+
+Not perfect yet, since it was extracted from the gem fidor_schema. For now you 
+need to read the code to find out about the detailed usage.
+
+* improve log output / handling
+* HowTO on validate data against the schema-draft v4 meta schema
+* add tests
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` to run the tests. 
+
+To install this gem onto your local machine, run `bundle exec rake install`. 
+To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/fidor/json_schema_validator
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "json_schema_validator"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/json_schema_validator.gemspec

@@ -0,0 +1,41 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'json_schema_validator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "json_schema_validator"
+  spec.version       = JsonSchemaValidator::VERSION
+  spec.authors       = ["Georg Leciejewski, Tim Becker"]
+  spec.email         = ["leciejewski@fidor.de"]
+
+  spec.summary       = %q{Helper methods to validate json schemata against the core meta schema.}
+  spec.description   = %q{Uses three different ruby schema gems to be as precise as possible}
+  spec.homepage      = "https://github.com/fidor/json_schema_validator"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+
+  #The different ruby schema gems
+
+  # most downloads on rubygems, last updated feb 2015
+  spec.add_dependency 'json-schema'
+  # 2nd most downloads on rubygems, last updated March 2015
+  spec.add_dependency 'json_schema'
+  # pretty new , last udpate sep 2014
+  spec.add_dependency 'jschema'
+end

data/lib/json_schema_validator.rb

@@ -0,0 +1,44 @@
+require "json_schema_validator/version"
+require 'json_schema_validator/base'
+require 'json_schema_validator/json-schema'
+require 'json_schema_validator/json_schema'
+require 'json_schema_validator/j_schema'
+
+module JsonSchemaValidator
+
+  # @param [String] path to schema files
+  def self.validate_schemas(schema_path, validators=nil)
+    res = {}
+    available_validators =  [Json_Schema, JsonSchema, JSchema]
+    validators ||= available_validators
+    files = Dir.glob("#{schema_path}/**/*.json")
+    validators.each do |validator|
+      i = validator.new files
+      i.validate_schemas
+      res[validator.to_s] = i.errors unless i.errors.empty?
+    end
+    res
+  end
+
+  # @param [Symbol] validator to use
+  def self.run(schema_path, validators=nil)
+    res = {}
+    available_validators =  [:underscore, :dash, :jschema]
+    validators ||= available_validators
+    files = Dir.glob("#{schema_path}/**/*.json")
+    validators.each do |validator|
+      case validator
+        when :underscore
+          res[validator] = Json_Schema.run files
+        when :dash
+          res[validator] = JsonSchema.run files
+        when :jschema
+          res[validator] = JSchema.run files
+        else
+          puts "Unknown validator: #{validator}"
+      end
+    end
+    res
+  end
+
+end

data/lib/json_schema_validator/base.rb

@@ -0,0 +1,80 @@
+# This functionality is intended to run the schema, through
+# any available Schema Validators for Ruby.
+#
+# They should be valid according to draft-4 ...
+#
+# The schema validators currently being considered are:
+#
+# https://github.com/ruby-json-schema/json-schema
+# https://github.com/brandur/json_schema (note the underscore!)
+# https://github.com/Soylent/jschema
+#
+# These are the three currently available ruby validators that
+# support draft-4. (According to json-schema.org).
+#
+# Each has their quirks, we'll try to:
+#    * use each to validate each given schema against the json-schema meta-schema
+#    * try to load each given schema as a schema for validation.
+#
+require 'pathname'
+
+module JsonSchemaValidator
+  class Base
+    # @return [Array<String>] file paths
+    attr_accessor :files_to_validate
+
+    # Run the given validator with all schema files
+    def self.run(files)
+      v = new(files)
+      v.log << "Running validation with #{name} for #{files.length} schemas"
+      v.validate_all
+      v
+    end
+
+    def validate_all
+      validate_schemas
+      validate_data
+    end
+
+    def validate_schemas
+      files_to_validate.each do |file|
+        schema = File.read file
+        log << "validate schema: #{file}"
+        validate schema
+      end
+    end
+
+    def validate_data
+      files_to_validate.each do |file|
+        schema = File.read file
+        log << "validate data against: #{file}"
+        use_for_validation schema
+      end
+    end
+
+    # Joins the logs before display
+    def log_fmt
+      res = []
+      if errors.length > 0
+        res << "#{errors.join("\n\n")}"
+        res << "="*50
+        res << "#{errors.length} with errors"
+      end
+      res << "#{success.uniq.length} Schemas passed"
+      res.join("\n")
+    end
+    # @return [Array<String>] error schemas
+    def errors
+      @errors ||= []
+    end
+    # @return [Array<String>] test log
+    def log
+      @log ||= []
+    end
+    # @return [Array<String>] successfull schema titles
+    def success
+      @success ||= []
+    end
+
+  end
+end

data/lib/json_schema_validator/j_schema.rb

@@ -0,0 +1,34 @@
+require 'jschema'
+module JsonSchemaValidator
+  class JSchema < Base
+
+    def initialize(files_to_validate)
+      @files_to_validate = files_to_validate
+      schema_data = File.read("#{File.dirname(__FILE__)}/schema.json")
+      schema_json = JSON.parse(schema_data)
+      @meta_schema = ::JSchema.build(schema_json)
+    end
+
+    def validate(schema)
+      schema_to_test = JSON.parse(schema)
+      result = @meta_schema.validate schema_to_test
+      if !result || result.length == 0
+        success << schema_to_test['title'] || schema_to_test.keys[0]
+      else
+        errors << "Schema validation failed: #{schema_to_test['title']}\n#{result.join("\n")}"
+      end
+    end
+
+    def use_for_validation(schema)
+      schema_to_test = JSON.parse(schema)
+      begin
+       ::JSchema.build(schema_to_test)
+      rescue
+        errors << "Data validation failed: #{schema_to_test['title']}\n#{$!}"
+        # puts $!.backtrace
+      else
+        success << schema_to_test['title'] || schema_to_test.keys[0]
+      end
+    end
+  end
+end

data/lib/json_schema_validator/json-schema.rb

@@ -0,0 +1,51 @@
+require 'json-schema'
+# https://github.com/ruby-json-schema/json-schema
+module JsonSchemaValidator
+  class JsonSchema < Base
+    def initialize(files_to_validate)
+      @files_to_validate = files_to_validate
+      @meta_schema_path  = "#{File.dirname(__FILE__)}/schema.json"
+
+      # need to know the base dir of the schema to resolve relative uris.
+      # see below.
+      @schemadir = File.dirname(@files_to_validate[0])
+    end
+
+    # @param [String] schema to test against the meta schema
+    def validate(schema)
+      schema_to_test = JSON.parse(schema)
+      begin
+        result = JSON::Validator.fully_validate(@meta_schema_path, schema_to_test)
+        if !result || result.length == 0
+          success << schema_to_test['title'] || schema_to_test.keys[0]
+        else
+          errors << "Schema validation failed: #{schema_to_test['title']}\n#{result.join("\n")}"
+        end
+      rescue => e
+        errors << "Schema validation failed: #{schema_to_test['title']}\n#{e}"
+        # puts e.backtrace
+      end
+    end
+
+    def use_for_validation(schema)
+      schema_to_test = JSON.parse(schema)
+
+      # json-schema resolves relatives path relative to it's own "."
+      # not relative to the file containing the reference ...
+      base_dir = Dir.pwd
+
+      begin
+        Dir.chdir @schemadir
+        data = {}
+        result = JSON::Validator.fully_validate(schema_to_test, data)
+        if !result || result.length == 0
+          success << schema_to_test['title']
+        else
+          errors << "Data validation failed: #{schema_to_test['title']}\n#{result.join("\n")}"
+        end
+      ensure
+        Dir.chdir base_dir
+      end
+    end
+  end
+end

data/lib/json_schema_validator/json_schema.rb

@@ -0,0 +1,37 @@
+require 'json_schema'
+module JsonSchemaValidator
+  class Json_Schema < Base
+
+    def initialize(files_to_validate)
+      @files_to_validate = files_to_validate
+      schema_data = File.read("#{File.dirname(__FILE__)}/schema.json")
+      schema_json = JSON.parse(schema_data)
+      @schema = ::JsonSchema.parse!(schema_json)
+      @errors, @success = [], []
+    end
+
+    # @param [String] schema to test against the meta schema
+    def validate(schema)
+      schema_to_test = JSON.parse(schema)
+      begin
+        @schema.validate! schema_to_test
+      rescue
+        errors << "Schema validation failed: #{schema_to_test['title']}\n#{$!}"
+      else
+        success << File.basename(schema)
+      end
+    end
+
+    def use_for_validation(schema)
+       schema_to_test = JSON.parse(schema)
+      begin
+       ::JsonSchema.parse!(schema_to_test)
+      rescue
+        errors << "Data validation failed: #{schema_to_test['title']}\n#{$!}"
+      else
+        success << schema_to_test['title']
+      end
+    end
+
+  end
+end

data/lib/json_schema_validator/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/lib/json_schema_validator/version.rb

@@ -0,0 +1,3 @@
+module JsonSchemaValidator
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: json_schema_validator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Georg Leciejewski, Tim Becker
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-12-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json-schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json_schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jschema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Uses three different ruby schema gems to be as precise as possible
+email:
+- leciejewski@fidor.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- json_schema_validator.gemspec
+- lib/json_schema_validator.rb
+- lib/json_schema_validator/base.rb
+- lib/json_schema_validator/j_schema.rb
+- lib/json_schema_validator/json-schema.rb
+- lib/json_schema_validator/json_schema.rb
+- lib/json_schema_validator/schema.json
+- lib/json_schema_validator/version.rb
+homepage: https://github.com/fidor/json_schema_validator
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Helper methods to validate json schemata against the core meta schema.
+test_files: []