jrpc 0.4.6 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9d50ab0067ae7afd904f28ddbbea101007a5d0b8
-  data.tar.gz: 05b0c1cacb643a91d2f678aa8f0f8b56171b7a26
+  metadata.gz: 88f3c2e9907a01e2628d9eb41bb96be8d683ab40
+  data.tar.gz: 8543544144a943094699050800dc5645402aa954
 SHA512:
-  metadata.gz: 9d360a93e53d3ae19d31a16297d75a3cb6f35d08fbff9eca0117fa7e426fc426498dc7ae94abbcc5acc18ca99f1e8917ae9353810e6ceb868a697c43a2929827
-  data.tar.gz: a50513f654cb83bfaed158e5fe6a7a4e805804440946e86cb29529589635abf389bd7ff3bb924fc2244582b2c0e1d23bdc56651fbbe5649182dc37117e3aec2a
+  metadata.gz: 8b4906aa2277f8e6dae407f222a206071cd8fe2979c869a0808945befe5093e44957f20ea55a8c78248777304198035c2574f08f18924ecd23d673abc3393e39
+  data.tar.gz: 3b43159a29ebf248714acede8b4a20cf83f629f14291b92d557da2c6ef5f846462feb62d1af98ba6436f4a1c0b676e043234a85ca970e8ed2ee19248efc8e912

data/jrpc.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'netstring', '~> 0'
-  spec.add_dependency 'net_tcp_client', '~> 1.0', '>= 1.0.2'
+  spec.add_dependency 'net_tcp_client', '~> 2.0'
   spec.add_dependency 'oj', '~> 2.0'
 
   spec.add_development_dependency 'bundler', '~> 1.10'

data/lib/jrpc/base_client.rb

@@ -7,6 +7,7 @@ module JRPC
     attr_reader :uri, :options
 
     ID_CHARACTERS = (('a'..'z').to_a + ('0'..'9').to_a + ('A'..'Z').to_a).freeze
+    REQUEST_TYPES = [:request, :notification].freeze
 
     def initialize(uri, options)
       @uri = uri
@@ -17,31 +18,58 @@ module JRPC
       invoke_request(method, *params)
     end
 
-    def invoke_request(method, *params)
-      request = create_message(method, params)
-      id = generate_id
-      request['id'] = id
-
-      response = send_command Oj.dump(request, mode: :compat)
-      response = Oj.load(response)
-
-      validate_response(response, id)
-      parse_error(response['error']) if response.has_key?('error')
+    def perform_request(method, params: nil, type: :request, read_timeout: nil, write_timeout: nil)
+      validate_request(params, type)
+      request = create_message(method.to_s, params)
+      if type == :request
+        id = generate_id
+        request['id'] = id
+        response = send_command serialize_request(request), read_timeout: read_timeout, write_timeout: write_timeout
+        response = deserialize_response(response)
+
+        validate_response(response, id)
+        parse_error(response['error']) if response.has_key?('error')
+
+        response['result']
+      else
+        send_notification serialize_request(request), write_timeout: write_timeout
+        nil
+      end
+    end
 
-      response['result']
+    def invoke_request(method, *params)
+      warn '[DEPRECATION] `invoke_request` is deprecated. Please use `perform_request` instead.'
+      params = nil if params.empty?
+      perform_request(method, params: params)
     end
 
     def invoke_notification(method, *params)
-      send_notification create_message(method, params).to_json
-      nil
+      warn '[DEPRECATION] `invoke_request` is deprecated. Please use `perform_request` instead.'
+      params = nil if params.empty?
+      perform_request(method, params: params, type: :notification)
     end
 
     private
 
+    def serialize_request(request)
+      Oj.dump(request, mode: :compat)
+    end
+
+    def deserialize_response(response)
+      Oj.load(response)
+    end
+
     def validate_response(response, id)
-      raise ClientError.new('Wrong response structure') unless response.is_a?(Hash)
-      raise ClientError.new('Wrong version') if response['jsonrpc'] != JRPC::JSON_RPC_VERSION
-      raise ClientError.new("ID response mismatch. expected #{id.inspect} got #{response['id'].inspect}") if id != response['id']
+      raise ClientError, 'Wrong response structure' unless response.is_a?(Hash)
+      raise ClientError, 'Wrong version' if response['jsonrpc'] != JRPC::JSON_RPC_VERSION
+      if id != response['id']
+        raise ClientError, "ID response mismatch. expected #{id.inspect} got #{response['id'].inspect}"
+      end
+    end
+
+    def validate_request(params, type)
+      raise ClientError, 'invalid type' unless REQUEST_TYPES.include?(type)
+      raise ClientError, 'invalid params' if !params.nil? && !params.is_a?(Array) && !params.is_a?(Hash)
     end
 
     def parse_error(error)
@@ -63,11 +91,11 @@ module JRPC
       end
     end
 
-    def send_command(json)
+    def send_command(json, options={})
       raise NotImplementedError
     end
 
-    def send_notification(json)
+    def send_notification(json, options={})
       raise NotImplementedError
     end
 
@@ -81,7 +109,7 @@ module JRPC
           'jsonrpc' => JSON_RPC_VERSION,
           'method' => method
       }
-      message['params'] = params unless params.empty?
+      message['params'] = params unless params.nil?
       message
     end
   end

data/lib/jrpc/tcp_client.rb

@@ -14,12 +14,18 @@ module JRPC
       super
       @logger = @options.delete(:logger) || Logger.new($null)
       @namespace = @options.delete(:namespace).to_s
-      t = @options.fetch(:timeout, 5)
+
+      timeout = @options.fetch(:timeout, 5)
+      connect_timeout = @options.fetch(:connect_timeout, timeout)
+      read_timeout = @options.fetch(:read_timeout, timeout)
+      write_timeout = @options.fetch(:write_timeout, nil) # default 60
+      connect_retry_count = @options.fetch(:connect_retry_count, nil) # default 10
 
       @transport = Net::TCPClient.new server: @uri,
-                                   connect_retry_count: t,
-                                   connect_timeout: t,
-                                   read_timeout: t, # write_timeout: t,
+                                   connect_retry_count: connect_retry_count,
+                                   connect_timeout: connect_timeout,
+                                   read_timeout: read_timeout,
+                                   write_timeout: write_timeout,
                                    buffered: false # recommended for RPC
     rescue ::SocketError
       raise ConnectionError, "Can't connect to #{@uri}"
@@ -27,48 +33,58 @@ module JRPC
 
     private
 
-    def send_command(request)
+    def send_command(request, options={})
+      read_timeout = options.fetch(:read_timeout)
+      write_timeout = options.fetch(:write_timeout)
       response = nil
       t = Benchmark.realtime do
-        logger.debug "Request address: #{uri}"
-        logger.debug "Request message: #{Utils.truncate(request, MAX_LOGGED_MESSAGE_LENGTH)}"
-        send_request(request)
-        response = receive_response
+        logger.debug { "Request address: #{uri}" }
+        logger.debug { "Request message: #{Utils.truncate(request, MAX_LOGGED_MESSAGE_LENGTH)}" }
+        logger.debug { "Request read_timeout: #{read_timeout}" }
+        logger.debug { "Request write_timeout: #{write_timeout}" }
+        send_request(request, write_timeout)
+        response = receive_response(read_timeout)
+      end
+      logger.debug do
+        "(#{'%.2f' % (t * 1000)}ms) Response message: #{Utils.truncate(response, MAX_LOGGED_MESSAGE_LENGTH)}"
       end
-      logger.debug "(#{'%.2f' % (t * 1000)}ms) Response message: #{Utils.truncate(response, MAX_LOGGED_MESSAGE_LENGTH)}"
       response
     end
 
-    def send_notification(request)
-      logger.debug "Request address: #{uri}"
-      logger.debug "Request message: #{Utils.truncate(request, MAX_LOGGED_MESSAGE_LENGTH)}"
-      send_request(request)
-      logger.debug 'No response required'
+    def send_notification(request, options={})
+      write_timeout = options.fetch(:write_timeout)
+      logger.debug { "Request address: #{uri}" }
+      logger.debug { "Request message: #{Utils.truncate(request, MAX_LOGGED_MESSAGE_LENGTH)}" }
+      logger.debug { "Request write_timeout: #{write_timeout}" }
+      send_request(request, write_timeout)
+      logger.debug { 'No response required' }
     end
 
     def create_message(method, params)
       super("#{namespace}#{method}", params)
     end
 
-    def send_request(request)
-      @transport.write Netstring.dump(request.to_s)
+    def send_request(request, timeout)
+      timeout ||= @transport.write_timeout
+      @transport.write Netstring.dump(request.to_s), timeout
     rescue ::SocketError
       raise ConnectionError, "Can't send request to #{uri}"
     end
 
-    def receive_response
-      length = get_msg_length
-      response = @transport.read(length+1)
+    def receive_response(timeout)
+      timeout ||= @transport.read_timeout
+      length = get_msg_length(timeout)
+      response = @transport.read(length+1, nil, timeout)
       raise ClientError.new('invalid response. missed comma as terminator') if response[-1] != ','
       response.chomp(',')
     rescue ::SocketError
       raise ConnectionError, "Can't receive response from #{uri}"
     end
 
-    def get_msg_length
+    def get_msg_length(timeout)
       length = ''
       while true do
-        character = @transport.read(1)
+        character = @transport.read(1, nil, timeout)
         break if character == ':'
         length += character
       end
@@ -77,4 +93,4 @@ module JRPC
     end
 
   end
-end
+end

data/lib/jrpc/version.rb

@@ -1,3 +1,3 @@
 module JRPC
-  VERSION = '0.4.6'
+  VERSION = '1.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jrpc
 version: !ruby/object:Gem::Version
-  version: 0.4.6
+  version: 1.0.0
 platform: ruby
 authors:
 - Denis Talakevich
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-16 00:00:00.000000000 Z
+date: 2017-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: netstring
@@ -30,20 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.2
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.2
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: oj
   requirement: !ruby/object:Gem::Requirement