ragnar 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in ragnar.gemspec
+gemspec

data/README.md

@@ -0,0 +1,61 @@
+Ragnar is a client library that aims to provide some top-level helpers for creating AMQP pub/sub code that can be used across many services nodes without having to do a ton of connection/channel handling. This is very much a work in progress, so bear with it.
+
+### Connections ###
+
+Ragnar provides a convenience connector to run EventMachine and setup the AMQP connection. For **Unicorn**, place the connector call inside the `after_fork` block in order to get things going:
+
+    after_fork do |server, worker|
+      Ragnar::Connector.connect :host => 'localhost', :port => 5732
+    end
+
+### Publishing ###
+
+The following code will publish a message to the 'events' exchange under the routing key 'the.event.name'.
+
+    Ragnar.exchange(:topic, 'events') do |x|
+      x.publish('the.event.name', 'this is the message')
+    end
+
+And the equivalent AMQP code:
+
+    AMQP.start do |connection, connect_ok|
+      channel  = AMQP::Channel.new(connection)
+      exchange = channel.topic('events', :auto_delete => false)
+      exchange.publish('this is the message', :routing_key => 'the.event.name')
+    end
+
+
+### Subscriptions ###
+
+The following code with Ragnar creates a single topic subscription on the 'events' exchange, using the queue 'myservice.the.event.name' and routing key 'the.event.name'.
+
+    Ragnar.exchange(:topic, 'events') do |x|
+      x.queue_prefix = :myservice # optional
+      x.subscribe('the.event.name') do |message|
+        # subscription code
+      end
+    end
+    
+The equivalent AMQP code for the code above would be:
+
+    AMQP.start do |connection|
+      channel  = AMQP::Channel.new(connection)
+      exchange = channel.topic('events', :auto_delete => false)
+      channel.queue('myservice.the.event.name').bind(exchange, :routing_key => 'the.event.name').subscribe do |headers, payload|
+        # subscription code
+      end
+    end
+
+### Feedback ###
+
+Feedback and comments are welcome:
+
+* Web: [rand9.com][web]
+* Twitter: [@localshred][twitter]
+* Github: [github][]
+
+Cheers
+
+  [web]: http://www.rand9.com "rand9.com"
+  [twitter]: http://twitter.com/localshred "Twitter: @localshred"
+  [github]: http://github.com/localshred "Github: localshred"

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/lib/ragnar.rb

@@ -0,0 +1,28 @@
+require 'ragnar/connector'
+require 'ragnar/exchange'
+
+module Ragnar
+  
+  module_function
+  
+  def exchange type, name, options={}
+    exch = exchanges[key(type, name)] || store(Ragnar::Exchange.new(type, name, options))
+    yield(exch) if block_given?
+    exch
+  end
+
+  def store ex
+    exchanges[key(ex.type, ex.name)] = ex
+  end
+
+  def exchanges
+    @exchanges ||= {}
+  end
+  
+  def key type, name
+    '%s-%s' % [type.to_s, name]
+  end
+  
+  private :store, :exchanges, :key
+  
+end

data/lib/ragnar/connector.rb

@@ -0,0 +1,28 @@
+require 'amqp'
+
+# Provide a simple connector piece that runs EM and passes through AMQP connection options
+module Ragnar
+  class Connector
+    
+    class << self
+      
+      # Store the connection for later retrieval
+      attr_accessor :connection
+      
+      # Pass connection options through to AMQP
+      def connect opts={}
+        unless EM.reactor_running?
+          Thread.new { EventMachine.run }
+          sleep 0.5
+        end
+        @connection = AMQP.connect(opts)
+      end
+      
+      def connected?
+        @connection && @connection.connected?
+      end
+    
+    end
+    
+  end
+end

data/lib/ragnar/exchange.rb

@@ -0,0 +1,28 @@
+module Ragnar
+  class Exchange
+    
+    attr_reader :exchange, :channel, :type, :name, :options
+    attr_accessor :queue_prefix
+    
+    def initialize type, name, opts={}
+      @type, @name, @options = type, name, opts
+      @channel = AMQP::Channel.new(Ragnar::Connector.connection)
+      @exchange = @channel.__send__(@type, @name, @options)
+    end
+    
+    def publish routing_key, message, opts={}
+      @exchange.publish(message, opts.merge(:routing_key => routing_key))
+    end
+    
+    def subscribe name, opts={}, &block
+      @channel.queue(queue_name(name)).bind(@exchange, :routing_key => name).subscribe(opts, &block)
+    end
+    
+    private
+    
+    def queue_name name
+      queue_prefix.nil? ? name : '%s.%s' % [queue_prefix, name]
+    end
+    
+  end
+end

data/lib/ragnar/version.rb

@@ -0,0 +1,3 @@
+module Ragnar
+  VERSION = "0.0.1"
+end

data/ragnar.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "ragnar/version"
+
+Gem::Specification.new do |s|
+  s.name        = "ragnar"
+  s.version     = Ragnar::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["BJ Neislen"]
+  s.email       = ["bj.neilsen@gmail.com"]
+  s.homepage    = "http://www.rand9.com"
+  s.summary     = %q{Provide top-level pub/sub methods with RabbitMQ (AMQP) for interacting with a larger service ecosystem}
+  s.description = %q{Provide top-level pub/sub methods with RabbitMQ (AMQP) for interacting with a larger service ecosystem}
+
+  s.rubyforge_project = "ragnar"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  s.add_dependency 'amqp', '~>0.7.1'
+  s.add_development_dependency 'rspec', '~>2.5.0'
+  s.add_development_dependency 'evented-spec', '~>0.4.1'
+end

data/spec/lib/ragnar/connector_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+require 'ragnar/connector'
+
+describe Ragnar::Connector do
+  include EventedSpec::SpecHelper
+  include EventedSpec::AMQPSpec
+  
+  before(:each) do
+    Ragnar::Connector.connection = nil
+  end
+  
+  describe '.connect' do
+    
+    it 'runs eventmachine and creates an AMQP connection' do
+      connection = Ragnar::Connector.connect
+      delayed(0.3) {
+        EM.reactor_running?.should be_true
+        connection.should be_connected
+        done
+      }
+    end
+    
+    it 'accepts an options hash and passes it through' do
+      opts = {:host => 'localhost', :port => '5762'}
+      AMQP.should_receive(:connect).with(opts)
+      Ragnar::Connector.connect(opts)
+      done
+    end
+    
+    it 'uses the existing reactor if it already exists' do
+      em do
+        EM.should_not_receive(:run)
+        Ragnar::Connector.connect
+        done
+      end
+    end
+    
+  end
+  
+  describe '.connection' do
+    
+    it 'stores the connection' do
+      Ragnar::Connector.connect
+      delayed(0.3) {
+        Ragnar::Connector.connection.should be_connected
+        done
+      }
+    end
+    
+    it 'does not create the connection for you' do
+      AMQP.should_not_receive(:connect)
+      Ragnar::Connector.connection.should be_nil
+      done
+    end
+    
+  end
+  
+  describe '.connected?' do
+    it 'relays connection state' do
+      Ragnar::Connector.connected?.should be_false
+      Ragnar::Connector.connect
+      delayed(0.3) {
+        Ragnar::Connector.connected?.should be_true
+        done
+      }
+    end
+  end
+  
+end

data/spec/lib/ragnar/exchange_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+require 'ragnar/connector'
+require 'ragnar/exchange'
+
+describe Ragnar::Exchange do
+  include EventedSpec::SpecHelper
+  include EventedSpec::AMQPSpec
+  
+  describe '.new' do
+    it 'creates a channel and exchange' do
+      opts = {:durable => true}
+      name = 'exch_name'
+      
+      Ragnar::Connector.should_receive(:connection).and_return(connection = mock('connection'))
+      AMQP::Channel.should_receive(:new).with(connection).and_return(channel = mock('channel'))
+      channel.should_receive(:topic).with(name, opts)
+      Ragnar::Exchange.new(:topic, name, opts)
+      done
+    end
+  end
+  
+  describe '#queue_prefix' do
+    it 'sets a temporary queue prefix' do
+      exch = Ragnar::Exchange.new(:topic, 'name')
+      exch.queue_prefix = :my_service
+      exch.queue_prefix.should == :my_service
+      done
+    end
+  end
+  
+  describe '#subscribe' do
+    it 'binds a queue to the channel and assigns the subscription to the queue' do
+      exch = Ragnar::Exchange.new(:topic, 'name')
+      subscription = Proc.new {|message| true }
+      exch.channel.should_receive(:queue).with('the.event.name').and_return(queue = mock('queue'))
+      queue.should_receive(:bind).with(exch.exchange, :routing_key => 'the.event.name').and_return(binding = mock('binding'))
+      binding.should_receive(:subscribe).with(subscription)
+      exch.subscribe('the.event.name', subscription)
+      done
+    end
+    
+    it 'uses the queue_prefix if present when setting the queue name' do
+      exch = Ragnar::Exchange.new(:topic, 'name')
+      exch.queue_prefix = :my_service
+      exch.channel.should_receive(:queue).with('my_service.the.event.name').and_return(queue = mock('queue'))
+      queue.should_receive(:bind).with(exch.exchange, :routing_key => 'the.event.name').and_return(binding = mock('binding'))
+      binding.should_receive(:subscribe)
+      exch.subscribe('the.event.name')
+      done
+    end
+  end
+  
+  describe '#publish' do
+    it 'publishes messages to the exchange' do
+      exch = Ragnar::Exchange.new(:topic, 'name')
+      publish_opts = {:param => 'value', :routing_key => 'the.event.name'}
+      exch.exchange.should_receive(:publish).with('the message', publish_opts)
+      exch.publish('the.event.name', 'the message', publish_opts)
+      done
+    end
+  end
+  
+end

data/spec/lib/ragnar_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+require 'ragnar'
+
+describe Ragnar do
+  include EventedSpec::SpecHelper
+  include EventedSpec::AMQPSpec
+  
+  describe '.exchange' do
+    context 'when the exchange does not exist' do
+      it 'creates a new exchange' do
+        opts = {:param => 'value'}
+        Ragnar::Exchange.should_receive(:new).with(:topic, 'exch_name', opts).and_return(mock('ex', :type => :topic, :name => 'exch_name'))
+        Ragnar.exchange(:topic, 'exch_name', opts)
+        done
+      end
+    end
+    
+    context 'when the exchange already has been created locally' do
+      it 'uses the existing exchange' do
+        exch = Ragnar.exchange(:topic, 'exch_name')
+        Ragnar.exchange(:topic, 'exch_name').should === exch
+        done
+      end
+    end
+    
+    context 'when passed a block with embedded subscriptions' do
+      it 'registers the subscriptions with the exchange' do
+        subscriber = Proc.new{|message| true }
+        exchange = Ragnar::Exchange.new(:topic, 'events')
+        Ragnar.should_receive(:store).and_return(exchange)
+        
+        exchange.should_receive(:queue_prefix=).with(:my_service)
+        exchange.should_receive(:subscribe).with('the.message.route.1', subscriber)
+        exchange.should_receive(:subscribe).with('the.message.route.2', subscriber)
+        exchange.should_receive(:subscribe).with('the.message.route.3', subscriber)
+        exchange.should_receive(:subscribe).with('the.message.route.4', subscriber)
+        
+        Ragnar.exchange(:topic, 'events') do |x|
+          x.queue_prefix = :my_service
+          x.subscribe('the.message.route.1', subscriber)
+          x.subscribe('the.message.route.2', subscriber)
+          x.subscribe('the.message.route.3', subscriber)
+          x.subscribe('the.message.route.4', subscriber)
+        end
+        
+        done
+      end
+    end
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'rspec'
+require 'evented-spec'
+
+$: << File.expand_path('../lib', File.dirname(__FILE__))

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification 
+name: ragnar
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- BJ Neislen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-05 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: amqp
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 7
+        - 1
+        version: 0.7.1
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 5
+        - 0
+        version: 2.5.0
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: evented-spec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 4
+        - 1
+        version: 0.4.1
+  type: :development
+  version_requirements: *id003
+description: Provide top-level pub/sub methods with RabbitMQ (AMQP) for interacting with a larger service ecosystem
+email: 
+- bj.neilsen@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- lib/ragnar.rb
+- lib/ragnar/connector.rb
+- lib/ragnar/exchange.rb
+- lib/ragnar/version.rb
+- ragnar.gemspec
+- spec/lib/ragnar/connector_spec.rb
+- spec/lib/ragnar/exchange_spec.rb
+- spec/lib/ragnar_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://www.rand9.com
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: ragnar
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Provide top-level pub/sub methods with RabbitMQ (AMQP) for interacting with a larger service ecosystem
+test_files: 
+- spec/lib/ragnar/connector_spec.rb
+- spec/lib/ragnar/exchange_spec.rb
+- spec/lib/ragnar_spec.rb
+- spec/spec_helper.rb