ztk 1.4.4 → 1.4.5

data/lib/ztk/ssh/command.rb

@@ -1,25 +1,7 @@
-################################################################################
-#
-#      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 Console Command Helpers
     module Command
 
       # Builds our SSH console command.

data/lib/ztk/ssh/download.rb

@@ -1,25 +1,7 @@
-################################################################################
-#
-#      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 Download Functionality
     module Download
 
       # Downloads a remote file to the local host.

data/lib/ztk/ssh/exec.rb

@@ -1,35 +1,25 @@
-################################################################################
-#
-#      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 Command Execution Functionality
     module Exec
 
       # Executes a command on the remote host.
       #
       # @param [String] command The command to execute.
       # @param [Hash] options The options hash for executing the command.
-      # @option options [Boolean] :silence Squelch output to STDOUT and STDERR.
-      #   If the log level is :debug, STDOUT and STDERR will go to the log file
-      #   regardless of this setting.  STDOUT and STDERR are always returned in
-      #   the output return value regardless of this setting.
+      # @option options [Integer] :timeout (600) How long in seconds before
+      #   the command will timeout.
+      # @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.
       #
       # @return [OpenStruct#output] The output of the command, both STDOUT and
       #   STDERR.
@@ -44,7 +34,7 @@ module ZTK
       #   end
       #   puts ssh.exec("hostname").inspect
       def exec(command, options={})
-        options = OpenStruct.new({ :exit_code => 0, :silence => false }.merge(config.send(:table)).merge(options))
+        options = OpenStruct.new(config.send(:table).merge(options))
 
         options.ui.logger.debug { "config=#{options.send(:table).inspect}" }
         options.ui.logger.debug { "options=#{options.send(:table).inspect}" }

data/lib/ztk/ssh/file.rb

@@ -1,25 +1,7 @@
-################################################################################
-#
-#      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 Remote File Functionality
     module File
       require 'tempfile'
 

data/lib/ztk/ssh/upload.rb

@@ -1,32 +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
   class SSH
 
+    # SSH Upload Functionality
     module Upload
 
       # Uploads a local file to a remote host.
       #
-      # @param [String] local The local file/path you wish to upload from.
-      # @param [String] remote The remote file/path you with to upload to.
-      #
       # @example Upload a file:
       #   $logger = ZTK::Logger.new(STDOUT)
       #   ssh = ZTK::SSH.new
@@ -37,6 +16,10 @@ module ZTK
       #   local = File.expand_path(File.join(ENV["HOME"], ".ssh", "id_rsa.pub"))
       #   remote = File.expand_path(File.join("/tmp", "id_rsa.pub"))
       #   ssh.upload(local, remote)
+      #
+      # @param [String] local The local file/path you wish to upload from.
+      # @param [String] remote The remote file/path you with to upload to.
+      # @return [Boolean] True if successful.
       def upload(local, remote)
         config.ui.logger.debug { "config=#{config.send(:table).inspect}" }
         config.ui.logger.info { "upload(#{local.inspect}, #{remote.inspect})" }

data/lib/ztk/tcp_socket_check.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.
-#
-################################################################################
 require 'socket'
 require 'timeout'
 
 module ZTK
 
-  # ZTK::TCPSocketCheck Error Class
+  # TCPSocketCheck Error Class
   #
-  # @author Zachary Patten <zachary@jovelabs.net>
+  # @author Zachary Patten <zachary AT jovelabs DOT com>
   class TCPSocketCheckError < Error; end
 
   # TCP Socket Checking Class
@@ -79,7 +60,7 @@ module ZTK
   #
   # The wait methods timeout is bound to the configuration option *wait*.
   #
-  # @author Zachary Patten <zachary@jovelabs.net>
+  # @author Zachary Patten <zachary AT jovelabs DOT com>
   class TCPSocketCheck < ZTK::Base
 
     # @param [Hash] configuration Configuration options hash.

data/lib/ztk/template.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 "erubis"
+require 'erubis'
 
 module ZTK
 
-  # ZTK::Template Error Class
+  # Template Error Class
   #
-  # @author Zachary Patten <zachary@jovelabs.net>
+  # @author Zachary Patten <zachary AT jovelabs DOT com>
   class TemplateError < Error; end
 
   # Erubis Templating Class
@@ -42,7 +23,7 @@ module ZTK
   #     This is a test template!
   #     Hello World
   #
-  # @author Zachary Patten <zachary@jovelabs.net>
+  # @author Zachary Patten <zachary AT jovelabs DOT com>
   class Template
 
     class << self

data/lib/ztk/ui.rb

@@ -1,38 +1,18 @@
-################################################################################
-#
-#      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::UI Error Class
+  # UI Error Class
   #
-  # @author Zachary Patten <zachary@jovelabs.net>
+  # @author Zachary Patten <zachary AT jovelabs DOT com>
   class UIError < Error; end
 
-  # ZTK UI Class
+  # UI Class
   #
   # This class encapsulates a STDOUT, STDERR, STDIN
   # and logging device.
   #
-  # @author Zachary Patten <zachary@jovelabs.net>
+  # @author Zachary Patten <zachary AT jovelabs DOT com>
   class UI < ZTK::Base
 
     attr_accessor :stdout, :stderr, :stdin, :logger

data/lib/ztk/version.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
 
   # ZTK Version String
-  VERSION = "1.4.4"
+  VERSION = "1.4.5"
 
 end

data/spec/spec_helper.rb

@@ -1,6 +1,6 @@
 ################################################################################
 #
-#      Author: Zachary Patten <zachary@jovelabs.net>
+#      Author: Zachary Patten <zachary AT jovelabs DOT com>
 #   Copyright: Copyright (c) Zachary Patten
 #     License: Apache License, Version 2.0
 #

data/spec/ztk/background_spec.rb

@@ -1,6 +1,6 @@
 ################################################################################
 #
-#      Author: Zachary Patten <zachary@jovelabs.net>
+#      Author: Zachary Patten <zachary AT jovelabs DOT com>
 #   Copyright: Copyright (c) Zachary Patten
 #     License: Apache License, Version 2.0
 #

data/spec/ztk/base_spec.rb

@@ -1,6 +1,6 @@
 ################################################################################
 #
-#      Author: Zachary Patten <zachary@jovelabs.net>
+#      Author: Zachary Patten <zachary AT jovelabs DOT com>
 #   Copyright: Copyright (c) Zachary Patten
 #     License: Apache License, Version 2.0
 #

data/spec/ztk/benchmark_spec.rb

@@ -1,6 +1,6 @@
 ################################################################################
 #
-#      Author: Zachary Patten <zachary@jovelabs.net>
+#      Author: Zachary Patten <zachary AT jovelabs DOT com>
 #   Copyright: Copyright (c) Zachary Patten
 #     License: Apache License, Version 2.0
 #

data/spec/ztk/command_spec.rb

@@ -1,6 +1,6 @@
 ################################################################################
 #
-#      Author: Zachary Patten <zachary@jovelabs.net>
+#      Author: Zachary Patten <zachary AT jovelabs DOT com>
 #   Copyright: Copyright (c) Zachary Patten
 #     License: Apache License, Version 2.0
 #

data/spec/ztk/config_spec.rb

@@ -1,6 +1,6 @@
 ################################################################################
 #
-#      Author: Zachary Patten <zachary@jovelabs.net>
+#      Author: Zachary Patten <zachary AT jovelabs DOT com>
 #   Copyright: Copyright (c) Zachary Patten
 #     License: Apache License, Version 2.0
 #

data/spec/ztk/dsl_spec.rb

@@ -1,6 +1,6 @@
 ################################################################################
 #
-#      Author: Zachary Patten <zachary@jovelabs.net>
+#      Author: Zachary Patten <zachary AT jovelabs DOT com>
 #   Copyright: Copyright (c) Zachary Patten
 #     License: Apache License, Version 2.0
 #

data/spec/ztk/locator_spec.rb

@@ -1,6 +1,6 @@
 ################################################################################
 #
-#      Author: Zachary Patten <zachary@jovelabs.net>
+#      Author: Zachary Patten <zachary AT jovelabs DOT com>
 #   Copyright: Copyright (c) Zachary Patten
 #     License: Apache License, Version 2.0
 #

data/spec/ztk/logger_spec.rb

@@ -1,6 +1,6 @@
 ################################################################################
 #
-#      Author: Zachary Patten <zachary@jovelabs.net>
+#      Author: Zachary Patten <zachary AT jovelabs DOT com>
 #   Copyright: Copyright (c) Zachary Patten
 #     License: Apache License, Version 2.0
 #

data/spec/ztk/parallel_spec.rb

@@ -1,6 +1,6 @@
 ################################################################################
 #
-#      Author: Zachary Patten <zachary@jovelabs.net>
+#      Author: Zachary Patten <zachary AT jovelabs DOT com>
 #   Copyright: Copyright (c) Zachary Patten
 #     License: Apache License, Version 2.0
 #

data/spec/ztk/pty_spec.rb

@@ -1,6 +1,6 @@
 ################################################################################
 #
-#      Author: Zachary Patten <zachary@jovelabs.net>
+#      Author: Zachary Patten <zachary AT jovelabs DOT com>
 #   Copyright: Copyright (c) Zachary Patten
 #     License: Apache License, Version 2.0
 #