net-ssh-telnet 0.0.2 → 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 00bb9ece1f4ba5a748bc3c1c7f6a65f386c76543
+  data.tar.gz: 9af12f0b2318c4e1123ead13004f7223974bb9ce
+SHA512:
+  metadata.gz: 1d6d0b0c1a9b38d5f96f0f89d4b556c69621a768629625dc3e70c7709a75819fdd480b218a9db10c2a3f53cac5a33152e4d002494a996431aec0a45edd707baf
+  data.tar.gz: e148e3bae70620f0413b1cab661a1b35473c8bed1e596ae5f32b92bac142bc30b8735477f49f7dbd1ccc6117e22c30433e76e1f549100f79ac7e4b7a669c6b76

data/.gitignore

@@ -0,0 +1,8 @@
+examples/dump.log
+examples/output.log
+pkg
+doc
+*.swp
+/.yardoc
+/.bundle
+/Gemfile.lock

data/.yardopts

@@ -0,0 +1 @@
+- History.txt

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in golden_gate.gemspec
+gemspec

data/History.txt

@@ -1,8 +1,19 @@
+=== 0.2.0 / 2017-01-16
+* Add option to change prompt after initialization
+* Cleanup requires for gemspec
+
+=== 0.1.1 / 2016-05-06
+* Apply fix to race condition during initialization from lumean
+
+=== 0.1.0 / 2016-02-09
+* Fixed 'Timeout' and 'Waittime' options
+* Fork to net-ssh-telnet2
+
 === 0.0.2 / 2009-03-15
 
 * 4 bugfixes from Brian Candler
-  * Bug in original Net::Telnet EOL translation 
-    (http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-core/16599) 
+  * Bug in original Net::Telnet EOL translation
+    (http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-core/16599)
     duplicate the fix.
   * Remove rubygems require.
   * Handle EOF more gracefully.

data/README.txt

@@ -1,7 +1,7 @@
 = net-ssh-telnet
 
-* http://net-ssh-telnet.rubyforge.org
-* mailto:mkent@magoazul.com
+* https://github.com/duke-automation/net-ssh-telnet
+* mailto:sean@duke.edu
 
 == DESCRIPTION:
 
@@ -20,7 +20,7 @@ Please see Net::Telnet for main documentation (included with ruby stdlib).
 
 == REQUIREMENTS:
 
-* net-ssh >= 2.0.1 
+* net-ssh >= 2.0.1
 
 == INSTALL:
 
@@ -33,6 +33,7 @@ Please see Net::Telnet for main documentation (included with ruby stdlib).
 Based on code in net/telnet.rb by Wakou Aoyama <wakou@ruby-lang.org>
 Modified to work with Net::SSH by Brian Candler <b.candler@pobox.com>
 Additional Net::SSH v2 modifications by Matthew Kent <matt@bravenet.com>
+Additional Net::SSH v2 modifications by Sean Dilda <sean@duke.edu>
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Rakefile

@@ -1,14 +1 @@
-# -*- ruby -*-
-
-require 'rubygems'
-require 'hoe'
-$:.unshift(File.dirname(__FILE__) + "/lib")
-require 'net/ssh/telnet'
-
-Hoe.new('net-ssh-telnet', Net::SSH::Telnet::VERSION) do |p|
-  p.developer('Matthew Kent', 'matt@bravenet.com')
-  p.extra_deps << ['net-ssh', '>= 2.0.1']
-  p.remote_rdoc_dir = ''
-end
-
-# vim: syntax=Ruby
+require "bundler/gem_tasks"

data/lib/net/ssh/telnet.rb

@@ -1,5 +1,5 @@
 require 'net/ssh'
- 
+
 module Net
 module SSH
 
@@ -8,13 +8,12 @@ module SSH
   # Provides a simple send/expect interface with an API almost
   # identical to Net::Telnet. Please see Net::Telnet for main documentation.
   # Only the differences are documented here.
-  
+
   class Telnet
 
     CR   = "\015"
     LF   = "\012"
     EOL  = CR + LF
-    VERSION = '0.0.2'
 
     # Wrapper to emulate the behaviour of Net::Telnet "Proxy" option, where
     # the user passes in an already-open socket
@@ -37,10 +36,10 @@ module SSH
     # as shown below.
     #
     # Note that unlike Net::Telnet there is no preprocess method automatically
-    # setting up options related to proper character translations, so if your 
-    # remote ptty is configured differently than the typical linux one you may 
-    # need to pass in a different terminator or call 'stty' remotely to set it 
-    # into an expected mode. This is better explained by the author of perl's 
+    # setting up options related to proper character translations, so if your
+    # remote ptty is configured differently than the typical linux one you may
+    # need to pass in a different terminator or call 'stty' remotely to set it
+    # into an expected mode. This is better explained by the author of perl's
     # Net::SSH::Expect here:
     #
     # http://search.cpan.org/~bnegrao/Net-SSH-Expect-1.04/lib/Net/SSH/Expect.pod
@@ -135,7 +134,26 @@ module SSH
     #   )
     #   puts "Logged in"
     #   puts s.cmd("show alerts")
-
+    #
+    # New objects take a +option+ hash to set default settings. The keys for this options hash
+    # are all strings. A block can also be passed to constructor which will get executed after
+    # the first prompt is found.
+    #
+    # ==== Hash Parameters
+    #
+    # * <tt>"Host"</tt> - a string to define the hostname to connect to(Default: "localhost")
+    # * <tt>"Port"</tt> - port number to connect to(Default: 22)
+    # * <tt>"Prompt"</tt> - a regular expression to define the the prompt to expect(Default: /[$%#>] \z/n )
+    # * <tt>"Timeout"</tt> - the time out value passed on to Net::Ssh - also the default value for #waitfor(Default: 10)
+    # * <tt>"Waittime"</tt> - Max time to wait after a possible prompt it seen to make sure more data isn't coming(Default: 0)
+    # * <tt>"Terminator"</tt> - This value is appended to all strings that are sent to #print.(Default: LF)
+    # * <tt>"Binmode"</tt> - Enable binary mode.(Default: false)
+    # * <tt>"Output_log"</tt> - A file name to open as an output log.
+    # * <tt>"Dump_log"</tt> - A file name to open to dump the entire session to.
+    # * <tt>"Session"</tt> - An existing Net::Ssh object for Net::Ssh::Telnet to use as its connection(See example 1)
+    # * <tt>"Proxy"</tt> - An open IO object to use as a Proxy(See example 3)
+    # * <tt>"Factory"</tt> - A connection factory to use to establish the connection. Net::Ssh::Telnet will call #open(host, post) on this object.(See example 4)
+    #
     def initialize(options, &blk) # :yield: mesg
       @options = options
       @options["Host"]       = "localhost"   unless @options.has_key?("Host")
@@ -233,6 +251,9 @@ module SSH
       @eof = false
       @channel = nil
       @ssh.open_channel do |channel|
+        channel.on_data { |ch,data| @buf << data }
+        channel.on_extended_data { |ch,type,data| @buf << data if type == 1 }
+        channel.on_close { @eof = true }
         channel.request_pty { |ch,success|
           if success == false
             raise "Failed to open ssh pty"
@@ -247,22 +268,18 @@ module SSH
             raise "Failed to open ssh shell"
           end
         }
-        channel.on_data { |ch,data| @buf << data }
-        channel.on_extended_data { |ch,type,data| @buf << data if type == 1 }
-        channel.on_close { @eof = true }
       end
       @ssh.loop
     end # initialize
 
     # Close the ssh channel, and also the entire ssh session if we
     # opened it.
-
     def close
       @channel.close if @channel
       @channel = nil
       @ssh.close if @close_all and @ssh
     end
-        
+
     # The ssh session and channel we are using.
     attr_reader :ssh, :channel
 
@@ -289,7 +306,20 @@ module SSH
     end
 
     # Read data from the host until a certain sequence is matched.
-
+    #
+    # The +options+ parameter takes an string keyed option Hash or a String.
+    #
+    # A block can be provided to be called after the first prompt or match is found.
+    #
+    # ==== Hash Parameters
+    #
+    # * <tt>"Match"</tt> - Regular expression to match
+    # * <tt>"Prompt"</tt> - Regular expression to match (Same as "Match")
+    # * <tt>"String"</tt> - String to match
+    # * <tt>"Timeout"</tt> - Max time in seconds that can pass between packets (Default: 10 - set to false for no timeout)
+    # * <tt>"Waittime"</tt> - Max time to wait after a possible prompt it seen to make sure more data isn't coming(Default: 0)
+    # * <tt>"FailEOF"</tt> - Raise EOFError if EOF is reached on the connection.(Default: false)
+    #
     def waitfor(options) # :yield: recvdata
       time_out = @options["Timeout"]
       waittime = @options["Waittime"]
@@ -319,15 +349,16 @@ module SSH
       rest = ''
       sock = @ssh.transport.socket
 
-      until prompt === line and @buf == "" and (@eof or (not sock.closed? and not IO::select([sock], nil, nil, waittime)))
-        while @buf == "" and !@eof
-          # timeout is covered by net-ssh
-          begin
-            @channel.connection.process(0.1)
-          rescue IOError
-            @eof = true
-          end
+      until @ssh.transport.socket.available == 0 && @buf == "" && prompt === line && (@eof || (!sock.closed? && !IO::select([sock], nil, nil, waittime)))
+        # @buf may have content if it was processed by Net::SSH before #waitfor
+        # was called
+        # The prompt is checked in case a waittime was specified, we've already
+        # seen the prompt, but a protocol-level packet came through during the
+        # above IO::select, causing us to reprocess
+        if @buf == '' && (@ssh.transport.socket.available == 0) && !(prompt === line) && !IO::select([sock], nil, nil, time_out)
+          raise Net::ReadTimeout, "timed out while waiting for more data"
         end
+        _process_ssh
         if @buf != ""
           c = @buf; @buf = ""
           @dumplog.log_dump('<', c) if @options.has_key?("Dump_log")
@@ -362,10 +393,13 @@ module SSH
     # dumplog, if the Dump_log option is set.
     def write(string)
       @dumplog.log_dump('>', string) if @options.has_key?("Dump_log")
+      # Add string to Net:SSH output queue
       @channel.send_data string
+      # Call single instance of Net::SSH loop to process output queue
+      _process_ssh
     end
 
-    # Sends a string to the host.
+    # Sends +string+ to the host.
     #
     # This does _not_ automatically append a newline to the string.  Embedded
     # newlines may be converted depending upon the values of binmode or
@@ -380,21 +414,40 @@ module SSH
       end
     end
 
-    # Sends a string to the host.
+    # Change the standard prompt
+    # This is useful if you need a special prompt value for initializing the
+    # session, but want to use a different prompt for the rest of the session
+    def prompt= val
+      @options["Prompt"] = val
+    end
+
+    # Sends +string+ to the host.
     #
     # Same as #print(), but appends a newline to the string.
     def puts(string)
       self.print(string + "\n")
     end
 
-    # Send a command to the host.
+    # Sends a command to the host.
     #
     # More exactly, sends a string to the host, and reads in all received
     # data until is sees the prompt or other matched sequence.
     #
     # The command or other string will have the newline sequence appended
     # to it.
-
+    #
+    # The +options+ parameter takes a String or Hash. The Hash can be used to override the
+    # default settings that were established when the object was created.
+    #
+    # A block can be provided to be called when the first prompt or "Match" is found.
+    #
+    # ==== Hash Parameters
+    #
+    # * <tt>"String"</tt> - This string is sent over the connection via the #puts method.
+    # * <tt>"Match"</tt> - Passed to #waitfor as the "Prompt" parameter. See its defintion for details.
+    # * <tt>"Timeout"</tt> - Passed to #waitfor see its definition for details
+    # * <tt>"FailEOF"</tt> - Passed to #waitfor see its definition for details
+    #
     def cmd(options) # :yield: recvdata
       match    = @options["Prompt"]
       time_out = @options["Timeout"]
@@ -417,6 +470,18 @@ module SSH
       end
     end
 
+    private
+
+    def _process_ssh
+      begin
+        @channel.connection.process(0)
+      rescue IOError
+        @eof = true
+      end
+    end
+
   end  # class Telnet
 end  # module SSH
 end  # module Net
+
+require 'net/ssh/telnet/version'

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

@@ -0,0 +1,7 @@
+module Net
+module SSH
+class Telnet
+    VERSION = '0.2.0'
+end
+end
+end

data/net-ssh-telnet.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'net/ssh/telnet/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "net-ssh-telnet"
+  spec.version       = Net::SSH::Telnet::VERSION
+  spec.authors       = ["Sean Dilda"]
+  spec.email         = ["sean@duke.edu"]
+  spec.description   = %q{A ruby module to provide a simple send/expect interface over SSH with an API almost identical to Net::Telnet. Ideally it should be a drop in replacement. Please see Net::Telnet for main documentation (included with ruby stdlib).}
+  spec.summary       = %q{Provides Net::Telnet API for SSH connections}
+  spec.homepage      = "https://github.com/duke-automation/net-ssh-telnet"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.require_paths = ["lib"]
+  spec.extra_rdoc_files = ['README.txt', 'History.txt']
+
+  spec.add_runtime_dependency 'net-ssh', '>= 2.0.1'
+  spec.add_development_dependency 'rake'
+end

metadata

@@ -1,73 +1,58 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: net-ssh-telnet
-version: !ruby/object:Gem::Version 
-  version: 0.0.2
+version: !ruby/object:Gem::Version
+  version: 0.2.0
 platform: ruby
-authors: 
-- Matthew Kent
+authors:
+- Sean Dilda
 autorequire: 
 bindir: bin
-cert_chain: 
-- |
-  -----BEGIN CERTIFICATE-----
-  MIIDMjCCAhqgAwIBAgIBADANBgkqhkiG9w0BAQUFADA/MQ4wDAYDVQQDDAVta2Vu
-  dDEYMBYGCgmSJomT8ixkARkWCG1hZ29henVsMRMwEQYKCZImiZPyLGQBGRYDY29t
-  MB4XDTA4MDcyODA0NTIzMVoXDTA5MDcyODA0NTIzMVowPzEOMAwGA1UEAwwFbWtl
-  bnQxGDAWBgoJkiaJk/IsZAEZFghtYWdvYXp1bDETMBEGCgmSJomT8ixkARkWA2Nv
-  bTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAK9kASXLzL37znIcJoWH
-  lE6LYK9Drf9/tTP0aMJBRwzFAL6NP4KCDTSbzRcurb2gqJI5Hz7wJBm7QQaw7jnx
-  F+wUWEUnXF9v8BIpruFpIM+VHIMaj4h5ifSOh7lOARCn0tBHYYadxlyHhj+cROCf
-  h8SPXUQ7Otsba/8tIjYZTh+tiru7hZApAXZRZOiGPjARwuqvcWYYstbxWOyG5hAB
-  QHdhJD1nv03uHuCR0S/FpLmDM+REEh2PAXbvJIMkBJJ+2KP+7oWwU95/pclnEXE/
-  e0qKZkVsaszihkvh1loxlKhU/sV0Sjo+LJ/fM7SR1a9WzSw1c1C/5Twjmq6jnaLG
-  ZGECAwEAAaM5MDcwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0OBBYEFGhf
-  2WxIO89iFR2KfqyyXeWlUsBMMA0GCSqGSIb3DQEBBQUAA4IBAQAyvET0KFjr4Ars
-  HvOFhZOer5jWTfGDUcKB8oOfLhbs7PANVNv0BARxgH0Dj95kTcIfSvQLWfv5OmqC
-  AT3P6hPV6WbRCJOGPy0jeZcKWgPepl8vqnBciqzB8beBXmYmEe097MNvnlZptqU5
-  If5GWrjlRoeYpRDNpMpaN4UFxsb/I4MGYvbnrEVc6Ev1ztgK5Kci8oYcINjUhCls
-  EOmi6kiwQNdHUW0XLqwGanEip196lyE5IHRylQ5UiwYI0T4hDSc9f0SE+dzENdFw
-  doMOs6odERAAmX+M7PQ4i3Zvs+Jv9SazZBcl8+sohZL3I5A1fkNQXts1hV6TObce
-  T6VhSPds
-  -----END CERTIFICATE-----
-
-date: 2009-03-15 00:00:00 -07:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+cert_chain: []
+date: 2017-04-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: net-ssh
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.1
   type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 2.0.1
-    version: 
-- !ruby/object:Gem::Dependency 
-  name: hoe
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.7.0
-    version: 
-description: A ruby module to provide a simple send/expect interface over SSH with an API almost identical to Net::Telnet. Ideally it should be a drop in replacement.  Please see Net::Telnet for main documentation (included with ruby stdlib).
-email: 
-- matt@bravenet.com
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A ruby module to provide a simple send/expect interface over SSH with
+  an API almost identical to Net::Telnet. Ideally it should be a drop in replacement.
+  Please see Net::Telnet for main documentation (included with ruby stdlib).
+email:
+- sean@duke.edu
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
-- History.txt
-- Manifest.txt
+extra_rdoc_files:
 - README.txt
-- Todo.txt
-files: 
 - History.txt
-- Manifest.txt
+files:
+- ".gitignore"
+- ".yardopts"
+- Gemfile
+- History.txt
 - README.txt
 - Rakefile
 - Todo.txt
@@ -76,33 +61,31 @@ files:
 - examples/get_hostname.rb
 - examples/non_standard_shell.rb
 - lib/net/ssh/telnet.rb
+- lib/net/ssh/telnet/version.rb
+- net-ssh-telnet.gemspec
 - test/test_net-ssh-telnet.rb
-has_rdoc: true
-homepage: http://net-ssh-telnet.rubyforge.org
+homepage: https://github.com/duke-automation/net-ssh-telnet
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
-rdoc_options: 
-- --main
-- README.txt
-require_paths: 
+rdoc_options: []
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: net-ssh-telnet
-rubygems_version: 1.2.0
+rubyforge_project: 
+rubygems_version: 2.5.1
 signing_key: 
-specification_version: 2
-summary: A ruby module to provide a simple send/expect interface over SSH with an API almost identical to Net::Telnet
-test_files: 
-- test/test_net-ssh-telnet.rb
+specification_version: 4
+summary: Provides Net::Telnet API for SSH connections
+test_files: []

data.tar.gz.sig

@@ -1 +0,0 @@
-"�4��JWy�,���]�<^����F~'�OI�\#_�'��ս��Y&M�L�)���Cޟ{����%��*�~�=��z8��g�K��G*�4�cM����(�Й���x|��8���&�Dÿ��?��ɗf�P�kyGX�!	��,�$oۚ�#�ݯ���w�|�

data/Manifest.txt

@@ -1,11 +0,0 @@
-History.txt
-Manifest.txt
-README.txt
-Rakefile
-Todo.txt
-examples/detailed_debug.rb
-examples/get_disk_info.rb
-examples/get_hostname.rb
-examples/non_standard_shell.rb
-lib/net/ssh/telnet.rb
-test/test_net-ssh-telnet.rb