ferocia-rubywmq 1.1.0

data/.document

@@ -0,0 +1,8 @@
+ext/lib/wmq_const.rb
+ext/wmq.c
+ext/wmq_queue_manager.c
+ext/wmq_message.c
+ext/wmq_queue.c
+ext/lib/wmq_const_admin.rb
+ext/lib/wmq_temp.rb
+README

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2006 J. Reid Morrison. Dimension Solutions, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/Manifest.txt

@@ -0,0 +1,20 @@
+.document
+lib/wmq.rb
+ext/lib/wmq_temp.rb
+ext/decode_rfh.h
+ext/decode_rfh.c
+ext/wmq.h
+ext/wmq.c
+ext/wmq_message.c
+ext/wmq_mq_load.c
+ext/wmq_queue.c
+ext/wmq_queue_manager.c
+ext/extconf.rb
+ext/extconf_client.rb
+ext/build.bat
+ext/build.sh
+ext/generate/generate_const.rb
+ext/generate/generate_reason.rb
+ext/generate/generate_structs.rb
+ext/generate/wmq_structs.erb
+examples/files_to_q.cfg

data/README

@@ -0,0 +1,73 @@
+== Description
+   rubywmq - RubyWMQ is a Ruby interface into WebSphere MQ, previously called MQSeries
+
+== Synopsis
+   require 'wmq'
+
+   WMQ::QueueManager.connect(:q_mgr_name=>'REID') do |qmgr|
+     qmgr.put(:q_name=>'TEST.QUEUE', :data => 'Hello World')
+   end
+
+== Building Ruby WMQ
+   Building Ruby WMQ on UNIX/Linux
+   -------------------------------
+   The following is required to build from source code
+   * A 'C' compiler
+   * The WebSphere MQ Software development toolkit
+
+   Extracting the source code package:
+   * unzip package.zip
+   * tar -xvf package.tar
+
+   cd ext/wmq
+   Edit the file build.sh and edit the location of WebSphere MQ (if not in /opt/mqm)
+   Also edit extconf.rb and extconf_client.rb with the location of WebSphere MQ (if not in /opt/mqm)
+
+   Run build.sh
+
+   For any questions, or to report build errors, submit a new Support Request:
+   http://rubywmq.rubyforge.org
+
+   Building Ruby WMQ on Windows
+   ----------------------------
+   The following is required to build from source code
+   * The Visual C++ 6.0 compiler
+   * The WebSphere MQ Software development toolkit
+
+   cd ext\wmq
+   Edit the file build.bat and edit the location of WebSphere MQ
+   (if not in C:\Program Files\IBM\WebSphere MQ)
+   and the location of Visual C++ 6 (if not C:\Program Files\Microsoft Visual Studio\VC98)
+   Also edit extconf.rb and extconf_client.rb with the location of WebSphere MQ (if not in C:\Program Files\IBM\WebSphere MQ)
+
+   Run build.bat
+
+== Support
+   For any questions, or to report build errors, submit a new Support Request:
+   http://rubywmq.rubyforge.org
+
+== Future Plans
+   Add more formatting option contants and related methods.
+
+== License
+   Copyright 2006 J. Reid Morrison. Dimension Solutions, Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+
+== Copyright
+   (C) 2006 J. Reid Morrison. Dimension Solutions, Inc.
+   All Rights Reserved
+
+== Author
+   Reid Morrison
+   rubywmq at gmail dot com

data/examples/each_a.rb

@@ -0,0 +1,32 @@
+################################################################################
+#  Copyright 2006 J. Reid Morrison. Dimension Solutions, Inc.
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+################################################################################
+
+#
+# Sample : each() : Retrieve all messages from a queue
+#          If no messages are on the queue, the program
+#          completes without waiting
+#
+require 'rubygems'
+require 'wmq/wmq'
+
+WMQ::QueueManager.connect(:q_mgr_name=>'REID') do |qmgr|
+  qmgr.open_queue(:q_name=>'TEST.QUEUE', :mode=>:input) do |queue|
+    queue.each do |message|
+      puts "Data Received: #{message.data}"
+    end
+  end
+  puts 'Completed.'
+end

data/examples/each_b.rb

@@ -0,0 +1,41 @@
+################################################################################
+#  Copyright 2006 J. Reid Morrison. Dimension Solutions, Inc.
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+################################################################################
+
+#
+# Sample : each() : Retrieve all messages from a queue that
+#          have the same correlation id
+#
+require 'rubygems'
+require 'wmq/wmq'
+
+WMQ::QueueManager.connect(:q_mgr_name=>'REID') do |qmgr|
+  qmgr.open_queue(:q_name=>'TEST.QUEUE', :mode=>:input) do |queue|
+    message = WMQ::Message.new
+
+    # Retrieve First message
+    if queue.get(:message=>message)
+      puts "Data Received: #{message.data}"
+
+      #Retrieve all subsequent messages that have the same correlation id
+      queue.each(:message=>message, :match=>WMQ::MQMO_MATCH_CORREL_ID) do |msg|
+        puts "Matching Data Received: #{msg.data}"
+      end
+    else
+      puts 'No message available'
+    end
+  end
+  puts 'Completed.'
+end

data/examples/each_header.rb

@@ -0,0 +1,38 @@
+################################################################################
+#  Copyright 2006 J. Reid Morrison. Dimension Solutions, Inc.
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+################################################################################
+
+#
+# Sample : each() : Retrieve all messages from a queue
+#          If no messages are on the queue, the program
+#          completes without waiting
+#
+require 'rubygems'
+require 'wmq/wmq'
+
+WMQ::QueueManager.connect(:q_mgr_name=>'REID') do |qmgr|
+  qmgr.open_queue(:q_name=>'TEST.DEAD', :mode=>:browse) do |queue|
+    queue.each do |message|
+      puts "Data Received: #{message.data}"
+      
+      puts "Message Descriptor:"
+      p message.descriptor
+      
+      puts "Headers Received:"
+      message.headers.each {|header| p header}
+    end
+  end
+  puts 'Completed.'
+end

data/examples/files_to_q.cfg

@@ -0,0 +1,24 @@
+dev:
+  qmgr_options:
+    :q_mgr_name: REID
+  output_queue:
+    :q_name: TEST.QUEUE
+  put_options:
+    :new_msg_id: true
+  descriptor:
+    :format: MQSTR
+  source_directory: messages
+
+test:
+  qmgr_options:
+    :q_mgr_name: TEST.QMGR
+    :channel_name: SYSTEM.DEF.SVRCONN
+    :connection_name: remotehost(1414)
+  output_queue:
+    :q_name: TEST.QUEUE
+  put_options:
+    :new_msg_id: true
+  descriptor:
+    :format: MQSTR
+  source_directory: messages
+

data/examples/files_to_q.rb

@@ -0,0 +1,47 @@
+################################################################################
+#  Copyright 2006 J. Reid Morrison. Dimension Solutions, Inc.
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+################################################################################
+
+#
+# Example : files_to_q : Place all files in a directory to a queue
+#          Each file is written as a separate message
+#
+require 'rubygems'
+require 'find'
+require 'yaml'
+require 'wmq/wmq'
+
+# Call program passing environment name as first parameter
+#   The environment corresponds to an entry in the config file
+env = ARGV[0] || raise("Command line argument 'environment' is required")
+config = YAML::load_file('files_to_q.cfg')[env]
+
+message = WMQ::Message.new
+message.descriptor = config['descriptor'] || {}
+tstart = Time.now
+counter = 0
+WMQ::QueueManager.connect(config['qmgr_options']) do |qmgr|
+  qmgr.open_queue({:mode=>:output}.merge(config['output_queue'])) do |queue|
+    Find.find(config['source_directory']) do |path|
+      unless FileTest.directory?(path)
+        printf("%5d: #{path}\n",counter = counter + 1)
+        message.data = File.read(path)
+        queue.put({:message => message}.merge(config['put_options']))
+      end
+    end
+  end
+end
+duration = Time.now - tstart
+printf "Processed #{counter} messages in %.3f seconds. Average: %.3f messages/second\n", duration, counter/duration

data/examples/get_a.rb

@@ -0,0 +1,35 @@
+################################################################################
+#  Copyright 2006 J. Reid Morrison. Dimension Solutions, Inc.
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+################################################################################
+
+#
+# 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'
+
+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)
+      puts "Data Received: #{message.data}"
+    else
+      puts 'No message available'
+    end
+  end
+end
+

data/examples/get_client.rb

@@ -0,0 +1,51 @@
+################################################################################
+#  Copyright 2006 J. Reid Morrison. Dimension Solutions, Inc.
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+################################################################################
+
+#
+# Sample : get() : Retrieve a single message from a queue
+#          If no messages are on the queue, message.data is nil
+#
+# The Client connection is determined by the :connection_name parameter supplied
+# to QueueManager::connect or QueueManager::new
+# 
+# If :connection_name is not present, a WebSphere MQ Server connection will be used
+# I.e. Local server connection
+# 
+require 'rubygems'
+require 'wmq/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|
+
+    message = WMQ::Message.new
+    if queue.get(:message => message)
+      puts "Data Received: #{message.data}"
+      
+      puts "Message Descriptor:"
+      p message.descriptor
+      
+      puts "Headers Received:"
+      message.headers.each {|header| p header}
+    else
+      puts 'No message available'
+    end
+  end
+end
+

data/examples/put1_a.rb

@@ -0,0 +1,25 @@
+################################################################################
+#  Copyright 2006 J. Reid Morrison. Dimension Solutions, Inc.
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+################################################################################
+
+#
+# Sample : put1() : Put a single message to a queue
+#
+require 'rubygems'
+require 'wmq/wmq'
+
+WMQ::QueueManager.connect(:q_mgr_name=>'REID') do |qmgr|
+  qmgr.put(:q_name=>'TEST.QUEUE', :data => 'Hello World')
+end

data/examples/put1_b.rb

@@ -0,0 +1,33 @@
+################################################################################
+#  Copyright 2006 J. Reid Morrison. Dimension Solutions, Inc.
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+################################################################################
+
+#
+# Sample : put1() : Put a single message to a queue
+#
+#          Set the correlation id to a text string
+#
+require 'rubygems'
+require 'wmq/wmq'
+
+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)
+end
+

data/examples/put1_c.rb

@@ -0,0 +1,32 @@
+################################################################################
+#  Copyright 2006 J. Reid Morrison. Dimension Solutions, Inc.
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+################################################################################
+
+#
+# Sample : put() : Put a single request message to a queue
+#
+require 'rubygems'
+require 'wmq/wmq'
+
+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'}
+  
+  qmgr.put(:q_name=>'TEST.QUEUE', :message => message)
+end

data/examples/put_a.rb

@@ -0,0 +1,35 @@
+################################################################################
+#  Copyright 2006 J. Reid Morrison. Dimension Solutions, Inc.
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+################################################################################
+
+#
+# Sample : put() : Put a single message to a queue
+#          Open the queue so that multiple puts can be performed
+#
+require 'rubygems'
+require 'wmq/wmq'
+
+WMQ::QueueManager.connect(:q_mgr_name=>'REID') do |qmgr|
+  qmgr.open_queue(:q_name=>'TEST.QUEUE', :mode=>:output) do |queue|
+
+    # First message
+    queue.put(:data => 'Hello World')
+
+    # Second message
+    #   This message will have new message and correlation id's
+    queue.put(:data => 'Hello Again')
+  end
+end
+

data/examples/put_b.rb

@@ -0,0 +1,43 @@
+################################################################################
+#  Copyright 2006 J. Reid Morrison. Dimension Solutions, Inc.
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+################################################################################
+
+#
+# Sample : put() : Put two Messages to a queue
+#          Open the queue so that multiple puts can be performed
+#          Ensure that all messages have the same correlation id
+#
+require 'rubygems'
+require 'wmq/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
+
+    # First message
+    #   Results in a WMQ generated msg_id and empty correl_id
+    message.data = 'Hello World'
+    queue.put(:message => message)
+
+    # Second message
+    #   new_msg_id will cause the second message to have a new message id
+    #   otherwise both messages will have the same message and correlation id's
+    #   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)
+  end
+end

data/examples/put_dlh.rb

@@ -0,0 +1,41 @@
+################################################################################
+#  Copyright 2006 J. Reid Morrison. Dimension Solutions, Inc.
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+################################################################################
+
+#
+# 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'
+
+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'}
+    ]
+    
+    message.descriptor[:format] = WMQ::MQFMT_STRING
+    
+    queue.put(:message=>message)
+  end
+end
+

data/examples/put_dynamic_q.rb

@@ -0,0 +1,38 @@
+################################################################################
+#  Copyright 2006 J. Reid Morrison. Dimension Solutions, Inc.
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+################################################################################
+
+#
+# Sample : put() : Put a single message to a queue
+#          Create the queue if it does not already exist
+#
+#   Note : The queue name is that of the model queue
+#          The dynamic_q_name is the actual queue name
+#
+#   This sample is more usefull if the model queue was a Permanent Dynamic one.
+#   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'
+
+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