publishing_platform_schemas 0.1.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b9908506b494629e6db1c0e9f7913926bb57d7e7bba972b9cca8f688ee48a3f
-  data.tar.gz: ae8b12485e1e19ad35971943ca96b50b4703b43d6e16aebcfbb904fa2ab670f9
+  metadata.gz: 28b746e71aa3fa2da5fcd6b25cd398f315c7ca830f6462e688529faaa3144241
+  data.tar.gz: 3a99432a8668c48a09f021017c8a526eea1dc8af84bbb4945975f932d1b37bbe
 SHA512:
-  metadata.gz: 12f1ac7e89d3353f4f83a1f95629022c19328ac7d8942dd95914d7447ef3b2832b1ec89351f12e05300a1bd70698c4b823de8b9c69775957ba58b2c7c6fb9ab4
-  data.tar.gz: c8da8abc17516ec011c1fa469080b6955513b1b0cc36bbba3a28ac16cbbe40c09851b7573b7e1fa234913869c17960d0972c107887f29de6959113ba12c8c6c6
+  metadata.gz: 978b46ca15a78589c0cbf2b4fb6c16ba00c343b4181957383ab3619e0c4fa54554738f3b252418fbd7f1cbd683ded8d39bc575fc0cd7a3b339408c340c03e6d7
+  data.tar.gz: 940423b9ace1f728c42cca4741557d1bc8d82aa53969cab09d4d2d7da3e8bdfdfcaba9b2eda21603fbeb4d485cdba2592291bb7d4cd3a12c9e785cb295aae9bf

data/lib/publishing_platform_schemas/rspec_matchers.rb

@@ -0,0 +1,16 @@
+require "publishing_platform_schemas/validator"
+
+module PublishingPlatformSchemas
+  module RSpecMatchers
+    %w[links frontend publisher notification].each do |schema_type|
+      RSpec::Matchers.define "be_valid_against_#{schema_type}_schema".to_sym do |schema_name|
+        match do |item|
+          @validator = PublishingPlatformSchemas::Validator.new(schema_name, schema_type, item)
+          @validator.valid?
+        end
+
+        failure_message { @validator.error_message }
+      end
+    end
+  end
+end

data/lib/publishing_platform_schemas/validator.rb

@@ -0,0 +1,53 @@
+require "json-schema"
+
+module PublishingPlatformSchemas
+  class Validator
+    attr_reader :schema_name, :type
+    attr_accessor :payload
+
+    def initialize(schema_name, type, payload)
+      @schema_name = schema_name
+      @type = type
+      @payload = ensure_json(payload)
+    end
+
+    def valid?
+      errors.empty?
+    end
+
+    def error_message
+      <<~DOC
+        expected the payload to be valid against the '#{schema_name}' schema:
+
+        #{formatted_payload}
+
+        Validation errors:
+        #{errors}
+      DOC
+    end
+
+  private
+
+    def errors
+      schema = Schema.find("#{type}_schema": schema_name)
+      validator = JSON::Validator.fully_validate(schema, payload)
+      validator.map { |message| "- #{humanized_error(message)}" }.join("\n")
+    end
+
+    def formatted_payload
+      JSON.pretty_generate(JSON.parse(payload))
+    end
+
+    def humanized_error(message)
+      message.gsub("The property '#/'", "The item")
+             .gsub(/in schema [0-9a-f-]+/, "")
+             .strip
+    end
+
+    def ensure_json(payload)
+      return payload if payload.is_a?(String)
+
+      payload.to_json
+    end
+  end
+end

data/lib/publishing_platform_schemas/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PublishingPlatformSchemas
-  VERSION = "0.1.2"
+  VERSION = "0.3.0"
 end

data/publishing_platform_schemas.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = %w[lib]
 
   # This should be kept in sync with the json-schema version of publishing-api.
-  spec.add_dependency "json-schema", ">= 2.8", "< 4.4"
+  spec.add_dependency "json-schema", ">= 2.8", "< 5.2"
 
   spec.add_development_dependency "climate_control"
   spec.add_development_dependency "publishing_platform_rubocop"

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: publishing_platform_schemas
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Publishing Platform
 bindir: exe
 cert_chain: []
-date: 2025-04-03 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json-schema
@@ -18,7 +18,7 @@ dependencies:
         version: '2.8'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '4.4'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -28,7 +28,7 @@ dependencies:
         version: '2.8'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '4.4'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: climate_control
   requirement: !ruby/object:Gem::Requirement
@@ -90,7 +90,9 @@ files:
 - bin/setup
 - lib/publishing_platform_schemas.rb
 - lib/publishing_platform_schemas/example.rb
+- lib/publishing_platform_schemas/rspec_matchers.rb
 - lib/publishing_platform_schemas/schema.rb
+- lib/publishing_platform_schemas/validator.rb
 - lib/publishing_platform_schemas/version.rb
 - publishing_platform_schemas.gemspec
 licenses:
@@ -110,7 +112,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.6
+rubygems_version: 3.6.8
 specification_version: 4
 summary: Gem to work with the Publishing Platform content schemas
 test_files: []