json_validator 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 53df7dd58f70876c93e8d4289db52ed1639a0a50
+  data.tar.gz: 61f4c218b92cf98902b4298248955f94f2588131
+SHA512:
+  metadata.gz: eb4f3e30be96038c7be8501593b1b463bbe7dc89200a8df5885ece06ca136e0b05945caf571d4d9386c1f44b73215eabf0f7252369166c5e6b43ca47ef08ff98
+  data.tar.gz: 5f5b5674b0cfbf1191f087ca7dd91059d5eea73565c2ec8c44b827c3f6dfbf985c1be6605e0fbd77350daa7e1b93c666e26c8800dfe23987a90fa8c22799a11d

data/.gemfiles/rails3_2.gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'activesupport', '~> 3.2.0'
+gem 'activemodel', '~> 3.2.0'
+gemspec path: '../'

data/.gemfiles/rails4_0.gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'activesupport', '~> 4.0.0'
+gem 'activemodel', '~> 4.0.0'
+gemspec path: '../'

data/.gemfiles/rails4_1.gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'activesupport', '~> 4.1.0'
+gem 'activemodel', '~> 4.1.0'
+gemspec path: '../'

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--order rand
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 1.9
+  - 2.0
+  - 2.1
+  - jruby
+  - rbx-2
+gemfile:
+  - .gemfiles/rails3_2.gemfile
+  - .gemfiles/rails4_0.gemfile
+  - .gemfiles/rails4_1.gemfile

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Iain Beeston
+
+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,34 @@
+# JsonValidator
+
+[![Build Status](http://img.shields.io/travis/iainbeeston/json_validator/master.svg)](https://travis-ci.org/iainbeeston/json_validator)
+[![Code Climate](http://img.shields.io/codeclimate/github/iainbeeston/json_validator.svg)](https://codeclimate.com/github/iainbeeston/json_validator)
+
+JsonValidator is an ActiveModel validator that validates any hash field against [JSONSchema](http://json-schema.org), returning errors in the model's own `errors` attribute.
+
+This gem was originally written to provide deep validation of JSON attributes, which are available alongside primative types in recent versions of [PostgreSQL](http://www.postgresql.org), but it works equally well with ActiveModel objects.
+
+Most of the functionality is dependent on the wonderful [json-schema](https://github.com/hoxworth/json-schema) gem.
+
+## Usage
+
+If you're using Ruby on Rails and ActiveRecord, add a validation to your model like this:
+
+    class Foo < ActiveRecord::Base
+      validates :bar, json: {
+        schema: {
+          '$schema' => 'http://json-schema.org/schema#',
+          'title': 'Universal spoons schema',
+          'properties': {
+		    'handleSize': {
+			  'type': 'integer',
+			  'minimum': 0
+			}
+	      },
+          'required': ['handleSize']
+        }
+      }
+    end
+
+Then whenever an instance of `Foo` is saved, `Foo.bar` (assumed to be a hash) will be validated against the JSON schema specified. In this case, `Foo.new(bar: { handleSize: -10 })` would be invalid, but `Foo.new(bar: { handleSize: 10 })` would be valid.
+
+The attribute being validated can be either a hash or a string (which will be parsed as JSON). The schema can be either a hash or a Proc that returns a hash (if you'd like to decide on the schema at runtime), and there's no reason why you could not load your schema from a .json file.

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_validator.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "json_validator_meta"
+
+Gem::Specification.new do |spec|
+  spec.name          = "json_validator"
+  spec.version       = JsonValidatorMeta::VERSION
+  spec.authors       = ["Iain Beeston"]
+  spec.email         = ["iain.beeston@gmail.com"]
+  spec.summary       = %q{ActiveModel that validates hash fields using JSON schema}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_dependency "activesupport", ">= 3.2"
+  spec.add_dependency "activemodel", ">= 3.2"
+  spec.add_dependency "json-schema"
+  spec.add_dependency "json"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", ">= 3.0"
+end

data/lib/json_validator.rb

@@ -0,0 +1,45 @@
+require 'json_validator_meta'
+# activemodel validators have an undeclared dependency on the hash extensions from active support
+require 'active_support/core_ext/hash'
+require 'active_model/validator'
+require 'json'
+require 'json-schema'
+
+class JsonValidator < ActiveModel::EachValidator
+  VERSION = JsonValidatorMeta::VERSION
+
+  def validate_each(record, attribute, value)
+    raw_errors = JSON::Validator.fully_validate(schema(record), json(value))
+    translated_errors = raw_errors.map do |e|
+      translate_message(e)
+    end
+    translated_errors.each do |e|
+      record.errors.add(attribute, e)
+    end
+  end
+
+  def schema(record)
+    if options[:schema].respond_to?(:call)
+      options[:schema].call(record)
+    else
+      options[:schema].to_hash
+    end
+  end
+
+  def json(value)
+    if value.respond_to?(:to_hash)
+      value.to_hash
+    else
+      JSON.parse(value.to_s)
+    end
+  end
+
+  def translate_message(msg)
+    # remove suffix
+    msg.gsub!(/ in schema .*$/, '')
+  end
+
+  def check_validity!
+    fail ArgumentError, :'Schema unspecified. Please specify :schema as either a Proc or a hash' if options[:schema].nil?
+  end
+end

data/lib/json_validator_meta.rb

@@ -0,0 +1,4 @@
+# can't put this in a JsonValidator module because ActiveModel expects JsonValidator to be a class
+module JsonValidatorMeta
+  VERSION = '0.0.1'
+end

data/spec/integration/active_model_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+require 'active_model'
+require 'json_validator'
+
+class FakeActiveModel
+  include ActiveModel::Validations
+
+  attr_accessor :json_data
+
+  def initialize(json_data)
+    self.json_data = json_data.to_hash
+  end
+
+  validates :json_data, json: {
+    allow_blank: true,
+    schema: {
+      'type' => 'object',
+      'required' => ['foo']
+    }
+  }
+end
+
+describe FakeActiveModel do
+  it 'sets validation errors using JsonValidator' do
+    expect(FakeActiveModel.new(hello: :world)).to_not be_valid
+  end
+
+  it 'does not set validation errors using JsonValidator when the json is valid' do
+    expect(FakeActiveModel.new(foo: :bar)).to be_valid
+  end
+
+  it 'does not run JsonValidator when allow_blank is true and the json is an empty hash' do
+    expect(FakeActiveModel.new({})).to be_valid
+  end
+end

data/spec/lib/json_validator_spec.rb

@@ -0,0 +1,162 @@
+require 'spec_helper'
+require 'active_model'
+require 'json_validator'
+
+class FakeValidatingModel
+  include ActiveModel::Validations
+
+  attr_accessor :json_data
+
+  def initialize(json_data)
+    self.json_data = json_data.to_hash
+  end
+end
+
+describe JsonValidator do
+  describe '#validate_each' do
+    let(:model) { FakeValidatingModel.new(json_data) }
+    subject { described_class.new(attributes: [:json_data], schema: json_schema) }
+
+    context 'when the schema is empty' do
+      let(:json_data) do
+        {
+          'soup' => 'tastes good'
+        }
+      end
+      subject { described_class.new(attributes: [:json_data], schema: {}) }
+
+      it 'does not set any errors' do
+        expect { subject.validate_each(model, :json_data, json_data) }.to_not change { model.errors.empty? }
+      end
+    end
+
+    context 'when a schema specifies required fields' do
+      let(:json_data) do
+        {
+          'bread' => 'is crusty'
+        }
+      end
+      let(:json_schema) do
+        {
+          'type' => 'object',
+          'required' => ['soup']
+        }
+      end
+
+      it 'sets errors for required fields that are blank' do
+        expect {
+          subject.validate_each(model, :json_data, json_data)
+        }.to change {
+          model.errors.to_hash
+        }.from(
+          {}
+        ).to(
+          {
+            json_data: ["The property '#/' did not contain a required property of 'soup'"]
+          }
+        )
+      end
+    end
+
+    context 'when a schema specifies minLength' do
+      let(:json_data) do
+        {
+          'menu' => 'does not have enough variety',
+          'address' => 'is fine'
+        }
+      end
+      let(:json_schema) do
+        {
+          'type' => 'object',
+          'properties' => {
+            'menu' => {
+              'type' => 'string',
+              'minLength' => 200
+            },
+            'address' => {
+              'type' => 'string',
+              'minLength' => 3
+            }
+          }
+        }
+      end
+
+      it 'sets errors for fields with minLength that do not meet the required length' do
+        expect {
+          subject.validate_each(model, :json_data, json_data)
+        }.to change {
+          model.errors.to_hash
+        }.from(
+          {}
+        ).to(
+          {
+            json_data: ["The property '#/menu' was not of a minimum string length of 200"]
+          }
+        )
+      end
+    end
+  end
+
+  describe '#initialize' do
+    context 'when a schema is not specified' do
+      it 'raises an error' do
+        expect {
+          described_class.new(attributes: [:name])
+        }.to raise_error(ArgumentError).with_message(
+          'Schema unspecified. Please specify :schema as either a Proc or a hash'
+        )
+      end
+    end
+  end
+
+  describe '#schema' do
+    context 'when initialized with a :schema option' do
+      context 'that is a lambda' do
+        subject { described_class.new(attributes: [:name], schema: ->(model) { { foo: model.name } }) }
+
+        it 'is the result of the lambda (passed the model)' do
+          expect(subject.schema(double(name: 'ack'))).to eq(foo: 'ack')
+        end
+      end
+
+      context 'that is a hash' do
+        subject { described_class.new(attributes: [:name], schema: { foo: :bar }) }
+
+        it 'is the hash' do
+          expect(subject.schema(double)).to eq(foo: :bar)
+        end
+      end
+    end
+  end
+
+  describe '#json' do
+    subject { described_class.new(attributes: [:name], schema: {}) }
+
+    it 'returns the input when passed a hash' do
+      expect(subject.json('foo' => 'bar')).to eq('foo' => 'bar')
+    end
+
+    it 'parses the input as JSON when passed a string' do
+      expect(subject.json('{"foo": "bar"}')).to eq('foo' => 'bar')
+    end
+
+    it 'calls #to_hash when passed any other object' do
+      expect(subject.json(double(to_hash: { 'foo' => 'bar' }))).to eq('foo' => 'bar')
+    end
+  end
+
+  describe '#translate_message' do
+    subject { described_class.new(attributes: [:name], schema: { foo: :bar }) }
+
+    it 'translates json-schema messages to slightly more readable ones' do
+      msg = "The property '#/menu' was not of a minimum string length of 200 in schema 40148e2f-45d6-51b7-972a-179bd9de61d6#"
+      expect(subject.translate_message(msg)).to eq("The property '#/menu' was not of a minimum string length of 200")
+    end
+  end
+
+  describe '#VERSION' do
+    it 'is the same as JsonValidatorMeta::VERSION' do
+      expect(described_class.const_get(:VERSION)).to eq(JsonValidatorMeta::VERSION)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,57 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, make a
+# separate helper file that requires this one and then use it only in the specs
+# that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+    expectations.syntax = :expect
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+    mocks.syntax = :expect
+
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended.
+    mocks.verify_partial_doubles = true
+  end
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: json_validator
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Iain Beeston
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !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
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- iain.beeston@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gemfiles/rails3_2.gemfile"
+- ".gemfiles/rails4_0.gemfile"
+- ".gemfiles/rails4_1.gemfile"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- json_validator.gemspec
+- lib/json_validator.rb
+- lib/json_validator_meta.rb
+- spec/integration/active_model_spec.rb
+- spec/lib/json_validator_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.2.2
+signing_key: 
+specification_version: 4
+summary: ActiveModel that validates hash fields using JSON schema
+test_files:
+- spec/integration/active_model_spec.rb
+- spec/lib/json_validator_spec.rb
+- spec/spec_helper.rb