json_validate 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 41f7781180656471a8e9be351a577bc223f24b06
+  data.tar.gz: bc42cdbbc1d98671dc3f4138d8b4a37136f33f51
+SHA512:
+  metadata.gz: 37fe6b85028fd6dcb3a1ad05dfef180754474b71962486a27ee56a95103287784e5dcf8636689df5613ea69588910e37f7d15639d91d46eb90956e6acc1ebcc2
+  data.tar.gz: dc7b4a903cb744288207373c3d11cb3da3a5da23e1446fa7c2f782258c28119fdf6199b73848b38bc2157c4360d223b6aef0d25687353d79fdeeb0474a9b7efc

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.0.0

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Tomoyuki Morita
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,53 @@
+# JSONValidate
+
+This gem offers very simple way to validate parsed JSON object.
+Suppose your program expect an input JSON as below.
+
+```json
+    {
+      "id": 100,
+      "title": "Some title",
+      "tags": ["funny", "cute"]
+    }
+```
+
+It can be validated by the following code.
+
+```ruby
+    # assume json_str contains the JSON input
+    object = JSON.parse(json_str)
+    object.validate( {id: Fixnum, title: String, tags: [String]} )
+```
+
+If the JSON doesn't have designated structure, validate method raise a ValidationError.
+
+```ruby
+    object = JSON.parse('{"hoge": 1}')
+    object.validate( {id:Fixnum} ) # => raise ValidationError
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'json_validate'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install json_validate
+
+## Usage
+
+
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

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

data/json_validate.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'json_validate/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "json_validate"
+  spec.version       = JSONValidate::VERSION
+  spec.authors       = ["Tomoyuki Morita"]
+  spec.email         = ["ykmr1224@gmail.com"]
+  spec.description   = %q{Offers simple way to validate JSON object having expected structure.}
+  spec.summary       = %q{Offers simple way to validate JSON object having expected structure.}
+  spec.homepage      = "https://github.com/ykmr1224/json_validate"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/json_validate.rb

@@ -0,0 +1,92 @@
+require "json_validate/version"
+
+module JSONValidate
+  class ValidationError < RuntimeError
+  end
+
+  def self.pathstr(path)
+    "/"+path.join("/")
+  end
+
+  # Validate each elements of a hash by the validator.
+  def self.validateHash(hash, validator, path=[])
+      raise ValidationError.new(pathstr(path) + " : Expected to be a Hash.") unless hash.kind_of? Hash
+      validator.each do |key, value|
+        raise ValidationError.new(pathstr(path) + " : Key '#{key}' is expected to be exists.") unless hash.include? key.to_s
+        path.push(key.to_s)
+        validate(hash[key.to_s], value, path)
+        path.pop
+      end
+  end
+
+  # Validate each elements of an array by the first element of validator(validator[0])
+  # This expects validator is an array containing only one element. Other than the first element will be ignored
+  def self.validateArray(array, validator, path=[])
+    raise ValidationError.new(pathstr(path) + " : Expected to be an Array.") unless array.kind_of? Array
+    parent = path.pop || "" # to make the path like "/hoge/foo/parent[1]""
+    array.each_index do |i|
+      path.push(parent+"[#{i}]")
+      validate(array[i], validator[0], path)
+      path.pop
+    end
+    path.push parent
+  end
+
+  # Validate the parsed JSON object with the validator
+  # validator can be a hash or an array
+  #  e.g. {id: Fixnum, subject: String, message: String, receipients: [{email: String, name: String}]}
+  #  e.g. [String]
+  # This throws a ValidationError if the validation failed.
+  # If a block is given, validator is ignored and the block is evaluated as the validator to be used
+  def self.validate(json, validator=nil, path=[], &block)
+    return validate(json, JSONValidate.instance_eval(&block), path) if block_given?
+
+    case validator
+    when Hash # validate each pair of the hash
+      validateHash(json, validator, path)
+    when Array # validate each elements of the array
+      validateArray(json, validator, path)
+    when Class # validate the type of the value
+      raise ValidationError.new(pathstr(path)) unless json.kind_of? validator
+    when CustomValidator
+      raise ValidationError.new(pathstr(path)) unless validator.validate(json)
+    when Regexp
+      raise ValidationError.new(pathstr(path)) unless validator =~ json
+    when nil
+      raise ValidationError.new(pathstr(path)) unless json.nil?
+    else
+      raise ValidationError.new("Validator is expected to be Hash, Array, or Class.")
+    end
+  end
+
+  class CustomValidator
+    def validate(json, path=[]); false; end
+    def message; ""; end
+  end
+
+private
+
+  class BooleanValidator < CustomValidator
+    def validate(json, path=[])
+      json.kind_of?(TrueClass) || json.kind_of?(FalseClass)
+    end
+  end
+
+  def self.boolean
+    BooleanValidator.new
+  end
+
+end
+
+class Hash
+  def validate(&block)
+    JSONValidate.validate(self, &block)
+  end
+end
+
+class Array
+  def validate(&block)
+    JSONValidate.validate(self, &block)
+  end
+end
+

data/lib/json_validate/version.rb

@@ -0,0 +1,3 @@
+module JSONValidate
+  VERSION = "0.0.1"
+end

data/spec/json_validate_spec.rb

@@ -0,0 +1,105 @@
+require 'spec_helper'
+require 'json'
+
+# define an utility metod
+class Array
+   def except(*value)
+     self - value
+   end
+end
+
+describe JSONValidate do
+  it 'should have a version number' do
+    expect(JSONValidate::VERSION).not_to be_nil
+  end
+
+  describe "#validate" do
+    it 'should not raise error for valid object types' do
+      json = JSON.parse('{"a":1, "b":"hoge", "c":{"c1":1}, "d":[1,2,3], "e":true, "f":false, "g":null}')
+      expect{
+        JSONValidate.validate(json, {a: Fixnum, b: String, c: Hash, d: Array, e: TrueClass, f: FalseClass, g: NilClass })
+      }.not_to raise_error
+    end
+
+    # examples for type unmatch
+    types = [Fixnum, String, Hash, Array, TrueClass, FalseClass, NilClass]
+    sample_values = {
+      '1' => Fixnum,
+      '"hoge"' => String,
+      '{"c1":1}' => Hash,
+      '[1,2,3]' => Array,
+      'true' => TrueClass,
+      'false' => FalseClass,
+      'null' => NilClass}
+    sample_values.each do |value, type|
+      json = JSON.parse('{"a":'+value+'}')
+      types.except(type).each do |wrong_type|
+        it "should raise error for #{value} if #{wrong_type} is the expected type" do
+          expect{ JSONValidate.validate(json, {a: wrong_type}) }.to raise_error
+        end
+      end
+    end
+
+    it "should raise error for missing variable" do
+      json = JSON.parse('{"a": "hoge"}')
+      expect{ JSONValidate.validate(json, {a: String, b: String}) }.to raise_error
+    end
+
+    it "should handle nested hash properly" do
+      json = JSON.parse('{"a": {"b": "hoge", "c": {"d": "foo"}}, "e": "bar"}')
+      expect{ JSONValidate.validate(json, {a: {b: String, c: {d: String}}, e: String}) }.not_to raise_error
+      expect{ JSONValidate.validate(json, {a: {b: String, c: {d: Fixnum}}, e: String}) }.to raise_error
+    end
+
+    it "should validate all items in array" do
+      json = JSON.parse('["a", "b", "c", "d"]')
+      expect{ JSONValidate.validate(json, [String]) }.not_to raise_error
+      expect{ JSONValidate.validate(json, [Fixnum]) }.to raise_error
+
+      json = JSON.parse('["a", "b", "c", 1]')
+      expect{ JSONValidate.validate(json, [String]) }.to raise_error(JSONValidate::ValidationError, /\/\[3\]/)
+
+      json = JSON.parse('[{"a": 1, "b": "hoge"}, {"a": 2, "b": "foo"}]')
+      expect{ JSONValidate.validate(json, [{a: Fixnum, b: String}]) }.not_to raise_error
+
+      json = JSON.parse('[{"a": 1, "b": "hoge"}, {"a": 2, "b": 3}]')
+      expect{ JSONValidate.validate(json, [{a: Fixnum, b: String}]) }.to raise_error(JSONValidate::ValidationError, /\/\[1\]\/b/)
+
+      json = JSON.parse('[{"a": 1, "b": "hoge"}, {"a": 2, "b": "foo"}, {"a": 3}]')
+      expect{ JSONValidate.validate(json, [{a: Fixnum, b: String}]) }.to raise_error(JSONValidate::ValidationError, /\/\[2\]/)
+    end
+
+    it "should validate string by Regexp" do
+      json = JSON.parse('["abc", "aa", "b", "cccc"]')
+      expect{ JSONValidate.validate(json, [/[abc]+/])}.not_to raise_error
+
+      json = JSON.parse('["abc", "AA", "b", "cccc"]')
+      expect{ JSONValidate.validate(json, [/[abc]+/])}.to raise_error(JSONValidate::ValidationError, /\/\[1\]/)
+    end
+  end
+
+  describe "Hash#validate" do
+    it 'should add an instance method #validate to Hash' do
+      expect(Hash.new).to respond_to(:validate)
+    end
+
+    it "can be invoked via hash decoded from JSON" do
+      json = JSON.parse('{"a": 1, "b": "hoge"}')
+      expect{ json.validate{ {a: Fixnum, b: String} } }.not_to raise_error
+      expect{ json.validate{ {a: Fixnum, b: Fixnum} } }.to raise_error(JSONValidate::ValidationError, /\/b/)
+    end
+  end
+
+  describe "Array#validate" do
+    it 'should add an instance method #validate to Array' do
+      expect(Array.new).to respond_to(:validate)
+    end
+
+    it "can be invoked via array decoded from JSON" do
+      json = JSON.parse('[{"id": 1}, {"id": 2}, {"id": 3}]')
+      expect{ json.validate{ [{id: Fixnum}] } }.not_to raise_error
+      expect{ json.validate{ [{id: String}] } }.to raise_error(JSONValidate::ValidationError, /\/\[0\]\/id/)
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'json_validate'

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: json_validate
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Tomoyuki Morita
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: 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'
+description: Offers simple way to validate JSON object having expected structure.
+email:
+- ykmr1224@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- json_validate.gemspec
+- lib/json_validate.rb
+- lib/json_validate/version.rb
+- spec/json_validate_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/ykmr1224/json_validate
+licenses:
+- MIT
+metadata: {}
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Offers simple way to validate JSON object having expected structure.
+test_files:
+- spec/json_validate_spec.rb
+- spec/spec_helper.rb
+has_rdoc: