nn-core 0.1.0

data/.gitignore

@@ -0,0 +1,9 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+*.tmproj
+.rbx
+
+*.rbc
+.redcar/

data/.rspec

@@ -0,0 +1,4 @@
+--color
+--format documentation
+--backtrace
+--default_path spec

data/Authors.txt

@@ -0,0 +1,2 @@
+Chuck Remes, git@chuckremes.com
+

data/Gemfile

@@ -0,0 +1,5 @@
+source "http://rubygems.org"
+
+gemspec
+
+gem "jruby-openssl", :platform => :jruby

data/History.txt

@@ -0,0 +1,4 @@
+20130204 / 0.1.0
+	* Initial release. Wrapped the nanomsg library as of commit 
+		5ded934af0.
+		

data/README.md

@@ -0,0 +1,57 @@
+nn-core
+-------
+
+nn-core is a very thin FFI wrapper around the nanomsg library. The intention is to provide a very
+simple wrapper that hews as close to the C API as possible. Other gems that want to offer a more
+idiomatic API for Ruby should require this gem and build a nice Ruby API with it.
+
+For more information on nanomsg, please visit its website:
+
+http://nanomsg.org
+
+Installation
+------------
+
+1. Make sure to build libnanomsg first by following these instructions:
+
+http://github.com/250bpm/nanomsg
+
+2. git clone git://github.com/chuckremes/nn-core.git
+
+3. cd nn-core
+
+4. ruby -S gem build nn-core.gemspec
+
+5. ruby -S gem install nn-core*.gem
+
+6. In your code, do:
+
+```ruby
+require "nn-core"
+```
+
+License
+-------
+
+(The MIT License)
+
+Copyright (c) 2013 Chuck Remes
+
+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,6 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+
+task :default => :spec

data/lib/nn-core/constants.rb

@@ -0,0 +1,85 @@
+module NNCore
+  NN_HAUSNUMERO = 156384712
+
+  # SP address families
+  AF_SP = 1
+  AF_SP_RAW = 2
+
+  # Transport types
+  NN_INPROC = -1
+  NN_IPC = -2
+  NN_TCP = -3
+
+  # Protocols
+  NN_PAIR_ID = 1
+  NN_PAIR = (NN_PAIR_ID * 16 + 0)
+
+  NN_PUBSUB_ID = 2
+  NN_PUB = (NN_PUBSUB_ID * 16 + 0)
+  NN_SUB = (NN_PUBSUB_ID * 16 + 1)
+
+  NN_REQREP_ID = 3
+  NN_REQ = (NN_REQREP_ID * 16 + 0)
+  NN_REP = (NN_REQREP_ID * 16 + 1)
+
+  NN_FANIN_ID = 4
+  NN_SOURCE = (NN_FANIN_ID * 16 + 0)
+  NN_SINK = (NN_FANIN_ID * 16 + 1)
+  NN_FANOUT_ID = 5
+  NN_PUSH = (NN_FANOUT_ID * 16 + 0)
+  NN_PULL = (NN_FANOUT_ID * 16 + 1)
+
+  NN_SURVEY_ID = 6
+  NN_SURVEYOR = (NN_SURVEY_ID * 16 + 0)
+  NN_RESPONDENT = (NN_SURVEY_ID * 16 + 1)
+
+  # Socket Option Levels (SOL)
+  NN_SOL_SOCKET = 0
+
+  # Socket options
+  NN_LINGER = 1
+  NN_SNDBUF = 2
+  NN_RCVBUF = 3
+  NN_SNDTIMEO = 4
+  NN_RCVTIMEO = 5
+  NN_RECONNECT_IVL = 6
+  NN_RECONNECT_IVL_MAX = 7
+  NN_SNDPRIO = 8
+  #NN_SNDFD = 10
+  #NN_RCVFD = 11
+
+  # Send/recv options
+  NN_DONTWAIT = 1
+  NN_MSG = -1
+
+  # Socket errors
+  ENOTSUP = Errno::ENOTSUP::Errno rescue NN_HAUSNUMERO + 1
+  EPROTONOSUPPORT = Errno::EPROTONOSUPPORT::Errno rescue NN_HAUSNUMERO + 2
+  ENOBUFS = Errno::ENOBUFS::Errno rescue NN_HAUSNUMERO + 3
+  ENETDOWN = Errno::ENETDOWN::Errnow rescue NN_HAUSNUMERO + 4
+  EADDRINUSE = Errno::EADDRINUSE::Errno rescue NN_HAUSNUMERO + 5
+  EADDRNOTAVAIL = Errno::EADDRNOTAVAIL::Errno rescue NN_HAUSNUMERO + 6
+  ECONNREFUSED = Errno::ECONNREFUSED::Errno rescue NN_HAUSNUMERO + 7
+  EINPROGRESS = Errno::EINPROGRESS::Errno rescue NN_HAUSNUMERO + 8
+  ENOTSOCK = Errno::ENOTSOCK::Errno rescue NN_HAUSNUMERO + 9
+  EAFNOSUPPORT = Errno::EAFNOSUPPORT::Errno rescue NN_HAUSNUMERO + 10
+  EPROTO = Errno::EPROTO::Errno rescue NN_HAUSNUMERO + 11
+  
+  ETIMEDOUT = Errno::ETIMEDOUT::Errno
+  EAGAIN = Errno::EAGAIN::Errno
+  EINVAL = Errno::EINVAL::Errno
+  ENOMEM = Errno::ENOMEM::Errno
+  ENODEV = Errno::ENODEV::Errno
+  EFAULT = Errno::EFAULT::Errno
+  #  EINTR  = Errno::EINTR::Errno
+  EBADF = Errno::EBADF::Errno
+  ENOPROTOOPT = Errno::ENOPROTOOPT::Errno
+  ENAMETOOLONG = Errno::ENAMETOOLONG::Errno
+
+  # Library errors
+  ETERM = Errno::ETERM::Errno rescue NN_HAUSNUMERO + 53
+  EFSM = Errno::EFSM::Errno rescue NN_HAUSNUMERO + 54
+
+  # Miscellaneous
+  NN_INPROCB_NAMELEN_MAX = 64
+end

data/lib/nn-core/libnanomsg.rb

@@ -0,0 +1,59 @@
+
+module NNCore
+  module LibNanomsg
+    extend FFI::Library
+    
+    begin
+      # bias the library discovery to a path inside the gem first, then
+      # to the usual system paths
+      inside_gem = File.join(File.dirname(__FILE__), '..', '..', 'ext')
+      local_path = FFI::Platform::IS_WINDOWS ? ENV['PATH'].split(';') : ENV['PATH'].split(':')
+      library_name = "libnanomsg"
+      LIB_PATHS = [
+        inside_gem, '/usr/local/lib', '/opt/local/lib', '/usr/local/homebrew/lib', '/usr/lib64'
+      ].map{|path| "#{path}/#{library_name}.#{FFI::Platform::LIBSUFFIX}"}
+      ffi_lib(LIB_PATHS + [library_name])
+    rescue LoadError
+      if LIB_PATHS.push(*local_path).any? {|path|
+        File.file? File.join(path, "#{library_name}.#{FFI::Platform::LIBSUFFIX}")}
+        warn "Unable to load this gem. The #{library_name} library exists, but cannot be loaded."
+        warn "If this is Windows:"
+        warn "-  Check that you have MSVC runtime installed or statically linked"
+        warn "-  Check that your DLL is compiled for #{FFI::Platform::ADDRESS_SIZE} bit"
+      else
+        warn "Unable to load this gem. The #{library_name} library (or DLL) could not be found."
+        warn "If this is a Windows platform, make sure #{library_name}.dll is on the PATH."
+        warn "If the DLL was built with mingw, make sure the other two dependent DLLs,"
+        warn "libgcc_s_sjlj-1.dll and libstdc++6.dll, are also on the PATH."
+        warn "For non-Windows platforms, make sure #{library_name} is located in this search path:"
+        warn LIB_PATHS.inspect
+      end
+      raise LoadError, "The #{library_name} library (or DLL) could not be loaded"
+    end
+    # Size_t not working properly on Windows
+    find_type(:size_t) rescue typedef(:ulong, :size_t)
+
+    attach_function :nn_version, [:pointer, :pointer, :pointer], :int
+    
+    attach_function :nn_init, [], :int
+    attach_function :nn_term, [], :int
+    attach_function :nn_errno, [], :int
+    attach_function :nn_strerror, [:int], :string
+    attach_function :nn_socket, [:int, :int], :int
+    attach_function :nn_close, [:int], :int
+    
+    attach_function :nn_getsockopt, [:int, :int, :int, :pointer, :pointer], :int
+    attach_function :nn_setsockopt, [:int, :int, :int, :pointer, :size_t], :int
+    attach_function :nn_bind, [:int, :string], :int
+    attach_function :nn_connect, [:int, :string], :int
+    attach_function :nn_shutdown, [:int, :int], :int
+    attach_function :nn_send, [:int, :pointer, :size_t, :int], :int
+    attach_function :nn_recv, [:int, :pointer, :size_t, :int], :int
+
+    # functions for working with raw buffers
+    attach_function :nn_sendmsg, [:int, :pointer, :int], :int
+    attach_function :nn_recvmsg, [:int, :pointer, :int], :int
+    attach_function :nn_allocmsg, [:size_t, :int], :pointer
+    attach_function :nn_freemsg, [:pointer], :int        
+  end
+end

data/lib/nn-core/structs.rb

@@ -0,0 +1,121 @@
+
+module NNCore
+  module LibNanomsg
+        
+    # Structs for working with raw buffers (not recommended)
+    module NNIOVecLayout
+      def self.included(base)
+        base.class_eval do
+          layout :iov_base,  :pointer,
+            :iov_len,    :size_t
+        end
+      end
+    end
+
+    class NNIOVec < FFI::Struct
+      include NNIOVecLayout
+      
+      def iov_base
+        self[:iov_base]
+      end
+      
+      def iov_base=(pointer)
+        self[:iov_base] = pointer
+      end
+      
+      def iov_len
+        self[:iov_len]
+      end
+      
+      def iov_len=(length)
+        self[:iov_len] = length
+      end
+    end
+    
+    module NNMsgHdrLayout
+      def self.included(base)
+        base.class_eval do
+          layout :msg_iov, NNIOVec.ptr,
+          :msg_iovlen, :int,
+          :msg_control, :pointer,
+          :msg_controllen, :size_t
+        end
+      end
+    end
+    
+    class NNMsgHdr < FFI::Struct
+      include NNMsgHdrLayout
+      
+      def msg_iov
+        self[:msg_iov]
+      end
+      
+      def msg_iov=(structure)
+        self[:msg_iov] = structure
+      end
+      
+      def msg_iovlen
+        self[:msg_iovlen]
+      end
+      
+      def msg_iovlen=(length)
+        self[:msg_iovlen] = length
+      end
+      
+      def msg_control
+        self[:msg_control]
+      end
+      
+      def msg_control=(pointer)
+        self[:msg_control] = pointer
+      end
+      
+      def msg_controllen
+        self[:msg_controllen]
+      end
+      
+      def msg_controllen=(value)
+        self[:msg_controllen] = value
+      end
+    end
+    
+    module NNCMsgHdrLayout
+      def self.included(base)
+        base.class_eval do
+          layout :cmsg_len, :size_t,
+          :cmsg_level, :int,
+          :cmsg_type, :int
+        end
+      end
+    end
+    
+    class NNCMsgHdr < FFI::Struct
+      include NNCMsgHdrLayout
+      
+      def cmsg_len
+        self[:cmsg_len]
+      end
+      
+      def cmsg_len=(length)
+        self[:csmg_len] = length
+      end
+      
+      def cmsg_level
+        self[:cmsg_level]
+      end
+      
+      def cmsg_level=(level)
+        self[:cmsg_level] = level
+      end
+      
+      def cmsg_type
+        self[:cmsg_type]
+      end
+      
+      def cmsg_type=(type)
+        self[:cmsg_type] = type
+      end
+    end
+        
+  end
+end

data/lib/nn-core/version.rb

@@ -0,0 +1,3 @@
+module NNCore
+  VERSION = "0.1.0"
+end

data/lib/nn-core.rb

@@ -0,0 +1,6 @@
+require 'ffi'
+require 'nn-core/version'
+
+require 'nn-core/libnanomsg'
+require 'nn-core/structs'
+require 'nn-core/constants'

data/nn-core.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "nn-core/version"
+
+Gem::Specification.new do |s|
+  s.name        = "nn-core"
+  s.version     = NNCore::VERSION
+  s.authors     = ["Chuck Remes"]
+  s.email       = ["git@chuckremes.com"]
+  s.homepage    = "http://github.com/chuckremes/nn-core"
+  s.summary     = %q{Wraps the nanomsg networking library using Ruby FFI (foreign function interface).}
+  s.description = %q{Wraps the nanomsg networking library using the ruby FFI (foreign
+function interface). It only exposes the native C API to Ruby. Other gems should use this gem
+to build an API using Ruby idioms.}
+
+  s.rubyforge_project = "nn-core"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency "ffi"
+  s.add_development_dependency "rspec", ["~> 2.6"]
+  s.add_development_dependency "rake"
+end

data/spec/nn_bind_spec.rb

@@ -0,0 +1,106 @@
+require 'spec_helper'
+
+module NNCore
+  describe "nn_bind" do
+
+    context "given an initialized library and" do
+      before(:each) { LibNanomsg.nn_init }
+      after(:each) { LibNanomsg.nn_term }
+
+
+      context "given a valid socket" do
+        before(:each) do
+          LibNanomsg.nn_init
+          @socket = LibNanomsg.nn_socket(AF_SP, NN_PUB)
+        end
+
+        after(:each) do
+          LibNanomsg.nn_close(@socket)
+          LibNanomsg.nn_term
+        end
+
+        it "returns a non-zero endpoint number for a valid INPROC address" do
+          rc = LibNanomsg.nn_bind(@socket, "inproc://some_address")
+          rc.should > 0
+        end
+
+        it "returns a non-zero endpoint number for a valid IPC address" do
+          rc = LibNanomsg.nn_bind(@socket, "ipc:///tmp/some_address")
+          rc.should > 0
+        end
+
+        it "returns a non-zero endpoint number for a valid TCP address" do
+          rc = LibNanomsg.nn_bind(@socket, "tcp://127.0.0.1:5555")
+          rc.should > 0
+        end
+
+        it "returns -1 for an invalid INPROC address" do
+          rc = LibNanomsg.nn_bind(@socket, "inproc:/missing_first_slash")
+          rc.should == -1
+          LibNanomsg.nn_errno.should == EINVAL
+        end
+
+        it "returns -1 for an invalid INPROC address (too long)" do
+          rc = LibNanomsg.nn_bind(@socket, "inproc://#{'a' * (NN_INPROCB_NAMELEN_MAX + 1)}")
+          rc.should == -1
+          LibNanomsg.nn_errno.should == ENAMETOOLONG
+        end
+
+        it "returns -1 for an invalid IPC address" do
+          rc = LibNanomsg.nn_bind(@socket, "ipc:/missing_slashes)")
+          rc.should == -1
+          LibNanomsg.nn_errno.should == EINVAL
+        end
+
+        it "returns -1 for an invalid TCP address (missing address)" do
+          rc = LibNanomsg.nn_bind(@socket, "tcp://")
+          rc.should == -1
+          LibNanomsg.nn_errno.should == EINVAL
+        end
+
+        it "returns -1 for an invalid TCP address (non-numeric port)" do
+          rc = LibNanomsg.nn_bind(@socket, "tcp://192.168.0.1:port")
+          rc.should == -1
+          LibNanomsg.nn_errno.should == EINVAL
+        end
+
+        it "returns -1 for an invalid TCP address (port number is out of range)" do
+          rc = LibNanomsg.nn_bind(@socket, "tcp://192.168.0.1:65536")
+          rc.should == -1
+          LibNanomsg.nn_errno.should == EINVAL
+        end
+
+        it "returns -1 for an unsupported transport protocol" do
+          rc = LibNanomsg.nn_bind(@socket, "zmq://192.168.0.1:65536")
+          rc.should == -1
+          LibNanomsg.nn_errno.should == EPROTONOSUPPORT
+        end
+
+        it "returns -1 for specifying a non-existent device using TCP transport" do
+          rc = LibNanomsg.nn_bind(@socket, "tcp://eth5:5555")
+          rc.should == -1
+          LibNanomsg.nn_errno.should == ENODEV
+        end
+
+        it "returns -1 when binding to an existing endpoint" do
+          rc = LibNanomsg.nn_bind(@socket, "inproc://some_endpoint")
+          rc = LibNanomsg.nn_bind(@socket, "inproc://some_endpoint")
+          rc.should == -1
+          LibNanomsg.nn_errno.should == EADDRINUSE
+        end
+        
+      end
+
+      context "given an invalid file descriptor" do
+        
+        it "returns -1 and sets nn_errno to EBADF" do
+          rc = LibNanomsg.nn_bind(0, "inproc://some_endpoint")
+          rc.should == -1
+          LibNanomsg.nn_errno.should == EBADF
+        end
+        
+      end
+
+    end
+  end
+end

data/spec/nn_close_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+module NNCore
+  describe "nn_close" do
+
+    context "given an unitialized library" do
+      before(:each) { LibNanomsg.nn_term }
+
+      it "returns -1 and sets nn_errno to EFAULT" do
+        LibNanomsg.nn_close(0).should == -1
+        LibNanomsg.nn_errno.should == EFAULT
+      end
+
+    end
+
+    context "given an initialized library and" do
+      before(:each) { LibNanomsg.nn_init }
+      after(:each) { LibNanomsg.nn_term }
+
+      context "given a valid socket" do
+        before(:each) { @socket = LibNanomsg.nn_socket(AF_SP, NN_PUB) }
+
+        it "returns 0" do
+          LibNanomsg.nn_close(@socket).should be_zero
+        end
+
+      end
+
+      context "given an invalid file descriptor" do
+
+        it "returns -1 and sets nn_errno to EBADF" do
+          LibNanomsg.nn_close(0).should == -1
+          LibNanomsg.nn_errno.should == EBADF
+        end
+
+      end
+
+    end
+  end
+end

data/spec/nn_connect_spec.rb

@@ -0,0 +1,112 @@
+require 'spec_helper'
+
+# NOTE!
+#
+# Any specs added to this file should be mirrored in the nn_bind_spec.rb file too
+# so that coverage remains complete.
+#
+
+module NNCore
+  describe "nn_connect" do
+
+    context "given an initialized library and" do
+      before(:each) { LibNanomsg.nn_init }
+      after(:each) { LibNanomsg.nn_term }
+
+
+      context "given a valid socket" do
+        before(:each) do
+          LibNanomsg.nn_init
+          @socket = LibNanomsg.nn_socket(AF_SP, NN_PUB)
+        end
+
+        after(:each) do
+          LibNanomsg.nn_close(@socket)
+          LibNanomsg.nn_term
+        end
+
+        it "returns a non-zero endpoint number for a valid INPROC address" do
+          rc = LibNanomsg.nn_connect(@socket, "inproc://some_address")
+          rc.should > 0
+        end
+
+        it "returns a non-zero endpoint number for a valid IPC address" do
+          rc = LibNanomsg.nn_connect(@socket, "ipc:///tmp/some_address")
+          rc.should > 0
+        end
+
+        it "returns a non-zero endpoint number for a valid TCP address" do
+          rc = LibNanomsg.nn_connect(@socket, "tcp://127.0.0.1:5555")
+          rc.should > 0
+        end
+
+        it "returns -1 for an invalid INPROC address" do
+          rc = LibNanomsg.nn_connect(@socket, "inproc:/missing_first_slash")
+          rc.should == -1
+          LibNanomsg.nn_errno.should == EINVAL
+        end
+
+        it "returns -1 for an invalid INPROC address (too long)" do
+          rc = LibNanomsg.nn_connect(@socket, "inproc://#{'a' * (NN_INPROCB_NAMELEN_MAX + 1)}")
+          rc.should == -1
+          LibNanomsg.nn_errno.should == ENAMETOOLONG
+        end
+
+        it "returns -1 for an invalid IPC address" do
+          rc = LibNanomsg.nn_connect(@socket, "ipc:/missing_slashes)")
+          rc.should == -1
+          LibNanomsg.nn_errno.should == EINVAL
+        end
+
+#        it "returns -1 for an invalid TCP address (missing port)" do
+#          rc = LibNanomsg.nn_connect(@socket, "tcp://*:")
+#          rc.should == -1
+#          LibNanomsg.nn_errno.should == EINVAL
+#        end
+#
+#        it "returns -1 for an invalid TCP address (non-numeric port)" do
+#          rc = LibNanomsg.nn_connect(@socket, "tcp://192.168.0.1:port")
+#          rc.should == -1
+#          LibNanomsg.nn_errno.should == EINVAL
+#        end
+#
+#        it "returns -1 for an invalid TCP address (port number is out of range)" do
+#          rc = LibNanomsg.nn_connect(@socket, "tcp://192.168.0.1:65536")
+#          rc.should == -1
+#          LibNanomsg.nn_errno.should == EINVAL
+#        end
+
+        it "returns -1 for an unsupported transport protocol" do
+          rc = LibNanomsg.nn_connect(@socket, "zmq://192.168.0.1:65536")
+          rc.should == -1
+          LibNanomsg.nn_errno.should == EPROTONOSUPPORT
+        end
+
+        it "returns -1 for specifying a non-existent device using TCP transport" do
+          pending # currently fails
+          rc = LibNanomsg.nn_connect(@socket, "tcp://doesntexist:5555")
+          rc.should == -1
+          LibNanomsg.nn_errno.should == ENODEV
+        end
+
+        it "returns 2 when connecting twice to an existing endpoint" do
+          rc = LibNanomsg.nn_connect(@socket, "inproc://some_endpoint")
+          rc = LibNanomsg.nn_connect(@socket, "inproc://some_endpoint")
+          rc.should == 2
+        end
+        
+      end
+
+      context "given an invalid file descriptor" do
+        
+        it "returns -1 and sets nn_errno to EBADF" do
+          rc = LibNanomsg.nn_connect(0, "inproc://some_endpoint")
+          rc.should == -1
+          LibNanomsg.nn_errno.should == EBADF
+        end
+        
+      end
+
+    end
+  end
+end

data/spec/nn_getsockopt_spec.rb

@@ -0,0 +1,109 @@
+require 'spec_helper'
+
+module NNCore
+  describe "nn_getsockopt" do
+
+    context "given an initialized library and" do
+      before(:each) { LibNanomsg.nn_init }
+      after(:each) { LibNanomsg.nn_term }
+
+
+      context "given a valid socket" do
+        before(:each) do
+          LibNanomsg.nn_init
+          @socket = LibNanomsg.nn_socket(AF_SP, NN_PUB)
+          @option = FFI::MemoryPointer.new(:int32)
+          @size = FFI::MemoryPointer.new :size_t
+          @size.write_int(4)
+        end
+
+        after(:each) do
+          LibNanomsg.nn_close(@socket)
+          LibNanomsg.nn_term
+        end
+
+        it "NN_LINGER returns a default of 1000" do
+          rc = LibNanomsg.nn_getsockopt(@socket, NN_SOL_SOCKET, NN_LINGER, @option, @size)
+          rc.should == 0
+          @option.read_int.should == 1000
+        end
+
+        it "NN_SNDBUF returns a default of 128KB" do
+          rc = LibNanomsg.nn_getsockopt(@socket, NN_SOL_SOCKET, NN_SNDBUF, @option, @size)
+          rc.should == 0
+          @option.read_int.should == 131072
+        end
+
+        it "NN_RCVBUF returns a default of 128KB" do
+          rc = LibNanomsg.nn_getsockopt(@socket, NN_SOL_SOCKET, NN_RCVBUF, @option, @size)
+          rc.should == 0
+          @option.read_int.should == 131072
+        end
+
+        it "NN_SNDTIMEO returns a default of -1" do
+          rc = LibNanomsg.nn_getsockopt(@socket, NN_SOL_SOCKET, NN_SNDTIMEO, @option, @size)
+          rc.should == 0
+          @option.read_int.should == -1
+        end
+
+        it "NN_RCVTIMEO returns a default of -1" do
+          rc = LibNanomsg.nn_getsockopt(@socket, NN_SOL_SOCKET, NN_RCVTIMEO, @option, @size)
+          rc.should == 0
+          @option.read_int.should == -1
+        end
+
+        it "NN_RECONNECT_IVL returns a default of 100 (units are milliseconds)" do
+          rc = LibNanomsg.nn_getsockopt(@socket, NN_SOL_SOCKET, NN_RECONNECT_IVL, @option, @size)
+          rc.should == 0
+          @option.read_int.should == 100
+        end
+
+        it "NN_RECONNECT_IVL_MAX returns a default of 0 (units are milliseconds)" do
+          rc = LibNanomsg.nn_getsockopt(@socket, NN_SOL_SOCKET, NN_RECONNECT_IVL_MAX, @option, @size)
+          rc.should == 0
+          @option.read_int.should == 0
+        end
+
+        it "NN_SNDPRIO returns a default of 8" do
+          rc = LibNanomsg.nn_getsockopt(@socket, NN_SOL_SOCKET, NN_SNDPRIO, @option, @size)
+          rc.should == 0
+          @option.read_int.should == 8
+        end
+
+
+        context "given an unsupported socket level" do
+
+          SOCKET_OPTIONS.keys.each do |socket_option|
+            it "socket option #{socket_option} returns -1 and set nn_errno to EBADF" do
+              option = FFI::MemoryPointer.new(:int32)
+              size = FFI::MemoryPointer.new :size_t
+              size.write_int(4)
+
+              rc = LibNanomsg.nn_getsockopt(@socket, 100, SOCKET_OPTIONS[socket_option], option, size)
+              rc.should == -1
+              LibNanomsg.nn_errno.should == ENOPROTOOPT
+            end
+          end
+
+        end
+
+      end
+
+      context "given a bad socket file descriptor" do
+
+        SOCKET_OPTIONS.keys.each do |socket_option|
+          it "socket option #{socket_option} returns -1 and set nn_errno to EBADF" do
+            option = FFI::MemoryPointer.new(:int32)
+            size = FFI::MemoryPointer.new :size_t
+            size.write_int(4)
+
+            rc = LibNanomsg.nn_getsockopt(0, NN_SOL_SOCKET, SOCKET_OPTIONS[socket_option], option, size)
+            rc.should == -1
+            LibNanomsg.nn_errno.should == EBADF
+          end
+        end
+      end
+
+    end
+  end
+end

data/spec/nn_init_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+module NNCore
+  describe "nn_init" do
+
+    it "returns 0 for successful library initialization" do
+      LibNanomsg.nn_init.should be_zero
+    end
+
+  end
+end

data/spec/nn_recv_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+module NNCore
+  describe "nn_recv" do
+
+    context "given an initialized library and" do
+      before(:each) { LibNanomsg.nn_init }
+      after(:each) { LibNanomsg.nn_term }
+
+
+      context "given a valid connected sender and receiver socket pair" do
+        before(:each) do
+          LibNanomsg.nn_init
+          @socket = LibNanomsg.nn_socket(AF_SP, NN_PAIR)
+          @sender = LibNanomsg.nn_socket(AF_SP, NN_PAIR)
+          @endpoint = LibNanomsg.nn_bind(@socket, "inproc://some_endpoint")
+          LibNanomsg.nn_connect(@sender, "inproc://some_endpoint")
+        end
+
+        after(:each) do
+          LibNanomsg.nn_close(@socket)
+          LibNanomsg.nn_close(@sender)
+          LibNanomsg.nn_term
+        end
+
+        context "given a pre-allocated buffer" do
+
+          it "returns the number of bytes received" do
+            string = "ABC"
+            LibNanomsg.nn_send(@sender, string, string.size, 0)
+            
+            buffer = FFI::MemoryPointer.new(5)
+            nbytes = LibNanomsg.nn_recv(@socket, buffer, 5, 0)
+            nbytes.should == 3
+            buffer.read_string.should == string
+          end
+        end
+        
+        context "given no pre-allocated buffer" do
+          
+
+          it "returns the number of bytes received and returns the buffer" do
+            string = "ABC"
+            LibNanomsg.nn_send(@sender, string, string.size, 0)
+            
+            buffer = FFI::MemoryPointer.new(:pointer)
+            nbytes = LibNanomsg.nn_recv(@socket, buffer, NN_MSG, 0)
+            nbytes.should == 3
+            buffer.get_pointer(0).read_string.should == string
+          end
+        end
+      end
+
+      context "given an invalid socket" do
+
+        it "returns -1 and sets nn_errno to EBADF" do
+          rc = LibNanomsg.nn_send(0, "ABC", 3, 0)
+          rc.should == -1
+          LibNanomsg.nn_errno.should == EBADF
+        end
+
+      end
+
+    end
+  end
+end

data/spec/nn_send_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+module NNCore
+  describe "nn_send" do
+
+    context "given an initialized library and" do
+      before(:each) { LibNanomsg.nn_init }
+      after(:each) { LibNanomsg.nn_term }
+
+
+      context "given a valid socket" do
+        before(:each) do
+          LibNanomsg.nn_init
+          @socket = LibNanomsg.nn_socket(AF_SP, NN_PUB)
+        end
+
+        after(:each) do
+          LibNanomsg.nn_close(@socket)
+          LibNanomsg.nn_term
+        end
+
+        context "given a valid endpoint" do
+          before(:each) do
+            @endpoint = LibNanomsg.nn_bind(@socket, "inproc://some_endpoint")
+          end
+
+          it "returns the number of bytes sent" do
+            nbytes = LibNanomsg.nn_send(@socket, "ABC", 3, 0)
+            nbytes.should == 3
+          end
+        end
+
+        context "disconnected from all endpoints" do
+          it "returns the number of bytes queued" do
+            nbytes = LibNanomsg.nn_send(@socket, "ABC", 3, 0)
+            nbytes.should == 3
+          end
+        end
+      end
+
+      context "given an invalid socket" do
+
+        it "returns -1 and sets nn_errno to EBADF" do
+          rc = LibNanomsg.nn_send(0, "ABC", 3, 0)
+          rc.should == -1
+          LibNanomsg.nn_errno.should == EBADF
+        end
+
+      end
+
+    end
+  end
+end

data/spec/nn_setsockopt_spec.rb

@@ -0,0 +1,72 @@
+require 'spec_helper'
+
+module NNCore
+  describe "nn_setsockopt" do
+
+    context "given an initialized library and" do
+      before(:each) { LibNanomsg.nn_init }
+      after(:each) { LibNanomsg.nn_term }
+
+
+      context "given a valid socket" do
+        before(:each) do
+          LibNanomsg.nn_init
+          @socket = LibNanomsg.nn_socket(AF_SP, NN_PUB)
+          @option = FFI::MemoryPointer.new(:int32)
+          @size = FFI::MemoryPointer.new :size_t
+          @size.write_int(4)
+        end
+
+        after(:each) do
+          LibNanomsg.nn_close(@socket)
+          LibNanomsg.nn_term
+        end
+
+        SOCKET_OPTIONS.keys.each do |socket_option|
+
+          it "#{socket_option} overrides the default" do
+            @option.write_int(10)
+            rc = LibNanomsg.nn_setsockopt(@socket, NN_SOL_SOCKET, SOCKET_OPTIONS[socket_option], @option, 4)
+            rc.should == 0
+            rc = LibNanomsg.nn_getsockopt(@socket, NN_SOL_SOCKET, SOCKET_OPTIONS[socket_option], @option, @size)
+            rc.should == 0
+
+            @option.read_int.should == 10
+          end
+        end
+
+
+        context "given an unsupported socket level" do
+
+          SOCKET_OPTIONS.keys.each do |socket_option|
+            it "socket option #{socket_option} returns -1 and set nn_errno to EBADF" do
+              option = FFI::MemoryPointer.new(:int32)
+
+              rc = LibNanomsg.nn_setsockopt(@socket, 100, SOCKET_OPTIONS[socket_option], option, 4)
+              rc.should == -1
+              LibNanomsg.nn_errno.should == ENOPROTOOPT
+            end
+          end
+
+        end
+
+      end
+
+      context "given a bad socket file descriptor" do
+
+        SOCKET_OPTIONS.keys.each do |socket_option|
+          it "socket option #{socket_option} returns -1 and set nn_errno to EBADF" do
+            option = FFI::MemoryPointer.new(:int32)
+            size = FFI::MemoryPointer.new :size_t
+            size.write_int(4)
+
+            rc = LibNanomsg.nn_getsockopt(0, NN_SOL_SOCKET, SOCKET_OPTIONS[socket_option], option, size)
+            rc.should == -1
+            LibNanomsg.nn_errno.should == EBADF
+          end
+        end
+      end
+
+    end
+  end
+end

data/spec/nn_shutdown_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+module NNCore
+  describe "nn_shutdown" do
+
+    context "given an initialized library and" do
+      before(:each) { LibNanomsg.nn_init }
+      after(:each) { LibNanomsg.nn_term }
+
+
+      context "given a valid socket and" do
+        before(:each) do
+          LibNanomsg.nn_init
+          @socket = LibNanomsg.nn_socket(AF_SP, NN_PUB)
+        end
+
+        after(:each) do
+          LibNanomsg.nn_close(@socket)
+          LibNanomsg.nn_term
+        end
+
+        context "given a valid endpoint" do
+          before(:each) do
+            @endpoint = LibNanomsg.nn_bind(@socket, "inproc://some_endpoint")
+          end
+
+          it "returns 0" do
+            rc = LibNanomsg.nn_shutdown(@socket, @endpoint)
+            rc.should == 0
+          end
+        end
+
+        context "given an invalid endpoint" do
+          it "returns -1 and set nn_errno to EINVAL" do
+            rc = LibNanomsg.nn_shutdown(@socket, 0)
+            rc.should == -1
+            LibNanomsg.nn_errno.should == EINVAL
+          end
+        end
+      end
+
+      context "given an invalid socket" do
+
+        it "returns -1 and sets nn_errno to EBADF" do
+          rc = LibNanomsg.nn_shutdown(0, 0)
+          rc.should == -1
+          LibNanomsg.nn_errno.should == EBADF
+        end
+
+      end
+
+    end
+  end
+end

data/spec/nn_socket_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+module NNCore
+  describe "nn_socket" do
+
+    context "given an initialized library and" do
+      before(:each) { LibNanomsg.nn_init }
+      after(:each) { LibNanomsg.nn_term }
+
+      PROTOCOLS.keys.each do |protocol|
+
+        context "given a supported protocol #{protocol} and address family AF_SP" do
+
+          it "returns a non-zero file descriptor for the socket" do
+            @socket = LibNanomsg.nn_socket(AF_SP, PROTOCOLS[protocol])
+            
+            @socket.should == 0
+            
+            LibNanomsg.nn_close(@socket)
+          end
+        end
+
+        context "given a supported protocol #{protocol} and address family AF_SP_RAW" do
+
+          it "returns -1 and sets nn_errno to EINVAL" do
+            @socket = LibNanomsg.nn_socket(AF_SP_RAW, PROTOCOLS[protocol])
+            
+            @socket.should == -1
+            LibNanomsg.nn_errno.should == EINVAL
+          end
+        end
+
+      end
+
+      context "given an unsupported address family" do
+
+        #        it "nn_socket returns -1 and sets nn_errno to EAFNOSUPPORT" do
+        #          LibNanomsg.nn_socket(0, NN_PUB).should == -1
+        #          LibNanomsg.nn_errno.should == EAFNOSUPPORT
+        #        end
+      end
+
+      context "given an unsupported protocol and a supported address family" do
+
+        it "AF_SP returns -1 and sets nn_errno to EINVAL" do
+          LibNanomsg.nn_socket(AF_SP, 0).should == -1
+          LibNanomsg.nn_errno.should == EINVAL
+        end
+
+        it "AF_SP_RAW returns -1 and sets nn_errno to EINVAL" do
+          LibNanomsg.nn_socket(AF_SP_RAW, 0).should == -1
+          LibNanomsg.nn_errno.should == EINVAL
+        end
+      end
+
+    end
+
+  end
+end

data/spec/nn_term_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+module NNCore
+  describe "nn_term" do
+
+    context "given an initialized library and" do
+      before(:each) { LibNanomsg.nn_init }
+      after(:each) { LibNanomsg.nn_term }
+
+      it "returns 0 for successful library termination" do
+        LibNanomsg.nn_term.should be_zero
+      end
+
+    end
+
+  end
+end

data/spec/nn_version_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+module NNCore
+  describe "nn_bind" do
+
+    context "given an initialized library" do
+      before(:each) { LibNanomsg.nn_init }
+      after(:each) { LibNanomsg.nn_term }
+
+      it "returns 0 and populates the pointers with the major, minor and patch version numbers" do
+        major = FFI::MemoryPointer.new(:int)
+        minor = FFI::MemoryPointer.new(:int)
+        patch = FFI::MemoryPointer.new(:int)
+
+        # there is no return value for this function
+        LibNanomsg.nn_version(major, minor, patch)
+        
+        major.read_int.should >= 0
+        minor.read_int.should >= 0
+        patch.read_int.should >= 0
+      end
+
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+require 'bundler/setup'
+require 'nn-core'
+
+module NNCore
+  SOCKET_OPTIONS = {
+    :NN_LINGER => NN_LINGER,
+    :NN_SNDBUF => NN_SNDBUF,
+    :NN_RCVBUF => NN_RCVBUF,
+    :NN_SENDTIMEO => NN_SNDTIMEO,
+    :NN_RCVTIMEO => NN_RCVTIMEO,
+    :NN_RECONNECT_IVL => NN_RECONNECT_IVL,
+    :NN_RECONNECT_IVL_MAX => NN_RECONNECT_IVL_MAX,
+    :NN_SNDPRIO => NN_SNDPRIO
+  }
+  
+  PROTOCOLS = {
+    :NN_PUB => NN_PUB,
+    :NN_SUB => NN_SUB
+  }
+  
+  ADDRESS_FAMILIES = {
+    :AF_SP => AF_SP,
+    :AF_SP_RAW => AF_SP_RAW
+  }
+end

metadata

@@ -0,0 +1,176 @@
+--- !ruby/object:Gem::Specification
+name: nn-core
+version: !ruby/object:Gem::Version
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors:
+- Chuck Remes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  name: ffi
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+    none: false
+  name: rspec
+  type: :development
+- !ruby/object:Gem::Dependency
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  name: rake
+  type: :development
+description: ! 'Wraps the nanomsg networking library using the ruby FFI (foreign
+
+  function interface). It only exposes the native C API to Ruby. Other gems should
+  use this gem
+
+  to build an API using Ruby idioms.'
+email:
+- git@chuckremes.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- !binary |-
+  LmdpdGlnbm9yZQ==
+- !binary |-
+  LnJzcGVj
+- !binary |-
+  QXV0aG9ycy50eHQ=
+- !binary |-
+  R2VtZmlsZQ==
+- !binary |-
+  SGlzdG9yeS50eHQ=
+- !binary |-
+  UkVBRE1FLm1k
+- !binary |-
+  UmFrZWZpbGU=
+- !binary |-
+  bGliL25uLWNvcmUucmI=
+- !binary |-
+  bGliL25uLWNvcmUvY29uc3RhbnRzLnJi
+- !binary |-
+  bGliL25uLWNvcmUvbGlibmFub21zZy5yYg==
+- !binary |-
+  bGliL25uLWNvcmUvc3RydWN0cy5yYg==
+- !binary |-
+  bGliL25uLWNvcmUvdmVyc2lvbi5yYg==
+- !binary |-
+  bm4tY29yZS5nZW1zcGVj
+- !binary |-
+  c3BlYy9ubl9iaW5kX3NwZWMucmI=
+- !binary |-
+  c3BlYy9ubl9jbG9zZV9zcGVjLnJi
+- !binary |-
+  c3BlYy9ubl9jb25uZWN0X3NwZWMucmI=
+- !binary |-
+  c3BlYy9ubl9nZXRzb2Nrb3B0X3NwZWMucmI=
+- !binary |-
+  c3BlYy9ubl9pbml0X3NwZWMucmI=
+- !binary |-
+  c3BlYy9ubl9yZWN2X3NwZWMucmI=
+- !binary |-
+  c3BlYy9ubl9zZW5kX3NwZWMucmI=
+- !binary |-
+  c3BlYy9ubl9zZXRzb2Nrb3B0X3NwZWMucmI=
+- !binary |-
+  c3BlYy9ubl9zaHV0ZG93bl9zcGVjLnJi
+- !binary |-
+  c3BlYy9ubl9zb2NrZXRfc3BlYy5yYg==
+- !binary |-
+  c3BlYy9ubl90ZXJtX3NwZWMucmI=
+- !binary |-
+  c3BlYy9ubl92ZXJzaW9uX3NwZWMucmI=
+- !binary |-
+  c3BlYy9zcGVjX2hlbHBlci5yYg==
+homepage: http://github.com/chuckremes/nn-core
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+requirements: []
+rubyforge_project: nn-core
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Wraps the nanomsg networking library using Ruby FFI (foreign function interface).
+test_files:
+- !binary |-
+  c3BlYy9ubl9iaW5kX3NwZWMucmI=
+- !binary |-
+  c3BlYy9ubl9jbG9zZV9zcGVjLnJi
+- !binary |-
+  c3BlYy9ubl9jb25uZWN0X3NwZWMucmI=
+- !binary |-
+  c3BlYy9ubl9nZXRzb2Nrb3B0X3NwZWMucmI=
+- !binary |-
+  c3BlYy9ubl9pbml0X3NwZWMucmI=
+- !binary |-
+  c3BlYy9ubl9yZWN2X3NwZWMucmI=
+- !binary |-
+  c3BlYy9ubl9zZW5kX3NwZWMucmI=
+- !binary |-
+  c3BlYy9ubl9zZXRzb2Nrb3B0X3NwZWMucmI=
+- !binary |-
+  c3BlYy9ubl9zaHV0ZG93bl9zcGVjLnJi
+- !binary |-
+  c3BlYy9ubl9zb2NrZXRfc3BlYy5yYg==
+- !binary |-
+  c3BlYy9ubl90ZXJtX3NwZWMucmI=
+- !binary |-
+  c3BlYy9ubl92ZXJzaW9uX3NwZWMucmI=
+- !binary |-
+  c3BlYy9zcGVjX2hlbHBlci5yYg==