elasticgraph-json_schema 0.18.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6d27de518ae5b2935f1a24cca436bdd71c9578283feaf8ee91c5ad63ea52730b
+  data.tar.gz: 5d7241ecceef9a3080e2de4f86c3d0afde7f356d1f53ee5b5a476215dfbe383d
+SHA512:
+  metadata.gz: e7b32ff1e5e3be8d05364e5406d53df66e1673694843e4e663edd91b7fdd7057ab49a9576416d90882737ee94670d38bda5641a38227efa0cb0bcf987c3b6e0b
+  data.tar.gz: 92f3263d379de21c0c3e43a42322c4a681936c1d13ce62433aa8bd03447563275e1a07dc91398aa2d714846ab77ab6f346ea3e7d3d4e8468e6239a6a3466da0b

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Block, Inc.
+
+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,3 @@
+# ElasticGraph::JSONSchema
+
+Provides JSON Schema validation for ElasticGraph.

data/elasticgraph-json_schema.gemspec

@@ -0,0 +1,16 @@
+# Copyright 2024 Block, Inc.
+#
+# Use of this source code is governed by an MIT-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/MIT.
+#
+# frozen_string_literal: true
+
+require_relative "../gemspec_helper"
+
+ElasticGraphGemspecHelper.define_elasticgraph_gem(gemspec_file: __FILE__, category: :core) do |spec, eg_version|
+  spec.summary = "ElasticGraph gem that provides JSON Schema validation."
+
+  spec.add_dependency "elasticgraph-support", eg_version
+  spec.add_dependency "json_schemer", "~> 2.3"
+end

data/lib/elastic_graph/json_schema/json_schema_draft_7_schema.json

@@ -0,0 +1,172 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "$id": "http://json-schema.org/draft-07/schema#",
+    "title": "Core schema meta-schema",
+    "definitions": {
+        "schemaArray": {
+            "type": "array",
+            "minItems": 1,
+            "items": { "$ref": "#" }
+        },
+        "nonNegativeInteger": {
+            "type": "integer",
+            "minimum": 0
+        },
+        "nonNegativeIntegerDefault0": {
+            "allOf": [
+                { "$ref": "#/definitions/nonNegativeInteger" },
+                { "default": 0 }
+            ]
+        },
+        "simpleTypes": {
+            "enum": [
+                "array",
+                "boolean",
+                "integer",
+                "null",
+                "number",
+                "object",
+                "string"
+            ]
+        },
+        "stringArray": {
+            "type": "array",
+            "items": { "type": "string" },
+            "uniqueItems": true,
+            "default": []
+        }
+    },
+    "type": ["object", "boolean"],
+    "properties": {
+        "$id": {
+            "type": "string",
+            "format": "uri-reference"
+        },
+        "$schema": {
+            "type": "string",
+            "format": "uri"
+        },
+        "$ref": {
+            "type": "string",
+            "format": "uri-reference"
+        },
+        "$comment": {
+            "type": "string"
+        },
+        "title": {
+            "type": "string"
+        },
+        "description": {
+            "type": "string"
+        },
+        "default": true,
+        "readOnly": {
+            "type": "boolean",
+            "default": false
+        },
+        "writeOnly": {
+            "type": "boolean",
+            "default": false
+        },
+        "examples": {
+            "type": "array",
+            "items": true
+        },
+        "multipleOf": {
+            "type": "number",
+            "exclusiveMinimum": 0
+        },
+        "maximum": {
+            "type": "number"
+        },
+        "exclusiveMaximum": {
+            "type": "number"
+        },
+        "minimum": {
+            "type": "number"
+        },
+        "exclusiveMinimum": {
+            "type": "number"
+        },
+        "maxLength": { "$ref": "#/definitions/nonNegativeInteger" },
+        "minLength": { "$ref": "#/definitions/nonNegativeIntegerDefault0" },
+        "pattern": {
+            "type": "string",
+            "format": "regex"
+        },
+        "additionalItems": { "$ref": "#" },
+        "items": {
+            "anyOf": [
+                { "$ref": "#" },
+                { "$ref": "#/definitions/schemaArray" }
+            ],
+            "default": true
+        },
+        "maxItems": { "$ref": "#/definitions/nonNegativeInteger" },
+        "minItems": { "$ref": "#/definitions/nonNegativeIntegerDefault0" },
+        "uniqueItems": {
+            "type": "boolean",
+            "default": false
+        },
+        "contains": { "$ref": "#" },
+        "maxProperties": { "$ref": "#/definitions/nonNegativeInteger" },
+        "minProperties": { "$ref": "#/definitions/nonNegativeIntegerDefault0" },
+        "required": { "$ref": "#/definitions/stringArray" },
+        "additionalProperties": { "$ref": "#" },
+        "definitions": {
+            "type": "object",
+            "additionalProperties": { "$ref": "#" },
+            "default": {}
+        },
+        "properties": {
+            "type": "object",
+            "additionalProperties": { "$ref": "#" },
+            "default": {}
+        },
+        "patternProperties": {
+            "type": "object",
+            "additionalProperties": { "$ref": "#" },
+            "propertyNames": { "format": "regex" },
+            "default": {}
+        },
+        "dependencies": {
+            "type": "object",
+            "additionalProperties": {
+                "anyOf": [
+                    { "$ref": "#" },
+                    { "$ref": "#/definitions/stringArray" }
+                ]
+            }
+        },
+        "propertyNames": { "$ref": "#" },
+        "const": true,
+        "enum": {
+            "type": "array",
+            "items": true,
+            "minItems": 1,
+            "uniqueItems": true
+        },
+        "type": {
+            "anyOf": [
+                { "$ref": "#/definitions/simpleTypes" },
+                {
+                    "type": "array",
+                    "items": { "$ref": "#/definitions/simpleTypes" },
+                    "minItems": 1,
+                    "uniqueItems": true
+                }
+            ]
+        },
+        "format": { "type": "string" },
+        "contentMediaType": { "type": "string" },
+        "contentEncoding": { "type": "string" },
+        "if": { "$ref": "#" },
+        "then": { "$ref": "#" },
+        "else": { "$ref": "#" },
+        "allOf": { "$ref": "#/definitions/schemaArray" },
+        "anyOf": { "$ref": "#/definitions/schemaArray" },
+        "oneOf": { "$ref": "#/definitions/schemaArray" },
+        "not": { "$ref": "#" }
+    },
+    "default": true
+}

data/lib/elastic_graph/json_schema/meta_schema_validator.rb

@@ -0,0 +1,56 @@
+# Copyright 2024 Block, Inc.
+#
+# Use of this source code is governed by an MIT-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/MIT.
+#
+# frozen_string_literal: true
+
+require "elastic_graph/json_schema/validator"
+require "elastic_graph/json_schema/validator_factory"
+require "elastic_graph/support/hash_util"
+require "json"
+
+module ElasticGraph
+  module JSONSchema
+    # Provides a strict validator based on the JSON schema spec that a JSON schema document is valid.
+    def self.strict_meta_schema_validator
+      @strict_meta_schema_validator ||= MetaSchemaLoader.load_strict_validator
+    end
+
+    # Provides a validator that allows additional ElasticGraph metadata to be embedded
+    # in JSON schema for internal ElasticGraph use.
+    def self.elastic_graph_internal_meta_schema_validator
+      @elastic_graph_internal_meta_schema_validator ||= MetaSchemaLoader.load_strict_validator({
+        "properties" => {
+          "ElasticGraph" => {
+            "type" => "object",
+            "required" => ["type", "nameInIndex"],
+            "properties" => {
+              "type" => {"type" => "string"},
+              "nameInIndex" => {"type" => "string"}
+            }
+          }
+        }
+      })
+    end
+
+    module MetaSchemaLoader
+      def self.load_strict_validator(overrides = {})
+        # Downloaded from: https://json-schema.org/draft-07/schema
+        schema = ::JSON.parse(::File.read(::File.expand_path("../json_schema_draft_7_schema.json", __FILE__)))
+        schema = Support::HashUtil.deep_merge(schema, overrides) unless overrides.empty?
+
+        # The meta schema allows additionalProperties in nearly every place. While a JSON schema definition
+        # with additional properties is considered valid, we do not intend to use any additional properties,
+        # and any usage of an additional property is almost certainly a typo. So here we set
+        # `with_unknown_properties_disallowed`.
+        root_schema = ValidatorFactory.new(schema: schema, sanitize_pii: false) # The meta schema has no PII
+          .with_unknown_properties_disallowed
+          .root_schema
+
+        Validator.new(schema: root_schema, sanitize_pii: false)
+      end
+    end
+  end
+end

data/lib/elastic_graph/json_schema/validator.rb

@@ -0,0 +1,40 @@
+# Copyright 2024 Block, Inc.
+#
+# Use of this source code is governed by an MIT-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/MIT.
+#
+# frozen_string_literal: true
+
+require "json"
+
+module ElasticGraph
+  module JSONSchema
+    class Validator < ::Data.define(:schema, :sanitize_pii)
+      def valid?(data)
+        schema.valid?(data)
+      end
+
+      def validate(data)
+        schema.validate(data).map do |error|
+          # The schemas can be very large and make the output very noisy, hiding what matters. So we remove them here.
+          error.delete("root_schema")
+          error.delete("schema")
+          error
+        end
+      end
+
+      # Validates the given data against the schema, returning an error message if it is invalid.
+      # The error message is suitable for throwing or logging, as we take care to ensure it contains
+      # no PII.
+      def validate_with_error_message(data)
+        errors = validate(data)
+        return if errors.empty?
+
+        errors.each { |error| error.delete("data") } if sanitize_pii
+
+        "Validation errors:\n\n#{errors.map { |e| ::JSON.pretty_generate(e) }.join("\n\n")}"
+      end
+    end
+  end
+end

data/lib/elastic_graph/json_schema/validator_factory.rb

@@ -0,0 +1,103 @@
+# Copyright 2024 Block, Inc.
+#
+# Use of this source code is governed by an MIT-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/MIT.
+#
+# frozen_string_literal: true
+
+require "elastic_graph/json_schema/validator"
+require "json_schemer"
+
+module ElasticGraph
+  module JSONSchema
+    class ValidatorFactory
+      # @dynamic root_schema
+      attr_reader :root_schema
+
+      def initialize(schema:, sanitize_pii:)
+        @raw_schema = schema
+        @root_schema = ::JSONSchemer.schema(
+          schema,
+          meta_schema: schema.fetch("$schema"),
+          # Here we opt to have regular expressions resolved using an ecmo-compatible resolver, instead of Ruby's.
+          #
+          # We do this because regexp patterns in our JSON schema are intended to be used by JSON schema libraries
+          # in many languages, not just in Ruby, and we want to support the widest compatibility. For example,
+          # Ruby requires that we use `\A` and `\z` to anchor the start and end of the string (`^` and `$` anchor the
+          # start and end of a line instead), where as ecmo regexes treat `^` and `$` as the start and end of the string.
+          # For a pattern to be usable by non-Ruby publishers, we need to use `^/`$` for our start/end anchors, and we
+          # want our validator to treat it the same way here.
+          #
+          # Also, this was the default before json_schemer 1.0 (and we used 0.x versions for a long time...).
+          # This maintains the historical behavior we've had.
+          #
+          # For more info:
+          # https://github.com/davishmcclurg/json_schemer/blob/v1.0.0/CHANGELOG.md#breaking-changes
+          regexp_resolver: "ecma"
+        )
+
+        @sanitize_pii = sanitize_pii
+        @validators_by_type_name = ::Hash.new do |hash, key|
+          # Create a copy of the schema with a ref to the type merged at the root.
+          # This ensures that any relative $ref paths will correctly resolve, while
+          # specifying the type we want to validate against using $ref.
+          hash[key] = Validator.new(
+            schema: root_schema.ref("#/$defs/#{key}"),
+            sanitize_pii: sanitize_pii
+          )
+        end
+      end
+
+      def validator_for(type_name)
+        @validators_by_type_name[type_name]
+      end
+
+      # Changes the matcher to disallow additional properties. Property paths specified in
+      # `except` will be allowed.
+      def with_unknown_properties_disallowed(except: [])
+        allow_paths = except.map { |p| p.split(".") }
+        schema_copy = ::Marshal.load(::Marshal.dump(@raw_schema)) # deep copy so our mutations don't affect caller
+        prevent_unknown_properties!(schema_copy, allow_paths: allow_paths)
+
+        ValidatorFactory.new(schema: schema_copy, sanitize_pii: @sanitize_pii)
+      end
+
+      private
+
+      # The meta schema allows additionalProperties in nearly every place. While a JSON schema definition
+      # with additional properties is considered valid, we do not intend to use any additional properties,
+      # and any usage of an additional property is almost certainly a typo. So here we mutate the meta
+      # schema to set `additionalProperties: false` everywhere.
+      def prevent_unknown_properties!(object, allow_paths:, parent_path: [])
+        case object
+        when ::Array
+          object.each { |value| prevent_unknown_properties!(value, allow_paths: allow_paths, parent_path: parent_path) }
+        when ::Hash
+          if object["properties"]
+            object["additionalProperties"] = false
+
+            allowed_extra_props = allow_paths.filter_map do |path|
+              *prefix, prop_name = path
+              prop_name if prefix == parent_path
+            end
+
+            allowed_extra_props.each_with_object(object["properties"]) do |prop_name, props|
+              # @type var empty_hash: ::Hash[::String, untyped]
+              empty_hash = {}
+              props[prop_name] ||= empty_hash
+            end
+
+            object["properties"].each do |key, value|
+              prevent_unknown_properties!(value, allow_paths: allow_paths, parent_path: parent_path + [key])
+            end
+          else
+            object.each do |key, value|
+              prevent_unknown_properties!(value, allow_paths: allow_paths, parent_path: parent_path)
+            end
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,245 @@
+--- !ruby/object:Gem::Specification
+name: elasticgraph-json_schema
+version: !ruby/object:Gem::Version
+  version: 0.18.0.0
+platform: ruby
+authors:
+- Myron Marston
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-08-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop-factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.26'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.26'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop-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: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.39.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.39.0
+- !ruby/object:Gem::Dependency
+  name: steep
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: coderay
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: flatware-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+- !ruby/object:Gem::Dependency
+  name: super_diff
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.12.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.12.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+- !ruby/object:Gem::Dependency
+  name: simplecov-console
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: elasticgraph-support
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.18.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.18.0.0
+- !ruby/object:Gem::Dependency
+  name: json_schemer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+description: 
+email:
+- myron@squareup.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- elasticgraph-json_schema.gemspec
+- lib/elastic_graph/json_schema/json_schema_draft_7_schema.json
+- lib/elastic_graph/json_schema/meta_schema_validator.rb
+- lib/elastic_graph/json_schema/validator.rb
+- lib/elastic_graph/json_schema/validator_factory.rb
+homepage: 
+licenses:
+- MIT
+metadata:
+  gem_category: core
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.9
+signing_key: 
+specification_version: 4
+summary: ElasticGraph gem that provides JSON Schema validation.
+test_files: []