rubywmq 2.0.2 → 2.1.0

data/examples/get_a.rb

@@ -2,14 +2,12 @@
 # Sample : get() : Retrieve a single message from a queue
 #          If no messages are on the queue, message.data is nil
 #
-require 'rubygems'
 require 'wmq'
 
-WMQ::QueueManager.connect(:q_mgr_name=>'REID') do |qmgr|
-  qmgr.open_queue(:q_name=>'TEST.QUEUE', :mode=>:input) do |queue|
-
+WMQ::QueueManager.connect(q_mgr_name: 'REID') do |qmgr|
+  qmgr.open_queue(q_name: 'TEST.QUEUE', mode: :input) do |queue|
     message = WMQ::Message.new
-    if queue.get(:message => message)
+    if queue.get(message: message)
       puts "Data Received: #{message.data}"
     else
       puts 'No message available'

data/examples/get_client.rb

@@ -8,25 +8,24 @@
 # If :connection_name is not present, a WebSphere MQ Server connection will be used
 # I.e. Local server connection
 #
-require 'rubygems'
 require 'wmq'
 
 WMQ::QueueManager.connect(
-            :connection_name => 'localhost(1414)',        # Use MQ Client Library
-            :channel_name    => 'SYSTEM.DEF.SVRCONN',     # Optional, since this is the default value
-            :transport_type  => WMQ::MQXPT_TCP            # Optional, since this is the default value
-       ) do |qmgr|
-  qmgr.open_queue(:q_name=>'TEST.QUEUE', :mode=>:input) do |queue|
+  connection_name: 'localhost(1414)',    # Use MQ Client Library
+  channel_name:    'SYSTEM.DEF.SVRCONN', # Optional, since this is the default value
+  transport_type:  WMQ::MQXPT_TCP        # Optional, since this is the default value
+) do |qmgr|
+  qmgr.open_queue(q_name: 'TEST.QUEUE', mode: :input) do |queue|
 
     message = WMQ::Message.new
-    if queue.get(:message => message)
+    if queue.get(message: message)
       puts "Data Received: #{message.data}"
 
-      puts "Message Descriptor:"
+      puts 'Message Descriptor:'
       p message.descriptor
 
-      puts "Headers Received:"
-      message.headers.each {|header| p header}
+      puts 'Headers Received:'
+      message.headers.each { |header| p header }
     else
       puts 'No message available'
     end

data/examples/put1_a.rb

@@ -1,9 +1,8 @@
 #
 # Sample : put1() : Put a single message to a queue
 #
-require 'rubygems'
 require 'wmq'
 
-WMQ::QueueManager.connect(:q_mgr_name=>'REID') do |qmgr|
-  qmgr.put(:q_name=>'TEST.QUEUE', :data => 'Hello World')
+WMQ::QueueManager.connect(q_mgr_name: 'REID') do |qmgr|
+  qmgr.put(q_name: 'TEST.QUEUE', data: 'Hello World')
 end

data/examples/put1_b.rb

@@ -3,15 +3,12 @@
 #
 #          Set the correlation id to a text string
 #
-require 'rubygems'
 require 'wmq'
 
-WMQ::QueueManager.connect(:q_mgr_name=>'REID') do |qmgr|
-
-  message = WMQ::Message.new
-  message.data = 'Hello World'
+WMQ::QueueManager.connect(q_mgr_name: 'REID') do |qmgr|
+  message                        = WMQ::Message.new
+  message.data                   = 'Hello World'
   message.descriptor[:correl_id] = 'My first message'
 
-  qmgr.put(:q_name=>'TEST.QUEUE', :message=>message)
+  qmgr.put(q_name: 'TEST.QUEUE', message: message)
 end
-

data/examples/put1_c.rb

@@ -1,16 +1,16 @@
 #
 # Sample : put() : Put a single request message to a queue
 #
-require 'rubygems'
 require 'wmq'
 
-WMQ::QueueManager.connect(:q_mgr_name=>'REID') do |qmgr|
-  message = WMQ::Message.new
+WMQ::QueueManager.connect(q_mgr_name: 'REID') do |qmgr|
+  message      = WMQ::Message.new
   message.data = 'Hello World'
 
   message.descriptor = {
-    :msg_type=> WMQ::MQMT_REQUEST,
-    :reply_to_q=>'TEST.REPLY.QUEUE'}
+    msg_type:   WMQ::MQMT_REQUEST,
+    reply_to_q: 'TEST.REPLY.QUEUE'
+  }
 
-  qmgr.put(:q_name=>'TEST.QUEUE', :message => message)
+  qmgr.put(q_name: 'TEST.QUEUE', message: message)
 end

data/examples/put_a.rb

@@ -2,7 +2,6 @@
 # Sample : put() : Put a single message to a queue
 #          Open the queue so that multiple puts can be performed
 #
-require 'rubygems'
 require 'wmq'
 
 WMQ::QueueManager.connect(:q_mgr_name=>'REID') do |qmgr|
@@ -16,4 +15,3 @@ WMQ::QueueManager.connect(:q_mgr_name=>'REID') do |qmgr|
     queue.put(:data => 'Hello Again')
   end
 end
-

data/examples/put_b.rb

@@ -3,18 +3,16 @@
 #          Open the queue so that multiple puts can be performed
 #          Ensure that all messages have the same correlation id
 #
-require 'rubygems'
 require 'wmq'
 
-WMQ::QueueManager.connect(:q_mgr_name=>'REID') do |qmgr|
-  qmgr.open_queue(:q_name=>'TEST.QUEUE', :mode=>:output) do |queue|
-
-    message = WMQ::Message.new
+WMQ::QueueManager.connect(q_mgr_name: 'REID') do |qmgr|
+  qmgr.open_queue(q_name: 'TEST.QUEUE', mode: :output) do |queue|
+    message      = WMQ::Message.new
 
     # First message
     #   Results in a WMQ generated msg_id and empty correl_id
     message.data = 'Hello World'
-    queue.put(:message => message)
+    queue.put(message: message)
 
     # Second message
     #   new_msg_id will cause the second message to have a new message id
@@ -22,6 +20,6 @@ WMQ::QueueManager.connect(:q_mgr_name=>'REID') do |qmgr|
     #   This message will have the same correlation id as the first message (empty)
     message.data = 'Hello Again'
     p message.descriptor
-    queue.put(:message => message, :new_msg_id => true)
+    queue.put(message: message, new_msg_id: true)
   end
 end

data/examples/put_dlh.rb

@@ -2,24 +2,23 @@
 # Sample : put() : Put a message to a queue with a dead letter header
 #          Open the queue so that multiple puts can be performed
 #
-require 'rubygems'
 require 'wmq'
 
-WMQ::QueueManager.connect(:q_mgr_name=>'REID') do |qmgr|
-  qmgr.open_queue(:q_name=>'TEST.QUEUE', :mode=>:output) do |queue|
-    message = WMQ::Message.new
-    message.data = 'Hello World'
-
+WMQ::QueueManager.connect(q_mgr_name: 'REID') do |qmgr|
+  qmgr.open_queue(q_name: 'TEST.QUEUE', mode: :output) do |queue|
+    message         = WMQ::Message.new
+    message.data    = 'Hello World'
     message.headers = [
-     {:header_type =>:dead_letter_header,
-      :reason      => WMQ::MQRC_UNKNOWN_REMOTE_Q_MGR,
-      :dest_q_name =>'ORIGINAL_QUEUE_NAME',
-      :dest_q_mgr_name =>'BAD_Q_MGR'}
+      {
+        header_type:     :dead_letter_header,
+        reason:          WMQ::MQRC_UNKNOWN_REMOTE_Q_MGR,
+        dest_q_name:     'ORIGINAL_QUEUE_NAME',
+        dest_q_mgr_name: 'BAD_Q_MGR'
+      }
     ]
 
     message.descriptor[:format] = WMQ::MQFMT_STRING
 
-    queue.put(:message=>message)
+    queue.put(:message => message)
   end
 end
-

data/examples/put_dynamic_q.rb

@@ -9,14 +9,14 @@
 #   That way the queue would remain after termination of this code.
 #   In this sample the queue will disappear when this program terminates
 #
-require 'rubygems'
 require 'wmq'
 
-WMQ::QueueManager.connect(:q_mgr_name=>'REID') do |qmgr|
-  qmgr.open_queue(:q_name => 'SYSTEM.DEFAULT.MODEL.QUEUE',
-                  :dynamic_q_name => 'TEST.QUEUE.SAMPLE',
-                  :mode  => :output
-                  ) do |queue|
-    queue.put(:data => 'Hello World')
+WMQ::QueueManager.connect(q_mgr_name: 'REID') do |qmgr|
+  qmgr.open_queue(
+    q_name:         'SYSTEM.DEFAULT.MODEL.QUEUE',
+    dynamic_q_name: 'TEST.QUEUE.SAMPLE',
+    mode:           :output
+  ) do |queue|
+    queue.put(data: 'Hello World')
   end
 end

data/examples/put_group_a.rb

@@ -5,14 +5,13 @@
 #          Allow MQ to create the unique group id and let it automatically
 #          assign message sequence numbers for each message in the group
 #
-require 'rubygems'
 require 'wmq'
 
 # Put 5 messages in a single group onto the queue
 total = 5
 
-WMQ::QueueManager.connect(:q_mgr_name=>'REID') do |qmgr|
-  qmgr.open_queue(:q_name=>'TEST.QUEUE', :mode=>:output) do |queue|
+WMQ::QueueManager.connect(q_mgr_name: 'REID') do |qmgr|
+  qmgr.open_queue(q_name: 'TEST.QUEUE', mode: :output) do |queue|
     message = WMQ::Message.new
     total.times do |count|
       message.data = "Hello:#{count}"
@@ -28,7 +27,7 @@ WMQ::QueueManager.connect(:q_mgr_name=>'REID') do |qmgr|
       #
       # By setting the put :options => WMQ::MQPMO_LOGICAL_ORDER then MQ will supply a unique Group Id
       # and MQ will automatically set the message sequence number for us.
-      queue.put(:message => message, :new_id => true, :options => WMQ::MQPMO_LOGICAL_ORDER)
+      queue.put(message: message, new_id: true, options: WMQ::MQPMO_LOGICAL_ORDER)
       p message.descriptor
     end
   end

data/examples/put_group_b.rb

@@ -5,32 +5,32 @@
 #          Supply our own user-defined group Id.
 #          We also have to supply the message sequence number which starts at 1
 #
-require 'rubygems'
 require 'wmq'
 
 # Put 5 messages in a single group onto the queue
 total = 5
 
-WMQ::QueueManager.connect(:q_mgr_name=>'REID') do |qmgr|
-  qmgr.open_queue(:q_name=>'TEST.QUEUE', :mode=>:output) do |queue|
-    message = WMQ::Message.new
+WMQ::QueueManager.connect(q_mgr_name: 'REID') do |qmgr|
+  qmgr.open_queue(q_name: 'TEST.QUEUE', mode: :output) do |queue|
+    message                       = WMQ::Message.new
     # Supply a unique Group Id, truncated to the MQ maximum for Group Id.
     message.descriptor[:group_id] = 'MyUniqueGroupId'
+
     total.times do |count|
       #   new_id => true causes subsequent messages to have unique message and
       #   correlation id's. Otherwise all messages will have the same message and
       #   correlation id's since the same message object is being
       #   re-used for all put calls
-      message.data = "Hello:#{count}"
+      message.data                        = "Hello:#{count}"
 
       # Set the message flag to indicate message is in a group
       # On the last message, set the last message flag
-      message.descriptor[:msg_flags] = (count < total-1) ? WMQ::MQMF_MSG_IN_GROUP : WMQ::MQMF_LAST_MSG_IN_GROUP
+      message.descriptor[:msg_flags]      = (count < total-1) ? WMQ::MQMF_MSG_IN_GROUP : WMQ::MQMF_LAST_MSG_IN_GROUP
       message.descriptor[:msg_seq_number] = count + 1
 
       # By setting the put :options => WMQ::MQPMO_LOGICAL_ORDER then MQ will supply a unique Group Id
       # and MQ will automatically set the message sequence number for us.
-      queue.put(:message => message, :new_id => true)
+      queue.put(message: message, new_id: true)
       p message.descriptor
     end
   end

data/examples/put_rfh.rb

@@ -2,7 +2,6 @@
 # Sample : put() : Put a message to a queue with a Refernce header
 #          Open the queue so that multiple puts can be performed
 #
-require 'rubygems'
 require 'wmq'
 
 # The Rules Format header (MQRFH) allows a list of name value pairs to be sent along
@@ -31,21 +30,24 @@ require 'wmq'
 #       it out immediately again could result in re-ordering of the name value pairs.
 #
 
-WMQ::QueueManager.connect(:q_mgr_name=>'REID') do |qmgr|
-  qmgr.open_queue(:q_name=>'TEST.QUEUE', :mode=>:output) do |queue|
-    message = WMQ::Message.new
+WMQ::QueueManager.connect(q_mgr_name: 'REID') do |qmgr|
+  qmgr.open_queue(q_name: 'TEST.QUEUE', mode: :output) do |queue|
+    message      = WMQ::Message.new
     message.data = 'Hello World'
 
     message.headers = [
-     {:header_type =>:rf_header,
-      :name_value => {'name1' => 'value1',
-                      'name2' => 'value2',
-                      'name3' => ['value 3a', 'value 3b']}
-     }]
+      {
+        header_type: :rf_header,
+        name_value:  {
+          'name1' => 'value1',
+          'name2' => 'value2',
+          'name3' => ['value 3a', 'value 3b']
+        }
+      }
+    ]
 
     message.descriptor[:format] = WMQ::MQFMT_STRING
 
-    queue.put(:message=>message)
+    queue.put(message: message)
   end
 end
-

data/examples/put_rfh2_a.rb

@@ -2,26 +2,25 @@
 # Sample : put() : Put a message to a queue with a Refernce header
 #          Open the queue so that multiple puts can be performed
 #
-require 'rubygems'
 require 'wmq'
 
 # The Rules Format header2 (MQRFH2) allows a an XML-like string to be passed as a header
 # to the data.
 #
-
-WMQ::QueueManager.connect(:q_mgr_name=>'REID') do |qmgr|
-  qmgr.open_queue(:q_name=>'TEST.QUEUE', :mode=>:output) do |queue|
-    message = WMQ::Message.new
+WMQ::QueueManager.connect(q_mgr_name: 'REID') do |qmgr|
+  qmgr.open_queue(q_name: 'TEST.QUEUE', mode: :output) do |queue|
+    message      = WMQ::Message.new
     message.data = 'Hello World'
 
     message.headers = [
-     {:header_type =>:rf_header_2,
-      :xml => '<hello>to the world</hello>'
-     }]
+      {
+        header_type: :rf_header_2,
+        xml:         '<hello>to the world</hello>'
+      }
+    ]
 
     message.descriptor[:format] = WMQ::MQFMT_STRING
 
-    queue.put(:message=>message)
+    queue.put(message: message)
   end
 end
-

data/examples/put_rfh2_b.rb

@@ -2,26 +2,26 @@
 # Sample : put() : Put a message to a queue with a Refernce header
 #          Open the queue so that multiple puts can be performed
 #
-require 'rubygems'
 require 'wmq'
 
 # The Rules Format header2 (MQRFH2) allows a an XML-like string to be passed as a header
 # to the data.
 #
-
-WMQ::QueueManager.connect(:q_mgr_name=>'REID') do |qmgr|
-  qmgr.open_queue(:q_name=>'TEST.QUEUE', :mode=>:output) do |queue|
-    message = WMQ::Message.new
+WMQ::QueueManager.connect(q_mgr_name: 'REID') do |qmgr|
+  qmgr.open_queue(q_name: 'TEST.QUEUE', mode: :output) do |queue|
+    message      = WMQ::Message.new
     message.data = 'Hello World'
 
     message.headers = [
-     {:header_type =>:rf_header_2,
-      :xml => ['<hello>to the world</hello>', '<another>xml like string</another>'],
-     }]
+      {
+        header_type: :rf_header_2,
+        xml:         ['<hello>to the world</hello>', '<another>xml like string</another>'],
+      }
+    ]
 
     message.descriptor[:format] = WMQ::MQFMT_STRING
 
-    queue.put(:message=>message)
+    queue.put(message: message)
   end
 end
 

data/examples/put_xmit_q.rb

@@ -1,17 +1,72 @@
 #
 # Sample : put() : Put a message to a queue with a Transmission header
 #
-require 'rubygems'
 require 'wmq'
 
-WMQ::QueueManager.connect(:q_mgr_name=>'REID') do |qmgr|
-  qmgr.open_queue(:q_name=>'TEST.QUEUE', :mode=>:output) do |queue|
-    message = WMQ::Message.new
-    message.data = "Test message from 'LOCALQMS1'"
-    message.descriptor = {:original_length=>-1, :priority=>0, :put_time=>"18510170", :msg_id=>"AMQ LOCALQMS1   E\233\001\237 \000\003\005", :expiry=>-1, :persistence=>0, :reply_to_q=>"MQMON", :correl_id=>"AMQ LOCALQMS1   E\233\001\237 \000\003\004", :feedback=>0, :offset=>0, :report=>0, :msg_flags=>0, :reply_to_q_mgr=>"LOCALQMS1", :appl_identity_data=>"", :put_appl_name=>"LOCALQMS1", :user_identifier=>"mqm", :msg_seq_number=>1, :appl_origin_data=>"", :accounting_token=>"\026\001\005\025\000\000\000\271U\305\002\261\022\362\321\021D\3206\357\003\000\000\000\000\000\000\000\000\000\000\v", :backout_count=>0, :coded_char_set_id=>437, :put_appl_type=>7, :msg_type=>8, :group_id=>"", :put_date=>"20070109", :format=>"MQSTR", :encoding=>546}
-    message.headers = [{:priority=>0, :remote_q_mgr_name=>"OTHER.QMGR", :put_time=>"18510170", :msg_id=>"AMQ LOCALQMS1   E\233\001\237 \000\003\004", :expiry=>-1, :persistence=>0, :remote_q_name=>"OTHER.Q", :header_type=>:xmit_q_header, :reply_to_q=>"MQMON", :correl_id=>"", :feedback=>0, :report=>0, :reply_to_q_mgr=>"LOCALQMS1", :appl_identity_data=>"", :put_appl_name=>"uments\\MQ\\MQMon\\mqmonntp.exe", :user_identifier=>"mqm", :appl_origin_data=>"", :accounting_token=>"\026\001\005\025\000\000\000\271U\305\002\261\022\362\321\021D\3206\357\003\000\000\000\000\000\000\000\000\000\000\v", :backout_count=>0, :coded_char_set_id=>437, :put_appl_type=>11, :msg_type=>8, :put_date=>"20070109", :encoding=>546}]
+WMQ::QueueManager.connect(q_mgr_name: 'REID') do |qmgr|
+  qmgr.open_queue(q_name: 'TEST.QUEUE', mode: :output) do |queue|
+    message            = WMQ::Message.new
+    message.data       = "Test message from 'LOCALQMS1'"
+    message.descriptor = {
+      original_length:    -1,
+      priority:           0,
+      put_time:           '18510170',
+      msg_id:             "AMQ LOCALQMS1   E\233\001\237 \000\003\005",
+      expiry:             -1,
+      persistence:        0,
+      reply_to_q:         'MQMON',
+      correl_id:          "AMQ LOCALQMS1   E\233\001\237 \000\003\004",
+      feedback:           0,
+      offset:             0,
+      report:             0,
+      msg_flags:          0,
+      reply_to_q_mgr:     'LOCALQMS1',
+      appl_identity_data: '',
+      put_appl_name:      'LOCALQMS1',
+      user_identifier:    'mqm',
+      msg_seq_number:     1,
+      appl_origin_data:   '',
+      accounting_token:   "\026\001\005\025\000\000\000\271U\305\002\261\022\362\321\021D\3206\357\003\000\000\000\000\000\000\000\000\000\000\v",
+      backout_count:      0,
+      coded_char_set_id:  437,
+      put_appl_type:      7,
+      msg_type:           8,
+      group_id:           '',
+      put_date:           '20070109',
+      format:             'MQSTR',
+      encoding:           546
+    }
+    message.headers    =
+      [
+        {
+          priority:           0,
+          remote_q_mgr_name:  'OTHER.QMGR',
+          put_time:           '18510170',
+          msg_id:             "AMQ LOCALQMS1   E\233\001\237 \000\003\004",
+          expiry:             -1,
+          persistence:        0,
+          remote_q_name:      'OTHER.Q',
+          header_type:        :xmit_q_header,
+          reply_to_q:         'MQMON',
+          correl_id:          '',
+          feedback:           0,
+          report:             0,
+          reply_to_q_mgr:     'LOCALQMS1',
+          appl_identity_data: '',
+          put_appl_name:      "uments\\MQ\\MQMon\\mqmonntp.exe",
+          user_identifier:    'mqm',
+          appl_origin_data:   '',
+          accounting_token:   "\026\001\005\025\000\000\000\271U\305\002\261\022\362\321\021D\3206\357\003\000\000\000\000\000\000\000\000\000\000\v",
+          backout_count:      0,
+          coded_char_set_id:  437,
+          put_appl_type:      11,
+          msg_type:           8,
+          put_date:           '20070109',
+          encoding:           546
+        }
+      ]
 
-    queue.put(:message=>message)
+    queue.put(message: message)
   end
 end