winrm-fs 1.0.1 → 1.0.2

data/README.md

@@ -1,79 +1,79 @@
-# File system operations over Windows Remote Management (WinRM) for Ruby
-[![Build Status](https://travis-ci.org/WinRb/winrm-fs.svg?branch=master)](https://travis-ci.org/WinRb/winrm-fs)
-[![Gem Version](https://badge.fury.io/rb/winrm-fs.svg)](http://badge.fury.io/rb/winrm-fs)
-[![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:
-```ruby
-require 'winrm-fs'
-
-connection = WinRM::Connection.new(...
-file_manager = WinRM::FS::FileManager.new(connection)
-
-# upload file.txt from the current working directory
-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 multiple directories and a file to c:\programData
-file_manager.upload([
-  '/Users/sneal/foo1',
-  '/Users/sneal/foo2'
-  '/Users/sneal/fluffy.txt'
-], '$env:ProgramData')
-```
-
-### Optimizing WinRM settings
-Since winrm-fs 1.0/winrm 2.0, files are uploaded using the PSRP protocol and transfer speeds are dramatically improved from previous versions. This is largely due to the fact that the size of chunks that can be transferred at one time are now governed by the `MaxEnvelopeSizekb` winrm configuration setting on the endpoint. This default to 500 on Windows 2012 R2 and 150 on Windows 2008 R2. You may experience much faster transfer rates on 2008 R2 by increasing this setting.
-
-### Handling progress events
-If you want to implement your own custom progress handling, you can pass a code
-block and use the proggress data that `upload` yields to this block:
-```ruby
-file_manager.upload('c:/dev/my_dir', '$env:AppData') do |bytes_copied, total_bytes, local_path, remote_path|
-  puts "#{bytes_copied}bytes of #{total_bytes}bytes copied"
-end
-```
-
-## Troubleshooting
-
-If you're having trouble, first of all its most likely a network or WinRM configuration
-issue. Take a look at the [WinRM gem troubleshooting](https://github.com/WinRb/WinRM#troubleshooting)
-first.
-
-## Contributing
-
-1. Fork it.
-2. Create a branch (git checkout -b my_feature_branch)
-3. Run the unit and integration tests (bundle exec rake integration)
-4. Commit your changes (git commit -am "Added a sweet feature")
-5. Push to the branch (git push origin my_feature_branch)
-6. Create a pull requst from your branch into master (Please be sure to provide enough detail for us to cipher what this change is doing)
-
-### Running the tests
-
-We use Bundler to manage dependencies during development.
-
-```
-$ bundle install
-```
-
-Once you have the dependencies, you can run the unit tests with `rake`:
-
-```
-$ bundle exec rake spec
-```
-
-To run the integration tests you will need a Windows box with the WinRM service properly configured. Its easiest to use the Vagrant Windows box in the Vagrantilfe of this repo.
-
-1. Create a Windows VM with WinRM configured (see above).
-2. Copy the config-example.yml to config.yml - edit this file with your WinRM connection details.
-3. Run `bundle exec rake integration`
-
-## WinRM-fs Authors
-* Shawn Neal (https://github.com/sneal)
-* Matt Wrock (https://github.com/mwrock)
-
-[Contributors](https://github.com/WinRb/winrm-fs/graphs/contributors)
+# File system operations over Windows Remote Management (WinRM) for Ruby
+[![Build Status](https://travis-ci.org/WinRb/winrm-fs.svg?branch=master)](https://travis-ci.org/WinRb/winrm-fs)
+[![Gem Version](https://badge.fury.io/rb/winrm-fs.svg)](http://badge.fury.io/rb/winrm-fs)
+[![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:
+```ruby
+require 'winrm-fs'
+
+connection = WinRM::Connection.new(...
+file_manager = WinRM::FS::FileManager.new(connection)
+
+# upload file.txt from the current working directory
+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 multiple directories and a file to c:\programData
+file_manager.upload([
+  '/Users/sneal/foo1',
+  '/Users/sneal/foo2'
+  '/Users/sneal/fluffy.txt'
+], '$env:ProgramData')
+```
+
+### Optimizing WinRM settings
+Since winrm-fs 1.0/winrm 2.0, files are uploaded using the PSRP protocol and transfer speeds are dramatically improved from previous versions. This is largely due to the fact that the size of chunks that can be transferred at one time are now governed by the `MaxEnvelopeSizekb` winrm configuration setting on the endpoint. This default to 500 on Windows 2012 R2 and 150 on Windows 2008 R2. You may experience much faster transfer rates on 2008 R2 by increasing this setting.
+
+### Handling progress events
+If you want to implement your own custom progress handling, you can pass a code
+block and use the proggress data that `upload` yields to this block:
+```ruby
+file_manager.upload('c:/dev/my_dir', '$env:AppData') do |bytes_copied, total_bytes, local_path, remote_path|
+  puts "#{bytes_copied}bytes of #{total_bytes}bytes copied"
+end
+```
+
+## Troubleshooting
+
+If you're having trouble, first of all its most likely a network or WinRM configuration
+issue. Take a look at the [WinRM gem troubleshooting](https://github.com/WinRb/WinRM#troubleshooting)
+first.
+
+## Contributing
+
+1. Fork it.
+2. Create a branch (git checkout -b my_feature_branch)
+3. Run the unit and integration tests (bundle exec rake integration)
+4. Commit your changes (git commit -am "Added a sweet feature")
+5. Push to the branch (git push origin my_feature_branch)
+6. Create a pull requst from your branch into master (Please be sure to provide enough detail for us to cipher what this change is doing)
+
+### Running the tests
+
+We use Bundler to manage dependencies during development.
+
+```
+$ bundle install
+```
+
+Once you have the dependencies, you can run the unit tests with `rake`:
+
+```
+$ bundle exec rake spec
+```
+
+To run the integration tests you will need a Windows box with the WinRM service properly configured. Its easiest to use the Vagrant Windows box in the Vagrantilfe of this repo.
+
+1. Create a Windows VM with WinRM configured (see above).
+2. Copy the config-example.yml to config.yml - edit this file with your WinRM connection details.
+3. Run `bundle exec rake integration`
+
+## WinRM-fs Authors
+* Shawn Neal (https://github.com/sneal)
+* Matt Wrock (https://github.com/mwrock)
+
+[Contributors](https://github.com/WinRb/winrm-fs/graphs/contributors)

data/Rakefile

@@ -1,28 +1,28 @@
-# encoding: UTF-8
-require 'rubygems'
-require 'bundler/setup'
-require 'rspec/core/rake_task'
-require 'rubocop/rake_task'
-
-# Change to the directory of this file.
-Dir.chdir(File.expand_path('../', __FILE__))
-
-# For gem creation and bundling
-require 'bundler/gem_tasks'
-
-RSpec::Core::RakeTask.new(:spec) do |task|
-  task.pattern = 'spec/unit/*_spec.rb'
-  task.rspec_opts = ['--color', '-f documentation']
-end
-
-# Run the integration test suite
-RSpec::Core::RakeTask.new(:integration) do |task|
-  task.pattern = 'spec/integration/*_spec.rb'
-  task.rspec_opts = ['--color', '-f documentation']
-end
-
-RuboCop::RakeTask.new
-
-task default: [:spec, :rubocop]
-
-task all: [:default, :integration]
+# encoding: UTF-8
+require 'rubygems'
+require 'bundler/setup'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+# Change to the directory of this file.
+Dir.chdir(File.expand_path('../', __FILE__))
+
+# For gem creation and bundling
+require 'bundler/gem_tasks'
+
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.pattern = 'spec/unit/*_spec.rb'
+  task.rspec_opts = ['--color', '-f documentation']
+end
+
+# Run the integration test suite
+RSpec::Core::RakeTask.new(:integration) do |task|
+  task.pattern = 'spec/integration/*_spec.rb'
+  task.rspec_opts = ['--color', '-f documentation']
+end
+
+RuboCop::RakeTask.new
+
+task default: [:spec, :rubocop]
+
+task all: [:default, :integration]

data/VERSION

@@ -1 +1 @@
-1.0.1
+1.0.2

data/Vagrantfile

@@ -1,9 +1,9 @@
-# encoding: UTF-8
-# -*- mode: ruby -*-
-# vi: set ft=ruby :
-
-VAGRANTFILE_API_VERSION = '2'
-
-Vagrant.configure(VAGRANTFILE_API_VERSION) do |config|
-  config.vm.box = 'mwrock/WindowsNano'
-end
+# encoding: UTF-8
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+VAGRANTFILE_API_VERSION = '2'
+
+Vagrant.configure(VAGRANTFILE_API_VERSION) do |config|
+  config.vm.box = 'mwrock/WindowsNano'
+end

data/appveyor.yml

@@ -1,39 +1,39 @@
-version: "master-{build}"
-
-os: Windows Server 2012 R2
-platform:
-  - x64
-
-environment:
-  winrm_user: test_user
-  winrm_password: Pass@word1
-
-  matrix:
-    - ruby_version: "21"
-      winrm_endpoint: http://localhost:5985/wsman
-
-clone_folder: c:\projects\winrm-fs
-clone_depth: 1
-branches:
-  only:
-    - master
-
-install:
-  - ps: net user /add $env:winrm_user $env:winrm_password
-  - ps: net localgroup administrators $env:winrm_user /add
-  - ps: winrm set winrm/config/client/auth '@{Basic="true"}'
-  - ps: winrm set winrm/config/service/auth '@{Basic="true"}'
-  - ps: winrm set winrm/config/service '@{AllowUnencrypted="true"}'
-  - ps: $env:PATH="C:\Ruby$env:ruby_version\bin;$env:PATH"
-  - ps: Write-Host $env:PATH
-  - ps: ruby --version
-  - ps: gem --version
-  - ps: gem install bundler --quiet --no-ri --no-rdoc
-  - ps: bundler --version
-
-build_script:
-  - bundle install || bundle install || bundle install
-
-test_script:
-  - SET SPEC_OPTS=--format progress
-  - bundle exec rake integration
+version: "master-{build}"
+
+os: Windows Server 2012 R2
+platform:
+  - x64
+
+environment:
+  winrm_user: test_user
+  winrm_password: Pass@word1
+
+  matrix:
+    - ruby_version: "21"
+      winrm_endpoint: http://localhost:5985/wsman
+
+clone_folder: c:\projects\winrm-fs
+clone_depth: 1
+branches:
+  only:
+    - master
+
+install:
+  - ps: net user /add $env:winrm_user $env:winrm_password
+  - ps: net localgroup administrators $env:winrm_user /add
+  - ps: winrm set winrm/config/client/auth '@{Basic="true"}'
+  - ps: winrm set winrm/config/service/auth '@{Basic="true"}'
+  - ps: winrm set winrm/config/service '@{AllowUnencrypted="true"}'
+  - ps: $env:PATH="C:\Ruby$env:ruby_version\bin;$env:PATH"
+  - ps: Write-Host $env:PATH
+  - ps: ruby --version
+  - ps: gem --version
+  - ps: gem install bundler --quiet --no-ri --no-rdoc
+  - ps: bundler --version
+
+build_script:
+  - bundle install || bundle install || bundle install
+
+test_script:
+  - SET SPEC_OPTS=--format progress
+  - bundle exec rake integration

data/bin/rwinrmcp

@@ -1,86 +1,86 @@
-#!/usr/bin/env ruby
-# encoding: UTF-8
-#
-# Copyright 2014 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.
-
-# TODO: refactor this
-# rubocop:disable all
-
-$LOAD_PATH.push File.expand_path('../../lib', __FILE__)
-
-require 'io/console'
-require 'winrm-fs'
-
-def help_msg
-  puts 'Usage: rwinrmcp sourcefile user@host:directory/targetfile'
-  puts ''
-end
-
-def parse_options
-  options = {}
-  fail 'Missing required options' unless ARGV.length == 2
-
-  options[:source_path] = ARGV[0]
-  fail "Cannot find source file: #{options[:source_path]}" unless \
-    File.exist?(options[:source_path])
-
-  m = /^(?<user>[a-z0-9\.\!\$ _-]+)@{1}(?<host>[a-z0-9\.\-]+)(?<port>:[0-9]+)?:{1}(?<file>.+)/i.match(ARGV[1])
-  fail "#{ARGV[1]} is an invalid destination" unless m
-  options[:user] = m[:user]
-  options[:endpoint] = "http://#{m[:host]}#{m[:port] || ':5985'}/wsman"
-  options[:dest_path] = m[:file]
-
-  # Get the password
-  print 'Password: '
-  options[:pass] = STDIN.noecho(&:gets).chomp
-  puts
-
-  # Set some defaults required by WinRM WS
-  options[:auth_type] = :plaintext
-  options[:basic_auth_only] = true
-
-  options
-rescue StandardError => e
-  puts e.message
-  help_msg
-  exit 1
-end
-
-def file_manager(options)
-  service = WinRM::WinRMWebService.new(
-    options[:endpoint],
-    options[:auth_type].to_sym,
-    options)
-  WinRM::FS::FileManager.new(service)
-end
-
-def run(options)
-  bytes = file_manager(options).upload(options[:source_path], options[:dest_path])
-  puts "#{bytes} total bytes transfered"
-  exit 0
-rescue Interrupt
-  puts 'exiting'
-  # ctrl-c
-rescue WinRM::WinRMAuthorizationError
-  puts 'Authentication failed, bad user name or password'
-  exit 1
-rescue StandardError => e
-  puts e.message
-  exit 1
-end
-
-run(parse_options)
-
-# rubocop:enable all
+#!/usr/bin/env ruby
+# encoding: UTF-8
+#
+# Copyright 2014 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.
+
+# TODO: refactor this
+# rubocop:disable all
+
+$LOAD_PATH.push File.expand_path('../../lib', __FILE__)
+
+require 'io/console'
+require 'winrm-fs'
+
+def help_msg
+  puts 'Usage: rwinrmcp sourcefile user@host:directory/targetfile'
+  puts ''
+end
+
+def parse_options
+  options = {}
+  fail 'Missing required options' unless ARGV.length == 2
+
+  options[:source_path] = ARGV[0]
+  fail "Cannot find source file: #{options[:source_path]}" unless \
+    File.exist?(options[:source_path])
+
+  m = /^(?<user>[a-z0-9\.\!\$ _-]+)@{1}(?<host>[a-z0-9\.\-]+)(?<port>:[0-9]+)?:{1}(?<file>.+)/i.match(ARGV[1])
+  fail "#{ARGV[1]} is an invalid destination" unless m
+  options[:user] = m[:user]
+  options[:endpoint] = "http://#{m[:host]}#{m[:port] || ':5985'}/wsman"
+  options[:dest_path] = m[:file]
+
+  # Get the password
+  print 'Password: '
+  options[:pass] = STDIN.noecho(&:gets).chomp
+  puts
+
+  # Set some defaults required by WinRM WS
+  options[:auth_type] = :plaintext
+  options[:basic_auth_only] = true
+
+  options
+rescue StandardError => e
+  puts e.message
+  help_msg
+  exit 1
+end
+
+def file_manager(options)
+  service = WinRM::WinRMWebService.new(
+    options[:endpoint],
+    options[:auth_type].to_sym,
+    options)
+  WinRM::FS::FileManager.new(service)
+end
+
+def run(options)
+  bytes = file_manager(options).upload(options[:source_path], options[:dest_path])
+  puts "#{bytes} total bytes transfered"
+  exit 0
+rescue Interrupt
+  puts 'exiting'
+  # ctrl-c
+rescue WinRM::WinRMAuthorizationError
+  puts 'Authentication failed, bad user name or password'
+  exit 1
+rescue StandardError => e
+  puts e.message
+  exit 1
+end
+
+run(parse_options)
+
+# rubocop:enable all