celldee-bunny 0.0.6 → 0.0.7

data/README.markdown

@@ -1,18 +1,31 @@
-# README
+# Bunny: A synchronous Ruby AMQP client
+
+Google Group: [bunny-amqp](http://groups.google.com/group/bunny-amqp)
+
+## Announcements
+
+**IMPORTANT**
+
+The Exchange#initialize method has changed as of version 0.0.7
+
+You now create an exchange like this -
+
+    b = Bunny.new
+    exch = b.exchange('*my_exchange*', :type => :fanout)
+
+If you do not specify a :type option then a default of :direct is used.
 
 ## About
 
-*bunny* is an AMQP client, written in Ruby, that is intended to allow you to interact with AMQP-compliant message brokers/servers such as RabbitMQ in a synchronous fashion.
+*Bunny* is an [AMQP](http://www.amqp.org) (Advanced Message Queuing Protocol) client, written in Ruby, that is intended to allow you to interact with AMQP-compliant message brokers/servers such as [RabbitMQ](http://www.rabbitmq.com) in a synchronous fashion.
 
-You can use *bunny* to -
+You can use *Bunny* to -
 
 * Create and delete exchanges
 * Create and delete queues
 * Publish and consume messages
  
-*bunny* is being tested with RabbitMQ version 1.5.4 and version 0-8 of the AMQP specification.
-
-There is a Google Group for discussing bunny - [bunny-amqp](http://groups.google.com/group/bunny-amqp)
+*Bunny* is known to work with RabbitMQ version 1.5.4 and version 0-8 of the AMQP specification. If you want to try to use it with other AMQP message brokers/servers please let me know how you get on.
  
 ## Quick Start
 
@@ -42,6 +55,61 @@ There is a Google Group for discussing bunny - [bunny-amqp](http://groups.google
     # close the connection
     b.close
 
+## Bunny methods
+
+These are the Bunny methods that you will probably want to use -
+
+### Create a Bunny instance
+Bunny#new({_options_})
+
+### Start a communication session with the target server
+Bunny#start
+
+### Stop a communication session with the target server
+Bunny#stop
+
+### Create a Queue
+Bunny#queue(_**name**_, {_options_})
+
+### Creates an Exchange
+Bunny#exchange(_**name**_, {_options_})
+
+### Return connection status ('CONNECTED' or 'NOT CONNECTED')
+Bunny#status               
+
+### Publish a message to an exchange
+Exchange#publish(_**data**_, {_options_})
+
+### Delete an exchange from the target server
+Exchange#delete({_options_})
+
+### Bind a queue to an exchange
+Queue#bind(_**exchange**_, {_options_})
+
+### Unbind a queue from an exchange
+Queue#unbind(_**exchange**_, {_options_})
+
+### Publish a message to a queue
+Queue#publish(_**data**_, {_options_})
+
+### Pop a message off of a queue
+Queue#pop({_options_})
+
+### Return queue message count
+Queue#message_count
+
+### Return queue consumer count
+Queue#consumer_count
+
+### Return queue status (array of message count and consumer_count)
+Queue#status
+
+### Send an acknowledge message to the server
+Queue#ack
+
+### Delete a queue from the target server
+Queue#delete({_options_})
+
 ## Acknowledgements
 
 This project has borrowed heavily from the following two projects and owes their respective creators and collaborators a whole lot of gratitude:

data/lib/amqp/client.rb

@@ -3,8 +3,8 @@ module AMQP
     CONNECT_TIMEOUT = 1.0
     RETRY_DELAY     = 10.0
 
-    attr_reader   :status
-    attr_accessor :channel, :host, :logging, :exchanges, :queues, :port, :ticket
+    attr_reader   :status, :host, :vhost, :port
+    attr_accessor :channel, :logging, :exchanges, :queues, :ticket
 
     def initialize(opts = {})
 			@host = opts[:host] || 'localhost'

data/lib/bunny.rb

@@ -32,8 +32,8 @@ class Bunny
 		client.status
 	end
 	
-	def exchange(type, name, opts = {})
-		client.exchanges[name] ||= Exchange.new(client, type, name, opts)
+	def exchange(name, opts = {})
+		client.exchanges[name] ||= Exchange.new(client, name, opts)
 	end
   
   def queue(name, opts = {})
@@ -51,5 +51,17 @@ class Bunny
   def exchanges
     client.exchanges ||= {}
   end
+	
+	def host
+		client.host
+	end
+	
+	def vhost
+		client.vhost
+	end
+	
+	def port
+		client.port
+	end
 
 end

data/lib/bunny/exchange.rb

@@ -4,11 +4,13 @@ class Exchange
 	
   attr_reader :client, :type, :name, :opts, :key
 
-  def initialize(client, type, name, opts = {})
+  def initialize(client, name, opts = {})
 		# check connection to server
 		raise 'Not connected to server' if client.status == NOT_CONNECTED
 		
-    @client, @type, @name, @opts = client, type, name, opts
+    @client, @name, @opts = client, name, opts
+		@type = opts[:type] || :direct
+		opts.delete(:type) unless opts[:type].nil?
     @key = opts[:key]
 		@client.exchanges[@name] ||= self
 		
@@ -41,15 +43,12 @@ class Exchange
     client.send_frame(*out)
   end
 
-  def delete(opts = {})
-		client.exchanges.delete(name)
-		
+  def delete(opts = {})	
     client.send_frame(
       Protocol::Exchange::Delete.new({ :exchange => name, :nowait => true }.merge(opts))
     )
-  end
 
-  def reset
-    initialize(client, type, name, opts)
+		client.exchanges.delete(name)
   end
+
 end

data/lib/bunny/queue.rb

@@ -93,16 +93,16 @@
 	  end
 
 	  def delete(opts = {})
-			client.queues.delete(name)
-			
 	    client.send_frame(
 	      Protocol::Queue::Delete.new({ :queue => name, :nowait => true }.merge(opts))
 	    )
+	
+			client.queues.delete(name)
 	  end
 
 	private
 	  def exchange
-	    @exchange ||= Exchange.new(client, :direct, '', :key => name)
+	    @exchange ||= Exchange.new(client, '', {:type => :direct, :key => name})
 	  end
 
 	  def bindings

data/spec/bunny_spec.rb

@@ -24,7 +24,7 @@ describe Bunny do
   end
 
 	it "should be able to create an exchange" do
-		exch = @b.exchange(:direct, 'test_exchange')
+		exch = @b.exchange('test_exchange')
 		exch.should be_an_instance_of Exchange
 		exch.name.should == 'test_exchange'
 		@b.exchanges.has_key?('test_exchange').should be true

data/spec/exchange_spec.rb

@@ -19,8 +19,16 @@ describe Exchange do
 		@b.stop
 	end
 	
+	it "should be able to create a default direct exchange" do
+		exch = @b.exchange('direct_defaultex')
+		exch.should be_an_instance_of Exchange
+		exch.name.should == 'direct_defaultex'
+		exch.type.should == :direct
+		@b.exchanges.has_key?('direct_defaultex').should be true
+	end
+	
 	it "should be able to be instantiated as a direct exchange" do
-		exch = @b.exchange(:direct, 'direct_exchange')
+		exch = @b.exchange('direct_exchange', :type => :direct)
 		exch.should be_an_instance_of Exchange
 		exch.name.should == 'direct_exchange'
 		exch.type.should == :direct
@@ -28,7 +36,7 @@ describe Exchange do
 	end
 	
 	it "should be able to be instantiated as a topic exchange" do
-		exch = @b.exchange(:topic, 'topic_exchange')
+		exch = @b.exchange('topic_exchange', :type => :topic)
 		exch.should be_an_instance_of Exchange
 		exch.name.should == 'topic_exchange'
 		exch.type.should == :topic
@@ -36,20 +44,28 @@ describe Exchange do
 	end
 	
 	it "should be able to be instantiated as a fanout exchange" do
-		exch = @b.exchange(:fanout, 'fanout_exchange')
+		exch = @b.exchange('fanout_exchange', :type => :fanout)
 		exch.should be_an_instance_of Exchange
 		exch.name.should == 'fanout_exchange'
 		exch.type.should == :fanout
 		@b.exchanges.has_key?('fanout_exchange').should be true
 	end
 	
+	it "should be able to be instantiated as a headers exchange" do
+		exch = @b.exchange('head_exchange', :type => :headers)
+		exch.should be_an_instance_of Exchange
+		exch.name.should == 'head_exchange'
+		exch.type.should == :headers
+		@b.exchanges.has_key?('head_exchange').should be true
+	end
+	
 	it "should be able to publish a message" do
-		exch = @b.exchange(:direct, 'direct_exchange')
+		exch = @b.exchange('direct_exchange')
 		exch.publish('This is a published message')
 	end
 	
 	it "should be able to be deleted" do
-		exch = @b.exchange(:direct, 'direct_exchange')
+		exch = @b.exchange('direct_exchange')
 		exch.delete
 		@b.exchanges.has_key?('direct_exchange').should be false
 	end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: celldee-bunny
 version: !ruby/object:Gem::Version 
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors: 
 - Chris Duncan
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-23 00:00:00 -07:00
+date: 2009-04-24 00:00:00 -07:00
 default_executable: 
 dependencies: []