amqp 0.8.0.rc13 → 0.8.0.rc14

data/lib/amqp/client.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 
-require "uri"
+require 'amq/client/settings'
 require "amqp/session"
 
 module AMQP
@@ -33,11 +33,16 @@ module AMQP
                Hash.new
              end
 
-      if block
-        AMQP.client.connect(opts.merge(options), &block)
-      else
-        AMQP.client.connect(opts.merge(options))
+      connection = if block
+                     AMQP.client.connect(opts.merge(options), &block)
+                   else
+                     AMQP.client.connect(opts.merge(options))
+                   end
+
+      connection.on_open do
+        require "amqp/extensions/rabbitmq" if connection.broker.rabbitmq?
       end
+      connection
     end
 
     # Parses AMQP connection URI and returns its components as a hash.
@@ -80,23 +85,7 @@ module AMQP
     # @see http://bit.ly/ks8MXK Connecting to The Broker documentation guide
     # @api public
     def self.parse_connection_uri(connection_string)
-      uri = URI.parse(connection_string)
-      raise ArgumentError.new("Connection URI must use amqp or amqps schema (example: amqp://bus.megacorp.internal:5766), learn more at http://bit.ly/ks8MXK") unless %w{amqp amqps}.include?(uri.scheme)
-
-      opts = {}
-
-      opts[:scheme] = uri.scheme
-      opts[:user]   = URI.unescape(uri.user) if uri.user
-      opts[:pass]   = URI.unescape(uri.password) if uri.password
-      opts[:host]   = uri.host if uri.host
-      opts[:port]   = uri.port || AMQP_PORTS[uri.scheme]
-      opts[:ssl]    = uri.scheme == AMQPS
-      if uri.path =~ %r{^/(.*)}
-        raise ArgumentError.new("#{uri} has multiple-segment path; please percent-encode any slashes in the vhost name (e.g. /production => %2Fproduction). Learn more at http://bit.ly/amqp-gem-and-connection-uris") if $1.index('/')
-        opts[:vhost] = URI.unescape($1)
-      end
-
-      opts
+      AMQ::Client::Settings.parse_amqp_url(connection_string)
     end
   end # Client
 

data/lib/amqp/compatibility/ruby187_patchlevel_check.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 if RUBY_VERSION =~ /^1.8.7/
   require "rbconfig"
   conf = RbConfig::CONFIG

data/lib/amqp/connection.rb

@@ -13,9 +13,8 @@ module AMQP
 
   # Starts EventMachine event loop unless it is already running and connects
   # to AMQP broker using {AMQP.connect}. It is generally a good idea to
-  # start EventMachine event loop in a separate thread and use {AMQP.connect}.
-  # That said, for applications that do not publish or handle large volumes of
-  # data {AMQP.start} works very well and its use is not discouraged.
+  # start EventMachine event loop in a separate thread and use {AMQP.connect}
+  # (for Web applications that do not use Thin or Goliath, it is the only option).
   #
   # See {AMQP.connect} for information about arguments this method takes and
   # information about relevant topics such as authentication failure handling.

data/lib/amqp/consumer.rb

@@ -0,0 +1,208 @@
+# encoding: utf-8
+
+require "amq/client/async/consumer"
+
+module AMQP
+  # AMQP consumers are entities that handle messages delivered to them ("push API" as opposed to "pull API") by AMQP broker.
+  # Every consumer is associated with a queue. Consumers can be exclusive (no other consumers can be registered for the same queue)
+  # or not (consumers share the queue). In the case of multiple consumers per queue, messages are distributed in round robin
+  # manner with respect to channel-level prefetch setting).
+  #
+  # @see AMQP::Queue
+  # @see AMQP::Queue#subscribe
+  # @see AMQP::Queue#cancel
+  class Consumer < AMQ::Client::Async::Consumer
+
+    #
+    # API
+    #
+
+    # @return [AMQP::Channel] Channel this consumer uses
+    attr_reader :channel
+    # @return [AMQP::Queue] Queue messages are consumed from
+    attr_reader :queue
+    # @return [String] Consumer tag, unique consumer identifier
+    attr_reader :consumer_tag
+    # @return [Hash] Custom subscription metadata
+    attr_reader :arguments
+
+
+    # @return [AMQ::Client::ConsumerTagGenerator] Consumer tag generator
+    def self.tag_generator
+      @tag_generator ||= AMQ::Client::ConsumerTagGenerator.new
+    end # self.tag_generator
+
+    # @param [AMQ::Client::ConsumerTagGenerator] Assigns consumer tag generator that will be used by consumer instances
+    # @return [AMQ::Client::ConsumerTagGenerator] Provided argument
+    def self.tag_generator=(generator)
+      @tag_generator = generator
+    end
+
+
+    def initialize(channel, queue, consumer_tag = nil, exclusive = false, no_ack = false, arguments = {}, no_local = false)
+      super(channel, queue, (consumer_tag || self.class.tag_generator.generate_for(queue)), exclusive, no_ack, arguments, no_local)
+    end # initialize
+
+    # @return [Boolean] true if this consumer is exclusive (other consumers for the same queue are not allowed)
+    def exclusive?
+      super
+    end # exclusive?
+
+
+
+    # Begin consuming messages from the queue
+    # @return [AMQP::Consumer] self
+    def consume(nowait = false, &block)
+      @channel.once_open do
+        @queue.once_declared do
+          super(nowait, &block)
+        end
+      end
+
+      self
+    end # consume(nowait = false, &block)
+
+    # Used by automatic recovery code.
+    # @api plugin
+    # @return [AMQP::Consumer] self
+    def resubscribe(&block)
+      @channel.once_open do
+        @queue.once_declared do
+          self.unregister_with_channel
+          @consumer_tag = self.class.tag_generator.generate_for(@queue)
+          self.register_with_channel
+
+          super(&block)
+        end
+      end
+
+      self
+    end # resubscribe(&block)
+
+    # @return [AMQP::Consumer] self
+    def cancel(nowait = false, &block)
+      @channel.once_open do
+        @queue.once_declared do
+          super(nowait, &block)
+        end
+      end
+
+      self
+    end # cancel(nowait = false, &block)
+
+    # {AMQP::Queue} API compatibility.
+    #
+    # @return [Boolean] true if this consumer is active (subscribed for message delivery)
+    # @api public
+    def subscribed?
+      !@callbacks[:delivery].empty?
+    end # subscribed?
+
+    # Legacy {AMQP::Queue} API compatibility.
+    # @private
+    # @deprecated
+    def callback
+      if @callbacks[:delivery]
+        @callbacks[:delivery].first
+      end
+    end # callback
+
+
+    # Register a block that will be used to handle delivered messages.
+    #
+    # @return [AMQP::Consumer] self
+    # @see AMQP::Queue#subscribe
+    def on_delivery(&block)
+      # We have to maintain this multiple arities jazz
+      # because older versions this gem are used in examples in at least 3
+      # books published by O'Reilly :(. MK.
+      delivery_shim = Proc.new { |basic_deliver, headers, payload|
+        case block.arity
+        when 1 then
+          block.call(payload)
+        when 2 then
+          h = Header.new(@channel, basic_deliver, headers.decode_payload)
+          block.call(h, payload)
+        else
+          h = Header.new(@channel, basic_deliver, headers.decode_payload)
+          block.call(h, payload, basic_deliver.consumer_tag, basic_deliver.delivery_tag, basic_deliver.redelivered, basic_deliver.exchange, basic_deliver.routing_key)
+        end
+      }
+
+      super(&delivery_shim)
+    end # on_delivery(&block)
+
+
+    # @group Acknowledging & Rejecting Messages
+
+    # Acknowledge a delivery tag.
+    # @return [Consumer]  self
+    #
+    # @api public
+    # @see http://bit.ly/htCzCX AMQP 0.9.1 protocol documentation (Section 1.8.3.13.)
+    def acknowledge(delivery_tag)
+      super(delivery_tag)
+    end # acknowledge(delivery_tag)
+
+    #
+    # @return [Consumer]  self
+    #
+    # @api public
+    # @see http://bit.ly/htCzCX 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)
+
+    # @endgroup
+
+
+    # @group Error Handling & Recovery
+
+    # Defines a callback that will be executed after TCP connection is interrupted (typically because of a network failure).
+    # Only one callback can be defined (the one defined last replaces previously added ones).
+    #
+    # @api public
+    def on_connection_interruption(&block)
+      super(&block)
+    end # on_connection_interruption(&block)
+    alias after_connection_interruption on_connection_interruption
+
+
+    # Defines a callback that will be executed after TCP connection is recovered after a network failure
+    # but before AMQP connection is re-opened.
+    # Only one callback can be defined (the one defined last replaces previously added ones).
+    #
+    # @api public
+    def before_recovery(&block)
+      super(&block)
+    end # before_recovery(&block)
+
+    # Defines a callback that will be executed when AMQP connection is recovered after a network failure..
+    # Only one callback can be defined (the one defined last replaces previously added ones).
+    #
+    # @api public
+    def on_recovery(&block)
+      super(&block)
+    end # on_recovery(&block)
+    alias after_recovery on_recovery
+
+
+    # Called by associated connection object when AMQP connection has been re-established
+    # (for example, after a network failure).
+    #
+    # @api plugin
+    def auto_recover
+      super
+    end # auto_recover
+
+    # @endgroup
+
+
+    # @return [String] Readable representation of relevant object state.
+    def inspect
+      "#<AMQP::Consumer:#{@consumer_tag}> queue=#{@queue.name} channel=#{@channel.id} callbacks=#{@callbacks.inspect}"
+    end # inspect
+
+
+  end # Consumer
+end # AMQP

data/lib/amqp/deprecated/fork.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require "amqp/ext/em"
 
 module AMQP

data/lib/amqp/deprecated/mq.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 # Alias for AMQP::Channel.
 #
 # @note This class will be removed before 1.0 release.

data/lib/amqp/exchange.rb

@@ -374,10 +374,10 @@ module AMQP
     #
     # h2. Data serialization
     #
-    # Note that this method calls #to_s on payload argument value. You are encouraged to take care of
+    # Note that this method calls #to_s on payload argument value. Applications are encouraged of
     # data serialization before publishing (using JSON, Thrift, Protocol Buffers or other serialization library).
-    # Note that because AMQP is a binary protocol, text formats like JSON lose lose their strong point of being easy
-    # to inspect data as it travels across network. For the same reason BSON may be a good fit.
+    # Note that because AMQP is a binary protocol, text formats like JSON largely lose their strong point of being easy
+    # to inspect as data travels across network, so "BSON":http://bsonspec.org may be a good fit.
     #
     #
     # h2. Publishing and message persistence
@@ -477,7 +477,9 @@ module AMQP
       opts    = @default_publish_options.merge(options)
 
       @channel.once_open do
-        super(payload.to_s, opts[:key] || opts[:routing_key] || @default_routing_key, @default_headers.merge(options), opts[:mandatory], opts[:immediate])
+        properties                 = @default_headers.merge(options)
+        properties[:delivery_mode] = properties.delete(:persistent) ? 2 : 1
+        super(payload.to_s, opts[:key] || opts[:routing_key] || @default_routing_key, properties, opts[:mandatory], opts[:immediate])
 
         # don't pass block to AMQ::Client::Exchange#publish because it will be executed
         # immediately and we want to do it later. See ruby-amqp/amqp/#67 MK.

data/lib/amqp/extensions/rabbitmq.rb

@@ -1 +1,3 @@
-require "amq/client/extensions/rabbitmq"
+# encoding: utf-8
+
+require "amq/client/extensions/rabbitmq"

data/lib/amqp/header.rb

@@ -1,27 +1,31 @@
 # encoding: utf-8
 
 module AMQP
-  # We keep this class around for sake of API compatibility with 0.7.x series.
-  #
-  # @note This class is not part of the public API and may be removed in the future without any warning.
+  # Message metadata (aka envelope).
   class Header
 
     #
     # API
     #
 
+    # @api public
     # @return [AMQP::Channel]
     attr_reader :channel
-    # AMQP method frame this header is associated with. Carries additional information that varies between AMQP methods.
+
+    # AMQP method frame this header is associated with.
+    # Carries additional information that varies between AMQP methods.
+    #
+    # @api public
     # @return [AMQ::Protocol::Method]
     attr_reader :method
-    # AMQP message header as a hash
+
+    # AMQP message attributes
     # @return [Hash]
-    attr_reader :header
+    attr_reader :attributes
 
     # @api public
-    def initialize(channel, method, header)
-      @channel, @method, @header = channel, method, header
+    def initialize(channel, method, attributes)
+      @channel, @method, @attributes = channel, method, attributes
     end
 
     # Acknowledges the receipt of this message with the server.
@@ -41,18 +45,76 @@ module AMQP
     # @return [Hash] AMQP message header w/o method-specific information.
     # @api public
     def to_hash
-      @header
+      @attributes
     end # to_hash
 
-    def respond_to_missing?(meth, _)
-      (@header && args.empty? && blk.nil? && @header.has_key?(meth)) || @method.respond_to?(meth)
-    end
+    def delivery_tag
+      @method.delivery_tag
+    end # delivery_tag
+
+    def consumer_tag
+      @method.consumer_tag
+    end # consumer_tag
+
+    def redelivered
+      @method.redelivered
+    end # redelivered
+
+    def redelivered?
+      @method.redelivered
+    end # redelivered?
+
+    def exchange
+      @method.exchange
+    end # exchange
+
+    # @deprecated
+    def header
+      @attributes
+    end # header
+
+    def headers
+      @attributes[:headers]
+    end # headers
+
+    def delivery_mode
+      @attributes[:delivery_mode]
+    end # delivery_mode
+
+    def content_type
+      @attributes[:content_type]
+    end # content_type
+
+    def timestamp
+      @attributes[:timestamp]
+    end # timestamp
+
+    def type
+      @attributes[:type]
+    end # type
+
+    def priority
+      @attributes[:priority]
+    end # priority
+
+    def reply_to
+      @attributes[:reply_to]
+    end # reply_to
+
+    def correlation_id
+      @attributes[:correlation_id]
+    end # correlation_id
+
+    def message_id
+      @attributes[:message_id]
+    end # message_id
+
 
     # Returns AMQP message attributes.
     # @api public
     def method_missing(meth, *args, &blk)
-      if @header && args.empty? && blk.nil? && @header.has_key?(meth)
-        @header[meth]
+      if @attributes && args.empty? && blk.nil? && @attributes.has_key?(meth)
+        @attributes[meth]
       else
         @method.__send__(meth, *args, &blk)
       end