rubywmq 2.0.2 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 834d0740e22c3b3190b212f009b66b4d9edd49ba
-  data.tar.gz: 33401b505830bc3d54fe6dcc32f4c1002b765cfe
+  metadata.gz: b802e25f55b180913d83383fa1677fde31a954c3
+  data.tar.gz: 366ed87e4148c86ba88e4fea59145335c089aa98
 SHA512:
-  metadata.gz: 88e4d7a3df579cd225328b8f1835d323e35aa160d142d36265ae26a1918a3c3007421e470adcb2a40bfffd27b7218e75bb2fc50fa51e8dce7981fdcc12645c5b
-  data.tar.gz: 51e22dd147c46b90975cd3de53e10ea29045afeb26beb81e1329f0e8a4fe42aafbf597f858d6cf8466a5b38f48f890854e81227500396575c9e40605af6cc057
+  metadata.gz: cef09bb323a8a79f7aa6cc2e79dd8240419c94589d02b59bfe7b1859d398bef6c1b1d3afe0a19e0088588d1a2a2ac4c18a8260d32743cfad5484dbbbec11b023
+  data.tar.gz: 2d5747bafe54f8700e1ba61ec5a6a64cfa5cb412f78e387fa89551ed162bdd494cb826c556804b0a735c67045d4e1014207ad491fb75eb989659089f79ac73e0

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rake'
+gem 'minitest'
+gem 'minitest-reporters'
+gem 'minitest-stub_any_instance'
+gem 'shoulda-context'
+gem 'awesome_print'

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: /
+  specs:
+    rubywmq (2.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ansi (1.5.0)
+    awesome_print (1.6.1)
+    builder (3.2.2)
+    minitest (5.7.0)
+    minitest-reporters (1.0.19)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    minitest-stub_any_instance (1.0.1)
+    rake (10.4.2)
+    ruby-progressbar (1.7.5)
+    shoulda-context (1.2.1)
+
+PLATFORMS
+  ruby
+  x64-mingw32
+
+DEPENDENCIES
+  awesome_print
+  minitest
+  minitest-reporters
+  minitest-stub_any_instance
+  rake
+  rubywmq!
+  shoulda-context
+
+BUNDLED WITH
+   1.10.6

data/LICENSE.txt

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2006 - 2012  J. Reid Morrison
+   Copyright 2006 - 2015  J. Reid Morrison
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

data/README.md

@@ -1,4 +1,4 @@
-## rubywmq
+# rubywmq
 
 RubyWMQ is a high performance native Ruby interface into WebSphere MQ.
 
@@ -10,8 +10,8 @@ The Ruby WMQ interface currently supports the following features:
 
 High performance
 
-* Able to read over 2000 messages per second from a Queue
-* (Non-persistent messages, < 4K each, MQ V6, running on Windows Laptop)
+* Able to read over 2,000 messages per second from a Queue
+    * Non-persistent messages, < 4K each, MQ V6
 
 Full support for the entire MQ Administration interface (MQAI)
 
@@ -44,16 +44,14 @@ Single Ruby WMQ auto-detection library that concurrently supports:
 
 Includes latest client connection options such as SSL
 
-Tested with WebSphere MQ V5.3, V6, V7, and V7.5
+Tested with WebSphere MQ V5.3, V6, V7, V7.5, and V8
 
 Is written in C to ensure easier portability and performance
 
 ### Compatibility
 
-Ruby
-
-* RubyWMQ only works on Ruby MRI on with Ruby 1.8.7, Ruby 1.9.3, or greater
-* For JRuby, see http://github.com/reidmorrison/jruby-jms
+* Ruby 1.9 or greater
+* Not designed for JRuby, use (jruby-jms)[https://github.com/reidmorrison/jruby-jms]
 
 WebSphere MQ
 
@@ -64,21 +62,18 @@ WebSphere MQ
 ## Example
 
 ```ruby
-require 'rubygems'
 require 'wmq'
 
 # Connect to a local queue manager called 'TEST' and put a single message
 # on the queue 'TEST.QUEUE'
-WMQ::QueueManager.connect(:q_mgr_name=>'TEST') do |qmgr|
-    qmgr.put(:q_name=>'TEST.QUEUE', :data => 'Hello World')
+WMQ::QueueManager.connect(q_mgr_name: 'TEST') do |qmgr|
+    qmgr.put(q_name: 'TEST.QUEUE', data: 'Hello World')
 end
 ```
 
 ## More Examples
 
-There are many examples covering many of the ways that RubyWMQ can be used. The examples
-are installed as part of the Gem under the 'examples' sub-directory. The examples can
-also be be viewed at https://github.com/reidmorrison/rubywmq/tree/master/examples
+The examples below are all available at https://github.com/reidmorrison/rubywmq/tree/master/examples
 
 Put one message to a Queue (Without opening the queue)
 
@@ -149,6 +144,8 @@ Also install RubyGems and ruby-dev or ruby-sdk packages if not already installed
 
 Install the [WebSphere MQ Client and/or Server](http://www.ibm.com/developerworks/downloads/ws/wmq/)
 
+* Develop on [WebSphere MQ Advanced](https://www.ibm.com/developerworks/community/blogs/messaging/entry/develop_on_websphere_mq_advanced_at_no_charge?lang=en#) at no charge!
+
 * Note: Install the Development Toolkit (SDK) and Client
 
 Install RubyWMQ Gem
@@ -186,7 +183,7 @@ Download and install the Ruby installer from http://rubyinstaller.org/downloads/
 
 Download and install the Development Kit from the same site
 
-* Extract files into c:\DevKit
+* Extract files into c:\Devkit
 
 Open a command prompt and run the commands below:
 
@@ -199,22 +196,28 @@ If you experience any difficulties, see https://github.com/oneclick/rubyinsta
 
 Install the [WebSphere MQ Client and/or Server](http://www.ibm.com/developerworks/downloads/ws/wmq/)
 
+* Develop on [WebSphere MQ Advanced](https://www.ibm.com/developerworks/community/blogs/messaging/entry/develop_on_websphere_mq_advanced_at_no_charge?lang=en#) at no charge!
+
 * Note: Install the Development Toolkit (SDK) and Client
 
 #### Install the RubyWMQ Gem
 
     call "c:\DevKit\devkitvars.bat"
-    gem install rubywmq --platform=ruby
+    gem install rubywmq
+
+If WebSphere MQ is installed in the non-default location:
+
+    gem install rubywmq --platform=ruby -- '--with-mqm-include="C:\Program Files\IBM\WebSphere MQ\Tools\c\include"'
 
 #### Installation Errors
 
 Use this command to find the directory in which the gems are installed
 
-    gem env
+    gem which rubywmq
 
 The path to the rubywmq gem will be something like
 
-    C:\Ruby193\lib\ruby\gems\1.9.1\gems\rubywmq-2.0.0\ext
+    C:\Ruby22\lib\ruby\gems\2.2.0\gems\rubywmq-2.0.3\ext
 
 When WebSphere MQ is not installed in the default location, change to the directory
 above and call the build command directly while supplying the location explicitly:
@@ -235,7 +238,6 @@ Create a local queue called TEST.QUEUE
 Run the following Ruby Code in an irb session:
 
 ```ruby
-require 'rubygems'
 require 'wmq'
 WMQ::QueueManager.connect(:q_mgr_name=>'TEST') do |qmgr|
   qmgr.put(:q_name=>'TEST.QUEUE', :data => 'Hello World')
@@ -256,7 +258,7 @@ is installed locally. This prevents issues with having to statically link with
 both the client and server libraries and then having to select the "correct"
 one on startup.
 
-Additionally, this approach allows RubyWMQ to be simultaneously connect to both a local
+Additionally, this approach allows RubyWMQ to be simultaneously connected to a local
 Queue Manager via server bindings and to a remote Queue Manager using Client bindings.
 
 Instead of hard coding all the MQ C Structures and return codes into RubyWMQ, it
@@ -359,41 +361,21 @@ dis channel(*) chltype(SVRCONN)
 * Look for the channel name the application is using.
 * Note: the channel name is case-sensitive.
 
-## Support
+## Versioning
 
-Ruby WMQ Community Support Mailing List: <http://rubyforge.org/mailman/listinfo/rubywmq-misc>
-
-Feature and Bug Reports: <http://github.com/reidmorrison/rubywmq/issues>
-
-## Contributing
-
-Once you've made your great commits:
-
-1. [Fork](http://help.github.com/forking/) rubywmq
-2. Create a topic branch - `git checkout -b my_branch`
-3. Push to your branch - `git push origin my_branch`
-4. Create an [Issue](http://github.com/reidmorrison/rubywmq/issues) with a link to your branch
-5. That's it!
-
-## Meta
-
-* Code: `git clone git://github.com/reidmorrison/rubywmq.git`
-* Home: <http://github.com/reidmorrison/rubywmq>
-* Bugs: <http://github.com/reidmorrison/rubywmq/issues>
-* Gems: <http://rubygems.org/gems/rubywmq>
-
-This project uses [Semantic Versioning](http://semver.org/).
+This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## Author
 
-Reid Morrison :: reidmo@gmail.com :: @reidmorrison
+[Reid Morrison](https://github.com/reidmorrison) :: @reidmorrison
+
+## Contributors
 
-Special thanks to Edwin Fine for the RFH parsing code and for introducing me to
-the wonderful world of Ruby
+* Edwin Fine - RFH parsing code
 
 ## License
 
-Copyright 2006 - 2012 J. Reid Morrison
+Copyright 2006 - 2015 J. Reid Morrison
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

data/Rakefile

@@ -1,91 +1,27 @@
-lib = File.expand_path('../lib/', __FILE__)
-$:.unshift lib unless $:.include?(lib)
-
-require 'rubygems'
-require 'rubygems/package'
 require 'rake/clean'
 require 'rake/testtask'
-require 'date'
-require 'wmq/version'
 
-desc "Build Ruby Source gem"
-task :gem  do |t|
-  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/
-  ]
+require_relative 'lib/wmq/version'
 
-  gemspec = Gem::Specification.new do |spec|
-    spec.name              = 'rubywmq'
-    spec.version           = WMQ::VERSION
-    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             = FileList["./**/*"].exclude(*excludes).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'
-  end
-  p gemspec.files
-  Gem::Package.build gemspec
+task :gem do
+  system 'gem build rubywmq.gemspec'
 end
 
-desc "Build a binary gem including pre-compiled binary files for re-distribution"
-task :binary  do |t|
-  # Move compiled files into locations for repackaging as a binary gem
-  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')
-
-  gemspec = Gem::Specification.new do |spec|
-    spec.name              = 'rubywmq'
-    spec.version           = WMQ::VERSION
-    spec.platform          = Gem::Platform::CURRENT
-    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['examples/**/*.rb'] +
-                             Dir['examples/**/*.cfg'] +
-                             Dir['doc/**/*.*'] +
-                             Dir['lib/**/*.rb'] +
-                             ['lib/wmq/wmq.so', 'tests/test.rb', 'README', 'LICENSE']
-    spec.license           = "Apache License V2.0"
-    spec.rubyforge_project = 'rubywmq'
-    spec.test_file         = 'tests/test.rb'
-    spec.has_rdoc          = false
-    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'
-  end
-  Gem::Package.build gemspec
+task publish: :gem do
+  system "git tag -a v#{WMQ::VERSION} -m 'Tagging #{WMQ::VERSION}'"
+  system 'git push --tags'
+  system "gem push rubywmq-#{WMQ::VERSION}.gem"
+  system "rm rubywmq-#{WMQ::VERSION}.gem"
 end
 
-desc "Run Test Suite"
+desc 'Run Test Suite'
 task :test do
   Rake::TestTask.new(:functional) do |t|
-    t.test_files = FileList['test/*_test.rb']
+    t.test_files = FileList['test/**/*_test.rb']
     t.verbose    = true
   end
 
   Rake::Task['functional'].invoke
 end
+
+task default: :test

data/examples/each_a.rb

@@ -3,11 +3,10 @@
 #          If no messages are on the queue, the program
 #          completes without waiting
 #
-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|
     queue.each do |message|
       puts "Data Received: #{message.data}"
     end

data/examples/each_b.rb

@@ -2,19 +2,18 @@
 # Sample : each() : Retrieve all messages from a queue that
 #          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=>: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
 
     # Retrieve First message
-    if queue.get(:message=>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|
+      queue.each(message: message, match: WMQ::MQMO_MATCH_CORREL_ID) do |msg|
         puts "Matching Data Received: #{msg.data}"
       end
     else

data/examples/each_header.rb

@@ -3,19 +3,18 @@
 #          If no messages are on the queue, the program
 #          completes without waiting
 #
-require 'rubygems'
 require 'wmq'
 
-WMQ::QueueManager.connect(:q_mgr_name=>'REID') do |qmgr|
-  qmgr.open_queue(:q_name=>'TEST.DEAD', :mode=>:browse) do |queue|
+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:"
+      puts 'Message Descriptor:'
       p message.descriptor
 
-      puts "Headers Received:"
-      message.headers.each {|header| p header}
+      puts 'Headers Received:'
+      message.headers.each { |header| p header }
     end
   end
   puts 'Completed.'

data/examples/files_to_q.rb

@@ -2,27 +2,26 @@
 # 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'
 
 # 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")
+env    = ARGV[0] || fail('Command line argument `environment` is required')
 config = YAML::load_file('files_to_q.cfg')[env]
 
-message = WMQ::Message.new
+message            = WMQ::Message.new
 message.descriptor = config['descriptor'] || {}
-tstart = Time.now
-counter = 0
+tstart             = Time.now
+counter            = 0
 WMQ::QueueManager.connect(config['qmgr_options']) do |qmgr|
-  qmgr.open_queue({:mode=>:output}.merge(config['output_queue'])) do |queue|
+  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)
+        printf("%5d: #{path}\n", counter = counter + 1)
         message.data = File.read(path)
-        queue.put({:message => message}.merge(config['put_options']))
+        queue.put({ message: message }.merge(config['put_options']))
       end
     end
   end