ZDevice 0.1.0

data/.gitignore

@@ -0,0 +1,3 @@
+pkg/*
+*.gem
+.bundle

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in zdevice.gemspec
+gemspec

data/README.md

@@ -0,0 +1,39 @@
+# ZDevice
+
+ZDevice is a Ruby DSL for assembling arbitrary ZeroMQ routing devices, with support for the ZDCF configuration syntax.
+
+## Example: PUB/SUB queue device
+
+    b = ZMQ::Device::Builder.new(
+      context: { iothreads: 5 },
+      main: {
+        type: :queue,
+        frontend: { type: :SUB, option: { hwm: 1, swap: 25}, connect: ["tcp://127.0.0.1:5555"]},
+        backend:  { type: :PUB, bind: ["tcp://127.0.0.1:5556"] }
+      }
+    )
+
+    # relay all incoming messages to all subscribers
+    b.main.start do
+      loop do
+        msg = ZMQ::Message.new
+        frontend.recv msg
+        backend.send msg
+      end
+    end
+
+## Resources
+
+* [ZDCF JSON specification](http://rfc.zeromq.org/spec:3)
+
+## License
+
+(The MIT License)
+
+Copyright (c) 2010 Ilya Grigorik
+
+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/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/autotest/discover.rb

@@ -0,0 +1 @@
+Autotest.add_discovery { 'rspec2' }

data/lib/zdevice.rb

@@ -0,0 +1,119 @@
+require 'ffi-rzmq'
+
+module ZMQ
+  module Device
+
+    class Builder
+      def initialize(conf = {})
+        conf = symbolize_keys(conf)
+
+        @context = Context.new(conf.delete(:context))
+        @devices = {}
+
+        conf.each do |name, c|
+          @devices[name] = Device.new(name, @context.ctx, c)
+          (class << self; self; end).class_eval do
+            define_method "#{name}" do
+              @devices[name]
+            end
+          end
+        end
+      end
+
+      def symbolize_keys(conf)
+        recursive = Proc.new do |h, sh|
+          h.each do |k,v|
+            sh[k.to_sym] = v.is_a?(Hash) ? recursive.call(v, {}) : v
+          end
+          sh
+        end
+
+        recursive.call(conf, {})
+      end
+
+      def close
+        @devices.values.map { |d| d.close }
+      end
+    end
+
+    class Context
+      attr_reader :iothreads, :verbose, :ctx
+      def initialize(conf = {})
+        @iothreads = conf[:iothreads] || 1
+        @verbose   = conf[:verbose]   || false
+
+        @ctx = ZMQ::Context.new(@iothreads)
+      end
+    end
+
+    class Device
+      attr_reader :name, :type
+      def initialize(name, ctx, conf = {}, &blk)
+        raise 'invalid name' if name == 'context'
+        raise 'missing type' if !conf.key? :type
+
+        @name = name
+        @type = conf.delete(:type)
+        @sockets = {}
+
+        conf.each do |name, c|
+          @sockets[name] = ZSocket.new(name, ctx, c)
+          (class << self; self; end).class_eval do
+            define_method "#{name}" do
+              @sockets[name].socket
+            end
+          end
+        end
+      end
+
+      def start(&blk)
+        instance_eval &blk
+      end
+
+      def close
+        @sockets.values.map {|s| s.close }
+      end
+    end
+
+    class ZSocket
+      attr_reader :name, :type, :socket
+      def initialize(name, ctx = nil, conf = {})
+        raise 'invalid name' if name == 'type'
+        raise 'missing type' if !conf.key? :type
+
+        @name = name
+        conf[:option] ||= {}
+        @type = case conf.delete(:type).downcase
+          when :pub then ZMQ::PUB
+          when :sub then ZMQ::SUB
+          else 1
+        end
+
+        # if no filter is specified, then accept all messages by default
+        if @type == ZMQ::SUB
+          conf[:option][:subscribe] = '' if !conf[:option][:subscribe]
+        end
+
+        @socket = ctx.socket @type
+        (conf[:bind]    || []).each { |addr| @socket.bind addr }
+        (conf[:connect] || []).each { |addr| @socket.connect(addr) }
+
+        conf[:option].each do |k, v|
+          flag = case k
+          when :subscribe then ZMQ::SUBSCRIBE
+          when :hwm       then ZMQ::HWM
+          when :swap      then ZMQ::SWAP
+          end
+
+          [v].flatten.map {|val| @socket.setsockopt(flag, val) }
+        end
+      end
+
+      def close
+        @socket.close
+      end
+    end
+
+  end
+
+end

data/lib/zdevice/version.rb

@@ -0,0 +1,3 @@
+module Zdevice
+  VERSION = "0.1.0"
+end

data/spec/relay_spec.rb

@@ -0,0 +1,84 @@
+require 'lib/zdevice'
+
+include ZMQ::Device
+
+describe "relay device" do
+
+  it "should assemble a one-time relay ZMQ Device" do
+    b = Builder.new(
+      context: { iothreads: 5 },
+      main: {
+        type: :queue,
+
+        frontend: {
+          type: :SUB,
+          option: { hwm: 1, swap: 25},
+          connect: ["tcp://127.0.0.1:5555"]
+        },
+
+        backend: {
+          type: :PUB,
+        bind: ["tcp://127.0.0.1:5556"] }
+      }
+    )
+
+    b.main.class.should == Device
+    b.main.type.should == :queue
+
+    # Create producer socket
+    sctx = ZMQ::Context.new
+    pub = sctx.socket(ZMQ::PUB)
+    pub.bind("tcp://127.0.0.1:5555")
+
+    # Start relay device
+    Thread.new do
+      b.main.start do
+        msg = ZMQ::Message.new
+        frontend.recv msg
+        backend.send msg
+      end
+    end
+
+    # Start producer
+    Thread.new do
+      loop do
+        pub.send ZMQ::Message.new("queue test")
+      end
+    end
+
+    # Consume re-routed message from producer
+    sub = sctx.socket(ZMQ::SUB)
+    sub.setsockopt(ZMQ::SUBSCRIBE, '')
+    sub.connect("tcp://127.0.0.1:5556")
+
+    rmsg = ZMQ::Message.new
+    sub.recv rmsg
+
+    rmsg.copy_out_string.should == "queue test"
+
+    pub.close
+    sub.close
+    b.close
+  end
+
+  it "should have more Ruby friendly syntax" do
+    pending "maybe"
+
+    d = Device.new do
+      context iothreads: 5, verbose: false
+
+      device :queue do
+        socket :frontend do
+          type ZMQ::SUB
+          option hwm: 1, swap: 25
+          connect ['']
+          bind ['']
+        end
+      end
+    end
+
+    d.queue.start do
+    end
+  end
+
+end

data/spec/zdevice_spec.rb

@@ -0,0 +1,63 @@
+require 'lib/zdevice'
+
+include ZMQ::Device
+
+describe ZMQ::Device do
+
+  let(:ctx) { ZMQ::Context.new }
+
+  context Builder do
+    it "should symbolize configuration keys" do
+      b = Builder.new(
+        'context' => { 'iothreads' => 5 },
+        'main' => {
+          'type' => :queue,
+        }
+      )
+
+      b.main.class.should == Device
+      b.main.type.should == :queue
+    end
+  end
+
+  context Context do
+    it "should accept optional iothread count" do
+      c = Context.new(iothreads: 5)
+      c.iothreads.should == 5
+    end
+
+    it "should accept optional verbose flag" do
+      c = Context.new(verbose: true)
+      c.verbose.should be_true
+    end
+  end
+
+  context Device do
+    it "should validate type" do
+      lambda { Device.new('context') }.should raise_error
+    end
+
+    it "should validate name" do
+      lambda { Device.new('context', ctx, type: :a) }.should raise_error
+      d = Device.new('valid', nil, type: :a)
+      d.name.should == 'valid'
+    end
+  end
+
+  context ZSocket do
+    it "should have any name except 'type'" do
+      lambda { ZSocket.new('type') }.should raise_error('invalid name')
+
+      s = ZSocket.new('valid', ctx, type: :queue)
+      s.name.should == 'valid'
+      s.close
+    end
+
+    it "should have a type" do
+      s = ZSocket.new('valid', ctx, type: :queue)
+      s.type.should >= 0
+      s.close
+    end
+  end
+
+end

data/zdevice.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "zdevice/version"
+
+Gem::Specification.new do |s|
+  s.name        = "ZDevice"
+  s.version     = Zdevice::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Ilya Grigorik"]
+  s.email       = ["ilya@igvita.com"]
+  s.homepage    = "http://github.com/igrigorik/zdevice"
+  s.summary     = %q{ZDevice is a Ruby DSL for assembling arbitrary ZeroMQ routing devices, with support for the ZDCF configuration syntax.}
+  s.description = s.summary
+
+  s.rubyforge_project = "zdevice"
+  s.add_dependency "ffi"
+  s.add_dependency "ffi-rzmq"
+  s.add_development_dependency "rspec"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification 
+name: ZDevice
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Ilya Grigorik
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-17 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: ffi
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: ffi-rzmq
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: ZDevice is a Ruby DSL for assembling arbitrary ZeroMQ routing devices, with support for the ZDCF configuration syntax.
+email: 
+- ilya@igvita.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- autotest/discover.rb
+- lib/zdevice.rb
+- lib/zdevice/version.rb
+- spec/relay_spec.rb
+- spec/zdevice_spec.rb
+- zdevice.gemspec
+has_rdoc: true
+homepage: http://github.com/igrigorik/zdevice
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: zdevice
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: ZDevice is a Ruby DSL for assembling arbitrary ZeroMQ routing devices, with support for the ZDCF configuration syntax.
+test_files: 
+- spec/relay_spec.rb
+- spec/zdevice_spec.rb