io_request 1.2.0 → 2.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5bc70dc523aa523749a9ff7ced4fb1e59243a70ab963026b76c0feada184adad
-  data.tar.gz: fd2d048ddf79f0102bbc39ab72ad98529b090d40a2f681b72bb14d2149bea241
+  metadata.gz: e57d41dbda1d6665dd595e36da99ce52b60fd2d979957583570224e752b6e8ae
+  data.tar.gz: eb50b39358a127a3b6b231d37606a4835b92030b682987bdd6f5a973d3c5b8bd
 SHA512:
-  metadata.gz: 4e348c7d960286264707730c07f46ed6de58edd8b27653271aa4b76f87718c1ca623364299a409d4179c71083158c076d9658dcfe7a7f1ef6b62610eae797da3
-  data.tar.gz: 5d01d75cfdd3eea6b39b1e1a74556bd260ded06d699f72cbe22f1812d5680a3d4621170116d2bfc7700d0c6a8793c1e34959dd039fd2bb94566abae439816950
+  metadata.gz: d9680f420318ec5d177ada3d79cccd5bab722e1993f541e802d877603bfa9011fb22cd0df5b9f01602a7a4ba54131203d1f2a7645950cdc4ef0adc151fb85c15
+  data.tar.gz: 92ea531ada90eda834b847d86009c4ede9594185540acbe7f76a65d0f579b62ff739b9a5ef01acc3d3b08657b97a7ab3a8e36c0dacc90024bd60c53c53b85866

data/.gitignore

@@ -1,8 +1,10 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+Gemfile.lock

data/.rubocop.yml

@@ -0,0 +1,37 @@
+inherit_from: .rubocop_todo.yml
+
+require:
+  - rubocop-performance
+
+AllCops:
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+  ExtraDetails: false
+  TargetRubyVersion: 2.6
+  Exclude:
+    - config/**/*
+    - tmp/**/*
+    - Capfile
+    - Gemfile
+    - Rakefile
+
+# EOL is handled by git settings
+Layout/EndOfLine:
+  Enabled: false
+
+# Just enough
+Layout/LineLength:
+  Max: 100
+
+# Disable some common cops for tests
+Style/Documentation:
+  Exclude:
+    - test/**/*
+Metrics/AbcSize:
+  Exclude:
+    - test/**/*
+Metrics/MethodLength:
+  Max: 15 # Extended limit of lines in method
+  Exclude:
+    - test/**/*
+

data/.rubocop_todo.yml

@@ -0,0 +1,7 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2020-07-15 18:13:41 UTC using RuboCop version 0.88.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.

data/Gemfile

@@ -1,4 +1,17 @@
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in io_request.gemspec
-gemspec
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in io_request.gemspec
+gemspec
+
+gem 'rubocop', '~> 0.88.0', group: :development
+gem 'rubocop-performance', '~> 1.6', group: :development, require: false
+
+gem 'json', '~> 2.3'
+
+gem 'timeout', '~> 0.1.0'
+
+gem 'logger', '~> 1.4'
+
+gem 'openssl', '~> 2.2'
+
+gem 'pry', '~> 0.13.1'

data/README.md

@@ -1,39 +1,31 @@
-# IORequest
-
-Small gem to create JSON request/response type of connection over IO object
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'io_request'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install io_request
-
-## Usage
-
-Documentation is available at https://www.rubydoc.info/gems/io_request
-
-Some examples could be find in *examples* folder.
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/fizvlad/io-request-rb.
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+# IORequest
+
+Small gem to create JSON request/response type of connection over different IO objects.
+
+## Installation
+
+Using [bundler](https://bundler.io/):
+
+```
+$ bundle add io_request
+```
+
+## Usage
+
+Documentation is available at https://www.rubydoc.info/gems/io_request
+
+Some examples could be find in *examples* folder.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/fizvlad/io-request-rb.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,10 +1,31 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/*_test.rb"]
-end
-
-task :default => :test
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new(:rubocop) {}
+namespace 'rubocop' do
+  desc 'Generate rubocop TODO file.'
+  task 'todo' do
+    puts `rubocop --auto-gen-config`
+  end
+end
+
+namespace 'yardoc' do
+  desc 'Generate documentation'
+  task 'generate' do
+    puts `yardoc lib/*`
+  end
+
+  desc 'List undocumented elements'
+  task 'undoc' do
+    puts `yardoc stats --list-undoc lib/*`
+  end
+end
+
+task :default => :test

data/bin/console

@@ -1,14 +1,8 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "io_request"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'io_request'
+
+require 'pry'
+Pry.start(__FILE__)

data/io_request.gemspec

@@ -1,37 +1,39 @@
-lib = File.expand_path("lib", __dir__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "io_request/version"
+require 'io_request/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "io_request"
+  spec.name          = 'io_request'
   spec.version       = IORequest::VERSION
-  spec.authors       = ["Fizvlad"]
-  spec.email         = ["fizvlad@mail.ru"]
+  spec.authors       = ['Fizvlad']
+  spec.email         = ['fizvlad@mail.ru']
 
-  spec.summary       = "Small gem to create JSON request/response type of connection over IO object"
-  spec.homepage      = "https://github.com/fizvlad/io-request-rb"
-  spec.license       = "MIT"
+  spec.summary       = 'Small gem to create JSON request/response type of connection over IO object'
+  spec.homepage      = 'https://github.com/fizvlad/io-request-rb'
+  spec.license       = 'MIT'
 
-  spec.required_ruby_version = ">=2.3.1"
+  spec.required_ruby_version = '>=2.6.5'
 
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/fizvlad/io-request-rb"
-  spec.metadata["changelog_uri"] = "https://github.com/fizvlad/io-request-rb/releases"
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/fizvlad/io-request-rb'
+  spec.metadata['changelog_uri'] = 'https://github.com/fizvlad/io-request-rb/releases'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 13.0"
-  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
 
-  spec.add_runtime_dependency "logger", "~>1.4"
-  spec.add_runtime_dependency "timeout-extensions", "~>0.1.1"
-  spec.add_runtime_dependency "json", "~>2.0"
+  spec.add_runtime_dependency 'json', '~>2.0'
+  spec.add_runtime_dependency 'logger', '~>1.4'
+  spec.add_runtime_dependency 'timeout-extensions', '~>0.1.1'
 end

data/lib/io_request.rb

@@ -1,8 +1,20 @@
-require_relative "io_request/version"
-require_relative "io_request/utility"
-require_relative "io_request/logging"
-require_relative "io_request/message"
-require_relative "io_request/client"
-
-# Main module.
-module IORequest; end
+# frozen_string_literal: true
+
+# Main module.
+module IORequest
+  # Client received message of zero size.
+  class ZeroSizeMessageError < RuntimeError; end
+
+  # Authorization failed.
+  class AuthorizationFailureError < RuntimeError; end
+end
+
+require_relative 'io_request/version'
+require_relative 'io_request/logging'
+require_relative 'io_request/utility/multi_thread'
+require_relative 'io_request/utility/with_id'
+require_relative 'io_request/utility/with_prog_name'
+
+require_relative 'io_request/authorizer'
+require_relative 'io_request/message'
+require_relative 'io_request/client'

data/lib/io_request/authorizer.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module IORequest
+  # Class to authorize client connection.
+  class Authorizer
+    # @yieldparam io_r [IO] input stream.
+    # @yieldparam io_w [IO] output stream.
+    # @yieldreturn [Object, nil] if `nil` is returned, authorization will be
+    #   considered as failed one. Otherwise data will be saved into `data`.
+    def initialize(&block)
+      @block = block
+      @data = nil
+    end
+
+    # @return [Object] literally any non-nil data from block.
+    attr_reader :data
+
+    # @return [Boolean] authorization status.
+    def authorize(io_r, io_w)
+      @data = nil
+      @data = @block.call(io_r, io_w)
+      !@data.nil?
+    rescue StandardError => e
+      IORequest.logger.error(e.full_message)
+      false
+    end
+  end
+
+  # No authorization.
+  def Authorizer.empty
+    Authorizer.new { |_io_r, _io_w| true }
+  end
+
+  # Secret key authorization.
+  def Authorizer.by_secret_key(key)
+    Authorizer.new do |io_r, io_w|
+      io_w.write(key)
+      other = io_r.read(key.size)
+      key == other ? other : nil
+    end
+  end
+end

data/lib/io_request/client.rb

@@ -1,193 +1,213 @@
-require "base64"
-require "timeout"
-require "json"
+# frozen_string_literal: true
+
+require 'timeout'
+require 'json'
 
 module IORequest
   # Connection client.
+  #
+  # General scheme:
+  #  Client 1                 Client 2
+  #     |                        |
+  #   (        Authorization       )  See `Authorizer` class. Error in authorization should close
+  #     |                        |    connection
+  #     |                        |
+  #   [    Data transition loop    ]  Loop runs until someone sends 0 sized data. Then everyone
+  #     |                        |    should close connection. Any R/W errors should also finish the
+  #     |                        |    loop
+  #     |                        |
+  #     |-> uint(2 bytes)      ->|    Specifies size of following JSON string
+  #     |-> Mesage as JSON     ->|    Message itself. It should contain its `type`, `id` and some
+  #     |                        |    data hash
+  #     |                        |
+  #     |               (Message handling) See `Handler` class
+  #     |                        |
+  #     |<- uint(2 bytes)      <-|
+  #     |<- Mesage as JSON     <-|
   class Client
     include Utility::WithProgName
     include Utility::MultiThread
 
-    # Initialize new client over IO.
-    #
-    # @option options [:gets] read IO to read from.
-    # @option options [:puts] write IO to write to.
-    def initialize(read: nil, write: nil)
-      @io_r = read
-      @io_w = write
-
-      @mutex = Mutex.new
-      @responders = [] # Array of pairs [Subhash, Block]
-      @out_requests = {} # Request => Proc
-
-      @receive_thread = Thread.new { receive_loop }
-      IORequest.debug("New IORequest client initialized", prog_name)
-    end
-
-    # Send request.
-    #
-    # Optional block can be provided. It will be called when response received.
-    #
-    # @option options [Hash] data data to send.
-    # @option options [Boolean] sync whether to join request after sending.
-    # @option options [Integer, Float] timeout timeout for {Request#join}.
-    #
-    # @yieldparam request [Response] response for request.
-    #
-    # @return [Request]
-    def request(data: {}, sync: false, timeout: nil, &block)
-      req = Request.new(data)
-      @out_requests[req] = block
-      IORequest.debug("Sending request ##{req.id}", prog_name)
-      send(req.to_hash)
-      req.join(timeout) if sync
-      req
-    end
-
-    # Setup block for answering incoming requests.
-    #
-    # @param subdata [Hash] provided block will be called only if received data
-    #   includes this hash.
-    #
-    # @yieldparam request [Request] incoming request.
-    # @yieldreturn [Hash] data to be sent in response.
-    #
-    # @return [nil]
-    def respond(subdata = {}, &block)
-      @responders << [subdata, block]
-      nil
+    # Initialize new client.
+    def initialize(authorizer: Authorizer.empty)
+      @open = false
+      @authorizer = authorizer
+
+      @mutex_r = Mutex.new
+      @mutex_w = Mutex.new
+
+      @responses = {}
+      @responses_access_mutex = Mutex.new
+      @responses_access_cv = ConditionVariable.new
     end
 
-    private
+    # Start new client connection.
+    # @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).
+    def open(read: nil, write: nil, read_write: nil)
+      @io_r = read_write || read
+      @io_w = read_write || write
 
-    # Starts receiving loop and freezes thread.
-    def receive_loop
-      loop do
-        h = receive(nil)
-        break if h.nil?
-        case h[:type]
-          when "request"
-            handle_in_request(Request.from_hash h)
-          when "response"
-            handle_in_response(Response.from_hash h)
-          else
-            IORequest.warn("Unknown message type: #{h[:type].inspect}", prog_name)
-        end
-      end
-      IORequest.debug("Receive loop exited", prog_name)
-    end
-    # Handle incoming request.
-    def handle_in_request(req)
-      IORequest.debug("Handling request ##{req.id}", prog_name)
-      in_thread(name: "request_handler") do
-        responder = find_responder(req)
-        data = nil
-        data = begin
-          if responder
-            responder.call(req, self)
-          else
-            IORequest.warn "Responder not found!"
-            nil
-          end
-        rescue Exception => e
-          IORequest.warn "Provided block raised exception:\n#{e.full_message}", prog_name
-          nil
+      IORequest.logger.debug(prog_name) { 'Starting connection' }
+
+      authorization
+      @open = true
+      @data_transition_thread = in_thread(name: 'connection') { data_transition_loop }
+    end
+
+    def open?
+      @open
+    end
+
+    # Close connection.
+    def close
+      close_internal
+
+      join_threads
+    end
+
+    # @yieldparam [Hash]
+    # @yieldreturn [Hash]
+    def on_request(&block)
+      IORequest.logger.debug(prog_name) { 'Saved on_request block' }
+      @on_request = block
+    end
+    alias respond on_request
+
+    def on_close(&block)
+      IORequest.logger.debug(prog_name) { 'Saved on_close block' }
+      @on_close = block
+    end
+
+    # If callback block is provided, request will be sent asynchroniously.
+    # @param data [Hash]
+    def request(data = {}, &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)
         end
-        data ||= {}
-        res = Response.new(data, req)
-        send(res.to_hash)
+        nil
+      else
+        send_request_and_wait_for_response(message).data
       end
-      nil
-    end
-    # Handle incoming response.
-    def handle_in_response(res)
-      req_id = res.request.to_i
-      req = @out_requests.keys.find { |r| r.id == req_id }
-      unless req
-        IORequest.warn("Request ##{req_id} not found", prog_name)
-        return
+    end
+
+    attr_reader :authorizer
+
+    private
+
+    def close_internal
+      IORequest.logger.debug(prog_name) { 'Closing connection' }
+      send_zero_size_request
+      close_io
+      @data_transition_thread = nil
+      @open = false
+      @on_close&.call if defined?(@on_close)
+    end
+
+    def close_io
+      begin
+        @io_r&.close
+      rescue StandardError => e
+        IORequest.logger.debug "Failed to close read IO: #{e}"
       end
-      IORequest.debug("Request ##{req_id} response received", prog_name)
-      req.response = res
-      # If block is not provided it's totally ok
-      block = @out_requests.delete(req)
-      if block
-        in_thread(name: "response_handle") do
-          begin
-            block.call(res)
-          rescue Exception => e
-            IORequest.warn("Provided block raised exception:\n#{e.full_message}", prog_name)
-          end
-        end
+      begin
+        @io_w&.close
+      rescue StandardError => e
+        IORequest.logger.debug "Failed to close write IO: #{e}"
       end
+      IORequest.logger.debug(prog_name) { 'Closed IO streams' }
     end
 
-    # find responder for provided request.
-    def find_responder(req)
-      result = nil
-      @responders.each do |subdata, block|
-        if req.data.contains? subdata
-          result = block
-          break
+    def authorization
+      auth_successful = @mutex_r.synchronize do
+        @mutex_w.synchronize do
+          IORequest.logger.debug(prog_name) { 'Authorizing new client' }
+          @authorizer.authorize(@io_r, @io_w)
         end
       end
+      raise AuthorizationFailureError unless auth_successful
 
-      result
+      IORequest.logger.debug(prog_name) { "New client authorized with data #{@authorizer.data}" }
     end
 
-    # Send data.
-    #
-    # @param [Hash]
-    def send(data)
-      IORequest.debug("Sending hash: #{data.inspect}", prog_name)
-      send_raw(encode(data_to_string data))
+    def data_transition_loop
+      IORequest.logger.debug(prog_name) { 'Starting data transition loop' }
+      loop do
+        data_transition_iteration
+      rescue ZeroSizeMessageError
+        IORequest.logger.debug(prog_name) { 'Connection was closed from the other side' }
+        break
+      rescue StandardError => e
+        IORequest.logger.debug(prog_name) { "Data transition unknown error: #{e}" }
+        break
+      end
+      close_internal
     end
 
-    # Receive data.
-    #
-    # @param timeout [Integer, Float, nil] timeout size or +nil+ if no timeout required.
-    #
-    # @return [Hash, nil] hash or +nil+ if timed out or IO was closed.
-    def receive(timeout)
-      str = Timeout::timeout(timeout) do
-        receive_raw
+    def data_transition_iteration
+      message = @mutex_r.synchronize { Message.read_from(@io_r) }
+      IORequest.logger.debug(prog_name) { "Received message: #{message}" }
+      if message.request?
+        in_thread(name: 'responding') { handle_request(message) }
+      else
+        handle_response(message)
       end
-      return nil if str.nil?
-      string_to_data(decode(str))
-    rescue Timeout::Error
-      nil
-    rescue IOError
-      nil
-    rescue Exception => e
-      IORequest.warn "Exception of #{e.class} encountered while trying to receive message. Suggesting IO was closed. Full trace: #{e.full_message}", prog_name
-      nil
     end
 
-    # Send string.
-    def send_raw(str)
-      @io_w.puts str
+    def handle_request(message)
+      data = {}
+      data = @on_request&.call(message.data) if defined?(@on_request)
+      response = Message.new(data, type: :response, to: message.id)
+      send_response(response)
     end
-    # Receive string.
-    def receive_raw
-      @io_r.gets&.chomp
+
+    def handle_response(message)
+      @responses_access_mutex.synchronize do
+        @responses[message.to.to_s] = message
+        @responses_access_cv.broadcast
+      end
     end
 
-    # Encode string
-    def encode(str)
-      Base64::strict_encode64 str
+    def send_response(response)
+      @mutex_w.synchronize do
+        IORequest.logger.debug(prog_name) { "Sending response: #{response}" }
+        response.write_to(@io_w)
+      end
     end
-    # Decode string
-    def decode(str)
-      Base64::strict_decode64 str
+
+    def send_zero_size_request
+      @mutex_w.synchronize do
+        IORequest.logger.debug(prog_name) { 'Sending zero size message' }
+        @io_w.write([0].pack('S'))
+      end
+    rescue StandardError => e
+      IORequest.logger.debug(prog_name) { "Failed to send zero-sized message(#{e})" }
     end
 
-    # Turn data into string
-    def data_to_string(data)
-      JSON.generate(data)
+    def send_request_and_wait_for_response(request)
+      @mutex_w.synchronize do
+        IORequest.logger.debug(prog_name) { "Sending message: #{request}" }
+        request.write_to(@io_w)
+      end
+      wait_for_response(request)
     end
-    # Turn string into data
-    def string_to_data(str)
-      JSON.parse(str).symbolize_keys!
+
+    def wait_for_response(request)
+      IORequest.logger.debug(prog_name) { "Waiting for response for #{request}" }
+      @responses_access_mutex.synchronize do
+        response = nil
+        until response
+          @responses_access_cv.wait(@responses_access_mutex)
+          response = @responses[request.id.to_s]
+        end
+        IORequest.logger.debug(prog_name) { "Found response: #{response}" }
+        response
+      end
     end
   end
 end