fluffle 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 122f80facd1bb3cf22f70ff33546da4ae228f72e
-  data.tar.gz: b7939ddcb8bfc94962cea7d6e2b6257afe29eb73
+  metadata.gz: 23e4f19afd95059c202ab4bc0af6272d02a7c9d0
+  data.tar.gz: 7ebfc0c7c29f5a947413d870e7652b745636a57a
 SHA512:
-  metadata.gz: a90deb17fc848e89a176a47a27050ee30a60b5b59746c149cbdb11b8da025cfca8735e55336c640a968be663e1b73a584663813f2b18486784c34bd05587f0e3
-  data.tar.gz: d8b0d2d9226d1a5f2e9611c4f448161d30a33f1bb3e38f1458e64e62264678d4cfc6b9aa53b0bc6f059dde5a80d27693efa32f52b32985214b8169063d7c7717
+  metadata.gz: b0ce2b422e356596c1dad872f56ce106360f82e0c5079f3372817a586af11de7a0c0409ed6578f43b8ca21b8837b12c33b69469cd20c971e33b98ccb2023355d
+  data.tar.gz: 80c7da2ff18ece5e1754a36a595cff627c0f925d84b2c652c352064e891ff52c2209c5eee56f795ee00bc748fbbb78270bbb4ec9de719f1c860b97558c5fa3c2

data/examples/client.rb

@@ -3,7 +3,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 require 'fluffle'
 
-client = Fluffle::Client.new url: 'amqp://localhost'
+client = Fluffle::Client.new url: 'amqp://localhost', confirms: true
 # You can also pass `connection:` to use an existing Bunny connection:
 #   Fluffle::Client.new(connection: Bunny.new('amqp://localhost', heartbeat: 2))
 

data/lib/fluffle/client.rb

@@ -9,12 +9,14 @@ module Fluffle
   class Client
     include Connectable
 
+    attr_reader :confirms
     attr_accessor :default_timeout
     attr_accessor :logger
 
-    def initialize(url: nil, connection: nil)
+    def initialize(url: nil, connection: nil, confirms: false)
       self.connect(url || connection)
 
+      @confirms        = confirms
       @default_timeout = 5
       @logger          = Fluffle.logger
 
@@ -26,9 +28,13 @@ module Fluffle
       # Used for generating unique message IDs
       @prng = Random.new
 
-      @pending_responses = Concurrent::Map.new
+      if confirms
+        @pending_confirms = Concurrent::Map.new
+        confirm_select
+      end
 
-      self.subscribe
+      @pending_responses = Concurrent::Map.new
+      subscribe
     end
 
     def subscribe
@@ -45,6 +51,22 @@ module Fluffle
       end
     end
 
+    def confirm_select
+      handle_confirm = ->(tag, _multiple, nack) do
+        ivar = @pending_confirms.delete tag
+
+        if ivar
+          ivar.set nack
+        else
+          self.logger.error "Missing confirm IVar: tag=#{tag}"
+        end
+      end
+
+      # Set the channel in confirmation mode so that we can receive confirms
+      # of published messages
+      @channel.confirm_select handle_confirm
+    end
+
     # Fetch and set the `IVar` with a response from the server. This method is
     # called from the reply queue's background thread; the main thread will
     # normally be waiting for the `IVar` to be set.
@@ -102,25 +124,57 @@ module Fluffle
     def publish_and_wait(payload, queue:, timeout:)
       id = payload['id']
 
-      ivar = Concurrent::IVar.new
-      @pending_responses[id] = ivar
-
-      self.publish payload, queue: queue
-
-      response = ivar.value timeout
+      response_ivar = Concurrent::IVar.new
+      @pending_responses[id] = response_ivar
 
-      if ivar.incomplete?
-        method = payload['method']
-        arity  = (payload['params'] && payload['params'].length) || 0
-        raise Errors::TimeoutError.new("Timed out waiting for response to `#{method}/#{arity}'")
+      if confirms
+        with_confirmation(timeout: timeout) { publish payload, queue: queue }
+      else
+        publish payload, queue: queue
       end
 
+      response = response_ivar.value timeout
+      raise_incomplete(payload, 'response') if response_ivar.incomplete?
+
       return response
     ensure
       # Don't leak the `IVar` if it timed out
       @pending_responses.delete id
     end
 
+    # Returns a nice formatted description of a payload with its method name
+    #   and arity
+    def describe_payload(payload)
+      method = payload['method']
+      arity  = (payload['params'] && payload['params'].length) || 0
+
+      "#{method}/#{arity}"
+    end
+
+    # Wraps a block (which should publish a message) with a blocking check
+    #   that the client received a confirmation from the RabbitMQ server
+    #   that the message that was received and routed successfully
+    def with_confirmation(timeout:)
+      tag = @channel.next_publish_seq_no
+      confirm_ivar = Concurrent::IVar.new
+      @pending_confirms[tag] = confirm_ivar
+
+      yield
+
+      nack = confirm_ivar.value timeout
+      if confirm_ivar.incomplete?
+        raise_incomplete payload, 'confirm'
+      elsif nack
+        raise Errors::NackError.new('Received nack from confirmation')
+      end
+    end
+
+    # event_name - String describing what we timed out waiting for, should
+    #   be 'response' or 'confirm'
+    def raise_incomplete(payload, event_name)
+      raise Errors::TimeoutError.new("Timed out waiting for #{event_name} to `#{describe_payload(payload)}'")
+    end
+
     def publish(payload, queue:)
       opts = {
         routing_key: Fluffle.request_queue_name(queue),

data/lib/fluffle/version.rb

@@ -1,3 +1,3 @@
 module Fluffle
-  VERSION = '0.3.1'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fluffle
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Dirk Gadsden