amqp-boilerplate 0.0.2 → 0.0.3

data/CHANGELOG

@@ -0,0 +1,14 @@
+= version 0.0.3
+
+  * [FEATURE] Added amqp_exchange macro to Consumer for selecting the exchange
+  to bind to.
+
+= version 0.0.2
+
+  * [FEATURE] AMQP::boilerplate.boot for booting up within an EventLoop (i.e.
+  when using Passenger)
+
+= version 0.0.1
+
+  * [FEATURE] Added class for setting up an AMQP Consumer
+  * [FEATURE] Added module for creating an AMQP Producer

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Ludo van den Boom, http://cubicphuse.nl
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,53 @@
+= amqp-boilerplate
+
+amqp-boilerplate is a set of helper classes and modules to be used with the
+Ruby amqp gem.
+
+== Install
+
+ gem install amqp-boilerplate
+
+== Configuration
+
+See {AMQP::Boilerplate.configure} for configuration options.
+
+== Usage
+
+amqp-boilerplate provides the AMQP::Boilerplate::Producer module for creating
+message producers, and the AMQP::Boilerplate::Consumer class for setting up a
+message consumer.
+
+=== Producers
+
+The following sample code shows a basic producer.
+
+  class MyProducer
+    extend AMQP::Boilerplate::Producer
+
+    amqp :routing_key => "hello.world"
+    amqp_message :message
+
+    def message
+      "Look! I am a string that will be posted to the exchange."
+    end
+  end
+
+For more information please refer to {AMQP::Boilerplate::Producer}
+
+=== Consumers
+
+The following sample code shows a basic consumer.
+
+  class MyConsumer < AMQP::Boilerplate::Consumer
+    amqp_queue "hello.world"
+
+    def handle_message(payload, metadata)
+      puts "Received message: #{payload}"
+    end
+  end
+
+For more information please refer to {AMQP::Boilerplate::Consumer}
+
+== License
+
+amqp-boilerplate is released under the MIT license.

data/lib/amqp/boilerplate/consumer.rb

@@ -1,7 +1,23 @@
 module AMQP
   module Boilerplate
+    # @example Basic consumer
+    #   class MyConsumer < AMQP::Boilerplate::Consumer
+    #     amqp_queue "hello.world"
+    #
+    #     def handle_message(payload, metadata)
+    #       puts "Received message: #{payload}"
+    #     end
+    #   end
     class Consumer
       class << self
+        # Macro for selecting exchange to bind to
+        #
+        # @param [String] name Exchange name
+        # @return [void]
+        def amqp_exchange(name)
+          @exchange_name = name
+        end
+
         def amqp_queue(name=AMQ::Protocol::EMPTY_STRING, options={})
           @queue_name = name
           @queue_options = options
@@ -19,6 +35,7 @@ module AMQP
           channel.on_error(&consumer.method(:handle_channel_error))
 
           queue = channel.queue(@queue_name, @queue_options)
+          queue.bind(@exchange_name) if @exchange_name
           queue.subscribe(@subscription_options, &consumer.method(:handle_message))
 
           AMQP::Boilerplate.logger.info("[#{self.name}.start] Started consumer '#{self.name}'")

data/lib/amqp/boilerplate/version.rb

@@ -1,5 +1,5 @@
 module AMQP
   module Boilerplate
-    VERSION = "0.0.2"
+    VERSION = "0.0.3"
   end
 end

data/spec/amqp/boilerplate/consumer_spec.rb

@@ -90,5 +90,32 @@ describe AMQP::Boilerplate::Consumer do
       @queue.should_receive(:subscribe).with(:ack => true)
       BarConsumer.start
     end
+
+    describe "when an exchange name has been provided" do
+      before(:each) do
+        @exchange_name = "amq.fanout"
+        BarConsumer.amqp_exchange(@exchange_name)
+      end
+
+      after(:each) do
+        BarConsumer.amqp_exchange(nil)
+      end
+
+      it "should bind to the exchange" do
+        @queue.should_receive(:bind).with(@exchange_name)
+        BarConsumer.start
+      end
+    end
+
+    describe "when no exchange name provided" do
+      before(:each) do
+        BarConsumer.amqp_exchange(nil)
+      end
+
+      it "should not explicitly bind to an exchange" do
+        @queue.should_not_receive(:bind)
+        BarConsumer.start
+      end
+    end
   end
 end

data/spec/amqp/boilerplate_spec.rb

@@ -6,9 +6,15 @@ describe AMQP::Boilerplate do
       AMQP::Boilerplate.stub(:logger).and_return(mock.as_null_object)
 
       EventMachine.stub(:next_tick).and_yield
+      AMQP::Utilities::EventLoopHelper.stub(:run).and_yield
+
+      AMQP.stub(:connection).and_return(mock(AMQP::Session))
+      AMQP::Channel.stub(:new).and_return(mock(AMQP::Channel))
 
-      AMQP::Boilerplate.stub(:start_consumers)
       AMQP::Boilerplate.stub(:load_consumers)
+      AMQP::Boilerplate.stub(:start_consumers)
+      AMQP::Boilerplate.stub(:start)
+      AMQP::Boilerplate.stub(:sleep)
     end
 
     it "should load all consumers" do
@@ -26,6 +32,18 @@ describe AMQP::Boilerplate do
       AMQP::Boilerplate.boot
     end
 
+    it "should sleep for a while" do
+      AMQP::Boilerplate.should_receive(:sleep).with(0.25)
+      AMQP::Boilerplate.boot
+    end
+
+    describe "wen not using passenger" do
+      it "should use built-in EventLoopHelper" do
+        AMQP::Utilities::EventLoopHelper.should_receive(:run)
+        AMQP::Boilerplate.boot
+      end
+    end
+
     describe "when using passenger" do
       before(:each) do
         PhusionPassenger = Class.new
@@ -82,6 +100,10 @@ describe AMQP::Boilerplate do
   end
 
   describe ".start" do
+    before(:each) do
+      AMQP.stub(:start)
+    end
+
     it "should start AMQP" do
       AMQP.should_receive(:start)
       AMQP::Boilerplate.start

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: amqp-boilerplate
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Patrick Baselier
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-09-13 00:00:00 +02:00
+date: 2011-09-15 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -92,8 +92,10 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - .rspec
+- CHANGELOG
 - Gemfile
-- README
+- LICENSE
+- README.rdoc
 - Rakefile
 - amqp-boilerplate.gemspec
 - lib/amqp-boilerplate.rb

data/README

@@ -1,18 +0,0 @@
-= AMQP Boilterplate
-
-== Getting started
-
-=== Install RabbitMQ
-
-=== Install the gem
-
-==== Rails 3.x
-  gem "amqp-boilerplate", "~> 0.1.0"
-
-=== Create a producer
-
-=== Create a consumer
-
-== License
-
-