rabbitmq-jruby-client 0.1.7

data/MIT-LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2009 Jerry Luk <jerryluk@gmail.com>
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1,55 @@
+RabbitMQ JRuby Client
+=====================
+rabbitmq-jruby-client allows you to use RabbitMQ Client from JRuby using the official Java RabbitMQ client from Rabbit Technologies
+See more at http://www.rabbitmq.com
+
+Getting Started
+===============
+1. Make sure you can install RubyGem from GitHub (you only have to do this once): jruby -S gem sources -a http://gems.github.com
+2. Install and start RabbitMQ (see below)
+3. Install JRuby RabbitMQ Client: jruby -S gem install jerryluk-rabbitmq-jruby-client
+
+Example Usage
+=============
+gem 'jerryluk-rabbitmq-jruby-client'
+require 'rabbitmq_client'
+
+# Initializes the new client and connect to the server
+client = RabbitMQClient.new
+
+# Initializes a new queue
+queue = client.queue('queue_name')
+
+# Initializes a new exchange
+exchange = client.exchange('exchange_name')
+
+# Connects queue with the exchange
+queue.bind(exchange)
+
+# Publish a message to the queue
+queue.publish('message body')
+
+# Retrieve a message from the queue
+message = queue.retrieve
+
+# Subscribe to a queue with callback. The callback will be run in a new thread for each new message. 
+queue.subscribe do |message|
+  # do something with message
+end
+
+# Subscribe to a queue in a loop. No new thread will be created.
+queue.loop_subscribe do |message|
+  # do something with message
+end
+
+
+Installing RabbitMQ on OS X
+===========================
+1. Install MacPorts
+2. sudo port install erlang
+3. wget http://www.rabbitmq.com/releases/rabbitmq-server/v1.5.3/rabbitmq-server-generic-unix-1.5.3.tar.gz
+4. tar zxvf rabbitmq-server-1.5.3.tar.gz
+5. sudo mv rabbitmq_server-1.5.3 /opt/local/lib/erlang/lib
+
+To run RabbitMQ
+6. sudo /opt/local/lib/erlang/lib/rabbitmq_server-1.5.3/sbin/rabbitmq-server

data/lib/rabbitmq_client.rb

@@ -0,0 +1,189 @@
+require 'java'
+require File.dirname(__FILE__) + '/junit.jar'
+require File.dirname(__FILE__) + '/commons-cli-1.1.jar'
+require File.dirname(__FILE__) + '/commons-io-1.2.jar'
+require File.dirname(__FILE__) + '/rabbitmq-client.jar'
+
+class RabbitMQClient
+  include ObjectSpace
+  include_class('com.rabbitmq.client.Connection')
+  include_class('com.rabbitmq.client.ConnectionParameters')
+  include_class('com.rabbitmq.client.ConnectionFactory')
+  include_class('com.rabbitmq.client.Channel')
+  include_class('com.rabbitmq.client.Consumer')
+  include_class('com.rabbitmq.client.DefaultConsumer')
+  include_class('com.rabbitmq.client.QueueingConsumer')
+  include_class('com.rabbitmq.client.MessageProperties')
+  include_class('java.lang.InterruptedException')
+  include_class('java.lang.String') { |package, name| "J#{name}" }
+  
+  class RabbitMQClientError < StandardError;end
+  
+  class QueueConsumer < DefaultConsumer
+    def initialize(channel, block)
+      @channel = channel
+      @block = block
+      super(channel)
+    end
+    
+    def handleDelivery(consumer_tag, envelope, properties, body)
+      delivery_tag = envelope.get_delivery_tag
+      message_body = Marshal.load(String.from_java_bytes(body))
+      # TODO: Do we need to do something with properties?
+      @block.call message_body
+      @channel.basic_ack(delivery_tag, false)
+    end
+  end
+  
+  class Queue
+    def initialize(name, channel, durable=false)
+      @name = name
+      @durable = durable
+      @channel = channel
+      @channel.queue_declare(name, durable)
+      self
+    end
+    
+    def bind(exchange, routing_key='')
+      @routing_key = routing_key
+      @exchange = exchange
+      raise RabbitMQClientError, "queue and exchange has different durable property" unless @durable == exchange.durable
+      @channel.queue_bind(@name, @exchange.name, @routing_key)
+      self
+    end
+    
+    # Set props for different type of message. Currently they are:
+    # RabbitMQClient::MessageProperties::MINIMAL_BASIC
+    # RabbitMQClient::MessageProperties::MINIMAL_PERSISTENT_BASIC
+    # RabbitMQClient::MessageProperties::BASIC
+    # RabbitMQClient::MessageProperties::PERSISTENT_BASIC
+    # RabbitMQClient::MessageProperties::TEXT_PLAIN
+    # RabbitMQClient::MessageProperties::PERSISTENT_TEXT_PLAIN
+    def publish(message_body, props=nil)
+      auto_bind
+      message_body_byte = Marshal.dump(message_body).to_java_bytes
+      @channel.basic_publish(@exchange.name, @routing_key, props, message_body_byte)
+      message_body
+    end
+    
+    def persistent_publish(message_body, props=MessageProperties::PERSISTENT_TEXT_PLAIN)
+      raise RabbitMQClientError, "can only publish persistent message to durable queue" unless @durable
+      publish(message_body, props)
+    end
+    
+    def retrieve
+      auto_bind
+      message_body = nil
+      no_ack = false
+      response = @channel.basic_get(@name, no_ack)
+      if response
+        props = response.get_props
+        message_body = Marshal.load(String.from_java_bytes(response.get_body))
+        delivery_tag = response.get_envelope.get_delivery_tag
+        @channel.basic_ack(delivery_tag, false)
+      end
+      message_body
+    end
+    
+    def subscribe(&block)
+      no_ack = false
+      @channel.basic_consume(@name, no_ack, QueueConsumer.new(@channel, block))
+    end
+    
+    def loop_subscribe(&block)
+      no_ack = false
+      consumer = QueueingConsumer.new(@channel)
+      @channel.basic_consume(@name, no_ack, consumer)
+      loop do
+        begin
+          delivery = consumer.next_delivery
+          message_body = Marshal.load(String.from_java_bytes(delivery.get_body))
+          block.call message_body
+          @channel.basic_ack(delivery.get_envelope.get_delivery_tag, false)
+        rescue InterruptedException => ie
+          next
+        end
+      end
+    end
+    
+    protected
+    def auto_bind
+      unless @exchange
+        exchange = Exchange.new("#{@name}_exchange", 'fanout', @channel, @durable)
+        self.bind(exchange)
+      end
+    end
+  end
+  
+  class Exchange
+    attr_reader :name
+    attr_reader :durable
+    
+    def initialize(name, type, channel, durable=false)
+      @name = name
+      @type = type
+      @durable = durable
+      @channel = channel
+      @channel.exchange_declare(@name, type.to_s, durable)
+      self
+    end
+  end
+  
+  # Class Methods
+  class << self
+  end
+  
+  attr_reader :channel
+  attr_reader :connection
+  
+  # Instance Methods
+  def initialize(options={})
+    # server address
+    @host = options[:host] || '127.0.0.1'
+    @port = options[:port] || 5672
+    
+    # login details
+    @username = options[:username] || 'guest'
+    @password = options[:password] || 'guest'
+    @vhost = options[:vhost] || '/'
+    
+    # queues and exchanges
+    @queues = {}
+    @exchanges = {}
+    
+    connect unless options[:no_auto_connect]
+    # Disconnect before the object is destroyed
+    define_finalizer(self, lambda {|id| self.disconnect if self.connected? })
+    self
+  end
+  
+  def connect
+    params = ConnectionParameters.new
+    params.set_username(@username)
+    params.set_password(@password)
+    params.set_virtual_host(@vhost)
+    params.set_requested_heartbeat(0)
+    conn_factory = ConnectionFactory.new(params)
+    @connection = conn_factory.new_connection(@host, @port)
+    @channel = @connection.create_channel
+  end
+  
+  def disconnect
+    @channel.close
+    @connection.close
+    @connection = nil
+  end
+  
+  def connected?
+    @connection != nil
+  end
+  
+  def queue(name, durable=false)
+    @queues[name] ||= Queue.new(name, @channel, durable)
+  end
+  
+  def exchange(name, type='fanout', durable=false)
+    @exchanges[name] ||= Exchange.new(name, type, @channel, durable)
+  end
+end
+

data/spec/rabbitmq_client_spec.rb

@@ -0,0 +1,125 @@
+require 'rubygems'
+require 'spec'
+require File.dirname(__FILE__) + '/../lib/rabbitmq_client'
+
+describe RabbitMQClient do
+  before(:each) do
+    @client = RabbitMQClient.new
+  end
+  
+  after(:each) do
+    @client.disconnect
+  end
+  
+  it "should able to create a connection" do
+    @client.connection.should_not be_nil
+  end
+  
+  it "should able to create a channel" do
+    @client.channel.should_not be_nil
+  end
+  
+  it "should be able to create a new exchange" do
+    exchange = @client.exchange('test_exchange', 'direct')
+    exchange.should_not be_nil
+  end
+  
+  describe Queue, "Basic non-persistent queue" do
+    before(:each) do
+      @queue = @client.queue('test_queue')
+      @exchange = @client.exchange('test_exchange', 'direct')
+    end
+    
+    it "should able to create a queue" do
+      @queue.should_not be_nil
+    end
+    
+    it "should able to bind to an exchange" do
+      @queue.bind(@exchange).should_not be_nil
+    end
+    
+    it "should able to publish and retrieve a message" do
+      @queue.bind(@exchange)
+      @queue.publish('Hello World')
+      @queue.retrieve.should == 'Hello World'
+      @queue.publish('人大')
+      @queue.retrieve.should == '人大'
+    end
+    
+    it "should able to subscribe with a callback function" do
+      a = 0
+      @queue.bind(@exchange)
+      @queue.subscribe do |v|
+         a += v.to_i
+      end
+      @queue.publish("1")
+      @queue.publish("2")
+      sleep 1
+      a.should == 3
+    end
+    
+    it "should able to subscribe to a queue using loop_subscribe" do
+      a = 0
+      @queue.bind(@exchange)
+      Thread.new do
+        begin
+          timeout(1) do
+            @queue.loop_subscribe do |v|
+              a += v.to_i
+            end
+          end
+        rescue Timeout::Error => e
+        end
+      end
+      @queue.publish("1")
+      @queue.publish("2")
+      sleep 2
+      a.should == 3
+    end
+    
+    it "should raise an exception if binding a persistent queue with non-persistent exchange and vice versa" do
+      persistent_queue = @client.queue('test_queue1', true)
+      persistent_exchange = @client.exchange('test_exchange1', 'fanout', true)
+      lambda { persistent_queue.bind(@exchange) }.should raise_error(RabbitMQClient::RabbitMQClientError)
+      lambda { @queue.bind(persistent_exchange) }.should raise_error(RabbitMQClient::RabbitMQClientError)
+    end
+    
+    it "should raise an exception if publish a persistent message on non-duration queue" do
+      @queue.bind(@exchange)
+      lambda { @queue.persistent_publish('Hello') }.should raise_error(RabbitMQClient::RabbitMQClientError)
+    end
+  end
+  
+  describe Queue, "Basic persistent queue" do
+    before(:each) do
+      @queue = @client.queue('test_durable_queue', true)
+      @exchange = @client.exchange('test_durable_exchange', 'fanout', true)
+    end
+    
+    it "should able to create a queue" do
+      @queue.should_not be_nil
+    end
+    
+    it "should able to bind to an exchange" do
+      @queue.bind(@exchange).should_not be_nil
+    end
+    
+    it "should able to publish and retrieve a message" do
+      @queue.bind(@exchange)
+      @queue.persistent_publish('Hello World')
+      @queue.retrieve.should == 'Hello World'
+    end
+    
+    it "should able to subscribe with a callback function" do
+      a = 0
+      @queue.bind(@exchange)
+      @queue.subscribe do |v|
+         a += v.to_i
+      end
+      @queue.persistent_publish("1")
+      @queue.persistent_publish("2")
+      sleep 1
+      a.should == 3
+    end
+  end
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification 
+name: rabbitmq-jruby-client
+version: !ruby/object:Gem::Version 
+  version: 0.1.7
+platform: ruby
+authors: 
+  - Jerry Luk
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-02-09 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: A RabbitMQ client for JRuby
+email: jerryluk@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+  - README
+  - MIT-LICENSE
+  - lib/commons-cli-1.1.jar
+  - lib/commons-io-1.2.jar
+  - lib/rabbitmq-client.jar
+  - lib/junit.jar
+  - lib/rabbitmq_client.rb
+  - spec/rabbitmq_client_spec.rb
+has_rdoc: true
+homepage: http://www.linkedin.com/in/jerryluk
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+  - lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A RabbitMQ client for JRuby
+test_files: 
+  - spec/rabbitmq_client_spec.rb