ezmq 0.3.7 → 0.4.0

data/doc/_index.html

@@ -188,7 +188,7 @@
 </div>
 
     <div id="footer">
-  Generated on Mon Feb  2 15:37:50 2015 by
+  Generated on Tue Feb  3 09:55:04 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.0.0).
 </div>

data/doc/file.README.html

@@ -84,7 +84,9 @@
 <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>ezmq</span><span class='tstring_end'>&#39;</span></span>
 
 <span class='id identifier rubyid_server'>server</span> <span class='op'>=</span> <span class='const'>EZMQ</span><span class='op'>::</span><span class='const'>Server</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
-<span class='id identifier rubyid_server'>server</span><span class='period'>.</span><span class='id identifier rubyid_listen'>listen</span>
+<span class='id identifier rubyid_server'>server</span><span class='period'>.</span><span class='id identifier rubyid_listen'>listen</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_message'>message</span><span class='op'>|</span>
+  <span class='id identifier rubyid_message'>message</span>
+<span class='kw'>end</span>
 </code></pre>
 
 <h2>Synchronous Client Request</h2>
@@ -118,7 +120,9 @@
 <span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>json</span><span class='tstring_end'>&#39;</span></span>
 
 <span class='id identifier rubyid_server'>server</span> <span class='op'>=</span> <span class='const'>EZMQ</span><span class='op'>::</span><span class='const'>Server</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='label'>encode:</span> <span class='tlambda'>-&gt;</span> <span class='id identifier rubyid_m'>m</span> <span class='tlambeg'>{</span> <span class='const'>JSON</span><span class='period'>.</span><span class='id identifier rubyid_dump'>dump</span> <span class='id identifier rubyid_m'>m</span> <span class='rbrace'>}</span><span class='comma'>,</span> <span class='label'>decode:</span> <span class='tlambda'>-&gt;</span> <span class='id identifier rubyid_m'>m</span> <span class='tlambeg'>{</span> <span class='const'>JSON</span><span class='period'>.</span><span class='id identifier rubyid_load'>load</span> <span class='id identifier rubyid_m'>m</span> <span class='rbrace'>}</span>
-<span class='id identifier rubyid_server'>server</span><span class='period'>.</span><span class='id identifier rubyid_listen'>listen</span>
+<span class='id identifier rubyid_server'>server</span><span class='period'>.</span><span class='id identifier rubyid_listen'>listen</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_message'>message</span><span class='op'>|</span>
+  <span class='id identifier rubyid_message'>message</span>
+<span class='kw'>end</span>
 </code></pre>
 
 <h2>JSON Synchronous Client Request</h2>
@@ -154,7 +158,9 @@
 <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>ezmq</span><span class='tstring_end'>&#39;</span></span>
 
 <span class='id identifier rubyid_subscriber'>subscriber</span> <span class='op'>=</span> <span class='const'>EZMQ</span><span class='period'>.</span><span class='const'>Subscriber</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='label'>topic:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>foorever</span><span class='tstring_end'>&#39;</span></span>
-<span class='id identifier rubyid_subscriber'>subscriber</span><span class='period'>.</span><span class='id identifier rubyid_listen'>listen</span>
+<span class='id identifier rubyid_subscriber'>subscriber</span><span class='period'>.</span><span class='id identifier rubyid_listen'>listen</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_message'>message</span><span class='comma'>,</span> <span class='id identifier rubyid_topic'>topic</span><span class='op'>|</span>
+  <span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>[</span><span class='embexpr_beg'>#{</span> <span class='id identifier rubyid_topic'>topic</span> <span class='embexpr_end'>}</span><span class='tstring_content'>] </span><span class='embexpr_beg'>#{</span> <span class='id identifier rubyid_message'>message</span> <span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
+<span class='kw'>end</span>
 </code></pre>
 
 <h2>Pipeline Work Generator</h2>
@@ -208,7 +214,9 @@
 <span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>json</span><span class='tstring_end'>&#39;</span></span>
 
 <span class='id identifier rubyid_collector'>collector</span> <span class='op'>=</span> <span class='const'>EZMQ</span><span class='op'>::</span><span class='const'>Puller</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='label'>port:</span> <span class='int'>5556</span>
-<span class='id identifier rubyid_collector'>collector</span><span class='period'>.</span><span class='id identifier rubyid_listen'>listen</span>
+<span class='id identifier rubyid_collector'>collector</span><span class='period'>.</span><span class='id identifier rubyid_listen'>listen</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_message'>message</span><span class='op'>|</span>
+  <span class='id identifier rubyid_puts'>puts</span> <span class='id identifier rubyid_message'>message</span>
+<span class='kw'>end</span>
 </code></pre>
 
 <h1>Operating System Notes</h1>
@@ -230,7 +238,7 @@ sudo aptitude install libzmq3-dev
 </div></div>
 
     <div id="footer">
-  Generated on Mon Feb  2 15:37:50 2015 by
+  Generated on Tue Feb  3 09:55:04 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.0.0).
 </div>

data/doc/index.html

@@ -84,7 +84,9 @@
 <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>ezmq</span><span class='tstring_end'>&#39;</span></span>
 
 <span class='id identifier rubyid_server'>server</span> <span class='op'>=</span> <span class='const'>EZMQ</span><span class='op'>::</span><span class='const'>Server</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
-<span class='id identifier rubyid_server'>server</span><span class='period'>.</span><span class='id identifier rubyid_listen'>listen</span>
+<span class='id identifier rubyid_server'>server</span><span class='period'>.</span><span class='id identifier rubyid_listen'>listen</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_message'>message</span><span class='op'>|</span>
+  <span class='id identifier rubyid_message'>message</span>
+<span class='kw'>end</span>
 </code></pre>
 
 <h2>Synchronous Client Request</h2>
@@ -118,7 +120,9 @@
 <span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>json</span><span class='tstring_end'>&#39;</span></span>
 
 <span class='id identifier rubyid_server'>server</span> <span class='op'>=</span> <span class='const'>EZMQ</span><span class='op'>::</span><span class='const'>Server</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='label'>encode:</span> <span class='tlambda'>-&gt;</span> <span class='id identifier rubyid_m'>m</span> <span class='tlambeg'>{</span> <span class='const'>JSON</span><span class='period'>.</span><span class='id identifier rubyid_dump'>dump</span> <span class='id identifier rubyid_m'>m</span> <span class='rbrace'>}</span><span class='comma'>,</span> <span class='label'>decode:</span> <span class='tlambda'>-&gt;</span> <span class='id identifier rubyid_m'>m</span> <span class='tlambeg'>{</span> <span class='const'>JSON</span><span class='period'>.</span><span class='id identifier rubyid_load'>load</span> <span class='id identifier rubyid_m'>m</span> <span class='rbrace'>}</span>
-<span class='id identifier rubyid_server'>server</span><span class='period'>.</span><span class='id identifier rubyid_listen'>listen</span>
+<span class='id identifier rubyid_server'>server</span><span class='period'>.</span><span class='id identifier rubyid_listen'>listen</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_message'>message</span><span class='op'>|</span>
+  <span class='id identifier rubyid_message'>message</span>
+<span class='kw'>end</span>
 </code></pre>
 
 <h2>JSON Synchronous Client Request</h2>
@@ -154,7 +158,9 @@
 <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>ezmq</span><span class='tstring_end'>&#39;</span></span>
 
 <span class='id identifier rubyid_subscriber'>subscriber</span> <span class='op'>=</span> <span class='const'>EZMQ</span><span class='period'>.</span><span class='const'>Subscriber</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='label'>topic:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>foorever</span><span class='tstring_end'>&#39;</span></span>
-<span class='id identifier rubyid_subscriber'>subscriber</span><span class='period'>.</span><span class='id identifier rubyid_listen'>listen</span>
+<span class='id identifier rubyid_subscriber'>subscriber</span><span class='period'>.</span><span class='id identifier rubyid_listen'>listen</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_message'>message</span><span class='comma'>,</span> <span class='id identifier rubyid_topic'>topic</span><span class='op'>|</span>
+  <span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>[</span><span class='embexpr_beg'>#{</span> <span class='id identifier rubyid_topic'>topic</span> <span class='embexpr_end'>}</span><span class='tstring_content'>] </span><span class='embexpr_beg'>#{</span> <span class='id identifier rubyid_message'>message</span> <span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
+<span class='kw'>end</span>
 </code></pre>
 
 <h2>Pipeline Work Generator</h2>
@@ -208,7 +214,9 @@
 <span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>json</span><span class='tstring_end'>&#39;</span></span>
 
 <span class='id identifier rubyid_collector'>collector</span> <span class='op'>=</span> <span class='const'>EZMQ</span><span class='op'>::</span><span class='const'>Puller</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='label'>port:</span> <span class='int'>5556</span>
-<span class='id identifier rubyid_collector'>collector</span><span class='period'>.</span><span class='id identifier rubyid_listen'>listen</span>
+<span class='id identifier rubyid_collector'>collector</span><span class='period'>.</span><span class='id identifier rubyid_listen'>listen</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_message'>message</span><span class='op'>|</span>
+  <span class='id identifier rubyid_puts'>puts</span> <span class='id identifier rubyid_message'>message</span>
+<span class='kw'>end</span>
 </code></pre>
 
 <h1>Operating System Notes</h1>
@@ -230,7 +238,7 @@ sudo aptitude install libzmq3-dev
 </div></div>
 
     <div id="footer">
-  Generated on Mon Feb  2 15:37:50 2015 by
+  Generated on Tue Feb  3 09:55:04 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.0.0).
 </div>

data/doc/top-level-namespace.html

@@ -103,7 +103,7 @@
 </div>
 
     <div id="footer">
-  Generated on Mon Feb  2 15:37:50 2015 by
+  Generated on Tue Feb  3 09:55:04 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.0.0).
 </div>

data/ezmq.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |gem|
   gem.name        = 'ezmq'
-  gem.version     = '0.3.7'
+  gem.version     = '0.4.0'
   gem.licenses    = 'MIT'
   gem.authors     = ['Chris Olstrom']
   gem.email       = 'chris@olstrom.com'
@@ -24,4 +24,8 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'churn'
   gem.add_development_dependency 'yard'
   gem.add_development_dependency 'inch'
+  gem.add_development_dependency 'kintama'
+  gem.add_development_dependency 'simplecov'
+  gem.add_development_dependency 'coveralls'
+  gem.add_development_dependency 'codeclimate-test-reporter'
 end

data/lib/ezmq/context.rb

@@ -10,7 +10,7 @@ module EZMQ
     #   allow multiple sockets to share access to system resources, and an
     #   entire context can be terminated, closing all sockets within it.
     #
-    # Contexts are useful when dealing with the 'inproc' transport / protocol.
+    # Contexts are useful when dealing with the :inproc transport.
     #   Any sockets that need to communicate in-process must share a context.
     #
     # @return [Context] a new instance of Context.

data/lib/ezmq/pair.rb

@@ -22,15 +22,15 @@ module EZMQ
   end
 
   # Returns a pair of EZMQ::Pair sockets connected to each other.
-  # 
+  #
   # @param [Hash] options optional parameters.
   # @see EZMQ::Socket EZMQ::Socket for optional parameters.
-  # 
+  #
   # @return [Array<EZMQ::Pair>]
   #
   def self.create_linked_pair(**options)
     options[:context] ||= EZMQ::Context.new
-    options[:protocol] ||= 'inproc'
+    options[:transport] ||= :inproc
     options[:address] ||= options[:context].context.address
     %i(bind connect).map do |mode|
       EZMQ::Pair.new mode, options

data/lib/ezmq/socket.rb

@@ -16,10 +16,10 @@ module EZMQ
     #   (one will be created if not provided).
     # @option options [lambda] encode how to encode messages.
     # @option options [lambda] decode how to decode messages.
-    # @option options [String] protocol ('tcp') protocol for transport.
+    # @option options [Symbol] transport (:tcp) transport for transport.
     # @option options [String] address ('127.0.0.1') address for endpoint.
     # @option options [Fixnum] port (5555) port for endpoint.
-    # @note port is ignored unless protocol is one of 'tcp', 'pgm' or 'epgm'.
+    # @note port is ignored unless transport is one of :tcp, :pgm or :epgm
     #
     # @return [Socket] a new instance of Socket.
     #
@@ -29,7 +29,7 @@ module EZMQ
       @socket = @context.socket type
       @encode = options[:encode] || -> m { m }
       @decode = options[:decode] || -> m { m }
-      endpoint = options.select { |k, _| %i(protocol address port).include? k }
+      endpoint = options.select { |k, _| %i(transport address port).include? k }
       method(mode).call endpoint
     end
 
@@ -76,37 +76,33 @@ module EZMQ
     # @note This method can be called as #bind, in which case it binds to the
     #   specified address instead.
     #
-    # @param [String] protocol ('tcp') protocol for transport.
+    # @param [Symbol] transport (:tcp) transport for transport.
     # @param [String] address ('127.0.0.1') address for endpoint.
     # @note Binding to 'localhost' is not consistent on all platforms.
     #   Prefer '127.0.0.1' instead.
     # @param [Fixnum] port (5555) port for endpoint.
-    # @note port is ignored unless protocol is one of 'tcp', 'pgm' or 'epgm'.
+    # @note port is ignored unless transport is one of :tcp, :pgm or :epgm
     #
     # @return [Boolean] was connection successful?
     #
-    def connect(protocol: 'tcp', address: '127.0.0.1', port: 5555)
-      endpoint = "#{ protocol }://#{ address }"
-      endpoint = "#{ endpoint }:#{ port }" if %w(tcp pgm epgm).include? protocol
+    def connect(transport: :tcp, address: '127.0.0.1', port: 5555)
+      endpoint = "#{ transport }://#{ address }"
+      endpoint << ":#{ port }" if %i(tcp pgm epgm).include? transport
       @socket.method(__callee__).call(endpoint) == 0
     end
 
     alias_method :bind, :connect
 
-    # By default, waits for a message and prints it to STDOUT.
+    # Like receive, but doesn't stop at one message.
     #
     # @yield message passes the message received to the block.
     # @yieldparam [String] message the message received.
     #
     # @return [void]
     #
-    def listen
+    def listen(&block)
       loop do
-        if block_given?
-          yield receive
-        else
-          puts receive
-        end
+        block.call receive
       end
     end
   end

data/lib/ezmq/subscribe.rb

@@ -46,7 +46,7 @@ module EZMQ
       end
     end
 
-    # By default, waits for a message and prints it to STDOUT.
+    # Like receive, but doesn't stop at one message.
     #
     # @yield [message, topic] passes the message body and topic to the block.
     # @yieldparam [String] message the message received.
@@ -54,14 +54,9 @@ module EZMQ
     #
     # @return [void]
     #
-    def listen
+    def listen(&block)
       loop do
-        if block_given?
-          yield(*receive)
-        else
-          message, topic = receive
-          puts "#{ topic } #{ message }"
-        end
+        block.call(*receive)
       end
     end
 

data/tests/ezmq.rb

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
+
+require 'simplecov'
+require 'coveralls'
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+SimpleCov.command_name 'Kintama'
+SimpleCov.start { add_filter '/tests/' }
+
+require 'kintama'
+require 'timeout'
+require 'json'
+
+require_relative '../lib/ezmq'
+require_relative 'ezmq/context'
+require_relative 'ezmq/socket'
+require_relative 'ezmq/request'
+require_relative 'ezmq/reply'
+require_relative 'ezmq/publish'
+require_relative 'ezmq/subscribe'
+require_relative 'ezmq/push'
+require_relative 'ezmq/pull'
+require_relative 'ezmq/pair'

data/tests/ezmq/context.rb

@@ -0,0 +1,9 @@
+context 'Contexts' do
+  setup do
+    @context = EZMQ::Context.new
+  end
+
+  should 'instantiate properly' do
+    assert_kind_of EZMQ::Context, @context
+  end
+end

data/tests/ezmq/pair.rb

@@ -0,0 +1,63 @@
+context 'Paired sockets' do
+  setup do
+    @bound, @connected = EZMQ.create_linked_pair
+  end
+
+  should 'initialize properly' do
+    assert_kind_of EZMQ::Socket, @bound
+    assert_kind_of EZMQ::Socket, @connected
+  end
+
+  should 'return the length of messages they send' do
+    assert_equal 7, @connected.send('message')
+  end
+
+  should 'return the contents of messages they receive' do
+    @connected.send 'message'
+    assert_equal 'message', @bound.receive
+  end
+
+  should 'yield the contents of messages they receive, if given a block' do
+    @bound.send 'message'
+    assert_equal 'message', @connected.receive { |m| m }
+  end
+
+  should 'block if no message is present' do
+    assert_raises Timeout::Error do
+      Timeout.timeout(0.1) do
+        @connected.receive
+      end
+    end
+  end
+
+  should 'receive multiple messages if listening' do
+    3.times { @bound.send 'message' }
+    messages = []
+    begin
+      Timeout.timeout(0.1) do
+        @connected.listen do |message|
+          messages << message
+        end
+      end
+    rescue Timeout::Error
+      assert_equal 3, messages.size
+    end
+  end
+end
+
+context 'Paired sockets with encoding/decoding' do
+  setup do
+    e = -> message { JSON.dump message }
+    d = -> message { JSON.load message }
+    @bound, @connected = EZMQ.create_linked_pair encoding: e, decoding: d
+  end
+
+  should 'return the length of messages they send' do
+    assert_equal 7, @connected.send('message')
+  end
+
+  should 'return the contents of messages they receive' do
+    @connected.send 'message'
+    assert_equal 'message', @bound.receive
+  end
+end

data/tests/ezmq/publish.rb

@@ -0,0 +1,19 @@
+context 'Publishers' do
+  setup do
+    @context = EZMQ::Context.new
+    options = { transport: :inproc, address: 'test', context: @context }
+    @publisher = EZMQ::Publisher.new options
+    @subscriber = EZMQ::Subscriber.new options
+    Thread.new do
+      socket.receive
+    end
+  end
+
+  should 'return the length of messages they send (without a topic)' do
+    assert_equal 8, @publisher.send('message')
+  end
+
+  should 'return the length of messages they send (with a topic)' do
+    assert_equal 8, @publisher.send('message')
+  end
+end

data/tests/ezmq/pull.rb

@@ -0,0 +1,15 @@
+context 'Pullers' do
+  setup do
+    @context = EZMQ::Context.new
+    options = { transport: :inproc, address: 'test', context: @context }
+    @pusher = EZMQ::Pusher.new options
+    @puller = EZMQ::Puller.new options
+    Thread.new do
+      @pusher.send 'message'
+    end
+  end
+
+  should 'return the contents of messages they receive' do
+    assert_equal 'message', @puller.receive
+  end
+end

data/tests/ezmq/push.rb

@@ -0,0 +1,12 @@
+context 'Pushers' do
+  setup do
+    @context = EZMQ::Context.new
+    options = { transport: :inproc, address: 'test', context: @context }
+    @pusher = EZMQ::Pusher.new options
+    @puller = EZMQ::Puller.new options
+  end
+
+  should 'return the length of messages they send' do
+    assert_equal 7, @pusher.send('message')
+  end
+end

data/tests/ezmq/reply.rb

@@ -0,0 +1,35 @@
+context 'Servers' do
+  setup do
+    @context = EZMQ::Context.new
+    options = { transport: :inproc, address: 'test', context: @context }
+    @server = EZMQ::Server.new options
+    @client = EZMQ::Client.new options
+    Thread.new do
+      @client.request 'message'
+    end
+  end
+
+  should 'yield the contents of a request, if given a block' do
+    assert_nothing_raised do
+      Timeout.timeout(0.1) do
+        @server.listen do |request|
+          assert_equal request, 'message'
+          break
+        end
+      end
+    end
+  end
+
+  should 'return the length of messages they send' do
+    @server.receive
+    assert_equal 7, @server.send('message')
+  end
+
+  should 'return the contents of a request they receive' do
+    assert_equal 'message', @server.receive
+  end
+
+  should 'yield the contents of reply, if given a block' do
+    assert_equal 'message', @server.receive { |m| m }
+  end
+end