jrpc 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 89173d093947f7660038fd40edf8df685f0eba58
-  data.tar.gz: 730eb903478be492a2708c4d104c016b120f17ec
+  metadata.gz: fa57d4ebd661941d43cc81ab71df478fc7e2cd90
+  data.tar.gz: 6675b878174f71c7fc96a7d4a7d5c485cdb99670
 SHA512:
-  metadata.gz: c22cdaf992b9ed4ac0553c8d18fa5ac34de673cb2e7da20a0476734dbf50465e82a7951b7ed4424e7f62330db517c98aba25da2a999a916902c9174d2f5d56d2
-  data.tar.gz: 39b0a463f4a6353a1daa9f8d81e65e7482907af7a6a8e0a34ee4cc20c8e6b3c1fd1eb7a50e799a5125acf5252701d5892c5d2086f78dfd5dadd00ed6944af87f
+  metadata.gz: d95b4e15d5611b9b0b032f599c5d0b675887a2cf834bc6796808dcce43c599cbcbd80380b6f9be6783a55f65b8190d7aaa0cb32f31889384d24c41307c2cf7e5
+  data.tar.gz: 9ecb04ea701ef5bd048d777e61c440cd519387247c42e02f39a05092ebbbc40520c918b4c36afb576e277f8dd013c65a34274747b8eef484002f146ef25efa6a

data/jrpc.gemspec

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

data/lib/jrpc.rb

@@ -1,6 +1,8 @@
 require 'jrpc/version'
 require 'jrpc/utils'
 require 'jrpc/base_client'
+require 'jrpc/transport/socket_base'
+require 'jrpc/transport/socket_tcp'
 require 'jrpc/tcp_client'
 require 'jrpc/error/error'
 require 'jrpc/error/connection_error'

data/lib/jrpc/base_client.rb

@@ -9,6 +9,13 @@ module JRPC
     ID_CHARACTERS = (('a'..'z').to_a + ('0'..'9').to_a + ('A'..'Z').to_a).freeze
     REQUEST_TYPES = [:request, :notification].freeze
 
+    def self.connect(uri, options)
+      client = new(uri, options)
+      yield(client)
+    ensure
+      client.close if client
+    end
+
     def initialize(uri, options)
       @uri = uri
       @options = options

data/lib/jrpc/tcp_client.rb

@@ -1,4 +1,3 @@
-require 'net/tcp_client'
 require 'netstring'
 require 'logger'
 require 'benchmark'
@@ -18,22 +17,34 @@ module JRPC
       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
+      write_timeout = @options.fetch(:write_timeout, 60) # default 60
+      connect_retry_count = @options.fetch(:connect_retry_count, 10) # default 10
+      @close_after_sent = @options.fetch(:close_after_sent, false)
 
-      @transport = Net::TCPClient.new server: @uri,
-                                   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}"
+      @transport = JRPC::Transport::SocketTcp.new server: @uri,
+                                                  connect_retry_count: connect_retry_count,
+                                                  connect_timeout: connect_timeout,
+                                                  read_timeout: read_timeout,
+                                                  write_timeout: write_timeout
+      begin
+        @transport.connect
+      rescue JRPC::SocketTcp::Error
+        raise ConnectionError, "Can't connect to #{@uri}"
+      end
     end
 
     private
 
-    def send_command(request, options={})
+    def ensure_connected
+      if @transport.closed?
+        logger.debug { 'Connecting transport...' }
+        @transport.connect
+        logger.debug { 'Connected.' }
+      end
+    end
+
+    def send_command(request, options = {})
+      ensure_connected
       read_timeout = options.fetch(:read_timeout)
       write_timeout = options.fetch(:write_timeout)
       response = nil
@@ -49,15 +60,20 @@ module JRPC
         "(#{'%.2f' % (t * 1000)}ms) Response message: #{Utils.truncate(response, MAX_LOGGED_MESSAGE_LENGTH)}"
       end
       response
+    ensure
+      @transport.close if @close_after_sent
     end
 
-    def send_notification(request, options={})
+    def send_notification(request, options = {})
+      ensure_connected
       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' }
+    ensure
+      @transport.close if @close_after_sent
     end
 
     def create_message(method, params)
@@ -74,8 +90,7 @@ module JRPC
     def receive_response(timeout)
       timeout ||= @transport.read_timeout
       length = get_msg_length(timeout)
-      response = ''
-      @transport.read(length+1, response, timeout)
+      response = @transport.read(length + 1, timeout)
       raise ClientError.new('invalid response. missed comma as terminator') if response[-1] != ','
       response.chomp(',')
     rescue ::SocketError
@@ -85,7 +100,7 @@ module JRPC
     def get_msg_length(timeout)
       length = ''
       while true do
-        character = @transport.read(1, nil, timeout)
+        character = @transport.read(1, timeout)
         break if character == ':'
         length += character
       end

data/lib/jrpc/transport/socket_base.rb

@@ -0,0 +1,82 @@
+module JRPC
+  module Transport
+    class SocketBase
+
+      class Error < StandardError
+      end
+
+      class TimeoutError < Error
+        def initialize
+          super(self.class.to_s.split('::').last)
+        end
+      end
+
+      class ReadTimeoutError < TimeoutError
+      end
+
+      class WriteTimeoutError < TimeoutError
+      end
+
+      class ConnectionTimeoutError < TimeoutError
+      end
+
+      class ConnectionFailedError < Error
+      end
+
+      attr_reader :options, :read_timeout, :write_timeout
+
+      def self.connect(options)
+        connection = new(options)
+        yield(connection)
+      ensure
+        connection.close if connection
+      end
+
+      def initialize(options)
+        @server = options.fetch(:server)
+        @read_timeout = options.fetch(:read_timeout, nil)
+        @write_timeout = options.fetch(:write_timeout, nil)
+        @connect_timeout = options.fetch(:connect_timeout, nil)
+        @connect_retry_count = options.fetch(:connect_retry_count, 0)
+        @options = options
+      end
+
+      def connect
+        retries = @connect_retry_count
+
+        while retries >= 0
+          begin
+            connect_socket
+            break
+          rescue Error => e
+            retries -= 1
+            raise e if retries < 0
+          end
+        end
+      end
+
+      def read(_length, _timeout = @read_timeout)
+        raise NotImplementedError
+      end
+
+      def write(_data, _timeout = @write_timeout)
+        raise NotImplementedError
+      end
+
+      def close
+        raise NotImplementedError
+      end
+
+      def closed?
+        raise NotImplementedError
+      end
+
+      private
+
+      def connect_socket
+        raise NotImplementedError
+      end
+
+    end
+  end
+end

data/lib/jrpc/transport/socket_tcp.rb

@@ -0,0 +1,78 @@
+module JRPC
+  module Transport
+    class SocketTcp < SocketBase
+
+      attr_reader :socket
+
+      def initialize(options)
+        super
+        @socket = build_socket
+      end
+
+      def read(length, timeout = @read_timeout)
+        received = ''
+        length_to_read = length
+        while length_to_read > 0
+          io_read, = IO.select([@socket], [], [], timeout)
+          raise ReadTimeoutError unless io_read
+          chunk = io_read[0].read_nonblock(length_to_read)
+          received += chunk
+          length_to_read -= chunk.bytesize
+        end
+        received
+      end
+
+      def write(data, timeout = @write_timeout)
+        length_written = 0
+        data_to_write = data
+        while data_to_write.bytesize > 0
+          _, io_write, = IO.select([], [@socket], [], timeout)
+          raise WriteTimeoutError unless io_write
+          chunk_length = io_write[0].write_nonblock(data_to_write)
+          length_written += chunk_length
+          data_to_write = data.byteslice(length_written, data.length)
+        end
+        length_written
+      end
+
+      def close
+        @socket.close
+      end
+
+      def closed?
+        @socket.closed?
+      end
+
+      private
+
+      def set_timeout_to(socket, type, value)
+        secs = Integer(value)
+        u_secs = Integer((value - secs) * 1_000_000)
+        opt_val = [secs, u_secs].pack('l_2')
+        socket.setsockopt Socket::SOL_SOCKET, type, opt_val
+      end
+
+      def build_socket
+        host = @server.split(':').first
+        addr = Socket.getaddrinfo(host, nil)
+        sock = Socket.new(Socket.const_get(addr[0][0]), Socket::SOCK_STREAM, 0)
+        set_timeout_to(sock, Socket::SO_RCVTIMEO, @connect_timeout) if @connect_timeout
+        sock
+      end
+
+      def connect_socket
+        host, port = @server.split(':')
+        addr = Socket.getaddrinfo(host, nil)
+        full_addr = Socket.pack_sockaddr_in(port, addr[0][3])
+        @socket.connect(full_addr)
+      rescue Errno::EISCONN => _
+        # already connected
+      rescue Errno::ETIMEDOUT => _
+        raise ConnectionTimeoutError
+      rescue Errno::ECONNREFUSED, Errno::EHOSTUNREACH, Errno::ETIMEDOUT => e
+        raise ConnectionFailedError, "#{e.class} #{e.message}"
+      end
+
+    end
+  end
+end

data/lib/jrpc/version.rb

@@ -1,3 +1,3 @@
 module JRPC
-  VERSION = '1.0.1'
+  VERSION = '1.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jrpc
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Denis Talakevich
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-11 00:00:00.000000000 Z
+date: 2018-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: netstring
@@ -24,20 +24,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: net_tcp_client
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: oj
   requirement: !ruby/object:Gem::Requirement
@@ -123,6 +109,8 @@ files:
 - lib/jrpc/error/server_error.rb
 - lib/jrpc/error/unknown_error.rb
 - lib/jrpc/tcp_client.rb
+- lib/jrpc/transport/socket_base.rb
+- lib/jrpc/transport/socket_tcp.rb
 - lib/jrpc/utils.rb
 - lib/jrpc/version.rb
 homepage: https://github.com/senid231/jrpc