winrm 2.2.3 → 2.3.0

data/lib/winrm/http/transport_factory.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");
@@ -59,9 +57,7 @@ module WinRM
                 .select { |m| m.to_s.start_with?('init_') && m.to_s.end_with?('_transport') }
                 .map { |tm| tm.to_s.split('_')[1] }
 
-        unless valid.include?(transport.to_s)
-          raise WinRM::InvalidTransportError.new(transport, valid)
-        end
+        raise WinRM::InvalidTransportError.new(transport, valid) unless valid.include?(transport.to_s)
       end
     end
   end

data/lib/winrm/output.rb

@@ -1,5 +1,3 @@
-# encoding: UTF-8
-#
 # Copyright 2014 Max Lincoln <max@devopsy.com>
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -48,6 +46,7 @@ module WinRM
     # Sets the exitcode
     def exitcode=(code)
       raise WinRM::InvalidExitCode unless code.is_a? Integer
+
       @exitcode = code
     end
 

data/lib/winrm/psrp/fragment.rb

@@ -1,5 +1,3 @@
-# encoding: UTF-8
-#
 # Copyright 2016 Matt Wrock <matt@mattwrock.com>
 # Copyright 2016 Shawn Neal <sneal@sneal.net>
 #

data/lib/winrm/psrp/message.rb

@@ -1,5 +1,3 @@
-# encoding: UTF-8
-#
 # Copyright 2015 Matt Wrock <matt@mattwrock.com>
 # Copyright 2016 Shawn Neal <sneal@sneal.net>
 #
@@ -81,7 +79,7 @@ module WinRM
         pipeline_id = nil,
         destination = SERVER_DESTINATION
       )
-        raise 'invalid message type' unless MESSAGE_TYPES.values.include?(type)
+        raise 'invalid message type' unless MESSAGE_TYPES.value?(type)
 
         @data = data
         @destination = destination

data/lib/winrm/psrp/message_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/psrp/message_data/base.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/psrp/message_data/error_record.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/psrp/message_data/pipeline_host_call.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/psrp/message_data/pipeline_output.rb

@@ -1,54 +1,48 @@
-# -*- encoding: utf-8 -*-
-#
-# Copyright 2016 Matt Wrock <matt@mattwrock.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.
-
-require 'rexml/document'
-
-module WinRM
-  module PSRP
-    module MessageData
-      # Handles decoding a raw powershell output response
-      class PipelineOutput < Base
-        def output
-          extract_out_string(remove_bom(raw.force_encoding('utf-8')))
-        end
-
-        private
-
-        def extract_out_string(text)
-          doc = REXML::Document.new(text)
-          doc.root.get_elements('//S').map do |node|
-            text = ''
-            if node.text
-              text << node.text.gsub(/_x(\h\h\h\h)_/) do
-                decoded_text = Regexp.last_match[1].hex.chr.force_encoding('utf-8')
-                if decoded_text.respond_to?(:scrub)
-                  decoded_text.scrub
-                else
-                  decoded_text.encode('utf-16', invalid: :replace, undef: :replace).encode('utf-8')
-                end
-              end.chomp
-            end
-            text << "\r\n"
-          end.join
-        end
-
-        def remove_bom(text)
-          text.sub("\xEF\xBB\xBF", '')
-        end
-      end
-    end
-  end
-end
+# Copyright 2016 Matt Wrock <matt@mattwrock.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.
+
+require 'rexml/document'
+
+module WinRM
+  module PSRP
+    module MessageData
+      # Handles decoding a raw powershell output response
+      class PipelineOutput < Base
+        def output
+          extract_out_string(remove_bom(raw.force_encoding('utf-8')))
+        end
+
+        private
+
+        def extract_out_string(text)
+          doc = REXML::Document.new(text)
+          doc.root.get_elements('//S').map do |node|
+            text = ''
+            if node.text
+              text << node.text.gsub(/(_x\h\h\h\h_)+/) do |match|
+                match.scan(/_x(\h\h\h\h)_/).flatten.map(&:hex)
+                     .pack('S*').force_encoding('utf-16le').encode('utf-8')
+              end.chomp
+            end
+            text << "\r\n"
+          end.join
+        end
+
+        def remove_bom(text)
+          text.sub("\xEF\xBB\xBF", '')
+        end
+      end
+    end
+  end
+end

data/lib/winrm/psrp/message_data/pipeline_state.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/psrp/message_data/runspacepool_host_call.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/psrp/message_data/runspacepool_state.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/psrp/message_data/session_capability.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/psrp/message_defragmenter.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');
@@ -31,11 +29,13 @@ module WinRM
         @messages[fragment.object_id] ||= []
         @messages[fragment.object_id].push fragment
 
+        # rubocop:disable Style/GuardClause
         if fragment.end_fragment
           blob = []
           @messages.delete(fragment.object_id).each { |frag| blob += frag.blob }
           return message_from(blob.pack('C*'))
         end
+        # rubocop:enable Style/GuardClause
       end
 
       def fragment_from(byte_string)

data/lib/winrm/psrp/message_factory.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");
@@ -65,7 +63,8 @@ module WinRM
         # @api private
         def render(template, context = nil)
           template_path = File.expand_path(
-            "#{File.dirname(__FILE__)}/#{template}.xml.erb")
+            "#{File.dirname(__FILE__)}/#{template}.xml.erb"
+          )
           template = File.read(template_path)
           Erubis::Eruby.new(template).result(context)
         end

data/lib/winrm/psrp/message_fragmenter.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');
@@ -45,7 +43,7 @@ module WinRM
             object_id,
             message.bytes[bytes_fragmented..last_byte - 1],
             fragment_id,
-            bytes_fragmented == 0,
+            bytes_fragmented.zero?,
             last_byte == message_bytes.length
           )
           fragment_id += 1

data/lib/winrm/psrp/powershell_output_decoder.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/psrp/receive_response_reader.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");
@@ -41,6 +39,7 @@ module WinRM
         read_response(wsmv_message, wait_for_done_state) do |stream|
           message = defragmenter.defragment(stream[:text])
           next unless message
+
           if block_given?
             yield message
           else
@@ -62,6 +61,7 @@ module WinRM
             output.exitcode = exit_code if exit_code
             decoded_text = @output_decoder.decode(message)
             next unless decoded_text
+
             out = { stream_type(message) => decoded_text }
             output << out
             yield [out[:stdout], out[:stderr]] if block_given?
@@ -79,9 +79,7 @@ module WinRM
         when WinRM::PSRP::Message::MESSAGE_TYPES[:pipeline_host_call]
           type = :stderr if message.data.include?('WriteError')
         when WinRM::PSRP::Message::MESSAGE_TYPES[:pipeline_state]
-          if message.parsed_data.pipeline_state == WinRM::PSRP::MessageData::PipelineState::FAILED
-            type = :stderr
-          end
+          type = :stderr if message.parsed_data.pipeline_state == WinRM::PSRP::MessageData::PipelineState::FAILED
         end
         type
       end

data/lib/winrm/psrp/uuid.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");
@@ -32,6 +30,7 @@ module WinRM
       # @return [Array<byte>] UUID in a Windows GUID compatible byte array layout.
       def uuid_to_windows_guid_bytes(uuid)
         return [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0] unless uuid
+
         b = uuid.scan(/[0-9a-fA-F]{2}/).map { |x| x.to_i(16) }
         b[0..3].reverse + b[4..5].reverse + b[6..7].reverse + b[8..15]
       end

data/lib/winrm/shells/base.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");
@@ -86,6 +84,7 @@ module WinRM
       # Closes the shell if one is open
       def close
         return unless shell_id
+
         begin
           self.class.close_shell(connection_opts, transport, shell_id)
         rescue WinRMWSManFault => e
@@ -132,6 +131,7 @@ module WinRM
         yield shell_id, command_id
       rescue WinRMWSManFault => e
         raise unless FAULTS_FOR_RESET.include?(e.fault_code) && (tries -= 1) > 0
+
         reset_on_error(e)
         retry
       ensure
@@ -152,7 +152,8 @@ module WinRM
           connection_opts,
           shell_uri: shell_uri,
           shell_id: shell_id,
-          command_id: command_id)
+          command_id: command_id
+        )
         transport.send_request(cleanup_msg.build)
       rescue WinRMWSManFault => e
         raise unless [ERROR_OPERATION_ABORTED, SHELL_NOT_FOUND].include?(e.fault_code)
@@ -174,7 +175,8 @@ module WinRM
       def add_finalizer
         ObjectSpace.define_finalizer(
           self,
-          self.class.finalize(connection_opts, transport, shell_id))
+          self.class.finalize(connection_opts, transport, shell_id)
+        )
       end
 
       def remove_finalizer

data/lib/winrm/shells/cmd.rb

@@ -1,65 +1,63 @@
-# -*- 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 'base'
-
-module WinRM
-  module Shells
-    # Proxy to a remote cmd.exe shell
-    class Cmd < Base
-      include WinRM::WSMV::SOAP
-      class << self
-        def finalize(connection_opts, transport, shell_id)
-          proc { Cmd.close_shell(connection_opts, transport, shell_id) }
-        end
-
-        def close_shell(connection_opts, transport, shell_id)
-          msg = WinRM::WSMV::CloseShell.new(connection_opts, shell_id: shell_id)
-          transport.send_request(msg.build)
-        end
-      end
-
-      protected
-
-      def send_command(command, arguments)
-        cmd_msg = WinRM::WSMV::Command.new(
-          connection_opts,
-          shell_id: shell_id,
-          command: command,
-          arguments: arguments
-        )
-        resp_doc = transport.send_request(cmd_msg.build)
-        command_id = REXML::XPath.first(resp_doc, "//#{NS_WIN_SHELL}:CommandId").text
-        logger.debug("[WinRM] Command created for #{command} with id: #{command_id}")
-        command_id
-      end
-
-      def response_reader
-        @response_reader ||= WinRM::WSMV::ReceiveResponseReader.new(transport, logger)
-      end
-
-      def open_shell
-        msg = WinRM::WSMV::CreateShell.new(connection_opts, shell_opts)
-        resp_doc = transport.send_request(msg.build)
-        REXML::XPath.first(resp_doc, "//*[@Name='ShellId']").text
-      end
-
-      def out_streams
-        %w(stdout stderr)
-      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 'base'
+
+module WinRM
+  module Shells
+    # Proxy to a remote cmd.exe shell
+    class Cmd < Base
+      include WinRM::WSMV::SOAP
+      class << self
+        def finalize(connection_opts, transport, shell_id)
+          proc { Cmd.close_shell(connection_opts, transport, shell_id) }
+        end
+
+        def close_shell(connection_opts, transport, shell_id)
+          msg = WinRM::WSMV::CloseShell.new(connection_opts, shell_id: shell_id)
+          transport.send_request(msg.build)
+        end
+      end
+
+      protected
+
+      def send_command(command, arguments)
+        cmd_msg = WinRM::WSMV::Command.new(
+          connection_opts,
+          shell_id: shell_id,
+          command: command,
+          arguments: arguments
+        )
+        resp_doc = transport.send_request(cmd_msg.build)
+        command_id = REXML::XPath.first(resp_doc, "//*[local-name() = 'CommandId']").text
+        logger.debug("[WinRM] Command created for #{command} with id: #{command_id}")
+        command_id
+      end
+
+      def response_reader
+        @response_reader ||= WinRM::WSMV::ReceiveResponseReader.new(transport, logger)
+      end
+
+      def open_shell
+        msg = WinRM::WSMV::CreateShell.new(connection_opts, shell_opts)
+        resp_doc = transport.send_request(msg.build)
+        REXML::XPath.first(resp_doc, "//*[@Name='ShellId']").text
+      end
+
+      def out_streams
+        %w[stdout stderr]
+      end
+    end
+  end
+end