winrm-fs 1.0.1 → 1.0.2

data/lib/winrm-fs/core/tmp_zip.rb

@@ -1,166 +1,177 @@
-# -*- encoding: utf-8 -*-
-#
-# Author:: Fletcher (<fnichol@nichol.ca>)
-#
-# Copyright (C) 2015, Fletcher Nichol
-#
-# 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 'delegate'
-require 'pathname'
-require 'tempfile'
-require 'zip'
-
-module WinRM
-  module FS
-    module Core
-      # A temporary Zip file for a given directory.
-      #
-      # @author Fletcher Nichol <fnichol@nichol.ca>
-      class TmpZip
-        # Contructs a new Zip file for the given directory.
-        #
-        # There are 2 ways to interpret the directory path:
-        #
-        # * If the directory has no path separator terminator, then the
-        #   directory basename will be used as the base directory in the
-        #   resulting zip file.
-        # * If the directory has a path separator terminator (such as `/` or
-        #   `\\`), then the entries under the directory will be added to the
-        #   resulting zip file.
-        #
-        # The following emaples assume a directory tree structure of:
-        #
-        #     src
-        #     |-- alpha.txt
-        #     |-- beta.txt
-        #     \-- sub
-        #         \-- charlie.txt
-        #
-        # @example Including the base directory in the zip file
-        #
-        #   TmpZip.new("/path/to/src")
-        #   # produces a zip file with entries:
-        #   # - src/alpha.txt
-        #   # - src/beta.txt
-        #   # - src/sub/charlie.txt
-        #
-        # @example Excluding the base directory in the zip file
-        #
-        #   TmpZip.new("/path/to/src/")
-        #   # produces a zip file with entries:
-        #   # - alpha.txt
-        #   # - beta.txt
-        #   # - sub/charlie.txt
-        #
-        # @param dir [String,Pathname,#to_s] path to the directory
-        # @param logger [#debug,#debug?] an optional logger/ui object that
-        #   responds to `#debug` and `#debug?` (default `nil`)
-        def initialize(dir, logger = nil)
-          @logger = logger || Logging.logger[self]
-          @dir = Pathname.new(dir)
-          @zip_io = Tempfile.open(['tmpzip-', '.zip'], binmode: true)
-          write_zip
-          @zip_io.close
-        end
-
-        # @return [Pathname] path to zip file
-        def path
-          Pathname.new(zip_io.path) if zip_io.path
-        end
-
-        # Unlinks (deletes) the zip file from the filesystem.
-        def unlink
-          zip_io.unlink
-        end
-
-        private
-
-        # @return [Pathname] the directory used to create the Zip file
-        # @api private
-        attr_reader :dir
-
-        # @return [#debug] the logger
-        # @api private
-        attr_reader :logger
-
-        # @return [IO] the Zip file IO
-        # @api private
-        attr_reader :zip_io
-
-        # @return [Array<Pathname] all recursive files under the base
-        #   directory, excluding directories
-        # @api private
-        def entries
-          Pathname.glob(dir.join('**/*')).delete_if(&:directory?).sort
-        end
-
-        # (see Logging.log_subject)
-        # @api private
-        def log_subject
-          @log_subject ||= [self.class.to_s.split('::').last, path].join('::')
-        end
-
-        # Adds all file entries to the Zip output stream.
-        #
-        # @param zos [Zip::OutputStream] zip output stream
-        # @api private
-        def produce_zip_entries(zos)
-          entries.each do |entry|
-            entry_path = entry.sub(/#{dir}\//i, '')
-            logger.debug "+++ Adding #{entry_path}"
-            zos.put_next_entry(
-              zip_entry(entry_path),
-              nil, nil, ::Zip::Entry::DEFLATED, Zlib::BEST_COMPRESSION)
-            entry.open('rb') { |src| IO.copy_stream(src, zos) }
-          end
-          logger.debug '=== All files added.'
-        end
-
-        # Writes out a temporary Zip file.
-        #
-        # @api private
-        def write_zip
-          logger.debug 'Populating files'
-          Zip::OutputStream.write_buffer(NoDupIO.new(zip_io)) do |zos|
-            produce_zip_entries(zos)
-          end
-        end
-
-        def zip_entry(entry_path)
-          Zip::Entry.new(
-            zip_io.path,
-            entry_path.to_s,
-            nil, nil, nil, nil, nil, nil,
-            ::Zip::DOSTime.new(2000)
-          )
-        end
-
-        # Simple delegate wrapper to prevent `#dup` calls being made on IO
-        # objects. This is used to bypass an issue in the `Zip::Outputstream`
-        # constructor where an incoming IO is duplicated, leading to races
-        # on flushing the final stream to disk.
-        #
-        # @author Fletcher Nichol <fnichol@nichol.ca>
-        # @api private
-        class NoDupIO < SimpleDelegator
-          # @return [self] returns self and does *not* return a duplicate
-          #   object
-          def dup
-            self
-          end
-        end
-      end
-    end
-  end
-end
+# -*- encoding: utf-8 -*-
+#
+# Author:: Fletcher (<fnichol@nichol.ca>)
+#
+# Copyright (C) 2015, Fletcher Nichol
+#
+# 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 'delegate'
+require 'pathname'
+require 'tempfile'
+require 'zip'
+
+module WinRM
+  module FS
+    module Core
+      # A temporary Zip file for a given directory.
+      #
+      # @author Fletcher Nichol <fnichol@nichol.ca>
+      class TmpZip
+        # Contructs a new Zip file for the given directory.
+        #
+        # There are 2 ways to interpret the directory path:
+        #
+        # * If the directory has no path separator terminator, then the
+        #   directory basename will be used as the base directory in the
+        #   resulting zip file.
+        # * If the directory has a path separator terminator (such as `/` or
+        #   `\\`), then the entries under the directory will be added to the
+        #   resulting zip file.
+        #
+        # The following emaples assume a directory tree structure of:
+        #
+        #     src
+        #     |-- alpha.txt
+        #     |-- beta.txt
+        #     \-- sub
+        #         \-- charlie.txt
+        #
+        # @example Including the base directory in the zip file
+        #
+        #   TmpZip.new("/path/to/src")
+        #   # produces a zip file with entries:
+        #   # - src/alpha.txt
+        #   # - src/beta.txt
+        #   # - src/sub/charlie.txt
+        #
+        # @example Excluding the base directory in the zip file
+        #
+        #   TmpZip.new("/path/to/src/")
+        #   # produces a zip file with entries:
+        #   # - alpha.txt
+        #   # - beta.txt
+        #   # - sub/charlie.txt
+        #
+        # @param dir [String,Pathname,#to_s] path to the directory
+        # @param logger [#debug,#debug?] an optional logger/ui object that
+        #   responds to `#debug` and `#debug?` (default `nil`)
+        def initialize(dir, logger = nil)
+          @logger = logger || Logging.logger[self]
+          @dir = clean_dirname(dir)
+          @zip_io = Tempfile.open(['tmpzip-', '.zip'], binmode: true)
+          write_zip
+          @zip_io.close
+        end
+
+        # @return [Pathname] path to zip file
+        def path
+          Pathname.new(zip_io.path) if zip_io.path
+        end
+
+        # Unlinks (deletes) the zip file from the filesystem.
+        def unlink
+          zip_io.unlink
+        end
+
+        private
+
+        # @return [Pathname] the directory used to create the Zip file
+        # @api private
+        attr_reader :dir
+
+        # @return [#debug] the logger
+        # @api private
+        attr_reader :logger
+
+        # @return [IO] the Zip file IO
+        # @api private
+        attr_reader :zip_io
+
+        # @return [Pathname] the pathname object representing dirname that
+        # doesn't have any of those ~ in it
+        # @api private
+        def clean_dirname(dir)
+          paths = Pathname.glob(dir)
+          if paths.length != 1
+            fail "Expected Pathname.glob(dir) to return only dir, got #{paths}"
+          end
+          paths.first
+        end
+
+        # @return [Array<Pathname] all recursive files under the base
+        #   directory, excluding directories
+        # @api private
+        def entries
+          Pathname.glob(dir.join('**/*')).delete_if(&:directory?).sort
+        end
+
+        # (see Logging.log_subject)
+        # @api private
+        def log_subject
+          @log_subject ||= [self.class.to_s.split('::').last, path].join('::')
+        end
+
+        # Adds all file entries to the Zip output stream.
+        #
+        # @param zos [Zip::OutputStream] zip output stream
+        # @api private
+        def produce_zip_entries(zos)
+          entries.each do |entry|
+            entry_path = entry.sub(/#{dir}\//i, '')
+            logger.debug "+++ Adding #{entry_path}"
+            zos.put_next_entry(
+              zip_entry(entry_path),
+              nil, nil, ::Zip::Entry::DEFLATED, Zlib::BEST_COMPRESSION)
+            entry.open('rb') { |src| IO.copy_stream(src, zos) }
+          end
+          logger.debug '=== All files added.'
+        end
+
+        # Writes out a temporary Zip file.
+        #
+        # @api private
+        def write_zip
+          logger.debug 'Populating files'
+          Zip::OutputStream.write_buffer(NoDupIO.new(zip_io)) do |zos|
+            produce_zip_entries(zos)
+          end
+        end
+
+        def zip_entry(entry_path)
+          Zip::Entry.new(
+            zip_io.path,
+            entry_path.to_s,
+            nil, nil, nil, nil, nil, nil,
+            ::Zip::DOSTime.new(2000)
+          )
+        end
+
+        # Simple delegate wrapper to prevent `#dup` calls being made on IO
+        # objects. This is used to bypass an issue in the `Zip::Outputstream`
+        # constructor where an incoming IO is duplicated, leading to races
+        # on flushing the final stream to disk.
+        #
+        # @author Fletcher Nichol <fnichol@nichol.ca>
+        # @api private
+        class NoDupIO < SimpleDelegator
+          # @return [self] returns self and does *not* return a duplicate
+          #   object
+          def dup
+            self
+          end
+        end
+      end
+    end
+  end
+end

data/lib/winrm-fs/exceptions.rb

@@ -1,28 +1,28 @@
-# encoding: UTF-8
-#
-# Copyright 2015 Shawn Neal <sneal@sneal.net>
-#
-# 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 WinRM
-  module FS
-    # WinRM-FS base class for errors
-    class WinRMFSError < StandardError; end
-
-    # Error that occurs when a file upload fails
-    class WinRMUploadError < WinRMFSError; end
-
-    # Error that occurs when a file download fails
-    class WinRMDownloadError < WinRMFSError; end
-  end
-end
+# encoding: UTF-8
+#
+# Copyright 2015 Shawn Neal <sneal@sneal.net>
+#
+# 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 WinRM
+  module FS
+    # WinRM-FS base class for errors
+    class WinRMFSError < StandardError; end
+
+    # Error that occurs when a file upload fails
+    class WinRMUploadError < WinRMFSError; end
+
+    # Error that occurs when a file download fails
+    class WinRMDownloadError < WinRMFSError; end
+  end
+end

data/lib/winrm-fs/file_manager.rb

@@ -1,117 +1,118 @@
-# encoding: UTF-8
-#
-# Copyright 2015 Shawn Neal <sneal@sneal.net>
-#
-# 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 'winrm'
-require_relative 'scripts/scripts'
-require_relative 'core/file_transporter'
-
-module WinRM
-  module FS
-    # Perform file transfer operations between a local machine and winrm endpoint
-    class FileManager
-      # Creates a new FileManager instance
-      # @param [WinRM::Connection] WinRM web connection client
-      def initialize(connection)
-        @connection = connection
-        @logger = connection.logger
-      end
-
-      # Gets the MD5 checksum of the specified file if it exists,
-      # otherwise ''
-      # @param [String] The remote file path
-      def checksum(path)
-        @logger.debug("checksum: #{path}")
-        script = WinRM::FS::Scripts.render('checksum', path: path)
-        @connection.shell(:powershell) { |e| e.run(script).stdout.chomp }
-      end
-
-      # Create the specifed directory recursively
-      # @param [String] The remote dir to create
-      # @return [Boolean] True if successful, otherwise false
-      def create_dir(path)
-        @logger.debug("create_dir: #{path}")
-        script = WinRM::FS::Scripts.render('create_dir', path: path)
-        @connection.shell(:powershell) { |e| e.run(script).exitcode == 0 }
-      end
-
-      # Deletes the file or directory at the specified path
-      # @param [String] The path to remove
-      # @return [Boolean] True if successful, otherwise False
-      def delete(path)
-        @logger.debug("deleting: #{path}")
-        script = WinRM::FS::Scripts.render('delete', path: path)
-        @connection.shell(:powershell) { |e| e.run(script).exitcode == 0 }
-      end
-
-      # Downloads the specified remote file to the specified local path
-      # @param [String] The full path on the remote machine
-      # @param [String] The full path to write the file to locally
-      def download(remote_path, local_path)
-        @logger.debug("downloading: #{remote_path} -> #{local_path}")
-        script = WinRM::FS::Scripts.render('download', path: remote_path)
-        output = @connection.shell(:powershell) { |e| e.run(script) }
-        return false if output.exitcode != 0
-        contents = output.stdout.gsub('\n\r', '')
-        out = Base64.decode64(contents)
-        IO.binwrite(local_path, out)
-        true
-      end
-
-      # Checks to see if the given path exists on the target file system.
-      # @param [String] The full path to the directory or file
-      # @return [Boolean] True if the file/dir exists, otherwise false.
-      def exists?(path)
-        @logger.debug("exists?: #{path}")
-        script = WinRM::FS::Scripts.render('exists', path: path)
-        @connection.shell(:powershell) { |e| e.run(script).exitcode == 0 }
-      end
-
-      # Gets the current user's TEMP directory on the remote system, for example
-      # 'C:/Windows/Temp'
-      # @return [String] Full path to the temp directory
-      def temp_dir
-        @guest_temp ||= begin
-          (@connection.shell(:powershell) { |e| e.run('$env:TEMP') }).stdout.chomp.gsub('\\', '/')
-        end
-      end
-
-      # Upload one or more local files and directories to a remote directory
-      # @example copy a single file to a winrm endpoint
-      #
-      #   file_manager.upload('/Users/sneal/myfile.txt', 'c:/foo/myfile.txt')
-      #
-      # @example copy a single directory to a winrm endpoint
-      #
-      #   file_manager.upload('c:/dev/my_dir', '$env:AppData')
-      #
-      # @param [String] A path to a local directory or file that will be copied
-      #   to the remote Windows box.
-      # @param [String] The target directory or file
-      #   This path may contain powershell style environment variables
-      # @yieldparam [Fixnum] Number of bytes copied in current payload sent to the winrm endpoint
-      # @yieldparam [Fixnum] The total number of bytes to be copied
-      # @yieldparam [String] Path of file being copied
-      # @yieldparam [String] Target path on the winrm endpoint
-      # @return [Fixnum] The total number of bytes copied
-      def upload(local_path, remote_path, &block)
-        @connection.shell(:powershell) do |shell|
-          file_transporter ||= WinRM::FS::Core::FileTransporter.new(shell)
-          file_transporter.upload(local_path, remote_path, &block)[0]
-        end
-      end
-    end
-  end
-end
+# encoding: UTF-8
+#
+# Copyright 2015 Shawn Neal <sneal@sneal.net>
+#
+# 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 'winrm'
+require_relative 'scripts/scripts'
+require_relative 'core/file_transporter'
+
+module WinRM
+  module FS
+    # Perform file transfer operations between a local machine and winrm endpoint
+    class FileManager
+      # Creates a new FileManager instance
+      # @param [WinRM::Connection] WinRM web connection client
+      def initialize(connection)
+        @connection = connection
+        @logger = connection.logger
+      end
+
+      # Gets the MD5 checksum of the specified file if it exists,
+      # otherwise ''
+      # @param [String] The remote file path
+      # @parms [String] The digest method
+      def checksum(path, digest = 'MD5')
+        @logger.debug("checksum with #{digest}: #{path}")
+        script = WinRM::FS::Scripts.render('checksum', path: path, digest: digest)
+        @connection.shell(:powershell) { |e| e.run(script).stdout.chomp }
+      end
+
+      # Create the specifed directory recursively
+      # @param [String] The remote dir to create
+      # @return [Boolean] True if successful, otherwise false
+      def create_dir(path)
+        @logger.debug("create_dir: #{path}")
+        script = WinRM::FS::Scripts.render('create_dir', path: path)
+        @connection.shell(:powershell) { |e| e.run(script).exitcode == 0 }
+      end
+
+      # Deletes the file or directory at the specified path
+      # @param [String] The path to remove
+      # @return [Boolean] True if successful, otherwise False
+      def delete(path)
+        @logger.debug("deleting: #{path}")
+        script = WinRM::FS::Scripts.render('delete', path: path)
+        @connection.shell(:powershell) { |e| e.run(script).exitcode == 0 }
+      end
+
+      # Downloads the specified remote file to the specified local path
+      # @param [String] The full path on the remote machine
+      # @param [String] The full path to write the file to locally
+      def download(remote_path, local_path)
+        @logger.debug("downloading: #{remote_path} -> #{local_path}")
+        script = WinRM::FS::Scripts.render('download', path: remote_path)
+        output = @connection.shell(:powershell) { |e| e.run(script) }
+        return false if output.exitcode != 0
+        contents = output.stdout.gsub('\n\r', '')
+        out = Base64.decode64(contents)
+        IO.binwrite(local_path, out)
+        true
+      end
+
+      # Checks to see if the given path exists on the target file system.
+      # @param [String] The full path to the directory or file
+      # @return [Boolean] True if the file/dir exists, otherwise false.
+      def exists?(path)
+        @logger.debug("exists?: #{path}")
+        script = WinRM::FS::Scripts.render('exists', path: path)
+        @connection.shell(:powershell) { |e| e.run(script).exitcode == 0 }
+      end
+
+      # Gets the current user's TEMP directory on the remote system, for example
+      # 'C:/Windows/Temp'
+      # @return [String] Full path to the temp directory
+      def temp_dir
+        @guest_temp ||= begin
+          (@connection.shell(:powershell) { |e| e.run('$env:TEMP') }).stdout.chomp.gsub('\\', '/')
+        end
+      end
+
+      # Upload one or more local files and directories to a remote directory
+      # @example copy a single file to a winrm endpoint
+      #
+      #   file_manager.upload('/Users/sneal/myfile.txt', 'c:/foo/myfile.txt')
+      #
+      # @example copy a single directory to a winrm endpoint
+      #
+      #   file_manager.upload('c:/dev/my_dir', '$env:AppData')
+      #
+      # @param [String] A path to a local directory or file that will be copied
+      #   to the remote Windows box.
+      # @param [String] The target directory or file
+      #   This path may contain powershell style environment variables
+      # @yieldparam [Fixnum] Number of bytes copied in current payload sent to the winrm endpoint
+      # @yieldparam [Fixnum] The total number of bytes to be copied
+      # @yieldparam [String] Path of file being copied
+      # @yieldparam [String] Target path on the winrm endpoint
+      # @return [Fixnum] The total number of bytes copied
+      def upload(local_path, remote_path, &block)
+        @connection.shell(:powershell) do |shell|
+          file_transporter ||= WinRM::FS::Core::FileTransporter.new(shell)
+          file_transporter.upload(local_path, remote_path, &block)[0]
+        end
+      end
+    end
+  end
+end