ffi-rzmq 2.0.0 → 2.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a406c4de564eef119c3f303a386546d6bfda94fd
-  data.tar.gz: 4ef6371ae1029809d302dc7911d0a5a056328428
+SHA256:
+  metadata.gz: 403a3126661f6dc781b72e58f03a2c6b84e38c8d72e9f4b25115c44731aef8e7
+  data.tar.gz: 86bd066c1eddd598e67387144e21e45875e2fd79e8a57c6d38c56f04a11b2f19
 SHA512:
-  metadata.gz: 801813a1a358e60fc0906369c1da88638bdb2c91588da12c50adf2b5869b8542690baa14b3d6098f2ba34e74fcb9468631c5f23ac21dba216782be21a654406d
-  data.tar.gz: 88e1a7bdc0500f6703e94ace2c145f96420fafa89b0bd39927edd5f4a396ca36a4a0bbb543d57b517b115eae5ffb9c55288b1b568fc4ae11f8acee903ceaa1b1
+  metadata.gz: 8704b9f4d77c7a3dba2381dfea0a8cc96604b453c4e042162c0410371bea0207433b8348b954398c5855427e6f4efc8b51a437a7abe4582f4de1d73e42ed17c1
+  data.tar.gz: a4df109b2adcc9b18ea2f772bac5d1130b33b7066a8c1160706cc201c0aa08f58acbef56b44c53a9151c38f9bcb553ccb2ede46182bfdaf9d79bccf85a7b4b08

data/.travis.yml

@@ -1,15 +1,14 @@
-before_install: sudo apt-get install libzmq3-dev
-script: bundle exec rspec
+script: ./travis_build_script.sh
 language: ruby
 rvm:
-  - 1.9.3
-  - 2.0.0
+  - 2.6.0
   - ruby-head
-  - jruby-19mode
+  - jruby
   - jruby-head
-  - rbx-2.1.1
+  - rbx-3
 
 matrix:
   allow_failures:
     - rvm: ruby-head
     - rvm: jruby-head
+    - rvm: rbx-3

data/AUTHORS.txt

@@ -32,4 +32,6 @@ Paul Chechetin, github: paulche
 
 Michael Zaccari, github: mzaccari
 
-Jason Roelofs, github: jasonroelofs
+Jason Roelofs, github: jasonroelofs
+
+Cédric Boutillier, github: boutil

data/History.txt

@@ -1,3 +1,63 @@
+== 2.0.7
+  * Fix Issue #130
+    Fix to better support Zeromq 3.x users when performing context termination.
+    Support library ffi-rzmq-core was updated to handle this support, so
+    we now have a minimum dependency of ffi-rzmq-core 1.0.7 on this gem.
+
+  * Fix Issue #131
+    Update the OpenSSL key and certificate files. Original files were 1024 bits
+    but this causes problems on some modern Linux (e.g. Debian) which complains
+    about the key length. Updated to 4096 bits. Copied the key and cert
+    generation scripts from the Debian repository with attribution. Thanks to
+    @boutil for the helper script and the bug report.
+
+== 2.0.6
+  * Fix for uncaught exception. Strange case... somehow calling
+    `zmq_ctx_term` was returning nil, so when checking the result code it
+    would fail. No overrides a nil value with 0 so check passes.
+
+  * Update some JRuby-specific code to fetch a file descriptor value. API
+    changed from earlier versions, so code is updated to use new API. All
+    specs pass.
+
+== 2.0.5
+  * Fix issue #123. Bundled gems were a bit outdated so upgraded to latest
+    rspec gem.
+
+  * Fix issue #124. Newer releases of libzmq are not exporting all symbols
+    to the global namespace so some lazy loading performed by FFI was
+	failing. Now force all symbols into global namespace.
+
+  * Fix "::Fixnum has been deprecated" warnings from MRI 2.4.x+.
+
+  * Force ffi-rzmq-core 1.0.6 or later as dependency.
+
+== 2.0.4
+  * Screwed up the release managment. Had wrong version in version.rb. Fixed.
+  
+== 2.0.3
+  * Updated specs to use RSpec 3.x syntax. Never again... if they change it
+    then I'm dumping rspec.
+    
+  * Now loading version.rb during startup so that ZMQ::VERSION returns a string.
+  
+  * Modified README to point most people to the Ruby gem that wraps the CZMQ
+    library. It's a much higher-level library that makes writing zeromq apps
+    very easy. This gem is for writing low-level code which most people don't
+    want or need to do. This gem is going into maintenance mode only.
+  
+
+== 2.0.2 
+
+  * Updated README to make it clearer which versions of libzmq are supported.
+  
+  * Updated README to use a newer example.
+
+== 2.0.1 / 20140122
+  * Fix setsockopt with string parameters for options that have very strict
+    requirements (like CURVE_SECRETKEY) (37aed3c)
+
+  * Provide a wrapper for zmq_curve_keypair for ZeroMQ4
 
 == 2.0.0 / 20140108
 	* Split out all of the FFI code to its own gem so other projects can use

data/README.rdoc

@@ -2,6 +2,22 @@ ffi-rzmq
     by Chuck Remes
     http://www.zeromq.org/bindings:ruby-ffi
 
+== FUTURE SUPPORT
+
+Most people writing Zeromq applications in Ruby should be using the rbczmq
+project. It wraps the CZMQ binding which is a much higher-level library
+for writing Zeromq code. Find the Ruby gem here:
+
+    http://github.com/methodmissing/rbczmq
+    
+Few projects need to write the low-level zeromq code that this gem allows.
+With the release of ffi-rzmq 2.0.3, this library is going into permanent 
+maintenance mode. As new versions of libzmq are released, interested parties
+should send pull requests to this project or its related project
+ffi-rzmq-core to support new features.
+
+The original README text follows...
+
 == DESCRIPTION:
 
 This gem wraps the ZeroMQ networking library using the ruby FFI (foreign
@@ -9,11 +25,18 @@ function interface). It's a pure ruby wrapper so this gem can be loaded
 and run by any ruby runtime that supports FFI. That's all of them:
 MRI 1.9.x, Rubinius and JRuby.
 
-This single gem supports 0mq 2.2.x and 3.2.x 0mq APIs. The 0mq project started
+The Ruby API provided by this gem is *NOT* very Ruby-like. It very closely
+tracks the libzmq C API. However, the contributors to this project have
+done all of the hard work to wrap up all of libzmq and make it accessible
+from Ruby. If you want it to be more Ruby-like (e.g. raise Exceptions instead
+of returning integer codes) then *wrap this library* with your own and release
+it as a gem. We will all be grateful!
+
+This single gem supports 0mq 3.2.x and 4.x APIs. The 0mq project started
 making backward-incompatible changes to the API with the 3.1.x release.
 The gem auto-configures itself to expose the API conforming to the loaded
-C library. 0mq API 3.0 is *not* supported; the 0mq community voted to
-abandon it.
+C library. 0mq 2.x is no longer supported. 0mq API 3.0 is *not* supported; 
+the 0mq community voted to abandon it.
 
 The impetus behind this library was to provide support for ZeroMQ in
 JRuby which has native threads. Unlike MRI, which has a GIL, JRuby and
@@ -36,7 +59,7 @@ than using a C extension.
 == FEATURES/PROBLEMS:
 
 This gem needs more tests. This gem has been battle tested by myself
-and others for over a year, so I am fairly confident that it is solid.
+and others for years, so I am fairly confident that it is solid.
 However, it is inevitable that there will be bugs, so please open
 issues for them here or fork this project, fix them, and send me a pull
 request.
@@ -46,6 +69,14 @@ on that gem to load and run this code, then this project also no longer
 supports MRI 1.8.x. I recommend JRuby for the best performance and
 stability.
 
+The `Socket` and `Context` classes have finalizers which will
+be called by the garbage collector when there are no more references.
+However, these finalizers should not be relied upon to orderly close
+your sockets and then the context. Finalizers run in a non-determinant
+order, so the `Context` finalizer may run first which will hang the
+program. To avoid this, make sure to close all sockets before the
+program exits.
+
 All features are implemented.
 
 == BUILD STATUS:
@@ -56,62 +87,71 @@ All features are implemented.
 
 == SYNOPSIS:
 
-0mq API v2 client code:
+0mq API v3.2-4 client code:
 
   require 'rubygems'
   require 'ffi-rzmq'
 
   if ARGV.length < 3
-    puts "usage: local_lat <connect-to> <message-size> <roundtrip-count>"
+    puts "usage: ruby local_lat.rb <connect-to> <message-size> <roundtrip-count>"
     exit
   end
-
+  
   bind_to = ARGV[0]
   message_size = ARGV[1].to_i
   roundtrip_count = ARGV[2].to_i
 
   ctx = ZMQ::Context.new
-  s = ctx.socket ZMQ::REP
-  rc = s.setsockopt(ZMQ::HWM, 100)
-  rc = s.bind(bind_to)
+  s   = ctx.socket ZMQ::REP
+  rc  = s.setsockopt(ZMQ::SNDHWM, 100)
+  rc  = s.setsockopt(ZMQ::RCVHWM, 100)
+  rc  = s.bind(bind_to)
 
-  msg = ""
   roundtrip_count.times do
-    rc = s.recv_string msg
+    msg = ""
+    rc  = s.recv_string msg
     raise "Message size doesn't match, expected [#{message_size}] but received [#{msg.size}]" if message_size != msg.size
-    rc = s.send_string msg, 0
+    rc  = s.send_string msg, 0
   end
 
-
-0mq API v2 server code:
+0mq API v3.2-4 server code:
 
   require 'rubygems'
   require 'ffi-rzmq'
 
   if ARGV.length < 3
-    puts "usage: remote_lat <connect-to> <message-size> <roundtrip-count>"
+    puts "usage: ruby remote_lat.rb <connect-to> <message-size> <roundtrip-count>"
     exit
   end
-
+  
+  def assert(rc)
+    raise "Last API call failed at #{caller(1)}" unless rc >= 0
+  end
+  
   connect_to = ARGV[0]
   message_size = ARGV[1].to_i
   roundtrip_count = ARGV[2].to_i
 
   ctx = ZMQ::Context.new
-  s = ctx.socket ZMQ::REQ
-  rc = s.connect(connect_to)
+  s   = ctx.socket ZMQ::REQ
+  rc  = s.connect(connect_to)
 
   msg = "#{ '3' * message_size }"
 
-  start_time = Time.now
+  time_start = Time.now
 
-  msg = ""
   roundtrip_count.times do
-    rc = s.send_string msg, 0
-    rc = s.recv_string msg
+    assert(s.send_string(msg, 0))
+  
+    msg = ''
+    assert(s.recv_string(msg, 0))
+  
     raise "Message size doesn't match, expected [#{message_size}] but received [#{msg.size}]" if message_size != msg.size
   end
 
+  time_end = Time.now
+  puts "Time #{( time_end - time_start )}"
+
 == Better Examples
 
 I highly recommend visiting the Learn Ruby 0mq project for a bunch of good code examples.
@@ -139,7 +179,7 @@ It will crash randomly and you will be sad.
 
 == INSTALL:
 
-Make sure the ZeroMQ library is already installed on your system.
+Make sure the ZeroMQ library is already installed on your system. We recommend 'brew' or 'macports' to get it.
 
  % gem install ffi-rzmq # should grab the latest release
 
@@ -161,7 +201,7 @@ that activity. That DLL also requires that you copy libstdc++-6.dll and libgcc_s
 
 (The MIT License)
 
-Copyright (c) 2013 Chuck Remes
+Copyright (c) 2013-2017 Chuck Remes
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Rakefile

@@ -4,3 +4,18 @@ require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new
 
 task :default => :spec
+
+task :console do
+  require 'irb'
+  require 'irb/completion'
+  require 'ffi-rzmq'
+  ARGV.clear
+  IRB.start
+end
+
+task :pryconsole do
+  require 'pry'
+  require 'ffi-rzmq'
+  ARGV.clear
+  Pry.start
+end

data/examples/repreq_over_curve.rb

@@ -0,0 +1,60 @@
+require File.join(File.dirname(__FILE__), '..', 'lib', 'ffi-rzmq')
+
+# This example shows the basics of a CURVE-secured REP/REQ setup between
+# a Server and Client. This is the minimal required setup for authenticating
+# a connection between a Client and a Server. For validating the Client's authentication
+# once the initial connection has succeeded, you'll need a ZAP handler on the Server.
+
+# Build the Server's keys
+server_public_key, server_private_key = ZMQ::Util.curve_keypair
+
+# Build the Client's keys
+client_public_key, client_private_key = ZMQ::Util.curve_keypair
+
+context = ZMQ::Context.new
+bind_point = "tcp://127.0.0.1:4455"
+
+##
+# Configure the Server
+##
+server = context.socket ZMQ::REP
+
+server.setsockopt(ZMQ::CURVE_SERVER, 1)
+server.setsockopt(ZMQ::CURVE_SECRETKEY, server_private_key)
+
+server.bind(bind_point)
+
+##
+# Configure the Client to talk to the Server
+##
+client = context.socket ZMQ::REQ
+
+client.setsockopt(ZMQ::CURVE_SERVERKEY, server_public_key)
+client.setsockopt(ZMQ::CURVE_PUBLICKEY, client_public_key)
+client.setsockopt(ZMQ::CURVE_SECRETKEY, client_private_key)
+
+client.connect(bind_point)
+
+##
+# Show that communication still works
+##
+
+client_message = "Hello Server!"
+server_response = "Hello Client!"
+
+puts "Client sending: #{client_message}"
+client.send_string client_message
+
+server.recv_string(server_message = '')
+puts "Server received: #{server_message}, replying with #{server_response}"
+
+server.send_string(server_response)
+
+client.recv_string(response = '')
+puts "Client has received: #{response}"
+
+puts "Finished"
+
+client.close
+server.close
+context.terminate

data/ffi-rzmq.gemspec

@@ -21,7 +21,7 @@ and run by any ruby runtime that supports FFI. That's all of the major ones - MR
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_runtime_dependency "ffi-rzmq-core", [">= 1.0.1"]
-  s.add_development_dependency "rspec", ["~> 2.14"]
+  s.add_runtime_dependency "ffi-rzmq-core", [">= 1.0.7"]
+  s.add_development_dependency "rspec", ["~> 3.7"]
   s.add_development_dependency "rake"
 end

data/lib/ffi-rzmq/context.rb

@@ -82,9 +82,9 @@ module ZMQ
     def terminate
       unless @context.nil? || @context.null?
         remove_finalizer
-        rc = LibZMQ.zmq_ctx_destroy(@context)
+        rc = LibZMQ.terminate_context(@context)
         @context = nil
-        rc
+        rc || 0
       else
         0
       end
@@ -129,7 +129,7 @@ module ZMQ
     end
 
     def self.close context, pid
-      Proc.new { LibZMQ.zmq_term context if !context.null? && Process.pid == pid }
+      Proc.new { LibZMQ.zmq_ctx_term context if !context.null? && Process.pid == pid }
     end
   end
 

data/lib/ffi-rzmq/exceptions.rb

@@ -13,6 +13,9 @@ module ZMQ
     end
   end # call ZeroMQError
 
+  class NotSupportedError < ZeroMQError
+  end
+
 
   class ContextError < ZeroMQError
     # True when the exception was raised due to the library

data/lib/ffi-rzmq/poll_item.rb

@@ -1,5 +1,4 @@
 require 'forwardable'
-require 'io_extensions'
 
 module ZMQ
   class PollItem

data/lib/ffi-rzmq/socket.rb

@@ -135,15 +135,14 @@ module ZMQ
         pointer.write_int value
 
       elsif 2 == @option_lookup[name]
+        # Strings are treated as pointers by FFI so we'll just pass it through
         length ||= value.size
+        pointer = value
 
-        # note: not checking errno for failed memory allocations :(
-        pointer = LibC.malloc length
-        pointer.write_string value
       end
 
       rc = LibZMQ.zmq_setsockopt @socket, name, pointer, length
-      LibC.free(pointer) unless pointer.nil? || pointer.null?
+      LibC.free(pointer) unless pointer.is_a?(String) || pointer.nil? || pointer.null?
       rc
     end
 

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

data/lib/ffi-rzmq/version.rb

@@ -1,3 +1,3 @@
 module ZMQ
-  VERSION = "2.0.0"
+  VERSION = "2.0.7"
 end

data/lib/ffi-rzmq.rb

@@ -66,6 +66,7 @@ end  # module ZMQ
 require 'ffi-rzmq-core'
 
 # the order of files is important
-%w(util exceptions context message socket poll_items poll_item poll device).each do |file|
+require ZMQ.libpath(['.', "io_extensions"])
+%w(util exceptions context message socket poll_items poll_item poll device version).each do |file|
   require ZMQ.libpath(['ffi-rzmq', file])
 end

data/lib/io_extensions.rb

@@ -10,7 +10,7 @@ class IO
       when STDERR, $stderr
         2
       else
-        JRuby.reference(self).getOpenFile.getMainStream.getDescriptor.getChannel.getFDVal
+        JRuby.reference(self).getOpenFile().getFileno
       end
     end
   else

data/spec/context_spec.rb

@@ -11,31 +11,31 @@ module ZMQ
       include APIHelper
 
       it "should return nil for negative io threads" do
-        Context.create(-1).should be_nil
+        expect(Context.create(-1)).to eq(nil)
       end
       
       it "should default to requesting 1 i/o thread when no argument is passed" do
         ctx = Context.create
-        ctx.io_threads.should == 1
+        expect(ctx.io_threads).to eq(1)
       end
 
       it "should set the :pointer accessor to non-nil" do
         ctx = Context.create
-        ctx.pointer.should_not be_nil
+        expect(ctx.pointer).not_to be_nil
       end
 
       it "should set the :context accessor to non-nil" do
         ctx = Context.create
-        ctx.context.should_not be_nil
+        expect(ctx.context).not_to be_nil
       end
 
       it "should set the :pointer and :context accessors to the same value" do
         ctx = Context.create
-        ctx.pointer.should == ctx.context
+        expect(ctx.pointer).to eq(ctx.context)
       end
       
       it "should define a finalizer on this object" do
-        ObjectSpace.should_receive(:define_finalizer)
+        expect(ObjectSpace).to receive(:define_finalizer)
         ctx = Context.create
       end
     end # context initializing
@@ -45,31 +45,31 @@ module ZMQ
       include APIHelper
 
       it "should raise a ContextError exception for negative io threads" do
-        lambda { Context.new(-1) }.should raise_exception(ZMQ::ContextError)
+        expect { Context.new(-1) }.to raise_exception(ZMQ::ContextError)
       end
       
       it "should default to requesting 1 i/o thread when no argument is passed" do
         ctx = Context.new
-        ctx.io_threads.should == 1
+        expect(ctx.io_threads).to eq(1)
       end
 
       it "should set the :pointer accessor to non-nil" do
         ctx = Context.new
-        ctx.pointer.should_not be_nil
+        expect(ctx.pointer).not_to be_nil
       end
 
       it "should set the :context accessor to non-nil" do
         ctx = Context.new
-        ctx.context.should_not be_nil
+        expect(ctx.context).not_to be_nil
       end
 
       it "should set the :pointer and :context accessors to the same value" do
         ctx = Context.new
-        ctx.pointer.should == ctx.context
+        expect(ctx.pointer).to eq(ctx.context)
       end
       
       it "should define a finalizer on this object" do
-        ObjectSpace.should_receive(:define_finalizer)
+        expect(ObjectSpace).to receive(:define_finalizer)
         Context.new 1
       end
     end # context initializing
@@ -79,13 +79,13 @@ module ZMQ
       it "should set the context to nil when terminating the library's context" do
         ctx = Context.new # can't use a shared context here because we are terminating it!
         ctx.terminate
-        ctx.pointer.should be_nil
+        expect(ctx.pointer).to be_nil
       end
       
       it "should call the correct library function to terminate the context" do
         ctx = Context.new
 
-        LibZMQ.should_receive(:zmq_ctx_destroy).with(ctx.pointer).and_return(0)
+        expect(LibZMQ).to receive(:terminate_context).with(ctx.pointer).and_return(0)
         ctx.terminate
       end
     end # context terminate
@@ -94,8 +94,8 @@ module ZMQ
     context "when allocating a socket" do
       it "should return nil when allocation fails" do
         ctx = Context.new
-        LibZMQ.stub(:zmq_socket => nil)
-        ctx.socket(ZMQ::REQ).should be_nil
+        allow(LibZMQ).to receive(:zmq_socket).and_return(nil)
+        expect(ctx.socket(ZMQ::REQ)).to be_nil
       end
     end # context socket
 

data/spec/device_spec.rb

@@ -26,9 +26,9 @@ module ZMQ
         front = @ctx.socket(ZMQ::PUSH)
         front.bind(@front_endpoint)
         @mutex.synchronize { @device_thread = true }
-        puts "create streamer device and running..."
+        puts "create streamer device and running..." if $DEBUG
         Device.new(back, front)
-        puts "device exited"
+        puts "device exited" if $DEBUG
         back.close
         front.close
       end
@@ -40,7 +40,7 @@ module ZMQ
         
         break if can_break
       end
-      puts "broke out of wait_for_device loop"
+      puts "broke out of wait_for_device loop" if $DEBUG
     end
 
     it "should create a device without error given valid opts" do
@@ -63,16 +63,16 @@ module ZMQ
 
       res = ''
       rc = puller.recv_string(res, ZMQ::DONTWAIT)
-      res.should == "hello"
+      expect(res).to eq("hello")
 
       pusher.close
       puller.close
     end
 
     it "should raise an ArgumentError when trying to pass non-socket objects into the device" do
-      lambda {
+      expect {
         Device.new(1,2)
-      }.should raise_exception(ArgumentError)
+      }.to raise_exception(ArgumentError)
     end
   end
 end