amqp 0.8.0.rc13 → 0.8.0.rc14

data/lib/amqp/rpc.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 $stdout.puts <<-MESSAGE
 -------------------------------------------------------------------------------------
 DEPRECATION WARNING!

data/lib/amqp/session.rb

@@ -1,6 +1,7 @@
 # encoding: utf-8
 
 require "amq/client/adapters/event_machine"
+require "amqp/broker"
 
 module AMQP
   # AMQP session represents connection to the broker. Session objects let you define callbacks for
@@ -33,16 +34,57 @@ module AMQP
     # API
     #
 
+    # @group Connecting, reconnecting, disconnecting
+
+    def initialize(*args, &block)
+      super(*args, &block)
+
+      @client_properties = {
+        :platform    => ::RUBY_DESCRIPTION,
+        :product     => "AMQP gem",
+        :information => "http://github.com/ruby-amqp/amqp",
+        :version     => AMQP::VERSION
+      }
+    end # initialize(*args, &block)
+
+    # @return [Boolean] true if this AMQP connection is currently open
     # @api plugin
     def connected?
       self.opened?
     end
 
+    # @return [String] Broker hostname this connection uses
+    # @api public
+    def hostname
+      @settings[:host]
+    end
+    alias host hostname
+
+    # @return [String] Broker port this connection uses
+    # @api public
+    def port
+      @settings[:port]
+    end
+
+    # @return [String] Broker endpoint in the form of HOST:PORT/VHOST
+    # @api public
+    def broker_endpoint
+      "#{self.hostname}:#{self.port}/#{self.vhost}"
+    end
+
+    # @return [String] Username used by this connection
+    # @api public
+    def username
+      @settings[:user]
+    end # username
+    alias user username
+
+
     # Reconnect to the broker using current connection settings.
     #
     # @param [Boolean] force Enforce immediate connection
     # @param [Fixnum] period If given, reconnection will be delayed by this period, in seconds.
-    # @api plugin
+    # @api public
     def reconnect(force = false, period = 2)
       # we do this to make sure this method shows up in our documentation
       # this method is too important to leave out and YARD currently does not
@@ -50,6 +92,66 @@ module AMQP
       super(force, period)
     end # reconnect(force = false)
 
+    # A version of #reconnect that allows connecting to different endpoints (hosts).
+    # @see #reconnect
+    # @api public
+    def reconnect_to(connection_string_or_options = {}, period = 2)
+      opts = case connection_string_or_options
+             when String then
+               AMQP::Client.parse_connection_uri(connection_string_or_options)
+             when Hash then
+               connection_string_or_options
+             else
+               Hash.new
+             end
+
+      super(opts, period)
+    end # reconnect_to(connection_string_or_options = {})
+
+
+    # Properly close connection with AMQ broker, as described in
+    # section 2.2.4 of the {http://bit.ly/hw2ELX AMQP 0.9.1 specification}.
+    #
+    # @api  plugin
+    # @see  #close_connection
+    def disconnect(reply_code = 200, reply_text = "Goodbye", &block)
+      # defined here to make this method appear in YARD documentation. MK.
+      super(reply_code, reply_text, &block)
+    end
+    alias close disconnect
+
+    # @endgroup
+
+
+
+    # @group Broker information
+
+    # 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)
+    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)
+    attr_reader :server_capabilities
+
+    # Locales server supports
+    #
+    # @see http://bit.ly/htCzCX 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
+    def broker
+      @broker ||= AMQP::Broker.new(@server_properties)
+    end # broker
+
+    # @endgroup
+
+
 
     # Defines a callback that will be executed when AMQP connection is considered open:
     # after client and broker has agreed on max channel identifier and maximum allowed frame
@@ -62,6 +164,9 @@ module AMQP
       super(&block)
     end # on_open(&block)
 
+
+    # @group Error Handling and Recovery
+
     # Defines a callback that will be run when broker confirms connection termination
     # (client receives connection.close-ok). You can define more than one callback.
     #
@@ -99,17 +204,72 @@ module AMQP
       super(&block)
     end
 
+    # 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
 
-    # Properly close connection with AMQ broker, as described in
-    # section 2.2.4 of the {http://bit.ly/hw2ELX AMQP 0.9.1 specification}.
+
+    # @private
+    # @api plugin
+    def handle_connection_interruption
+      super
+    end # handle_connection_interruption
+
+
+    # Defines a callback that will be executed when connection is closed after
+    # connection-level exception. Only one callback can be defined (the one defined last
+    # replaces previously added ones).
     #
-    # @api  plugin
-    # @see  #close_connection
-    def disconnect(reply_code = 200, reply_text = "Goodbye", &block)
-      # defined here to make this method appear in YARD documentation. MK.
-      super(reply_code, reply_text, &block)
+    # @api public
+    def on_error(&block)
+      super(&block)
     end
-    alias close disconnect
+
+
+    # Defines a callback that will be executed after TCP connection has 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 after AMQP connection has 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
+
+
+    # @return [Boolean] whether connection is in the automatic recovery mode
+    # @api public
+    def auto_recovering?
+      super
+    end # auto_recovering?
+    alias auto_recovery? auto_recovering?
+
+
+    # Performs recovery of channels that are in the automatic recovery mode.
+    #
+    # @see Channel#auto_recover
+    # @see Queue#auto_recover
+    # @see Exchange#auto_recover
+    # @api plugin
+    def auto_recover
+      super
+    end # auto_recover
+
+    # @endgroup
 
 
 

data/lib/amqp/utilities/event_loop_helper.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require "eventmachine"
 require "amqp/utilities/server_type"
 

data/lib/amqp/utilities/server_type.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 # Original version is from Qusion project by Daniel DeLeo.
 #
 # Copyright (c) 2009 Daniel DeLeo

data/lib/amqp/version.rb

@@ -1,10 +1,10 @@
 # encoding: utf-8
 
 module AMQP
-  # AMQP gem version. Not to be confused with AMQP protocol version
+  # amqp gem version. Not to be confused with the AMQP protocol version
   # it implements. For that, see {AMQ::Protocol::VERSION}
   #
   # @see AMQ::Protocol::VERSION
   # @return [String] AMQP gem version
-  VERSION = '0.8.0.rc13'
+  VERSION = '0.8.0.rc14'
 end

data/lib/mq.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 $stdout.puts <<-MESSAGE
 -------------------------------------------------------------------------------------
 DEPRECATION WARNING!
@@ -20,8 +22,8 @@ MQ should have been called Channel all along). No other AMQP client library we k
 of invents it's own terminology when it comes to AMQP entities, and amqp gem shouldn't,
 too.
 
-If you disagree with this really strongly, let us know by opening an issue at
-https://github.com/ruby-amqp/amqp/issues
+Learn more at http://bit.ly/amqp-gem-080-migration, all documentation guides are at
+http://bit.ly/amqp-gem-docs.
 
 Thank you for understanding. AMQP gem maintainers team.
 

data/lib/mq/logger.rb

@@ -1,2 +1,4 @@
+# encoding: utf-8
+
 require "mq"
-require "amqp/logger"
+require "amqp/logger"

data/lib/mq/rpc.rb

@@ -1,2 +1,4 @@
+# encoding: utf-8
+
 require "mq"
-require "amqp/rpc"
+require "amqp/rpc"

data/spec/integration/authentication_spec.rb

@@ -1,4 +1,5 @@
-# -*- coding: utf-8 -*-
+# encoding: utf-8
+
 require "spec_helper"
 
 describe "Authentication attempt" do
@@ -10,7 +11,7 @@ describe "Authentication attempt" do
   include EventedSpec::EMSpec
   include EventedSpec::SpecHelper
 
-  default_timeout 1.0
+  default_timeout 7.0
 
 
   describe "with default connection parameters" do
@@ -29,11 +30,8 @@ describe "Authentication attempt" do
       it "succeeds" do
         AMQP.connect do |connection|
           connection.should be_open
-
           connection.close { done }
         end
-
-        done(0.5)
       end # it
     end # context
   end # describe
@@ -52,15 +50,24 @@ describe "Authentication attempt" do
         it "succeeds" do
           connection = AMQP.connect(AMQP_OPTS.merge(:username => "amqp_gem", :password => "amqp_gem_password", :vhost => "amqp_gem_testbed"))
 
-          done(0.4) {
+          done(3.0) {
             connection.should be_connected
+
+            connection.username.should        == "amqp_gem"
+            connection.user.should            == "amqp_gem"
+            connection.hostname.should        == "localhost"
+            connection.host.should            == "localhost"
+            connection.port.should            == 5672
+            connection.vhost.should           == "amqp_gem_testbed"
+            connection.broker_endpoint.should == "localhost:5672/amqp_gem_testbed"
+
             connection.close
           }
         end # it
       end # context
 
       context "and provided credentials ARE INCORRECT" do
-        default_timeout 10
+        default_timeout 6
 
         after(:all) { done }
 
@@ -76,7 +83,7 @@ describe "Authentication attempt" do
 
 
       context "and provided vhost DOES NOT EXIST" do
-        default_timeout 10
+        default_timeout 6
 
         after(:all) { done }
 
@@ -106,7 +113,7 @@ describe "Authentication attempt" do
         it "succeeds" do
           connection = AMQP.connect "amqp://amqp_gem:amqp_gem_password@localhost/amqp_gem_testbed"
 
-          done(0.3) {
+          done(3.0) {
             connection.should be_connected
             connection.close
           }
@@ -114,7 +121,7 @@ describe "Authentication attempt" do
       end # context
 
       context "and provided credentials ARE INCORRECT" do
-        default_timeout 10
+        default_timeout 6
 
         after(:all) { done }
 

data/spec/integration/automatic_binding_for_default_direct_exchange_spec.rb

@@ -1,4 +1,4 @@
-# -*- coding: utf-8 -*-
+# encoding: utf-8
 
 require 'spec_helper'
 

data/spec/integration/automatic_recovery_predicate_spec.rb

@@ -0,0 +1,68 @@
+# encoding: utf-8
+
+require "spec_helper"
+
+describe AMQP::Channel, "#auto_recovery" do
+
+  #
+  # Environment
+  #
+
+  include EventedSpec::AMQPSpec
+  include EventedSpec::SpecHelper
+
+
+  default_options AMQP_OPTS
+  default_timeout 2
+
+
+  it "switches automatic recovery mode on" do
+    ch = AMQP::Channel.new(AMQP.connection)
+    ch.auto_recovery.should be_false
+    ch.auto_recovery = true
+    ch.auto_recovery.should be_true
+    ch.auto_recovery = false
+    ch.auto_recovery.should be_false
+
+    done
+  end
+end
+
+
+
+
+describe AMQP::Channel, "options hash" do
+
+  #
+  # Environment
+  #
+
+  include EventedSpec::AMQPSpec
+  include EventedSpec::SpecHelper
+
+
+  default_options AMQP_OPTS
+  default_timeout 2
+
+
+  it "can be passed as the 3rd constructor argument" do
+    ch = AMQP::Channel.new(AMQP.connection, AMQP::Channel.next_channel_id, :auto_recovery => true)
+    ch.auto_recovery.should be_true
+    ch.auto_recovery = false
+    ch.auto_recovery.should be_false
+
+    done
+  end
+
+
+  it "can be passed as the 2nd constructor argument" do
+    ch = AMQP::Channel.new(AMQP.connection, :auto_recovery => true)
+    ch.auto_recovery.should be_true
+    ch.should be_auto_recovering
+    ch.auto_recovery = false
+    ch.auto_recovery.should be_false
+    ch.should_not be_auto_recovering
+
+    done
+  end
+end

data/spec/integration/basic_get_spec.rb

@@ -1,4 +1,5 @@
-# -*- coding: utf-8 -*-
+# encoding: utf-8
+
 require "spec_helper"
 
 describe AMQP::Queue, "#pop" do