winrm 2.2.3 → 2.3.6

data/lib/winrm/wsmv/iso8601_duration.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");

data/lib/winrm/wsmv/keep_alive.rb

@@ -1,5 +1,3 @@
-# -*- encoding: utf-8 -*-
-#
 # Copyright 2016 Matt Wrock <matt@mattwrock.com>
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/winrm/wsmv/receive_response_reader.rb

@@ -1,126 +1,128 @@
-# -*- 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 'soap'
-require_relative 'header'
-require_relative 'command_output_decoder'
-require_relative '../output'
-
-module WinRM
-  module WSMV
-    # Class for reading wsmv Receive_Response messages
-    class ReceiveResponseReader
-      include WinRM::WSMV::SOAP
-      include WinRM::WSMV::Header
-
-      # Creates a new ReceiveResponseReader
-      # @param transport [HttpTransport] The WinRM SOAP transport
-      # @param logger [Logger] The logger to log diagnostic messages to
-      def initialize(transport, logger)
-        @transport = transport
-        @logger = logger
-        @output_decoder = CommandOutputDecoder.new
-      end
-
-      attr_reader :logger
-
-      # Reads streams and returns decoded output
-      # @param wsmv_message [WinRM::WSMV::Base] A wsmv message to send to endpoint
-      # @yieldparam [string] standard out response text
-      # @yieldparam [string] standard error response text
-      # @yieldreturn [WinRM::Output] The command output
-      def read_output(wsmv_message)
-        with_output do |output|
-          read_response(wsmv_message, true) do |stream, doc|
-            handled_out = handle_stream(stream, output, doc)
-            yield handled_out if handled_out && block_given?
-          end
-        end
-      end
-
-      # Reads streams sent in one or more receive response messages
-      # @param wsmv_message [WinRM::WSMV::Base] A wsmv message to send to endpoint
-      # @param wait_for_done_state whether to poll for a CommandState of Done
-      # @yieldparam [Hash] Hash representation of stream with type and text
-      # @yieldparam [REXML::Document] Complete SOAP envelope returned to wsmv_message
-      def read_response(wsmv_message, wait_for_done_state = false)
-        resp_doc = nil
-        until command_done?(resp_doc, wait_for_done_state)
-          logger.debug('[WinRM] Waiting for output...')
-          resp_doc = send_get_output_message(wsmv_message.build)
-          logger.debug('[WinRM] Processing output')
-          read_streams(resp_doc) do |stream|
-            yield stream, resp_doc
-          end
-        end
-      end
-
-      protected
-
-      def with_output
-        output = WinRM::Output.new
-        yield output
-        output.exitcode ||= 0
-        output
-      end
-
-      private
-
-      def handle_stream(stream, output, resp_doc)
-        decoded_text = @output_decoder.decode(stream[:text])
-        return unless decoded_text
-
-        out = { stream[:type] => decoded_text }
-        output << out
-        if (code = REXML::XPath.first(resp_doc, "//#{NS_WIN_SHELL}:ExitCode"))
-          output.exitcode = code.text.to_i
-        end
-        [out[:stdout], out[:stderr]]
-      end
-
-      def send_get_output_message(message)
-        @transport.send_request(message)
-      rescue WinRMWSManFault => e
-        # If no output is available before the wsman:OperationTimeout expires,
-        # the server MUST return a WSManFault with the Code attribute equal to
-        # 2150858793. When the client receives this fault, it SHOULD issue
-        # another Receive request.
-        # http://msdn.microsoft.com/en-us/library/cc251676.aspx
-        raise unless e.fault_code == '2150858793'
-
-        logger.debug('[WinRM] retrying receive request after timeout')
-        retry
-      end
-
-      def command_done?(resp_doc, wait_for_done_state)
-        return false unless resp_doc
-        return true unless wait_for_done_state
-
-        REXML::XPath.match(
-          resp_doc,
-          "//*[@State='http://schemas.microsoft.com/wbem/wsman/1/windows/shell/" \
-          "CommandState/Done']").any?
-      end
-
-      def read_streams(response_document)
-        REXML::XPath.match(response_document, "//#{NS_WIN_SHELL}:Stream").each do |stream|
-          next if stream.text.nil? || stream.text.empty?
-          yield type: stream.attributes['Name'].to_sym, text: stream.text
-        end
-      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 'soap'
+require_relative 'header'
+require_relative 'command_output_decoder'
+require_relative '../output'
+
+module WinRM
+  module WSMV
+    # Class for reading wsmv Receive_Response messages
+    class ReceiveResponseReader
+      include WinRM::WSMV::SOAP
+      include WinRM::WSMV::Header
+
+      # Creates a new ReceiveResponseReader
+      # @param transport [HttpTransport] The WinRM SOAP transport
+      # @param logger [Logger] The logger to log diagnostic messages to
+      def initialize(transport, logger)
+        @transport = transport
+        @logger = logger
+        @output_decoder = CommandOutputDecoder.new
+      end
+
+      attr_reader :logger
+
+      # Reads streams and returns decoded output
+      # @param wsmv_message [WinRM::WSMV::Base] A wsmv message to send to endpoint
+      # @yieldparam [string] standard out response text
+      # @yieldparam [string] standard error response text
+      # @yieldreturn [WinRM::Output] The command output
+      def read_output(wsmv_message)
+        with_output do |output|
+          read_response(wsmv_message, true) do |stream, doc|
+            handled_out = handle_stream(stream, output, doc)
+            yield handled_out if handled_out && block_given?
+          end
+        end
+      end
+
+      # Reads streams sent in one or more receive response messages
+      # @param wsmv_message [WinRM::WSMV::Base] A wsmv message to send to endpoint
+      # @param wait_for_done_state whether to poll for a CommandState of Done
+      # @yieldparam [Hash] Hash representation of stream with type and text
+      # @yieldparam [REXML::Document] Complete SOAP envelope returned to wsmv_message
+      def read_response(wsmv_message, wait_for_done_state = false)
+        resp_doc = nil
+        until command_done?(resp_doc, wait_for_done_state)
+          logger.debug('[WinRM] Waiting for output...')
+          resp_doc = send_get_output_message(wsmv_message.build)
+          logger.debug('[WinRM] Processing output')
+          read_streams(resp_doc) do |stream|
+            yield stream, resp_doc
+          end
+        end
+      end
+
+      protected
+
+      def with_output
+        output = WinRM::Output.new
+        yield output
+        output.exitcode ||= 0
+        output
+      end
+
+      private
+
+      def handle_stream(stream, output, resp_doc)
+        decoded_text = @output_decoder.decode(stream[:text])
+        return unless decoded_text
+
+        out = { stream[:type] => decoded_text }
+        output << out
+        if (code = REXML::XPath.first(resp_doc, "//*[local-name() = 'ExitCode']"))
+          output.exitcode = code.text.to_i
+        end
+        [out[:stdout], out[:stderr]]
+      end
+
+      def send_get_output_message(message)
+        @transport.send_request(message)
+      rescue WinRMWSManFault => e
+        # If no output is available before the wsman:OperationTimeout expires,
+        # the server MUST return a WSManFault with the Code attribute equal to
+        # 2150858793. When the client receives this fault, it SHOULD issue
+        # another Receive request.
+        # http://msdn.microsoft.com/en-us/library/cc251676.aspx
+        raise unless e.fault_code == '2150858793'
+
+        logger.debug('[WinRM] retrying receive request after timeout')
+        retry
+      end
+
+      def command_done?(resp_doc, wait_for_done_state)
+        return false unless resp_doc
+        return true unless wait_for_done_state
+
+        REXML::XPath.match(
+          resp_doc,
+          "//*[@State='http://schemas.microsoft.com/wbem/wsman/1/windows/shell/" \
+          "CommandState/Done']"
+        ).any?
+      end
+
+      def read_streams(response_document)
+        body_path = "/*[local-name() = 'Envelope']/*[local-name() = 'Body']"
+        path = "#{body_path}/*[local-name() = 'ReceiveResponse']/*[local-name() = 'Stream']"
+        REXML::XPath.match(response_document, path).each do |stream|
+          next if stream.text.nil? || stream.text.empty?
+
+          yield type: stream.attributes['Name'].to_sym, text: stream.text
+        end
+      end
+    end
+  end
+end

data/lib/winrm/wsmv/send_data.rb

@@ -1,5 +1,3 @@
-# -*- encoding: utf-8 -*-
-#
 # Copyright 2016 Matt Wrock <matt@mattwrock.com>
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/winrm/wsmv/soap.rb

@@ -1,5 +1,3 @@
-# -*- encoding: utf-8 -*-
-#
 # Copyright 2010 Dan Wanek <dan.wanek@gmail.com>
 # Copyright 2016 Shawn Neal <sneal@sneal.net>
 #

data/lib/winrm/wsmv/wql_pull.rb

@@ -1,56 +1,54 @@
-# -*- encoding: utf-8 -*-
-
-require 'nori'
-require_relative 'base'
-
-module WinRM
-  module WSMV
-    # WSMV message to 'pull' rest of enumeration results from Windows via WQL
-    class WqlPull < Base
-      def initialize(session_opts, namespace, enumeration_context)
-        @session_opts = session_opts
-        @namespace = namespace
-        @enumeration_context = enumeration_context
-      end
-
-      def process_response(response)
-        parser = Nori.new(
-          parser: :rexml,
-          advanced_typecasting: false,
-          convert_tags_to: ->(tag) { tag.snakecase.to_sym },
-          strip_namespaces: true
-        )
-        parser.parse(response.to_s)[:envelope][:body]
-      end
-
-      protected
-
-      def create_header(header)
-        header << Gyoku.xml(wql_header)
-      end
-
-      def create_body(body)
-        body.tag!("#{NS_ENUM}:Pull") { |en| en << Gyoku.xml(wql_body) }
-      end
-
-      private
-
-      def wql_header
-        merge_headers(
-          shared_headers(@session_opts),
-          resource_uri_wmi(@namespace),
-          action_enumerate_pull
-        )
-      end
-
-      def wql_body
-        {
-          "#{NS_ENUM}:EnumerationContext" => @enumeration_context,
-          "#{NS_WSMAN_DMTF}:OptimizeEnumeration" => nil,
-          "#{NS_ENUM}:MaxElements" => '32000',
-          "#{NS_WSMAN_MSFT}:SessionId" => "uuid:#{@session_opts[:session_id]}"
-        }
-      end
-    end
-  end
-end
+require 'nori'
+require_relative 'base'
+
+module WinRM
+  module WSMV
+    # WSMV message to 'pull' rest of enumeration results from Windows via WQL
+    class WqlPull < Base
+      def initialize(session_opts, namespace, enumeration_context)
+        @session_opts = session_opts
+        @namespace = namespace
+        @enumeration_context = enumeration_context
+      end
+
+      def process_response(response)
+        parser = Nori.new(
+          parser: :rexml,
+          advanced_typecasting: false,
+          convert_tags_to: ->(tag) { tag.snakecase.to_sym },
+          strip_namespaces: true
+        )
+        parser.parse(response.to_s)[:envelope][:body]
+      end
+
+      protected
+
+      def create_header(header)
+        header << Gyoku.xml(wql_header)
+      end
+
+      def create_body(body)
+        body.tag!("#{NS_ENUM}:Pull") { |en| en << Gyoku.xml(wql_body) }
+      end
+
+      private
+
+      def wql_header
+        merge_headers(
+          shared_headers(@session_opts),
+          resource_uri_wmi(@namespace),
+          action_enumerate_pull
+        )
+      end
+
+      def wql_body
+        {
+          "#{NS_ENUM}:EnumerationContext" => @enumeration_context,
+          "#{NS_WSMAN_DMTF}:OptimizeEnumeration" => nil,
+          "#{NS_ENUM}:MaxElements" => '32000',
+          "#{NS_WSMAN_MSFT}:SessionId" => "uuid:#{@session_opts[:session_id]}"
+        }
+      end
+    end
+  end
+end

data/lib/winrm/wsmv/wql_query.rb

@@ -1,99 +1,98 @@
-# -*- 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 'nori'
-require_relative 'base'
-
-module WinRM
-  module WSMV
-    # WSMV message to query Windows via WQL
-    class WqlQuery < Base
-      def initialize(transport, session_opts, wql, namespace = nil)
-        @session_opts = session_opts
-        @wql = wql
-        @namespace = namespace
-        @transport = transport
-      end
-
-      def process_response(response, &block)
-        parser = Nori.new(
-          parser: :rexml,
-          advanced_typecasting: false,
-          convert_tags_to: ->(tag) { tag.snakecase.to_sym },
-          strip_namespaces: true
-        )
-        @items = Hash.new { |h, k| h[k] = [] }
-
-        hresp = parser.parse(response.to_s)[:envelope][:body][:enumerate_response]
-        process_items hresp[:items], &block
-
-        # Perform WS-Enum PULL's until we have all the elements
-        enumeration_context = hresp[:enumeration_context]
-        until enumeration_context.nil?
-          query = WqlPull.new(@session_opts, @namespace, enumeration_context)
-          hresp = query.process_response(@transport.send_request(query.build))[:pull_response]
-          process_items hresp[:items], &block
-          enumeration_context = hresp[:enumeration_context]
-        end
-
-        @items
-      end
-
-      protected
-
-      def create_header(header)
-        header << Gyoku.xml(wql_header)
-      end
-
-      def create_body(body)
-        body.tag!("#{NS_ENUM}:Enumerate") { |en| en << Gyoku.xml(wql_body) }
-      end
-
-      private
-
-      def process_items(items, &block)
-        return if items.nil?
-        items.each_pair do |k, v|
-          # Normalize items so the type always has an array even if it's just a single item.
-          v_ary = v.is_a?(Array) ? v : [v]
-          if block
-            v_ary.each { |val| yield k, val }
-          else
-            @items[k] += v_ary
-          end
-        end
-      end
-
-      def wql_header
-        merge_headers(shared_headers(@session_opts), resource_uri_wmi(@namespace), action_enumerate)
-      end
-
-      def wql_body
-        {
-          "#{NS_WSMAN_DMTF}:OptimizeEnumeration" => nil,
-          "#{NS_WSMAN_DMTF}:MaxElements" => '32000',
-          "#{NS_WSMAN_DMTF}:Filter" => @wql,
-          "#{NS_WSMAN_MSFT}:SessionId" => "uuid:#{@session_opts[:session_id]}",
-          :attributes! => {
-            "#{NS_WSMAN_DMTF}:Filter" => {
-              'Dialect' => 'http://schemas.microsoft.com/wbem/wsman/1/WQL'
-            }
-          }
-        }
-      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 'nori'
+require_relative 'base'
+
+module WinRM
+  module WSMV
+    # WSMV message to query Windows via WQL
+    class WqlQuery < Base
+      def initialize(transport, session_opts, wql, namespace = nil)
+        @session_opts = session_opts
+        @wql = wql
+        @namespace = namespace
+        @transport = transport
+      end
+
+      def process_response(response, &block)
+        parser = Nori.new(
+          parser: :rexml,
+          advanced_typecasting: false,
+          convert_tags_to: ->(tag) { tag.snakecase.to_sym },
+          strip_namespaces: true
+        )
+        @items = Hash.new { |h, k| h[k] = [] }
+
+        hresp = parser.parse(response.to_s)[:envelope][:body][:enumerate_response]
+        process_items hresp[:items], &block
+
+        # Perform WS-Enum PULL's until we have all the elements
+        enumeration_context = hresp[:enumeration_context]
+        until enumeration_context.nil?
+          query = WqlPull.new(@session_opts, @namespace, enumeration_context)
+          hresp = query.process_response(@transport.send_request(query.build))[:pull_response]
+          process_items hresp[:items], &block
+          enumeration_context = hresp[:enumeration_context]
+        end
+
+        @items
+      end
+
+      protected
+
+      def create_header(header)
+        header << Gyoku.xml(wql_header)
+      end
+
+      def create_body(body)
+        body.tag!("#{NS_ENUM}:Enumerate") { |en| en << Gyoku.xml(wql_body) }
+      end
+
+      private
+
+      def process_items(items, &block)
+        return if items.nil?
+
+        items.each_pair do |k, v|
+          # Normalize items so the type always has an array even if it's just a single item.
+          v_ary = v.is_a?(Array) ? v : [v]
+          if block
+            v_ary.each { |val| yield k, val }
+          else
+            @items[k] += v_ary
+          end
+        end
+      end
+
+      def wql_header
+        merge_headers(shared_headers(@session_opts), resource_uri_wmi(@namespace), action_enumerate)
+      end
+
+      def wql_body
+        {
+          "#{NS_WSMAN_DMTF}:OptimizeEnumeration" => nil,
+          "#{NS_WSMAN_DMTF}:MaxElements" => '32000',
+          "#{NS_WSMAN_DMTF}:Filter" => @wql,
+          "#{NS_WSMAN_MSFT}:SessionId" => "uuid:#{@session_opts[:session_id]}",
+          :attributes! => {
+            "#{NS_WSMAN_DMTF}:Filter" => {
+              'Dialect' => 'http://schemas.microsoft.com/wbem/wsman/1/WQL'
+            }
+          }
+        }
+      end
+    end
+  end
+end

data/lib/winrm/wsmv/write_stdin.rb

@@ -1,5 +1,3 @@
-# -*- encoding: utf-8 -*-
-#
 # Copyright 2016 Shawn Neal <sneal@sneal.net>
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

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