winrm-fs 1.3.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7898b5512c391163a77d694860db51a5c15c5745031c2b34c0cd181a9bbda37
-  data.tar.gz: 87864314b0863331944c604d26c0721db568db238da87923b836d80097531dad
+  metadata.gz: d4af545258de812839e8ff58480b26128f23b9335207bf62eafed48ef9220d0a
+  data.tar.gz: b77310f1de5e0d6a8eb1cd2df45948ac4b848684c4646d25e75045cd8967a235
 SHA512:
-  metadata.gz: d468205639de56be5fcf4c4896a823f96760e03e23153b6e09cc9c1bc2779725d84f429a759d67088e622a288a3e002bb528f9e23749cded6416baac38b26614
-  data.tar.gz: b8787f4e3ae986aa32ae324cd1e6113081b83cb291ba519b027dea7ee67f0c4a0d9d15e50e38222328d94829735156a525c066cab56966c6e92de25754efc5b4
+  metadata.gz: 2ba78d2418a7cab543ac316dced1053c935a07c56b052053f84dfaf8d676dd4600dffe51e5c040204e2ba6f83131fd90180513725135849e8eacda72e23e49bb
+  data.tar.gz: fbb8b91d4283677593d68391d1be8e5d168230a1d82cfecbf3cf06c9a7dfa55adf4bac02d53e39c78c9a83a7a408abb0d0235d8c71b223f99581280bb0451e8e

data/VERSION

@@ -1 +1 @@
-1.3.0
+1.3.1

data/changelog.md

@@ -1,4 +1,7 @@
 # WinRM-fs Gem Changelog
+# 1.3.1
+- Download files in chunks
+
 # 1.3.0
 - Upload from StringIO object
 - Add missing winrm/exceptions require in file_transporter

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

@@ -347,6 +347,7 @@ module WinRM
           path = false
           locals.each do |local|
             raise UploadSourceError if string_io
+
             if local.is_a?(StringIO)
               string_io = true
             else

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

@@ -103,6 +103,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
 

data/lib/winrm-fs/file_manager.rb

@@ -59,16 +59,44 @@ module WinRM
       # 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)
+        @connection.shell(:powershell) { |e| e.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
@@ -115,12 +143,12 @@ module WinRM
 
       private
 
-      def download_dir(remote_path, local_path, first)
+      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/spec/integration/file_manager_spec.rb

@@ -58,6 +58,24 @@ describe WinRM::FS::FileManager do
     end
   end
 
+  context 'download file chunked' do
+    let(:download_dir) { File.join(spec_dir, 'temp') }
+    let(:dest_file) { Pathname.new(File.join(dest_dir, File.basename(this_file))) }
+    let(:download_file) { Pathname.new(File.join(download_dir, File.basename(this_file))) }
+
+    before(:each) do
+      expect(subject.delete(dest_dir)).to be true
+      FileUtils.rm_rf(Dir.glob("#{download_dir}/*"))
+      FileUtils.mkdir_p(download_dir)
+    end
+
+    it 'should download the specified file in 1000 byte chunks' do
+      subject.upload(this_file, dest_file)
+      subject.download(dest_file, download_file, 1000)
+      expect(File.open(download_file).read).to eq(File.open(this_file).read)
+    end
+  end
+
   context 'download directory' do
     let(:download_dir) { File.join(spec_dir, 'temp') }
     let(:dest_file) { Pathname.new(File.join(dest_dir, File.basename(this_file))) }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: winrm-fs
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Shawn Neal
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-31 00:00:00.000000000 Z
+date: 2018-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erubis