winrm-fs 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 906e09af384b4685d053fdd0654978757d26e3d2d281841706db04c78c44139c
-  data.tar.gz: d708a910d83ecfde7357a4ba9b42c138d375264c7ca126705fbfbacc5e7e842e
+  metadata.gz: d7898b5512c391163a77d694860db51a5c15c5745031c2b34c0cd181a9bbda37
+  data.tar.gz: 87864314b0863331944c604d26c0721db568db238da87923b836d80097531dad
 SHA512:
-  metadata.gz: b1ad3a5cf262cfe8ea47db2072600c328cb672816b122fe9340afacb364fefc620de0467d9d65d1bb1290ce215cbe521d74ba852307ea94edd7fa31765e11dab
-  data.tar.gz: 6cf1d092f268dc0d0afba76653e56df120938fde974a597ee1d930aa64bdc553bb9254e7a5f4f614d654255ce01acc2b53efd336a6ba5ea0ae78fe6f40fb49b3
+  metadata.gz: d468205639de56be5fcf4c4896a823f96760e03e23153b6e09cc9c1bc2779725d84f429a759d67088e622a288a3e002bb528f9e23749cded6416baac38b26614
+  data.tar.gz: b8787f4e3ae986aa32ae324cd1e6113081b83cb291ba519b027dea7ee67f0c4a0d9d15e50e38222328d94829735156a525c066cab56966c6e92de25754efc5b4

data/README.md

@@ -4,7 +4,7 @@
 [![Build status](https://ci.appveyor.com/api/projects/status/wm6apa8ojfhfmwsf?svg=true)](https://ci.appveyor.com/project/winrb/winrm-fs)
 
 ## Uploading files
-Files may be copied from the local machine to the winrm endpoint. Individual files or directories, as well as arrays of files and directories may be specified:
+Files may be copied from the local machine to the winrm endpoint. Individual files or directories, as well as arrays of files and directories may be specified. Data from a `StringIO` object may also be uploaded to a remote file.
 ```ruby
 require 'winrm-fs'
 
@@ -17,6 +17,9 @@ file_manager.upload('file.txt', 'c:/file.txt')
 # upload the my_dir directory to c:/foo/my_dir
 file_manager.upload('/Users/sneal/my_dir', 'c:/foo/my_dir')
 
+# upload from an in-memory buffer
+file_manager.upload(StringIO.new('some data to upload'), 'c:/file.txt')
+
 # upload multiple directories and a file to c:\programData
 file_manager.upload([
   '/Users/sneal/foo1',

data/VERSION

@@ -1 +1 @@
-1.2.1
+1.3.0

data/changelog.md

@@ -1,4 +1,9 @@
 # WinRM-fs Gem Changelog
+# 1.3.0
+- Upload from StringIO object
+- Add missing winrm/exceptions require in file_transporter
+- Use correct way to relativize paths of Zip entries
+
 # 1.2.1
 - Correctly handle unicode filenames
 

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

@@ -21,6 +21,7 @@ require 'digest'
 require 'securerandom'
 require 'stringio'
 
+require 'winrm/exceptions'
 require 'winrm-fs/core/tmp_zip'
 
 module WinRM
@@ -32,6 +33,14 @@ module WinRM
       class FileTransporterFailed < ::WinRM::WinRMError; end
       # rubocop:disable MethodLength, AbcSize, ClassLength
 
+      # Exception for the case where upload source contains more than one
+      # StringIO object, or a combination of file/directory paths and StringIO object
+      class UploadSourceError < StandardError
+        def initialize(msg = 'Only a single StringIO object may be uploaded.')
+          super
+        end
+      end
+
       # Object which can upload one or more files or directories to a remote
       # host over WinRM using PowerShell scripts and CMD commands. Note that
       # this form of file transfer is *not* ideal and extremely costly on both
@@ -67,17 +76,16 @@ module WinRM
         # * progress yields block like net-scp progress
         # * final API: def upload(locals, remote, _options = {}, &_progress)
         #
-        # @param locals [Array<String>,String] one or more local file or
-        #   directory paths
+        # @param locals [Array<String>,String,StringIO] one or more
+        #   local file or directory paths, StringIO objects also accepted
         # @param remote [String] the base destination path on the remote host
         # @return [Hash] report hash, keyed by the local SHA1 digest
         def upload(locals, remote)
           files = nil
           report = nil
           remote = remote.to_s
-
           elapsed1 = Benchmark.measure do
-            files = make_files_hash(Array(locals), remote)
+            files = make_files_hash([locals].flatten, remote)
             report = check_files(files)
             merge_with_report!(files, report)
             reconcile_destinations!(files)
@@ -183,16 +191,15 @@ module WinRM
         # Adds an entry to a files Hash (keyed by local SHA1 digest) for a file.
         #
         # @param hash [Hash] hash to be mutated
-        # @param local [String] file path
+        # @param local [String, StringIO] file path or StringIO object
         # @param remote [String] path to destination on remote host
         # @api private
         def add_file_hash!(hash, local, remote)
           logger.debug "creating hash for file #{remote}"
-
           hash[sha1sum(local)] = {
             'src'   => local,
             'dst'   => remote,
-            'size'  => File.size(local)
+            'size'  => local.is_a?(StringIO) ? local.size : File.size(local)
           }
         end
 
@@ -223,7 +230,7 @@ module WinRM
               sha1,
               {
                 'target' => data.fetch('tmpzip', data['dst']),
-                'src_basename' => File.basename(data['src']),
+                'src_basename' => data['src'].is_a?(StringIO) ? data['dst'] : File.basename(data['src']),
                 'dst' => data['dst']
               }
             ]
@@ -302,33 +309,61 @@ module WinRM
         # digest. Each file entry has a source and destination set, at a
         # minimum.
         #
-        # @param locals [Array<String>] a collection of local files or
-        #   directories
+        # @param locals [Array<String,StringIO>] a collection of local files,
+        #   directories or StringIO objects
         # @param remote [String] the base destination path on the remote host
         # @return [Hash] files hash, keyed by the local SHA1 digest
         # @api private
         def make_files_hash(locals, remote)
           hash = {}
+          check_locals_array(locals)
           locals.each do |local|
-            local = local.to_s
-            expanded = File.expand_path(local)
-            expanded += local[-1] if local.end_with?('/', '\\')
-
-            if File.file?(expanded)
-              add_file_hash!(hash, expanded, remote)
-            elsif File.directory?(expanded)
-              add_directory_hash!(hash, expanded, remote)
+            if local.is_a?(StringIO)
+              add_file_hash!(hash, local, remote)
             else
-              raise Errno::ENOENT, "No such file or directory #{expanded}"
+              local = local.to_s
+              expanded = File.expand_path(local)
+              expanded += local[-1] if local.end_with?('/', '\\')
+              if File.file?(expanded)
+                add_file_hash!(hash, expanded, remote)
+              elsif File.directory?(expanded)
+                add_directory_hash!(hash, expanded, remote)
+              else
+                raise Errno::ENOENT, "No such file or directory #{expanded}"
+              end
             end
           end
           hash
         end
 
-        # @return [String] the SHA1 digest of a local file
+        # Ensure that only a single StringIO object is uploaded at a time
+        # This is necessary because the contents of the buffer will be written
+        # to the destination.
+        # @param locals [Array<String,StringIO>] a collection of local files,
+        #   directories or StringIO objects
+        # @api private
+        def check_locals_array(locals)
+          string_io = false
+          path = false
+          locals.each do |local|
+            raise UploadSourceError if string_io
+            if local.is_a?(StringIO)
+              string_io = true
+            else
+              path = true
+            end
+            raise UploadSourceError if string_io && path
+          end
+        end
+
+        # @return [String] the SHA1 digest of a local file or StringIO
         # @api private
         def sha1sum(local)
-          Digest::SHA1.file(local).hexdigest
+          if local.is_a?(StringIO)
+            Digest::SHA1.hexdigest(local.string)
+          else
+            Digest::SHA1.file(local).hexdigest
+          end
         end
 
         # Destructively merges a report Hash into an existing files Hash.
@@ -459,7 +494,7 @@ module WinRM
 
         # Uploads a local file.
         #
-        # @param src [String] path to a local file
+        # @param src [String, StringIO] path to a local file or StringIO object
         # @param dest [String] path to the file on the remote host
         # @return [Integer,Integer] the number of resulting upload chunks and
         #   the number of bytes transferred to the remote host
@@ -469,8 +504,12 @@ module WinRM
           chunks = 0
           bytes = 0
           elapsed = Benchmark.measure do
-            File.open(src, 'rb') do |io|
-              chunks, bytes = stream_upload(io, dest, &block)
+            if src.is_a?(StringIO)
+              chunks, bytes = stream_upload(src, dest, &block)
+            else
+              File.open(src, 'rb') do |io|
+                chunks, bytes = stream_upload(io, dest, &block)
+              end
             end
           end
           logger.debug(

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

@@ -125,7 +125,7 @@ module WinRM
         # @api private
         def produce_zip_entries(zos)
           entries.each do |entry|
-            entry_path = entry.sub(/#{dir}\//i, '')
+            entry_path = entry.relative_path_from(dir)
             logger.debug "+++ Adding #{entry_path}"
             zos.put_next_entry(
               zip_entry(entry_path),

data/spec/integration/file_manager_spec.rb

@@ -86,11 +86,27 @@ describe WinRM::FS::FileManager do
 
   context 'upload file' do
     let(:dest_file) { Pathname.new(File.join(dest_dir, File.basename(this_file))) }
+    let(:from_memory) { StringIO.new('Upload From Memory') }
 
     before(:each) do
       expect(subject.delete(dest_dir)).to be true
     end
 
+    it 'should upload a single StringIO object to a remote file' do
+      subject.upload(from_memory, dest_file)
+      expect(subject).to have_created(dest_file).with_content(from_memory.string)
+    end
+
+    it 'should error if multiple StringIO objects passed to upload' do
+      expect { subject.upload([from_memory, from_memory], dest_file) }
+        .to raise_error(WinRM::FS::Core::UploadSourceError)
+    end
+
+    it 'should error if both a StringIO object and a file path passed to upload' do
+      expect { subject.upload([from_memory, this_file], dest_file) }
+        .to raise_error(WinRM::FS::Core::UploadSourceError)
+    end
+
     it 'should upload the specified file' do
       subject.upload(this_file, dest_file)
       expect(subject).to have_created(dest_file).with_content(this_file)

metadata

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