rsmp_schemer 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fed88025943afac975e48c5ce3345ea888651d74c3b71eca02d20e46448690ec
+  data.tar.gz: 9cb403404dad2d438eb2b5c51eb14eca7c4d937fb3d610cbd2186725e4de6b33
+SHA512:
+  metadata.gz: 374ff54aa6b69e4c3b865e2bae151f0706a908187940fac4ad41971bc3b7d32cee7c3966eb8d5746a2aa8c5289c269367784bd64429a58e5c81d8f92b146afb9
+  data.tar.gz: e97c1b45d3f90baf44deeee5359263fb8bbc653b1121a7a1f4dbda74f73cf87d0da92d68752bd80a092bb55c1d46b7630e2b15bf4a274e40241d5af70fb81faa

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.DS_Store
+/.rspec_status

data/.gitmodules

@@ -0,0 +1,44 @@
+[submodule "schemas/core_3.1.2"]
+	path = schemas/core_3.1.2
+	url = https://github.com/rsmp-nordic/rsmp_schema.git
+	branch = core_3.1.2
+[submodule "schemas/core_3.1.3"]
+	path = schemas/core_3.1.3
+	url = https://github.com/rsmp-nordic/rsmp_schema.git
+	branch = core_3.1.3
+[submodule "schemas/core_3.1.4"]
+	path = schemas/core_3.1.4
+	url = https://github.com/rsmp-nordic/rsmp_schema.git
+	branch = core_3.1.4
+[submodule "schemas/core_3.1.5"]
+	path = schemas/core_3.1.5
+	url = https://github.com/rsmp-nordic/rsmp_schema.git
+	branch = core_3.1.5
+[submodule "schemas/tlc_1.0.15"]
+	path = schemas/tlc_1.0.15
+	url = https://github.com/rsmp-nordic/rsmp_schema.git
+	branch = tlc_1.0.15
+[submodule "schemas/tlc_1.0.7"]
+	path = schemas/tlc_1.0.7
+	url = https://github.com/rsmp-nordic/rsmp_schema.git
+	branch = tlc_1.0.7
+[submodule "schemas/tlc_1.0.8"]
+	path = schemas/tlc_1.0.8
+	url = https://github.com/rsmp-nordic/rsmp_schema.git
+	branch = tlc_1.0.8
+[submodule "schemas/tlc_1.0.9"]
+	path = schemas/tlc_1.0.9
+	url = https://github.com/rsmp-nordic/rsmp_schema.git
+	branch = tlc_1.0.9
+[submodule "schemas/tlc_1.0.10"]
+	path = schemas/tlc_1.0.10
+	url = https://github.com/rsmp-nordic/rsmp_schema.git
+	branch = tlc_1.0.10
+[submodule "schemas/tlc_1.0.13"]
+	path = schemas/tlc_1.0.13
+	url = https://github.com/rsmp-nordic/rsmp_schema.git
+	branch = tlc_1.0.13
+[submodule "schemas/tlc_1.0.14"]
+	path = schemas/tlc_1.0.14
+	url = https://github.com/rsmp-nordic/rsmp_schema.git
+	branch = tlc_1.0.14

data/.rspec

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

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-03-25
+- Initial release
+
+## [0.2.0] - 2021-05-19
+- Updated interface

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rsmp_schemer.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,46 @@
+PATH
+  remote: .
+  specs:
+    rsmp_schemer (0.2.0)
+      json_schemer (~> 0.2.18)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    ecma-re-validator (0.3.0)
+      regexp_parser (~> 2.0)
+    hana (1.3.7)
+    json_schemer (0.2.18)
+      ecma-re-validator (~> 0.3)
+      hana (~> 1.3)
+      regexp_parser (~> 2.0)
+      uri_template (~> 0.7)
+    rake (13.0.3)
+    regexp_parser (2.1.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    uri_template (0.7.0)
+
+PLATFORMS
+  x86_64-darwin-20
+
+DEPENDENCIES
+  rake (~> 13.0)
+  rsmp_schemer!
+  rspec (~> 3.9.0)
+  rspec-expectations (~> 3.9.1)
+
+BUNDLED WITH
+   2.2.15

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2019 The City Copenhagen
+
+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,54 @@
+# RSMP Schemer
+Gem for validating RSMP messages against RSMP JSON schemas.
+
+## Background
+When communicating via RSMP, the version of core and SXL used is negotiated during connection, and can therefore vary depending on who you communicate with.
+
+To validate against the correct version of the JSON schema, all relevant versions need to be avaiable, so you can 
+
+The actual JSON scheme files are maintained in the repo https://github.com/rsmp-nordic/rsmp_schema. Different version of core and SXLs are mainted in different branches.
+
+Each of these branches are included here as submodules, so you can choose which core and SXL version you want to validate against.
+
+The actual validation is performed with the json_schemer gem.
+
+## Usage
+Use ```Schemer#validate``` to validate against a particular schema type and version.
+
+Validating against core and sxl schemas is done separately.
+The core schema validates everything that's common to all types of equipment/SXLs.
+SXL schemas validate the mesage types specific to a type of equipment.
+
+For example, the core schema will validate that a CommandRequest has all the correct attributes, e.g. that there is a command code. The SXL schema will validate the content of the attributes. e.g. that the command code represents a valid command.
+
+If there are validation errors and error will be returned, pointing to the offendig items.  The errors come from the json_schemer gem.
+
+Nil means there are no errors, ie. the message is valid.
+
+Example, validating an an AggregatedStatusRequest:
+
+```ruby
+message = {
+  "mType" => "rSMsg",
+  "type" => "AggregatedStatusRequest",
+  "mId" => "E68A0010-C336-41ac-BD58-5C80A72C7092",
+  "cId" => "AB+84001=860SG001"
+}
+
+# validing using core 3.1.4 will return an error, because the message
+# type AggregatedStatusRequest was not introduced until 3.1.5:
+errors = RSMP::Schemer.validate(message, core: '3.1.4')
+# => [["/type", "enum", nil]]
+
+# The first item '/type' indicate the field with error
+# The second item 'enum' indicate an invalid enum valiue
+
+# validating using core 3.1.5 will succeeed, ie. return no errors:
+errors = RSMP::Schemer.validate(message, core: '3.1.5')
+# => nil
+
+# validate against several schemas:
+errors = RSMP::Schemer.validate(message, core: '3.1.5', tlc: '1.0.15')
+# => nil
+```
+

data/Rakefile

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]
+
+namespace :schema do
+	# task for adding scheme. run this like:
+	# type=core version=3.1.3 rake schema:add
+
+  task :add do
+    type = ENV['type']
+    version = ENV['version']
+    raise ArgumentError.new("type argument is missing") unless /\w+/ =~ type
+    raise ArgumentError.new("version argument must be in the format <x.y.z>") unless /\d+\.\d+\.\d+/ =~ version
+    puts "Adding schema for #{type} #{version}"
+    cmd = "git submodule add -b #{type}_#{version} https://github.com/rsmp-nordic/rsmp_schema.git schemas/#{type}_#{version}"
+    puts "Running: #{cmd}"
+    system cmd
+  end
+end

data/bin/console

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

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require_relative "rsmp_schemer/version"
+require_relative "rsmp_schemer/error"
+require_relative "rsmp_schemer/schemer"

data/lib/rsmp_schemer/error.rb

@@ -0,0 +1,16 @@
+module RSMP
+  module Schemer
+
+    class Error < StandardError
+    end
+
+    class UnknownSchemaError < Error
+    end
+
+    class UnknownSchemaTypeError < UnknownSchemaError
+    end
+
+    class UnknownSchemaVersionError < UnknownSchemaError
+    end
+  end
+end

data/lib/rsmp_schemer/schemer.rb

@@ -0,0 +1,90 @@
+require 'json_schemer'
+
+module RSMP
+end
+
+module RSMP::Schemer
+  @@schemas = nil
+
+  def self.schemas
+    return @@schemas if @@schemas
+    schemas_path = File.expand_path( File.join(__dir__,'..','..','schemas') )
+    @@schemas = {
+      core: {
+        '3.1.2' => JSONSchemer.schema( Pathname.new(File.join(schemas_path, 'core_3.1.2/schema/core/rsmp.json')) ),
+        '3.1.3' => JSONSchemer.schema( Pathname.new(File.join(schemas_path, 'core_3.1.3/schema/core/rsmp.json')) ),
+        '3.1.4' => JSONSchemer.schema( Pathname.new(File.join(schemas_path, 'core_3.1.4/schema/core/rsmp.json')) ),
+        '3.1.5' => JSONSchemer.schema( Pathname.new(File.join(schemas_path, 'core_3.1.5/schema/core/rsmp.json')) )
+      },
+      # note that tlc 1.0.11 and 1.0.12 does not exist (unreleased drafts)
+      tlc: {
+        '1.0.7' => JSONSchemer.schema( Pathname.new(File.join(schemas_path, 'tlc_1.0.7/schema/tlc/sxl.json')) ),
+        '1.0.8' => JSONSchemer.schema( Pathname.new(File.join(schemas_path, 'tlc_1.0.8/schema/tlc/sxl.json')) ),
+        '1.0.9' => JSONSchemer.schema( Pathname.new(File.join(schemas_path, 'tlc_1.0.9/schema/tlc/sxl.json')) ),
+        '1.0.10' => JSONSchemer.schema( Pathname.new(File.join(schemas_path, 'tlc_1.0.10/schema/tlc/sxl.json')) ),
+        '1.0.13' => JSONSchemer.schema( Pathname.new(File.join(schemas_path, 'tlc_1.0.13/schema/tlc/sxl.json')) ),
+        '1.0.14' => JSONSchemer.schema( Pathname.new(File.join(schemas_path, 'tlc_1.0.14/schema/tlc/sxl.json')) ),
+        '1.0.15' => JSONSchemer.schema( Pathname.new(File.join(schemas_path, 'tlc_1.0.15/schema/tlc/sxl.json')) )
+      }
+    }
+  end
+
+  def self.validate_using_schema message, schema
+    raise ArgumentError.new("message missing") unless message
+    raise ArgumentError.new("schema missing") unless schema
+    unless schema.valid? message
+      schema.validate(message).map do |item|
+        [item['data_pointer'],item['type'],item['details']]
+      end
+    else
+      []
+    end
+  end
+
+  def self.find_schemas type
+    raise ArgumentError.new("type missing") unless type
+    schemas[type.to_sym]
+  end
+
+  def self.find_schemas! type
+    schemas = find_schemas type
+    raise UnknownSchemaTypeError.new("Unknown schema type #{type}") unless schemas
+    schemas
+  end
+
+  def self.find_schema type, version
+    raise ArgumentError.new("version missing") unless version
+    schemas = find_schemas type
+    if schemas
+      schemas[version] 
+    else
+      nil
+    end
+  end
+
+  def self.find_schema! type, version
+    raise ArgumentError.new("version missing") unless version
+    schemas = find_schemas! type
+    schema = schemas[version]
+    raise UnknownSchemaVersionError.new("Unknown schema version #{type} #{version}") unless schema
+    schema
+  end
+
+  def self.has_schema? type, version
+    find_schema(type,version) != nil
+  end
+
+  def self.validate message, schemas
+    raise ArgumentError.new("message missing") unless message
+    raise ArgumentError.new("schemas missing") unless schemas
+    raise ArgumentError.new("schemas must be a Hash") unless schemas.is_a?(Hash)
+    raise ArgumentError.new("schemas cannot be empty") unless schemas.any?
+    errors = schemas.flat_map do |type, version|
+      schema = find_schema! type, version
+      validate_using_schema(message, schema)
+    end
+    return nil if errors.empty?
+    errors
+  end
+
+end

data/lib/rsmp_schemer/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module RSMP
+	module Schemer
+  	VERSION = "0.2.0"
+	end
+end

data/rsmp_schemer.gemspec

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'pathname'
+require_relative "lib/rsmp_schemer/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rsmp_schemer"
+  spec.version       = RSMP::Schemer::VERSION
+  spec.authors       = ["Emil Tin"]
+  spec.email         = ["zf0f@kk.dk"]
+
+  spec.summary       = "Validate RSMP message against RSMP JSON Schema."
+  spec.description   = "Validate RSMP message against RSMP JSON Schema. Support validating against core and different SXL's, in different versions."
+  spec.homepage      = "https://github.com/rsmp-nordic/rsmp_schemer"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/CHANGELOG.md"
+
+  # 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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+
+  # Add schema files in submodules inside schema/
+  `git submodule --quiet foreach pwd`.split($\).each do |submodule_path|
+    Dir.chdir(submodule_path) do
+      relative_path = Pathname.new(submodule_path).relative_path_from __dir__
+      `git ls-files`.split($\).each do |filename|
+        spec.files << relative_path.join(filename).to_s
+      end
+    end
+  end
+
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "json_schemer", "~> 0.2.18"
+
+  spec.add_development_dependency "rspec", "~> 3.9.0"
+  spec.add_development_dependency "rspec-expectations", "~> 3.9.1"
+  spec.add_development_dependency "rake", "~> 13.0"
+end

data/schemas/core_3.1.2/.rspec

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

data/schemas/core_3.1.2/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rsmp.gemspec
+gem 'json_schemer'
+gem 'rspec'

data/schemas/core_3.1.2/Gemfile.lock

@@ -0,0 +1,37 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    ecma-re-validator (0.3.0)
+      regexp_parser (~> 2.0)
+    hana (1.3.7)
+    json_schemer (0.2.18)
+      ecma-re-validator (~> 0.3)
+      hana (~> 1.3)
+      regexp_parser (~> 2.0)
+      uri_template (~> 0.7)
+    regexp_parser (2.1.1)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    uri_template (0.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  json_schemer
+  rspec
+
+BUNDLED WITH
+   2.2.3