activemodel_json_validator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a3670478b8b0b44c7091df975535441a8663f34fb4b3686d910200a798e5f9af
+  data.tar.gz: aebc17ef80ce040f4cef6af3eb09027da53af0a8a3e374cedcd8a7e4df485103
+SHA512:
+  metadata.gz: 8bfb4d8165b7e4bc915a8bcd7b862dbbd90d8a679b69c2f6f54cbacd07544b3556f2c100cd598bace14d4c11d1769af29e4f1bc7975f060ad3f9c631423a125f
+  data.tar.gz: 48230a189bfce245926a277e731ecb5293f68801cf15e583aded35e4f494b2b405d93723c02773ff102e06a64f7217b2d493466c9f52a793af53754ac0dee3ba

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,11 @@
+sudo: false
+cache: bundler
+language: ruby
+
+rvm:
+  - 2.4.0
+  - 2.5.0
+  - 2.6.0
+
+before_install:
+  - gem install bundler -v 2.0.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at alejandrodevs@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Alejandro Gutiérrez
+
+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,77 @@
+# ActiveModelJsonValidator
+[![Build Status](https://travis-ci.com/alejandrodevs/activemodel_json_validator.svg?branch=master)](https://travis-ci.org/alejandrodevs/activemodel_json_validator) [![Coverage Status](https://coveralls.io/repos/github/alejandrodevs/activemodel_json_validator/badge.svg?branch=master)](https://coveralls.io/github/alejandrodevs/activemodel_json_validator?branch=master)
+
+This gem aims to provide an easy way to validate json and jsonb attributes against a JSON schema. This gem is based on ActiveModel and [`json-schema`](https://github.com/ruby-json-schema/json-schema).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activemodel_json_validator'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activemodel_json_validator
+
+## Usage
+
+Add your json validation in the model:
+
+```ruby
+class User < ApplicationRecord
+  validates :preferences, json: true
+end
+```
+
+By default this validation will find an schema in:
+`app/models/schemas/user/preferences.json`.
+
+```json
+{
+  "type": "object",
+  "$schema": "http://json-schema.org/draft-04/schema",
+  "required": [
+    "locale",
+    "currency"
+  ],
+  "properties": {
+    "locale": { "type": "string" },
+    "currency": { "type": "string" },
+    "subscribed": { "type": "boolean" }
+  }
+}
+```
+
+Custom schema path could be passed to the validator:
+
+```ruby
+class User < ApplicationRecord
+  validates :preferences, json: {
+    schema: Rails.root.join('schemas', 'preferences.json').to_s
+  }
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also 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`, 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/alejandrodevs/activemodel_json_validator. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the ActivemodelJsonValidator project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/alejandrodevs/activemodel_json_validator/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

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

data/activemodel_json_validator.gemspec

@@ -0,0 +1,37 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'activemodel/json_validator/version'
+
+Gem::Specification.new do |spec|
+  spec.name         = 'activemodel_json_validator'
+  spec.version      = ActiveModel::JsonValidator::VERSION
+  spec.authors      = ['Alejandro Gutiérrez']
+  spec.email        = ['alejandrodevs@gmail.com']
+  spec.summary      = 'A simple json validator based on ActiveModel.'
+  spec.description  = 'A simple json validator based on ActiveModel.'
+  spec.homepage     = 'https://github.com/alejandrodevs/activemodel_json_validator'
+  spec.license      = 'MIT'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = "#{spec.homepage}/blob/master/LICENSE.txt"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'appraisal', '~> 2.2'
+  spec.add_development_dependency 'simplecov', '~> 0.17'
+  spec.add_development_dependency 'coveralls', '~> 0.7.2'
+
+  spec.add_dependency 'activemodel', '>= 4.2'
+  spec.add_dependency 'json-schema', '~> 2.8'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "activemodel_json_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(__FILE__)

data/bin/setup

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

data/lib/activemodel/json_validator/validator.rb

@@ -0,0 +1,44 @@
+class JsonValidator < ActiveModel::EachValidator
+  DEFAULT_SCHEMAS_PATH = %w(app models schemas).freeze
+
+  def initialize(options)
+    @model = options[:class]
+    super
+  end
+
+  def validate_each(model, attribute, value)
+    schema = options.fetch(:schema, default_schema(attribute))
+    errors = JSON::Validator.fully_validate(schema, value)
+    model.errors.add(attribute, message(errors)) if errors.any?
+  end
+
+  private
+
+  def message(errors)
+    message = options.fetch(:message, :invalid_json)
+    return message unless message.respond_to?(:call)
+    message.call(errors)
+  end
+
+  def default_root_path
+    Rails.root.join.to_s if defined?(Rails)
+    File.join.to_s
+  end
+
+  def default_schemas_path
+    DEFAULT_SCHEMAS_PATH
+  end
+
+  def default_model_path
+    @model.model_name.singular
+  end
+
+  def default_schema(attribute)
+    File.join(
+      default_root_path,
+      default_schemas_path,
+      default_model_path,
+      "#{attribute}.json"
+    ).to_s
+  end
+end

data/lib/activemodel/json_validator/version.rb

@@ -0,0 +1,5 @@
+module ActiveModel
+  module JsonValidator
+    VERSION = '0.1.0'.freeze
+  end
+end

data/lib/activemodel_json_validator.rb

@@ -0,0 +1,5 @@
+require 'json-schema'
+require 'active_model'
+
+require 'activemodel/json_validator/version'
+require 'activemodel/json_validator/validator'

metadata

@@ -0,0 +1,172 @@
+--- !ruby/object:Gem::Specification
+name: activemodel_json_validator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alejandro Gutiérrez
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-08-19 00:00:00.000000000 Z
+dependencies:
+- !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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.2
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: json-schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+description: A simple json validator based on ActiveModel.
+email:
+- alejandrodevs@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- activemodel_json_validator.gemspec
+- bin/console
+- bin/setup
+- lib/activemodel/json_validator/validator.rb
+- lib/activemodel/json_validator/version.rb
+- lib/activemodel_json_validator.rb
+homepage: https://github.com/alejandrodevs/activemodel_json_validator
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/alejandrodevs/activemodel_json_validator
+  source_code_uri: https://github.com/alejandrodevs/activemodel_json_validator
+  changelog_uri: https://github.com/alejandrodevs/activemodel_json_validator/blob/master/LICENSE.txt
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A simple json validator based on ActiveModel.
+test_files: []