cztop 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a2f6944c31fc9ad2963801d45a819492a0c4a82c
-  data.tar.gz: cf4cacb4b356309058278b871143fb22c1ba53fa
+  metadata.gz: 96f2495047d3a6101b3dd40b8b840609e524d110
+  data.tar.gz: 4784cc4fc2f0334d2eb8dc59db6a703ad6807478
 SHA512:
-  metadata.gz: 49e3cfd581c7424139a818450aa46b063a244610e96ef488371e2e70583a595b57e5c373799b58ac42c291f92e9c5bacb83f8f26fadf7363a2c6dd05e24ef775
-  data.tar.gz: a3cf1ea8a5b50b522eb0c7a7505c11fd068100fead2cd141410f9ae5dfb64f69f8a79f5ba3008dcd62b46ae95f258a5b1db30901188916ee863bd0e99198e717
+  metadata.gz: 7cad245ae10e5925122107b97d304df4b1ff0ab7835aeb3d64ac4a558c37b0ad4db323d4ab7ce38b9241f920f5e793cd2497decee16318c3855d00865d43d4d9
+  data.tar.gz: b61227b5ffc632697054b96d65480cc16bc9a05a42d275b6890d0248811d73aff84c10c3ab75bb55239f4b4aa08edfb157f86f789e4edcf3f7ab44308c9573ce

data/.travis.yml

@@ -5,15 +5,16 @@ cache:
     - $HOME/.ccache
     - $HOME/.bundle
 rvm:
-  - 2.3.0
-  - 2.2.4
-  - 2.1.8
-  - 2.0.0-p648
+  - 2.3.1
+  - 2.2.5
   - jruby-head
   - rbx
 env:
   # recognized by czmq-ffi-gen's ci-scripts
   - CZMQ_VERSION=HEAD ZMQ_VERSION=HEAD
+matrix:
+  allow_failures:
+    - rvm: rbx
 before_install:
   - PATH="/usr/lib/ccache:$PATH" # enable ccache
   - export LD_LIBRARY_PATH=$HOME/lib # custom libs (for execution)

data/CHANGES.md

@@ -1,3 +1,12 @@
+0.5.0 (28/06/2016)
+-----
+* new example (weather PUB/SUB)
+* add option to enable IPv6 on sockets
+* avoid $DEBUG warnings
+* fix specs on Rubinius
+* better documentation
+* minor CI improvements
+
 0.4.0 (13/04/2016)
 -----
 * CZTop::Poller learns the following methods for convenience and compatibility:

data/Gemfile

@@ -8,4 +8,7 @@ gemspec
 group :development do
   gem 'rubocop', require: false
   gem 'coveralls', require: false, platform: :mri
+
+  # >= 3.1 doesn't work on Rubinius, see guard/listen#391
+  gem 'listen', '~> 3.0.x', require: false
 end

data/README.md

@@ -57,7 +57,7 @@ Here are some some of the goals I have/had in mind for this library:
 - [x] 100% test coverage
 - [x] provide a portable Z85 implementation
   * unlike [fpesce/z85](https://github.com/fpesce/z85), which is a C extension
-- [ ] use it to replace the [Celluloid::ZMQ](https://github.com/celluloid/celluloid-zmq) part of [Celluloid](https://github.com/celluloid/celluloid)
+- [x] use it to replace the [Celluloid::ZMQ](https://github.com/celluloid/celluloid-zmq) part of [Celluloid](https://github.com/celluloid/celluloid)
   * [celluloid/celluloid-zmq#56](https://github.com/celluloid/celluloid-zmq/issues/56)
 - [ ] implement some of the missing (CZMQ based) Ruby examples in the [ZMQ Guide](http://zguide.zeromq.org/page:all)
 
@@ -124,11 +124,9 @@ More information in the [API documentation](http://www.rubydoc.info/github/paddo
   * there are `#routing_id` and `#routing_id=` on the following classes:
     * CZTop::Message
     * CZTop::Frame
-  * requires ZMQ >= 4.2
 * ZMTP 3.1 heartbeat ready
   * `socket.options.heartbeat_ivl = 2000`
   * `socket.options.heartbeat_timeout = 8000`
-  * requires ZMQ >= 4.2
 
 ## Requirements
 
@@ -150,6 +148,11 @@ To install on OSX using homebrew, run:
 If you're running Linux, go check [this page](http://zeromq.org/distro:_start)
 to get more help. Make sure to install CZMQ, not only ZMQ.
 
+**Note:** Currently (as of May 2016), when compiling ZMQ from master, it may
+be required to pass `--enable-drafts` to `./configure` to make sure all the
+`zmq_poller_*()` functions are available. However, this doesn't seem to be the
+case on all systems.
+
 ### Supported Ruby versions
 
 See [.travis.yml](https://github.com/paddor/cztop/blob/master/.travis.yml) for a list of Ruby versions against which CZTop
@@ -157,7 +160,7 @@ is tested.
 
 At the time of writing, these include:
 
-* MRI (2.3, 2.2.4, 2.1.8, 2.0.0)
+* MRI (2.3, 2.2)
 * Rubinius (HEAD)
 * JRuby 9000 (HEAD)
 

data/ci-scripts/install-deps

@@ -2,7 +2,7 @@
 set -e
 mkdir -p vendor
 cd vendor
-git clone https://github.com/paddor/czmq-ffi-gen
+git clone --depth 1 https://github.com/paddor/czmq-ffi-gen
 cd czmq-ffi-gen
 ci-scripts/install-libsodium
 ci-scripts/install-libzmq

data/examples/weather_pub_sub/pub.rb

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+#
+# Weather update server, based on ZMQ's zguide.
+# Binds PUB socket to ipc:///tmp/weather_pubsub_example
+# Publishes random weather updates
+#
+
+require 'cztop'
+
+# create and bind socket
+socket = CZTop::Socket::PUB.new("ipc:///tmp/weather_pubsub_example")
+puts "<<< Socket bound to #{socket.last_endpoint.inspect}"
+
+while true
+	# Generate values for zipcodes
+	zipcode = rand(100000)
+	temperature = rand(215) - 80
+	relhumidity = rand(50) + 10
+	
+	update = "%05d %d %d" % [zipcode, temperature, relhumidity]
+	puts update
+	
+	socket << update
+end

data/examples/weather_pub_sub/sub.rb

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+#
+# Weather update client, based on that from ZMQ's zguide.
+# Connects SUB socket to ipc:///tmp/weather_pubsub_example
+# Collects weather updates and finds avg temp in zipcode
+#
+
+require 'cztop'
+
+COUNT = 100
+
+# Create socket, connect to publisher.
+socket = CZTop::Socket::SUB.new("ipc:///tmp/weather_pubsub_example")
+puts ">>> Socket Connected"
+
+# Subscribe to zipcode.  Default: Chicago - 60606
+filter = ARGV.size > 0 ? ARGV[0] : "60606"
+socket.subscribe(filter)
+
+# gather & process COUNT updates.
+print "Gathering #{COUNT} samples."
+total_temp = 0
+1.upto(COUNT) do |update_nbr|
+	msg = socket.receive
+	
+	zipcode, temperature, relhumidity = msg[0].split.map(&:to_i)
+	total_temp += temperature
+	# just to show that we're doing something...
+	print "." if update_nbr % 5 == 0
+end
+print "\n"
+
+puts "Average temperatuer for zipcode #{filter} was #{total_temp / COUNT}F."

data/lib/cztop/version.rb

@@ -1,3 +1,3 @@
 module CZTop
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/lib/cztop/z85/pipe.rb

@@ -22,7 +22,6 @@ class CZTop::Z85::Pipe
   #
   # @return [Integer] number of bytes read (binary data)
   def encode
-    padded = false
     @strategy.new(@source, @sink, ENCODE_READ_SZ) do |chunk, prev_chunk|
       @bin_bytes += chunk.bytesize if chunk
       if prev_chunk && chunk

data/lib/cztop/zsock_options.rb

@@ -32,10 +32,10 @@ module CZTop
       # @raise [NoMethodError] if option name can't be recognized
       def [](option_name)
         # NOTE: beware of predicates, especially #CURVE_server? & friends
-        m = public_methods.reject { |m| m =~ /=$/ }
+        meth = public_methods.reject { |m| m =~ /=$/ }
               .find { |m| m =~ /^#{option_name}\??$/i }
-        raise NoMethodError, option_name if m.nil?
-        __send__(m)
+        raise NoMethodError, option_name if meth.nil?
+        __send__(meth)
       end
 
       # Fuzzy option setter. This is to make it easier when porting
@@ -44,9 +44,9 @@ module CZTop
       # @param new_value [String, Integer] new value
       # @raise [NoMethodError] if option name can't be recognized
       def []=(option_name, new_value)
-        m = public_methods.find { |m| m =~ /^#{option_name}=$/i }
-        raise NoMethodError, option_name if m.nil?
-        __send__(m, new_value)
+        meth = public_methods.find { |m| m =~ /^#{option_name}=$/i }
+        raise NoMethodError, option_name if meth.nil?
+        __send__(meth, new_value)
       end
 
       include CZMQ::FFI
@@ -273,13 +273,23 @@ module CZTop
         Zsock.set_linger(@zocket, new_value)
       end
 
+      # @return [Boolean] current value of ipv6
+      def ipv6?() Zsock.ipv6(@zocket) != 0 end
+      # Set the IPv6 option for the socket. A value of true means IPv6 is
+      # enabled on the socket, while false means the socket will use only
+      # IPv4.  When IPv6 is enabled the socket will connect to, or accept 
+      # connections from, both IPv4 and IPv6 hosts.
+      # Default is false.
+      # @param new_value [Boolean] new value for ipv6
+      def ipv6=(new_value)
+        Zsock.set_ipv6(@zocket, new_value ? 1 : 0)
+      end
 # TODO: a reasonable subset of these
 #//  Get socket options
 #int zsock_gssapi_server (void *self);
 #int zsock_gssapi_plaintext (void *self);
 #char * zsock_gssapi_principal (void *self);
 #char * zsock_gssapi_service_principal (void *self);
-#int zsock_ipv6 (void *self);
 #int zsock_immediate (void *self);
 #int zsock_type (void *self);
 #int zsock_affinity (void *self);
@@ -311,7 +321,6 @@ module CZTop
 #void zsock_set_gssapi_plaintext (void *self, int gssapi_plaintext);
 #void zsock_set_gssapi_principal (void *self, const char * gssapi_principal);
 #void zsock_set_gssapi_service_principal (void *self, const char * gssapi_service_principal);
-#void zsock_set_ipv6 (void *self, int ipv6);
 #void zsock_set_immediate (void *self, int immediate);
 #void zsock_set_delay_attach_on_connect (void *self, int delay_attach_on_connect);
 #void zsock_set_affinity (void *self, int affinity);

data/perf/README.md

@@ -4,8 +4,8 @@ This directory contains simple performance measurement utilities:
 
 - `inproc_lat.rb` measures the latency of the inproc transport
 - `inproc_thr.rb` measures the throughput of the inproc transport
-- `local_lat.rb` and `remote_lat.rb` measure the latency other transports
-- `local_thr.rb` and `remote_thr.rb` measure the throughput other transports (TODO)
+- `local_lat.rb` and `remote_lat.rb` measure the latency of other transports
+- `local_thr.rb` and `remote_thr.rb` measure the throughput of other transports (TODO)
 
 ## Example Output
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cztop
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Patrik Wenger
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-04-13 00:00:00.000000000 Z
+date: 2016-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: czmq-ffi-gen
@@ -243,6 +243,8 @@ files:
 - examples/taxi_system/generate_keys.rb
 - examples/taxi_system/start_broker.sh
 - examples/taxi_system/start_clients.sh
+- examples/weather_pub_sub/pub.rb
+- examples/weather_pub_sub/sub.rb
 - exe/z85decode
 - exe/z85encode
 - lib/cztop.rb