amqp 1.0.0.pre2 → 1.0.0

data/lib/amqp/client.rb

@@ -22,7 +22,7 @@ module AMQP
     # @see AMQP.connect
     # @api plugin
     #
-    # @see http://bit.ly/ks8MXK Connecting to The Broker documentation guide
+    # @see http://rubyamqp.info/articles/connecting_to_broker/ Connecting to The Broker documentation guide
     def self.connect(connection_string_or_options = {}, options = {}, &block)
       opts = case connection_string_or_options
              when String then
@@ -82,7 +82,7 @@ module AMQP
     #
     # @raise [ArgumentError] When connection URI schema is not amqp or amqps, or the path contains multiple segments
     #
-    # @see http://bit.ly/ks8MXK Connecting to The Broker documentation guide
+    # @see http://rubyamqp.info/articles/connecting_to_broker/ Connecting to The Broker documentation guide
     # @api public
     def self.parse_connection_uri(connection_string)
       AMQ::Client::Settings.parse_amqp_url(connection_string)

data/lib/amqp/connection.rb

@@ -54,7 +54,7 @@ module AMQP
   # Pass it a block if you want a piece of code to be run once default connection
   # is successfully closed.
   #
-  # @note If default connection was never estabilished or is in the closing state already,
+  # @note If default connection was never established or is in the closing state already,
   #       this method has no effect.
   # @api public
   def self.stop(reply_code = 200, reply_text = "Goodbye", &block)
@@ -192,6 +192,7 @@ module AMQP
   # @option connection_options_or_string [String]  :username ("guest") Username to use. Also can be specified as :user.
   # @option connection_options_or_string [String]  :password ("guest") Password to use. Also can be specified as :pass.
   # @option connection_options_or_string [Hash]  :ssl TLS (SSL) parameters to use.
+  # @option connection_options_or_string [Fixnum] :heartbeat (0) Connection heartbeat, in seconds. 0 means no heartbeat. Can also be configured server-side starting with RabbitMQ 3.0.
   # @option connection_options_or_string [#call]  :on_tcp_connection_failure A callable object that will be run if connection to server fails
   # @option connection_options_or_string [#call]  :on_possible_authentication_failure A callable object that will be run if authentication fails (see Authentication failure section)
   #

data/lib/amqp/consumer.rb

@@ -139,7 +139,7 @@ module AMQP
     # @return [Consumer]  self
     #
     # @api public
-    # @see http://bit.ly/htCzCX AMQP 0.9.1 protocol documentation (Section 1.8.3.13.)
+    # @see http://files.travis-ci.org/docs/amqp/0.9.1/AMQP091Reference.pdf AMQP 0.9.1 protocol documentation (Section 1.8.3.13.)
     def acknowledge(delivery_tag)
       super(delivery_tag)
     end # acknowledge(delivery_tag)
@@ -148,7 +148,7 @@ module AMQP
     # @return [Consumer]  self
     #
     # @api public
-    # @see http://bit.ly/htCzCX AMQP 0.9.1 protocol documentation (Section 1.8.3.14.)
+    # @see http://files.travis-ci.org/docs/amqp/0.9.1/AMQP091Reference.pdf AMQP 0.9.1 protocol documentation (Section 1.8.3.14.)
     def reject(delivery_tag, requeue = true)
       super(delivery_tag, requeue)
     end # reject(delivery_tag, requeue = true)

data/lib/amqp/exceptions.rb

@@ -30,7 +30,7 @@ module AMQP
       @settings = settings
       @cause    = cause
 
-      super("Could not estabilish TCP connection to #{@settings[:host]}:#{@settings[:port]}")
+      super("Could not establish TCP connection to #{@settings[:host]}:#{@settings[:port]}")
     end # TCPConnectionFailed
   end
 
@@ -43,8 +43,17 @@ module AMQP
     def initialize(settings)
       @settings = settings
 
-      super("AMQP broker closed TCP connection before authentication succeeded: this usually means authentication failure due to misconfiguration. Settings are #{settings.inspect}")
+      super("AMQP broker closed TCP connection before authentication succeeded: this usually means authentication failure due to misconfiguration. Settings are #{filtered_settings.inspect}")
     end # initialize(settings)
+
+    def filtered_settings
+      filtered_settings = settings.dup
+      [:pass, :password].each do |sensitve_setting|
+        filtered_settings[sensitve_setting] &&= '[filtered]'
+      end
+
+      filtered_settings
+    end
   end # PossibleAuthenticationFailureError
 
 

data/lib/amqp/exchange.rb

@@ -134,9 +134,9 @@ module AMQP
   # @see Channel#topic
   # @see Channel#headers
   # @see Queue
-  # @see http://bit.ly/hw2ELX AMQP 0.9.1 specification (Section 2.1.1)
-  # @see http://bit.ly/hw2ELX AMQP 0.9.1 specification (Section 2.1.5)
-  # @see http://bit.ly/hw2ELX AMQP 0.9.1 specification (Section 3.1.3)
+  # @see http://files.travis-ci.org/docs/amqp/0.9.1/AMQP091Specification.pdf AMQP 0.9.1 specification (Section 2.1.1)
+  # @see http://files.travis-ci.org/docs/amqp/0.9.1/AMQP091Specification.pdf AMQP 0.9.1 specification (Section 2.1.5)
+  # @see http://files.travis-ci.org/docs/amqp/0.9.1/AMQP091Specification.pdf AMQP 0.9.1 specification (Section 3.1.3)
   class Exchange < AMQ::Client::Exchange
 
     #
@@ -162,7 +162,7 @@ module AMQP
     #   AMQP::Exchange.default(channel).publish("make clean", routing_key => "tasks")
     #
     # @see Exchange
-    # @see http://bit.ly/hw2ELX AMQP 0.9.1 specification (Section 2.1.2.4)
+    # @see http://files.travis-ci.org/docs/amqp/0.9.1/AMQP091Specification.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
     #       exchange that doesn't have any special routing semantics.
     # @return [Exchange] An instance that corresponds to the default exchange (of type direct).
@@ -292,7 +292,7 @@ module AMQP
     # @see Channel#topic
     # @see Channel#headers
     # @see Queue
-    # @see http://bit.ly/hw2ELX AMQP 0.9.1 specification (Section 3.1.3)
+    # @see http://files.travis-ci.org/docs/amqp/0.9.1/AMQP091Specification.pdf AMQP 0.9.1 specification (Section 3.1.3)
     #
     # @return [Exchange]
     # @api public

data/lib/amqp/queue.rb

@@ -97,7 +97,7 @@ module AMQP
   #
   # h2. Queue durability and persistence of messages.
   #
-  # Learn more in our {file:docs/Durability.textile Durability guide}.
+  # Learn more in our {http://rubyamqp.info/articles/durability/}.
   #
   #
   # h2. Message ordering
@@ -112,11 +112,11 @@ module AMQP
   # Learn more in {file:docs/ErrorHandling.textile Error Handling guide}.
   #
   #
-  # @note Please make sure you read {file:docs/Durability.textile Durability guide} that covers exchanges durability vs. messages
+  # @note Please make sure you read {http://rubyamqp.info/articles/durability/} that covers exchanges durability vs. messages
   #       persistence.
   #
   #
-  # @see http://bit.ly/hw2ELX AMQP 0.9.1 specification (Section 2.1.1)
+  # @see http://files.travis-ci.org/docs/amqp/0.9.1/AMQP091Specification.pdf AMQP 0.9.1 specification (Section 2.1.1)
   # @see AMQP::Exchange
   class Queue < AMQ::Client::Queue
 
@@ -221,7 +221,11 @@ module AMQP
     #
     # @api public
     def once_declared(&block)
-      @declaration_deferrable.callback(&block)
+      @declaration_deferrable.callback do
+        # guards against cases when deferred operations
+        # don't complete before the channel is closed
+        block.call if @channel.open?
+      end
     end # once_declared(&block)
 
 
@@ -281,14 +285,8 @@ module AMQP
     # @api public
     # @see Queue#unbind
     def bind(exchange, opts = {}, &block)
-      if self.server_named?
-        @channel.once_open do
-          @declaration_deferrable.callback do
-            super(exchange, (opts[:key] || opts[:routing_key] || AMQ::Protocol::EMPTY_STRING), (opts[:nowait] || block.nil?), opts[:arguments], &block)
-          end
-        end
-      else
-        @channel.once_open do
+      @channel.once_open do
+        self.once_name_is_available do
           super(exchange, (opts[:key] || opts[:routing_key] || AMQ::Protocol::EMPTY_STRING), (opts[:nowait] || block.nil?), opts[:arguments], &block)
         end
       end
@@ -345,7 +343,8 @@ module AMQP
     # {Queue#subscribe} or {Queue#pop} call.
     #
     # @param [Exchange] Exchange to unbind from.
-    #
+    # @option opts [String] :routing_key Binding routing key
+    # @option opts [Hash] :arguments Binding arguments
     # @option opts [Boolean] :nowait (true)  If set, the server will not respond to the method. The client should
     #                                       not wait for a reply method.  If the server could not complete the
     #                                       method it will raise a channel or connection exception.
@@ -357,7 +356,9 @@ module AMQP
     # @see Queue#bind
     def unbind(exchange, opts = {}, &block)
       @channel.once_open do
-        super(exchange, (opts[:key] || opts[:routing_key] || AMQ::Protocol::EMPTY_STRING), opts[:arguments], &block)
+        self.once_name_is_available do
+          super(exchange, (opts[:key] || opts[:routing_key] || AMQ::Protocol::EMPTY_STRING), opts[:arguments], &block)
+        end
       end
     end
 
@@ -391,7 +392,9 @@ module AMQP
     # @see Queue#unbind
     def delete(opts = {}, &block)
       @channel.once_open do
-        super(opts.fetch(:if_unused, false), opts.fetch(:if_empty, false), opts.fetch(:nowait, false), &block)
+        self.once_name_is_available do
+          super(opts.fetch(:if_unused, false), opts.fetch(:if_empty, false), opts.fetch(:nowait, false), &block)
+        end
       end
 
       # backwards compatibility
@@ -416,7 +419,9 @@ module AMQP
     # @see Queue#unbind
     def purge(opts = {}, &block)
       @channel.once_open do
-        super(opts.fetch(:nowait, false), &block)
+        self.once_declared do
+          super(opts.fetch(:nowait, false), &block)
+        end
       end
 
       # backwards compatibility
@@ -477,11 +482,17 @@ module AMQP
         }
 
         @channel.once_open do
-          # see AMQ::Client::Queue#get in amq-client
-          self.get(!opts.fetch(:ack, false), &shim)
+          self.once_name_is_available do
+            # see AMQ::Client::Queue#get in amq-client
+            self.get(!opts.fetch(:ack, false), &shim)
+          end
         end
       else
-        @channel.once_open { self.get(!opts.fetch(:ack, false)) }
+        @channel.once_open do
+          self.once_name_is_available do
+            self.get(!opts.fetch(:ack, false))
+          end
+        end
       end
     end
 
@@ -719,7 +730,9 @@ module AMQP
       opts[:nowait] = false if (@on_confirm_subscribe = opts[:confirm])
 
       @channel.once_open do
-        self.once_declared do
+        self.once_name_is_available do
+          # guards against a pathological case race condition when a channel
+          # is opened and closed before delayed operations are completed.
           self.consume(!opts[:ack], opts[:exclusive], (opts[:nowait] || block.nil?), opts[:no_local], nil, &opts[:confirm])
 
           self.on_delivery(&block)
@@ -785,7 +798,7 @@ module AMQP
     # @api public
     def unsubscribe(opts = {}, &block)
       @channel.once_open do
-        self.once_declared do
+        self.once_name_is_available do
           if @default_consumer
             @default_consumer.cancel(opts.fetch(:nowait, true), &block); @default_consumer = nil
           end
@@ -812,12 +825,14 @@ module AMQP
       shim = Proc.new { |q, declare_ok| block.call(declare_ok.message_count, declare_ok.consumer_count) }
 
       @channel.once_open do
-        # we do not use self.declare here to avoid caching of @passive since that will cause unexpected side-effects during automatic
-        # recovery process. MK.
-        @connection.send_frame(AMQ::Protocol::Queue::Declare.encode(@channel.id, @name, true, @opts[:durable], @opts[:exclusive], @opts[:auto_delete], false, @opts[:arguments]))
+        self.once_name_is_available do
+          # we do not use self.declare here to avoid caching of @passive since that will cause unexpected side-effects during automatic
+          # recovery process. MK.
+          @connection.send_frame(AMQ::Protocol::Queue::Declare.encode(@channel.id, @name, true, @opts[:durable], @opts[:exclusive], @opts[:auto_delete], false, @opts[:arguments]))
 
-        self.append_callback(:declare, &shim)
-        @channel.queues_awaiting_declare_ok.push(self)
+          self.append_callback(:declare, &shim)
+          @channel.queues_awaiting_declare_ok.push(self)
+        end
       end
 
       self
@@ -883,6 +898,16 @@ module AMQP
       { :queue => name, :nowait => (block.nil? && !name.empty?) }.merge(opts)
     end
 
+    def once_name_is_available(&block)
+      if server_named?
+        self.once_declared do
+          block.call
+        end
+      else
+        block.call
+      end
+    end
+
     private
 
     # Default direct exchange that we use to publish messages directly to this queue.

data/lib/amqp/session.rb

@@ -110,7 +110,7 @@ module AMQP
 
 
     # Properly close connection with AMQ broker, as described in
-    # section 2.2.4 of the {http://bit.ly/hw2ELX AMQP 0.9.1 specification}.
+    # section 2.2.4 of the {http://files.travis-ci.org/docs/amqp/0.9.1/AMQP091Specification.pdf AMQP 0.9.1 specification}.
     #
     # @api  plugin
     # @see  #close_connection
@@ -129,19 +129,19 @@ module AMQP
     # Server properties (product information, platform, et cetera)
     #
     # @return [Hash]
-    # @see http://bit.ly/htCzCX AMQP 0.9.1 protocol documentation (Section 1.4.2.1.3)
+    # @see http://files.travis-ci.org/docs/amqp/0.9.1/AMQP091Reference.pdf AMQP 0.9.1 protocol documentation (Section 1.4.2.1.3)
     attr_reader :server_properties
 
     # Server capabilities (usually used to detect AMQP 0.9.1 extensions like basic.nack, publisher
     # confirms and so on)
     #
     # @return [Hash]
-    # @see http://bit.ly/htCzCX AMQP 0.9.1 protocol documentation (Section 1.4.2.1.3)
+    # @see http://files.travis-ci.org/docs/amqp/0.9.1/AMQP091Reference.pdf AMQP 0.9.1 protocol documentation (Section 1.4.2.1.3)
     attr_reader :server_capabilities
 
     # Locales server supports
     #
-    # @see http://bit.ly/htCzCX AMQP 0.9.1 protocol documentation (Section 1.4.2.1.3)
+    # @see http://files.travis-ci.org/docs/amqp/0.9.1/AMQP091Reference.pdf AMQP 0.9.1 protocol documentation (Section 1.4.2.1.3)
     attr_reader :server_locales
 
     # @return [AMQP::Broker] Broker this connection is established with
@@ -186,7 +186,7 @@ module AMQP
       super(&block)
     end
 
-    # Defines a callback that will be run when initial TCP connection fails.
+    # Defines a callback that will be run when TCP connection to AMQP broker is lost (interrupted).
     # You can define only one callback.
     #
     # @api public

data/lib/amqp/version.rb

@@ -6,5 +6,5 @@ module AMQP
   #
   # @see AMQ::Protocol::VERSION
   # @return [String] AMQP gem version
-  VERSION = '1.0.0.pre2'
+  VERSION = '1.0.0'
 end

data/spec/integration/basic_get_spec.rb

@@ -24,9 +24,7 @@ describe AMQP::Queue, "#pop" do
     @exchange = @channel.fanout("amqpgem.integration.basic.get.queue", :auto_delete => true)
     @queue    = @channel.queue(@queue_name, :auto_delete => true)
 
-    @queue.bind(@exchange) do
-      puts "Bound #{@exchange.name} => #{@queue.name}"
-    end
+    @queue.bind(@exchange)
 
     @dispatched_data = "fetch me synchronously"
   end
@@ -61,36 +59,93 @@ describe AMQP::Queue, "#pop" do
 
   context "when THERE ARE messages in the queue" do
     it "yields message payload to the callback" do
-      number_of_received_messages = 0
-      expected_number_of_messages = 300
-
-      expected_number_of_messages.times do |i|
-        @exchange.publish(@dispatched_data + "_#{i}", :key => @queue_name)
-      end
+      @channel.default_exchange.publish(@dispatched_data, :routing_key => @queue.name)
 
-      @queue.status do |number_of_messages, number_of_consumers|
-        expected_number_of_messages.times do
-          @queue.pop do |headers, payload|
-            payload.should_not be_nil
-            number_of_received_messages += 1
-            headers.message_count.should == (expected_number_of_messages - number_of_received_messages)
-
-            if RUBY_VERSION =~ /^1.9/
-              payload.force_encoding("UTF-8").should =~ /#{@dispatched_data}/
-            else
-              payload.should =~ /#{@dispatched_data}/
-            end
-          end # pop
-        end # do
+      @queue.pop do |headers, payload|
+        payload.should == @dispatched_data
       end
 
-      delayed(1.3) {
+      delayed(0.5) {
         # Queue.Get doesn't qualify for subscription, hence, manual deletion is required
         @queue.delete
       }
-      done(2.5) {
-        number_of_received_messages.should == expected_number_of_messages
-      }
+      done(0.8)
     end # it
   end # context
+
+
+  context "with manual acknowledgements" do
+    default_timeout 4
+
+    let(:queue_name) { "amqpgem.integration.basic.get.acks.manual#{rand}" }
+
+    it "does not remove messages from the queue unless ack-ed" do
+      ch1 = AMQP::Channel.new
+      ch2 = AMQP::Channel.new
+
+      ch1.on_error do |ch, close_ok|
+        puts "Channel error: #{close_ok.reply_code} #{close_ok.reply_text}"
+      end
+
+      q  = ch1.queue(queue_name, :exclusive => true)
+      x  = ch1.default_exchange
+
+      q.purge
+      delayed(0.2) { x.publish(@dispatched_data, :routing_key => q.name) }
+
+      delayed(0.5) {
+        q.pop(:ack => true) do |meta, payload|
+          # never ack
+        end
+
+        ch1.close
+
+        EventMachine.add_timer(0.7) {
+          ch2.queue(queue_name, :exclusive => true).status do |number_of_messages, number_of_consumers|
+            number_of_messages.should == 1
+            done
+          end
+        }
+      }
+    end
+  end
+
+
+
+  context "with automatic acknowledgements" do
+    default_timeout 4
+
+    let(:queue_name) { "amqpgem.integration.basic.get.acks.automatic#{rand}" }
+
+    it "does remove messages from the queue after delivery" do
+      ch1 = AMQP::Channel.new
+      ch2 = AMQP::Channel.new
+
+      ch1.on_error do |ch, close_ok|
+        puts "Channel error: #{close_ok.reply_code} #{close_ok.reply_text}"
+      end
+
+      q  = ch1.queue(queue_name, :exclusive => true)
+      x  = ch1.default_exchange
+
+      q.purge
+      x.publish(@dispatched_data, :routing_key => q.name)
+
+      delayed(0.5) {
+        q.pop(:ack => false) do |meta, payload|
+          # never ack
+        end
+
+        ch1.close
+
+        EventMachine.add_timer(0.5) {
+          ch2.queue(queue_name, :exclusive => true).status do |number_of_messages, number_of_consumers|
+            number_of_messages.should == 0
+            done
+          end
+        }
+      }
+    end
+  end
+
 end # describe