bunny 1.4.1 → 1.5.0.pre1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 057bcd48a6c1234452c4e61915c28b55d5248f46
-  data.tar.gz: 6c28bc03055ce2c4b8a3b4d30488619b4ccc562d
+  metadata.gz: f2e3f4cbc8cb08e8cebce0b4ae4b87056744fcf4
+  data.tar.gz: 17d65911fb9a606ea5d5f7b9af0f21dd811266bf
 SHA512:
-  metadata.gz: 68d2af85cca78d231f02e8833afffdfc11c6b1dbbba3e8110d352b20f0412613c194d3353afaa5646dd15026f59cd5bd4a3ddbf87c8b9915ec0c6304c8b0e965
-  data.tar.gz: 6fcdeea240c210a56a3c0727447d328ce85325dead5fae8067b9a58da7584be4f4156ba78befc92f505587d7dd264b9ca1a3d319794f507ec1aede68fde8c527
+  metadata.gz: d16bfeab544fb842e3030bf1aa6fd7e7ed4a97966577934f45b8d5988e2fbd4d33125a1c601c8a44d6ef150b3707df52da07d5ff6519c64a461bdaad1869d6ed
+  data.tar.gz: 53766bae9993a4e3b5d064101d28023c435ea19ad051f2b05050674b1609fc4e7efbf644852630b2a7b58ddab362cde94d8360ce1d637d528ea83ed7350eb63d

data/.gitignore

@@ -20,3 +20,4 @@ repl-*
 debug/*
 *.dump
 deploy.docs.sh
+.ruby-version

data/.travis.yml

@@ -17,7 +17,7 @@ services:
 branches:
   only:
     - master
-    - 1.1.x-stable
+    - 1.4.x-stable
 matrix:
   allow_failures:
     - rvm: rbx

data/ChangeLog.md

@@ -1,11 +1,25 @@
-## Changes between Bunny 1.4.0 and 1.4.1
+## Changes between Bunny 1.4.0 and 1.5.0
 
-### Prevent Default Channel From Being Re-opened Twice on Recovery
+### Convenience Method for Temporary (Server-named, Exclusive) Queue Declaration
 
-Bunny's default channel (a relic from the `0.7.x` days when channels were not
-even part of the API) is no longer recovered one time too many.
+`Bunny::Channel#temporary_queue` is a convenience method that declares a new
+server-named exclusive queue:
 
-Contributed by Carl Chatfield.
+``` ruby
+q = ch.temporary_queue
+```
+
+Contributed by Daniel Schierbeck (Zendesk).
+
+
+### Host Lists
+
+It is now possible to pass the `:hosts` option to `Bunny.new`/`Bunny::Session#initialize`.
+When connection to RabbitMQ (including during connection recovery), a random host
+will be chosen from the list.
+
+Connection shuffling and robustness improvements are contributed by
+Andre Foeken (Nedap).
 
 
 ## Changes between Bunny 1.3.0 and 1.4.0

data/README.md

@@ -64,11 +64,11 @@ Bunny `0.7.x` and earlier versions support RabbitMQ 1.x and 2.x.
 
 ## Project Maturity
 
-Bunny is a mature library (started in early 2009) library with
+Bunny is a mature library (started in early 2009) with
 a stable public API.
 
 Before version 0.9, **a lot** of functionality was missing.  Version
-0.9 can be considered to be "second birthday" for Bunny as it was
+0.9 can be considered to be a "second birthday" for Bunny as it was
 rewritten from scratch with over a dozen of preview releases over the
 course of about a year.
 
@@ -95,7 +95,7 @@ gem install bunny
 To use Bunny in a project managed with Bundler:
 
 ``` ruby
-gem "bunny", "~> 1.3.1"
+gem "bunny", "~> 1.4.0"
 ```
 
 
@@ -191,6 +191,26 @@ try to explain what behavior you expected and why. Bonus points for
 contributing failing test cases.
 
 
+### Running the specs
+
+The cleanest way to get the specs running is by starting a clean rabbitmq server
+node on your machine specifically for the bunny specs.
+
+Make sure you have a recent version of RabbitMQ (> 3.2) and run the following command
+from the base directory of the gem:
+
+`RABBITMQ_NODENAME=bunny RABBITMQ_CONFIG_FILE=./spec/config/rabbitmq RABBITMQ_ENABLED_PLUGINS_FILE=./spec/config/enabled_plugins rabbitmq-server`
+
+> The specs use the Rabbitmq management plugin and require an SSL port to be available. The config files in the spec/config directory enable these. Please note that this config uses verify_none because the certificates are expired.
+
+Next up you'll need to prepare your node for the specs (Only once):
+
+`RABBITMQ_NODENAME=bunny ./bin/ci/before_build.sh`
+
+And then run the specs:
+
+`RABBITMQ_NODENAME=bunny rspec`
+
 ## Other Ruby RabbitMQ Clients
 
 Other widely used Ruby RabbitMQ clients are [March

data/examples/guides/extensions/basic_nack.rb

@@ -18,7 +18,7 @@ q    = ch.queue("", :exclusive => true)
 end
 
 20.times do
-  delivery_info, _, _ = q.pop(:ack => true)
+  delivery_info, _, _ = q.pop(:manual_ack => true)
 
   if delivery_info.delivery_tag == 20
     # requeue them all at once with basic.nack

data/examples/guides/extensions/dead_letter_exchange.rb

@@ -20,7 +20,7 @@ dlq  = ch.queue("", :exclusive => true).bind(dlx)
 x.publish("")
 sleep 0.2
 
-delivery_info, _, _ = q.pop(:ack => true)
+delivery_info, _, _ = q.pop(:manual_ack => true)
 puts "#{dlq.message_count} messages dead lettered so far"
 puts "Rejecting a message"
 ch.nack(delivery_info.delivery_tag)

data/examples/guides/queues/redeliveries.rb

@@ -29,7 +29,7 @@ x   = ch3.direct("amq.direct")
 q1  = ch1.queue("bunny.examples.acknowledgements.explicit", :auto_delete => false)
 q1.purge
 
-q1.bind(x).subscribe(:ack => true, :block => false) do |delivery_info, properties, payload|
+q1.bind(x).subscribe(:manual_ack => true, :block => false) do |delivery_info, properties, payload|
   # do some work
   sleep(0.2)
 
@@ -46,7 +46,7 @@ q1.bind(x).subscribe(:ack => true, :block => false) do |delivery_info, propertie
 end
 
 q2   = ch2.queue("bunny.examples.acknowledgements.explicit", :auto_delete => false)
-q2.bind(x).subscribe(:ack => true, :block => false) do |delivery_info, properties, payload|
+q2.bind(x).subscribe(:manual_ack => true, :block => false) do |delivery_info, properties, payload|
   # do some work
   sleep(0.2)
 

data/lib/bunny.rb

@@ -17,7 +17,7 @@ begin
   require "openssl"
 
   require "bunny/ssl_socket"
-rescue LoadError => e
+rescue LoadError
   # no-op
 end
 

data/lib/bunny/channel.rb

@@ -37,11 +37,10 @@ module Bunny
   # Channels can be opened either via `Bunny::Session#create_channel` (sufficient in the majority
   # of cases) or by instantiating `Bunny::Channel` directly:
   #
-  # @example Using {Bunny::Session#create_channel}:
-  #   conn = Bunny.new
-  #   conn.start
+  #     conn = Bunny.new
+  #     conn.start
   #
-  #   ch   = conn.create_channel
+  #     ch   = conn.create_channel
   #
   # This will automatically allocate a channel id.
   #
@@ -51,10 +50,8 @@ module Bunny
   # closed, too. Closed channels can no longer be used. Attempts to use them will raise
   # {Bunny::ChannelAlreadyClosed}.
   #
-  # @example
-  #
-  #   ch  = conn.create_channel
-  #   ch.close
+  #     ch = conn.create_channel
+  #     ch.close
   #
   # ## Higher-level API
   #
@@ -404,6 +401,16 @@ module Bunny
       register_queue(q)
     end
 
+    # Declares a new server-named queue that is automatically deleted when the
+    # connection is closed.
+    #
+    # @return [Bunny::Queue] Queue that was declared
+    # @see #queue
+    # @api public
+    def temporary_queue(opts = {})
+      queue("", opts.merge(:exclusive => true))
+    end
+
     # @endgroup
 
 
@@ -566,7 +573,8 @@ module Bunny
     # @param [String] queue Queue name
     # @param [Hash] opts Options
     #
-    # @option opts [Boolean] :ack (true) Will this message be acknowledged manually?
+    # @option opts [Boolean] :ack (true) [DEPRECATED] Use :manual_ack instead
+    # @option opts [Boolean] :manual_ack (true) Will this message be acknowledged manually?
     #
     # @return [Array] A triple of delivery info, message properties and message content
     #
@@ -575,15 +583,20 @@ module Bunny
     #   conn.start
     #   ch   = conn.create_channel
     #   # here we assume the queue already exists and has messages
-    #   delivery_info, properties, payload = ch.basic_get("bunny.examples.queue1", :ack => true)
+    #   delivery_info, properties, payload = ch.basic_get("bunny.examples.queue1", :manual_ack => true)
     #   ch.acknowledge(delivery_info.delivery_tag)
     # @see Bunny::Queue#pop
     # @see http://rubybunny.info/articles/queues.html Queues and Consumers guide
     # @api public
-    def basic_get(queue, opts = {:ack => true})
+    def basic_get(queue, opts = {:manual_ack => true})
       raise_if_no_longer_open!
 
-      @connection.send_frame(AMQ::Protocol::Basic::Get.encode(@id, queue, !(opts[:ack])))
+      unless opts[:ack].nil?
+        warn "[DEPRECATION] `:ack` is deprecated.  Please use `:manual_ack` instead."
+        opts[:manual_ack] = opts[:ack]
+      end
+
+      @connection.send_frame(AMQ::Protocol::Basic::Get.encode(@id, queue, !(opts[:manual_ack])))
       # this is a workaround for the edge case when basic_get is called in a tight loop
       # and network goes down we need to perform recovery. The problem is, basic_get will
       # keep blocking the thread that calls it without clear way to constantly unblock it
@@ -675,7 +688,7 @@ module Bunny
     #
     #   ch    = conn.create_channel
     #   # we assume the queue exists and has messages
-    #   delivery_info, properties, payload = ch.basic_get("bunny.examples.queue3", :ack => true)
+    #   delivery_info, properties, payload = ch.basic_get("bunny.examples.queue3", :manual_ack => true)
     #   ch.basic_reject(delivery_info.delivery_tag, true)
     #
     # @see Bunny::Channel#basic_nack
@@ -710,7 +723,7 @@ module Bunny
     #
     #   ch    = conn.create_channel
     #   # we assume the queue exists and has messages
-    #   delivery_info, properties, payload = ch.basic_get("bunny.examples.queue3", :ack => true)
+    #   delivery_info, properties, payload = ch.basic_get("bunny.examples.queue3", :manual_ack => true)
     #   ch.basic_ack(delivery_info.delivery_tag)
     #
     # @example Ack multiple messages fetched via basic.get
@@ -719,9 +732,9 @@ module Bunny
     #
     #   ch    = conn.create_channel
     #   # we assume the queue exists and has messages
-    #   _, _, payload1 = ch.basic_get("bunny.examples.queue3", :ack => true)
-    #   _, _, payload2 = ch.basic_get("bunny.examples.queue3", :ack => true)
-    #   delivery_info, properties, payload3 = ch.basic_get("bunny.examples.queue3", :ack => true)
+    #   _, _, payload1 = ch.basic_get("bunny.examples.queue3", :manual_ack => true)
+    #   _, _, payload2 = ch.basic_get("bunny.examples.queue3", :manual_ack => true)
+    #   delivery_info, properties, payload3 = ch.basic_get("bunny.examples.queue3", :manual_ack => true)
     #   # ack all fetched messages up to payload3
     #   ch.basic_ack(delivery_info.delivery_tag, true)
     #
@@ -769,7 +782,7 @@ module Bunny
     #
     #   ch    = conn.create_channel
     #   # we assume the queue exists and has messages
-    #   delivery_info, properties, payload = ch.basic_get("bunny.examples.queue3", :ack => true)
+    #   delivery_info, properties, payload = ch.basic_get("bunny.examples.queue3", :manual_ack => true)
     #   ch.basic_nack(delivery_info.delivery_tag, false, true)
     #
     #
@@ -779,9 +792,9 @@ module Bunny
     #
     #   ch    = conn.create_channel
     #   # we assume the queue exists and has messages
-    #   _, _, payload1 = ch.basic_get("bunny.examples.queue3", :ack => true)
-    #   _, _, payload2 = ch.basic_get("bunny.examples.queue3", :ack => true)
-    #   delivery_info, properties, payload3 = ch.basic_get("bunny.examples.queue3", :ack => true)
+    #   _, _, payload1 = ch.basic_get("bunny.examples.queue3", :manual_ack => true)
+    #   _, _, payload2 = ch.basic_get("bunny.examples.queue3", :manual_ack => true)
+    #   delivery_info, properties, payload3 = ch.basic_get("bunny.examples.queue3", :manual_ack => true)
     #   # requeue all fetched messages up to payload3
     #   ch.basic_nack(delivery_info.delivery_tag, true, true)
     #

data/lib/bunny/exceptions.rb

@@ -4,6 +4,12 @@ module Bunny
   class Exception < ::StandardError
   end
 
+  class HostListDepleted < Exception
+    def initialize
+      super("No more hosts to try in the supplied list of hosts")
+    end
+  end
+
   # Indicates a network failure. If automatic network
   # recovery mode is enabled, these will be typically handled
   # by the client itself.
@@ -54,7 +60,6 @@ module Bunny
     end
   end
 
-
   # Raised when TCP connection to RabbitMQ fails because of an unresolved
   # hostname, connectivity problem, etc
   class TCPConnectionFailed < Exception
@@ -67,7 +72,17 @@ module Bunny
           when Exception then
             e.message
           end
-      super("Could not establish TCP connection to #{hostname}:#{port}: #{m}")
+      if hostname && port
+        super("Could not establish TCP connection to #{hostname}:#{port}: #{m}")
+      else
+        super(m)
+      end
+    end
+  end
+
+  class TCPConnectionFailedForAllHosts < TCPConnectionFailed
+    def initialize
+      super("Could not establish TCP connection to any of the configured hosts", nil, nil)
     end
   end
 

data/lib/bunny/exchange.rb

@@ -1,5 +1,3 @@
-require "bunny/compatibility"
-
 module Bunny
   # Represents AMQP 0.9.1 exchanges.
   #
@@ -7,9 +5,6 @@ module Bunny
   # @see http://rubybunny.info/articles/extensions.html RabbitMQ Extensions guide
   class Exchange
 
-    include Bunny::Compatibility
-
-
     #
     # API
     #
@@ -33,12 +28,12 @@ module Bunny
     attr_accessor :opts
 
 
-    # The default exchange. Default exchange is a direct exchange that is predefined.
-    # It cannot be removed. Every queue is bind to this (direct) exchange by default with
-    # the following routing semantics: messages will be routed to the queue withe same
-    # same name as message's routing key. In other words, if a message is published with
-    # a routing key of "weather.usa.ca.sandiego" and there is a queue Q with this name,
-    # that message will be routed to Q.
+    # The default exchange. This exchange is a direct exchange that is predefined by the broker
+    # and that cannot be removed. Every queue is bound to this exchange by default with
+    # the following routing semantics: messages will be routed to the queue with the same
+    # name as the message's routing key. In other words, if a message is published with
+    # a routing key of "weather.usa.ca.sandiego" and there is a queue with this name,
+    # the message will be routed to the queue.
     #
     # @param [Bunny::Channel] channel_or_connection Channel to use. {Bunny::Session} instances
     #                                               are only supported for backwards compatibility.
@@ -46,11 +41,11 @@ module Bunny
     # @example Publishing a messages to the tasks queue
     #   channel     = Bunny::Channel.new(connection)
     #   tasks_queue = channel.queue("tasks")
-    #   Bunny::Exchange.default(channel).publish("make clean", routing_key => "tasks")
+    #   Bunny::Exchange.default(channel).publish("make clean", :routing_key => "tasks")
     #
     # @see http://rubybunny.info/articles/exchanges.html Exchanges and Publishing guide
     # @see http://www.rabbitmq.com/resources/specs/amqp0-9-1.pdf AMQP 0.9.1 specification (Section 2.1.2.4)
-    # @note Do not confuse default exchange with amq.direct: amq.direct is a pre-defined direct
+    # @note Do not confuse the default exchange with amq.direct: amq.direct is a pre-defined direct
     #       exchange that doesn't have any special routing semantics.
     # @return [Exchange] An instance that corresponds to the default exchange (of type direct).
     # @api public
@@ -58,11 +53,10 @@ module Bunny
       self.new(channel_or_connection, :direct, AMQ::Protocol::EMPTY_STRING, :no_declare => true)
     end
 
-    # @param [Bunny::Channel] channel_or_connection Channel this exchange will use. {Bunny::Session} instances are supported only for
-    #                                               backwards compatibility with 0.8.
-    # @param [Symbol,String] type                   Exchange type
-    # @param [String] name                          Exchange name
-    # @param [Hash] opts                            Exchange properties
+    # @param [Bunny::Channel] channel Channel this exchange will use.
+    # @param [Symbol,String] type     Exchange type
+    # @param [String] name            Exchange name
+    # @param [Hash] opts              Exchange properties
     #
     # @option opts [Boolean] :durable (false)      Should this exchange be durable?
     # @option opts [Boolean] :auto_delete (false)  Should this exchange be automatically deleted when it is no longer used?
@@ -75,10 +69,8 @@ module Bunny
     # @see http://rubybunny.info/articles/exchanges.html Exchanges and Publishing guide
     # @see http://rubybunny.info/articles/extensions.html RabbitMQ Extensions guide
     # @api public
-    def initialize(channel_or_connection, type, name, opts = {})
-      # old Bunny versions pass a connection here. In that case,
-      # we just use default channel from it. MK.
-      @channel          = channel_from(channel_or_connection)
+    def initialize(channel, type, name, opts = {})
+      @channel          = channel
       @name             = name
       @type             = type
       @options          = self.class.add_default_options(name, opts)

data/lib/bunny/queue.rb

@@ -1,4 +1,3 @@
-require "bunny/compatibility"
 require "bunny/get_response"
 
 module Bunny
@@ -8,9 +7,6 @@ module Bunny
   # @see http://rubybunny.info/articles/extensions.html RabbitMQ Extensions guide
   class Queue
 
-    include Bunny::Compatibility
-
-
     #
     # API
     #
@@ -22,8 +18,7 @@ module Bunny
     # @return [Hash] Options this queue was created with
     attr_reader :options
 
-    # @param [Bunny::Channel] channel_or_connection Channel this queue will use. {Bunny::Session} instances are supported only for
-    #                                               backwards compatibility with 0.8.
+    # @param [Bunny::Channel] channel Channel this queue will use.
     # @param [String] name                          Queue name. Pass an empty string to make RabbitMQ generate a unique one.
     # @param [Hash] opts                            Queue properties
     #
@@ -36,10 +31,10 @@ module Bunny
     # @see http://rubybunny.info/articles/queues.html Queues and Consumers guide
     # @see http://rubybunny.info/articles/extensions.html RabbitMQ Extensions guide
     # @api public
-    def initialize(channel_or_connection, name = AMQ::Protocol::EMPTY_STRING, opts = {})
+    def initialize(channel, name = AMQ::Protocol::EMPTY_STRING, opts = {})
       # old Bunny versions pass a connection here. In that case,
       # we just use default channel from it. MK.
-      @channel          = channel_from(channel_or_connection)
+      @channel          = channel
       @name             = name
       @options          = self.class.add_default_options(name, opts)
       @consumers        = Hash.new
@@ -152,6 +147,7 @@ module Bunny
     #
     # @param [Hash] opts Options
     #
+    # @option opts [Boolean] :ack (false) [DEPRECATED] Use :manual_ack instead
     # @option opts [Boolean] :manual_ack (false) Will this consumer use manual acknowledgements?
     # @option opts [Boolean] :exclusive (false) Should this consumer be exclusive for this queue?
     # @option opts [Boolean] :block (false) Should the call block calling thread?
@@ -163,17 +159,22 @@ module Bunny
     # @api public
     def subscribe(opts = {
                     :consumer_tag    => @channel.generate_consumer_tag,
-                    :ack             => false,
+                    :manual_ack      => false,
                     :exclusive       => false,
                     :block           => false,
                     :on_cancellation => nil
                   }, &block)
 
+      unless opts[:ack].nil?
+        warn "[DEPRECATION] `:ack` is deprecated.  Please use `:manual_ack` instead."
+        opts[:manual_ack] = opts[:ack]
+      end
+
       ctag       = opts.fetch(:consumer_tag, @channel.generate_consumer_tag)
       consumer   = Consumer.new(@channel,
                                 self,
                                 ctag,
-                                !(opts[:ack] || opts[:manual_ack]),
+                                !opts[:manual_ack],
                                 opts[:exclusive],
                                 opts[:arguments])
 
@@ -208,7 +209,8 @@ module Bunny
 
     # @param [Hash] opts Options
     #
-    # @option opts [Boolean] :ack (false) Will the message be acknowledged manually?
+    # @option opts [Boolean] :ack (false) [DEPRECATED] Use :manual_ack instead
+    # @option opts [Boolean] :manual_ack (false) Will the message be acknowledged manually?
     #
     # @return [Array] Triple of delivery info, message properties and message content.
     #                 If the queue is empty, all three will be nils.
@@ -229,7 +231,12 @@ module Bunny
     #
     #   puts "This is the message: " + payload + "\n\n"
     #   conn.close
-    def pop(opts = {:ack => false}, &block)
+    def pop(opts = {:manual_ack => false}, &block)
+      unless opts[:ack].nil?
+        warn "[DEPRECATION] `:ack` is deprecated.  Please use `:manual_ack` instead."
+        opts[:manual_ack] = opts[:ack]
+      end
+
       get_response, properties, content = @channel.basic_get(@name, opts)
 
       if block