ipc_transit 0.0.3 → 0.1

data/bin/transitd

@@ -2,10 +2,17 @@
 require 'rubygems'
 require 'net/http'
 require 'uri'
+require 'optparse'
+
 require 'ipc_transit'
 
 $url = 'http://127.0.0.1:8726/transit_data'
 
+OptionParser.new do |opts|
+    opts.on('-p[OPTIONAL]') do |p|
+        $ipc_transit_config_path = p
+    end
+end.parse!
 
 def one_message
     message = IPCTransit.receive('qname' => 'transitd', 'raw' => 1)

data/bin/trlist

@@ -1,7 +1,14 @@
 #!/usr/bin/env ruby
 require 'rubygems'
+require 'optparse'
+
 require 'ipc_transit'
 
+OptionParser.new do |opts|
+    opts.on('-p[OPTIONAL]') do |p|
+        $ipc_transit_config_path = p
+    end
+end.parse!
 
 IPCTransit.all_queues.each_pair do |qname, info|
     puts "#{qname} = #{info['count']}"

data/bin/trrecv

@@ -1,16 +1,33 @@
 #!/usr/bin/env ruby
 require 'rubygems'
-require 'ipc_transit'
+require 'optparse'
 require 'json'
 
-qname = ARGV[0]
-nowait = ARGV[1]
+require 'ipc_transit'
 
+options = {}
 
-#puts qname
-#puts message
+OptionParser.new do |opts|
+    opts.banner = "Usage: trrecv [options] qname"
+    opts.on('-s[OPTIONAL]') do |s|
+        options['single'] = 1
+    end
+    opts.on('-n[OPTIONAL]') do |n|
+        options['nowait'] = 1
+    end
+    opts.on('-p[OPTIONAL]') do |p|
+        $ipc_transit_config_path = p
+    end
+end.parse!
+
+qname = ARGV[0]
 
-while ret = IPCTransit.receive('qname' => qname, 'nowait' => 1)
+if options['single'] == 1
+    ret = IPCTransit.receive('qname' => qname, 'nowait' => options['nowait'])
     puts JSON.pretty_generate(ret)
+else
+    while ret = IPCTransit.receive('qname' => qname, 'nowait' => options['nowait'])
+        puts JSON.pretty_generate(ret)
+    end
 end
 

data/bin/trsend

@@ -1,8 +1,15 @@
 #!/usr/bin/env ruby
 require 'rubygems'
-require 'ipc_transit'
 require 'json'
+require 'optparse'
+
+require 'ipc_transit'
 
+OptionParser.new do |opts|
+    opts.on('-p[OPTIONAL]') do |p|
+        $ipc_transit_config_path = p
+    end
+end.parse!
 
 qname = ARGV[0]
 message = JSON.parse(ARGV[1])
@@ -11,6 +18,6 @@ dest = ARGV[2]
 if dest.nil?
     ret = IPCTransit.send('message' => message, 'qname' => qname)
 else
-    ret = IPCTransit.send('message' => message, 'qname' => qname, 'd' => dest)
+    ret = IPCTransit.send('message' => message, 'qname' => qname, 'destination' => dest)
 end
 puts ret

data/bin/trserver

@@ -1,8 +1,15 @@
 #!/usr/bin/env ruby
 require 'rubygems'
 require 'webrick'
+require 'optparse'
+
 require 'ipc_transit'
 
+OptionParser.new do |opts|
+    opts.on('-p[OPTIONAL]') do |p|
+        $ipc_transit_config_path = p
+    end
+end.parse!
 
 class PersistAnswers < WEBrick::HTTPServlet::AbstractServlet
     def do_POST(request, response)

data/lib/ipc_transit.rb

@@ -14,7 +14,16 @@ require 'ipc_transit/serialize'
 class IPCTransit
     @@queues = {}
 
-    @@ipc_transit_wire_header_args = {
+    if $ipc_transit_config_path.nil?
+        $ipc_transit_config_path = '/tmp/ipc_transit'
+    end
+
+    @@wire_header_arg_translate = {
+        'destination' => 'd',
+        'compression' => 'c',
+        'encoding' => 'e'
+    }
+    @@wire_header_args = {
         'e' => { #encoding
             'json' => 1,
             'yaml' => 1,
@@ -28,7 +37,7 @@ class IPCTransit
         't' => 1, #hop TTL
         'q' => 1, #destination qname
     }
-    @@ipc_transit_std_args = {
+    @@std_args = {
         'message' => 1,
         'qname' => 1,
         'nowait' => 1,
@@ -42,12 +51,15 @@ class IPCTransit
     #  message - hash reference
     #  qname - name of queue to send to
     #  nowait - do not block if the queue is full (optional)
+    #  encoding - currently JSON and YAML are implemented (optional, defaults to JSON)
+    #  compression - currently none and zlib are implemented (optional, defaults to none)
+    #  destination - IP or name of remote destination (optional)
 
     def self.send(args)
         ret = nil
         flags = IPC_NOWAIT
         begin
-            if args['d']
+            if args['destination']
                 args['q'] = args['qname']
                 args['qname'] = 'transitd'
                 if not args['t']
@@ -66,6 +78,22 @@ class IPCTransit
         return ret
     end
 
+    ##
+    #  Remove a queue
+    #
+    # Arguments:
+    #  qname - name of queue to remove
+
+    def self.remove(args)
+        qname = args['qname']
+        key = self.get_queue_id(args)
+        mq = MessageQueue.new(key, 0)
+        mq.ipc_rmid
+        File.delete("#{$ipc_transit_config_path}/#{qname}")
+        @@queues.delete(qname)
+    end
+
+
     ##
     #  Receive a message from a queue
     #
@@ -165,15 +193,6 @@ class IPCTransit
 
     private
 
-    def self.get_next_id
-        new_id = 1
-        @@queues.each_pair do |k,v|
-            if v['qid'] > new_id
-                new_id = v['qid']
-            end
-        end
-        return new_id + 1
-    end
     def self.get_queue_id(args)
         qname = args['qname']
         self.mk_queue_dir()
@@ -187,8 +206,8 @@ class IPCTransit
         begin
             self.lock_dir()
             File.umask(0000)
-            file = File.open("/tmp/transit/#{qname}", 'w', 0666)
-            new_qid = get_next_id
+            file = File.open("#{$ipc_transit_config_path}/#{qname}", 'w', 0666)
+            new_qid = ftok("#{$ipc_transit_config_path}/#{qname}", 1)
             file.puts("qid=#{new_qid}")
             file.puts("qname=#{qname}")
             file.close
@@ -203,15 +222,15 @@ class IPCTransit
 
     def self.lock_dir()
         File.umask(0000)
-        File.open('/tmp/transit.lock', File::WRONLY|File::EXCL|File::CREAT, 0666)
+        File.open("#{$ipc_transit_config_path}/transit.lock", File::WRONLY|File::EXCL|File::CREAT, 0666)
     end
     def self.unlock_dir()
-        File.delete('/tmp/transit.lock')
+        File.delete("#{$ipc_transit_config_path}/transit.lock")
     end
 
     def self.gather_queue_info()
         self.mk_queue_dir()
-        Dir.glob('/tmp/transit/*').each do |filename|
+        Dir.glob("#{$ipc_transit_config_path}/*").each do |filename|
             info = {}
             file = File.new(filename, 'r', 0666)
             while (line = file.gets)
@@ -232,7 +251,7 @@ class IPCTransit
 
     def self.mk_queue_dir()
         begin
-            Dir.mkdir('/tmp/transit', 0777)
+            Dir.mkdir($ipc_transit_config_path, 0777)
         rescue
         end
     end
@@ -242,9 +261,13 @@ class IPCTransit
 #it takes message and wire_meta_data
     def self.pack_message(args)
         args['message']['.ipc_transit_meta'] = {}
+        @@wire_header_arg_translate.keys.each do |k|
+            next unless args[k]
+            args[@@wire_header_arg_translate[k]] = args[k]
+        end
         args.keys.each do |k|
-            next if @@ipc_transit_wire_header_args[k]
-            next if @@ipc_transit_std_args[k]
+            next if @@wire_header_args[k]
+            next if @@std_args[k]
             args['message']['.ipc_transit_meta'][k] = args[k]
         end
         args['serialized_message'] = transit_freeze(args)
@@ -257,11 +280,11 @@ class IPCTransit
     def self.serialize_wire_meta(args)
         s = ''
         args.keys.each do |k|
-            if @@ipc_transit_wire_header_args[k]
+            if @@wire_header_args[k]
                 #make sure a valid value is passed in
-                if @@ipc_transit_wire_header_args[k] == 1
+                if @@wire_header_args[k] == 1
                     s = "#{s}#{k}=#{args[k]},"
-                elsif @@ipc_transit_wire_header_args[k][args[k]]
+                elsif @@wire_header_args[k][args[k]]
                     s = "#{s}#{k}=#{args[k]},"
                 else
                     raise "passed wire argument #{k} had value #{args[k]} not of allowed type"

data/lib/ipc_transit/test.rb

@@ -1,8 +1,9 @@
-#kind of ghetto, but I don't have a better way right now
-def drain_test_queue
+$ipc_transit_config_path = '/tmp/test_ipc_transit'
+$ipc_transit_test_qname = 'tr_dist_test_qname'
+
+def clear_test_queue
     begin
-        while ret = IPCTransit.receive('qname' => 'test_qname', 'nowait' => 1)
-        end
+        IPCTransit.remove('qname' => $ipc_transit_test_qname)
     rescue Exception => msg
     end
 end
@@ -10,12 +11,12 @@ end
 def run_daemon(prog)
     pid = fork
     if pid.nil? #child
-        exec "bin/#{prog}"
+        exec "ruby -Ilib bin/#{prog} -p/tmp/test_ipc_transit"
         exit
     end
     return pid
 end
+
 def kill_daemon(pid)
     Process.kill(9, pid)
 end
-

data/test/tc_transit_misc.rb

@@ -0,0 +1,28 @@
+require 'test/unit'
+require 'ipc_transit'
+require 'ipc_transit/test'
+
+class TestIPCTransit < Test::Unit::TestCase
+    def test_remove_queue
+        clear_test_queue()
+        IPCTransit.send('message' => { 'foo' => 'bar' }, 'qname' => $ipc_transit_test_qname)
+        all_info = IPCTransit.all_queue_info()
+        assert(all_info, 'We received some queue info')
+
+        assert(all_info[$ipc_transit_test_qname]['qname'] == $ipc_transit_test_qname, 'test queue is in all_queue_info')
+        x = all_info['tr_dist_some_random_queue']
+        assert(x.nil?, 'another, un-used qname is NOT in all info')
+        qid = all_info[$ipc_transit_test_qname]['qid']
+        assert(qid, 'queue_id for tr_dist_test_qname exists')
+
+        ret = IPCTransit.receive('qname' => $ipc_transit_test_qname, 'nowait' => 1)
+        assert(ret, 'IPCTransit.receive returned true')
+        assert_equal(ret['foo'], 'bar')
+
+        IPCTransit.remove('qname' => $ipc_transit_test_qname)
+        all_info = IPCTransit.all_queue_info()
+        x = all_info[$ipc_transit_test_qname]
+        assert(x.nil?, 'tr_dist_test_qname successfully removed')
+    end
+end
+

data/test/tc_transit_remote.rb

@@ -11,22 +11,22 @@ class TestIPCTransit < Test::Unit::TestCase
     end
 
     def test_basic_remote
-        drain_test_queue()
-        IPCTransit.send('message' => { 'foo' => 'bar' }, 'qname' => 'test_qname', 'd' => '127.0.0.1')
+        clear_test_queue()
+        IPCTransit.send('message' => { 'foo' => 'bar' }, 'qname' => $ipc_transit_test_qname, 'destination' => '127.0.0.1')
         ret = IPCTransit.receive('qname' => 'transitd', 'nowait' => 1)
         assert(ret, 'IPCTransit.receive returned true')
         assert_equal(ret['foo'], 'bar')
     end
 
     def test_full_remote
-        drain_test_queue()
+        clear_test_queue()
         begin
             @trserver_pid = run_daemon('trserver')
             @transitd_pid = run_daemon('transitd')
             sleep 2
-            IPCTransit.send('message' => { 'foo' => 'bar' }, 'qname' => 'test_qname', 'd' => '127.0.0.1')
+            IPCTransit.send('message' => { 'foo' => 'bar' }, 'qname' => $ipc_transit_test_qname, 'destination' => '127.0.0.1')
             sleep 2
-            ret = IPCTransit.receive('qname' => 'test_qname', 'nowait' => 1)
+            ret = IPCTransit.receive('qname' => $ipc_transit_test_qname, 'nowait' => 1)
         rescue Exception => msg
             puts "Exception: #{msg}"
         end

data/test/tc_transit_simple.rb

@@ -4,33 +4,33 @@ require 'ipc_transit/test'
 
 class TestIPCTransit < Test::Unit::TestCase
     def test_typical
-        drain_test_queue()
-        IPCTransit.send('message' => { 'foo' => 'bar' }, 'qname' => 'test_qname')
-        ret = IPCTransit.receive('qname' => 'test_qname', 'nowait' => 1)
+        clear_test_queue()
+        IPCTransit.send('message' => { 'foo' => 'bar' }, 'qname' => $ipc_transit_test_qname)
+        ret = IPCTransit.receive('qname' => $ipc_transit_test_qname, 'nowait' => 1)
         assert(ret, 'IPCTransit.receive returned true')
         assert_equal(ret['foo'], 'bar')
     end
 
     def test_wire_raw
-        drain_test_queue()
-        IPCTransit.send('message' => { 'foo' => 'bar' }, 'qname' => 'test_qname', 'e' => 'json', 'c' => 'none')
-        ret = IPCTransit.receive('qname' => 'test_qname', 'raw' => 1, 'nowait' => 1)
+        clear_test_queue()
+        IPCTransit.send('message' => { 'foo' => 'bar' }, 'qname' => $ipc_transit_test_qname, 'encoding' => 'json', 'compression' => 'none')
+        ret = IPCTransit.receive('qname' => $ipc_transit_test_qname, 'raw' => 1, 'nowait' => 1)
         assert(ret, 'IPCTransit.receive returned true')
         assert_equal(ret['message']['foo'], 'bar')
         assert_equal(ret['wire_headers']['e'], 'json')
         assert_equal(ret['wire_headers']['c'], 'none')
     end
     def test_message_meta
-        drain_test_queue()
-        IPCTransit.send( 'qname' => 'test_qname',
+        clear_test_queue()
+        IPCTransit.send( 'qname' => $ipc_transit_test_qname,
                 'message' => { 'foo' => 'bar' },
-                'e' => 'json',
-                'c' => 'none',
+                'encoding' => 'json',
+                'compression' => 'none',
                 'something' => 'else',
                 'x' => { 'this' => 'that' },
                 'once' => ['more',2]
         )
-        ret = IPCTransit.receive('qname' => 'test_qname', 'nowait' => 1)
+        ret = IPCTransit.receive('qname' => $ipc_transit_test_qname, 'nowait' => 1)
         assert(ret, 'IPCTransit.receive returned true')
         assert_equal(ret['foo'], 'bar')
         assert_equal(ret['.ipc_transit_meta']['something'], 'else')
@@ -40,27 +40,27 @@ class TestIPCTransit < Test::Unit::TestCase
     end
 
     def test_get_queue_info
-        drain_test_queue()
+        clear_test_queue()
         all_info = IPCTransit.all_queue_info()
-        IPCTransit.send('message' => { 'foo' => 'bar' }, 'qname' => 'test_qname')
+        IPCTransit.send('message' => { 'foo' => 'bar' }, 'qname' => $ipc_transit_test_qname)
         assert(all_info, 'We received some queue info')
 
-        assert(all_info['test_qname']['qname'] == 'test_qname', 'test queue is in all_queue_info')
-        qid = all_info['test_qname']['qid']
-        assert(qid, 'queue_id for test_qname exists')
+        assert(all_info[$ipc_transit_test_qname]['qname'] == $ipc_transit_test_qname, 'test queue is in all_queue_info')
+        qid = all_info[$ipc_transit_test_qname]['qid']
+        assert(qid, 'queue_id for tr_dist_test_qname exists')
 
-        ret = IPCTransit.receive('qname' => 'test_qname', 'nowait' => 1)
+        ret = IPCTransit.receive('qname' => $ipc_transit_test_qname, 'nowait' => 1)
         assert(ret, 'IPCTransit.receive returned true')
         assert_equal(ret['foo'], 'bar')
     end
 
     def test_all_queues
-        drain_test_queue()
-        IPCTransit.send('message' => { 'foo' => 'bar' }, 'qname' => 'test_qname')
+        clear_test_queue()
+        IPCTransit.send('message' => { 'foo' => 'bar' }, 'qname' => $ipc_transit_test_qname)
         ret = IPCTransit.all_queues()
         assert(ret, 'IPCTransit.all_queues returned true')
-        assert(ret['test_qname']['count'] == 1, 'exactly one message in test_qname')
-        ret = IPCTransit.receive('qname' => 'test_qname', 'nowait' => 1)
+        assert(ret[$ipc_transit_test_qname]['count'] == 1, 'exactly one message in tr_dist_test_qname')
+        ret = IPCTransit.receive('qname' => $ipc_transit_test_qname, 'nowait' => 1)
         assert(ret, 'IPCTransit.receive returned true')
         assert_equal(ret['foo'], 'bar')
     end

data/test/tc_transit_yaml.rb

@@ -4,17 +4,17 @@ require 'ipc_transit/test'
 
 class TestIPCTransit < Test::Unit::TestCase
     def test_yaml_typical
-        drain_test_queue()
-        IPCTransit.send('message' => { 'foo' => 'bar' }, 'e' => 'yaml', 'qname' => 'test_qname')
-        ret = IPCTransit.receive('qname' => 'test_qname', 'nowait' => 1)
+        clear_test_queue()
+        IPCTransit.send('message' => { 'foo' => 'bar' }, 'encoding' => 'yaml', 'qname' => $ipc_transit_test_qname)
+        ret = IPCTransit.receive('qname' => $ipc_transit_test_qname, 'nowait' => 1)
         assert(ret, 'IPCTransit.receive returned true')
         assert_equal(ret['foo'], 'bar')
     end
 
     def test_yaml_wire_raw
-        drain_test_queue()
-        IPCTransit.send('message' => { 'foo' => 'bar' }, 'qname' => 'test_qname', 'e' => 'yaml', 'c' => 'none')
-        ret = IPCTransit.receive('qname' => 'test_qname', 'raw' => 1, 'nowait' => 1)
+        clear_test_queue()
+        IPCTransit.send('message' => { 'foo' => 'bar' }, 'qname' => $ipc_transit_test_qname, 'encoding' => 'yaml', 'compression' => 'none')
+        ret = IPCTransit.receive('qname' => $ipc_transit_test_qname, 'raw' => 1, 'nowait' => 1)
         assert(ret, 'IPCTransit.receive returned true')
         assert(ret['serialized_message'] =~ /^---/, 'data verified as YAML')
         assert_equal(ret['message']['foo'], 'bar')
@@ -22,16 +22,16 @@ class TestIPCTransit < Test::Unit::TestCase
         assert_equal(ret['wire_headers']['c'], 'none')
     end
     def test_yaml_message_meta
-        drain_test_queue()
-        IPCTransit.send( 'qname' => 'test_qname',
+        clear_test_queue()
+        IPCTransit.send( 'qname' => $ipc_transit_test_qname,
                 'message' => { 'foo' => 'bar' },
-                'e' => 'json',
-                'c' => 'none',
+                'encoding' => 'json',
+                'compression' => 'none',
                 'something' => 'else',
                 'x' => { 'this' => 'that' },
                 'once' => ['more',2]
         )
-        ret = IPCTransit.receive('qname' => 'test_qname', 'e' => 'yaml', 'nowait' => 1)
+        ret = IPCTransit.receive('qname' => $ipc_transit_test_qname, 'encoding' => 'yaml', 'nowait' => 1)
         assert(ret, 'IPCTransit.receive returned true')
         assert_equal(ret['foo'], 'bar')
         assert_equal(ret['.ipc_transit_meta']['something'], 'else')

data/test/tc_transit_zlib.rb

@@ -4,32 +4,32 @@ require 'ipc_transit/test'
 
 class TestIPCTransit < Test::Unit::TestCase
     def test_zlib_typical
-        drain_test_queue()
-        IPCTransit.send('message' => { 'foo' => 'bar' }, 'qname' => 'test_qname', 'c' => 'zlib', 'e' => 'json')
-        ret = IPCTransit.receive('qname' => 'test_qname', 'nowait' => 1)
+        clear_test_queue()
+        IPCTransit.send('message' => { 'foo' => 'bar' }, 'qname' => $ipc_transit_test_qname, 'compression' => 'zlib', 'encoding' => 'json')
+        ret = IPCTransit.receive('qname' => $ipc_transit_test_qname, 'nowait' => 1)
         assert(ret, 'IPCTransit.receive returned true')
         assert_equal(ret['foo'], 'bar')
     end
 
     def test_zlib_wire_raw
-        drain_test_queue()
-        IPCTransit.send('message' => { 'foo' => 'bar' }, 'qname' => 'test_qname', 'c' => 'zlib')
-        ret = IPCTransit.receive('qname' => 'test_qname', 'raw' => 1, 'nowait' => 1)
+        clear_test_queue()
+        IPCTransit.send('message' => { 'foo' => 'bar' }, 'qname' => $ipc_transit_test_qname, 'compression' => 'zlib')
+        ret = IPCTransit.receive('qname' => $ipc_transit_test_qname, 'raw' => 1, 'nowait' => 1)
         assert(ret, 'IPCTransit.receive returned true')
         assert_equal(ret['message']['foo'], 'bar')
         assert_equal(ret['wire_headers']['c'], 'zlib')
     end
     def test_zlib_message_meta
-        drain_test_queue()
-        IPCTransit.send( 'qname' => 'test_qname',
+        clear_test_queue()
+        IPCTransit.send( 'qname' => $ipc_transit_test_qname,
                 'message' => { 'foo' => 'bar' },
-                'e' => 'json',
-                'c' => 'zlib',
+                'encoding' => 'json',
+                'compression' => 'zlib',
                 'something' => 'else',
                 'x' => { 'this' => 'that' },
                 'once' => ['more',2]
         )
-        ret = IPCTransit.receive('qname' => 'test_qname', 'nowait' => 1)
+        ret = IPCTransit.receive('qname' => $ipc_transit_test_qname, 'nowait' => 1)
         assert(ret, 'IPCTransit.receive returned true')
         assert_equal(ret['foo'], 'bar')
         assert_equal(ret['.ipc_transit_meta']['something'], 'else')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ipc_transit
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: '0.1'
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-17 00:00:00.000000000 Z
+date: 2012-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -100,6 +100,7 @@ files:
 - test/tc_transit_remote.rb
 - test/tc_transit_yaml.rb
 - test/tc_transit_zlib.rb
+- test/tc_transit_misc.rb
 homepage: http://rubygems.org/gems/ipc_transit
 licenses: []
 post_install_message: 
@@ -129,3 +130,4 @@ test_files:
 - test/tc_transit_remote.rb
 - test/tc_transit_yaml.rb
 - test/tc_transit_zlib.rb
+- test/tc_transit_misc.rb