io_request 2.3.0 → 2.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 39b0e0eb362ea37ce9f2b7359ec439bfc422ca12b2f89ba4483a8cba20c99a2f
-  data.tar.gz: 7c7fc713e6de0386789cabbde9a68183d52c8cba268bce30ca9a76c503cb8f3b
+  metadata.gz: 351ec9fd506f974e564ef51c452e47c6bb4a113022b0ec04e708245cd70fe12c
+  data.tar.gz: 7244b2989c36d827d86ef16aa84920e8f91bae6bf9009f4d503f2aaf6f58f164
 SHA512:
-  metadata.gz: 5473de710bff683d5dc610a8eb43207353853280c5a4d5a81eccefb1cf40ea924811b5cc7ad16b9b155ebc43186a8691a32c0648cd6dc80c1bb44ba697b38507
-  data.tar.gz: 8121c16e2f3e3d1b8776aff30d34415a1d29699d9725208621c5af62b17f2664011cea4a03f7b2de370c676dfd0c3f3ec274de9700ba1980ad4e749864cb5bb6
+  metadata.gz: 549415e26de1d5919b1f97a8cfa289e07b5510ae8d54640079a213d4fa93e395e55a804d019c8342d8a6c97c1ee1d033beea534fb9d33814431a35eb21d72501
+  data.tar.gz: e1f0d467271a09288471cc1c3251fc6719b7d54e2cbe1f50a044cf118616a05bf2c989bc6b6ad5c70d82d71cdb74e8cac452c01be107e9181c3021d06831a2f4

data/lib/io_request.rb

@@ -4,6 +4,12 @@
 module IORequest
   # Client received message of zero size.
   class ZeroSizeMessageError < RuntimeError; end
+
+  # Authorization failed.
+  class AuthorizationFailureError < RuntimeError; end
+
+  # Request timed out.
+  class RequestTimeoutError < RuntimeError; end
 end
 
 require_relative 'io_request/version'

data/lib/io_request/client.rb

@@ -45,15 +45,17 @@ module IORequest
     # @param r [IO] object to read from.
     # @param w [IO] object to write to.
     # @param rw [IO] read-write object (replaces `r` and `w` arguments).
+    # @return [Object] data from {Authorizer}
     def open(read: nil, write: nil, read_write: nil)
       @io_r = read_write || read
       @io_w = read_write || write
 
       IORequest.logger.debug(prog_name) { 'Starting connection' }
 
-      authorization
+      auth_data = authorization
       @open = true
       @data_transition_thread = in_thread(name: 'connection') { data_transition_loop }
+      auth_data
     end
 
     def open?
@@ -75,6 +77,7 @@ module IORequest
     end
     alias respond on_request
 
+    # Code to execute after connection is closed.
     def on_close(&block)
       IORequest.logger.debug(prog_name) { 'Saved on_close block' }
       @on_close = block
@@ -82,17 +85,18 @@ module IORequest
 
     # If callback block is provided, request will be sent asynchroniously.
     # @param data [Hash]
-    def request(data = {}, &callback)
+    # @param timeout [Integer] timeout in seconds.
+    def request(data, timeout: nil, &callback)
       message = Message.new(data, type: :request)
 
       if block_given?
         # Async execution of request
         in_thread(callback, name: 'requesting') do |cb|
-          cb.call(send_request_and_wait_for_response(message).data)
+          cb.call(send_request_and_wait_for_response(message, timeout).data)
         end
         nil
       else
-        send_request_and_wait_for_response(message).data
+        send_request_and_wait_for_response(message, timeout).data
       end
     end
 
@@ -124,18 +128,19 @@ module IORequest
     end
 
     def authorization
-      auth_successful = @mutex_r.synchronize do
+      auth_successful = false
+      data = nil
+      @mutex_r.synchronize do
         @mutex_w.synchronize do
           IORequest.logger.debug(prog_name) { 'Authorizing new client' }
-          @authorizer.authorize(@io_r, @io_w)
+          auth_successful = @authorizer.authorize(@io_r, @io_w)
+          data = @authorizer.data
         end
       end
-      unless auth_successful
-        IORequest.logger.debug(prog_name) { 'Authorization failed' }
-        raise 'Authorization failed'
-      end
+      raise AuthorizationFailureError unless auth_successful
 
-      IORequest.logger.debug(prog_name) { "New client authorized with data #{@authorizer.data}" }
+      IORequest.logger.debug(prog_name) { "New client authorized with data #{data}" }
+      data
     end
 
     def data_transition_loop
@@ -179,7 +184,11 @@ module IORequest
     def send_response(response)
       @mutex_w.synchronize do
         IORequest.logger.debug(prog_name) { "Sending response: #{response}" }
-        response.write_to(@io_w)
+        begin
+          response.write_to(@io_w)
+        rescue IOError => e
+          IORequest.logger.debug(prog_name) { "Failed to write response message: #{e}" }
+        end
       end
     end
 
@@ -192,21 +201,26 @@ module IORequest
       IORequest.logger.debug(prog_name) { "Failed to send zero-sized message(#{e})" }
     end
 
-    def send_request_and_wait_for_response(request)
+    def send_request_and_wait_for_response(request, timeout)
       @mutex_w.synchronize do
         IORequest.logger.debug(prog_name) { "Sending message: #{request}" }
         request.write_to(@io_w)
       end
-      wait_for_response(request)
+      wait_for_response(request, timeout)
     end
 
-    def wait_for_response(request)
+    def wait_for_response(request, timeout)
       IORequest.logger.debug(prog_name) { "Waiting for response for #{request}" }
+      waiting_start_time = Time.now
       @responses_access_mutex.synchronize do
         response = nil
         until response
-          @responses_access_cv.wait(@responses_access_mutex)
-          response = @responses[request.id.to_s]
+          @responses_access_cv.wait(@responses_access_mutex, 1)
+          if @responses_access_mutex.owned?
+            # NOTE: Only accessing responses hash if thread owns access mutex
+            response = @responses.delete(request.id.to_s)
+          end
+          raise RequestTimeoutError if timeout && (Time.now - waiting_start_time >= timeout)
         end
         IORequest.logger.debug(prog_name) { "Found response: #{response}" }
         response

data/lib/io_request/connection/ssl_sockets.rb

@@ -32,11 +32,20 @@ module IORequest
       end
 
       # @return [Array<IORequest::Client>]
-      attr_reader :clients
+      def clients
+        @clients_data.keys
+      end
+
+      # @param client [IORequest::Client]
+      # @return [Hash, nil] you are free to store anything you want in hash.
+      #   Only field you will find in it is `auth` with authenticator data.
+      def data(client)
+        @clients_data[client]
+      end
 
       # Start server.
       def start
-        @clients = []
+        @clients_data = {}
 
         @server = TCPServer.new(@port)
 
@@ -45,8 +54,8 @@ module IORequest
 
       # Fully stop server.
       def stop
-        @clients.each(&:close)
-        @clients = []
+        clients.each(&:close)
+        @clients_data.clear
 
         @server.close
         @server = nil
@@ -68,7 +77,7 @@ module IORequest
         while (socket = @server.accept)
           handle_socket(socket)
         end
-      rescue
+      rescue StandardError
         stop
       end
 
@@ -76,20 +85,21 @@ module IORequest
         ssl_socket = OpenSSL::SSL::SSLSocket.new(socket, @ctx)
         ssl_socket.accept
 
-        client = IORequest::Client.new authorizer: @authorizer
-        begin
-          client.open read_write: ssl_socket
-          client.on_request { |data| @requests_handler.call(data, client) }
-          @clients << client
-          client.on_close do
-            @clients.select!(&:open?)
-          end
-        rescue StandardError
-          IORequest.debug "Failed to open client: #{e}"
-          ssl_socket.close
+        handle_client(ssl_socket, IORequest::Client.new(authorizer: @authorizer))
+      rescue StandardError => e
+        IORequest.logger.warn "Unknown error while handling sockets: #{e}"
+      end
+
+      def handle_client(ssl_socket, client)
+        auth_data = client.open read_write: ssl_socket
+        client.on_request { |data| @requests_handler.call(data, client) }
+        @clients_data[client] = { auth: auth_data }
+        client.on_close do
+          @clients_data.select! { |c, _d| c.open? }
         end
       rescue StandardError => e
-        IORequest.warn "Unknown error while handling sockets: #{e}"
+        IORequest.logger.debug "Failed to open client: #{e}"
+        ssl_socket.close
       end
     end
 
@@ -108,9 +118,15 @@ module IORequest
         @authorizer = authorizer
         @requests_handler = requests_handler
 
+        @client = nil
+
         initialize_ssl_context(certificate, key)
       end
 
+      def connected?
+        !@client.nil?
+      end
+
       # Connect to server.
       # @param host [String] host of server.
       # @param port [Integer] port of server.
@@ -125,6 +141,9 @@ module IORequest
         begin
           @client.open read_write: ssl_socket
           @client.on_request(&@requests_handler)
+          @client.on_close do
+            @client = nil
+          end
         rescue StandardError
           ssl_socket.close
           @client = nil

data/lib/io_request/version.rb

@@ -2,5 +2,5 @@
 
 module IORequest
   # Gem version.
-  VERSION = '2.3.0'
+  VERSION = '2.5.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: io_request
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.5.1
 platform: ruby
 authors:
 - Fizvlad
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-19 00:00:00.000000000 Z
+date: 2020-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler