winrm 2.2.3 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 46a0806843f652f3d0b8d8858eb87cf0365d8e4d
-  data.tar.gz: 76f409feeda643970222972be8c571e2905a6fb9
+SHA256:
+  metadata.gz: cd8c4887729128df19666c0a4f2b099b088261f5cb60ecb1b2adf52810188710
+  data.tar.gz: 8711a914b783a6f6a6a5f5f8eb15ad74d4798dcf29242ff4b3b59679858e0c9e
 SHA512:
-  metadata.gz: cd17e956aa071c63ab65c0a9db69bada2a256b735ee4c9e2b63b32a16920357749bc814b32b15dd3ad61e777d77144fa73eea1e851c23347e0486ded69ffd47b
-  data.tar.gz: 119346b0543a18a8715f90b2c318df0bf98cbdeeae16d8afd7ffd70f73c6690b620e8c94d541e4a0798dc490c395f5e4feee7d12c8e83fddf64970560781602d
+  metadata.gz: 87eb8b34f189b70da6d6fd21e70142892cd9a8485f952a649229fb8cde0f073796af6ed9eb904e6c6b2f6d270ee901ec3d8ad69c36cd575e0b8def04faf5f9c9
+  data.tar.gz: eaf8d672f6f53d62029d41452cfeda2f1c9fba0164528ce057376b1ceb8805b5deb5dfd76d320c4f4eac695c66f3ac517460fbe72ca7de1b0a899bacb7cf9c91

data/.rubocop.yml

@@ -10,8 +10,17 @@ Style/Encoding:
 Style/NumericLiterals:
   Enabled: false
 
+Layout/EndOfLine:
+  Enabled: false
+
+Layout/IndentHeredoc:
+  Enabled: false
+
+Metrics/BlockLength:
+  Max: 200
+
 Metrics/LineLength:
-  Max: 100
+  Max: 120
 
 Metrics/MethodLength:
   Max: 20
@@ -19,6 +28,9 @@ Metrics/MethodLength:
 ModuleLength:
   Max: 250
 
+Naming/HeredocDelimiterNaming:
+  Enabled: false
+
 ClassLength:
   Max: 250
 

data/.travis.yml

@@ -1,11 +1,10 @@
-language: ruby
-rvm:
-  - 2.0.0
-  - 2.1.0
-before_install:
-  - gem update bundler
-
-# This prevents testing branches that are created just for PRs
-branches:
-  only:
-  - master
+language: ruby
+rvm:
+  - 2.2.0
+before_install:
+  - gem update bundler
+
+# This prevents testing branches that are created just for PRs
+branches:
+  only:
+  - master

data/Gemfile

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

data/README.md

@@ -72,7 +72,7 @@ The `:negotiate` transport uses the [rubyntlm gem](https://github.com/WinRb/ruby
 ### `:ssl`
 ```ruby
 WinRM::Connection.new( 
-  endpoint: 'https://myhost:59856/wsman',
+  endpoint: 'https://myhost:5986/wsman',
   transport: :ssl,
   user: 'administrator',
   password: 'Pass@word1'

data/Rakefile

@@ -1,4 +1,3 @@
-# encoding: UTF-8
 require 'rubygems'
 require 'bundler/setup'
 require 'rspec/core/rake_task'
@@ -6,7 +5,7 @@ require 'rubocop/rake_task'
 require 'bundler/gem_tasks'
 
 # Change to the directory of this file.
-Dir.chdir(File.expand_path('../', __FILE__))
+Dir.chdir(File.expand_path(__dir__))
 
 desc 'Open a Pry console for this library'
 task :console do
@@ -29,6 +28,6 @@ end
 
 RuboCop::RakeTask.new
 
-task default: [:spec, :rubocop]
+task default: %i[spec rubocop]
 
-task all: [:default, :integration]
+task all: %i[default integration]

data/appveyor.yml

@@ -11,7 +11,7 @@ environment:
   user_key: c:\projects\winrm\key.pem
 
   matrix:
-    - ruby_version: "21"
+    - ruby_version: "22"
       winrm_endpoint: http://localhost:5985/wsman
 
 clone_folder: c:\projects\winrm
@@ -40,7 +40,6 @@ install:
   - 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:

data/bin/rwinrm

@@ -1,97 +1,90 @@
-#!/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.
-
-# 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 ''
-end
-
-def parse_options
-  options = {}
-  fail 'Missing required options' unless ARGV.length == 1
-
-  m = /^(?<user>[a-z0-9\.\!\$ _-]+)@{1}(?<host>[a-z0-9\.\-]+)(?<port>:[0-9]+)?/i.match(ARGV[0])
-  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: '
-  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 repl(options)
-  client = WinRM::WinRMWebService.new(
-    options[:endpoint],
-    options[:auth_type].to_sym,
-    options)
-
-  client.set_timeout(3600)
-  shell_id = client.open_shell
-  command_id = client.run_command(shell_id, 'cmd', "/K prompt [#{ARGV[0]}]$P$G")
-
-  read_thread = Thread.new do
-    client.get_command_output(shell_id, command_id) do |stdout, stderr|
-      STDOUT.write stdout
-      STDERR.write stderr
-    end
-  end
-  read_thread.abort_on_exception = true
-
-  while (buf = Readline.readline('', true))
-    if buf =~ /^exit/
-      read_thread.exit
-      client.cleanup_command(shell_id, command_id)
-      client.close_shell(shell_id)
-      exit 0
-    else
-      client.write_stdin(shell_id, command_id, "#{buf}\r\n")
-    end
-  end
-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
-
-repl(parse_options)
-
-# rubocop:enable all
+#!/usr/bin/env ruby
+
+# 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.
+
+# 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 ''
+end
+
+def parse_options
+  options = {}
+  fail 'Missing required options' unless ARGV.length == 1
+
+  m = /^(?<user>[a-z0-9\.\!\$ _-]+)@{1}(?<host>[a-z0-9\.\-]+)(?<port>:[0-9]+)?/i.match(ARGV[0])
+  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: '
+  options[:password] = STDIN.noecho(&:gets).chomp
+  puts
+
+  # Set some defaults required by WinRM WS
+  options[:transport] = :plaintext
+  options[:basic_auth_only] = true
+  options[:operation_timeout] = 3600
+
+  options
+rescue StandardError => e
+  puts e.message
+  help_msg
+  exit 1
+end
+
+def repl(options)
+  shell = nil
+
+  client = WinRM::Connection.new(options)
+  shell = client.shell(:powershell)
+  prompt = "PS #{ARGV[0]}> "
+
+  while (buf = Readline.readline(prompt, true))
+    if buf =~ /^exit/
+      shell.close
+      shell = nil
+      exit 0
+    else
+      shell.run(buf) do |stdout, stderr|
+        $stdout.write stdout
+        $stderr.write stderr
+      end
+    end
+  end
+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
+ensure
+  shell.close unless shell.nil?
+end
+
+repl(parse_options)
+
+# rubocop:enable all

data/changelog.md

@@ -1,5 +1,10 @@
 # WinRM Gem Changelog
 
+# 2.3.0
+- Fixes rwinrm command
+- Use pack('S*') instead of .chr so full utf-16 can be supported
+- Omi Server compatibility fixes
+
 # 2.2.3
 - Revert change made in 2.2.2 that retries network errors in Close and cleanup
 

data/lib/winrm.rb

@@ -1,5 +1,3 @@
-# encoding: UTF-8
-#
 # Copyright 2010 Dan Wanek <dan.wanek@gmail.com>
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -30,9 +28,9 @@ module WinRM
       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: ' \
+      warn "Invalid WINRM_LOG level is set: #{ENV['WINRM_LOG']}"
+      warn ''
+      warn 'Please use one of the standard log levels: ' \
         'debug, info, warn, or error'
     end
   end

data/lib/winrm/connection.rb

@@ -1,86 +1,84 @@
-# -*- encoding: utf-8 -*-
-#
-# Copyright 2016 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.
-
-require_relative 'connection_opts'
-require_relative 'http/transport_factory'
-require_relative 'shells/shell_factory'
-require_relative 'wsmv/wql_query'
-require_relative 'wsmv/wql_pull'
-
-module WinRM
-  # WinRM connection used to establish a session with the remote WinRM service.
-  class Connection
-    # Creates a new WinRM connection
-    # See the ConnectionOpts class for connection options.
-    def initialize(connection_opts)
-      configure_connection_opts(connection_opts)
-      configure_logger
-    end
-
-    attr_accessor :logger
-
-    # Creates a new shell on the remote Windows server associated with
-    # this connection.
-    # @param shell_type [Symbol] The shell type :cmd or :powershell
-    # @param shell_opts [Hash] Options targeted for the created shell
-    # @return [Shell] PowerShell or Cmd shell instance.
-    def shell(shell_type, shell_opts = {})
-      shell = shell_factory.create_shell(shell_type, shell_opts)
-      if block_given?
-        begin
-          yield shell
-        ensure
-          shell.close
-        end
-      else
-        shell
-      end
-    end
-
-    # Executes a WQL query against the WinRM connection
-    # @param wql [String] The wql query
-    # @param namespace [String] namespace for query - default is root/cimv2/*
-    # @return [Hash] Hash representation of wql query response (Hash is empty if a block is given)
-    # @yeild [type, item] Yields the time name and item for every item
-    def run_wql(wql, namespace = 'root/cimv2/*', &block)
-      query = WinRM::WSMV::WqlQuery.new(transport, @connection_opts, wql, namespace)
-      query.process_response(transport.send_request(query.build), &block)
-    end
-
-    private
-
-    def configure_connection_opts(connection_opts)
-      @connection_opts = ConnectionOpts.create_with_defaults(connection_opts)
-    end
-
-    def configure_logger
-      @logger = Logging.logger[self]
-      logger.level = :warn
-      logger.add_appenders(Logging.appenders.stdout)
-    end
-
-    def shell_factory
-      @shell_factory ||= WinRM::Shells::ShellFactory.new(@connection_opts, transport, logger)
-    end
-
-    def transport
-      @transport ||= begin
-        transport_factory = WinRM::HTTP::TransportFactory.new
-        transport_factory.create_transport(@connection_opts)
-      end
-    end
-  end
-end
+# Copyright 2016 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.
+
+require_relative 'connection_opts'
+require_relative 'http/transport_factory'
+require_relative 'shells/shell_factory'
+require_relative 'wsmv/wql_query'
+require_relative 'wsmv/wql_pull'
+
+module WinRM
+  # WinRM connection used to establish a session with the remote WinRM service.
+  class Connection
+    # Creates a new WinRM connection
+    # See the ConnectionOpts class for connection options.
+    def initialize(connection_opts)
+      configure_connection_opts(connection_opts)
+      configure_logger
+    end
+
+    attr_accessor :logger
+
+    # Creates a new shell on the remote Windows server associated with
+    # this connection.
+    # @param shell_type [Symbol] The shell type :cmd or :powershell
+    # @param shell_opts [Hash] Options targeted for the created shell
+    # @return [Shell] PowerShell or Cmd shell instance.
+    def shell(shell_type, shell_opts = {})
+      shell = shell_factory.create_shell(shell_type, shell_opts)
+      if block_given?
+        begin
+          yield shell
+        ensure
+          shell.close
+        end
+      else
+        shell
+      end
+    end
+
+    # Executes a WQL query against the WinRM connection
+    # @param wql [String] The wql query
+    # @param namespace [String] namespace for query - default is root/cimv2/*
+    # @return [Hash] Hash representation of wql query response (Hash is empty if a block is given)
+    # @yeild [type, item] Yields the time name and item for every item
+    def run_wql(wql, namespace = 'root/cimv2/*', &block)
+      query = WinRM::WSMV::WqlQuery.new(transport, @connection_opts, wql, namespace)
+      query.process_response(transport.send_request(query.build), &block)
+    end
+
+    private
+
+    def configure_connection_opts(connection_opts)
+      @connection_opts = ConnectionOpts.create_with_defaults(connection_opts)
+    end
+
+    def configure_logger
+      @logger = Logging.logger[self]
+      logger.level = :warn
+      logger.add_appenders(Logging.appenders.stdout)
+    end
+
+    def shell_factory
+      @shell_factory ||= WinRM::Shells::ShellFactory.new(@connection_opts, transport, logger)
+    end
+
+    def transport
+      @transport ||= begin
+        transport_factory = WinRM::HTTP::TransportFactory.new
+        transport_factory.create_transport(@connection_opts)
+      end
+    end
+  end
+end