rsmp_schemer 0.2.0

data/schemas/core_3.1.4/schema/core/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.4/schema/core/status_request.json

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

data/schemas/core_3.1.4/schema/core/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" },
+          "q" : {
+            "description" : "Value",
+            "type" : "string",
+            "enum" : [ "recent", "old", "undefined", "unknown" ]
+        }
+        },
+        "required" : [ "sCI", "n", "s", "q" ],
+        "additionProperties": false
+      }
+    }
+  },
+  "required" : [ "mId", "cId", "sTs", "sS" ]
+}

data/schemas/core_3.1.4/schema/core/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.4/schema/core/status_unsubscribe.json

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

data/schemas/core_3.1.4/schema/core/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" },
+          "q" : {
+            "description" : "Value",
+            "type" : "string",
+            "enum" : [ "recent", "old", "undefined", "unknown" ]
+        }
+        },
+        "required" : [ "sCI", "n", "s", "q" ],
+        "additionProperties": false
+      }
+    }
+  },
+  "required" : [ "mId", "cId", "sTs", "sS" ]
+}

data/schemas/core_3.1.4/schema/core/version.json

@@ -0,0 +1,47 @@
+{
+  "title" :  "Version",
+  "description" :  "Version message",
+  "properties" : {
+    "mId" : { "$ref": "definitions.json#/message_id" },
+    "RSMP" : {
+      "description" : "Supported RSMP versions",
+      "type" : "array",
+      "items" : {
+        "type" : "object",
+        "properties" : {
+          "vers" : {
+            "$ref": "definitions.json#/version",
+            "description" : "RSMP version"
+          }
+        },
+        "required" : ["vers"],
+        "additionalProperties" : false
+      },
+      "minItems" : 1,
+      "uniqueItems" : true
+    },
+    "SXL" : {
+      "$ref": "definitions.json#/version",
+      "description" : "SXL version"
+    },
+    "siteId" : {
+      "description" : "Site ids",
+      "type" : "array",
+      "items" : {
+        "type" : "object",
+        "properties" : {
+          "sId" : {
+            "type" : "string",
+            "minLength": 1
+          }
+        },
+        "required" : [ "sId" ],
+        "additionalProperties" : false
+      },
+      "minItems" : 1,
+      "uniqueItems" : true,
+      "additionalProperties" : false
+    }
+  },
+  "required" : [ "mId", "RSMP", "SXL", "siteId" ]
+}

data/schemas/core_3.1.4/schema/core/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/core_3.1.4/spec/core/aggregated_status_spec.rb

@@ -0,0 +1,80 @@
+RSpec.describe "Traffic Light Controller RSMP SXL Schema validation" do
+	let(:message) {{
+		"mType" => "rSMsg",
+		"type" => "AggregatedStatus",
+		"mId" => "be12ab9a-800c-4c19-8c50-adf832f22420",
+		"cId" => "O+14439=481WA001",
+		"aSTS" => "2015-06-08T08:05:06.584Z",
+		"fP" => nil,
+		"fS" => nil,
+		"se" => [
+			true,false,false,false,false,false,false,false
+		]
+	}}
+
+	it 'accepts valid message' do
+	  expect( validate(message) ).to be_nil
+  end
+
+  it 'catches missing mId' do
+		invalid = message.dup
+		invalid.delete 'mId'
+	  expect( validate(invalid) ).to eq([
+	  	["", "required", {"missing_keys"=>["mId"]}]
+	  ])
+  end
+
+  it 'catches missing aSTS' do
+		invalid = message.dup
+		invalid.delete 'aSTS'
+	  expect( validate(invalid) ).to eq([
+	  	["", "required", {"missing_keys"=>["aSTS"]}]
+	  ])
+  end
+
+  it 'catches bad aSTS' do
+		invalid = message.dup
+		invalid['aSTS'] = "2015-06-08T08:05:06.5843Z"
+	  expect( validate(invalid) ).to eq([
+	  	["/aSTS", "pattern"]
+	  ])
+  end
+
+  it 'catches missing se' do
+		invalid = message.dup
+		invalid.delete 'se'
+	  expect( validate(invalid) ).to eq([
+	  	["", "required", {"missing_keys"=>["se"]}]
+	  ])
+  end
+
+  it 'catches bad se' do
+		invalid = message.dup
+		invalid['se'] = 123
+	  expect( validate(invalid) ).to eq([
+	  	["/se", "array"]
+	  ])
+
+		invalid = message.dup
+		invalid['se'] = [true,false,false,false,false,false,false]
+	  expect( validate(invalid) ).to eq([
+	  	["/se", "minItems"]
+	  ])
+
+		invalid = message.dup
+		invalid['se'] = [true,false,false,false,false,false,false,true,true]
+	  expect( validate(invalid) ).to eq([
+	  	["/se", "maxItems"]
+	  ])
+
+		invalid = message.dup
+		invalid['se'] = [false,false,false,1,nil,"",false,false]
+	  expect( validate(invalid) ).to eq([
+	  	["/se/3", "boolean"],
+	  	["/se/4", "boolean"],
+	  	["/se/5", "boolean"]
+	  ])
+
+	end
+
+end

data/schemas/core_3.1.4/spec/core/alarm_request_spec.rb

@@ -0,0 +1,72 @@
+RSpec.describe "Traffic Light Controller RSMP SXL Schema validation" do
+  let(:message) {{
+    "mType" => "rSMsg",
+    "type" => "Alarm",
+    "mId" => "E68A0010-C336-41ac-BD58-5C80A72C7092",
+    "cId" => "AB+84001=860SG001",
+    "aCId" => "A0001",
+    "aSp" => "Request"
+  }}
+
+  it 'accepts valid alarm request' do
+    expect( validate(message) ).to be_nil
+  end
+
+
+  it 'catches missing component id' do
+    invalid = message.dup
+    invalid.delete 'cId'
+    expect( validate(invalid) ).to eq([
+      ["", "required", {"missing_keys"=>["cId"]}]
+    ])
+  end
+
+  it 'catches missing alarm code id' do
+    invalid = message.dup
+    invalid.delete 'aCId'
+    expect( validate(invalid) ).to eq([
+      ["", "required", {"missing_keys"=>["aCId"]}]
+    ])
+  end
+
+  it 'catches bad alarm code id' do
+    invalid = message.dup
+    invalid['aCId'] = "001"
+    expect( validate(invalid) ).to eq([
+      ["/aCId", "pattern"]
+    ])
+  end
+
+  it 'catches wrong alarm code id type' do
+    invalid = message.dup
+    invalid['aCId'] = 123
+    expect( validate(invalid) ).to eq([
+      ["/aCId", "string"]
+    ])
+  end
+
+  it 'catches missing extended alarm code id' do
+    invalid = message.dup
+    invalid.delete 'xACId'
+    expect( validate(invalid) ).to eq([
+      ["", "required", {"missing_keys"=>["xACId"]}]
+    ])
+  end
+
+  it 'catches wrong extended alarm code id type' do
+    invalid = message.dup
+    invalid['xACId'] = 123
+    expect( validate(invalid) ).to eq([
+      ["/xACId", "string"]
+    ])
+  end
+
+  it 'catches extraneous alarm code id' do
+    invalid = message.dup
+    invalid['aS'] = 'Active'
+    expect( validate(invalid) ).to eq([
+      ["", "required", {"missing_keys"=>["aS"]}]
+    ])
+  end
+
+end

data/schemas/core_3.1.4/spec/core/alarm_spec.rb

@@ -0,0 +1,298 @@
+RSpec.describe "Traffic Light Controller RSMP SXL Schema validation" do
+	let(:message) {{
+		"mType" => "rSMsg",
+		"type" => "Alarm",
+		"mId" => "E68A0010-C336-41ac-BD58-5C80A72C7092",
+		"cId" => "AB+84001=860SG001",
+		"aCId" => "A0001",
+		"xACId" => "Serious lamp error",
+		"aSp" => "Issue",
+		"ack" => "notAcknowledged",
+		"aS" => "Active",
+		"sS" => "notSuspended",
+		"aTs" => "2009-10-01T11:59:31.571Z",
+		"cat" => "D",
+		"pri" => "2",
+		"rvs" => [
+		  {
+		    "n" => "color",
+		    "v" => "red"
+		  }
+		]
+	}}
+
+  it 'accepts valid alarm' do
+	  expect( validate(message) ).to be_nil
+  end
+
+  it 'catches missing component id' do
+		invalid = message.dup
+		invalid.delete 'cId'
+	  expect( validate(invalid) ).to eq([
+	  	["", "required", {"missing_keys"=>["cId"]}]
+	  ])
+  end
+
+  it 'catches missing alarm code id' do
+		invalid = message.dup
+		invalid.delete 'aCId'
+	  expect( validate(invalid) ).to eq([
+	  	["", "required", {"missing_keys"=>["aCId"]}]
+	  ])
+  end
+
+  it 'catches bad alarm code id' do
+		invalid = message.dup
+		invalid['aCId'] = "001"
+	  expect( validate(invalid) ).to eq([
+	  	["/aCId", "pattern"]
+	  ])
+	end
+
+  it 'catches wrong alarm code id type' do
+		invalid = message.dup
+		invalid['aCId'] = 123
+	  expect( validate(invalid) ).to eq([
+	  	["/aCId", "string"]
+	  ])
+  end
+
+  it 'catches missing extended alarm code id' do
+		invalid = message.dup
+		invalid.delete 'xACId'
+	  expect( validate(invalid) ).to eq([
+	  	["", "required", {"missing_keys"=>["xACId"]}]
+	  ])
+  end
+
+  it 'catches wrong extended alarm code id type' do
+		invalid = message.dup
+		invalid['xACId'] = 123
+	  expect( validate(invalid) ).to eq([
+	  	["/xACId", "string"]
+	  ])
+  end
+
+  it 'catches missing state' do
+		invalid = message.dup
+		invalid.delete 'aSp'
+	  expect( validate(invalid) ).to eq([
+	  	["", "required", {"missing_keys"=>["aSp"]}]
+	  ])
+  end
+
+  it 'catches bad state' do
+		invalid = message.dup
+		invalid['aSp'] = "Bad"
+	  expect( validate(invalid) ).to eq([
+	  	["/aSp", "enum"]
+	  ])
+	end
+
+  it 'catches wrong state type' do
+		invalid = message.dup
+		invalid['aSp'] = 123
+	  expect( validate(invalid) ).to eq([
+	  	["/aSp", "enum"],
+	  	["/aSp", "string"]
+	  ])
+  end
+
+  it 'catches missing alarm code id' do
+		invalid = message.dup
+		invalid.delete 'aS'
+	  expect( validate(invalid) ).to eq([
+	  	["", "required", {"missing_keys"=>["aS"]}]
+	  ])
+  end
+
+  it 'catches bad alarm code id' do
+		invalid = message.dup
+		invalid['aS'] = "Bad"
+	  expect( validate(invalid) ).to eq([
+	  	["/aS", "enum"]
+	  ])
+	end
+
+  it 'catches wrong alarm code id type' do
+		invalid = message.dup
+		invalid['aS'] = 123
+	  expect( validate(invalid) ).to eq([
+	  	["/aS", "enum"],
+	  	["/aS", "string"]
+	  ])
+  end
+
+  it 'catches missing alarm code id' do
+		invalid = message.dup
+		invalid.delete 'sS'
+	  expect( validate(invalid) ).to eq([
+	  	["", "required", {"missing_keys"=>["sS"]}]
+	  ])
+  end
+
+  it 'catches bad alarm code id' do
+		invalid = message.dup
+		invalid['sS'] = "Bad"
+	  expect( validate(invalid) ).to eq([
+	  	["/sS", "enum"]
+	  ])
+	end
+
+  it 'catches wrong alarm code id type' do
+		invalid = message.dup
+		invalid['sS'] = 123
+	  expect( validate(invalid) ).to eq([
+	  	["/sS", "enum"],
+	  	["/sS", "string"]
+	  ])
+  end
+
+  it 'catches missing alarm code id' do
+		invalid = message.dup
+		invalid.delete 'ack'
+	  expect( validate(invalid) ).to eq([
+	  	["", "required", {"missing_keys"=>["ack"]}]
+	  ])
+  end
+
+  it 'catches bad alarm code id' do
+		invalid = message.dup
+		invalid['ack'] = "Bad"
+	  expect( validate(invalid) ).to eq([
+	  	["/ack", "enum"]
+	  ])
+	end
+
+  it 'catches wrong alarm code id type' do
+		invalid = message.dup
+		invalid['ack'] = 123
+	  expect( validate(invalid) ).to eq([
+	  	["/ack", "enum"],
+	  	["/ack", "string"]
+	  ])
+  end
+
+  it 'catches missing category' do
+		invalid = message.dup
+		invalid.delete 'cat'
+	  expect( validate(invalid) ).to eq([
+	  	["", "required", {"missing_keys"=>["cat"]}]
+	  ])
+  end
+
+  it 'catches bad category' do
+		invalid = message.dup
+		invalid['cat'] = "A"
+	  expect( validate(invalid) ).to eq([
+	  	["/cat", "enum"]
+	  ])
+	end
+
+  it 'catches wrong category' do
+		invalid = message.dup
+		invalid['cat'] = 123
+	  expect( validate(invalid) ).to eq([
+	  	["/cat", "enum"],
+	  	["/cat", "string"]
+	  ])
+  end
+
+  it 'catches missing priority' do
+		invalid = message.dup
+		invalid.delete 'pri'
+	  expect( validate(invalid) ).to eq([
+	  	["", "required", {"missing_keys"=>["pri"]}]
+	  ])
+  end
+
+  it 'catches bad priority' do
+		invalid = message.dup
+		invalid['pri'] = "4"
+	  expect( validate(invalid) ).to eq([
+	  	["/pri", "enum"]
+	  ])
+	end
+
+  it 'catches wrong priority' do
+		invalid = message.dup
+		invalid['pri'] = 1
+	  expect( validate(invalid) ).to eq([
+	  	["/pri", "enum"],
+	  	["/pri", "string"]
+	  ])
+  end
+
+  it 'catches missing timestamp' do
+		invalid = message.dup
+		invalid.delete 'aTs'
+	  expect( validate(invalid) ).to eq([
+	  	["", "required", {"missing_keys"=>["aTs"]}]
+	  ])
+  end
+
+  it 'catches bad timestamp' do
+		invalid = message.dup
+		invalid['aTs'] = "yesterday"
+	  expect( validate(invalid) ).to eq([
+	  	["/aTs", "pattern"]
+	  ])
+	end
+
+  it 'catches wrong timestamp type' do
+		invalid = message.dup
+		invalid['aTs'] = 123
+	  expect( validate(invalid) ).to eq([
+	  	["/aTs", "string"]
+	  ])
+  end
+
+  it 'catches missing rvs' do
+		invalid = message.dup
+		invalid.delete 'rvs'
+	  expect( validate(invalid) ).to eq([
+	  	["", "required", {"missing_keys"=>["rvs"]}]
+	  ])
+  end
+
+  it 'catches bad rvs type' do
+		invalid = message.dup
+		invalid["rvs"] = {}
+	  expect( validate(invalid) ).to eq([
+	  	["/rvs", "array"]
+	  ])
+  end
+
+  it 'catches missing alarm name' do
+		invalid = message.dup
+		invalid["rvs"].first.delete 'n'
+	  expect( validate(invalid) ).to eq([
+	  	["/rvs/0", "required", {"missing_keys"=>["n"]}]
+	  ])
+  end
+
+  it 'catches bad alarm name' do
+		invalid = message.dup
+		invalid["rvs"].first['n'] = 3
+	  expect( validate(invalid) ).to eq([
+	  	["/rvs/0/n", "string"]
+	  ])
+  end
+
+  it 'catches missing alarm value' do
+		invalid = message.dup
+		invalid["rvs"].first.delete 'v'
+	  expect( validate(invalid) ).to eq([
+	  	["/rvs/0", "required", {"missing_keys"=>["v"]}]
+	  ])
+  end
+
+  it 'catches bad alarm value' do
+		invalid = message.dup
+		invalid["rvs"].first['v'] = 3
+	  expect( validate(invalid) ).to eq([
+	  	["/rvs/0/v", "string"]
+	  ])
+  end
+
+end