amqp 0.7.1 → 0.7.2

data/.gitignore

@@ -8,4 +8,9 @@
 Gemfile.lock
 
 spec/amqp.yml
-vendor/cache
+vendor/cache
+vendor/amq*
+vendor/evented-spec
+doc/*
+.yardoc/*
+tmp/*

data/.travis.yml

@@ -0,0 +1,9 @@
+script: "bundle exec rake spec:ci"
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - ree
+  - jruby
+gemfile:
+  - Gemfile
+  - gemfiles/eventmachine-pre

data/CHANGELOG

@@ -1,3 +1,10 @@
+= Version 0.7.2
+
+  * [BUG] Server-named queues declared en masse now get their unique names instead of all beign assigned the first generated name
+  * [API] Connection URI (string) format for vhosts no longer assumes that vhosts begin with a slash (/), learn more at http://bit.ly/mfzwcB
+  * [BUG] Heartbeats broken for long running tasks [#43]
+  * [BUG] Queue#reset leaks consumer tags [#40].
+
 = Version 0.7.1
 
   * [BUG] AMQP gem no longer conflicts with Builder 2.1.2 on Ruby 1.9.

data/Gemfile

@@ -1,13 +1,24 @@
 # encoding: utf-8
 
-source "http://gemcutter.org"
+source :rubygems
+
+# Use local clones if possible.
+# If you want to use your local copy, just symlink it to vendor.
+def custom_gem(name, options = Hash.new)
+  local_path = File.expand_path("../vendor/#{name}", __FILE__)
+  if File.exist?(local_path)
+    gem name, options.merge(:path => local_path).delete_if { |key, _| [:git, :branch].include?(key) }
+  else
+    gem name, options
+  end
+end
+
 
 gem "eventmachine"
-gem "json" if RUBY_VERSION < "1.9" || ARGV.first == "install"
-gem "amq-client", :git => "git://github.com/ruby-amqp/amq-client.git", :branch => "master"
 
 group(:test) do
   gem "rspec", ">=2.0.0"
-
-  gem "amqp-spec", :git => "git://github.com/ruby-amqp/amqp-spec.git", :branch => "master"
+  gem "rake"
+  # gem "amqp-spec", :git => "git://github.com/ruby-amqp/amqp-spec.git", :branch => "master"
+  custom_gem "evented-spec", :git => "git://github.com/ruby-amqp/evented-spec.git", :branch => "master"
 end

data/Rakefile

@@ -1,8 +1,14 @@
+require 'fileutils'
 require 'rspec/core/rake_task'
 
 desc "Run spec suite (uses Rspec2)"
 RSpec::Core::RakeTask.new(:spec) { |t|}
 
+namespace :spec do
+  desc "Clean up rbx compiled files and run spec suite"
+  RSpec::Core::RakeTask.new(:ci) { |t| Dir.glob("**/*.rbc").each {|f| FileUtils.rm_f(f) } }
+end
+
 desc "Run specs with RCov"
 RSpec::Core::RakeTask.new(:rcov) do |t|
   t.rcov = true

data/amqp.gemspec

@@ -10,8 +10,7 @@ Gem::Specification.new do |s|
   s.authors = ["Aman Gupta", "Jakub Stastny aka botanicus", "Michael S. Klishin"]
   s.homepage = "http://github.com/ruby-amqp/amqp"
   s.summary = "AMQP client implementation in Ruby/EventMachine."
-  s.description = "An implementation of the AMQP protocol in Ruby/EventMachine for writing clients to the RabbitMQ message broker."
-  s.cert_chain = nil
+  s.description = "Asynchronous AMQP 0.9.1 client for Ruby. Built on top of Eventmachine."
   s.email = ["bWljaGFlbEBub3ZlbWJlcmFpbi5jb20=\n", "c3Rhc3RueUAxMDFpZGVhcy5jeg==\n"].map { |i| Base64.decode64(i) }
 
   # files
@@ -19,20 +18,11 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   # RDoc
-  s.has_rdoc = true
   s.rdoc_options = '--include=examples --main README.md'
   s.extra_rdoc_files = ["README.md"] + Dir.glob("doc/*")
 
   # Dependencies
-  s.add_dependency "eventmachine", ">= 0.12.4"
-
-  begin
-    require "changelog"
-  rescue LoadError
-    warn "You have to have changelog gem installed for post install message"
-  else
-    s.post_install_message = CHANGELOG.new.version_changes
-  end
+  s.add_dependency "eventmachine"
 
   # RubyForge
   s.rubyforge_project = "amqp"

data/bin/set_test_suite_realms_up.sh

@@ -1,21 +1,7 @@
 #!/bin/sh
 
-# guest:guest has full access to /
+# guest:guest has full access to /amqp_gem_07x_stable_testbed
 
-rabbitmqctl add_vhost /
+rabbitmqctl add_vhost /amqp_gem_07x_stable_testbed
 rabbitmqctl add_user guest guest
 rabbitmqctl set_permissions -p / guest ".*" ".*" ".*"
-
-
-# amqp_gem:amqp_gem_password has full access to /amqp_gem_testbed
-
-rabbitmqctl add_vhost /amqp_gem_testbed
-rabbitmqctl add_user amqp_gem amqp_gem_password
-rabbitmqctl set_permissions -p /amqp_gem_testbed amqp_gem ".*" ".*" ".*"
-
-
-# amqp_gem_reader:reader_password has read access to /amqp_gem_testbed
-
-rabbitmqctl add_user amqp_gem_reader reader_password
-rabbitmqctl clear_permissions -p /amqp_gem_testbed guest
-rabbitmqctl set_permissions -p /amqp_gem_testbed amqp_gem_reader "^---$" "^---$" ".*"

data/examples/automatic_binding_for_default_direct_exchange.rb

@@ -20,7 +20,7 @@ end
 
 EM.run do
   connection = AMQP.connect
-  mq         = AMQP::Channel.new(connection)
+  ch         = AMQP::Channel.new(connection)
 
   show_stopper = Proc.new do
     $stdout.puts "Stopping..."
@@ -35,14 +35,14 @@ EM.run do
 
   $stdout.puts "Bound! Running #{AMQP::VERSION} version of the gem."
 
-  queue1    = mq.queue("queue1")
-  queue2    = mq.queue("queue2")
-  queue3    = mq.queue("queue3")
+  queue1    = ch.queue("queue1")
+  queue2    = ch.queue("queue2")
+  queue3    = ch.queue("queue3")
 
   queues    = [queue1, queue2, queue3]
 
   # Rely on default direct exchange binding, see section 2.1.2.4 Automatic Mode in AMQP 0.9.1 spec.
-  exchange = AMQP::Channel::Exchange.default
+  exchange = ch.default_exchange
 
   queue1.subscribe do |payload|
     puts "Got #{payload} for #{queue1.name}"

data/examples/default_channel.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+
+$:.unshift(File.expand_path("../../lib", __FILE__))
+require 'amqp'
+
+AMQP.start(:host => 'localhost') do |connection|
+
+  # Send Connection.Close on Ctrl+C
+  trap(:INT) do
+    AMQP.stop do
+      puts "Closing and AMQP.channel is #{AMQP.channel.open? ? 'open' : 'closed'}"
+      exit
+    end
+  end
+
+  puts "AMQP.connection is #{AMQP.connection}"
+  puts "AMQP.channel is #{AMQP.channel}"
+
+end

data/examples/immediately_bind_a_server_named_queue.rb

@@ -0,0 +1,38 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+require "bundler"
+Bundler.setup
+
+$:.unshift(File.expand_path("../../lib", __FILE__))
+
+require 'amqp'
+
+
+puts "=> AMQP gem #{AMQP::VERSION}"
+puts
+AMQP.start do |connection|
+  channel = AMQP::Channel.new
+  puts "Channel ##{channel.channel} is now open!"
+
+  xchange = channel.fanout("amq.fanout")
+  q = AMQP::Queue.new(channel, "", :auto_delete => true).bind(xchange).subscribe do |header, payload|
+    puts "Got a payload: #{payload}"
+  end
+
+  EventMachine.add_periodic_timer(0.5) {
+    xchange.publish("à bientôt!", :key => q.name)
+  }
+
+
+  show_stopper = Proc.new do
+    $stdout.puts "Stopping..."
+
+    connection.close {
+      EM.stop { exit }
+    }
+  end
+
+  Signal.trap "INT", show_stopper
+  EM.add_timer(3, show_stopper)
+end

data/examples/issues/issue_75.rb

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+require "bundler"
+Bundler.setup
+
+$:.unshift(File.expand_path("../../../lib", __FILE__))
+
+require 'amqp'
+
+AMQP.start(:host => "localhost") do |connection|
+  channel  = AMQP::Channel.new(connection)
+  channel.fanout("logs.nad", :auto_delete => false)
+  channel.fanout("logs.ad",  :auto_delete => true)
+
+  EM.add_timer(1) do
+    connection.close do
+      EM.stop { exit }
+    end
+  end
+end

data/gemfiles/eventmachine-pre

@@ -0,0 +1,24 @@
+# encoding: utf-8
+
+source :rubygems
+
+# Use local clones if possible.
+# If you want to use your local copy, just symlink it to vendor.
+def custom_gem(name, options = Hash.new)
+  local_path = File.expand_path("../vendor/#{name}", __FILE__)
+  if File.exist?(local_path)
+    gem name, options.merge(:path => local_path).delete_if { |key, _| [:git, :branch].include?(key) }
+  else
+    gem name, options
+  end
+end
+
+
+gem "eventmachine", "~> 1.0.0.beta3"
+
+group(:test) do
+  gem "rspec", ">=2.0.0"
+  gem "rake"
+  # gem "amqp-spec", :git => "git://github.com/ruby-amqp/amqp-spec.git", :branch => "master"
+  custom_gem "evented-spec", :git => "git://github.com/ruby-amqp/evented-spec.git", :branch => "master"
+end

data/lib/amqp/channel.rb

@@ -138,6 +138,8 @@ module AMQP
 
       @connection = connection || AMQP.start
 
+      @queues_awaiting_declare_ok = Array.new
+
       conn.callback { |c|
         @channel = c.add_channel(self)
         send Protocol::Channel::Open.new
@@ -147,6 +149,10 @@ module AMQP
     attr_reader :channel, :connection, :status
     alias :conn :connection
 
+    attr_reader :queues_awaiting_declare_ok
+
+
+
     def closed?
       @status.eql?(:closed)
     end
@@ -240,6 +246,18 @@ module AMQP
       end
     end
 
+    # Returns exchange object with the same name as default (aka unnamed) exchange.
+    # Default exchange is a direct exchange and automatically routes messages to
+    # queues when routing key matches queue name exactly. This feature is known as
+    # "automatic binding" (of queues to default exchange).
+    #
+    # *Use default exchange when you want to route messages directly to specific queues*
+    # (queue names are known, you don't mind this kind of coupling between applications).
+    def default_exchange
+      Exchange.default(self)
+    end
+
+
     # Defines, intializes and returns an Exchange to act as an ingress
     # point for all published messages.
     #
@@ -609,14 +627,19 @@ module AMQP
     # method it will raise a channel or connection exception.
     #
     def queue(name, opts = {}, &block)
-      if queue = self.queues.find { |queue| queue.name == name }
+      raise ArgumentError, "queue name must not be nil. Use '' (empty string) for server-named queues." if name.nil?
+
+      if name && !name.empty? && (queue = self.queues.find { |queue| queue.name == name })
         extended_opts = Queue.add_default_options(name, opts, block)
 
         validate_parameters_match!(queue, extended_opts)
 
         queue
       else
-        self.queues << Queue.new(self, name, opts, &block)
+        q = Queue.new(self, name, opts, &block)
+        self.queues << q
+
+        q
       end
     end
 
@@ -746,6 +769,9 @@ module AMQP
     def reset
       @deferred_status = nil
       @channel = nil
+
+      @queues_awaiting_declare_ok = Array.new
+
       initialize @connection
 
       @consumers = {}
@@ -857,12 +883,9 @@ module AMQP
         exchange.receive_response method
 
       when Protocol::Queue::DeclareOk
-        # We can't use queues[method.queue] because if the name would
-        # be an empty string, then AMQP broker generated a random one.
-        queues = self.queues.select { |queue| queue.opts[:nowait].eql?(false) }
-        queue  = queues.reverse.find { |queue| queue.status.eql?(:unfinished) }
-        queue.receive_status method
+        queue = @queues_awaiting_declare_ok.shift
 
+        queue.receive_status method
       when Protocol::Queue::BindOk
         # We can't use queues[method.queue] because if the name would
         # be an empty string, then AMQP broker generated a random one.
@@ -935,3 +958,25 @@ end # AMQP
 
 
 MQ = AMQP::Channel
+
+#
+# Backwards compatibility with 0.6.x
+#
+
+class MQ
+  # unique identifier
+  def MQ.id
+    Thread.current[:mq_id] ||= "#{`hostname`.strip}-#{Process.pid}-#{Thread.current.object_id}"
+  end
+
+  def MQ.default
+    # TODO: clear this when connection is closed
+    Thread.current[:mq] ||= MQ.new
+  end
+
+  # Allows for calls to all MQ instance methods. This implicitly calls
+  # MQ.new so that a new channel is allocated for subsequent operations.
+  def MQ.method_missing(meth, *args, &blk)
+    MQ.default.__send__(meth, *args, &blk)
+  end
+end

data/lib/amqp/client.rb

@@ -14,9 +14,28 @@ module AMQP
     @client = mod
   end
 
+  def self.mutex
+    @mutex ||= Mutex.new
+  end
+
+  def self.channel
+    self.mutex.synchronize { @channel }
+  end
+
+  def self.channel=(value)
+    self.mutex.synchronize { @channel = value }
+  end
+
+
   module Client
     include EM::Deferrable
 
+    #
+    # API
+    #
+
+    attr_reader :settings
+
     def initialize(opts = {})
       @settings = opts
       extend AMQP.client
@@ -27,6 +46,7 @@ module AMQP
 
       timeout @settings[:timeout] if @settings[:timeout]
       errback { @on_disconnect.call } unless @reconnecting
+      @connection_status = @settings[:connection_status]
 
       # TCP connection "openness"
       @tcp_connection_established = false
@@ -61,13 +81,15 @@ module AMQP
     def init_heartbeat
       @last_server_heartbeat = Time.now
 
-      @timer ||= EM::PeriodicTimer.new(@settings[:heartbeat]) do
+      @timer.cancel if @timer
+      @timer = EM::PeriodicTimer.new(@settings[:heartbeat]) do
         if connected?
           if @last_server_heartbeat < (Time.now - (@settings[:heartbeat] * 2))
             log "Reconnecting due to missing server heartbeats"
             reconnect(true)
           else
-            send AMQP::Frame::Heartbeat.new
+            @last_server_heartbeat = Time.now
+            send AMQP::Frame::Heartbeat.new, :channel => 0
           end
         end
       end
@@ -207,18 +229,63 @@ module AMQP
 
     private
 
+    AMQP_PORTS = Hash["amqp" => 5672, "amqps" => 5671].freeze
+
+    # Parses AMQP connection URI and returns its components as a hash.
+    #
+    # h2. vhost naming schemes
+    #
+    # It is convenient to be able to specify the AMQP connection
+    # parameters as a URI string, and various "amqp" URI schemes
+    # exist.  Unfortunately, there is no standard for these URIs, so
+    # while the schemes share the basic idea, they differ in some
+    # details.  This implementation aims to encourage URIs that work
+    # as widely as possible.
+    #
+    # The URI scheme should be "amqp", or "amqps" if SSL is required.
+    #
+    # The host, port, username and password are represented in the
+    # authority component of the URI in the same way as in http URIs.
+    #
+    # The vhost is obtained from the first segment of the path, with the
+    # leading slash removed.  The path should contain only a single
+    # segment (i.e, the only slash in it should be the leading one).
+    # If the vhost is to include slashes or other reserved URI
+    # characters, these should be percent-escaped.
+    #
+    # @example How vhost is parsed
+    #
+    #   AMQP::Client.parse_connection_uri("amqp://dev.rabbitmq.com")            # => vhost is nil, so default (/) will be used
+    #   AMQP::Client.parse_connection_uri("amqp://dev.rabbitmq.com/")           # => vhost is an empty string
+    #   AMQP::Client.parse_connection_uri("amqp://dev.rabbitmq.com/%2Fvault")   # => vhost is /vault
+    #   AMQP::Client.parse_connection_uri("amqp://dev.rabbitmq.com/production") # => vhost is production
+    #   AMQP::Client.parse_connection_uri("amqp://dev.rabbitmq.com/a.b.c")      # => vhost is a.b.c
+    #   AMQP::Client.parse_connection_uri("amqp://dev.rabbitmq.com/foo/bar")    # => ArgumentError
+    #
+    #
+    # @param [String] connection_string AMQP connection URI, à la JDBC connection string. For example: amqp://bus.megacorp.internal:5877.
+    # @return [Hash] Connection parameters (:username, :password, :vhost, :host, :port, :ssl)
+    #
+    # @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
+    # @api public
     def self.parse_connection_uri(connection_string)
       uri = URI.parse(connection_string)
-      raise("amqp:// uri required!") unless %w{amqp amqps}.include?(uri.scheme)
+      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[:user]  = URI.unescape(uri.user) if uri.user
-      opts[:pass]  = URI.unescape(uri.password) if uri.password
-      opts[:vhost] = URI.unescape(uri.path) if uri.path
-      opts[:host]  = uri.host if uri.host
-      opts[:port]  = uri.port || Hash["amqp" => 5672, "amqps" => 5671][uri.scheme]
-      opts[:ssl]   = uri.scheme == "amqps"
+      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
     end