skein 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6896b1151e348573c5b58ee131b6f568373d7547
+  data.tar.gz: 4ae4f3c7de9c5eaf0d17e9e0ec77ef02390824f1
+SHA512:
+  metadata.gz: 32a30b3dc6c37ac747d372f9379f90463f0c36de086ef2eb464eedc0d5f93b8b88e8737c5d0cd3a42dcbed0ccdd0d12e43bf2ac6f4f7679527d7f2e8e8aa88cc
+  data.tar.gz: fb8169c2061892dbe1c2c05da18a672646e09abf773a020ccbe556cabdbc997b6c8d85548f8392a751d834dc7a13c1970e59147d7d73d58d778caa3be50cafde

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gem 'birling'
+
+group :development, :test do
+  gem 'rake'
+  gem 'jeweler'
+  gem 'test-unit'
+end

data/Gemfile.lock

@@ -0,0 +1,69 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.0)
+      public_suffix (~> 2.0, >= 2.0.2)
+    birling (0.1.3)
+    builder (3.2.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)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 1.2)
+      multi_json (>= 1.7.5, < 2.0)
+      nokogiri (~> 1.6.0)
+      oauth2
+    hashie (3.4.6)
+    highline (1.7.8)
+    jeweler (2.1.2)
+      builder
+      bundler (>= 1.0)
+      git (>= 1.2.5)
+      github_api (~> 0.11.0)
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      rake
+      rdoc
+      semver
+    jwt (1.5.6)
+    mini_portile2 (2.1.0)
+    multi_json (1.12.1)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    nokogiri (1.6.8.1)
+      mini_portile2 (~> 2.1.0)
+    nokogiri (1.6.8.1-java)
+    oauth2 (1.2.0)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (>= 1.2, < 3)
+    power_assert (0.3.1)
+    public_suffix (2.0.4)
+    rack (2.0.1)
+    rake (11.3.0)
+    rdoc (5.0.0)
+    semver (1.0.1)
+    test-unit (3.2.1)
+      power_assert
+    thread_safe (0.3.5)
+    thread_safe (0.3.5-java)
+
+PLATFORMS
+  java
+  ruby
+
+DEPENDENCIES
+  birling
+  jeweler
+  rake
+  test-unit
+
+BUNDLED WITH
+   1.13.6

data/README.md

@@ -0,0 +1,57 @@
+# 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.
+
+## Dependencies
+
+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.
+
+## Installation
+
+The default [Bundler](http://bundler.io) configuration should be a good place
+to start:
+
+    bundle install
+
+## Configuration
+
+For testing, set up `config/rabbitmq.yml` with configuration parameters that
+define how to connect to RabbitMQ.
+
+## Client Modes
+
+### RPC
+
+An RPC client can make blocking or non-blocking calls. By default calls are
+blocking, but they can be made non-blocking by adding `!` to the end of the
+method name. For example:
+
+    client = Skein::Client.rpc('test_queue')
+
+    client.request!(test: 'data')
+
+    client.close
+
+Note that non-blocking calls are fire-and-forget, there is no way of knowing
+if that operation succeeded or failed.
+
+### Worker
+
+The back-end that receives and processes RPC calls is instantiated as
+a `Skein::Client::Worker` instance:
+
+    class Responder < Skein::Client::Worker
+      def request
+        {
+          result: true
+        }
+      end
+    end
+
+    Responder.new('test_queue')

data/RELEASES.md

@@ -0,0 +1,4 @@
+* 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
+* 0.1.0 - Proof of concept prototype.

data/Rakefile

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+
+require 'rake/testtask'
+
+# -- Jeweler ----------------------------------------------------------------
+
+require 'jeweler'
+
+Jeweler::Tasks.new do |gem|
+  gem.name = 'skein'
+  gem.homepage = 'http://github.com/postageapp/skein'
+  gem.license = 'closed'
+  gem.summary = %Q{RabbitMQ RPC/PubSub Library}
+  gem.description = %Q{Wrapper for RabbitMQ that makes blocking RPC calls and handles pub-sub broadcasts.}
+  gem.email = 'tadman@postageapp.com'
+  gem.authors = [ 'Scott Tadman' ]
+end
+
+Jeweler::RubygemsDotOrgTasks.new
+
+# -- test/unit --------------------------------------------------------------
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/**/test*.rb']
+  t.verbose = true
+  t.warning = !!ENV['RUBY_WARN']
+end
+
+task default: :test

data/VERSION

@@ -0,0 +1 @@
+0.3.0

data/bin/skein

@@ -0,0 +1,186 @@
+#!/usr/bin/env ruby
+
+# == Imports ================================================================
+
+require 'optparse'
+require 'thread'
+
+require_relative '../lib/skein'
+
+# == Support Classes ========================================================
+
+class EchoWorker < Skein::Client::Worker
+  def initialize(queue_name, options = nil)
+    super(queue_name, options || { })
+
+    @debug = options && options[:debug]
+  end
+
+  def echo(text)
+    if (@debug)
+      puts text
+    end
+
+    text
+  end
+end
+
+# == Support Methods ========================================================
+
+def rescue_safely(options)
+  yield
+
+rescue Object => e
+  $stderr.puts('[%s] %s' % [ e.class, e ])
+
+  if (options[:trace])
+    $stderr.puts(e.backtrace)
+  end
+
+  exit(-1)
+end
+
+def in_thread(options)
+  Thread.new do
+    begin
+      Thread.abort_on_exception = true
+
+      rescue_safely(options) do
+        yield
+      end
+    end
+  end
+end
+
+# == Main ===================================================================
+
+options = {
+  count: 1,
+  threads: 1
+}
+
+parser = OptionParser.new do |parser|
+  parser.on('-v', '--verbose') do
+    options[:verbose] = true
+  end
+
+  parser.on('-n', '--count=n') do |n|
+    options[:count] = n.to_i
+  end
+  parser.on('-c', '--threads=n') do |n|
+    options[:threads] = n.to_i
+  end
+  parser.on('-t', '--trace') do
+    options[:trace] = true
+  end
+  parser.on('-d', '--debug') do
+    options[:debug] = true
+  end
+
+  parser.on('-h', '--help') do
+    puts parser
+    exit(0)
+  end
+end
+
+Skein::RabbitMQ.force_require!
+
+args = parser.parse(*ARGV)
+
+case (command = args.shift)
+when 'config'
+  Skein::Support.hash_format(Skein.config).each do |line|
+    puts line
+  end
+when 'test'
+  rescue_safely(options) do
+    Skein::RabbitMQ.connect
+
+    puts '[OK] Connection succeeded.'
+  end
+when 'publish'
+  rescue_safely(options) do
+    publisher = Skein::Client.publisher('test_pubsub')
+
+    loop do
+      publisher << { test: Time.now.to_f }
+
+      sleep(1)
+    end
+  end
+when 'subscribe'
+  rescue_safely(options) do
+    subscriber = Skein::Client.subscriber('test_pubsub')
+
+    subscriber.listen do |message, metadata|
+      puts metadata.inspect
+      puts message.inspect
+    end
+  end
+when 'echo'
+  rescue_safely(options) do
+    results = Queue.new
+
+    start = Time.now
+
+    count = Hash.new(0)
+
+    tabulator = Thread.new do
+      loop do
+        v = results.pop
+
+        break if (v.nil?)
+
+        count[v] += 1
+      end
+    end
+
+    options[:threads].times.map do
+      in_thread(options) do
+        client = Skein::Client.new
+        rpc = client.rpc('test_echo')
+
+        options[:count].times do |i|
+          test_data = SecureRandom.uuid
+
+          response = rpc.echo(test_data)
+
+          results << (response == test_data)
+
+          if (options[:verbose])
+            puts '[%s] %s (%d/%d)' % [
+              (response == test_data ? 'OK' : 'ERR'),
+              response.inspect,
+              i + 1,
+              options[:count]
+            ]
+          end
+        end
+
+        rpc.close
+        client.close
+      end
+    end.each(&:join)
+
+    results << nil
+    tabulator.join
+
+    elapsed = Time.now - start
+
+    puts 'Success: %d Failed: %d in %.1fms [%d mps]' % [
+      count[true],
+      count[false],
+      elapsed.to_f * 1000,
+      count[true] > 0 ? (count[true].to_f / elapsed.to_f) : 0
+    ]
+  end
+when 'echo_server'
+  rescue_safely(options) do
+    options[:threads].times.map do
+      EchoWorker.new('test_echo')
+    end.each(&:join)
+  end
+else
+  $stderr.puts('Unknown command: %s' % command)
+  exit(-1)
+end

data/config/.gitignore

@@ -0,0 +1,3 @@
+*.yml
+*.json
+

data/config/skein.yml.example

@@ -0,0 +1,11 @@
+defaults: &defaults
+  host: 127.0.0.1
+  port: 5672
+  username: guest
+  password: guest
+
+development:
+  <<: *defaults
+
+test:
+  <<: *defaults

data/lib/skein.rb

@@ -0,0 +1,24 @@
+require 'json'
+
+module Skein
+  VERSION = File.read(File.expand_path('../VERSION', File.dirname(__FILE__))).chomp.freeze
+
+  def self.version
+    VERSION
+  end
+
+  def self.config
+    @config ||= Skein::Config.new
+  end
+end
+
+require_relative './skein/connected'
+
+require_relative './skein/client'
+require_relative './skein/config'
+require_relative './skein/context'
+require_relative './skein/handler'
+require_relative './skein/rabbitmq'
+require_relative './skein/reporter'
+require_relative './skein/rpc'
+require_relative './skein/support'

data/lib/skein/client.rb

@@ -0,0 +1,51 @@
+require 'securerandom'
+require 'fiber'
+
+class Skein::Client < Skein::Connected
+  # == Properties ===========================================================
+
+  # == Class Methods ========================================================
+
+  def self.rpc(*args)
+    new.rpc(*args)
+  end
+
+  def self.receiver(*args)
+    new.receiver(*args)
+  end
+
+  def self.publisher(*args)
+    new.publisher(*args)
+  end
+
+  def self.subscriber(*args)
+    new.subscriber(*args)
+  end
+
+  # == Instance Methods =====================================================
+
+  def initialize(connection: nil, context: nil)
+    super(connection: connection, context: context)
+  end
+
+  def rpc(queue_name = nil)
+    Skein::Client::RPC.new(queue_name, connection: self.connection, context: self.context)
+  end
+
+  def receiver
+    Skein::Client::Receiver.new(connection: self.connection, context: self.context)
+  end
+
+  def publisher(queue_name)
+    Skein::Client::Publisher.new(queue_name, connection: self.connection, context: self.context)
+  end
+
+  def subscriber(queue_name, routing_key = nil)
+    Skein::Client::Subscriber.new(queue_name, routing_key, connection: self.connection, context: self.context)
+  end
+end
+
+require_relative './client/publisher'
+require_relative './client/rpc'
+require_relative './client/subscriber'
+require_relative './client/worker'