bunny 0.5.3 → 0.6.0

data/{README → README.rdoc}

@@ -1,9 +1,14 @@
 = Bunny: A synchronous Ruby AMQP client
 
 *GitHub* *repo*: http://github.com/celldee/bunny
+
 *Rubyforge*: http://rubyforge.org/projects/bunny-amqp
+
 *Twitter*: http://twitter.com/bunny_amqp
+
 *Google* *Group*: http://groups.google.com/group/bunny-amqp
+
+*Blog*: http://bunnyamqp.wordpress.com
      
 === DESCRIPTION:
 
@@ -23,7 +28,9 @@ Bunny is known to work with RabbitMQ versions 1.5.4, 1.5.5, 1.6.0 and version 0-
 
 *Rubyforge*: <tt>gem install bunny</tt>
 
-*GitHub*: <tt>gem install celldee-bunny</tt>
+*Gemcutter*: <tt>gem install bunny</tt>
+
+*GitHub*: Current gem is not available.
 
 === QUICK START:
 
@@ -41,7 +48,7 @@ Bunny is known to work with RabbitMQ versions 1.5.4, 1.5.5, 1.6.0 and version 0-
    q.publish('Hello everybody!')
 
    # get message from the queue
-   msg = q.pop
+   msg = q.pop[:payload]
 
    puts 'This is the message: ' + msg + "\n\n"
 

data/bunny.gemspec

@@ -1,18 +1,18 @@
 Gem::Specification.new do |s|
   s.name = %q{bunny}
-  s.version = "0.5.3"
+  s.version = "0.6.0"
   s.authors = ["Chris Duncan"]
-  s.date = %q{2009-09-07}
+  s.date = %q{2009-10-05}
   s.description = %q{Another synchronous Ruby AMQP client}
   s.email = %q{celldee@gmail.com}
   s.rubyforge_project = %q{bunny-amqp}
   s.has_rdoc = true
- 	s.extra_rdoc_files = [ "README" ]
-  s.rdoc_options = [ "--main", "README" ]
+ 	s.extra_rdoc_files = [ "README.rdoc" ]
+  s.rdoc_options = [ "--main", "README.rdoc" ]
   s.homepage = %q{http://github.com/celldee/bunny/tree/master}
   s.summary = %q{A synchronous Ruby AMQP client that enables interaction with AMQP-compliant brokers/servers.}
   s.files = ["LICENSE",
-	 	"README",
+	 	"README.rdoc",
 		"Rakefile",
 		"bunny.gemspec",
 		"examples/simple_08.rb",
@@ -38,9 +38,12 @@ Gem::Specification.new do |s|
 		"lib/bunny/exchange09.rb",
 		"lib/bunny/queue08.rb",
 		"lib/bunny/queue09.rb",
+		"lib/bunny/subscription08.rb",
+		"lib/bunny/subscription09.rb",
 		"lib/qrack/client.rb",
 		"lib/qrack/channel.rb",
 		"lib/qrack/queue.rb",
+		"lib/qrack/subscription.rb",
 		"lib/qrack/protocol/protocol08.rb",
 		"lib/qrack/protocol/protocol09.rb",
 		"lib/qrack/protocol/spec08.rb",
@@ -54,7 +57,9 @@ Gem::Specification.new do |s|
 		"spec/spec_08/bunny_spec.rb",
 		"spec/spec_08/exchange_spec.rb",
 		"spec/spec_08/queue_spec.rb",
+		"spec/spec_08/connection_spec.rb",
 		"spec/spec_09/bunny_spec.rb",
 		"spec/spec_09/exchange_spec.rb",
-		"spec/spec_09/queue_spec.rb"]
-end
+		"spec/spec_09/queue_spec.rb",
+		"spec/spec_09/connection_spec.rb"]
+end

data/examples/simple_08.rb

@@ -22,7 +22,7 @@ q = b.queue('test1')
 q.publish('Hello everybody!')
 
 # get message from the queue
-msg = q.pop
+msg = q.pop[:payload]
 
 puts 'This is the message: ' + msg + "\n\n"
 

data/examples/simple_09.rb

@@ -22,7 +22,7 @@ q = b.queue('test1')
 q.publish('Hello everybody!')
 
 # get message from the queue
-msg = q.pop
+msg = q.pop[:payload]
 
 puts 'This is the message: ' + msg + "\n\n"
 

data/examples/simple_ack_08.rb

@@ -22,7 +22,7 @@ q = b.queue('test1')
 q.publish('Testing acknowledgements')
 
 # get message from the queue
-msg = q.pop(:ack => true)
+msg = q.pop(:ack => true)[:payload]
 
 # acknowledge receipt of message
 q.ack

data/examples/simple_ack_09.rb

@@ -22,7 +22,7 @@ q = b.queue('test1')
 q.publish('Testing acknowledgements')
 
 # get message from the queue
-msg = q.pop(:ack => true)
+msg = q.pop(:ack => true)[:payload]
 
 # acknowledge receipt of message
 q.ack

data/examples/simple_consumer_08.rb

@@ -44,18 +44,10 @@ exch = b.exchange('sorting_room')
 # bind queue to exchange
 q.bind(exch, :key => 'fred')
 
-# initialize counter
-i = 1
-
 # subscribe to queue
-begin
-	ret = q.subscribe(:consumer_tag => 'testtag1', :timeout => 30) do |msg|
-		puts "#{i.to_s}: #{msg}"
-		i+=1
-	end
-rescue Qrack::ClientTimeout
-	puts '==== simple_consumer_08.rb timed out - closing down ===='
-	q.unsubscribe(:consumer_tag => 'testtag1')
-	# close the connection
-	b.stop
-end
+q.subscribe(:consumer_tag => 'testtag1', :timeout => 30) do |msg|
+	puts "#{q.subscription.message_count}: #{msg[:payload]}"
+end
+
+# Close client
+b.stop

data/examples/simple_consumer_09.rb

@@ -44,18 +44,10 @@ exch = b.exchange('sorting_room')
 # bind queue to exchange
 q.bind(exch, :key => 'fred')
 
-# initialize counter
-i = 1
-
 # subscribe to queue
-begin
-	ret = q.subscribe(:consumer_tag => 'testtag1', :timeout => 30) do |msg|
-		puts "#{i.to_s}: #{msg}"
-		i+=1
-	end
-rescue Qrack::ClientTimeout
-	puts '==== simple_consumer_09.rb timed out - closing down ===='
-	q.unsubscribe(:consumer_tag => 'testtag1')
-	# close the connection
-	b.stop
-end
+q.subscribe(:consumer_tag => 'testtag1', :timeout => 30) do |msg|
+	puts "#{q.subscription.message_count}: #{msg[:payload]}"
+end
+
+# Close client
+b.stop

data/examples/simple_fanout_08.rb

@@ -30,9 +30,9 @@ q2.bind(exch)
 exch.publish('This message will be fanned out')
 
 # get message from the queues
-msg = q1.pop
+msg = q1.pop[:payload]
 puts 'This is the message from q1: ' + msg + "\n\n"
-msg = q2.pop
+msg = q2.pop[:payload]
 puts 'This is the message from q2: ' + msg + "\n\n"
 
 # close the client connection

data/examples/simple_fanout_09.rb

@@ -30,9 +30,9 @@ q2.bind(exch)
 exch.publish('This message will be fanned out')
 
 # get message from the queues
-msg = q1.pop
+msg = q1.pop[:payload]
 puts 'This is the message from q1: ' + msg + "\n\n"
-msg = q2.pop
+msg = q2.pop[:payload]
 puts 'This is the message from q2: ' + msg + "\n\n"
 
 # close the client connection

data/examples/simple_headers_08.rb

@@ -32,7 +32,7 @@ header_exch.publish('Headers test msg 2', :headers => {'h1'=>'z'})
 # get messages from the queue - should only be msg 1 that got through
 msg = ""
 until msg == :queue_empty do
-	msg = q.pop
+	msg = q.pop[:payload]
 	puts 'This is a message from the header_q1 queue: ' + msg + "\n" unless msg == :queue_empty
 end
 

data/examples/simple_headers_09.rb

@@ -32,7 +32,7 @@ header_exch.publish('Headers test msg 2', :headers => {'h1'=>'z'})
 # get messages from the queue - should only be msg 1 that got through
 msg = ""
 until msg == :queue_empty do
-	msg = q.pop
+	msg = q.pop[:payload]
 	puts 'This is a message from the header_q1 queue: ' + msg + "\n" unless msg == :queue_empty
 end
 

data/examples/simple_topic_08.rb

@@ -38,20 +38,20 @@ sports_results.publish('British Lions 15 : South Africa 12', :key => 'rugby.resu
 # get message from the queues
 
 # soccer queue got the soccer message
-msg = soccer.pop
+msg = soccer.pop[:payload]
 puts 'This is a message from the soccer q: ' + msg + "\n\n"
 
 # cricket queue got the cricket message
-msg = cricket.pop
+msg = cricket.pop[:payload]
 puts 'This is a message from the cricket q: ' + msg + "\n\n"
 
 # rugby queue got the rugby message
-msg = rugby.pop
+msg = rugby.pop[:payload]
 puts 'This is a message from the rugby q: ' + msg + "\n\n"
 
 # allsport queue got all of the messages
 until msg == :queue_empty do
-	msg = allsport.pop
+	msg = allsport.pop[:payload]
 	puts 'This is a message from the allsport q: ' + msg + "\n\n" unless msg == :queue_empty
 end
 

data/examples/simple_topic_09.rb

@@ -38,20 +38,20 @@ sports_results.publish('British Lions 15 : South Africa 12', :key => 'rugby.resu
 # get message from the queues
 
 # soccer queue got the soccer message
-msg = soccer.pop
+msg = soccer.pop[:payload]
 puts 'This is a message from the soccer q: ' + msg + "\n\n"
 
 # cricket queue got the cricket message
-msg = cricket.pop
+msg = cricket.pop[:payload]
 puts 'This is a message from the cricket q: ' + msg + "\n\n"
 
 # rugby queue got the rugby message
-msg = rugby.pop
+msg = rugby.pop[:payload]
 puts 'This is a message from the rugby q: ' + msg + "\n\n"
 
 # allsport queue got all of the messages
 until msg == :queue_empty do
-	msg = allsport.pop
+	msg = allsport.pop[:payload]
 	puts 'This is a message from the allsport q: ' + msg + "\n\n" unless msg == :queue_empty
 end
 

data/lib/bunny.rb

@@ -7,12 +7,16 @@ end
 
 module Bunny
 
-	class ProtocolError < StandardError; end
-	class ServerDownError < StandardError; end
 	class ConnectionError < StandardError; end
+	class ForcedChannelCloseError < StandardError; end
+	class ForcedConnectionCloseError < StandardError; end
 	class MessageError < StandardError; end
+	class ProtocolError < StandardError; end
+	class ServerDownError < StandardError; end
+	class UnsubscribeError < StandardError; end
+	class AcknowledgementError < StandardError; end
 	
-	VERSION = '0.5.3'
+	VERSION = '0.6.0'
 	
 	# Returns the Bunny version number
 
@@ -25,10 +29,9 @@ module Bunny
 	def self.new(opts = {})
 		# Set up Bunny according to AMQP spec version required
 		spec_version = opts[:spec] || '08'
-		setup(spec_version, opts)
-		
+
 		# Return client
-		@client
+		setup(spec_version, opts)
 	end
 	
 	# Runs a code block using a short-lived connection
@@ -38,13 +41,14 @@ module Bunny
 
 		# Set up Bunny according to AMQP spec version required
 		spec_version = opts[:spec] || '08'
-		setup(spec_version, opts)
+		client = setup(spec_version, opts)
 		
-    @client.start
-
-    block.call(@client)
-
-    @client.stop
+    begin
+      client.start
+      block.call(client)
+    ensure
+      client.stop
+    end
 
 		# Return success
 		:run_ok
@@ -60,8 +64,9 @@ module Bunny
 			require 'bunny/exchange08'
 			require 'bunny/queue08'
 			require 'bunny/channel08'
+			require 'bunny/subscription08'
 			
-			@client = Bunny::Client.new(opts)
+			client = Bunny::Client.new(opts)
 		else
 			# AMQP 0-9-1 specification
 			require 'qrack/qrack09'
@@ -69,11 +74,14 @@ module Bunny
 			require 'bunny/exchange09'
 			require 'bunny/queue09'
 			require 'bunny/channel09'
+			require 'bunny/subscription09'
 			
-			@client = Bunny::Client09.new(opts)
+			client = Bunny::Client09.new(opts)
 		end			
 		
 		include Qrack
+
+    client
 	end
 
-end
+end

data/lib/bunny/channel08.rb

@@ -8,7 +8,10 @@ module Bunny
 		def open
 			client.channel = self
 			client.send_frame(Qrack::Protocol::Channel::Open.new)
-      raise Bunny::ProtocolError, "Cannot open channel #{number}" unless client.next_method.is_a?(Qrack::Protocol::Channel::OpenOk)
+			
+			method = client.next_method
+			
+			client.check_response(method, Qrack::Protocol::Channel::OpenOk, "Cannot open channel #{number}")
 
 			@active = true
 			:open_ok
@@ -19,7 +22,10 @@ module Bunny
 			client.send_frame(
 	      Qrack::Protocol::Channel::Close.new(:reply_code => 200, :reply_text => 'bye', :method_id => 0, :class_id => 0)
 	    )
-	    raise Bunny::ProtocolError, "Error closing channel #{number}" unless client.next_method.is_a?(Qrack::Protocol::Channel::CloseOk)
+	
+			method = client.next_method
+			
+			client.check_response(method, Qrack::Protocol::Channel::CloseOk, "Error closing channel #{number}")
 	
 			@active = false
 			:close_ok

data/lib/bunny/channel09.rb

@@ -8,7 +8,10 @@ module Bunny
 		def open
 			client.channel = self
 			client.send_frame(Qrack::Protocol09::Channel::Open.new)
-      raise Bunny::ProtocolError, "Cannot open channel #{number}" unless client.next_method.is_a?(Qrack::Protocol09::Channel::OpenOk)
+			
+      method = client.next_method
+			
+			client.check_response(method, Qrack::Protocol09::Channel::OpenOk, "Cannot open channel #{number}")
 
 			@active = true
 			:open_ok
@@ -19,7 +22,10 @@ module Bunny
 			client.send_frame(
 	      Qrack::Protocol09::Channel::Close.new(:reply_code => 200, :reply_text => 'bye', :method_id => 0, :class_id => 0)
 	    )
-	    raise Bunny::ProtocolError, "Error closing channel #{number}" unless client.next_method.is_a?(Qrack::Protocol09::Channel::CloseOk)
+	
+	    method = client.next_method
+			
+			client.check_response(method, Qrack::Protocol09::Channel::CloseOk, "Error closing channel #{number}")
 	
 			@active = false
 			:close_ok

data/lib/bunny/client08.rb

@@ -22,10 +22,15 @@ Sets up a Bunny::Client object ready for connection to a broker/server. _Client_
 ==== OPTIONS:
 
 * <tt>:host => '_hostname_' (default = 'localhost')</tt>
-* <tt>:port => _portno_ (default = 5672)</tt>
+* <tt>:port => _portno_ (default = 5672 or 5671 if :ssl set to true)</tt>
 * <tt>:vhost => '_vhostname_' (default = '/')</tt>
 * <tt>:user => '_username_' (default = 'guest')</tt>
 * <tt>:pass => '_password_' (default = 'guest')</tt>
+* <tt>:ssl => true or false (default = false)</tt> - If set to _true_, ssl
+  encryption will be used and port will default to 5671.
+* <tt>:verify_ssl => true or false (default = true)</tt> - If ssl is enabled,
+  this will cause OpenSSL to validate the server certificate unless this
+  parameter is set to _false_.
 * <tt>:logfile => '_logfilepath_' (default = nil)</tt>
 * <tt>:logging => true or false (_default_)</tt> - If set to _true_, session information is sent
   to STDOUT if <tt>:logfile</tt> has not been specified. Otherwise, session information is written to
@@ -37,16 +42,49 @@ Sets up a Bunny::Client object ready for connection to a broker/server. _Client_
 * <tt>:frame_max => maximum frame size in bytes (default = 131072)</tt>
 * <tt>:channel_max => maximum number of channels (default = 0 no maximum)</tt>
 * <tt>:heartbeat => number of seconds (default = 0 no heartbeat)</tt>
+* <tt>:connect_timeout => number of seconds before Qrack::ConnectionTimeout is raised (default = 5)</tt>
 
 =end
 
     def initialize(opts = {})
 			super
 			@spec = '0-8'
-			@port = opts[:port] || Qrack::Protocol::PORT
+			@port = opts[:port] || (opts[:ssl] ? Qrack::Protocol::SSL_PORT : Qrack::Protocol::PORT)
       @insist = opts[:insist]
     end
 
+=begin rdoc
+
+=== DESCRIPTION:
+
+Checks response from AMQP methods and takes appropriate action
+
+=end
+
+		def check_response(received_method, expected_method, err_msg, err_class = Bunny::ProtocolError)
+			case
+				when received_method.is_a?(Qrack::Protocol::Connection::Close)
+					# Clean up the socket
+					close_socket
+					
+					raise Bunny::ForcedConnectionCloseError,
+						"Error Reply Code: #{received_method.reply_code}\nError Reply Text: #{received_method.reply_text}"
+						
+				when received_method.is_a?(Qrack::Protocol::Channel::Close)
+					# Clean up the channel
+					channel.active = false
+
+					raise Bunny::ForcedChannelCloseError,
+						"Error Reply Code: #{received_method.reply_code}\nError Reply Text: #{received_method.reply_text}"
+						
+				when !received_method.is_a?(expected_method)
+					raise err_class, err_msg
+					
+				else
+					:response_ok
+			end
+		end
+
 		def close_connection
 			# Set client channel to zero
       switch_channel(0)
@@ -54,7 +92,11 @@ Sets up a Bunny::Client object ready for connection to a broker/server. _Client_
 			send_frame(
 	      Qrack::Protocol::Connection::Close.new(:reply_code => 200, :reply_text => 'Goodbye', :class_id => 0, :method_id => 0)
 	    )
-	    raise Bunny::ProtocolError, "Error closing connection" unless next_method.is_a?(Qrack::Protocol::Connection::CloseOk)
+	
+			method = next_method
+			
+			check_response(method, Qrack::Protocol::Connection::CloseOk, "Error closing connection")
+	    
     end
 
 		def create_channel
@@ -92,8 +134,7 @@ Exchange
 =end
 
 		def exchange(name, opts = {})
-			return exchanges[name] if exchanges.has_key?(name)
-			Bunny::Exchange.new(self, name, opts)
+      exchanges[name] || Bunny::Exchange.new(self, name, opts)
 		end
 		
 		def init_connection
@@ -152,7 +193,7 @@ Exchange
       )
 
       frame = next_frame
-			raise Bunny::ProtocolError, "Connection failed - user: #{@user}, pass: #{@pass}" if frame.nil?
+			raise Bunny::ProtocolError, "Connection failed - user: #{@user}" if frame.nil?
 			
 			method = frame.payload
 
@@ -168,7 +209,7 @@ Exchange
 
       case method = next_method
       when Qrack::Protocol::Connection::OpenOk
-        return :ok
+        :ok
       when Qrack::Protocol::Connection::Redirect
 				raise Bunny::ConnectionError, "Cannot connect to the specified server - host: #{@host}, port: #{@port}" if @insist
 				
@@ -217,9 +258,9 @@ true, they are applied to the entire connection.
         Qrack::Protocol::Basic::Qos.new({ :prefetch_size => 0, :prefetch_count => 1, :global => false }.merge(opts))
       )
 
-      raise Bunny::ProtocolError,
-        "Error specifying Quality of Service" unless
- 				next_method.is_a?(Qrack::Protocol::Basic::QosOk)
+			method = next_method
+			
+			check_response(method, Qrack::Protocol::Basic::QosOk, "Error specifying Quality of Service")
 
       # return confirmation
       :qos_ok
@@ -265,9 +306,8 @@ Queue
         name = nil
       end
 
-      return queues[name] if queues.has_key?(name)
-
-      Bunny::Queue.new(self, name, opts)
+      # Queue is responsible for placing itself in the list of queues
+      queues[name] || Bunny::Queue.new(self, name, opts)
 	  end
 
 =begin rdoc
@@ -297,8 +337,11 @@ the message, potentially then delivering it to an alternative subscriber.
 			send_frame(
         Qrack::Protocol::Access::Request.new(:realm => '/data', :read => true, :write => true, :active => true, :passive => true)
       )
+
       method = next_method
-      raise Bunny::ProtocolError, 'Access denied' unless method.is_a?(Qrack::Protocol::Access::RequestOk)
+			
+			check_response(method, Qrack::Protocol::Access::RequestOk, "Access denied")
+      
       self.ticket = method.ticket
 		end
 	
@@ -384,10 +427,10 @@ after a commit.
 
 		def tx_commit
 			send_frame(Qrack::Protocol::Tx::Commit.new())
-
-			raise Bunny::ProtocolError,
-        "Error commiting transaction" unless
- 				next_method.is_a?(Qrack::Protocol::Tx::CommitOk)
+			
+			method = next_method
+			
+			check_response(method, Qrack::Protocol::Tx::CommitOk, "Error commiting transaction")
 
 			# return confirmation
 			:commit_ok
@@ -409,9 +452,9 @@ after a rollback.
 		def tx_rollback
 			send_frame(Qrack::Protocol::Tx::Rollback.new())
 
-			raise Bunny::ProtocolError,
-        "Error rolling back transaction" unless
- 				next_method.is_a?(Qrack::Protocol::Tx::RollbackOk)
+			method = next_method
+			
+			check_response(method, Qrack::Protocol::Tx::RollbackOk, "Error rolling back transaction")
 
 			# return confirmation
 			:rollback_ok
@@ -432,10 +475,10 @@ using the Commit or Rollback methods.
 
 		def tx_select
 			send_frame(Qrack::Protocol::Tx::Select.new())
+
+			method = next_method
 			
-			raise Bunny::ProtocolError,
-        "Error initiating transactions for current channel" unless
- 				next_method.is_a?(Qrack::Protocol::Tx::SelectOk)
+			check_response(method, Qrack::Protocol::Tx::SelectOk, "Error initiating transactions for current channel")
 
 			# return confirmation
 			:select_ok