cztop 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a73261e3bc3a15f8302b4e7eca58eb25393cfe301d9b755a7291bf35ef126674
-  data.tar.gz: 5d1f75990a28eba2460cfd61e5825492bcd66604bd7990dbcdf4a74db00c0e7e
+  metadata.gz: 066d9600730db24e49b9b83fee30840882432df13dde7372f9e7f969b3774b33
+  data.tar.gz: 67ee0941443c6a9eadf7d27b4bc084e00d20c2dc7ca4448fc6459edc93a88efb
 SHA512:
-  metadata.gz: 9ebe5b00e21a32e0b645f50a789a8818dddf31d4ed69a74c247b30b443e02cd4cdd05121f3cd2bc286c41e21e09bc6feb0b304fc245d9be6dbaf648e287c0bb8
-  data.tar.gz: cd3c05936f8ce4c0c8c6b8f3774d70bfaf1a7b85d9770e159fb0aed4ae0628f97e74bbaa76742b7518a06d257dd6c22504dc2285a827fcc36b5bb5f59bf51ac8
+  metadata.gz: c8852f4b214935ef5b0302a7a6481a2f51148dfc6fac939ca9d9b5f665ab06d8242418bdbe996edb9ad6fe010a84a540fd9b24e379cdd5b3197fd3c7a80f0478
+  data.tar.gz: 506f6e6b9a927e8c68d60c410d3ed84abfae1edef435c43baae8855eb2f02409815692eb4cf18501298ab5c8f9c988cdd48d308a93eb20d1ae136bf51c8283fe

data/.github/workflows/coverage.yml

@@ -4,13 +4,13 @@ on: [push,pull_request]
 
 jobs:
   build:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 3.1
+        ruby-version: 3.3
     - name: Install CZMQ
       run: sudo apt-get install libczmq-dev
     - name: Run the default task

data/.github/workflows/draft_api.yml

@@ -7,11 +7,11 @@ jobs:
     runs-on: ubuntu-22.04
     timeout-minutes: 15
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 3.3
+        ruby-version: '3.3'
     - name: Install ZMQ and CZMQ
       run: |
         export PKG_CONFIG_PATH=$HOME/lib/pkgconfig # custom libs (for linking)

data/.github/workflows/stable_api.yml

@@ -8,12 +8,11 @@ jobs:
     strategy:
       matrix:
         ruby:
-          - 3.0
-          - 3.1
-          - 3.2
-          - 3.3
+          - '3.1'
+          - '3.2'
+          - '3.3'
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - name: Set up Ruby ${{ matrix.ruby }}
       uses: ruby/setup-ruby@v1
       with:

data/.projections.json

@@ -0,0 +1,4 @@
+{
+  "lib/*.rb": { "alternate": "spec/{}_spec.rb" },
+  "spec/*_spec.rb": { "alternate": "lib/{}.rb", "dispatch": "bundle exec rspec -ff {file}" }
+}

data/CHANGES.md

@@ -1,3 +1,12 @@
+1.1.1 (1/4/2024)
+-----
+* speed up Async::IO#wait_readable and #wait_writable
+* update CI and specs
+
+1.1.0 (1/4/2024)
+-----
+* support Async
+
 1.1.0.pre1 (10/17/2022)
 -----
 * modernize syntax using Rubocop

data/README.md

@@ -10,6 +10,76 @@ FFI binding of [CZMQ](https://github.com/zeromq/czmq) and has a focus on being
 easy to use for Rubyists (POLS) and providing first class support for security
 mechanisms (like CURVE).
 
+
+## Example with Async
+
+```ruby
+#! /usr/bin/env ruby
+
+require 'cztop/async'
+
+Async do |task|
+  task.async do |t|
+    socket = CZTop::Socket::REP.new("inproc://req_rep_example")
+    io     = Async::IO.try_convert socket
+
+    socket.options.rcvtimeo = 50 # ms
+
+    loop do
+      msg = io.receive
+      puts "<<< #{msg.to_a.inspect}"
+      io << msg.to_a.map(&:upcase)
+    rescue IO::TimeoutError
+      break
+    end
+
+    puts "REP done."
+  end
+
+  task.async do
+    socket = CZTop::Socket::REQ.new("inproc://req_rep_example")
+    io     = Async::IO.try_convert socket
+
+    10.times do |i|
+      io << "foobar ##{i}"
+      msg = io.receive
+      puts ">>> #{msg.to_a.inspect}"
+    end
+
+    puts "REQ done."
+  end
+end
+```
+
+
+Output:
+```
+<<< ["foobar #0"]
+>>> ["FOOBAR #0"]
+<<< ["foobar #1"]
+>>> ["FOOBAR #1"]
+<<< ["foobar #2"]
+>>> ["FOOBAR #2"]
+<<< ["foobar #3"]
+>>> ["FOOBAR #3"]
+<<< ["foobar #4"]
+>>> ["FOOBAR #4"]
+<<< ["foobar #5"]
+>>> ["FOOBAR #5"]
+<<< ["foobar #6"]
+>>> ["FOOBAR #6"]
+<<< ["foobar #7"]
+>>> ["FOOBAR #7"]
+<<< ["foobar #8"]
+>>> ["FOOBAR #8"]
+<<< ["foobar #9"]
+>>> ["FOOBAR #9"]
+REQ done.
+REP done.
+0.46user 0.09system 0:00.60elapsed 90%CPU (0avgtext+0avgdata 47296maxresident)k
+0inputs+0outputs (0major+13669minor)pagefaults 0swaps
+```
+
 ## Overview
 
 ### Class Hierarchy
@@ -59,24 +129,12 @@ More information in the [API documentation](http://www.rubydoc.info/github/paddo
 
 ### Features
 
+* Ruby idiomatic API
 * compatible with [Async](https://github.com/socketry/async) / [Async::IO](https://github.com/socketry/async-io)
-* Ruby-like API
-  * method names
-    * sending a message via a socket is done with `Socket#<<`
-      * `socket << "simple message"`
-      * `socket << ["multi", "frame", "message"]`
-    * `#x=` methods instead of `#set_x` (e.g. socket options)
-    * `#[]` where it makes sense (e.g. on a Message, Config, or Certificate)
-  * no manual error checking needed
-    * if there's an error, an appropriate exception is raised
-  * of course, no manual dealing with the ZMQ context
-* easy security
-  * use `Socket#CURVE_server!(cert)` on the server
-  * and `Socket#CURVE_client!(client_cert, server_cert)` on the client
-* socket types as Ruby classes
-  * no need to manually pass type constants
-    * but you can: `CZTop::Socket.new_by_type(:REP)`
-  * e.g. `#subscribe` only exists on `CZTop::Socket::SUB`
+* errors as exceptions
+* CURVE security
+* supports CZMQ DRAFT API
+* extensive spec coverage
 
 ## Requirements
 
@@ -95,9 +153,11 @@ On macOS using Homebrew, run:
 
 ### Supported Rubies
 
-* MRI (3.0, 3.2, 3.3)
-* Rubinius (HEAD)
-* JRuby 9000 (HEAD)
+At least:
+
+* Ruby 3.0, 3.1, 3.2, 3.3
+
+Using CZTop with Async will require Ruby 3.2 because of the use of `IO::TimeoutError`, which was introduced in Ruby 3.2.
 
 ## Installation
 

data/cztop.gemspec

@@ -8,7 +8,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Patrik Wenger"]
   spec.email         = ["paddor@gmail.com"]
 
-  spec.summary       = %q{CZMQ Ruby binding based on the generated low-level FFI bindings of CZMQ}
+  spec.summary       = 'CZMQ FFI binding to bring ZMQ sockets to Ruby'
+  spec.description   = 'CZMQ binding based on the generated low-level FFI bindings of CZMQ'
   spec.homepage      = "https://rubygems.org/gems/cztop"
   spec.license       = "ISC"
   spec.required_ruby_version = Gem::Requirement.new(">= 3.0.0")
@@ -22,7 +23,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "czmq-ffi-gen", "~> 1.1.0.pre1"
+  spec.add_runtime_dependency "czmq-ffi-gen", "~> 1.1.0"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"
@@ -32,6 +33,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "pry"
   spec.add_development_dependency "yard"
   spec.add_development_dependency "rubocop", "~> 1.36.0"
-  spec.add_development_dependency "async", ">= 2.0.1"
-  spec.add_development_dependency "async-io"
+
+  if RUBY_VERSION >= '3.1'
+    spec.add_development_dependency "async", ">= 2.0.1"
+    spec.add_development_dependency "async-io"
+  end
 end

data/examples/async/async.rb

@@ -4,37 +4,32 @@ require 'cztop/async'
 
 Async do |task|
   task.async do |t|
-    socket = CZTop::Socket::REP.new("ipc:///tmp/req_rep_example")
+    socket = CZTop::Socket::REP.new("inproc://req_rep_example")
+    io     = Async::IO.try_convert socket
 
-    # Simply echo every message, with every frame String#upcase'd.
-    socket.options.rcvtimeo = 3
-    io = Async::IO.try_convert socket
+    socket.options.rcvtimeo = 50 # ms
 
-    msg = io.receive
-    puts "<<< #{msg.to_a.inspect}"
-    io << msg.to_a.map(&:upcase)
+    loop do
+      msg = io.receive
+      puts "<<< #{msg.to_a.inspect}"
+      io << msg.to_a.map(&:upcase)
+    rescue IO::TimeoutError
+      break
+    end
 
     puts "REP done."
   end
 
   task.async do
-    socket = CZTop::Socket::REQ.new("ipc:///tmp/req_rep_example")
-    puts ">>> Socket connected."
+    socket = CZTop::Socket::REQ.new("inproc://req_rep_example")
+    io     = Async::IO.try_convert socket
 
-    io = Async::IO.try_convert socket
-    # sleep 5
-    io << "foobar"
+    10.times do |i|
+      io << "foobar ##{i}"
+      msg = io.receive
+      puts ">>> #{msg.to_a.inspect}"
+    end
 
-    socket.options.rcvtimeo = 3
-    msg = io.receive
-    puts ">>> #{msg.to_a.inspect}"
     puts "REQ done."
   end
-
-  task.async do
-    6.times do
-      sleep 0.5
-      puts "tick"
-    end
-  end
 end

data/lib/cztop/async.rb

@@ -49,6 +49,8 @@ module Async
       def wait_readable(timeout = read_timeout)
         @io_fd ||= ::IO.for_fd @io.fd, autoclose: false
 
+        return true if @io.readable?
+
         if timeout
           timeout_at = now + timeout
 
@@ -67,6 +69,8 @@ module Async
       def wait_writable(timeout = write_timeout)
         @io_fd ||= ::IO.for_fd @io.fd, autoclose: false
 
+        return true if @io.writable?
+
         if timeout
           timeout_at = now + timeout
 

data/lib/cztop/cert_store.rb

@@ -13,6 +13,12 @@ module CZTop
     include HasFFIDelegate
     extend CZTop::HasFFIDelegate::ClassMethods
 
+    unless ::CZMQ::FFI::Zsys.has_curve
+      def self.new(...)
+        fail NotImplementedError
+      end
+    end
+
     # Initializes a new certificate store.
     #
     # @param location [String, #to_s, nil] location the path to the

data/lib/cztop/certificate.rb

@@ -8,6 +8,13 @@ module CZTop
     extend CZTop::HasFFIDelegate::ClassMethods
     include ::CZMQ::FFI
 
+    unless ::CZMQ::FFI::Zsys.has_curve
+      def self.new(...)
+        fail NotImplementedError
+      end
+    end
+
+
     # Warns if CURVE security isn't available.
     # @return [void]
     def self.check_curve_availability
@@ -57,6 +64,16 @@ module CZTop
     end
 
 
+    KEY_ALL_ZERO = '0000000000000000000000000000000000000000'
+
+    # @return [Boolean] whether one of the keys is all zeros (happens when CURVE is not available, i.e. libzmq was
+    #   compiled without libsodium)
+    # @see .check_curve_availability
+    def zero?
+      public_key(format: :z85) == KEY_ALL_ZERO || secret_key(format: :z85) == KEY_ALL_ZERO
+    end
+
+
     # Returns the public key either as Z85-encoded ASCII string (default) or
     # binary string.
     # @param format [Symbol] +:z85+ for Z85, +:binary+ for binary

data/lib/cztop/version.rb

@@ -2,6 +2,6 @@
 
 module CZTop
 
-  VERSION = '1.1.0'
+  VERSION = '1.1.1'
 
 end

data/lib/cztop/zsock_options.rb

@@ -111,58 +111,8 @@ module CZTop
 
       # @!endgroup
 
-      # @!group Security Mechanisms
-
-      # @return [Boolean] whether this zocket is a CURVE server
-      def CURVE_server?
-        Zsock.curve_server(@zocket).positive?
-      end
-
-
-      # Make this zocket a CURVE server.
-      # @param bool [Boolean]
-      # @note You'll have to use a {CZTop::Authenticator}.
-      def CURVE_server=(bool)
-        Zsock.set_curve_server(@zocket, bool ? 1 : 0)
-      end
-
-
-      # @return [String] Z85 encoded server key set
-      # @return [nil] if the current mechanism isn't CURVE or CURVE isn't
-      #   supported
-      def CURVE_serverkey
-        CURVE_key(:curve_serverkey)
-      end
 
-
-      # Get one of the CURVE keys.
-      # @param key_name [Symbol] something like +:curve_serverkey+
-      # @return [String, nil] key, if CURVE is supported and active, or nil
-      def CURVE_key(key_name)
-        return nil if mechanism != :CURVE
-
-        ptr = Zsock.__send__(key_name, @zocket)
-        return nil if ptr.null?
-
-        ptr.read_string
-      end
-      private :CURVE_key
-
-      # Sets the server's public key, so the zocket can authenticate the
-      # remote server.
-      # @param key [String] Z85 (40 bytes) or binary (32 bytes) server key
-      # @raise [ArgumentError] if key has wrong size
-      def CURVE_serverkey=(key)
-        case key.bytesize
-        when 40
-          Zsock.set_curve_serverkey(@zocket, key)
-        when 32
-          ptr = ::FFI::MemoryPointer.from_string(key)
-          Zsock.set_curve_serverkey_bin(@zocket, ptr)
-        else
-          raise ArgumentError, format('invalid server key: %p', key)
-        end
-      end
+      # @!group Security Mechanisms
 
       # supported security mechanisms and their macro value equivalent
       MECHANISMS = {
@@ -182,20 +132,92 @@ module CZTop
           raise format('unknown ZMQ security mechanism code: %i', code)
       end
 
+      if ::CZMQ::FFI::Zsys.has_curve
+        # @return [Boolean] whether this zocket is a CURVE server
+        def CURVE_server?
+          Zsock.curve_server(@zocket).positive?
+        end
 
-      # @return [String] Z85 encoded secret key set
-      # @return [nil] if the current mechanism isn't CURVE or CURVE isn't
-      #   supported
-      def CURVE_secretkey
-        CURVE_key(:curve_secretkey)
-      end
+
+        # Make this zocket a CURVE server.
+        # @param bool [Boolean]
+        # @note You'll have to use a {CZTop::Authenticator}.
+        def CURVE_server=(bool)
+          Zsock.set_curve_server(@zocket, bool ? 1 : 0)
+        end
+
+
+        # @return [String] Z85 encoded server key set
+        # @return [nil] if the current mechanism isn't CURVE or CURVE isn't
+        #   supported
+        def CURVE_serverkey
+          CURVE_key(:curve_serverkey)
+        end
+
+
+        # Get one of the CURVE keys.
+        # @param key_name [Symbol] something like +:curve_serverkey+
+        # @return [String, nil] key, if CURVE is supported and active, or nil
+        def CURVE_key(key_name)
+          return nil if mechanism != :CURVE
+
+          ptr = Zsock.__send__(key_name, @zocket)
+          return nil if ptr.null?
+
+          ptr.read_string
+        end
+        private :CURVE_key
+
+        # Sets the server's public key, so the zocket can authenticate the
+        # remote server.
+        # @param key [String] Z85 (40 bytes) or binary (32 bytes) server key
+        # @raise [ArgumentError] if key has wrong size
+        def CURVE_serverkey=(key)
+          case key.bytesize
+          when 40
+            Zsock.set_curve_serverkey(@zocket, key)
+          when 32
+            ptr = ::FFI::MemoryPointer.from_string(key)
+            Zsock.set_curve_serverkey_bin(@zocket, ptr)
+          else
+            raise ArgumentError, format('invalid server key: %p', key)
+          end
+        end
 
 
-      # @return [String] Z85 encoded public key set
-      # @return [nil] if the current mechanism isn't CURVE or CURVE isn't
-      #   supported
-      def CURVE_publickey
-        CURVE_key(:curve_publickey)
+        # @return [String] Z85 encoded secret key set
+        # @return [nil] if the current mechanism isn't CURVE or CURVE isn't
+        #   supported
+        def CURVE_secretkey
+          CURVE_key(:curve_secretkey)
+        end
+
+
+        # @return [String] Z85 encoded public key set
+        # @return [nil] if the current mechanism isn't CURVE or CURVE isn't
+        #   supported
+        def CURVE_publickey
+          CURVE_key(:curve_publickey)
+        end
+      else
+        def CURVE_server?
+          fail NotImplementedError
+        end
+        def CURVE_server=(...)
+          fail NotImplementedError
+        end
+        def CURVE_serverkey(...)
+          fail NotImplementedError
+        end
+        def CURVE_serverkey=(...)
+          fail NotImplementedError
+        end
+        def CURVE_secretkey(...)
+          fail NotImplementedError
+        end
+        def CURVE_publickey(...)
+          fail NotImplementedError
+        end
       end
 
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cztop
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Patrik Wenger
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0.pre1
+        version: 1.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0.pre1
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -164,7 +164,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description: CZMQ binding based on the generated low-level FFI bindings of CZMQ
 email:
 - paddor@gmail.com
 executables:
@@ -177,6 +177,7 @@ files:
 - ".github/workflows/draft_api.yml"
 - ".github/workflows/stable_api.yml"
 - ".gitignore"
+- ".projections.json"
 - ".rspec"
 - ".rubocop.yml"
 - ".yardopts"
@@ -273,5 +274,5 @@ requirements: []
 rubygems_version: 3.5.3
 signing_key: 
 specification_version: 4
-summary: CZMQ Ruby binding based on the generated low-level FFI bindings of CZMQ
+summary: CZMQ FFI binding to bring ZMQ sockets to Ruby
 test_files: []