rsmp_schema 0.1.0

data/rsmp_schema.gemspec

@@ -0,0 +1,40 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pathname'
+require_relative "lib/rsmp_schema/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rsmp_schema"
+  spec.version       = RSMP::Schema::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_schema"
+  spec.licenses      = ['MIT']
+  spec.required_ruby_version = '>= 3.0.0'
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/CHANGELOG.md"
+  spec.metadata["bug_tracker_uri"] = "#{spec.homepage}/issues"
+
+  # 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('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "json_schemer", "~> 0.2.21"
+  spec.add_dependency "thor", "~> 1.2.1"
+
+  spec.add_development_dependency "bundler", "~> 2.3.19"
+  spec.add_development_dependency "rake", "~> 13.0.6"
+  spec.add_development_dependency "rspec", "~> 3.11.0"
+  spec.add_development_dependency "rspec-expectations", "~> 3.11.0"
+end

data/schemas/core/3.1.1/aggregated_status.json

@@ -0,0 +1,25 @@
+{
+  "title" :  "Aggregated Status",
+  "description" :  "Aggregated status message",
+  "properties" : {
+    "mId" : { "$ref": "definitions.json#/message_id" },
+    "aSTS" : { "$ref": "definitions.json#/timestamp" },
+    "fP" : {
+      "description" : "Functional position",
+      "type" : "string, null"
+    },
+    "fS" : {
+      "description" : "Functional position",
+      "type" : "string, null"
+    },
+    "se" : {
+      "type" : "array",
+      "minItems": 8,
+      "maxItems": 8,
+      "items" : {
+        "type" : "boolean"
+      }
+    }
+  },
+  "required" : [ "mId", "aSTS", "fP", "fS", "se" ]
+}

data/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/core/3.1.1/alarm_issue.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/core/3.1.1/alarm_suspend_resume.json

@@ -0,0 +1,3 @@
+{
+  "required" : [ "mId", "cId", "aCId", "xACId", "aSp" ]
+}

data/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/core/3.1.1/command_request.json

@@ -0,0 +1,24 @@
+{
+  "title" :  "CommandRequest",
+  "description" :  "Command request",
+  "properties" : {
+    "mId" : { "$ref": "definitions.json#/message_id" },
+    "cId" : { "$ref": "definitions.json#/component_id" },
+    "arg" : {
+      "description" : "Command arguments",
+      "type" : "array",
+      "minItems": 1,
+      "items" : {
+        "type" : "object",
+        "properties": {
+          "cCI" : { "$ref": "definitions.json#/command_code" },
+          "n" : { "description" : "Unique reference of the value", "type" : "string" },
+          "cO" : { "description" : "Command", "type" : "string" },
+          "v" : { "description" : "Value" }
+        },
+        "required" : [ "cCI", "n", "cO", "v" ]
+      }
+    }
+  },
+  "required" : [ "mId", "cId", "arg"]
+}

data/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/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/core/3.1.1/definitions.json

@@ -0,0 +1,67 @@
+{
+  "message_id": {
+    "description" : "Message Id",
+    "type": "string",
+    "$comment" : "Example: 1.2.3 or 1.2",
+    "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
+  },
+  "timestamp" : {
+    "description" : "Timestamp",
+    "type": "string",
+    "$comment" : "Example: 2015-06-08T11:49:03.293Z",
+    "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}\\.[0-9]{3}Z$"
+  },
+  "integer" : {
+    "description" : "Integer as string",
+    "type": "string",
+    "$comment" : "Example: 123 or -123",
+    "pattern": "^\\-?[0-9]+$"
+  },
+  "version": {
+    "description" : "Version",
+    "type": "string",
+    "$comment" : "Example: 1.2.3 or 1.2",
+    "pattern" : "^[0-9]{1,2}\\.[0-9]{1,2}(\\.[0-9]{1,2})?"
+  },
+  "command_code": {
+    "description" : "Command code id",
+    "type" : "string",
+    "pattern" : "^M"
+  },
+  "status_code": {
+    "description" : "Status code id",
+    "type" : "string",
+    "pattern" : "^S"
+  },
+  "alarm_code": {
+    "description" : "Alarm code id",
+    "type" : "string",
+    "pattern" : "^A"
+  },
+  "component_id": {
+    "description" : "Compoment id",
+    "type" : "string"
+  },
+  "boolean": {
+    "description" : "Boolean as string",
+    "type" : "string",
+    "enum" : [ "True", "False" ]
+  },
+  "integer_list": {
+    "description" : "Comma-separated list of integers as strings",
+    "type" : "string",
+    "pattern" : "^(\\-?\\d+)(?:,(\\-?\\d+))*$"
+  },
+  "boolean_list": {
+    "description" : "Comma-separated list of booleans as strings",
+    "type" : "string",
+    "pattern" : "^(True|False)(?:,(True|False))*$"
+  },
+  "string_list": {
+    "description" : "Comma-separated list of strings",
+    "type" : "string"
+  }
+}
+
+
+

data/schemas/core/3.1.1/message_ack.json

@@ -0,0 +1,11 @@
+{
+  "title" :  "MessageAck",
+  "description" :  "Message acknowledged",
+  "properties" : {
+    "oMId" : {
+      "$ref": "definitions.json#/message_id",
+      "description" : "Old message id"
+    }
+  },
+  "required" : [ "oMId" ]
+}

data/schemas/core/3.1.1/message_not_ack.json

@@ -0,0 +1,15 @@
+{
+  "title" :  "MessageNotAck",
+  "description" :  "Message not acknowledgeded",
+  "properties" : {
+    "oMId" : {
+      "$ref": "definitions.json#/message_id",
+      "description" : "Old message id"
+    },
+    "rea" : {
+      "description" : "Reason / Error message",
+      "type" : "string"
+    }
+  },
+  "required" : [ "oMId" ]
+}

data/schemas/core/3.1.1/rsmp.json

@@ -0,0 +1,124 @@
+{
+  "allOf": [
+    {
+      "$ref": "core.json"
+    },
+    {
+      "if": {
+        "required" : ["type"],
+        "properties": { "type": { "const": "MessageAck" } }
+      },
+      "then": {
+        "$ref": "message_ack.json"
+      }
+    },
+    {
+      "if": {
+        "required" : ["type"],
+        "properties": { "type": { "const": "MessageNotAck" } }
+      },
+      "then": {
+        "$ref": "message_not_ack.json"
+      }
+    },
+    {
+      "if": {
+        "required" : ["type"],
+        "properties": { "type": { "const": "Version" } }
+      },
+      "then": {
+        "$ref": "version.json"
+      }
+    },
+    {
+      "if": {
+        "required" : ["type"],
+        "properties": { "type": { "const": "AggregatedStatus" } }
+      },
+      "then": {
+        "$ref": "aggregated_status.json"
+      }
+    },
+    {
+      "if": {
+        "required" : ["type"],
+        "properties": { "type": { "const": "Watchdog" } }
+      },
+      "then": {
+        "$ref": "watchdog.json"
+      }
+    },
+    {
+      "if": {
+        "required" : ["type"],
+        "properties": { "type": { "const": "Alarm" } }
+      },
+      "then": {
+        "$ref": "alarm.json"
+      }
+    },
+    {
+      "if": {
+        "required" : ["type"],
+        "properties": { "type": { "const": "CommandRequest" } }
+      },
+      "then": {
+        "$ref": "command_request.json"
+      }
+    },
+    {
+      "if": {
+        "required" : ["type"],
+        "properties": { "type": { "const": "CommandResponse" } }
+      },
+      "then": {
+        "$ref": "command_response.json"
+      }
+    },
+    {
+      "if": {
+        "required" : ["type"],
+        "properties": { "type": { "const": "StatusRequest" } }
+      },
+      "then": {
+        "$ref": "status_request.json"
+      }
+    },
+    {
+      "if": {
+        "required" : ["type"],
+        "properties": { "type": { "const": "StatusResponse" } }
+      },
+      "then": {
+        "$ref": "status_response.json"
+      }
+    },
+    {
+      "if": {
+         "required" : ["type"],
+       "properties": { "type": { "const": "StatusSubscribe" } }
+      },
+      "then": {
+        "$ref": "status_subscribe.json"
+      }
+    },
+    {
+      "if": {
+        "required" : ["type"],
+        "properties": { "type": { "const": "StatusUnsubscribe" } }
+      },
+      "then": {
+        "$ref": "status_unsubscribe.json"
+      }
+    },
+    {
+      "if": {
+        "required" : ["type"],
+        "properties": { "type": { "const": "StatusUpdate" } }
+      },
+      "then": {
+        "$ref": "status_update.json"
+      }
+    }
+  ]
+}

data/schemas/core/3.1.1/status.json

@@ -0,0 +1,21 @@
+{
+  "properties" : {
+    "mId" : { "$ref": "definitions.json#/message_id" },
+    "cId" : { "$ref": "definitions.json#/component_id" },
+    "sS" : {
+      "description" : "Status request arguments",
+      "type" : "array",
+      "minItems": 1,
+      "items" : {
+        "type" : "object",
+        "properties": {
+          "sCI" : { "$ref": "definitions.json#/status_code" },
+          "n" : { "description" : "Unique reference of the value", "type" : "string" }
+        },
+        "required" : [ "sCI", "n" ],
+        "additionalProperties": false
+      }
+    }
+  },
+  "required" : [ "mId", "cId", "sS"]
+}

data/schemas/core/3.1.1/status_request.json

@@ -0,0 +1,5 @@
+{
+  "title" :  "StatusRequest",
+  "description" :  "Status request",
+  "$ref": "status.json"
+}

data/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/core/3.1.1/status_subscribe.json

@@ -0,0 +1,27 @@
+{
+  "title" :  "StatusSubscribe",
+  "description" :  "Status subscribe",
+  "properties" : {
+    "mId" : { "$ref": "definitions.json#/message_id" },
+    "cId" : { "$ref": "definitions.json#/component_id" },
+    "sS" : {
+      "description" : "Status request arguments",
+      "type" : "array",
+      "minItems": 1,
+      "items" : {
+        "type" : "object",
+        "properties": {
+          "sCI" : { "$ref": "definitions.json#/status_code" },
+          "n" : { "description" : "Unique reference of the value", "type" : "string" },
+          "uRt" : {
+            "$ref": "definitions.json#/integer",
+            "description" : "Update interval in seconds, 0 means send when value changes"
+          }
+        },
+        "required" : [ "sCI", "n", "uRt" ],
+        "additionalProperties": false
+      }
+    }
+  },
+  "required" : [ "mId", "cId", "sS"]
+}

data/schemas/core/3.1.1/status_unsubscribe.json

@@ -0,0 +1,5 @@
+{
+  "title" :  "StatusUnsubscribe",
+  "description" :  "Status unsubscribe",
+  "$ref": "status.json"
+}

data/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" ]
+}