JsonSchema::PowerValidator

Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file lib/json_schema_power_validator. To experiment with that code, run bin/console for an interactive prompt.

TODO: Delete this and the text above, and describe your gem

Installation

Add this line to your application's Gemfile:

gem 'json_schema_power_validator'

And then execute:

$ bundle

Or install it yourself as:

$ gem install json_schema_power_validator

Usage

{
    "id": "https://github.com/timakin/json_schema_power_validator/schema/sample.json",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "description": "Test schema for example",
    "definitions": {
        "positiveInt": {
            "type": "integer",
            "minimum": 0
        },
        "name": {
            "type": "string",
            "minimumLength": 4,
            "maximumLength": 12
        }
    },
    "type": "object",
    "properties": {
        "id": {
            "$ref": "#/definitions/positiveInt"
        },
        "username": {
            "$ref": "#/definitions/name"
        }
    }
}

{
    "id": "https://github.com/timakin/json_schema_power_validator/schema/suite/sample.json",
    "description": "Schema PowerValidator for example.json",
    "examples": [
        {
            "context": "Success",
            "description": "Success Case",
            "expect": "valid",
            "values": {
                "id": 1,
                "username": "timakin"
            }
        },
        { ... },
        {
            "context": "Fail",
            "description": "fail",
            "expect": "valid",
            "values": {
                "id": -100,
                "username": "tim"
            }
        }
    ]
}

require 'json_schema_power_validator'

validated_schema = JsonSchema::PowerValidator.new("schema/sample.json", "schema/suite/sample.json")
validated_schema.get_result
#{
#   "results": [
#       {
#           "context": "Success",
#           "description": "Success Case",
#           "result": "success"
#       },
#       { ... }
#       {
#           "context": "Fail",
#           "description": "fail"
#           "reason": "Invalid parameter: id should satisfy the condition minimumLength"
#       }
#   ]
#}

validated_schema.ok?
# false

Development

After checking out the repo, run bin/setup to install dependencies. Then, run bin/console for an interactive prompt that will allow you to experiment.

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 to create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

1. Fork it ( https://github.com/timakin/json_schema_power_validator/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request