hecks-plugins-json-validator 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e5b20be7162ce46d038b8ef5c5551dfd7764a39a
+  data.tar.gz: 0ae13e35cab1100d8dd1c8ca4b46c9d6b9fc4548
+SHA512:
+  metadata.gz: 8479f09a701a2ed7b19c6651790d641f6a2e4eeec40bcec5f12221632d84d48e51e7dbea77de0b1e3b4dec94a72868e5d9d846e75e8167cbdaf3c73c28c6d74c
+  data.tar.gz: 8dbfb5194d61bbb1e4139a7b688fc276f0899c85524dacab61657bdcd81574273b49324264938ec20ab319a1ac18e2bc53ba77212570641a803f28fd62aea84f

data/lib/hecks-plugins-json-validator.rb

@@ -0,0 +1,58 @@
+require 'json-schema'
+require_relative 'matchers'
+require_relative 'parsers/schema_parser'
+require_relative 'parsers/message_parser'
+
+module HecksPlugins
+  # A validator that is built on top of json-schema to provide more
+  # functionality than the basic hecks validator.  Builds a json schema
+  # from a head spec and validates the user's input against it.
+  class JSONValidator
+    attr_reader :errors
+
+    def initialize(command:)
+      @args          = command.args
+      @domain_module = command.domain_module
+      @errors        = {}
+      @schema_parser = SchemaParser.new(
+        domain_module: domain_module,
+        object:        command.domain_module.head
+      ).call
+
+      @validator     = JSON::Validator
+    end
+
+    def call
+      parse_schema
+      validate
+      self
+    end
+
+    private
+
+    attr_reader :args, :domain_module, :schema, :schema_parser, :validator
+
+    def parse_schema
+      @schema = schema_parser.schema
+    end
+
+    def validate
+      MATCHERS.each do |matcher|
+        result = validator.fully_validate(schema, args, errors_as_objects: true)
+
+        result.each do |error|
+          parser = MessageParser.new(matcher: matcher, error: error).call
+          next unless parser.message
+          if parser.fragment && parser.fragment != parser.field_name
+            errors[parser.fragment] ||= {}
+            errors[parser.fragment][parser.field_name] ||= []
+            errors[parser.fragment][parser.field_name] << parser.message
+          else
+            errors[parser.field_name] ||= []
+            errors[parser.field_name] << parser.message
+          end
+        end
+      end
+    end
+  end
+end

data/lib/matchers.rb

@@ -0,0 +1,17 @@
+#
+module HecksPlugins
+  class JSONValidator
+    # These matchers create a cleaner, more user-friendly message out of the
+    # messages returned by json-schema
+    MATCHERS = [
+      {
+        regex:   /did not contain a required property of '(.*)' in schema/,
+        message: 'Missing'
+      },
+      {
+        regex: /The property '#\/(.*)' of type (.*) did not match the following type: (.*) in schema/,
+        message: 'Type mismatch. Got \'%s\', should have been \'%s\''
+      }
+    ]
+  end
+end

data/lib/parsers/message_parser.rb

@@ -0,0 +1,37 @@
+module HecksPlugins
+  class JSONValidator
+    # Turn the json-schema messages into easy to understand errors for the user
+    class MessageParser
+      attr_reader :message, :field_name, :fragment
+
+      def initialize(matcher:, error:)
+        @matcher = matcher
+        @error = error
+        @match = error[:message].match(matcher[:regex])
+        @fragment = error[:fragment].gsub('#/', '')
+        if fragment == ''
+          @fragment = nil
+        else
+          @fragment = fragment.to_sym
+        end
+
+      end
+
+      def call
+        parse_match
+        self
+      end
+
+      private
+
+      attr_reader :match, :matcher, :error
+
+      def parse_match
+        return unless match
+        @message    = matcher[:message]
+        @message    = message % match[2..-1] if match.length > 2
+        @field_name = match[1].to_sym
+      end
+    end
+  end
+end

data/lib/parsers/schema_parser.rb

@@ -0,0 +1,71 @@
+module HecksPlugins
+  class JSONValidator
+    # Create a JSON Schema from an object
+    class SchemaParser
+      attr_reader :schema
+      JSON_TYPES = %w{string number object array boolean null}
+      HECKS_NUMBER_TYPES = %w{integer currency}
+
+      def initialize domain_module:, object:
+        @domain_module = domain_module
+        @object =        object
+        @properties =    {}
+      end
+
+      def call
+        parse_required_fields
+        object.attributes.each { |a| parse_property(a) }
+        build_schema
+        self
+      end
+
+      private
+
+      attr_reader :required_fields, :object, :properties, :domain_module
+
+      def build_schema
+        @schema = {
+          "type"       => "object",
+          "required"   => required_fields,
+          "properties" => properties
+        }
+      end
+
+      def parse_required_fields
+        @required_fields = object.attributes.map{ |a| a.name }
+      end
+
+      def get_json_type attribute
+        result = attribute.type.downcase
+        return 'array'  if attribute.list?
+        return 'number' if HECKS_NUMBER_TYPES.include?(result)
+        return 'object' unless JSON_TYPES.include?(result)
+
+        result
+      end
+
+      def schema_for_attribute attribute
+        return {} if attribute.reference?
+        self.class.new(
+          domain_module: domain_module,
+          object: domain_module.find(attribute.type)
+        ).call.schema
+      end
+
+      def parse_property(attribute)
+        type = get_json_type(attribute)
+        name = attribute.name
+        properties[name] =
+          case type
+          when 'object' then schema_for_attribute(attribute)
+          when 'array'
+            {
+              "type"  => 'array',
+              "items" => schema_for_attribute(attribute)
+            }
+          else { "type" => type }
+          end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: hecks-plugins-json-validator
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Chris Young
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-12-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json-schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+description: Hecks JSON Schema Validations
+email: chris@example.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/hecks-plugins-json-validator.rb
+- lib/matchers.rb
+- lib/parsers/message_parser.rb
+- lib/parsers/schema_parser.rb
+homepage: https://github.com/chrisyoung/hecks
+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.6.10
+signing_key: 
+specification_version: 4
+summary: Advanced Domain Validations Based on JSON Schema http://json-schema.org/
+test_files: []