ffi-rzmq 1.0.3 → 2.0.1

data/lib/ffi-rzmq/util.rb

@@ -5,6 +5,23 @@ module ZMQ
   #
   class Util
 
+    # Generate and return a CURVE public/private keypair
+    #
+    # Raises an error if ZeroMQ is not configured for CURVE connections.
+    # Install libsodium if this is the case.
+    def self.curve_keypair
+      public_key = FFI::MemoryPointer.from_string(' ' * 41)
+      private_key = FFI::MemoryPointer.from_string(' ' * 41)
+      rc = LibZMQ.zmq_curve_keypair public_key, private_key
+
+      if rc < 0
+        raise NotSupportedError.new "zmq_curve_keypair" , rc, ZMQ::Util.errno,
+          "Rebuild zeromq with libsodium to enable CURVE security options."
+      end
+
+      [public_key.read_string, private_key.read_string]
+    end
+
     # Returns true when +rc+ is greater than or equal to 0, false otherwise.
     #
     # We use the >= test because zmq_poll() returns the number of sockets
@@ -28,19 +45,6 @@ module ZMQ
       LibZMQ.zmq_strerror(errno).read_string
     end
 
-    # Returns an array of the form [major, minor, patch] to represent the
-    # version of libzmq.
-    #
-    # Class method! Invoke as:  ZMQ::Util.version
-    #
-    def self.version
-      major = FFI::MemoryPointer.new :int
-      minor = FFI::MemoryPointer.new :int
-      patch = FFI::MemoryPointer.new :int
-      LibZMQ.zmq_version major, minor, patch
-      [major.read_int, minor.read_int, patch.read_int]
-    end
-
     # Attempts to bind to a random tcp port on +host+ up to +max_tries+
     # times. Returns the port number upon success or nil upon failure.
     #
@@ -56,7 +60,7 @@ module ZMQ
 
       resultcode_ok?(rc) ? random : nil
     end
-    
+
     # :doc:
     # Called to verify whether there were any errors during
     # operation. If any are found, raise the appropriate #ZeroMQError.
@@ -90,38 +94,26 @@ module ZMQ
 
       else
         raise ZeroMQError.new source, result_code, -1,
-        "Source [#{source}] does not match any zmq_* strings, rc [#{result_code}], errno [#{ZMQ::Util.errno}], error_string [#{ZMQ::Util.error_string}]"
+          "Source [#{source}] does not match any zmq_* strings, rc [#{result_code}], errno [#{ZMQ::Util.errno}], error_string [#{ZMQ::Util.error_string}]"
       end
     end
 
     def self.eagain?
       EAGAIN == ZMQ::Util.errno
     end
-    
-    if LibZMQ.version2?
-      def self.context_error?(source)
-        'zmq_init' == source ||
-        'zmq_socket' == source
-      end
-      
-      def self.message_error?(source)
-        ['zmq_msg_init', 'zmq_msg_init_data', 'zmq_msg_copy', 'zmq_msg_move'].include?(source)
-      end
-      
-    elsif LibZMQ.version3?
-      def self.context_error?(source)
-        'zmq_ctx_new' == source ||
+
+    def self.context_error?(source)
+      'zmq_ctx_new' == source ||
         'zmq_ctx_set' == source ||
         'zmq_ctx_get' == source ||
         'zmq_ctx_destory' == source ||
         'zmq_ctx_set_monitor' == source
-      end
-      
-      def self.message_error?(source)
-        ['zmq_msg_init', 'zmq_msg_init_data', 'zmq_msg_copy', 'zmq_msg_move', 'zmq_msg_close', 'zmq_msg_get',
-          'zmq_msg_more', 'zmq_msg_recv', 'zmq_msg_send', 'zmq_msg_set'].include?(source)
-      end
-    end # if LibZMQ.version...?
+    end
+
+    def self.message_error?(source)
+      ['zmq_msg_init', 'zmq_msg_init_data', 'zmq_msg_copy', 'zmq_msg_move', 'zmq_msg_close', 'zmq_msg_get',
+       'zmq_msg_more', 'zmq_msg_recv', 'zmq_msg_send', 'zmq_msg_set'].include?(source)
+    end
 
   end # module Util
 

data/lib/ffi-rzmq/version.rb

@@ -1,3 +1,3 @@
 module ZMQ
-  VERSION = "1.0.3"
+  VERSION = "2.0.1"
 end

data/lib/ffi-rzmq.rb

@@ -63,10 +63,9 @@ end  # module ZMQ
 # some code is conditionalized based upon what ruby engine we are
 # executing
 
-require 'ffi'
+require 'ffi-rzmq-core'
 
 # the order of files is important
-#%w(wrapper zmq exceptions context message socket poll_items poll device).each do |file|
-%w(libc libzmq constants util exceptions context message socket poll_items poll_item poll device).each do |file|
+%w(util exceptions context message socket poll_items poll_item poll device).each do |file|
   require ZMQ.libpath(['ffi-rzmq', file])
 end

data/spec/context_spec.rb

@@ -84,14 +84,9 @@ module ZMQ
       
       it "should call the correct library function to terminate the context" do
         ctx = Context.new
-        
-        if LibZMQ.version2?
-          LibZMQ.should_receive(:zmq_term).and_return(0)
-          ctx.terminate
-        else
-          LibZMQ.should_receive(:zmq_ctx_destroy).with(ctx.pointer).and_return(0)
-          ctx.terminate
-        end
+
+        LibZMQ.should_receive(:zmq_ctx_destroy).with(ctx.pointer).and_return(0)
+        ctx.terminate
       end
     end # context terminate
 

data/spec/device_spec.rb

@@ -5,7 +5,7 @@ module ZMQ
   describe Device do
     include APIHelper
 
-    before(:all) do
+    before(:each) do
       @ctx = Context.new
       poller_setup
       @front_endpoint = "inproc://device_front_test"
@@ -13,7 +13,7 @@ module ZMQ
       @mutex = Mutex.new
     end
 
-    after(:all) do
+    after(:each) do
       @ctx.terminate
     end
 
@@ -26,7 +26,9 @@ module ZMQ
         front = @ctx.socket(ZMQ::PUSH)
         front.bind(@front_endpoint)
         @mutex.synchronize { @device_thread = true }
-        Device.new(ZMQ::STREAMER, back, front)
+        puts "create streamer device and running..."
+        Device.new(back, front)
+        puts "device exited"
         back.close
         front.close
       end
@@ -34,12 +36,11 @@ module ZMQ
     
     def wait_for_device
       loop do
-        can_break = false
-        @mutex.synchronize do
-          can_break = true if @device_thread
-        end
+        can_break = @mutex.synchronize { @device_thread }
+        
         break if can_break
       end
+      puts "broke out of wait_for_device loop"
     end
 
     it "should create a device without error given valid opts" do
@@ -61,7 +62,7 @@ module ZMQ
       end
 
       res = ''
-      rc = puller.recv_string(res, ZMQ::NonBlocking)
+      rc = puller.recv_string(res, ZMQ::DONTWAIT)
       res.should == "hello"
 
       pusher.close
@@ -70,7 +71,7 @@ module ZMQ
 
     it "should raise an ArgumentError when trying to pass non-socket objects into the device" do
       lambda {
-        Device.new(ZMQ::STREAMER, 1,2)
+        Device.new(1,2)
       }.should raise_exception(ArgumentError)
     end
   end

data/spec/nonblocking_recv_spec.rb

@@ -12,19 +12,19 @@ module ZMQ
 
       it "returns -1 when there are no messages to read" do
         array = []
-        rc = @receiver.recvmsgs(array, ZMQ::NonBlocking)
+        rc = @receiver.recvmsgs(array, ZMQ::DONTWAIT)
         Util.resultcode_ok?(rc).should be_false
       end
 
       it "gets EAGAIN when there are no messages to read" do
         array = []
-        rc = @receiver.recvmsgs(array, ZMQ::NonBlocking)
+        rc = @receiver.recvmsgs(array, ZMQ::DONTWAIT)
         ZMQ::Util.errno.should == ZMQ::EAGAIN
       end
 
       it "returns the given array unmodified when there are no messages to read" do
         array = []
-        rc = @receiver.recvmsgs(array, ZMQ::NonBlocking)
+        rc = @receiver.recvmsgs(array, ZMQ::DONTWAIT)
         array.size.should be_zero
       end
 
@@ -39,7 +39,7 @@ module ZMQ
         end
         
         array = []
-        rc = @receiver.recvmsgs(array, ZMQ::NonBlocking)
+        rc = @receiver.recvmsgs(array, ZMQ::DONTWAIT)
         Util.resultcode_ok?(rc).should be_true
         array.size.should == 1
       end
@@ -52,7 +52,7 @@ module ZMQ
         end
 
         array = []
-        rc = @receiver.recvmsgs(array, ZMQ::NonBlocking)
+        rc = @receiver.recvmsgs(array, ZMQ::DONTWAIT)
         Util.resultcode_ok?(rc).should be_true
         array.size.should == 10
       end
@@ -68,7 +68,7 @@ module ZMQ
         end
 
         array = []
-        rc = @receiver.recvmsgs(array, ZMQ::NonBlocking)
+        rc = @receiver.recvmsgs(array, ZMQ::DONTWAIT)
         Util.resultcode_ok?(rc).should be_true
         array.size.should == 1 + 1 # extra 1 for envelope
       end
@@ -81,7 +81,7 @@ module ZMQ
         end
 
         array = []
-        rc = @receiver.recvmsgs(array, ZMQ::NonBlocking)
+        rc = @receiver.recvmsgs(array, ZMQ::DONTWAIT)
         Util.resultcode_ok?(rc).should be_true
         array.size.should == 10 + 1 # add 1 for the envelope
       end

data/spec/pushpull_spec.rb

@@ -44,11 +44,11 @@ module ZMQ
 
         poll_it_for_read(@pull) do
           rc = @push.sendmsg sent_message
-          LibZMQ.version2? ? rc.should == 0 : rc.should == string.size
+          rc.should == string.size
         end
         
-        rc = @pull.recvmsg received_message, ZMQ::NonBlocking
-        LibZMQ.version2? ? rc.should == 0 : rc.should == string.size
+        rc = @pull.recvmsg received_message, ZMQ::DONTWAIT
+        rc.should == string.size
         received_message.copy_out_string.should == string
       end
 
@@ -71,15 +71,16 @@ module ZMQ
         sockets << @pull
 
         sockets.each do |socket|
-          threads << Thread.new do
+          thr = Thread.new do
             buffer = ''
             rc = socket.recv_string buffer
-            version2? ? (rc.should == 0) : (rc.should == buffer.size)
+            rc.should == buffer.size
             mutex.synchronize { received << buffer }
             socket.close
           end
+          threads << thr
         end
-
+        
         count.times { @push.send_string(string) }
 
         threads.each {|t| t.join}
@@ -98,7 +99,7 @@ module ZMQ
             buffer = ''
             rc = 0
             mutex.synchronize { rc = @pull.recv_string buffer }
-            version2? ? (rc.should == 0) : (rc.should == buffer.size)
+            rc.should == buffer.size
             mutex.synchronize { received << buffer }
           end
         end

data/spec/reqrep_spec.rb

@@ -54,9 +54,9 @@ module ZMQ
         received_message = Message.new
 
         rc = @ping.sendmsg(Message.new(string))
-        LibZMQ.version2? ? rc.should == 0 : rc.should == string.size
+        rc.should == string.size
         rc = @pong.recvmsg received_message
-        LibZMQ.version2? ? rc.should == 0 : rc.should == string.size
+        rc.should == string.size
 
         received_message.copy_out_string.should == string
       end
@@ -66,12 +66,12 @@ module ZMQ
         received_message = Message.new
 
         poll_it_for_read(@pong) do
-          rc = @ping.sendmsg(Message.new(string), ZMQ::NonBlocking)
-          LibZMQ.version2? ? rc.should == 0 : rc.should == string.size
+          rc = @ping.sendmsg(Message.new(string), ZMQ::DONTWAIT)
+          rc.should == string.size
         end
         
-        rc = @pong.recvmsg received_message, ZMQ::NonBlocking
-        LibZMQ.version2? ? rc.should == 0 : rc.should == string.size
+        rc = @pong.recvmsg received_message, ZMQ::DONTWAIT
+        rc.should == string.size
 
         received_message.copy_out_string.should == string
       end

data/spec/socket_spec.rb

@@ -7,11 +7,8 @@ module ZMQ
   describe Socket do
     include APIHelper
 
-    socket_types = if LibZMQ.version2?
-      [ZMQ::REQ, ZMQ::REP, ZMQ::DEALER, ZMQ::ROUTER, ZMQ::PUB, ZMQ::SUB, ZMQ::PUSH, ZMQ::PULL, ZMQ::PAIR]
-    elsif LibZMQ.version3?
+    socket_types =
       [ZMQ::REQ, ZMQ::REP, ZMQ::DEALER, ZMQ::ROUTER, ZMQ::PUB, ZMQ::SUB, ZMQ::PUSH, ZMQ::PULL, ZMQ::PAIR, ZMQ::XPUB, ZMQ::XSUB]
-    end
 
     context "when initializing" do
       before(:all) { @ctx = Context.new }
@@ -173,123 +170,48 @@ module ZMQ
           end
         end # context using option ZMQ::IDENTITY
 
+        context "using option ZMQ::IPV4ONLY" do
+          it "should enable use of IPV6 sockets when set to 0" do
+            value = 0
+            socket.setsockopt ZMQ::IPV4ONLY, value
+            array = []
+            rc = socket.getsockopt(ZMQ::IPV4ONLY, array)
+            rc.should == 0
+            array[0].should == value
+          end
 
-        if version2?
-
-          context "using option ZMQ::HWM" do
-            it "should set the high water mark given a positive value" do
-              hwm = 4
-              socket.setsockopt ZMQ::HWM, hwm
-              array = []
-              rc = socket.getsockopt(ZMQ::HWM, array)
-              rc.should == 0
-              array[0].should == hwm
-            end
-          end # context using option ZMQ::HWM
-
-
-          context "using option ZMQ::SWAP" do
-            it "should set the swap value given a positive value" do
-              swap = 10_000
-              socket.setsockopt ZMQ::SWAP, swap
-              array = []
-              rc = socket.getsockopt(ZMQ::SWAP, array)
-              rc.should == 0
-              array[0].should == swap
-            end
-
-            it "returns -1 given a negative value" do
-              swap = -10_000
-              rc = socket.setsockopt(ZMQ::SWAP, swap)
-              rc.should == -1
-            end
-          end # context using option ZMQ::SWP
-
-
-          context "using option ZMQ::MCAST_LOOP" do
-            it "should enable the multicast loopback given a 1 (true) value" do
-              socket.setsockopt ZMQ::MCAST_LOOP, 1
-              array = []
-              rc = socket.getsockopt(ZMQ::MCAST_LOOP, array)
-              rc.should == 0
-              array[0].should be_true
-            end
-
-            it "should disable the multicast loopback given a 0 (false) value" do
-              socket.setsockopt ZMQ::MCAST_LOOP, 0
-              array = []
-              rc = socket.getsockopt(ZMQ::MCAST_LOOP, array)
-              rc.should == 0
-              array[0].should be_false
-            end
-          end # context using option ZMQ::MCAST_LOOP
-
-
-          context "using option ZMQ::RECOVERY_IVL_MSEC" do
-            it "should set the time interval for saving messages measured in milliseconds given a positive value" do
-              value = 200
-              socket.setsockopt ZMQ::RECOVERY_IVL_MSEC, value
-              array = []
-              rc = socket.getsockopt(ZMQ::RECOVERY_IVL_MSEC, array)
-              rc.should == 0
-              array[0].should == value
-            end
-
-            it "should default to a value of -1" do
-              value = -1
-              array = []
-              rc = socket.getsockopt(ZMQ::RECOVERY_IVL_MSEC, array)
-              rc.should == 0
-              array[0].should == value
-            end
-          end # context using option ZMQ::RECOVERY_IVL_MSEC
-
-        else # version3 or higher
-
-          context "using option ZMQ::IPV4ONLY" do
-            it "should enable use of IPV6 sockets when set to 0" do
-              value = 0
-              socket.setsockopt ZMQ::IPV4ONLY, value
-              array = []
-              rc = socket.getsockopt(ZMQ::IPV4ONLY, array)
-              rc.should == 0
-              array[0].should == value
-            end
-
-            it "should default to a value of 1" do
-              value = 1
-              array = []
-              rc = socket.getsockopt(ZMQ::IPV4ONLY, array)
-              rc.should == 0
-              array[0].should == value
-            end
-
-            it "returns -1 given a negative value" do
-              value = -1
-              rc = socket.setsockopt ZMQ::IPV4ONLY, value
-              rc.should == -1
-            end
+          it "should default to a value of 1" do
+            value = 1
+            array = []
+            rc = socket.getsockopt(ZMQ::IPV4ONLY, array)
+            rc.should == 0
+            array[0].should == value
+          end
 
-            it "returns -1 given a value > 1" do
-              value = 2
-              rc = socket.setsockopt ZMQ::IPV4ONLY, value
-              rc.should == -1
-            end
-          end # context using option ZMQ::IPV4ONLY
+          it "returns -1 given a negative value" do
+            value = -1
+            rc = socket.setsockopt ZMQ::IPV4ONLY, value
+            rc.should == -1
+          end
 
-          context "using option ZMQ::LAST_ENDPOINT" do
-            it "should return last enpoint" do
-              random_port = bind_to_random_tcp_port(socket, max_tries = 500)
-              array = []
-              rc = socket.getsockopt(ZMQ::LAST_ENDPOINT, array)
-              ZMQ::Util.resultcode_ok?(rc).should == true
-              endpoint_regex = %r{\Atcp://(.*):(\d+)\0\z}
-              array[0].should =~ endpoint_regex
-              Integer(array[0][endpoint_regex, 2]).should == random_port
-            end
+          it "returns -1 given a value > 1" do
+            value = 2
+            rc = socket.setsockopt ZMQ::IPV4ONLY, value
+            rc.should == -1
           end
-        end # version2? if/else block
+        end # context using option ZMQ::IPV4ONLY
 
+        context "using option ZMQ::LAST_ENDPOINT" do
+          it "should return last enpoint" do
+            random_port = bind_to_random_tcp_port(socket, max_tries = 500)
+            array = []
+            rc = socket.getsockopt(ZMQ::LAST_ENDPOINT, array)
+            ZMQ::Util.resultcode_ok?(rc).should == true
+            endpoint_regex = %r{\Atcp://(.*):(\d+)\0\z}
+            array[0].should =~ endpoint_regex
+            Integer(array[0][endpoint_regex, 2]).should == random_port
+          end
+        end
 
         context "using option ZMQ::SUBSCRIBE" do
           if ZMQ::SUB == socket_type
@@ -414,23 +336,13 @@ module ZMQ
             array[0].should == value
           end
 
-          if (ZMQ::SUB == socket_type) && version3? || (defined?(ZMQ::XSUB) && ZMQ::XSUB == socket_type)
             it "should default to a value of 0" do
-              value = 0
+              value = [SUB, XSUB].include?(socket_type) ? 0 : -1
               array = []
               rc = socket.getsockopt(ZMQ::LINGER, array)
               rc.should == 0
               array[0].should == value
             end
-          else
-            it "should default to a value of -1" do
-              value = -1
-              array = []
-              rc = socket.getsockopt(ZMQ::LINGER, array)
-              rc.should == 0
-              array[0].should == value
-            end
-          end
         end # context using option ZMQ::LINGER
 
 
@@ -457,7 +369,8 @@ module ZMQ
         context "using option ZMQ::BACKLOG" do
           it "should set the maximum number of pending socket connections given a positive value" do
             value = 200
-            socket.setsockopt ZMQ::BACKLOG, value
+            rc = socket.setsockopt ZMQ::BACKLOG, value
+            rc.should == 0
             array = []
             rc = socket.getsockopt(ZMQ::BACKLOG, array)
             rc.should == 0
@@ -514,8 +427,8 @@ module ZMQ
 
                 class PollFD < FFI::Struct
                   layout :fd,    :int,
-                  :events, :short,
-                  :revents, :short
+                    :events, :short,
+                    :revents, :short
                 end
               end # module LibSocket
 

data/spec/spec_helper.rb

@@ -1,11 +1,7 @@
-# To run these specs using rake, make sure the 'bones' and 'bones-extras'
-# gems are installed. Then execute 'rake spec' from the main directory
-# to run all specs.
 
 require File.expand_path(
 File.join(File.dirname(__FILE__), %w[.. lib ffi-rzmq]))
 
-require 'thread' # necessary when testing in MRI 1.8 mode
 Thread.abort_on_exception = true
 
 require 'openssl'
@@ -14,12 +10,8 @@ require 'securerandom'
 
 # define some version guards so we can turn on/off specs based upon
 # the version of the 0mq library that is loaded
-def version2?
-  ZMQ::LibZMQ.version2?
-end
-
-def version3?
-  ZMQ::LibZMQ.version3?
+def version4?
+  ZMQ::LibZMQ.version4?
 end
 
 def jruby?
@@ -35,7 +27,7 @@ end
 
 module APIHelper
   def poller_setup
-    @helper_poller ||= ZMQ::Poller.new
+    @helper_poller = ZMQ::Poller.new
   end
 
   def poller_register_socket(socket)

data/spec/util_spec.rb

@@ -0,0 +1,28 @@
+require File.join(File.dirname(__FILE__), %w[spec_helper])
+
+module ZMQ
+  describe Util do
+
+    if LibZMQ.version4?
+      describe "curve_keypair" do
+
+        it "returns a set of public and private keys" do
+          public_key, private_key = ZMQ::Util.curve_keypair
+
+          public_key.should_not == private_key
+          public_key.should_not be_nil
+          private_key.should_not be_nil
+        end
+
+        it "raises if zmq does not support CURVE (libsodium not linked)" do
+          lambda {
+            LibZMQ.should_receive(:zmq_curve_keypair).and_return(-1)
+            ZMQ::Util.curve_keypair
+          }.should raise_exception(ZMQ::NotSupportedError)
+        end
+
+      end
+    end
+
+  end
+end