winrm 2.0.3 → 2.1.0

data/lib/winrm/shells/retryable.rb

@@ -1,45 +1,45 @@
-# -*- encoding: utf-8 -*-
-#
-# Copyright 2016 Shawn Neal <sneal@sneal.net>
-# Copyright 2015 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_relative '../exceptions'
-
-module WinRM
-  module Shells
-    # Shell mixin for retrying an operation
-    module Retryable
-      RETRYABLE_EXCEPTIONS = lambda do
-        [
-          Errno::EACCES, Errno::EADDRINUSE, Errno::ECONNREFUSED, Errno::ETIMEDOUT,
-          Errno::ECONNRESET, Errno::ENETUNREACH, Errno::EHOSTUNREACH, ::WinRM::WinRMWSManFault,
-          ::WinRM::WinRMHTTPTransportError, ::WinRM::WinRMAuthorizationError,
-          HTTPClient::KeepAliveDisconnected, HTTPClient::ConnectTimeoutError
-        ].freeze
-      end
-
-      # Retries the operation a specified number of times with a delay between
-      # @param retries [Fixnum] The number of times to retry
-      # @param delay [Fixnum] The number of seconds to wait between retry attempts
-      def retryable(retries, delay)
-        yield
-      rescue *RETRYABLE_EXCEPTIONS.call
-        raise unless (retries -= 1) > 0
-        sleep(delay)
-        retry
-      end
-    end
-  end
-end
+# -*- encoding: utf-8 -*-
+#
+# Copyright 2016 Shawn Neal <sneal@sneal.net>
+# Copyright 2015 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_relative '../exceptions'
+
+module WinRM
+  module Shells
+    # Shell mixin for retrying an operation
+    module Retryable
+      RETRYABLE_EXCEPTIONS = lambda do
+        [
+          Errno::EACCES, Errno::EADDRINUSE, Errno::ECONNREFUSED, Errno::ETIMEDOUT,
+          Errno::ECONNRESET, Errno::ENETUNREACH, Errno::EHOSTUNREACH, ::WinRM::WinRMWSManFault,
+          ::WinRM::WinRMHTTPTransportError, ::WinRM::WinRMAuthorizationError,
+          HTTPClient::KeepAliveDisconnected, HTTPClient::ConnectTimeoutError
+        ].freeze
+      end
+
+      # Retries the operation a specified number of times with a delay between
+      # @param retries [Fixnum] The number of times to retry
+      # @param delay [Fixnum] The number of seconds to wait between retry attempts
+      def retryable(retries, delay)
+        yield
+      rescue *RETRYABLE_EXCEPTIONS.call
+        raise unless (retries -= 1) > 0
+        sleep(delay)
+        retry
+      end
+    end
+  end
+end

data/lib/winrm/shells/shell_factory.rb

@@ -1,50 +1,58 @@
-# -*- 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'
-require_relative 'cmd'
-require_relative 'power_shell'
-
-module WinRM
-  module Shells
-    # Factory for creating concrete shell instances
-    class ShellFactory
-      # Creates a new ShellFactory instance
-      # @param connection_opts [ConnectionOpts] The WinRM connection options
-      # @param transport [HttpTransport] The WinRM SOAP transport for sending messages
-      # @param logger [Logger] The logger to log messages to
-      def initialize(connection_opts, transport, logger)
-        @connection_opts = connection_opts
-        @transport = transport
-        @logger = logger
-      end
-
-      # Creates a new shell instance based off the shell_type
-      # @param shell_type [Symbol] The shell type :cmd or :powershell
-      # @return The ready to use shell instance
-      def create_shell(shell_type)
-        type = shell_type.to_s.capitalize.to_sym
-        if Shells.constants.include?(type)
-          WinRM::Shells.const_get(type).new(@connection_opts, @transport, @logger)
-        else
-          message = "#{type} is not a valid WinRM shell type. " \
-            'Expected either :cmd, :powershell or pluggable shell.'
-          raise WinRM::InvalidShellError, message
-        end
-      end
-    end
-  end
-end
+# -*- 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'
+require_relative 'cmd'
+require_relative 'power_shell'
+
+module WinRM
+  module Shells
+    # Factory for creating concrete shell instances
+    class ShellFactory
+      # Creates a new ShellFactory instance
+      # @param connection_opts [ConnectionOpts] The WinRM connection options
+      # @param transport [HttpTransport] The WinRM SOAP transport for sending messages
+      # @param logger [Logger] The logger to log messages to
+      def initialize(connection_opts, transport, logger)
+        @connection_opts = connection_opts
+        @transport = transport
+        @logger = logger
+      end
+
+      # Creates a new shell instance based off the shell_type
+      # @param shell_type [Symbol] The shell type :cmd or :powershell
+      # @param shell_opts [Hash] Options targeted for the created shell
+      # @return The ready to use shell instance
+      def create_shell(shell_type, shell_opts = {})
+        type = shell_type.to_s.capitalize.to_sym
+        args = [
+          @connection_opts,
+          @transport,
+          @logger
+        ]
+        # winrm-elevated has an initializer with no shell_opts so don't break it
+        args << shell_opts unless shell_opts.nil? || shell_opts.empty?
+        if Shells.constants.include?(type)
+          WinRM::Shells.const_get(type).new(*args)
+        else
+          message = "#{type} is not a valid WinRM shell type. " \
+            'Expected either :cmd, :powershell or pluggable shell.'
+          raise WinRM::InvalidShellError, message
+        end
+      end
+    end
+  end
+end

data/lib/winrm/version.rb

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

data/lib/winrm/wsmv/base.rb

@@ -1,59 +1,59 @@
-# -*- 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 'base64'
-require 'builder'
-require 'gyoku'
-require_relative 'soap'
-require_relative 'header'
-
-module WinRM
-  module WSMV
-    # Base class for all WSMV message classes
-    class Base
-      include WinRM::WSMV::SOAP
-      include WinRM::WSMV::Header
-
-      # Builds the WSMV message XML payload
-      def build
-        builder = Builder::XmlMarkup.new
-        builder.instruct!(:xml, encoding: 'UTF-8')
-        builder.tag! :env, :Envelope, namespaces do |env|
-          env.tag!(:env, :Header) do |env_header|
-            create_header(env_header)
-          end
-          env.tag!(:env, :Body) do |env_body|
-            create_body(env_body)
-          end
-        end
-      end
-
-      protected
-
-      def create_header
-        raise NotImplementedError
-      end
-
-      def create_body
-        raise NotImplementedError
-      end
-
-      def encode_bytes(bytes)
-        Base64.strict_encode64(bytes.pack('C*'))
-      end
-    end
-  end
-end
+# -*- 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 'base64'
+require 'builder'
+require 'gyoku'
+require_relative 'soap'
+require_relative 'header'
+
+module WinRM
+  module WSMV
+    # Base class for all WSMV message classes
+    class Base
+      include WinRM::WSMV::SOAP
+      include WinRM::WSMV::Header
+
+      # Builds the WSMV message XML payload
+      def build
+        builder = Builder::XmlMarkup.new
+        builder.instruct!(:xml, encoding: 'UTF-8')
+        builder.tag! :env, :Envelope, namespaces do |env|
+          env.tag!(:env, :Header) do |env_header|
+            create_header(env_header)
+          end
+          env.tag!(:env, :Body) do |env_body|
+            create_body(env_body)
+          end
+        end
+      end
+
+      protected
+
+      def create_header
+        raise NotImplementedError
+      end
+
+      def create_body
+        raise NotImplementedError
+      end
+
+      def encode_bytes(bytes)
+        Base64.strict_encode64(bytes.pack('C*'))
+      end
+    end
+  end
+end

data/lib/winrm/wsmv/cleanup_command.rb

@@ -1,61 +1,61 @@
-# -*- 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 WSMV
-    # WSMV message to execute a command inside a remote shell
-    class CleanupCommand < Base
-      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]
-        @shell_uri = opts[:shell_uri] || RESOURCE_URI_CMD
-      end
-
-      protected
-
-      def create_header(header)
-        header << Gyoku.xml(cleanup_header)
-      end
-
-      def create_body(body)
-        body.tag!("#{NS_WIN_SHELL}:Signal", 'CommandId' => @command_id) do |cl|
-          cl << Gyoku.xml(cleanup_body)
-        end
-      end
-
-      private
-
-      def cleanup_header
-        merge_headers(shared_headers(@session_opts),
-                      resource_uri_shell(@shell_uri),
-                      action_signal,
-                      selector_shell_id(@shell_id))
-      end
-
-      def cleanup_body
-        {
-          "#{NS_WIN_SHELL}:Code" =>
-            'http://schemas.microsoft.com/wbem/wsman/1/windows/shell/signal/terminate'
-        }
-      end
-    end
-  end
-end
+# -*- 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 WSMV
+    # WSMV message to execute a command inside a remote shell
+    class CleanupCommand < Base
+      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]
+        @shell_uri = opts[:shell_uri] || RESOURCE_URI_CMD
+      end
+
+      protected
+
+      def create_header(header)
+        header << Gyoku.xml(cleanup_header)
+      end
+
+      def create_body(body)
+        body.tag!("#{NS_WIN_SHELL}:Signal", 'CommandId' => @command_id) do |cl|
+          cl << Gyoku.xml(cleanup_body)
+        end
+      end
+
+      private
+
+      def cleanup_header
+        merge_headers(shared_headers(@session_opts),
+                      resource_uri_shell(@shell_uri),
+                      action_signal,
+                      selector_shell_id(@shell_id))
+      end
+
+      def cleanup_body
+        {
+          "#{NS_WIN_SHELL}:Code" =>
+            'http://schemas.microsoft.com/wbem/wsman/1/windows/shell/signal/terminate'
+        }
+      end
+    end
+  end
+end