bunny 2.19.0 → 2.20.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6de535f1d386dbf46fd89a733c1c44915280af55c3cc3cc56467abe0ead9c24
-  data.tar.gz: 6048aea84078fb8995718ed774d9a3956dc91645b24c09382cd54283b444aabe
+  metadata.gz: '0638b435d0f724c5b9566797df9ba50e94144f0bb82f60b01e5d794bce868512'
+  data.tar.gz: c278e7122a90653738ff68b845509873ed0e7ca7b5759e0a33a7157725bcf650
 SHA512:
-  metadata.gz: b3575710f81dabf6c116c92c4ac1807a29f0c0bcd1bd5fb35ae1fd9dd468df193efac49d0ad5e77ef04ecc53e97b9b4e13e70f4207972ba0c2335c28afcd6c9b
-  data.tar.gz: 8b90dd4da7dab28b529e78cf1282656ca1904432b1017ee5574545c1972315f975d175c718481372604b61796e9ae56b293a342dcba800fa0929e4b80cd7a3c4
+  metadata.gz: 44e1c56c0500d2e375a22e6349401e25d9e1c8f9e553b91df0ed4ac07ee80167cd50e28f6191e549961a31c7795e07a740949b72c971178b2f35060a221cc312
+  data.tar.gz: c0cbd8f1d0d6b6973f6ba6e3cc6140dbaa6843fe18cb00372e5b3a01bbdad5f1c265867b8314937ed711671266fb14fb281bbf739b2510a91fad4404b6ba4042

data/README.md

@@ -7,7 +7,7 @@ have any heavyweight dependencies.
 
 ## I Know What RabbitMQ and Bunny are, How Do I Get Started?
 
-[Right here](http://rubybunny.info/articles/getting_started.html)!
+[Right here](https://www.rabbitmq.com/getstarted.html)!
 
 
 ## What is Bunny Good For?
@@ -47,7 +47,13 @@ Specific examples:
 
 Modern Bunny versions support
 
- * CRuby 2.5 through 3.0 (inclusive)
+ * CRuby 2.6 through 3.1 (inclusive)
+ * [TruffleRuby](https://www.graalvm.org/ruby/)
+
+For environments that use TLS, Bunny expects Ruby installations to use a recent enough OpenSSL version that
+**includes support for TLS 1.3**.
+
+### JRuby
 
 Bunny works sufficiently well on JRuby but there are known
 JRuby bugs in versions prior to JRuby 9000 that cause high CPU burn. JRuby users should
@@ -58,8 +64,7 @@ Bunny `1.7.x` was the last version to support CRuby 1.9.3 and 1.8.7
 
 ## Supported RabbitMQ Versions
 
-Bunny `1.5.0` and later versions only support RabbitMQ `3.3+`.
-Bunny `1.4.x` and earlier supports RabbitMQ 2.x and 3.x.
+Modern Bunny releases target [currently supported RabbitMQ release series](https://www.rabbitmq.com/versions.html).
 
 
 ## Change Log
@@ -69,9 +74,8 @@ a stable public API.
 
 Change logs per release series:
 
- * [master](https://github.com/ruby-amqp/bunny/blob/master/ChangeLog.md)
- * [2.18.x](https://github.com/ruby-amqp/bunny/blob/2.18.x-stable/ChangeLog.md)
- * [2.17.x](https://github.com/ruby-amqp/bunny/blob/2.17.x-stable/ChangeLog.md)
+ * [main](https://github.com/ruby-amqp/bunny/blob/main/ChangeLog.md) (most notable changes for all release series)
+ * [2.19.x](https://github.com/ruby-amqp/bunny/blob/2.19.x-stable/ChangeLog.md)
 
 
 
@@ -81,20 +85,20 @@ Change logs per release series:
 
 [![Gem Version](https://badge.fury.io/rb/bunny.svg)](http://badge.fury.io/rb/bunny)
 
-### With Rubygems
+### Bundler Dependency
 
-To install Bunny with RubyGems:
+To use Bunny in a project managed with Bundler:
 
-```
-gem install bunny
+``` ruby
+gem "bunny", ">= 2.19.0"
 ```
 
-### Bundler Dependency
+### With Rubygems
 
-To use Bunny in a project managed with Bundler:
+To install Bunny with RubyGems:
 
-``` ruby
-gem "bunny", ">= 2.18.0"
+```
+gem install bunny
 ```
 
 
@@ -103,7 +107,7 @@ gem "bunny", ">= 2.18.0"
 Below is a small snippet that demonstrates how to publish
 and synchronously consume ("pull API") messages with Bunny.
 
-For a 15 minute tutorial using more practical examples, see [Getting Started with RabbitMQ and Ruby using Bunny](http://rubybunny.info/articles/getting_started.html).
+For a 15 minute tutorial using more practical examples, see [Getting Started with RabbitMQ and Ruby using Bunny](https://www.rabbitmq.com/tutorials/tutorial-one-ruby.html).
 
 ``` ruby
 require "bunny"
@@ -150,23 +154,25 @@ For a 15 minute tutorial using more practical examples, see [Getting Started wit
 
 ### Guides
 
-Bunny documentation guides are available at [rubybunny.info](http://rubybunny.info):
+Bunny documentation guides are [under `docs/guides` in this repository](https://github.com/ruby-amqp/bunny/tree/main/docs/guides):
 
- * [Queues and Consumers](http://rubybunny.info/articles/queues.html)
- * [Exchanges and Publishers](http://rubybunny.info/articles/exchanges.html)
+ * [Queues and Consumers](https://github.com/ruby-amqp/bunny/tree/main/docs/guides/queues.md)
+ * [Exchanges and Publishers](https://github.com/ruby-amqp/bunny/tree/main/docs/guides/exchanges.md)
  * [AMQP 0.9.1 Model Explained](http://www.rabbitmq.com/tutorials/amqp-concepts.html)
- * [Connecting to RabbitMQ](http://rubybunny.info/articles/connecting.html)
- * [Error Handling and Recovery](http://rubybunny.info/articles/error_handling.html)
- * [TLS/SSL Support](http://rubybunny.info/articles/tls.html)
- * [Bindings](http://rubybunny.info/articles/bindings.html)
- * [Using RabbitMQ Extensions with Bunny](http://rubybunny.info/articles/extensions.html)
- * [Durability and Related Matters](http://rubybunny.info/articles/durability.html)
+ * [Connecting to RabbitMQ](https://github.com/ruby-amqp/bunny/tree/main/docs/guides/connecting.md)
+ * [Error Handling and Recovery](https://github.com/ruby-amqp/bunny/tree/main/docs/guides/error_handling.md)
+ * [TLS/SSL Support](https://github.com/ruby-amqp/bunny/tree/main/docs/guides/tls.md)
+ * [Bindings](https://github.com/ruby-amqp/bunny/tree/main/docs/guides/bindings.md)
+ * [Using RabbitMQ Extensions with Bunny](https://github.com/ruby-amqp/bunny/tree/main/docs/guides/extensions.md)
+ * [Durability and Related Matters](https://github.com/ruby-amqp/bunny/tree/main/docs/guides/durability.md)
 
 Some highly relevant RabbitMQ documentation guides:
 
  * [Connections](https://www.rabbitmq.com/connections.html)
  * [Channels](https://www.rabbitmq.com/channels.html)
  * [Queues](https://www.rabbitmq.com/queues.html)
+ * [Quorum queues](https://www.rabbitmq.com/quorum-queues.html)
+ * [Streams](https://rabbitmq.com/streams.html) (Bunny can perform basic operations on streams even though it does not implement the [RabbitMQ Stream protocol](https://github.com/rabbitmq/rabbitmq-server/blob/v3.10.x/deps/rabbitmq_stream/docs/PROTOCOL.adoc))
  * [Publishers](https://www.rabbitmq.com/publishers.html)
  * [Consumers](https://www.rabbitmq.com/consumers.html)
  * Data safety: publisher and consumer [Confirmations](https://www.rabbitmq.com/confirms.html)
@@ -194,13 +200,6 @@ mailing list. Feel free to ask any questions that you may have.
 [![Build Status](https://travis-ci.org/ruby-amqp/bunny.svg)](https://travis-ci.org/ruby-amqp/bunny/)
 
 
-### News & Announcements on Twitter
-
-To subscribe for announcements of releases, important changes and so on, please follow [@rubyamqp](https://twitter.com/#!/rubyamqp) on Twitter.
-
-More detailed announcements can be found in the [RabbitMQ Ruby clients blog](http://blog.rubyrabbitmq.info).
-
-
 ### Reporting Issues
 
 If you find a bug you understand well, poor default, incorrect or unclear piece of documentation,

data/lib/bunny/channel.rb

@@ -143,6 +143,10 @@ module Bunny
     attr_reader :work_pool
     # @return [Integer] Next publisher confirmations sequence index
     attr_reader :next_publish_seq_no
+    # @return [Integer] Offset for the confirmations sequence index.
+    # This will be set to the current sequence index during automatic network failure recovery
+    # to keep the sequence monotonic for the user and abstract the reset from the protocol
+    attr_reader :delivery_tag_offset
     # @return [Hash<String, Bunny::Queue>] Queue instances declared on this channel
     attr_reader :queues
     # @return [Hash<String, Bunny::Exchange>] Exchange instances declared on this channel
@@ -408,7 +412,7 @@ module Bunny
     # @option opts [Boolean] :durable (false) Should this queue be durable?
     # @option opts [Boolean] :auto-delete (false) Should this queue be automatically deleted when the last consumer disconnects?
     # @option opts [Boolean] :exclusive (false) Should this queue be exclusive (only can be used by this connection, removed when the connection is closed)?
-    # @option opts [Boolean] :arguments ({}) Additional optional arguments (typically used by RabbitMQ extensions and plugins)
+    # @option opts [Hash] :arguments ({}) Additional optional arguments (typically used by RabbitMQ extensions and plugins)
     #
     # @return [Bunny::Queue] Queue that was declared or looked up in the cache
     # @see http://rubybunny.info/articles/queues.html Queues and Consumers guide
@@ -422,6 +426,73 @@ module Bunny
       register_queue(q)
     end
 
+    # Declares a new client-named quorum queue.
+    #
+    # @param [String] name Queue name. Empty (server-generated) names are not supported by this method.
+    # @param  [Hash]  opts  Queue properties and other options. Durability, exclusivity, auto-deletion options will be ignored.
+    #
+    # @option opts [Hash] :arguments ({}) Additional optional arguments (typically used by RabbitMQ extensions and plugins)
+    #
+    # @return [Bunny::Queue] Queue that was declared
+    # @see #durable_queue
+    # @see #queue
+    # @api public
+    def quorum_queue(name, opts = {})
+      throw ArgumentError.new("quorum queue name must not be nil") if name.nil?
+      throw ArgumentError.new("quorum queue name must not be empty (server-named QQs do not make sense)") if name.empty?
+
+      durable_queue(name, Bunny::Queue::Types::QUORUM, opts)
+    end
+
+    # Declares a new client-named stream (that Bunny can use as if it was a queue).
+    # Note that Bunny would still use AMQP 0-9-1 to perform operations on this "queue".
+    # To use stream-specific operations and to gain from stream protocol efficiency and partitioning,
+    # use a Ruby client for the RabbitMQ stream protocol.
+    #
+    # @param [String] name Stream name. Empty (server-generated) names are not supported by this method.
+    # @param  [Hash]  opts  Queue properties and other options. Durability, exclusivity, auto-deletion options will be ignored.
+    #
+    # @option opts [Hash] :arguments ({}) Additional optional arguments (typically used by RabbitMQ extensions and plugins)
+    #
+    #
+    # @return [Bunny::Queue] Queue that was declared
+    # @see #durable_queue
+    # @see #queue
+    # @api public
+    def stream(name, opts = {})
+      throw ArgumentError.new("stream name must not be nil") if name.nil?
+      throw ArgumentError.new("stream name must not be empty (server-named QQs do not make sense)") if name.empty?
+
+      durable_queue(name, Bunny::Queue::Types::STREAM, opts)
+    end
+
+    # Declares a new server-named queue that is automatically deleted when the
+    # connection is closed.
+    #
+    # @param [String] name Queue name. Empty (server-generated) names are not supported by this method.
+    # @param  [Hash]  opts  Queue properties and other options. Durability, exclusivity, auto-deletion options will be ignored.
+    #
+    # @option opts [Hash] :arguments ({}) Additional optional arguments (typically used by RabbitMQ extensions and plugins)
+    #
+    # @return [Bunny::Queue] Queue that was declared
+    # @see #queue
+    # @api public
+    def durable_queue(name, type = "classic", opts = {})
+      throw ArgumentError.new("queue name must not be nil") if name.nil?
+      throw ArgumentError.new("queue name must not be empty (server-named durable queues do not make sense)") if name.empty?
+
+      final_opts = opts.merge({
+        :type        => type,
+        :durable     => true,
+        # exclusive or auto-delete QQs do not make much sense
+        :exclusive   => false,
+        :auto_delete => false
+      })
+      q = find_queue(name) || Bunny::Queue.new(self, name, final_opts)
+
+      register_queue(q)
+    end
+
     # Declares a new server-named queue that is automatically deleted when the
     # connection is closed.
     #
@@ -1525,12 +1596,15 @@ module Bunny
 
     # Recovers publisher confirms mode. Used by the Automatic Network Failure
     # Recovery feature.
+    # Set the offset to the previous publish sequence index as the protocol will reset the index to after recovery.
     #
     # @api plugin
     def recover_confirm_mode
       if using_publisher_confirmations?
-        @unconfirmed_set.clear
-        @delivery_tag_offset = @next_publish_seq_no - 1
+        @unconfirmed_set_mutex.synchronize do
+          @unconfirmed_set.clear
+          @delivery_tag_offset = @next_publish_seq_no - 1
+        end
         confirm_select(@confirms_callback)
       end
     end
@@ -1599,7 +1673,7 @@ module Bunny
 
     # @return [String] Brief human-readable representation of the channel
     def to_s
-      "#<#{self.class.name}:#{object_id} @id=#{self.number} @connection=#{@connection.to_s}> @open=#{open?}"
+      "#<#{self.class.name}:#{object_id} @id=#{self.number} @connection=#{@connection.to_s} @open=#{open?}>"
     end
 
     def inspect
@@ -1663,7 +1737,7 @@ module Bunny
           if !pending_server_named_queue_declaration?
             # this response is for an outdated/overwritten
             # queue.declare, drop it
-            @logger.warn "Received a queue.declare-ok response for a mismatching queue (#{method.queue} instead of #{@pending_queue_declare_name}) on channel #{@id} possibly due to a timeout, ignoring it"
+            @logger.warn "Received a queue.declare-ok response for a mismatching queue (#{method.queue} instead of #{@pending_queue_declare_name}) on channel #{@id}, possibly due to concurrent channel use or a timeout, ignoring it"
           end
         end
       when AMQ::Protocol::Queue::DeleteOk then
@@ -1786,14 +1860,16 @@ module Bunny
       end
     end
 
+    # Handle delivery tag offset calculations to keep the the delivery tag monotonic after a reset
+    # due to automatic network failure recovery. @unconfirmed_set contains indices already offsetted.
     # @private
     def handle_ack_or_nack(delivery_tag_before_offset, multiple, nack)
-      delivery_tag          = delivery_tag_before_offset + @delivery_tag_offset
-      confirmed_range_start = multiple ? @delivery_tag_offset + @unconfirmed_set.min : delivery_tag
-      confirmed_range_end   = delivery_tag
-      confirmed_range       = (confirmed_range_start..confirmed_range_end)
-
       @unconfirmed_set_mutex.synchronize do
+        delivery_tag          = delivery_tag_before_offset + @delivery_tag_offset
+        confirmed_range_start = multiple ? @unconfirmed_set.min : delivery_tag
+        confirmed_range_end   = delivery_tag
+        confirmed_range       = (confirmed_range_start..confirmed_range_end)
+
         if nack
           @nacked_set.merge(@unconfirmed_set & confirmed_range)
         end

data/lib/bunny/consumer.rb

@@ -86,12 +86,12 @@ module Bunny
 
     # @return [String] More detailed human-readable string representation of this consumer
     def inspect
-      "#<#{self.class.name}:#{object_id} @channel_id=#{@channel.number} @queue=#{self.queue_name}> @consumer_tag=#{@consumer_tag} @exclusive=#{@exclusive} @no_ack=#{@no_ack}>"
+      "#<#{self.class.name}:#{object_id} @channel_id=#{@channel.number} @queue=#{self.queue_name} @consumer_tag=#{@consumer_tag} @exclusive=#{@exclusive} @no_ack=#{@no_ack}>"
     end
 
     # @return [String] Brief human-readable string representation of this consumer
     def to_s
-      "#<#{self.class.name}:#{object_id} @channel_id=#{@channel.number} @queue=#{self.queue_name}> @consumer_tag=#{@consumer_tag}>"
+      "#<#{self.class.name}:#{object_id} @channel_id=#{@channel.number} @queue=#{self.queue_name} @consumer_tag=#{@consumer_tag}>"
     end
 
     # @return [Boolean] true if this consumer uses automatic acknowledgement mode

data/lib/bunny/delivery_info.rb

@@ -37,7 +37,7 @@ module Bunny
       @channel       = channel
     end
 
-    # Iterates over the delivery properties
+    # Iterates over delivery properties
     # @see Enumerable#each
     def each(*args, &block)
       @hash.each(*args, &block)

data/lib/bunny/queue.rb

@@ -11,6 +11,23 @@ module Bunny
     # API
     #
 
+    module Types
+      QUORUM  = "quorum"
+      CLASSIC = "classic"
+      STREAM  = "stream"
+
+      KNOWN = [CLASSIC, QUORUM, STREAM]
+
+      def self.known?(q_type)
+        KNOWN.include?(q_type)
+      end
+    end
+
+    module XArgs
+      MAX_LENGTH = "x-max-length",
+      QUEUE_TYPE = "x-queue-type"
+    end
+
     # @return [Bunny::Channel] Channel this queue uses
     attr_reader :channel
     # @return [String] Queue name
@@ -25,7 +42,8 @@ module Bunny
     # @option opts [Boolean] :durable (false)      Should this queue be durable?
     # @option opts [Boolean] :auto_delete (false)  Should this queue be automatically deleted when the last consumer disconnects?
     # @option opts [Boolean] :exclusive (false)    Should this queue be exclusive (only can be used by this connection, removed when the connection is closed)?
-    # @option opts [Boolean] :arguments ({})       Additional optional arguments (typically used by RabbitMQ extensions and plugins)
+    # @option opts [String] :type (nil)            Type of the declared queue (classic, quorum or stream)
+    # @option opts [Hash] :arguments (nil)         Additional optional arguments (typically used by RabbitMQ extensions and plugins)
     #
     # @see Bunny::Channel#queue
     # @see http://rubybunny.info/articles/queues.html Queues and Consumers guide
@@ -42,7 +60,17 @@ module Bunny
       @exclusive        = @options[:exclusive]
       @server_named     = @name.empty?
       @auto_delete      = @options[:auto_delete]
-      @arguments        = @options[:arguments]
+      @type             = @options[:type]
+
+      @arguments        = if @type and !@type.empty? then
+        (@options[:arguments] || {}).merge({XArgs::QUEUE_TYPE => @type})
+      else
+        @options[:arguments]
+      end
+      verify_type!(@arguments)
+      # reassigns updated and verified arguments because Bunny::Channel#declare_queue
+      # accepts a map of options
+      @options[:arguments] = @arguments
 
       @bindings         = Array.new
 
@@ -389,5 +417,11 @@ module Bunny
         h
       end
     end
+
+    def verify_type!(args)
+      q_type = (args || {})["x-queue-type"]
+      throw ArgumentError.new(
+        "unsupported queue type #{q_type.inspect}, supported ones: #{Types::KNOWN.join(', ')}") if (q_type and !Types.known?(q_type))
+    end
   end
 end

data/lib/bunny/session.rb

@@ -109,7 +109,7 @@ module Bunny
     # @option connection_string_or_opts [String] :tls_key (nil) Path to client TLS/SSL private key file (.pem)
     # @option connection_string_or_opts [Array<String>] :tls_ca_certificates Array of paths to TLS/SSL CA files (.pem), by default detected from OpenSSL configuration
     # @option connection_string_or_opts [String] :verify_peer (true) Whether TLS peer verification should be performed
-    # @option connection_string_or_opts [Symbol] :tls_version (negotiated) What TLS version should be used (:TLSv1, :TLSv1_1, or :TLSv1_2)
+    # @option connection_string_or_opts [Symbol] :tls_protocol (negotiated) What TLS version should be used (:TLSv1, :TLSv1_1, or :TLSv1_2)
     # @option connection_string_or_opts [Integer] :channel_max (2047) Maximum number of channels allowed on this connection, minus 1 to account for the special channel 0.
     # @option connection_string_or_opts [Integer] :continuation_timeout (15000) Timeout for client operations that expect a response (e.g. {Bunny::Queue#get}), in milliseconds.
     # @option connection_string_or_opts [Integer] :connection_timeout (30) Timeout in seconds for connecting to the server.
@@ -671,8 +671,12 @@ module Bunny
           # avoid doing that while holding a mutex lock. MK.
           ch.handle_method(method)
         ensure
-          # synchronises on @channel_mutex under the hood
-          self.unregister_channel(ch)
+          if ch.nil?
+            @logger.warn "Received a server-sent channel.close but the channel was not found locally. Ignoring the frame."
+          else
+            # synchronises on @channel_mutex under the hood
+            self.unregister_channel(ch)
+          end
         end
       when AMQ::Protocol::Basic::GetEmpty then
         ch = find_channel(ch_number)

data/lib/bunny/transport.rb

@@ -25,6 +25,30 @@ module Bunny
     DEFAULT_READ_TIMEOUT  = 30.0
     DEFAULT_WRITE_TIMEOUT = 30.0
 
+    # mimics METHODS_MAP in ssl.rb but also lists TLS 1.3
+    # and string constants
+    TLS_VERSION_ALIASES = {
+      TLSv1: OpenSSL::SSL::TLS1_VERSION,
+      TLSv1_1: OpenSSL::SSL::TLS1_1_VERSION,
+      TLSv1_2: OpenSSL::SSL::TLS1_2_VERSION,
+      "1.0": OpenSSL::SSL::TLS1_VERSION,
+      "1.1": OpenSSL::SSL::TLS1_1_VERSION,
+      "1.2": OpenSSL::SSL::TLS1_2_VERSION,
+      OpenSSL::SSL::TLS1_VERSION => OpenSSL::SSL::TLS1_VERSION,
+      OpenSSL::SSL::TLS1_1_VERSION => OpenSSL::SSL::TLS1_1_VERSION,
+      OpenSSL::SSL::TLS1_2_VERSION => OpenSSL::SSL::TLS1_2_VERSION
+    }
+
+    # older OpenSSL versions won't support for TLS 1.3 and won't
+    # have this constant defined.
+    if defined?(OpenSSL::SSL::TLS1_3_VERSION)
+      TLS_VERSION_ALIASES["1.3"]                        = OpenSSL::SSL::TLS1_3_VERSION
+      TLS_VERSION_ALIASES[:TLSv1_3]                     = OpenSSL::SSL::TLS1_3_VERSION
+      TLS_VERSION_ALIASES[OpenSSL::SSL::TLS1_3_VERSION] = OpenSSL::SSL::TLS1_3_VERSION
+    end
+
+    TLS_VERSION_ALIASES.freeze
+
     attr_reader :session, :host, :port, :socket, :connect_timeout, :read_timeout, :write_timeout, :disconnect_timeout
     attr_reader :tls_context, :verify_peer, :tls_ca_certificates, :tls_certificate_path, :tls_key_path
 
@@ -491,7 +515,11 @@ but prone to man-in-the-middle attacks. Please set verify_peer: true in producti
       end
 
       ssl_version = opts[:tls_protocol] || opts[:ssl_version] || :TLSv1_2
-      ctx.ssl_version = ssl_version if ssl_version
+      if ssl_version
+        v = tls_version_constant(ssl_version)
+        ctx.min_version = v
+        ctx.max_version = v
+      end
 
       ctx
     end
@@ -519,6 +547,14 @@ but prone to man-in-the-middle attacks. Please set verify_peer: true in producti
       end
     end
 
+
+    def tls_version_constant(value)
+      # OpenSSL::SSL::TLS1_3_VERSION and similar constants
+      # are just integers, so use the value itself as fallback since
+      # there is no class to case switch on
+      TLS_VERSION_ALIASES[value] || value
+    end
+
     def timeout_from(options)
       options[:connect_timeout] || options[:connection_timeout] || options[:timeout] || DEFAULT_CONNECTION_TIMEOUT
     end

data/lib/bunny/version.rb

@@ -2,5 +2,5 @@
 
 module Bunny
   # @return [String] Version of the library
-  VERSION = "2.19.0"
+  VERSION = "2.20.3"
 end

data/lib/bunny.rb

@@ -53,17 +53,58 @@ module Bunny
   # Instantiates a new connection. The actual network
   # connection is started with {Bunny::Session#start}
   #
+  # @param [String, Hash] connection_string_or_opts Connection string or a hash of connection options
+  # @param [Hash] optz Extra options not related to connection
+  #
+  # @option connection_string_or_opts [String] :host ("127.0.0.1") Hostname or IP address to connect to
+  # @option connection_string_or_opts [Array<String>] :hosts (["127.0.0.1"]) list of hostname or IP addresses to select hostname from when connecting
+  # @option connection_string_or_opts [Array<String>] :addresses (["127.0.0.1:5672"]) list of addresses to select hostname and port from when connecting
+  # @option connection_string_or_opts [Integer] :port (5672) Port RabbitMQ listens on
+  # @option connection_string_or_opts [String] :username ("guest") Username
+  # @option connection_string_or_opts [String] :password ("guest") Password
+  # @option connection_string_or_opts [String] :vhost ("/") Virtual host to use
+  # @option connection_string_or_opts [Integer, Symbol] :heartbeat (:server) Heartbeat timeout to offer to the server. :server means use the value suggested by RabbitMQ. 0 means heartbeats and socket read timeouts will be disabled (not recommended).
+  # @option connection_string_or_opts [Integer] :network_recovery_interval (4) Recovery interval periodic network recovery will use. This includes initial pause after network failure.
+  # @option connection_string_or_opts [Boolean] :tls (false) Should TLS/SSL be used?
+  # @option connection_string_or_opts [String] :tls_cert (nil) Path to client TLS/SSL certificate file (.pem)
+  # @option connection_string_or_opts [String] :tls_key (nil) Path to client TLS/SSL private key file (.pem)
+  # @option connection_string_or_opts [Array<String>] :tls_ca_certificates Array of paths to TLS/SSL CA files (.pem), by default detected from OpenSSL configuration
+  # @option connection_string_or_opts [String] :verify_peer (true) Whether TLS peer verification should be performed
+  # @option connection_string_or_opts [Symbol] :tls_protocol (negotiated) What TLS version should be used (:TLSv1, :TLSv1_1, or :TLSv1_2)
+  # @option connection_string_or_opts [Integer] :channel_max (2047) Maximum number of channels allowed on this connection, minus 1 to account for the special channel 0.
+  # @option connection_string_or_opts [Integer] :continuation_timeout (15000) Timeout for client operations that expect a response (e.g. {Bunny::Queue#get}), in milliseconds.
+  # @option connection_string_or_opts [Integer] :connection_timeout (30) Timeout in seconds for connecting to the server.
+  # @option connection_string_or_opts [Integer] :read_timeout (30) TCP socket read timeout in seconds. If heartbeats are disabled this will be ignored.
+  # @option connection_string_or_opts [Integer] :write_timeout (30) TCP socket write timeout in seconds.
+  # @option connection_string_or_opts [Proc] :hosts_shuffle_strategy a callable that reorders a list of host strings, defaults to Array#shuffle
+  # @option connection_string_or_opts [Proc] :recovery_completed a callable that will be called when a network recovery is performed
+  # @option connection_string_or_opts [Logger] :logger The logger.  If missing, one is created using :log_file and :log_level.
+  # @option connection_string_or_opts [IO, String] :log_file The file or path to use when creating a logger.  Defaults to STDOUT.
+  # @option connection_string_or_opts [IO, String] :logfile DEPRECATED: use :log_file instead.  The file or path to use when creating a logger.  Defaults to STDOUT.
+  # @option connection_string_or_opts [Integer] :log_level The log level to use when creating a logger.  Defaults to LOGGER::WARN
+  # @option connection_string_or_opts [Boolean] :automatically_recover (true) Should automatically recover from network failures?
+  # @option connection_string_or_opts [Integer] :recovery_attempts (nil) Max number of recovery attempts, nil means forever
+  # @option connection_string_or_opts [Integer] :reset_recovery_attempts_after_reconnection (true) Should recovery attempt counter be reset after successful reconnection? When set to false, the attempt counter will last through the entire lifetime of the connection object.
+  # @option connection_string_or_opts [Proc] :recovery_attempt_started (nil) Will be called before every connection recovery attempt
+  # @option connection_string_or_opts [Proc] :recovery_completed (nil) Will be called after successful connection recovery
+  # @option connection_string_or_opts [Boolean] :recover_from_connection_close (true) Should this connection recover after receiving a server-sent connection.close (e.g. connection was force closed)?
+  # @option connection_string_or_opts [Object] :session_error_handler (Thread.current) Object which responds to #raise that will act as a session error handler. Defaults to Thread.current, which will raise asynchronous exceptions in the thread that created the session.
+  #
+  # @option optz [String] :auth_mechanism ("PLAIN") Authentication mechanism, PLAIN or EXTERNAL
+  # @option optz [String] :locale ("PLAIN") Locale RabbitMQ should use
+  # @option optz [String] :connection_name (nil) Client-provided connection name, if any. Note that the value returned does not uniquely identify a connection and cannot be used as a connection identifier in HTTP API requests.
+  #
   # @return [Bunny::Session]
   # @see Bunny::Session#start
   # @see http://rubybunny.info/articles/getting_started.html
   # @see http://rubybunny.info/articles/connecting.html
   # @api public
-  def self.new(connection_string_or_opts = ENV['RABBITMQ_URL'], opts = {})
-    if connection_string_or_opts.respond_to?(:keys) && opts.empty?
-      opts = connection_string_or_opts
+  def self.new(connection_string_or_opts = ENV['RABBITMQ_URL'], optz = {})
+    if connection_string_or_opts.respond_to?(:keys) && optz.empty?
+      optz = connection_string_or_opts
     end
 
-    conn = Session.new(connection_string_or_opts, opts)
+    conn = Session.new(connection_string_or_opts, optz)
     @default_connection ||= conn
 
     conn