amqp 0.6.0 → 0.6.4

data/README

@@ -21,10 +21,14 @@ To use with RabbitMQ, first run the server:
 
 To get started, refer to the various bundled examples:
 
-  ruby examples/mq/simple.rb     # low-level Queue/Exchange api
   ruby examples/mq/pingpong.rb   # 1-1 communication using amq.direct
   ruby examples/mq/clock.rb      # 1-N communication using amq.fanout
   ruby examples/mq/stocks.rb     # 1-subscriber communication using amq.topic
+
+  ruby examples/mq/multiclock.rb # header based routing (new rabbitmq feature)
+  ruby examples/mq/ack.rb        # using ack
+  ruby examples/mq/pop.rb        # pop off messages one at a time
+
   ruby examples/mq/hashtable.rb  # simple async rpc layer
   ruby examples/mq/primes.rb 4   # parallelized prime number generation
   ruby examples/mq/logger.rb     # simple logging api
@@ -32,6 +36,7 @@ To get started, refer to the various bundled examples:
 For more details into the lower level AMQP client API, run the simple client example:
 
   ruby examples/amqp/simple.rb   # low-level AMQP api
+  ruby examples/mq/internal.rb   # low-level Queue/Exchange api
 
 Or refer to protocol/doc.txt, which enumerates packets sent between a server and client
 during a typical session, in both binary and decoded formats.

data/Rakefile

@@ -0,0 +1,15 @@
+task :codegen do
+  sh 'ruby protocol/codegen.rb > lib/amqp/spec.rb'
+  sh 'ruby lib/amqp/spec.rb'
+end
+
+task :spec do
+  sh 'bacon lib/amqp.rb'
+end
+
+task :gem do
+  sh 'gem build *.gemspec'
+end
+
+task :pkg => :gem
+task :package => :gem

data/amqp.gemspec

@@ -0,0 +1,83 @@
+spec = Gem::Specification.new do |s|
+  s.name = 'amqp'
+  s.version = '0.6.4'
+  s.date = '2009-01-09'
+  s.summary = 'AMQP client implementation in Ruby/EventMachine'
+  s.email = "amqp@tmm1.net"
+  s.homepage = "http://amqp.rubyforge.org/"
+  s.description = "AMQP client implementation in Ruby/EventMachine"
+  s.has_rdoc = true
+  s.rdoc_options = '--include=examples'
+
+  # ruby -rpp -e' pp `git ls-files`.split("\n").grep(/^(doc|README)/) '
+  s.extra_rdoc_files = [
+    "README",
+    "doc/EXAMPLE_01_PINGPONG",
+    "doc/EXAMPLE_02_CLOCK",
+    "doc/EXAMPLE_03_STOCKS",
+    "doc/EXAMPLE_04_MULTICLOCK",
+    "doc/EXAMPLE_05_ACK",
+    "doc/EXAMPLE_05_POP",
+    "doc/EXAMPLE_06_HASHTABLE"
+  ]
+
+  s.authors = ["Aman Gupta"]
+  s.add_dependency('eventmachine', '>= 0.12.4')
+
+  # ruby -rpp -e' pp `git ls-files`.split("\n") '
+  s.files = [
+    "README",
+    "Rakefile",
+    "amqp.gemspec",
+    "amqp.todo",
+    "doc/EXAMPLE_01_PINGPONG",
+    "doc/EXAMPLE_02_CLOCK",
+    "doc/EXAMPLE_03_STOCKS",
+    "doc/EXAMPLE_04_MULTICLOCK",
+    "doc/EXAMPLE_05_ACK",
+    "doc/EXAMPLE_05_POP",
+    "doc/EXAMPLE_06_HASHTABLE",
+    "examples/amqp/simple.rb",
+    "examples/mq/ack.rb",
+    "examples/mq/clock.rb",
+    "examples/mq/pop.rb",
+    "examples/mq/hashtable.rb",
+    "examples/mq/internal.rb",
+    "examples/mq/logger.rb",
+    "examples/mq/multiclock.rb",
+    "examples/mq/pingpong.rb",
+    "examples/mq/primes-simple.rb",
+    "examples/mq/primes.rb",
+    "examples/mq/stocks.rb",
+    "lib/amqp.rb",
+    "lib/amqp/buffer.rb",
+    "lib/amqp/client.rb",
+    "lib/amqp/frame.rb",
+    "lib/amqp/protocol.rb",
+    "lib/amqp/server.rb",
+    "lib/amqp/spec.rb",
+    "lib/ext/blankslate.rb",
+    "lib/ext/em.rb",
+    "lib/ext/emfork.rb",
+    "lib/mq.rb",
+    "lib/mq/exchange.rb",
+    "lib/mq/header.rb",
+    "lib/mq/logger.rb",
+    "lib/mq/queue.rb",
+    "lib/mq/rpc.rb",
+    "old/README",
+    "old/Rakefile",
+    "old/amqp-0.8.json",
+    "old/amqp_spec.rb",
+    "old/amqpc.rb",
+    "old/codegen.rb",
+    "protocol/amqp-0.8.json",
+    "protocol/amqp-0.8.xml",
+    "protocol/codegen.rb",
+    "protocol/doc.txt",
+    "research/api.rb",
+    "research/primes-forked.rb",
+    "research/primes-processes.rb",
+    "research/primes-threaded.rb"
+  ]
+end

data/amqp.todo

@@ -0,0 +1,32 @@
+- breaks with header values that are nil
+- breaks with header values that are ruby objects (convert to strings?)
+- sending utf8 data in 1.9 breaks
+
+- generate amqp/spec.rb from original xml spec
+- add peek and pop to queues
+- use rabbitmq generated consumer tag from basic.consume-ok reply
+
+- allow temporary queues with amq.queue(nil) syntax (use uuids)
+  - use as temp queue in rpc
+  - use uuids for message ids in rpc
+
+- add ack/completed responses for messages
+- deleting queues/bindings/exchanges
+  + queue.unbind
+  - queue.remove or queue.close or queue.delete
+  - exchange.remove
+  - rpc.remove
+
+- handle errors and exceptions
+    binding to a non-existent (or not yet created in clock.rb) exchange
+      #<AMQP::Protocol::Channel::Close:0x11d35d4
+       @class_id=50,
+       @debug=1,
+       @method_id=20,
+       @reply_code=404,
+       @reply_text="NOT_FOUND - no exchange 'clock' in vhost '/'">>]
+
+- handle connection.redirect during connect (for rabbitmq in distributed mode) [or just set insist to true]
+
+- add amq.queue('name').size{ |num| "#{num} messages in the queue" } (send declare passive, look at declare-ok response)
+- clean up MQ.default on disconnect

data/doc/EXAMPLE_01_PINGPONG

@@ -0,0 +1,2 @@
+== Ping Pong Example
+  :include: mq/pingpong.rb

data/doc/EXAMPLE_02_CLOCK

@@ -0,0 +1,2 @@
+== Clock Example
+  :include: mq/clock.rb

data/doc/EXAMPLE_03_STOCKS

@@ -0,0 +1,2 @@
+== Stocks Example
+  :include: mq/stocks.rb

data/doc/EXAMPLE_04_MULTICLOCK

@@ -0,0 +1,2 @@
+== Muti-format Clock Example
+  :include: mq/multiclock.rb

data/doc/EXAMPLE_05_ACK

@@ -0,0 +1,2 @@
+== Ack Example
+  :include: mq/ack.rb

data/doc/EXAMPLE_05_POP

@@ -0,0 +1,2 @@
+== Pop Example
+  :include: mq/pop.rb

data/doc/EXAMPLE_06_HASHTABLE

@@ -0,0 +1,2 @@
+== HashTable RPC Example
+  :include: mq/hashtable.rb

data/examples/mq/{simple-ack.rb → ack.rb}

@@ -1,13 +1,12 @@
 $:.unshift File.dirname(__FILE__) + '/../../lib'
 require 'mq'
-require 'pp'
 
-# For ack to work appropriatly you must shutdown AMQP gracefully,
+# For ack to work appropriately you must shutdown AMQP gracefully,
 # otherwise all items in your queue will be returned
 Signal.trap('INT') { AMQP.stop{ EM.stop } }
 Signal.trap('TERM'){ AMQP.stop{ EM.stop } }
 
-EM.run do
+AMQP.start(:host => 'localhost') do
   MQ.queue('awesome').publish('Totally rad 1')
   MQ.queue('awesome').publish('Totally rad 2')
   MQ.queue('awesome').publish('Totally rad 3')

data/examples/mq/clock.rb

@@ -1,7 +1,7 @@
 $:.unshift File.dirname(__FILE__) + '/../../lib'
 require 'mq'
 
-EM.run{
+AMQP.start(:host => 'localhost') do
 
   def log *args
     p args
@@ -28,7 +28,7 @@ EM.run{
     log 'every 5 seconds', :received, time if time.strftime('%S').to_i%5 == 0
   }
 
-}
+end
 
 __END__
 

data/examples/mq/hashtable.rb

@@ -1,7 +1,7 @@
 $:.unshift File.dirname(__FILE__) + '/../../lib'
 require 'mq'
 
-EM.run{
+AMQP.start(:host => 'localhost') do
 
   def log *args
     p args
@@ -37,10 +37,10 @@ EM.run{
   client.set(:one, 1)
   client.keys do |res|
     log 'client', :keys => res
-    EM.stop_event_loop
+    AMQP.stop{ EM.stop }
   end
 
-}
+end
 
 __END__
 

data/examples/mq/logger.rb

@@ -4,7 +4,7 @@ require 'mq/logger'
 
 Logger = MQ::Logger
 
-EM.run{
+AMQP.start(:host => 'localhost') do
   if ARGV[0] == 'server'
 
     MQ.queue('logger').bind(MQ.fanout('logging', :durable => true)).subscribe{|msg|
@@ -37,7 +37,7 @@ EM.run{
     log = Logger.new(:webserver, :timestamp, :hostname, &log.printer)
     log.info 'Request for /', :GET, :session => 'abc'
 
-    AMQP.stop{ EM.stop_event_loop }
+    AMQP.stop{ EM.stop }
 
   else
 
@@ -50,7 +50,7 @@ EM.run{
     EM.stop
 
   end
-}
+end
 
 __END__
 

data/examples/mq/multiclock.rb

@@ -0,0 +1,49 @@
+$:.unshift File.dirname(__FILE__) + '/../../lib'
+require 'mq'
+require 'time'
+
+AMQP.start(:host => 'localhost') do
+
+  def log *args
+    p args
+  end
+
+  #AMQP.logging = true
+
+  clock = MQ.new.headers('multiformat_clock')
+  EM.add_periodic_timer(1){
+    puts
+
+    time = Time.new
+    ["iso8601","rfc2822"].each do |format|
+      formatted_time = time.send(format)
+      log :publish, format, formatted_time
+      clock.publish "#{formatted_time}", :headers => {"format" => format}
+    end
+  }
+
+  ["iso8601","rfc2822"].each do |format|
+    amq = MQ.new
+    amq.queue(format.to_s).bind(amq.headers('multiformat_clock'), :arguments => {"format" => format}).subscribe{ |time|
+      log "received #{format}", time
+    }
+  end
+
+end
+
+__END__
+
+[:publish, "iso8601", "2009-02-13T19:55:40-08:00"]
+[:publish, "rfc2822", "Fri, 13 Feb 2009 19:55:40 -0800"]
+["received iso8601", "2009-02-13T19:55:40-08:00"]
+["received rfc2822", "Fri, 13 Feb 2009 19:55:40 -0800"]
+
+[:publish, "iso8601", "2009-02-13T19:55:41-08:00"]
+[:publish, "rfc2822", "Fri, 13 Feb 2009 19:55:41 -0800"]
+["received iso8601", "2009-02-13T19:55:41-08:00"]
+["received rfc2822", "Fri, 13 Feb 2009 19:55:41 -0800"]
+
+[:publish, "iso8601", "2009-02-13T19:55:42-08:00"]
+[:publish, "rfc2822", "Fri, 13 Feb 2009 19:55:42 -0800"]
+["received iso8601", "2009-02-13T19:55:42-08:00"]
+["received rfc2822", "Fri, 13 Feb 2009 19:55:42 -0800"]

data/examples/mq/pingpong.rb

@@ -1,7 +1,7 @@
 $:.unshift File.dirname(__FILE__) + '/../../lib'
 require 'mq'
 
-EM.run{
+AMQP.start(:host => 'localhost') do
 
   def log *args
     p [ Time.now, *args ]
@@ -28,7 +28,7 @@ EM.run{
     log 'two', :received, msg
   }
 
-}
+end
 
 __END__
 

data/examples/mq/primes.rb

@@ -11,7 +11,7 @@ end
 
 # spawn workers
 workers = ARGV[0] ? (Integer(ARGV[0]) rescue 1) : 1
-EM.fork(workers) do
+AMQP.fork(workers) do
 
   log MQ.id, :started
 
@@ -33,7 +33,7 @@ EM.fork(workers) do
 end
 
 # use workers to check which numbers are prime
-EM.run{
+AMQP.start(:host => 'localhost') do
   
   prime_checker = MQ.rpc('prime checker')
 
@@ -52,7 +52,7 @@ EM.run{
 
   end
   
-}
+end
 
 __END__
 

data/examples/mq/stocks.rb

@@ -1,7 +1,7 @@
 $:.unshift File.dirname(__FILE__) + '/../../lib'
 require 'mq'
 
-EM.run{
+AMQP.start(:host => 'localhost') do
 
   def log *args
     p [ Time.now, *args ]
@@ -41,7 +41,7 @@ EM.run{
   watch_appl_stock
   watch_us_stocks
 
-}
+end
 
 __END__
 

data/lib/amqp.rb

@@ -38,7 +38,10 @@ module AMQP
       :timeout => nil,
 
       # logging
-      :logging => false
+      :logging => false,
+
+      # ssl
+      :ssl => false
     }
   end
 
@@ -99,4 +102,14 @@ module AMQP
       }
     end
   end
+
+  def self.fork workers
+    EM.fork(workers) do
+      # clean up globals in the fork
+      Thread.current[:mq] = nil
+      AMQP.instance_variable_set('@conn', nil)
+
+      yield
+    end
+  end
 end

data/lib/amqp/client.rb

@@ -9,7 +9,7 @@ module AMQP
         mq.process_frame(frame)
         return
       end
-      
+
       case frame
       when Frame::Method
         case method = frame.payload
@@ -49,7 +49,7 @@ module AMQP
   def self.client
     @client ||= BasicClient
   end
-  
+
   def self.client= mod
     mod.__send__ :include, AMQP
     @client = mod
@@ -65,23 +65,35 @@ module AMQP
       @on_disconnect ||= proc{ raise Error, "Could not connect to server #{opts[:host]}:#{opts[:port]}" }
 
       timeout @settings[:timeout] if @settings[:timeout]
-      errback{ @on_disconnect.call }
+      errback{ @on_disconnect.call } unless @reconnecting
+
+      @connected = false
     end
 
     def connection_completed
+      start_tls if @settings[:ssl]
       log 'connected'
       # @on_disconnect = proc{ raise Error, 'Disconnected from server' }
       unless @closing
-        @on_disconnect = method(:reconnect)
+        @on_disconnect = method(:disconnected)
         @reconnecting = false
       end
+
+      @connected = true
+      @connection_status.call(:connected) if @connection_status
+
       @buf = Buffer.new
       send_data HEADER
       send_data [1, 1, VERSION_MAJOR, VERSION_MINOR].pack('C4')
     end
 
+    def connected?
+      @connected
+    end
+
     def unbind
       log 'disconnected'
+      @connected = false
       EM.next_tick{ @on_disconnect.call }
     end
 
@@ -95,7 +107,7 @@ module AMQP
     def channels
       @channels ||= {}
     end
-  
+
     def receive_data data
       # log 'receive_data', data
       @buf << data
@@ -110,7 +122,7 @@ module AMQP
       # this is a stub meant to be
       # replaced by the module passed into initialize
     end
-  
+
     def send data, opts = {}
       channel = opts[:channel] ||= 0
       data = data.to_frame(channel) unless data.is_a? Frame
@@ -158,14 +170,14 @@ module AMQP
       end
 
       unless @reconnecting
+        @reconnecting = true
+
         @deferred_status = nil
         initialize(@settings)
 
         mqs = @channels
         @channels = {}
         mqs.each{ |_,mq| mq.reset } if mqs
-
-        @reconnecting = true
       end
 
       log 'reconnecting'
@@ -176,9 +188,18 @@ module AMQP
       opts = AMQP.settings.merge(opts)
       EM.connect opts[:host], opts[:port], self, opts
     end
-  
+
+    def connection_status &blk
+      @connection_status = blk
+    end
+
     private
-  
+
+    def disconnected
+      @connection_status.call(:disconnected) if @connection_status
+      reconnect
+    end
+
     def log *args
       return unless @settings[:logging] or AMQP.logging
       require 'pp'
@@ -186,4 +207,4 @@ module AMQP
       puts
     end
   end
-end
+end