librmdp 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.idea

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'minitest'
+gem 'simplecov', :require => false, :group => :test
+# Specify your gem's dependencies in librmdp.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Benoist
+
+MIT License
+
+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,54 @@
+# Librmdp
+
+A ruby implementation of the majordomo pattern
+http://rfc.zeromq.org/spec:7
+
+At this stage it's in POC stage. Use at own risk.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'librmdp'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install librmdp
+
+## Usage
+
+Start a broker
+==============
+
+    broker = Majordomo::Broker.new
+    broker.mediate
+
+Build a worker with 'echo' as service name
+==========================================
+
+    worker = Majordomo::Worker.new('tcp://0.0.0.0:5555', 'echo')
+
+    loop do
+      request = worker.receive_message(reply_to = '')
+      # do something with a request
+      worker.send_message(request, reply_to)
+    end
+
+Build a client
+==============
+    client = Majordomo::Client.new('tcp://0.0.0.0:5555')
+    client.send_message('echo', 'a')
+
+    response = client.receive_message
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs.push "lib"
+  t.libs.push "test"
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end
+desc "Run tests"
+task :default => :test

data/lib/librmdp.rb

@@ -0,0 +1,20 @@
+require 'ffi-rzmq'
+require 'majordomo/version'
+
+module Majordomo
+  CLIENT = 'MDPC01'
+  WORKER = 'MDPW01'
+
+  READY              = "\x01"
+  REQUEST            = "\x02"
+  REPLY              = "\x03"
+  HEARTBEAT          = "\x04"
+  DISCONNECT         = "\x05"
+  HEARTBEAT_LIVENESS = 3    #  3-5 is reasonable
+  HEARTBEAT_INTERVAL = 1000 #  msecs
+  HEARTBEAT_EXPIRY   = HEARTBEAT_INTERVAL * HEARTBEAT_LIVENESS
+end
+
+require 'majordomo/broker'
+require 'majordomo/worker'
+require 'majordomo/client'

data/lib/majordomo/broker.rb

@@ -0,0 +1,125 @@
+require 'majordomo/broker/service'
+require 'majordomo/broker/worker'
+
+module Majordomo
+  class Broker
+
+    attr_accessor :workers, :waiting, :services, :socket
+
+    def initialize(bind = 'tcp://*:5555')
+      @context      = ZMQ::Context.new
+      @socket       = @context.socket(ZMQ::ROUTER)
+      @poller       = ZMQ::Poller.new
+      @services     = {}
+      @workers      = {}
+      @waiting      = []
+      @heartbeat_at = Time.now + 0.001 * HEARTBEAT_INTERVAL
+
+      @socket.bind(bind)
+      @poller.register(@socket, ZMQ::POLLIN)
+      trap(:INT) { exit }
+      at_exit { destroy }
+    end
+
+    def mediate
+      loop do
+        items = @poller.poll(HEARTBEAT_INTERVAL)
+
+        if items > 0
+          @socket.recv_strings(message = [])
+          sender = message.shift
+          message.shift #empty
+          header = message.shift
+          case header
+            when CLIENT
+              message_client(sender, message)
+            when WORKER
+              message_worker(sender, message)
+          end
+        end
+
+        if Time.now > @heartbeat_at
+          purge
+          waiting.each do |worker|
+            worker.send_message(HEARTBEAT)
+          end
+          @heartbeat_at = Time.now + 0.001 * HEARTBEAT_INTERVAL
+          puts "Heartbeat #{waiting.count}"
+        end
+      end
+    end
+
+    def destroy
+      @socket.close
+      @context.terminate
+    end
+
+    def bind(endpoint)
+      @socket.bind(endpoint)
+    end
+
+    def message_worker(sender, message)
+      command      = message.shift
+      identity     = sender.unpack('H*').first
+      worker_ready = !!@workers[identity]
+
+      worker = Worker.require(self, sender)
+
+      case command
+        when READY
+          if worker_ready
+            worker.delete(true)
+          else
+            service        = message.shift
+            worker.service = Service.require(self, service)
+            @waiting << worker
+            worker.service.waiting << worker
+            worker.service.workers += 1
+            worker.expires_at      = Time.now + 0.001 * HEARTBEAT_EXPIRY
+            worker.service.dispatch
+          end
+        when REPLY
+          if worker_ready
+            client = message.shift
+            message.shift
+            message.unshift(worker.service.name)
+            message.unshift(CLIENT)
+            message.unshift(nil)
+            message.unshift(client)
+            @socket.send_strings(message)
+          else
+            worker.delete(true)
+          end
+        when HEARTBEAT
+          if worker_ready
+            if @waiting.any?
+              @waiting.delete(worker)
+              @waiting << worker
+            end
+            worker.expires_at = Time.now + 0.001 * HEARTBEAT_EXPIRY
+          else
+            worker.delete(true)
+          end
+        when DISCONNECT
+          worker.delete(false)
+      end
+    end
+
+    def message_client(sender, message)
+      service_name = message.shift
+      service      = Service.require(self, service_name)
+
+      message.unshift nil
+      message.unshift sender
+
+      service.requests << message
+      service.dispatch
+    end
+
+    def purge
+      waiting.each do |worker|
+        worker.delete(false) if Time.now > worker.expires_at
+      end
+    end
+  end
+end

data/lib/majordomo/broker/service.rb

@@ -0,0 +1,52 @@
+require 'set'
+
+module Majordomo
+  class Broker
+    class Service
+      attr_accessor :broker, :name, :requests, :waiting, :workers, :blacklist
+
+      def initialize(broker, name)
+        @broker    = broker
+        @name      = name
+        @requests  = []
+        @waiting   = []
+        @workers   = 0
+        @blacklist = ::Set.new
+      end
+
+      def self.require(broker, name)
+        service = broker.services[name]
+
+        if service == nil
+          service               = self.new(broker, name)
+          broker.services[name] = service
+        end
+        service
+      end
+
+      def dispatch
+        broker.purge
+        return if waiting.empty?
+
+        while requests.any?
+          worker  = waiting.shift
+          message = requests.shift
+          worker.send_message(REQUEST, message)
+          waiting << worker
+        end
+      end
+
+      def enable_command(command)
+        @blacklist.delete(command)
+      end
+
+      def disable_command(command)
+        @blacklist.add(command)
+      end
+
+      def command_enabled?(command)
+        @blacklist.include?(command)
+      end
+    end
+  end
+end

data/lib/majordomo/broker/worker.rb

@@ -0,0 +1,47 @@
+module Majordomo
+  class Broker
+    class Worker
+      attr_accessor :broker, :identity, :address, :service, :expires_at
+
+      def initialize(broker, identity, address)
+        @broker   = broker
+        @identity = identity
+        @address  = address
+      end
+
+      def self.require(broker, address)
+        identity = address.unpack('H*').first
+        worker   = broker.workers[identity]
+
+        if worker == nil
+          worker                   = self.new(broker, identity, address)
+          broker.workers[identity] = worker
+        end
+
+        worker
+      end
+
+      def delete(disconnect)
+        if disconnect
+          send_message(DISCONNECT)
+        end
+
+        if service
+          service.waiting.delete(self)
+          service.workers -= 1
+        end
+        broker.waiting.delete(self)
+        broker.workers.delete(identity)
+      end
+
+      def send_message(command, message = [])
+        message.unshift(command)
+        message.unshift(WORKER)
+        message.unshift(nil)
+        message.unshift(address)
+
+        broker.socket.send_strings(message)
+      end
+    end
+  end
+end

data/lib/majordomo/client.rb

@@ -0,0 +1,44 @@
+module Majordomo
+  class Client
+    attr_accessor :timeout, :client
+
+    def initialize(broker)
+      @context = ZMQ::Context.new
+      @poller  = ZMQ::Poller.new
+      @broker  = broker
+
+      @timeout = 2500
+
+      connect_to_broker
+    end
+
+    def connect_to_broker
+      if @client
+        @poller.deregister(@client, ZMQ::POLLIN)
+        @client.close
+      end
+      @client = @context.socket(ZMQ::DEALER)
+      @client.connect(@broker)
+      @poller.register(@client, ZMQ::POLLIN)
+    end
+
+    def send_message(service, request)
+      request = [request] unless request.is_a?(Array)
+      request.unshift(service)
+      request.unshift(CLIENT)
+      request.unshift('')
+      @client.send_strings(request)
+    end
+
+    def receive_message
+      @client.recv_strings(message = [])
+      message.shift
+      header = message.shift
+      raise unless header == CLIENT
+
+      message.shift #service
+
+      message
+    end
+  end
+end

data/lib/majordomo/version.rb

@@ -0,0 +1,3 @@
+module Majordomo
+  VERSION = "0.0.1"
+end

data/lib/majordomo/worker.rb

@@ -0,0 +1,89 @@
+module Majordomo
+  class Worker
+    attr_accessor :broker, :service, :worker, :heartbeat_at, :heartbeat, :liveness, :reconnect
+
+    def initialize(broker, service)
+      @context = ZMQ::Context.new
+      @poller  = ZMQ::Poller.new
+      @broker  = broker
+      @service = service
+
+      @heartbeat = HEARTBEAT_INTERVAL
+      @reconnect = HEARTBEAT_INTERVAL
+      connect_to_broker
+
+      trap(:INT) { exit }
+      at_exit { destroy }
+    end
+
+    def destroy
+      @worker.close
+      @context.terminate
+    end
+
+    def connect_to_broker
+      if @worker
+        puts 'Closing connection to broker'
+        @poller.deregister(@worker, ZMQ::POLLIN)
+        @worker.close
+      end
+      @worker = @context.socket(ZMQ::DEALER)
+      @worker.connect(@broker)
+      @worker.setsockopt(ZMQ::LINGER, 0)
+      @poller.register(@worker, ZMQ::POLLIN)
+
+      send_to_broker(READY, [@service])
+      @liveness     = HEARTBEAT_LIVENESS
+      @heartbeat_at = Time.now + 0.001 * @heartbeat
+    end
+
+    def send_to_broker(command, message = [])
+      message.unshift(command)
+      message.unshift(WORKER)
+      message.unshift('')
+
+      worker.send_strings(message)
+    end
+
+    def receive_message(reply_to)
+      loop do
+        items = @poller.poll(@heartbeat)
+        if items > 0
+          @worker.recv_strings(message = [])
+
+          @liveness = HEARTBEAT_LIVENESS
+          message.shift
+          header = message.shift
+          raise unless header == WORKER
+
+          command = message.shift
+          case command
+            when REQUEST
+              reply_to << message.shift
+              message.shift
+              return message
+            when HEARTBEAT
+            # Do nothing
+            when DISCONNECT
+              connect_to_broker
+            else
+              raise
+          end
+        elsif (@liveness -= 1) == 0
+          sleep(@reconnect*0.001)
+          connect_to_broker
+        end
+
+        if Time.now > @heartbeat_at
+          send_to_broker(HEARTBEAT)
+        end
+      end
+    end
+
+    def send_message(report, reply_to)
+      report.unshift('')
+      report.unshift(reply_to)
+      send_to_broker(REPLY, report)
+    end
+  end
+end

data/librmdp.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'majordomo/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'librmdp'
+  spec.version       = Majordomo::VERSION
+  spec.authors       = ['Benoist']
+  spec.email         = %w(benoist.claassen@gmail.com)
+  spec.description   = %q{A ruby implementation of the ZeroMQ majordomo pattern v0.1}
+  spec.summary       = %q{A ruby implementation of the ZeroMQ majordomo pattern v0.1}
+  spec.homepage      = 'https://github.com/benoist/librmdp'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_dependency 'ffi-rzmq'
+end

data/test/client_test.rb

@@ -0,0 +1,18 @@
+require 'test_helper'
+
+class TestClient < MiniTest::Unit::TestCase
+
+  def setup
+    @client = Majordomo::Client.new('tcp://0.0.0.0:5555')
+  end
+
+  def test_connect_to_broker
+    @client.connect_to_broker
+    assert_kind_of ZMQ::Socket, @client.client
+
+    old_client = @client.client.dup
+    @client.connect_to_broker
+    refute_equal old_client, @client.client
+  end
+
+end

data/test/integration_test.rb

@@ -0,0 +1,47 @@
+require 'test_helper'
+
+class TestIntegration < MiniTest::Unit::TestCase
+  def setup
+    @threads                  = []
+    Thread.abort_on_exception = true
+  end
+
+  def start_broker
+    @threads << Thread.new do
+      Majordomo::Broker.new.mediate
+    end
+  end
+
+  def start_worker
+    @threads << Thread.new do
+      worker = Majordomo::Worker.new('tcp://0.0.0.0:5555', 'echo')
+
+      request = worker.receive_message(reply_to = '')
+      worker.send_message(request, reply_to)
+      Thread.current.terminate
+    end
+  end
+
+  def close_threads
+    @threads.each { |thread| thread.exit }
+    @threads = []
+  end
+
+  def test_round_trip
+    start_broker
+    start_worker
+
+    client = Majordomo::Client.new('tcp://0.0.0.0:5555')
+    client.send_message('echo', 'a')
+
+    assert_equal %w(a), client.receive_message
+
+    close_threads
+  end
+
+end
+
+
+
+
+

data/test/test_helper.rb

@@ -0,0 +1,8 @@
+require 'simplecov'
+SimpleCov.start
+
+$LOAD_PATH << File.expand_path('../../lib', __FILE__)
+$LOAD_PATH << File.expand_path('../../test', __FILE__)
+
+require 'minitest/autorun'
+require 'librmdp'

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: librmdp
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Benoist
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ffi-rzmq
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A ruby implementation of the ZeroMQ majordomo pattern v0.1
+email:
+- benoist.claassen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/librmdp.rb
+- lib/majordomo/broker.rb
+- lib/majordomo/broker/service.rb
+- lib/majordomo/broker/worker.rb
+- lib/majordomo/client.rb
+- lib/majordomo/version.rb
+- lib/majordomo/worker.rb
+- librmdp.gemspec
+- test/client_test.rb
+- test/integration_test.rb
+- test/test_helper.rb
+homepage: https://github.com/benoist/librmdp
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: A ruby implementation of the ZeroMQ majordomo pattern v0.1
+test_files:
+- test/client_test.rb
+- test/integration_test.rb
+- test/test_helper.rb