amqp-boilerplate 0.0.1

data/.gitignore

@@ -0,0 +1,7 @@
+*.gem
+*.swo
+*.swp
+.bundle
+.rvmrc
+Gemfile.lock
+pkg/*

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in amqp-boilerplate.gemspec
+gemspec

data/README

@@ -0,0 +1,18 @@
+= 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
+
+

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+desc "Run specs"
+RSpec::Core::RakeTask.new(:spec) { |t| }
+
+desc "Run specs"
+task :default => :spec

data/amqp-boilerplate.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+
+$:.push File.expand_path("../lib", __FILE__)
+require 'amqp/boilerplate/version'
+
+Gem::Specification.new do |s|
+  s.name        = "amqp-boilerplate"
+  s.version     = AMQP::Boilerplate::VERSION
+  s.authors     = ["Patrick Baselier", "Ludo van den Boom"]
+  s.email       = ["patrick@kabisa.nl", "ludo@cubicphuse.nl"]
+  s.homepage    = ""
+  s.summary     = %q{Helper modules for quickly setting up AMQP producers/consumers}
+  s.description = %q{Collection of modules that aid in setting up AMQP producers and consumers.}
+
+  s.rubyforge_project = "amqp-boilerplate"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_development_dependency "rake", "~> 0.9"
+  s.add_development_dependency "rspec", "~> 2.6"
+  s.add_runtime_dependency "amqp", "~> 0.8"
+end

data/lib/amqp-boilerplate.rb

@@ -0,0 +1 @@
+require 'amqp/boilerplate'

data/lib/amqp/boilerplate.rb

@@ -0,0 +1,17 @@
+require 'amqp'
+
+require 'amqp/boilerplate/version'
+
+require 'amqp/boilerplate/consumer'
+require 'amqp/boilerplate/logging'
+require 'amqp/boilerplate/producer'
+
+module AMQP
+  module Boilerplate
+    extend Logging
+
+    def self.configure
+      yield self if block_given?
+    end
+  end
+end

data/lib/amqp/boilerplate/consumer.rb

@@ -0,0 +1,34 @@
+module AMQP
+  module Boilerplate
+    class Consumer
+      class << self
+        def amqp_queue(name=AMQ::Protocol::EMPTY_STRING, options={})
+          @queue_name = name
+          @queue_options = options
+        end
+
+        def amqp_subscription(options={})
+          @subscription_options = options
+        end
+
+        def start
+          consumer = new
+
+          channel = AMQP.channel
+          channel.on_error(&consumer.method(:handle_channel_error))
+
+          queue = channel.queue(@queue_name, @queue_options)
+          queue.subscribe(@subscription_options, &consumer.method(:handle_message))
+        end
+      end
+
+      def handle_message(metadata, payload)
+        raise NotImplementedError, "The time has come to implement your own consumer class. Good luck!"
+      end
+
+      def handle_channel_error(channel, channel_close)
+        AMQP::Boilerplate.logger.error("[#{self.class}#handle_channel_error] Code = #{channel_close.reply_code}, message = #{channel_close.reply_text}")
+      end
+    end
+  end
+end

data/lib/amqp/boilerplate/logging.rb

@@ -0,0 +1,13 @@
+require 'logger'
+
+module AMQP
+  module Boilerplate
+    module Logging
+      attr_writer :logger
+
+      def logger
+        @logger ||= ::Logger.new(STDOUT)
+      end
+    end
+  end
+end

data/lib/amqp/boilerplate/producer.rb

@@ -0,0 +1,45 @@
+module AMQP
+  module Boilerplate
+    module Producer
+      def amqp(options={})
+        send :include, InstanceMethods
+        @amqp_boilerplate_options = options
+      end
+
+      def amqp_exchange(type=:direct, name=AMQ::Protocol::EMPTY_STRING, options={})
+        @amqp_boilerplate_exchange = [type, name, options]
+      end
+
+      def amqp_message(method_name)
+        @amqp_boilerplate_message = method_name
+      end
+
+      def amqp_boilerplate_options
+        @amqp_boilerplate_options
+      end
+
+      def amqp_boilerplate_exchange
+        @amqp_boilerplate_exchange || amqp_exchange
+      end
+
+      def amqp_boilerplate_message
+        @amqp_boilerplate_message
+      end
+
+      module InstanceMethods
+        def publish
+          message = send(self.class.amqp_boilerplate_message.to_sym)
+          exchange.publish(message, self.class.amqp_boilerplate_options) do
+            AMQP::Boilerplate.logger.debug "[#{self.class}] Published message:\n#{message}"
+          end
+        end
+
+      private
+
+        def exchange
+          AMQP::Exchange.new(AMQP.channel, *self.class.amqp_boilerplate_exchange)
+        end
+      end
+    end
+  end
+end

data/lib/amqp/boilerplate/version.rb

@@ -0,0 +1,5 @@
+module AMQP
+  module Boilerplate
+    VERSION = "0.0.1"
+  end
+end

data/spec/amqp/boilerplate/consumer_spec.rb

@@ -0,0 +1,101 @@
+require 'spec_helper'
+
+class DummyConsumer < AMQP::Boilerplate::Consumer
+  amqp_queue "queue.name.here", :durable => true
+  amqp_subscription :ack => true
+end
+
+class FooConsumer < AMQP::Boilerplate::Consumer
+  amqp_queue
+end
+
+describe AMQP::Boilerplate::Consumer do
+  before(:each) do
+    @channel = mock(AMQP::Channel)
+    @channel.stub(:on_error).and_return(true)
+  end
+
+  describe "#handle_channel_error" do
+    before(:each) do
+      @channel_close = mock(:reply_code => "OK", :reply_text => "Something")
+    end
+
+    it "should log the code and message" do
+      AMQP::Boilerplate.logger.should_receive(:error).with("[DummyConsumer#handle_channel_error] Code = #{@channel_close.reply_code}, message = #{@channel_close.reply_text}")
+
+      DummyConsumer.new.handle_channel_error(@channel, @channel_close)
+    end
+  end
+
+  describe "#handle_message" do
+    it "should raise an error (must be implemented by subclasses)" do
+      expect {
+        AMQP::Boilerplate::Consumer.new.handle_message(anything, anything)
+      }.to raise_error(NotImplementedError, "The time has come to implement your own consumer class. Good luck!")
+    end
+  end
+
+  describe ".amqp_queue" do
+    before(:each) do
+      AMQP.stub(:channel).and_return(@channel)
+      @queue = mock(AMQP::Queue)
+      @channel.stub(:queue).and_return(@queue)
+      @queue.stub(:subscribe)
+    end
+
+    it "should use a default name for queue" do
+      @channel.should_receive(:queue).with(AMQ::Protocol::EMPTY_STRING, anything).and_return(@queue)
+
+      FooConsumer.start
+    end
+
+    it "should use a empty hash for queue options" do
+      @channel.should_receive(:queue).with(anything, {}).and_return(@queue)
+
+      FooConsumer.start
+    end
+  end
+
+  describe ".start" do
+    before(:each) do
+      @consumer = DummyConsumer.new
+      DummyConsumer.stub(:new).and_return(@consumer)
+
+      AMQP.stub(:channel).and_return(@channel)
+
+      @queue = mock(AMQP::Queue)
+      @channel.stub(:queue).and_return(@queue)
+      @queue.stub(:subscribe)
+    end
+
+    it "should use a channel" do
+      AMQP.should_receive(:channel).and_return(@channel)
+      DummyConsumer.start
+    end
+
+    it "should instantiate a consumer" do
+      DummyConsumer.should_receive(:new).and_return(@consumer)
+      DummyConsumer.start
+    end
+
+    it "should register a channel error handler" do
+      @channel.should_receive(:on_error)
+      DummyConsumer.start
+    end
+
+    it "should instantiate a queue with the proper queue name" do
+      @channel.should_receive(:queue).with("queue.name.here", anything)
+      DummyConsumer.start
+    end
+
+    it "should instantiate a queue provided with options" do
+      @channel.should_receive(:queue).with(anything, :durable => true)
+      DummyConsumer.start
+    end
+
+    it "should subscribe to the queue" do
+      @queue.should_receive(:subscribe).with(:ack => true)
+      DummyConsumer.start
+    end
+  end
+end

data/spec/amqp/boilerplate/logging_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe AMQP::Boilerplate::Logging do
+  after(:each) do
+    # Reset
+    AMQP::Boilerplate.logger = nil
+  end
+
+  describe "#logger" do
+    it "should set the logger to use" do
+      MyLogger = Class.new
+      AMQP::Boilerplate.logger = MyLogger # { |config| config.logger = MyLogger }
+      AMQP::Boilerplate.logger.should == MyLogger
+    end
+
+    it "should default to Ruby Logger" do
+      AMQP::Boilerplate.logger.should be_a(Logger)
+    end
+
+    it "should default to Logger writing to STDOUT" do
+      Logger.should_receive(:new).with(STDOUT)
+      AMQP::Boilerplate.logger
+    end
+  end
+end

data/spec/amqp/boilerplate/producer_spec.rb

@@ -0,0 +1,104 @@
+require 'spec_helper'
+
+class DummyProducer
+  extend AMQP::Boilerplate::Producer
+
+  amqp :routing_key => "some.routing.key"
+  amqp_exchange :fanout, "amq.fanout", { :durable => true }
+  amqp_message :message
+
+  def message
+    "hello world!"
+  end
+end
+
+class FooProducer
+  extend AMQP::Boilerplate::Producer
+
+  amqp :routing_key => "another.routing.key"
+  amqp_message :some_method
+
+  def some_method
+    'Foo Bar'
+  end
+end
+
+describe AMQP::Boilerplate::Producer do
+  before(:each) do
+    AMQP::Boilerplate.stub(:logger).and_return(mock.as_null_object)
+
+    @exchange = mock(AMQP::Exchange)
+    @exchange.stub(:publish).and_yield
+    AMQP::Exchange.stub!(:new).and_return(@exchange)
+
+    @producer = DummyProducer.new
+  end
+
+  describe ".amqp_exchange" do
+    it "should default amqp_exchange attributes" do
+      another_producer = FooProducer.new
+      AMQP::Exchange.should_receive(:new).with(AMQP.channel, :direct, AMQ::Protocol::EMPTY_STRING, {})
+      another_producer.publish
+    end
+  end
+
+  describe "#publish" do
+    it "should use an exchange" do
+      @producer.should_receive(:exchange).and_return(@exchange)
+      @producer.publish
+    end
+
+    it "should publish to exchange" do
+      @exchange.should_receive(:publish)
+      @producer.publish
+    end
+
+    it "should publish to the exchange using the proper routing_key" do
+      @exchange.should_receive(:publish).with(@producer.message, :routing_key => "some.routing.key")
+      @producer.publish
+
+      another_producer = FooProducer.new
+      @exchange.should_receive(:publish).with(another_producer.some_method, :routing_key => "another.routing.key")
+      another_producer.publish
+    end
+
+    it "should pass options to AMQP::Exchange#publish" do
+      DummyProducer.amqp({ :routing_key => "some.routing.key", :mandatory => true })
+      @exchange.should_receive(:publish).with(@producer.message, :routing_key => "some.routing.key", :mandatory => true)
+      @producer.publish
+
+      DummyProducer.amqp({ :routing_key => "some.routing.key", :mandatory => true, :immediate => true })
+      @exchange.should_receive(:publish).with(@producer.message, :routing_key => "some.routing.key", :mandatory => true, :immediate => true)
+      @producer.publish
+    end
+
+    describe "connecting to exchange" do
+      before(:each) do
+        @channel = mock(AMQP::Channel)
+        AMQP.stub(:channel).and_return(@channel)
+      end
+
+      it "should instantiate an exchange" do
+        AMQP::Exchange.should_receive(:new)
+        @producer.publish
+      end
+
+      it "should connect to the exchange" do
+        AMQP::Exchange.should_receive(:new).with(@channel, :fanout, "amq.fanout", { :durable => true })
+        @producer.publish
+      end
+
+      it "should use defaults for exchange configuration" do
+        DummyProducer.amqp_exchange()
+
+        AMQP::Exchange.should_receive(:new).with(@channel, :direct, AMQ::Protocol::EMPTY_STRING, {})
+        @producer.publish
+      end
+    end
+
+    it "should log after delivering message" do
+      AMQP::Boilerplate.logger.should_receive(:debug).with("[#{@producer.class}] Published message:\n#{@producer.message}")
+      @producer.publish
+    end
+  end
+end

data/spec/amqp/boilerplate_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe AMQP::Boilerplate do
+  describe ".configure" do
+    after(:each) do
+      AMQP::Boilerplate.logger = nil
+    end
+
+    it "should let us choose what logger to use" do
+      MyFunkyLogger = Class.new
+      AMQP::Boilerplate.configure { |config| config.logger = MyFunkyLogger }
+      AMQP::Boilerplate.logger.should == MyFunkyLogger
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'rspec'
+
+require 'amqp/boilerplate'
+
+RSpec.configure do |c|
+  c.mock_with :rspec
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification 
+name: amqp-boilerplate
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Patrick Baselier
+- Ludo van den Boom
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-09-12 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  type: :development
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 0
+        - 9
+        version: "0.9"
+  prerelease: false
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 2
+        - 6
+        version: "2.6"
+  prerelease: false
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  name: amqp
+  type: :runtime
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 0
+        - 8
+        version: "0.8"
+  prerelease: false
+  requirement: *id003
+description: Collection of modules that aid in setting up AMQP producers and consumers.
+email: 
+- patrick@kabisa.nl
+- ludo@cubicphuse.nl
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- Gemfile
+- README
+- Rakefile
+- amqp-boilerplate.gemspec
+- lib/amqp-boilerplate.rb
+- lib/amqp/boilerplate.rb
+- lib/amqp/boilerplate/consumer.rb
+- lib/amqp/boilerplate/logging.rb
+- lib/amqp/boilerplate/producer.rb
+- lib/amqp/boilerplate/version.rb
+- spec/amqp/boilerplate/consumer_spec.rb
+- spec/amqp/boilerplate/logging_spec.rb
+- spec/amqp/boilerplate/producer_spec.rb
+- spec/amqp/boilerplate_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: amqp-boilerplate
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: Helper modules for quickly setting up AMQP producers/consumers
+test_files: 
+- spec/amqp/boilerplate/consumer_spec.rb
+- spec/amqp/boilerplate/logging_spec.rb
+- spec/amqp/boilerplate/producer_spec.rb
+- spec/amqp/boilerplate_spec.rb
+- spec/spec_helper.rb