stapfen 1.2.1 → 1.3.0

data/README.md

@@ -23,7 +23,8 @@ Consider the following `myworker.rb` file:
         ]}
       end
 
-      consume 'thequeue' do |message|
+      consume 'thequeue', :dead_letter_queue => '/queue/dlq',
+                          :max_redeliveries => 0 do |message|
         data = expensive_computation(message.body)
         persist(data)
       end
@@ -40,6 +41,12 @@ It is also important to note that the `consume` block will be invoked inside an
 **instance** of `MyWorker` and will execute inside its own `Thread`, so take
 care when accessing other shared resources.
 
+The consume block accepts the usual
+[Stomp::Client](https://github.com/stompgem/stomp) subscription headers, as well
+as :dead_letter_queue and :max\_redeliveries.  If either of the latter two is
+present, the consumer will unreceive any messages for which the block returns
+false; after :max\_redeliveries, it will send the message to :dead_letter_queue.
+`consume` blocks without these headers will fail silently rather than unreceive.
 
 ## Installation
 

data/lib/stapfen/version.rb

@@ -1,3 +1,3 @@
 module Stapfen
-  VERSION = '1.2.1'
+  VERSION = '1.3.0'
 end

data/lib/stapfen/worker.rb

@@ -85,6 +85,10 @@ module Stapfen
       debug("Running with #{@client} inside of Thread:#{Thread.current.object_id}")
 
       self.class.consumers.each do |name, headers, block|
+        unreceive_headers = {}
+        [:max_redeliveries, :dead_letter_queue].each do |sym|
+          unreceive_headers[sym] = headers.delete(sym) if headers.has_key? sym
+        end
 
         # We're taking each block and turning it into a method so that we can
         # use the instance scope instead of the blocks originally bound scope
@@ -93,7 +97,11 @@ module Stapfen
         self.class.send(:define_method, method_name, &block)
 
         client.subscribe(name, headers) do |message|
-          self.send(method_name, message)
+          success = self.send(method_name, message)
+
+          if !success && !unreceive_headers.empty?
+            client.unreceive(message, unreceive_headers)
+          end
         end
       end
 

data/spec/worker_spec.rb

@@ -43,7 +43,7 @@ describe Stapfen::Worker do
         let(:name) { 'jms.queue.lol' }
 
         it 'should add an entry for the queue name' do
-          worker.consume(name)  do
+          worker.consume(name) do |msg|
             nil
           end
 
@@ -52,6 +52,68 @@ describe Stapfen::Worker do
           entry.first.should eq(name)
         end
       end
+
+      context 'unreceive behavior' do
+        let(:client) { mock('Stomp::Client', :open? => false) }
+        let(:name) { '/queue/some_queue' }
+        before :each do
+          Stomp::Client.stub(:new).and_return(client)
+
+          # Get a subscription?  Call the message handler block.
+          client.stub(:subscribe) do |name, headers, &block|
+            block.call('msg')
+          end
+        end
+  
+        context 'with just a queue name' do
+          context 'on a failed message' do
+            it 'should not unreceive' do
+              client.should_receive(:unreceive).never
+    
+              worker.consume(name) {|msg| false }
+              worker.new.run
+            end
+          end
+          context 'on a successful message' do
+            it 'should not unreceive' do
+              client.should_receive(:unreceive).never
+    
+              worker.consume(name) {|msg| true }
+              worker.new.run
+            end
+          end
+        end
+  
+        context 'with a queue name and headers for a dead_letter_queue and max_redeliveries' do
+          let(:unrec_headers) do
+            { :dead_letter_queue => '/queue/foo',
+            :max_redeliveries => 3 }
+          end
+          let(:raw_headers) { unrec_headers.merge(:other_header => 'foo!') }
+          context 'on a failed message' do
+            it 'should unreceive' do
+              client.should_receive(:unreceive).once
+    
+              worker.consume(name, raw_headers) {|msg| false }
+              worker.new.run
+            end
+            it 'should pass :unreceive_headers through to the unreceive call' do
+              client.should_receive(:unreceive).with('msg', unrec_headers).once
+    
+              worker.consume(name, raw_headers) {|msg| false }
+              worker.new.run
+            end
+          end
+          context 'on a successfully handled message' do
+            it 'should not unreceive' do
+              client.should_receive(:unreceive).never
+    
+              worker.consume(name, raw_headers) {|msg| true }
+              worker.new.run
+            end
+          end
+        end
+      end
     end
   end
 

data/stapfen.gemspec

@@ -18,5 +18,5 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
 
 
-  gem.add_dependency('stomp', '>= 1.2.8')
+  gem.add_dependency('stomp', '>= 1.2.14') # 1.2.14 fixes Stomp::Client#unreceive behavior
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stapfen
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-28 00:00:00.000000000 Z
+date: 2013-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: stomp
@@ -18,7 +18,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.2.8
+        version: 1.2.14
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.2.8
+        version: 1.2.14
 description: A simple gem for writing good basic STOMP workers
 email:
 - rtyler.croy@lookout.com
@@ -63,7 +63,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3534259377773611788
+      hash: -2572111186363930880
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -72,7 +72,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3534259377773611788
+      hash: -2572111186363930880
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25