winrm-fs 1.3.0 → 1.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7898b5512c391163a77d694860db51a5c15c5745031c2b34c0cd181a9bbda37
-  data.tar.gz: 87864314b0863331944c604d26c0721db568db238da87923b836d80097531dad
+  metadata.gz: 22197843455d6d73e34d00c91fd58d4a6201d08f02f61a64d5b971085360aebf
+  data.tar.gz: fd9181f9187df12ad0a6812891c29a1e917ccfc9f2d4064448a52d08f0455d05
 SHA512:
-  metadata.gz: d468205639de56be5fcf4c4896a823f96760e03e23153b6e09cc9c1bc2779725d84f429a759d67088e622a288a3e002bb528f9e23749cded6416baac38b26614
-  data.tar.gz: b8787f4e3ae986aa32ae324cd1e6113081b83cb291ba519b027dea7ee67f0c4a0d9d15e50e38222328d94829735156a525c066cab56966c6e92de25754efc5b4
+  metadata.gz: ebf3f8d594d00219a5b19f6eb2ba17ae4f466de4d4eb0929b6f61f8f9075473ccdaff127ab3ed10a06280a309cfe3b5d8976a1857970c3f02a22080413690667
+  data.tar.gz: a56cf8645bcb803c377f7146a1c5a005496e74b9b7993b6f18f38dd70c2a4de00174c65cd7abc3a0e409b07fa10a10bab7fce145b5dfb6991744f2c720d9a2e0

data/bin/rwinrmcp

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
 #
 # Copyright 2014 Shawn Neal <sneal@sneal.net>
 #

data/lib/winrm-fs.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #
 # Copyright 2015 Shawn Neal <sneal@sneal.net>
 #
@@ -13,9 +15,9 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'winrm'
+require 'winrm' unless defined?(WinRM::Connection)
 require 'logger'
-require 'pathname'
+require 'pathname' unless defined?(Pathname)
 require_relative 'winrm-fs/exceptions'
 require_relative 'winrm-fs/file_manager'
 

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: false
+
 #
 # Author:: Fletcher (<fnichol@nichol.ca>)
 #
@@ -15,11 +17,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'benchmark'
-require 'csv'
-require 'digest'
-require 'securerandom'
-require 'stringio'
+require 'benchmark' unless defined?(Benchmark)
+require 'csv' unless defined?(CSV)
+require 'digest' unless defined?(Digest)
+require 'securerandom' unless defined?(SecureRandom)
+require 'stringio' unless defined?(StringIO)
 
 require 'winrm/exceptions'
 require 'winrm-fs/core/tmp_zip'
@@ -31,7 +33,7 @@ module WinRM
       #
       # @author Fletcher Nichol <fnichol@nichol.ca>
       class FileTransporterFailed < ::WinRM::WinRMError; end
-      # rubocop:disable MethodLength, AbcSize, ClassLength
+      # rubocop:disable Metrics/MethodLength, Metrics/AbcSize, Metrics/ClassLength
 
       # Exception for the case where upload source contains more than one
       # StringIO object, or a combination of file/directory paths and StringIO object
@@ -115,6 +117,10 @@ module WinRM
           [total_size, files]
         end
 
+        def close
+          shell.close
+        end
+
         private
 
         # @return [String] the Array pack template for Base64 encoding a stream
@@ -179,12 +185,12 @@ module WinRM
           zip_sha1 = sha1sum(zip_io.path)
 
           hash[zip_sha1] = {
-            'src'     => dir,
+            'src' => dir,
             'src_zip' => zip_io.path.to_s,
-            'zip_io'  => zip_io,
-            'tmpzip'  => "#{TEMP_UPLOAD_DIRECTORY}\\tmpzip-#{zip_sha1}.zip",
-            'dst'     => "#{remote}\\#{File.basename(dir)}",
-            'size'    => File.size(zip_io.path)
+            'zip_io' => zip_io,
+            'tmpzip' => "#{TEMP_UPLOAD_DIRECTORY}\\tmpzip-#{zip_sha1}.zip",
+            'dst' => "#{remote}\\#{File.basename(dir)}",
+            'size' => File.size(zip_io.path)
           }
         end
 
@@ -197,9 +203,9 @@ module WinRM
         def add_file_hash!(hash, local, remote)
           logger.debug "creating hash for file #{remote}"
           hash[sha1sum(local)] = {
-            'src'   => local,
-            'dst'   => remote,
-            'size'  => local.is_a?(StringIO) ? local.size : File.size(local)
+            'src' => local,
+            'dst' => remote,
+            'size' => local.is_a?(StringIO) ? local.size : File.size(local)
           }
         end
 
@@ -347,6 +353,7 @@ module WinRM
           path = false
           locals.each do |local|
             raise UploadSourceError if string_io
+
             if local.is_a?(StringIO)
               string_io = true
             else
@@ -448,8 +455,9 @@ module WinRM
           read_size = ((max_encoded_write - dest.length) / 4) * 3
           chunk = 1
           bytes = 0
+          # Do not freeze this string
           buffer = ''
-          shell.run(<<-EOS
+          shell.run(<<-PS
             $to = $ExecutionContext.SessionState.Path.GetUnresolvedProviderPathFromPSPath("#{dest}")
             $parent = Split-Path $to
             if(!(Test-path $parent)) { mkdir $parent | Out-Null }
@@ -468,7 +476,7 @@ module WinRM
             # ClearScriptBlockCache to clear it.
             $bindingFlags= [Reflection.BindingFlags] "NonPublic,Static"
             $method = [scriptblock].GetMethod("ClearScriptBlockCache", $bindingFlags)
-          EOS
+          PS
                    )
 
           while input_io.read(read_size, buffer)
@@ -485,11 +493,11 @@ module WinRM
         end
 
         def stream_command(encoded_bytes)
-          <<-EOS
+          <<-PS
             if($method) { $method.Invoke($Null, $Null) }
             $bytes=[Convert]::FromBase64String('#{encoded_bytes}')
             $fileStream.Write($bytes, 0, $bytes.length)
-          EOS
+          PS
         end
 
         # Uploads a local file.
@@ -559,7 +567,7 @@ module WinRM
           size / 3 * 4
         end
       end
-      # rubocop:enable MethodLength, AbcSize, ClassLength
+      # rubocop:enable Metrics/MethodLength, Metrics/AbcSize, Metrics/ClassLength
     end
   end
 end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #
 # Author:: Fletcher (<fnichol@nichol.ca>)
 #
@@ -16,9 +18,9 @@
 # limitations under the License.
 
 require 'delegate'
-require 'pathname'
-require 'tempfile'
-require 'zip'
+require 'pathname' unless defined?(Pathname)
+require 'tempfile' unless defined?(Tempfile)
+require 'zip' unless defined?(Zip)
 
 module WinRM
   module FS
@@ -103,6 +105,7 @@ module WinRM
         def clean_dirname(dir)
           paths = Pathname.glob(dir)
           raise "Expected Pathname.glob(dir) to return only dir, got #{paths}" if paths.length != 1
+
           paths.first
         end
 
@@ -110,7 +113,7 @@ module WinRM
         #   directory, excluding directories
         # @api private
         def entries
-          Pathname.glob(dir.join('**/*')).delete_if(&:directory?).sort
+          Pathname.glob(dir.join('**/.*')).push(*Pathname.glob(dir.join('**/*'))).delete_if(&:directory?).sort
         end
 
         # (see Logging.log_subject)

data/lib/winrm-fs/exceptions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #
 # Copyright 2015 Shawn Neal <sneal@sneal.net>
 #

data/lib/winrm-fs/file_manager.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #
 # Copyright 2015 Shawn Neal <sneal@sneal.net>
 #
@@ -13,7 +15,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'winrm'
+require 'winrm' unless defined?(WinRM::Connection)
 require_relative 'scripts/scripts'
 require_relative 'core/file_transporter'
 
@@ -35,7 +37,7 @@ module WinRM
       def checksum(path, digest = 'SHA1')
         @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 }
+        ps_run(script).exitcode == 0
       end
 
       # Create the specifed directory recursively
@@ -44,7 +46,7 @@ module WinRM
       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 }
+        ps_run(script).exitcode == 0
       end
 
       # Deletes the file or directory at the specified path
@@ -53,22 +55,50 @@ module WinRM
       def delete(path)
         @logger.debug("deleting: #{path}")
         script = WinRM::FS::Scripts.render('delete', path: path)
-        @connection.shell(:powershell) { |e| e.run(script).exitcode == 0 }
+        ps_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, first = true)
-        @logger.debug("downloading: #{remote_path} -> #{local_path}")
-        script = WinRM::FS::Scripts.render('download', path: remote_path)
-        output = @connection.shell(:powershell) { |e| e.run(script) }
-        contents = output.stdout.gsub('\n\r', '')
-        return false if output.exitcode != 0
-        download_dir(remote_path, local_path, first) if contents.empty?
-        IO.binwrite(local_path, Base64.decode64(contents)) unless contents.empty?
+      # rubocop:disable Metrics/MethodLength
+      def download(remote_path, local_path, chunk_size = 1024 * 1024, first = true)
+        @logger.debug("downloading: #{remote_path} -> #{local_path} #{chunk_size}")
+        index = 0
+        output = _output_from_file(remote_path, chunk_size, index)
+        return download_dir(remote_path, local_path, chunk_size, first) if output.exitcode == 2
+
+        return false if output.exitcode >= 1
+
+        File.open(local_path, 'wb') do |fd|
+          out = _write_file(fd, output)
+          index += out.length
+          until out.empty?
+            output = _output_from_file(remote_path, chunk_size, index)
+            return false if output.exitcode >= 1
+
+            out = _write_file(fd, output)
+            index += out.length
+          end
+        end
         true
       end
+      # rubocop:enable Metrics/MethodLength
+
+      def _output_from_file(remote_path, chunk_size, index)
+        script = WinRM::FS::Scripts.render('download', path: remote_path, chunk_size: chunk_size, index: index)
+        ps_run(script)
+      end
+
+      def _write_file(tofd, output)
+        contents = output.stdout.gsub('\n\r', '')
+        out = Base64.decode64(contents)
+        out = out[0, out.length - 1] if out.end_with? "\x00"
+        return out if out.empty?
+
+        tofd.write(out)
+        out
+      end
 
       # Checks to see if the given path exists on the target file system.
       # @param [String] The full path to the directory or file
@@ -76,7 +106,7 @@ module WinRM
       def exists?(path)
         @logger.debug("exists?: #{path}")
         script = WinRM::FS::Scripts.render('exists', path: path)
-        @connection.shell(:powershell) { |e| e.run(script).exitcode == 0 }
+        ps_run(script).exitcode == 0
       end
 
       # Gets the current user's TEMP directory on the remote system, for example
@@ -84,7 +114,7 @@ module WinRM
       # @return [String] Full path to the temp directory
       def temp_dir
         @temp_dir ||= begin
-          (@connection.shell(:powershell) { |e| e.run('$env:TEMP') }).stdout.chomp.tr('\\', '/')
+          ps_run('$env:TEMP').stdout.chomp.tr('\\', '/')
         end
       end
 
@@ -109,18 +139,31 @@ module WinRM
       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]
+          begin
+            file_transporter.upload(local_path, remote_path, &block)[0]
+          ensure
+            file_transporter.close
+          end
         end
       end
 
       private
 
-      def download_dir(remote_path, local_path, first)
+      def ps_run(cmd)
+        shell = @connection.shell(:powershell)
+        begin
+          shell.run(cmd)
+        ensure
+          shell.close
+        end
+      end
+
+      def download_dir(remote_path, local_path, chunk_size, first)
         local_path = File.join(local_path, File.basename(remote_path.to_s)) if first
         FileUtils.mkdir_p(local_path) unless File.directory?(local_path)
         command = "Get-ChildItem #{remote_path} | Select-Object Name"
         @connection.shell(:powershell) { |e| e.run(command) }.stdout.strip.split(/\n/).drop(2).each do |file|
-          download(File.join(remote_path.to_s, file.strip), File.join(local_path, file.strip), first = false)
+          download(File.join(remote_path.to_s, file.strip), File.join(local_path, file.strip), chunk_size, false)
         end
       end
     end

data/lib/winrm-fs/scripts/download.ps1.erb

@@ -1,11 +1,17 @@
 $p = $ExecutionContext.SessionState.Path
 $path = $p.GetUnresolvedProviderPathFromPSPath("<%= path %>")
-If (Test-Path $path -PathType Leaf) {
-  $bytes = [System.convert]::ToBase64String([System.IO.File]::ReadAllBytes($path))
+$index = <%= index %>
+$chunkSize = <%= chunk_size %>
+if (Test-Path $path -PathType Leaf) {
+  $file = [System.IO.File]::OpenRead($path)
+  $seekedTo = $file.Seek($index, [System.IO.SeekOrigin]::Begin)
+  $chunk = New-Object byte[] $chunkSize
+  $bytesRead = $file.Read($chunk, 0, $chunkSize)
+  $bytes = [System.convert]::ToBase64String($chunk[0..$bytesRead])
   Write-Host $bytes
   exit 0
 }
 ElseIf (Test-Path $path -PathType Container) {
-  exit 0
+  exit 2
 }
 exit 1

data/lib/winrm-fs/scripts/scripts.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #
 # Copyright 2015 Shawn Neal <sneal@sneal.net>
 #
@@ -13,18 +15,32 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'erubis'
+require 'erubi'
 
 module WinRM
   module FS
     # PS1 scripts
     module Scripts
+      # rubocop:disable Metrics/MethodLength
       def self.render(template, context)
+        # rubocop:enable Metrics/MethodLength
         template_path = File.expand_path(
           "#{File.dirname(__FILE__)}/#{template}.ps1.erb"
         )
         template = File.read(template_path)
-        Erubis::Eruby.new(template).result(context)
+        case context
+        when Hash
+          b = binding
+          locals = context.collect { |k, _| "#{k} = context[#{k.inspect}]; " }
+          b.eval(locals.join)
+        when Binding
+          b = context
+        when NilClass
+          b = binding
+        else
+          raise ArgumentError
+        end
+        b.eval(Erubi::Engine.new(template).src)
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: winrm-fs
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.5
 platform: ruby
 authors:
 - Shawn Neal
@@ -9,22 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-31 00:00:00.000000000 Z
+date: 2020-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: erubis
+  name: erubi
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '1.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: logging
   requirement: !ruby/object:Gem::Requirement
@@ -51,14 +51,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: winrm
   requirement: !ruby/object:Gem::Requirement
@@ -91,16 +91,22 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '10.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '10.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '13'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -121,14 +127,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.51'
+        version: 0.68.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.51'
+        version: 0.68.0
 description: "    Ruby library for file system operations via Windows Remote Management\n"
 email:
 - sneal@sneal.net
@@ -140,20 +146,9 @@ extra_rdoc_files:
 - README.md
 - LICENSE
 files:
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- ".rubocop_todo.yml"
-- ".travis.yml"
-- Gemfile
 - LICENSE
 - README.md
-- Rakefile
-- VERSION
-- Vagrantfile
-- appveyor.yml
 - bin/rwinrmcp
-- changelog.md
 - lib/winrm-fs.rb
 - lib/winrm-fs/core/file_transporter.rb
 - lib/winrm-fs/core/tmp_zip.rb
@@ -167,15 +162,9 @@ files:
 - lib/winrm-fs/scripts/exists.ps1.erb
 - lib/winrm-fs/scripts/extract_files.ps1.erb
 - lib/winrm-fs/scripts/scripts.rb
-- spec/config-example.yml
-- spec/integration/file_manager_spec.rb
-- spec/integration/tmp_zip_spec.rb
-- spec/matchers.rb
-- spec/spec_helper.rb
-- spec/unit/tmp_zip_spec.rb
-- winrm-fs.gemspec
 homepage: http://github.com/WinRb/winrm-fs
-licenses: []
+licenses:
+- Apache-2.0
 metadata: {}
 post_install_message: 
 rdoc_options:
@@ -189,15 +178,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: WinRM File System