ztk 1.2.0 → 1.3.0

data/README.md

@@ -10,6 +10,10 @@ Zachary's (DevOp) Tool Kit is a general purpose utility gem, featuring a collect
 
 # RESOURCES
 
+Documentation:
+
+* http://zpatten.github.io/ztk/
+
 Source:
 
 * https://github.com/zpatten/ztk
@@ -18,10 +22,6 @@ Issues:
 
 * https://github.com/zpatten/ztk/issues
 
-Documentation:
-
-* http://zpatten.github.io/ztk/
-
 # LICENSE
 
 ZTK - Zachary's (DevOp) Tool Kit

data/lib/ztk/benchmark.rb

@@ -81,7 +81,7 @@ module ZTK
       #   after the block is yielded.  This *String* should have an *sprintf*
       #   floating point macro in it if the benchmark is desired to be embedded
       #   in the given *String*.
-      # @option options [Boolean] :use_spinner (true) Weither or not to use the
+      # @option options [Boolean] :use_spinner (true) Whether or not to use the
       #   ZTK::Spinner while benchmarking.
       #
       # @yield Block should execute the tasks to be benchmarked.

data/lib/ztk/ssh.rb

@@ -119,32 +119,40 @@ module ZTK
     autoload :Command,   'ztk/ssh/command'
     autoload :Download,  'ztk/ssh/download'
     autoload :Exec,      'ztk/ssh/exec'
+    autoload :File,      'ztk/ssh/file'
     autoload :Upload,    'ztk/ssh/upload'
 
     include ZTK::SSH::Bootstrap
     include ZTK::SSH::Command
     include ZTK::SSH::Download
     include ZTK::SSH::Exec
+    include ZTK::SSH::File
     include ZTK::SSH::Upload
 
     # @param [Hash] configuration Configuration options hash.
-    # @option config [String] :host_name Server hostname to connect to.
-    # @option config [String] :user Username to use for authentication.
-    # @option config [String, Array<String>] :keys A single or series of
+    # @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.
-    # @option config [String] :password Password to use for authentication.
-    # @option config [Integer] :timeout SSH connection timeout to use.
-    # @option config [Boolean] :compression Weither or not to use compression
-    #   for this session.
-    # @option config [Integer] :compression_level What level of compression to
-    #   use.
-    # @option config [String] :proxy_host_name Server hostname to proxy through.
-    # @option config [String] :proxy_user Username to use for proxy
+    # @option configuration [String] :password Password to use for authentication.
+    # @option configuration [Integer] :timeout (60) SSH connection timeout in
+    #   seconds to use.
+    # @option configuration [Boolean] :compression (false) Whether or not to use
+    #   compression for this session.
+    # @option configuration [Integer] :compression_level What level of
+    #   compression to use.
+    # @option configuration [String] :proxy_host_name Server hostname to proxy
+    #   through.
+    # @option configuration [String] :proxy_user Username to use for proxy
     #   authentication.
-    # @option config [Boolean] :request_pty Weither or not we should try to
-    #   obtain a PTY
-    # @option config [String, Array<String>] :proxy_keys A single or series of
-    #   identity files to use for authentication with the proxy.
+    # @option configuration [Boolean] :request_pty (true) Whether or not we
+    #   should try to obtain a PTY
+    # @option configuration [Boolean] :ignore_exit_status (false) Whether or not
+    #   we should throw an exception if the exit status is not kosher.
+    # @option configuration [Boolean] :forward_agent (true) Whether or not to
+    #   enable SSH agent forwarding.
+    # @option configuration [String, Array<String>] :proxy_keys A single or
+    #   series of identity files to use for authentication with the proxy.
     def initialize(configuration={})
       super({
         :forward_agent => true,
@@ -181,7 +189,6 @@ module ZTK
     # process.
     #
     # @example Launch a console:
-    #   $logger = ZTK::Logger.new(STDOUT)
     #   ssh = ZTK::SSH.new
     #   ssh.config do |config|
     #     config.user = ENV["USER"]

data/lib/ztk/ssh/bootstrap.rb

@@ -26,7 +26,7 @@ module ZTK
       def bootstrap(content, use_sudo=true)
         tempfile = Tempfile.new("bootstrap")
 
-        File.open(tempfile, 'w') do |file|
+        ::File.open(tempfile, 'w') do |file|
           file.puts(content)
           file.respond_to?(:flush) and file.flush
         end

data/lib/ztk/ssh/file.rb

@@ -0,0 +1,65 @@
+################################################################################
+#
+#      Author: Zachary Patten <zachary@jovelabs.net>
+#   Copyright: Copyright (c) Zachary Patten
+#     License: Apache License, Version 2.0
+#
+#   Licensed under the Apache License, Version 2.0 (the "License");
+#   you may not use this file except in compliance with the License.
+#   You may obtain a copy of the License at
+#
+#       http://www.apache.org/licenses/LICENSE-2.0
+#
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS,
+#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#   See the License for the specific language governing permissions and
+#   limitations under the License.
+#
+################################################################################
+module ZTK
+  class SSH
+
+    module File
+      require 'tempfile'
+
+      # Opens a temporary local file, yielding this to the supplied block.  Once
+      # the block returns the temporary file is uploaded to the remote host and
+      # installed as the supplied target.
+      #
+      # If the optional 'chown' or 'chmod' options are supplied then their
+      # respective actions will be taken on the target file on the remote host.
+      #
+      # @param [Hash] options The options hash.
+      # @option options [String] :target The target file on the remote host.
+      # @option options [String] :chown A user:group representation of who
+      #   to change ownership of the target file to (i.e. 'root:root').
+      # @option options [String] :chmod An octal file mode which to set the
+      #   target file to (i.e. '0755').
+      # @return [Boolean] Returns true if successfull.
+      def file(options={}, &block)
+        target = options[:target]
+        chown  = options[:chown]
+        chmod  = options[:chmod]
+
+        target.nil? and raise SSHError, "You must supply a target file!"
+        !block_given? and raise SSHError, "You must supply a block!"
+
+        tempfile = Tempfile.new("tempfile")
+        ::File.open(tempfile, 'w') do |file|
+          yield(file)
+        end
+        self.upload(tempfile.path, tempfile.path)
+
+        self.exec(%(sudo mv -v #{tempfile.path} #{target}), :silence => true)
+
+        self.exec(%(sudo chown -v #{chown} #{target}), :silence => true) if !chown.nil?
+        self.exec(%(sudo chmod -v #{chmod} #{target}), :silence => true) if !chmod.nil?
+
+        true
+      end
+
+    end
+
+  end
+end

data/lib/ztk/tcp_socket_check.rb

@@ -101,7 +101,7 @@ module ZTK
     # method will timeout and return false after the amount of seconds specified
     # in *config.timeout* has passed if the socket has not become ready.
     #
-    # @return [Boolean] Returns true or false depending on weither the socket
+    # @return [Boolean] Returns true or false depending on Whether the socket
     #   is ready or not.
     def ready?
       config.host.nil? and log_and_raise(TCPSocketCheckError, "You must supply a host!")
@@ -128,7 +128,7 @@ module ZTK
     # method will timeout and return false after the amount of seconds specified
     # in *config.wait* has passed if the socket has not become ready.
     #
-    # @return [Boolean] Returns true or false depending on weither the socket
+    # @return [Boolean] Returns true or false depending on Whether the socket
     #   became ready or not.
     def wait
       config.ui.logger.debug { "Waiting for socket to become available; timeout after #{config.wait} seconds." }

data/lib/ztk/version.rb

@@ -21,6 +21,6 @@
 module ZTK
 
   # ZTK Version String
-  VERSION = "1.2.0"
+  VERSION = "1.3.0"
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ztk
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-27 00:00:00.000000000 Z
+date: 2013-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erubis
@@ -204,6 +204,7 @@ files:
 - lib/ztk/ssh/command.rb
 - lib/ztk/ssh/download.rb
 - lib/ztk/ssh/exec.rb
+- lib/ztk/ssh/file.rb
 - lib/ztk/ssh/upload.rb
 - lib/ztk/tcp_socket_check.rb
 - lib/ztk/template.rb
@@ -245,7 +246,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1781664085234422223
+      hash: 2390490628279422468
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -254,7 +255,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1781664085234422223
+      hash: 2390490628279422468
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25