ferocia-rubywmq 1.1.0

data/lib/wmq.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.
+################################################################################
+
+# Load wmq that uses auto-load library.
+# 
+# If it fails, then it is likely due to this platform not being supported
+# by auto load facility in Ruby WMQ, so try to load client linked library
+begin
+  require 'wmq/wmq'
+rescue LoadError
+  require 'wmq/wmq_client'
+end

data/rubywmq.binary.gemspec

@@ -0,0 +1,32 @@
+require 'fileutils'
+require 'rubygems'
+
+if $0 == __FILE__
+  FileUtils.mkdir_p('lib/wmq')
+  Dir['ext/lib/*.rb'].each{|file| FileUtils.copy(file, File.join('lib/wmq', File.basename(file)))}
+  FileUtils.copy('ext/wmq.so', 'lib/wmq/wmq.so')
+end
+
+spec = Gem::Specification.new do |s|
+  s.name = 'rubywmq'
+  s.version = '1.1.0'
+  s.author = 'Reid Morrison'
+  s.email = 'rubywmq@gmail.com'
+  s.homepage = 'http://www.reidmorrison.com/rubywmq'
+  s.platform = Gem::Platform::CURRENT
+  s.summary = 'Ruby interface into WebSphere MQ (MQSeries)'
+  s.description = 'RubyWMQ is a Ruby interface into WebSphere MQ, previously called MQSeries'
+  s.files = Dir['examples/**/*.rb'] + 
+            Dir['examples/**/*.cfg'] + 
+            Dir['doc/**/*.*'] + 
+            Dir['lib/**/*.rb'] + 
+            ['lib/wmq/wmq.so', 'tests/test.rb', 'README', 'LICENSE'] 
+  s.rubyforge_project = 'rubywmq'
+  s.test_file = 'tests/test.rb'
+  s.has_rdoc = false
+  s.required_ruby_version = '>= 1.8.3'
+  s.requirements << 'WebSphere MQ v5.3, v6 or v7 Client or Server'
+end
+if $0 == __FILE__
+  Gem::Builder.new(spec).build
+end

data/rubywmq.gemspec

@@ -0,0 +1,33 @@
+$:.unshift File.expand_path('../lib', __FILE__)
+
+Gem::Specification.new do |spec|
+
+  excludes = [/lib.wmq.constants\.rb/, /lib.wmq.constants_admin\.rb/, /ext.wmq_structs\.c/, /ext.wmq_reason\.c/, /ext.Makefile/, /ext.*\.o/, /ext.wmq\.so/, /\.gem$/, /\.log$/, /nbproject/]
+
+  spec.name              = 'ferocia-rubywmq'
+  spec.version           = "1.1.0"
+  spec.platform          = Gem::Platform::RUBY
+  spec.authors           = ['Reid Morrison', 'Edwin Fine']
+  spec.email             = ['reidmo@gmail.com']
+  spec.homepage          = 'https://github.com/reidmorrison/rubywmq'
+  spec.date              = Date.today.to_s
+  spec.summary           = "Native Ruby interface into WebSphere MQ"
+  spec.description       = "RubyWMQ is a high performance native Ruby interface into WebSphere MQ."
+  spec.files             = Dir.glob("./**/*").reject {|p| excludes.any? {|e| p[e] } }.map {|f| f.sub(/^\.\//, '')} + ['.document']
+  spec.license           = "Apache License V2.0"
+  spec.extensions        << 'ext/extconf.rb'
+  spec.rubyforge_project = 'rubywmq'
+  spec.test_file         = 'tests/test.rb'
+  spec.has_rdoc          = true
+  spec.required_ruby_version = '>= 1.8.4'
+  spec.add_development_dependency 'shoulda'
+  spec.requirements << 'WebSphere MQ v5.3, v6 or v7 Client or Server with Development Kit'
+
+  spec.post_install_message = <<-MESSAGE
+* ferocia-rubywmq builds against the WMQ libs, which aren't available for OS X.
+* The gem will still install, but the build will be skipped, producing a
+* non-functional gem, so you'll need stubs. (You can skip the build elsewhere by
+* setting the DISABLE_RUBYWMQ environment variable.)
+  MESSAGE
+end
+

data/tests/test.rb

@@ -0,0 +1,328 @@
+# Shift include path to use locally built copy of rubywmq - For testing dev builds only
+#$:.unshift '../lib'
+
+require 'rubygems'
+require 'wmq/wmq'
+require 'wmq/wmq_const_admin'
+require 'test/unit'
+class TestTest < Test::Unit::TestCase
+
+  def setup
+    puts '****** setup: start ******'
+    @queue_manager = WMQ::QueueManager.new(:q_mgr_name => 'REID') #, :connection_name=>'localhost(1414)')
+    @queue_manager.connect
+
+    # Create Queue and clear any messages from the queue
+    @in_queue = WMQ::Queue.new(:queue_manager=>@queue_manager,
+                               :mode=>:input,
+                               :dynamic_q_name=>'UNIT.TEST.*',
+                               :q_name=>'SYSTEM.DEFAULT.MODEL.QUEUE',
+                               :fail_if_exists=>false)
+    @in_queue.open
+    @in_queue.each { |message| }
+
+    # Open same queue for Output. Queue should be created by now
+    @out_queue = WMQ::Queue.new(:queue_manager=>@queue_manager,
+                                :mode=>:output,
+                                :q_name=>@in_queue.name)
+    @out_queue.open
+    puts '****** setup: end ******'
+  end
+
+  def teardown
+    puts '****** teardown: start ******'
+    @out_queue.close
+    @in_queue.close
+    @queue_manager.disconnect
+    puts '****** teardown: end ******'
+  end
+
+  def test_exceptions
+    puts '****** test_exceptions: start ******'
+    assert_raise(TypeError) { WMQ::QueueManager.new(1) }
+    assert_nothing_raised   { WMQ::QueueManager.new(:exception_on_error=>nil) }
+    assert_raise(TypeError) { WMQ::QueueManager.new(:exception_on_error=>1) }
+    assert_raise(TypeError) { WMQ::QueueManager.new(:q_mgr_name=>2).connect }
+    assert_raise(WMQ::WMQException) { WMQ::QueueManager.new(:q_mgr_name=>'bad').connect }
+    puts '****** test_exceptions: end ******'
+  end
+
+  def test_queue_manager
+    puts '****** test_queue_manager ******'
+    assert_equal(Object, WMQ::QueueManager.superclass)
+    assert_equal(WMQ::QueueManager, @queue_manager.class)
+  end
+
+  def test_1
+    puts '****** test_1 ******'
+    assert_equal(@out_queue.put(:data=>'Hello World'), true)
+    message = WMQ::Message.new
+    assert_equal(@in_queue.get(:message=>message), true)
+    assert_equal(message.data, 'Hello World')
+  end
+
+  def test_dynamic_buffer
+    puts '****** test_dynamic_buffer ******'
+    # Clear out queue of any messages
+    @in_queue.each { |message| }
+
+    test_sizes = [0, 1, 100, 101, 102, 500, 65534, 65535, 65536, 65537, 1*1024*1024, 4*1024*1024]
+    test_sizes.each do |size|
+      str = '0123456789ABCDEF' * (size/16) + '0123456789ABCDEF'[0,size%16]
+      assert_equal(str.length, size)
+      assert_equal(@out_queue.put(:data=>str), true)
+    end
+
+    # First test the browse mechanism
+    counter = 0
+    @queue_manager.open_queue(:mode=>:browse, :q_name=>@in_queue.name) do |browse_queue|
+      browse_queue.each do |message|
+        size = test_sizes[counter]
+        assert_equal(size, message.data.length)
+        str = '0123456789ABCDEF' * (size/16) + '0123456789ABCDEF'[0,size%16]
+        assert_equal(str, message.data)
+        counter = counter + 1
+      end
+    end
+    assert_equal(test_sizes.size, counter)
+
+    # Now retrieve the messages destructively
+    message = WMQ::Message.new
+    test_sizes.each do |size|
+      assert_equal(true, @in_queue.get(:message=>message, :match=>WMQ::MQMO_NONE))
+      assert_equal(size, message.data.length)
+      str = '0123456789ABCDEF' * (size/16) + '0123456789ABCDEF'[0,size%16]
+      assert_equal(str, message.data)
+    end
+  end
+
+  def test_q_name_hash
+    puts '****** test_q_name_hash ******'
+    @queue_manager.open_queue(:mode=>:output,
+                              :q_name=>{:q_name=>@in_queue.name,
+                                        :q_mgr_name=>@queue_manager.name}
+                             ) do |test_queue|
+      assert_equal(true, test_queue.put(:data=>'Hello World'))
+      message = WMQ::Message.new
+      assert_equal(true, @in_queue.get(:message=>message))
+      assert_equal('Hello World', message.data)
+    end
+  end
+
+  def test_execute
+    puts '****** test_execute ******'
+    array = @queue_manager.inquire_q(:q_name=>@in_queue.name, :q_type=>WMQ::MQQT_LOCAL, :current_q_depth=>nil)
+    assert_equal(1, array.size)
+    assert_equal(@in_queue.name, array[0][:q_name])
+
+    assert_equal(true, @queue_manager.inquire_process(:process_name=>'*').size>0)
+    assert_raise(WMQ::WMQException) { @queue_manager.inquire_q(:q_name=>'BADQUEUENAME*') }
+    assert_equal(1, @queue_manager.ping_q_mgr.size)
+  end
+
+  def test_mqsc
+    puts '****** test_mqsc ******'
+    array = @queue_manager.mqsc("dis ql(#{@in_queue.name})")
+    assert_equal(1, array.size)
+    assert_equal(true, array[0].include?("QUEUE(#{@in_queue.name})"))
+  end
+
+  def test_put1
+    puts '****** test_put1 ******'
+    data = 'Some Test Data'
+    assert_equal(true,@queue_manager.put(:q_name=>@in_queue.name, :data=>data))
+
+    message = WMQ::Message.new
+    assert_equal(true, @in_queue.get(:message=>message))
+    assert_equal(data, message.data)
+  end
+
+  def verify_header(header, format)
+    verify_multiple_headers([header], format)
+  end
+
+  def verify_multiple_headers(headers, format)
+    data = 'Some Test Data'
+    message = WMQ::Message.new
+    message.data = data
+    message.descriptor[:format] = format
+    message.headers = headers
+    #assert_equal(true,@queue_manager.put(:q_name=>@in_queue.name, :message=>message))
+    assert_equal(true,@out_queue.put(:message=>message))
+
+    message = WMQ::Message.new
+    assert_equal(true, @in_queue.get(:message=>message))
+    assert_equal(data, message.data)
+    assert_equal(headers.size, message.headers.size)
+    count = 0
+    headers.each do |header|
+      reply_header = message.headers[count]
+      header.each_pair{|key, value| assert_equal(value, reply_header[key])}
+      count = count + 1
+    end
+  end
+  
+  def test_dlh
+    puts '****** test_dlh ******'
+    dlh = {: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',
+           :put_appl_name   =>'TestApp.exe',
+           }
+
+    verify_header(dlh, WMQ::MQFMT_DEAD_LETTER_HEADER)
+    # Untested keys:
+    #:put_date=>"",
+    #:put_time=>"",
+    #:encoding=>0,
+    #:coded_char_set_id=>437,
+    #:put_appl_type=>0,
+
+    # Test again, but use QueueManager#put this time
+    data = 'Some Test Data'
+    message = WMQ::Message.new
+    message.data = data
+    message.descriptor[:format] = WMQ::MQFMT_STRING
+    message.headers << dlh
+    assert_equal(true,@queue_manager.put(:q_name=>@in_queue.name, :message=>message))
+
+    message = WMQ::Message.new
+    assert_equal(true, @in_queue.get(:message=>message))
+    assert_equal(data, message.data)
+    assert_equal(1, message.headers.size)
+    reply_header = message.headers[0]
+
+    dlh.each_pair{|key, value| assert_equal(value, reply_header[key])}
+  end
+
+  def test_cics
+    puts '****** test_cics ******'
+    cics = {:header_type     =>:cics,
+            :reason          =>WMQ::MQRC_UNKNOWN_REMOTE_Q_MGR,
+            :facility        =>'TOKEN123',
+            :reply_to_format =>WMQ::MQFMT_STRING,
+            }
+    verify_header(cics, WMQ::MQFMT_NONE)
+  end
+  
+  def test_ims
+    puts '****** test_ims ******'
+    ims = {:header_type      =>:ims,
+           :l_term_override  =>'LTERM',
+           :reply_to_format  =>WMQ::MQFMT_STRING,
+          }
+    verify_header(ims, WMQ::MQFMT_STRING)
+  end
+  
+  def test_transmission_header
+    puts '****** test_transmission_header ******'
+    xqh = {:header_type     =>:xmit_q_header,
+           :remote_q_name   =>'SOME_REMOTE_QUEUE',
+           :remote_q_mgr_name=>'SOME_REMOTE_Q_MGR',
+           :msg_type        =>WMQ::MQMT_REQUEST,
+           :msg_id          =>'my message Id',
+          }
+    verify_header(xqh, WMQ::MQFMT_STRING)
+  end
+  
+  def test_rf_header
+    puts '****** test_rf_header ******'
+    rfh = {:header_type =>:rf_header,
+           :name_value  => {' name   s' => '  v a "l" u e 1  ', 
+                            'n a m e 2 ' => 'v a l u e  2', 
+                            '' => ['"', '""', '"""', '""""', ''],
+                            'name3'=>['"value3"', '', '"',' value 43"']},
+          }
+    verify_header(rfh, WMQ::MQFMT_STRING)
+  end
+  
+  def test_rf_header_2
+    puts '****** test_rf_header_2 ******'
+    rfh2 = {:header_type =>:rf_header_2,
+            :xml => ['<hello>to the world</hello>', 
+                     '<another>xml like string</another>'],
+           }
+    verify_header(rfh2, WMQ::MQFMT_STRING)
+  end
+  
+  def test_multiple_headers
+    puts '****** test_multiple_headers ******'
+    headers = [{:header_type      => :rf_header_2,
+                :xml              => ['<hello>to the world</hello>', 
+                                      '<another>xml like string</another>'],},
+                
+               {:header_type      => :rf_header,
+                :name_value       => {' name   s' => '  v a l u e 1  ', 
+                                      'n a m e 2 ' => 'v a l u e  2', 
+                                      'name3'=>['value3', '', 'value 43']} },
+                
+               {:header_type      => :ims,
+                :l_term_override  => 'LTERM',
+                :reply_to_format  => WMQ::MQFMT_STRING},
+                
+               {:header_type      => :rf_header,
+                :name_value       => {' name   s' => '  v a l u e 1  ', 
+                                      'n a m e 2 ' => 'v a l u e  2', 
+                                      'name3'=>['value3', '', 'value 43']} },
+
+               {:header_type      => :cics,
+                :reason           => WMQ::MQRC_UNKNOWN_REMOTE_Q_MGR,
+                :facility         => 'TOKEN123',
+                :reply_to_format  => WMQ::MQFMT_STRING},
+
+               {:header_type      => :rf_header_2,
+                :xml              => ['<hello>to the world</hello>', '<another>xml like string</another>'],},
+                
+               {:header_type      => :xmit_q_header,
+                :remote_q_name    => 'SOME_REMOTE_QUEUE',
+                :remote_q_mgr_name=> 'SOME_REMOTE_Q_MGR',
+                :msg_type         => WMQ::MQMT_REQUEST,
+                :msg_id           => 'my message Id'},
+              ]              
+    verify_multiple_headers(headers, WMQ::MQFMT_STRING)
+  end
+  
+  def test_xmit_multiple_headers
+    puts '****** test_xmit_q_header with ims header ******'
+    headers = [{:header_type      => :xmit_q_header,
+                :remote_q_name    => 'SOME_REMOTE_QUEUE',
+                :remote_q_mgr_name=> 'SOME_REMOTE_Q_MGR',
+                :msg_type         => WMQ::MQMT_REQUEST,
+                :msg_id           => 'my message Id'},
+                
+               {:header_type      => :ims,
+                :l_term_override  => 'LTERM',
+                :reply_to_format  => WMQ::MQFMT_STRING},
+              ]
+    verify_multiple_headers(headers, WMQ::MQFMT_STRING)
+  end
+  
+  def test_message_grouping
+    puts '****** test_message_grouping ******'
+    # Clear out queue of any messages
+    @in_queue.each { |message| }
+    
+    msg = WMQ::Message.new
+    msg.data = 'First'
+    msg.descriptor[:msg_flags] = WMQ::MQMF_MSG_IN_GROUP
+    assert_equal(@out_queue.put(:message=>msg, :options => WMQ::MQPMO_LOGICAL_ORDER), true)
+    
+    msg.data = 'Second'
+    assert_equal(@out_queue.put(:message=>msg, :options => WMQ::MQPMO_LOGICAL_ORDER), true)
+    
+    msg.data = 'Last'
+    msg.descriptor[:msg_flags] = WMQ::MQMF_LAST_MSG_IN_GROUP
+    assert_equal(@out_queue.put(:message=>msg, :options => WMQ::MQPMO_LOGICAL_ORDER), true)
+
+    # Now retrieve the messages destructively
+    message = WMQ::Message.new
+    test_sizes.each do |size|
+      assert_equal(true, @in_queue.get(:message=>message, :match=>WMQ::MQMO_NONE))
+      assert_equal(size, message.data.length)
+      str = '0123456789ABCDEF' * (size/16) + '0123456789ABCDEF'[0,size%16]
+      assert_equal(str, message.data)
+    end
+  end
+  
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: ferocia-rubywmq
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Reid Morrison
+- Edwin Fine
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: RubyWMQ is a high performance native Ruby interface into WebSphere MQ.
+email:
+- reidmo@gmail.com
+executables: []
+extensions:
+- ext/extconf.rb
+extra_rdoc_files: []
+files:
+- examples/each_a.rb
+- examples/each_b.rb
+- examples/each_header.rb
+- examples/files_to_q.cfg
+- examples/files_to_q.rb
+- examples/get_a.rb
+- examples/get_client.rb
+- examples/put1_a.rb
+- examples/put1_b.rb
+- examples/put1_c.rb
+- examples/put_a.rb
+- examples/put_b.rb
+- examples/put_dlh.rb
+- examples/put_dynamic_q.rb
+- examples/put_group_a.rb
+- examples/put_group_b.rb
+- examples/put_rfh.rb
+- examples/put_rfh2_a.rb
+- examples/put_rfh2_b.rb
+- examples/put_xmit_q.rb
+- examples/q_to_files.cfg
+- examples/q_to_files.rb
+- examples/request.rb
+- examples/server.rb
+- ext/build.bat
+- ext/build.sh
+- ext/decode_rfh.c
+- ext/decode_rfh.h
+- ext/extconf.rb
+- ext/extconf_client.rb
+- ext/generate/generate_const.rb
+- ext/generate/generate_reason.rb
+- ext/generate/generate_structs.rb
+- ext/generate/wmq_structs.erb
+- ext/lib/wmq_temp.rb
+- ext/wmq.c
+- ext/wmq.h
+- ext/wmq_message.c
+- ext/wmq_mq_load.c
+- ext/wmq_queue.c
+- ext/wmq_queue_manager.c
+- lib/wmq.rb
+- LICENSE
+- Manifest.txt
+- README
+- rubywmq.binary.gemspec
+- rubywmq.gemspec
+- tests/test.rb
+- .document
+homepage: https://github.com/reidmorrison/rubywmq
+licenses:
+- Apache License V2.0
+post_install_message: ! '* ferocia-rubywmq builds against the WMQ libs, which aren''t
+  available for OS X.
+
+  * The gem will still install, but the build will be skipped, producing a
+
+  * non-functional gem, so you''ll need stubs. (You can skip the build elsewhere by
+
+  * setting the DISABLE_RUBYWMQ environment variable.)
+
+'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.8.4
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- WebSphere MQ v5.3, v6 or v7 Client or Server with Development Kit
+rubyforge_project: rubywmq
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Native Ruby interface into WebSphere MQ
+test_files:
+- tests/test.rb