jerryluk-rabbitmq-jruby-client 0.1.4 → 0.1.5

data/README

@@ -1,22 +1,49 @@
-
-This project is a JRuby wrapper of the Java RabbitMQ Client from Rabbit Technologies
-
-http://www.rabbitmq.com/
-
-Using this library does not require you to use EventMachine for subscribing a RabbitMQ queue.
-
-To use RabbitMQ JRuby Client with Workling:
-1. Copy workling_rabbitmq_client.rb and workling_rabbitmq_subscriber.rb to lib
-Create an initializer 'rabbitmq.rb' in 'config/initializers'
-
-require 'workling_rabbitmq_client'
-Workling::Remote.dispatcher = Workling::Remote::Runners::ClientRunner.new
-Workling::Remote.dispatcher.client = Workling::Clients::WorklingRabbitMQClient.new
-
-Optional: To use subscriber
-Modify vendor/plugins/workling/script/listen.rb, added this after the require statements
-
-require 'workling_rabbitmq_subscriber'
-
-To start Workling: (You can use script/workling_client because it uses daemons)
-jruby vendor/plugins/workling/script/listen.rb
+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
+queue.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

@@ -12,8 +12,11 @@ class RabbitMQClient
   include_class('com.rabbitmq.client.Channel')
   include_class('com.rabbitmq.client.Consumer')
   include_class('com.rabbitmq.client.DefaultConsumer')
+  include_class('com.rabbitmq.client.MessageProperties')
   include_class('java.lang.String') { |package, name| "J#{name}" }
   
+  class RabbitMQClientError < StandardError;end
+  
   class QueueConsumer < DefaultConsumer
     def initialize(channel, block)
       @channel = channel
@@ -24,26 +27,36 @@ class RabbitMQClient
     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)
+    def initialize(name, channel, durable=false)
       @name = name
+      @durable = durable
       @channel = channel
-      @channel.queue_declare(name)
+      @channel.queue_declare(name, durable)
       self
     end
     
-    def bind(exchange, routing_key=nil)
-      @routing_key = routing_key || "#{@name}_#{Time.now.to_i.to_s}_#{rand(1<<64).to_s}"
+    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
@@ -51,6 +64,11 @@ class RabbitMQClient
       message_body
     end
     
+    def persistent_publish(message_body, props=MessageProperties::PERSISTENT_BASIC)
+      raise RabbitMQClientError, "can only publish persistent message to durable queue" unless @durable
+      publish(message_body, props)
+    end
+    
     def retrieve
       auto_bind
       message_body = nil
@@ -73,7 +91,7 @@ class RabbitMQClient
     protected
     def auto_bind
       unless @exchange
-        exchange = Exchange.new("#{@name}_exchange", 'fanout', @channel)
+        exchange = Exchange.new("#{@name}_exchange", 'fanout', @channel, @durable)
         self.bind(exchange)
       end
     end
@@ -81,12 +99,14 @@ class RabbitMQClient
   
   class Exchange
     attr_reader :name
+    attr_reader :durable
     
-    def initialize(name, type, channel)
+    def initialize(name, type, channel, durable=false)
       @name = name
       @type = type
+      @durable = durable
       @channel = channel
-      @channel.exchange_declare(@name, type.to_s)
+      @channel.exchange_declare(@name, type.to_s, durable)
       self
     end
   end
@@ -99,7 +119,7 @@ class RabbitMQClient
   attr_reader :connection
   
   # Instance Methods
-  def initialize(options={})
+  def initialize(options={:auto_connect => true})
     # server address
     @host = options[:host] || '127.0.0.1'
     @port = options[:port] || 5672
@@ -113,7 +133,7 @@ class RabbitMQClient
     @queues = {}
     @exchanges = {}
     
-    connect
+    connect if options[:auto_connect]
     # Disconnect before the object is destroyed
     define_finalizer(self, lambda {|id| self.disconnect if self.connected? })
     self
@@ -140,12 +160,12 @@ class RabbitMQClient
     @connection != nil
   end
   
-  def queue(name)
-    @queues[name] ||= Queue.new(name, @channel)
+  def queue(name, durable=false)
+    @queues[name] ||= Queue.new(name, @channel, durable)
   end
   
-  def exchange(name, type='fanout')
-    @exchanges[name] ||= Exchange.new(name, type, @channel)
+  def exchange(name, type='fanout', durable=false)
+    @exchanges[name] ||= Exchange.new(name, type, @channel, durable)
   end
 end
 

data/spec/rabbitmq_client_spec.rb

@@ -7,6 +7,10 @@ describe RabbitMQClient 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
@@ -20,7 +24,7 @@ describe RabbitMQClient do
     exchange.should_not be_nil
   end
   
-  describe Queue do
+  describe Queue, "Basic non-persistent queue" do
     before(:each) do
       @queue = @client.queue('test_queue')
       @exchange = @client.exchange('test_exchange', 'direct')
@@ -51,5 +55,50 @@ describe RabbitMQClient do
       sleep 1
       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

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: jerryluk-rabbitmq-jruby-client
 version: !ruby/object:Gem::Version 
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors: 
 - Jerry Luk