brightbox-warren 0.5 → 0.7

data/CHANGELOG

@@ -1,2 +1,4 @@
+v0.7. Added adapters
+v0.6. Added config file
 v0.5. Added filters
 v0.3. Initial release

data/{LICENCE → LICENSE}

@@ -1,6 +1,6 @@
-Released under the MIT Licence
+Released under the MIT License
 
-Copyright (c) 2008 Brightbox Systems Ltd 
+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:
 
@@ -8,4 +8,4 @@ Permission is hereby granted, free of charge, to any person obtaining a copy of
 
 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.  
+See http://www.brightbox.co.uk/ for contact details.

data/Manifest

@@ -2,24 +2,28 @@ 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
+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/adapters/amqp_adapter.rb
+lib/warren/adapters/bunny_adapter.rb
 lib/warren/connection.rb
+lib/warren/filters/shared_secret.rb
+lib/warren/filters/yaml.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
+LICENSE
 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
+spec/warren/warren_spec.rb
 tasks/rdoc.rake
 tasks/rspec.rake
+warren.gemspec

data/Rakefile

@@ -2,13 +2,13 @@ require 'rubygems'
 require 'rake'
 
 # Load in external rakefiles
-Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each do | rake_file | 
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each do | rake_file |
   load rake_file
 end
 
 # Gem stuff
 require 'echoe'
-Echoe.new('warren') do | gem | 
+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'

data/examples/authed/receiver.rb

@@ -1,5 +1,7 @@
 require "rubygems"
 require File.expand_path(File.dirname(__FILE__) + "/../../lib/warren")
+require File.expand_path(File.dirname(__FILE__) + "/../../lib/warren/adapters/amqp_adapter")
+require File.expand_path(File.dirname(__FILE__) + "/../../lib/warren/filters/shared_secret")
 
 Signal.trap("INT") { AMQP.stop { EM.stop } }
 Signal.trap("TERM") { AMQP.stop { EM.stop } }
@@ -9,7 +11,7 @@ q = "main"
 puts "Listening to the #{q} queue."
 
 # Setup the connection directly this time
-Warren::Queue.connection = {:user => "caius", :pass => "caius", :vhost => "/"}
+Warren::Queue.connection = {"development" => {:user => "caius", :pass => "caius", :vhost => "/"}}
 
 # Set the secret key
 require File.expand_path(File.dirname(__FILE__) + "/secret")

data/examples/authed/sender.rb

@@ -1,16 +1,18 @@
 require "rubygems"
 require File.expand_path(File.dirname(__FILE__) + "/../../lib/warren")
+require File.expand_path(File.dirname(__FILE__) + "/../../lib/warren/adapters/amqp_adapter")
+require File.expand_path(File.dirname(__FILE__) + "/../../lib/warren/filters/shared_secret")
 
 Signal.trap("INT") { exit! }
 Signal.trap("TERM") { exit! }
 
 # Setup our own connection before generating the queue object
-conn = Warren::Connection.new(
+conn = Warren::Connection.new("development" => {
   :user => "caius",
   :pass => "caius",
   :vhost => "/",
   :default_queue => "main"
-)
+})
 # Set the connection for the queue
 Warren::Queue.connection = conn
 # Generate some data to send

data/examples/simple/amqp_receiver.rb

@@ -0,0 +1,18 @@
+require "rubygems"
+require File.expand_path(File.dirname(__FILE__) + "/../../lib/warren")
+# Next line is the only one you need to change to use a different adapter
+require File.expand_path(File.dirname(__FILE__) + "/../../lib/warren/adapters/amqp_adapter")
+
+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."
+
+Warren::Queue.connection = {"development" => {: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 → amqp_sender.rb}

@@ -1,16 +1,18 @@
 require "rubygems"
-require File.expand_path(File.dirname(__FILE__) + "/../lib/warren")
+require File.expand_path(File.dirname(__FILE__) + "/../../lib/warren")
+# Next line is the only one you need to change to use a different adapter
+require File.expand_path(File.dirname(__FILE__) + "/../../lib/warren/adapters/amqp_adapter")
 
 Signal.trap("INT") { exit! }
 Signal.trap("TERM") { exit! }
 
 # Setup our own connection before generating the queue object
-conn = Warren::Connection.new(
+conn = Warren::Connection.new("development" => {
   :user => "caius",
   :pass => "caius",
   :vhost => "/",
   :default_queue => "main"
-)
+})
 # Set the connection for the queue
 Warren::Queue.connection = conn
 # Generate some data to send
@@ -26,8 +28,9 @@ data = {
     }
   ]
 }
+
 # 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" }
+# p Warren::Queue.publish(:default, data) { "foo" }

data/examples/simple/bunny_receiver.rb

@@ -0,0 +1,18 @@
+require "rubygems"
+require File.expand_path(File.dirname(__FILE__) + "/../../lib/warren")
+# Next line is the only one you need to change to use a different adapter
+require File.expand_path(File.dirname(__FILE__) + "/../../lib/warren/adapters/bunny_adapter")
+
+Signal.trap("INT") { exit! }
+Signal.trap("TERM") { exit! }
+
+# Listen to the main queue
+q = "main"
+puts "Listening to the #{q} queue."
+
+Warren::Queue.connection = {"development" => {: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/bunny_sender.rb

@@ -0,0 +1,36 @@
+require "rubygems"
+require File.expand_path(File.dirname(__FILE__) + "/../../lib/warren")
+# Next line is the only one you need to change to use a different adapter
+require File.expand_path(File.dirname(__FILE__) + "/../../lib/warren/adapters/bunny_adapter")
+
+Signal.trap("INT") { exit! }
+Signal.trap("TERM") { exit! }
+
+# Setup our own connection before generating the queue object
+conn = Warren::Connection.new("development" => {
+  :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.rb

@@ -1,24 +1,23 @@
 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__), ".."))
+WARREN_ENV = (defined?(RAILS_ENV) ? RAILS_ENV : "development") unless defined?(WARREN_ENV)
+WARREN_ROOT = File.dirname($0)
+WARREN_LIB_ROOT = File.expand_path(File.join(File.dirname(__FILE__), ".."))
 
 # Require everything in the lib folder
-Dir["#{WARREN_ROOT}/lib/warren/**/*.rb"].each do |file|
+Dir["#{WARREN_LIB_ROOT}/lib/warren/*.rb"].each do |file|
   require file
 end

data/lib/warren/adapters/amqp_adapter.rb

@@ -0,0 +1,87 @@
+require "rubygems"
+require "mq"
+
+class Warren::Queue::AMQPAdapter < Warren::Queue
+  
+  # 
+  # Checks the connection details are correct for this adapter
+  # 
+  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."
+    end
+    true
+  end
+  
+  # 
+  # Returns the default queue name or returns InvalidConnectionDetails
+  # if no default queue is defined
+  # 
+  def self.queue_name
+    unless self.connection.options.has_key?(:default_queue)
+      raise Warren::Connection::InvalidConnectionDetails, "Missing a default queue name."
+    end
+    self.connection.options[:default_queue]
+  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.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.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/adapters/bunny_adapter.rb

@@ -0,0 +1,97 @@
+require "rubygems"
+require "bunny"
+
+class Warren::Queue::BunnyAdapter < Warren::Queue
+  
+  # 
+  # Checks the connection details are correct for this adapter
+  # 
+  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."
+    end
+    true
+  end
+  
+  # 
+  # Returns the default queue name or returns InvalidConnectionDetails
+  # if no default queue is defined
+  # 
+  def self.queue_name
+    unless self.connection.options.has_key?(:default_queue)
+      raise Warren::Connection::InvalidConnectionDetails, "Missing a default queue name."
+    end
+    self.connection.options[:default_queue]
+  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.queue_name if queue_name == :default
+    # Create a message object if it isn't one already
+    msg = Warren::MessageFilter.pack(payload)
+
+    do_connect(queue_name, blk) do |queue|
+      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.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))
+    end
+  end
+
+  private
+
+  #
+  # Connects and does the stuff its told to!
+  #
+  def self.do_connect queue_name, callback = nil, &block
+    # Open a connection
+    b = Bunny.new(connection_details)
+    b.start
+    # Create the queue
+    q = b.queue(queue_name)
+    # Run the code on the queue
+    block.call(q)
+    # And stop
+    b.stop
+    # Returns the block return value or true
+    callback.nil? ? true : callback.call
+  end
+  
+  def self.connection_details
+    {
+      :user  => self.connection.options[:user],
+      :pass  => self.connection.options[:pass],
+      :vhost => self.connection.options[:vhost]
+    }
+  end
+
+end