rmq 0.0.1

data/lib/rmq/queue.rb

@@ -0,0 +1,36 @@
+module RMQ
+  class Queue
+    include MQClient
+
+    # TODO add some caching for the queue handle
+
+    def initialize(queue_manager, name)
+      @queue_manager = queue_manager
+      @queue_name = name
+    end
+
+    def put_message(payload)
+      @queue_handle = open_queue(@queue_manager.connection_handle, @queue_name, Constants::MQOO_OUTPUT) if @queue_handle.nil?
+
+      put_message_on_queue(@queue_manager.connection_handle, @queue_handle, payload)
+
+      close_queue(@queue_manager.connection_handle, @queue_handle, Constants::MQCO_NONE)
+      @queue_handle = nil
+    end
+
+    def depth
+      queue_depth(@queue_manager.connection_handle, @queue_name)
+    end
+
+    def get_message
+      @queue_handle = open_queue(@queue_manager.connection_handle, @queue_name, Constants::MQOO_INPUT_SHARED) if @queue_handle.nil?
+
+      payload = get_message_from_queue(@queue_manager.connection_handle, @queue_handle)
+
+      close_queue(@queue_manager.connection_handle, @queue_handle, Constants::MQCO_NONE)
+      @queue_handle = nil
+
+      payload
+    end
+  end
+end

data/lib/rmq/queue_manager.rb

@@ -0,0 +1,105 @@
+require 'rmq/mqclient'
+
+module RMQ
+  class QueueManager
+    include MQClient
+    include Constants
+
+    attr_reader :connection_handle
+
+    def self.connect(queue_manager)
+      qm = QueueManager.new(queue_manager)
+      qm.connect
+
+      qm
+    end
+
+    def initialize(queue_manager)
+      @queue_manager = queue_manager
+    end
+
+    def connect
+      hconn_ptr = FFI::MemoryPointer.new :long
+      completion_code_ptr = FFI::MemoryPointer.new :long
+      reason_code_ptr = FFI::MemoryPointer.new :long
+
+      MQClient.mqconn(@queue_manager, hconn_ptr, completion_code_ptr, reason_code_ptr)
+
+      @connection_handle = hconn_ptr.read_long
+
+      unless completion_code_ptr.read_long == MQCC_OK
+        raise RMQException.new(completion_code_ptr.read_long, reason_code_ptr.read_long), "Cannot connect to queue manager #{@queue_manager}"
+      end
+    end
+
+    def disconnect
+      completion_code_ptr = FFI::MemoryPointer.new :long
+      reason_code_ptr = FFI::MemoryPointer.new :long
+      hconn_ptr = FFI::MemoryPointer.new :long
+
+      hconn_ptr.write_long @connection_handle
+      MQClient.mqdisc(hconn_ptr, completion_code_ptr, reason_code_ptr)
+
+      unless completion_code_ptr.read_long == MQCC_OK
+        raise RMQException.new(completion_code_ptr.read_long, reason_code_ptr.read_long), "Cannot disconnect from queue manager #{@queue_manager}"
+      end
+    end
+
+    def find_queue(queue_name)
+      queue_names = []
+
+      adminbag_handle = create_admin_bag
+      responsebag_handle = create_response_bag
+      add_string_to_bag(adminbag_handle, MQCA_Q_NAME, "*")
+      add_integer_to_bag(adminbag_handle, MQIA_Q_TYPE, MQQT_LOCAL)
+      add_inquiry(adminbag_handle, MQIA_CURRENT_Q_DEPTH)
+
+      execute(@connection_handle, MQCMD_INQUIRE_Q, MQHB_NONE, adminbag_handle, responsebag_handle, MQHO_NONE, MQHO_NONE)
+
+      number_of_bags = count_items(responsebag_handle, MQHA_BAG_HANDLE)
+
+      for bag_number in (0..number_of_bags - 1)
+        attributes_bag_handle = inquire_bag(responsebag_handle, MQHA_BAG_HANDLE, bag_number)
+        queue_names.push inquire_string(attributes_bag_handle, MQCA_Q_NAME, 0)
+      end
+
+      delete_bag(adminbag_handle)
+      delete_bag(responsebag_handle)
+
+      if queue_names.include?(queue_name)
+        RMQ::Queue.new(self, queue_name)
+      else
+        nil
+      end
+    end
+
+    def create_queue(queue_name)
+      adminbag_handle = create_admin_bag
+      responsebag_handle = create_response_bag
+      add_string_to_bag(adminbag_handle, MQCA_Q_NAME, queue_name)
+      add_integer_to_bag(adminbag_handle, MQIA_Q_TYPE, MQQT_LOCAL)
+      execute(@connection_handle, MQCMD_CREATE_Q, MQHB_NONE, adminbag_handle, responsebag_handle, MQHO_NONE, MQHO_NONE)
+
+      delete_bag(adminbag_handle)
+      delete_bag(responsebag_handle)
+
+      RMQ::Queue.new(self, queue_name)
+    end
+
+    def delete_queue(queue_name, purge = true)
+      adminbag_handle = create_admin_bag
+      responsebag_handle = create_response_bag
+      add_string_to_bag(adminbag_handle, MQCA_Q_NAME, queue_name)
+
+      if purge # delete queue regardless of messages in it
+        add_integer_to_bag(adminbag_handle, MQIACF_PURGE, MQPO_YES)
+      end
+
+      execute(@connection_handle, MQCMD_DELETE_Q, MQHB_NONE, adminbag_handle, responsebag_handle, MQHO_NONE, MQHO_NONE)
+
+      delete_bag(adminbag_handle)
+      delete_bag(responsebag_handle)
+    end
+
+  end
+end

data/lib/rmq/version.rb

@@ -0,0 +1,3 @@
+module RMQ
+  VERSION = "0.0.1"
+end

data/spec/rmq/queue_manager_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+describe RMQ::QueueManager do
+
+  after(:each) do
+    @qm.disconnect if !@qm.nil?
+  end
+
+  it 'should pass the canary test' do
+    true.should == true
+  end
+
+  it 'should connect/disconnect to/from local queue manager' do
+    @qm = RMQ::QueueManager::connect(SpecHelper::DATA[:queue_manager])
+    @qm.should_not be_nil
+  end
+
+  it "should raise an exception for a wrong queue manager name" do
+    lambda { RMQ::QueueManager::connect("INVALID_NAME") }.should raise_error(RMQ::RMQException)
+  end
+
+  it "should create a new queue" do
+    @qm = RMQ::QueueManager::connect(SpecHelper::DATA[:queue_manager])
+    queue = @qm.create_queue("RMQ.SAMPLE")
+    queue.should_not be_nil
+
+    @qm.find_queue("RMQ.SAMPLE").should_not be_nil
+
+    @qm.delete_queue("RMQ.SAMPLE")
+  end
+
+  it "should find an existing queue" do
+    @qm = RMQ::QueueManager::connect(SpecHelper::DATA[:queue_manager])
+    @qm.find_queue("SYSTEM.ADMIN.COMMAND.QUEUE").should_not be_nil    # SAMPLE_IN needs to be changed to one that always exists
+  end
+
+  it "should not find a non-existing queue" do
+    @qm = RMQ::QueueManager::connect(SpecHelper::DATA[:queue_manager])
+    @qm.find_queue("DOES_NOT_EXIST").should be_nil
+  end
+
+  it "should delete a queue" do
+    @qm = RMQ::QueueManager::connect(SpecHelper::DATA[:queue_manager])
+    @qm.create_queue("RMQ.SAMPLE")
+    @qm.find_queue("RMQ.SAMPLE").should_not be_nil
+
+    @qm.delete_queue("RMQ.SAMPLE")
+    @qm.find_queue("RMQ.SAMPLE").should be_nil
+  end
+
+end

data/spec/rmq/queue_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe RMQ::Queue do
+
+  before(:each) do
+    @qm = RMQ::QueueManager::connect(SpecHelper::DATA[:queue_manager])
+
+    @qm.delete_queue("RMQ.SAMPLE") unless @qm.find_queue("RMQ.SAMPLE").nil?
+    @queue = @qm.create_queue("RMQ.SAMPLE")
+  end
+
+  after(:each) do
+    @qm.delete_queue("RMQ.SAMPLE")
+    @qm.disconnect if !@qm.nil?
+  end
+
+  it "should put a message on a queue" do
+    @queue.put_message("sample message")
+    @queue.depth.should == 1
+  end
+
+  it "should read a message from a queue" do
+    @queue.put_message("I want to read this back")
+    @queue.get_message.should == "I want to read this back"
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require 'rspec'
+require 'rmq'
+
+ENV['MQSERVER'] = "SYSTEM.DEF.SVRCONN/TCP/127.0.0.1(1414)"
+
+module SpecHelper
+  DATA = {
+      :queue_manager => "BKR_QMGR"
+  }
+end
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.formatter     = 'documentation'
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: rmq
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Stephan Schwab
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &22418904 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :development
+  prerelease: false
+  version_requirements: *22418904
+description: Ruby wrapper around MQ series client library
+email: sns@caimito.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/rmq/constants.rb
+- lib/rmq/exceptions.rb
+- lib/rmq/get_message_options.rb
+- lib/rmq/message_descriptor.rb
+- lib/rmq/mqclient.rb
+- lib/rmq/object_descriptor.rb
+- lib/rmq/put_message_options.rb
+- lib/rmq/queue.rb
+- lib/rmq/queue_manager.rb
+- lib/rmq/version.rb
+- lib/rmq.rb
+- spec/rmq/queue_manager_spec.rb
+- spec/rmq/queue_spec.rb
+- spec/spec_helper.rb
+homepage: http://rubygems.org/gems/rmq
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Ruby MQ client wrapper
+test_files:
+- spec/rmq/queue_manager_spec.rb
+- spec/rmq/queue_spec.rb
+- spec/spec_helper.rb