publishing_platform_schemas 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 88231446d780966954fa7df80621e314cb2d885e187402b7d68e8ee2d10513e2
+  data.tar.gz: 33fd84d51fab3235f9f5089153939493a7c4a66eca9553a8288e77e55bd3cd74
+SHA512:
+  metadata.gz: 2d0f1ebc0dc699816e80c3fadf1a88678f5f44b9c0963b8e2c3e797adb908bc1f3f9a5a96ea4a6982cbe5bb2ff83daf8c3b9c57f56ea1ace47f1f51fd172b74f
+  data.tar.gz: 6671a6f2e8996641695e7b48b76f658180e9945986e81a90ed32c6f92e0352a0e25ac26daac258e1edb7136b51023a5e48e99010d7b930265275db653191718c

data/.github/workflows/main.yml

@@ -0,0 +1,27 @@
+name: Ruby
+
+on:
+  push:
+    branches:
+      - master
+
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    name: Ruby ${{ matrix.ruby }}
+    strategy:
+      matrix:
+        ruby:
+          - '3.1.2'
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - name: Run the default task
+      run: bundle exec rake

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,3 @@
+inherit_gem:
+  publishing_platform_rubocop:
+    - config/default.yml

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in publishing_platform_schemas.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"

data/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2024 Publishing Platform
+Copyright (c) 2016 Crown Copyright (Government Digital Service)
+
+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,2 @@
+# Publishing Platform Schemas
+Gem to work with the Publishing Platform content schemas

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "publishing_platform_schemas"
+
+# 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/publishing_platform_schemas/schema.rb

@@ -0,0 +1,50 @@
+module PublishingPlatformSchemas
+  class Schema
+    # Find a schema by name
+    #
+    # @param schema [Hash] Type => Name of the schema/format:
+    # @example
+    #
+    #   PublishingPlatformSchemas::Schema.find(links_schema: "detailed_guide")
+    #   PublishingPlatformSchemas::Schema.find(frontend_schema: "detailed_guide")
+    #   PublishingPlatformSchemas::Schema.find(publisher_schema: "detailed_guide")
+    #   PublishingPlatformSchemas::Schema.find(notification_schema: "detailed_guide")
+    # @return [Hash] the JSON schema as a hash
+    def self.find(schema)
+      file_path = "#{PublishingPlatformSchemas.content_schema_dir}/dist/formats/#{location_for_schema_name(schema)}"
+      JSON.parse(File.read(file_path))
+    end
+
+    # Return all schemas in a hash, keyed by schema name
+    #
+    # @param schema_type [String] The type: frontend, publisher, notification or links
+    # @return [Array<Hash>] List of JSON schemas as hashes
+    def self.all(schema_type: "*")
+      schema_type = "publisher" if schema_type == "publisher"
+      Dir.glob("#{PublishingPlatformSchemas.content_schema_dir}/dist/formats/*/#{schema_type}/*.json").each_with_object({}) do |file_path, hash|
+        hash[file_path] = JSON.parse(File.read(file_path))
+      end
+    end
+
+    # Return all schema names
+    #
+    # @return [Array] all the schema names
+    def self.schema_names
+      Dir.glob("#{PublishingPlatformSchemas.content_schema_dir}/dist/formats/*").map do |directory|
+        File.basename(directory)
+      end
+    end
+
+    # @private
+    def self.location_for_schema_name(schema)
+      type, schema_name = schema.to_a.flatten
+      {
+        links_schema: "#{schema_name}/publisher/links.json",
+        frontend_schema: "#{schema_name}/frontend/schema.json",
+        publisher_schema: "#{schema_name}/publisher/schema.json",
+      }[type]
+    end
+
+    private_class_method :location_for_schema_name
+  end
+end

data/lib/publishing_platform_schemas/version.rb

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

data/lib/publishing_platform_schemas.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require_relative "publishing_platform_schemas/version"
+require_relative "publishing_platform_schemas/schema"
+
+module PublishingPlatformSchemas
+  def self.content_schema_dir=(path_to_schemas)
+    @content_schema_dir = path_to_schemas
+  end
+
+  def self.content_schema_dir
+    @content_schema_dir ||= ENV.fetch("PUBLISHING_PLATFORM_CONTENT_SCHEMAS_PATH", "../publishing-api/content_schemas")
+  end
+
+  # @private
+  class InvalidContentGenerated < RuntimeError
+  end
+end

data/publishing_platform_schemas.gemspec

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative "lib/publishing_platform_schemas/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "publishing_platform_schemas"
+  spec.version = PublishingPlatformSchemas::VERSION
+  spec.authors = ["Publishing Platform"]
+
+  spec.summary = "Gem to work with the Publishing Platform content schemas"
+  spec.description = "Gem to work with the Publishing Platform content schemas"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.0"
+
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  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_development_dependency "publishing_platform_rubocop"
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: publishing_platform_schemas
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Publishing Platform
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-07-17 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.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+- !ruby/object:Gem::Dependency
+  name: publishing_platform_rubocop
+  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'
+description: Gem to work with the Publishing Platform content schemas
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/publishing_platform_schemas.rb
+- lib/publishing_platform_schemas/schema.rb
+- lib/publishing_platform_schemas/version.rb
+- publishing_platform_schemas.gemspec
+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: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key: 
+specification_version: 4
+summary: Gem to work with the Publishing Platform content schemas
+test_files: []