winrm-fs 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f0f709ab1c583eaa7566b5adc461aaf46cf2b65e
-  data.tar.gz: c8cdda9ef2983370cbc964dc9d89eddf348dbd22
+SHA256:
+  metadata.gz: d7898b5512c391163a77d694860db51a5c15c5745031c2b34c0cd181a9bbda37
+  data.tar.gz: 87864314b0863331944c604d26c0721db568db238da87923b836d80097531dad
 SHA512:
-  metadata.gz: b0d362238781bb50982b7b3f8947b754c3dde755fe4f727197579d943534c717db891b3a197150f2ad975661d12bfc8be66b2e6e9eee9f1395efa6e70cf15a39
-  data.tar.gz: f5daea2da6036290bca6446936f6d79105578a8106746c809a3887725ba2d7171470451f5c7e0290a8ec4264f7f597af86e77dcb0b01697d697ca35dd433bcc9
+  metadata.gz: d468205639de56be5fcf4c4896a823f96760e03e23153b6e09cc9c1bc2779725d84f429a759d67088e622a288a3e002bb528f9e23749cded6416baac38b26614
+  data.tar.gz: b8787f4e3ae986aa32ae324cd1e6113081b83cb291ba519b027dea7ee67f0c4a0d9d15e50e38222328d94829735156a525c066cab56966c6e92de25754efc5b4

data/.rubocop.yml

@@ -7,6 +7,9 @@ Naming/FileName:
 Style/Encoding:
   Enabled: true
 
+Layout/EndOfLine:
+  Enabled: false
+
 Metrics/LineLength:
   Max: 120
 

data/.rubocop_todo.yml

@@ -34,13 +34,6 @@ Naming/HeredocDelimiterNaming:
     - 'spec/matchers.rb'
     - 'winrm-fs.gemspec'
 
-# Offense count: 2
-# Cop supports --auto-correct.
-# Configuration parameters: AutoCorrect.
-Performance/HashEachMethods:
-  Exclude:
-    - 'lib/winrm-fs/core/file_transporter.rb'
-
 # Offense count: 1
 # Configuration parameters: .
 # SupportedStyles: annotated, template, unannotated

data/.travis.yml

@@ -1,6 +1,6 @@
 language: ruby
 rvm:
-  - 2.1.0
+  - 2.2.0
   - 2.3.4
   - 2.4.1
 

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/Rakefile

@@ -4,7 +4,7 @@ require 'rspec/core/rake_task'
 require 'rubocop/rake_task'
 
 # Change to the directory of this file.
-Dir.chdir(File.expand_path('../', __FILE__))
+Dir.chdir(File.expand_path(__dir__))
 
 # For gem creation and bundling
 require 'bundler/gem_tasks'

data/VERSION

@@ -1 +1 @@
-1.2.0
+1.3.0

data/appveyor.yml

@@ -9,7 +9,7 @@ environment:
   winrm_password: Pass@word1
 
   matrix:
-    - ruby_version: "21"
+    - ruby_version: "22"
       winrm_endpoint: http://localhost:5985/wsman
 
 clone_folder: c:\projects\winrm-fs

data/changelog.md

@@ -1,4 +1,12 @@
 # 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
+
 # 1.2.0
 - Add ability to download directories
 

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
@@ -56,6 +65,7 @@ module WinRM
           @shell  = shell
           @logger = shell.logger
           @id_generator = opts.fetch(:id_generator) { -> { SecureRandom.uuid } }
+          Zip.unicode_names = true
         end
 
         # Uploads a collection of files and/or directories to the remote host.
@@ -66,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)
@@ -182,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
 
@@ -222,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']
               }
             ]
@@ -301,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.
@@ -432,7 +468,7 @@ module WinRM
             # ClearScriptBlockCache to clear it.
             $bindingFlags= [Reflection.BindingFlags] "NonPublic,Static"
             $method = [scriptblock].GetMethod("ClearScriptBlockCache", $bindingFlags)
-            EOS
+          EOS
                    )
 
           while input_io.read(read_size, buffer)
@@ -458,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
@@ -468,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/lib/winrm-fs/file_manager.rb

@@ -83,7 +83,7 @@ module WinRM
       # 'C:/Windows/Temp'
       # @return [String] Full path to the temp directory
       def temp_dir
-        @guest_temp ||= begin
+        @temp_dir ||= begin
           (@connection.shell(:powershell) { |e| e.run('$env:TEMP') }).stdout.chomp.tr('\\', '/')
         end
       end
@@ -116,7 +116,7 @@ module WinRM
       private
 
       def download_dir(remote_path, local_path, first)
-        local_path = File.join(local_path, File.basename(remote_path)) if 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|

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)

data/spec/spec_helper.rb

@@ -9,7 +9,6 @@ module ConnectionHelper
   def winrm_connection
     WinRM::Connection.new(config)
   end
-  # rubocop:enable AbcSize
 
   def config
     @config ||= begin

data/winrm-fs.gemspec

@@ -1,30 +1,30 @@
 require 'date'
 
-version = File.read(File.expand_path('../VERSION', __FILE__)).strip
+version = File.read(File.expand_path('VERSION', __dir__)).strip
 
 Gem::Specification.new do |s|
   s.platform = Gem::Platform::RUBY
   s.name = 'winrm-fs'
   s.version = version
-  s.date	= Date.today.to_s
+  s.date = Date.today.to_s
 
   s.author = ['Shawn Neal', 'Matt Wrock']
   s.email = ['sneal@sneal.net', 'matt@mattwrock.com']
   s.homepage = 'http://github.com/WinRb/winrm-fs'
 
   s.summary = 'WinRM File System'
-  s.description	= <<-EOF
+  s.description = <<-EOF
     Ruby library for file system operations via Windows Remote Management
   EOF
 
   s.files = `git ls-files`.split(/\n/)
   s.require_path = 'lib'
-  s.rdoc_options	= %w[-x test/ -x examples/]
+  s.rdoc_options = %w[-x test/ -x examples/]
   s.extra_rdoc_files = %w[README.md LICENSE]
 
   s.bindir = 'bin'
   s.executables = ['rwinrmcp']
-  s.required_ruby_version	= '>= 2.1.0'
+  s.required_ruby_version = '>= 2.2.0'
   s.add_runtime_dependency 'erubis', '~> 2.7'
   s.add_runtime_dependency 'logging', ['>= 1.6.1', '< 3.0']
   s.add_runtime_dependency 'rubyzip', '~> 1.1'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: winrm-fs
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Shawn Neal
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-12 00:00:00.000000000 Z
+date: 2018-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erubis
@@ -189,7 +189,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.1.0
+      version: 2.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -197,7 +197,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: WinRM File System