bunny 0.6.3.rc2 → 0.7

data/lib/bunny/consumer.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8
+
+####################################
+# NOTE: THIS CLASS IS HERE TO MAKE #
+# TRANSITION TO AMQ CLIENT EASIER  #
+####################################
+
+require "qrack/subscription"
+
+# NOTE: This file is rather a temporary hack to fix
+# https://github.com/ruby-amqp/bunny/issues/9 then
+# some permanent solution. It's mostly copied from
+# the AMQP and AMQ Client gems. Later on we should
+# use AMQ Client directly and just inherit from
+# the AMQ::Client::Sync::Consumer class.
+
+module Bunny
+
+  # AMQP consumers are entities that handle messages delivered
+  # to them ("push API" as opposed to "pull API") by AMQP broker.
+  # Every consumer is associated with a queue. Consumers can be
+  # exclusive (no other consumers can be registered for the same
+  # queue) or not (consumers share the queue). In the case of
+  # multiple consumers per queue, messages are distributed in
+  # round robin manner with respect to channel-level prefetch
+  # setting).
+  class Consumer < Qrack::Subscription
+    def initialize(*args)
+      super(*args)
+      @consumer_tag ||= (1..32).to_a.shuffle.join
+    end
+
+    alias_method :consume, :start
+  end
+end

data/lib/bunny/exchange08.rb

@@ -1,5 +1,7 @@
+# encoding: utf-8
+
 module Bunny
-  
+
 =begin rdoc
 
 === DESCRIPTION:
@@ -28,7 +30,7 @@ target broker/server or visit the {AMQP website}[http://www.amqp.org] to find th
 specification that applies to your target broker/server.
 
 =end
-  
+
   class Exchange
 
     attr_reader :client, :type, :name, :opts, :key
@@ -36,38 +38,35 @@ specification that applies to your target broker/server.
     def initialize(client, name, opts = {})
       # check connection to server
       raise Bunny::ConnectionError, 'Not connected to server' if client.status == :not_connected
-    
+
       @client, @name, @opts = client, name, opts
-  
+
       # set up the exchange type catering for default names
-      if name.match(/^amq\./)
-        new_type = name.sub(/amq\./, '')
+      if name =~ /^amq\.(.+)$/
+        predeclared = true
+        new_type = $1
         # handle 'amq.match' default
         new_type = 'headers' if new_type == 'match'
         @type = new_type.to_sym
       else
         @type = opts[:type] || :direct
       end
-      
+
       @key = opts[:key]
       @client.exchanges[@name] ||= self
-      
+
       # ignore the :nowait option if passed, otherwise program will hang waiting for a
       # response that will not be sent by the server
       opts.delete(:nowait)
-      
-      unless name == "amq.#{type}" or name == ''
-        client.send_frame(
-          Qrack::Protocol::Exchange::Declare.new(
-            { :exchange => name, :type => type, :nowait => false }.merge(opts)
-          )
-        )
 
-				method = client.next_method
+      unless predeclared or name == ''
+        opts = { :exchange => name, :type => type, :nowait => false }.merge(opts)
+
+        client.send_frame(Qrack::Protocol::Exchange::Declare.new(opts))
 
-				client.check_response(method, Qrack::Protocol::Exchange::DeclareOk,
-				 	"Error declaring exchange #{name}: type = #{type}")
+        method = client.next_method
 
+        client.check_response(method, Qrack::Protocol::Exchange::DeclareOk, "Error declaring exchange #{name}: type = #{type}")
       end
     end
 
@@ -95,14 +94,11 @@ if successful. If an error occurs raises _Bunny_::_ProtocolError_.
       # response that will not be sent by the server
       opts.delete(:nowait)
 
-      client.send_frame(
-        Qrack::Protocol::Exchange::Delete.new({ :exchange => name, :nowait => false }.merge(opts))
-      )
+      client.send_frame(Qrack::Protocol::Exchange::Delete.new({ :exchange => name, :nowait => false }.merge(opts)))
 
-			method = client.next_method
+      method = client.next_method
 
-			client.check_response(method, Qrack::Protocol::Exchange::DeleteOk,
-			 	"Error deleting exchange #{name}")
+      client.check_response(method, Qrack::Protocol::Exchange::DeleteOk, "Error deleting exchange #{name}")
 
       client.exchanges.delete(name)
 
@@ -122,6 +118,7 @@ if any, is committed.
 
 * <tt>:key => 'routing_key'</tt> - Specifies the routing key for the message. The routing key is
   used for routing messages depending on the exchange configuration.
+* <tt>:content_type => 'content/type'</tt> - Specifies the content type to use for the message.
 * <tt>:mandatory => true or false (_default_)</tt> - Tells the server how to react if the message
   cannot be routed to a queue. If set to _true_, the server will return an unroutable message
   with a Return method. If this flag is zero, the server silently drops the message.
@@ -130,8 +127,8 @@ if any, is committed.
   undeliverable message with a Return method. If set to _false_, the server will queue the message,
   but with no guarantee that it will ever be consumed.
 * <tt>:persistent => true or false (_default_)</tt> - Tells the server whether to persist the message
-  If set to _true_, the message will be persisted to disk and not lost if the server restarts. 
-  If set to _false_, the message will not be persisted across server restart. Setting to _true_ 
+  If set to _true_, the message will be persisted to disk and not lost if the server restarts.
+  If set to _false_, the message will not be persisted across server restart. Setting to _true_
   incurs a performance penalty as there is an extra cost associated with disk access.
 
 ==== RETURNS:
@@ -144,25 +141,24 @@ nil
       opts = opts.dup
       out = []
 
-			# Set up options
-			routing_key = opts.delete(:key) || key
-			mandatory = opts.delete(:mandatory)
-			immediate = opts.delete(:immediate)
-			delivery_mode = opts.delete(:persistent) ? 2 : 1
-
-      out << Qrack::Protocol::Basic::Publish.new(
-        { :exchange => name,
-					:routing_key => routing_key,
-					:mandatory => mandatory,
-					:immediate => immediate }
-      )
+      # Set up options
+      routing_key = opts.delete(:key) || key
+      mandatory = opts.delete(:mandatory)
+      immediate = opts.delete(:immediate)
+      delivery_mode = opts.delete(:persistent) ? 2 : 1
+      content_type = opts.delete(:content_type) || 'application/octet-stream'
+
+      out << Qrack::Protocol::Basic::Publish.new({ :exchange => name,
+                                                   :routing_key => routing_key,
+                                                   :mandatory => mandatory,
+                                                   :immediate => immediate })
       data = data.to_s
       out << Qrack::Protocol::Header.new(
         Qrack::Protocol::Basic,
         data.bytesize, {
-          :content_type  => 'application/octet-stream',
+          :content_type  => content_type,
           :delivery_mode => delivery_mode,
-          :priority      => 0 
+          :priority      => 0
         }.merge(opts)
       )
       out << Qrack::Transport::Body.new(data)
@@ -171,5 +167,5 @@ nil
     end
 
   end
-  
+
 end

data/lib/bunny/exchange09.rb

@@ -1,34 +1,29 @@
-module Bunny
-  
-=begin rdoc
-
-=== DESCRIPTION:
-
-*Exchanges* are the routing and distribution hub of AMQP. All messages that Bunny sends
-to an AMQP broker/server _have_ to pass through an exchange in order to be routed to a
-destination queue. The AMQP specification defines the types of exchange that you can create.
-
-At the time of writing there are four (4) types of exchange defined -
+# encoding: utf-8
 
-* <tt>:direct</tt>
-* <tt>:fanout</tt>
-* <tt>:topic</tt>
-* <tt>:headers</tt>
-
-AMQP-compliant brokers/servers are required to provide default exchanges for the _direct_ and
-_fanout_ exchange types. All default exchanges are prefixed with <tt>'amq.'</tt>, for example -
-
-* <tt>amq.direct</tt>
-* <tt>amq.fanout</tt>
-* <tt>amq.topic</tt>
-* <tt>amq.match</tt> or <tt>amq.headers</tt>
-
-If you want more information about exchanges, please consult the documentation for your
-target broker/server or visit the {AMQP website}[http://www.amqp.org] to find the version of the
-specification that applies to your target broker/server.
+module Bunny
 
-=end
-  
+  # *Exchanges* are the routing and distribution hub of AMQP. All messages that Bunny sends
+  # to an AMQP broker/server @have_to pass through an exchange in order to be routed to a
+  # destination queue. The AMQP specification defines the types of exchange that you can create.
+  #
+  # At the time of writing there are four (4) types of exchange defined:
+  #
+  # * @:direct@
+  # * @:fanout@
+  # * @:topic@
+  # * @:headers@
+  #
+  # AMQP-compliant brokers/servers are required to provide default exchanges for the @direct@ and
+  # @fanout@ exchange types. All default exchanges are prefixed with @'amq.'@, for example:
+  #
+  # * @amq.direct@
+  # * @amq.fanout@
+  # * @amq.topic@
+  # * @amq.match@ or @amq.headers@
+  #
+  # If you want more information about exchanges, please consult the documentation for your
+  # target broker/server or visit the "AMQP website":http://www.amqp.org to find the version of the
+  # specification that applies to your target broker/server.
   class Exchange09
 
     attr_reader :client, :type, :name, :opts, :key
@@ -36,74 +31,63 @@ specification that applies to your target broker/server.
     def initialize(client, name, opts = {})
       # check connection to server
       raise Bunny::ConnectionError, 'Not connected to server' if client.status == :not_connected
-    
+
       @client, @name, @opts = client, name, opts
-  
+
       # set up the exchange type catering for default names
-      if name.match(/^amq\./)
-        new_type = name.sub(/amq\./, '')
+      if name =~ /^amq\.(.+)$/
+        predeclared = true
+        new_type = $1
         # handle 'amq.match' default
         new_type = 'headers' if new_type == 'match'
         @type = new_type.to_sym
       else
         @type = opts[:type] || :direct
       end
-      
+
       @key = opts[:key]
       @client.exchanges[@name] ||= self
-      
+
       # ignore the :nowait option if passed, otherwise program will hang waiting for a
       # response that will not be sent by the server
       opts.delete(:nowait)
-      
-      unless name == "amq.#{type}" or name == ''
-        client.send_frame(
-          Qrack::Protocol09::Exchange::Declare.new(
-            { :exchange => name, :type => type, :nowait => false,
-	 						:deprecated_ticket => 0, :deprecated_auto_delete => false, :deprecated_internal => false }.merge(opts)
-          )
-        )
+
+      unless predeclared or name == ''
+        opts = {
+          :exchange => name, :type => type, :nowait => false,
+          :deprecated_ticket => 0, :deprecated_auto_delete => false, :deprecated_internal => false
+        }.merge(opts)
+
+        client.send_frame(Qrack::Protocol09::Exchange::Declare.new(opts))
 
         method = client.next_method
 
-				client.check_response(method, Qrack::Protocol09::Exchange::DeclareOk,
-				 	"Error declaring exchange #{name}: type = #{type}")
-				
+        client.check_response(method, Qrack::Protocol09::Exchange::DeclareOk, "Error declaring exchange #{name}: type = #{type}")
       end
     end
 
-=begin rdoc
-
-=== DESCRIPTION:
-
-Requests that an exchange is deleted from broker/server. Removes reference from exchanges
-if successful. If an error occurs raises _Bunny_::_ProtocolError_.
-
-==== Options:
-
-* <tt>:if_unused => true or false (_default_)</tt> - If set to _true_, the server will only
-  delete the exchange if it has no queue bindings. If the exchange has queue bindings the
-  server does not delete it but raises a channel exception instead.
-* <tt>:nowait => true or false (_default_)</tt> - Ignored by Bunny, always _false_.
-
-==== Returns:
-
-<tt>:delete_ok</tt> if successful
-=end
-
+    # Requests that an exchange is deleted from broker/server. Removes reference from exchanges
+    # if successful. If an error occurs raises {Bunny::ProtocolError}.
+    #
+    # @option opts [Boolean] :if_unused (false)
+    #   If set to @true@, the server will only delete the exchange if it has no queue bindings. If the exchange has queue bindings the server does not delete it but raises a channel exception instead.
+    #
+    # @option opts [Boolean] :nowait (false)
+    #   Ignored by Bunny, always @false@.
+    #
+    # @return [Symbol] @:delete_ok@ if successful.
     def delete(opts = {})
       # ignore the :nowait option if passed, otherwise program will hang waiting for a
       # response that will not be sent by the server
       opts.delete(:nowait)
 
-      client.send_frame(
-        Qrack::Protocol09::Exchange::Delete.new({ :exchange => name, :nowait => false, :deprecated_ticket => 0 }.merge(opts))
-      )
+      opts = { :exchange => name, :nowait => false, :deprecated_ticket => 0 }.merge(opts)
+
+      client.send_frame(Qrack::Protocol09::Exchange::Delete.new(opts))
 
       method = client.next_method
 
-			client.check_response(method, Qrack::Protocol09::Exchange::DeleteOk,
-			 	"Error deleting exchange #{name}")
+      client.check_response(method, Qrack::Protocol09::Exchange::DeleteOk, "Error deleting exchange #{name}")
 
       client.exchanges.delete(name)
 
@@ -111,67 +95,65 @@ if successful. If an error occurs raises _Bunny_::_ProtocolError_.
       :delete_ok
     end
 
-=begin rdoc
-
-=== DESCRIPTION:
-
-Publishes a message to a specific exchange. The message will be routed to queues as defined
-by the exchange configuration and distributed to any active consumers when the transaction,
-if any, is committed.
-
-==== OPTIONS:
-
-* <tt>:key => 'routing_key'</tt> - Specifies the routing key for the message. The routing key is
-  used for routing messages depending on the exchange configuration.
-* <tt>:mandatory => true or false (_default_)</tt> - Tells the server how to react if the message
-  cannot be routed to a queue. If set to _true_, the server will return an unroutable message
-  with a Return method. If this flag is zero, the server silently drops the message.
-* <tt>:immediate => true or false (_default_)</tt> - Tells the server how to react if the message
-  cannot be routed to a queue consumer immediately. If set to _true_, the server will return an
-  undeliverable message with a Return method. If set to _false_, the server will queue the message,
-  but with no guarantee that it will ever be consumed.
-* <tt>:persistent => true or false (_default_)</tt> - Tells the server whether to persist the message
-  If set to _true_, the message will be persisted to disk and not lost if the server restarts. 
-  If set to _false_, the message will not be persisted across server restart. Setting to _true_ 
-  incurs a performance penalty as there is an extra cost associated with disk access.
-
-==== RETURNS:
-
-nil
-
-=end
-
+    # Publishes a message to a specific exchange. The message will be routed to queues as defined
+    # by the exchange configuration and distributed to any active consumers when the transaction,
+    # if any, is committed.
+    #
+    # @option opts [String] :key
+    #   Specifies the routing key for the message. The routing key is
+    #   used for routing messages depending on the exchange configuration.
+    #
+    # @option opts [String] :content_type
+    #   Specifies the content type for the message.
+    #
+    # @option opts [Boolean] :mandatory (false)
+    #   Tells the server how to react if the message cannot be routed to a queue.
+    #   If set to @true@, the server will return an unroutable message
+    #   with a Return method. If this flag is zero, the server silently drops the message.
+    #
+    # @option opts [Boolean] :immediate (false)
+    #   Tells the server how to react if the message cannot be routed to a queue consumer
+    #   immediately. If set to @true@, the server will return an undeliverable message with
+    #   a Return method. If set to @false@, the server will queue the message, but with no
+    #   guarantee that it will ever be consumed.
+    #
+    # @option opts [Boolean] :persistent (false)
+    #   Tells the server whether to persist the message. If set to @true@, the message will
+    #   be persisted to disk and not lost if the server restarts. If set to @false@, the message
+    #   will not be persisted across server restart. Setting to @true@ incurs a performance penalty
+    #   as there is an extra cost associated with disk access.
+    #
+    # @return [NilClass] nil
     def publish(data, opts = {})
       opts = opts.dup
       out = []
 
-			# Set up options
-			routing_key = opts.delete(:key) || key
-			mandatory = opts.delete(:mandatory)
-			immediate = opts.delete(:immediate)
-			delivery_mode = opts.delete(:persistent) ? 2 : 1
-
-			out << Qrack::Protocol09::Basic::Publish.new(
-			  { :exchange => name,
-					:routing_key => routing_key,
-					:mandatory => mandatory,
-					:immediate => immediate,
-					:deprecated_ticket => 0 }
-			)
-			data = data.to_s
-			out << Qrack::Protocol09::Header.new(
-			  Qrack::Protocol09::Basic,
-			  data.bytesize, {
-			    :content_type  => 'application/octet-stream',
-			    :delivery_mode => delivery_mode,
-			    :priority      => 0 
-			  }.merge(opts)
-			)
-			out << Qrack::Transport09::Body.new(data)
+      # Set up options
+      routing_key = opts.delete(:key) || key
+      mandatory = opts.delete(:mandatory)
+      immediate = opts.delete(:immediate)
+      delivery_mode = opts.delete(:persistent) ? 2 : 1
+      content_type = opts.delete(:content_type) || 'application/octet-stream'
+
+      out << Qrack::Protocol09::Basic::Publish.new({ :exchange => name,
+                                                     :routing_key => routing_key,
+                                                     :mandatory => mandatory,
+                                                     :immediate => immediate,
+                                                     :deprecated_ticket => 0 })
+      data = data.to_s
+      out << Qrack::Protocol09::Header.new(
+                                           Qrack::Protocol09::Basic,
+                                           data.bytesize, {
+                                             :content_type  => content_type,
+                                             :delivery_mode => delivery_mode,
+                                             :priority      => 0
+                                           }.merge(opts)
+                                           )
+      out << Qrack::Transport09::Body.new(data)
 
       client.send_frame(*out)
     end
 
   end
-  
+
 end