stapfen 2.0.2 → 2.1.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZmQzNmFhNTgxODI5ZTM1ZTQ4NTJkYzg4NTRhNmY5N2ZlOGZjMWM4OQ==
+    YWZmOWJmNmUzNmU2MDA1MmUzZDJhOGM5ZmRlMDMwOGZjMmU5YWM4MA==
   data.tar.gz: !binary |-
-    OTQ0OGI2NjE5MmY3ZDAyMzU0Yzc2M2IyYjljNGE0NDNjYjUzMTkzYg==
+    NGM4ODgxMTUwMjFhZTQyYTE3ZjgxODgzOThlMDYzYjcxN2JjMGUyMg==
 SHA512:
   metadata.gz: !binary |-
-    N2U5NDc0Y2UxOGNkZjY1NDcxMzg2ZDM5ZTg5NjMyZDY2YjkxYmFlMmZlNzQw
-    MDA1OThiOTYxZDBiZDU3N2MyY2FhZWEzMGQxYTQ4NTY1NzE1OWJiMGQxZTg4
-    ZDU1ODUyZTI4ZmEwMTE4MzIyOTg4ZjcwMDZmMTIxZTJhMGU2OGQ=
+    ZTU4OTgyZmFkY2EyZTAwYmEyNDQxMWI3NjhkOTNiNTA0MGIwOWM2ZDM5NzY3
+    NTQ4ZDVlYTAxYWM1YWJjOTQxYzIwNWI1Zjk4OGFjN2ZlN2QwMTAxZGEzYzMz
+    M2YwNDdiMWQwODkzMmEyOWMwM2M3OTQyMDVkNzEyNDY1NDZjOWE=
   data.tar.gz: !binary |-
-    ODg5Y2EzMjBmNDY5MjI3NmI5Mzg0N2VlMjIyNDk5MGFkNzg0ZTVmMzk1MTEy
-    ZDI3MjRmNTgxNjFiMmU1NWI3NmQ0YjkzODQ4MWRiN2ViYjczNzdmNGU2ZmIy
-    NjEyYTZlZmJlODhmZTJlNDMyOTE0NDE2NTQ4MTdjZWJkY2U0MzA=
+    NjNhOTRiNjcwMWY4YjRkNThhOWJkYzM4ZTZmZDAzNTA5NjQ4YmQzOGEzYjJl
+    YmJiMGE4MDZmMGJjMmQ1MDYyNDVlODA2ZDQxZWIwMzVmOWE1YTA4ZTMxYmY4
+    NDg0OTc0ZjlmZmU2ZGM5MjAwNjhlYzFhYTM1NTk1ZmNiZDM2YzU=

data/README.md

@@ -73,14 +73,14 @@ 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.
 
-### STOMP-specific support
-
-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.
+### Fallback and dead-letter-queue support
+
+The consume block accepts the usual subscriptions headers, as well as two
+additional headers `:dead_letter_queue` and `:max_redeliveries`.  If either of
+the latter two is present, the honsumer 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/client/jms.rb

@@ -84,7 +84,40 @@ module Stapfen
       end
 
       def can_unreceive?
-        false
+        true
+      end
+
+      # JMS doesn't implement unreceive in quite the way Stomp does, so we'll
+      # implement it here.
+      #
+      # Given a message and a set of unreceive headers, this will deliver the
+      # message back to its originating queue a limited number of times, then
+      # failover to the dead letter queue.
+      #
+      # @param [Stapfen::Message] message The message to unreceive.
+      # @param [Hash] unreceive_headers
+      # @option unreceive_headers [Integer] :max_redeliveries The number of times
+      #   to attempt redelivery.
+      # @option unreceive_headers [String] :dead_letter_queue After giving up on
+      #   redelivering, send the message here.
+      def unreceive(message, unreceive_headers)
+        return if unreceive_headers[:max_redeliveries].nil? && unreceive_headers[:max_redeliveries].nil?
+
+        headers = message.headers
+        retry_count = headers.delete('retry_count').to_i || 0
+        retry_count += 1
+        headers['retry_count'] = retry_count
+
+        destination = headers.delete('destination')
+
+        if unreceive_headers[:max_redeliveries] && (retry_count <= unreceive_headers[:max_redeliveries])
+          self.publish(destination, message.body, headers)
+        elsif unreceive_headers[:dead_letter_queue] # Done retrying, send to DLQ
+          headers['original_destination'] = destination
+          headers.delete('retry_count')
+
+          self.publish(unreceive_headers[:dead_letter_queue], message.body, headers)
+        end
       end
     end
   end

data/lib/stapfen/version.rb

@@ -1,3 +1,3 @@
 module Stapfen
-  VERSION = '2.0.2'
+  VERSION = '2.1.0'
 end

data/spec/client/jms_spec.rb

@@ -12,7 +12,110 @@ if RUBY_PLATFORM == 'java'
     describe '#can_unreceive?' do
       subject { client.can_unreceive? }
 
-      it { should_not be_true }
+      it { should be_true }
+    end
+
+    describe '#unreceive' do
+      let(:body) { 'Some body in string form' }
+      let(:message) { double('Message', :headers => msg_headers.merge('destination' => orig_destination), :body => body) }
+      let(:max_redeliveries) { 2 }
+      let(:dlq) { '/queue/some_queue/dlq' }
+      let(:unreceive_headers) do
+        { :dead_letter_queue => dlq, :max_redeliveries => max_redeliveries }
+      end
+      let(:orig_destination) { '/queue/some_queue' }
+
+      # Just to make sure we preserve any headers we don't explicitly get rid of
+      let(:orig_headers) do
+        { 'key1' => 'value1' }
+      end
+
+
+      subject(:unreceive!) { client.unreceive(message, unreceive_headers) }
+
+      context 'with no unreceive[:max_redeliveries] or unreceive[:dead_letter_queue]' do
+        let(:msg_headers) { orig_headers }
+        let(:unreceive_headers) { Hash.new }
+
+        it 'should not resend the message' do
+          client.should_not_receive(:publish)
+
+          unreceive!
+        end
+      end
+
+      context 'On a message with no retry_count in the headers' do
+        let(:msg_headers) { orig_headers }
+
+        it 'should publish it to the same destination with a retry_count of 1' do
+          client.should_receive(:publish) do |dest, the_body, the_headers|
+            expect(dest).to eql orig_destination
+            expect(the_body).to eql body
+            expect(the_headers).to eql msg_headers.merge({'retry_count' => 1})
+          end
+
+          unreceive!
+        end
+      end
+
+      context 'On a message with a retry_count in the headers' do
+        let(:msg_headers) { orig_headers.merge('retry_count' => retry_count) }
+
+        context 'that is less than max_redeliveries' do
+         let(:retry_count) { max_redeliveries - 1 }
+
+          it 'should publish it to the same destination with a retry_count increased by one' do
+            client.should_receive(:publish) do |dest, the_body, the_headers|
+              expect(dest).to eql orig_destination
+              expect(the_body).to eql body
+
+
+              expect(the_headers).to eql msg_headers.merge({'retry_count' => retry_count + 1})
+            end
+
+            unreceive!
+          end
+        end
+
+        # This is the 'last' attempt to redeliver, so don't send it again
+        context 'that is equal to max_redeliveries' do
+         let(:retry_count) { max_redeliveries }
+
+          it 'should publish it to the DLQ with no retry_count' do
+            client.should_receive(:publish) do |dest, the_body, the_headers|
+              expect(the_body).to eql body
+              expect(dest).to eql dlq
+
+              # Headers should eql msg_headers except for retry count,
+              # and original_destination
+              msg_headers.delete('retry_count')
+              msg_headers['original_destination'] = orig_destination
+              expect(the_headers).to eql msg_headers
+            end
+
+            unreceive!
+          end
+        end
+
+        context 'that is greater than max_redeliveries' do
+         let(:retry_count) { max_redeliveries + 1 }
+
+          it 'should publish it to the DLQ with no retry_count' do
+            client.should_receive(:publish) do |dest, the_body, the_headers|
+              expect(the_body).to eql body
+              expect(dest).to eql dlq
+
+              # Headers should eql msg_headers except for retry count,
+              # and original_destination
+              msg_headers.delete('retry_count')
+              msg_headers['original_destination'] = orig_destination
+              expect(the_headers).to eql msg_headers
+            end
+
+            unreceive!
+          end
+        end
+      end
     end
 
     describe '#connect' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stapfen
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.1.0
 platform: ruby
 authors:
 - R. Tyler Croy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-12 00:00:00.000000000 Z
+date: 2014-01-22 00:00:00.000000000 Z
 dependencies: []
 description: A simple gem for writing good basic STOMP workers
 email: