rsmp 0.1.0

data/lib/rsmp/supervisor_proxy.rb

@@ -0,0 +1,292 @@
+# Handles a site connection to a remote supervisor
+
+module RSMP  
+  class SupervisorProxy < Proxy
+
+    attr_reader :supervisor_id, :site
+
+    def initialize options
+      super options
+      @site = options[:site]
+      @site_settings = @site.site_settings.clone
+      @ip = options[:ip]
+      @port = options[:port]
+      @status_subscriptions = {}
+      @status_subscriptions_mutex = Mutex.new
+    end
+
+    def node
+      site
+    end
+
+    def start
+      log "Connecting to superviser at #{@ip}:#{@port}", level: :info
+      super
+      connect
+      @logger.unmute @ip, @port
+      start_reader
+      send_version @site_settings["rsmp_versions"]
+    rescue Errno::ECONNREFUSED
+      log "No connection to supervisor at #{@ip}:#{@port}", level: :error
+      unless @site.site_settings["reconnect_interval"] == :no
+        log "Will try to reconnect again every #{@site.site_settings["reconnect_interval"]} seconds..", level: :info
+        @logger.mute @ip, @port
+      end
+    end
+
+    def connect
+      return if @socket
+      @endpoint = Async::IO::Endpoint.tcp(@ip, @port)
+      @socket = @endpoint.connect
+      @stream = Async::IO::Stream.new(@socket)
+      @protocol = Async::IO::Protocol::Line.new(@stream,"\f") # rsmp messages are json terminated with a form-feed
+    end
+
+    def connection_complete
+      super
+      log "Connection to supervisor established", level: :info
+      start_watchdog
+    end
+
+    def process_message message
+      case message
+        when Alarm
+        when StatusResponse
+        when StatusUpdate
+        when AggregatedStatus
+          will_not_handle message
+        when CommandRequest
+          process_command_request message
+        when CommandResponse
+          process_command_response message
+        when StatusRequest
+          process_status_request message
+        when StatusSubscribe
+          process_status_subcribe message
+        when StatusUnsubscribe
+          process_status_unsubcribe message
+        else
+          super message
+      end
+    end
+
+    def acknowledged_first_ingoing message
+      # TODO
+      # aggregateds status should only be send for later version of rsmp
+      # to handle verison differences, we probably need inherited classes
+      case message.type
+        when "Watchdog"
+          if @site_settings['send_after_connect']
+            send_all_aggregated_status
+          end
+      end
+    end
+
+    def send_all_aggregated_status
+      @site.components.each_pair do |c_id,component|
+        if component.grouped
+          send_aggregated_status component
+        end
+      end
+    end
+
+    def reconnect_delay
+      interval = @site_settings["reconnect_interval"]
+      log "Waiting #{interval} seconds before trying to reconnect", level: :info
+      @task.sleep interval
+    end
+
+    def version_accepted message, rsmp_version
+      log "Received Version message, using RSMP #{rsmp_version}", message: message, level: :log
+      start_timer
+      acknowledge message
+      connection_complete
+      @version_determined = true
+    end
+
+    def send_aggregated_status component
+      message = AggregatedStatus.new({
+        "aSTS" => RSMP.now_string,
+        "cId" =>  component.c_id,
+        "fP" => nil,
+        "fS" => nil,
+        "se" => component.aggregated_status_bools
+      })
+      send_message message
+    end
+
+    def process_aggregated_status message
+      se = message.attribute("se")
+      validate_aggregated_status(message,se) == false
+      on = set_aggregated_status se
+      log "Received #{message.type} status [#{on.join(', ')}]", message: message, level: :log
+      acknowledge message
+    end
+
+    def process_alarm message
+      alarm_code = message.attribute("aCId")
+      asp = message.attribute("aSp")
+      status = ["ack","aS","sS"].map { |key| message.attribute(key) }.join(',')
+      log "Received #{message.type}, #{alarm_code} #{asp} [#{status}]", message: message, level: :log
+      acknowledge message
+    end
+
+    def process_command_request message
+      log "Received #{message.type}", message: message, level: :log
+      rvs = []
+      message.attributes["arg"].each do |arg|
+        unless arg['cCI'] && arg['n'] && arg['v']
+          dont_acknowledge message, '', 'bad arguments'
+          return
+        end 
+        rvs << { "cCI" => arg["cCI"],
+                 "n" => arg["n"],
+                 "v" => arg["v"],
+                 "age" => "recent" }
+      end
+
+      response = CommandResponse.new({
+        "cId"=>message.attributes["cId"],
+        "cTS"=>RSMP.now_string,
+        "rvs"=>rvs
+      })
+      acknowledge message
+      send_message response
+    end
+
+    def process_status_request message
+      log "Received #{message.type}", message: message, level: :log
+      sS = message.attributes["sS"].clone.map do |request|
+        request["s"] = rand(100).to_s
+        request["q"] = "recent"
+        request
+      end
+      response = StatusResponse.new({
+        "cId"=>message.attributes["cId"],
+        "sTs"=>RSMP.now_string,
+        "sS"=>sS
+      })
+      acknowledge message
+      send_message response
+    end
+
+    def process_status_subcribe message
+      log "Received #{message.type}", message: message, level: :log
+
+      # @status_subscriptions is organized by component/code/name, for example:
+      #
+      # {"AA+BBCCC=DDDEE002"=>{"S001"=>["number"]}}
+      #
+      # This is done to make it easy to send a single status update
+      # for each component, containing all the requested statuses
+
+      update_list = {}
+
+      component = message.attributes["cId"]
+      
+      @status_subscriptions[component] ||= {}    
+      update_list[component] ||= {} 
+
+      message.attributes["sS"].each do |arg|
+        subcription = {interval: arg["uRt"].to_i, last_sent_at: nil}
+        @status_subscriptions[component][arg["sCI"]] ||= {}
+        @status_subscriptions[component][arg["sCI"]][arg["n"]] = subcription
+
+        update_list[component][arg["sCI"]] ||= []
+        update_list[component][arg["sCI"]] << arg["n"]
+      end
+      acknowledge message
+      send_status_updates update_list   # send status after subscribing is accepted
+    end
+
+    def process_status_unsubcribe message
+      log "Received #{message.type}", message: message, level: :log
+      component = message.attributes["cId"]
+
+      if @status_subscriptions[component]
+         message.attributes["sS"].each do |arg|
+          if @status_subscriptions[component][arg["sCI"]]
+            @status_subscriptions[component][arg["sCI"]].delete arg["n"]
+          end
+          if @status_subscriptions[component][arg["sCI"]].empty?
+            @status_subscriptions[component].delete(arg["sCI"])
+          end
+        end
+        if @status_subscriptions[component].empty?
+          @status_subscriptions.delete(component)
+        end
+      end
+      acknowledge message
+    end
+
+    def timer now
+      super
+      status_update_timer now if ready?
+    end
+
+    def status_update_timer now
+      update_list = {}
+      # go through subscriptons and build a similarly organized list,
+      # that only contains what should be send
+
+      @status_subscriptions.each_pair do |component,by_code|
+        by_code.each_pair do |code,by_name|
+          by_name.each_pair do |name,subscription|
+            if subscription[:interval] == 0 
+              # send as soon as the data changes
+              if rand(100) >= 90
+                should_send = true
+              end
+            else
+              # send at regular intervals
+              if subscription[:last_sent_at] == nil || (now - subscription[:last_sent_at]) >= subscription[:interval]
+                should_send = true
+              end
+            end
+            if should_send
+              subscription[:last_sent_at] = now
+              update_list[component] ||= {}
+              update_list[component][code] ||= []
+              update_list[component][code] << name
+           end
+          end
+        end
+      end
+      send_status_updates update_list
+    rescue StandardError => e
+      log ["Status update exception: #{e}",e.backtrace].flatten.join("\n"), level: :error
+    end
+
+    def send_status_updates update_list
+      now = RSMP.now_string
+      update_list.each_pair do |component,by_code|
+        sS = []
+        by_code.each_pair do |code,names|
+          names.each do |name|
+            sS << { "sCI": code,
+                     "n": name,
+                     "s": rand(100),
+                     "q": "recent" }
+          end
+        end
+        update = StatusUpdate.new({
+          "cId"=>component,
+          "sTs"=>now,
+          "sS"=>sS
+        })
+        send_message update
+      end
+    end
+
+    def send_alarm
+      message = Alarm.new({
+        "aSTS"=>RSMP.now_string,
+        "fP"=>nil,
+        "fS"=>nil,
+        "se"=>@site.aggregated_status_bools
+      })
+      send_message message
+    end
+
+  end
+end

data/lib/rsmp/version.rb

@@ -0,0 +1,3 @@
+module RSMP
+  VERSION = "0.1.0"
+end

data/lib/rsmp/wait.rb

@@ -0,0 +1,17 @@
+# Helper for waiting for an Async condition using a block
+
+module RSMP
+  class Wait
+
+    def self.wait_for task, condition, timeout, &block
+      task.with_timeout(timeout) do
+        loop do
+          value = condition.wait
+          result = yield value 
+          return result if result   # return result of check, if not nil
+        end
+      end
+    end   
+
+  end
+end

data/lib/rsmp.rb

@@ -0,0 +1,29 @@
+require 'yaml'
+require 'socket'
+require 'time'
+require 'async/io'
+require 'async/io/protocol/line'
+require 'colorize'
+require 'json'
+require 'securerandom'
+require 'json_schemer'
+require 'async/queue'
+
+require 'rsmp/rsmp'
+require 'rsmp/base'
+require 'rsmp/wait'
+require 'rsmp/version'
+require 'rsmp/node'
+require 'rsmp/supervisor'
+require 'rsmp/component'
+require 'rsmp/site_base'
+require 'rsmp/site'
+require 'rsmp/proxy'
+require 'rsmp/supervisor_proxy'
+require 'rsmp/site_proxy'
+require 'rsmp/error'
+require 'rsmp/probe'
+require 'rsmp/probe_collection'
+require 'rsmp/message'
+require 'rsmp/logger'
+require 'rsmp/archive'

data/rsmp.gemspec

@@ -0,0 +1,43 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "rsmp/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rsmp"
+  spec.version       = RSMP::VERSION
+  spec.authors       = ["Emil Tin"]
+  spec.email         = ["zf0f@kk.dk"]
+
+  spec.summary       = %q{RoadSide Message Protocol (RSMP) library.}
+  spec.description   = %q{Easy RSMP site and supervisor communication.}
+  spec.homepage      = "https://github.com/rsmp-nordic/rsmp"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/rsmp-nordic/rsmp"
+  spec.metadata["changelog_uri"] = "https://github.com/rsmp-nordic/rsmp/blob/master/CHANGELOG.md"
+  spec.metadata["bug_tracker_uri"] = "https://github.com/rsmp-nordic/rsmp/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 "async", "~> 1.23.0"
+  spec.add_dependency "async-io", "~> 1.27.0"
+  spec.add_dependency "colorize", "~> 0.8.1"
+  spec.add_dependency "thor", "~> 0.20.3"
+  spec.add_dependency "json_schemer", "~> 0.2.8"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec-expectations", "~> 3.8.3"
+  spec.add_development_dependency "rspec-with_params", "~> 0.2.0"
+  spec.add_development_dependency "timecop", "~> 0.9.1"
+  spec.add_development_dependency "cucumber", "~> 3.1.2"
+  spec.add_development_dependency "aruba", "~> 0.14.11"
+end

metadata

@@ -0,0 +1,266 @@
+--- !ruby/object:Gem::Specification
+name: rsmp
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Emil Tin
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-11-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: async
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.23.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.23.0
+- !ruby/object:Gem::Dependency
+  name: async-io
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.27.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.27.0
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.3
+- !ruby/object:Gem::Dependency
+  name: json_schemer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.8
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-expectations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.3
+- !ruby/object:Gem::Dependency
+  name: rspec-with_params
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.2
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.11
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.11
+description: Easy RSMP site and supervisor communication.
+email:
+- zf0f@kk.dk
+executables:
+- rsmp
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".gitmodules"
+- ".rspec"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- config/site.yaml
+- config/supervisor.yaml
+- exe/rsmp
+- lib/rsmp.rb
+- lib/rsmp/alarm.rb
+- lib/rsmp/archive.rb
+- lib/rsmp/base.rb
+- lib/rsmp/cli.rb
+- lib/rsmp/component.rb
+- lib/rsmp/error.rb
+- lib/rsmp/logger.rb
+- lib/rsmp/message.rb
+- lib/rsmp/node.rb
+- lib/rsmp/probe.rb
+- lib/rsmp/probe_collection.rb
+- lib/rsmp/proxy.rb
+- lib/rsmp/rsmp.rb
+- lib/rsmp/site.rb
+- lib/rsmp/site_base.rb
+- lib/rsmp/site_proxy.rb
+- lib/rsmp/supervisor.rb
+- lib/rsmp/supervisor_base.rb
+- lib/rsmp/supervisor_proxy.rb
+- lib/rsmp/version.rb
+- lib/rsmp/wait.rb
+- rsmp.gemspec
+homepage: https://github.com/rsmp-nordic/rsmp
+licenses: []
+metadata:
+  homepage_uri: https://github.com/rsmp-nordic/rsmp
+  source_code_uri: https://github.com/rsmp-nordic/rsmp
+  changelog_uri: https://github.com/rsmp-nordic/rsmp/blob/master/CHANGELOG.md
+  bug_tracker_uri: https://github.com/rsmp-nordic/rsmp/issues
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: RoadSide Message Protocol (RSMP) library.
+test_files: []