warren 0.8.9

data/CHANGELOG

@@ -0,0 +1,14 @@
+v0.8.9. Fixing a StackTooDeep bug.
+v0.8.8. Bumping for github
+v0.8.7. Added a TestAdapter
+v0.8.6. Also added dummy adapter to gemspec
+v0.8.5. Added dummy adapter for testing purposes
+v0.8.4. Fix typo in 0.8.3
+v0.8.3. Can now override WARREN_ENV from the command line.
+v0.8.2. Added nice error message when no details for current env
+v0.8.1. Fixed bug in passing params in
+v0.8. Gem works with rails
+v0.7. Added adapters
+v0.6. Added config file
+v0.5. Added filters
+v0.3. Initial release

data/LICENSE

@@ -0,0 +1,11 @@
+Released under the MIT License
+
+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,32 @@
+CHANGELOG
+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/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
+lib/warren.rb
+LICENSE
+Manifest
+Rakefile
+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

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,25 @@
+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 } }
+
+# Listen to the main queue
+q = "main"
+puts "Listening to the #{q} queue."
+
+# Setup the connection directly this time
+Warren::Queue.connection = {"development" => {: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,40 @@
+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("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"
+    }
+  ]
+}
+
+# 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/amqp_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/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/amqp_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/amqp_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/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/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,93 @@
+require "rubygems"
+require "bunny"
+
+module Warren
+  class Queue
+    class BunnyAdapter < 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(self.connection.options)
+        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
+
+    end
+  end
+end

data/lib/warren/adapters/dummy_adapter.rb

@@ -0,0 +1,12 @@
+require "rubygems"
+
+class DummyAdapter < Warren::Queue
+  def self.publish queue_name, payload, &blk
+    puts "publishing #{payload.inspect} to #{queue_name}"
+  end
+
+  def self.subscribe queue_name, &block
+    puts "subscribing to #{queue_name}"
+  end
+end
+

data/lib/warren/adapters/test_adapter.rb

@@ -0,0 +1,27 @@
+require "rubygems"
+
+class TestAdapter < Warren::Queue
+  ConnectionFailed = Class.new(Exception)
+  # 
+  def self.publish queue_name, payload, &blk
+    raise TestAdapter::ConnectionFailed if fail?
+    true
+  end
+
+  # 
+  # def self.subscribe queue_name, &block
+  #   puts "subscribing to #{queue_name}"
+  # end
+  # 
+  
+  private
+  
+  def self.fail?
+    File.exists?(file_name) && (File.read(file_name, 4) == "FAIL")
+  end
+  
+  def self.file_name
+    "#{WARREN_ROOT}/tmp/warren.txt"
+  end
+end
+

data/lib/warren/connection.rb

@@ -0,0 +1,140 @@
+require "yaml"
+module Warren
+  class Connection
+
+    attr_reader :options
+
+    #
+    # Creates a new connection by reading the options from
+    # WARREN_ROOT/config/warren.yml or specify the file to read as an
+    # argument or by passing a hash of connection details in.
+    #
+    #   Warren::Connection.new # reads WARREN_ROOT/config/warren.yml
+    #   Warren::Connection.new("file.yml")       # reads file.yml
+    #   Warren::Connection.new({"foo" => "bar"}) # uses the hash
+    #
+    # Reads WARREN_ENV out of the yaml'd hash (just like ActiveRecord)
+    # "development" by default (and RAILS_ENV if running under rails)
+    #
+    # Raises InvalidConnectionDetails if no params are found for the current
+    # environment.
+    #
+    # todo: fail nicely if the env isn't defined
+    #
+    def initialize params = nil
+      get_connection_details(params)
+      # Make the details publically accessible
+      @options = @opts
+    end
+
+    #
+    # Raised if connection details are missing or invalid
+    # Check the error message for more details
+    #
+    InvalidConnectionDetails = Class.new(Exception)
+
+    private
+
+    #
+    # Short version: This is the brain of this class and sets everything up.
+    #
+    # Long version: Works out where the connection details need to come from
+    # (params or yml) and parses them from there. Then figures out if the details
+    # are there for the current env and raises a nice error if there aren't any
+    # detail for the current env. Then we symblize all the keys and get the adapter
+    # to check its happy with the connection details we have.
+    #
+    def get_connection_details params
+      case params
+      when NilClass
+        # Read from config/warren.yml
+        read_config_file
+
+      when String
+        # See if it exists as a file
+        parse_config_file(params)
+
+      when Hash
+        # Use it as-is
+        @opts = params
+
+      else
+        # See if it responds to :read
+        if respond_to?(:read)
+          # Parse it as yaml
+          parse_config(params)
+        else
+          # Have no idea what to do with it
+          raise InvalidConnectionDetails, "Don't know what to do with the params passed. Please pass a hash, filename or nothing."
+        end
+      end
+
+      # Make sure the hash keys are symbols
+      @opts = symbolize_keys(@opts)
+      # Parse out the current environment
+      parse_environment
+      # Call the adapter to figure out if the details are alright
+      check_connection_details
+    end
+
+    #
+    # Reads in either config/warren.yml or the passed argument as a YAML file
+    #
+    def read_config_file filename=nil
+      filename ||= "#{WARREN_ROOT}/config/warren.yml"
+      parse_config_file(filename)
+    end
+
+    #
+    # Parses the config file into a hash from yaml.
+    #
+    def parse_config_file filename
+      if File.exists?(filename)
+        @opts = YAML.load_file(filename)
+      else
+        raise InvalidConnectionDetails, "File not found: '#{filename}'"
+      end
+    end
+
+    #
+    # Parses the object using YAML#load
+    #
+    def parse_config obj
+      @opts = YAML.load(obj)
+    end
+
+    #
+    # Modifies the hash into just the details for the
+    # current environment, or raises InvalidConnectionDetails
+    #
+    def parse_environment
+      # keys are symbolified already
+      unless @opts.has_key?(WARREN_ENV.to_sym)
+        raise InvalidConnectionDetails, "No details for current environment '#{WARREN_ENV}'"
+      end
+      @opts = @opts[WARREN_ENV.to_sym]
+    end
+
+    #
+    # Changes all keys into symbols
+    #
+    def symbolize_keys(hash)
+      hash.each do |key, value|
+        hash.delete(key)
+        # Make it recursive
+        hash[key.to_sym] = (value.is_a?(Hash) ? symbolize_keys(value) : value)
+      end
+      hash
+    end
+
+    #
+    # Calls the adapter to check the connection details
+    # Returns true or raises InvalidConnectionDetails
+    #
+    def check_connection_details
+      return true unless Warren::Queue.adapter.respond_to?(:check_connection_details)
+      Warren::Queue.adapter.send(:check_connection_details, @opts)
+    end
+
+  end
+end