cztop 0.14.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b76df17a50c624efad9617599401e6b76ae5b50700544d37c5c8d0bf28b92a2
-  data.tar.gz: c956bf815260cd9cbf7368467a4c9f24d7db33969b706a8ad6d4aa9d61626187
+  metadata.gz: '0099b49a3147e57b4e29b8ca7288370f56e06694230c2f390e36308ac1f0cb1e'
+  data.tar.gz: d4431ae33cc4c35f9911d755d4377913f502156c26317b04a720c598f1f3eb3b
 SHA512:
-  metadata.gz: 35945dabfac2708d8fa666638221495e5beffa0bb901733115a9cdc49a4ed7393e6528f870f5ef6952d780a1ffe96c0eebe24953ee87e20ea058e26d7e6dd333
-  data.tar.gz: 38343f20bfad8f9b5a3cf735d6bf4f1d23e7bc74ead44f7ebc09df7dbe4fdf2e50722710b230fdf1f70f99a5967ae3bc3eb77e056e7f24a928c8e6c1da6193f7
+  metadata.gz: 48f93f12b32aaed87a7cdbdf3f83ff064e69f1fef3e27e4dfaee21a7d721698bd8e7e1675d6fa1110b7597ae7651d971d4502b631a5505345cbb0dbf8ecc19e8
+  data.tar.gz: 90540f6ccab41b27361fc1372feb5198351a725b20a69509285ed459073f438a149a7e5e11043a1936b978610c664a0f7096bbb27c6801054cb85ff6fcd6a0b4

data/.github/workflows/main.yml

@@ -0,0 +1,26 @@
+name: Specs
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-20.04
+    strategy:
+      matrix:
+        ruby:
+          - "2.6"
+          - "2.7"
+          - "3.0"
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby ${{ matrix.ruby }}
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - name: Install CZMQ
+      run: sudo apt install libczmq-dev
+    - name: Run the default task
+      run: |
+        gem install bundler -v 2.2.3
+        bundle install
+        bundle exec rake

data/.ruby-version

@@ -0,0 +1 @@
+3.0

data/CHANGES.md

@@ -1,8 +1,6 @@
-0.14.1 (11/25/2019)
+1.0.0 (01/08/2021)
 -----
-* relax dependencies (ffi)
-* respect env var ZMQ_PATH when loading ZMQ for CZTop::Poller
-
+* modernized project
 
 0.13.1 (03/04/2018)
 -----

data/Gemfile

@@ -2,13 +2,4 @@ source 'https://rubygems.org'
 gemspec
 
 # useful when working on czmq-ffi-gen in parallel
-#gem "czmq-ffi-gen", git: "https://github.com/paddor/czmq-ffi-gen.git"
-#gem "rspec-core", git: "file:///Users/paddor/src/ruby/rspec-core"
-
-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
+# gem "czmq-ffi-gen", path: "../czmq-ffi-gen"

data/README.md

@@ -1,31 +1,13 @@
+![Specs status](https://github.com/paddor/cztop/workflows/Specs/badge.svg)
+
 # CZTop
 
 CZTop is a CZMQ binding for Ruby. It is based on
-[czmq-ffi-gen](https://gitlab.com/paddor/czmq-ffi-gen), the generated low-level
+[czmq-ffi-gen](https://github.com/paddor/czmq-ffi-gen), the generated low-level
 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).
 
-[![pipeline status](https://gitlab.com/paddor/cztop/badges/master/pipeline.svg)](https://gitlab.com/paddor/cztop/commits/master)
-[![Coverage Status](https://coveralls.io/repos/gitlab/paddor/cztop/badge.svg?branch=master)](https://coveralls.io/gitlab/paddor/cztop?branch=master)
-[![ISC License](https://img.shields.io/badge/license-ISC_License-blue.svg)](LICENSE)
-
-## Goals
-
-Here are some some of the goals I had in mind for this library:
-
-- [x] as easy as possible, Ruby-esque API
-- [x] first class support for security (CURVE mechanism)
-  - [x] including handling of certificates
-- [x] support MRI, Rubinius, and JRuby
-- [x] high-quality API documentation
-- [x] 100% test coverage
-- [x] provide a portable Z85 implementation
-  * unlike [fpesce/z85](https://github.com/fpesce/z85), which is a C extension
-- [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)
-
 ## Overview
 
 ### Class Hierarchy
@@ -89,50 +71,28 @@ More information in the [API documentation](http://www.rubydoc.info/github/paddo
   * 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 some constant
+  * 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
-* DRAFT API ready
-  * certain DRAFT methods are supported if the libraries (ZMQ/CZMQ) have been compiled with DRAFT APIs enabled (`--enable-drafts`)
-  * use `CZMQ::FFI.has_draft?` to check if the CZMQ DRAFT API is available
-  * use `CZMQ::FFI::LibZMQ.has_draft?` to check if the ZMQ DRAFT API is available
-  * extend CZTop to your needs
-* ZMTP 3.1 heartbeat ready
-  * `socket.options.heartbeat_ivl = 2000`
-  * `socket.options.heartbeat_timeout = 8000`
+  * e.g. `#subscribe` only exists on `CZTop::Socket::SUB`
 
 ## Requirements
 
-You'll need:
-
-* CZMQ >= 4.1
-* ZMQ >= 4.2
-
-For security mechanisms like CURVE, it's recommended to use Libsodium. However,
-ZMQ can be compiled with tweetnacl enabled.
 
-To install on OSX using homebrew, run:
+* CZMQ >= 4.2
+* ZMQ >= 4.3
 
-    $ brew install libsodium
-    $ brew install zmq  --HEAD --with-libsodium
-    $ brew install czmq --HEAD
 
-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.
+On Ubuntu 20.04+:
 
-**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.
+    $ sudo apt install libczmq-dev
 
-### Supported Ruby versions
+On macOS using Homebrew, run:
 
-See [.travis.yml](https://github.com/paddor/cztop/blob/master/.travis.yml) for a list of Ruby versions against which CZTop
-is tested.
+    $ brew install czmq
 
-At the time of writing, these include:
+### Supported Rubies
 
-* MRI (2.3, 2.2)
+* MRI (2.6, 2.7, 3.0)
 * Rubinius (HEAD)
 * JRuby 9000 (HEAD)
 
@@ -159,20 +119,19 @@ and Ruby.  The following API documentation is currently available:
 
 * [YARD API documentation](http://www.rubydoc.info/gems/cztop) (release)
 
-Feel free to start a [wiki](https://gitlab.com/paddor/cztop/wiki) page.
+Feel free to start a [wiki](https://github.com/paddor/cztop/wiki) page.
 
 ## Performance
 
-Performance should be pretty okay since this is based on czmq-ffi-gen, which is
-reasonably thin.  CZTop is just a convenience layer.
+CZTop is just a convenience layer on top of the thin czmq-ffi-gen library.
 
 Make sure to check out the
-[perf](https://gitlab.com/paddor/cztop/blob/master/perf) directory for latency
+[perf](https://github.com/paddor/cztop/blob/master/perf) directory for latency
 and throughput measurement scripts.
 
 ## Usage
 
-See the [examples](https://gitlab.com/paddor/cztop/blob/master/examples) directory for some examples.
+See the [examples](https://github.com/paddor/cztop/blob/master/examples) directory for some examples.
 
 
 ## Contributing

data/cztop.gemspec

@@ -1,7 +1,6 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'cztop/version'
+# frozen_string_literal: true
+
+require_relative "lib/cztop/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "cztop"
@@ -9,16 +8,21 @@ 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.homepage      = "https://github.com/paddor/cztop"
+  spec.summary       = %q{CZMQ Ruby 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(">= 2.5.0")
+
+  spec.metadata["homepage_uri"]    = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/paddor/cztop"
+  spec.metadata["changelog_uri"]   = "https://github.com/paddor/cztop/blob/master/CHANGELOG.md"
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "czmq-ffi-gen", "~> 0.16"
+  spec.add_runtime_dependency "czmq-ffi-gen", "~> 1.0"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"
@@ -27,10 +31,4 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec-given", "~> 3.8.0"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "yard"
-  spec.add_development_dependency "guard"
-  spec.add_development_dependency "guard-rspec"
-  spec.add_development_dependency "guard-yard"
-  spec.add_development_dependency "guard-shell"
-  spec.add_development_dependency 'terminal-notifier-guard'
-  spec.add_development_dependency 'foreman'
 end

data/lib/cztop/version.rb

@@ -1,3 +1,3 @@
 module CZTop
-  VERSION = "0.14.1"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cztop
 version: !ruby/object:Gem::Version
-  version: 0.14.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Patrik Wenger
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-25 00:00:00.000000000 Z
+date: 2021-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: czmq-ffi-gen
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.16'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.16'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -122,90 +122,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: guard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: guard-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: guard-yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: guard-shell
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: terminal-notifier-guard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: foreman
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: 
 email:
 - paddor@gmail.com
@@ -215,21 +131,19 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/main.yml"
 - ".gitignore"
-- ".gitlab-ci.yml"
 - ".rspec"
+- ".ruby-version"
 - ".yardopts"
 - AUTHORS
 - CHANGES.md
 - Gemfile
-- Guardfile
 - LICENSE
-- Procfile
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
-- ci-scripts/install-deps
 - cztop.gemspec
 - examples/ruby_actor/actor.rb
 - examples/simple_req_rep/rep.rb
@@ -283,10 +197,13 @@ files:
 - perf/inproc_thru.rb
 - perf/local_lat.rb
 - perf/remote_lat.rb
-homepage: https://github.com/paddor/cztop
+homepage: https://rubygems.org/gems/cztop
 licenses:
 - ISC
-metadata: {}
+metadata:
+  homepage_uri: https://rubygems.org/gems/cztop
+  source_code_uri: https://github.com/paddor/cztop
+  changelog_uri: https://github.com/paddor/cztop/blob/master/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -295,15 +212,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.2.4
 signing_key: 
 specification_version: 4
-summary: CZMQ Ruby binding, based on the generated low-level FFI bindings of CZMQ
+summary: CZMQ Ruby binding based on the generated low-level FFI bindings of CZMQ
 test_files: []

data/.gitlab-ci.yml

@@ -1,32 +0,0 @@
-.rspec:
-  image: ruby:latest
-  stage: test
-  variables:
-    ZMQ_VERSION: "stable"
-    CZMQ_VERSION: "stable"
-  before_script:
-    - export LD_LIBRARY_PATH=$HOME/lib # custom libs (for execution)
-    - export PKG_CONFIG_PATH=$HOME/lib/pkgconfig # custom libs (for linking)
-    - env
-    - ci-scripts/install-deps
-    - gem install bundler --no-document
-    - bundle install --path vendor/bundle
-  script:
-    - bundle exec rspec
-  cache:
-    key: "$CI_JOB_NAME"
-    paths:
-      - "vendor/bundle"
-
-
-ruby-latest_with_stable_czmq:
-  extends: .rspec
-  variables:
-    CZMQ_VERSION: "stable"
-
-
-ruby-latest_with_HEAD_czmq:
-  extends: .rspec
-  allow_failure: true
-  variables:
-    CZMQ_VERSION: "HEAD"

data/Guardfile

@@ -1,61 +0,0 @@
-require "guard/rspec/dsl"
-
-# Start using
-#
-#   bundle exec guard -g doc & bundle exec guard -g spec
-#
-# This way you get parallel execution, so
-# * documentation is regenerated immediately
-# * specs are run immediately
-
-README_FILE = %r{^README\.md}
-
-# set these later using help from guard-rspec
-ruby_lib_files = nil
-spec_files     = nil
-
-# I don't need no shell that hogs my CPU whenever I hit return.
-interactor :off
-
-group :spec do
-  guard :rspec, cmd: "bundle exec rspec" do
-    dsl = Guard::RSpec::Dsl.new(self)
-
-    # RSpec files
-    rspec = dsl.rspec
-    watch(rspec.spec_helper) { rspec.spec_dir }
-    watch(rspec.spec_support) { rspec.spec_dir }
-    watch(rspec.spec_files)
-    spec_files = rspec.spec_files
-
-    # Ruby files
-    ruby = dsl.ruby
-    watch(ruby.lib_files) { |m| rspec.spec.(m[1]) }
-    ruby_lib_files = ruby.lib_files
-  end
-
-
-  puts "README pattern: %p" % README_FILE
-  puts "ruby lib files pattern: %p" % ruby_lib_files
-  puts "spec files pattern: %p" % spec_files
-end
-
-group :syntax_check do
-  guard :shell do
-    # check Ruby syntax
-    watch(Regexp.union(ruby_lib_files, spec_files)) do |m|
-      puts "Checking Ruby syntax of %p ..." % m[0]
-      if not system("ruby -c #{m[0]}")
-        n "#{m[0]} is incorrect", 'Ruby Syntax', :failed
-      end
-    end
-  end
-end
-
-YARD_OPTS = "--use-cache .yardoc/cache.db"
-
-group :doc do
-  guard 'yard' do
-    watch(Regexp.union(README_FILE, ruby_lib_files))
-  end
-end

data/Procfile

@@ -1,3 +0,0 @@
-doc: bundle exec guard -g doc
-spec: bundle exec guard -g spec
-syntax_check: bundle exec guard -g syntax_check

data/ci-scripts/install-deps

@@ -1,8 +0,0 @@
-#!/bin/sh -x
-set -e
-mkdir -p vendor
-cd vendor
-git clone --depth 1 https://gitlab.com/paddor/czmq-ffi-gen
-cd czmq-ffi-gen
-ci-scripts/install-libzmq
-ci-scripts/install-libczmq