brightbox-warren 0.7 → 0.8

data/CHANGELOG

@@ -1,3 +1,4 @@
+v0.8. Gem works with rails
 v0.7. Added adapters
 v0.6. Added config file
 v0.5. Added filters

data/lib/warren/adapters/bunny_adapter.rb

@@ -1,97 +1,101 @@
 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
+module Warren
+  class Queue
+    class BunnyAdapter < Queue
 
-  #
-  # 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)
+      # 
+      # 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
 
-    do_connect(queue_name, blk) do |queue|
-      queue.publish msg.to_s
-    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
 
-  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
+      #
+      # 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)
 
-  private
+        do_connect(queue_name, blk) do |queue|
+          queue.publish msg.to_s
+        end
 
-  #
-  # 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
+
+      #
+      # 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
 
-end
+      #
+      # 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
+  end
+end

data/lib/warren/connection.rb

@@ -17,9 +17,9 @@ module Warren
     #
     def initialize params = nil
       if params.nil? || !params.is_a?(Hash)
-        file ||= WARREN_ROOT << "/config" << "/warren.yml"
+        file ||= "#{WARREN_ROOT}/config/warren.yml"
         raise InvalidConnectionDetails, "Config file not found: #{file}" unless File.exists?(file)
-        opts = YAML.load(file)
+        opts = YAML.load_file(file)
       end
       opts ||= params
       

data/lib/warren/queue.rb

@@ -1,69 +1,71 @@
-class Warren::Queue
-  @@connection = nil
-  @@adapter    = nil
+module Warren
+  class Queue
+    @@connection = nil
+    @@adapter    = nil
 
-  #
-  # Raised if no connection has been defined yet.
-  #
-  NoConnectionDetails = Class.new(Exception)
+    #
+    # Raised if no connection has been defined yet.
+    #
+    NoConnectionDetails = Class.new(Exception)
 
-  #
-  # Raised if a block is expected by the method but none is given.
-  #
-  NoBlockGiven = Class.new(Exception)
-  
-  # 
-  # Raised if an adapter isn't set
-  # 
-  NoAdapterSet = Class.new(Exception)
+    #
+    # Raised if a block is expected by the method but none is given.
+    #
+    NoBlockGiven = Class.new(Exception)
 
-  # 
-  # Sets the current connection
-  # 
-  def self.connection= conn
-    @@connection = (conn.is_a?(Warren::Connection) ? conn : Warren::Connection.new(conn) )
-  end
-  
-  #
-  # Returns the current connection details
-  #
-  def self.connection
-    @@connection ||= Warren::Connection.new
-  end
+    # 
+    # Raised if an adapter isn't set
+    # 
+    NoAdapterSet = Class.new(Exception)
 
-  # 
-  # Sets the adapter when this class is subclassed.
-  # 
-  def self.inherited klass
-    @@adapter = klass
-  end
-  
-  # 
-  # Sets the adapter manually
-  # 
-  def self.adapter= klass
-    @@adapter = klass
-  end
+    # 
+    # Sets the current connection
+    # 
+    def self.connection= conn
+      @@connection = (conn.is_a?(Warren::Connection) ? conn : Warren::Connection.new(conn) )
+    end
 
-  # 
-  # Returns the current adapter or raises NoAdapterSet exception
-  # 
-  def self.adapter
-    @@adapter || raise(NoAdapterSet)
-  end
+    #
+    # Returns the current connection details
+    #
+    def self.connection
+      @@connection ||= Warren::Connection.new
+    end
 
-  # 
-  # Publishes the message to the queue
-  # 
-  def self.publish *args, &blk
-    self.adapter.publish(*args, &blk)
-  end
-  
-  # 
-  # Sends the subscribe message to the adapter class
-  # 
-  def self.subscribe *args, &blk
-    self.adapter.subscribe(*args, &blk)
-  end
+    # 
+    # Sets the adapter when this class is subclassed.
+    # 
+    def self.inherited klass
+      @@adapter = klass
+    end
+
+    # 
+    # Sets the adapter manually
+    # 
+    def self.adapter= klass
+      @@adapter = klass
+    end
+
+    # 
+    # Returns the current adapter or raises NoAdapterSet exception
+    # 
+    def self.adapter
+      @@adapter || raise(NoAdapterSet)
+    end
 
-end
+    # 
+    # Publishes the message to the queue
+    # 
+    def self.publish *args, &blk
+      self.adapter.publish(*args, &blk)
+    end
+
+    # 
+    # Sends the subscribe message to the adapter class
+    # 
+    def self.subscribe *args, &blk
+      self.adapter.subscribe(*args, &blk)
+    end
+
+  end
+end

data/lib/warren.rb

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

data/readme.rdoc

@@ -21,6 +21,16 @@ Start by looking at examples/ to see how to use it, and then lib/warren/adapters
     
     # See examples/ for more
 
+== Rails
+
+Add this to your environment.rb
+
+    config.gem "brightbox-warren", :lib => "warren", :version => ">= 0.8"
+
+And then in an initializer file (or bottom of environment.rb) require the adapter you want to use (for rabbitmq I suggest bunny - amqp uses eventmachine and was giving me issues under passenger.) And then any filters you want to use.
+
+    require "warren/adapters/bunny_adapter"
+
 == License
 
 Licensed under the MIT license. See LICENSE for more details.

data/warren.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{warren}
-  s.version = "0.7"
+  s.version = "0.8"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Caius Durling, David Smalley"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: brightbox-warren
 version: !ruby/object:Gem::Version 
-  version: "0.7"
+  version: "0.8"
 platform: ruby
 authors: 
 - Caius Durling, David Smalley