rsmp_schemer 0.4.0 → 0.5.0

data/schemas/core_3.1.2/Gemfile.lock

@@ -1,37 +0,0 @@
-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

data/schemas/core_3.1.2/README.md

@@ -1,70 +0,0 @@
-# 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 is split into multiple files to enable reuse.
-
-An SXL defines massages specific to a particular type of equipment, but they all rely on the core part of the RSMP specification.
-
-To validate a message against a particular SXL, use the sxl.json file in the relevant folder.
-For example, to validate against the SXL for Trafic Light Controllers (TLCs), include 'tcl/sxl.json'
-
-This main sxl.json file includes the core.json part, which contains validations for the RSMP core elements.
-Depending on the message type, commands.json, alarms.json, etc. will be included. That file in turn looks at the command/status/alarm code and includes the file describing the detailed parameters, arguments, etc.
-
-For example, validating a CommandRequest M0001 message will include these parts:
-
-```
-sxl.json
-  core.json
-  commands.json
-    M0001.json
-```
-
-## Example usage
-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('tlc/sxl.json')
-schemer = JSONSchemer.schema(schema)
-puts schemer.valid? message     # => true
-```
-
-## RSpec tests
-The reposity includes RSpec test that checks the schema, by testing the result of validating a set of valid and invalid RSMP messages using the json_schemer gem.
-
-This is useful when developing the schema, to ensure it validates correctly.
-
-
-```
-$ bundle              # install gems
-$ bundle exec rspec   # run rspec tests
-```

data/schemas/core_3.1.2/examples/validate.rb

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

data/schemas/core_3.1.2/schema/core/alarm.json

@@ -1,55 +0,0 @@
-{
-  "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 message variant",
-      "type" : "string",
-      "enum" : [ "Issue", "Acknowledge", "Suspend", "Resume" ]
-    },
-    "ack" : {
-      "description" : "Acknowledgement",
-      "type" : "string",
-      "enum" : [ "Acknowledged", "notAcknowledged" ]
-    },
-    "aS" : {
-      "description" : "Status",
-      "type" : "string",
-      "enum" : [ "inActive", "Active" ]
-    },
-    "sS" : {
-      "description" : "Suspended",
-      "type" : "string",
-      "enum" : [ "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" ],
-        "additionProperties": false
-      }
-    }
-  },
-  "required" : [ "mId", "cId", "aCId", "xACId", "aSp", "ack", "aS", "aTs", "sS", "cat", "pri", "rvs" ]
-}

data/schemas/core_3.1.2/schema/core/command_response.json

@@ -1,34 +0,0 @@
-{
-  "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" ],
-        "additionProperties": false
-      }
-    }
-  },
-  "required" : [ "mId", "cId", "cTS", "rvs" ]
-}

data/schemas/core_3.1.2/schema/core/core.json

@@ -1,35 +0,0 @@
-{
-  "$schema" : "http://json-schema.org/draft-07/schema#",
-  "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.2/schema/core/status_response.json

@@ -1,30 +0,0 @@
-{
-  "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.2/schema/core/status_update.json

@@ -1,30 +0,0 @@
-{
-  "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.2/schema/core/watchdog.json

@@ -1,9 +0,0 @@
-{
-  "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.2/spec/core/aggregated_status_spec.rb

@@ -1,80 +0,0 @@
-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