fluffle 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2de3913524a4ba8c3270b96d5272f806c1b307e1
-  data.tar.gz: f2d2d81a77fed5dd7ed95a79e70e986c53c5bca4
+  metadata.gz: 255eee82ad3d15d6a7b9623e2abc52327c0b029c
+  data.tar.gz: 9d0496f43f6f63e85b8de2d861d516959ec92cb5
 SHA512:
-  metadata.gz: b33a3af2b4958527059766387e030d491d56ee05dbfc6e3141f57255f0c664680e575319fd2aa4cd38bbe7ae1466e6e00da17d82c111c81fc29bfa7c33b9a263
-  data.tar.gz: a92a7984a455c82071dd492b50fa87ad9d81aa86bb7a6059fdc51a707a056e4fc9b505aa62678d2c1689cfad228cbb1a1953459f01143a93fa55ae5fdae32032
+  metadata.gz: 5dad9fde293a176c4b3f9cfe1c8dcc3cee2359f683db422d3e8a1f0273be9d84e57b5c24b1bd044a8f7416db58fa9d96551c87d4c1c19ee1e75ad31df9165e8c
+  data.tar.gz: 1d5e676a4db1978eda8e987c56d045ae137cd06345917ad10a0678db108d1b18d8240f9c2361ed47b00f4d512690443e3910fa99450e412198bd460b86e8cce7

data/README.md

@@ -14,8 +14,10 @@ An implementation of [JSON-RPC][] over RabbitMQ through the [Bunny][] library. P
 
 ## Features
 
-- Client: Thread-safe blocking client (via [concurrent-ruby][])
-- Server: One-thread-per-queue implementation (multi-threaded coming soon)
+Both the client and server implementations should be thread-safe, as their behavior is implemented on top of the excellent [concurrent-ruby][] gem's data structures.
+
+- Client: Thread-safe client that can perform multiple requests concurrently
+- Server: Single or multi-threaded server (one request/response per thread)
 - Server: Easy-to-use built-in handlers and straightforward API for building custom handlers
 
 [concurrent-ruby]: https://github.com/ruby-concurrency/concurrent-ruby
@@ -26,9 +28,41 @@ See the [`examples`](examples/) directory.
 
 The server provides a few options for handling RPC requests:
 
-- Dispatcher pattern: `dispatcher.handle('upcase') { |str| str.upcase }`
-- Delegator pattern: delegate will receive the `#upcase` message with a single argument (the string)
-- Custom: any handler needs to implement the API described in `Fluffle::Handlers::Base`
+- [Dispatcher](lib/fluffle/handlers/dispatcher.rb): `dispatcher.handle('upcase') { |str| str.upcase }`
+- [Delegator](lib/fluffle/handlers/delegator.rb): delegate will receive the `#upcase` message with a single argument (the string)
+- Custom: any handler needs to implement the API described in [`Fluffle::Handlers::Base`](lib/fluffle/handlers/base.rb)
+
+### Basic server and client
+
+A server has two basic requirements: the URL of a RabbitMQ server to connect to and one or more queues to drain (with a handler for each queue).
+
+Below is a basic server providing an `upcase` method to return the upper cased version of its argument:
+
+```ruby
+require 'fluffle'
+
+server = Fluffle::Server.new url: 'amqp://localhost'
+
+server.drain do |dispatcher|
+  dispatcher.handle('upcase') { |str| str.upcase }
+end
+
+server.start
+```
+
+This example relies on a couple features of `Server#drain`:
+
+1. By default it will drain the `default` queue.
+2. You can provide a block to the method to have it set up a [`Dispatcher`](lib/fluffle/handlers/dispatcher.rb) handler and pass that in to the block.
+
+And client to call that `upcase` method looks like:
+
+```ruby
+client = Fluffle::Client.new url: 'amqp://localhost'
+
+client.call 'upcase', ['Hello world!']
+# => "HELLO WORLD!"
+```
 
 ## License
 

data/examples/client.rb

@@ -4,6 +4,8 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'fluffle'
 
 client = Fluffle::Client.new url: 'amqp://localhost'
+# You can also pass `connection:` to use an existing Bunny connection:
+#   Fluffle::Client.new(connection: Bunny.new('amqp://localhost', heartbeat: 2))
 
 timings = 10.times.map do
   t0 = Time.now

data/examples/server.rb

@@ -3,7 +3,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 require 'fluffle'
 
-server = Fluffle::Server.new url: 'amqp://localhost'
+server = Fluffle::Server.new url: 'amqp://localhost', concurrency: 5
 
 server.drain do |dispatcher|
   dispatcher.handle('foo') { 'bar' }

data/lib/fluffle/client.rb

@@ -12,12 +12,12 @@ module Fluffle
     attr_accessor :default_timeout
     attr_accessor :logger
 
-    def initialize(url:)
+    def initialize(url: nil, connection: nil)
+      self.connect(url || connection)
+
       @default_timeout = 5
       @logger          = Fluffle.logger
 
-      self.connect url
-
       @uuid        = UUIDTools::UUID.timestamp_create.to_s
       @channel     = @connection.create_channel
       @exchange    = @channel.default_exchange

data/lib/fluffle/connectable.rb

@@ -9,7 +9,13 @@ module Fluffle
     def connect(*args)
       self.stop if self.connected?
 
-      @connection = Bunny.new *args
+      @connection =
+        if args.first.is_a? Bunny::Session
+          args.first
+        else
+          Bunny.new *args
+        end
+
       @connection.start
     end
 

data/lib/fluffle/server.rb

@@ -6,8 +6,9 @@ module Fluffle
 
     # url:         - Optional URL to pass to `Bunny.new` to immediately connect
     # concurrency: - Number of threads to handle messages on (default: 1)
-    def initialize(url: nil, concurrency: 1)
-      self.connect(url) if url
+    def initialize(url: nil, connection: nil, concurrency: 1)
+      url_or_connection = url || connection
+      self.connect(url_or_connection) if url_or_connection
 
       @handlers     = {}
       @handler_pool = Concurrent::FixedThreadPool.new concurrency

data/lib/fluffle/version.rb

@@ -1,3 +1,3 @@
 module Fluffle
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 end

data/spec/client_spec.rb

@@ -13,6 +13,33 @@ describe Fluffle::Client do
     end
   end
 
+  describe '#initialize' do
+    it 'allows user to pass an `amqp://` URL via `url:`' do
+      client = Fluffle::Client.new url: 'amqp://localhost'
+
+      expect(client.connection).to be_a Bunny::Session
+      expect(client.connected?).to eq true
+    end
+
+    it 'allows user to provide existing Bunny connection via `connection:`' do
+      bunny_channel = double 'Bunny::Channel',
+        default_exchange: double('Bunny::Exchange'),
+        queue: double('Bunny::Queue', subscribe: nil)
+
+      bunny_session = double 'Bunny::Session',
+        create_channel: bunny_channel,
+        start: nil,
+        connected?: true
+
+      allow(bunny_session).to receive(:is_a?).with(Bunny::Session).and_return(true)
+
+      client = Fluffle::Client.new connection: bunny_session
+
+      expect(client.connection).to eq bunny_session
+      expect(client.connected?).to eq true
+    end
+  end
+
   describe '#call' do
     def prepare_response(payload)
       ->(id) do

data/spec/handlers/delegator_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe Fluffle::Handlers::Delegator do
+  before do
+    @delegated_object = double 'Delegated Object'
+
+    @handler = Fluffle::Handlers::Delegator.new @delegated_object
+  end
+
+  it 'calls the method with the params on the delegated object' do
+    param1 = 'One'
+    param2 = 'Two'
+    result = 'Three'
+
+    expect(@delegated_object).to receive(:some_method)
+      .with(param1, param2)
+      .and_return(result)
+
+    actual_result = @handler.call id: 'abc123',
+                                  method: 'some_method',
+                                  params: [param1, param2],
+                                  meta: {}
+
+    expect(actual_result).to eq(result)
+  end
+end

data/spec/handlers/dispatcher_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe Fluffle::Handlers::Dispatcher do
+  before do
+    @handler = Fluffle::Handlers::Dispatcher.new
+
+    @handler.handle('double_it') { |arg| arg * 2 }
+  end
+
+  it 'calls the method with the params on the delegated object' do
+    result = @handler.call id: 'abc123',
+                           method: 'double_it',
+                           params: [2],
+                           meta: {}
+
+    expect(result).to eq(4)
+  end
+
+  it 'raises error if method not configured' do
+    expect {
+      @handler.call id: 'def456',
+                    method: 'doesnt_exist',
+                    params: ['whatever'],
+                    meta: {}
+    }.to raise_error(NoMethodError, /doesnt_exist/)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluffle
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Dirk Gadsden
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-14 00:00:00.000000000 Z
+date: 2016-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny
@@ -139,6 +139,8 @@ files:
 - lib/fluffle/testing.rb
 - lib/fluffle/version.rb
 - spec/client_spec.rb
+- spec/handlers/delegator_spec.rb
+- spec/handlers/dispatcher_spec.rb
 - spec/server_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/Everlane/fluffle