bunny 0.10.4 → 0.10.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b9c9bf09dd970ef5209cce72c05a7d73f82f4750
-  data.tar.gz: d658fe0aea0c6f3461b2f4d1c54db3b7d8c0f9a6
+  metadata.gz: 30cd6500ecfd75b3739c29654e916438ec46851e
+  data.tar.gz: 2099cdb7829fcbd14dfe105b924b227ec764b052
 SHA512:
-  metadata.gz: 220ac2fd8093683bfdb6b6c614b8198a47a996295804bd677d3aebfa6001eb1e5dfd7ad63b359e98050fb285f680c0ba5867b9a7f88d2437487db81cc25e84c1
-  data.tar.gz: a59a8fce37f7807548223b15041d349f5ec8522342427277cebb2de729a0927fde4fb660e5b4ea869b3abd395610e5bc9d3844e126f4d8d7476ce260f0cbae1a
+  metadata.gz: 4eef9cc1148e341756184bb7685f84dc34d55ad3db86b030277360474e8cb13cdbbdf6f1323852e56f4deac0c8fc17ac072c295f610678d5e5aa2325ec50a81b
+  data.tar.gz: 7d69d18fc1d4eccaec10fe33423490b9b9bae51abc031170e658b3070706c6e29cc8c80d14d0ac444b28ab6faaf1a5ee362c73f78dc7b45c13f8358b3c25ccf6

data/ChangeLog.md

@@ -1,3 +1,16 @@
+## Changes between Bunny 0.10.4 and 0.10.5
+
+### Bunny::Session.parse_uri
+
+`Bunny::Session.parse_uri` is a new method that parses
+connection URIs into hashes that `Bunny::Session#initialize`
+accepts.
+
+``` ruby
+Bunny::Session.parse_uri("amqp://user:pwd@broker.eng.megacorp.local/myapp_qa")
+```
+
+
 ## Changes between Bunny 0.10.3 and 0.10.4
 
 ### Default Paths for TLS/SSL CA's on All OS'es

data/lib/bunny.rb

@@ -9,6 +9,7 @@ require "amq/protocol/extensions"
 require "bunny/framing"
 require "bunny/exceptions"
 require "bunny/socket"
+require "bunny/timeout"
 
 begin
   require "openssl"
@@ -33,20 +34,6 @@ module Bunny
   # AMQP protocol version Bunny implements
   PROTOCOL_VERSION = AMQ::Protocol::PROTOCOL_VERSION
 
-  # unifies Ruby standard library's Timeout (which is not accurate on
-  # Ruby 1.8 and has other issues) and SystemTimer (the gem)
-  Timer = if RUBY_VERSION < "1.9"
-            begin
-              require "bunny/system_timer"
-              Bunny::SystemTimer
-            rescue LoadError
-              Timeout
-            end
-          else
-            Timeout
-          end
-
-
   #
   # API
   #

data/lib/bunny/channel.rb

@@ -602,7 +602,7 @@ module Bunny
 
       @connection.send_frame(AMQ::Protocol::Basic::Qos.encode(@id, 0, prefetch_count, global))
 
-      Bunny::Timer.timeout(read_write_timeout, ClientTimeout) do
+      Bunny::Timeout.timeout(read_write_timeout, ClientTimeout) do
         @last_basic_qos_ok = wait_on_continuations
       end
       raise_if_continuation_resulted_in_a_channel_error!
@@ -621,7 +621,7 @@ module Bunny
       raise_if_no_longer_open!
 
       @connection.send_frame(AMQ::Protocol::Basic::Recover.encode(@id, requeue))
-      Bunny::Timer.timeout(read_write_timeout, ClientTimeout) do
+      Bunny::Timeout.timeout(read_write_timeout, ClientTimeout) do
         @last_basic_recover_ok = wait_on_continuations
       end
       raise_if_continuation_resulted_in_a_channel_error!
@@ -823,7 +823,7 @@ module Bunny
           arguments))
 
       begin
-        Bunny::Timer.timeout(read_write_timeout, ClientTimeout) do
+        Bunny::Timeout.timeout(read_write_timeout, ClientTimeout) do
           @last_basic_consume_ok = wait_on_continuations
         end
       rescue Exception => e
@@ -873,7 +873,7 @@ module Bunny
           consumer.arguments))
 
       begin
-        Bunny::Timer.timeout(read_write_timeout, ClientTimeout) do
+        Bunny::Timeout.timeout(read_write_timeout, ClientTimeout) do
           @last_basic_consume_ok = wait_on_continuations
         end
       rescue Exception => e
@@ -908,7 +908,7 @@ module Bunny
     def basic_cancel(consumer_tag)
       @connection.send_frame(AMQ::Protocol::Basic::Cancel.encode(@id, consumer_tag, false))
 
-      Bunny::Timer.timeout(read_write_timeout, ClientTimeout) do
+      Bunny::Timeout.timeout(read_write_timeout, ClientTimeout) do
         @last_basic_cancel_ok = wait_on_continuations
       end
 
@@ -982,7 +982,7 @@ module Bunny
           opts[:if_unused],
           opts[:if_empty],
           false))
-      Bunny::Timer.timeout(read_write_timeout, ClientTimeout) do
+      Bunny::Timeout.timeout(read_write_timeout, ClientTimeout) do
         @last_queue_delete_ok = wait_on_continuations
       end
       raise_if_continuation_resulted_in_a_channel_error!
@@ -1002,7 +1002,7 @@ module Bunny
 
       @connection.send_frame(AMQ::Protocol::Queue::Purge.encode(@id, name, false))
 
-      Bunny::Timer.timeout(read_write_timeout, ClientTimeout) do
+      Bunny::Timeout.timeout(read_write_timeout, ClientTimeout) do
         @last_queue_purge_ok = wait_on_continuations
       end
       raise_if_continuation_resulted_in_a_channel_error!
@@ -1038,7 +1038,7 @@ module Bunny
           opts[:routing_key],
           false,
           opts[:arguments]))
-      Bunny::Timer.timeout(read_write_timeout, ClientTimeout) do
+      Bunny::Timeout.timeout(read_write_timeout, ClientTimeout) do
         @last_queue_bind_ok = wait_on_continuations
       end
 
@@ -1073,7 +1073,7 @@ module Bunny
           exchange_name,
           opts[:routing_key],
           opts[:arguments]))
-      Bunny::Timer.timeout(read_write_timeout, ClientTimeout) do
+      Bunny::Timeout.timeout(read_write_timeout, ClientTimeout) do
         @last_queue_unbind_ok = wait_on_continuations
       end
 
@@ -1112,7 +1112,7 @@ module Bunny
           false,
           false,
           opts[:arguments]))
-      Bunny::Timer.timeout(read_write_timeout, ClientTimeout) do
+      Bunny::Timeout.timeout(read_write_timeout, ClientTimeout) do
         @last_exchange_declare_ok = wait_on_continuations
       end
 
@@ -1137,7 +1137,7 @@ module Bunny
           name,
           opts[:if_unused],
           false))
-      Bunny::Timer.timeout(read_write_timeout, ClientTimeout) do
+      Bunny::Timeout.timeout(read_write_timeout, ClientTimeout) do
         @last_exchange_delete_ok = wait_on_continuations
       end
 
@@ -1181,7 +1181,7 @@ module Bunny
           opts[:routing_key],
           false,
           opts[:arguments]))
-      Bunny::Timer.timeout(read_write_timeout, ClientTimeout) do
+      Bunny::Timeout.timeout(read_write_timeout, ClientTimeout) do
         @last_exchange_bind_ok = wait_on_continuations
       end
 
@@ -1225,7 +1225,7 @@ module Bunny
           opts[:routing_key],
           false,
           opts[:arguments]))
-      Bunny::Timer.timeout(read_write_timeout, ClientTimeout) do
+      Bunny::Timeout.timeout(read_write_timeout, ClientTimeout) do
         @last_exchange_unbind_ok = wait_on_continuations
       end
 
@@ -1253,7 +1253,7 @@ module Bunny
       raise_if_no_longer_open!
 
       @connection.send_frame(AMQ::Protocol::Channel::Flow.encode(@id, active))
-      Bunny::Timer.timeout(read_write_timeout, ClientTimeout) do
+      Bunny::Timeout.timeout(read_write_timeout, ClientTimeout) do
         @last_channel_flow_ok = wait_on_continuations
       end
       raise_if_continuation_resulted_in_a_channel_error!
@@ -1274,7 +1274,7 @@ module Bunny
       raise_if_no_longer_open!
 
       @connection.send_frame(AMQ::Protocol::Tx::Select.encode(@id))
-      Bunny::Timer.timeout(read_write_timeout, ClientTimeout) do
+      Bunny::Timeout.timeout(read_write_timeout, ClientTimeout) do
         @last_tx_select_ok = wait_on_continuations
       end
       raise_if_continuation_resulted_in_a_channel_error!
@@ -1289,7 +1289,7 @@ module Bunny
       raise_if_no_longer_open!
 
       @connection.send_frame(AMQ::Protocol::Tx::Commit.encode(@id))
-      Bunny::Timer.timeout(read_write_timeout, ClientTimeout) do
+      Bunny::Timeout.timeout(read_write_timeout, ClientTimeout) do
         @last_tx_commit_ok = wait_on_continuations
       end
       raise_if_continuation_resulted_in_a_channel_error!
@@ -1304,7 +1304,7 @@ module Bunny
       raise_if_no_longer_open!
 
       @connection.send_frame(AMQ::Protocol::Tx::Rollback.encode(@id))
-      Bunny::Timer.timeout(read_write_timeout, ClientTimeout) do
+      Bunny::Timeout.timeout(read_write_timeout, ClientTimeout) do
         @last_tx_rollback_ok = wait_on_continuations
       end
       raise_if_continuation_resulted_in_a_channel_error!
@@ -1344,7 +1344,7 @@ module Bunny
       @confirms_callback = callback
 
       @connection.send_frame(AMQ::Protocol::Confirm::Select.encode(@id, false))
-      Bunny::Timer.timeout(read_write_timeout, ClientTimeout) do
+      Bunny::Timeout.timeout(read_write_timeout, ClientTimeout) do
         @last_confirm_select_ok = wait_on_continuations
       end
       raise_if_continuation_resulted_in_a_channel_error!

data/lib/bunny/concurrent/continuation_queue.rb

@@ -21,7 +21,7 @@ module Bunny
 
       def poll(timeout_in_ms = nil)
         if timeout_in_ms
-          Bunny::Timer.timeout(timeout_in_ms / 1000, Timeout::Error) do
+          Bunny::Timeout.timeout(timeout_in_ms / 1000, Timeout::Error) do
             @q.pop
           end
         else

data/lib/bunny/session.rb

@@ -97,18 +97,23 @@ module Bunny
     # @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] :heartbeat (600) Heartbeat interval. 0 means no heartbeat.
+    # @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 optz [String] :auth_mechanism ("PLAIN") Authentication mechanism, PLAIN or EXTERNAL
     # @option optz [String] :locale ("PLAIN") Locale RabbitMQ should use
     #
     # @see http://rubybunny.info/articles/connecting.html Connecting to RabbitMQ guide
+    # @see http://rubybunny.info/articles/tls.html TLS/SSL guide
     # @api public
     def initialize(connection_string_or_opts = Hash.new, optz = Hash.new)
       opts = case (ENV["RABBITMQ_URL"] || connection_string_or_opts)
              when nil then
                Hash.new
              when String then
-               AMQ::Settings.parse_amqp_url(connection_string_or_opts)
+               self.class.parse_uri(connection_string_or_opts)
              when Hash then
                connection_string_or_opts
              end.merge(optz)
@@ -193,6 +198,8 @@ module Bunny
     # @private
     attr_reader :mutex_impl
 
+    # Provides a way to fine tune the socket used by connection.
+    # Accepts a block that the socket will be yielded to.
     def configure_socket(&block)
       raise ArgumentError, "No block provided!" if block.nil?
 
@@ -265,7 +272,7 @@ module Bunny
       if @transport.open?
         close_all_channels
 
-        Bunny::Timer.timeout(@transport.disconnect_timeout, ClientTimeout) do
+        Bunny::Timeout.timeout(@transport.disconnect_timeout, ClientTimeout) do
           self.close_connection(true)
         end
 
@@ -342,6 +349,41 @@ module Bunny
       @default_channel.exchange(*args)
     end
 
+    # Defines a callback that will be executed when RabbitMQ blocks the connection
+    # because it is running low on memory or disk space (as configured via config file
+    # and/or rabbitmqctl).
+    #
+    # @yield [AMQ::Protocol::Connection::Blocked] connection.blocked method which provides a reason for blocking
+    #
+    # @api public
+    def on_blocked(&block)
+      @block_callback = block
+    end
+
+    # Defines a callback that will be executed when RabbitMQ unblocks the connection
+    # that was previously blocked, e.g. because the memory or disk space alarm has cleared.
+    #
+    # @see #on_blocked
+    # @api public
+    def on_unblocked(&block)
+      @unblock_callback = block
+    end
+
+    # @return [Boolean] true if the connection is currently blocked by RabbitMQ because it's running low on
+    #                   RAM, disk space, or other resource; false otherwise
+    # @see #on_blocked
+    # @see #on_unblocked
+    def blocked?
+      @blocked
+    end
+
+    # Parses an amqp[s] URI into a hash that {Bunny::Session#initialize} accepts.
+    #
+    # @param [String] uri amqp or amqps URI to parse
+    # @return [Hash] Parsed URI as a hash
+    def self.parse_uri(uri)
+      AMQ::Settings.parse_amqp_url(uri)
+    end
 
     #
     # Implementation
@@ -376,7 +418,7 @@ module Bunny
     # @private
     def close_all_channels
       @channels.reject {|n, ch| n == 0 || !ch.open? }.each do |_, ch|
-        Bunny::Timer.timeout(@transport.disconnect_timeout, ClientTimeout) { ch.close }
+        Bunny::Timeout.timeout(@transport.disconnect_timeout, ClientTimeout) { ch.close }
       end
     end
 
@@ -635,7 +677,7 @@ module Bunny
           # a native method that cannot be (easily) interrupted.
           # So we use this ugly hack or else our test suite takes forever
           # to run on JRuby (a new connection is opened/closed per example). MK.
-          if RUBY_ENGINE == "jruby"
+          if defined?(JRUBY_VERSION)
             sleep 0.075
           else
             @reader_loop.join

data/lib/bunny/timeout.rb

@@ -0,0 +1,18 @@
+module Bunny
+  # Unifies Ruby standard library's Timeout (which is not accurate on
+  # Ruby 1.8) and SystemTimer (the gem)
+  Timeout = if RUBY_VERSION < "1.9"
+              begin
+                require "bunny/system_timer"
+                Bunny::SystemTimer
+              rescue LoadError
+                Timeout
+              end
+            else
+              Timeout
+            end
+
+  # Backwards compatibility
+  # @private
+  Timer = Timeout
+end

data/lib/bunny/transport.rb

@@ -112,7 +112,7 @@ module Bunny
     def write(data)
       begin
         if @read_write_timeout
-          Bunny::Timer.timeout(@read_write_timeout, Bunny::ClientTimeout) do
+          Bunny::Timeout.timeout(@read_write_timeout, Bunny::ClientTimeout) do
             if open?
               @writes_mutex.synchronize { @socket.write(data) }
               @socket.flush
@@ -250,7 +250,7 @@ module Bunny
 
     def initialize_socket
       begin
-        @socket = Bunny::Timer.timeout(@connect_timeout, ConnectionTimeout) do
+        @socket = Bunny::Timeout.timeout(@connect_timeout, ConnectionTimeout) do
           Bunny::Socket.open(@host, @port,
                              :keepalive      => @opts[:keepalive],
                              :socket_timeout => @connect_timeout)

data/lib/bunny/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bunny
 version: !ruby/object:Gem::Version
-  version: 0.10.4
+  version: 0.10.5
 platform: ruby
 authors:
 - Chris Duncan
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-24 00:00:00.000000000 Z
+date: 2013-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: amq-protocol
@@ -123,6 +123,7 @@ files:
 - lib/bunny/ssl_socket.rb
 - lib/bunny/system_timer.rb
 - lib/bunny/test_kit.rb
+- lib/bunny/timeout.rb
 - lib/bunny/transport.rb
 - lib/bunny/version.rb
 - lib/bunny/versioned_delivery_tag.rb