brightbox-warren 0.8 → 0.8.2

data/CHANGELOG

@@ -1,3 +1,5 @@
+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

data/Manifest

@@ -26,4 +26,3 @@ spec/warren/queue_spec.rb
 spec/warren/warren_spec.rb
 tasks/rdoc.rake
 tasks/rspec.rake
-warren.gemspec

data/lib/warren/adapters/bunny_adapter.rb

@@ -76,7 +76,7 @@ module Warren
       #
       def self.do_connect queue_name, callback = nil, &block
         # Open a connection
-        b = Bunny.new(connection_details)
+        b = Bunny.new(self.connection.options)
         b.start
         # Create the queue
         q = b.queue(queue_name)
@@ -88,14 +88,6 @@ module Warren
         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

@@ -1,7 +1,7 @@
 require "yaml"
 module Warren
   class Connection
-    
+
     attr_reader :options
 
     #
@@ -9,23 +9,22 @@ module Warren
     # 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
-      if params.nil? || !params.is_a?(Hash)
-        file ||= "#{WARREN_ROOT}/config/warren.yml"
-        raise InvalidConnectionDetails, "Config file not found: #{file}" unless File.exists?(file)
-        opts = YAML.load_file(file)
-      end
-      opts ||= params
-      
-      opts = symbolize_keys(opts[WARREN_ENV])
-      check_connection_details(opts)
-      @options = opts
+      get_connection_details(params)
+      # Make the details publically accessible
+      @options = @opts
     end
 
     #
@@ -36,23 +35,105 @@ module Warren
 
     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)
-        hash[key.to_sym] = value
+        # 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 params
+    #
+    def check_connection_details
       return true unless Warren::Queue.adapter.respond_to?(:check_connection_details)
-      Warren::Queue.adapter.send(:check_connection_details, params)
+      Warren::Queue.adapter.send(:check_connection_details, @opts)
     end
 
   end

data/readme.rdoc

@@ -27,10 +27,18 @@ Add this to your environment.rb
 
     config.gem "brightbox-warren", :lib => "warren", :version => ">= 0.8"
 
+Add the config into config/warren.yml with the details for each environment. Works just the same as database.yml:
+
+    development:
+        user: rabbit
+        pass: carrots53
+        host: rabbit.warren
+        logging: false
+
 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.
+Licensed under the MIT license. See LICENSE for more details.

data/spec/spec_helper.rb

@@ -1 +1,12 @@
 require File.join(File.dirname(__FILE__) + "/../lib/warren")
+
+# Hacky and I hate it, but needed to 
+# change constants in tests
+# from http://is.gd/12JVp
+def silently(&block)
+  warn_level = $VERBOSE
+  $VERBOSE = nil
+  result = block.call
+  $VERBOSE = warn_level
+  result
+end

data/spec/warren/connection_spec.rb

@@ -1,67 +1,100 @@
 require File.dirname(__FILE__) + '/../spec_helper'
 
 describe Warren::Connection do
-  
+
   before(:each) do
-    @file = stub 'io', :read => yaml_data
     setup_adapter
   end
-    
-  it "should read from a config file" do
-    YAML.should_receive(:load).with("#{File.dirname($0)}/config/warren.yml").and_return({"development" => {}})
+
+  it "should read from warren.yml" do
+    setup_config_file
 
     Warren::Connection.new
   end
 
-  it "should parse the right config out" do    
-    conn = Warren::Connection.new(@file)
-    conn.instance_variable_get("@opts").should == {
-      :host    => "localhost",
-      :user    => "rspec",
-      :pass    => "password",
-      :logging => false
-    }
-  end
-  
-  it "should symbolize keys in a hash" do
-    conn = Warren::Connection.new(@file)
-    hash = {"one" => "two", "three" => "four", :five => "six"}
-    conn.send(:symbolize_keys, hash).should == {
-      :one   => "two",
-      :three => "four",
-      :five  => "six"
-    }
-  end
-  
-  it "should raise if no adapter set to check against" do
-    Warren::Queue.adapter = nil
-    lambda {
-      Warren::Connection.new(@file)
-    }.should raise_error(Warren::Queue::NoAdapterSet)
-  end
-  
-  it "should successfully check against adapter" do
-    _adapter = stub 'queue', :check_connection_details => true
-    
-    Warren::Connection.new(@file)
+  it "should read from an arbitrary file" do
+    File.should_receive(:exists?).with("my_awesome_config.yml").and_return(true)
+    YAML.should_receive(:load_file).with("my_awesome_config.yml").and_return({"development" => {}})
+
+    Warren::Connection.new("my_awesome_config.yml")
   end
-  
-  it "should raise errors for missing connection details" do
-    _adapter = stub 'queue', :check_connection_details => ["one", "two"]
+
+  describe "parsing config with file" do
+
+    before do
+      setup_config_file
+    end
+
+    it "should parse the right config out" do
+      conn = Warren::Connection.new
+      WARREN_ENV.should == "development"
+      conn.instance_variable_get("@options").should == {
+        :user => "rspec",
+        :pass => "password",
+        :host => "localhost",
+        :logging => false,
+      }
+    end
     
-    Warren::Connection.new(@file)
-  end
-  
-  it "should raise errors for other prerequisits in the adapter" do
-    Adapter = Class.new(Warren::Queue) do
-      def self.check_connection_details params
-        raise Warren::Connection::InvalidConnectionDetails, "Missing prerequisites"
+    it "should raise if no details for current environment" do
+      silently { WARREN_ENV = "rspec" }
+      
+      lambda { Warren::Connection.new }.
+      should raise_error(
+        Warren::Connection::InvalidConnectionDetails,
+        "No details for current environment 'rspec'"
+      )
+      
+      silently { WARREN_ENV = "development" }
+    end
+
+    it "should symbolize keys in a hash" do
+      conn = Warren::Connection.new
+      hash = {"one" => "two", "three" => {"four" => 7}, :five => "six"}
+      conn.send(:symbolize_keys, hash).should == {
+        :one   => "two",
+        :three => {:four => 7},
+        :five  => "six"
+      }
+    end
+
+    it "should raise if no adapter set to check against" do
+      Warren::Queue.adapter = nil
+      lambda { Warren::Connection.new }.
+      should raise_error(Warren::Queue::NoAdapterSet)
+    end
+
+    it "should successfully check against adapter" do
+      _adapter = mock 'queue', :check_connection_details => true
+      _adapter.should_receive(:check_connection_details)
+      Warren::Queue.adapter = _adapter
+      
+      Warren::Connection.new
+    end
+
+    it "should raise errors for missing connection details" do
+      _adapter = stub 'queue', :check_connection_details => ["one", "two"]
+
+      Warren::Connection.new
+    end
+
+    it "should raise errors for other prerequisits in the adapter" do
+      Adapter = Class.new(Warren::Queue) do
+        def self.check_connection_details params
+          raise Warren::Connection::InvalidConnectionDetails, "Missing prerequisites"
+        end
       end
+
+      lambda { Warren::Connection.new }.
+      should raise_error(Warren::Connection::InvalidConnectionDetails, "Missing prerequisites")
     end
 
-    lambda {
-      Warren::Connection.new(@file)
-    }.should raise_error(Warren::Connection::InvalidConnectionDetails, "Missing prerequisites")
+  end
+
+  def setup_config_file
+    config_file = "#{File.dirname($0)}/config/warren.yml"
+    File.should_receive(:exists?).with(config_file).and_return(true)
+    YAML.should_receive(:load_file).with(config_file).and_return(yaml_data)
   end
 
   def setup_adapter
@@ -70,20 +103,20 @@ describe Warren::Connection do
   end
 
   def yaml_data
-    a = <<-EOF
----
-development:
-  host: localhost
-  user: rspec
-  pass: password
-  logging: false
-
-test:
-  host: localhost
-  user: rspec
-  pass: password
-  logging: true
-EOF
+    {
+      "development" => {
+        "host" => "localhost",
+        "user" => "rspec",
+        "pass" => "password",
+        "logging" => false
+      },
+      "test" => {
+        "host" => "localhost-test",
+        "user" => "rspec-test",
+        "pass" => "password-test",
+        "logging" => true
+      }
+    }
   end
 
 end

data/warren.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{warren}
-  s.version = "0.8"
+  s.version = "0.8.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-06-12}
+  s.date = %q{2009-06-15}
   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/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/queue.rb", "lib/warren.rb", "LICENSE", "tasks/rdoc.rake", "tasks/rspec.rake"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: brightbox-warren
 version: !ruby/object:Gem::Version 
-  version: "0.8"
+  version: 0.8.2
 platform: ruby
 authors: 
 - Caius Durling, David Smalley
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-06-12 00:00:00 -07:00
+date: 2009-06-15 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency