q-ruby-driver 1.1.0

data/lib/q-ruby-driver/q_message.rb

@@ -0,0 +1,57 @@
+module QRubyDriver
+
+  # Provided for legacy compatibility with previous versions of q-ruby-driver
+  # Usage of this class is deprecated
+  class QMessage
+
+    attr :message_type
+    attr :exception
+    attr :value
+    attr :message_type
+    attr :message
+    attr :timing
+
+    @exception = false
+
+    def create(value, sync = false)
+      @value = value
+      sync == true ? @message_type = :sync : @message_type = :async
+
+      start_time = Time.now
+
+      qio = QIO.new
+      qio.write_message(value, sync)
+      qio.pos=0
+      @message = qio.read
+      puts [@message].inspect
+      @length = @message.length
+      @timing = Time.now - start_time
+
+      self
+    end
+
+    # Decodes a binary message into a QMessage
+    def decode(message)
+      start_time= Time.now
+      @message = message
+      qio = QIO.new(@message)
+      begin
+        @length, @message_type = qio.message_header()
+        @value = qio.read_item()
+      rescue QException => qe
+        @exception = qe
+      end
+    end
+
+    def to_s
+      if @message.nil?
+        "QMessage [None]"
+      elsif !@exception.nil?
+        "QException [#{@message.unpack("H*")}] Type[#{@message_type}] Length [#{@length}] Value[#{@value}]"
+      else
+        "QMessage [#{@message.unpack("H*")}] Type[#{@message_type}] Length [#{@length}] Value[#{@value}]"
+      end
+    end
+
+  end
+end

data/spec/q-ruby-driver_spec.rb

@@ -0,0 +1,186 @@
+require File.expand_path(
+        File.join(File.dirname(__FILE__), %w[.. lib q-ruby-driver]))
+
+include QRubyDriver
+
+# RSpec tests require a live Q instance to which we can connect.
+# See TestUnit tests for a self-contained test
+
+describe QRubyDriver do
+
+  HOST, PORT = "localhost", 5001
+
+  it "should allow a basic Q connection to a Q instance" do
+    q_conn = QConnection.new HOST, PORT
+    q_conn.close
+  end
+
+  it "should allow us to send a hand crafted message via a Q connection with async" do
+    q_conn = QConnection.new HOST, PORT
+    q_conn.send_raw("01000000120000000a0004000000613a6062")
+    q_conn.close
+  end
+
+  it "should allow us to send a hand crafted message via a Q connection with sync" do
+    q_conn = QConnection.new HOST, PORT
+    q_conn.send_raw("01010000110000000a0003000000613a31")
+    q_conn.close
+  end
+
+  it "should allow us to get a String" do
+    q_conn = QConnection.new HOST, PORT
+    response = q_conn.get("2+2")
+    q_conn.close
+    response.should.== 4
+    puts response
+  end
+
+  it "should allow us to get a variable to set its value" do
+    q_conn = QConnection.new HOST, PORT
+    q_conn.get("a:`cheesy")
+    response = q_conn.get("a")
+    q_conn.close
+    response.should.== "cheesy"
+  end
+
+  it "should allow us to get a dictionary" do
+    q_conn = QConnection.new HOST, PORT
+    response = q_conn.get("`a`b!2 3")
+    q_conn.close
+    response.should.is_a? Hash
+    response.length.should.== 2
+    response["a"].should.== 2
+    response["b"].should.== 3
+
+    puts response.inspect
+  end
+
+  it "should allow us to get vectors" do
+    q_conn = QConnection.new HOST, PORT
+    q_conn.get("a:`IBM`GOOG`APPL")
+    response = q_conn.get("a")
+    q_conn.close
+    response.should.is_a? Array
+    response.length.should.== 3
+    response[0].should.== "IBM"
+    response[1].should.== "GOOG"
+    response[2].should.== "APPL"
+
+    puts response.inspect
+  end
+
+  it "should allow us to create a 1,000,000 trades" do
+    q_conn = QConnection.new HOST, PORT
+    q_conn.get("""trade:(	[]date:`date$();
+	   	time:`time$();
+		sym:`symbol$();
+		price:`float$();
+		size:`int$();
+		exchange:`symbol$();
+		c:()
+		);
+    """)
+    q_conn.get("portfolio:`IBM`GOOG`VOD`BA`AIB`MSFT`BOI / define variable portfolio")
+    q_conn.get("countries:(portfolio!`USA`USA`UK`USA`IRL`USA`IRL) / some countries")
+    q_conn.get("dts: .z.D-til 200 / A few dates")
+    q_conn.get("st: 09:30:00.000 / market open")
+    q_conn.get("et: 16:00:00.000 / market close")
+    q_conn.get("exchanges:`N`L`O`C / Some exchanges")
+    q_conn.get("n:1000000 / The number of trades to create")
+    response = q_conn.get("\\t insert[`trade;(n?dts;st+n?et-st;n?portfolio;n?100f;n?1000;n?exchanges;n?.Q.A,'reverse .Q.a)] / create 1m random trades")
+
+    puts "Created a million trades in #{response}ms"
+
+    response = q_conn.get("count trade")
+    response.should.== 1000000
+    q_conn.close
+  end
+
+  it "should allow us to select from the trades table" do
+    q_conn = QConnection.new HOST, PORT
+    response = q_conn.get("select max price by sym from trade")
+    response.keys[0].length.should.== 1
+
+    puts response.inspect
+    
+    response[response.keys[0]]["price"].length.should.== 7
+    response.keys[0]["sym"].length.should.== 7
+    response.keys[0]["sym"].include?("GOOG").should.== true
+    response.keys[0]["sym"].include?("BA").should.== true
+    response.keys[0]["sym"].include?("BOI").should.== true
+    response.keys[0]["sym"].include?("IBM").should.== true
+    response.keys[0]["sym"].include?("MSFT").should.== true
+    response.keys[0]["sym"].include?("VOD").should.== true
+    response.keys[0]["sym"].include?("CHEESE").should.== false
+    
+    q_conn.close
+  end
+
+  it "should support getting functions" do
+    q_conn = QConnection.new HOST, PORT
+    response = q_conn.get("show_me:{[something] show something;show_me};")
+    puts response
+    q_conn.get("show_me(`hello)")
+
+    q_conn.close
+  end
+  
+
+  it "should return exceptions" do
+    q_conn = QConnection.new HOST, PORT
+    begin
+      q_conn.get("somethingmissing")
+    rescue QRubyDriver::QException => e
+      puts e.message
+    end
+    q_conn.close
+  end
+
+  it "should be able to handle multi-type dictionaries" do
+    q_conn = QConnection.new HOST, PORT
+    response = q_conn.get("(`b,1)!(`a,3)")
+    q_conn.close
+    response.should.is_a? Hash
+    response.length.should.== 2
+
+    response["b"].should.== "a"
+    response[1].should.== 3
+
+  end
+
+  it "should be able to handle lists" do
+    q_conn = QConnection.new HOST, PORT
+    response = q_conn.get("enlist til 5")
+    q_conn.close
+    response.should.is_a? Array
+    response.length.should.== 1
+    response[0].should.is_a? Array
+
+    response[0][0].should.== 0
+    response[0][1].should.== 1
+    response[0][2].should.== 2
+    response[0][3].should.== 3
+    response[0][4].should.== 4
+
+  end
+
+  it "should support character arrays" do
+    q_conn = QConnection.new HOST, PORT
+    response = q_conn.get("\"hello\"")
+    q_conn.close
+    
+    response.should.is_a? Array
+    response.length.should.== 5
+    response.should.== "hello"
+  end
+
+#  it "should be able to support arrays as parameters" do
+#    q_conn = QConnection.new HOST, PORT
+#    values = ["a",1,2,3,4,5]
+#    response = q_conn.get(values)
+#    response.length.should.==values
+#    q_conn.close
+#  end
+
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+
+require File.expand_path(
+    File.join(File.dirname(__FILE__), %w[.. lib q-ruby-driver-ruby-driver]))
+
+include QRubyDriver
+
+Spec::Runner.configure do |config|
+  # == Mock Framework
+  #
+  # RSpec uses it's own mocking framework by default. If you prefer to
+  # use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+end
+

data/test/test_connection.rb

@@ -0,0 +1,63 @@
+require './test_helper'
+require 'test/unit'
+require 'socket'
+
+# Tests the socket connection using a dummy server
+# which gives a spoof response
+
+class TestConnection < Test::Unit::TestCase
+
+  HOST = "127.0.0.1"
+  @@port = 12300
+
+  def setup
+    @@serv = TCPServer.new(HOST, @@port)
+  end
+
+  def teardown
+    @@conn.close
+    @@port += 1
+  end
+
+  # helper methods
+  def string_to_int_array(str)
+    str.each_byte.map{|x| x}
+  end
+
+  def test_async
+    request = "Hello world!"
+    Thread.new() {
+      # listen for initial connection
+      s = @@serv.accept
+      s.recv(100)
+      s.write ['0','1','0','2'].pack('H4')
+      sleep(1) # wait a bit
+      expected = [1, 0, 0, 0, request.length+14, 0, 0, 0, 10, 0, request.length, 0, 0, 0] + string_to_int_array(request)
+      assert_equal(expected,string_to_int_array(s.recv(100)))
+    }
+    @@conn=QRubyDriver::QConnection.new(HOST, @@port)
+    @@conn.set(request)
+    sleep(5)
+    assert(true)
+  end
+
+  def test_sync
+    request = "Hello world!"
+    obj = ["foo",[91,34],["bar",[true,false,true]]]
+    Thread.new() {
+      # listen for initial connection
+      s = @@serv.accept
+      s.recv(100)
+      s.write ['0','1','0','2'].pack('H4')
+      sleep(1) # wait a bit
+      expected = [1, 1, 0, 0, request.length+14, 0, 0, 0, 10, 0, request.length, 0, 0, 0] + string_to_int_array(request)
+      assert_equal(expected,string_to_int_array(s.recv(100)))
+      qio=QRubyDriver::QIO.new()
+      qio.write_message(obj, :response)
+      qio.pos=0
+      s.write qio.read
+    }
+    @@conn=QRubyDriver::QConnection.new(HOST, @@port)
+    assert_equal(obj, @@conn.get(request))
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'bundler'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'q-ruby-driver'

data/test/test_io.rb

@@ -0,0 +1,167 @@
+require './test_helper'
+require 'test/unit'
+
+# These tests do round-trip integration testing
+# (i.e. write then read) on the QIO class
+class TestIO < Test::Unit::TestCase
+
+  def setup
+    @qio=QRubyDriver::QIO.new()
+  end
+
+  # helper methods
+  def string_to_int_array(str)
+    str.each_byte.map{|x| x}
+  end
+
+  def test_string
+    str="This is a %1$5#!@-ing string"
+
+    expected=[1, 0, 0, 0, str.length+14, 0, 0, 0, 10, 0, 28, 0, 0, 0]+string_to_int_array(str)
+
+    @qio.write_message(str)
+    @qio.pos=0
+    assert_equal(expected, string_to_int_array(@qio.read()))
+    @qio.pos=0
+    assert_equal(str, @qio.read_message())
+  end
+
+  def test_int
+    int=1
+
+    expected=[1, 0, 0, 0, 13, 0, 0, 0, 250, 1, 0, 0, 0]
+
+    @qio.write_message(int)
+    @qio.pos=0
+    assert_equal(expected, string_to_int_array(@qio.read()))
+    @qio.pos=0
+    assert_equal(int, @qio.read_message())
+  end
+
+  def test_float
+    float=3.68423
+
+    expected=[1, 0, 0, 0, 17, 0, 0, 0, 247, 97, 137, 7, 148, 77, 121, 13, 64]
+
+    @qio.write_message(float)
+    @qio.pos=0
+    assert_equal(expected, string_to_int_array(@qio.read()))
+    @qio.pos=0
+    assert_equal(float, @qio.read_message())
+  end
+
+  def test_symbol
+    sym="This is a %1$5#!@-ing symbol".to_sym
+    expected=[1, 0, 0, 0, 38, 0, 0, 0, 245]+string_to_int_array(sym.to_s)+[0]
+
+    @qio.write_message(sym)
+    @qio.pos=0
+    assert_equal(expected, string_to_int_array(@qio.read()))
+    @qio.pos=0
+    assert_equal(sym.to_s, @qio.read_message())
+  end
+
+  def test_exception
+    exc=Exception.new("This is an exception")
+    expected=[1, 0, 0, 0, 30, 0, 0, 0, 128]+string_to_int_array(exc.message)+[0]
+
+    @qio.write_message(exc)
+    @qio.pos=0
+    assert_equal(expected, string_to_int_array(@qio.read()))
+    @qio.pos=0
+
+    # should throw the exception when reading
+    begin
+      @qio.read_message()
+    rescue QRubyDriver::QException => qe
+      assert_equal(exc.message, qe.message)
+    end
+  end
+
+  def test_int_vector
+    vector=[1,3]
+
+    expected=[1, 0, 0, 0, 22, 0, 0, 0, 6, 0, 2, 0, 0, 0, 1, 0, 0, 0, 3, 0, 0, 0]
+
+    @qio.write_message(vector)
+    @qio.pos=0
+    assert_equal(expected, string_to_int_array(@qio.read()))
+    @qio.pos=0
+    assert_equal(vector, @qio.read_message())
+  end
+
+  def test_bool_vector
+    vector=[true,false,true]
+
+    msg_header=[1, 0, 0, 0, 17, 0, 0, 0]
+    bool_vector =  [1, 0, 3, 0, 0, 0, 1, 0, 1]
+    expected=msg_header+bool_vector
+
+    @qio.write_message(vector)
+    @qio.pos=0
+    assert_equal(expected, string_to_int_array(@qio.read()))
+    @qio.pos=0
+    assert_equal(vector, @qio.read_message())
+  end
+
+  def test_symbol_vector
+    vector=[:symbol1, :symbol2, :symbol3]
+
+    msg_header = [1, 0, 0, 0, 38, 0, 0, 0]
+    sym_vector = [11, 0, 3, 0, 0, 0]+vector.map{|x| string_to_int_array(x.to_s)+[0]}.flatten
+    expected=msg_header+sym_vector
+    
+    @qio.write_message(vector)
+    @qio.pos=0
+    assert_equal(expected, string_to_int_array(@qio.read()))
+    @qio.pos=0
+    assert_equal(vector.map{|x|x.to_s}, @qio.read_message())
+  end
+
+  def test_list
+    list=["foo",[91,34],["bar",[true,false,true]]]
+
+    msg_header =   [1, 0, 0, 0, 61, 0, 0, 0]
+    list1_header = [0, 0, 3, 0, 0, 0]
+    string_foo =   [10, 0, 3, 0, 0, 0] + string_to_int_array("foo")
+    int_vector =   [6, 0, 2, 0, 0, 0, 91, 0, 0, 0, 34, 0, 0, 0]
+    list2_header = [0, 0, 2, 0, 0, 0]
+    string_bar =   [10, 0, 3, 0, 0, 0] + string_to_int_array("bar")
+    bool_vector =  [1, 0, 3, 0, 0, 0, 1, 0, 1]
+    expected=msg_header+list1_header+string_foo+int_vector+list2_header+string_bar+bool_vector
+
+    @qio.write_message(list)
+    @qio.pos=0
+    assert_equal(expected, string_to_int_array(@qio.read()))
+    @qio.pos=0
+    assert_equal(list, @qio.read_message())
+  end
+
+  def test_flip
+    hash={:foo => [91,34, 20], :bar => [true,false,true], :woof => ["beatles","stones","zeppelin"], :meow => [:how, :now, :cow]}
+
+    msg_header =   [1, 0, 0, 0, 131, 0, 0, 0]
+    flip_dict_header = [98, 0, 99]
+    sym_vector_1 = [11, 0, 4, 0, 0, 0] + hash.keys.map{|x|string_to_int_array(x.to_s)+[0]}.flatten
+    list_header = [0, 0, 4, 0, 0, 0]
+    int_vector =   [6, 0, 3, 0, 0, 0, 91, 0, 0, 0, 34, 0, 0, 0, 20, 0, 0, 0]
+    bool_vector =   [1, 0, 3, 0, 0, 0, 1, 0, 1]
+    # I'm not actually sure if "char_vector_list" is the correct IPC format
+    # but it is my expectation for now until I learn otherwise
+    char_vector_list =   [0, 0, 3, 0, 0, 0] + hash[:woof].map{|x| [10, 0, x.length, 0, 0, 0] + string_to_int_array(x.to_s)}.flatten
+    sym_vector_2 = [11, 0, 3, 0, 0, 0] + hash[:meow].map{|x|string_to_int_array(x.to_s)+[0]}.flatten
+
+    expected = msg_header + flip_dict_header + sym_vector_1 + list_header + int_vector + bool_vector + char_vector_list + sym_vector_2
+
+    @qio.write_message(hash)
+    @qio.pos=0
+    assert_equal(expected, string_to_int_array(@qio.read()))
+    @qio.pos=0
+
+    expected_hash={}
+    hash.keys.each {|k| expected_hash[k.to_s]=hash[k]}
+    expected_hash['meow'] = expected_hash['meow'].map{|x|x.to_s}
+
+    assert_equal(expected_hash, @qio.read_message())
+  end
+end