philotic 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2e126429cf9f92b56a49a1f1e609479736b965c1
-  data.tar.gz: 2b0f1b015e34e9e7d773973cee7b4d7657186229
+  metadata.gz: 9801556e2c18c1147b0de999eeef96c1b3b00cf4
+  data.tar.gz: d43caf8f1c8aa98e67aec1b0ed11edee9aea22e2
 SHA512:
-  metadata.gz: 18e0412f7f720e0a382e17f109d54472ec0d6328e5d739ed8eabdf45058e33f70eb322908335d28a8b3d1825f67d42f47a63f622b3bd0df19751b0648533c00a
-  data.tar.gz: 1f06ba6e3e167d1c4d79540c7555435754b8ebee2bc62a7e3787309ab4115ec815110f036d7a2c66819e68858f08eea4993447e396196f6fbb97086ccfa0f121
+  metadata.gz: 3acc57d92689ff4dd1de133e968c26d7321391aab11ff532a1cd3d997f483302ae7920f387cbb7dd351a10516ccee67c596375e485d3188f5feccdf4bf8ae0e0
+  data.tar.gz: 2101fd35dceb87a98ef72e9327bec7497d271428bda282f8c7e58fc61dc2644362f5ebf293f847dd4b649bf58f7f340d94b2f2672bb45af6d5f85642c7e0680c

data/examples/simple_singleton.rb

@@ -11,7 +11,7 @@ Philotic.config.message_return_handler = lambda do |basic_return, metadata, mess
 end
 
 Philotic.subscribe(header_key: 'header_1') do |message|
-  ap header_key: message.header_key, payload_key: message.payload_key, methods: message.methods - Philotic::Message.new.methods
+  ap message.attributes
 end
 
 # normally we'd do:
@@ -23,5 +23,5 @@ end
 loop do
   Philotic::Message.publish({header_key: "header_#{[1, 2].sample}"}, {payload_key: 'payload_value'})
   # only send a message every two seconds so we can see whats going on
-  sleep 2
+  sleep 0.1
 end

data/examples/subscribing/acks.rb

@@ -6,19 +6,19 @@ require 'philotic'
 require 'awesome_print'
 
 # sometimes ack
-Philotic.subscribe('flaky_queue', ack: true) do |message|
+Philotic.subscribe('flaky_queue', manual_ack: true) do |message|
   ap message.attributes
    [true, false].sample ? acknowledge(message) : reject(message)
 end
 
 # always ack
-Philotic.subscribe('flaky_queue', ack: true) do |message|
+Philotic.subscribe('flaky_queue', manual_ack: true) do |message|
   ap message.attributes
   acknowledge(message, true)
 end
 
 # always reject
-Philotic.subscribe('flaky_queue', ack: true) do |message|
+Philotic.subscribe('flaky_queue', manual_ack: true) do |message|
   ap message.attributes
   reject message
 end

data/examples/subscribing/consumer.rb

@@ -10,16 +10,16 @@ class NamedQueueConsumer < Philotic::Consumer
   # subscribe to an existing named queue
   subscribe_to :test_queue
 
-  #use acknowledgements
-  ack_messages
+  # use acknowledgements
+  auto_acknowledge
 
   # REQUEUE the message with RabbitMQ if consume throws these errors. I.e., something went wrong with the consumer
   # Only valid with ack_messages
-  requeueable_errors PossiblyTransientErrorOne, PossiblyTransientErrorTwo
+  # requeueable_errors PossiblyTransientErrorOne, PossiblyTransientErrorTwo
 
   # REJECT the message with RabbitMQ if consume throws these errors. I.e., The message is malformed/invalid
   # Only valid with ack_messages
-  rejectable_errors BadMessageError
+  # rejectable_errors BadMessageError
 
   def consume(message)
     ap named: message.attributes

data/lib/philotic/consumer.rb

@@ -5,7 +5,6 @@ module Philotic
   class Consumer < Philotic::Subscriber
 
     class << self
-
       def subscribe_to(subscription)
         @subscription = subscription
       end
@@ -14,16 +13,24 @@ module Philotic
         @subscription
       end
 
-      def ack_messages
-        @ack_messages = true
+      def manually_acknowledge
+        @manually_acknowledge = true
       end
 
-      def exclusive
-        @exclusive = true
+      def manually_acknowledge?
+        !!@manually_acknowledge
       end
 
-      def ack_messages?
-        !!@ack_messages
+      def auto_acknowledge
+        @auto_acknowledge = true
+      end
+
+      def auto_acknowledge?
+        !!@auto_acknowledge
+      end
+
+      def exclusive
+        @exclusive = true
       end
 
       def exclusive?
@@ -50,11 +57,11 @@ module Philotic
 
       def subscription_options
         {
-          manual_ack: ack_messages?,
+          manual_ack: auto_acknowledge? || manually_acknowledge?,
           exclusive:  exclusive?,
         }
       end
-    end
+    end # end class methods
 
     def subscribe
       super(self.class.subscription, self.class.subscription_options) do |message|
@@ -69,22 +76,19 @@ module Philotic
     private
 
     def _consume(message)
-      if self.class.ack_messages?
+      if self.class.auto_acknowledge?
         begin
           consume(message)
+          acknowledge(message)
         rescue => e
-
           if self.class.requeueable_errors.include? e.class
             reject(message, true)
-            return
           elsif self.class.rejectable_errors.include? e.class
             reject(message, false)
-            return
           else
             raise e
           end
         end
-        acknowledge(message)
       else
         consume(message)
       end

data/lib/philotic/version.rb

@@ -1,3 +1,3 @@
 module Philotic
-  VERSION = '1.0.1'
+  VERSION = '1.0.2'
 end

data/spec/philotic/consumer_spec.rb

@@ -27,11 +27,19 @@ describe Philotic::Consumer do
     end
   end
 
-  describe '.ack_messages' do
-    it 'sets the class variable @ack_messages' do
-      expect(subject.ack_messages?).not_to be true
-      subject.ack_messages
-      expect(subject.ack_messages?).to be true
+  describe '.manually_acknowledge' do
+    it 'sets the class variable @manually_acknowledge' do
+      expect(subject).not_to be_manually_acknowledge
+      subject.manually_acknowledge
+      expect(subject).to be_manually_acknowledge
+    end
+  end
+
+  describe '.auto_acknowledge' do
+    it 'sets the class variable @auto_acknowledge' do
+      expect(subject).not_to be_auto_acknowledge
+      subject.auto_acknowledge
+      expect(subject).to be_auto_acknowledge
     end
   end
 
@@ -91,7 +99,13 @@ describe Philotic::Consumer do
     it 'returns a hash with the exclusive and manual_ack options' do
       expect(subject.subscription_options).to match({manual_ack: false, exclusive: false})
 
-      subject.ack_messages
+      subject.auto_acknowledge
+      expect(subject.subscription_options).to match({manual_ack: true, exclusive: false})
+
+      subject.instance_variable_set(:@auto_acknowledge, nil)
+      expect(subject.subscription_options).to match({manual_ack: false, exclusive: false})
+
+      subject.manually_acknowledge
       expect(subject.subscription_options).to match({manual_ack: true, exclusive: false})
 
       subject.exclusive
@@ -102,7 +116,7 @@ describe Philotic::Consumer do
   describe '#subscribe' do
     it 'proxies to Philotic::Subscriber#subscribe' do
       subject.subscribe_to named_queue
-      subject.ack_messages
+      subject.auto_acknowledge
       subject.exclusive
 
       expect_any_instance_of(Philotic::Subscriber).to receive(:subscribe).with(named_queue, manual_ack: true, exclusive: true)
@@ -136,7 +150,7 @@ describe Philotic::Consumer do
     end
 
     it 'acknowledges messages when @ack_messages is set' do
-      subject.class.ack_messages
+      subject.class.auto_acknowledge
 
       subject.define_singleton_method :consume do |message|
         # no op
@@ -148,7 +162,7 @@ describe Philotic::Consumer do
     end
 
     it 'requeues messages when @ack_messages is set and a requeueable error is thrown' do
-      subject.class.ack_messages
+      subject.class.auto_acknowledge
       subject.class.requeueable_errors(RuntimeError)
 
       subject.define_singleton_method :consume do |message|
@@ -161,7 +175,7 @@ describe Philotic::Consumer do
     end
 
     it 'rejects messages when @ack_messages is set and a rejectable error is thrown' do
-      subject.class.ack_messages
+      subject.class.auto_acknowledge
       subject.class.rejectable_errors(RuntimeError)
 
       subject.define_singleton_method :consume do |message|
@@ -174,7 +188,7 @@ describe Philotic::Consumer do
     end
 
     it 'raises all non-requeueable and non-rejectable errors' do
-      subject.class.ack_messages
+      subject.class.auto_acknowledge
 
       subject.define_singleton_method :consume do |message|
         raise RuntimeError.new 'oops'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: philotic
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Nathan Keyes