brightbox-warren 0.5

data/CHANGELOG

@@ -0,0 +1,2 @@
+v0.5. Added filters
+v0.3. Initial release

data/LICENCE

@@ -0,0 +1,11 @@
+Released under the MIT Licence
+
+Copyright (c) 2008 Brightbox Systems Ltd 
+
+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.
+
+See http://www.brightbox.co.uk/ for contact details.  

data/Manifest

@@ -0,0 +1,25 @@
+CHANGELOG
+examples/authed/receiver.rb
+examples/authed/secret.rb
+examples/authed/sender.rb
+examples/simple/mass_sender.rb
+examples/simple/receiver.rb
+examples/simple/sender.rb
+lib/warren/connection.rb
+lib/warren/message_filter.rb
+lib/warren/message_filters/shared_secret.rb
+lib/warren/message_filters/yaml.rb
+lib/warren/queue.rb
+lib/warren.rb
+LICENCE
+Manifest
+Rakefile
+readme.rdoc
+spec/hash_extend.rb
+spec/spec.opts
+spec/spec_helper.rb
+spec/warren/connection_spec.rb
+spec/warren/message_filter_spec.rb
+spec/warren/queue_spec.rb
+tasks/rdoc.rake
+tasks/rspec.rake

data/Rakefile

@@ -0,0 +1,23 @@
+require 'rubygems'
+require 'rake'
+
+# Load in external rakefiles
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each do | rake_file | 
+  load rake_file
+end
+
+# Gem stuff
+require 'echoe'
+Echoe.new('warren') do | gem | 
+  gem.author = ["Caius Durling", "David Smalley"]
+  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']]
+end
+
+desc "Generates the manifest and the gemspec"
+task :build => [:manifest, :build_gemspec] do
+  puts "Built!"
+end
+

data/examples/authed/receiver.rb

@@ -0,0 +1,23 @@
+require "rubygems"
+require File.expand_path(File.dirname(__FILE__) + "/../../lib/warren")
+
+Signal.trap("INT") { AMQP.stop { EM.stop } }
+Signal.trap("TERM") { AMQP.stop { EM.stop } }
+
+# Listen to the main queue
+q = "main"
+puts "Listening to the #{q} queue."
+
+# Setup the connection directly this time
+Warren::Queue.connection = {:user => "caius", :pass => "caius", :vhost => "/"}
+
+# Set the secret key
+require File.expand_path(File.dirname(__FILE__) + "/secret")
+Warren::MessageFilter::SharedSecret.key = SUPER_SECRET_KEY
+# And add the filter
+Warren::MessageFilter << Warren::MessageFilter::SharedSecret
+
+# And attach a block for new messages to fire
+Warren::Queue.subscribe(q) do |msg|
+  p [Time.now, msg]
+end

data/examples/authed/secret.rb

@@ -0,0 +1 @@
+SUPER_SECRET_KEY = "This is my super secret string"

data/examples/authed/sender.rb

@@ -0,0 +1,38 @@
+require "rubygems"
+require File.expand_path(File.dirname(__FILE__) + "/../../lib/warren")
+
+Signal.trap("INT") { exit! }
+Signal.trap("TERM") { exit! }
+
+# Setup our own connection before generating the queue object
+conn = Warren::Connection.new(
+  :user => "caius",
+  :pass => "caius",
+  :vhost => "/",
+  :default_queue => "main"
+)
+# Set the connection for the queue
+Warren::Queue.connection = conn
+# Generate some data to send
+data = {
+  :people => [
+    :fred => {
+      :age => 25,
+      :location => "Leeds"
+    },
+    :george => {
+      :age => 32,
+      :location => "London"
+    }
+  ]
+}
+
+# Set the secret key
+require File.expand_path(File.dirname(__FILE__) + "/secret")
+Warren::MessageFilter::SharedSecret.key = SUPER_SECRET_KEY
+
+# And add the filter
+Warren::MessageFilter << Warren::MessageFilter::SharedSecret
+
+# Push a message onto the queue
+p Warren::Queue.publish(:default, data )

data/examples/simple/mass_sender.rb

@@ -0,0 +1,21 @@
+require "rubygems"
+require File.expand_path(File.dirname(__FILE__) + "/../lib/warren")
+
+Signal.trap("INT") { exit! }
+Signal.trap("TERM") { exit! }
+
+# Setup our own connection before generating the queue object
+conn = Warren::Connection.new({
+  :user => "caius",
+  :pass => "caius",
+  :vhost => "/",
+  :default_queue => "main"
+})
+# Set the connection for the queue
+Warren::Queue.connection = conn
+
+1000.times do | i |
+  puts i
+  sleep 0.1
+  Warren::Queue.publish(:default, "Message no #{i}") { puts "sent ##{i}" }
+end

data/examples/simple/receiver.rb

@@ -0,0 +1,17 @@
+require "rubygems"
+require File.expand_path(File.dirname(__FILE__) + "/../lib/warren")
+
+Signal.trap("INT") { AMQP.stop { EM.stop } }
+Signal.trap("TERM") { AMQP.stop { EM.stop } }
+
+# Listen to the main queue
+q = "main"
+puts "Listening to the #{q} queue."
+
+# Setup the connection directly this time
+Warren::Queue.connection = {:user => "caius", :pass => "caius", :vhost => "/"}
+
+# And attach a block for new messages to fire
+Warren::Queue.subscribe(q) do |msg|
+  p [Time.now, msg]
+end

data/examples/simple/sender.rb

@@ -0,0 +1,33 @@
+require "rubygems"
+require File.expand_path(File.dirname(__FILE__) + "/../lib/warren")
+
+Signal.trap("INT") { exit! }
+Signal.trap("TERM") { exit! }
+
+# Setup our own connection before generating the queue object
+conn = Warren::Connection.new(
+  :user => "caius",
+  :pass => "caius",
+  :vhost => "/",
+  :default_queue => "main"
+)
+# Set the connection for the queue
+Warren::Queue.connection = conn
+# Generate some data to send
+data = {
+  :people => [
+    :fred => {
+      :age => 25,
+      :location => "Leeds"
+    },
+    :george => {
+      :age => 32,
+      :location => "London"
+    }
+  ]
+}
+# Push a message onto the queue
+p Warren::Queue.publish(:default, data )
+
+# And then push a message onto the queue, returning "foo"
+p Warren::Queue.publish(:default, data) { "foo" }

data/lib/warren/connection.rb

@@ -0,0 +1,37 @@
+class Warren::Connection
+  
+  # Creates a new connection with the options passed in.
+  # Requires at least a :user, :pass and :vhost else will raise
+  # InvalidConnectionDetails.
+  def initialize 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 InvalidConnectionDetails, "Missing a username, password or vhost."
+    end
+    @opts = opts
+  end
+  
+  # Returns the default queue name or returns InvalidConnectionDetails
+  # if no default queue is defined
+  def queue_name
+    raise InvalidConnectionDetails, "Missing a default queue name." unless @opts.has_key?(:default_queue)
+    @opts[:default_queue]
+  end
+  
+  # Returns a hash of the connection options
+  def options
+    {
+      :user  => @opts[:user],
+      :pass  => @opts[:pass],
+      :vhost => @opts[:vhost],
+      :host  => (@opts[:host] || "localhost"),
+      :port  => (@opts[:port] || ::AMQP::PORT.to_i),
+      :logging => (@opts[:logging] || false)
+    }
+  end
+  
+  # Raised if connection details are missing or invalid
+  # Check the error message for more details
+  class InvalidConnectionDetails < Exception
+  end
+end

data/lib/warren/message_filter.rb

@@ -0,0 +1,70 @@
+require File.expand_path(File.dirname(__FILE__) + "/message_filters/yaml")
+
+module Warren
+  # Handles filtering messages going onto/coming off the queue
+  class MessageFilter
+    # Array of filters to be run on the message before its
+    # pushed to rabbit.
+    # 
+    # NB: These get called in reverse order from the array - 
+    # the last filter to be added gets called first.
+    @@filters = [Warren::MessageFilter::Yaml]
+
+    class << self
+      # Adds a filter to the list
+      # 
+      # A valid filter is just a class that defines
+      # <tt>self.pack</tt> and <tt>self.unpack</tt> 
+      # methods, which both accept a single argument,
+      # act upon it, and return the output.
+      # 
+      # Example filter class (See also message_filters/*.rb)
+      # 
+      #     class Foo
+      #       def self.pack msg
+      #         msg.reverse # Assumes msg responds to reverse
+      #       end
+      # 
+      #       def self.unpack msg
+      #         msg.reverse # Does the opposite of Foo#pack
+      #       end
+      #     end
+      # 
+      def << filter
+        @@filters << filter
+      end
+      alias :add_filter :<<
+    end
+    
+    # Returns current array of filters
+    def self.filters
+      @@filters
+    end
+    
+    # Resets the filters to default
+    def self.reset_filters
+      @@filters = [Warren::MessageFilter::Yaml]
+    end
+
+    # Runs the raw message through all the filters
+    # and returns the filtered version
+    def self.pack msg
+      @@filters.reverse.each do |f|
+        # puts "Packing with #{f}"
+        msg = f.send(:pack, msg)
+      end
+      msg
+    end
+
+    # Runs the filtered message through all the
+    # filters and returns the raw version
+    def self.unpack msg
+      @@filters.each do |f|
+        # puts "Unpacking with #{f}"
+        msg = f.unpack(msg)
+      end
+      msg
+    end
+    
+  end
+end

data/lib/warren/message_filters/shared_secret.rb

@@ -0,0 +1,70 @@
+begin
+  require "hmac-sha2"
+rescue LoadError => e
+  puts "Error loading the `ruby-hmac` gem."
+  exit!
+end
+
+module Warren
+  class MessageFilter
+    # Hashes the message using a secret salt, stores the hash
+    # in the message and then checks its the same when pulled
+    # off the other end.
+    # 
+    # Basic trust implementation to make sure the message
+    # hasn't been tampered with in transit and came from
+    # an "authorised" app.
+    # 
+    # Make sure both the publisher and subscriber use the same
+    # key else you'll get KeyValidationError error raised.
+    # 
+    class SharedSecret
+      # Raised when no key (salt) is provided
+      class NoKeyError < Exception; end
+      # Raised when there is a key mismatch error
+      class KeyValidationError < Exception; end
+      
+      # Sets the key to use
+      def self.key= key
+        @@key = key
+      end
+      
+      # Returns the current key
+      # Raises NoKeyError if no key has been assigned yet
+      def self.key
+        raise NoKeyError if @@key.nil?
+        @@key
+      end
+      
+      # Returns the hashed message
+      # 
+      # Expects that msg#to_s returns a string
+      # to hash against.
+      # 
+      def self.secret msg
+        HMAC::SHA256.hexdigest(self.key, msg.to_s)
+      end
+      
+      # Called when the message is being packed for
+      # transit. Returns a hash.
+      def self.pack msg
+        # Make sure its a hash
+        msg = {:secret_msg => msg} unless msg.is_a? Hash
+        # And add our secret into the hash
+        msg[:secret] = self.secret(msg.to_s)
+        msg
+      end
+      
+      # Called when unpacking the message from transit.
+      # Returns the original object.
+      def self.unpack msg
+        # Check the secret exists in the msg and matches the secret_string
+        raise KeyValidationError unless msg.delete(:secret) == self.secret(msg)
+        # see if its a hash we created, it'll only contain the key "secret_msg" if it is
+        msg = msg[:secret_msg] if msg.keys == [:secret_msg]
+        msg        
+      end
+            
+    end
+  end
+end

data/lib/warren/message_filters/yaml.rb

@@ -0,0 +1,20 @@
+require "yaml"
+
+module Warren
+  class MessageFilter
+    # Packs the message into a YAML string
+    # for transferring safely across the wire
+    class Yaml
+      
+      # Returns a YAML string
+      def self.pack msg
+        YAML.dump(msg)
+      end
+      
+      # Returns original message
+      def self.unpack msg
+        YAML.load(msg)
+      end
+    end
+  end
+end

data/lib/warren/queue.rb

@@ -0,0 +1,85 @@
+class Warren::Queue
+  @@connection = nil
+  
+  # Raised if no connection has been defined yet.
+  class NoConnectionDetails < Exception
+  end
+  
+  # Raised if a block is expected by the method but none is given.
+  class NoBlockGiven < Exception
+  end
+    
+  # Sets the connection details
+  def self.connection= params
+    @@connection = params.is_a?(Warren::Connection) ? params : Warren::Connection.new(params)
+  end
+  
+  # Returns the current connection details
+  # Raises NoConnectionDetails if no connection details have been
+  # assigned yet.
+  def self.connection
+    if @@connection.nil?
+      raise NoConnectionDetails, "You need to set the connection details."
+    end
+    @@connection
+  end
+  
+  #
+  # Sends a message to a queue. If successfully sent it returns
+  # true, unless callback block is passed (see below)
+  # 
+  #   Warren::Queue.publish(:queue_name, {:foo => "name"})
+  # 
+  # Can also pass a block which is fired after the message
+  # is sent. If a block is passed, then the return value of the block
+  # is returned from this method.
+  # 
+  #   Warren::Queue.publish(:queue_name, {:foo => "name"}) { puts "foo" }
+  # 
+  def self.publish queue_name, payload, &blk
+    queue_name = self.connection.queue_name if queue_name == :default
+    # Create a message object if it isn't one already
+    msg = Warren::MessageFilter.pack(payload)
+        
+    do_connect(true, blk) do
+      queue = MQ::Queue.new(MQ.new, queue_name)
+      queue.publish msg.to_s
+    end
+
+  end
+  
+  #
+  # Subscribes to a queue and runs the block
+  # for each message received
+  # 
+  #   Warren::Queue.subscribe("example") {|msg| puts msg }
+  # 
+  # Expects a block and raises NoBlockGiven if no block is given.
+  # 
+  def self.subscribe queue_name, &block
+    raise NoBlockGiven unless block_given?
+    queue_name = self.connection.queue_name if queue_name == :default
+    # todo: check if its a valid queue?
+    do_connect(false) do
+      queue = MQ::Queue.new(MQ.new, queue_name)
+      queue.subscribe do |msg|
+        msg = Warren::MessageFilter.unpack(msg)
+        block.call(msg)
+      end
+    end
+  end
+
+
+  private
+  
+  # Connects and does the stuff its told to!
+  def self.do_connect should_stop = true, callback = nil, &block
+    AMQP.start(self.connection.options) do
+      block.call
+      AMQP.stop { EM.stop_event_loop } if should_stop
+    end
+    # Returns the block return value or true
+    callback.nil? ? true : callback.call
+  end
+  
+end

data/lib/warren.rb

@@ -0,0 +1,24 @@
+require "yaml"
+require "rubygems"
+require "mq"
+
+# 
+# Library for pushing messages onto RabbitMQ queues,
+# and receiving them at the other end.
+# 
+# It handles authentication + filtering messages with custom
+# classes if needed.
+# 
+# Start with Warren::Queue for details and see also
+# examples/
+# 
+module Warren
+  @@foo = ""
+end
+
+WARREN_ROOT = File.expand_path(File.join(File.dirname(__FILE__), ".."))
+
+# Require everything in the lib folder
+Dir["#{WARREN_ROOT}/lib/warren/**/*.rb"].each do |file|
+  require file
+end

data/readme.rdoc

@@ -0,0 +1,19 @@
+= Warren
+
+Library for pushing messages onto RabbitMQ queues, and receiving them at the other end.
+
+It handles authentication + filtering messages with custom classes if needed.
+
+Start with Warren::Queue for details and see also examples/
+
+== Released under the MIT Licence
+
+Copyright (c) 2008 Brightbox Systems Ltd 
+
+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.
+
+See http://www.brightbox.co.uk/ for contact details.  

data/spec/hash_extend.rb

@@ -0,0 +1,9 @@
+class Hash
+  def except(*blacklist)
+    self.reject {|key, value| blacklist.include?(key) }
+  end
+
+  def only(*whitelist)
+    self.reject {|key, value| !whitelist.include?(key) }
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,3 @@
+--colour
+--format progress
+--loadby mtime

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require File.join(File.dirname(__FILE__) + "/../lib/warren")
+
+# Hash#only and Hash#except
+require File.join(File.dirname(__FILE__) + "/hash_extend")

data/spec/warren/connection_spec.rb

@@ -0,0 +1,70 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Warren::Connection do
+  
+  before(:each) do
+    @c = Warren::Connection.new(details)
+  end
+  
+  it "should require a username" do
+    lambda {
+      Warren::Connection.new(details.except(:user))
+    }.should raise_error(Warren::Connection::InvalidConnectionDetails)
+  end
+  
+  it "should require a password" do
+    lambda {
+      Warren::Connection.new(details.except(:pass))
+    }.should raise_error(Warren::Connection::InvalidConnectionDetails)
+  end
+  
+  it "should require a queue name if none specified" do
+    lambda {
+      conn = Warren::Connection.new(details)
+      conn.queue_name
+    }.should raise_error(Warren::Connection::InvalidConnectionDetails)
+  end
+  
+  it "should return a default host" do
+    @c.options[:host].should == "localhost"
+  end
+  
+  it "should return a given host" do
+    c = Warren::Connection.new(details.merge({:host => "caius"}))
+    c.options[:host].should == "caius"
+  end
+  
+  it "should return a default port" do
+    @c.options[:port].should == 5672
+  end
+  
+  it "should return a given port" do
+    c = Warren::Connection.new(details.merge({:port => 1}))
+    c.options[:port].should == 1
+  end
+  
+  it "should return a default logging param" do
+    @c.options[:logging].should == false
+  end
+  
+  it "should return a given logging param" do
+    c = Warren::Connection.new(details.merge({:logging => true}))
+    c.options[:logging].should == true
+  end
+
+  it "should return the given queue name" do
+    conn = Warren::Connection.new(details.merge({:default_queue => "queue"}))
+    conn.queue_name.should == "queue"
+  end
+
+  private
+
+  def details
+    {
+      :user  => "user",
+      :pass  => "pass",
+      :vhost => "main",
+    }
+  end
+  
+end

data/spec/warren/message_filter_spec.rb

@@ -0,0 +1,84 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+# Needed for some tests later on
+class Foo
+  def self.pack msg
+    msg
+  end
+
+  def self.unpack msg
+    msg
+  end
+end
+
+describe Warren::MessageFilter do
+  
+  before(:each) do
+    Warren::MessageFilter.reset_filters
+  end
+  
+  describe "Managing Filters" do
+    it "should have YAML as a filter by default" do
+      fs = Warren::MessageFilter.filters
+
+      fs.should have(1).element
+      fs.first.should == Warren::MessageFilter::Yaml
+    end
+
+    it "should add additional filters to the stack" do
+      Warren::MessageFilter.should respond_to(:<<)
+      Warren::MessageFilter << Foo
+      fs = Warren::MessageFilter.filters
+
+      fs.should have(2).elements
+      fs.first.should == Warren::MessageFilter::Yaml
+      fs.last.should == Foo
+    end
+  end
+  
+  describe "calling filters to send message" do
+    
+    it "should YAML by default" do
+      @msg = "message"
+      Warren::MessageFilter::Yaml.should_receive(:pack).with(@msg).and_return("yamled")
+      
+      Warren::MessageFilter.pack(@msg)
+    end
+    
+    it "should call each filter in turn when packing" do
+      @msg = "message"
+      
+      Foo.should_receive(:pack).with(@msg).and_return("fooed")
+      Warren::MessageFilter::Yaml.should_receive(:pack).with("fooed").and_return("yamled")
+      
+      Warren::MessageFilter << Foo
+      
+      Warren::MessageFilter.pack(@msg).should == "yamled"
+    end
+    
+  end
+  
+  describe "calling filters to unpack message" do
+    it "should un-YAML by default" do
+      @msg = "yamled"
+      
+      Warren::MessageFilter::Yaml.should_receive(:unpack).with("yamled").and_return("message")
+      
+      Warren::MessageFilter.unpack(@msg).should == "message"
+    end
+    
+    it "should run all unpack filters" do
+      @msg = "yamled message"
+      
+      Warren::MessageFilter::Yaml.should_receive(:unpack).with("yamled message").and_return("fooed")
+      Foo.should_receive(:unpack).with("fooed").and_return("message")
+      
+      Warren::MessageFilter << Foo
+      Warren::MessageFilter.filters.should == [Warren::MessageFilter::Yaml, Foo]
+      
+      Warren::MessageFilter.unpack(@msg).should == "message"
+    end
+  end
+    
+end
+

data/spec/warren/queue_spec.rb

@@ -0,0 +1,93 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Warren::Queue do
+  
+  it "should require raise exception with no connection details" do
+    lambda {
+      Warren::Queue.connection
+    }.should raise_error(Warren::Queue::NoConnectionDetails)
+  end
+  
+  it "should require connection details to publish" do
+    lambda {
+      Warren::Queue.publish("", "")
+    }.should raise_error(Warren::Queue::NoConnectionDetails)
+  end
+  
+  it "should require connection details to subscribe" do
+    lambda {
+      Warren::Queue.subscribe("") { true }
+    }.should raise_error(Warren::Queue::NoConnectionDetails)
+  end
+  
+  it "should set connection details" do
+    conn = new_connection
+    
+    Warren::Queue.connection = conn
+    Warren::Queue.connection.should == conn
+  end
+  
+  it "should publish to a queue" do
+    Warren::Queue.connection = new_connection
+    
+    Warren::Queue.should_receive(:do_connect).with(true, nil).and_return(true)
+    Warren::Queue.publish("queue", "payload")
+  end
+  
+  it "should publish to a default queue" do
+    Warren::Queue.connection = new_connection(:default_queue => "queue")
+    
+    Warren::Queue.should_receive(:do_connect).with(true, nil).and_return(true)
+    Warren::Queue.publish(:default, "payload")
+  end
+    
+  it "should publish to a queue with a block" do
+    Warren::Queue.connection = new_connection
+    
+    blk = Proc.new { true }
+    
+    Warren::Queue.should_receive(:do_connect).with(true, blk).and_return(true)
+    Warren::Queue.publish("queue", "payload", &blk)
+  end
+  
+  describe "subscribing" do
+    
+    it "should require a block to be passed" do
+      Warren::Queue.connection = new_connection
+      
+      lambda {
+        Warren::Queue.subscribe("queue")
+      }.should raise_error(Warren::Queue::NoBlockGiven)
+    end
+    
+    it "should subscribe to a queue" do
+      Warren::Queue.connection = new_connection
+      
+      Warren::Queue.should_receive(:do_connect).with(false).and_return(true)
+      Warren::Queue.subscribe("queue") { true }
+    end
+    
+    it "should subscribe to the default queue" do
+      Warren::Queue.connection = new_connection(:default_queue => "queue")
+      
+      Warren::Queue.should_receive(:do_connect).with(false).and_return(true)
+      Warren::Queue.subscribe(:default) { true }
+    end
+    
+  end
+  
+  private
+  
+  def new_connection opts = {}
+    Warren::Connection.new(details.merge(opts))
+  end
+  
+  def details
+    {
+      :user  => "user",
+      :pass  => "pass",
+      :vhost => "main",
+    }
+  end
+  
+end

data/tasks/rdoc.rake

@@ -0,0 +1,7 @@
+require "rake/rdoctask"
+
+Rake::RDocTask.new do |rd|
+  rd.main = "lib/warren.rb"
+  rd.rdoc_files.include("lib/**/*.rb")
+  rd.rdoc_dir = "doc"
+end

data/tasks/rspec.rake

@@ -0,0 +1,24 @@
+# Borrowed from http://github.com/rsim/ruby-plsql/tree/master/tasks/rspec.rake
+# Github++
+begin
+  require "spec"
+rescue LoadError
+  require "rubygems"
+  require "spec"
+end
+
+begin
+  require "spec/rake/spectask"
+rescue LoadError
+  puts <<-EOS
+To use rspec for testing you must install rspec gem:
+  [sudo] gem install rspec
+EOS
+  exit(0)
+end
+
+desc "Run the specs under spec/*"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ["--options", "spec/spec.opts"]
+  t.spec_files = FileList["spec/**/*_spec.rb"]
+end

data/warren.gemspec

@@ -0,0 +1,34 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{warren}
+  s.version = "0.5"
+
+  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-03-13}
+  s.description = %q{Library for pushing messages onto and off RabbitMQ queues}
+  s.email = %q{support@brightbox.co.uk}
+  s.extra_rdoc_files = ["CHANGELOG", "lib/warren/connection.rb", "lib/warren/message_filter.rb", "lib/warren/message_filters/shared_secret.rb", "lib/warren/message_filters/yaml.rb", "lib/warren/queue.rb", "lib/warren.rb", "tasks/rdoc.rake", "tasks/rspec.rake"]
+  s.files = ["CHANGELOG", "examples/authed/receiver.rb", "examples/authed/secret.rb", "examples/authed/sender.rb", "examples/simple/mass_sender.rb", "examples/simple/receiver.rb", "examples/simple/sender.rb", "lib/warren/connection.rb", "lib/warren/message_filter.rb", "lib/warren/message_filters/shared_secret.rb", "lib/warren/message_filters/yaml.rb", "lib/warren/queue.rb", "lib/warren.rb", "LICENCE", "Manifest", "Rakefile", "readme.rdoc", "spec/hash_extend.rb", "spec/spec.opts", "spec/spec_helper.rb", "spec/warren/connection_spec.rb", "spec/warren/message_filter_spec.rb", "spec/warren/queue_spec.rb", "tasks/rdoc.rake", "tasks/rspec.rake", "warren.gemspec"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/brightbox/warren}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Warren", "--main", "readme.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{warren}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Library for pushing messages onto and off RabbitMQ queues}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<amqp>, [">= 0.6.0"])
+    else
+      s.add_dependency(%q<amqp>, [">= 0.6.0"])
+    end
+  else
+    s.add_dependency(%q<amqp>, [">= 0.6.0"])
+  end
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification 
+name: brightbox-warren
+version: !ruby/object:Gem::Version 
+  version: "0.5"
+platform: ruby
+authors: 
+- Caius Durling, David Smalley
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-13 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: amqp
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.6.0
+    version: 
+description: Library for pushing messages onto and off RabbitMQ queues
+email: support@brightbox.co.uk
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- CHANGELOG
+- lib/warren/connection.rb
+- lib/warren/message_filter.rb
+- lib/warren/message_filters/shared_secret.rb
+- lib/warren/message_filters/yaml.rb
+- lib/warren/queue.rb
+- lib/warren.rb
+- tasks/rdoc.rake
+- tasks/rspec.rake
+files: 
+- CHANGELOG
+- examples/authed/receiver.rb
+- examples/authed/secret.rb
+- examples/authed/sender.rb
+- examples/simple/mass_sender.rb
+- examples/simple/receiver.rb
+- examples/simple/sender.rb
+- lib/warren/connection.rb
+- lib/warren/message_filter.rb
+- lib/warren/message_filters/shared_secret.rb
+- lib/warren/message_filters/yaml.rb
+- lib/warren/queue.rb
+- lib/warren.rb
+- LICENCE
+- Manifest
+- Rakefile
+- readme.rdoc
+- spec/hash_extend.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/warren/connection_spec.rb
+- spec/warren/message_filter_spec.rb
+- spec/warren/queue_spec.rb
+- tasks/rdoc.rake
+- tasks/rspec.rake
+- warren.gemspec
+has_rdoc: true
+homepage: http://github.com/brightbox/warren
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Warren
+- --main
+- readme.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: warren
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Library for pushing messages onto and off RabbitMQ queues
+test_files: []
+