em-zeromq 0.2.3 → 0.3.0

data/.gitignore

@@ -12,3 +12,5 @@ pkg
 Gemfile.lock
 pkg/*
 .rvmrc
+coverage/
+*test*/

data/README.md

@@ -12,6 +12,7 @@ EventMachine support for ZeroMQ
 ## Usage: ##
 
 Supported on:
+
 - MRI 1.9+
 - Rubinius
 - JRuby
@@ -29,7 +30,8 @@ to keep a reference to it in scope, this is what you don't want to do (that's ho
 ```ruby
 EM.run do
   context = EM::ZeroMQ::Context.new(1)
-  dealer_socket = context.connect(...)
+  dealer_socket = context.sockt(...)
+  dealer_socket.connect(...)
   dealer_socket.send_msg('', "ping")
 end
 ```
@@ -42,42 +44,52 @@ It should not be a major problem anyway since code like above is only written fo
 but I just pulled my hair trying to figure out why my test code was not working so now you
 have been warned !
 
+## Breaking changes: 0.2.x => 0.3.x ##
+
+Until the gem hit the 1.0 mark you should not use the "~>" operator in your Gemfile,
+lock yourself to the exact version you want. That said I will use the second digit to
+flag api changes but be aware that small changes can still occur between releases.
+
 
 ## Example ##
 ```ruby
 require 'rubygems'
 require 'em-zeromq'
-    
-Thread.abort_on_exception = true
 
 class EMTestPullHandler
   attr_reader :received
-  def on_readable(socket, messages)
-    messages.each do |m|
+  def on_readable(socket, parts)
+    parts.each do |m|
       puts m.copy_out_string
     end
   end
 end
 
+trap('INT') do
+  EM::stop()
+end
 
 ctx = EM::ZeroMQ::Context.new(1)
 EM.run do
   # setup push sockets
-  push_socket1 = ctx.bind( ZMQ::PUSH, 'tcp://127.0.0.1:2091')
-  push_socket2 = ctx.bind( ZMQ::PUSH, 'ipc:///tmp/a')
-  push_socket3 = ctx.bind( ZMQ::PUSH, 'inproc://simple_test')
+  push_socket1 = ctx.socket(ZMQ::PUSH)  
+  push_socket1.bind('tcp://127.0.0.1:2091')
   
-  # setup one pull sockets listening to both push sockets
-  pull_socket = ctx.connect( ZMQ::PULL, 'tcp://127.0.0.1:2091', EMTestPullHandler.new)
+  push_socket2 = ctx.socket(ZMQ::PUSH) do |s|
+    s.bind('ipc:///tmp/a')
+  end
+  
+  push_socket3 = ctx.socket(ZMQ::PUSH)
+  push_socket3.bind('inproc://simple_test')
+  
+  # setup one pull sockets listening to all push sockets
+  pull_socket = ctx.socket(ZMQ::PULL, EMTestPullHandler.new)
+  pull_socket.connect('tcp://127.0.0.1:2091')
   pull_socket.connect('ipc:///tmp/a')
   pull_socket.connect('inproc://simple_test')
   
   n = 0
   
-  # push_socket.hwm = 40
-  # puts push_socket.hwm
-  # puts pull_socket.hwm
-  
   EM::PeriodicTimer.new(0.1) do
     puts '.'
     push_socket1.send_msg("t#{n += 1}_")
@@ -91,7 +103,7 @@ end
 
 (The MIT License)
 
-Copyright (c) 2011
+Copyright (c) 2011 - 2012
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Rakefile

@@ -3,5 +3,6 @@ Bundler::GemHelper.install_tasks
 
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec) do |t|
+  ENV['COVERAGE'] = "1"
 end
 task :default => :spec

data/em-zeromq.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |s|
   s.add_dependency 'ffi-rzmq', '0.9.3'
 
   s.add_development_dependency 'rspec', '>= 2.5.0'
+  s.add_development_dependency 'simplecov'
   s.add_development_dependency 'rake'
 
   s.files         = `git ls-files`.split("\n")

data/example/simple.rb

@@ -6,8 +6,8 @@ Thread.abort_on_exception = true
 
 class EMTestPullHandler
   attr_reader :received
-  def on_readable(socket, messages)
-    messages.each do |m|
+  def on_readable(socket, parts)
+    parts.each do |m|
       puts m.copy_out_string
     end
   end
@@ -23,20 +23,28 @@ puts "Started (with zmq #{ZMQ::Util.version.join('.')})."
 ctx = EM::ZeroMQ::Context.new(1)
 EM.run do
   # setup push sockets
-  push_socket1 = ctx.bind( ZMQ::PUSH, 'tcp://127.0.0.1:2091')
-  push_socket2 = ctx.bind( ZMQ::PUSH, 'ipc:///tmp/a')
-  push_socket3 = ctx.bind( ZMQ::PUSH, 'inproc://simple_test')
+  push_socket1 = ctx.socket(ZMQ::PUSH)
+  
+  push_socket1.hwm = 40
+  puts "HWM: #{push_socket1.hwm}"
+  
+  push_socket1.bind('tcp://127.0.0.1:2091')
+  
+  push_socket2 = ctx.socket(ZMQ::PUSH) do |s|
+    s.bind('ipc:///tmp/a')
+  end
+  
+  push_socket3 = ctx.socket(ZMQ::PUSH)
+  push_socket3.bind('inproc://simple_test')
   
   # setup one pull sockets listening to all push sockets
-  pull_socket = ctx.connect( ZMQ::PULL, 'tcp://127.0.0.1:2091', EMTestPullHandler.new)
+  pull_socket = ctx.socket(ZMQ::PULL, EMTestPullHandler.new)
+  pull_socket.connect('tcp://127.0.0.1:2091')
   pull_socket.connect('ipc:///tmp/a')
   pull_socket.connect('inproc://simple_test')
   
   n = 0
   
-  push_socket1.hwm = 40
-  puts "HWM: #{push_socket1.hwm}"
-  
   EM::PeriodicTimer.new(0.1) do
     puts '.'
     push_socket1.send_msg("t#{n += 1}_")

data/lib/em-zeromq/context.rb

@@ -17,62 +17,34 @@ module EventMachine
           @context = ZMQ::Context.new(threads_or_context)
         end
       end
-
-      def bind(socket_type, address, handler = nil, opts = {})
-        create(socket_type, :bind, address, handler, opts)
-      end
-
-      def connect(socket_type, address, handler = nil, opts = {})
-        create(socket_type, :connect, address, handler, opts)
-      end
       
-      def create(socket_type, bind_or_connect, address, handler, opts = {})
-        socket_type = find_type(socket_type)
-        socket = @context.socket(socket_type)
-        
-        ident = opts.delete(:identity)
-        if ident
-          socket.setsockopt(ZMQ::IDENTITY, ident)
-        end
-        
-        unless opts.empty?
-          raise "unknown keys: #{opts.keys.join(', ')}"
-        end
-
-        if bind_or_connect == :bind
-          socket.bind(address)
-        else
-          socket.connect(address)
-        end
+      ##
+      # Create a socket in this context.
+      # 
+      # @param [Integer] socket_type One of ZMQ::REQ, ZMQ::REP, ZMQ::PULL, ZMQ::PUSH,
+      #   ZMQ::ROUTER, ZMQ::DEALER
+      # 
+      # @param [Object] handler an object which respond to on_readable(socket, parts)
+      #   and can respond to on_writeable(socket)
+      # 
+      def socket(socket_type, handler = nil)
+        zmq_socket = @context.socket(socket_type)
         
         fd = []
-        if socket.getsockopt(ZMQ::FD, fd) < 0
+        if zmq_socket.getsockopt(ZMQ::FD, fd) < 0
           raise "Unable to get socket FD: #{ZMQ::Util.error_string}"
         end
         
-        conn = EM.watch(fd[0], EventMachine::ZeroMQ::Connection, socket, socket_type, address, handler)
-
-        if READABLES.include?(socket_type)
-          conn.register_readable
-        end
         
-        if WRITABLES.include?(socket_type)
-          conn.register_writable
-        end
-
-        conn
-      end
-      
-    private
-      def find_type(type)
-        if type.is_a?(Symbol) or type.is_a?(String)
-          ZMQ.const_get(type.to_s.upcase)
-        else
-          type
+        EM.watch(fd[0], EventMachine::ZeroMQ::Socket, zmq_socket, socket_type, handler).tap do |s|
+          s.register_readable if READABLES.include?(socket_type)
+          s.register_writable if WRITABLES.include?(socket_type)
+          
+          yield(s) if block_given?
         end
       end
       
     end
-
+    
   end
 end

data/lib/em-zeromq/{connection.rb → socket.rb}

@@ -1,14 +1,13 @@
 module EventMachine
   module ZeroMQ
-    class Connection < EventMachine::Connection
+    class Socket < EventMachine::Connection
       attr_accessor :on_readable, :on_writable, :handler
-      attr_reader   :socket, :socket_type, :address
+      attr_reader   :socket, :socket_type      
 
-      def initialize(socket, socket_type, address, handler)
+      def initialize(socket, socket_type, handler)
         @socket      = socket
         @socket_type = socket_type
         @handler     = handler
-        @address     = address
       end
       
       def self.map_sockopt(opt, name)
@@ -176,7 +175,7 @@ module EventMachine
       def get_message
         msg       = ZMQ::Message.new
         msg_recvd = @socket.recv(msg, ZMQ::NOBLOCK)
-        msg_recvd ? msg : nil
+        msg_recvd != -1 ? msg : nil
       end
       
       # Detaches the socket from the EM loop,

data/lib/em-zeromq/version.rb

@@ -1,4 +1,4 @@
 # encoding: utf-8
 module EmZeromq
-  VERSION = "0.2.3"
+  VERSION = "0.3.0"
 end

data/spec/context_spec.rb

@@ -13,11 +13,8 @@ describe 'Context' do
   
   it 'can create socket' do
     EM::run do
-      s1 = @ctx.bind(:router, 'tcp://127.0.0.1:5555')
-      s2 = @ctx.bind('router', 'tcp://127.0.0.1:5556')
-      s3 = @ctx.bind(ZMQ::ROUTER, 'tcp://127.0.0.1:5557')
-    
-      s1.instance_variable_get('@socket').name.should == 'ROUTER'
+      s = @ctx.socket(ZMQ::ROUTER)
+      s.instance_variable_get('@socket').name.should == 'ROUTER'
       EM::stop_event_loop
     end
   end

data/spec/pub_sub_spec.rb

@@ -13,10 +13,13 @@ describe EventMachine::ZeroMQ do
 
   it "Should instantiate a connection given valid opts" do
     sub_conn = nil
+    address = rand_addr
+    
     run_reactor(1) do
-      sub_conn = SPEC_CTX.bind(ZMQ::PUB, rand_addr, EMTestSubHandler.new)
+      sub_conn = SPEC_CTX.socket(ZMQ::PUB, EMTestSubHandler.new)
+      sub_conn.bind(address)
     end
-    sub_conn.should be_a(EventMachine::ZeroMQ::Connection)
+    sub_conn.should be_a(EventMachine::ZeroMQ::Socket)
   end
 
   describe "sending/receiving a single message via PUB/SUB" do
@@ -25,11 +28,15 @@ describe EventMachine::ZeroMQ do
       @test_message = test_message = "TMsg#{rand(999)}"
       
       run_reactor(0.5) do
+        address = rand_addr
+        
         results[:sub_hndlr] = pull_hndlr = EMTestSubHandler.new
-        sub_conn  = SPEC_CTX.bind(ZMQ::SUB, rand_addr, pull_hndlr)
+        sub_conn  = SPEC_CTX.socket(ZMQ::SUB, pull_hndlr)
+        sub_conn.bind(address)
         sub_conn.subscribe('')
         
-        pub_conn  = SPEC_CTX.connect(ZMQ::PUB, sub_conn.address, EMTestSubHandler.new)
+        pub_conn  = SPEC_CTX.socket(ZMQ::PUB, EMTestSubHandler.new)
+        pub_conn.connect(address)
         
         pub_conn.socket.send_string test_message, ZMQ::NOBLOCK
         

data/spec/push_pull_spec.rb

@@ -14,9 +14,10 @@ describe EventMachine::ZeroMQ do
   it "Should instantiate a connection given valid opts" do
     pull_conn = nil
     run_reactor do
-      pull_conn = SPEC_CTX.bind(ZMQ::PULL, rand_addr, EMTestPullHandler.new)
+      pull_conn = SPEC_CTX.socket(ZMQ::PULL, EMTestPullHandler.new)
+      pull_conn.bind(rand_addr)
     end
-    pull_conn.should be_a(EventMachine::ZeroMQ::Connection)
+    pull_conn.should be_a(EventMachine::ZeroMQ::Socket)
   end
 
   describe "sending/receiving a single message via PUB/SUB" do
@@ -25,9 +26,15 @@ describe EventMachine::ZeroMQ do
       @test_message = test_message = "TMsg#{rand(999)}"
       
       run_reactor(0.5) do
+        
+        address = rand_addr
+        
         results[:pull_hndlr] = pull_hndlr = EMTestPullHandler.new
-        pull_conn = SPEC_CTX.bind(ZMQ::PULL, rand_addr, pull_hndlr)
-        push_conn  = SPEC_CTX.connect(ZMQ::PUSH, pull_conn.address)
+        pull_conn = SPEC_CTX.socket(ZMQ::PULL, pull_hndlr)
+        pull_conn.bind(address)
+        
+        push_conn  = SPEC_CTX.socket(ZMQ::PUSH)
+        push_conn.connect(address)
         
         push_conn.socket.send_string test_message, ZMQ::NOBLOCK
         

data/spec/router_dealer_spec.rb

@@ -33,9 +33,10 @@ describe EventMachine::ZeroMQ do
   it "Should instantiate a connection given valid opts for Router/Dealer" do
     router_conn = nil
     run_reactor(1) do
-      router_conn = SPEC_CTX.bind(ZMQ::ROUTER, rand_addr, EMTestRouterHandler.new)
+      router_conn = SPEC_CTX.socket(ZMQ::ROUTER, EMTestRouterHandler.new)
+      router_conn.bind(rand_addr)
     end
-    router_conn.should be_a(EventMachine::ZeroMQ::Connection)
+    router_conn.should be_a(EventMachine::ZeroMQ::Socket)
   end
 
   describe "sending/receiving a single message via Router/Dealer" do
@@ -48,8 +49,13 @@ describe EventMachine::ZeroMQ do
         results[:router_hndlr] = router_hndlr = EMTestRouterHandler.new
 
         addr = rand_addr
-        dealer_conn = SPEC_CTX.bind(ZMQ::DEALER, addr, dealer_hndlr, :identity => "dealer1")
-        router_conn = SPEC_CTX.connect(ZMQ::ROUTER, addr, router_hndlr, :identity => "router1")
+        dealer_conn = SPEC_CTX.socket(ZMQ::DEALER, dealer_hndlr)
+        dealer_conn.identity = "dealer1"
+        dealer_conn.bind(addr)
+        
+        router_conn = SPEC_CTX.socket(ZMQ::ROUTER, router_hndlr)
+        router_conn.identity = "router1"
+        router_conn.connect(addr)
         
         EM::add_timer(0.1) do
           router_conn.send_msg('dealer1','', test_message)

data/spec/spec_helper.rb

@@ -2,6 +2,11 @@ require 'rspec'
 require 'set'
 Thread.abort_on_exception = true
 
+if ENV['COVERAGE']
+  require 'simplecov'
+  SimpleCov.start
+end
+
 require File.expand_path(
     File.join(File.dirname(__FILE__), %w[.. lib em-zeromq]))
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: em-zeromq
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-23 00:00:00.000000000 Z
+date: 2012-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
-  requirement: &70154900691620 !ruby/object:Gem::Requirement
+  requirement: &70098716501040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -22,10 +22,10 @@ dependencies:
         version: 1.0.0.beta.4
   type: :runtime
   prerelease: false
-  version_requirements: *70154900691620
+  version_requirements: *70098716501040
 - !ruby/object:Gem::Dependency
   name: ffi
-  requirement: &70154900707520 !ruby/object:Gem::Requirement
+  requirement: &70098716500480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: 1.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *70154900707520
+  version_requirements: *70098716500480
 - !ruby/object:Gem::Dependency
   name: ffi-rzmq
-  requirement: &70154900707060 !ruby/object:Gem::Requirement
+  requirement: &70098716499780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -44,10 +44,10 @@ dependencies:
         version: 0.9.3
   type: :runtime
   prerelease: false
-  version_requirements: *70154900707060
+  version_requirements: *70098716499780
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70154900706600 !ruby/object:Gem::Requirement
+  requirement: &70098716498920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,10 +55,21 @@ dependencies:
         version: 2.5.0
   type: :development
   prerelease: false
-  version_requirements: *70154900706600
+  version_requirements: *70098716498920
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &70098716498140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70098716498140
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70154900706220 !ruby/object:Gem::Requirement
+  requirement: &70098716373420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -66,7 +77,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70154900706220
+  version_requirements: *70098716373420
 description: Low level event machine support for ZeroMQ
 email:
 - schmurfy@gmail.com
@@ -83,9 +94,8 @@ files:
 - em-zeromq.gemspec
 - example/simple.rb
 - lib/em-zeromq.rb
-- lib/em-zeromq/connection.rb
 - lib/em-zeromq/context.rb
-- lib/em-zeromq/rzmq_compat.rb
+- lib/em-zeromq/socket.rb
 - lib/em-zeromq/version.rb
 - spec/context_spec.rb
 - spec/pub_sub_spec.rb
@@ -108,7 +118,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3798582032913593030
+      hash: 4514270127933019528
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -117,10 +127,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3798582032913593030
+      hash: 4514270127933019528
 requirements: []
 rubyforge_project: em-zeromq
-rubygems_version: 1.8.15
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: Low level event machine support for ZeroMQ

data/lib/em-zeromq/rzmq_compat.rb

@@ -1,26 +0,0 @@
-module RZMQCompat
-  class ZMQError < RuntimeError; end
-  class ZMQOperationFailed < ZMQError; end
-  
-  def self.included(klass)
-    klass.instance_eval do
-      %w(recv).each do |m|
-        alias_method :"#{m}_without_raise", m.to_sym
-        alias_method m.to_sym, :"#{m}_with_raise"
-      end
-    end
-  end
-  
-  def recv_with_raise(msg, flags = 0)
-    ret = recv_without_raise(msg, flags)
-    if (ret == true) || (ret == 0)
-      true
-    else
-      false
-    end
-  end
-  
-  
-end
-
-ZMQ::Socket.send(:include, RZMQCompat)