bunny 0.7.12 → 0.8.0

data/lib/bunny/{subscription09.rb → subscription.rb}

@@ -31,6 +31,12 @@ module Bunny
   # @option opts [Integer] :message_max
   #   When the required number of messages is processed subscribe loop is exited.
   #
+  # @option opts [IO] :cancellator (nil)
+  #   A cancellator can be used to for cancelling the subscribe loop from another
+  #   thread or from a signal handler. Whenever Bunny notices that this IO object has
+  #   become readable, the subscribe loop will be exited after the current message
+  #   has been processed.
+  #
   # h2. Operation
   #
   # Passes a hash of message information to the block, if one has been supplied. The hash contains
@@ -54,14 +60,13 @@ module Bunny
   #   :exchange
   #   :routing_key
   #
-  # If the :timeout option is specified then the subscription will
-  # automatically cease if the given number of seconds passes with no
-  # message arriving.
+  # If the :timeout option is specified then the subscription will automatically
+  # cease if the given number of seconds passes with no message arriving.
   #
   # @example
   #   my_queue.subscribe(timeout: 5) { |msg| puts msg[:payload] }
   #   my_queue.subscribe(message_max: 10, ack: true) { |msg| puts msg[:payload] }
-  class Subscription09 < Bunny::Consumer
+  class Subscription < Bunny::Consumer
 
     def setup_consumer
       subscription_options = {
@@ -73,11 +78,11 @@ module Bunny
         :nowait => false
       }.merge(@opts)
 
-      client.send_frame(Qrack::Protocol09::Basic::Consume.new(subscription_options))
+      client.send_frame(Qrack::Protocol::Basic::Consume.new(subscription_options))
 
       method = client.next_method
 
-      client.check_response(method, Qrack::Protocol09::Basic::ConsumeOk, "Error subscribing to queue #{queue.name}")
+      client.check_response(method, Qrack::Protocol::Basic::ConsumeOk, "Error subscribing to queue #{queue.name}, got #{method}")
 
       @consumer_tag = method.consumer_tag
     end

data/lib/bunny/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 
 module Bunny
-  VERSION = "0.7.12"
+  VERSION = "0.8.0"
 end

data/lib/qrack/client.rb

@@ -1,12 +1,6 @@
 # encoding: utf-8
 
-begin
-  # try loading AMQ::Client::Setttings form the amq client gem, if it has been already loaded
-  # this avoids "warning: already initialized constant AMQP_PORTS"
-  require "amq/client/settings"
-rescue LoadError
-  require "qrack/amq-client-url"
-end
+require "qrack/amq-client-url"
 
 module Qrack
 
@@ -20,12 +14,9 @@ module Qrack
     CONNECT_TIMEOUT = 5.0
     RETRY_DELAY     = 10.0
 
-    attr_reader   :status, :host, :vhost, :port, :logging, :spec, :heartbeat, :frame_max
+    attr_reader   :status, :host, :vhost, :port, :logging, :spec, :heartbeat, :last_method
     attr_accessor :channel, :logfile, :exchanges, :queues, :channels, :message_in, :message_out, :connecting
 
-    # Temporary hack to make Bunny 0.7 work with port number in AMQP URL.
-    # This is not necessary on Bunny 0.8 as it removes support of AMQP 0.8.
-    attr_reader :__opts__
 
     def initialize(connection_string_or_opts = Hash.new, opts = Hash.new)
       opts = case connection_string_or_opts
@@ -37,18 +28,18 @@ module Qrack
         Hash.new
       end.merge(opts)
 
-      # Temporary hack to make Bunny 0.7 work with port number in AMQP URL.
-      # This is not necessary on Bunny 0.8 as it removes support of AMQP 0.8.
-      @__opts__ = opts
-
-
       @host   = opts[:host] || 'localhost'
+      @port   = opts[:port] || (opts[:ssl] ? Qrack::Protocol::SSL_PORT : Qrack::Protocol::PORT)
       @user   = opts[:user]  || 'guest'
       @pass   = opts[:pass]  || 'guest'
       @vhost  = opts[:vhost] || '/'
       @logfile = opts[:logfile] || nil
       @logging = opts[:logging] || false
       @ssl = opts[:ssl] || false
+      @ssl_cert = opts[:ssl_cert] || nil
+      @ssl_key = opts[:ssl_key] || nil
+      @ssl_cert_string = opts[:ssl_cert_string] || nil
+      @ssl_key_string = opts[:ssl_key_string] || nil
       @verify_ssl = opts[:verify_ssl].nil? || opts[:verify_ssl]
       @status = :not_connected
       @frame_max = opts[:frame_max] || 131072
@@ -62,6 +53,7 @@ module Qrack
       create_logger if @logging
       @message_in = false
       @message_out = false
+      @last_method = nil
       @connecting = false
       @channels ||= []
       # Create channel 0
@@ -79,7 +71,7 @@ module Qrack
 
       # Close all active channels
       channels.each do |c|
-        Bunny::Timer::timeout(@read_write_timeout) { c.close } if c.open?
+        Bunny::Timer::timeout(@disconnect_timeout) { c.close } if c.open?
       end
 
       # Close connection to AMQP server
@@ -142,9 +134,6 @@ module Qrack
       end
 
       method = frame.payload
-      # at this point, we can receive a channel or connection close, which we need to check for
-      check_returned_message(method)
-
       header = next_payload
 
       # If maximum frame size is smaller than message payload body then message
@@ -171,6 +160,11 @@ module Qrack
       send_command(:write, *args)
     end
 
+    def read_ready?(timeout, cancelator = nil)
+      io = IO.select([ @socket, cancelator ].compact, nil, nil, timeout)
+      io and io[0].include?(@socket)
+    end
+
     private
 
     def close_socket(reason=nil)
@@ -219,7 +213,9 @@ module Qrack
 
         if @ssl
           require 'openssl' unless defined? OpenSSL::SSL
-          @socket = OpenSSL::SSL::SSLSocket.new(@socket)
+          sslctx = OpenSSL::SSL::SSLContext.new
+          initialize_client_pair(sslctx)
+          @socket = OpenSSL::SSL::SSLSocket.new(@socket, sslctx)
           @socket.sync_close = true
           @socket.connect
           @socket.post_connection_check(host) if @verify_ssl
@@ -233,6 +229,19 @@ module Qrack
       @socket
     end
 
+    def initialize_client_pair(sslctx)
+      if @ssl_cert
+        @ssl_cert_string = File.read(@ssl_cert)
+      end
+      if @ssl_key
+        @ssl_key_string = File.read(@ssl_key)
+      end
+
+      sslctx.cert = OpenSSL::X509::Certificate.new(@ssl_cert_string) if @ssl_cert_string
+      sslctx.key = OpenSSL::PKey::RSA.new(@ssl_key_string) if @ssl_key_string
+      sslctx
+    end
+
   end
 
 end

data/lib/qrack/protocol/{protocol08.rb → protocol.rb}

@@ -120,7 +120,8 @@ module Qrack
       end
 
       def method_missing meth, *args, &blk
-        @properties.has_key?(meth) || @klass.properties.find{|_,name| name == meth } ? @properties[meth] : super
+        @properties.has_key?(meth) || @klass.properties.find{|_,name| name == meth } ? @properties[meth] :
+          super
       end
     end
 

data/lib/qrack/protocol/{spec09.rb → spec.rb}

@@ -3,18 +3,19 @@
 
 
 #:stopdoc:
-# this file was autogenerated on 2011-07-21 07:07:06 +0100
-# using amqp-0.9.1.json  (mtime: 2011-07-20 19:10:34 +0100)
+# this file was autogenerated on 2012-02-28 11:22:27 -0500
+# using amqp-0.9.1.json  (mtime: 2012-02-28 10:50:44 -0500)
 #
 # DO NOT EDIT! (edit ext/qparser.rb and config.yml instead, and run 'ruby qparser.rb')
 
 module Qrack
-  module Protocol09
+  module Protocol
     HEADER        = "AMQP".freeze
     VERSION_MAJOR = 0
     VERSION_MINOR = 9
     REVISION      = 1
     PORT          = 5672
+    SSL_PORT      = 5671
 
     RESPONSES = {
       200 => :REPLY_SUCCESS,
@@ -79,7 +80,7 @@ module Qrack
 
           def arguments() @arguments ||= [] end
 
-          def parent() Protocol09.const_get(self.to_s[/Protocol09::(.+?)::/,1]) end
+          def parent() Protocol.const_get(self.to_s[/Protocol::(.+?)::/,1]) end
           def id()     self::ID end
           def name()   self::NAME.to_s end
         end
@@ -117,8 +118,8 @@ module Qrack
           def self.inherited klass
             klass.const_set(:ID, #{id})
             klass.const_set(:NAME, :#{name.to_s})
-            Protocol09.classes[#{id}] = klass
-            Protocol09.classes[klass::NAME] = klass
+            Protocol.classes[#{id}] = klass
+            Protocol.classes[klass::NAME] = klass
           end
         ]
       end
@@ -127,7 +128,7 @@ module Qrack
 end
 
 module Qrack
-  module Protocol09
+  module Protocol
     class Connection   < Class(  10, :connection   ); end
     class Channel      < Class(  20, :channel      ); end
     class Exchange     < Class(  40, :exchange     ); end

data/lib/qrack/{qrack08.rb → qrack.rb}

@@ -2,11 +2,11 @@
 
 $: << File.expand_path(File.dirname(__FILE__))
 
-require 'protocol/spec08'
-require 'protocol/protocol08'
+require 'protocol/spec'
+require 'protocol/protocol'
 
-require 'transport/buffer08'
-require 'transport/frame08'
+require 'transport/buffer'
+require 'transport/frame'
 
 require 'qrack/client'
 require 'qrack/channel'

data/lib/qrack/subscription.rb

@@ -39,6 +39,9 @@ module Qrack
       # Initialize message counter
       @message_count = 0
 
+      # Store cancellator
+      @cancellator = opts[:cancellator]
+
       # Store options
       @opts = opts
     end
@@ -52,14 +55,30 @@ module Qrack
       # Notify server about new consumer
       setup_consumer
 
+      # We need to keep track of three possible subscription states
+      # :subscribed, :pending, and :unsubscribed
+      # 'pending' occurs because of network latency, where we tried to unsubscribe but were already given a message
+      subscribe_state = :subscribed
+
       # Start subscription loop
       loop do
 
         begin
-          method = client.next_method(:timeout => timeout)
+          method = client.next_method(:timeout => timeout, :cancellator => @cancellator)
         rescue Qrack::FrameTimeout
-          queue.unsubscribe
-          break
+          begin
+            queue.unsubscribe
+            subscribe_state = :unsubscribed
+
+            break
+          rescue Bunny::ProtocolError
+            # Unsubscribe failed because we actually got a message, so we're in a weird state.
+            # We have to keep processing the message or else it may be lost...
+            # ...and there is also a CancelOk method floating around that we need to consume from the socket
+
+            method = client.last_method
+            subscribe_state = :pending
+          end
         end
 
         # Increment message counter
@@ -67,25 +86,55 @@ module Qrack
 
         # get delivery tag to use for acknowledge
         queue.delivery_tag = method.delivery_tag if @ack
-
         header = client.next_payload
 
+        # The unsubscribe ok may be sprinked into the payload
+        if subscribe_state == :pending and header.is_a?(Qrack::Protocol::Basic::CancelOk)
+          # We popped off the CancelOk, so we don't have to keep looking for it
+          subscribe_state = :unsubscribed
+
+          # Get the actual header now
+          header = client.next_payload
+        end
+
         # If maximum frame size is smaller than message payload body then message
         # will have a message header and several message bodies
         msg = ''
         while msg.length < header.size
-          msg << client.next_payload
+          message = client.next_payload
+
+          # The unsubscribe ok may be sprinked into the payload
+          if subscribe_state == :pending and message.is_a?(Qrack::Protocol::Basic::CancelOk)
+            # We popped off the CancelOk, so we don't have to keep looking for it
+            subscribe_state = :unsubscribed
+            next
+          end
+
+          msg << message
         end
 
         # If block present, pass the message info to the block for processing
         blk.call({:header => header, :payload => msg, :delivery_details => method.arguments}) if !blk.nil?
 
-        # Exit loop if message_max condition met
-        if (!message_max.nil? and message_count == message_max)
-          # Stop consuming messages
-          queue.unsubscribe()
+        # Unsubscribe if we've encountered the maximum number of messages
+        if subscribe_state == :subscribed and !message_max.nil? and message_count == message_max
+          queue.unsubscribe
+          subscribe_state = :unsubscribed
+        end
+
+        # Exit the loop if we've unsubscribed
+        if subscribe_state != :subscribed
+          # We still haven't found the CancelOk, so it's the next method
+          if subscribe_state == :pending
+            method = client.next_method
+            client.check_response(method, Qrack::Protocol::Basic::CancelOk, "Error unsubscribing from queue #{queue.name}, got #{method.class}")
+
+            subscribe_state = :unsubscribed
+          end
+
           # Acknowledge receipt of the final message
           queue.ack() if @ack
+
           # Quit the loop
           break
         end

data/lib/qrack/transport/{buffer08.rb → buffer.rb}

@@ -267,6 +267,14 @@ module Qrack
         end
       end
 
+      def read_ready?(timeout, cancellator)
+        if @data.is_a?(Qrack::Client)
+          @data.read_ready?(timeout, cancellator)
+        else
+          true
+        end
+      end
+
       def _read(size, pack = nil)
         if @data.is_a?(Qrack::Client)
           raw = @data.read(size)

data/lib/qrack/transport/{frame08.rb → frame.rb}

@@ -3,7 +3,7 @@
 
 
 #:stopdoc:
-# this file was autogenerated on 2011-07-21 07:15:33 +0100
+# this file was autogenerated on 2012-02-28 11:22:27 -0500
 #
 # DO NOT EDIT! (edit ext/qparser.rb and config.yml instead, and run 'ruby qparser.rb')
 
@@ -18,10 +18,6 @@ module Qrack
                  1 => 'Method',
                  2 => 'Header',
                  3 => 'Body',
-                 4 => 'OobMethod',
-                 5 => 'OobHeader',
-                 6 => 'OobBody',
-                 7 => 'Trace',
                  8 => 'Heartbeat',
                }
 
@@ -55,8 +51,13 @@ module Qrack
         end
       end
 
-      def self.parse buf
+      def self.parse(buf, opts)
         buf = Transport::Buffer.new(buf) unless buf.is_a? Transport::Buffer
+
+        if opts[:timeout] or opts[:cancellator]
+          raise Qrack::FrameTimeout unless buf.read_ready?(opts[:timeout], opts[:cancellator])
+        end
+
         buf.extract do
           id, channel, payload, footer = buf.read(:octet, :short, :longstr, :octet)
           Qrack::Transport.const_get(@types[id]).new(payload, channel) if footer == FOOTER
@@ -93,22 +94,6 @@ module Qrack
       ID = 3
     end
 
-    class OobMethod < Frame
-      ID = 4
-    end
-
-    class OobHeader < Frame
-      ID = 5
-    end
-
-    class OobBody < Frame
-      ID = 6
-    end
-
-    class Trace < Frame
-      ID = 7
-    end
-
     class Heartbeat < Frame
       ID = 8
     end

data/spec/spec_09/bunny_spec.rb

@@ -13,7 +13,7 @@ require "bunny"
 describe Bunny do
 
   before(:each) do
-    @b = Bunny.new(:spec => '09')
+    @b = Bunny.new
     @b.start
   end
 
@@ -33,7 +33,7 @@ describe Bunny do
   it "should be able to create and open a new channel" do
     c = @b.create_channel
     c.number.should == 2
-    c.should be_an_instance_of(Bunny::Channel09)
+    c.should be_an_instance_of(Bunny::Channel)
     @b.channels.size.should == 3
     c.open.should == :open_ok
     @b.channel.number.should == 2
@@ -51,24 +51,26 @@ describe Bunny do
 
   it "should be able to create an exchange" do
     exch = @b.exchange('test_exchange')
-    exch.should be_an_instance_of(Bunny::Exchange09)
+    exch.should be_an_instance_of(Bunny::Exchange)
     exch.name.should == 'test_exchange'
     @b.exchanges.has_key?('test_exchange').should be(true)
   end
 
   it "should be able to create a queue" do
     q = @b.queue('test1')
-    q.should be_an_instance_of(Bunny::Queue09)
+    q.should be_an_instance_of(Bunny::Queue)
     q.name.should == 'test1'
     @b.queues.has_key?('test1').should be(true)
   end
 
-  it "should be able to set QoS" do
-    @b.qos.should == :qos_ok
+  # Current RabbitMQ has not implemented some functionality
+  it "should raise an error if setting of QoS fails" do
+    lambda { @b.qos(:global => true) }.should raise_error(Bunny::ForcedConnectionCloseError)
+    @b.status.should == :not_connected
   end
 
-  it "should be able to set QoS (with global:true)" do
-    @b.qos(:global => true).should == :qos_ok
+  it "should be able to set QoS" do
+    @b.qos.should == :qos_ok
   end
 
 end