gmsec 0.0.1

data/examples/gm_msg_config

@@ -0,0 +1,87 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+
+require 'gmsec'
+require 'commander'
+
+class Program
+  include Commander::Methods
+  include GMSEC
+
+  MESSAGE_TYPES = %w[
+    LOG ARCHIVE-MESSAGE-RETRIEVAL-REQUEST ARCHIVE-MESSAGE-RETRIEVAL-RESPONSE
+    DIRECTIVE-REQUEST DIRECTIVE-RESPONSE C2CX-CONFIGURATION C2CX-CONTROL
+    C2CX-DEVICE C2CX-HEARTBEAT C2CX-RESOURCE TELEMETRY-CCSDS-PACKET
+    TELEMETRY-CCSDS-FRAME REPLAY-TELEMETRY-REQUEST REPLAY-TELEMETRY-RESPONSE
+    MNEMONIC-VALUE-REQUEST MNEMONIC-VALUE-RESPONSE MNEMONIC-VALUE-DATA-MESSAGE
+    ARCHIVE-MNEMONIC-VALUE-REQUEST ARCHIVE-MNEMONIC-VALUE-RESPONSE
+    ARCHIVE-MNEMONIC-VALUE-DATA DATABASE-ATTRIBUTES-REQUEST
+    DB-RESPONSE-LIMIT-SET DB-RESPONSE-TEXT-CONVERSION DB-RESPONSE-CAL-CURVE
+    DB-RESPONSE-SHORT-DESCRIPTION DB-RESPONSE-LONG-DESCRIPTION
+    DB-RESPONSE-LIST-OF-MNEMONICS COMMAND-REQUEST COMMAND-RESPONSE 
+    PRODUCT-REQUEST PRODUCT-RESPONSE PRODUCT-MSG]
+
+  def run
+    program :name, 'gm_msg_config'
+    program :version, VERSION
+    program :description, 'Ruby implementation of the gm_msg_config.c example GMSEC program'
+
+    default_command :run
+
+    command :run do |c|
+      c.syntax = 'usage: gm_msg_config <filename.xml>'
+      c.description = 'Read the contents of a config file and prompt the user to which messages they would like to publish.'
+      c.action do |args, options|
+
+        say API.api_version
+
+        config_file = ConfigFile.new(args.first)
+
+        config = GMSEC::Config.from_config_file(config_file, "GMSEC-MESSAGE-BUS").tap do |config|
+          say config.to_xml
+        end
+
+        connection = Connection.new(config).tap do |connection|
+          connection.connect
+          say connection.library_version
+        end
+
+        while 
+          # Ask user for message type.
+          message_type = ask_for_message_type
+
+          # Create a new message from the connection.
+          message = connection.new_message.tap do |message|
+            message.load_fields_from_config_file(config_file, message_type)
+            say message.to_xml
+          end
+
+          connection.publish(message)
+
+          break unless agree("Display another format_message? (y/n)")
+        end
+      end
+    end
+
+    run!
+  end
+
+  def ask_for_message_type
+    MESSAGE_TYPES.each_with_index do |config_type, i|
+      say "#{i+1}.)\t#{config_type}"
+    end
+
+    message_number = ask(<<-TEXT.gsub(/^\s+/, ""), Integer) do |q|
+      ======================================================================
+      Select the number of the desired GMSEC Message format to be displayed:
+      ======================================================================
+    TEXT
+      q.in = 1..MESSAGE_TYPES.length
+    end
+
+    MESSAGE_TYPES[message_number]
+  end
+end
+
+Program.new.run if $0 == __FILE__

data/examples/gmconfig

@@ -0,0 +1,57 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+
+require 'gmsec'
+require 'commander'
+
+class Program
+  include Commander::Methods
+  include GMSEC
+
+  def run
+    program :name, 'gm_msg_config'
+    program :version, VERSION
+    program :description, 'Ruby implementation of the gmconfig.c example GMSEC program'
+
+    default_command :run
+
+    command :run do |c|
+      c.syntax = 'usage: gmconfig_c <filename>'
+      c.description = 'Read a configuration file and publish a preconfigured message several times'
+      c.action do |args, options|
+
+        say API.api_version
+
+        config_file = ConfigFile.new(args.first)
+
+        config = GMSEC::Config.from_config_file(config_file, "config1").tap do |config|
+          say config.to_xml
+        end
+
+        connection = Connection.new(config).tap do |connection|
+          connection.connect
+          say connection.library_version
+        end
+
+        subject = config_file.get_subscription("events").tap do |subject|
+          say "Subscribe to #{subject}"
+        end
+
+        message = connection.new_message.tap do |message|
+          message.load_fields_from_config_file(config_file, "msg1")
+          say message.to_xml
+        end
+
+        10.times do
+          say message.to_xml
+          connection.publish(message)
+        end
+      end
+    end
+
+    run!
+  end
+end
+
+Program.new.run if $0 == __FILE__

data/examples/gmconfig.xml

@@ -0,0 +1,45 @@
+<?xml version="1.0" encoding="UTF-8"?> 
+
+<!--
+   Copyright 2007-2014 United States Government as represented by the
+   Administrator of The National Aeronautics and Space Administration.
+   All Rights Reserved.
+-->
+
+
+
+
+<DEFINITIONS>
+	<SUBSCRIPTION NAME="events" PATTERN="GMSEC.MISSION.CONST.SAT.EVT.MSG.>"/>
+	<SUBSCRIPTION NAME="custom1" PATTERN="CUSTOM.MESSAGE.SUBJECTS.*"/>
+	<CONFIG NAME="config2">
+		<PARAMETER NAME="connectiontype">gmsec_mb</PARAMETER>
+		<PARAMETER NAME="loglevel">info</PARAMETER>
+		<PARAMETER NAME="server">localhost</PARAMETER>
+		<PARAMETER NAME="port">9000</PARAMETER>
+	</CONFIG>		
+	<CONFIG NAME="config1">
+		<PARAMETER NAME="connectiontype">gmsec_mb</PARAMETER>
+		<PARAMETER NAME="loglevel">info</PARAMETER>
+		<PARAMETER NAME="server">localhost</PARAMETER>
+		<PARAMETER NAME="tracking">true</PARAMETER>
+		<PARAMETER NAME="isthreaded">true</PARAMETER>
+		<PARAMETER NAME="compress">true</PARAMETER>
+	</CONFIG>
+	<MESSAGE NAME="msg1" SUBJECT="GMSEC.MISSION.CONST.SAT.EVT.MSG" KIND="PUBLISH">
+		<CONFIG NAME="msg_config">
+			<PARAMETER NAME="KIND">GMSEC_MSG_PUBLISH</PARAMETER>
+		</CONFIG>		
+		<FIELD TYPE="CHAR" NAME="C">c</FIELD>
+		<FIELD TYPE="BOOL" NAME="T">TRUE</FIELD>
+		<FIELD TYPE="BOOL" NAME="F">FALSE</FIELD>
+		<FIELD TYPE="I16" NAME="J">123</FIELD>
+		<FIELD TYPE="U16" NAME="K">123</FIELD>
+		<FIELD TYPE="I32" NAME="I">123</FIELD>
+		<FIELD TYPE="U32" NAME="U">123</FIELD>
+		<FIELD TYPE="STRING" NAME="S">This is a test</FIELD>
+		<FIELD TYPE="F32" NAME="E">123</FIELD>
+		<FIELD TYPE="F64" NAME="D">123</FIELD>
+		<FIELD TYPE="BIN" NAME="X">4a4c4d4e4f5051</FIELD>
+	</MESSAGE>
+</DEFINITIONS>

data/examples/gmpub

@@ -0,0 +1,76 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+
+require 'gmsec'
+require 'commander'
+
+class Program
+  include Commander::Methods
+  include GMSEC
+
+  def run
+    program :name, 'gm_msg_config'
+    program :version, VERSION
+    program :description, 'Ruby implementation of the gmconfig.c example GMSEC program'
+
+    default_command :run
+
+    command :run do |c|
+      c.syntax = 'usage: gmconfig_c <filename>'
+      c.description = 'Read a configuration file and publish a preconfigured message several times'
+      c.action do |args, options|
+
+        say API.api_version
+
+        config = GMSEC::Config.new.tap do |config|
+          args.each do |argument|
+            key, value = argument.split("=")
+            config[key] = value
+          end
+        end
+
+        subject = config["SUBJECT"] || "GMSEC.TEST.PUBLISH"
+        iterations = (config["ITERATIONS"] || 1).to_i
+        interval_ms = (config["INTERVAL_MS"] || 1000).to_i
+
+        connection = Connection.new(config).tap do |connection|
+          connection.connect
+          say connection.library_version
+        end
+
+        (1..iterations).each do |iteration|
+          value = iteration + 1
+
+          message = connection.new_message.tap do |message|
+            fields = [Field.new("C", "c", type: :char),
+                      Field.new("T", true, type: :bool),
+                      Field.new("F", false, type: :bool),
+                      Field.new("J", value, type: :i16),
+                      Field.new("K", value, type: :u16),
+                      Field.new("I", value, type: :i32),
+                      Field.new("COUNT", iteration, type: :i32),
+                      Field.new("U", value, type: :u32),
+                      Field.new("S", value, type: :str),
+                      Field.new("E", value, type: :f32),
+                      Field.new("D", value, type: :f64)]
+
+            fields.each do |field|
+              message << field
+            end
+          end
+
+          puts message.to_xml
+
+          connection.publish(message)
+
+          sleep interval_ms / 1000.0
+        end
+      end
+    end
+
+    run!
+  end
+end
+
+Program.new.run if $0 == __FILE__

data/gmsec.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gmsec/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'gmsec'
+  spec.version       = GMSEC::VERSION
+  spec.authors       = ['Stefan Novak']
+  spec.email         = ['stefan@novak.io']
+  spec.summary       = %q{Unofficial Ruby wrapper for NASA's GMSEC.}
+  spec.description   = %q{Unofficial Ruby wrapper for NASA's GMSEC. For more information, visit http://gmsec.gsfc.nasa.gov/.}
+  spec.homepage      = 'http://gmsec.gsfc.nasa.gov/'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'commander', '~> 4.2.1'
+  spec.add_development_dependency 'pry', '~> 0.10.1'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.1.0'
+
+  spec.add_dependency 'ffi', '~> 1.9.6'
+  spec.add_dependency 'terminal-table', '~> 1.4.5'
+end

data/lib/gmsec.rb

@@ -0,0 +1,15 @@
+require 'ffi'
+require 'terminal-table'
+
+require 'gmsec/version'
+
+module GMSEC
+  autoload :API, 'gmsec/api'
+  autoload :Config, 'gmsec/config'
+  autoload :ConfigFile, 'gmsec/config_file'
+  autoload :Connection, 'gmsec/connection'
+  autoload :Definitions, 'gmsec/definitions'
+  autoload :Field, 'gmsec/field'
+  autoload :Message, 'gmsec/message'
+  autoload :Status, 'gmsec/status'
+end

data/lib/gmsec/api.rb

@@ -0,0 +1,157 @@
+module GMSEC::API
+
+  module Finalizer
+
+    # Allows us to specify #destroy! to be called on an instance during GC.
+    def initialize(*args, **kwargs)
+      ObjectSpace.define_finalizer(self, self.class.method(:destroy!).to_proc)
+
+      # If there is a `native_value` keyword argument supplied, assign
+      # the value to native_object
+      if native_object = kwargs.delete(:native_object)
+        @native_object = native_object
+      else
+        if respond_to? :native_object_initializer
+          initialize_native_object do |pointer|
+            native_object_initializer(pointer)
+          end
+        end
+      end
+
+      if kwargs.empty?
+        super(*args)
+      else
+        super(*args, **kwargs)
+      end
+    end
+  end
+
+  def self.extended(base)
+    base.extend FFI::Library
+    base.extend FFI::DataConverter
+    base.send :prepend, Finalizer
+
+    class << base
+      def to_native(value, context=nil)
+        value.instance_variable_get("@native_object")
+      end
+
+      def from_native(value, context=nil)
+        new(native_object: value)
+      end
+
+      def size
+        find_type(native_type).size
+      end
+
+      def destroy!(instance)
+        if instance.respond_to? :destroy!
+          instance.destroy!
+        end
+      end
+
+      def api_version
+        gmsec_GetAPIVersion
+      end
+    end
+
+    # Load the library for each time the API module is extended.
+    base.send(:load_library)
+    base.include GMSEC::Definitions
+  end
+
+  def bind(object_name, &block)
+    native_type find_type(object_name)
+
+    if block_given?
+      define_method(:native_object_initializer, &block)
+    end
+
+    protected
+
+    # Proxy #find_type through class
+    define_method(:find_type) do |type|
+      self.class.find_type(type)
+    end
+
+    define_method(:initialize_native_object) do |&block|
+      instance_eval do
+        pointer = FFI::MemoryPointer.new(self.class.native_type)
+        block.call(pointer)
+        @native_object = pointer.read_pointer
+      end
+    end
+
+    define_method(:with_string_pointer) do |&block|
+      pointer = FFI::MemoryPointer.new :pointer
+      block.call(pointer)
+      if pointer.read_pointer != nil
+        pointer.read_pointer.read_string_to_null
+      end
+    end
+  end
+
+  def has(*objects)
+    mapping = {
+      config: GMSEC::Config,
+      status: GMSEC::Status}
+
+    objects.select{|object| mapping.keys.include? object}.each do |object|
+      attr_accessor object
+
+      # Overwrite the getter method to memoize a new instance of the mapped object.
+      define_method(object) do
+        name = "@#{object}"
+        instance_variable_set(name, instance_variable_get(name) || mapping[object].new)
+      end
+    end
+  end
+
+  protected
+
+  def load_library
+    self.ffi_lib gmsec_library_path 
+  end
+
+  def search_paths
+    @search_paths ||= begin
+      if ENV['GMSEC_LIBRARY_PATH']
+        ENV['GMSEC_LIBRARY_PATH']
+      elsif FFI::Platform.windows?
+        ENV['PATH'].split(File::PATH_SEPARATOR)
+      else
+        [ '/opt/local/{lib64,lib}',
+          '/opt/local/{lib64,lib}',
+          '/usr/lib/{x86_64,i386}-linux-gnu',
+          '/usr/local/{lib64,lib}',
+          '/usr/{lib64,lib}']
+      end
+    end
+  end
+
+  def find_lib(lib)
+    if ENV['GMSEC_LIBRARY_PATH'] && File.file?(ENV['GMSEC_LIBRARY_PATH'])
+      ENV['GMSEC_LIBRARY_PATH']
+    else
+      Dir.glob(search_paths.map {|path|
+        File.expand_path(File.join(path, "#{lib}.#{FFI::Platform::LIBSUFFIX}"))
+      }).first
+    end
+  end
+
+  def gmsec_library_path
+    @gmsec_library_path ||= begin
+      find_lib('{lib,}GMSECAPI{,-?}')
+    end
+  end
+
+  extend self
+
+  load_library
+
+  def self.api_version
+    gmsec_GetAPIVersion
+  end
+
+  attach_function :gmsec_GetAPIVersion, [], :string
+end