ffi-rzmq-core 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d251cf90787964d1767307c511f830c983dd47c0
-  data.tar.gz: dbc73d731823c0f445d56b3a06250e4bdea8d2cc
+  metadata.gz: 65eb637703a1d78ee4d04307a8abee14f7ef4f33
+  data.tar.gz: 75103d5374eab92e290d2f4d9b62327446749570
 SHA512:
-  metadata.gz: 4a0b12abbb518be94ce38b80a65c3c494f76d7e527cbcb4e93ad801e066ef2d6553c5a0ed44c73aed998626d497e5d9e96f01fd0399407f5186bc100604f58d9
-  data.tar.gz: da40bae1ff70d829ec8b4f8bea9628417e3210138e83aa89f6e4d58fe5209103af8126ab48a2718f9b01416dc0fdcc268718e0c9e323bfd8a6213edc752739b9
+  metadata.gz: 1059be1ce0a593b54a70d149f8b9d7cf08ef28b3255612b4e6661ca3bf7b5fc283f14ac83c4b90640dd74777c6d95ee4c8c6c3f5c53f5841dfbfb1ab490c231d
+  data.tar.gz: 7d69ae0b651d109c17fa865934302161e63f246a3fb39e2c73b526d4db5eb2b35079163f14ba17b0b25b3dc134932fe430b893fb73a8af012c3ca7f7aa950cb7

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+
+task :default => :spec

data/lib/ffi-rzmq-core/libc.rb

@@ -8,8 +8,8 @@ module LibC
   find_type(:size_t) rescue typedef(:ulong, :size_t)
 
   # memory allocators
-  attach_function :malloc, [:size_t], :pointer
-  attach_function :free, [:pointer], :void
+  attach_function :malloc, [:size_t],  :pointer
+  attach_function :free,   [:pointer], :void
 
   # get a pointer to the free function; used for ZMQ::Message deallocation
   Free = library.find_symbol('free')

data/lib/ffi-rzmq-core/libzmq.rb

@@ -39,7 +39,7 @@ module LibZMQ
 
   # Context and misc api
   #
-  # @blocking = true is a hint to FFI that the following (and only the following)
+  # The `:blocking` option is a hint to FFI that the following (and only the following)
   # function may block, therefore it should release the GIL before calling it.
   # This can aid in situations where the function call will/may block and another
   # thread within the lib may try to call back into the ruby runtime. Failure to
@@ -80,6 +80,12 @@ module LibZMQ
   attach_function :zmq_bind, [:pointer, :string], :int, :blocking => true
   attach_function :zmq_connect, [:pointer, :string], :int, :blocking => true
   attach_function :zmq_close, [:pointer], :int, :blocking => true
+  attach_function :zmq_unbind, [:pointer, :string], :int, :blocking => true
+  attach_function :zmq_disconnect, [:pointer, :string], :int, :blocking => true
+  attach_function :zmq_recvmsg, [:pointer, :pointer, :int], :int, :blocking => true
+  attach_function :zmq_recv, [:pointer, :pointer, :size_t, :int], :int, :blocking => true
+  attach_function :zmq_sendmsg, [:pointer, :pointer, :int], :int, :blocking => true
+  attach_function :zmq_send, [:pointer, :pointer, :size_t, :int], :int, :blocking => true
 
   # Device API
   attach_function :zmq_proxy, [:pointer, :pointer, :pointer], :int, :blocking => true
@@ -90,11 +96,4 @@ module LibZMQ
   # Monitoring API
   attach_function :zmq_socket_monitor, [:pointer, :pointer, :int], :int, :blocking => true
 
-  # Socket API
-  attach_function :zmq_unbind, [:pointer, :string], :int, :blocking => true
-  attach_function :zmq_disconnect, [:pointer, :string], :int, :blocking => true
-  attach_function :zmq_recvmsg, [:pointer, :pointer, :int], :int, :blocking => true
-  attach_function :zmq_recv, [:pointer, :pointer, :size_t, :int], :int, :blocking => true
-  attach_function :zmq_sendmsg, [:pointer, :pointer, :int], :int, :blocking => true
-  attach_function :zmq_send, [:pointer, :pointer, :size_t, :int], :int, :blocking => true
 end

data/lib/ffi-rzmq-core/libzmq4.rb

@@ -0,0 +1,17 @@
+# Wraps the new API methods available in ZeroMQ 4
+#
+module LibZMQ
+
+  attach_function :zmq_ctx_term,     [:pointer], :void, :blocking => true
+  attach_function :zmq_ctx_shutdown, [:pointer], :void, :blocking => true
+
+  attach_function :zmq_send_const,   [:pointer, :pointer, :size_t], :int, :blocking => true
+
+  attach_function :zmq_z85_encode,   [:pointer, :pointer, :size_t], :string, :blocking => true
+  attach_function :zmq_z85_decode,   [:pointer, :string],           :pointer, :blocking => true
+
+  # Requires ZMQ compiled with libsodium
+  # Will return -1 with errno set to ENOSUP otherwise
+  attach_function :zmq_curve_keypair, [:pointer, :pointer], :int, :blocking => true
+
+end

data/lib/ffi-rzmq-core/structures.rb

@@ -2,12 +2,12 @@ module LibZMQ
 
   # Used for casting pointers back to the msg_t struct
   #
-  class Msg < FFI::Struct
+  class Message < FFI::Struct
     layout :content,  :pointer,
       :flags,    :uint8,
       :vsm_size, :uint8,
       :vsm_data, [:uint8, 30]
-  end # class Msg
+  end
 
 
   # Create the basic mapping for the poll_item_t structure so we can

data/lib/ffi-rzmq-core/version.rb

@@ -1,3 +1,3 @@
 module LibZMQ
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/lib/ffi-rzmq-core.rb

@@ -3,4 +3,8 @@ require 'ffi-rzmq-core/libc'
 require 'ffi-rzmq-core/libzmq'
 require 'ffi-rzmq-core/structures'
 require 'ffi-rzmq-core/utilities'
-require 'ffi-rzmq-core/constants'
+require 'ffi-rzmq-core/constants'
+
+if LibZMQ.version4?
+  require 'ffi-rzmq-core/libzmq4'
+end

data/spec/libc_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe LibC do
+
+  it "exposes the malloc function" do
+    expect(LibC).to respond_to(:malloc)
+  end
+
+  it "exposes the free function" do
+    expect(LibC).to respond_to(:free)
+    expect(LibC::Free).to_not be_nil
+  end
+
+  it "exposes the memcpy function" do
+    expect(LibC).to respond_to(:memcpy)
+  end
+
+end

data/spec/libzmq4_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+if LibZMQ.version4?
+  describe LibZMQ do
+
+    it "exposes new context management methods" do
+      [:zmq_ctx_term, :zmq_ctx_shutdown].each do |method|
+        expect(LibZMQ).to respond_to(method)
+      end
+    end
+
+    it "exposes new sending methods" do
+      expect(LibZMQ).to respond_to(:zmq_send_const)
+    end
+
+    it "exposes the binary encoding / decoding API" do
+      [:zmq_z85_encode, :zmq_z85_decode].each do |method|
+        expect(LibZMQ).to respond_to(method)
+      end
+    end
+
+    it "exposes CURVE security methods" do
+      expect(LibZMQ).to respond_to(:zmq_curve_keypair)
+    end
+
+  end
+end

data/spec/libzmq_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe LibZMQ do
+
+  it "exposes basic query methods" do
+    [:zmq_version, :zmq_errno, :zmq_strerror].each do |method|
+      expect(LibZMQ).to respond_to(method)
+    end
+  end
+
+  it "exposes initialization and context methods" do
+    [:zmq_init, :zmq_term, :zmq_ctx_new,
+     :zmq_ctx_destroy, :zmq_ctx_set, :zmq_ctx_get].each do |method|
+      expect(LibZMQ).to respond_to(method)
+    end
+  end
+
+  it "exposes the message API" do
+    [:zmq_msg_init, :zmq_msg_init_size, :zmq_msg_init_data,
+     :zmq_msg_close, :zmq_msg_data, :zmq_msg_size,
+     :zmq_msg_copy, :zmq_msg_move, :zmq_msg_send,
+     :zmq_msg_recv, :zmq_msg_more, :zmq_msg_get, :zmq_msg_set].each do |method|
+      expect(LibZMQ).to respond_to(method)
+    end
+  end
+
+  it "exposes the socket API" do
+    [:zmq_socket, :zmq_setsockopt, :zmq_getsockopt,
+     :zmq_bind, :zmq_connect, :zmq_close,
+     :zmq_unbind, :zmq_disconnect, :zmq_recvmsg,
+     :zmq_recv, :zmq_sendmsg, :zmq_send].each do |method|
+      expect(LibZMQ).to respond_to(method)
+    end
+  end
+
+  it "exposes the Device API" do
+    expect(LibZMQ).to respond_to(:zmq_proxy)
+  end
+
+  it "exposes the Poll API" do
+    expect(LibZMQ).to respond_to(:zmq_poll)
+  end
+
+  it "exposes the Monitoring API" do
+    expect(LibZMQ).to respond_to(:zmq_socket_monitor)
+  end
+
+end

data/spec/spec_helper.rb

@@ -1,8 +1,14 @@
-
 require File.expand_path(
 File.join(File.dirname(__FILE__), %w[.. lib ffi-rzmq-core]))
 
-def jruby?
-  RUBY_PLATFORM =~ /java/
+require 'rspec'
+require 'rspec/autorun'
+
+Dir[File.join(File.dirname(__FILE__), "support", "*.rb")].each do |support|
+  require support
+end
+
+RSpec.configure do |config|
+  config.include VersionChecking
 end
 

data/spec/structures_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe LibZMQ do
+
+  it "wraps the msg_t struct as Message" do
+    message = LibZMQ::Message.new
+
+    expect(message[:content]).to_not be_nil
+    expect(message[:flags]).to_not be_nil
+    expect(message[:vsm_size]).to_not be_nil
+    expect(message[:vsm_data]).to_not be_nil
+  end
+
+  it "wraps poll_item_t in a PollItem" do
+    poll_item = LibZMQ::PollItem.new
+    expect(poll_item.socket).to_not be_nil
+    expect(poll_item.fd).to_not be_nil
+    expect(poll_item.readable?).to_not be_nil
+    expect(poll_item.writable?).to_not be_nil
+    expect(poll_item.inspect).to_not be_nil
+  end
+
+  it "wraps zmq_event_t in an EventData" do
+    event_data = LibZMQ::EventData.new
+
+    expect(event_data.event).to_not be_nil
+    expect(event_data.value).to_not be_nil
+    expect(event_data.inspect).to_not be_nil
+  end
+
+end

data/spec/support/version_checking.rb

@@ -0,0 +1,7 @@
+# Helper methods for figuring out which version of Ruby / ZMQ we are
+# testing and working with.
+module VersionChecking
+  def jruby?
+    RUBY_PLATFORM =~ /java/
+  end
+end

metadata

@@ -1,57 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: ffi-rzmq-core
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Chuck Remes
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2013-11-14 00:00:00.000000000 Z
+date: 2013-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: ffi
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.9'
   type: :runtime
-  prerelease: false
+  name: ffi
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.9'
+  prerelease: false
 - !ruby/object:Gem::Dependency
-  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.14'
   type: :development
-  prerelease: false
+  name: rspec
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.14'
+  prerelease: false
 - !ruby/object:Gem::Dependency
-  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
-  prerelease: false
+  name: rake
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+  prerelease: false
 description: |-
   This gem provides only the FFI wrapper for the ZeroMQ (0mq) networking library.
       Project can be used by any other zeromq gems that want to provide their own high-level Ruby API.
@@ -63,22 +63,30 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .travis.yml
+- Gemfile
 - LICENSE
 - README.md
+- Rakefile
 - ffi-rzmq-core.gemspec
 - lib/ffi-rzmq-core.rb
 - lib/ffi-rzmq-core/constants.rb
 - lib/ffi-rzmq-core/libc.rb
 - lib/ffi-rzmq-core/libzmq.rb
+- lib/ffi-rzmq-core/libzmq4.rb
 - lib/ffi-rzmq-core/structures.rb
 - lib/ffi-rzmq-core/utilities.rb
 - lib/ffi-rzmq-core/version.rb
+- spec/libc_spec.rb
+- spec/libzmq4_spec.rb
+- spec/libzmq_spec.rb
 - spec/spec_helper.rb
+- spec/structures_spec.rb
+- spec/support/version_checking.rb
 homepage: http://github.com/chuckremes/ffi-rzmq-core
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -93,10 +101,16 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.0.3
-signing_key: 
+rubyforge_project:
+rubygems_version: 2.1.9
+signing_key:
 specification_version: 4
 summary: This gem provides only the FFI wrapper for the ZeroMQ (0mq) networking library.
 test_files:
+- spec/libc_spec.rb
+- spec/libzmq4_spec.rb
+- spec/libzmq_spec.rb
 - spec/spec_helper.rb
+- spec/structures_spec.rb
+- spec/support/version_checking.rb
+has_rdoc: