cztop 1.1.2 → 1.2.1

data/.rubocop.yml

@@ -1,175 +0,0 @@
-AllCops:
-  TargetRubyVersion: 2.7
-  NewCops: enable
-Layout/EmptyLineAfterMagicComment:
-  Enabled: true
-Layout/ExtraSpacing:
-  AllowForAlignment: true
-Layout/EmptyLines:
-  Enabled: false
-Layout/EmptyLineBetweenDefs:
-  NumberOfEmptyLines: 2
-Layout/MultilineOperationIndentation:
-  Enabled: true
-Gemspec/DeprecatedAttributeAssignment: # new in 1.30
-  Enabled: true
-Gemspec/RequireMFA: # new in 1.23
-  Enabled: true
-Layout/LineContinuationLeadingSpace: # new in 1.31
-  Enabled: true
-Layout/LineContinuationSpacing: # new in 1.31
-  Enabled: true
-Layout/LineEndStringConcatenationIndentation: # new in 1.18
-  Enabled: true
-Layout/SpaceBeforeBrackets: # new in 1.7
-  Enabled: true
-Lint/AmbiguousAssignment: # new in 1.7
-  Enabled: true
-Lint/AmbiguousOperatorPrecedence: # new in 1.21
-  Enabled: false
-Lint/AmbiguousRange: # new in 1.19
-  Enabled: true
-Lint/ConstantOverwrittenInRescue: # new in 1.31
-  Enabled: true
-Lint/DeprecatedConstants: # new in 1.8
-  Enabled: true
-Lint/DuplicateBranch: # new in 1.3
-  Enabled: true
-Lint/DuplicateRegexpCharacterClassElement: # new in 1.1
-  Enabled: true
-Lint/EmptyBlock: # new in 1.1
-  Enabled: true
-Lint/EmptyClass: # new in 1.3
-  Enabled: true
-Lint/EmptyInPattern: # new in 1.16
-  Enabled: true
-Lint/IncompatibleIoSelectWithFiberScheduler: # new in 1.21
-  Enabled: true
-Lint/LambdaWithoutLiteralBlock: # new in 1.8
-  Enabled: true
-Lint/NoReturnInBeginEndBlocks: # new in 1.2
-  Enabled: true
-Lint/NonAtomicFileOperation: # new in 1.31
-  Enabled: true
-Lint/NumberedParameterAssignment: # new in 1.9
-  Enabled: true
-Lint/OrAssignmentToConstant: # new in 1.9
-  Enabled: true
-Lint/RedundantDirGlobSort: # new in 1.8
-  Enabled: true
-Lint/RefinementImportMethods: # new in 1.27
-  Enabled: true
-Lint/RequireRangeParentheses: # new in 1.32
-  Enabled: true
-Lint/RequireRelativeSelfPath: # new in 1.22
-  Enabled: true
-Lint/SymbolConversion: # new in 1.9
-  Enabled: true
-Lint/ToEnumArguments: # new in 1.1
-  Enabled: true
-Lint/TripleQuotes: # new in 1.9
-  Enabled: true
-Lint/UnexpectedBlockArity: # new in 1.5
-  Enabled: true
-Lint/UnmodifiedReduceAccumulator: # new in 1.1
-  Enabled: true
-Lint/UselessRuby2Keywords: # new in 1.23
-  Enabled: true
-Naming/BlockForwarding: # new in 1.24
-  Enabled: true
-Security/CompoundHash: # new in 1.28
-  Enabled: true
-Security/IoMethods: # new in 1.22
-  Enabled: true
-Style/AndOr:
-  EnforcedStyle: conditionals
-Style/InfiniteLoop:
-  Enabled: false
-Style/ArgumentsForwarding: # new in 1.1
-  Enabled: true
-Style/CollectionCompact: # new in 1.2
-  Enabled: true
-Style/DocumentDynamicEvalDefinition: # new in 1.1
-  Enabled: true
-Style/EmptyHeredoc: # new in 1.32
-  Enabled: true
-Style/EndlessMethod: # new in 1.8
-  Enabled: true
-Style/EnvHome: # new in 1.29
-  Enabled: true
-Style/FetchEnvVar: # new in 1.28
-  Enabled: true
-Style/FileRead: # new in 1.24
-  Enabled: true
-Style/FileWrite: # new in 1.24
-  Enabled: true
-Style/FrozenStringLiteralComment:
-  EnforcedStyle: always_true
-Style/HashConversion: # new in 1.10
-  Enabled: true
-Style/HashExcept: # new in 1.7
-  Enabled: true
-Style/IfWithBooleanLiteralBranches: # new in 1.9
-  Enabled: true
-Style/InPatternThen: # new in 1.16
-  Enabled: true
-Style/MagicCommentFormat: # new in 1.35
-  Enabled: true
-Style/MapCompactWithConditionalBlock: # new in 1.30
-  Enabled: true
-Style/MapToHash: # new in 1.24
-  Enabled: true
-Style/MultilineInPatternThen: # new in 1.16
-  Enabled: true
-Style/NegatedIfElseCondition: # new in 1.2
-  Enabled: true
-Style/NestedFileDirname: # new in 1.26
-  Enabled: true
-Style/NilLambda: # new in 1.3
-  Enabled: true
-Style/NumberedParameters: # new in 1.22
-  Enabled: true
-Style/NumberedParametersLimit: # new in 1.22
-  Enabled: true
-Style/ObjectThen: # new in 1.28
-  Enabled: true
-Style/OpenStructUse: # new in 1.23
-  Enabled: true
-Style/QuotedSymbols: # new in 1.16
-  Enabled: true
-Style/RedundantArgument: # new in 1.4
-  Enabled: true
-Style/RedundantInitialize: # new in 1.27
-  Enabled: true
-Style/RedundantSelfAssignmentBranch: # new in 1.19
-  Enabled: true
-Style/SelectByRegexp: # new in 1.22
-  Enabled: true
-Style/StringChars: # new in 1.12
-  Enabled: true
-Style/SwapValues: # new in 1.1
-  Enabled: true
-Style/ClassAndModuleChildren:
-  Enabled: false
-Style/StringConcatenation:
-  Enabled: false
-Style/RescueModifier:
-  Enabled: false
-Style/YodaCondition:
-  Enabled: false
-Lint/AmbiguousRegexpLiteral:
-  Enabled: false
-Style/WordArray:
-  Enabled: false
-Style/Semicolon:
-  Enabled: false
-Naming/MethodName:
-  Enabled: false
-Style/EmptyMethod:
-  Enabled: false
-Layout/EmptyLinesAroundClassBody:
-  Enabled: true
-  EnforcedStyle: empty_lines_except_namespace
-Layout/EmptyLinesAroundModuleBody:
-  Enabled: true
-  EnforcedStyle: empty_lines_except_namespace

data/.yardopts

@@ -1 +0,0 @@
---private lib/**/*.rb - README.md LICENSE

data/Rakefile

@@ -1,6 +0,0 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-task :default => :spec

data/ci/install-libczmq

@@ -1,22 +0,0 @@
-#!/bin/sh -x
-# vim: ft=sh
-set -e
-mkdir -p ~/src
-cd ~/src
-
-case "$CZMQ_VERSION" in
-HEAD)
-	echo "Using HEAD and compiling with --enable-drafts ..."
-	git clone https://github.com/zeromq/czmq czmq
-	CONFIGURE_OPTS="--enable-drafts=yes"
-	;;
-*)
-	echo '$CZMQ_VERSION not set.'
-	exit 1
-esac
-
-cd czmq
-./autogen.sh
-./configure --prefix=$HOME $CONFIGURE_OPTS
-make
-make install

data/ci/install-libzmq

@@ -1,22 +0,0 @@
-#!/bin/sh -x
-# vim: ft=sh
-set -e
-mkdir -p ~/src
-cd ~/src
-
-case "$ZMQ_VERSION" in
-HEAD)
-	echo "Using HEAD and compiling with --enable-drafts ..."
-	git clone https://github.com/zeromq/libzmq libzmq
-	CONFIGURE_OPTS="--enable-drafts=yes"
-	;;
-*)
-	echo '$ZMQ_VERSION not set.'
-	exit 1
-esac
-
-cd libzmq
-./autogen.sh
-./configure --prefix=$HOME $CONFIGURE_OPTS
-make
-make install

data/examples/ruby_actor/actor.rb

@@ -1,100 +0,0 @@
-#!/usr/bin/env ruby
-require 'cztop'
-
-##
-# This example shows how to create a simple actor using a Ruby block.
-# Of course it also supports the CZMQ-native way, passing a pointer to
-# a C function. That's how CZTop::Beacon, CZTop::Authenticator, ... are
-# implemented.
-#
-
-counter = 0
-actor = CZTop::Actor.new do |msg, pipe|
-  # This block is called once for every received message.
-
-  case command = msg[0]
-  when "UPCASE"
-    # Upcase second message frame and send back.
-    word = msg[1]
-    puts ">>> Actor converts #{word.inspect} to uppercase."
-    pipe << word.upcase
-  when "COUNT"
-    # Count up.
-    counter += 1
-    puts ">>> Actor has incremented counter to: #{counter}"
-  when "PRODUCE"
-    # Produce multiple messages.
-    num = msg[1].to_i
-    puts ">>> Actor produces #{num} messages."
-    num.times { |i| pipe << "FOO #{i+1}/#{num}" }
-  else
-    # crashes actor #=> Actor#dead? and Actor#crashed? will return true
-    # also, Actor#exception will return this exception.
-    raise "invalid command: #{command}"
-  end
-end
-puts ">>> Actor created."
-
-##
-# Let actor count.
-#
-# Actor#<< is thread-safe.
-#
-actor << "COUNT"
-actor << "COUNT"
-actor << "COUNT"
-actor << "COUNT"
-actor << "COUNT"
-actor << "COUNT"
-
-
-##
-# Request a response from actor.
-#
-# Actor#request is thread-safe and ensures that the right response gets
-# returned.
-#
-puts actor.request(["UPCASE", "foobar"]).inspect
-#=> #<CZTop::Message:0x7f98c8d96000 frames=1 content_size=6 content=["FOOBAR"]>
-
-
-##
-# Let actor produce some messages.
-#
-# Actor#receive is thread-safe, but doesn't guarantee any particular order.
-#
-actor << %w[ PRODUCE 5 ]
-puts actor.receive[0] #1
-puts actor.receive[0] #2
-puts actor.receive[0] #3
-puts actor.receive[0] #4
-puts actor.receive[0] #5
-
-##
-# Let actor die.
-#
-# Blocks until dead.
-actor.terminate
-actor.dead? #=> true
-actor.crashed? #=> false
-actor.exception #=> nil, because it didn't crash
-
-
-__END__
-Example output:
-
->>> Actor created.
->>> Actor has incremented counter to: 1
->>> Actor has incremented counter to: 2
->>> Actor has incremented counter to: 3
->>> Actor has incremented counter to: 4
->>> Actor has incremented counter to: 5
->>> Actor has incremented counter to: 6
->>> Actor converts "foobar" to uppercase.
-#<CZTop::Message:0x7f81c55bdca0 frames=1 content_size=6 content=["FOOBAR"]>
->>> Actor produces 5 messages.
-FOO 1/5
-FOO 2/5
-FOO 3/5
-FOO 4/5
-FOO 5/5

data/examples/simple_req_rep/rep.rb

@@ -1,12 +0,0 @@
-#!/usr/bin/env ruby
-require 'cztop'
-
-# create and bind socket
-socket = CZTop::Socket::REP.new("ipc:///tmp/req_rep_example")
-puts "<<< Socket bound to #{socket.last_endpoint.inspect}"
-
-# Simply echo every message, with every frame String#upcase'd.
-while msg = socket.receive
-  puts "<<< #{msg.to_a.inspect}"
-  socket << msg.to_a.map(&:upcase)
-end

data/examples/simple_req_rep/req.rb

@@ -1,35 +0,0 @@
-#!/usr/bin/env ruby
-require 'cztop'
-
-# connect
-socket = CZTop::Socket::REQ.new("ipc:///tmp/req_rep_example")
-puts ">>> Socket connected."
-
-# simple string
-socket << "foobar"
-msg = socket.receive
-puts ">>> #{msg.to_a.inspect}"
-
-# multi frame message as array
-socket << %w[foo bar baz]
-msg = socket.receive
-puts ">>> #{msg.to_a.inspect}"
-
-# manually instantiating a Message
-msg = CZTop::Message.new("bla")
-msg << "another frame" # append a frame
-socket << msg
-msg = socket.receive
-puts ">>> #{msg.to_a.inspect}"
-
-##
-# This will send 20 additional messages:
-#
-#   ./req.rb 20
-#
-if ARGV.first
-  ARGV.first.to_i.times do
-    socket << ["fooooooooo", "baaaaaar"]
-    puts ">>> " + socket.receive.to_a.inspect
-  end
-end

data/examples/taxi_system/.gitignore

@@ -1,2 +0,0 @@
-secret_keys/
-public_keys/

data/examples/taxi_system/Makefile

@@ -1,2 +0,0 @@
-README.md: README.gsl generate_keys.rb broker.rb client.rb start_broker.sh start_clients.sh
-	gsl README

data/examples/taxi_system/README.gsl

@@ -1,115 +0,0 @@
-.output "README.md"
-.template 1
-# Taxi System
-
-Suppose you're running a taxi company. You have a set of taxi drivers
-working for you.  You'd like to connect them to your central server, so they're
-ready to get service requests from customers who'd like to get picked up by a
-taxi from some place X. As soon as a customer sends his service request, the
-central server will send the closest taxi nearby that's available to the
-customer.
-
-Of course you want the communication between the broker and the taxi drivers to
-be secure, meaning you want encryption and authentication.
-
-You also want ping-pong heartbeating, as you want to have confidence you can
-get in touch with your taxi drivers any time you want. And if a service
-request can't be delivered to a particular taxi driver, you wanna know
-immediately.
-
-This solution is implemented using CLIENT/SERVER sockets and the CURVE
-security mechanism.
-
-## Broker
-
-Here's a possible implementation of the broker. What you'll have to provide
-are the environment variables `BROKER_ADDRESS` (the public TCP endpoint),
-`BROKER_CERT` (path to the broker's secret+public keys), and `CLIENT_CERTS`
-(directory to taxi drivers' certificates, public keys only).
-
-After the start, the broker will just start listening for the drivers (CLIENT
-sockets) to connect. After a driver has connected, authenticated, and sent its
-`HELLO` message, the broker answers with a `WELCOME` or `WELCOMEBACK` message,
-depending if the driver was connected before (it might have reconnected and
-been assigned a new routing ID).
-
-The broker will present you with a Pry shell. Right before starting the shell,
-there's a small usage information, but it's not very well visible due to Pry's
-noisy start. It's simple, though. Inside that shell, you can use the method
-`#send_command(driver, command)`. Example:
-
-```
-  pry> send_command("driver1", "foobar")
-```
-
-Depending on whether the driver is connected, it'll send the message or report
-that it cannot do so.
-
-```ruby
-.literal from "broker.rb"
-```
-
-## Client
-
-Here you have to provide the environment variables `BROKER_ADDRESS` (ditto),
-`BROKER_CERT` (public key only), `CLIENT_CERT` (taxi driver's certificate
-containing the secret+public keys).
-
-After connecting to the broker and completing the security handshake, the
-client sends a `HELLO` message, after which it immediately expects some answer
-from the broker (see above). After that, it just listens for messages (service
-requests) and prints them into the terminal.
-
-```ruby
-.literal from "client.rb"
-```
-
-## How to run the example
-
-### Generate broker's and drivers' keys
-
-Here's a simple script that'll create the broker's certificate and the taxi
-drivers' certificates. There are also public key only files so a minimum amount
-of information can be made available on one system, e.g. a taxi driver's system
-must not know the broker's secret key. Also, the broker doesn't necessarily
-need to know the clients' secret keys just to authenticate them.
-
-```ruby
-.literal from "generate_keys.rb"
-
-```
-Run it as follows:
-
-```
-\./generate_keys.rb
-```
-
-### Start broker
-
-Run this:
-
-```
-\./start_broker.sh
-```
-
-which will execute the following script:
-
-```sh
-.literal from "start_broker.sh"
-```
-
-### Start driver software instances
-
-Run this in another terminal:
-
-```
-\./start_clients.sh
-```
-
-which will execute the following script:
-
-```sh
-.literal from "start_clients.sh"
-```
-
-.endtemplate