ferocia-rubywmq 1.1.3 → 2.0.2

data/ext/generate/wmq_structs.erb

@@ -1,20 +1,4 @@
-<% 
-################################################################################
-#  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.
-################################################################################
-
+<%
     symbols = {
           'descriptor='=>nil,
           'headers='=>nil,
@@ -68,7 +52,7 @@
       # Transmission-queue header - Todo: Need to deal with MQMDE
       {:file=>'cmqc.h', :struct=>'MQXQH', :header=>'xmit_q_header', :format=>'MsgDesc.Format'},
     ]
-    
+
     wmq_structs.each do |struct|
       # Parse WebSphere MQ 'C' Header file and extract elements
       elements = extract_struct(@path+'/'+struct[:file], struct[:struct])
@@ -84,20 +68,6 @@
     end
 %>
 /* --------------------------------------------------------------------------
- *  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.
- * --------------------------------------------------------------------------
  *
  *  WARNING: DO NOT MODIFY THIS FILE
  *
@@ -110,16 +80,16 @@
 /* --------------------------------------------------------------------------
  *  Static's to hold Symbols
  * --------------------------------------------------------------------------*/
-<% 
+<%
     header_file = 'cmqc.h'
     struct = 'MQMD'
 
     # Define static variables to hold Ruby symbols
     key_list = symbols.keys.sort
-    key_list.each do |key, value| 
+    key_list.each do |key, value|
       %><%="static ID ID_#{key.sub('=', '_set')};\n" %><%
     end
-    
+
     # initialize symbols
     %>
 /* --------------------------------------------------------------------------
@@ -127,7 +97,7 @@
  * --------------------------------------------------------------------------*/
 void wmq_structs_id_init()
 {
-<%  key_list.each do |key, value| 
+<%  key_list.each do |key, value|
       %><%="    ID_%-20s = rb_intern(\"%s\");\n"% [key.sub('=', '_set'), key] %><%
     end
 %>}
@@ -145,18 +115,18 @@ void Message_from_<%=struct_name.downcase%>(VALUE hash, <%=struct_name%>* <%=var
 {
     VALUE  str;
     size_t size;
-    size_t length; 
+    size_t length;
     size_t i;
     char*  pChar;
-        
+
 <%
       elements.each do |item|
         type = item[0]
         name = item[1]
-          
+
         next if @@field_ignore_list.include?(name) ||
                 (name=='Format' && struct[:header])
-          
+
         match = /(MQ\D+)/.match(type)
         type = "#{match[1]}S" if match[1] != type
 %><%=   if type == 'MQMDS'
@@ -164,25 +134,25 @@ void Message_from_<%=struct_name.downcase%>(VALUE hash, <%=struct_name%>* <%=var
         else
           "    %-16s(hash, %-30s #{variable}->%s)\n" % ["WMQ_#{type}2HASH", rubyize_name(name)+',',name]
         end %><%
-      end 
+      end
 %>}
 
 static int Message_to_<%=struct_name.downcase%>_each (VALUE key, VALUE value, <%=struct_name%>* p<%=struct_name.downcase%>)
 {
     VALUE str;
     size_t size;
-    size_t length; 
+    size_t length;
     VALUE  val;
     ID     id = rb_to_id(key);
-    
+
    <% contains = nil
       elements.each do |item|
         type = item[0]
         name = item[1]
-          
+
         next if @@field_ignore_list.include?(name) ||
                 (name=='Format' && struct[:header])
-          
+
         match = /(MQ\D+)/.match(type)
         type = "#{match[1]}S" if match[1] != type
 %><%=   if type == 'MQMDS'
@@ -198,9 +168,9 @@ static int Message_to_<%=struct_name.downcase%>_each (VALUE key, VALUE value, <%
     else<%   end
       end
 %><%=struct[:header]?" if(id != ID_header_type)":""%><%
-      if contains 
+      if contains
 %> {
-      Message_to_<%= contains%>_each(key, value, &pmqxqh->MsgDesc); 
+      Message_to_<%= contains%>_each(key, value, &pmqxqh->MsgDesc);
    }<%
       else%>
     {
@@ -215,7 +185,7 @@ void Message_to_<%=struct_name.downcase%>(VALUE hash, <%=struct_name%>* p<%=stru
 {
     rb_hash_foreach(hash, Message_to_<%=struct_name.downcase%>_each, (VALUE)p<%=struct_name.downcase%>);
 }
-<%  end # wmq_structs.each 
+<%  end # wmq_structs.each
 %>
 
 /* --------------------------------------------------------------------------
@@ -240,10 +210,10 @@ void Message_deblock(VALUE self, PMQMD pmqmd, PMQBYTE p_buffer, MQLONG total_len
         {
             VALUE hash = rb_hash_new();
             P<%=struct[:struct]%> p_header = (P<%=struct[:struct]%>)p_data;
-            
+
             if(trace_level>2)
                 printf("WMQ::Message#deblock Found <%=struct[:header]%>\n");
-                
+
             if(memcmp(p_header->StrucId, <%=struct[:struct_id] || "#{struct[:struct].upcase}_STRUC_ID"%>, sizeof(p_header->StrucId)) != 0)
             {
                 if(trace_level>1)
@@ -277,7 +247,7 @@ void Message_deblock(VALUE self, PMQMD pmqmd, PMQBYTE p_buffer, MQLONG total_len
         else
 <%
       end
-    end # wmq_structs.each 
+    end # wmq_structs.each
 %>        {
             break;
         }
@@ -287,7 +257,7 @@ void Message_deblock(VALUE self, PMQMD pmqmd, PMQBYTE p_buffer, MQLONG total_len
     {
         strncpy(pmqmd->Format, p_format, MQ_FORMAT_LENGTH);
     }
-    
+
     Message_from_mqmd(descriptor, pmqmd);
     rb_funcall(self, ID_descriptor_set, 1, descriptor);
     rb_funcall(self, ID_headers_set, 1, headers);
@@ -302,8 +272,8 @@ void Message_build_set_format(ID header_type, PMQBYTE p_format)
 %>    if(header_type == ID_<%=struct[:header]%>) { memcpy(p_format, MQFMT_<%=struct[:header].upcase%>, MQ_FORMAT_LENGTH); return;}
 <%
       end
-    end # wmq_structs.each 
-    
+    end # wmq_structs.each
+
 %>
     rb_raise(rb_eArgError, "Invalid/Unknown header_type supplied in WMQ::Message#headers array");
 }
@@ -332,7 +302,7 @@ int Message_build_header (VALUE hash, struct Message_build_header_arg* parg)
 
             if(parg->trace_level>2)
                 printf ("WMQ::Message#build_header Found <%=struct[:header]%>\n");
-                
+
             p_data = Message_autogrow_data_buffer(parg, sizeof(<%=struct[:struct]%>));
 
             memcpy(p_data, &<%=struct[:struct]%>_DEF, sizeof(<%=struct[:struct]%>));
@@ -351,13 +321,13 @@ int Message_build_header (VALUE hash, struct Message_build_header_arg* parg)
 
             if(parg->trace_level>2)
                 printf ("WMQ::Message#build_header data offset:%ld\n", (long)(*(parg->p_data_offset)));
-<%      end 
+<%      end
 %>        }
         else
 <%
       end
-    end # wmq_structs.each 
-    
+    end # wmq_structs.each
+
 %>        {
             rb_raise(rb_eArgError, "Unknown :header_type supplied in WMQ::Message#headers array");
         }

data/ext/wmq.c

@@ -1,5 +1,5 @@
 /*
- *  Copyright 2006 J. Reid Morrison. Dimension Solutions, Inc.
+ *  Copyright 2006 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.
@@ -80,9 +80,6 @@ void Init_wmq() {
     QueueManager_selector_id_init();
     QueueManager_command_id_init();
     wmq_structs_id_init();
-
-    rb_require("wmq/wmq_temp");
-    rb_require("wmq/wmq_const");
 }
 
 /*

data/ext/wmq.h

@@ -1,5 +1,5 @@
 /* --------------------------------------------------------------------------
- *  Copyright 2006 J. Reid Morrison. Dimension Solutions, Inc.
+ *  Copyright 2006 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.
@@ -33,6 +33,10 @@
    #define rb_str_set_len(str, length) (RSTRING_LEN(str) = (length))
 #endif
 
+#ifndef _int64
+   #define _int64 long long
+#endif
+
 #include <cmqc.h>
 #include <cmqxc.h>
 

data/ext/wmq_message.c

@@ -1,5 +1,5 @@
 /* --------------------------------------------------------------------------
- *  Copyright 2006 J. Reid Morrison. Dimension Solutions, Inc.
+ *  Copyright 2006 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/ext/wmq_mq_load.c

@@ -1,5 +1,5 @@
 /*
- *  Copyright 2006 J. Reid Morrison. Dimension Solutions, Inc.
+ *  Copyright 2006 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/ext/wmq_queue.c

@@ -1,5 +1,5 @@
 /* --------------------------------------------------------------------------
- *  Copyright 2006 J. Reid Morrison. Dimension Solutions, Inc.
+ *  Copyright 2006 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/ext/wmq_queue_manager.c

@@ -1,5 +1,5 @@
 /*
- *  Copyright 2006 J. Reid Morrison. Dimension Solutions, Inc.
+ *  Copyright 2006 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.
@@ -429,8 +429,8 @@ VALUE QueueManager_connect(VALUE self)
     }
 
     pqm->MQCONNX(
-            RSTRING_PTR(name),      /* queue manager                  */
-            &pqm->connect_options,   /* Connection Options             */
+            RSTRING_PTR(name),       /* queue manager                  */
+            &pqm->connect_options,   /* connection options             */
             &pqm->hcon,              /* connection handle              */
             &pqm->comp_code,         /* completion code                */
             &pqm->reason_code);      /* connect reason code            */

data/lib/rubywmq.rb

@@ -0,0 +1 @@
+require 'wmq'

data/lib/wmq.rb

@@ -1,29 +1,16 @@
-################################################################################
-#  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.
-################################################################################
+require 'wmq/version'
+require 'wmq/constants'
+require 'wmq/constants_admin'
+require 'wmq/queue_manager'
+require 'wmq/message'
 
-# 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
+# Load wmq using the auto-load library.
 #
-# Don't try and load wmq on a mac
-unless RUBY_PLATFORM =~ /darwin/ || ENV['DISABLE_RUBYWMQ']
-  begin
-    require 'wmq/wmq'
-  rescue LoadError
-    require 'wmq/wmq_client'
-  end
+# If it fails, then it is most likely since this platform is not supported
+# by the auto load facility in Ruby WMQ, so try to load client linked library
+# For Example AIX does not support Autoload whereas Windows and Linux are supported
+begin
+  require 'wmq/wmq'
+rescue LoadError
+  require 'wmq/wmq_client'
 end

data/lib/wmq/message.rb

@@ -0,0 +1,70 @@
+# Message Ruby methods
+module WMQ
+  # Message contains the message descriptor (MQMD), data
+  # and any headers.
+  #
+  # Note:
+  # * The format in the descriptor applies only to the format of the data portion,
+  #   not the format of any included headers
+  # * The message format can ONLY be supplied in the descriptor.
+  #   * I.e. It is the format of the data, Not the headers.
+  #   * On the wire formats are determined automatically by the :header_type key for
+  #     each header
+  #   * Other WebSphere MQ interfaces require that the formats be "daisy-chained"
+  #     * I.e. The MQMD.Format is actually the format of the first header
+  #     * Ruby WMQ removes this tedious requirement and performs this
+  #       requirement automatically under the covers
+  #   * The format of any header should not be supplied in the descriptor or any header
+  #
+  # Message has the following attributes:
+  # * descriptor = {
+  #                                                           # WebSphere MQ Equivalent
+  #     :format             => WMQ::MQFMT_STRING,             # MQMD.Format - Format of data only
+  #                            WMQ::MQFMT_NONE                #   Do not supply header formats here
+  #     :original_length    => Number                         # MQMD.OriginalLength
+  #     :priority           => 0 .. 9                         # MQMD.Priority
+  #     :put_time           => String                         # MQMD.PutTime
+  #     :msg_id             => String                         ...
+  #     :expiry             => Number
+  #     :persistence        => Number
+  #     :reply_to_q         => String
+  #     :correl_id          => String
+  #     :feedback           => Number
+  #     :offset             => Number
+  #     :report             => Number
+  #     :msg_flags          => Number
+  #     :reply_to_q_mgr     => String
+  #     :appl_identity_data => String
+  #     :put_appl_name      => String
+  #     :user_identifier    => String
+  #     :msg_seq_number     => Number
+  #     :appl_origin_data   => String
+  #     :accounting_token   => String
+  #     :backout_count      => Number
+  #     :coded_char_set_id  => Number
+  #     :put_appl_type      => Number
+  #     :msg_type           => Number
+  #     :group_id           => String
+  #     :put_date           => String
+  #     :encoding           => Number
+  #   }
+  # * data => String
+  # * headers => Array of Hashes
+  #   * Note: Do not supply the format of any header. Ruby WMQ does this for you.
+  #
+  #    The following headers are supported:
+  #   * Rules And Formatting Header (RFH)
+  #       :header_type => :rf_header
+  #       :....
+  #   * Rules and Formatting V2 Header (RFH2)
+  #       ....
+  #   * Dead Letter Header
+  #   * CICS Header
+  #   * IMS Header
+  #   * Transmission Queue Header
+  #   * ...
+  class Message
+    attr_accessor :data, :descriptor, :headers
+  end
+
+end

data/{ext/lib/wmq_temp.rb → lib/wmq/queue_manager.rb}

@@ -1,35 +1,6 @@
-################################################################################
-#  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.
-################################################################################
-
+# QueueManager ruby methods
 module WMQ
-
-  # Temporary placeholder until the following code is moved to 'C'
-
-  #
   class QueueManager
-    def method_missing(name, *args)
-      if args.size == 1
-        self.execute({:command=>name}.merge(args[0]))
-      elsif args.size == 0
-        self.execute({:command=>name})
-      else
-        raise("Invalid arguments supplied to QueueManager#:#{name}, args:#{args}")
-      end
-    end
-
     # Execute any MQSC command against the queue manager
     #
     # Example
@@ -124,74 +95,16 @@ module WMQ
       return self.put(parms)
     end
 
-  end
+    # Expose Commands directly as Queue Manager methods
+    def method_missing(name, *args)
+      if args.size == 1
+        self.execute({:command=>name}.merge(args[0]))
+      elsif args.size == 0
+        self.execute({:command=>name})
+      else
+        raise("Invalid arguments supplied to QueueManager#:#{name}, args:#{args}")
+      end
+    end
 
-  # Message contains the message descriptor (MQMD), data
-  # and any headers.
-  #
-  # Note:
-  # * The format in the descriptor applies only to the format of the data portion,
-  #   not the format of any included headers
-  # * The message format can ONLY be supplied in the descriptor.
-  #   * I.e. It is the format of the data, Not the headers.
-  #   * On the wire formats are determined automatically by the :header_type key for 
-  #     each header
-  #   * Other WebSphere MQ interfaces require that the formats be "daisy-chained"
-  #     * I.e. The MQMD.Format is actually the format of the first header
-  #     * Ruby WMQ removes this tedious requirement and performs this
-  #       requirement automatically under the covers
-  #   * The format of any header should not be supplied in the descriptor or any header
-  #
-  # Message has the following attributes:
-  # * descriptor = {
-  #                                                           # WebSphere MQ Equivalent
-  #     :format             => WMQ::MQFMT_STRING,             # MQMD.Format - Format of data only
-  #                            WMQ::MQFMT_NONE                #   Do not supply header formats here
-  #     :original_length    => Number                         # MQMD.OriginalLength
-  #     :priority           => 0 .. 9                         # MQMD.Priority
-  #     :put_time           => String                         # MQMD.PutTime
-  #     :msg_id             => String                         ...
-  #     :expiry             => Number
-  #     :persistence        => Number
-  #     :reply_to_q         => String
-  #     :correl_id          => String
-  #     :feedback           => Number
-  #     :offset             => Number
-  #     :report             => Number
-  #     :msg_flags          => Number
-  #     :reply_to_q_mgr     => String
-  #     :appl_identity_data => String
-  #     :put_appl_name      => String
-  #     :user_identifier    => String
-  #     :msg_seq_number     => Number
-  #     :appl_origin_data   => String
-  #     :accounting_token   => String
-  #     :backout_count      => Number
-  #     :coded_char_set_id  => Number
-  #     :put_appl_type      => Number
-  #     :msg_type           => Number
-  #     :group_id           => String
-  #     :put_date           => String
-  #     :encoding           => Number
-  #   }
-  # * data => String
-  # * headers => Array of Hashes
-  #   * Note: Do not supply the format of any header. Ruby WMQ does this for you.
-  #   
-  #    The following headers are supported:
-  #   * Rules And Formatting Header (RFH)
-  #       :header_type => :rf_header
-  #       :....
-  #   * Rules and Formatting V2 Header (RFH2)
-  #       ....
-  #   * Dead Letter Header
-  #   * CICS Header
-  #   * IMS Header
-  #   * Transmission Queue Header
-  #   * ...
-  class Message
-    attr_reader :data, :descriptor, :headers
-    attr_writer :data, :descriptor, :headers
   end
-
 end