winrm 2.2.3 → 2.3.0

data/lib/winrm/shells/shell_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");

data/lib/winrm/version.rb

@@ -1,7 +1,5 @@
-# encoding: UTF-8
-
 # WinRM module
 module WinRM
   # The version of the WinRM library
-  VERSION = '2.2.3'.freeze
+  VERSION = '2.3.0'.freeze
 end

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

data/lib/winrm/wsmv/cleanup_command.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");
@@ -23,6 +21,7 @@ module WinRM
       def initialize(session_opts, opts)
         raise 'opts[:shell_id] is required' unless opts[:shell_id]
         raise 'opts[:command_id] is required' unless opts[:command_id]
+
         @session_opts = session_opts
         @shell_id = opts[:shell_id]
         @command_id = opts[:command_id]

data/lib/winrm/wsmv/close_shell.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");
@@ -22,6 +20,7 @@ module WinRM
     class CloseShell < Base
       def initialize(session_opts, shell_opts)
         raise 'shell_opts[:shell_id] is required' unless shell_opts[:shell_id]
+
         @session_opts = session_opts
         @shell_id = shell_opts[:shell_id]
         @shell_uri = shell_opts[:shell_uri] || RESOURCE_URI_CMD

data/lib/winrm/wsmv/command.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");
@@ -85,12 +83,13 @@ module WinRM
 
       def command_header_opts
         return {} if @shell_uri != RESOURCE_URI_CMD
+
         # this is only needed for the regular Windows shell
         {
           "#{NS_WSMAN_DMTF}:OptionSet" => {
             "#{NS_WSMAN_DMTF}:Option" => [@consolemode, @skipcmd], :attributes! => {
               "#{NS_WSMAN_DMTF}:Option" => {
-                'Name' => %w(WINRS_CONSOLEMODE_STDIN WINRS_SKIP_CMD_SHELL)
+                'Name' => %w[WINRS_CONSOLEMODE_STDIN WINRS_SKIP_CMD_SHELL]
               }
             }
           }

data/lib/winrm/wsmv/command_output.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");
@@ -23,11 +21,12 @@ module WinRM
       def initialize(session_opts, command_out_opts)
         raise 'command_out_opts[:shell_id] is required' unless command_out_opts[:shell_id]
         raise 'command_out_opts[:command_id] is required' unless command_out_opts[:command_id]
+
         @session_opts = session_opts
         @shell_id = command_out_opts[:shell_id]
         @command_id = command_out_opts[:command_id]
         @shell_uri = command_out_opts[:shell_uri] || RESOURCE_URI_CMD
-        @out_streams = command_out_opts[:out_streams] || %w(stdout stderr)
+        @out_streams = command_out_opts[:out_streams] || %w[stdout stderr]
       end
 
       protected

data/lib/winrm/wsmv/command_output_decoder.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");
@@ -39,6 +37,7 @@ module WinRM
 
       def handle_invalid_encoding(decoded_text)
         return decoded_text if decoded_text.valid_encoding?
+
         if decoded_text.respond_to?(:scrub)
           decoded_text.scrub
         else

data/lib/winrm/wsmv/configuration.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/create_pipeline.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/create_shell.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");
@@ -62,9 +60,7 @@ module WinRM
           "#{NS_WIN_SHELL}:OutputStreams" => @o_stream
         }
         body["#{NS_WIN_SHELL}:WorkingDirectory"] = @working_directory if @working_directory
-        if @idle_timeout
-          body["#{NS_WIN_SHELL}:IdleTimeOut"] = format_idle_timeout(@idle_timeout)
-        end
+        body["#{NS_WIN_SHELL}:IdleTimeOut"] = format_idle_timeout(@idle_timeout) if @idle_timeout
         body["#{NS_WIN_SHELL}:Environment"] = environment_vars_body if @env_vars
         body
       end
@@ -108,7 +104,7 @@ module WinRM
           "#{NS_WSMAN_DMTF}:OptionSet" => {
             "#{NS_WSMAN_DMTF}:Option" => [@noprofile, @codepage], :attributes! => {
               "#{NS_WSMAN_DMTF}:Option" => {
-                'Name' => %w(WINRS_NOPROFILE WINRS_CODEPAGE)
+                'Name' => %w[WINRS_NOPROFILE WINRS_CODEPAGE]
               }
             }
           }

data/lib/winrm/wsmv/header.rb

@@ -1,215 +1,213 @@
-# -*- 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.
-
-# rubocop:disable Metrics/MethodLength
-
-require_relative 'soap'
-require_relative 'iso8601_duration'
-
-module WinRM
-  module WSMV
-    # SOAP header utility mixin
-    module Header
-      # WSMan URI of the regular Windows cmd shell
-      RESOURCE_URI_CMD = 'http://schemas.microsoft.com/wbem/wsman/1/windows/shell/cmd'.freeze
-
-      # WSMan URI for PowerShell
-      RESOURCE_URI_POWERSHELL = 'http://schemas.microsoft.com/powershell/Microsoft.PowerShell'.freeze
-
-      # Merge the various header hashes and make sure we carry all of the attributes
-      # through instead of overwriting them.
-      def merge_headers(*headers)
-        hdr = {}
-        headers.each do |h|
-          hdr.merge!(h) do |k, v1, v2|
-            v1.merge!(v2) if k == :attributes!
-          end
-        end
-        hdr
-      end
-
-      def shared_headers(session_opts)
-        {
-          "#{SOAP::NS_ADDRESSING}:To" => session_opts[:endpoint],
-          "#{SOAP::NS_ADDRESSING}:ReplyTo" => {
-            "#{SOAP::NS_ADDRESSING}:Address" =>
-              'http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous',
-            :attributes! => {
-              "#{SOAP::NS_ADDRESSING}:Address" => {
-                'mustUnderstand' => true
-              }
-            }
-          },
-          "#{SOAP::NS_WSMAN_DMTF}:MaxEnvelopeSize" => session_opts[:max_envelope_size],
-          "#{SOAP::NS_ADDRESSING}:MessageID" => "uuid:#{SecureRandom.uuid.to_s.upcase}",
-          "#{SOAP::NS_WSMAN_MSFT}:SessionId" => "uuid:#{session_opts[:session_id]}",
-          "#{SOAP::NS_WSMAN_DMTF}:Locale/" => '',
-          "#{SOAP::NS_WSMAN_MSFT}:DataLocale/" => '',
-          "#{SOAP::NS_WSMAN_DMTF}:OperationTimeout" =>
-            Iso8601Duration.sec_to_dur(session_opts[:operation_timeout]),
-          :attributes! => {
-            "#{SOAP::NS_WSMAN_DMTF}:MaxEnvelopeSize" => { 'mustUnderstand' => true },
-            "#{SOAP::NS_WSMAN_DMTF}:Locale/" => {
-              'xml:lang' => session_opts[:locale], 'mustUnderstand' => false
-            },
-            "#{SOAP::NS_WSMAN_MSFT}:DataLocale/" => {
-              'xml:lang' => session_opts[:locale], 'mustUnderstand' => false
-            },
-            "#{SOAP::NS_WSMAN_MSFT}:SessionId" => { 'mustUnderstand' => false }
-          }
-        }
-      end
-
-      # Helper methods for SOAP Headers
-
-      def resource_uri_shell(shell_uri)
-        {
-          "#{SOAP::NS_WSMAN_DMTF}:ResourceURI" => shell_uri, :attributes! => {
-            "#{SOAP::NS_WSMAN_DMTF}:ResourceURI" => {
-              'mustUnderstand' => true
-            }
-          }
-        }
-      end
-
-      def resource_uri_cmd
-        resource_uri_shell(RESOURCE_URI_CMD)
-      end
-
-      def resource_uri_wmi(namespace = 'root/cimv2/*')
-        {
-          "#{SOAP::NS_WSMAN_DMTF}:ResourceURI" =>
-          "http://schemas.microsoft.com/wbem/wsman/1/wmi/#{namespace}",
-          :attributes! => {
-            "#{SOAP::NS_WSMAN_DMTF}:ResourceURI" => {
-              'mustUnderstand' => true
-            }
-          }
-        }
-      end
-
-      def action_get
-        {
-          "#{SOAP::NS_ADDRESSING}:Action" =>
-          'http://schemas.xmlsoap.org/ws/2004/09/transfer/Get',
-          :attributes! => {
-            "#{SOAP::NS_ADDRESSING}:Action" => {
-              'mustUnderstand' => true
-            }
-          }
-        }
-      end
-
-      def action_delete
-        {
-          "#{SOAP::NS_ADDRESSING}:Action" =>
-          'http://schemas.xmlsoap.org/ws/2004/09/transfer/Delete',
-          :attributes! => {
-            "#{SOAP::NS_ADDRESSING}:Action" => {
-              'mustUnderstand' => true
-            }
-          }
-        }
-      end
-
-      def action_command
-        {
-          "#{SOAP::NS_ADDRESSING}:Action" =>
-          'http://schemas.microsoft.com/wbem/wsman/1/windows/shell/Command',
-          :attributes! => {
-            "#{SOAP::NS_ADDRESSING}:Action" => {
-              'mustUnderstand' => true
-            }
-          }
-        }
-      end
-
-      def action_receive
-        {
-          "#{SOAP::NS_ADDRESSING}:Action" =>
-          'http://schemas.microsoft.com/wbem/wsman/1/windows/shell/Receive',
-          :attributes! => {
-            "#{SOAP::NS_ADDRESSING}:Action" => {
-              'mustUnderstand' => true
-            }
-          }
-        }
-      end
-
-      def action_send
-        {
-          "#{SOAP::NS_ADDRESSING}:Action" =>
-          'http://schemas.microsoft.com/wbem/wsman/1/windows/shell/Send',
-          :attributes! => {
-            "#{SOAP::NS_ADDRESSING}:Action" => {
-              'mustUnderstand' => true
-            }
-          }
-        }
-      end
-
-      def action_signal
-        {
-          "#{SOAP::NS_ADDRESSING}:Action" =>
-          'http://schemas.microsoft.com/wbem/wsman/1/windows/shell/Signal',
-          :attributes! => {
-            "#{SOAP::NS_ADDRESSING}:Action" => {
-              'mustUnderstand' => true
-            }
-          }
-        }
-      end
-
-      def action_enumerate
-        {
-          "#{SOAP::NS_ADDRESSING}:Action" =>
-          'http://schemas.xmlsoap.org/ws/2004/09/enumeration/Enumerate',
-          :attributes! => {
-            "#{SOAP::NS_ADDRESSING}:Action" => {
-              'mustUnderstand' => true
-            }
-          }
-        }
-      end
-
-      def action_enumerate_pull
-        {
-          "#{SOAP::NS_ADDRESSING}:Action" =>
-          'http://schemas.xmlsoap.org/ws/2004/09/enumeration/Pull',
-          :attributes! => {
-            "#{SOAP::NS_ADDRESSING}:Action" => {
-              'mustUnderstand' => true
-            }
-          }
-        }
-      end
-
-      def selector_shell_id(shell_id)
-        {
-          "#{SOAP::NS_WSMAN_DMTF}:SelectorSet" => {
-            "#{SOAP::NS_WSMAN_DMTF}:Selector" => shell_id, :attributes! => {
-              "#{SOAP::NS_WSMAN_DMTF}:Selector" => {
-                'Name' => 'ShellId'
-              }
-            }
-          }
-        }
-      end
-    end
-  end
-end
-
-# rubocop:enable Metrics/MethodLength
+# 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.
+
+# rubocop:disable Metrics/MethodLength
+
+require_relative 'soap'
+require_relative 'iso8601_duration'
+
+module WinRM
+  module WSMV
+    # SOAP header utility mixin
+    module Header
+      # WSMan URI of the regular Windows cmd shell
+      RESOURCE_URI_CMD = 'http://schemas.microsoft.com/wbem/wsman/1/windows/shell/cmd'.freeze
+
+      # WSMan URI for PowerShell
+      RESOURCE_URI_POWERSHELL = 'http://schemas.microsoft.com/powershell/Microsoft.PowerShell'.freeze
+
+      # Merge the various header hashes and make sure we carry all of the attributes
+      # through instead of overwriting them.
+      def merge_headers(*headers)
+        hdr = {}
+        headers.each do |h|
+          hdr.merge!(h) do |k, v1, v2|
+            v1.merge!(v2) if k == :attributes!
+          end
+        end
+        hdr
+      end
+
+      def shared_headers(session_opts)
+        {
+          "#{SOAP::NS_ADDRESSING}:To" => session_opts[:endpoint],
+          "#{SOAP::NS_ADDRESSING}:ReplyTo" => {
+            "#{SOAP::NS_ADDRESSING}:Address" =>
+              'http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous',
+            :attributes! => {
+              "#{SOAP::NS_ADDRESSING}:Address" => {
+                'mustUnderstand' => true
+              }
+            }
+          },
+          "#{SOAP::NS_WSMAN_DMTF}:MaxEnvelopeSize" => session_opts[:max_envelope_size],
+          "#{SOAP::NS_ADDRESSING}:MessageID" => "uuid:#{SecureRandom.uuid.to_s.upcase}",
+          "#{SOAP::NS_WSMAN_MSFT}:SessionId" => "uuid:#{session_opts[:session_id]}",
+          "#{SOAP::NS_WSMAN_DMTF}:Locale/" => '',
+          "#{SOAP::NS_WSMAN_MSFT}:DataLocale/" => '',
+          "#{SOAP::NS_WSMAN_DMTF}:OperationTimeout" =>
+            Iso8601Duration.sec_to_dur(session_opts[:operation_timeout]),
+          :attributes! => {
+            "#{SOAP::NS_WSMAN_DMTF}:MaxEnvelopeSize" => { 'mustUnderstand' => true },
+            "#{SOAP::NS_WSMAN_DMTF}:Locale/" => {
+              'xml:lang' => session_opts[:locale], 'mustUnderstand' => false
+            },
+            "#{SOAP::NS_WSMAN_MSFT}:DataLocale/" => {
+              'xml:lang' => session_opts[:locale], 'mustUnderstand' => false
+            },
+            "#{SOAP::NS_WSMAN_MSFT}:SessionId" => { 'mustUnderstand' => false }
+          }
+        }
+      end
+
+      # Helper methods for SOAP Headers
+
+      def resource_uri_shell(shell_uri)
+        {
+          "#{SOAP::NS_WSMAN_DMTF}:ResourceURI" => shell_uri, :attributes! => {
+            "#{SOAP::NS_WSMAN_DMTF}:ResourceURI" => {
+              'mustUnderstand' => true
+            }
+          }
+        }
+      end
+
+      def resource_uri_cmd
+        resource_uri_shell(RESOURCE_URI_CMD)
+      end
+
+      def resource_uri_wmi(namespace = 'root/cimv2/*')
+        {
+          "#{SOAP::NS_WSMAN_DMTF}:ResourceURI" =>
+          "http://schemas.microsoft.com/wbem/wsman/1/wmi/#{namespace}",
+          :attributes! => {
+            "#{SOAP::NS_WSMAN_DMTF}:ResourceURI" => {
+              'mustUnderstand' => true
+            }
+          }
+        }
+      end
+
+      def action_get
+        {
+          "#{SOAP::NS_ADDRESSING}:Action" =>
+          'http://schemas.xmlsoap.org/ws/2004/09/transfer/Get',
+          :attributes! => {
+            "#{SOAP::NS_ADDRESSING}:Action" => {
+              'mustUnderstand' => true
+            }
+          }
+        }
+      end
+
+      def action_delete
+        {
+          "#{SOAP::NS_ADDRESSING}:Action" =>
+          'http://schemas.xmlsoap.org/ws/2004/09/transfer/Delete',
+          :attributes! => {
+            "#{SOAP::NS_ADDRESSING}:Action" => {
+              'mustUnderstand' => true
+            }
+          }
+        }
+      end
+
+      def action_command
+        {
+          "#{SOAP::NS_ADDRESSING}:Action" =>
+          'http://schemas.microsoft.com/wbem/wsman/1/windows/shell/Command',
+          :attributes! => {
+            "#{SOAP::NS_ADDRESSING}:Action" => {
+              'mustUnderstand' => true
+            }
+          }
+        }
+      end
+
+      def action_receive
+        {
+          "#{SOAP::NS_ADDRESSING}:Action" =>
+          'http://schemas.microsoft.com/wbem/wsman/1/windows/shell/Receive',
+          :attributes! => {
+            "#{SOAP::NS_ADDRESSING}:Action" => {
+              'mustUnderstand' => true
+            }
+          }
+        }
+      end
+
+      def action_send
+        {
+          "#{SOAP::NS_ADDRESSING}:Action" =>
+          'http://schemas.microsoft.com/wbem/wsman/1/windows/shell/Send',
+          :attributes! => {
+            "#{SOAP::NS_ADDRESSING}:Action" => {
+              'mustUnderstand' => true
+            }
+          }
+        }
+      end
+
+      def action_signal
+        {
+          "#{SOAP::NS_ADDRESSING}:Action" =>
+          'http://schemas.microsoft.com/wbem/wsman/1/windows/shell/Signal',
+          :attributes! => {
+            "#{SOAP::NS_ADDRESSING}:Action" => {
+              'mustUnderstand' => true
+            }
+          }
+        }
+      end
+
+      def action_enumerate
+        {
+          "#{SOAP::NS_ADDRESSING}:Action" =>
+          'http://schemas.xmlsoap.org/ws/2004/09/enumeration/Enumerate',
+          :attributes! => {
+            "#{SOAP::NS_ADDRESSING}:Action" => {
+              'mustUnderstand' => true
+            }
+          }
+        }
+      end
+
+      def action_enumerate_pull
+        {
+          "#{SOAP::NS_ADDRESSING}:Action" =>
+          'http://schemas.xmlsoap.org/ws/2004/09/enumeration/Pull',
+          :attributes! => {
+            "#{SOAP::NS_ADDRESSING}:Action" => {
+              'mustUnderstand' => true
+            }
+          }
+        }
+      end
+
+      def selector_shell_id(shell_id)
+        {
+          "#{SOAP::NS_WSMAN_DMTF}:SelectorSet" => {
+            "#{SOAP::NS_WSMAN_DMTF}:Selector" => shell_id, :attributes! => {
+              "#{SOAP::NS_WSMAN_DMTF}:Selector" => {
+                'Name' => 'ShellId'
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end
+
+# rubocop:enable Metrics/MethodLength