amqp 0.7.0.pre → 0.7.0

data/lib/mq/collection.rb

@@ -1,6 +1,7 @@
 # encoding: utf-8
 
 class MQ
+  # MQ::Collection is used to store named AMQ model entities (exchanges, queues)
   class Collection < ::Array
     class IncompatibleItemError < ArgumentError
       def initialize(item)
@@ -21,15 +22,17 @@ class MQ
     # run declare twice in order to change options, because the AMQP
     # broker closes the connection if we try to do so).
 
-    # Use Collection#<< for adding items to the collection.
+    # Use Collection# << for adding items to the collection.
     undef_method :[]=
 
     def <<(item)
-      if (item.name rescue nil).nil? || ! self[item.name]
+      if (item.name rescue nil).nil? || !self[item.name]
         self.add!(item)
       end
 
-      return item
+      # We can't just return the item, because in case the item isn't added
+      # to the collection, then it'd be different from self[item.name].
+      return self[item.name]
     end
 
     alias_method :__push__, :push
@@ -45,88 +48,3 @@ class MQ
     end
   end
 end
-
-if $0 =~ /bacon/ or $0 == __FILE__
-  require "bacon"
-
-  Item = Struct.new(:name)
-
-  describe MQ::Collection do
-    before do
-      @items = 3.times.map { |int| Item.new("name-#{int}") }
-      @collection = MQ::Collection.new(@items)
-    end
-
-    describe "accessors" do
-      should "be accessible by its name" do
-        @collection["name-1"].should.not.be.nil
-        @collection["name-1"].should.eql(@items[1])
-      end
-
-      should "not allow to change already existing object" do
-        lambda { @collection["name-1"] = Item.new("test") }.should.raise(NoMethodError)
-      end
-    end
-
-    describe "#<<" do
-      should "raise IncompatibleItemError if the argument doesn't have method :name" do
-        lambda { @collection << nil }.should.raise(MQ::Collection::IncompatibleItemError)
-      end
-
-      should "add an item into the collection" do
-        length = @collection.length
-        @collection << Item.new("test")
-        @collection.length.should.eql(length + 1)
-      end
-
-      should "not add an item to the collection if another item with given name already exists and the name IS NOT nil" do
-        @collection << Item.new("test")
-        length = @collection.length
-        @collection << Item.new("test")
-        @collection.length.should.eql(length)
-      end
-
-      should "add an item to the collection if another item with given name already exists and the name IS nil" do
-        @collection << Item.new(nil)
-        length = @collection.length
-        @collection << Item.new(nil)
-        @collection.length.should.eql(length + 1)
-      end
-
-      should "return the item" do
-        item = Item.new("test")
-        (@collection << item).should.eql item
-      end
-
-      should "return the item even if it already existed" do
-        item = Item.new("test")
-        @collection << item
-        (@collection << item).should.eql item
-      end
-    end
-
-    describe "#add!" do
-      should "raise IncompatibleItemError if the argument doesn't have method :name" do
-        lambda { @collection << nil }.should.raise(MQ::Collection::IncompatibleItemError)
-      end
-
-      should "add an item into the collection" do
-        length = @collection.length
-        @collection << Item.new("test")
-        @collection.length.should.eql(length + 1)
-      end
-
-      should "add an item to the collection if another item with given name already exists" do
-        @collection.add! Item.new("test")
-        length = @collection.length
-        @collection.add! Item.new("test")
-        @collection.length.should.eql(length + 1)
-      end
-
-      should "return the item" do
-        item = Item.new("test")
-        (@collection << item).should.eql item
-      end
-    end
-  end
-end

data/lib/mq/exchange.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 class MQ
   # An Exchange acts as an ingress point for all published messages. An
   # exchange may also be described as a router or a matcher. Every
@@ -20,8 +22,41 @@ class MQ
   # the default exchange for publishing the messages.
   #
   class Exchange
+
+    #
+    # Behaviors
+    #
+
     include AMQP
 
+
+
+    #
+    # API
+    #
+
+
+    # The default exchange.
+    # Every queue is bind to this (direct) exchange by default.
+    # You can't remove it or bind there queue explicitly.
+
+    # Do NOT confuse with amq.direct: it's only a normal direct
+    # exchange and the only special thing about it is that it's
+    # predefined in the system, so you can use it straightaway.
+
+    # Example:
+    # MQ.new.queue("tasks")
+    # MQ::Exchange.default.publish("make clean", routing_key: "tasks")
+
+    # For more info see section 2.1.2.4 Automatic Mode of the AMQP 0.9.1 spec.
+    def self.default
+      @@default ||= self.new(MQ.new, :direct, "", :no_declare => true)
+    end
+
+    def self.add_default_options(type, name, opts, block)
+      { :exchange => name, :type => type, :nowait => block.nil? }.merge(opts)
+    end
+
     # Defines, intializes and returns an Exchange to act as an ingress
     # point for all published messages.
     #
@@ -194,14 +229,15 @@ class MQ
     # sensitive to the ordering of clients' actions!
     #
     # == Exceptions
-    # Doing any of these activities are illegal and will raise MQ:Error.
-    # * redeclare an already-declared exchange to a different type
+    # Doing any of these activities are illegal and will raise exceptions:
+    # 
+    # * redeclare an already-declared exchange to a different type (raises MQ::IncompatibleOptionsError)
     # * :passive => true and the exchange does not exist (NOT_FOUND)
     #
-    def initialize mq, type, name, opts = {}, &block
+    def initialize(mq, type, name, opts = {}, &block)
       @mq = mq
       @type, @opts = type, opts
-      @opts = { :exchange => name, :type => type, :nowait => block.nil? }.merge(opts)
+      @opts = self.class.add_default_options(type, name, opts, block)
       @key = opts[:key]
       @name = name unless name.empty?
       @status = :unknown
@@ -225,7 +261,7 @@ class MQ
         # Call the callback immediately, as given exchange is already
         # declared.
         @status = :finished
-        block.call(self)
+        block.call(self) if block
       end
 
       self.callback = block
@@ -274,8 +310,8 @@ class MQ
     # message stays in memory and is never persisted to non-volatile (slow)
     # storage.
     #
-    def publish data, opts = {}
-      @mq.callback{
+    def publish(data, opts = {})
+      @mq.callback {
         out = []
 
         out << Protocol::Basic::Publish.new({ :exchange => name,
@@ -317,8 +353,8 @@ class MQ
     # bindings. If the exchange has queue bindings the server does not
     # delete it but raises a channel exception instead (MQ:Error).
     #
-    def delete opts = {}
-      @mq.callback{
+    def delete(opts = {})
+      @mq.callback {
         @mq.send Protocol::Exchange::Delete.new({ :exchange => name,
                                                   :nowait => true }.merge(opts))
         @mq.exchanges.delete name
@@ -326,13 +362,34 @@ class MQ
       nil
     end
 
+
+    def durable?
+      !!@opts[:durable]
+    end # durable?
+
+    def transient?
+      !self.durable?
+    end # transient?
+
+    def auto_deleted?
+      !!@opts[:auto_delete]
+    end # auto_deleted?
+    alias auto_deletable? auto_deleted?
+
+
     def reset
       @deferred_status = nil
       initialize @mq, @type, @name, @opts
     end
 
-    def receive_response response
+
+
+    #
+    # Implementation
+    #
+
+    def receive_response(response)
       self.callback && self.callback.call(self)
-    end
-  end
-end
+    end # receive_response
+  end # Exchange
+end # MQ

data/lib/mq/header.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 class MQ
   class Header
     include AMQP
@@ -9,20 +11,24 @@ class MQ
 
     # Acknowledges the receipt of this message with the server.
     def ack
-      @mq.callback{
+      @mq.callback {
         @mq.send Protocol::Basic::Ack.new(:delivery_tag => properties[:delivery_tag])
       }
     end
 
     # Reject this message (XXX currently unimplemented in rabbitmq)
     # * :requeue => true | false (default false)
-    def reject opts = {}
-      @mq.callback{
-        @mq.send Protocol::Basic::Reject.new(opts.merge(:delivery_tag => properties[:delivery_tag]))
-      }
+    def reject(opts = {})
+      if @mq.broker.server_properties[:product] == "RabbitMQ"
+        raise NotImplementedError.new("RabbitMQ doesn't implement the Basic.Reject method\nSee http://lists.rabbitmq.com/pipermail/rabbitmq-discuss/2009-February/002853.html")
+      else
+        @mq.callback {
+          @mq.send Protocol::Basic::Reject.new(opts.merge(:delivery_tag => properties[:delivery_tag]))
+        }
+      end
     end
 
-    def method_missing meth, *args, &blk
+    def method_missing(meth, *args, &blk)
       @header.send meth, *args, &blk
     end
 

data/lib/mq/logger.rb

@@ -1,6 +1,8 @@
+# encoding: utf-8
+
 class MQ
   class Logger
-    def initialize *args, &block
+    def initialize(*args, &block)
       opts = args.pop if args.last.is_a? Hash
       opts ||= {}
 
@@ -13,7 +15,7 @@ class MQ
     attr_reader :prop
     alias :base :prop
 
-    def log severity, *args
+    def log(severity, *args)
       opts = args.pop if args.last.is_a? Hash and args.size != 1
       opts ||= {}
       opts = @prop.clone.update(opts)
@@ -56,7 +58,7 @@ class MQ
     end
     alias :method_missing :log
 
-    def print data = nil, &block
+    def print(data = nil, &block)
       if block
         @printer = block
       elsif data.is_a? Proc
@@ -68,7 +70,7 @@ class MQ
       end
     end
     alias :printer :print
-    
+
     def self.printer &block
       @printer = block if block
       @printer
@@ -77,13 +79,13 @@ class MQ
     def self.disabled?
       !!@disabled
     end
-    
+
     def self.enable
       @disabled = false
     end
-    
+
     def self.disable
       @disabled = true
     end
   end
-end
+end

data/lib/mq/queue.rb

@@ -1,7 +1,13 @@
+# encoding: utf-8
+
 class MQ
   class Queue
     include AMQP
 
+    def self.add_default_options(name, opts, block)
+      { :queue => name, :nowait => block.nil? }.merge(opts)
+    end
+
     # Queues store and forward messages.  Queues can be configured in the server
     # or created at runtime.  Queues must be attached to at least one exchange
     # in order to receive messages from publishers.
@@ -15,8 +21,8 @@ class MQ
     #
     # == Options
     # * :passive => true | false (default false)
-    # If set, the server will not create the exchange if it does not
-    # already exist. The client can use this to check whether an exchange
+    # If set, the server will not create the queue if it does not
+    # already exist. The client can use this to check whether the queue
     # exists without modifying  the server state.
     #
     # * :durable => true | false (default false)
@@ -51,7 +57,7 @@ class MQ
     #
     # The server waits for a short period of time before
     # determining the queue is unused to give time to the client code
-    # to bind an exchange to it.
+    # to bind a queue to it.
     #
     # If the queue has been previously declared, this option is ignored
     # on subsequent declarations.
@@ -61,9 +67,9 @@ class MQ
     # not wait for a reply method.  If the server could not complete the
     # method it will raise a channel or connection exception.
     #
-    def initialize mq, name, opts = {}, &block
+    def initialize(mq, name, opts = {}, &block)
       @mq = mq
-      @opts = { :queue => name, :nowait => block.nil? }.merge(opts)
+      @opts = self.class.add_default_options(name, opts, block)
       @bindings ||= {}
       @name = name unless name.empty?
       @status = @opts[:nowait] ? :unknown : :unfinished
@@ -74,7 +80,7 @@ class MQ
       self.callback = block
     end
 
-    attr_reader :name
+    attr_reader :name, :sync_bind
     attr_accessor :opts, :callback, :bind_callback
 
     # This method binds a queue to an exchange.  Until a queue is
@@ -110,12 +116,13 @@ class MQ
     # not wait for a reply method.  If the server could not complete the
     # method it will raise a channel or connection exception.
     #
-    def bind exchange, opts = {}, &block
+    def bind(exchange, opts = {}, &block)
       @status = :unbound
+      @sync_bind = ! opts[:nowait]
       exchange = exchange.respond_to?(:name) ? exchange.name : exchange
       @bindings[exchange] = opts
 
-      @mq.callback{
+      @mq.callback {
         @mq.send Protocol::Queue::Bind.new({ :queue => name,
                                              :exchange => exchange,
                                              :routing_key => opts[:key],
@@ -139,11 +146,11 @@ class MQ
     # not wait for a reply method.  If the server could not complete the
     # method it will raise a channel or connection exception.
     #
-    def unbind exchange, opts = {}
+    def unbind(exchange, opts = {})
       exchange = exchange.respond_to?(:name) ? exchange.name : exchange
       @bindings.delete exchange
 
-      @mq.callback{
+      @mq.callback {
         @mq.send Protocol::Queue::Unbind.new({ :queue => name,
                                                :exchange => exchange,
                                                :routing_key => opts[:key],
@@ -172,8 +179,8 @@ class MQ
     # not wait for a reply method.  If the server could not complete the
     # method it will raise a channel or connection exception.
     #
-    def delete opts = {}
-      @mq.callback{
+    def delete(opts = {})
+      @mq.callback {
         @mq.send Protocol::Queue::Delete.new({ :queue => name,
                                                :nowait => true }.merge(opts))
       }
@@ -183,8 +190,8 @@ class MQ
 
     # Purge all messages from the queue.
     #
-    def purge opts = {}
-      @mq.callback{
+    def purge(opts = {})
+      @mq.callback {
         @mq.send Protocol::Queue::Purge.new({ :queue => name,
                                               :nowait => true }.merge(opts))
       }
@@ -245,14 +252,14 @@ class MQ
     # not wait for a reply method.  If the server could not complete the
     # method it will raise a channel or connection exception.
     #
-    def pop opts = {}, &blk
+    def pop(opts = {}, &blk)
       if blk
         @on_pop = blk
         @on_pop_opts = opts
       end
 
-      @mq.callback{
-        @mq.get_queue{ |q|
+      @mq.callback {
+        @mq.get_queue { |q|
           q.push(self)
           @mq.send Protocol::Basic::Get.new({ :queue => name,
                                               :consumer_tag => name,
@@ -318,7 +325,7 @@ class MQ
     # automatically set :nowait => false. This is required for the server
     # to send a confirmation.
     #
-    def subscribe opts = {}, &blk
+    def subscribe(opts = {}, &blk)
       @consumer_tag = "#{name}-#{Kernel.rand(999_999_999_999)}"
       @mq.consumers[@consumer_tag] = self
 
@@ -328,7 +335,7 @@ class MQ
       @on_msg_opts = opts
       opts[:nowait] = false if (@on_confirm_subscribe = opts[:confirm])
 
-      @mq.callback{
+      @mq.callback {
         @mq.send Protocol::Basic::Consume.new({ :queue => name,
                                                 :consumer_tag => @consumer_tag,
                                                 :no_ack => !opts[:ack],
@@ -358,15 +365,15 @@ class MQ
     # not wait for a reply method.  If the server could not complete the
     # method it will raise a channel or connection exception.
     #
-    def unsubscribe opts = {}, &blk
+    def unsubscribe(opts = {}, &blk)
       @on_cancel = blk
-      @mq.callback{
+      @mq.callback {
         @mq.send Protocol::Basic::Cancel.new({ :consumer_tag => @consumer_tag }.merge(opts))
       }
       self
     end
 
-    def publish data, opts = {}
+    def publish(data, opts = {})
       exchange.publish(data, opts)
     end
 
@@ -390,7 +397,7 @@ class MQ
     # See AMQP::Protocol::Header for the hash properties available from
     # the headers parameter. See #pop or #subscribe for a code example.
     #
-    def receive headers, body
+    def receive(headers, body)
       headers = MQ::Header.new(@mq, headers) unless headers.nil?
 
       if cb = (@on_msg || @on_pop)
@@ -400,27 +407,32 @@ class MQ
 
     # Get the number of messages and consumers on a queue.
     #
-    #  MQ.queue('name').status{ |num_messages, num_consumers|
+    #  MQ.queue('name').status { |num_messages, num_consumers|
     #   puts num_messages
     #  }
     #
-    def status opts = {}, &blk
+    def status(opts = {}, &blk)
       return @status if opts.empty? && blk.nil?
 
       @on_status = blk
-      @mq.callback{
+      @mq.callback {
         @mq.send Protocol::Queue::Declare.new({ :queue => name,
                                                 :passive => true }.merge(opts))
       }
       self
     end
 
-    def receive_status declare_ok
+    def receive_status(declare_ok)
       @name = declare_ok.queue
       @status = :finished
 
       if self.callback
-        self.callback.call(self, declare_ok.message_count, declare_ok.consumer_count)
+        # compatibility for a common case when callback only takes one argument
+        if self.callback.arity == 1
+          self.callback.call(self)
+        else
+          self.callback.call(self, declare_ok.message_count, declare_ok.consumer_count)
+        end
       end
 
       if @on_status
@@ -430,7 +442,7 @@ class MQ
       end
     end
 
-    def after_bind bind_ok
+    def after_bind(bind_ok)
       @status = :bound
       if self.bind_callback
         self.bind_callback.call(self)
@@ -456,7 +468,7 @@ class MQ
 
       binds = @bindings
       @bindings = {}
-      binds.each{|ex,opts| bind(ex, opts) }
+      binds.each { |ex, opts| bind(ex, opts) }
 
       if blk = @on_msg
         @on_msg = nil