warren 0.9.1 → 0.9.2

data/CHANGELOG

@@ -1,3 +1,4 @@
+v0.9.2. Updated to work with bunny 0.6.0
 v0.9.1. Instated the dependency upon bunny
 v0.9.0. Adding a logger
 v0.8.9. Fixing a StackTooDeep bug.

data/Manifest

@@ -23,9 +23,11 @@ lib/warren/queue.rb
 readme.rdoc
 spec/spec.opts
 spec/spec_helper.rb
+spec/warren/adapters/bunny_adapter_spec.rb
 spec/warren/adapters/test_adapter_spec.rb
 spec/warren/connection_spec.rb
 spec/warren/queue_spec.rb
 spec/warren/warren_spec.rb
 tasks/rdoc.rake
 tasks/rspec.rake
+warren.gemspec

data/Rakefile

@@ -13,7 +13,7 @@ Echoe.new('warren') do | gem |
   gem.email = 'support@brightbox.co.uk'
   gem.summary = 'Library for pushing messages onto and off RabbitMQ queues'
   gem.url = 'http://github.com/brightbox/warren'
-  gem.dependencies = [["amqp", '>= 0.6.0'], ["bunny", ">= 0.4.3"]]
+  gem.dependencies = [["amqp", '>= 0.6.0'], ["bunny", ">= 0.6.0"]]
 end
 
 desc "Generates the manifest and the gemspec"

data/lib/warren/adapters/bunny_adapter.rb

@@ -1,4 +1,5 @@
 require "rubygems"
+gem "bunny", ">= 0.6.0"
 require "bunny"
 
 module Warren
@@ -10,8 +11,10 @@ module Warren
       # 
       def self.check_connection_details opts
         # Check they've passed in the stuff without a default on it
-        unless opts.has_key?(:user) && opts.has_key?(:pass) && opts.has_key?(:vhost)
-          raise Warren::Connection::InvalidConnectionDetails, "Missing a username, password or vhost."
+        [:user, :pass, :vhost].each do | required_arg |
+          unless opts.has_key?(required_arg)
+            raise Warren::Connection::InvalidConnectionDetails, "#{required_arg.to_s.capitalize} not specified"
+          end
         end
         true
       end
@@ -58,19 +61,36 @@ module Warren
       #
       # Expects a block and raises NoBlockGiven if no block is given.
       #
+      # The block is passed up to two arguments, depending on how many
+      # you ask for. The first one is always required, which is the message
+      # passed over the queue (after being unpacked by filters.)
+      # The (optional) second argument is a hash of headers bunny gives us
+      # containing extra data about the message.
+      # 
+      #   Warren::Queue.subscribe(:default) {|msg, payload| puts msg, payload }
+      # 
       def self.subscribe queue_name, &block
         raise NoBlockGiven unless block_given?
         queue_name = self.queue_name if queue_name == :default
         # todo: check if its a valid queue?
         do_connect(queue_name) do |queue|
-          msg = queue.pop
-          return if msg == :queue_empty
-          block.call(Warren::MessageFilter.unpack(msg))
+          handle_bunny_message(queue.pop, &block)
         end
       end
 
       private
 
+      # Called when a message is pulled off the queue by bunny.
+      #
+      def self.handle_bunny_message headers, &block
+        payload = headers.delete(:payload)
+        return if payload == :queue_empty
+        # unpack it
+        payload = Warren::MessageFilter.unpack(payload)
+        # Call our block with as many args as we need to
+        block.arity == 1 ? block.call(payload) : block.call(payload, headers)
+      end
+
       #
       # Connects and does the stuff its told to!
       #

data/lib/warren/adapters/test_adapter.rb

@@ -4,7 +4,7 @@ class TestAdapter < Warren::Queue
   ConnectionFailed = Class.new(Exception)
   # 
   def self.publish queue_name, payload, &blk
-    raise TestAdapter::ConnectionFailed if fail?
+    raise self::ConnectionFailed if fail?
     true
   end
 

data/lib/warren/filters/shared_secret.rb

@@ -18,7 +18,7 @@ module Warren
     # Make sure both the publisher and subscriber use the same
     # key else you'll get KeyValidationError error raised.
     #
-    class SharedSecret
+    class SharedSecret < MessageFilter
       # Raised when no key (salt) is provided
       class NoKeyError < Exception; end
       # Raised when there is a key mismatch error

data/spec/warren/adapters/bunny_adapter_spec.rb

@@ -0,0 +1,93 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+require "#{File.dirname(__FILE__)}/../../../lib/warren/adapters/bunny_adapter.rb"
+
+describe Warren::Queue::BunnyAdapter do
+
+  before do
+    # play nicely with other adapters loaded
+    Warren::Queue.adapter = Warren::Queue::BunnyAdapter
+  end
+
+  describe "connection details" do
+
+    before do
+      setup_config_object
+    end
+
+    it "should override check_connection_details" do
+      Warren::Queue::BunnyAdapter.methods(false).should include("check_connection_details")
+    end
+    
+    it "should require a username" do
+      @options.delete(:user)
+      lambda {
+        Warren::Connection.new(@config)
+      }.should raise_error(Warren::Connection::InvalidConnectionDetails, "User not specified")
+    end
+
+    it "should require a password" do
+      @options.delete(:pass)
+      lambda {
+        Warren::Connection.new(@config)
+      }.should raise_error(Warren::Connection::InvalidConnectionDetails, "Pass not specified")
+    end
+
+    it "should require a vhost" do
+      @options.delete(:vhost)
+      lambda {
+        Warren::Connection.new(@config)
+      }.should raise_error(Warren::Connection::InvalidConnectionDetails, "Vhost not specified")
+    end
+  end
+
+  describe "subscribe" do
+    it "should override subscribe" do
+      Warren::Queue::BunnyAdapter.methods(false).should include("subscribe")
+    end
+
+    it "should accept a subscribe block with one argument" do
+      blk = lambda do |one|
+        one.should == "my message"
+      end
+
+      send_headers_to_bunny_with &blk
+    end
+
+    it "should accept a subscribe block with two arguments" do
+      blk = lambda do | message, headers |
+        message.should == "my message"
+        headers.should == {:some => :header}
+      end
+
+      headers = {
+        :payload => "my message",
+        :some => :header
+      }
+      Warren::Queue::BunnyAdapter.__send__(:handle_bunny_message, headers, &blk)
+    end
+
+    def send_headers_to_bunny_with &blk
+      headers = {
+        :payload => "my message",
+        :some => :header
+      }
+      Warren::Queue::BunnyAdapter.__send__(:handle_bunny_message, headers, &blk)
+    end
+  end
+
+  protected
+
+  def setup_config_object
+    @options = {
+      :host => "localhost",
+      :user => "rspec",
+      :pass => "password",
+      :vhost => "/",
+      :logging => false
+    }
+    @config = {
+      :development => @options
+    }
+  end
+
+end

data/spec/warren/adapters/test_adapter_spec.rb

@@ -3,6 +3,11 @@ require "#{File.dirname(__FILE__)}/../../../lib/warren/adapters/test_adapter.rb"
 
 describe TestAdapter do
 
+  before do
+    # play nicely with other adapters loaded
+    Warren::Queue.adapter = TestAdapter
+  end
+
   before(:all) do
     @file_name = "#{WARREN_ROOT}/tmp/warren.txt"
   end

data/warren.gemspec

@@ -2,15 +2,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{warren}
-  s.version = "0.9.1"
+  s.version = "0.9.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Caius Durling, David Smalley"]
-  s.date = %q{2009-11-09}
+  s.date = %q{2009-12-21}
   s.description = %q{Library for pushing messages onto and off RabbitMQ queues}
   s.email = %q{support@brightbox.co.uk}
   s.extra_rdoc_files = ["CHANGELOG", "LICENSE", "lib/warren.rb", "lib/warren/adapters/amqp_adapter.rb", "lib/warren/adapters/bunny_adapter.rb", "lib/warren/adapters/dummy_adapter.rb", "lib/warren/adapters/test_adapter.rb", "lib/warren/connection.rb", "lib/warren/filters/shared_secret.rb", "lib/warren/filters/yaml.rb", "lib/warren/message_filter.rb", "lib/warren/queue.rb", "tasks/rdoc.rake", "tasks/rspec.rake"]
-  s.files = ["CHANGELOG", "LICENSE", "Manifest", "Rakefile", "examples/authed/receiver.rb", "examples/authed/secret.rb", "examples/authed/sender.rb", "examples/simple/amqp_mass_sender.rb", "examples/simple/amqp_receiver.rb", "examples/simple/amqp_sender.rb", "examples/simple/bunny_receiver.rb", "examples/simple/bunny_sender.rb", "lib/warren.rb", "lib/warren/adapters/amqp_adapter.rb", "lib/warren/adapters/bunny_adapter.rb", "lib/warren/adapters/dummy_adapter.rb", "lib/warren/adapters/test_adapter.rb", "lib/warren/connection.rb", "lib/warren/filters/shared_secret.rb", "lib/warren/filters/yaml.rb", "lib/warren/message_filter.rb", "lib/warren/queue.rb", "readme.rdoc", "spec/spec.opts", "spec/spec_helper.rb", "spec/warren/adapters/test_adapter_spec.rb", "spec/warren/connection_spec.rb", "spec/warren/queue_spec.rb", "spec/warren/warren_spec.rb", "tasks/rdoc.rake", "tasks/rspec.rake", "warren.gemspec"]
+  s.files = ["CHANGELOG", "LICENSE", "Manifest", "Rakefile", "examples/authed/receiver.rb", "examples/authed/secret.rb", "examples/authed/sender.rb", "examples/simple/amqp_mass_sender.rb", "examples/simple/amqp_receiver.rb", "examples/simple/amqp_sender.rb", "examples/simple/bunny_receiver.rb", "examples/simple/bunny_sender.rb", "lib/warren.rb", "lib/warren/adapters/amqp_adapter.rb", "lib/warren/adapters/bunny_adapter.rb", "lib/warren/adapters/dummy_adapter.rb", "lib/warren/adapters/test_adapter.rb", "lib/warren/connection.rb", "lib/warren/filters/shared_secret.rb", "lib/warren/filters/yaml.rb", "lib/warren/message_filter.rb", "lib/warren/queue.rb", "readme.rdoc", "spec/spec.opts", "spec/spec_helper.rb", "spec/warren/adapters/bunny_adapter_spec.rb", "spec/warren/adapters/test_adapter_spec.rb", "spec/warren/connection_spec.rb", "spec/warren/queue_spec.rb", "spec/warren/warren_spec.rb", "tasks/rdoc.rake", "tasks/rspec.rake", "warren.gemspec"]
   s.homepage = %q{http://github.com/brightbox/warren}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Warren", "--main", "readme.rdoc"]
   s.require_paths = ["lib"]
@@ -24,13 +24,13 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<amqp>, [">= 0.6.0"])
-      s.add_runtime_dependency(%q<bunny>, [">= 0.4.3"])
+      s.add_runtime_dependency(%q<bunny>, [">= 0.6.0"])
     else
       s.add_dependency(%q<amqp>, [">= 0.6.0"])
-      s.add_dependency(%q<bunny>, [">= 0.4.3"])
+      s.add_dependency(%q<bunny>, [">= 0.6.0"])
     end
   else
     s.add_dependency(%q<amqp>, [">= 0.6.0"])
-    s.add_dependency(%q<bunny>, [">= 0.4.3"])
+    s.add_dependency(%q<bunny>, [">= 0.6.0"])
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: warren
 version: !ruby/object:Gem::Version 
-  version: 0.9.1
+  version: 0.9.2
 platform: ruby
 authors: 
 - Caius Durling, David Smalley
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-09 00:00:00 +00:00
+date: 2009-12-21 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -30,7 +30,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.4.3
+        version: 0.6.0
     version: 
 description: Library for pushing messages onto and off RabbitMQ queues
 email: support@brightbox.co.uk
@@ -79,6 +79,7 @@ files:
 - readme.rdoc
 - spec/spec.opts
 - spec/spec_helper.rb
+- spec/warren/adapters/bunny_adapter_spec.rb
 - spec/warren/adapters/test_adapter_spec.rb
 - spec/warren/connection_spec.rb
 - spec/warren/queue_spec.rb