jrpc 1.1.7 → 1.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 67534bff4d06dfed8a49ddf71bb56356d65f9c119731b220e6490394a187f720
-  data.tar.gz: fd53da1804ddc60f54d549811b7d866541601dc4b3f58dc15de2a112c10039cf
+  metadata.gz: e116c8eef34ce5bd8a4ced0e2e693ad37df69895e67c3d28d68537c60711d012
+  data.tar.gz: 8a60df19ba2676a28c03925d0be33b8cda720f9da147e4854a87cba9f25dd251
 SHA512:
-  metadata.gz: c99a86b3b5a59ff431d5356604d4cfcd1803212a8e3be22819de4bbab9d826d985a47bec9fed72cc82f8adfa80f208b1823ab85566325fe3f7965db52d631911
-  data.tar.gz: d565e6cf0cd0afa20b935d1ca6e554d2aa6142dd46bfbefd1468f4910175f326656a6015fae7a160ef5ad8da41574e0c8c9d000ea8d624e5e989e5f8683ca262
+  metadata.gz: 10a940570df20f1246c61c6df6d2c950e9acf5e16e397727c6693822f121bfeff14409529b732e385f2f8806ed9c26d32ddcd9c545406ab54c3b26b5e9ee6db2
+  data.tar.gz: e79fc4f45058b4aa8570928866d97fb9e473b805fbc2c730879d0d6478824e91c9a37728900fde9e827a58753978b3b9468dd03d145d6c2cd09310bafceb49e8

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+.rake_tasks~

data/CHANGELOG.md

@@ -0,0 +1,39 @@
+# Changelog
+
+### Unreleased
+
+### 1.1.8
+* handling FIN signal for TCP socket [didww/jrpc#19](https://github.com/didww/jrpc/pull/19)
+* add gem executables [didww/jrpc#19](https://github.com/didww/jrpc/pull/19)
+
+### 1.1.7
+* connect ot socket in nonblock mode
+
+### 1.1.6
+* update oj version to ~> 3.0
+
+### 1.1.5
+* update oj version to ~> 2.0
+
+### 1.1.4
+* handle EOF on read
+* fix jrpc error require
+* use JRPC::Error as base class for JRPC::Transport::SocketBase::Error
+
+### 1.1.3
+* close socket when clearing socket if it's not closed
+
+### 1.1.2
+* reset socket when broken pipe error appears
+
+### 1.1.1
+* fix rescuing error in TcpClient initializer
+
+### 1.1.0
+* use own socket wrapper
+
+### 1.0.1
+* Net::TCPClient#read method process data with buffer variable
+
+### 1.0.0
+* stable release

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'jrpc'
+
+# 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__)

data/bin/jrpc

@@ -0,0 +1,100 @@
+#!/usr/bin/env ruby
+# coding: utf-8
+
+require 'optparse'
+require 'jrpc'
+
+Options = Struct.new(
+    :host,
+    :port,
+    :type,
+    :method,
+    :params,
+    :id,
+    :debug,
+    :namespace,
+    :timeout
+)
+
+class Parser
+  def self.parse(argv)
+    args = Options.new
+    args.host = '127.0.0.1'
+    args.port = 7080
+    args.type = 'request'
+    args.timeout = 5
+
+    opt_parser = OptionParser.new do |opts|
+      opts.banner = 'Usage: jrpc [options] method [params, ...]'
+
+      opts.on('--host=HOST', 'host (default 127.0.0.1)') do |host|
+        args.host = host
+      end
+
+      opts.on('-p=PORT', '--port=PORT', 'port (default 7080)') do |port|
+        args.port = port
+      end
+
+      opts.on('-r', '--request', 'Sets type to request (default true)') do
+        args.type = 'request'
+      end
+
+      opts.on('-n', '--notification', 'Sets type to is notification (default false)') do
+        args.type = 'notification'
+      end
+
+      opts.on('--namespace=NAMESPACE', 'Sets method namespace') do |namespace|
+        args.namespace = namespace
+      end
+
+      opts.on('--id=ID', 'Request ID (will be generated randomly by default)') do |id|
+        args.id = id
+      end
+
+      opts.on('--timeout=TIMEOUT', 'timeout for socket') do |timeout|
+        args.timeout = timeout
+      end
+
+      opts.on('-d', '--debug', 'Debug output') do
+        args.debug = true
+      end
+
+      opts.on('-h', '--help', 'Prints this help and exit') do
+        puts opts
+        exit
+      end
+
+      opts.on('-v', '--version', 'Prints version and exit') do
+        puts "JRPC version: #{JRPC::VERSION}"
+        exit
+      end
+    end
+
+    opt_parser.parse!(argv)
+    args.method = argv.first
+    args.params = argv[1..-1]
+    # puts "PARSED:\n#{args.inspect}\n#{argv.inspect}"
+    return args
+  end
+end
+
+options = Parser.parse(ARGV.dup)
+
+logger = Logger.new($stdout)
+logger.level = options.debug ? Logger::DEBUG : Logger::INFO
+addr = "#{options.host}:#{options.port}"
+logger.debug { "Connecting to #{addr} ..." }
+client = JRPC::TcpClient.new(addr, namespace: options.namespace, timeout: options.timeout, logger: logger)
+
+logger.debug { "Sending #{options.type} #{options.method} #{options.params} ..." }
+response = client.perform_request(options.method, params: options.params, type: options.type.to_sym)
+
+if options.type == 'request'
+  logger.debug { "Request was sent. Response: #{response.inspect}" }
+  puts JSON.pretty_generate(response)
+else
+  logger.debug 'Notification was sent.'
+end
+
+client.close
+logger.debug 'Exited'

data/bin/jrpc-shell

@@ -0,0 +1,99 @@
+#!/usr/bin/env ruby
+# coding: utf-8
+
+require 'readline'
+require 'singleton'
+require 'jrpc'
+
+class Command
+  include Singleton
+
+  def self.call(command, args)
+    meth = "cmd_#{command}"
+    if instance.respond_to?(meth)
+      instance.public_send(meth, *args)
+    else
+      "ERROR: invalid command #{command.inspect}\n#{instance.help_usage}"
+    end
+  rescue ArgumentError => e
+    "ERROR: ArgumentError #{e.message}\n#{instance.help_usage}"
+  end
+
+  attr_accessor :logger, :client, :help_usage
+  instance.logger = Logger.new(STDOUT)
+  instance.logger.level = Logger::INFO
+  instance.help_usage = [
+      'Usage:',
+      '  connect host port',
+      '  disconnect',
+      '  request method param1 param2',
+      '  request method {"param1": 1. "param2": 2}',
+      '  notification method param1 param2',
+      '  notification method {"param1": 1. "param2": 2}',
+      '  help',
+      '  version'
+  ].join("\n")
+
+  def cmd_help
+    help_usage
+  end
+
+  def cmd_version
+    "JRPC version: #{JRPC::VERSION}"
+  end
+
+  def cmd_connect(host, port)
+    client&.close
+    self.client = JRPC::TcpClient.new("#{host}:#{port}", namespace: '', timeout: 5, logger: logger)
+    'Connected.'
+  rescue JRPC::Error => e
+    "ERROR: JRPC #{e.message}\n#{help_usage}"
+  end
+
+  def cmd_disconnect
+    return "ERROR: Not connected\n#{help_usage}" if client.nil?
+
+    client.close
+    self.client = nil
+    'Disconnected'
+  end
+
+  def cmd_request(method, *params)
+    return "ERROR: Not connected\n#{help_usage}" if client.nil?
+
+    params = JSON.parse(params.first) if params.size == 1 && params[0] == '{'
+
+    response = client.perform_request(method, params: params)
+    JSON.pretty_generate(response)
+  rescue JRPC::Error => e
+    "ERROR: JRPC #{e.message}\n#{help_usage}"
+  end
+
+  def cmd_notification(method, *params)
+    return "ERROR: Not connected\n#{help_usage}" if client.nil?
+
+    params = JSON.parse(params.first) if params.size == 1 && params[0] == '{'
+
+    response = client.perform_request(method, params: params, type: :notification)
+    JSON.pretty_generate(response)
+  rescue JRPC::Error => e
+    "ERROR: JRPC #{e.message}\n#{help_usage}"
+  end
+end
+
+puts 'Welcome to JRPC shell'
+while input = Readline.readline('> ', true)
+  if %w[exit close quit].include?(input)
+    break
+  elsif input == 'hist'
+    puts Readline::HISTORY.to_a
+  elsif input == ''
+    # Remove blank lines from history
+    Readline::HISTORY.pop
+  else
+    command, *args = input.split(' ')
+    puts Command.call(command, args)
+  end
+end
+
+puts 'Shell Exited'

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/jrpc.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
 
   spec.summary       = 'JSON RPC client'
   spec.description   = 'JSON RPC client over TCP'
-  spec.homepage      = 'https://github.com/senid231/jrpc'
+  spec.homepage      = 'https://github.com/didww/jrpc'
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
@@ -20,7 +20,10 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'netstring', '~> 0'
   spec.add_dependency 'oj', '~> 3.0'
 
-  spec.add_development_dependency 'bundler', '~> 1.10'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.executables << 'jrpc'
+  spec.executables << 'jrpc-shell'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
 end

data/lib/jrpc.rb

@@ -1,3 +1,5 @@
+require 'socket'
+require 'json'
 require 'jrpc/version'
 require 'jrpc/error/error'
 require 'jrpc/utils'

data/lib/jrpc/transport/socket_tcp.rb

@@ -8,6 +8,7 @@ module JRPC
         while length_to_read > 0
           io_read, = IO.select([socket], [], [], timeout)
           raise ReadTimeoutError unless io_read
+          check_fin_signal
           chunk = io_read[0].read_nonblock(length_to_read)
           received += chunk
           length_to_read -= chunk.bytesize
@@ -25,6 +26,7 @@ module JRPC
         while data_to_write.bytesize > 0
           _, io_write, = IO.select([], [socket], [], timeout)
           raise WriteTimeoutError unless io_write
+          check_fin_signal
           chunk_length = io_write[0].write_nonblock(data_to_write)
           length_written += chunk_length
           data_to_write = data.byteslice(length_written, data.length)
@@ -41,8 +43,27 @@ module JRPC
         socket.close
       end
 
+      # Socket implementation allows client to send data to server after FIN,
+      # but server will never receive this data.
+      # So we consider socket closed when it have FIN event
+      # and close it correctly from client side.
       def closed?
-        @socket.nil? || socket.closed?
+        return true if @socket.nil? || socket.closed?
+
+        if fin_signal?
+          close
+          return true
+        end
+
+        false
+      end
+
+      # Socket implementation allows client to send data to server after FIN,
+      # but server will never receive this data.
+      # We correctly close socket from client side when FIN event received.
+      # Should be checked before send data to socket or recv data from socket.
+      def check_fin_signal
+        close if socket && !socket.closed? && fin_signal?
       end
 
       def socket
@@ -51,6 +72,19 @@ module JRPC
 
       private
 
+      # when recv_nonblock(1) responds with empty string means that FIN event was received.
+      # in other cases it will return 1 byte string or raise EAGAINWaitReadable.
+      # MSG_PEEK means we do not move pointer when reading data.
+      # see https://apidock.com/ruby/BasicSocket/recv_nonblock
+      def fin_signal?
+        begin
+          resp = socket.recv_nonblock(1, Socket::MSG_PEEK)
+        rescue IO::EAGAINWaitReadable => _
+          resp = nil
+        end
+        resp == ''
+      end
+
       def clear_socket!
         return if @socket.nil?
         @socket.close unless @socket.closed?

data/lib/jrpc/version.rb

@@ -1,3 +1,3 @@
 module JRPC
-  VERSION = '1.1.7'
+  VERSION = '1.1.8'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jrpc
 version: !ruby/object:Gem::Version
-  version: 1.1.7
+  version: 1.1.8
 platform: ruby
 authors:
 - Denis Talakevich
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-04 00:00:00.000000000 Z
+date: 2020-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: netstring
@@ -42,30 +42,30 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -83,17 +83,24 @@ dependencies:
 description: JSON RPC client over TCP
 email:
 - senid231@gmail.com
-executables: []
+executables:
+- jrpc
+- jrpc-shell
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/console
+- bin/jrpc
+- bin/jrpc-shell
+- bin/setup
 - jrpc.gemspec
 - lib/jrpc.rb
 - lib/jrpc/base_client.rb
@@ -113,7 +120,7 @@ files:
 - lib/jrpc/transport/socket_tcp.rb
 - lib/jrpc/utils.rb
 - lib/jrpc/version.rb
-homepage: https://github.com/senid231/jrpc
+homepage: https://github.com/didww/jrpc
 licenses:
 - MIT
 metadata: {}
@@ -132,7 +139,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: JSON RPC client