rb_banyan 0.1.2.pre

data/README.md

@@ -0,0 +1,135 @@
+## A Simple Echo Server
+```
+require 'rb_banyan/banyan_base.rb'
+
+class SimpleEchoServer < BanyanBase
+
+  def initialize
+    # set the process name for the console banner
+    super(process_name: 'SimpleEchoServer')
+    
+    # allow time for zmq connections to complete
+    sleep(0.3)
+
+    # set the subscriber topic
+    set_subscriber_topic('echo')
+
+    # wait for messages to arrive
+    begin
+      receive_loop
+    rescue SystemExit, Interrupt
+      clean_up
+    end
+  end
+
+  # process incoming messages - just resend the payload with
+  # a topic of 'reply'
+  def incoming_message_processing(_topic, payload)
+    publish_payload(payload, 'reply')
+  end
+end
+
+
+SimpleEchoServer.new
+
+```
+## A Simple Echo Client
+
+```
+require 'rubygems'
+require 'rb_banyan/banyan_base.rb'
+
+# This is a simple echo client. It sends out a series of messages and expects an
+# echo reply from the server
+
+# To use: 1. Start the backplane.
+#         2. Start the server.
+#         3. Start this client.
+
+class SimpleEchoClient < BanyanBase
+
+  def initialize
+
+    # set the process name for the console banner
+    super(process_name:'SimpleEchoClient')
+
+    # allow time for zmq connections to complete
+    sleep(0.3)
+
+    # initialize the number of messages to send and receive
+    @number_of_messages = @message_number = 10
+
+    # set the subscriber topic
+    set_subscriber_topic('reply')
+
+    # send the first message
+    publish_payload({'message_number': @message_number}, 'echo')
+
+    # adjust the message number for the next send
+    @message_number -= 1
+
+    # get the reply messages
+    # wait for messages to arrive
+    begin
+      receive_loop
+    rescue SystemExit, Interrupt
+      clean_up
+    end
+  end
+
+  # With each incoming message, adjust the message number and 
+  # publish the next message until the count is achieved.
+  def incoming_message_processing(_topic, payload)
+    # if all messages received, we are done.
+    if payload['message_number'] == 0
+        puts('All messages sent and received')
+        clean_up
+        exit(0)
+
+    # we have more to send - bump the message number and send the message out
+    else
+      @message_number -= 1
+      publish_payload({'message_number': @message_number}, 'echo')
+    end
+  end
+end
+
+SimpleEchoClient.new
+
+```
+
+# RbBanyan
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rb_banyan`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rb_banyan'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rb_banyan
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rb_banyan.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rb_banyan"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/examples/banyan_base/simple_echo_client.rb

@@ -0,0 +1,85 @@
+########################################################################################
+# Copyright (c) 2017 Alan Yorinks - All Rights Reserved.
+#
+# This file is part of JavaScript-Banyan.
+#
+# Ruby Banyan is free software; you can redistribute it and/or
+# modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
+# Version 3 as published by the Free Software Foundation; either
+# or (at your option) any later version.
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# General Public License for more details.
+
+# You should have received a copy of the GNU AFFERO GENERAL PUBLIC LICENSE
+# along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+#
+# simple_echo_server.rb
+########################################################################################
+
+require_relative '../../lib/rb_banyan/banyan_base.rb'
+
+# This is a simple echo client. It sends out a series of messages and expects an
+# echo reply from the server
+
+# To use: 1. Start the backplane.
+#         2. Start the server.
+#        3. Start this client.
+
+class SimpleEchoClient < BanyanBase
+
+  def initialize(process_name: 'SimpleEchoClient',
+                 subscribe_topic: 'echo',
+                 publish_topic: 'reply',
+                 publish_payload: {'message_number': @message_number})
+
+    super(process_name:process_name)
+
+    # allow time for zmq connections to complete
+    sleep(0.3)
+
+    # initialize the number of messages to send and receive
+    @number_of_messages = @message_number = 10
+
+
+
+    # set the subscriber topic
+    set_subscriber_topic('reply')
+
+    # send the first message - make sure that the server is already started
+    publish_payload({'message_number': @message_number}, 'echo')
+    # adjust the message number for the next send
+    @message_number -= 1
+
+    # get the reply messages
+    begin
+      receive_loop
+    rescue SystemExit, Interrupt
+      clean_up
+      exit(0)
+    end
+  end
+
+  def incoming_message_processing(_topic, payload)
+    if payload['message_number'] == 0
+      # all messages sent - wait for user to press Enter to exit the client.
+      begin
+        puts((@number_of_messages).to_s + ' messages sent and received. ')
+        puts('Press enter to exit.')
+        gets
+        clean_up
+        exit(0)
+      end
+
+      # bump the message number and send the message out
+    else
+      @message_number -= 1
+      publish_payload({'message_number': @message_number}, 'echo')
+    end
+
+  end
+end
+
+SimpleEchoClient.new

data/examples/banyan_base/simple_echo_server.rb

@@ -0,0 +1,97 @@
+########################################################################################
+# Copyright (c) 2017 Alan Yorinks - All Rights Reserved.
+#
+# This file is part of JavaScript-Banyan.
+#
+# Ruby Banyan is free software; you can redistribute it and/or
+# modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
+# Version 3 as published by the Free Software Foundation; either
+# or (at your option) any later version.
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# General Public License for more details.
+
+# You should have received a copy of the GNU AFFERO GENERAL PUBLIC LICENSE
+# along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+#
+# simple_echo_server.rb
+#############################################################################
+
+require_relative '../../lib/rb_banyan/banyan_base.rb'
+###################################################################
+# This is a very basic echo server.
+# It subscribes to receive messages with a topic of 'echo', and
+# when a message is received, it publishes the received payload,
+# with a topic of 'reply'
+###################################################################
+class SimpleEchoServer < BanyanBase
+
+  def initialize(process_name: 'SimpleEchoServer',
+                 subscribe_topic: 'echo',
+                 publish_topic: 'reply')
+
+    super(process_name:process_name)
+    sleep(0.3)
+
+    @subscribe_topic = subscribe_topic
+    @publish_topic = publish_topic
+
+    # allow time for zmq connections to complete
+
+    # set the subscriber topic
+    set_subscriber_topic(@subscribe_topic)
+
+    # wait for messages to arrive
+    begin
+      receive_loop
+    rescue SystemExit, Interrupt
+      clean_up
+    end
+
+  end
+
+  # process incoming messages - just resend the payload with
+  # a topic of 'reply'
+  def incoming_message_processing(_topic, payload)
+    publish_payload(payload, @publish_topic)
+  end
+
+end
+
+
+options = { process_name: 'MultiEchoClient',
+            subscribe_topic: 'echo',
+            publish_topic: 'reply'}
+
+optparse = OptionParser.new do |opts|
+  opts.on('-n', '--n Process Name',
+          'Name Of This Banyan Component') do |process_name|
+    options[:process_name] = process_name
+  end
+
+  opts.on('-p', '--p Publish Topic',
+          'Topic String') do |loop_time|
+    options[:publish_topic] = loop_time
+  end
+
+  opts.on('-s', '--s Subscribe Topic',
+          'Topic String') do |loop_time|
+    options[:subscribe_topic] = loop_time
+  end
+
+  opts.on('-h', '--help', 'Display this screen') do
+    puts opts
+    exit
+  end
+end
+
+begin
+  optparse.parse!
+end
+
+options[:loop_time] = options[:loop_time].to_f
+SimpleEchoServer.new(process_name: options[:process_name],
+                    publish_topic: options[:publish_topic],
+                    subscribe_topic: options[:subscribe_topic])

data/examples/coverage/.last_run.json

@@ -0,0 +1,5 @@
+{
+  "result": {
+    "covered_percent": 100.0
+  }
+}

data/exe/rb_backplane

@@ -0,0 +1,150 @@
+#!/usr/bin/env ruby
+
+
+###########################################################################
+# Copyright (c) 2017 Alan Yorinks - All Rights Reserved.
+#
+# This file is part of Ruby-Banyan.
+#
+# Ruby Banyan is free software; you can redistribute it and/or
+# modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
+# Version 3 as published by the Free Software Foundation; either
+# or (at your option) any later version.
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# General Public License for more details.
+
+# You should have received a copy of the GNU AFFERO GENERAL PUBLIC LICENSE
+# along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+#
+# banyan_base.rb
+#############################################################################
+
+require 'rubygems'
+require 'ffi-rzmq'
+require 'socket'
+require 'msgpack'
+require 'optparse'
+
+###################################################################
+# This the banyan backplane for ruby. It must be started before
+# any other banyan components are invoked.
+
+###################################################################
+
+# noinspection RubyResolve,RubyResolve
+
+class BackPlane
+
+  def initialize(subscriber_port: '43125', publisher_port: '43124',
+                 process_name: 'Backplane', loop_time: 0.001)
+
+    # This is the initializer for the Banyan BackPlane class. The class must be instantiated
+    # before starting any other Python Banyan modules
+
+    # :param subscriber_port: subscriber IP port number
+    # :param publisher_port: publisher IP port number
+    # :param backplane_name: name to appear on the console for this backplane
+    # :param loop_time: event loop idle timer
+
+    @subscriber_port = subscriber_port
+    @publisher_port = publisher_port
+    @process_name = process_name
+    @loop_time = loop_time
+
+    @back_plane_ip_address = Socket.ip_address_list[1].ip_address
+
+    puts('************************************************************')
+    # noinspection RubyResolve
+    puts(process_name + ' BackPlane on IP address: ' +
+             @back_plane_ip_address)
+    puts('Subscriber Port = ' + @subscriber_port)
+    puts('Publisher  Port = ' + @publisher_port)
+    puts('Loop Time = ' + @loop_time.to_s + ' seconds')
+    puts('************************************************************')
+
+    # establish the zeromq sub and pub sockets and connect to the backplane
+    @context = ZMQ::Context.create
+
+    @subscriber = @context.socket ZMQ::SUB
+    @publisher = @context.socket ZMQ::PUB
+
+    # subscribe to all messages
+    @subscriber.setsockopt ZMQ::SUBSCRIBE, ''
+
+    # noinspection RubyResolve
+    # this looks backwards, but is correct. the backplane
+    # accepts messages and re-sends them.
+    @subscriber.bind 'tcp://' + @back_plane_ip_address + ':' + @publisher_port
+    @publisher.bind 'tcp://' + @back_plane_ip_address + ':' + @subscriber_port
+    trap("INT") {puts "Control C detected - bye bye."; @publisher.close; @subscriber.close; @context.terminate; exit}
+
+    loop do
+      list = []
+      p = @subscriber.recv_strings(list, ZMQ::DONTWAIT)
+      begin
+        if p == -1
+          sleep(@loop_time)
+          if ZMQ::Util.errno == ZMQ::EAGAIN
+            next
+          else
+            puts ZMQ::Util.errno
+          end
+        else
+          @publisher.send_strings(list, flags = ZMQ::DONTWAIT)
+        end
+      rescue Interrupt
+        clean_up
+      end
+    end
+  end
+
+  def clean_up
+    # cleanup before exiting
+
+    @publisher.close
+    @subscriber.close
+    @context.terminate
+    exit
+  end
+end
+
+options = {publisher_port: '43124',
+           subscriber_port: '43125', process_name: 'Unknown',
+           loop_time: '0.01'}
+
+optparse = OptionParser.new do |opts|
+
+  opts.on('-p', '--p PUBLISHER PORT', 'Publisher Port Number') do |publisher_port|
+    options[:publisher_port] = publisher_port
+  end
+
+  opts.on('-s', '--s SUBSCRIBER PORT', 'Subscriber Port Number') do |subscriber_port|
+    options[:subscriber_port] = subscriber_port
+  end
+
+  opts.on('-n', '--n Process Name', 'Name Of This Banyan Component') do |process_name|
+    options[:process_name] = process_name
+  end
+
+  opts.on('-t', '--t Loop Delay Time', 'Time In Seconds') do |loop_time|
+    options[:loop_time] = loop_time
+  end
+  opts.on('-h', '--help', 'Display this screen') do
+    puts opts
+    exit
+  end
+end
+
+begin
+  optparse.parse!
+end
+
+options[:loop_time] = options[:loop_time].to_f
+BackPlane.new(subscriber_port: options[:subscriber_port],
+              publisher_port: options[:publisher_port],
+              process_name: options[:process_name],
+              loop_time: options[:loop_time])
+

data/exe/rb_monitor

@@ -0,0 +1,75 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/rb_banyan/banyan_base.rb'
+
+
+class RBMonitor < BanyanBase
+  def initialize(back_plane_ip_address: nil, subscriber_port: '43125', publisher_port: '43124',
+                 process_name: 'Monitor', loop_time: 0.1)
+
+    back_plane_ip_address = Socket.ip_address_list[1].ip_address if back_plane_ip_address.nil?
+
+    super(back_plane_ip_address: back_plane_ip_address, subscriber_port: subscriber_port, publisher_port: publisher_port,
+          process_name: process_name, loop_time: loop_time)
+
+    # allow time for zmq connections to complete
+    sleep(0.3)
+
+    set_subscriber_topic('')
+
+    # wait for messages to arrive
+    begin
+      receive_loop
+    rescue SystemExit, Interrupt
+      clean_up
+    end
+  end
+
+  def incoming_message_processing(topic, payload)
+    puts(topic, payload)
+    STDOUT.flush
+  end
+end
+
+options = {back_plane_ip_address: nil, publisher_port: '43124',
+           subscriber_port: '43125', process_name: 'Banyan Monitor',
+           loop_time: '0.001'}
+
+optparse = OptionParser.new do |opts|
+  opts.on('-b', '--b Backplane Ip Address', 'IP address of Backplane in use') do |back_plane_ip_address|
+    options[:back_plane_ip_address] = back_plane_ip_address
+  end
+
+  opts.on('-p', '--p PUBLISHER PORT', 'Publisher Port Number') do |publisher_port|
+    options[:publisher_port] = publisher_port
+  end
+
+  opts.on('-s', '--s SUBSCRIBER PORT', 'Subscriber Port Number') do |subscriber_port|
+    options[:subscriber_port] = subscriber_port
+  end
+
+  opts.on('-n', '--n Process Name', 'Name Of This Banyan Component') do |process_name|
+    options[:process_name] = process_name
+  end
+
+  opts.on('-t', '--t Loop Delay Time', 'Time In Seconds') do |loop_time|
+    options[:loop_time] = loop_time
+  end
+  opts.on('-h', '--help', 'Display this screen') do
+    puts opts
+    exit
+  end
+end
+
+begin
+  optparse.parse!
+end
+
+options[:loop_time] = options[:loop_time].to_f
+b = RBMonitor.new(back_plane_ip_address: options[:back_plane_ip_address],
+                      subscriber_port: options[:subscriber_port],
+                      publisher_port: options[:publisher_port],
+                      process_name: options[:process_name],
+                      loop_time: options[:loop_time])
+
+