cztop 1.0.0 → 1.1.0.pre1

data/lib/cztop/z85/pipe.rb

@@ -1,18 +1,22 @@
+# frozen_string_literal: true
+
 # Can be used if you want to encode or decode data from one IO to another.
 # It'll do so until it hits EOF in the source IO.
 class CZTop::Z85::Pipe
+
   # @param source [IO] where to read data
   # @param sink [IO] where to write data
   # @param strategy [Strategy] algorithm to use (pass the class itself,
   #   not an instance)
   def initialize(source, sink, strategy: Strategy::Parallel)
-    @source, @sink = source, sink
-    @strategy = strategy
+    @source    = source
+    @sink      = sink
+    @strategy  = strategy
     @bin_bytes = 0 # processed binary data (non-Z85)
   end
 
   # @return [Integer] size of chunks read when encoding
-  ENCODE_READ_SZ = (32 * 2**10) # 32 KiB (for full chunks read)
+  ENCODE_READ_SZ = (32 * (2**10)) # 32 KiB (for full chunks read)
 
   # @return [Integer] size of chunks read when decoding
   DECODE_READ_SZ = ENCODE_READ_SZ / 4 * 5
@@ -29,14 +33,15 @@ class CZTop::Z85::Pipe
       elsif prev_chunk && chunk.nil? # last chunk
         CZTop::Z85::Padded.encode(prev_chunk)
       elsif prev_chunk.nil? && chunk.nil?
-        CZTop::Z85.encode("") # empty input
+        CZTop::Z85.encode('') # empty input
       else
-        "" # very first chunk. don't encode anything yet...
+        '' # very first chunk. don't encode anything yet...
       end
     end.execute
-    return @bin_bytes
+    @bin_bytes
   end
 
+
   # Decodes Z85 data from source and writes decoded data to sink. This is
   # done until EOF is hit on the source.
   #
@@ -48,19 +53,21 @@ class CZTop::Z85::Pipe
       elsif prev_chunk && chunk.nil?
         CZTop::Z85::Padded.decode(prev_chunk)
       elsif prev_chunk.nil? && chunk.nil?
-        CZTop::Z85.decode("") # empty input
+        CZTop::Z85.decode('') # empty input
       else
-        "" # very first chunk. don't decode anything yet...
+        '' # very first chunk. don't decode anything yet...
       end
     end.execute
-    return @bin_bytes
+    @bin_bytes
   end
 
+
   # @abstract
   # Different encoding/decoding strategies (algorithms).
   #
   # This is mainly just for me to practice the GoF Strategy Pattern.
   class Strategy
+
     # @param source [IO] the source
     # @param sink [IO] the sink
     # @param read_sz [Integer] chunk size when reading from source
@@ -71,33 +78,41 @@ class CZTop::Z85::Pipe
     #   the first time)
     # @yieldreturn [String] encoded/decoded chunk to write to sink
     def initialize(source, sink, read_sz, &xcode)
-      @source = source
-      @sink = sink
+      @source  = source
+      @sink    = sink
       @read_sz = read_sz
-      @xcode = xcode
+      @xcode   = xcode
     end
 
+
     # @abstract
     # Runs the algorithm.
     # @raise [void]
-    def execute() raise NotImplementedError end
+    def execute
+      raise NotImplementedError
+    end
+
 
     # A single thread that is either reading input, encoding/decoding, or
     # writing output.
     class Sequential < Strategy
+
       # Runs the algorithm.
       # @raise [void]
       def execute
         previous_chunk = nil
         while true
           chunk = @source.read(@read_sz)
-          @sink << @xcode.(chunk, previous_chunk)
+          @sink << @xcode.call(chunk, previous_chunk)
           break if chunk.nil?
+
           previous_chunk = chunk
         end
       end
+
     end
 
+
     # Uses three threads:
     #
     # 1. reads from source
@@ -108,6 +123,7 @@ class CZTop::Z85::Pipe
     # platforms such as Rubinius and JRuby (and multiple CPU cores).
     #
     class Parallel < Strategy
+
       # Initializes the 2 sized queues used.
       def initialize(*)
         super
@@ -126,6 +142,7 @@ class CZTop::Z85::Pipe
         # @sink
       end
 
+
       # Runs the algorithm.
       # @raise [void]
       def execute
@@ -140,12 +157,13 @@ class CZTop::Z85::Pipe
       # pushes a +nil+ into the queue.
       # @return [void]
       def read
-        while chunk = @source.read(@read_sz)
+        while (chunk = @source.read(@read_sz))
           @source_queue << chunk
         end
         @source_queue << nil
       end
 
+
       # Pops all chunks from the source queue, encodes or decodes them,
       # and pushes the result into the sink queue. Then pushes a +nil+
       # into the queue.
@@ -157,21 +175,26 @@ class CZTop::Z85::Pipe
           chunk = @source_queue.pop
 
           # call @xcode for the trailing nil-chunk as well
-          @sink_queue << @xcode.(chunk, previous_chunk)
+          @sink_queue << @xcode.call(chunk, previous_chunk)
 
           break if chunk.nil?
+
           previous_chunk = chunk
         end
         @sink_queue << nil
       end
 
+
       # Pops all chunks from the sink queue and writes them to the sink.
       # @return [void]
       def write
-        while chunk = @sink_queue.pop
+        while (chunk = @sink_queue.pop)
           @sink << chunk
         end
       end
+
     end
+
   end
+
 end

data/lib/cztop/z85.rb

@@ -1,13 +1,17 @@
+# frozen_string_literal: true
+
 module CZTop
   # Represents a CZMQ::FFI::Zarmour in Z85 mode.
   #
   # Use this class to encode to and from the Z85 encoding scheme.
   # @see http://rfc.zeromq.org/spec:32
   class Z85
+
     include HasFFIDelegate
     extend CZTop::HasFFIDelegate::ClassMethods
 
     class << self
+
       # Same as {Z85#encode}, but without the need to create an instance
       # first.
       #
@@ -20,6 +24,7 @@ module CZTop
         default.encode(input)
       end
 
+
       # Same as {Z85#decode}, but without the need to create an instance
       # first.
       #
@@ -39,6 +44,7 @@ module CZTop
       def default
         @default ||= Z85.new
       end
+
     end
 
     def initialize
@@ -46,6 +52,7 @@ module CZTop
       ffi_delegate.set_mode(CZMQ::FFI::Zarmour::MODE_Z85)
     end
 
+
     # Encodes to Z85.
     # @param input [String] possibly binary input data
     # @return [String] Z85 encoded data as ASCII string
@@ -53,15 +60,17 @@ module CZTop
     #   remainder
     # @raise [SystemCallError] if this fails
     def encode(input)
-      raise ArgumentError, "wrong input length" if input.bytesize % 4 > 0
+      raise ArgumentError, 'wrong input length' if (input.bytesize % 4).positive?
+
       input = input.dup.force_encoding(Encoding::BINARY)
-      ptr = ffi_delegate.encode(input, input.bytesize)
+      ptr   = ffi_delegate.encode(input, input.bytesize)
       raise_zmq_err if ptr.null?
       z85 = ptr.read_string
       z85.encode!(Encoding::ASCII)
-      return z85
+      z85
     end
 
+
     # Decodes from Z85.
     # @param input [String] Z85 encoded data
     # @return [String] original data as binary string
@@ -69,11 +78,13 @@ module CZTop
     #   remainder
     # @raise [SystemCallError] if this fails
     def decode(input)
-      raise ArgumentError, "wrong input length" if input.bytesize % 5 > 0
+      return '' if input.empty?
+      raise ArgumentError, 'wrong input length' if (input.bytesize % 5).positive?
+
       zchunk = ffi_delegate.decode(input)
       raise_zmq_err if zchunk.null?
-      decoded_string = zchunk.data.read_string(zchunk.size - 1)
-      return decoded_string
+      zchunk.data.read_string(zchunk.size - 1)
     end
+
   end
 end

data/lib/cztop/zap.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module CZTop
   # This module provides two classes useful when implementing your own ZAP
   # authentication handler or when directly communicating with one. Within
@@ -12,51 +14,58 @@ module CZTop
   # @note This is not needed to be able to use {CZTop::Authenticator}!
   # @see https://rfc.zeromq.org/spec:27/ZAP
   module ZAP
+
     # the endpoint a ZAP authenticator has bound to
-    ENDPOINT = "inproc://zeromq.zap.01"
+    ENDPOINT = 'inproc://zeromq.zap.01'
 
     # the ZAP version supported by this code
-    VERSION = "1.0"
+    VERSION = '1.0'
 
     # superclass for ZAP errors
     class Error < StandardError
     end
 
+
     # used when the response contains an unsupported version
     class VersionMismatch < Error
     end
 
+
     # security mechanisms mentioned in ZeroMQ RFC 27.
     module Mechanisms
-      NULL = "NULL"
-      PLAIN = "PLAIN"
-      CURVE = "CURVE"
+
+      NULL  = 'NULL'
+      PLAIN = 'PLAIN'
+      CURVE = 'CURVE'
+
     end
 
+
     # Represents a ZAP request.
     class Request
+
       # Crafts a new {Request} from a message.
       #
       # @param msg [CZTop::message] the message
       # @return [Request] the request
       # @raise [VersionMismatch] if the message contains an unsupported version
       def self.from_message(msg)
-          version,       # The version frame, which SHALL contain the three octets "1.0".
-          request_id,    # The request id, which MAY contain an opaque binary blob.
-          domain,        # The domain, which SHALL contain a string.
-          address,       # The address, the origin network IP address.
-          identity,      # The identity, the connection Identity, if any.
-          mechanism,     # The mechanism, which SHALL contain a string.
-          *credentials = # The credentials, which SHALL be zero or more opaque frames.
-            msg.to_a
+        version,       # The version frame, which SHALL contain the three octets "1.0".
+        request_id,    # The request id, which MAY contain an opaque binary blob.
+        domain,        # The domain, which SHALL contain a string.
+        address,       # The address, the origin network IP address.
+        identity,      # The identity, the connection Identity, if any.
+        mechanism,     # The mechanism, which SHALL contain a string.
+        *credentials = # The credentials, which SHALL be zero or more opaque frames.
+          msg.to_a
 
         raise VersionMismatch if version != VERSION
 
         new(domain, credentials, mechanism: mechanism).tap do |r|
-          r.version = version
+          r.version    = version
           r.request_id = request_id
-          r.address = address
-          r.identity = identity
+          r.address    = address
+          r.identity   = identity
         end
       end
 
@@ -89,22 +98,25 @@ module CZTop
       # @param credentials [Array<String>] the credentials of the user,
       #   depending on the security mechanism used
       def initialize(domain, credentials = [], mechanism: Mechanisms::CURVE)
-        @domain = domain
+        @domain      = domain
         @credentials = credentials
-        @mechanism = mechanism
-        @version = VERSION
+        @mechanism   = mechanism
+        @version     = VERSION
       end
 
+
       # Creates a sendable message from this {Request}.
       # @return [CZTop::Message} this request packed into a message
       def to_msg
-        fields = [ @version, @request_id, @domain, @address,
-          @identity, @mechanism, @credentials].flatten.map(&:to_s)
+        fields = [@version, @request_id, @domain, @address,
+                  @identity, @mechanism, @credentials].flatten.map(&:to_s)
 
         CZTop::Message.new(fields)
       end
+
     end
 
+
     # Represents a ZAP response.
     class Response
 
@@ -112,23 +124,27 @@ module CZTop
       class TemporaryError < Error
       end
 
+
       # used to indicate an internal error of the authenticator
       class InternalError < Error
       end
 
+
       # Status codes of ZAP responses.
       module StatusCodes
-        SUCCESS = "200"
-        TEMPORARY_ERROR = "300"
-        AUTHENTICATION_FAILURE = "400"
-        INTERNAL_ERROR = "500"
+
+        SUCCESS                = '200'
+        TEMPORARY_ERROR        = '300'
+        AUTHENTICATION_FAILURE = '400'
+        INTERNAL_ERROR         = '500'
 
         ALL = [
           SUCCESS,
           TEMPORARY_ERROR,
           AUTHENTICATION_FAILURE,
           INTERNAL_ERROR
-        ]
+        ].freeze
+
       end
 
       include StatusCodes
@@ -160,16 +176,16 @@ module CZTop
         when INTERNAL_ERROR
           raise InternalError, status_text
         else
-          raise InternalError, "invalid status code"
+          raise InternalError, 'invalid status code'
         end
 
         new(status_code).tap do |r|
-          r.version = version
-          r.request_id = request_id
+          r.version     = version
+          r.request_id  = request_id
           r.status_code = status_code
           r.status_text = status_text
-          r.user_id = user_id
-          r.meta_data = meta_data
+          r.user_id     = user_id
+          r.meta_data   = meta_data
         end
       end
 
@@ -198,30 +214,37 @@ module CZTop
       def initialize(status_code)
         @status_code = status_code.to_s
         raise ArgumentError unless ALL.include?(@status_code)
-        @version = VERSION
+
+        @version     = VERSION
       end
 
+
       # @return [Boolean] whether the authentication was successful
       def success?
         @status_code == SUCCESS
       end
 
+
       # Returns the user ID, if authentication was successful.
       # @return [String] the user ID of the authenticated user
       # @return [nil] if authentication was unsuccessful
       def user_id
         return nil unless success?
+
         @user_id
       end
 
+
       # Returns the meta data, if authentication was successful.
       # @return [String] the meta data for the authenticated user
       # @return [nil] if authentication was unsuccessful
       def meta_data
         return nil unless success?
+
         @meta_data
       end
 
+
       # Creates a sendable message from this {Response}.
       # @return [CZTop::Message} this request packed into a message
       def to_msg
@@ -229,6 +252,8 @@ module CZTop
                   @status_text, @user_id, @meta_data].map(&:to_s)
         CZTop::Message.new(fields)
       end
+
     end
+
   end
 end