ferocia-rubywmq 1.1.3 → 2.0.2

data/.document

@@ -1,8 +1,4 @@
-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.txt

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2006 - 2012  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.
+   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/README.md

@@ -0,0 +1,408 @@
+## rubywmq
+
+RubyWMQ is a high performance native Ruby interface into WebSphere MQ.
+
+* http://github.com/reidmorrison/rubywmq
+
+### Features
+
+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)
+
+Full support for the entire MQ Administration interface (MQAI)
+
+* Create Queues
+* Query Queue Depths
+* etc…
+
+Full support for all WebSphere MQ Headers
+
+* Rules and Format Header 2 (RFH2)
+* Rules and Format Header (RFH)
+* Name Value pairs returned as a Hash
+* Dead Letter Header
+* Transmission Queue Header
+* IMS, CICS, …..
+
+Conforms with the Ruby way. Implements:
+
+* each
+* Code blocks
+
+Relatively easy interface for reading or writing messages
+
+* MQ Headers made easy
+
+Single Ruby WMQ auto-detection library that concurrently supports:
+
+* WebSphere MQ Server Connection
+* WebSphere MQ Client Connection
+
+Includes latest client connection options such as SSL
+
+Tested with WebSphere MQ V5.3, V6, V7, and V7.5
+
+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
+
+WebSphere MQ
+
+* RubyWMQ parses the header files that come with WebSphere MQ so always
+  stays up to date with the latest structures and return codes
+* RubyWMQ has been tested against WebSphere MQ 5, 6, and 7.5
+
+## 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')
+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
+
+Put one message to a Queue (Without opening the queue)
+
+* put1_a.rb
+* put1_b.rb
+* put1_c.rb
+
+Put messages to a Queue
+
+* put_a.rb
+* put_b.rb
+
+Read one message from a queue
+
+* get_a.rb
+
+Reading Several messages from a Queue:
+
+* each_a.rb
+* each_b.rb
+* each_header.rb
+
+Connect using MQ Client connection
+
+* get_client.rb
+
+Put Messages to a Queue as a group
+
+* put_group_a.rb
+* put_group_b.rb
+
+Put Messages to a Queue, including message headers
+
+* put_dlh.rb
+* put_dynamic_q.rb
+* put_rfh.rb
+* put_rfh2_a.rb
+* put_rfh2_b.rb
+* put_xmit_q.rb
+
+Writing multiple files to a queue, where each file is a separate message:
+
+* files_to_q.rb, files_to_q.cfg
+
+Writing the contents of a queue to multiple files, where each message is a separate file:
+
+* q_to_files.rb, q_to_files.cfg
+
+Sample “client” and “server” side applications for sending or processing requests
+
+* request.rb
+* server.rb
+
+## Documentation
+
+Documentation for the RubyWMQ Gem is generated automatically when the gem is installed.
+It is also available [online](http://rubywmq.rubyforge.org/doc/index.html)
+
+## Installation
+
+### Installing on UNIX/Linux
+
+Install a 'C' Compiler, GNU C++ is recommended
+
+Install Ruby using the package manager for your platform
+
+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/)
+
+* Note: Install the Development Toolkit (SDK) and Client
+
+Install RubyWMQ Gem
+
+    gem install rubywmq
+
+If no errors appear RubyWMQ is ready for use
+
+#### Installation Errors
+
+Use this command to find the directory in which the gems are installed
+
+    gem env
+
+When WebSphere MQ is not installed in the default location, call the build
+command directly and supply the location explicitly:
+
+    ruby extconf.rb --with-mqm-include=/opt/mqm/inc --with-mqm-lib=/opt/mqm/lib
+    make
+
+For platforms such as AIX and HP-UX it may be necessary to statically link in
+the WebSphere MQ client library when the auto-detection build above does not work.
+This build option is a last resort since it will only work using a client connection
+
+    ruby extconf_client.rb --with-mqm-include=/opt/mqm/inc --with-mqm-lib=/opt/mqm/lib
+    make
+
+### Installing on Windows
+
+#### Install Ruby and DevKit
+
+Download and install the Ruby installer from http://rubyinstaller.org/downloads/
+
+* Select "Add Ruby executables to your PATH" during the installation
+
+Download and install the Development Kit from the same site
+
+* Extract files into c:\DevKit
+
+Open a command prompt and run the commands below:
+
+    cd c:\DevKit
+    ruby dk.rb init
+
+If you experience any difficulties, see https://github.com/oneclick/rubyinstaller/wiki/Development-Kit
+
+#### Install WebSphereMQ
+
+Install the [WebSphere MQ Client and/or Server](http://www.ibm.com/developerworks/downloads/ws/wmq/)
+
+* Note: Install the Development Toolkit (SDK) and Client
+
+#### Install the RubyWMQ Gem
+
+    call "c:\DevKit\devkitvars.bat"
+    gem install rubywmq --platform=ruby
+
+#### Installation Errors
+
+Use this command to find the directory in which the gems are installed
+
+    gem env
+
+The path to the rubywmq gem will be something like
+
+    C:\Ruby193\lib\ruby\gems\1.9.1\gems\rubywmq-2.0.0\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:
+
+    call "C:\DevKit\devkitvars.bat"
+    ruby extconf.rb --with-mqm-include="C:\Program Files\IBM\WebSphere MQ\Tools\c\include"
+    nmake
+
+## Verifying the build
+
+### Verifying a local WebSphere MQ Server installation
+
+Create a local Queue Manager called TEST. Select the option to create the server
+side channels.
+
+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')
+end
+```
+
+## Rails Installation
+
+After following the steps above to compile the source code, add the following
+line to Gemfile
+
+    gem 'rubywmq'
+
+## Architecture
+
+RubyWMQ uses an automatic detection library to figure out whether a Client or Server
+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
+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
+parses the MQ 'C' header files at compile time to take advantage of all the latest
+features in new releases.
+
+## FAQ
+
+### Programs fail with: `require': no such file to load -- wmq (LoadError)
+
+After successfully installing RubyWMQ using the command “gem install rubywmq”,
+program fails with output similar to the following:
+
+    rubywmq-0.3.0/tests/test.rb:4:in `require': no such file to load -- wmq (LoadError)
+        from rubywmq-0.3.0/tests/test.rb:4
+
+Answer: Add the following line to the top of your Ruby program
+
+    require 'rubygems'
+
+### Program fails to connect with MQRC2059, MQRC_Q_MGR_NOT_AVAILABLE
+
+When connecting to either a local or remote WebSphere MQ Queue Manager, a very common
+error returned is that the Queue Manager is not available. This error can occur
+under any of the following circumstances:
+
+#### MQ Server Connections (Local Queue Manager)
+
+Possible Configuration Issues:
+
+* Ensure that :connection_name is not being supplied to the connect method.
+Even if it is supplied with a nul or empty value, it will cause a client connection attempt to be made.
+
+Is the Queue Manager active?
+
+* Try running the following command on the machine running the Queue Manager
+and check that the Queue Manager is marked as ‘Running’:
+
+```
+dspmq
+
+Expected output:
+QMNAME(REID)                          STATUS(Running)
+```
+
+* Check that the :q_mgr_name supplied to QueueManager::connect matches the Queue Manager name above.
+* Note: Queue Manager names are case-sensitive
+
+#### MQ Client Connections (Remote Queue Manager)
+
+Possible Client Configuration Issues:
+
+* Incorrect host name
+* Incorrect port number
+* Incorrect Channel Name
+
+    For example, the channel being used does not exist on the remote Queue Manager.
+
+* Note: The channel name is case-sensitive
+
+Incorrect Queue Manager Name
+
+* :q_mgr_name is optional for Client Connections. It does however ensure that the program connects to the expected Queue Manager.
+
+    For example when the wrong Queue Manager listener is now running on the expected port.
+
+* Is the MQ listener program running on the port supplied above?
+
+
+On UNIX/Linux, try the following command on the machine running the Queue Manager:
+
+    ps -ef | grep runmqlsr
+
+* The Queue Mananger name and port number should be displayed
+
+* If no port number is specified on the command line for an instance of runmqlsr, it means that it is using port 1414.
+
+Is the Queue Manager active?
+
+* Try running the following command on the machine running the Queue Manager and check that the Queue Manager is marked as ‘Running’:
+
+```
+dspmq
+
+Expected output:
+QMNAME(REID)                          STATUS(Running)
+```
+
+* Check that the :q_mgr_name supplied to QueueManager::connect matches the Queue Manager name above. Note: Queue Manager names are case-sensitive
+* Check if the Channel being used is still defined on the Queue Manager
+
+    On the machine running the Queue Manager, run the following commands (may need to run them under the 'mqm' userid):
+
+```
+runmqsc queue_manager_name
+dis channel(*) chltype(SVRCONN)
+```
+
+* Replace queue_manager_name above with the actual name of the Queue Manager being connected to
+* Look for the channel name the application is using.
+* Note: the channel name is case-sensitive.
+
+## Support
+
+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/).
+
+## Author
+
+Reid Morrison :: reidmo@gmail.com :: @reidmorrison
+
+Special thanks to Edwin Fine for the RFH parsing code and for introducing me to
+the wonderful world of Ruby
+
+## License
+
+Copyright 2006 - 2012 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.
+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.