amqp 0.8.0.rc5 → 0.8.0.rc6

data/README.textile

@@ -103,9 +103,12 @@ end
 
 (see "as a Gist":https://gist.github.com/910211)
 
+"Getting started guide":http://rdoc.info/github/ruby-amqp/amqp/master/file/docs/GettingStarted.textile explains this and two more examples in detail,
+and is written in a form of a tutorial.
 
 
-h2(#Documentation_tutorials_guides_API_reference). Documentation: tutorials, guides & API reference
+
+h2. Documentation: tutorials, guides & API reference
 
 We believe that in order to be the best Ruby AMQP client out there, we need to care about documentation as much as
 code readability, API beauty and autotomated testing across 5 Ruby implementations on 3 operating systems.
@@ -140,50 +143,8 @@ h3. API reference
 
 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>
-
+We cover this subject for multiple Ruby application servers in "Connecting to the broker guide":http://bit.ly/kFCVQU, take a look and let us know
+what wasn't clear.
 
 
 h2. How does amqp gem relate to amq-client gem, amq-protocol and libraries like bunny?

data/amqp.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |s|
 
   # Dependencies
   s.add_dependency "eventmachine"
-  s.add_dependency "amq-client", ">= 0.7.0.alpha17"
+  s.add_dependency "amq-client", ">= 0.7.0.alpha18"
 
   begin
     require "changelog"

data/docs/Clustering.textile

@@ -0,0 +1,25 @@
+h1. Clustering
+
+
+h2. About this guide
+
+This guide covers clustered AMQP broker setups, with RabbitMQ as example.
+
+
+h2. Covered versions
+
+TBD
+
+
+h2. Clustering
+
+TBD
+
+
+h2. Tell us what you think!
+
+Please take a moment and tell us what you think about this guide on "Ruby AMQP mailing list":http://groups.google.com/group/ruby-amqp:
+what was unclear? what wasn't covered? maybe you don't like guide style or grammar and spelling are incorrect? Readers feedback is
+key to making documentation better.
+
+If mailing list communication is not an option for you for some reason, you can "contact guides author directly":mailto:michael@novemberain.com?subject=amqp%20gem%20documentation

data/docs/DocumentationGuidesIndex.textile

@@ -8,9 +8,10 @@ h2. Guide list
  * {file:docs/Exchanges.textile Exchanges}
  * {file:docs/Bindings.textile Bindings}
  * {file:docs/Routing.textile Routing}
- * {file:docs/Durability.textile Exchanges, queues and message durability}
+ * {file:docs/Durability.textile Durability and message persistence}
  * {file:docs/ErrorHandling.textile Error handling}
  * {file:docs/08Migration.textile Upgrading from version 0.6.x/0.7.x to 0.8.x and above}
+ * {file:docs/Clustering.textile Clustering}
  * {file:docs/RabbitMQVersions.textile RabbitMQ versions}
  * {file:docs/ConnectionEncryptionWithTLS.textile Using TLS (SSL)}
  * {file:docs/VendorSpecificExtensions.textile Vendor-specific extensions to AMQP 0.9.1 spec}

data/docs/Durability.textile

@@ -1,9 +1,10 @@
-h1. TBD
+h1. Durability and related matters
 
 
 h2. About this guide
 
-TBD
+This guide covers queue, exchange and message durability, as well as other
+topics related to durability, for example, durability in cluster environment.
 
 
 h2. Covered versions
@@ -11,12 +12,57 @@ h2. Covered versions
 This guide covers amqp gem v0.8.0 and later.
 
 
+h2. Entity durability and message persistence
+
+h3. Durability of exchanges
+
+AMQP separates concept of durability of entities (queues, exchanges) from messages persistence.
+Exchanges can be durable or transient. Durable exchanges survive broker restart, transient exchanges don't (they
+have to be redeclared when broker comes back online). Not all scenarios and use cases mandate exchanges to be
+durable.
+
+
+h3. Durability of queues
+
+Durable queues are persisted to disk and thus survive broker restarts. Queues that are not durable are called transient.
+Not all scenarios and use cases mandate queues to be durable.
+
+Note that *only durable queues can be bound to durable exchanges*. This guarantees that it is possible to restore bindings
+on broker restart.
+
+Durability of a queue does not make _messages_ that are routed to that queue durable. If broker is taken down and then
+brought back up, durable queue will be re-declared during broker startup, however, only _persistent_ messages will be recovered.
+
+
+h3. Persistence of messages
 
-h2. TBD
+The concept of messages persistence is separate: messages may be published as persistent. That makes
+AMQP broker persist them to disk. If the server is restarted, the system ensures that received persistent messages
+are not lost. Simply publishing message to a durable exchange or the fact that queue(s) they are routed to
+is durable doesn't make messages persistent: it all depends on persistence mode of the messages itself.
+Publishing messages as persistent affects performance (just like with data stores, durability comes at a certain cost
+in performance and vise versa). Pass :persistent => true to {Exchange#publish} to publish your message as persistent.
+
+
+h3. Transactions
+
+TBD
+
+
+h3. Publisher confirms
 
 TBD
 
 
+h3. Clustering
+
+To achieve degree of durability critical applications need, it's necessary but not enough to use durable queues,
+exchanges and persistent messages. You need to use a cluster of brokers because otherwise, a single hardware problem
+may bring broker down completely.
+
+See {file:docs/Clustering.textile Clustering guide} for in-depth discussion of this topic.
+
+
 
 h2. Tell us what you think!
 

data/docs/GettingStarted.textile

@@ -55,35 +55,41 @@ This guides assumes you have one of the supported Ruby implementations installed
 h3. With Rubygems
 
 To get amqp gem 0.8.0
+<pre>
 <code>
 gem install amqp --pre
 </code>
+</pre>
 
 h3. With Bundler
 
+<pre>
 <code>
 gem "amqp", :git => "git://github.com/ruby-amqp/amqp.git", :branch => "master"
 </code>
+</pre>
 
 h3. Verifying your installation
 
 Lets verify your installation with this quick irb session:
 
+<pre>
 <code>
 irb -rubygems
 
 :001 > require "amqp"
- => true
- :002 > AMQP::VERSION
- => "0.8.0.rc2"
+=> true
+:002 > AMQP::VERSION
+=> "0.8.0.rc2"
 </code>
-
+</pre>
 
 
 h2. A "Hello, world" example
 
 Lets begin with a classic Hello, world example. First, here's the code:
 
+<pre>
 <code>
 #!/usr/bin/env ruby
 # encoding: utf-8
@@ -110,6 +116,7 @@ EventMachine.run do
   exchange.publish "Hello, world!", :routing_key => queue.name
 end
 </code>
+</pre>
 
 This example demonstrates a very common communication scenario: app A wants to publish a message that will end up in
 a queue that app B listens on. In this example, queue name is "amqpgem.examples.hello". Lets go through this example
@@ -376,7 +383,7 @@ demonstrating how one can use AMQP fanout exchanges to do broadcasting.
 h2. Weathr: many-to-many topic routing example
 
 So far we have seen point-to-point communication and broadcast. These two are possible with many protocols:
-HTTP handles these scenarios just fine. What differentiates AMQP? Next is going to introduce you to topic
+HTTP handles these scenarios just fine. What differentiates AMQP? Next we are going to introduce you to topic
 exchanges and routing with patterns, one of the features that makes AMQP very powerful.
 
 Our third example is weather condition updates. What makes it different from the previous two is that

data/docs/Queues.textile

@@ -521,7 +521,7 @@ Callback can be omitted. However, remember that this operation takes some time.
 
 h2. Queue durability vs Message durability
 
-TBD
+See {file:docs/Durability.textile Durability guide}
 
 
 

data/examples/connection/connect_and_immediately_disconnect.rb

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+require "bundler"
+Bundler.setup
+
+$:.unshift(File.expand_path("../../../lib", __FILE__))
+
+require 'amqp'
+
+EventMachine.run do
+  connection = AMQP.connect(:host => '127.0.0.1')
+  connection.disconnect {
+    EventMachine.stop
+  }
+end

data/examples/guides/queues/09_unsubscribing_a_consumer.rb

@@ -4,7 +4,8 @@
 require "rubygems"
 require "amqp"
 
-AMQP.start("amqp://guest:guest@dev.rabbitmq.com:5672/") do |connection, open_ok|
+#AMQP.start("amqp://guest:guest@dev.rabbitmq.com:5672/") do |connection, open_ok|
+AMQP.start do |connection, open_ok|
   AMQP::Channel.new do |channel, open_ok|
     exchange = channel.fanout("amq.fanout")
 

data/lib/amqp/exchange.rb

@@ -112,19 +112,7 @@ module AMQP
   #
   # h2. Exchange durability and persistence of messages.
   #
-  # AMQP separates concept of durability of entities (queues, exchanges) from messages persistence.
-  # Exchanges can be durable or transient. Durable exchanges survive broker restart, transient exchanges don't (they
-  # have to be redeclared when broker comes back online). Not all scenarios and use cases mandate exchanges to be
-  # durable.
-  #
-  # The concept of messages persistence is separate: messages may be published as persistent. That makes
-  # AMQP broker persist them to disk. If the server is restarted, the system ensures that received persistent messages
-  # are not lost. Simply publishing message to a durable exchange or the fact that queue(s) they are routed to
-  # is durable doesn't make messages persistent: it all depends on persistence mode of the messages itself.
-  # Publishing messages as persistent affects performance (just like with data stores, durability comes at a certain cost
-  # in performance and vise versa). Pass :persistent => true to {Exchange#publish} to publish your message as persistent.
-  #
-  # Note that *only durable queues can be bound to durable exchanges*.  Learn more in our {file:docs/Durability.textile Durability guide}.
+  # Learn more in our {file:docs/Durability.textile Durability guide}.
   #
   #
   #
@@ -429,7 +417,7 @@ module AMQP
     #
     # @return [Exchange] self
     #
-    # @note Please make sure you read {Exchange Exchange class} documentation section on exchanges durability vs. messages
+    # @note Please make sure you read {file:docs/Durability.textile Durability guide} that covers exchanges durability vs. messages
     #       persistence.
     # @api public
     def publish(payload, options = {}, &block)

data/lib/amqp/queue.rb

@@ -96,19 +96,7 @@ module AMQP
   #
   # h2. Queue durability and persistence of messages.
   #
-  # AMQP separates concept of durability of entities (queues, exchanges) from messages persistence.
-  # Queues can be durable or transient. Durable queues survive broker restart, transient queues don't (they
-  # have to be redeclared when broker comes back online). Long-living queues (see Queue life-cycle section above)
-  # are usually durable, short-lived queues don't have to be.
-  #
-  # The concept of messages persistence is separate: messages may be published as persistent. That makes
-  # AMQP broker persist them to disk. If the server is restarted, the system ensures that received persistent messages
-  # are not lost. Simply publishing message to a durable exchange or the fact that queue(s) they are routed to
-  # is durable doesn't make messages persistent: it all depends on persistence mode of the messages itself.
-  # Publishing messages as persistent affects performance (just like with data stores, durability comes at a certain cost
-  # in performance and vise versa). Pass :persistent => true to {Exchange#publish} to publish your message as persistent.
-  #
-  # Note that *only durable queues can be bound to durable exchanges*. Learn more in our {file:docs/Durability.textile Durability guide}.
+  # Learn more in our {file:docs/Durability.textile Durability guide}.
   #
   #
   # h2. Message ordering
@@ -123,7 +111,7 @@ module AMQP
   # Learn more in {file:docs/ErrorHandling.textile Error Handling guide}.
   #
   #
-  # @note Please make sure you read a section on queue durability vs. messages
+  # @note Please make sure you read {file:docs/Durability.textile Durability guide} that covers exchanges durability vs. messages
   #       persistence.
   #
   #

data/lib/amqp/version.rb

@@ -6,5 +6,5 @@ module AMQP
   #
   # @see AMQ::Protocol::VERSION
   # @return [String] AMQP gem version
-  VERSION = '0.8.0.rc5'
+  VERSION = '0.8.0.rc6'
 end

data/spec/integration/regressions/issue66_spec.rb

@@ -0,0 +1,35 @@
+# -*- coding: utf-8 -*-
+require "spec_helper"
+
+describe "Authentication attempt" do
+
+  #
+  # Environment
+  #
+
+  include EventedSpec::AMQPSpec
+  include EventedSpec::SpecHelper
+
+
+  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
+        c = AMQP.connect
+        c.disconnect
+
+        done
+      end # it
+    end # context
+  end # describe
+end # describe "Authentication attempt"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification 
 name: amqp
 version: !ruby/object:Gem::Version 
-  hash: 977940490
+  hash: 977940491
   prerelease: true
   segments: 
   - 0
   - 8
   - 0
-  - rc5
-  version: 0.8.0.rc5
+  - rc6
+  version: 0.8.0.rc6
 platform: ruby
 authors: 
 - Aman Gupta
@@ -17,7 +17,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: 
-date: 2011-05-04 00:00:00 +04:00
+date: 2011-05-06 00:00:00 +04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -42,13 +42,13 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 1369027927
+        hash: 1369027924
         segments: 
         - 0
         - 7
         - 0
-        - alpha17
-        version: 0.7.0.alpha17
+        - alpha18
+        version: 0.7.0.alpha18
   type: :runtime
   version_requirements: *id002
 description: Widely used, feature-rich asynchronous AMQP 0.9.1 client with batteries included
@@ -63,6 +63,7 @@ extra_rdoc_files:
 - README.textile
 - docs/08Migration.textile
 - docs/Bindings.textile
+- docs/Clustering.textile
 - docs/ConnectingToTheBroker.textile
 - docs/ConnectionEncryptionWithTLS.textile
 - docs/DocumentationGuidesIndex.textile
@@ -91,6 +92,7 @@ files:
 - bin/set_test_suite_realms_up.sh
 - docs/08Migration.textile
 - docs/Bindings.textile
+- docs/Clustering.textile
 - docs/ConnectingToTheBroker.textile
 - docs/ConnectionEncryptionWithTLS.textile
 - docs/DocumentationGuidesIndex.textile
@@ -106,6 +108,7 @@ files:
 - examples/channels/prefetch_as_constructor_argument.rb
 - examples/channels/qos_aka_prefetch.rb
 - examples/channels/qos_aka_prefetch_without_callback.rb
+- examples/connection/connect_and_immediately_disconnect.rb
 - examples/error_handling/channel_level_exception.rb
 - examples/error_handling/channel_level_exception_with_multiple_channels_involved.rb
 - examples/error_handling/connection_loss_handler.rb
@@ -204,6 +207,7 @@ files:
 - spec/integration/queue_declaration_spec.rb
 - spec/integration/queue_exclusivity_spec.rb
 - spec/integration/queue_redeclaration_with_incompatible_attributes_spec.rb
+- spec/integration/regressions/issue66_spec.rb
 - spec/integration/reply_queue_communication_spec.rb
 - spec/integration/store_and_forward_spec.rb
 - spec/integration/topic_subscription_spec.rb