amqp 0.7.5 → 0.8.0.beta1

data/.gitignore

@@ -8,9 +8,8 @@
 Gemfile.lock
 
 spec/amqp.yml
+vendor/bundle
 vendor/cache
-vendor/amq*
-vendor/evented-spec
-doc/*
+
 .yardoc/*
-tmp/*
+doc/*

data/.travis.yml

@@ -1,9 +1,7 @@
-script: "bundle exec rake spec:ci"
+script: "bundle exec rspec spec"
 rvm:
   - 1.8.7
   - 1.9.2
   - ree
-  - jruby
-gemfile:
-  - Gemfile
-  - gemfiles/eventmachine-pre
+  - rbx
+  - jruby

data/.yardopts

@@ -0,0 +1,6 @@
+--no-private
+--protected
+--markup="textile" lib/**/*.rb
+-
+LICENSE
+docs/*.textile

data/CHANGELOG

@@ -1,15 +1,34 @@
-= Version 0.7.2
+= Version 0.8.0
 
-  * [BUG] Server-named queues declared en masse now get their unique names instead of all beign assigned the first generated name
-  * [API] Connection URI (string) format for vhosts no longer assumes that vhosts begin with a slash (/), learn more at http://bit.ly/mfzwcB
-  * [BUG] Queue#reset leaks consumer tags [#40].
+  * [API] AMQP::Channel.new now accepts (an optional) block and yields newly opened channel to it as soon as
+          channel.open-ok arrives from the broker.
+  * [API] AMQP::Header#ack now can acknowledge multiple deliveries
+  * [API] AMQP::Exchange#delete now takes (an optional) block that is called when exchange.delete-ok response arrives.
+  * [API] AMQP::Header now implements #to_hash
+  * [API] AMQP::Queue#pop block now can take 1, 2 or 7 (that's right) arguments.
+          1 argument means handler is only interested in content payload
+	  2 arguments means handler is interested in headers and the content
+	  7 arguments means handlers wants all the properties get-ok (or get-empty) carries
+  * [API] AMQP::Queue#purge  now takes an optional block which is called when queue.purge-ok response arrives.
+  * [API] AMQP::Queue#delete now takes an optional block which is called when queue.delete-ok response arrives.
+  * [API] AMQP::Queue#delete now accepts :nowait option.
+  * [API] AMQP::Queue#unbind now takes an optional block which is called when queue.unbind-ok response arrives.
+  * [API] AMQP::Queue#unbind now accepts :routing_key as alias to :key. we believe it is a good idea to use AMQP terms.
+  * [API] AMQP::Channel#prefetch now takes (an optional) 2nd parameter that specifies
+          that QoS settings should be applied to underlying connection, as well as optional callback.
+  * [API] AMQP::Channel#recover now takes (an optional) callback that is called when
+          basic.recover-ok is received.
+  * [API] AMQP::Frame is gone.
+  * [API] AMQP::Buffer is gone. Serialization & framing are now handled primarily by amq-protocol.
+  * [FEATURE] AMQP gem is now AMQP 0.9.1 compatible: it runs atop of amq-client gem
+  * [API] AMQP::Queue#publish is deprecated.
+  * [API] Name argument for AMQP::Queue.new and Channel#queue is optional.
 
 = Version 0.7.1
 
   * [BUG] AMQP gem no longer conflicts with Builder 2.1.2 on Ruby 1.9.
-          All Ruby on Rails 3 users who run Ruby 1.9 are highly recommended
-	  to upgrade!
-
+        All Ruby on Rails 3 users who run Ruby 1.9 are highly recommended
+  			to upgrade!
   * [API] AMQP::Exchange.default no longer caches exchange object between calls
           because it may lead to very obscure issues when channel that exchange was
 	  using is closed (due to connection loss, as part of test suite teardown

data/Gemfile

@@ -1,24 +1,32 @@
 # encoding: utf-8
 
-source :rubygems
+source "http://gemcutter.org"
 
 # Use local clones if possible.
-# If you want to use your local copy, just symlink it to vendor.
 def custom_gem(name, options = Hash.new)
-  local_path = File.expand_path("../vendor/#{name}", __FILE__)
-  if File.exist?(local_path)
+  local_path = File.expand_path("../../#{name}", __FILE__)
+  if ENV["USE_AMQP_CUSTOM_GEMS"] && File.directory?(local_path)
     gem name, options.merge(:path => local_path).delete_if { |key, _| [:git, :branch].include?(key) }
   else
     gem name, options
   end
 end
 
-
 gem "eventmachine"
+gem "json", :platform => :ruby_18
+custom_gem "amq-client",   :git => "git://github.com/ruby-amqp/amq-client.git",   :branch => "master"
+custom_gem "amq-protocol", :git => "git://github.com/ruby-amqp/amq-protocol.git", :branch => "master"
+
+group(:development) do
+  gem "yard"
+  # yard tags this buddy along
+  gem "RedCloth"
+
+  custom_gem "nake",         :platform => :ruby_19
+  custom_gem "contributors", :platform => :ruby_19
+end
 
 group(:test) do
   gem "rspec", ">=2.0.0"
-  gem "rake"
-  # gem "amqp-spec", :git => "git://github.com/ruby-amqp/amqp-spec.git", :branch => "master"
   custom_gem "evented-spec", :git => "git://github.com/ruby-amqp/evented-spec.git", :branch => "master"
 end

data/README.textile

@@ -0,0 +1,216 @@
+h1. About amqp gem "!http://travis-ci.org/ruby-amqp/amqp.png!":http://travis-ci.org/ruby-amqp/amqp
+
+amqp gem is a widely used, feature-rich asynchronous Ruby AMQP client built on top of "EventMachine":http://rubyeventmachine.com.
+This library works with Ruby 1.8.7, Ruby 1.9.2, JRuby, REE and Rubinius, and is
+licensed under the "Ruby License":http://www.ruby-lang.org/en/LICENSE.txt.
+Versions 0.8.0 and later of amqp gem implement "AMQP 0.9.1":http://bit.ly/hw2ELX.
+
+
+h2. What is AMQP?
+
+AMQP is an "open standard for messaging middleware":http://www.amqp.org/confluence/display/AMQP/About+AMQP that
+emphasizes interoperability between different technologies (for example, Java, .NET,
+Ruby, Python, C and so on).
+
+Key features of AMQP are very flexible yet simple routing and binary protocol
+efficiency.
+
+
+h2. What is amqp gem good for?
+
+One can use amqp gem to make Ruby applications interoperate with other
+applications (both Ruby and not). Complexity and size may vary from
+simple work queues to complex multi-stage data processing workflows that involve
+dozens or hundreds of applications built with all kinds of technologies.
+
+Specific examples:
+
+ * A Web application may route messages to a Java app that works
+   with SMS delivery gateways.
+
+ * Periodically run (Cron-driven) application may notify other systems that
+   there are some new results.
+
+ * Content aggregators may update full-text search and geospatial search indexes
+	 by delegating actual indexing work to other applications over AMQP.
+
+ * Companies may provide "Firehose-like" push APIs to their customers, partners
+   or just general public.
+
+ * A new shiny Ruby-based system may be integrated with an existing C++-based component
+   using AMQP.
+
+ * An application that watches updates from a real-time stream (be it markets data
+   or Twitter stream) can propagate updates to interested parties, including
+	 Web applications that display that information in the real time.
+
+
+
+h2. Getting started with amqp gem
+
+h3. Install RabbitMQ
+
+Please refer to "RabbitMQ installation guide":http://www.rabbitmq.com/install.html
+Note that for Ubuntu and Debian we strongly advice that you use "RabbitMQ apt repository":http://www.rabbitmq.com/debian.html#apt
+that has recent versions of RabbitMQ. Ubuntu (even 10.10) and Debian both "ship with old RabbitMQ version":http://packages.ubuntu.com/maverick/rabbitmq-server,
+that only supports AMQP protocol 0.8. amqp gem 0.8.0 and later *will not work with RabbitMQ versions
+before 2.0*.
+
+
+h3. Install the gem
+
+<pre>gem install amqp</pre>
+
+
+h3. "Hello, World" example
+
+<pre>
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+require "rubygems"
+require 'amqp'
+
+EventMachine.run do
+  AMQP.connect(:host => 'localhost') do |connection|
+    puts "Connected to AMQP broker"
+
+    channel  = AMQP::Channel.new(connection)
+    queue    = channel.queue("amqpgem.examples.hello_world")
+    exchange = channel.default_exchange
+
+    queue.subscribe do |payload|
+      puts "Received a message: #{payload}. Disconnecting..."
+
+      connection.close {
+        EM.stop { exit }
+      }
+    end
+
+    exchange.publish "Hello, world!", :routing_key => queue.name
+  end  
+end
+</pre>
+
+(see "as a Gist":https://gist.github.com/910211)
+
+
+h2. How to use AMQP gem with Ruby on Rails, Merb, Sinatra and other web frameworks
+
+To use AMQP gem from web applications, you would need to have EventMachine reactor running.
+If you use "Thin":http://code.macournoyer.com/thin/ or "Goliath":https://github.com/postrank-labs/goliath/,
+you are all set: those two servers use EventMachine under the hood.
+
+With other web servers, you need to start EventMachine reactor in a separate thread like this:
+
+<pre>Thread.new { EM.run }</pre>
+
+Otherwise EventMachine will block current thread.
+
+
+Then connect to AMQP broker:
+
+<pre>amqp_connection = AMQP.connect(:host => "localhost", :user => "guest", :pass => "guest", :vhost => "/")</pre>
+
+In a Ruby on Rails app, probably the best place for this code is initializer
+(like config/initializers/amqp.rb). For Merb apps, it is config/init.rb. For
+Sinatra and pure Rack applications, place it next to other configuration
+code.
+
+If you want to integrate AMQP with "Thin":http://code.macournoyer.com/thin/, "Goliath":https://github.com/postrank-labs/goliath/ or
+some other EventMachine-based software which already runs an event loop, you might want to use following code:
+
+<pre>EM.next_tick { AMQP.connect(...) }</pre>
+
+So in case EventMachine reactor isn't running yet on server/application boot,
+connection won't fail but instead wait for reactor to start.
+
+Same separate thread technique can be used to make EventMachine play nicely with other
+libraries that would block current thread (like "File::Tail":http://rubygems.org/gems/file-tail).
+
+
+h2. Using amqp gem in your app/library using Bundler
+
+With Bundler, add this line to your Gemfile:
+
+<pre>gem "amqp"</pre>
+
+If you want to use edge version (usually there is no need to):
+
+<pre>
+gem "amqp", :git => "git://github.com/ruby-amqp/amqp.git", :branch => "master"
+</pre>
+
+
+
+h2. Examples
+
+You can find many examples (both real-world cases and simple demonstrations)
+"under examples directory":https://github.com/ruby-amqp/amqp/tree/master/examples in the repository.
+
+
+
+h2. How does amqp gem relate to amq-client gem, amq-protocol and libraries like bunny?
+
+See "this page about AMQP gems family":https://github.com/ruby-amqp/amq-client/blob/master/README.textile
+
+
+h2. How can I learn more?
+
+h3. AMQP resources
+
+ * "RabbitMQ tutorials":http://www.rabbitmq.com/getstarted.html that demonstrate interoperability
+ * "Wikipedia page on AMQP":http://en.wikipedia.org/wiki/Advanced_Message_Queuing_Protocol
+ * "AMQP quick reference":http://www.rabbitmq.com/amqp-0-9-1-quickref.html
+ * John O'Hara on the "history of AMQP":http://www.acmqueue.org/modules.php?name=Content&pa=showpage&pid=485
+
+h3. Messaging and distributed systems resources
+
+ * "Enterprise Integration Patterns":http://www.eaipatterns.com/, a book about messaging and use of messaging in systems integration.
+
+ * "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
+ * Joe Armstrong on "Erlang messaging vs RPC":http://armstrongonsoftware.blogspot.com/2008/05/road-we-didnt-go-down.html
+
+
+h2. Community
+
+ * "Ruby AMQP mailing list":http://groups.google.com/group/ruby-amqp
+ * "RabbitMQ mailing list":https://lists.rabbitmq.com/cgi-bin/mailman/listinfo/rabbitmq-discuss (AMQP community epicenter).
+ * "Jabber room for contributors":xmpp://amqp-dev@conf.netlab.cz
+
+
+h2. License
+
+AMQP gem is licensed under the "Ruby License:"http://www.ruby-lang.org/en/LICENSE.txt.
+
+
+h2. Credits and copyright information
+
+* The Original Code is "tmm1/amqp":http://github.com/tmm1/amqp.
+* The Initial Developer of the Original Code is Aman Gupta.
+* Copyright (c) 2008 - 2010 "Aman Gupta":http://github.com/tmm1.
+* Contributions from "Jakub Stastny":http://github.com/botanicus are Copyright (c) 2011 VMware, Inc.
+* Copyright (c) 2010 — 2011 "ruby-amqp":https://github.com/ruby-amqp group members.
+
+Currently maintained by "ruby-amqp":https://github.com/ruby-amqp group members
+Special thanks to Dmitriy Samovskiy, Ben Hood and Tony Garnock-Jones.
+
+
+
+h2. FAQ
+
+h3. So, does amqp gem only work with RabbitMQ?
+
+This library was tested primarily with "RabbitMQ":http://rabbitmq.com, although it should be compatible with any
+server implementing the "AMQP 0.9.1 spec":http://bit.ly/hw2ELX. For AMQP 0.8.0 brokers,
+use version 0.7.
+
+
+h2. Links
+
+* "API Documentation":http://rdoc.info/github/ruby-amqp/amq-protocol/master/frames
+* "Examples":https://github.com/ruby-amqp/amq-protocol/tree/master/examples/
+* "Issue tracker":http://github.com/ruby-amqp/amq-protocol/issues
+* "Continous integration server":http://travis-ci.org/#!/ruby-amqp/amqp

data/Rakefile

@@ -1,14 +1,8 @@
-require 'fileutils'
 require 'rspec/core/rake_task'
 
 desc "Run spec suite (uses Rspec2)"
 RSpec::Core::RakeTask.new(:spec) { |t|}
 
-namespace :spec do
-  desc "Clean up rbx compiled files and run spec suite"
-  RSpec::Core::RakeTask.new(:ci) { |t| Dir.glob("**/*.rbc").each {|f| FileUtils.rm_f(f) } }
-end
-
 desc "Run specs with RCov"
 RSpec::Core::RakeTask.new(:rcov) do |t|
   t.rcov = true

data/amqp.gemspec

@@ -11,18 +11,28 @@ Gem::Specification.new do |s|
   s.homepage = "http://github.com/ruby-amqp/amqp"
   s.summary = "AMQP client implementation in Ruby/EventMachine."
   s.description = "Asynchronous AMQP 0.9.1 client for Ruby. Built on top of Eventmachine."
+  s.cert_chain = nil
   s.email = ["bWljaGFlbEBub3ZlbWJlcmFpbi5jb20=\n", "c3Rhc3RueUAxMDFpZGVhcy5jeg==\n"].map { |i| Base64.decode64(i) }
 
   # files
-  s.files = `git ls-files`.split("\n")
+  s.files = `git ls-files`.split("\n").reject { |file| file =~ /^vendor\// }
   s.require_paths = ["lib"]
 
   # RDoc
-  s.rdoc_options = '--include=examples --main README.md'
-  s.extra_rdoc_files = ["README.md"] + Dir.glob("doc/*")
+  s.has_rdoc = true
+  s.rdoc_options = '--include=examples --main README.textile'
+  s.extra_rdoc_files = ["README.textile"] + Dir.glob("doc/*")
 
   # Dependencies
-  s.add_dependency "eventmachine"
+  s.add_dependency "eventmachine", "~> 0.12.10"
+  s.add_dependency "amq-client"
+
+  begin
+    require "changelog"
+    s.post_install_message = CHANGELOG.new.version_changes
+  rescue LoadError
+    # warn "You have to have changelog gem installed for post install message"
+  end
 
   # RubyForge
   s.rubyforge_project = "amqp"

data/bin/jenkins.sh

@@ -0,0 +1,27 @@
+#!/bin/bash
+
+echo -e "\n\n==== Setup ===="
+source /etc/profile
+git fetch && git reset origin/master --hard
+
+# FIXME: Jenkins user doesn't have permissions to run it.
+# PATH=/usr/sbin:$PATH ./bin/set_test_suite_realms_up.sh
+echo "~ NOT running ./bin/set_test_suite_realms_up.sh"
+
+echo -e "\n\n==== Ruby 1.9.2 Head ===="
+rvm use 1.9.2-head@ruby-amqp
+gem install bundler --no-ri --no-rdoc
+bundle install --path vendor/bundle/1.9.2 --without development; echo
+bundle update; echo
+bundle exec rspec spec
+return_status=$?
+
+echo -e "\n\n==== Ruby 1.8.7 ===="
+rvm use 1.8.7@ruby-amqp
+gem install bundler --no-ri --no-rdoc
+bundle install --path vendor/bundle/1.8.7 --without development; echo
+bundle update; echo
+bundle exec rspec spec
+return_status=$(expr $return_status + $?)
+
+test $return_status -eq 0

data/bin/set_test_suite_realms_up.sh

@@ -1,7 +1,21 @@
 #!/bin/sh
 
-# guest:guest has full access to /amqp_gem_07x_stable_testbed
+# guest:guest has full access to /
 
-rabbitmqctl add_vhost /amqp_gem_07x_stable_testbed
+rabbitmqctl add_vhost /
 rabbitmqctl add_user guest guest
 rabbitmqctl set_permissions -p / guest ".*" ".*" ".*"
+
+
+# amqp_gem:amqp_gem_password has full access to /amqp_gem_testbed
+
+rabbitmqctl add_vhost /amqp_gem_testbed
+rabbitmqctl add_user amqp_gem amqp_gem_password
+rabbitmqctl set_permissions -p /amqp_gem_testbed amqp_gem ".*" ".*" ".*"
+
+
+# amqp_gem_reader:reader_password has read access to /amqp_gem_testbed
+
+rabbitmqctl add_user amqp_gem_reader reader_password
+rabbitmqctl clear_permissions -p /amqp_gem_testbed guest
+rabbitmqctl set_permissions -p /amqp_gem_testbed amqp_gem_reader "^---$" "^---$" ".*"

data/docs/VendorSpecificExtensions.textile

@@ -0,0 +1,32 @@
+h1. Vendor-specific AMQP extensions support in amqp gem
+
+h2. RabbitMQ extensions
+
+h3. Supported extensions
+
+AMQP gem supports two "RabbitMQ extensions to AMQP 0.9.1":
+
+* "Publisher confirmations":http://www.rabbitmq.com/extensions.html#confirms (confirm.* class)
+* "Negative acknowledgements":http://www.rabbitmq.com/extensions.html#negative-acknowledgements (basic.nack)
+
+h3. Enabling RabbitMQ extensions
+
+If you are using RabbitMQ as AMQP broker and want to use these extensions, simply replace
+
+<pre>require "amqp"</pre>
+
+with
+
+<pre>
+require "amqp"
+require "amqp/extensions/rabbitmq"
+</pre>
+
+h3. Example of using publisher confirmations
+
+<script src="https://gist.github.com/923599.js?file=rabbitmq_publisher_confirmations_with_amqp_gem_0.8.0.rb"></script>
+
+
+h3. Documentation
+
+RabbitMQ extensions documentation is part of "amq-client gem documentation":http://rubydoc.info/github/ruby-amqp/amq-client/master/frames