net-telnet-rfc2217 0.0.3 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c22526ce99613e2c561a64f7b7c9063591eaac34fce16602374afbc7461287c
-  data.tar.gz: 18d1b8c6679c93ec46d69ad0a6f6e0942b868f3bb2b82022d6d50f88a01b411d
+  metadata.gz: 0c39563771f3856b4bc00958b23c0dfd9fbc1dddc74f1296576450ecba9c63d1
+  data.tar.gz: 5ac03d21506442c8b686ae9d5f1d9d452a40f7a2404eaf6cc941c7ebdd703bf0
 SHA512:
-  metadata.gz: a92d336bd6cc302a1f1b2d3aba4ab57d45115556e954da8937afbdef7a4f7a1056ebdb5911fa6f3685b01e2123734c66166fef9c510c9055e6959f855b117108
-  data.tar.gz: cceb6cf145dcbffa1fb0132f7bc7d2f9c73b9b80c2bc993d2865e339e0e5a52aca0330f0b0eeb799c39b1984a41697bc56cdbee0c99b65f70fe82129fb9e3944
+  metadata.gz: 1e6c931590c7d2cca1127f3291fa2596b338ab10fe3fe2f128860b405cd02e59c6d49876c37c821cb4c3da3e91e079a0ec34b3aa553dca3359e5b6e702e0a5f3
+  data.tar.gz: 6c589b90e212849f27283d9ff71eb44a674ed3831e23d695900991716e977f0f7f3bdfbd613a7c15845b836a6f3a0b6fb696b32452388f4254b6172546e828f8

data/lib/net/telnet/rfc2217/version.rb

@@ -1,7 +1,7 @@
 module Net
   class Telnet
     class RFC2217
-      VERSION = '0.0.3'
+      VERSION = '1.0.1'
     end
   end
 end

data/lib/net/telnet/rfc2217.rb

@@ -1,5 +1,4 @@
 require 'net/telnet'
-require 'byebug'
 
 # have to patch Telnet to allow us to read control sequences
 require 'net/telnet/rfc2217/telnet'
@@ -14,43 +13,9 @@ module Net
 
       attr_reader :telnet
 
-      COM_PORT_OPTION = 44.chr
-
-      SET_BAUDRATE = 1.chr
-      SET_DATASIZE = 2.chr
-      SET_PARITY = 3.chr
-      SET_STOPSIZE = 4.chr
-      SET_CONTROL = 5.chr
-      NOTIFY_LINESTATE = 6.chr
-      NOTIFY_MODEMSTATE = 7.chr
-      FLOWCONTROL_SUSPEND = 8.chr
-      SET_LINESTATE_MASK = 10.chr
-      SET_MODEMSTATE_MASK = 11.chr
-      PURGE_DATA = 12.chr
-
-      SET_BAUDRATE_RESPONSE = 101.chr
-      SET_DATASIZE_RESPONSE = 102.chr
-      SET_PARITY_RESPONSE = 103.chr
-      SET_STOPSIZE_RESPONSE = 104.chr
-      SET_CONTROL_RESPONSE = 105.chr
-      NOTIFY_LINESTATE_RESPONSE = 106.chr
-      NOTIFY_MODEMSTATE_RESPONSE = 107.chr
-      FLOWCONTROL_SUSPEND_RESPONSE = 108.chr
-      SET_LINESTATE_MASK_RESPONSE = 110.chr
-      SET_MODEMSTATE_MASK_RESPONSE = 111.chr
-      PURGE_DATA_RESPONSE = 112.chr
-
-      NONE = 1
-      ODD = 2
-      EVEN = 3
-      MARK = 4
-      SPACE = 5
-
-      SERIAL_PORT_PARAMS = %w{baud data_bits stop_bits parity}.freeze
-
       class << self
-        def open(options)
-          sp = new(options)
+        def open(**kwargs)
+          sp = new(opt**kwargs)
           if block_given?
             begin
               yield sp
@@ -64,9 +29,15 @@ module Net
         end
       end
 
-      def initialize(options = {}, &block)
-        set_modem_params(options.slice(*SERIAL_PORT_PARAMS))
+      attr_reader :baud, :data_bits, :parity, :stop_bits
 
+      def initialize(host, port: 23, baud: 115200, data_bits: 8, parity: :none, stop_bits: 1, &block)
+        set_modem_params(baud: baud, data_bits: data_bits, parity: parity, stop_bits: stop_bits)
+
+        options = {
+          'Host' => host,
+          'Port' => port,
+        }
         options['Binmode'] = true
         options['Telnetmode'] = false
         @telnet = Telnet.new(options, &block)
@@ -81,35 +52,15 @@ module Net
         end
       end
 
-      def get_modem_params
-        @modem_params
-      end
-
-      def set_modem_params(modem_params)
-        @modem_params = modem_params.dup
-        @modem_params['baud'] = 115200 unless @modem_params.key?('baud')
-        @modem_params['data_bits'] = 8 unless @modem_params.key?('data_bits')
-        @modem_params['stop_bits'] = 1 unless @modem_params.key?('stop_bits')
-        unless @modem_params.key?('parity')
-          @modem_params['parity'] = (data_bits == 8 ? NONE : EVEN)
-        end
-        write_modem_params if telnet
-      end
-
-      def baud
-        get_modem_params['baud']
-      end
+      def set_modem_params(baud: nil, data_bits: nil, parity: nil, stop_bits: nil)
+        raise ArgumentError, "Parity must be :none, :even, :odd, :mark, or :space" unless parity.nil? || %i{none even odd mark space}.include?(parity)
 
-      def data_bits
-        get_modem_params['data_bits']
-      end
+        @baud ||= baud || 115200
+        @data_bits ||= data_bits || 8
+        @parity ||= parity || :none
+        @stop_bits ||= stop_bits || 1
 
-      def stop_bits
-        get_modem_params['stop_bits']
-      end
-
-      def parity
-        get_modem_params['parity']
+        write_modem_params if telnet
       end
 
       def sock
@@ -119,11 +70,16 @@ module Net
       def read(length, outbuf = '')
         readpartial(length, outbuf)
         while outbuf.length < length
-          outbuf.concat(length - outbuf.length)
+          outbuf.concat(readpartial(length - outbuf.length))
         end
         outbuf
       end
 
+      def readbyte
+        read(1)&.[](0)
+      end
+      alias getbyte readbyte
+
       def readpartial(length, outbuf = '')
         loop do
           # 0 is special and means "just see if there's data to read"
@@ -189,6 +145,15 @@ module Net
         result
       end
 
+      def ready?
+        loop do
+          return true unless @buffer.empty?
+          return false if sock.wait_readable(0).nil?
+          # consume control characters first
+          readpartial(0)
+        end
+      end
+
       def ungetbyte(b)
         @buffer.insert(0, b.chr)
       end
@@ -212,12 +177,46 @@ module Net
 
       private
 
+      COM_PORT_OPTION = 44.chr
+
+      SET_BAUDRATE = 1.chr
+      SET_DATASIZE = 2.chr
+      SET_PARITY = 3.chr
+      SET_STOPSIZE = 4.chr
+      SET_CONTROL = 5.chr
+      NOTIFY_LINESTATE = 6.chr
+      NOTIFY_MODEMSTATE = 7.chr
+      FLOWCONTROL_SUSPEND = 8.chr
+      SET_LINESTATE_MASK = 10.chr
+      SET_MODEMSTATE_MASK = 11.chr
+      PURGE_DATA = 12.chr
+
+      SET_BAUDRATE_RESPONSE = 101.chr
+      SET_DATASIZE_RESPONSE = 102.chr
+      SET_PARITY_RESPONSE = 103.chr
+      SET_STOPSIZE_RESPONSE = 104.chr
+      SET_CONTROL_RESPONSE = 105.chr
+      NOTIFY_LINESTATE_RESPONSE = 106.chr
+      NOTIFY_MODEMSTATE_RESPONSE = 107.chr
+      FLOWCONTROL_SUSPEND_RESPONSE = 108.chr
+      SET_LINESTATE_MASK_RESPONSE = 110.chr
+      SET_MODEMSTATE_MASK_RESPONSE = 111.chr
+      PURGE_DATA_RESPONSE = 112.chr
+
+      NONE = 1
+      ODD = 2
+      EVEN = 3
+      MARK = 4
+      SPACE = 5
+
+      private_constant *(constants - [:WaitReadable])
+
       def write_modem_params
         telnet.write(
           IAC + SB + COM_PORT_OPTION + SET_BAUDRATE + [baud].pack("N") + IAC + SE +
           IAC + SB + COM_PORT_OPTION + SET_DATASIZE + data_bits.chr + IAC + SE +
           IAC + SB + COM_PORT_OPTION + SET_STOPSIZE + stop_bits.chr + IAC + SE +
-          IAC + SB + COM_PORT_OPTION + SET_PARITY + parity.chr + IAC + SE)
+          IAC + SB + COM_PORT_OPTION + SET_PARITY + const_get(parity.upcase, false).chr + IAC + SE)
         sock.flush
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: net-telnet-rfc2217
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 1.0.1
 platform: ruby
 authors:
 - Cody Cutrer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-15 00:00:00.000000000 Z
+date: 2021-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-telnet
@@ -81,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Library for getting an IO-like object for a remote serial port