em-zeromq 0.1.1

data/.bnsignore

@@ -0,0 +1,18 @@
+# The list of files that should be ignored by Mr Bones.
+# Lines that start with '#' are comments.
+#
+# A .gitignore file can be used instead by setting it as the ignore
+# file in your Rakefile:
+#
+#   Bones {
+#     ignore_file  '.gitignore'
+#   }
+#
+# For a project with a C extension, the following would be a good set of
+# exclude patterns (uncomment them if you want to use them):
+# *.[oa]
+# *~
+announcement.txt
+coverage
+doc
+pkg

data/.gitignore

@@ -0,0 +1,8 @@
+*.swp
+*.swo
+*.swn
+
+*.rbc
+*~
+
+pkg

data/History.txt

@@ -0,0 +1,4 @@
+== 1.0.0 / 2011-01-29
+
+* 1 major enhancement
+  * Birthday!

data/README.md

@@ -0,0 +1,80 @@
+# em-zeromq #
+
+Low level event machine support for ZeroMQ
+
+## Description: ##
+
+WARNING THIS IS ALPHA QUALITY AT THE MOMENT
+
+A minimal test case passes, the basics of this are working.
+It needs work for sure, for instance, you cannot remove a socket yet
+
+
+## Using: ##
+
+You must use either rubinius, jruby, or 1.9.x rubies. 1.8.7 unfixable issues.
+
+If you use 1.9.x, be sure to install the ffi gem first.
+
+For all rubies install ffi-rzmq and eventmachine as well.
+
+This only works with ZeroMQ 2.1.x which is still unreleased
+Build+Install ZeroMQ 2.1 from HEAD ( https://github.com/zeromq/zeromq2 ) 
+
+Run the specs, see specs for examples
+
+Want to help out? Ask! Much work to be done here
+
+## Example ##
+
+    require 'rubygems'
+    require 'em-zeromq'
+        
+    Thread.abort_on_exception = true
+
+    class EMTestPullHandler
+      attr_reader :received
+      def on_readable(socket, messages)
+        messages.each do |m|
+          puts m.copy_out_string
+        end
+      end
+    end
+    class EMTestPushHandler
+      def on_writable(socket)
+      end
+    end
+    EM.run do
+      ZCTX  = ZMQ::Context.new 1
+      push = EM::ZeroMQ.create ZCTX, ZMQ::PUSH, :bind, 'tcp://127.0.0.1:2091', EMTestPushHandler.new
+      pull = EM::ZeroMQ.create ZCTX, ZMQ::PULL, :connect, 'tcp://127.0.0.1:2091', EMTestPullHandler.new
+          
+      EM::PeriodicTimer.new(1) {
+        push.socket.send_string "Hello World! #{Time.now}", ZMQ::NOBLOCK
+      }
+    end
+
+## License: ##
+
+(The MIT License)
+
+Copyright (c) 2009 FIXME (different 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/Rakefile

@@ -0,0 +1,20 @@
+
+begin
+  require 'bones'
+rescue LoadError
+  abort '### Please install the "bones" gem ###'
+end
+
+#task :default => 'test:run'
+task 'gem:release' => 'test:run'
+  
+#depend_on 'ffi-rzmq', '0.7.0'
+#depend_on 'eventmachine'
+
+Bones {
+  name  'em-zeromq'
+  authors  'Andrew Cholakian'
+  email    'andrew@andrewvc.com'
+  url      'https://github.com/andrewvc/em-zeromq'
+}
+

data/bin/em-zeromq

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require File.expand_path(
+    File.join(File.dirname(__FILE__), %w[.. lib em-zeromq]))
+
+# Put your code here
+

data/em-zeromq.gemspec

@@ -0,0 +1,36 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{em-zeromq}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Andrew Cholakian"]
+  s.date = %q{2011-02-01}
+  s.default_executable = %q{em-zeromq}
+  s.description = %q{Low level event machine support for ZeroMQ}
+  s.email = %q{andrew@andrewvc.com}
+  s.executables = ["em-zeromq"]
+  s.extra_rdoc_files = ["History.txt", "bin/em-zeromq", "lib/em-zeromq/.connection.rb.swp", "version.txt"]
+  s.files = [".Rakefile.swo", ".bnsignore", "History.txt", "README.md", "Rakefile", "bin/em-zeromq", "example/simple.rb", "lib/em-zeromq.rb", "lib/em-zeromq/.connection.rb.swp", "lib/em-zeromq/connection.rb", "lib/em-zeromq/zeromq.rb", "spec/.pub_sub_spec.rb.swp", "spec/pub_sub_spec.rb", "spec/push_pull_spec.rb", "spec/spec_helper.rb", "test/test_em-zeromq.rb", "version.txt"]
+  s.homepage = %q{https://github.com/andrewvc/em-zeromq}
+  s.rdoc_options = ["--main", "README.md"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{em-zeromq}
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Low level event machine support for ZeroMQ}
+  s.test_files = ["test/test_em-zeromq.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<bones>, [">= 3.5.4"])
+    else
+      s.add_dependency(%q<bones>, [">= 3.5.4"])
+    end
+  else
+    s.add_dependency(%q<bones>, [">= 3.5.4"])
+  end
+end

data/example/simple.rb

@@ -0,0 +1,27 @@
+require 'rubygems'
+require 'em-zeromq'
+    
+Thread.abort_on_exception = true
+
+class EMTestPullHandler
+  attr_reader :received
+  def on_readable(socket, messages)
+    messages.each do |m|
+      puts m.copy_out_string
+    end
+  end
+end
+class EMTestPushHandler
+  def on_writable(socket)
+  end
+end
+EM.run do
+  ZCTX  = ZMQ::Context.new 1
+  push = EM::ZeroMQ.create ZCTX, ZMQ::PUSH, :bind, 'tcp://127.0.0.1:2091', EMTestPushHandler.new
+  pull = EM::ZeroMQ.create ZCTX, ZMQ::PULL, :connect, 'tcp://127.0.0.1:2091', EMTestPullHandler.new
+      
+  EM::PeriodicTimer.new(1) {
+    push.socket.send_string "Hello World! #{Time.now}", ZMQ::NOBLOCK
+  }
+end
+

data/lib/em-zeromq.rb

@@ -0,0 +1,67 @@
+require 'eventmachine'
+require 'ffi-rzmq'
+
+module EmZeromq
+
+  # :stopdoc:
+  LIBPATH = ::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
+  PATH = ::File.dirname(LIBPATH) + ::File::SEPARATOR
+  # :startdoc:
+
+  # Returns the version string for the library.
+  #
+  def self.version
+    @version ||= File.read(path('version.txt')).strip
+  end
+
+  # Returns the library path for the module. If any arguments are given,
+  # they will be joined to the end of the libray path using
+  # <tt>File.join</tt>.
+  #
+  def self.libpath( *args, &block )
+    rv =  args.empty? ? LIBPATH : ::File.join(LIBPATH, args.flatten)
+    if block
+      begin
+        $LOAD_PATH.unshift LIBPATH
+        rv = block.call
+      ensure
+        $LOAD_PATH.shift
+      end
+    end
+    return rv
+  end
+
+  # Returns the lpath for the module. If any arguments are given,
+  # they will be joined to the end of the path using
+  # <tt>File.join</tt>.
+  #
+  def self.path( *args, &block )
+    rv = args.empty? ? PATH : ::File.join(PATH, args.flatten)
+    if block
+      begin
+        $LOAD_PATH.unshift PATH
+        rv = block.call
+      ensure
+        $LOAD_PATH.shift
+      end
+    end
+    return rv
+  end
+
+  # Utility method used to require all files ending in .rb that lie in the
+  # directory below this file that has the same name as the filename passed
+  # in. Optionally, a specific _directory_ name can be passed in such that
+  # the _filename_ does not have to be equivalent to the directory.
+  #
+  def self.require_all_libs_relative_to( fname, dir = nil )
+    dir ||= ::File.basename(fname, '.*')
+    search_me = ::File.expand_path(
+        ::File.join(::File.dirname(fname), dir, '**', '*.rb'))
+
+    Dir.glob(search_me).sort.each {|rb| require rb}
+  end
+
+end  # module EmZeromq
+
+EmZeromq.require_all_libs_relative_to(__FILE__)
+

data/lib/em-zeromq/connection.rb

@@ -0,0 +1,73 @@
+
+module EventMachine
+  module ZeroMQ
+    class Connection < EventMachine::Connection
+      attr_accessor :on_readable, :on_writable, :handler
+      attr_reader   :socket, :socket_type, :address
+
+      def initialize(socket, socket_type, address, handler)
+        @socket      = socket
+        @socket_type = socket_type
+        @handler     = handler
+        @address     = address
+      end
+
+      def notify_readable
+        return unless read_capable?
+        #return unless (@socket.getsockopt(ZMQ::EVENTS) & ZMQ::POLLOUT) == ZMQ::POLLOUT
+         
+        msg_parts = []
+
+        loop do
+          msg = get_message
+          if msg
+            msg_parts << msg
+            while @socket.more_parts?
+              msg = get_message
+              if msg
+                msg_parts << msg
+              else
+                raise "Multi-part message missing a message!"
+              end
+            end
+            
+            @handler.on_readable(@socket, msg_parts)
+          else
+            break
+          end
+        end
+      end
+      
+      def get_message
+        msg       = ZMQ::Message.new
+        msg_recvd = @socket.recv(msg, ZMQ::NOBLOCK)
+        msg_recvd ? msg : nil
+      end
+
+      def deregister_writable
+        self.notify_writable = false
+      end
+      
+      def register_writable
+        if (@socket.getsockopt(ZMQ::EVENTS) & ZMQ::POLLOUT) == ZMQ::POLLOUT
+          notify_writable
+        end
+        self.notify_writable = true
+      end
+      
+      def notify_writable
+        @handler.on_writable(@socket)
+      end
+      
+      private
+      
+      def read_capable?
+        @read_capable  ||= EM::ZeroMQ::READABLE_TYPES.include? @socket_type
+      end
+
+      def write_capable?
+        @write_capable ||= EM::ZeroMQ::WRITABLE_TYPES.include? @socket_type
+      end
+    end
+  end
+end

data/lib/em-zeromq/zeromq.rb

@@ -0,0 +1,30 @@
+module EventMachine
+  module ZeroMQ
+    READABLE_TYPES = [ZMQ::SUB, ZMQ::PULL, ZMQ::REQ, ZMQ::REP, ZMQ::XREQ, ZMQ::XREP, ZMQ::PAIR]
+    WRITABLE_TYPES = [ZMQ::PUB, ZMQ::PUSH, ZMQ::REQ, ZMQ::REP, ZMQ::XREQ, ZMQ::XREP, ZMQ::PAIR]
+
+     def self.create(context, socket_type, bind_or_connect, address, handler)
+      socket = context.socket socket_type
+       
+      unless [:bind, :connect].include?(bind_or_connect)
+        raise ArgumentError, "Invalid Option '#{bind_or_connect}' try :bind or :connect"
+      end
+       
+      if bind_or_connect == :bind
+        socket.bind address
+      else
+        socket.connect address
+      end
+       
+      conn = EM.watch(socket.getsockopt(ZMQ::FD), EventMachine::ZeroMQ::Connection, socket, socket_type, address, handler)
+      conn.notify_readable = true if EM::ZeroMQ::READABLE_TYPES.include? socket_type
+      
+      #Given the nature of ZMQ this isn't that useful, and will generally
+      #cause perf problems as it repeatedly triggers. If people really want to
+      #use it, they should do so explicitly
+      conn.notify_writable = false
+      conn
+    end
+
+  end
+end

data/spec/pub_sub_spec.rb

@@ -0,0 +1,74 @@
+require File.join(File.dirname(__FILE__), %w[spec_helper])
+
+describe EventMachine::ZeroMQ do
+  class EMTestSubHandler
+    attr_reader :received
+    def initialize
+      @received = []
+    end
+    def on_readable(socket, messages)
+      @received += messages
+    end
+  end
+  class EMTestPubHandler
+    def initialize(&block)
+      @on_writable_callback = block
+    end
+    def on_writable(socket)
+      @on_writable_callback.call(socket) if @on_writable_callback
+    end
+  end
+
+  def make_sub(addr, b_or_c, handler=EMTestSubHandler.new)
+    conn = EM::ZeroMQ.create SPEC_CTX, ZMQ::SUB, b_or_c, addr, handler
+    conn.socket.setsockopt(ZMQ::SUBSCRIBE,'')
+    conn
+  end
+  
+  def make_pub(addr, b_or_c, handler=EMTestPubHandler.new)
+    EM::ZeroMQ.create SPEC_CTX, ZMQ::PUB, b_or_c, addr, handler
+  end
+
+  it "Should instantiate a connection given valid opts" do
+    sub_conn = nil
+    run_reactor(2) do
+      sub_conn = make_sub(rand_addr, :bind, EMTestSubHandler.new)
+    end
+    sub_conn.should be_a(EventMachine::ZeroMQ::Connection)
+  end
+
+  describe "sending/receiving a single message via PUB/SUB" do
+    before(:all) do
+      results = {}
+      @test_message = test_message = "TMsg#{rand(999)}"
+      
+      run_reactor(0.5) do
+        results[:sub_hndlr] = pull_hndlr = EMTestSubHandler.new
+        sub_conn  = make_sub rand_addr, :bind, pull_hndlr
+        pub_conn  = make_pub sub_conn.address, :connect
+        
+        pub_conn.socket.send_string test_message, ZMQ::NOBLOCK
+        
+        EM::Timer.new(0.1) { results[:specs_ran] = true }
+      end
+      
+      @results = results
+    end
+
+    it "should run completely" do
+      @results[:specs_ran].should be_true
+    end
+    
+    it "should receive one message" do
+      @results[:sub_hndlr].received.length.should == 1
+    end
+    
+    it "should receive the message as a ZMQ::Message" do
+      @results[:sub_hndlr].received.first.should be_a(ZMQ::Message)
+    end
+    
+    it "should receive the message intact" do
+      @results[:sub_hndlr].received.first.copy_out_string.should == @test_message
+    end
+  end
+end

data/spec/push_pull_spec.rb

@@ -0,0 +1,72 @@
+require File.join(File.dirname(__FILE__), %w[spec_helper])
+
+describe EventMachine::ZeroMQ do
+  class EMTestPullHandler
+    attr_reader :received
+    def initialize
+      @received = []
+    end
+    def on_readable(socket, messages)
+      @received += messages
+    end
+  end
+  class EMTestPushHandler
+    def initialize(&block)
+      @on_writable_callback = block
+    end
+    def on_writable(socket)
+      @on_writable_callback.call(socket) if @on_writable_callback
+    end
+  end
+
+  def make_pull(addr, b_or_c, handler=EMTestPullHandler.new)
+    EM::ZeroMQ.create SPEC_CTX, ZMQ::PULL, b_or_c, addr, handler
+  end
+  
+  def make_push(addr, b_or_c, handler=EMTestPushHandler.new)
+    EM::ZeroMQ.create SPEC_CTX, ZMQ::PUSH, b_or_c, addr, handler
+  end
+
+  it "Should instantiate a connection given valid opts" do
+    pull_conn = nil
+    run_reactor do
+      pull_conn = make_pull(rand_addr, :bind, EMTestPullHandler.new)
+    end
+    pull_conn.should be_a(EventMachine::ZeroMQ::Connection)
+  end
+
+  describe "sending/receiving a single message via PUB/SUB" do
+    before(:all) do
+      results = {}
+      @test_message = test_message = "TMsg#{rand(999)}"
+      
+      run_reactor(0.5) do
+        results[:pull_hndlr] = pull_hndlr = EMTestPullHandler.new
+        pull_conn  = make_pull rand_addr, :bind, pull_hndlr
+        push_conn  = make_push pull_conn.address, :connect
+        
+        push_conn.socket.send_string test_message, ZMQ::NOBLOCK
+        
+        EM::Timer.new(0.1) { results[:specs_ran] = true }
+      end
+      
+      @results = results
+    end
+
+    it "should run completely" do
+      @results[:specs_ran].should be_true
+    end
+    
+    it "should receive one message" do
+      @results[:pull_hndlr].received.length.should == 1
+    end
+    
+    it "should receive the message as a ZMQ::Message" do
+      @results[:pull_hndlr].received.first.should be_a(ZMQ::Message)
+    end
+    
+    it "should receive the message intact" do
+      @results[:pull_hndlr].received.first.copy_out_string.should == @test_message
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,42 @@
+require 'set'
+Thread.abort_on_exception = true
+
+require File.expand_path(
+    File.join(File.dirname(__FILE__), %w[.. lib em-zeromq]))
+
+def run_reactor(time=0.2,&block)
+  Thread.new do
+    EM.run do
+      yield
+    end
+  end
+  sleep time
+  EM.stop rescue nil
+  sleep 0.1
+end
+
+USED_RAND_ADDRS = Set.new
+def rand_addr(scheme='tcp')
+  addr = nil
+  loop do 
+    case scheme
+    when 'tcp'
+      addr = "tcp://127.0.0.1:#{rand(10_000) + 20_000}"
+    when 'inproc'
+      addr = "inproc://testinp-#{rand(10_000) + 20_000}"
+    end
+    
+    if USED_RAND_ADDRS.include? addr
+      next
+    else
+      USED_RAND_ADDRS << addr
+      break
+    end
+  end
+  addr
+end
+
+SPEC_CTX = ZMQ::Context.new 1
+def spec_ctx
+  SPEC_CTX
+end

data/version.txt

@@ -0,0 +1 @@
+0.1.1

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification 
+name: em-zeromq
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
+platform: ruby
+authors: 
+- Andrew Cholakian
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-01 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bones
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 6
+        - 2
+        version: 3.6.2
+  type: :development
+  version_requirements: *id001
+description: Low level event machine support for ZeroMQ
+email: andrew@andrewvc.com
+executables: 
+- em-zeromq
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- bin/em-zeromq
+files: 
+- .Rakefile.swo
+- .bnsignore
+- .gitignore
+- History.txt
+- README.md
+- Rakefile
+- bin/em-zeromq
+- em-zeromq.gemspec
+- example/simple.rb
+- lib/em-zeromq.rb
+- lib/em-zeromq/connection.rb
+- lib/em-zeromq/zeromq.rb
+- spec/pub_sub_spec.rb
+- spec/push_pull_spec.rb
+- spec/spec_helper.rb
+- test/test_em-zeromq.rb
+- version.txt
+has_rdoc: true
+homepage: https://github.com/andrewvc/em-zeromq
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.md
+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: em-zeromq
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Low level event machine support for ZeroMQ
+test_files: 
+- test/test_em-zeromq.rb