amqp 0.7.5 → 0.8.0.beta1

data/lib/amqp/rpc.rb

@@ -1,114 +1,18 @@
-# encoding: utf-8
+$stdout.puts <<-MESSAGE
+-------------------------------------------------------------------------------------
+DEPRECATION WARNING!
 
-module AMQP
+Use of amqp/rpc.rb is deprecated. Instead of
 
-  # encoding: utf-8
+  require "amqp/rpc"
 
-  if defined?(BasicObject)
-    BlankSlate = BasicObject
-  else
-    class BlankSlate #:nodoc:
-      instance_methods.each { |m| undef_method m unless m =~ /^__/ }
-    end
-  end
+please use
 
+  require "amqp/deprecated/rpc"
 
-  # Basic RPC (remote procedure call) facility.
-  #
-  # Needs more detail and explanation.
-  #
-  #  EM.run do
-  #    server = AMQP::Channel.new.rpc('hash table node', Hash)
-  #
-  #    client = AMQP::Channel.new.rpc('hash table node')
-  #    client[:now] = Time.now
-  #    client[:one] = 1
-  #
-  #    client.values do |res|
-  #      p 'client', :values => res
-  #    end
-  #
-  #    client.keys do |res|
-  #      p 'client', :keys => res
-  #      EM.stop_event_loop
-  #    end
-  #  end
-  #
-  class RPC < ::AMQP::BlankSlate
-    # Takes a channel, queue and optional object.
-    #
-    # The optional object may be a class name, module name or object
-    # instance. When given a class or module name, the object is instantiated
-    # during this setup. The passed queue is automatically subscribed to so
-    # it passes all messages (and their arguments) to the object.
-    #
-    # Marshalling and unmarshalling the objects is handled internally. This
-    # marshalling is subject to the same restrictions as defined in the
-    # Marshal[http://ruby-doc.org/core/classes/Marshal.html] standard
-    # library. See that documentation for further reference.
-    #
-    # When the optional object is not passed, the returned rpc reference is
-    # used to send messages and arguments to the queue. See #method_missing
-    # which does all of the heavy lifting with the proxy. Some client
-    # elsewhere must call this method *with* the optional block so that
-    # there is a valid destination. Failure to do so will just enqueue
-    # marshalled messages that are never consumed.
-    #
-    def initialize(mq, queue, obj = nil)
-      @mq = mq
-      @mq.rpcs[queue] ||= self
 
-      if obj
-        @obj = case obj
-               when ::Class
-                 obj.new
-               when ::Module
-                 (::Class.new do include(obj) end).new
-               else
-                 obj
-               end
+Both amqp/rpc.rb and AMQP::RPC implementation will be REMOVED before 1.0 release.
+If you need RPC, we recommend the rpc gem (see https://github.com/ruby-amqp/rpc).
+MESSAGE
 
-        @mq.queue(queue).subscribe(:ack => true) { |info, request|
-          method, *args = ::Marshal.load(request)
-          ret = @obj.__send__(method, *args)
-
-          info.ack
-
-          if info.reply_to
-            @mq.queue(info.reply_to, :auto_delete => true).publish(::Marshal.dump(ret), :key => info.reply_to, :message_id => info.message_id)
-          end
-        }
-      else
-        @callbacks ||= {}
-        # XXX implement and use queue(nil)
-        @queue = @mq.queue(@name = "random identifier #{::Kernel.rand(999_999_999_999)}", :auto_delete => true).subscribe { |info, msg|
-          if blk = @callbacks.delete(info.message_id)
-            blk.call ::Marshal.load(msg)
-          end
-        }
-        @remote = @mq.queue(queue)
-      end
-    end
-
-    # Calling AMQP::Channel.rpc(*args) returns a proxy object without any methods beyond
-    # those in Object. All calls to the proxy are handled by #method_missing which
-    # works to marshal and unmarshal all method calls and their arguments.
-    #
-    #  EM.run do
-    #    server = AMQP::Channel.new.rpc('hash table node', Hash)
-    #    client = AMQP::Channel.new.rpc('hash table node')
-    #
-    #    # calls #method_missing on #[] which marshals the method name and
-    #    # arguments to publish them to the remote
-    #    client[:now] = Time.now
-    #    ....
-    #  end
-    #
-    def method_missing(meth, *args, &blk)
-      # XXX use uuids instead
-      message_id = "random message id #{::Kernel.rand(999_999_999_999)}"
-      @callbacks[message_id] = blk if blk
-      @remote.publish(::Marshal.dump([meth, *args]), :reply_to => blk ? @name : nil, :message_id => message_id)
-    end
-  end
-end
+require "amqp/deprecated/rpc"

data/lib/amqp/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 
 module AMQP
-  VERSION = '0.7.5'
+  VERSION = '0.8.0.beta1'
 end

data/lib/mq.rb

@@ -20,7 +20,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.
 
-Learn more at http://bit.ly/amqp-gem-080-migration.
+If you disagree with this really strongly, let us know by opening an issue at
+https://github.com/ruby-amqp/amqp/issues
 
 Thank you for understanding. AMQP gem maintainers team.
 

data/lib/mq/logger.rb

@@ -0,0 +1,2 @@
+require "mq"
+require "amqp/logger"

data/lib/mq/rpc.rb

@@ -0,0 +1,2 @@
+require "mq"
+require "amqp/rpc"

data/spec/integration/authentication_spec.rb

@@ -7,34 +7,31 @@ describe "Authentication attempt" do
   # Environment
   #
 
-  include EventedSpec::EMSpec
-  default_timeout 1
-  em_before { AMQP.cleanup_state }
-  em_after  { AMQP.cleanup_state }
+  include EventedSpec::AMQPSpec
+  include EventedSpec::SpecHelper
 
 
-  # Tests below use AMQP_OPTS for settings, if you really need to modify them,
-  # create amqp.yml file with new settings. (see spec/spec_helper)
-
-  # Also it assumes that guest/guest has access to /
   describe "with default connection parameters" do
+
     #
     # Examples
     #
 
-
+    # assuming there is an account guest with password of "guest" that has
+    # access to / (default vhost)
     context "when guest/guest has access to /" do
       after :all do
         done
       end
 
       it "succeeds" do
-        connection = AMQP.connect
+        AMQP.connect do |connection|
+          connection.should be_open
 
-        done(0.3) {
-          connection.should be_connected
-          connection.close
-        }
+          connection.close { done }
+        end
+
+        done(0.5)
       end # it
     end # context
   end # describe
@@ -46,18 +43,14 @@ describe "Authentication attempt" do
     # Examples
     #
 
-    # assuming AMQP_OPTS are correct
-    # and SchadenFreude with random password doesn't have any access
-    context "when #{AMQP_OPTS[:username]} has access to #{AMQP_OPTS[:vhost]}" do
-      after :all do
-        done
-      end
-
+    # assuming there is an account amqp_gem with password of "amqp_gem_password" that has
+    # access to /amqp_gem_testbed
+    context "when amqp_gem/amqp_gem_testbed has access to /amqp_gem_testbed" do
       context "and provided credentials are correct" do
         it "succeeds" do
-          connection = AMQP.connect :username => AMQP_OPTS[:username], :password => AMQP_OPTS[:password], :vhost => AMQP_OPTS[:vhost]
+          connection = AMQP.connect :username => "amqp_gem", :password => "amqp_gem_password", :vhost => "/amqp_gem_testbed"
 
-          done(0.3) {
+          done(0.5) {
             connection.should be_connected
             connection.close
           }
@@ -65,12 +58,17 @@ describe "Authentication attempt" do
       end # context
 
       context "and provided credentials ARE INCORRECT" do
-        it "fails" do
-          connection = AMQP.connect :user => "SchadenFreude", :pass => Time.now.to_i.to_s, :vhost => AMQP_OPTS[:vhost]
+        default_timeout 10
 
-          done(0.5) {
-            connection.should_not be_connected
+        after(:all) { done }
+
+        it "fails" do
+          handler = Proc.new { |settings|
+            puts "Callback has fired"
+            callback_has_fired = true
+            done
           }
+          connection = AMQP.connect(:username => "amqp_gem", :password => Time.now.to_i.to_s, :vhost => "/amqp_gem_testbed", :on_possible_authentication_failure => handler)
         end # it
       end
     end # context
@@ -83,16 +81,12 @@ describe "Authentication attempt" do
     # Examples
     #
 
-    # assuming AMQP_OPTS are correct
-    # and SchadenFreude with random password doesn't have any access
-    context "when #{AMQP_OPTS[:username]} has access to #{AMQP_OPTS[:vhost]}" do
-      after :all do
-        done
-      end
-
+    # assuming there is an account amqp_gem with password of "amqp_gem_password" that has
+    # access to /amqp_gem_testbed
+    context "when amqp_gem/amqp_gem_testbed has access to /amqp_gem_testbed" do
       context "and provided credentials are correct" do
         it "succeeds" do
-          connection = AMQP.connect "amqp://#{AMQP_OPTS[:username]}:#{AMQP_OPTS[:password]}@localhost/#{URI::escape AMQP_OPTS[:vhost], /[^-_.!~*'()a-zA-Z\d]/n}"
+          connection = AMQP.connect "amqp://amqp_gem:amqp_gem_password@localhost/amqp_gem_testbed"
 
           done(0.3) {
             connection.should be_connected
@@ -102,12 +96,14 @@ describe "Authentication attempt" do
       end # context
 
       context "and provided credentials ARE INCORRECT" do
-        it "succeeds" do
-          connection = AMQP.connect "amqp://schadenfreude:#{Time.now.to_i}@localhost"
+        default_timeout 10
 
-          done(0.5) {
-            connection.should_not be_connected
-            connection.close
+        after(:all) { done }
+
+        it "fails" do
+          connection = AMQP.connect "amqp://amqp_gem:#{Time.now.to_i}@localhost/amqp_gem_testbed", :on_possible_authentication_failure => Proc.new { |settings|
+            puts "Callback has fired"
+            done
           }
         end # it
       end # context

data/spec/integration/automatic_binding_for_default_direct_exchange_spec.rb

@@ -16,8 +16,8 @@ describe "Queue that was bound to default direct exchange thanks to Automatic Mo
     @channel   = AMQP::Channel.new
     @channel.should be_open
 
-    @queue1    = @channel.queue("amqp-gem.automatic-binding.q1", :auto_delete => true)
-    @queue2    = @channel.queue("amqp-gem.automatic-binding.q2", :auto_delete => true)
+    @queue1    = @channel.queue("queue1")
+    @queue2    = @channel.queue("queue2")
 
     # Rely on default direct exchange binding, see section 2.1.2.4 Automatic Mode in AMQP 0.9.1 spec.
     @exchange = AMQP::Exchange.default(@channel)
@@ -55,9 +55,7 @@ describe "Queue that was bound to default direct exchange thanks to Automatic Mo
       @exchange.publish("some white noise", :routing_key => "killa key")
     end
 
-    delayed(0.2) { @queue2.delete }
-
-    done(0.35) {
+    done(0.2) {
       number_of_received_messages.should == expected_number_of_messages
     }
   end # it

data/spec/integration/basic_get_spec.rb

@@ -0,0 +1,91 @@
+# -*- coding: utf-8 -*-
+require "spec_helper"
+
+describe AMQP::Queue, "#pop" do
+
+  #
+  # Environment
+  #
+
+  include EventedSpec::AMQPSpec
+  include EventedSpec::SpecHelper
+
+
+  default_options AMQP_OPTS
+  default_timeout 10
+
+  amqp_before do
+    @channel   = AMQP::Channel.new
+    @channel.should be_open
+
+    @queue_name = "amqpgem.integration.basic.get.queue"
+
+    @exchange = @channel.fanout("amqpgem.integration.basic.get.queue", :auto_delete => true)
+    @queue    = @channel.queue(@queue_name, :auto_delete => true)
+
+    @queue.bind(@exchange) do
+      puts "Bound #{@exchange.name} => #{@queue.name}"
+    end
+
+    @dispatched_data = "fetch me synchronously"
+  end
+
+
+
+  #
+  # Examples
+  #
+
+  context "when THERE ARE NO messages in the queue" do
+    it "yields nil (instead of message payload) to the callback" do
+      @queue.purge do
+        callback_has_fired = false
+
+        @queue.status do |number_of_messages, number_of_consumers|
+          number_of_messages.should == 0
+        end
+
+        @queue.pop do |payload|
+          callback_has_fired = true
+
+          payload.should be_nil
+        end
+
+        done(0.2) {
+          callback_has_fired.should be_true
+        }
+      end
+    end
+  end
+
+  context "when THERE ARE messages in the queue" do  
+    it "yields message payload to the callback" do
+      number_of_received_messages = 0
+      expected_number_of_messages = 300
+
+      expected_number_of_messages.times do |i|
+        @exchange.publish(@dispatched_data + "_#{i}", :key => @queue_name)
+      end
+
+      @queue.status do |number_of_messages, number_of_consumers|
+        expected_number_of_messages.times do
+          @queue.pop do |headers, payload|
+            payload.should_not be_nil
+            number_of_received_messages += 1            
+            headers.message_count.should == (expected_number_of_messages - number_of_received_messages)
+
+            if RUBY_VERSION =~ /^1.9/
+              payload.force_encoding("UTF-8").should =~ /#{@dispatched_data}/
+            else
+              payload.should =~ /#{@dispatched_data}/
+            end
+          end # pop
+        end # do
+      end
+
+      done(1.5) {
+        number_of_received_messages.should == expected_number_of_messages
+      }
+    end # it
+  end # context
+end # describe

data/spec/integration/channel_close_spec.rb

@@ -2,14 +2,14 @@
 
 require "spec_helper"
 
-describe AMQP, "#close(&callback)" do
+describe AMQP::Channel, "#close(&callback)" do
   include EventedSpec::AMQPSpec
 
-  default_timeout 5
-
   it "takes a callback which will run when we get back Channel.Close-Ok" do
-    AMQP::Channel.new.close do |amq|
-      done
+    channel = AMQP::Channel.new do |*args|
+      channel.close do |channel, method|
+        done
+      end
     end
   end
 end

data/spec/integration/exchange_declaration_spec.rb

@@ -26,8 +26,6 @@ describe AMQP do
       it 'declares a new direct exchange with that name' do
         @channel.direct('name').name.should == 'name'
 
-        @channel.direct('name').delete
-
         done
       end
 
@@ -37,8 +35,6 @@ describe AMQP do
         exchange.should_not be_durable
         exchange.should be_transient
 
-        exchange.delete
-
         done
       end
 
@@ -46,7 +42,6 @@ describe AMQP do
         exchange = @channel.direct('name')
 
         exchange.should_not be_auto_deleted
-        exchange.delete
 
         done
       end
@@ -64,9 +59,9 @@ describe AMQP do
     context "when exchange name was specified as a blank string" do
       it 'returns direct exchange with server-generated name' do
         pending <<-EOF
-          This has to be fixed in RabbitMQ first
-          https://bugzilla.rabbitmq.com/show_bug.cgi?id=23509
-        EOF
+      This has to be fixed in RabbitMQ first
+      https://bugzilla.rabbitmq.com/show_bug.cgi?id=23509
+    EOF
         @channel.direct("") do |exchange|
           exchange.name.should_not be_empty
           done
@@ -85,9 +80,6 @@ describe AMQP do
 
           exchange.should == original_exchange
 
-          original_exchange.delete
-          exchange.delete
-
           done
         end # it
       end
@@ -112,8 +104,6 @@ describe AMQP do
         exchange.should be_durable
         exchange.should_not be_transient
 
-        exchange.delete
-
         done
       end # it
     end # context
@@ -125,8 +115,6 @@ describe AMQP do
         exchange.should_not be_durable
         exchange.should be_transient
 
-        exchange.delete
-
         done
       end # it
     end # context
@@ -137,7 +125,6 @@ describe AMQP do
         exchange = @channel.direct("a new auto-deleted direct exchange", :auto_delete => true)
 
         exchange.should be_auto_deleted
-        exchange.delete
         done
       end # it
     end # context
@@ -148,7 +135,6 @@ describe AMQP do
         exchange = @channel.direct("a new non-auto-deleted direct exchange", :auto_delete => false)
 
         exchange.should_not be_auto_deleted
-        exchange.delete
         done
       end # it
     end # context
@@ -159,7 +145,6 @@ describe AMQP do
         exchange = @channel.direct("a new non-auto-deleted direct exchange", :auto_delete => false)
 
         exchange.should_not be_auto_deleted
-        exchange.delete
         done
       end # it
     end # context
@@ -167,14 +152,12 @@ describe AMQP do
 
     context "when exchange is re-declared with parameters different from original declaration" do
       it "raises an exception" do
-        exchange = @channel.direct("previously.declared.durable.direct.exchange", :durable => true)
+        @channel.direct("previously.declared.durable.direct.exchange", :durable => true)
 
         expect {
           @channel.direct("previously.declared.durable.direct.exchange", :durable => false)
         }.to raise_error(AMQP::IncompatibleOptionsError)
 
-        exchange.delete
-
         done
       end # it
     end # context
@@ -191,7 +174,6 @@ describe AMQP do
         exchange = @channel.fanout(name)
 
         exchange.name.should == name
-        exchange.delete
 
         done
       end
@@ -217,9 +199,6 @@ describe AMQP do
 
           exchange.should == original_exchange
 
-          original_exchange.delete
-          exchange.delete
-
           done
         end # it
       end
@@ -314,8 +293,6 @@ describe AMQP do
         exchange = @channel.topic(name)
         exchange.name.should == name
 
-        exchange.delete
-
         done
       end
     end # context
@@ -339,8 +316,6 @@ describe AMQP do
           exchange          = @channel.topic(name, :passive => true)
 
           exchange.should == original_exchange
-          original_exchange.delete
-          exchange.delete
 
           done
         end # it
@@ -366,8 +341,6 @@ describe AMQP do
         exchange.should be_durable
         exchange.should_not be_transient
 
-        exchange.delete
-
         done
       end # it
     end # context
@@ -379,8 +352,6 @@ describe AMQP do
         exchange.should_not be_durable
         exchange.should be_transient
 
-        exchange.delete
-
         done
       end # it
     end # context
@@ -401,7 +372,6 @@ describe AMQP do
         exchange = @channel.topic("a new non-auto-deleted topic exchange", :auto_delete => false)
 
         exchange.should_not be_auto_deleted
-        exchange.delete
         done
       end # it
     end # context
@@ -412,7 +382,6 @@ describe AMQP do
         exchange = @channel.topic("a new non-auto-deleted topic exchange", :auto_delete => false)
 
         exchange.should_not be_auto_deleted
-        exchange.delete
         done
       end # it
     end # context
@@ -426,15 +395,13 @@ describe AMQP do
       it "raises an exception" do
         channel = AMQP::Channel.new
 
-        exchange = channel.topic("previously.declared.durable.topic.exchange", :durable => true)
+        channel.topic("previously.declared.durable.topic.exchange", :durable => true)
         channel.should be_open
 
         expect {
           channel.topic("previously.declared.durable.topic.exchange", :durable => false)
         }.to raise_error(AMQP::IncompatibleOptionsError)
 
-        exchange.delete
-
         done
       end # it
     end # context
@@ -451,7 +418,6 @@ describe AMQP do
         exchange = @channel.headers(name)
 
         exchange.name.should == name
-        exchange.delete
 
         done
       end
@@ -480,8 +446,6 @@ describe AMQP do
           exchange          = @channel.headers(name, :passive => true)
 
           exchange.should == original_exchange
-          original_exchange.delete
-          exchange.delete
 
           done
         end # it
@@ -507,8 +471,6 @@ describe AMQP do
         exchange.should be_durable
         exchange.should_not be_transient
 
-        exchange.delete
-
         done
       end # it
     end # context
@@ -520,8 +482,6 @@ describe AMQP do
         exchange.should_not be_durable
         exchange.should be_transient
 
-        exchange.delete
-
         done
       end # it
     end # context
@@ -532,7 +492,6 @@ describe AMQP do
         exchange = @channel.headers("a new auto-deleted headers exchange", :auto_delete => true)
 
         exchange.should be_auto_deleted
-
         done
       end # it
     end # context
@@ -543,8 +502,6 @@ describe AMQP do
         exchange = @channel.headers("a new non-auto-deleted headers exchange", :auto_delete => false)
 
         exchange.should_not be_auto_deleted
-        exchange.delete
-
         done
       end # it
     end # context
@@ -555,8 +512,6 @@ describe AMQP do
         exchange = @channel.headers("a new non-auto-deleted headers exchange", :auto_delete => false)
 
         exchange.should_not be_auto_deleted
-        exchange.delete
-
         done
       end # it
     end # context
@@ -568,14 +523,12 @@ describe AMQP do
       end
 
       it "raises an exception" do
-        exchange = @channel.headers("previously.declared.durable.topic.exchange", :durable => true)
+        @channel.headers("previously.declared.durable.topic.exchange", :durable => true)
 
         expect {
           @channel.headers("previously.declared.durable.topic.exchange", :durable => false)
         }.to raise_error(AMQP::IncompatibleOptionsError)
 
-        exchange.delete
-
         done
       end # it
     end # context