rsmp_schemer 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e979c4d4740c002ae59bfdd01d79fa770bbabc8023ca09aed92146d773fb3fb6
-  data.tar.gz: be144f4286d92e895f860bdc50000c44c775981ac974a4709f9b4246aad86058
+  metadata.gz: b7c8e9f715da2acbcc1478ce7a5d1e560f03ad2ce8573e4ef881c64246ee72b2
+  data.tar.gz: 2660b213fccd759cbeb37d6bd89aed7ecf7c0536864e28541b033394c8188416
 SHA512:
-  metadata.gz: 64bb52538722e23d8eacc81c0fbf5dc3f0a4b8990cf52addcbe0ce311f7c24b297de608847dc5615ec45eeb013710c1611bb72ae15e3da21ce5912afad54ec43
-  data.tar.gz: 3f58b379bc1b5dae8af62dd1b16461c918936c8b0d8649a5f485dbf8d5ae2497ce808a40aa6b9807675592c9712ea090efa929d475eee7ddeffddb7d11f70366
+  metadata.gz: fad06e4373eb7d018c03d1ac5ef8e4d3a4a8558b173fba41ee71c16ad48071b0780069e64a571b031a0da183bfa47e53168b489751c3fc055acd3e04d75cf2ce
+  data.tar.gz: 4b0982f0f40707364dbe8e6e6fa25abd3347c9107a174aa9cde4e925a448d930ed5172a440235b890d1871df5af0512d906ce09e8169425027ab557bc8f13a61

data/.gitmodules

@@ -1,44 +1,3 @@
-[submodule "schemas/core_3.1.2"]
-	path = schemas/core_3.1.2
+[submodule "schemas"]
+	path = schemas
 	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/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rsmp_schemer (0.4.2)
+    rsmp_schemer (0.5.0)
       json_schemer (~> 0.2.21)
 
 GEM

data/lib/rsmp_schemer/schemer.rb

@@ -8,23 +8,24 @@ module RSMP::Schemer
 
   def self.schemas
     return @@schemas if @@schemas
-    schemas_path = File.expand_path( File.join(__dir__,'..','..','schemas') )
+    schemas_path = File.expand_path( File.join(__dir__,'..','..','schemas','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')) )
+        '3.1.1' => JSONSchemer.schema( Pathname.new(File.join(schemas_path, 'core','3.1.1','rsmp.json')) ),
+        '3.1.2' => JSONSchemer.schema( Pathname.new(File.join(schemas_path, 'core','3.1.2','rsmp.json')) ),
+        '3.1.3' => JSONSchemer.schema( Pathname.new(File.join(schemas_path, 'core','3.1.3','rsmp.json')) ),
+        '3.1.4' => JSONSchemer.schema( Pathname.new(File.join(schemas_path, 'core','3.1.4','rsmp.json')) ),
+        '3.1.5' => JSONSchemer.schema( Pathname.new(File.join(schemas_path, 'core','3.1.5','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')) )
+        '1.0.7'  => JSONSchemer.schema( Pathname.new(File.join(schemas_path, 'tlc','1.0.7' ,'sxl.json')) ),
+        '1.0.8'  => JSONSchemer.schema( Pathname.new(File.join(schemas_path, 'tlc','1.0.8' ,'sxl.json')) ),
+        '1.0.9'  => JSONSchemer.schema( Pathname.new(File.join(schemas_path, 'tlc','1.0.9' ,'sxl.json')) ),
+        '1.0.10' => JSONSchemer.schema( Pathname.new(File.join(schemas_path, 'tlc','1.0.10','sxl.json')) ),
+        '1.0.13' => JSONSchemer.schema( Pathname.new(File.join(schemas_path, 'tlc','1.0.13','sxl.json')) ),
+        '1.0.14' => JSONSchemer.schema( Pathname.new(File.join(schemas_path, 'tlc','1.0.14','sxl.json')) ),
+        '1.0.15' => JSONSchemer.schema( Pathname.new(File.join(schemas_path, 'tlc','1.0.15','sxl.json')) )
       }
     }
   end

data/lib/rsmp_schemer/version.rb

@@ -2,6 +2,6 @@
 
 module RSMP
   module Schemer
-    VERSION = "0.4.2"
+    VERSION = "0.5.0"
   end
 end

data/schemas/Gemfile.lock

@@ -0,0 +1,37 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.5.0)
+    ecma-re-validator (0.4.0)
+      regexp_parser (~> 2.2)
+    hana (1.3.7)
+    json_schemer (0.2.21)
+      ecma-re-validator (~> 0.3)
+      hana (~> 1.3)
+      regexp_parser (~> 2.0)
+      uri_template (~> 0.7)
+    regexp_parser (2.5.0)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    uri_template (0.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  json_schemer
+  rspec
+
+BUNDLED WITH
+   2.3.19

data/schemas/README.md

@@ -0,0 +1,73 @@
+# About
+JSON Schema for RSMP messages. The schema can be used to automatically validate RSMP messages.
+
+The schema so far covers the core specifiation and the SXL for Trafic Light Controllers:
+https://github.com/rsmp-nordic/rsmp_core
+https://github.com/rsmp-nordic/rsmp_sxl_traffic_lights
+
+More about JSON Schema:
+https://json-schema.org/
+
+## Schema organisation
+The schema consists of a core schema shared by all equipment types, and an SXL schema for each supported equipment type. At the only SXL supported is for Traffic Light Controllers. An SXL defines massages specific to a particular type of equipment, but they all rely on the core part of the RSMP specification.
+
+Both core and SXL schemas exist in different version, for validation agaist a particular version of the spec.
+
+For example, to validate against the SXL for Trafic Light Controllers (TLCs), version 1.0.15, use the file schemas/tcl/1.0.15/sxl.json.
+
+Depending on the message type, relevant JSON Schema elements will be included to validate the detailed parameters, arguments, etc.
+
+For example, validating a CommandRequest M0001 message will include these parts:
+
+```
+sxl.json
+  commands.json
+    M0001.json
+```
+
+##  Usage
+The JSON Schema can be used from any language that provides a suitable JSON Schema validation library.
+
+For example, to validate a JSON message with Ruby using the json_schemer gem:
+
+```ruby
+require 'json_schemer'
+
+message = {
+  "mType" => "rSMsg",
+  "mId" => "4173c2c8-a933-43cb-9425-66d4613731ed",
+  "type" => "CommandRequest",
+  "siteId" => [
+    { "sId" => "RN+SI0001" }
+  ],
+  "cId" => "O+14439=481WA001",
+  "arg" => [
+    {
+      "cCI" => "M0001",
+      "n" => "status",
+      "cO" => "setValue",
+      "v" => "YellowFlash"
+    }
+  ]
+}
+
+# try validating a message against our schema
+schema = Pathname.new('schemas/tlc/1.0.15/sxl.json')
+schemer = JSONSchemer.schema(schema)
+puts schemer.valid? message     # => true
+```
+
+## RSpec tests
+The reposity includes RSpec test written in Ruby that checks the schema, by testing the result of validating a set of RSMP messages using the json_schemer gem.
+
+To run the tests, you need Ruby installed. Then run bundler to ensure you have rspec. Then run use the rspec command to run tests:
+
+```
+$ bundle              # install gems
+$ bundle exec rspec   # run rspec tests
+```
+
+## Schema maintenance
+The SXL JSON Schemas are generated automatically from their corresponding YAML source, and should therefore not be edited by hand. Instead, edit the YAML source and regenerate the schema files.
+
+The core schemas has no YAML sources and are maintained by hand.

data/schemas/examples/validate.rb

@@ -0,0 +1,32 @@
+require 'json_schemer'
+
+message = {
+  "mType" => "rSMsg",
+  "mId" => "4173c2c8-a933-43cb-9425-66d4613731ed",
+  "type" => "CommandRequest",
+  "siteId" => [
+    { "sId" => "RN+SI0001" }
+  ],
+  "cId" => "O+14439=481WA001",
+  "arg" => [
+    {
+      "cCI" => "M0002",
+      "n" => "timeplan",
+      "cO" => "setPlan",
+      "v" => "1"
+    }
+  ]
+}
+
+# try validating a message against our schema
+schema = Pathname.new('schema/tlc/sxl.json')
+schemer = JSONSchemer.schema(schema)
+if schemer.valid? message
+  puts 'ok'
+else
+  schemer.validate(message).each do |item|
+    puts [item['data_pointer'],item['type'],item['details']].compact.join(' ')
+  end
+end
+
+

data/schemas/schemas/core/3.1.1/alarm.json

@@ -0,0 +1,58 @@
+{
+  "title" :  "Alarm",
+  "description" :  "Alarm messsage",
+  "properties" : {
+    "mId" : { "$ref": "definitions.json#/message_id" },
+    "cId" : { "$ref": "definitions.json#/component_id" },
+    "aCId" : { "$ref": "definitions.json#/alarm_code" },
+    "xACId" : { "description" : "External alarm code id", "type" : "string" },
+    "aSp" : {
+      "description" : "Alarm specialization",
+      "type" : "string",
+      "enum" : [ "Issue", "Acknowledge", "Suspend", "Resume",
+                 "issue", "acknowledge", "suspend", "resume" ]
+    }
+  },
+  "required" : [ "aSp"],
+  "allOf" : [
+    {
+      "if": {
+        "required" : [ "aSp" ],
+        "properties" : {
+          "aSp" : { "enum" : [ "Issue",
+                               "issue"] }
+        }
+      },
+      "then": { "$ref": "alarm_issue.json" }
+    },
+    {
+      "if": {
+        "allOf" : [
+          {
+            "required" : [ "aSp" ],
+            "properties" : {
+              "aSp" : { "enum" : [ "Suspend", "Resume",
+                                   "suspend", "resume"] }
+            }
+          },
+          {
+            "not": { "required" : [ "sS" ] }
+          }
+        ]
+      },
+      "then": { "$ref": "alarm_suspend_resume.json" }
+    },
+    {
+      "if": {
+        "required" : [ "aSp", "sS" ],
+        "properties" : {
+          "aSp" : { "enum" : [ "Suspend", "Resume",
+                               "suspend", "resume"] },
+          "sS" : { "enum" : [ "suspended", "notSuspended",
+                              "Suspended", "NotSuspended" ] }
+        }
+      },
+      "then": { "$ref": "alarm_suspended_resumed.json" }
+    }
+  ]
+}

data/schemas/schemas/core/3.1.1/alarm_suspended_resumed.json

@@ -0,0 +1,47 @@
+{
+  "properties" : {
+    "ack" : {
+      "description" : "Acknowledgement",
+      "type" : "string",
+      "enum" : [ "Acknowledged", "notAcknowledged",
+                 "acknowledged", "NotAcknowledged" ]
+    },
+    "aS" : {
+      "description" : "Active status",
+      "type" : "string",
+      "enum" : [ "inActive", "Active",
+                 "InActive", "active" ]
+    },
+    "sS" : {
+      "description" : "Suspend status",
+      "type" : "string",
+      "enum" : [ "suspended", "notSuspended",
+                 "Suspended", "NotSuspended" ]
+    },
+    "aTs" : { "$ref": "definitions.json#/timestamp" },
+    "cat" : {
+      "description" : "Category",
+      "type" : "string",
+      "enum" : [ "T", "D" ]
+    },
+    "pri" : {
+      "description" : "Priority",
+      "type" : "string",
+      "enum" : [ "1", "2", "3" ]
+    },
+    "rvs" : {
+      "description" : "Return values",
+      "type" : "array",
+      "items" : {
+        "type" : "object",
+        "properties": {
+          "n" : { "description" : "Unique reference of the value", "type" : "string" },
+          "v" : { "description" : "Value", "type" : "string" }
+        },
+        "required" : [ "n", "v" ],
+        "additionalProperties": false
+      }
+    }
+  },
+  "required" : [ "mId", "cId", "aCId", "xACId", "aSp", "ack", "aS", "aTs", "sS", "cat", "pri", "rvs" ]
+}

data/schemas/schemas/core/3.1.1/command_response.json

@@ -0,0 +1,34 @@
+{
+  "title" :  "CommandRequest",
+  "description" :  "Command request",
+  "properties" : {
+    "mId" : { "$ref": "definitions.json#/message_id" },
+    "cId" : { "$ref": "definitions.json#/component_id" },
+    "cTS" : { "$ref": "definitions.json#/timestamp" },
+    "rvs" : {
+      "description" : "Command arguments",
+      "type" : "array",
+      "items" : {
+        "type" : "object",
+        "properties": {
+          "cCI" : { "$ref": "definitions.json#/command_code" },
+          "n" : {
+            "description" : "Unique reference of the value",
+            "type" : "string"
+          },
+          "v" : {
+            "description" : "Value"
+          },
+          "age" : {
+            "description" : "Age of the value",
+            "type" : "string",
+            "enum" : [ "recent", "old", "undefined", "unknown" ]
+          }
+        },
+        "required" : [ "cCI", "n", "v", "age" ],
+        "additionalProperties": false
+      }
+    }
+  },
+  "required" : [ "mId", "cId", "cTS", "rvs" ]
+}

data/schemas/schemas/core/3.1.1/core.json

@@ -0,0 +1,38 @@
+{
+  "$schema" : "http://json-schema.org/draft-07/schema#",
+  "name" : "core",
+  "description" : "Core",
+  "version" : "3.1.1",
+  "type" :  "object",
+  "allOf" : [
+    {
+      "properties" : {
+        "mType" : {
+          "description" : "Supported RSMP versions",
+          "type" : "string",
+          "const" : "rSMsg"
+        },
+        "type" : {
+          "description" : "Type of RMSP message",
+          "type" : "string",
+          "enum" : [
+            "MessageAck",
+            "MessageNotAck",
+            "Version",
+            "AggregatedStatus",
+            "Watchdog",
+            "Alarm",
+            "CommandRequest",
+            "CommandResponse",
+            "StatusRequest",
+            "StatusResponse",
+            "StatusSubscribe",
+            "StatusUnsubscribe",
+            "StatusUpdate"
+          ]
+        }
+      },
+      "required" : [ "mType", "type" ]
+    }
+  ]
+}

data/schemas/schemas/core/3.1.1/status_response.json

@@ -0,0 +1,30 @@
+{
+  "title" :  "StatusResponse",
+  "description" :  "Status response",
+  "properties" : {
+    "mId" : { "$ref": "definitions.json#/message_id" },
+    "cId" : { "$ref": "definitions.json#/component_id" },
+    "sTs" : { "$ref": "definitions.json#/timestamp" },
+    "sS" : {
+      "description" : "Status response arguments",
+      "type" : "array",
+      "minItems": 1,
+      "items" : {
+        "type" : "object",
+        "properties": {
+          "sCI" : { "$ref": "definitions.json#/status_code" },
+          "n" : { "description" : "Unique reference of the value", "type" : "string" },
+          "s" : { "description" : "Value", "type" : "string" },
+          "ageState" : {
+            "description" : "Value",
+            "type" : "string",
+            "enum" : [ "recent", "old", "undefined", "unknown" ]
+          }
+        },
+        "required" : [ "sCI", "n", "s", "ageState" ],
+        "additionalProperties": false
+      }
+    }
+  },
+  "required" : [ "mId", "cId", "sTs", "sS" ]
+}

data/schemas/schemas/core/3.1.1/status_update.json

@@ -0,0 +1,30 @@
+{
+  "title" :  "StatusUpdate",
+  "description" :  "Status update",
+  "properties" : {
+    "mId" : { "$ref": "definitions.json#/message_id" },
+    "cId" : { "$ref": "definitions.json#/component_id" },
+    "sTs" : { "$ref": "definitions.json#/timestamp" },
+    "sS" : {
+      "description" : "Status update arguments",
+      "type" : "array",
+      "minItems": 1,
+      "items" : {
+        "type" : "object",
+        "properties": {
+          "sCI" : { "$ref": "definitions.json#/status_code" },
+          "n" : { "description" : "Unique reference of the value", "type" : "string" },
+          "s" : { "description" : "Value", "type" : "string" },
+          "ageState" : {
+            "description" : "Value",
+            "type" : "string",
+            "enum" : [ "recent", "old", "undefined", "unknown" ]
+          }
+        },
+        "required" : [ "sCI", "n", "s", "ageState" ],
+        "additionalProperties": false
+      }
+    }
+  },
+  "required" : [ "mId", "cId", "sTs", "sS" ]
+}

data/schemas/schemas/core/3.1.1/watchdog.json

@@ -0,0 +1,9 @@
+{
+  "title" :  "Watchdog",
+  "description" :  "Watchdog message",
+  "properties" : {
+    "mId" : { "$ref": "definitions.json#/message_id" },
+    "wTs" : { "$ref": "definitions.json#/timestamp" }
+  },
+  "required" : [ "mId", "wTs" ]
+}

data/schemas/schemas/core/3.1.2/rsmp.json

@@ -0,0 +1,3 @@
+{
+  "$ref": "../3.1.1/rsmp.json"      // no changes from 3.1.1
+}