winrm 1.3.0.dev.3 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 19e0ee9ca403a8fe7b5385edd2a055e040aa69fe
-  data.tar.gz: 7c66ac5aa2b9b02fa2245f52f1f61f770f929287
+  metadata.gz: f3608a4fcc34f3bcad9cee57c3fada4a67a4ccb0
+  data.tar.gz: 89f128800437d974194dedafb9ef3d56300c33e5
 SHA512:
-  metadata.gz: d2e8e8dddd4eb89fb2a19ff72ee2413cd39599c6c7198e1b8d3761f095739631ab73bb11467073d555a9fa059a723c081ce0d3d91188f2176143c65461770801
-  data.tar.gz: dcbd77c85f639859fdfbd60ba9a26b82ef7676139f9878853b8c4d64a85f8a1bff5e6051acb6f96d6c268025ed901ee7e7a054f4197886893e95954ed07de55a
+  metadata.gz: b041e877f6b11c9b11acff78c714da8d2bb6e3cd80f87a8788deb62177edb8f2e1483e9f9aa7d36966fd8cccc2d57c0f69c601498f782b96535b397ec22486c3
+  data.tar.gz: e10dd4724ec11e483fa652ba49cf93a41f8999256ef3b5564235856b46b340dd120d7602b9da63901b356f986deecf6f54edbe0a81a8cd39ea2703b3abbcb661

data/.rubocop.yml

@@ -0,0 +1,9 @@
+AllCops:
+  Exclude:
+    - 'lib/winrm/winrm_service.rb'
+
+Style/Encoding:
+  Enabled: true
+
+Metrics/LineLength:
+  Max: 100

data/Gemfile

@@ -1,2 +1,3 @@
+# encoding: UTF-8
 source 'https://rubygems.org'
 gemspec

data/README.md

@@ -72,28 +72,6 @@ iex $cmd
 WinRM::WinRMWebService.new(endpoint, :kerberos, :realm => 'MYREALM.COM')
 ```
 
-### Uploading files
-Files may be copied from the local machine to the winrm endpoint. Individual
-files or directories may be specified:
-```ruby
-service = WinRM::WinRMWebService.new(...
-file_manager = WinRM::FileManager.new(service)
-file_manager.upload('c:/dev/my_dir', '$env:AppData')
-```
-Or an array of several files and/or directories can be included:
-```ruby
-file_manager.upload(['c:/dev/file1.txt','c:/dev/dir1'], '$env:AppData')
-```
-
-#### Handling progress events
-If you want to implemnt 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
 You may have some errors like ```WinRM::WinRMAuthorizationError```.
 You can run the following commands on the server to try to solve the problem:
@@ -118,11 +96,14 @@ You can read more about that on issue [#29](https://github.com/WinRb/WinRM/issue
    'winrm quickconfig' on your server or enable WinRM via group policy and
    everything should be working.
 
-2. Multi-Instance support:  The SOAP back-end has been completely gutted
-   and is now using some of the Savon core libraries for parsing and
-   building packets. Moving away from Handsoap allows multiple instances
-   to be created because the SOAP backend is no longer a Singleton type
-   class.
+2. Multi-Instance support:  Moving away from Handsoap allows multiple
+   instances to be created because the SOAP backend is no longer a Singleton
+   type class.
+
+3. 100% Ruby: Nokogiri while faster can present additional frustration for
+   users above and beyond what is already required to get WinRM working.
+   The goal of this gem is make using WinRM easy. In V2 we plan on making
+   the parser swappable in case you really do need the performance.
 
 ## Contributing
 

data/Rakefile

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

data/VERSION

@@ -1 +1 @@
-1.3.0.dev.3
+1.3.0

data/Vagrantfile

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

data/bin/rwinrm

@@ -1,41 +1,44 @@
 #!/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.
 
-$:.push File.expand_path('../../lib', __FILE__)
+# rubocop:disable all
+
+$LOAD_PATH.push File.expand_path('../../lib', __FILE__)
 
 require 'readline'
 require 'io/console'
 require 'winrm'
 
 def help_msg
-  puts "Usage: rwinrm user@host"
-  puts ""
+  puts 'Usage: rwinrm user@host'
+  puts ''
 end
 
 def parse_options
   options = {}
-  raise "Missing required options" unless ARGV.length == 1
-  
+  fail 'Missing required options' unless ARGV.length == 1
+
   m = /^(?<user>\w+)@{1}(?<host>[a-zA-Z0-9\.]+)(?<port>:[0-9]+)?/.match(ARGV[0])
-  raise "#{ARGV[0]} is an invalid host" unless m
+  fail "#{ARGV[0]} is an invalid host" unless m
   options[:user] = m[:user]
   options[:endpoint] = "http://#{m[:host]}#{m[:port] || ':5985'}/wsman"
 
   # Get the password
-  print "Password: "
+  print 'Password: '
   options[:pass] = STDIN.noecho(&:gets).chomp
   puts
 
@@ -57,7 +60,7 @@ def repl(options)
     options)
 
   client.set_timeout(3600)
-  shell_id = client.open_shell()
+  shell_id = client.open_shell
   command_id = client.run_command(shell_id, 'cmd', "/K prompt [#{ARGV[0]}]$P$G")
 
   read_thread = Thread.new do
@@ -68,9 +71,9 @@ def repl(options)
   end
   read_thread.abort_on_exception = true
 
-  while buf = Readline.readline('', true)
+  while (buf = Readline.readline('', true))
     if buf =~ /^exit/
-      read_thread.exit()
+      read_thread.exit
       client.cleanup_command(shell_id, command_id)
       client.close_shell(shell_id)
       exit 0
@@ -79,13 +82,16 @@ def repl(options)
     end
   end
 rescue Interrupt
+  puts 'exiting'
   # ctrl-c
 rescue WinRM::WinRMAuthorizationError
-  puts "Authentication failed, bad user name or password"
+  puts 'Authentication failed, bad user name or password'
   exit 1
 rescue StandardError => e
   puts e.message
   exit 1
 end
 
-repl(parse_options())
+repl(parse_options)
+
+# rubocop:enable all

data/changelog.md

@@ -1,4 +1,25 @@
-1.2.0
+# WinRM Gem Changelog
+
+# 1.3.0
+- Fixed multiple issues with WinRMHTTPTransportError incorrectly being raised
+- Refactored and added more unit and integration tests
+- Added ability to write to stdin
+- Added rwinrm binary to launch remote shell
+- Added WINRM_LOG env var to set log level
+- Retry Kerberos auth once if 401 response is received
+- Remove Savon dependency and use newer versions of underlying dependencies
+- Remove Nokogiri dependency and replace with native Ruby XML
+- Fixed issue 85, ensure WQL response is not nil
+- All WinRM library errors inherit from base class WinRMError
+- Integrations tests should now pass on Windows Server 2008+
+- Bump Ruby NTLM gem version dependency
+- HTTP client receive timeout is now configurable via set_timeout
+- Added backwards compatible Output class to make it easier to collect output
+- Bumped gssapi dependency from 1.0 to 1.2 and fixed issue 54
+- Added Rubocop to build
+- Fixed error when commands contain a newline character
+
+# 1.2.0
 - Allow user to disable SSL peer ceritifcate validation #44
 - Allow commands with "'" chars on Ruby 2.x, fixes #69
 - Fixed uninitialized constant Module::Kconv in Ruby 2.x, fixes #65

data/lib/winrm.rb

@@ -1,11 +1,13 @@
+# encoding: UTF-8
+#
 # Copyright 2010 Dan Wanek <dan.wanek@gmail.com>
-# 
+#
 # 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.
@@ -13,22 +15,23 @@
 # limitations under the License.
 
 require 'date'
-require 'kconv' # rubyntlm .0.1.1 doesn't require kconv, workaround for issue #65
 require 'logging'
 
+# Main WinRM module entry point
 module WinRM
   # Enable logging if it is requested. We do this before
   # anything else so that we can setup the output before
   # any logging occurs.
-  if ENV["WINRM_LOG"] && ENV["WINRM_LOG"] != ""
+  if ENV['WINRM_LOG'] && ENV['WINRM_LOG'] != ''
     begin
-      Logging.logger.root.level = ENV["WINRM_LOG"]
+      Logging.logger.root.level = ENV['WINRM_LOG']
       Logging.logger.root.appenders = Logging.appenders.stderr
     rescue ArgumentError
       # This means that the logging level wasn't valid
-      $stderr.puts "Invalid WINRM_LOG level is set: #{ENV["WINRM_LOG"]}"
-      $stderr.puts ""
-      $stderr.puts "Please use one of the standard log levels: debug, info, warn, or error"
+      $stderr.puts "Invalid WINRM_LOG level is set: #{ENV['WINRM_LOG']}"
+      $stderr.puts ''
+      $stderr.puts 'Please use one of the standard log levels: ' \
+        'debug, info, warn, or error'
     end
   end
 end

data/lib/winrm/exceptions/exceptions.rb

@@ -1,11 +1,13 @@
+# encoding: UTF-8
+#
 # Copyright 2010 Dan Wanek <dan.wanek@gmail.com>
-# 
+#
 # 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.
@@ -13,19 +15,12 @@
 # limitations under the License.
 
 module WinRM
-
   # WinRM base class for errors
   class WinRMError < StandardError; end
 
   # Authorization Error
   class WinRMAuthorizationError < WinRMError; end
 
-  # Error that occurs when a file upload fails
-  class WinRMUploadError < WinRMError; end
-
-  # Error that occurs when a file download fails
-  class WinRMDownloadError < WinRMError; end
-
   # A Fault returned in the SOAP response. The XML node is a WSManFault
   class WinRMWSManFault < WinRMError
     attr_reader :fault_code

data/lib/winrm/helpers/iso8601_duration.rb

@@ -1,44 +1,48 @@
+# encoding: UTF-8
+#
 # Copyright 2010 Dan Wanek <dan.wanek@gmail.com>
-# 
+#
 # 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.
 
+# rubocop:disable Metrics/MethodLength
+# rubocop:disable Metrics/AbcSize
+
 # Format an ISO8601 Duration
 module Iso8601Duration
-
   # Convert the number of seconds to an ISO8601 duration format
   # @see http://tools.ietf.org/html/rfc2445#section-4.3.6
   # @param [Fixnum] seconds The amount of seconds for this duration
   def self.sec_to_dur(seconds)
     seconds = seconds.to_i
-    iso_str = "P"
-    if(seconds > 604800) # more than a week
-      weeks = seconds / 604800
-      seconds -= (604800 * weeks)
+    iso_str = 'P'
+    if seconds > 604_800 # more than a week
+      weeks = seconds / 604_800
+      seconds -= (604_800 * weeks)
       iso_str << "#{weeks}W"
     end
-    if(seconds > 86400) # more than a day
-      days = seconds / 86400
-      seconds -= (86400 * days)
+    if seconds > 86_400 # more than a day
+      days = seconds / 86_400
+      seconds -= (86_400 * days)
       iso_str << "#{days}D"
     end
-    if(seconds > 0)
-      iso_str << "T"
-      if(seconds > 3600) # more than an hour
+    if seconds > 0
+      iso_str << 'T'
+      if seconds > 3600 # more than an hour
         hours = seconds / 3600
         seconds -= (3600 * hours)
         iso_str << "#{hours}H"
       end
-      if(seconds > 60) # more than a minute
+      if seconds > 60 # more than a minute
         minutes = seconds / 60
         seconds -= (60 * minutes)
         iso_str << "#{minutes}M"
@@ -49,3 +53,6 @@ module Iso8601Duration
     iso_str
   end
 end
+
+# rubocop:enable Metrics/MethodLength
+# rubocop:enable Metrics/AbcSize

data/lib/winrm/helpers/powershell_script.rb

@@ -1,6 +1,22 @@
+# 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.
+
 module WinRM
+  # Wraps a PowerShell script to make it easy to Base64 encode for transport
   class PowershellScript
-
     attr_reader :text
 
     # Creates a new PowershellScript object which can be used to encode
@@ -13,10 +29,9 @@ module WinRM
     # Encodes the script so that it can be passed to the PowerShell
     # --EncodedCommand argument.
     # @return [String] The UTF-16LE base64 encoded script
-    def encoded()
+    def encoded
       encoded_script = text.encode('UTF-16LE', 'UTF-8')
       Base64.strict_encode64(encoded_script)
     end
-
   end
 end