adamh-amqp 0.6.3.1

data/README

@@ -0,0 +1,128 @@
+Simple AMQP driver for Ruby/EventMachine
+  (c) 2008 Aman Gupta (tmm1)
+ 
+  http://github.com/tmm1/amqp
+  http://rubyforge.org/projects/amqp
+  http://hopper.squarespace.com/blog/2008/7/22/simple-amqp-library-for-ruby.html
+  http://groups.google.com/group/ruby-amqp
+  http://lists.rabbitmq.com/pipermail/rabbitmq-discuss/2008-July/001417.html
+
+This library works with Ruby 1.8, Ruby 1.9 and JRuby.
+
+This library was tested primarily with RabbitMQ, although it should be compatible with any
+server implementing the AMQP 0-8 spec.
+
+To use with RabbitMQ, first run the server:
+
+  hg clone http://hg.rabbitmq.com/rabbitmq-codegen
+  hg clone http://hg.rabbitmq.com/rabbitmq-server
+  cd rabbitmq-server
+  make run
+
+To get started, refer to the various bundled examples:
+
+  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
+
+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.
+
+To run the test suite:
+
+  rake spec
+
+The lib/amqp/spec.rb file is generated automatically based on the AMQP specification. To generate it:
+
+  rake codegen
+
+This project was inspired by py-amqplib, rabbitmq, qpid and rubbyt.
+Special thanks to Dmitriy Samovskiy, Ben Hood and Tony Garnock-Jones.
+
+AMQP resources:
+
+  Servers:
+    RabbitMQ (Rabbit Technologies, Erlang/OTP, MPL) - http://rabbitmq.com
+    ZeroMQ   (iMatix/FastMQ/Intel, C++, GPL3)       - http://www.zeromq.org
+    OpenAMQ  (iMatix, C, GPL2)                      - http://openamq.org
+    ActiveMQ (Apache Foundation, Java, apache2)     - http://activemq.apache.org
+
+  Steve Vinoski explains AMQP in his column, Towards Integration
+    http://steve.vinoski.net/pdf/IEEE-Advanced_Message_Queuing_Protocol.pdf
+
+  John O'Hara on the history of AMQP
+    http://www.acmqueue.org/modules.php?name=Content&pa=showpage&pid=485
+
+  Dmitriy's presentation on RabbitMQ/AMQP
+    http://somic-org.homelinux.org/blog/2008/07/31/slides-for-my-amqprabbitmq-talk/
+
+  ZeroMQ's analysis of the messaging technology market
+    http://www.zeromq.org/whitepapers:market-analysis
+
+  Pieter Hintjens's background to AMQP
+    http://www.openamq.org/doc:amqp-background
+
+  Barry Pederson's py-amqplib
+    http://barryp.org/software/py-amqplib/
+
+  Ben Hood on writing an AMQP client
+    http://hopper.squarespace.com/blog/2008/6/21/build-your-own-amqp-client.html
+
+  Dmitriy Samovskiy introduces Ruby + QPid + RabbitMQ
+    http://somic-org.homelinux.org/blog/2008/06/24/ruby-amqp-rabbitmq-example/
+
+  Ben Hood's as3-amqp
+    http://github.com/0x6e6562/as3-amqp
+    http://hopper.squarespace.com/blog/2008/7/4/server-side-as3.html
+    http://hopper.squarespace.com/blog/2008/3/24/as3-amqp-client-first-cut.html
+
+  RabbitMQ's protocol code generator
+    http://hg.rabbitmq.com/rabbitmq-codegen/
+
+  Erlang Exchange presentation on the implementation of RabbitMQ
+    http://skillsmatter.com/podcast/erlang/presenting-rabbitmq-an-erlang-based-implementatio-nof-amqp
+    http://www.lshift.net/blog/2008/07/01/slides-from-our-erlang-exchange-talk
+
+  Jonathan Conway's series on RabbitMQ and using it with Ruby/Merb
+    http://jaikoo.com/2008/3/20/daemonize-rabbitmq
+    http://jaikoo.com/2008/3/14/oh-hai-rabbitmq
+    http://jaikoo.com/2008/2/29/friday-round-up-2008-02-29
+    http://jaikoo.com/2007/9/4/didn-t-you-get-the-memo
+
+  Open Enterprise's series on messaging middleware and AMQP
+    http://www1.interopsystems.com/analysis/can-amqp-break-ibms-mom-monopoly-part-1.html
+    http://www1.interopsystems.com/analysis/can-amqp-break-ibms-mom-monopoly-part-2.html
+    http://www1.interopsystems.com/analysis/can-amqp-break-ibms-mom-monopoly-part-3.html
+
+Messaging and distributed systems resources:
+
+  A Critique of the Remote Procedure Call Paradigm
+    http://www.cs.vu.nl/~ast/publications/euteco-1988.pdf
+
+  A Note on Distributed Computing
+    http://research.sun.com/techrep/1994/smli_tr-94-29.pdf
+
+  Convenience Over Correctness
+    http://steve.vinoski.net/pdf/IEEE-Convenience_Over_Correctness.pdf
+
+  Metaprotocol Taxonomy and Communications Patterns
+    http://hessian.caucho.com/doc/metaprotocol-taxonomy.xtp
+
+  Joe Armstrong on Erlang messaging vs RPC
+    http://armstrongonsoftware.blogspot.com/2008/05/road-we-didnt-go-down.html
+
+  SEDA: scalable internet services using message queues
+    http://www.eecs.harvard.edu/~mdw/papers/seda-sosp01.pdf

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.3.1'
+  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/amqp/simple.rb

@@ -0,0 +1,79 @@
+$:.unshift File.dirname(__FILE__) + '/../../lib'
+require 'amqp'
+
+module SimpleClient
+  def process_frame frame
+    case frame
+    when Frame::Body
+      EM.stop_event_loop
+
+    when Frame::Method
+      case method = frame.payload
+      when Protocol::Connection::Start
+        send Protocol::Connection::StartOk.new({:platform => 'Ruby/EventMachine',
+                                                :product => 'AMQP',
+                                                :information => 'http://github.com/tmm1/amqp',
+                                                :version => '0.1.0'},
+                                               'AMQPLAIN',
+                                               {:LOGIN => 'guest',
+                                                :PASSWORD => 'guest'},
+                                               'en_US')
+
+      when Protocol::Connection::Tune
+        send Protocol::Connection::TuneOk.new(:channel_max => 0,
+                                              :frame_max => 131072,
+                                              :heartbeat => 0)
+
+        send Protocol::Connection::Open.new(:virtual_host => '/',
+                                            :capabilities => '',
+                                            :insist => false)
+
+      when Protocol::Connection::OpenOk
+        send Protocol::Channel::Open.new, :channel => 1
+
+      when Protocol::Channel::OpenOk
+        send Protocol::Access::Request.new(:realm => '/data',
+                                           :read => true,
+                                           :write => true,
+                                           :active => true), :channel => 1
+
+      when Protocol::Access::RequestOk
+        @ticket = method.ticket
+        send Protocol::Queue::Declare.new(:ticket => @ticket,
+                                          :queue => '',
+                                          :exclusive => false,
+                                          :auto_delete => true), :channel => 1
+
+      when Protocol::Queue::DeclareOk
+        @queue = method.queue
+        send Protocol::Queue::Bind.new(:ticket => @ticket,
+                                       :queue => @queue,
+                                       :exchange => '',
+                                       :routing_key => 'test_route'), :channel => 1
+
+      when Protocol::Queue::BindOk
+        send Protocol::Basic::Consume.new(:ticket => @ticket,
+                                          :queue => @queue,
+                                          :no_local => false,
+                                          :no_ack => true), :channel => 1
+
+      when Protocol::Basic::ConsumeOk
+        data = "this is a test!"
+
+        send Protocol::Basic::Publish.new(:ticket => @ticket,
+                                          :exchange => '',
+                                          :routing_key => 'test_route'), :channel => 1
+        send Protocol::Header.new(Protocol::Basic, data.length, :content_type => 'application/octet-stream',
+                                                                :delivery_mode => 1,
+                                                                :priority => 0), :channel => 1
+        send Frame::Body.new(data), :channel => 1
+      end
+    end
+  end
+end
+
+EM.run{
+  AMQP.logging = true
+  AMQP.client = SimpleClient
+  AMQP.start
+}

data/examples/mq/ack.rb

@@ -0,0 +1,45 @@
+$:.unshift File.dirname(__FILE__) + '/../../lib'
+require 'mq'
+
+# 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 } }
+
+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')
+
+  i = 0
+
+  # Stopping after the second item was acked will keep the 3rd item in the queue
+  MQ.queue('awesome').subscribe(:ack => true) do |h,m|
+    if (i+=1) == 3
+      puts 'Shutting down...'
+      AMQP.stop{ EM.stop }
+    end
+
+    if AMQP.closing?
+      puts "#{m} (ignored, redelivered later)"
+    else
+      puts m
+      h.ack
+    end
+  end
+end
+
+__END__
+
+Totally rad 1
+Totally rad 2
+Shutting down...
+Totally rad 3 (ignored, redelivered later)
+
+When restarted:
+
+Totally rad 3
+Totally rad 1
+Shutting down...
+Totally rad 2 (ignored, redelivered later)
+Totally rad 3 (ignored, redelivered later)

data/examples/mq/clock.rb

@@ -0,0 +1,56 @@
+$:.unshift File.dirname(__FILE__) + '/../../lib'
+require 'mq'
+
+AMQP.start(:host => 'localhost') do
+
+  def log *args
+    p args
+  end
+
+  # AMQP.logging = true
+
+  clock = MQ.new.fanout('clock')
+  EM.add_periodic_timer(1){
+    puts
+
+    log :publishing, time = Time.now
+    clock.publish(Marshal.dump(time))
+  }
+
+  amq = MQ.new
+  amq.queue('every second').bind(amq.fanout('clock')).subscribe{ |time|
+    log 'every second', :received, Marshal.load(time)
+  }
+
+  amq = MQ.new
+  amq.queue('every 5 seconds').bind(amq.fanout('clock')).subscribe{ |time|
+    time = Marshal.load(time)
+    log 'every 5 seconds', :received, time if time.strftime('%S').to_i%5 == 0
+  }
+
+end
+
+__END__
+
+[:publishing, Thu Jul 17 20:14:00 -0700 2008]
+["every 5 seconds", :received, Thu Jul 17 20:14:00 -0700 2008]
+["every second", :received, Thu Jul 17 20:14:00 -0700 2008]
+
+[:publishing, Thu Jul 17 20:14:01 -0700 2008]
+["every second", :received, Thu Jul 17 20:14:01 -0700 2008]
+
+[:publishing, Thu Jul 17 20:14:02 -0700 2008]
+["every second", :received, Thu Jul 17 20:14:02 -0700 2008]
+
+[:publishing, Thu Jul 17 20:14:03 -0700 2008]
+["every second", :received, Thu Jul 17 20:14:03 -0700 2008]
+
+[:publishing, Thu Jul 17 20:14:04 -0700 2008]
+["every second", :received, Thu Jul 17 20:14:04 -0700 2008]
+
+[:publishing, Thu Jul 17 20:14:05 -0700 2008]
+["every 5 seconds", :received, Thu Jul 17 20:14:05 -0700 2008]
+["every second", :received, Thu Jul 17 20:14:05 -0700 2008]
+
+[:publishing, Thu Jul 17 20:14:06 -0700 2008]
+["every second", :received, Thu Jul 17 20:14:06 -0700 2008]