fluffle 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e96a7339ec279990aaa392943d1311b880fb8b50
+  data.tar.gz: ce5531d38a298fc3dc30bbb6bf5e9f60be34e35a
+SHA512:
+  metadata.gz: 2ccae5e39f1dcfa3f32fddaf180ee0124e3d76313beb0983d0fa1f668fa6e3ebfd118620b8bc18d783804bce022dc119ae2e08c1afb4b7dc996c05c9970373b3
+  data.tar.gz: 69eeb23cf91f14575f93a1c2f82a53fdd1e719fb39b132a3baf5e0baa74132987257fa1456c53cbb5623a0b0a715eb074f027e784ed68fc3b05e9cef7d88d63d

data/.gitignore

@@ -0,0 +1,2 @@
+.DS_Store
+pkg

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,52 @@
+PATH
+  remote: .
+  specs:
+    fluffle (0.0.1)
+      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

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Everlane Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,33 @@
+# fluffle
+
+An implementation of [JSON-RPC][] over RabbitMQ through the [Bunny][] library. Provides both a client and server.
+
+![](fluffle.jpg)
+
+> A group of baby bunnies is called a [fluffle][].
+
+[Bunny]: https://github.com/ruby-amqp/bunny
+[fluffle]: http://imgur.com/6eABy1v
+[JSON-RPC]: http://www.jsonrpc.org/specification
+
+## Features
+
+- Client: Thread-safe blocking client (via [concurrent-ruby][])
+- Server: One-thread-per-queue implementation (multi-threaded coming soon)
+- Server: Easy-to-use built-in handlers and straightforward API for building custom handlers
+
+[concurrent-ruby]: https://github.com/ruby-concurrency/concurrent-ruby
+
+## Examples
+
+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`
+
+## License
+
+Released under the MIT license, see [LICENSE](LICENSE) for details.

data/Rakefile

@@ -0,0 +1,4 @@
+require 'bundler/gem_tasks'
+
+# No-op to make Travis CI happy
+task 'default'

data/examples/client.rb

@@ -0,0 +1,14 @@
+lib = File.join File.dirname(__FILE__), '..', 'lib'
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'fluffle'
+
+server = Fluffle::Client.new url: 'amqp://localhost'
+
+timings = 10.times.map do
+  t0 = Time.now
+  server.call('foo').inspect
+  Time.now - t0
+end
+
+puts timings

data/examples/server.rb

@@ -0,0 +1,12 @@
+lib = File.join File.dirname(__FILE__), '..', 'lib'
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'fluffle'
+
+server = Fluffle::Server.new url: 'amqp://localhost'
+
+server.drain 'default' do |dispatcher|
+  dispatcher.handle('foo') { 'bar' }
+end
+
+server.start

data/fluffle.gemspec

@@ -0,0 +1,28 @@
+lib = File.join File.dirname(__FILE__), 'lib'
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'fluffle/version'
+
+Gem::Specification.new do |s|
+  s.name     = 'fluffle'
+  s.version  = Fluffle::VERSION
+  s.authors  = ['Dirk Gadsden']
+  s.email    = ['dirk@esherido.com']
+  s.summary  = 'Client and server implementations for JSON-RPC over RabbitMQ'
+  s.homepage = 'https://github.com/Everlane/fluffle'
+  s.license  = 'MIT'
+
+  s.required_ruby_version = '>= 1.9.3'
+
+  s.add_dependency 'bunny',           '~> 2.5.0'
+  s.add_dependency 'concurrent-ruby', '~> 1.0.2'
+  s.add_dependency 'oj',              '~> 2.17.1'
+  s.add_dependency 'uuidtools',       '~> 2.1.5'
+
+  s.add_development_dependency 'pry',   '~> 0.10.1'
+  s.add_development_dependency 'rake',  '~> 11.2.2'
+  s.add_development_dependency 'rspec', '~> 3.4.0'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- test/*`.split("\n")
+end

data/lib/fluffle/client.rb

@@ -0,0 +1,76 @@
+require 'concurrent'
+require 'oj'
+require 'securerandom'
+require 'uuidtools'
+
+require 'fluffle/connectable'
+
+module Fluffle
+  class Client
+    include Connectable
+
+    def initialize(url:)
+      self.connect url
+
+      @uuid        = UUIDTools::UUID.timestamp_create.to_s
+      @channel     = @connection.create_channel
+      @exchange    = @channel.default_exchange
+      @reply_queue = @channel.queue Fluffle.response_queue_name(@uuid), exclusive: true
+
+      # Used for generating unique message IDs
+      @prng = Random.new
+
+      @pending_responses = Concurrent::Map.new
+
+      self.subscribe
+    end
+
+    def subscribe
+      @reply_queue.subscribe do |delivery_info, properties, payload|
+        self.handle_resposne delivery_info: delivery_info,
+                             properties: properties,
+                             payload: payload
+      end
+    end
+
+    def handle_resposne(delivery_info:, properties:, payload:)
+      payload  = Oj.load payload
+
+      ivar = @pending_responses.delete payload['id']
+      ivar.set payload
+    end
+
+    def call(method, params = [], queue: 'default')
+      id = random_bytes_as_hex 8
+
+      payload = {
+        'jsonrpc' => '2.0',
+        'id'      => id,
+        'method'  => method,
+        '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
+
+      if response['result']
+        response['result']
+      else
+        raise # TODO: Raise known error subclass to be caught by client code
+      end
+    end
+
+    protected
+
+    def random_bytes_as_hex(bytes)
+      # Adapted from `SecureRandom.hex`
+      @prng.bytes(bytes).unpack('H*')[0]
+    end
+  end
+end

data/lib/fluffle/connectable.rb

@@ -0,0 +1,20 @@
+module Fluffle
+  module Connectable
+    def self.included(klass)
+      klass.class_eval do
+        attr_reader :connection
+      end
+    end
+
+    def connect(*args)
+      self.stop if self.connected?
+
+      @connection = Bunny.new *args
+      @connection.start
+    end
+
+    def connected?
+      @connection&.connected?
+    end
+  end
+end

data/lib/fluffle/errors.rb

@@ -0,0 +1,50 @@
+module Fluffle
+  module Errors
+    class BaseError < StandardError
+      def to_response
+        {
+          'code'    => self.code,
+          'message' => self.message,
+          'data'    => self.data
+        }
+      end
+    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
+
+      def initialize(code: 0, message:, data: nil)
+        @code = code
+        @data = data
+
+        super message
+      end
+    end
+
+    # Superclass of all errors that may be raised within the server
+    class ServerError < BaseError
+      # Longer-form description that may be present in the `data` field of
+      # the `Error` response object
+      attr_reader :description
+
+      def data
+        { 'description' => @description }
+      end
+    end
+
+    class InvalidRequestError < ServerError
+      def initialize(description)
+        @description = description
+
+        super 'Invalid Request'
+      end
+
+      def code
+        -32600
+      end
+    end
+  end
+end

data/lib/fluffle/handlers/base.rb

@@ -0,0 +1,9 @@
+module Fluffle
+  module Handlers
+    class Base
+      def call(method:, params:, id:, meta:)
+        raise RuntimeError, '#call is not implemented on abstract Base handler class'
+      end
+    end
+  end
+end

data/lib/fluffle/handlers/delegator.rb

@@ -0,0 +1,13 @@
+module Fluffle
+  module Handlers
+    class Delegator < Base
+      def initialize(delegated_object)
+        @delegated_object = delegated_object
+      end
+
+      def call(method:, params:,  **_)
+        @delegated_object.send method.to_sym, *params
+      end
+    end
+  end
+end

data/lib/fluffle/handlers/dispatcher.rb

@@ -0,0 +1,27 @@
+module Fluffle
+  module Handlers
+    class Dispatcher < Base
+      def initialize
+        @routes = []
+
+        yield self if block_given?
+      end
+
+      # pattern - Right now just a String that 1-to-1 matches the `method`
+      # block - Block to call with the `params`
+      def handle(pattern, &block)
+        @routes << [pattern, block]
+      end
+
+      def call(method:, params:,  **_)
+        @routes.each do |(pattern, block)|
+          next if pattern != method
+
+          return block.call(*params)
+        end
+
+        raise NoMethodError, "Undefined method '#{method}'"
+      end
+    end
+  end
+end

data/lib/fluffle/server.rb

@@ -0,0 +1,128 @@
+module Fluffle
+  class Server
+    class << self
+      attr_accessor :default_server
+    end
+
+    attr_reader :connection, :handlers
+
+    def initialize(url: nil)
+      self.connect(url) if url
+
+      @handlers = {}
+      @queues   = {}
+
+      self.class.default_server ||= self
+    end
+
+    def connect(*args)
+      self.stop if self.connected?
+
+      @connection = Bunny.new *args
+      @connection.start
+    end
+
+    def connected?
+      @connection&.connected?
+    end
+
+    def drain(queue: 'default', handler: nil, &block)
+      if handler && block
+        raise ArgumentError, 'Cannot provide both handler: and block'
+      end
+
+      handler = Fluffle::Handlers::Dispatcher.new(&block) if block
+
+      @handlers[queue_name.to_s] = handler
+    end
+
+    def start
+      @channel  = @connection.create_channel
+      @exchange = @channel.default_exchange
+
+      @handlers.each do |name, handler|
+        qualified_name = Fluffle.response_queue_name name
+        queue          = @channel.queue qualified_name
+
+        queue.subscribe do |delivery_info, properties, payload|
+          self.handle_request queue_name: name,
+                              handler: handler,
+                              delivery_info: delivery_info,
+                              properties: properties,
+                              payload: payload
+        end
+      end
+
+      @channel.work_pool.join
+    end
+
+    def handle_request(queue_name:, handler:, delivery_info:, properties:, payload:)
+      id       = nil
+      reply_to = properties[:reply_to]
+
+      begin
+        id, method, params = self.decode payload
+
+        validate_request method: method
+
+        result = handler.call id: id,
+                              method: method,
+                              params: params,
+                              meta: {
+                                reply_to: reply_to
+                              }
+      rescue => err
+        error = self.build_error_response err
+      end
+
+      response = { 'jsonrpc' => '2.0', 'id' => id }
+
+      if error
+        response['error'] = error
+      else
+        response['result'] = result
+      end
+
+      @exchange.publish Oj.dump(response), routing_key: reply_to,
+                                           correlation_id: id
+    end
+
+    protected
+
+    def decode(payload)
+      payload = Oj.load payload
+
+      id     = payload['id']
+      method = payload['method']
+      params = payload['params']
+
+      [id, method, params]
+    end
+
+    # Raises if elements of the request do not comply with the spec
+    def validate_request(request)
+      raise Errors::InvalidRequestError.new("Missing `method' Request object member") unless request[:method]
+    end
+
+    # Convert a Ruby error into a hash complying with the JSON-RPC spec
+    # for `Error` response objects
+    def build_error_response(err)
+      if err.is_a? Errors::BaseError
+        err.to_response
+
+      elsif err.is_a? NoMethodError
+        { 'code' => -32601, 'message' => 'Method not found' }
+
+      else
+        response = {
+          'code' => 0,
+          'message' => err.message
+        }
+
+        response['data'] = err.data if err.respond_to? :data
+
+        response
+      end
+    end
+  end
+end

data/lib/fluffle/version.rb

@@ -0,0 +1,3 @@
+module Fluffle
+  VERSION = '0.0.1'
+end

data/lib/fluffle.rb

@@ -0,0 +1,20 @@
+require 'bunny'
+
+require 'fluffle/version'
+require 'fluffle/client'
+require 'fluffle/errors'
+require 'fluffle/handlers/base'
+require 'fluffle/handlers/delegator'
+require 'fluffle/handlers/dispatcher'
+require 'fluffle/server'
+
+module Fluffle
+  # Expand a short name into a fully-qualified one
+  def self.request_queue_name(name)
+    "fluffle.requests.#{name}"
+  end
+
+  def self.response_queue_name(name)
+    "fluffle.responses.#{name}"
+  end
+end

data/spec/server_spec.rb

@@ -0,0 +1,116 @@
+require 'spec_helper'
+
+describe Fluffle::Server do
+  describe '#handle_request' do
+    before do
+      @exchange_spy = exchange_spy = spy 'Exchange'
+
+      subject.instance_eval do
+        @exchange = exchange_spy
+      end
+    end
+
+    def id
+      @id = '123' unless instance_variable_defined? :@id
+      @id
+    end
+
+    def method
+      @method = 'do_something' unless instance_variable_defined? :@method
+      @method
+    end
+
+    def params
+      @params = [] unless instance_variable_defined? :@params
+      @params
+    end
+
+    def reply_to
+      @reply_to = 'fakeclient' unless instance_variable_defined? :@reply_to
+      @reply_to
+    end
+
+    def make_request(payload: {}, handler:)
+      payload['jsonrpc'] = '2.0'  unless payload.key? 'jsonrpc'
+      payload['id']      = id     unless payload.key? 'id'
+      payload['method']  = method unless payload.key? 'method'
+      payload['params']  = params unless payload.key? 'params'
+
+      subject.handle_request queue_name: 'fakequeue',
+                             handler: handler,
+                             delivery_info: double('DeliveryInfo'),
+                             properties: { reply_to: reply_to },
+                             payload: Oj.dump(payload)
+    end
+
+    def expect_response(payload:, routing_key: nil, correlation_id: nil)
+      routing_key    ||= reply_to
+      correlation_id ||= id
+
+      payload['jsonrpc'] ||= '2.0'
+      payload['id']      ||= id
+
+      expect(@exchange_spy).to have_received(:publish) do |payload_json, opts|
+        expect(Oj.load(payload_json)).to eq payload
+
+        expect(opts).to eq routing_key: routing_key,
+                           correlation_id: correlation_id
+      end
+    end
+
+    it 'responds with the result for a normal request' do
+      @params = ['bar']
+
+      result = 'baz'
+
+      handler = double 'Handler'
+      expect(handler).to receive(:call) do |args|
+        expect(args).to eq({
+          id: id,
+          method: method,
+          params: params,
+          meta: { reply_to: reply_to }
+        })
+
+        result
+      end
+
+      make_request handler: handler
+
+      expect_response payload: { 'result' => result }
+    end
+
+    it 'responds with the appropriate code and message when method not found' do
+      @method = 'notfound'
+
+      handler = double 'Handler'
+      expect(handler).to receive(:call).and_raise(NoMethodError.new("undefined method `#{method}'"))
+
+      make_request handler: handler
+
+      expect_response payload: {
+                        'error' => {
+                          'code'    => -32601,
+                          'message' => 'Method not found'
+                        }
+                      }
+    end
+
+    it "responds with the appropriate code and message when `method' isn't supplied" do
+      @method = nil
+
+      handler = double 'Handler'
+      expect(handler).not_to receive(:call)
+
+      make_request handler: handler
+
+      expect_response payload: {
+                        'error' => {
+                          'code' => -32600,
+                          'message' => 'Invalid Request',
+                          'data' => { 'description' => "Missing `method' Request object member" }
+                        }
+                      }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'bundler/setup'
+
+require 'fluffle'

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification
+name: fluffle
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Dirk Gadsden
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-08-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bunny
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.17.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.17.1
+- !ruby/object:Gem::Dependency
+  name: uuidtools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.5
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 11.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 11.2.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+description: 
+email:
+- dirk@esherido.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- examples/client.rb
+- examples/server.rb
+- fluffle.gemspec
+- fluffle.jpg
+- lib/fluffle.rb
+- lib/fluffle/client.rb
+- lib/fluffle/connectable.rb
+- lib/fluffle/errors.rb
+- lib/fluffle/handlers/base.rb
+- lib/fluffle/handlers/delegator.rb
+- lib/fluffle/handlers/dispatcher.rb
+- lib/fluffle/server.rb
+- lib/fluffle/version.rb
+- spec/server_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/Everlane/fluffle
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Client and server implementations for JSON-RPC over RabbitMQ
+test_files: []