fluffle 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c36afa6e383f47841a3217e98ca0e40a6080024c
-  data.tar.gz: acae18e71e14ed4414e74bf8d9f166a015849ffc
+  metadata.gz: 77c72df240211039c526d501f7f34af3bb36330c
+  data.tar.gz: f71668dca91239e6b211be0239d43f5a72dd51d4
 SHA512:
-  metadata.gz: c90963f8af3c68307b79571253dbbce7be639b7d76f655dc4811cdbcf7dc602bd0e0f60e46d536c817e2eb3b5c90a5efe326453fcaaf0ebd766de0c3a9f53a0b
-  data.tar.gz: bc776904911b7098d7d9e67be211f34d251d11c29f70197346157187e18fd4471d2fbc8d4cc4efff675240bf60a6a03241c336a8bd706f17e407b2c3f7fdc0e1
+  metadata.gz: e195c331ce7a3817cef21c76f05f2253b46929b1355b4fad38c617c2b15ab53c7b05ff74c2a9c4296bf0ca5d375a0598b6c9bfcd5f19392595c00edb8dc25997
+  data.tar.gz: d1c08745886f2031b8582890b1e28f09783e66b9f93d45e176b3707d8cb6012eabd46d70967bd2c58149b0d9007cc65c38f36949cfda72d15296660a42211e97

data/.gitignore

@@ -1,2 +1,3 @@
 .DS_Store
+Gemfile.lock
 pkg

data/fluffle.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |s|
   s.homepage = 'https://github.com/Everlane/fluffle'
   s.license  = 'MIT'
 
-  s.required_ruby_version = '>= 1.9.3'
+  s.required_ruby_version = '>= 2.0'
 
   s.add_dependency 'bunny',           '~> 2.5.0'
   s.add_dependency 'concurrent-ruby', '~> 1.0.2'

data/lib/fluffle/client.rb

@@ -9,7 +9,13 @@ module Fluffle
   class Client
     include Connectable
 
+    attr_accessor :default_timeout
+    attr_accessor :logger
+
     def initialize(url:)
+      @default_timeout = 5
+      @logger          = Fluffle.logger
+
       self.connect url
 
       @uuid        = UUIDTools::UUID.timestamp_create.to_s
@@ -27,20 +33,33 @@ module Fluffle
 
     def subscribe
       @reply_queue.subscribe do |delivery_info, properties, payload|
-        self.handle_resposne delivery_info: delivery_info,
-                             properties: properties,
-                             payload: payload
+        self.handle_reply delivery_info: delivery_info,
+                          properties: properties,
+                          payload: payload
       end
     end
 
-    def handle_resposne(delivery_info:, properties:, payload:)
-      payload  = Oj.load payload
+    # 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.
+    def handle_reply(delivery_info:, properties:, payload:)
+      payload = Oj.load payload
+      id      = payload['id']
 
-      ivar = @pending_responses.delete payload['id']
-      ivar.set payload
+      ivar = @pending_responses.delete id
+
+      if ivar
+        ivar.set payload
+      else
+        self.logger.error "Missing pending response IVar: id=#{id || 'null'}"
+      end
     end
 
-    def call(method, params = [], queue: 'default')
+    def call(method, params = [], queue: 'default', **opts)
+      # Using `.fetch` here so that we can pass `nil` as the timeout and have
+      # it be respected
+      timeout = opts.fetch :timeout, self.default_timeout
+
       id = random_bytes_as_hex 8
 
       payload = {
@@ -50,24 +69,66 @@ module Fluffle
         'params'  => params
       }
 
-      @exchange.publish Oj.dump(payload), routing_key: Fluffle.request_queue_name(queue),
-                                          correlation_id: id,
-                                          reply_to: @reply_queue.name
-
-      ivar = Concurrent::IVar.new
-      @pending_responses[id] = ivar
-
-      response = ivar.value
+      response = publish_and_wait payload, queue: queue,
+                                           timeout: timeout
 
       if response['result']
         response['result']
       else
-        raise # TODO: Raise known error subclass to be caught by client code
+        error = response['error'] || {}
+
+        raise Errors::CustomError.new code: error['code'] || 0,
+                                      message: error['message'] || "Missing both `result' and `error' on Response object",
+                                      data: error['data']
       end
     end
 
     protected
 
+    # Publish a payload to the server and wait (block) for the response
+    #
+    # Returns a Hash from the parsed JSON response from the server
+    # Raises TimeoutError if server failed to respond in time
+    def publish_and_wait(payload, queue:, timeout:)
+      id = payload['id']
+
+      ivar = self.publish payload, queue: queue
+
+      response = ivar.value timeout
+
+      if ivar.incomplete?
+        method = payload['method']
+        arity  = payload['params']&.length || 0
+        raise Errors::TimeoutError.new("Timed out waiting for response to `#{method}/#{arity}'")
+      end
+
+      return response
+    ensure
+      # Don't leak the `IVar` if it timed out
+      @pending_responses.delete id
+    end
+
+    # Create an `IVar` future for the response, store that in
+    # `@pending_responses`, and finally publish the payload to the server
+    #
+    # Returns the `IVar`
+    def publish(payload, queue:)
+      id = payload['id']
+
+      opts = {
+        routing_key: Fluffle.request_queue_name(queue),
+        correlation_id: id,
+        reply_to: @reply_queue.name
+      }
+
+      ivar = Concurrent::IVar.new
+      @pending_responses[id] = ivar
+
+      @exchange.publish Oj.dump(payload), opts
+
+      ivar
+    end
+
     def random_bytes_as_hex(bytes)
       # Adapted from `SecureRandom.hex`
       @prng.bytes(bytes).unpack('H*')[0]

data/lib/fluffle/errors.rb

@@ -10,11 +10,14 @@ module Fluffle
       end
     end
 
+    class TimeoutError < StandardError
+    end
+
     # Raise this within your own code to get an error that will be faithfully
     # translated into the code, message, and data member fields of the
     # spec's `Error` response object
     class CustomError < BaseError
-      attr_accessor :data
+      attr_accessor :code, :data
 
       def initialize(code: 0, message:, data: nil)
         @code = code

data/lib/fluffle/version.rb

@@ -1,3 +1,3 @@
 module Fluffle
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/lib/fluffle.rb

@@ -1,4 +1,5 @@
 require 'bunny'
+require 'logger'
 
 require 'fluffle/version'
 require 'fluffle/client'
@@ -17,4 +18,8 @@ module Fluffle
   def self.response_queue_name(name)
     "fluffle.responses.#{name}"
   end
+
+  def self.logger
+    @logger ||= Logger.new $stdout
+  end
 end

data/spec/client_spec.rb

@@ -0,0 +1,82 @@
+require 'spec_helper'
+
+describe Fluffle::Client do
+  subject do
+    Fluffle::Client.new url: nil
+  end
+
+  before do
+    @exchange_spy = exchange_spy = spy 'Exchange'
+
+    subject.instance_eval do
+      @exchange = exchange_spy
+    end
+  end
+
+  describe '#call' do
+    def prepare_response(payload)
+      ->(id) do
+        response_payload = { 'jsonrpc' => '2.0', 'id' => id }.merge(payload)
+
+        subject.handle_reply delivery_info: double('DeliveryInfo'),
+                             properties: double('Properties'),
+                             payload: Oj.dump(response_payload)
+      end
+    end
+
+    it 'returns the value on result from server' do
+      method = 'foo'
+      result = 'bar'
+
+      respond = prepare_response 'result' => result
+
+      allow(@exchange_spy).to receive(:publish) do |payload, opts|
+        payload = Oj.load(payload)
+
+        expect(payload).to include({
+          'id'     => kind_of(String),
+          'method' => method
+        })
+
+        respond.call payload['id']
+      end
+
+      expect(subject.call(method)).to eq(result)
+    end
+
+    it 'raises on error from server' do
+      code    = 1337
+      message = 'Uh-oh!'
+
+      respond = prepare_response 'error' => {
+        'code'    => code,
+        'message' => message
+      }
+
+      allow(@exchange_spy).to receive(:publish) do |payload, _opts|
+        payload = Oj.load(payload)
+
+        respond.call payload['id']
+      end
+
+      expect { subject.call('will.raise') }.to raise_error do |error|
+        expect(error).to be_a Fluffle::Errors::CustomError
+        expect(error.code).to eq code
+        expect(error.message).to eq message
+        expect(error.data).to be_nil
+      end
+    end
+
+    it 'raises on timeout' do
+      allow(@exchange_spy).to receive(:publish)
+
+      t0 = Time.now
+
+      expect {
+        subject.call 'whatever', timeout: 0.01
+      }.to raise_error(Fluffle::Errors::TimeoutError)
+
+      expect(Time.now - t0).to be < 0.1
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluffle
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Dirk Gadsden
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-09 00:00:00.000000000 Z
+date: 2016-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny
@@ -118,7 +118,6 @@ files:
 - ".gitignore"
 - ".rspec"
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
@@ -135,6 +134,7 @@ files:
 - lib/fluffle/handlers/dispatcher.rb
 - lib/fluffle/server.rb
 - lib/fluffle/version.rb
+- spec/client_spec.rb
 - spec/server_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/Everlane/fluffle
@@ -149,7 +149,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/Gemfile.lock

@@ -1,52 +0,0 @@
-PATH
-  remote: .
-  specs:
-    fluffle (0.0.2)
-      bunny (~> 2.5.0)
-      concurrent-ruby (~> 1.0.2)
-      oj (~> 2.17.1)
-      uuidtools (~> 2.1.5)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    amq-protocol (2.0.1)
-    bunny (2.5.0)
-      amq-protocol (>= 2.0.1)
-    coderay (1.1.1)
-    concurrent-ruby (1.0.2)
-    diff-lcs (1.2.5)
-    method_source (0.8.2)
-    oj (2.17.1)
-    pry (0.10.4)
-      coderay (~> 1.1.0)
-      method_source (~> 0.8.1)
-      slop (~> 3.4)
-    rake (11.2.2)
-    rspec (3.4.0)
-      rspec-core (~> 3.4.0)
-      rspec-expectations (~> 3.4.0)
-      rspec-mocks (~> 3.4.0)
-    rspec-core (3.4.4)
-      rspec-support (~> 3.4.0)
-    rspec-expectations (3.4.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.4.0)
-    rspec-mocks (3.4.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.4.0)
-    rspec-support (3.4.1)
-    slop (3.6.0)
-    uuidtools (2.1.5)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  fluffle!
-  pry (~> 0.10.1)
-  rake (~> 11.2.2)
-  rspec (~> 3.4.0)
-
-BUNDLED WITH
-   1.12.5