ztk 1.4.4 → 1.4.5

data/lib/ztk/dsl/core/relations/has_many.rb

@@ -1,26 +1,6 @@
-################################################################################
-#
-#      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::DSL::Core::Relations
 
-  # @author Zachary Patten <zachary@jovelabs.net>
+  # @author Zachary Patten <zachary AT jovelabs DOT com>
   # @api private
   module HasMany
 
@@ -57,7 +37,7 @@ module ZTK::DSL::Core::Relations
       end
     end
 
-    # @author Zachary Patten <zachary@jovelabs.net>
+    # @author Zachary Patten <zachary AT jovelabs DOT com>
     module ClassMethods
 
       def has_many(key, options={})

data/lib/ztk/locator.rb

@@ -1,30 +1,11 @@
-################################################################################
-#
-#      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
 
-  # ZTK::Locator Error Class
+  # Locator Error Class
   #
-  # @author Zachary Patten <zachary@jovelabs.net>
+  # @author Zachary Patten <zachary AT jovelabs DOT com>
   class LocatorError < Error; end
 
-  # @author Zachary Patten <zachary@jovelabs.net>
+  # @author Zachary Patten <zachary AT jovelabs DOT com>
   class Locator
 
     class << self

data/lib/ztk/logger.rb

@@ -1,23 +1,4 @@
-################################################################################
-#
-#      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.
-#
-################################################################################
-require "logger"
+require 'logger'
 
 module ZTK
 
@@ -41,7 +22,7 @@ module ZTK
   #     $logger.error { "This is a error message!" }
   #     $logger.fatal { "This is a fatal message!" }
   #
-  # @author Zachary Patten <zachary@jovelabs.net>
+  # @author Zachary Patten <zachary AT jovelabs DOT com>
   class Logger < ::Logger
 
     # Log Levels

data/lib/ztk/parallel.rb

@@ -1,29 +1,10 @@
-################################################################################
-#
-#      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.
-#
-################################################################################
-require "base64"
+require 'base64'
 
 module ZTK
 
-  # ZTK::Parallel Error Class
+  # Parallel Error Class
   #
-  # @author Zachary Patten <zachary@jovelabs.net>
+  # @author Zachary Patten <zachary AT jovelabs DOT com>
   class ParallelError < Error; end
 
   # Parallel Processing Class
@@ -112,7 +93,7 @@ module ZTK
   #     [0, 1, 2]
   #     => nil
   #
-  # @author Zachary Patten <zachary@jovelabs.net>
+  # @author Zachary Patten <zachary AT jovelabs DOT com>
   class Parallel < ZTK::Base
 
     # Default Maximum Number of Forks

data/lib/ztk/pty.rb

@@ -1,37 +1,22 @@
-################################################################################
-#
-#      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.
-#
-################################################################################
 require 'pty'
 
 module ZTK
 
-  # ZTK::PTY Error Class
-  # @author Zachary Patten <zachary@jovelabs.net>
+  # PTY Error Class
+  #
+  # @author Zachary Patten <zachary AT jovelabs DOT com>
   class PTYError < Error; end
 
   # Ruby PTY Class Wrapper
-  # @author Zachary Patten <zachary@jovelabs.net>
+  #
+  # Wraps the Ruby PTY class, providing better functionality.
+  #
+  # @author Zachary Patten <zachary AT jovelabs DOT com>
   class PTY
 
     class << self
 
-      # Wraps the Ruby PTY class, providing better functionality.
+      # Spawns a ruby-based PTY.
       #
       # @param [Array] args An argument splat to be passed to PTY::spawn
       #

data/lib/ztk/report.rb

@@ -1,33 +1,14 @@
-################################################################################
-#
-#      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.
-#
-################################################################################
 require 'socket'
 require 'timeout'
 
 module ZTK
 
-  # ZTK::Report Error Class
+  # Report Error Class
   #
-  # @author Zachary Patten <zachary@jovelabs.net>
+  # @author Zachary Patten <zachary AT jovelabs DOT com>
   class ReportError < Error; end
 
-  # ZTK Report Class
+  # Report Class
   #
   # This class contains tools for generating spreadsheet or key-value list
   # styled output.  Report methods are currently meant to be interchangeable;
@@ -36,7 +17,7 @@ module ZTK
   #
   # The idea here is that everything is auto-sized and simply displayed.
   #
-  # @author Zachary Patten <zachary@jovelabs.net>
+  # @author Zachary Patten <zachary AT jovelabs DOT com>
   class Report < ZTK::Base
 
     # @param [Hash] configuration Configuration options hash.

data/lib/ztk/rescue_retry.rb

@@ -1,31 +1,11 @@
-################################################################################
-#
-#      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
 
-  # ZTK::RescueRetry Error Class
+  # RescueRetry Error Class
   #
-  # @author Zachary Patten <zachary@jovelabs.net>
+  # @author Zachary Patten <zachary AT jovelabs DOT com>
   class RescueRetryError < Error; end
 
-  # ZTK RescueRetry Class
+  # RescueRetry Class
   #
   # This class contains an exception handling tool, which will allowing retry
   # of all or specific *Exceptions* based on a set number of attempts to make.
@@ -94,7 +74,7 @@ module ZTK
   #     1
   #     => nil
   #
-  # @author Zachary Patten <zachary@jovelabs.net>
+  # @author Zachary Patten <zachary AT jovelabs DOT com>
   class RescueRetry
 
     class << self

data/lib/ztk/spinner.rb

@@ -1,38 +1,19 @@
-################################################################################
-#
-#      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.
-#
-################################################################################
-require "ostruct"
+require 'ostruct'
 
 module ZTK
 
-  # ZTK::Spinner Error Class
+  # Spinner Error Class
   #
-  # @author Zachary Patten <zachary@jovelabs.net>
+  # @author Zachary Patten <zachary AT jovelabs DOT com>
   class SpinnerError < Error; end
 
-  # ZTK Spinner Class
+  # Spinner Class
   #
   # This class can be used to display an "activity indicator" to a user while
   # a task is executed in the supplied block.  This indicator takes the form
   # of a spinner.
   #
-  # @author Zachary Patten <zachary@jovelabs.net>
+  # @author Zachary Patten <zachary AT jovelabs DOT com>
   class Spinner
 
     class << self
@@ -54,7 +35,7 @@ module ZTK
       #   taking place "behind the scenes".
       # @return [Object] The return value of the block.
       #
-      # @author Zachary Patten <zachary@jovelabs.net>
+      # @author Zachary Patten <zachary AT jovelabs DOT com>
       # @author Stephen Nelson-Smith <stephen@atalanta-systems.com>
       def spin(options={}, &block)
         options = Base.build_config({

data/lib/ztk/ssh.rb

@@ -1,32 +1,13 @@
-################################################################################
-#
-#      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.
-#
-################################################################################
-require "ostruct"
-require "net/ssh"
-require "net/ssh/proxy/command"
-require "net/sftp"
+require 'ostruct'
+require 'net/ssh'
+require 'net/ssh/proxy/command'
+require 'net/sftp'
 
 module ZTK
 
-  # ZTK::SSH Error Class
+  # SSH Error Class
   #
-  # @author Zachary Patten <zachary@jovelabs.net>
+  # @author Zachary Patten <zachary AT jovelabs DOT com>
   class SSHError < Error; end
 
   # SSH Multi-function Class
@@ -82,7 +63,7 @@ module ZTK
   #       config.host_key_verify = true
   #     end
   #
-  # @author Zachary Patten <zachary@jovelabs.net>
+  # @author Zachary Patten <zachary AT jovelabs DOT com>
   class SSH < ZTK::Base
     # Exit Signal Mappings
     EXIT_SIGNALS = {
@@ -153,6 +134,16 @@ module ZTK
     #   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.
+    # @option options [Boolean] :ignore_exit_status (false) Whether or not
+    #   we should ignore the exit status of the the process we spawn.  By
+    #   default we do not ignore the exit status and throw an exception if it is
+    #   non-zero.
+    # @option options [Integer] :exit_code (0) The exit code we expect the
+    #   process to return.  This is ignore if *ignore_exit_status* is true.
+    # @option options [Boolean] :silence (false) Whether or not we should
+    #   squelch the output of the process.  The output will always go to the
+    #   logging device supplied in the ZTK::UI object.  The output is always
+    #   available in the return value from the method additionally.
     def initialize(configuration={})
       super({
         :forward_agent => true,
@@ -160,7 +151,9 @@ module ZTK
         :user_known_hosts_file => '/dev/null',
         :timeout => 60,
         :ignore_exit_status => false,
-        :request_pty => true
+        :request_pty => true,
+        :exit_code => 0,
+        :silence => false
       }.merge(configuration))
       config.ui.logger.debug { "config=#{config.send(:table).inspect}" }
     end

data/lib/ztk/ssh/bootstrap.rb

@@ -1,28 +1,26 @@
-################################################################################
-#
-#      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
 
+    # SSH Bootstrap Functionality
     module Bootstrap
       require 'tempfile'
 
+      # SSH Bootstrap
+      #
+      # Renders the *content* string into a file on the remote host and proceeds
+      # to execute it via */bin/bash*.  Sudo is prefixed by default, but can be
+      # disabled.
+      #
+      # @example Sample Bootstrap, assuming the @ssh variable is an instance of ZTK::SSH connected to a host.
+      #   @ssh.bootstrap(IO.read("bootstrap.sh"))
+      #
+      # @example
+      #   @ssh.bootstrap("apt-get -y upgrade")
+      #
+      # @param [String] content What to render out to the bootstrap file we will
+      #   execute.
+      # @param [Boolean] use_sudo Whether or not we should prefix *sudo*
+      #   on our command.
       def bootstrap(content, use_sudo=true)
         tempfile = Tempfile.new("bootstrap")