skein 0.3.7 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b32f15d7b24be749e57fd000f914ce2c6bebe627
-  data.tar.gz: 9b385eeed01567244a1a1840dbe0a85dbce02e09
+SHA256:
+  metadata.gz: 1f9116f29d28ed7c32ceda7ae576d7339b5d10d25232b15d785468823622e2b1
+  data.tar.gz: 186e7299d4e36079bd527dd6829ec5cb882ba26447be7ec126605fde7c6c8de9
 SHA512:
-  metadata.gz: 81c8f2c46312e393ee8d226d353292e4cd83c56b209fe73f25165a42468ac55c4f8511b9afba0f66d075199b928259c56a2545a2c8f00584ca0909c9b158496b
-  data.tar.gz: 11e302e24b88f989c80e750c3f2da37ba8720d51c68bc4da93b473186dba9df800fb3d15bc5c02f3d4f175ed7fe79a1e07a8d185cdf9bf00a3d12a25b6c532ce
+  metadata.gz: 2d0229f1b32971be57e3b1164af63c3fdbfbb46cc29bd277ad7a95341e880d32a8056f7a917b5178ddf5319d58c7856f9c599475f5508cd1da27c02b6f6e5744
+  data.tar.gz: c960a2492da91dc3595658a48e86cae0ac9e627c15d156fbbcf615a24c2d49ea14e5b01512748b50bece8c06013686c680234a25bd2d11952c66aa6d528b16cb

data/Gemfile

@@ -1,8 +1,11 @@
 source 'https://rubygems.org'
 
-gem 'birling'
+gem 'birling', '>= 0.2.0'
 
 group :development, :test do
+  gem 'bunny', platforms: :ruby
+  gem 'march_hare', platforms: :jruby
+
   gem 'rake'
   gem 'jeweler'
   gem 'test-unit'

data/Gemfile.lock

@@ -1,57 +1,68 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.5.0)
-      public_suffix (~> 2.0, >= 2.0.2)
-    birling (0.1.3)
-    builder (3.2.3)
+    addressable (2.4.0)
+    amq-protocol (2.3.2)
+    birling (0.3.1)
+    builder (3.2.4)
+    bunny (2.19.0)
+      amq-protocol (~> 2.3, >= 2.3.1)
+      sorted_set (~> 1, >= 1.0.2)
     descendants_tracker (0.0.4)
       thread_safe (~> 0.3, >= 0.3.1)
     faraday (0.9.2)
       multipart-post (>= 1.2, < 3)
-    git (1.3.0)
-    github_api (0.11.3)
-      addressable (~> 2.3)
-      descendants_tracker (~> 0.0.1)
+    git (1.9.1)
+      rchardet (~> 1.8)
+    github_api (0.16.0)
+      addressable (~> 2.4.0)
+      descendants_tracker (~> 0.0.4)
       faraday (~> 0.8, < 0.10)
-      hashie (>= 1.2)
-      multi_json (>= 1.7.5, < 2.0)
-      nokogiri (~> 1.6.0)
-      oauth2
-    hashie (3.5.5)
-    highline (1.7.8)
-    jeweler (2.3.3)
+      hashie (>= 3.4)
+      mime-types (>= 1.16, < 3.0)
+      oauth2 (~> 1.0)
+    hashie (4.1.0)
+    highline (2.0.3)
+    jeweler (2.3.9)
       builder
-      bundler (>= 1.0)
+      bundler
       git (>= 1.2.5)
-      github_api (~> 0.11.0)
+      github_api (~> 0.16.0)
       highline (>= 1.6.15)
       nokogiri (>= 1.5.10)
-      psych (~> 2.2)
+      psych
       rake
       rdoc
       semver2
-    jwt (1.5.6)
-    mini_portile2 (2.1.0)
-    multi_json (1.12.1)
+    jwt (2.2.3)
+    mime-types (2.99.3)
+    mini_portile2 (2.6.1)
+    multi_json (1.15.0)
     multi_xml (0.6.0)
-    multipart-post (2.0.0)
-    nokogiri (1.6.8.1)
-      mini_portile2 (~> 2.1.0)
-    oauth2 (1.3.1)
-      faraday (>= 0.8, < 0.12)
-      jwt (~> 1.0)
+    multipart-post (2.1.1)
+    nokogiri (1.12.4)
+      mini_portile2 (~> 2.6.1)
+      racc (~> 1.4)
+    oauth2 (1.4.7)
+      faraday (>= 0.8, < 2.0)
+      jwt (>= 1.0, < 3.0)
       multi_json (~> 1.3)
       multi_xml (~> 0.5)
       rack (>= 1.2, < 3)
-    power_assert (1.0.1)
-    psych (2.2.4)
-    public_suffix (2.0.5)
-    rack (2.0.1)
-    rake (12.0.0)
-    rdoc (5.1.0)
+    power_assert (2.0.1)
+    psych (4.0.1)
+    racc (1.5.2)
+    rack (2.2.3)
+    rake (13.0.6)
+    rbtree (0.4.4)
+    rchardet (1.8.0)
+    rdoc (6.3.2)
     semver2 (3.4.2)
-    test-unit (3.2.3)
+    set (1.0.1)
+    sorted_set (1.0.3)
+      rbtree
+      set (~> 1.0)
+    test-unit (3.4.7)
       power_assert
     thread_safe (0.3.6)
 
@@ -59,10 +70,12 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  birling
+  birling (>= 0.2.0)
+  bunny
   jeweler
+  march_hare
   rake
   test-unit
 
 BUNDLED WITH
-   1.14.6
+   2.2.27

data/LICENSE.md

@@ -1,4 +1,4 @@
-Copyright (c) 2016 Scott Tadman, PostageApp
+Copyright (c) 2016-2019 Scott Tadman, PostageApp Ltd.
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,8 +1,8 @@
 # Skein
 
-[Skein](https://en.wikipedia.org/wiki/V_formation) is a RabbitMQ-based standard
-and implementation for Ruby that defines how to dispatch
-[JSON-RPC](http://json-rpc.org) jobs over AMQP.
+[Skein](https://en.wikipedia.org/wiki/V_formation) is a RabbitMQ-based method
+for handling remote procedure calls (RPC) and pub/sub channels over AMQP using
+[JSON-RPC](http://json-rpc.org) payloads.
 
 ## Dependencies
 
@@ -10,7 +10,7 @@ This library requires an active AMQP server like [RabbitMQ](http://rabbitmq.com)
 and a Ruby driver for AMQP like [Bunny](http://rubybunny.info) or
 [March Hare](http://rubymarchhare.info).
 
-Both jRuby and MRI Ruby are supported.
+Both JRuby and MRI Ruby are supported with the appropriate driver.
 
 ## Installation
 
@@ -55,3 +55,8 @@ a `Skein::Client::Worker` instance:
     end
 
     Responder.new('test_queue')
+
+## Debugging
+
+Setting the environment variable `SKEIN_DEBUG_JSON` will show raw JSON
+payloads received by both RPC workers and clients.

data/RELEASES.md

@@ -1,3 +1,5 @@
+* 0.7.1 - Allow setting of default Skein.config configuration
+* 0.7.0 - Automatic recovering from closed RabbitMQ channels
 * 0.3.0 - Adding EventMachine compatibility
 * 0.2.1 - Cleaning up RPC interface with blocking vs. non-blocking
 * 0.2.0 - First working version in JRuby/MRI Ruby

data/VERSION

@@ -1 +1 @@
-0.3.7
+0.8.1

data/bin/skein

@@ -128,7 +128,7 @@ when 'subscribe'
   end
 when 'echo'
   rescue_safely(options) do
-    results = Queue.new
+    results = TimeoutQueue.new
 
     start = Time.now
 

data/examples/echo

@@ -0,0 +1,66 @@
+#!/usr/bin/env ruby
+
+# == Imports ================================================================
+
+require 'optparse'
+require 'securerandom'
+require 'bundler/setup'
+
+Bundler.require(:default)
+
+require_relative '../lib/skein'
+
+# == Support Classes ========================================================
+
+# == Main ===================================================================
+
+config = Skein::Config.new
+
+config.queue = 'skein-echo-test'
+
+options = {
+  repeat: false
+}
+
+program = OptionParser.new do |opts|
+  opts.on('-q', '--queue NAME', 'Queue to listen on') do |s|
+    config.queue = s
+  end
+  opts.on('-e', '--exchange NAME', 'Exchange to attach to') do |s|
+    config.exchange = s
+  end
+  opts.on('-u', '--username NAME', 'Authenticate with username') do |s|
+    config.username = s
+  end
+  opts.on('-p', '--password NAME', 'Authenticate with password') do |s|
+    config.password = s
+  end
+  opts.on('-H', '--host NAME', 'Connect to RabbitMQ host') do |s|
+    config.host = s
+  end
+  opts.on('-P', '--port NAME', 'Connect to RabbitMQ port') do |s|
+    config.port = s.to_i
+  end
+  opts.on('-r', '--repeat', 'Repeat echo') do |s|
+    options[:repeat] = true
+  end
+end
+
+program.parse!(ARGV)
+
+client = Skein::Client.new(
+  connection: Skein::RabbitMQ.connect(config)
+)
+
+rpc = client.rpc(config.exchange, routing_key: config.queue)
+threads = Hash.new { |h,k| h[k] = h.length }
+
+loop do
+  puts rpc.echo(SecureRandom.uuid)
+
+  if (options[:repeat])
+    sleep(1)
+  else
+    break
+  end
+end

data/examples/echo-server

@@ -0,0 +1,77 @@
+#!/usr/bin/env ruby
+
+# == Imports ================================================================
+
+require 'optparse'
+require 'bundler/setup'
+
+Bundler.require(:default)
+
+require_relative '../lib/skein'
+
+# == Support Classes ========================================================
+
+class EchoWorker < Skein::Client::Worker
+  def echo(*args)
+    puts "Received: #{args.inspect}"
+
+    args
+  end
+end
+
+# == Main ===================================================================
+
+config = Skein::Config.new
+
+config.queue = 'skein-echo-test'
+config.concurrency = 1
+
+program = OptionParser.new do |opts|
+  opts.on('-q', '--queue NAME', 'Queue to listen on') do |s|
+    config.queue = s
+  end
+  opts.on('-e', '--exchange NAME', 'Exchange to attach to') do |s|
+    config.exchange = s
+  end
+  opts.on('-u', '--username NAME', 'Authenticate with username') do |s|
+    config.username = s
+  end
+  opts.on('-p', '--password NAME', 'Authenticate with password') do |s|
+    config.password = s
+  end
+  opts.on('-H', '--host NAME', 'Connect to RabbitMQ host') do |s|
+    config.host = s
+  end
+  opts.on('-P', '--port NAME', 'Connect to RabbitMQ port') do |s|
+    config.port = s.to_i
+  end
+  opts.on('-w', '--workers COUNT', 'Set workers count') do |s|
+    config.concurrency = s.to_i
+  end
+end
+
+program.parse!(ARGV)
+
+worker = EchoWorker.new(
+  config.queue,
+  exchange_name: config.exchange,
+  concurrency: config.concurrency,
+  connection: Skein::RabbitMQ.connect(config)
+)
+
+puts "EchoWorker active on #{config.queue}"
+
+Signal.trap('INT') do |signal|
+  # Force quit immediately, don't wait on threads
+  Process.exit!(0)
+end
+
+Signal.trap('QUIT') do |signal|
+  puts "\r Threads: #{Thread.list.length}"
+  Thread.list.each do |thread|
+    puts '#%s %s' % [ thread.object_id, thread.name ]
+    puts thread.backtrace.join("\n")
+  end
+end
+
+worker.join

data/lib/skein/adapter.rb

@@ -1,6 +1,9 @@
 module Skein::Adapter
   # == Mixin Methods =========================================================
   
+  # REFACTOR: This should be converted into a proper subclass of the
+  #           various drivers that does the method re-writing at a lower level.
+  
   def subscribe(queue, block: true, manual_ack: true)
     case (queue.class.to_s.split(/::/)[0])
     when 'Bunny'

data/lib/skein/client/publisher.rb

@@ -1,14 +1,22 @@
 class Skein::Client::Publisher < Skein::Connected
   # == Instance Methods =====================================================
 
-  def initialize(queue_name, connection: nil, context: nil)
+  def initialize(exchange_name, type: nil, durable: nil, connection: nil, context: nil)
     super(connection: connection, context: context)
 
-    @queue = self.channel.topic(queue_name)
+    @queue = self.channel.send(type || :topic, exchange_name, durable: durable)
   end
 
   def publish!(message, routing_key = nil)
     @queue.publish(JSON.dump(message), routing_key: routing_key)
   end
   alias_method :<<, :publish!
+
+  def close(delete_queue: false)
+    if (delete_queue)
+      @queue.delete
+    end
+
+    super()
+  end
 end

data/lib/skein/client/rpc.rb

@@ -2,6 +2,11 @@ require 'securerandom'
 require 'fiber'
 
 class Skein::Client::RPC < Skein::Connected
+  # == Exceptions ===========================================================
+
+  class RPCException < Exception
+  end
+
   # == Constants ============================================================
 
   EXCHANGE_NAME_DEFAULT = ''.freeze
@@ -10,30 +15,70 @@ class Skein::Client::RPC < Skein::Connected
 
   # == Instance Methods =====================================================
 
-  def initialize(exchange_name = nil, routing_key: nil, connection: nil, context: nil)
-    super(connection: connection, context: context)
+  def initialize(exchange_name = nil, routing_key: nil, connection: nil, context: nil, ident: nil, expiration: nil, persistent: true, durable: true, timeout: nil)
+    super(connection: connection, context: context, ident: ident)
 
-    @rpc_exchange = self.channel.direct(exchange_name || EXCHANGE_NAME_DEFAULT, durable: true)
     @routing_key = routing_key
+    @timeout = timeout
+
+    @rpc_exchange = self.channel.direct(
+      exchange_name || EXCHANGE_NAME_DEFAULT,
+      durable: durable
+    )
+
     @response_queue = self.channel.queue(
       @ident,
       durable: false,
       header: true,
       auto_delete: true
     )
+    @expiration = expiration
+    @persistent = !!persistent
 
     @callback = { }
 
     @consumer = Skein::Adapter.subscribe(@response_queue, block: false) do |payload, delivery_tag, reply_to|
       self.context.trap do
+        if (ENV['SKEIN_DEBUG_JSON'])
+          $stdout.puts(payload)
+        end
+
         response = JSON.load(payload)
 
         if (callback = @callback.delete(response['id']))
-          case (callback)
-          when Queue
-            callback << response['result']
-          when Proc
-            callback.call
+          if (response['error'])
+            exception =
+              case (response['error'] and response['error']['code'])
+              when -32601
+                NoMethodError.new(
+                  "%s from `%s' RPC call" % [
+                    response.dig('error', 'message'),
+                    response.dig('error', 'data', 'method')
+                  ]
+                )
+              when -32602
+                ArgumentError.new(
+                  response.dig('error', 'data', 'message') || 'wrong number of arguments'
+                )
+              else
+                RPCException.new(
+                  response.dig('error', 'data', 'message') || response.dig('error', 'message')
+                )
+              end
+
+            case (callback)
+            when Skein::TimeoutQueue
+              callback << exception
+            when Proc
+              callback.call(exception)
+            end
+          else
+            case (callback)
+            when Skein::TimeoutQueue
+              callback << response['result']
+            when Proc
+              callback.call(response['result'])
+            end
           end
         end
 
@@ -42,20 +87,31 @@ class Skein::Client::RPC < Skein::Connected
     end
   end
 
+  # Temporarily deliver RPC calls to a different routing key. The supplied
+  # block is executed with this temporary routing in effect.
+  def reroute!(routing_key)
+    routing_key, @routing_key = @routing_key, routing_key
+
+    yield if (block_given?)
+
+    @routing_key = routing_key
+  end
+
   def close
-    @consumer and @consumer.cancel
+    @consumer&.cancel
     @consumer = nil
 
     super
   end
 
-  def method_missing(name, *args)
+  def method_missing(name, *args, &block)
     name = name.to_s
 
     blocking = !name.sub!(/!\z/, '')
 
     message_id = SecureRandom.uuid
     request = JSON.dump(
+      jsonrpc: '2.0',
       method: name,
       params: args,
       id: message_id
@@ -66,26 +122,29 @@ class Skein::Client::RPC < Skein::Connected
       routing_key: @routing_key,
       reply_to: blocking ? @ident : nil,
       content_type: 'application/json',
-      message_id: message_id
+      message_id: message_id,
+      persistent: @persistent,
+      expiration: @expiration
     )
 
     if (block_given?)
       @callback[message_id] =
         if (defined?(EventMachine))
-          EventMachine.next_tick do
-            yield
-          end
+          EventMachine.next_tick(&block)
         else
-          lambda do
-            yield
-          end
+          block
         end
     elsif (blocking)
-      queue = Queue.new
+      queue = Skein::TimeoutQueue.new(blocking: true, timeout: @timeout)
 
       @callback[message_id] = queue
 
-      queue.pop
+      case (result = queue.pop)
+      when Exception
+        raise result
+      else
+        result
+      end
     end
   end
 end