cwyckoff-rosetta_queue 0.3.0 → 0.3.3

data/History.txt

@@ -1,9 +1,32 @@
-== 0.1.x (git)
+== 0.2.x (git)
 
  === New features
+ === Bufixes
+
+== 0.2.0
+ === New features
+  * Synchronous AMQP adapter (Chris Wyckoff - Lead Media Partners)
+    * Uses celldee's synchronous AMQP client, 'Bunny'.
+  * Added .delete method to Consumer class (Chris Wyckoff - Lead Media Partners)
+    * Allows user to purge a queue.
+    * Works for AMQP adapters only.
+ === Bufixes
+  * client :ack now working. (Chris Wyckoff - Lead Media Partners)
+
+== 0.1.4
+
+ === New features
+  * Removed dependency on ActiveSupport and brought over needed String methods. (Derek and Matt - Greenview Data, Inc.)
+  * Safer shutdown in ThreadedManager (Rob Sanheim - Relevance)
+  * Beanstalk Adaper (David Brady - Lead Media Partners)
+    * Still needs some work to have it take advantage of beanstalk's subscribe functionality.
+  * Synchronous AMQP adapter
+    * Uses celldee's synchronous AMQP client, 'Bunny'.
+  * Added .delete method to Consumer class
+    * Allows user to purge a queue.
+    * Works for AMQP adapters only.
   * Beanstalk Adaper (David Brady)
     * Still needs some work to have it take advantage of beanstalk's subscribe funtionality.
- === Bufixes
 
 == 0.1.0 / 2008-01-28 - Initial Release
-RosettaQueue was realased in the wild! RQ's initial development was primarily sponsored by Alliance Health Networks (thanks!!).  The original authors were Chris Wyckoff and Ben Mabey.The initial release included adapters for stomp and amqp, in addition to a null and fake adapters for testing.
+RosettaQueue was realased in the wild! RQ's initial development was primarily sponsored by Alliance Health Networks (thanks!!).  The original authors were Chris Wyckoff and Ben Mabey. The initial release included adapters for stomp and amqp, in addition to a null and fake adapters for testing.

data/README.rdoc

@@ -2,155 +2,10 @@
 
 Rosetta Queue is a messaging gateway API with adapters for many messaging systems available in Ruby. Messaging systems can be easily switched out with a small configuration change. Code for testing on the object and application level is also provided.
 
-The adapters provided currently are for stomp, amqp, and beanstalk.  We would like to add adapters for other messaging gateways.  The stomp adapter has been used in production along side with Apache's ActiveMQ.  The amqp adapter currently works along side RabbitMQ and passes the acceptance tests but as of yet has not been used in production.
-
-
-== Quick Tutorial
-
-Note: The API will most likely change until we reach 1.0.  We will be moving to a more concise API (i.e. queue(:test_queue) << message, etc...)  We will also be changing how exceptions are handled.
-
-When using Rosetta Queue in an application you will need to configure the queues, adapters, and filters (optional).  These configurations should be placed in a file that gets loaded once when your program starts.  If you are using Rails then a good place for this is config/initializers/rosetta_queue.rb.
-
-
-To set up destinations for producing and consuming messages:
-
-RosettaQueue::Destinations.define do |queue|
-  queue.map :test_queue, '/queue/my_test_queue'
-end
-
-
-Defining your adapter:
-
-  RosettaQueue::Adapter.define do |a|
-    a.user = ""
-    a.password = ""
-    a.host = "localhost"
-    a.port = 61613
-    a.type = "stomp"
-  end
-
-
-Define a logger for Rosetta Queue to use.  The logger should be a standard ruby logger:
-
-  RosettaQueue.logger = Logger.new('/my_project/rosetta_queue.log')
-
-
-You can optionally set up filters that are applied to all messages that are sent and received.  For example, if you want to use hashes as messages and serialize them as JSON the following filters (along with ActiveSupport) would accomplish this:
-
-  RosettaQueue::Filters.define do |filter_for|
-    filter_for.receiving { |message| ActiveSupport::JSON.decode(message) }
-    filter_for.sending { |hash| hash.to_json }
-  end
-
-
-To publish a message:
-
-  message = {"hello" => "world!"}  # Assuming you have a filter setup
-  RosettaQueue::Producer.publish(:test_queue, message)
-
-When consuming messages from a queue you will generally want to create a consumer to handle the messages:
-
-  class TestConsumer
-    include RosettaQueue::MessageHandler
-
-    subscribes_to :vendor_status
-    options :persistent => true
-
-    def on_message(message)
-      puts "We consumed a message: #{message.inspect}"
-    end
-
-  end
-
-To fire the consumers up you will want to run a separate process create a manager with all of your consumers.
-
-  require 'rosetta_queue'
-  require 'rosetta_queue/consumer_managers/threaded'
-  require 'test_consumer'
-
-  RosettaQueue::ThreadedManager.create do |m|
-    m.add(TestConsumer.new)
-    m.start
-  end
-
-
-It is recommended that you set your adapter to the 'null' adapter for your specs and then include RosettaQueue::Matchers in any example group you are needing to specify behaviour with RosettaQueue.  The matchers currently switch out the null adapter for the fake adapter to verify the behaviour.  All the matchers for the unit tests are lambda based, like so:
-
-  lambda { model.save }.should publish("foo", :to => :test_queue).
-
-Please look at the publishing matchers for more information.  For examples on how to write acceptance tests for your Rosetta Queue's code please see RosettaQueue's own Cucumber features and read this {blog post}[http://www.benmabey.com/2009/02/17/using-cucumber-to-integrate-distributed-systems-and-test-messaging/].
-
-
-=== AMQP
-
-The AMQP adapter is based on the synchronous AMQP ruby client "Bunny" by celldee [http://github.com/celldee/bunny].  The original AMQP adapter for RosettaQueue was the 'evented' client by Aman Gupta [http://github.com/tmm1/amqp], but the evented model posed some problems for our integration tests.  That, and the desire to keep things simple led us to use a synchronous AMQP client.
-
-==== Configuration
-
-If you are using the AMQP adapter, there are some important rules when defining the adapter and mapping your destinations.  Two of the basic building blocks of AMQP are queues and exchanges.  Queues bind to exchanges in several different ways.  A can queue bind to an exchange and requests messages that match a specific routing key, which is called 'direct exchange' and is analogous to the 'point-to-point' messaging pattern.  Alternately, queues can bind to an exchange to receive all messages sent to that exchange; this is called 'fanout exchange' and is analogous to the 'publish-subscribe' pattern.  So, when you want to define a simple 'direct-exchange' queue, your queue name must begin with the term "queue".
-
-   RosettaQueue::Destinations.define do |queue|
-     queue.map :test_queue, 'queue.my_test_queue'
-   end
-
-And, when you want to define a queue that will bind to a 'fanout-exchange', your queue name must begin with the term "fanout".
-
-   RosettaQueue::Destinations.define do |queue|
-     queue.map :test_queue, 'fanout.my_test_queue'
-   end
-
-Oh, and when defining your adapter, be sure to specify the AMQP adapter as :amqp_synch, not :amqp.  This way, if we do get around to adding Aman's evented AMQP client, we can distinguish between the synchronous and asynchronous clients (i.e., :amqp_sync vs. :amqp_asynch).
-
-
-== How to contribute
-----------------------------------------------------------------
-Gems you will need:
-cucumber, rspec, yaml, stomp, bunny, beanstalk-client
-
-You should be able to run the rspec code examples (specs) without any brokers running with autospec or 'rake spec'.
-
-To run the cucumber features you will need the a messaging system setup that can speak stomp and AMQP.  We have been using the following brokers in testing:
-
-=== Apache ActiveMQ (for the stomp adapter)
-Go to http://activemq.apache.org/download.html to download the latest version, and see http://activemq.apache.org/getting-started.html for installation and configuration instructions.
-The stomp client and features should work with ApacheMQ out of the box.  If you are running any ApacheMQ servers in production on your network you will want to disable the multicast autodiscovery in conf/activemq.xml.  (Around lines 56 and 98.)
-
-=== RabbitMQ (for the amqp adapter)
-Download the right tar from here: http://www.rabbitmq.com/download.html and follow the installation directions that comes with it.
-The features rely on a user of 'rosetta' being setup with the password of 'password' and added to the default virtualhost. You can set them up like so:
-
-  rabbitmqctl add_user rosetta password
-  rabbitmqctl map_user_vhost rosetta /
-
-=== Beanstalk (for the beanstalk adapter) ===
-
-You should set up and run a local instance of beanstalk for your
-tests.
-
-==== beanstalkd ====
-
-Mac OSX users can install beanstalkd from ports. Linux users should
-check their package manager of choice. This is probably the optimal
-method.
-
-Diehards can clone git://github.com/kr/beanstalkd and build it from
-source. It is nontrivial.
-
-Once installed, you can launch beanstalk by running
-
-  beanstalkd -p 11300
-
-This will make it listen on localhost on the standard port 11300,
-which the specs use. You might also want to daemonize beanstalk with
-the -d option but for testing this is not recommended, as the queue
-can get stuck with old messages, which will break your specs.
-
-==== beanstalk-client ====
-
-You will also need the Ruby beanstalk-client gem.
-
-  sudo gem install beanstalk-client
-
+Documentation can be found on the wiki.[http://wiki.github.com/bmabey/rosetta_queue]
 
+== Authors
 
+Ben Mabey [http://github.com/bmabey]
 
+Chris Wyckoff [http://github.com/cwyckoff]

data/Rakefile

@@ -28,3 +28,6 @@ begin
 rescue LoadError
   puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
 end
+
+desc "Default task runs specs"
+task :default => [:spec]

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :major: 0
-:minor: 1
-:patch: 2
+:minor: 2
+:patch: 0

data/cucumber.yml

@@ -1 +1 @@
-default: features --format pretty
+default: features --format pretty --require features

data/examples/sample_amqp_consumer.rb

@@ -0,0 +1,45 @@
+require 'rubygems'
+require File.dirname(__FILE__) + '/../init.rb'
+require File.expand_path(File.dirname(__FILE__) + '/../lib/rosetta_queue/consumer_managers/threaded')
+RosettaQueue.logger = Logger.new(File.expand_path(File.dirname(__FILE__) + '/../../log/rosetta_queue.log'))
+
+module RosettaQueue
+
+  Adapter.define do |a|
+    a.user      = "rosetta"
+    a.password  = "password"
+    a.host      = "localhost"
+    a.type      = 'amqp_synch'
+  end
+
+  Destinations.define do |dest|
+    dest.map :foo, "queue.foo"
+  end  
+
+  class MessageHandlerFoo
+    include RosettaQueue::MessageHandler
+    subscribes_to :foo
+    options :ack => true
+    attr_reader :msg
+
+    def on_message(msg)
+      puts "FOO received message: #{msg}"
+    end
+
+  end
+
+#   consumer = RosettaQueue::Consumer.new(MessageHandlerFoo.new)
+# #  Thread.new(consumer) do |cons|
+#     consumer.receive
+# #  end 
+#   puts "sleeping for 10"
+#   sleep 10
+#   puts "shutting consumer down"
+#  consumer.disconnect
+
+  ThreadedManager.create do |m|
+    m.add MessageHandlerFoo.new
+    m.start
+  end 
+
+end

data/examples/sample_amqp_fanout_consumer.rb

@@ -0,0 +1,52 @@
+require 'rubygems'
+require File.dirname(__FILE__) + '/../init.rb'
+require File.expand_path(File.dirname(__FILE__) + '/../lib/rosetta_queue/consumer_managers/threaded.rb')
+RosettaQueue.logger = Logger.new(File.expand_path(File.dirname(__FILE__) + '/../../log/rosetta_queue.log'))
+
+module RosettaQueue
+
+  Adapter.define do |a|
+    a.user      = "rosetta"
+    a.password  = "password"
+    a.host      = "localhost"
+    a.type      = 'amqp_synch'
+  end
+
+  Destinations.define do |dest|
+    dest.map :foo, "fanout.foo"
+  end  
+
+  class MessageHandlerFoo
+    include RosettaQueue::MessageHandler
+    subscribes_to :foo
+    options :ack => true
+    attr_reader :msg
+
+    def on_message(msg)
+      puts "FOO received message:  #{msg}"
+      ack
+    end
+
+  end
+
+  class MessageHandlerBar
+    include RosettaQueue::MessageHandler
+    subscribes_to :foo
+    options :ack => true
+    attr_reader :msg
+
+    def on_message(msg)
+      puts "BAR received message:  #{msg}"
+      ack
+    end
+  end
+
+
+  # threaded version
+  ThreadedManager.create do |m|
+    m.add MessageHandlerFoo.new
+    m.add MessageHandlerBar.new
+    m.start
+  end 
+
+end

data/examples/sample_amqp_fanout_producer.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require File.dirname(__FILE__) + '/../init.rb'
+RosettaQueue.logger = Logger.new(File.expand_path(File.dirname(__FILE__) + '/../../log/rosetta_queue.log'))
+
+RosettaQueue::Adapter.define do |a|
+  a.user      = "rosetta"
+  a.password  = "password"
+  a.host      = "localhost"
+  a.type      = "amqp_synch"
+end
+
+RosettaQueue::Destinations.define do |dest|
+  dest.map :foo, "fanout.foo"
+end  
+
+
+RosettaQueue::Producer.publish(:foo, "hello there")
+

data/examples/sample_amqp_producer.rb

@@ -0,0 +1,16 @@
+require 'rubygems'
+require File.dirname(__FILE__) + '/../init.rb'
+RosettaQueue.logger = Logger.new(File.expand_path(File.dirname(__FILE__) + '/../../log/rosetta_queue.log'))
+
+RosettaQueue::Adapter.define do |a|
+  a.user      = "rosetta"
+  a.password  = "password"
+  a.host      = "localhost"
+  a.type      = "amqp_synch"
+end
+
+RosettaQueue::Destinations.define do |dest|
+  dest.map :foo, "queue.foo"
+end  
+
+RosettaQueue::Producer.publish(:foo, "hello there")

data/features/filtering.feature

@@ -0,0 +1,31 @@
+Feature: Message Filtering
+  In order to save time and prevent lots of typing
+  As a RosettaQueue user
+  I want to be able to define filters for processing all of my messages
+
+
+  Scenario Outline: receiving filter
+    Given RosettaQueue is configured for '<Adapter>'
+    And a destination is set with queue '<Queue>' and queue address '<QueueAddress>'
+    And a receiving filter is defined to prepend 'Foo' to all messages
+    And the message 'Hello World' is published to queue '<Queue>'
+    When the message on '<Queue>' is consumed
+    Then the consumed message should equal "Foo Hello World"
+
+    Examples:
+    | Adapter		| Queue    |  QueueAddress	|
+    | amqp_synch	| foo  	   |  queue.foo		|
+#    | stomp 		| foo  	   |  queue/foo		|
+  
+  Scenario Outline: sending filter
+    Given RosettaQueue is configured for '<Adapter>'
+    And a destination is set with queue '<Queue>' and queue address '<QueueAddress>'
+    And a sending filter is defined to prepend 'Foo' to all messages
+    And the message 'Hello World' is published to queue '<Queue>'
+    When the message on '<Queue>' is consumed
+    Then the consumed message should equal "Foo Hello World"
+
+    Examples:
+    | Adapter		| Queue    |  QueueAddress	|
+    | amqp_synch 	| foo  	   |  queue.foo		|
+#    | stomp 		| foo  	   |  queue/foo		|

data/features/messaging.feature

@@ -0,0 +1,47 @@
+Story: Producing and Consuming
+
+  As a RosettaQueue user
+  I want to publish and consume point-to-point using various messaging protocols
+  So that I can reliably integrate my systems with a message broker
+
+  Background:
+    Given consumer logs have been cleared
+
+  Scenario Outline: Point-to-Point
+    Given RosettaQueue is configured for '<Adapter>'
+    And a destination is set with queue '<Queue>' and queue address '<QueueAddress>'
+    And a consumer is listening to queue '<Queue>'
+    When a message is published to '<Queue>'
+    Then the message should be consumed from '<Queue>'
+
+    Examples:
+    | Adapter		| Queue    |  QueueAddress	|
+    | amqp_synch	| foo      |  queue.foo		|
+    | amqp_evented	| bar      |  queue.bar		|
+#    | stomp		| baz      |  /queue/baz  	|
+#    | beanstalk	| baz      |  baz  		|
+
+  Scenario Outline: Delete queue
+    Given RosettaQueue is configured for '<Adapter>'
+    And a destination is set with queue '<Queue>' and queue address '<QueueAddress>'
+    When a message is published to '<Queue>'
+    And the queue '<Queue>' is deleted
+    Then the queue '<Queue>' should no longer exist
+
+    Examples:
+    | Adapter	  | Queue    |  QueueAddress	|
+    | amqp_synch  | foo      |  queue.foo 	|
+
+
+  Scenario Outline: Publish-Subscribe
+    Given RosettaQueue is configured for '<Adapter>'
+    And a destination is set with queue '<Queue>' and queue address '<QueueAddress>'
+    And multiple consumers are listening to queue '<Queue>'
+    When a message is published to '<Queue>'
+    Then multiple messages should be consumed from '<Queue>'
+
+    Examples:
+   | Adapter	  | QueueAddress  | Queue	|
+   | amqp_synch   | fanout.baz 	  | baz		|
+#    | amqp_evented | queue.foo 	  | foo		|
+#    | stomp        | topic/foo     | bar 	|

data/features/step_definitions/common_messaging_steps.rb

@@ -0,0 +1,82 @@
+def eval_consumer_class(queue, log_file="point-to-point.log", klass_name=nil)
+  klass_name = "#{queue.to_s.capitalize}Consumer" if klass_name.nil?
+  return if Object.const_defined?(klass_name)
+  options = {}
+  unless @adapter_type == "stomp"
+    options = ":ack => true"
+  else 
+    options = ":ack => 'client'"
+  end 
+
+  str = <<-EOC
+    class #{klass_name}
+      include RosettaQueue::MessageHandler
+      subscribes_to :#{queue}
+      options #{options}
+    
+      def on_message(msg)
+        begin
+          file_path = "#{CONSUMER_LOG_DIR}/#{log_file}"
+          File.open(file_path, "w+") do |f|
+            f << msg + " from #{klass_name}"
+          end 
+        rescue Exception => e
+          puts e.message
+        end 
+      end
+    end
+  EOC
+
+  eval(str)
+  Object.const_get(klass_name)
+end 
+
+Given /^consumer logs have been cleared$/ do
+    %w[point-to-point pub-sub fooconsumer barconsumer].each do |file_name|
+      file_path = "#{CONSUMER_LOG_DIR}/#{file_name}.log"
+      File.delete(file_path) if File.exists?(file_path)
+      File.open(file_path, "a+")
+    end 
+end
+
+Given /^RosettaQueue is configured for '(\w+)'$/ do |adapter_type|
+  @adapter_type = adapter_type
+  RosettaQueue::Adapter.define do |a|
+    a.user      = "rosetta"
+    a.password  = "password"
+    a.host      = "localhost"
+    a.type      = @adapter_type
+    a.port      = case @adapter_type
+                    when /stomp/
+                    "61613"
+                    when /beanstalk/
+                    "11300"
+                    else
+                    nil
+                    end
+  end
+end
+
+Given /^a destination is set with queue '(.*)' and queue address '(.*)'$/ do |key, queue|
+  RosettaQueue::Destinations.define do |dest|
+    dest.map key.to_sym, queue
+  end  
+end
+
+Given /^the message '(.+)' is published to queue '(.+)'$/ do |message, queue_name|
+  publish_message(message, {:to => queue_name})
+end
+
+When /^a message is published to '(\w+)'$/ do |q|
+  RosettaQueue::Producer.publish(q.to_sym, "Hello World!")
+#  publish_message("Hello World!", {:options => {:to => q}})
+end
+
+When /^the queue '(.*)' is deleted$/ do |queue|
+  system("rabbitmqctl list_queues | grep #{queue}").should be_true
+  RosettaQueue::Consumer.delete(queue.to_sym)
+end
+
+Then /^the queue '(.*)' should no longer exist$/ do |queue|
+  system("rabbitmqctl list_queues | grep #{queue}").should be_false
+end