amq-client 0.7.0.alpha13 → 0.7.0.alpha14

data/.travis.yml

@@ -4,4 +4,7 @@ rvm:
   - 1.9.2
   - ree
   - rbx
-  - jruby
+  - jruby
+gemfile:
+  - Gemfile
+  - gemfiles/eventmachine-pre

data/amq-client.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |s|
   s.has_rdoc   = true
 
   # files
-  s.files = `git ls-files`.split("\n").reject { |file| file =~ /^vendor\// }
+  s.files = `git ls-files`.split("\n").reject { |file| file =~ /^vendor\// || file =~ /^gemfiles\// }
   s.require_paths = ["lib"]
   s.extra_rdoc_files = ["README.textile"] + Dir.glob("doc/*")
 

data/examples/eventmachine_adapter/authentication/{plain_password_with_incorrect_credentials.rb → plain_password_with_incorrect_credentials_handled_with_a_callback.rb}

@@ -11,7 +11,7 @@ EM.run do
                                           :password => "a password that is incorrect #{Time.now.to_i}", :on_possible_authentication_failure => Proc.new { |settings|
                                             puts "Authentication failed, as expected, settings are: #{settings.inspect}"
 
-                                            EM.stop
+                                            EventMachine.stop
                                           }) do |client|
     raise "Should not really be executed"
   end

data/examples/eventmachine_adapter/authentication/plain_password_with_incorrect_credentials_handled_with_a_rescue_block.rb

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+__dir = File.join(File.dirname(File.expand_path(__FILE__)), "..")
+require File.join(__dir, "example_helper")
+
+begin
+  EventMachine.run do
+    AMQ::Client::EventMachineClient.connect(:port     => 5672,
+                                            :vhost    => "/amq_client_testbed",
+                                            :user     => "amq_client_gem",
+                                            :password => "a password that is incorrect #{Time.now.to_i}") do |client|
+      raise "Should not really be executed"
+    end
+  end
+rescue AMQ::Client::PossibleAuthenticationFailureError => afe
+  puts "Authentication failed, as expected. Caught #{afe.inspect}"
+  EventMachine.stop if EventMachine.reactor_running?
+end

data/lib/amq/client/adapter.rb

@@ -109,7 +109,7 @@ module AMQ
         # the block if it is given.
         #
         # @example Specifying adapter via the :adapter option
-        #   AMQ::Client::Adapter.connect(adapter: "socket")
+        #   AMQ::Client::Adapter.connect(:adapter => "socket")
         # @example Specifying using custom adapter class
         #   AMQ::Client::SocketClient.connect
         # @param [Hash] Connection parameters, including :adapter to use.
@@ -155,6 +155,14 @@ module AMQ
         def tcp_connection_failure_exception_class
           @tcp_connection_failure_exception_class ||= AMQ::Client::TCPConnectionFailed
         end # tcp_connection_failure_exception_class
+
+        # Can be overriden by higher-level libraries like amqp gem or bunny.
+        # Defaults to AMQ::Client::PossibleAuthenticationFailure.
+        #
+        # @return [Class]
+        def authentication_failure_exception_class
+          @authentication_failure_exception_class ||= AMQ::Client::PossibleAuthenticationFailureError
+        end # authentication_failure_exception_class
       end # ClassMethods
 
 
@@ -203,7 +211,6 @@ module AMQ
       # section 2.2.4 of the {http://bit.ly/hw2ELX AMQP 0.9.1 specification}.
       #
       # @api  plugin
-      # @todo This method should await broker's response with Close-Ok. {http://github.com/michaelklishin MK}.
       # @see  #close_connection
       def disconnect(reply_code = 200, reply_text = "Goodbye", &block)
         @intentionally_closing_connection = true

data/lib/amq/client/adapters/coolio.rb

@@ -8,32 +8,57 @@ require "amq/client/framing/string/frame"
 
 module AMQ
   module Client
+    #
+    # CoolioClient is a drop-in replacement for EventMachineClient, if you prefer
+    # cool.io style.
+    #
     class CoolioClient
+      #
+      # Cool.io socket delegates most of its operations to the parent adapter.
+      # Thus, 99.9% of the time you don't need to deal with this class.
+      #
+      # @api private
+      # @private
       class Socket < ::Coolio::TCPSocket
         attr_accessor :adapter
 
+        # Connects to given host/port and sets parent adapter.
+        #
+        # @param [CoolioClient]
+        # @param [String]
+        # @param [Fixnum]
         def self.connect(adapter, host, port)
           socket = super(host, port)
           socket.adapter = adapter
           socket
         end
 
+        # Triggers socket_connect callback
         def on_connect
           #puts "On connect"
-          adapter.on_socket_connect
+          adapter.socket_connected
         end
 
+        # Triggers on_read callback
         def on_read(data)
           # puts "Received data"
           # puts_data(data)
-          adapter.on_read(data)
+          adapter.receive_data(data)
         end
 
-        # This handler should never trigger in normal circumstances
+        # Triggers socket_disconnect callback
         def on_close
-          adapter.on_socket_disconnect
+          adapter.socket_disconnected
+        end
+
+        # Triggers tcp_connection_failed callback
+        def on_connect_failed
+          adapter.tcp_connection_failed
         end
 
+        # Sends raw data through the socket
+        #
+        # param [String] Binary data
         def send_raw(data)
           # puts "Sending data"
           # puts_data(data)
@@ -41,6 +66,7 @@ module AMQ
         end
 
         protected
+        # Debugging routine
         def puts_data(data)
           puts "    As string:     #{data.inspect}"
           puts "    As byte array: #{data.bytes.to_a.inspect}"
@@ -60,98 +86,182 @@ module AMQ
       # API
       #
 
+      # Cool.io socket for multiplexing et al.
+      #
+      # @private
       attr_accessor :socket
+
+      # Hash with available callbacks
       attr_accessor :callbacks
+
+      # AMQP connections
+      #
+      # @see AMQ::Client::Connection
       attr_accessor :connections
 
+      # Creates a socket and attaches it to cool.io default loop.
+      #
+      # Called from CoolioClient.connect
+      #
+      # @see AMQ::Client::Adapter::ClassMethods#connect
+      # @param [Hash] connection settings
+      # @api private
       def establish_connection(settings)
         socket = Socket.connect(self, settings[:host], settings[:port])
         socket.attach(Cool.io::Loop.default)
         self.socket = socket
       end
 
+      # Registers on_connection callback
+      # @see #on_connection
+      # @api private
       def register_connection_callback(&block)
         self.on_connection(&block)
       end
 
+      # Performs basic initialization. Do not use this method directly, use
+      # CoolioClient.connect instead
+      #
+      # @see AMQ::Client::Adapter::ClassMethods#connect
+      # @api private
       def initialize
         # Be careful with default values for #ruby hashes: h = Hash.new(Array.new); h[:key] ||= 1
         # won't assign anything to :key. MK.
         @callbacks   = {}
         @connections = []
         super
+        if settings[:on_tcp_connection_failure]
+          on_tcp_connection_failure(&settings.delete(:on_tcp_connection_failure))
+        end
       end
 
-      # sets a callback for connection
+      # Sets a callback for successful connection (after we receive open-ok)
+      #
+      # @api public
       def on_connection(&block)
         define_callback :connect, &block
       end
 
-      # sets a callback for disconnection
+      # Sets a callback for disconnection (as in client-side disconnection)
+      #
+      # @api public
       def on_disconnection(&block)
         define_callback :disconnect, &block
       end
 
+      # Sets a callback for tcp connection failure (as in can't make initial connection)
+      def on_tcp_connection_failure(&block)
+        define_callback :tcp_connection_failure, &block
+      end
+
+      # Sets a callback for successful connection (after we receive tune-ok)
+      #
+      # @api public
       def on_open(&block)
         define_callback :open, &block
       end # on_open(&block)
 
 
-      # called by AMQ::Client::Connection after we receive connection.open-ok.
+      # Called by AMQ::Client::Connection after we receive connection.open-ok.
+      #
+      # @api private
       def connection_successful
         exec_callback_yielding_self(:connect)
       end
 
-      # called by AMQ::Client::Connection after we receive connection.close-ok.
+      # Called by AMQ::Client::Connection after we receive connection.close-ok.
+      #
+      # @api private
       def disconnection_successful
         exec_callback_yielding_self(:disconnect)
         close_connection
+        closed!
       end
 
+      # Called by AMQ::Client::Connection after we receive connection.tune.
+      #
+      # @api private
       def open_successful
         @authenticating = false
+        opened!
         exec_callback_yielding_self(:open)
       end # open_successful
 
+      # Called by Socket if it could not connect.
+      #
+      # @api private
+      def tcp_connection_failed
+        if has_callback?(:tcp_connection_failure)
+          exec_callback_yielding_self(:tcp_connection_failure)
+        else
+          raise self.class.tcp_connection_failure_exception_class.new(settings)
+        end
+      end # tcp_connection_failed
 
-      # triggered when socket is connected but before handshake is done
-      def on_socket_connect
+      # Called when socket is connected but before handshake is done
+      #
+      # @api private
+      def socket_connected
         post_init
       end
 
-      # triggered after socket is closed
-      def on_socket_disconnect
+      # Called after socket is closed
+      #
+      # @api private
+      def socket_disconnected
       end
 
+      # Sends raw data through the socket
+      #
+      # @param [String] binary data
+      # @api private
       def send_raw(data)
         socket.send_raw data
       end
 
       # The story about the buffering is kinda similar to EventMachine,
       # you keep receiving more than one frame in a single packet.
-      def on_read(chunk)
+      #
+      # @param [String] chunk with binary data received. It could be one frame,
+      #   more than one frame or less than one frame.
+      # @api private
+      def receive_data(chunk)
         @chunk_buffer << chunk
         while frame = get_next_frame
           receive_frame(AMQ::Client::Framing::String::Frame.decode(frame))
         end
       end
 
+      # Closes the socket.
+      #
+      # @api private
       def close_connection
         @socket.close
       end
 
+      # Returns class used for tcp connection failures.
+      #
+      # @api private
+      def self.tcp_connection_failure_exception_class
+        AMQ::Client::TCPConnectionFailed
+      end # self.tcp_connection_failure_exception_class
 
       protected
 
+      # @api private
       def post_init
         reset
         handshake
       end
 
+      # @api private
       def reset
         @chunk_buffer = ""
       end
 
+      # Returns next frame from buffer whenever possible
+      #
+      # @api private
       def get_next_frame
         return nil unless @chunk_buffer.size > 7 # otherwise, cannot read the length
         # octet + short

data/lib/amq/client/adapters/event_machine.rb

@@ -137,10 +137,13 @@ module AMQ
         # EventMachine::Connection's and Adapter's constructors arity
         # make it easier to use *args. MK.
         @settings                           = args.first
-        @on_possible_authentication_failure = @settings[:on_possible_authentication_failure]
         @on_tcp_connection_failure          = @settings[:on_tcp_connection_failure] || Proc.new { |settings|
           raise self.class.tcp_connection_failure_exception_class.new(settings)
         }
+        @on_possible_authentication_failure = @settings[:on_possible_authentication_failure] || Proc.new { |settings|
+          raise self.class.authentication_failure_exception_class.new(settings)
+        }
+
 
         self.reset
 
@@ -306,7 +309,7 @@ module AMQ
       end # disconnection_successful
 
 
-      # Called when initial TCP connection fails.
+      # Called when previously established TCP connection fails.
       # @api public
       def tcp_connection_lost
         @on_tcp_connection_loss.call(self, @settings) if @on_tcp_connection_loss

data/lib/amq/client/entity.rb

@@ -68,6 +68,10 @@ module AMQ
         callbacks = Array(self.callbacks.delete(name))
         callbacks.map { |c| c.call(self, *args, &block) } if callbacks.any?
       end
+
+      def has_callback?(name)
+        self.callbacks[name] && !self.callbacks[name].empty?
+      end # has_callback?
     end
 
     # AMQ entities, as implemented by AMQ::Client, have callbacks and can run them

data/lib/amq/client/version.rb

@@ -1,5 +1,5 @@
 module AMQ
   module Client
-    VERSION = "0.7.0.alpha13"
+    VERSION = "0.7.0.alpha14"
   end
 end

data/spec/integration/coolio/connection_close_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+require 'integration/coolio/spec_helper'
+
+describe "AMQ::Client::CoolioClient", "Connection.Close", :nojruby => true do
+  include EventedSpec::SpecHelper
+  default_timeout 0.5
+
+  it "should issue a callback and close connection" do
+    coolio do
+      AMQ::Client::CoolioClient.connect do |client|
+        @client = client
+        client.should be_opened
+        client.close do
+          done
+        end
+      end
+    end
+    @client.should be_closed
+  end
+end

data/spec/integration/coolio/connection_start_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+require 'integration/coolio/spec_helper'
+
+#
+# We assume that default connection settings (amqp://guest:guest@localhost:5672/) should work
+#
+describe "AMQ::Client::CoolioClient", "Connection.Start", :nojruby => true do
+  include EventedSpec::SpecHelper
+  default_timeout 0.5
+
+  context "with valid credentials" do
+    it "should trigger the callback" do
+      coolio do
+        AMQ::Client::CoolioClient.connect do |client|
+          client.should be_opened
+          done
+        end
+      end
+    end
+  end
+
+  context "with invalid credentials" do
+    context "when given an errback" do
+      it "should trigger the errback" do
+        coolio do
+          AMQ::Client::CoolioClient.connect(:port => 12938, :on_tcp_connection_failure => proc { done }) do |client|
+            raise "This callback should never happen"
+          end
+        end
+      end
+    end
+
+    context "when given no errback" do
+      it "should raise an error" do
+        expect {
+          coolio do
+            AMQ::Client::CoolioClient.connect(:port => 12938) { }
+            done(0.5)
+          end
+        }.to raise_error(AMQ::Client::TCPConnectionFailed)
+      end
+    end
+  end
+
+end

data/spec/integration/eventmachine/connection_close_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+require 'integration/eventmachine/spec_helper'
+
+describe AMQ::Client::EventMachineClient, "Connection.Close" do
+  include EventedSpec::SpecHelper
+  default_timeout 0.5
+
+  it "should issue a callback and close connection" do
+    em do
+      AMQ::Client::EventMachineClient.connect do |client|
+        @client = client
+        client.should be_opened
+        client.close do
+          done
+        end
+      end
+    end
+    @client.should be_closed
+  end
+end

data/spec/integration/eventmachine/connection_start_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+require 'integration/eventmachine/spec_helper'
+
+#
+# We assume that default connection settings (amqp://guest:guest@localhost:5672/) should work
+#
+describe AMQ::Client::EventMachineClient, "Connection.Start" do
+  include EventedSpec::SpecHelper
+  default_timeout 0.5
+
+  context "with valid credentials" do
+    it "should trigger the callback" do
+      em do
+        AMQ::Client::EventMachineClient.connect do |client|
+          done
+        end
+      end
+    end
+  end
+
+  context "with invalid credentials" do
+    context "when given an errback" do
+      it "should trigger the errback" do
+        em do
+          AMQ::Client::EventMachineClient.connect(:port => 12938, :on_tcp_connection_failure => proc { done }) do |client|
+            raise "This callback should never happen"
+          end
+        end
+      end
+    end
+
+    context "when given no errback" do
+      it "should raise an error" do
+        expect {
+          em do
+            AMQ::Client::EventMachineClient.connect(:port => 12938) { }
+            done(0.5)
+          end
+        }.to raise_error(AMQ::Client::TCPConnectionFailed)
+      end
+    end
+  end
+
+end

data/spec/unit/client/entity_spec.rb

@@ -12,6 +12,17 @@ describe AMQ::Client::Entity do
     subject.callbacks.should be_kind_of(Hash)
   end
 
+  describe "#has_callback?" do
+    it "should return true if entity has at least one callback with given name" do
+      subject.define_callback(:init, proc {})
+      subject.has_callback?(:init).should be_true
+    end
+
+    it "should return false if entity doesn't have callbacks with given name" do
+      subject.has_callback?(:init).should be_false
+    end
+  end
+
   describe "#exec_callback" do
     it "executes callback for given event" do
       proc = Proc.new { |*args, &block|

metadata

@@ -1,10 +1,16 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: amq-client
-version: !ruby/object:Gem::Version
-  version: 0.7.0.alpha13
-  prerelease: 6
+version: !ruby/object:Gem::Version 
+  hash: 1369027944
+  prerelease: true
+  segments: 
+  - 0
+  - 7
+  - 0
+  - alpha14
+  version: 0.7.0.alpha14
 platform: ruby
-authors:
+authors: 
 - Jakub Stastny
 - Michael S. Klishin
 - Theo Hultberg
@@ -12,41 +18,46 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: 
-date: 2011-04-24 00:00:00.000000000 +04:00
+date: 2011-04-30 00:00:00 +04:00
 default_executable: 
-dependencies:
-- !ruby/object:Gem::Dependency
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: eventmachine
-  requirement: &2165032900 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :runtime
-  prerelease: false
-  version_requirements: *2165032900
-- !ruby/object:Gem::Dependency
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
   name: amq-protocol
-  requirement: &2165032440 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :runtime
-  prerelease: false
-  version_requirements: *2165032440
-description: amq-client supports multiple networking adapters (EventMachine, TCP sockets,
-  cool.io) and supposed to back more opinionated AMQP clients (such as amqp gem, bunny,
-  et cetera) or be used directly in cases when access to more advanced AMQP 0.9.1
-  features is more important that convenient APIs
-email:
+  version_requirements: *id002
+description: amq-client supports multiple networking adapters (EventMachine, TCP sockets, cool.io) and supposed to back more opinionated AMQP clients (such as amqp gem, bunny, et cetera) or be used directly in cases when access to more advanced AMQP 0.9.1 features is more important that convenient APIs
+email: 
 - stastny@101ideas.cz
 - michael@novemberain.com
 executables: []
+
 extensions: []
-extra_rdoc_files:
+
+extra_rdoc_files: 
 - README.textile
 - doc/_index.html
 - doc/AMQ.html
@@ -57,7 +68,7 @@ extra_rdoc_files:
 - doc/index.html
 - doc/method_list.html
 - doc/top-level-namespace.html
-files:
+files: 
 - .gitignore
 - .gitmodules
 - .rspec
@@ -83,7 +94,8 @@ files:
 - examples/coolio_adapter/queue_unbind.rb
 - examples/eventmachine_adapter/authentication/plain_password_with_custom_role_credentials.rb
 - examples/eventmachine_adapter/authentication/plain_password_with_default_role_credentials.rb
-- examples/eventmachine_adapter/authentication/plain_password_with_incorrect_credentials.rb
+- examples/eventmachine_adapter/authentication/plain_password_with_incorrect_credentials_handled_with_a_callback.rb
+- examples/eventmachine_adapter/authentication/plain_password_with_incorrect_credentials_handled_with_a_rescue_block.rb
 - examples/eventmachine_adapter/basic_cancel.rb
 - examples/eventmachine_adapter/basic_consume.rb
 - examples/eventmachine_adapter/basic_consume_with_acknowledgements.rb
@@ -169,6 +181,8 @@ files:
 - spec/integration/coolio/basic_return_spec.rb
 - spec/integration/coolio/channel_close_spec.rb
 - spec/integration/coolio/channel_flow_spec.rb
+- spec/integration/coolio/connection_close_spec.rb
+- spec/integration/coolio/connection_start_spec.rb
 - spec/integration/coolio/spec_helper.rb
 - spec/integration/coolio/tx_commit_spec.rb
 - spec/integration/coolio/tx_rollback_spec.rb
@@ -177,6 +191,8 @@ files:
 - spec/integration/eventmachine/basic_return_spec.rb
 - spec/integration/eventmachine/channel_close_spec.rb
 - spec/integration/eventmachine/channel_flow_spec.rb
+- spec/integration/eventmachine/connection_close_spec.rb
+- spec/integration/eventmachine/connection_start_spec.rb
 - spec/integration/eventmachine/spec_helper.rb
 - spec/integration/eventmachine/tx_commit_spec.rb
 - spec/integration/eventmachine/tx_rollback_spec.rb
@@ -201,26 +217,38 @@ files:
 has_rdoc: true
 homepage: http://github.com/ruby-amqp/amq-client
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>'
-    - !ruby/object:Gem::Version
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      hash: 25
+      segments: 
+      - 1
+      - 3
+      - 1
       version: 1.3.1
 requirements: []
+
 rubyforge_project: amq-client
-rubygems_version: 1.6.2
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: amq-client is a fully-featured, low-level AMQP 0.9.1 client
 test_files: []
+