ruby-eql 0.0.1 → 0.0.2

data/History.txt

@@ -1,7 +1,12 @@
-=== 0.0.1 / 2008-05-28
+=== 0.0.2 / 2008-06-06
+
+* 1 change
+  * net-ssh-telnet becomes its own gem
+* 1 minor enhancement
+  * added output_log option 
 
-* Initial release 
+=== 0.0.1 / 2008-05-28
 
+* 1 major enhancement
   * Birthday!
   * Test release.
-

data/Manifest.txt

@@ -7,5 +7,4 @@ examples/ssh_show_members_with_volumes.rb
 examples/telnet_options_file_show_version.rb
 lib/eql.rb
 lib/eql/cli.rb
-lib/netsshtelnet.rb
 test/test_eql.rb

data/README.txt

@@ -21,7 +21,7 @@ series arrays.
 
 == REQUIREMENTS:
 
-* net-ssh 
+* net-ssh-telnet 
 
 == INSTALL:
 

data/Rakefile

@@ -7,7 +7,7 @@ require 'eql'
 
 Hoe.new('ruby-eql', Eql::VERSION) do |p|
   p.developer('Matthew Kent', 'matt@bravenet.com')
-  p.extra_deps << ['net-ssh', '>= 2.0.1']
+  p.extra_deps << ['net-ssh-telnet', '>= 0.0.1']
   p.remote_rdoc_dir = ''
 end
 

data/examples/ssh_show_members_with_volumes.rb

@@ -10,9 +10,10 @@ san = Eql::GroupManager.open(
       :username => 'grpadmin', 
       :password => 'pass', 
       :timeout => 3,
-      # nb: In telnet mode will print your user/password into the log, though
-      # in ssh it won't.
-      :session_log => "debug.log"
+      # nb: In telnet mode this will print your user/password into the log, 
+      # though in ssh it won't.
+      :session_log => "session.log",
+      :output_log => "output.log"
     )
 
 begin

data/lib/eql.rb

@@ -3,11 +3,11 @@
 require 'net/telnet'
 require 'yaml'
 
-require 'netsshtelnet'
+require 'net/ssh/telnet'
 require 'eql/cli'
 
 module Eql
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
   COMPAT_VERSION = 'V3.3.1 (R68703)'
 
   class GroupManager 
@@ -63,6 +63,7 @@ module Eql
         "Username"   => args[:username]    || DEFAULT_USERNAME,
         "Password"   => args[:password]    || DEFAULT_PASSWORD,
         "Dump_log"   => args[:session_log] || nil,
+        "Output_log" => args[:output_log]  || nil,
         "Prompt"     => PROMPT,
         # nb: Just net::ssh, net::telnet is autodetected
         "Terminator" => TERMINATOR,
@@ -70,6 +71,7 @@ module Eql
 
       # Don't pass it at all if undefined, they will try to open it
       @ops.delete("Dump_log") if @ops["Dump_log"].nil?
+      @ops.delete("Output_log") if @ops["Output_log"].nil?
 
       if @ops["Method"] == "ssh"
         @ops["Port"] = DEFAULT_SSH_PORT if @ops["Port"].nil?

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: ruby-eql
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
-date: 2008-05-30 00:00:00 -07:00
+  version: 0.0.2
+date: 2008-06-06 00:00:00 -07:00
 summary: Ruby module to make interacting with the Equallogic PSxxxE series command line interface a breeze
 require_paths: 
 - lib
@@ -61,7 +61,6 @@ files:
 - examples/telnet_options_file_show_version.rb
 - lib/eql.rb
 - lib/eql/cli.rb
-- lib/netsshtelnet.rb
 - test/test_eql.rb
 test_files: 
 - test/test_eql.rb
@@ -81,13 +80,13 @@ requirements: []
 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: net-ssh
+  name: net-ssh-telnet
   version_requirement: 
   version_requirements: !ruby/object:Gem::Version::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 2.0.1
+        version: 0.0.1
     version: 
 - !ruby/object:Gem::Dependency 
   name: hoe

metadata.gz.sig

@@ -1,2 +1,2 @@
-綛���޴
X�V7x�ނ5��u�K!�Z8�c����|��a�����l�%x���!��A;���
-.|�yF����1=s�DCN��>���_���n�VǞ�҃w���X�]��a�MO	�L�HJ;ԟ��P�s�3�s����MY!��'����"�\�w�d�+����_����;�\��f�E�P��%��l�{-�p�Z���i��t�#7=�u%42I�zu�!��aUM�l�3����3�QA�
+���
��jEo������Mx��Y)�k�@���W��Y�=Lm������ИOB�ξ.�Ud\�
+E����H��qC���D�yx������g�n�MeT$NT9��{Ã���.^�*�O���̓� ��Rÿ� A1`��>ȇ�(��]eA���)"ݥK��D�%-�1���Aw�cz5�V��F�f�^�@���y�&G��y˙FFG%Zy��/�k_Mʂ�!��g+�>��J*Gȶ�Q�t��'��P���

data/lib/netsshtelnet.rb

@@ -1,433 +0,0 @@
-# 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>
-
-require 'rubygems'
-require 'net/ssh'
- 
-module Net
-module SSH
-
-  # == Net::SSH::Telnet
-  #
-  # 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
-    REVISION = '$Id$'
-
-    # Wrapper to emulate the behaviour of Net::Telnet "Proxy" option, where
-    # the user passes in an already-open socket
-
-    class TinyFactory
-      def initialize(sock)
-        @sock = sock
-      end
-      def open(host, port)
-        s = @sock
-        @sock = nil
-        s
-      end
-    end
-
-    # Creates a new Net::SSH::Telnet object.
-    #
-    # The API is similar to Net::Telnet, although you will need to pass in
-    # either an existing Net::SSH::Session object or a Username and Password,
-    # 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 
-    # Net::SSH::Expect here:
-    #
-    # http://search.cpan.org/~bnegrao/Net-SSH-Expect-1.04/lib/Net/SSH/Expect.pod
-    # #IMPORTANT_NOTES_ABOUT_DEALING_WITH_SSH_AND_PSEUDO-TERMINALS
-    #
-    # though for most installs the default LF should be fine. See example 5
-    # below.
-    #
-    # A new option is added to correct a misfeature of Net::Telnet. If you
-    # pass "FailEOF" => true, then if the remote end disconnects while you
-    # are still waiting for your match pattern then an EOFError is raised.
-    # Otherwise, it reverts to the same behaviour as Net::Telnet, which is
-    # just to return whatever data was sent so far, or nil if no data was
-    # returned so far. (This is a poor design because you can't tell whether
-    # the expected pattern was successfully matched or the remote end
-    # disconnected unexpectedly, unless you perform a second match on the
-    # return string). See
-    # http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-core/11373
-    # http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-core/11380
-    #
-    # Example 1 - pass existing Net::SSH::Session object
-    #
-    #   ssh = Net::SSH.start("127.0.0.1",
-    #         :username=>"test123",
-    #         :password=>"pass456"
-    #   )
-    #   s = Net::SSH::Telnet.new(
-    #         "Dump_log" => "/dev/stdout",
-    #         "Session" => ssh
-    #   )
-    #   puts "Logged in"
-    #   p s.cmd("echo hello")
-    #
-    # This is the most flexible way as it allows you to set up the SSH
-    # session using whatever authentication system you like. When done this
-    # way, calling Net::SSH::Telnet.new multiple times will create
-    # multiple channels, and #close will only close one channel.
-    #
-    # In all later examples, calling #close will close the entire
-    # Net::SSH::Session object (and therefore drop the TCP connection)
-    #
-    # Example 2 - pass host, username and password
-    #
-    #   s = Net::SSH::Telnet.new(
-    #           "Dump_log" => "/dev/stdout",
-    #           "Host" => "127.0.0.1",
-    #           "Username" => "test123",
-    #           "Password" => "pass456"
-    #   )
-    #   puts "Logged in"
-    #   puts s.cmd("echo hello")
-    #
-    # Example 3 - pass open IO object, username and password (this is really
-    # just for compatibility with Net::Telnet Proxy feature)
-    #
-    #   require 'socket'
-    #   sock = TCPSocket.open("127.0.0.1",22)
-    #   s = Net::SSH::Telnet.new(
-    #           "Dump_log" => "/dev/stdout",
-    #           "Proxy" => sock,
-    #           "Username" => "test123",
-    #           "Password" => "pass456"
-    #   )
-    #   puts "Logged in"
-    #   puts s.cmd("echo hello")
-    #
-    # Example 4 - pass a connection factory, host, username and password;
-    # Net::SSH will call #open(host,port) on this object. Included just
-    # because it was easy :-)
-    #
-    #   require 'socket'
-    #   s = Net::SSH::Telnet.new(
-    #           "Dump_log" => "/dev/stdout",
-    #           "Factory" => TCPSocket,
-    #           "Host" => "127.0.0.1",
-    #           "Username" => "test123",
-    #           "Password" => "pass456"
-    #   )
-    #   puts "Logged in"
-    #   puts s.cmd("echo hello")
-    #
-    # Example 5 - connection to a SAN device running a customized NetBSD with
-    # different ptty defaults, it doesn't convert LF -> CR+LF (see the man
-    # page for 'stty')
-    #
-    #   require 'socket'
-    #   s = Net::SSH::Telnet.new(
-    #           "Dump_log" => "/dev/stdout",
-    #           "Factory" => TCPSocket,
-    #           "Host" => "192.168.1.1",
-    #           "Username" => "test123",
-    #           "Password" => "pass456",
-    #           "Terminator" => "\r"
-    #   )
-    #   puts "Logged in"
-    #   puts s.cmd("show alerts")
-
-    def initialize(options, &blk) # :yield: mesg
-      @options = options
-      @options["Host"]       = "localhost"   unless @options.has_key?("Host")
-      @options["Port"]       = 22            unless @options.has_key?("Port")
-      @options["Prompt"]     = /[$%#>] \z/n  unless @options.has_key?("Prompt")
-      @options["Timeout"]    = 10            unless @options.has_key?("Timeout")
-      @options["Waittime"]   = 0             unless @options.has_key?("Waittime")
-      @options["Terminator"] = LF            unless @options.has_key?("Terminator")
-
-      unless @options.has_key?("Binmode")
-        @options["Binmode"]    = false
-      else
-        unless (true == @options["Binmode"] or false == @options["Binmode"])
-          raise ArgumentError, "Binmode option must be true or false"
-        end
-      end
-
-      if @options.has_key?("Output_log")
-        @log = File.open(@options["Output_log"], 'a+')
-        @log.sync = true
-        @log.binmode
-      end
-
-      if @options.has_key?("Dump_log")
-        @dumplog = File.open(@options["Dump_log"], 'a+')
-        @dumplog.sync = true
-        @dumplog.binmode
-        def @dumplog.log_dump(dir, x)  # :nodoc:
-          len = x.length
-          addr = 0
-          offset = 0
-          while 0 < len
-            if len < 16
-              line = x[offset, len]
-            else
-              line = x[offset, 16]
-            end
-            hexvals = line.unpack('H*')[0]
-            hexvals += ' ' * (32 - hexvals.length)
-            hexvals = format("%s %s %s %s  " * 4, *hexvals.unpack('a2' * 16))
-            line = line.gsub(/[\000-\037\177-\377]/n, '.')
-            printf "%s 0x%5.5x: %s%s\n", dir, addr, hexvals, line
-            addr += 16
-            offset += 16
-            len -= 16
-          end
-          print "\n"
-        end
-      end
-
-      if @options.has_key?("Session")
-        @ssh = @options["Session"]
-        @close_all = false
-      elsif @options.has_key?("Proxy")
-        @ssh = Net::SSH.start(@options["Host"],  # ignored
-                :port => @options["Port"],       # ignored
-                :username => @options["Username"],
-                :password => @options["Password"],
-                :timeout => @options["Timeout"],
-                :proxy => TinyFactory.new(@options["Proxy"]),
-                :log => (@log ? @log : STDERR)
-        )
-        @close_all = true
-      else
-        message = "Trying " + @options["Host"] + "...\n"
-        yield(message) if block_given?
-        @log.write(message) if @options.has_key?("Output_log")
-        @dumplog.log_dump('#', message) if @options.has_key?("Dump_log")
-
-        begin
-          @ssh = Net::SSH.start(@options["Host"],
-                :port => @options["Port"],
-                :username => @options["Username"],
-                :password => @options["Password"],
-                :timeout => @options["Timeout"],
-                :proxy => @options["Factory"],
-                :log => (@log ? @log : STDERR)
-          )
-          @close_all = true
-        rescue TimeoutError
-          raise TimeoutError, "timed out while opening a connection to the host"
-        rescue
-          @log.write($ERROR_INFO.to_s + "\n") if @options.has_key?("Output_log")
-          @dumplog.log_dump('#', $ERROR_INFO.to_s + "\n") if @options.has_key?("Dump_log")
-          raise
-        end
-
-        message = "Connected to " + @options["Host"] + ".\n"
-        yield(message) if block_given?
-        @log.write(message) if @options.has_key?("Output_log")
-        @dumplog.log_dump('#', message) if @options.has_key?("Dump_log")
-      end
-
-      @buf = ""
-      @eof = false
-      @channel = nil
-      state = nil
-      @ssh.open_channel do |channel|
-        channel.on_success { |ch|
-          case state
-          when :pty
-            state = :shell
-            channel.send_request "shell", nil, true
-          when :shell
-            state = :prompt
-            @channel = ch
-            waitfor(@options['Prompt'], &blk)
-            return
-          end
-        }
-        channel.on_failure { |ch|
-          case state
-          when :pty
-            state = :shell
-            channel.send_request "shell", nil, true
-          else
-            ch.close
-            raise "Failed to open ssh #{state}"
-          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 }
-        state = :pty
-        channel.request_pty(:want_reply => 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
-
-    # Turn newline conversion on (+mode+ == false) or off (+mode+ == true),
-    # or return the current value (+mode+ is not specified).
-    def binmode(mode = nil)
-      case mode
-      when nil
-        @options["Binmode"]
-      when true, false
-        @options["Binmode"] = mode
-      else
-        raise ArgumentError, "argument must be true or false"
-      end
-    end
-
-    # Turn newline conversion on (false) or off (true).
-    def binmode=(mode)
-      if (true == mode or false == mode)
-        @options["Binmode"] = mode
-      else
-        raise ArgumentError, "argument must be true or false"
-      end
-    end
-
-    # Read data from the host until a certain sequence is matched.
-
-    def waitfor(options) # :yield: recvdata
-      time_out = @options["Timeout"]
-      waittime = @options["Waittime"]
-      fail_eof = @options["FailEOF"]
-
-      if options.kind_of?(Hash)
-        prompt   = if options.has_key?("Match")
-                     options["Match"]
-                   elsif options.has_key?("Prompt")
-                     options["Prompt"]
-                   elsif options.has_key?("String")
-                     Regexp.new( Regexp.quote(options["String"]) )
-                   end
-        time_out = options["Timeout"]  if options.has_key?("Timeout")
-        waittime = options["Waittime"] if options.has_key?("Waittime")
-        fail_eof = options["FailEOF"]  if options.has_key?("FailEOF")
-      else
-        prompt = options
-      end
-
-      if time_out == false
-        time_out = nil
-      end
-
-      line = ''
-      buf = ''
-      rest = ''
-      # We want to use #read_ready?(maxwait) but it's not available
-      sock = @ssh.connection.instance_variable_get(:@session).instance_variable_get(:@socket)
-
-      until prompt === line and ((@eof and @buf == "") or not IO::select([sock], nil, nil, waittime))
-        while @buf == "" and !@eof
-          unless IO::select([sock], nil, nil, time_out)
-            raise TimeoutError, "timed out while waiting for more data"
-          end
-          # Note: this could hang if partial message received. Should we
-          # wrap with timeout { ... } instead?
-          @channel.connection.process
-        end
-        if @buf != ""
-          c = @buf; @buf = ""
-          @dumplog.log_dump('<', c) if @options.has_key?("Dump_log")
-          buf = c
-          buf.gsub!(/#{EOL}/no, "\n") unless @options["Binmode"]
-          rest = ''
-          @log.print(buf) if @options.has_key?("Output_log")
-          line += buf
-          yield buf if block_given?
-        elsif @eof # End of file reached
-          break if prompt === line
-          raise EOFError if fail_eof
-          if line == ''
-            line = nil
-            yield nil if block_given?
-          end
-          break
-        end
-      end
-      line
-    end
-
-    # Write +string+ to the host.
-    #
-    # Does not perform any conversions on +string+.  Will log +string+ to the
-    # dumplog, if the Dump_log option is set.
-    def write(string)
-      @dumplog.log_dump('>', string) if @options.has_key?("Dump_log")
-      @channel.send_data string
-      @channel.connection.process true
-    end
-
-    # Sends a 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
-    # terminator.
-    def print(string)
-      terminator = @options["Terminator"]
-
-      if @options["Binmode"]
-        self.write(string)
-      else
-        self.write(string.gsub(/\n/n, terminator))
-      end
-    end
-
-    # Sends a 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.
-    #
-    # 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.
-
-    def cmd(options) # :yield: recvdata
-      match    = @options["Prompt"]
-      time_out = @options["Timeout"]
-
-      if options.kind_of?(Hash)
-        string   = options["String"]
-        match    = options["Match"]   if options.has_key?("Match")
-        time_out = options["Timeout"] if options.has_key?("Timeout")
-      else
-        string = options
-      end
-
-      self.puts(string)
-      if block_given?
-        waitfor({"Prompt" => match, "Timeout" => time_out}){|c| yield c }
-      else
-        waitfor({"Prompt" => match, "Timeout" => time_out})
-      end
-    end
-
-  end  # class Telnet
-end  # module SSH
-end  # module Net