ztk 1.9.1 → 1.10.0

data/lib/ztk/ansi.rb

@@ -97,7 +97,6 @@ module ZTK
     #   @return [String] The colored string.
 
     # Defines a RegEx for stripping ANSI codes from strings
-    #ANSI_REGEX = /\e\[(?:(?:[349]|10)[0-7]|[0-9]|[34]8;5;\d{1,3})?m/
     ANSI_REGEX = /\e\[([0-9]{1,2}(;[0-9]{1,2})?)?[m|K]/
 
     # Build ANSI Methods

data/lib/ztk/ssh.rb

@@ -61,9 +61,12 @@ module ZTK
   # @author Zachary Patten <zachary AT jovelabs DOT com>
   class SSH < ZTK::Base
     require 'ostruct'
+    require 'tempfile'
     require 'net/ssh'
+    require 'net/ssh/gateway'
     require 'net/ssh/proxy/command'
     require 'net/sftp'
+    require 'net/scp'
 
     # Exit Signal Mappings
     EXIT_SIGNALS = {
@@ -121,7 +124,8 @@ module ZTK
     # @option configuration [String] :host_name Server hostname to connect to.
     # @option configuration [String] :user Username to use for authentication.
     # @option configuration [String, Array<String>] :keys A single or series of
-    #   identity files to use for authentication.
+    #   identity files to use for authentication.  You can also supply keys as
+    #   String blobs which will be rendered to temporary files automatically.
     # @option configuration [String] :password Password to use for authentication.
     # @option configuration [Integer] :timeout (60) SSH connection timeout in
     #   seconds to use.
@@ -160,7 +164,9 @@ module ZTK
         :ignore_exit_status => false,
         :request_pty => true,
         :exit_code => 0,
-        :silence => false
+        :silence => false,
+        :keys => Array.new,
+        :proxy_keys => Array.new
       }.merge(configuration))
 
       config.ui.logger.debug { "config=#{config.send(:table).inspect}" }

data/lib/ztk/ssh/command.rb

@@ -6,6 +6,7 @@ module ZTK
 
       # Builds our SSH console command.
       def console_command
+        process_keys
         verbosity = ((ENV['LOG_LEVEL'] == "DEBUG") ? '-vv' : '-q')
 
         command = Array.new
@@ -34,6 +35,7 @@ module ZTK
         !config.proxy_user and log_and_raise(SSHError, "You must specify an proxy user in order to SSH proxy.")
         !config.proxy_host_name and log_and_raise(SSHError, "You must specify an proxy host_name in order to SSH proxy.")
 
+        process_keys
         verbosity = ((ENV['LOG_LEVEL'] == "DEBUG") ? '-vv' : '-q')
 
         command = Array.new

data/lib/ztk/ssh/core.rb

@@ -8,7 +8,11 @@ module ZTK
       #
       # Primarily used internally.
       def ssh
-        @ssh ||= Net::SSH.start(config.host_name, config.user, ssh_options)
+        if do_proxy?
+          @ssh ||= self.gateway.ssh(config.host_name, config.user, ssh_options)
+        else
+          @ssh ||= Net::SSH.start(config.host_name, config.user, ssh_options)
+        end
         @ssh
       end
 
@@ -20,10 +24,30 @@ module ZTK
         @sftp
       end
 
-      # Close our session gracefully.
-      def close
-        config.ui.logger.debug { "close" }
+      # Starts an SCP session.  Can also be used to get the Net::SCP object.
+      #
+      # Primarily used internally.
+      def scp
+        @scp ||= self.ssh.scp
+        @scp
+      end
 
+      # Starts an SSH gateway session.  Can also be used to get the
+      # Net::SSH::Gateway object.
+      #
+      # Primarily used internally.
+      def gateway
+        @gateway ||= Net::SSH::Gateway.new(config.proxy_host_name, config.proxy_user, gateway_options)
+        @gateway
+      end
+
+      # Should we run a proxy?
+      def do_proxy?
+        ((!config.proxy_host_name.nil? && !config.proxy_host_name.empty?) && (!config.proxy_user.nil? && !config.proxy_user.empty?))
+      end
+
+      # Attempts to close the SSH session if it is valid.
+      def close_ssh
         if (!@ssh.nil? && !@ssh.closed?)
           config.ui.logger.debug { "SSH object is valid and not closed" }
 
@@ -39,11 +63,41 @@ module ZTK
         else
           config.ui.logger.debug { "SSH object is NIL!" }
         end
+      end
 
-        @ssh = nil
-        @sftp = nil
+      # Attempts to close the gateway session if it is valid.
+      def close_gateway
+        if (!@gateway.nil? && !@gateway.closed?)
+          config.ui.logger.debug { "gateway object is valid and not shutdown" }
+
+          begin
+            config.ui.logger.debug { "attempting to shutdown" }
+            @gateway.shutdown!
+            config.ui.logger.debug { "shutdown" }
+
+          rescue Exception => e
+            config.ui.logger.fatal { "EXCEPTION: #{e.inspect}" }
+          end
+
+        else
+          config.ui.logger.debug { "gateway object is NIL!" }
+        end
+      end
+
+      # Close our session gracefully.
+      def close
+        config.ui.logger.debug { "close" }
+
+        close_ssh
+        close_gateway
 
         true
+
+      ensure
+        @ssh     = nil
+        @gateway = nil
+        @sftp    = nil
+        @scp     = nil
       end
 
       # The on_retry method we'll use with the RescueRetry class.

data/lib/ztk/ssh/download.rb

@@ -6,14 +6,6 @@ module ZTK
 
       # Downloads a remote file to the local host.
       #
-      # @param [String] remote The remote file/path you with to download from.
-      # @param [String] local The local file/path you wish to download to.
-      # @param [Hash] options An optional hash of options.
-      # @option options [Boolean] :recursive Whether or not to recursively
-      #   download files and directories.  By default this looks at the local
-      #   target and if it is a directory this is set to *true* otherwise it
-      #   will default to *false*.
-      #
       # @example Download a file:
       #   $logger = ZTK::Logger.new(STDOUT)
       #   ssh = ZTK::SSH.new
@@ -24,8 +16,24 @@ module ZTK
       #   local = File.expand_path(File.join(ZTK::Locator.root, "tmp", "id_rsa.pub"))
       #   remote = File.expand_path(File.join(ENV['HOME'], ".ssh", "id_rsa.pub"))
       #   ssh.download(remote, local)
+      #
+      # @param [String] remote The remote file/path you with to download from.
+      # @param [String] local The local file/path you wish to download to.
+      # @param [Hash] options An optional hash of options.
+      # @option options [Boolean] :recursive (false) Whether or not to
+      #   recursively download files and directories.  By default this looks at
+      #   the local target and if it is a directory this is set to *true*
+      #   otherwise it will default to *false*.
+      # @option options [Boolean] :use_scp (false) If set to true, the file will
+      #   be transfered using SCP instead of SFTP.  The default behaviour is to
+      #   use SFTP.  *WARNING: Recursive downloads are handled in differing
+      #   manners between SCP and SFTP!*
+      # @return [Boolean] True if successful.
       def download(remote, local, options={})
-        options = {:recursive => ::File.directory?(local) }.merge(options)
+        options = {
+          :recursive => ::File.directory?(local),
+          :use_scp => false
+        }.merge(options)
         options = OpenStruct.new(config.send(:table).merge(options))
 
         options.ui.logger.debug { "config=#{config.send(:table).inspect}" }
@@ -33,24 +41,41 @@ module ZTK
         options.ui.logger.info { "download(#{remote.inspect}, #{local.inspect})" }
 
         ZTK::RescueRetry.try(:ui => config.ui, :tries => ZTK::SSH::RESCUE_RETRY_ATTEMPTS, :on_retry => method(:on_retry)) do
-          sftp.download!(remote.to_s, local.to_s, options.send(:table)) do |event, downloader, *args|
-            case event
-            when :open
-              options.ui.logger.debug { "download(#{args[0].remote} -> #{args[0].local})" }
-              options.on_progress.nil? or options.on_progress.call(:open, args)
-            when :close
-              options.ui.logger.debug { "close(#{args[0].local})" }
-              options.on_progress.nil? or options.on_progress.call(:close, args)
-            when :mkdir
-              options.ui.logger.debug { "mkdir(#{args[0]})" }
-              options.on_progress.nil? or options.on_progress.call(:mkdir, args)
-            when :get
-              options.ui.logger.debug { "get(#{args[0].remote}, size #{args[2].size} bytes, offset #{args[1]})" }
+          if (options.use_scp == false)
+            sftp.download!(remote.to_s, local.to_s, options.send(:table)) do |event, downloader, *args|
+              case event
+              when :open
+                options.ui.logger.debug { "download(#{args[0].remote} -> #{args[0].local})" }
+                options.on_progress.nil? or options.on_progress.call(:open, args)
+              when :close
+                options.ui.logger.debug { "close(#{args[0].local})" }
+                options.on_progress.nil? or options.on_progress.call(:close, args)
+              when :mkdir
+                options.ui.logger.debug { "mkdir(#{args[0]})" }
+                options.on_progress.nil? or options.on_progress.call(:mkdir, args)
+              when :get
+                options.ui.logger.debug { "get(#{args[0].remote}, size #{args[2].size} bytes, offset #{args[1]})" }
+                options.on_progress.nil? or options.on_progress.call(:get, args)
+              when :finish
+                options.ui.logger.debug { "finish" }
+                options.on_progress.nil? or options.on_progress.call(:finish, args)
+              end
+            end
+          else
+            opened = false
+            args = []
+
+            scp.download!(remote.to_s, local.to_s, options.send(:table)) do |ch, name, sent, total|
+              args = [ OpenStruct.new(:size => total, :local => name, :remote => name), sent, '' ]
+
+              opened or (options.on_progress.nil? or options.on_progress.call(:open, args) and (opened = true))
+
+              options.ui.logger.debug { "get(#{args[0].remote}, sent #{args[1]}, total #{args[0].size})" }
               options.on_progress.nil? or options.on_progress.call(:get, args)
-            when :finish
-              options.ui.logger.debug { "finish" }
-              options.on_progress.nil? or options.on_progress.call(:finish, args)
             end
+
+            options.ui.logger.debug { "finish" }
+            options.on_progress.nil? or options.on_progress.call(:finish, args)
           end
         end
 

data/lib/ztk/ssh/private.rb

@@ -4,37 +4,77 @@ module ZTK
     # SSH Private Functionality
     module Private
 
+      # Builds our core options
+      def base_options
+        options = Hash.new
+
+        config.encryption.nil? or              options.merge!(:encryption => config.encryption)
+        config.compression.nil? or             options.merge!(:compression => config.compression)
+        config.compression_level.nil? or       options.merge!(:compression_level => config.compression_level)
+        config.timeout.nil? or                 options.merge!(:timeout => config.timeout)
+        config.forward_agent.nil? or           options.merge!(:forward_agent => config.forward_agent)
+        config.global_known_hosts_file.nil? or options.merge!(:global_known_hosts_file => config.global_known_hosts_file)
+        config.auth_methods.nil? or            options.merge!(:auth_methods => config.auth_methods)
+        config.host_key.nil? or                options.merge!(:host_key => config.host_key)
+        config.host_key_alias.nil? or          options.merge!(:host_key_alias => config.host_key_alias)
+        config.keys_only.nil? or               options.merge!(:keys_only => config.keys_only)
+        config.hmac.nil? or                    options.merge!(:hmac => config.hmac)
+        config.rekey_limit.nil? or             options.merge!(:rekey_limit => config.rekey_limit)
+        config.user_known_hosts_file.nil? or   options.merge!(:user_known_hosts_file => config.user_known_hosts_file)
+
+        options
+      end
+
       # Builds our SSH options hash.
       def ssh_options
-        options = {}
-
-        # These are plainly documented on the Net::SSH config class.
-        options.merge!(:encryption => config.encryption) if config.encryption
-        options.merge!(:compression => config.compression) if config.compression
-        options.merge!(:compression_level => config.compression_level) if config.compression_level
-        options.merge!(:timeout => config.timeout) if config.timeout
-        options.merge!(:forward_agent => config.forward_agent) if config.forward_agent
-        options.merge!(:global_known_hosts_file => config.global_known_hosts_file) if config.global_known_hosts_file
-        options.merge!(:auth_methods => config.auth_methods) if config.auth_methods
-        options.merge!(:host_key => config.host_key) if config.host_key
-        options.merge!(:host_key_alias => config.host_key_alias) if config.host_key_alias
-        options.merge!(:host_name => config.host_name) if config.host_name
-        options.merge!(:keys => config.keys) if config.keys
-        options.merge!(:keys_only => config.keys_only) if config.keys_only
-        options.merge!(:hmac => config.hmac) if config.hmac
-        options.merge!(:port => config.port) if config.port
-        options.merge!(:proxy => Net::SSH::Proxy::Command.new(proxy_command)) if config.proxy_host_name
-        options.merge!(:rekey_limit => config.rekey_limit) if config.rekey_limit
-        options.merge!(:user => config.user) if config.user
-        options.merge!(:user_known_hosts_file => config.user_known_hosts_file) if config.user_known_hosts_file
-
-        # This is not plainly documented on the Net::SSH config class.
-        options.merge!(:password => config.password) if config.password
+        process_keys
+        options = base_options
+
+        config.port.nil? or     options.merge!(:port => config.port)
+        config.password.nil? or options.merge!(:password => config.password)
+        config.keys.nil? or     options.merge!(:keys => config.keys)
 
         config.ui.logger.debug { "ssh_options(#{options.inspect})" }
         options
       end
 
+      # Builds our SSH gateway options hash.
+      def gateway_options
+        process_keys
+        options = base_options
+
+        config.proxy_port.nil? or     options.merge!(:port => config.proxy_port)
+        config.proxy_password.nil? or options.merge!(:password => config.proxy_password)
+        config.proxy_keys.nil? or     options.merge!(:keys => config.proxy_keys)
+
+        config.ui.logger.debug { "gateway_options(#{options.inspect})" }
+        options
+      end
+
+      # Iterate the keys and proxy_keys, converting them as needed.
+      def process_keys
+        config.keys = config.keys.collect do |key|
+          process_key(key)
+        end
+
+        config.proxy_keys = config.proxy_keys.collect do |proxy_key|
+          process_key(proxy_key)
+        end
+      end
+
+      # Process a individual key, rendering it to a temporary file if needed.
+      def process_key(key)
+        if ::File.exists?(key)
+          key
+        else
+          tempfile = ::Tempfile.new('key')
+          tempfile.write(key)
+          tempfile.flush
+
+          tempfile.path
+        end
+      end
+
       # Builds a human readable tag about our connection.  Used for internal
       # logging purposes.
       def tag

data/lib/ztk/ssh/upload.rb

@@ -19,8 +19,19 @@ module ZTK
       #
       # @param [String] local The local file/path you wish to upload from.
       # @param [String] remote The remote file/path you with to upload to.
+      # @param [Hash] options An optional hash of options.
+      # @option options [Boolean] :recursive (false) Whether or not to
+      #   recursively download files and directories.
+      # @option options [Boolean] :use_scp (false) If set to true, the file will
+      #   be transfered using SCP instead of SFTP.  The default behaviour is to
+      #   use SFTP.  *WARNING: Recursive downloads are handled in differing
+      #   manners between SCP and SFTP!*
       # @return [Boolean] True if successful.
       def upload(local, remote, options={})
+        options = {
+          :recursive => false,
+          :use_scp => false
+        }.merge(options)
         options = OpenStruct.new(config.send(:table).merge(options))
 
         options.ui.logger.debug { "config=#{config.send(:table).inspect}" }
@@ -28,24 +39,41 @@ module ZTK
         config.ui.logger.info { "upload(#{local.inspect}, #{remote.inspect})" }
 
         ZTK::RescueRetry.try(:ui => config.ui, :tries => ZTK::SSH::RESCUE_RETRY_ATTEMPTS, :on_retry => method(:on_retry)) do
-          sftp.upload!(local.to_s, remote.to_s) do |event, uploader, *args|
-            case event
-            when :open
-              options.ui.logger.debug { "upload(#{args[0].local} -> #{args[0].remote})" }
-              options.on_progress.nil? or options.on_progress.call(:open, args)
-            when :close
-              options.ui.logger.debug { "close(#{args[0].remote})" }
-              options.on_progress.nil? or options.on_progress.call(:close, args)
-            when :mkdir
-              options.ui.logger.debug { "mkdir(#{args[0]})" }
-              options.on_progress.nil? or options.on_progress.call(:mkdir, args)
-            when :put
-              options.ui.logger.debug { "put(#{args[0].remote}, size #{args[2].size} bytes, offset #{args[1]})" }
-              options.on_progress.nil? or options.on_progress.call(:put, args)
-            when :finish
-              options.ui.logger.debug { "finish" }
-              options.on_progress.nil? or options.on_progress.call(:finish, args)
+          if (options.use_scp == false)
+            sftp.upload!(local.to_s, remote.to_s) do |event, uploader, *args|
+              case event
+              when :open
+                options.ui.logger.debug { "upload(#{args[0].local} -> #{args[0].remote})" }
+                options.on_progress.nil? or options.on_progress.call(:open, args)
+              when :close
+                options.ui.logger.debug { "close(#{args[0].remote})" }
+                options.on_progress.nil? or options.on_progress.call(:close, args)
+              when :mkdir
+                options.ui.logger.debug { "mkdir(#{args[0]})" }
+                options.on_progress.nil? or options.on_progress.call(:mkdir, args)
+              when :put
+                options.ui.logger.debug { "put(#{args[0].remote}, size #{args[2].size} bytes, offset #{args[1]})" }
+                options.on_progress.nil? or options.on_progress.call(:put, args)
+              when :finish
+                options.ui.logger.debug { "finish" }
+                options.on_progress.nil? or options.on_progress.call(:finish, args)
+              end
             end
+          else
+            opened = false
+            args = []
+
+            scp.upload!(local.to_s, remote.to_s, options.send(:table)) do |ch, name, sent, total|
+              args = [ OpenStruct.new(:size => total, :local => name, :remote => name), sent, '' ]
+
+              opened or (options.on_progress.nil? or options.on_progress.call(:open, args) and (opened = true))
+
+              options.ui.logger.debug { "put(#{args[0].remote}, sent #{args[1]}, total #{args[0].size})" }
+              options.on_progress.nil? or options.on_progress.call(:get, args)
+            end
+
+            options.ui.logger.debug { "finish" }
+            options.on_progress.nil? or options.on_progress.call(:finish, args)
           end
         end
 

data/lib/ztk/version.rb

@@ -1,6 +1,6 @@
 module ZTK
 
   # ZTK Version String
-  VERSION = "1.9.1"
+  VERSION = "1.10.0"
 
 end

data/spec/ztk/ssh_spec.rb

@@ -231,68 +231,73 @@ describe ZTK::SSH do
 
     describe "upload" do
 
-      it "should be able to upload a file to 127.0.0.1 as the current user (your key must be in ssh-agent)" do
-        subject.config do |config|
-          config.ui = @ui
+      [true, false].each do |use_scp|
+        it "should be able to upload a file to 127.0.0.1 as the current user using #{use_scp ? 'scp' : 'sftp'} (your key must be in ssh-agent)" do
+          subject.config do |config|
+            config.ui = @ui
 
-          config.user = ENV["USER"]
-          config.host_name = "127.0.0.1"
-        end
+            config.user = ENV["USER"]
+            config.host_name = "127.0.0.1"
+          end
 
-        data = "Hello World @ #{Time.now.utc}"
+          data = "Hello World @ #{Time.now.utc}"
 
-        remote_file = File.join(ZTK::Locator.root, "tmp", "ssh-upload-remote")
-        File.exists?(remote_file) && File.delete(remote_file)
+          remote_file = File.join(ZTK::Locator.root, "tmp", "ssh-upload-remote")
+          File.exists?(remote_file) && File.delete(remote_file)
 
-        local_file = File.join(ZTK::Locator.root, "tmp", "ssh-upload-local")
-        if RUBY_VERSION < "1.9.3"
-          File.open(local_file, 'w') do |file|
-            file.puts(data)
+          local_file = File.join(ZTK::Locator.root, "tmp", "ssh-upload-local")
+          if RUBY_VERSION < "1.9.3"
+            File.open(local_file, 'w') do |file|
+              file.puts(data)
+            end
+          else
+            IO.write(local_file, data)
           end
-        else
-          IO.write(local_file, data)
-        end
 
-        File.exists?(remote_file).should == false
-        subject.upload(local_file, remote_file)
-        File.exists?(remote_file).should == true
+          File.exists?(remote_file).should == false
+          subject.upload(local_file, remote_file)
+          File.exists?(remote_file).should == true
 
-        File.exists?(remote_file) && File.delete(remote_file)
-        File.exists?(local_file) && File.delete(local_file)
+          File.exists?(remote_file) && File.delete(remote_file)
+          File.exists?(local_file) && File.delete(local_file)
+        end
       end
 
     end
 
     describe "download" do
 
-      it "should be able to download a file from 127.0.0.1 as the current user (your key must be in ssh-agent)" do
-        subject.config do |config|
-          config.ui = @ui
+      [true, false].each do |use_scp|
+        it "should be able to download a file from 127.0.0.1 as the current user using #{use_scp ? 'scp' : 'sftp'} (your key must be in ssh-agent)" do
+          subject.config do |config|
+            config.ui = @ui
 
-          config.user = ENV["USER"]
-          config.host_name = "127.0.0.1"
-        end
+            config.user = ENV["USER"]
+            config.host_name = "127.0.0.1"
+            config.use_scp = use_scp
+          end
 
-        data = "Hello World @ #{Time.now.utc}"
+          data = "Hello World @ #{Time.now.utc}"
 
-        local_file = File.join(ZTK::Locator.root, "tmp", "ssh-download-local")
-        File.exists?(local_file) && File.delete(local_file)
+          local_file = File.join(ZTK::Locator.root, "tmp", "ssh-download-local")
+          File.exists?(local_file) && File.delete(local_file)
 
-        remote_file = File.join(ZTK::Locator.root, "tmp", "ssh-download-remote")
-        if RUBY_VERSION < "1.9.3"
-          File.open(remote_file, 'w') do |file|
-            file.puts(data)
+          remote_file = File.join(ZTK::Locator.root, "tmp", "ssh-download-remote")
+          if RUBY_VERSION < "1.9.3"
+            File.open(remote_file, 'w') do |file|
+              file.puts(data)
+            end
+          else
+            IO.write(remote_file, data)
           end
-        else
-          IO.write(remote_file, data)
-        end
 
-        File.exists?(local_file).should == false
-        subject.download(remote_file, local_file)
-        File.exists?(local_file).should == true
+          File.exists?(local_file).should == false
+          subject.download(remote_file, local_file)
+          File.exists?(local_file).should == true
 
-        File.exists?(local_file) && File.delete(local_file)
-        File.exists?(remote_file) && File.delete(remote_file)
+          File.exists?(local_file) && File.delete(local_file)
+          File.exists?(remote_file) && File.delete(remote_file)
+        end
       end
 
     end
@@ -511,72 +516,76 @@ describe ZTK::SSH do
 
     describe "upload" do
 
-      it "should be able to upload a file to 127.0.0.1 as the current user (your key must be in ssh-agent)" do
-        subject.config do |config|
-          config.ui = @ui
+      [true, false].each do |use_scp|
+        it "should be able to upload a file to 127.0.0.1 as the current user #{use_scp ? 'scp' : 'sftp'} (your key must be in ssh-agent)" do
+          subject.config do |config|
+            config.ui = @ui
 
-          config.user = ENV["USER"]
-          config.host_name = "127.0.0.1"
-          config.proxy_user = ENV["USER"]
-          config.proxy_host_name = "127.0.0.1"
-        end
+            config.user = ENV["USER"]
+            config.host_name = "127.0.0.1"
+            config.proxy_user = ENV["USER"]
+            config.proxy_host_name = "127.0.0.1"
+          end
 
-        data = "Hello World @ #{Time.now.utc}"
+          data = "Hello World @ #{Time.now.utc}"
 
-        remote_file = File.join(ZTK::Locator.root, "tmp", "ssh-upload-remote")
-        File.exists?(remote_file) && File.delete(remote_file)
+          remote_file = File.join(ZTK::Locator.root, "tmp", "ssh-upload-remote")
+          File.exists?(remote_file) && File.delete(remote_file)
 
-        local_file = File.join(ZTK::Locator.root, "tmp", "ssh-upload-local")
-        if RUBY_VERSION < "1.9.3"
-          File.open(local_file, 'w') do |file|
-            file.puts(data)
+          local_file = File.join(ZTK::Locator.root, "tmp", "ssh-upload-local")
+          if RUBY_VERSION < "1.9.3"
+            File.open(local_file, 'w') do |file|
+              file.puts(data)
+            end
+          else
+            IO.write(local_file, data)
           end
-        else
-          IO.write(local_file, data)
-        end
 
-        File.exists?(remote_file).should == false
-        subject.upload(local_file, remote_file)
-        File.exists?(remote_file).should == true
+          File.exists?(remote_file).should == false
+          subject.upload(local_file, remote_file)
+          File.exists?(remote_file).should == true
 
-        File.exists?(remote_file) && File.delete(remote_file)
-        File.exists?(local_file) && File.delete(local_file)
+          File.exists?(remote_file) && File.delete(remote_file)
+          File.exists?(local_file) && File.delete(local_file)
+        end
       end
 
     end
 
     describe "download" do
 
-      it "should be able to download a file from 127.0.0.1 as the current user (your key must be in ssh-agent)" do
-        subject.config do |config|
-          config.ui = @ui
+      [true, false].each do |use_scp|
+        it "should be able to download a file from 127.0.0.1 as the current user using #{use_scp ? 'scp' : 'sftp'} (your key must be in ssh-agent)" do
+          subject.config do |config|
+            config.ui = @ui
 
-          config.user = ENV["USER"]
-          config.host_name = "127.0.0.1"
-          config.proxy_user = ENV["USER"]
-          config.proxy_host_name = "127.0.0.1"
-        end
+            config.user = ENV["USER"]
+            config.host_name = "127.0.0.1"
+            config.proxy_user = ENV["USER"]
+            config.proxy_host_name = "127.0.0.1"
+          end
 
-        data = "Hello World @ #{Time.now.utc}"
+          data = "Hello World @ #{Time.now.utc}"
 
-        local_file = File.join(ZTK::Locator.root, "tmp", "ssh-download-local")
-        File.exists?(local_file) && File.delete(local_file)
+          local_file = File.join(ZTK::Locator.root, "tmp", "ssh-download-local")
+          File.exists?(local_file) && File.delete(local_file)
 
-        remote_file = File.join(ZTK::Locator.root, "tmp", "ssh-download-remote")
-        if RUBY_VERSION < "1.9.3"
-          File.open(remote_file, 'w') do |file|
-            file.puts(data)
+          remote_file = File.join(ZTK::Locator.root, "tmp", "ssh-download-remote")
+          if RUBY_VERSION < "1.9.3"
+            File.open(remote_file, 'w') do |file|
+              file.puts(data)
+            end
+          else
+            IO.write(remote_file, data)
           end
-        else
-          IO.write(remote_file, data)
-        end
 
-        File.exists?(local_file).should == false
-        subject.download(remote_file, local_file)
-        File.exists?(local_file).should == true
+          File.exists?(local_file).should == false
+          subject.download(remote_file, local_file)
+          File.exists?(local_file).should == true
 
-        File.exists?(local_file) && File.delete(local_file)
-        File.exists?(remote_file) && File.delete(remote_file)
+          File.exists?(local_file) && File.delete(local_file)
+          File.exists?(remote_file) && File.delete(remote_file)
+        end
       end
 
     end

data/ztk.gemspec

@@ -39,7 +39,9 @@ Gem::Specification.new do |spec|
   spec.add_dependency("activesupport")
   spec.add_dependency("erubis")
   spec.add_dependency("net-ssh")
+  spec.add_dependency("net-ssh-gateway")
   spec.add_dependency("net-sftp")
+  spec.add_dependency("net-scp")
 
   spec.add_development_dependency("pry")
   spec.add_development_dependency("rake")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ztk
 version: !ruby/object:Gem::Version
-  version: 1.9.1
+  version: 1.10.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-05 00:00:00.000000000 Z
+date: 2013-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -59,6 +59,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: net-ssh-gateway
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: net-sftp
   requirement: !ruby/object:Gem::Requirement
@@ -75,6 +91,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: net-scp
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -275,7 +307,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4609495191496685449
+      hash: -3144121438206062484
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -284,7 +316,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4609495191496685449
+      hash: -3144121438206062484
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25