kinetic-ruby 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ce317494566b4a799ad6f6d0fcd85b76710236ac
-  data.tar.gz: 16d20839e916fe61f7d8af3efbee17ce58f24acd
+  metadata.gz: 1840704ef9325e41a5d55525c171d5ddb13976a1
+  data.tar.gz: a23ef054767a14f647616611f28a21ab303827b1
 SHA512:
-  metadata.gz: e328a4e1ec4b30b4f558d5d7125bee2e402a6f8db56dc371e4bb9d969370ccb8a57406c78cbe50ff7115195ef4d237c784b8d20de4606b538317415b05ab2ce4
-  data.tar.gz: acef68467e27a99e6e7792085abf33ca24dcd663c271561468e82de8b52560a9f264bafdcd9036db3b7b0d2fb756d27970b565e4a047e29ea8329232fb200684
+  metadata.gz: 14e8e1d553598b0bdef56324090ddfb4325bdb170d0350f86775faa2f602c4c48af3c7f08eabf2b3afe486063d8fdb29be4170bfcfc04744dae8152149806be0
+  data.tar.gz: f285d6d15043214f08b5319f444f745360bb0cd0ef2a0c7aa76044adc119bcfdc100103fec21336ea1060339f29664f842264cfaf7b1c9131e97b0612dec4189

data/Rakefile

@@ -1,27 +1,29 @@
+HERE = File.expand_path(File.dirname(__FILE__))
+$LOAD_PATH.unshift File.join(HERE, 'lib')
+
 require 'rake'
 require 'rake/clean'
-require_relative 'lib/kinetic-ruby'
+require 'kinetic-ruby'
+
+load 'tasks/kinetic-ruby.rake'
 
 CLEAN.include ['*.gem', '*.log']
 
 desc "Run example"
 task :example do
-  kr = KineticRuby.new
-  kr.log_level = KineticRuby::LOG_LEVEL_INFO
+  kr = KineticRuby::Proto.new
   kr.test_kinetic_proto
 end
 
 desc "Run example w/o logging"
 task :example_no_log do
-  kr = KineticRuby.new
-  kr.log_level = KineticRuby::LOG_LEVEL_NONE
+  kr = KineticRuby::Proto.new(KineticRuby::Logger::LOG_LEVEL_NONE)
   kr.test_kinetic_proto
 end
 
 desc "Run example w/ verbose logging"
 task :example_verbose_log do
-  kr = KineticRuby.new
-  kr.log_level = KineticRuby::LOG_LEVEL_VERBOSE
+  kr = KineticRuby::Proto.new(KineticRuby::Logger::LOG_LEVEL_VERBOSE)
   kr.test_kinetic_proto
 end
 

data/lib/kinetic-ruby.rb

@@ -1,10 +1,12 @@
-require_relative "protobuf/kinetic.pb"
-require 'yaml'
-require 'fileutils'
+require_relative 'kinetic_logger'
+require_relative 'kinetic_proto'
+require_relative 'kinetic_server'
 
-class KineticRuby
+module KineticRuby
 
-  VERSION = "0.2.1"
+  VERSION = '0.3.0'
+  DEFAULT_KINETIC_PORT = 8123
+  TEST_KINETIC_PORT = 8999
 
   kp_tag = ''
   FileUtils.cd "./vendor/kinetic-protocol" do
@@ -13,131 +15,4 @@ class KineticRuby
   end
   KINETIC_PROTOCOL_VERSION = kp_tag
 
-  LOG_LEVELS = [
-    LOG_LEVEL_NONE = 0,
-    LOG_LEVEL_ERROR = 1,
-    LOG_LEVEL_INFO = 2,
-    LOG_LEVEL_VERBOSE = 3,
-  ]
-
-  def initialize
-    @message_out = nil
-    @message_in = nil
-    @log_level = LOG_LEVEL_NONE
-  end
-
-  def log_level=(level)
-    if !LOG_LEVELS.include? level
-      raise "\nInvalid LOG_LEVEL specified!\nValid levels:\n\t" +
-        LOG_LEVELS.map{|l|"#{self.class}::#{l}"}.join("\n\t") + "\n\n"
-    end
-    @log_level = level
-  end
-
-  def encode_test_message
-    encode
-  end
-
-  def test_kinetic_proto
-    msg = encode
-    decode msg
-    puts
-    puts "Kinetic Protocol protobuf encode/decode test passed!"
-  end
-
-private
-
-  def log_err(msg='')
-    log_message(msg, $stderr) if @log_level >= LOG_LEVEL_ERROR
-  end
-
-  def log_info(msg='')
-    log_message(msg) if @log_level >= LOG_LEVEL_INFO
-  end
-
-  alias log log_info
-
-  def log_verbose(msg='')
-    log_message(msg) if @log_level >= LOG_LEVEL_VERBOSE
-  end
-
-  def log_message(msg='', stream=$stdout)
-    $stderr.flush
-    stream.flush
-    stream.puts msg
-    stream.flush
-  end
-
-  def encode
-    pb = Seagate::Kinetic::Message.new
-
-    log
-    log "#{pb.class} - Encoding"
-    log  "---------------------------------------"
-
-    log_verbose "  fields:"
-    pb.fields.sort.each{|f| log_verbose "    #{f}"}
-    log_verbose
-
-    log_verbose "  hmac:"
-    pb.hmac = "0123456789ABCDEF0123"
-    log_verbose "    #{pb.hmac.inspect}"
-    log_verbose
-
-    log "  command:"
-    pb.command = Seagate::Kinetic::Message::Command.new(
-      header: Seagate::Kinetic::Message::Header.new(
-        clusterVersion: 0x1122334455667788,
-        identity:       0x1234567898654321
-        ),
-      body: Seagate::Kinetic::Message::Body.new(
-        keyValue: Seagate::Kinetic::Message::KeyValue.new(
-            key: "KeYvAl"
-          )
-        ),
-      status: Seagate::Kinetic::Message::Status.new(
-          code: Seagate::Kinetic::Message::Status::StatusCode::NO_SUCH_HMAC_ALGORITHM,
-          statusMessage: "The specified HMAC security algorithm does not exist!",
-          detailedMessage: "YOUCH!"
-        ),
-    )
-    pb.command.to_yaml.each_line{|l| log("    #{l}")}
-    log
-
-    @message_out = pb
-
-    log "  encoded:"
-    encoded = pb.encode
-    log_verbose
-    log_verbose "    Inspection: #{encoded.inspect}"
-    log_verbose
-    log_verbose "    Content:"
-    encoded.to_yaml.each_line{|l| log_verbose "    #{l}"}
-    log_verbose
-    log "    Length: #{encoded.length} bytes"
-    log
-
-    return encoded
-  end
-
-  def decode(buf)
-
-    @message_in = Seagate::Kinetic::Message.decode(buf)
-
-    log
-    log "#{@message_in.class} - Decoding"
-    log  "-----------------------------------"
-
-    log "  command:"
-    @message_in.command.to_yaml.each_line{|l| log "    #{l}"}
-    log
-
-    if @message_in != @message_out
-      log_err "Inbound/outbound messages do not match!\n\n"
-      raise "\nKinetic Protocol message roundtrip FAILED!\n\n"
-    end
-
-    log "Kinetic Protocol message roundtrip SUCCESS!"
-  end
-
 end

data/lib/kinetic_logger.rb

@@ -0,0 +1,43 @@
+module KineticRuby
+  class Logger
+    def initialize(logging_level=LOG_LEVEL_INFO, stream=$stdout)
+      set_log_level(logging_level)
+      @stream = stream
+    end
+
+    LOG_LEVELS = [
+      LOG_LEVEL_NONE = 0,
+      LOG_LEVEL_ERROR = 1,
+      LOG_LEVEL_INFO = 2,
+      LOG_LEVEL_VERBOSE = 3,
+    ]
+
+    def set_log_level(level)
+      if !LOG_LEVELS.include? level
+        raise "\nInvalid LOG_LEVEL specified!\nValid levels:\n\t" +
+          LOG_LEVELS.map{|l|"#{self.class}::#{l}"}.join("\n\t") + "\n\n"
+      end
+      @level = level
+    end
+
+    def log_info(msg='')
+      log_message(msg) if @level >= LOG_LEVEL_INFO
+    end
+    alias log log_info
+
+    def log_err(msg='')
+      log_message(msg, $stderr) if @level >= LOG_LEVEL_ERROR
+    end
+
+    def log_verbose(msg='')
+      log_message(msg) if @level >= LOG_LEVEL_VERBOSE
+    end
+
+    def log_message(msg='')
+      $stderr.flush
+      @stream.flush
+      @stream.puts msg
+      @stream.flush
+    end
+  end
+end

data/lib/kinetic_proto.rb

@@ -0,0 +1,96 @@
+require 'yaml'
+require 'fileutils'
+require_relative 'kinetic_logger'
+require_relative 'kinetic_server'
+
+module KineticRuby
+
+  class Proto
+
+    def initialize(log_level = KineticRuby::Logger::LOG_LEVEL_INFO)
+      require_relative "protobuf/kinetic.pb"
+      @message_out = nil
+      @message_in = nil
+      @logger = KineticRuby::Logger.new(log_level)
+    end
+
+    def decode(buf)
+      @message_in = Seagate::Kinetic::Message.decode(buf)
+
+      @logger.log
+      @logger.log "#{@message_in.class} - Decoding"
+      @logger.log  "-----------------------------------"
+
+      @logger.log "  command:"
+      @message_in.command.to_yaml.each_line{|l| @logger.log "    #{l}"}
+      @logger.log
+    end
+
+    def test_encode
+      pb = Seagate::Kinetic::Message.new
+
+      @logger.log
+      @logger.log "#{pb.class} - Encoding"
+      @logger.log  "---------------------------------------"
+
+      @logger.log_verbose "  fields:"
+      pb.fields.sort.each{|f| @logger.log_verbose "    #{f}"}
+      @logger.log_verbose
+
+      @logger.log_verbose "  hmac:"
+      pb.hmac = "0123456789ABCDEF0123"
+      @logger.log_verbose "    #{pb.hmac.inspect}"
+      @logger.log_verbose
+
+      @logger.log "  command:"
+      pb.command = Seagate::Kinetic::Message::Command.new(
+        header: Seagate::Kinetic::Message::Header.new(
+          clusterVersion: 0x1122334455667788,
+          identity:       0x1234567898654321
+          ),
+        body: Seagate::Kinetic::Message::Body.new(
+          keyValue: Seagate::Kinetic::Message::KeyValue.new(
+              key: "KeYvAl"
+            )
+          ),
+        status: Seagate::Kinetic::Message::Status.new(
+            code: Seagate::Kinetic::Message::Status::StatusCode::NO_SUCH_HMAC_ALGORITHM,
+            statusMessage: "The specified HMAC security algorithm does not exist!",
+            detailedMessage: "YOUCH!"
+          ),
+      )
+      pb.command.to_yaml.each_line{|l| @logger.log("    #{l}")}
+      @logger.log
+
+      @message_out = pb
+
+      @logger.log "  encoded:"
+      encoded = pb.encode
+      @logger.log_verbose
+      @logger.log_verbose "    Inspection: #{encoded.inspect}"
+      @logger.log_verbose
+      @logger.log_verbose "    Content:"
+      encoded.to_yaml.each_line{|l| @logger.log_verbose "    #{l}"}
+      @logger.log_verbose
+      @logger.log "    Length: #{encoded.length} bytes"
+      @logger.log
+
+      return encoded
+    end
+
+    def test_kinetic_proto
+      msg = test_encode
+      decode msg
+
+      if @message_in != @message_out
+        @logger.log_err "Inbound/outbound messages do not match!\n\n"
+        raise "\nKinetic Protocol message roundtrip FAILED!\n\n"
+      end
+
+      @logger.log
+      @logger.log "Kinetic Protocol protobuf encode/decode test passed!"
+      @logger.log
+    end
+
+  end
+end

data/lib/kinetic_server.rb

@@ -0,0 +1,111 @@
+require_relative 'kinetic-ruby'
+
+$kinetic_server = nil
+
+module KineticRuby
+
+  class Server
+
+    def initialize(port = nil, logger = nil)
+      port ||= DEFAULT_KINETIC_PORT
+      raise "Invalid Kinetic test server port specified (port: #{port})" if !port || port < 0
+      @port = port
+      @logger = logger
+      @server = nil
+      @worker = nil
+      @listeners = []
+    end
+
+    def report(message='')
+      $stderr.flush
+      $stdout.flush
+      puts message
+      $stderr.flush
+      $stdout.flush
+    end
+
+    def report_banner(message)
+      report "\n#{message}\n#{'='*message.length}\n\n"
+    end
+
+    def report_buffer(buf)
+      bytes = buf.bytes
+      row_len = 16
+      report "Raw Data:"
+      while !bytes.empty?
+        row_len = bytes.count >= row_len ? row_len : bytes.count
+        row = bytes.slice!(row_len)
+        msg = "  "
+        row.each do |b|
+          msg += sprintf("0x%02X", b)
+        end
+        report msg
+      end
+      report
+    end
+
+    def start
+      return unless @server.nil?
+
+      @server = TCPServer.new @port
+      @listeners = []
+
+      # Setup handler for signaled shutdown (via ctrl+c)
+      trap("INT") do
+        report "Kinetic Test Server: INT triggered Kintic Test Server shutdown"
+        shutdown
+      end
+
+      # Create worker thread for test server to run in so we can continue
+      @worker = Thread.new do
+        report "Kinetic Test Server: Listening for Kinetic clients..."
+        loop do
+          @listeners << Thread.start(@server.accept) do |client|
+            report "Kinetic Test Server: Connected to #{client.inspect}"
+            request = ""
+            while request += client.getc # Read characters from socket
+
+              request_match = request.match(/^read\((\d+)\)/)
+              if request_match
+                len = request_match[1].to_i
+                response = "G"*len
+                report "Kinetic Test Server: Responding to 'read(#{len})' w/ '#{response}'"
+                client.write response
+                request = ""
+
+              elsif request =~ /^readProto()/
+                kruby = KineticRuby::Server.new
+                response = kruby.encode_test_message
+                report "Kinetic Test Server: Responding to 'read(#{len})' w/ dummy protobuf (#{response.length} bytes)"
+                client.write response
+                request = ""
+
+              elsif request.length > 20
+                report_banner "Received unknown data:"
+                report_buffer(request)
+              end
+
+            end
+            report "Kinetic Test Server: Client #{client.inspect} disconnected!"
+          end
+        end
+      end
+
+    end
+
+    def shutdown
+      return if @server.nil?
+      report "Kinetic Test Server: shutting down..."
+      @listeners.each do |client|
+        client.join(0.3) if client.alive?
+      end
+      @listeners = []
+      @worker.exit
+      @worker = nil
+      @server.close
+      @server = nil
+      report "Kinetic Test Server: shutdown complete"
+    end
+
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kinetic-ruby
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Greg Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-24 00:00:00.000000000 Z
+date: 2014-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -63,6 +63,9 @@ files:
 - Rakefile
 - LICENSE
 - ./lib/kinetic-ruby.rb
+- ./lib/kinetic_logger.rb
+- ./lib/kinetic_proto.rb
+- ./lib/kinetic_server.rb
 - ./lib/protobuf/kinetic.pb.rb
 - ./vendor/kinetic-protocol/kinetic.proto
 - ./vendor/kinetic-protocol/README.md