winrm-transport 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aa1f2fdc3f82de0bb032b2596593bfa9da97ec6b
-  data.tar.gz: 4eba1f0bd3c1c43120cec91a3808965074707b09
+  metadata.gz: 9ca52f34c3f6b0ff2f00ece7df30f643f1550cad
+  data.tar.gz: 6ed1f20e933dc8f8b66e85b7baf8d8b0b2b000c4
 SHA512:
-  metadata.gz: ad0da920c78b1437d40405341d92daa43dfb932a0bd92a796105aad4acdca540a53e01e37e9cc546c3f08b164f16a116e2231738ee3cc492fd5ab10897b2e8fd
-  data.tar.gz: c94c56a6e8574af20e253a1c8058e25cc05b952e98b27373b09a1d1afba8dbf6ed65e0e8daa5ac613434e68011b1156f9401097e6a484262fdb3c5ab40d5ab6d
+  metadata.gz: ff8c18ab5f56d00ccc1ba7625de74d7d05c3bd1df2a053454dde0e236e10f808c13443311e77dbe9d31f2da0b7ad743049727925f07724796a4e42450fc24ed4
+  data.tar.gz: de9e5d01d7774e9eb3a76d22ddd12bc56eb1907554f4074ff1d88489be2e02c0cd7fdeb6c8b98024a8b469cc66e090244a0675669fd53b685418ce171b994a5a

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 1.0.4 / 2017-01-06
+
+* Adds deprecation verbage to gemspec
+
 ## 1.0.2 / 2015-11-10
 
 ### Bug fixes

data/lib/winrm/transport/command_executor.rb

@@ -1,217 +1,217 @@
-# -*- encoding: utf-8 -*-
-#
-# Author:: Matt Wrock (<matt@mattwrock.com>)
-#
-# Copyright (C) 2014, Matt Wrock
-#
-# 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 "winrm/transport/logging"
-
-module WinRM
-
-  module Transport
-
-    # Object which can execute multiple commands and Powershell scripts in
-    # one shared remote shell session. The maximum number of commands per
-    # shell is determined by interrogating the remote host when the session
-    # is opened and the remote shell is automatically recycled before the
-    # threshold is reached.
-    #
-    # @author Matt Wrock <matt@mattwrock.com>
-    # @author Fletcher Nichol <fnichol@nichol.ca>
-    class CommandExecutor
-
-      include Logging
-
-      # @return [Integer,nil] the safe maximum number of commands that can
-      #   be executed in one remote shell session, or `nil` if the
-      #   threshold has not yet been determined
-      attr_reader :max_commands
-
-      # @return [String,nil] the identifier for the current open remote
-      #   shell session, or `nil` if the session is not open
-      attr_reader :shell
-
-      # Creates a CommandExecutor given a `WinRM::WinRMWebService` object.
-      #
-      # @param service [WinRM::WinRMWebService] a winrm web service object
-      # @param logger [#debug,#info] an optional logger/ui object that
-      #   responds to `#debug` and `#info` (default: `nil`)
-      # @param closer [ShellCloser] an optional object to automatically
-      #   close the active open remote shell when CommandExecutor garbarge
-      #   collects
-      def initialize(service, logger = nil, closer = nil)
-        @service        = service
-        @logger         = logger
-        @closer         = closer
-        @command_count  = 0
-      end
-
-      # Closes the open remote shell session. This method can be called
-      # multiple times, even if there is no open session.
-      def close
-        return if shell.nil?
-
-        service.close_shell(shell)
-        remove_finalizer
-        @shell = nil
-      end
-
-      # Opens a remote shell session for reuse. The maxiumum
-      # command-per-shell threshold is also determined the first time this
-      # method is invoked and cached for later invocations.
-      #
-      # @return [String] the remote shell session indentifier
-      def open
-        close
-        @shell = service.open_shell
-        add_finalizer(shell)
-        @command_count = 0
-        determine_max_commands unless max_commands
-        shell
-      end
-
-      # Runs a CMD command.
-      #
-      # @param command [String] the command to run on the remote system
-      # @param arguments [Array<String>] arguments to the command
-      # @yield [stdout, stderr] yields more live access the standard
-      #   output and standard error streams as they are returns, if
-      #   streaming behavior is desired
-      # @return [WinRM::Output] output object with stdout, stderr, and
-      #   exit code
-      def run_cmd(command, arguments = [], &block)
-        reset if command_count_exceeded?
-        ensure_open_shell!
-
-        @command_count += 1
-        result = nil
-        service.run_command(shell, command, arguments) do |command_id|
-          result = service.get_command_output(shell, command_id, &block)
-        end
-        result
-      end
-
-      # Run a Powershell script that resides on the local box.
-      #
-      # @param script_file [IO,String] an IO reference for reading the
-      #   Powershell script or the actual file contents
-      # @yield [stdout, stderr] yields more live access the standard
-      #   output and standard error streams as they are returns, if
-      #   streaming behavior is desired
-      # @return [WinRM::Output] output object with stdout, stderr, and
-      #   exit code
-      def run_powershell_script(script_file, &block)
-        # this code looks overly compact in an attempt to limit local
-        # variable assignments that may contain large strings and
-        # consequently bloat the Ruby VM
-        run_cmd(
-          "powershell",
-          [
-            "-encodedCommand",
-            ::WinRM::PowershellScript.new(
-              script_file.is_a?(IO) ? script_file.read : script_file
-            ).encoded
-          ],
-          &block
-        )
-      end
-
-      private
-
-      # @return [Integer] the default maximum number of commands which can be
-      #   executed in one remote shell session on "older" versions of Windows
-      # @api private
-      LEGACY_LIMIT = 15
-
-      # @return [Integer] the default maximum number of commands which can be
-      #   executed in one remote shell session on "modern" versions of Windows
-      # @api private
-      MODERN_LIMIT = 1500
-
-      # @return [String] the PowerShell command used to determine the version
-      #   of Windows
-      # @api private
-      PS1_OS_VERSION = "[environment]::OSVersion.Version.tostring()".freeze
-
-      # @return [Integer] the number of executed commands on the remote
-      #   shell session
-      # @api private
-      attr_accessor :command_count
-
-      # @return [#debug,#info] the logger
-      # @api private
-      attr_reader :logger
-
-      # @return [WinRM::WinRMWebService] a WinRM web service object
-      # @api private
-      attr_reader :service
-
-      # Creates a finalizer for this connection which will close the open
-      # remote shell session when the object is garabage collected or on
-      # Ruby VM shutdown.
-      #
-      # @param shell_id [String] the remote shell identifier
-      # @api private
-      def add_finalizer(shell_id)
-        ObjectSpace.define_finalizer(self, @closer.for(shell_id)) if @closer
-      end
-
-      # @return [true,false] whether or not the number of exeecuted commands
-      #   have exceeded the maxiumum threshold
-      # @api private
-      def command_count_exceeded?
-        command_count > max_commands.to_i
-      end
-
-      # Ensures that there is an open remote shell session.
-      #
-      # @raise [WinRM::WinRMError] if there is no open shell
-      # @api private
-      def ensure_open_shell!
-        if shell.nil?
-          raise ::WinRM::WinRMError, "#{self.class}#open must be called " \
-            "before any run methods are invoked"
-        end
-      end
-
-      # Determines the safe maximum number of commands that can be executed
-      # on a remote shell session by interrogating the remote host.
-      #
-      # @api private
-      def determine_max_commands
-        os_version = run_powershell_script(PS1_OS_VERSION).stdout.chomp
-        @max_commands = os_version < "6.2" ? LEGACY_LIMIT : MODERN_LIMIT
-        @max_commands -= 2 # to be safe
-      end
-
-      # Removes any finalizers for this connection.
-      #
-      # @api private
-      def remove_finalizer
-        ObjectSpace.undefine_finalizer(self) if @closer
-      end
-
-      # Closes the remote shell session and opens a new one.
-      #
-      # @api private
-      def reset
-        debug {
-          "Resetting WinRM shell (Max command limit is #{max_commands})"
-        }
-        open
-      end
-    end
-  end
-end
+# -*- encoding: utf-8 -*-
+#
+# Author:: Matt Wrock (<matt@mattwrock.com>)
+#
+# Copyright (C) 2014, Matt Wrock
+#
+# 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 "winrm/transport/logging"
+
+module WinRM
+
+  module Transport
+
+    # Object which can execute multiple commands and Powershell scripts in
+    # one shared remote shell session. The maximum number of commands per
+    # shell is determined by interrogating the remote host when the session
+    # is opened and the remote shell is automatically recycled before the
+    # threshold is reached.
+    #
+    # @author Matt Wrock <matt@mattwrock.com>
+    # @author Fletcher Nichol <fnichol@nichol.ca>
+    class CommandExecutor
+
+      include Logging
+
+      # @return [Integer,nil] the safe maximum number of commands that can
+      #   be executed in one remote shell session, or `nil` if the
+      #   threshold has not yet been determined
+      attr_reader :max_commands
+
+      # @return [String,nil] the identifier for the current open remote
+      #   shell session, or `nil` if the session is not open
+      attr_reader :shell
+
+      # Creates a CommandExecutor given a `WinRM::WinRMWebService` object.
+      #
+      # @param service [WinRM::WinRMWebService] a winrm web service object
+      # @param logger [#debug,#info] an optional logger/ui object that
+      #   responds to `#debug` and `#info` (default: `nil`)
+      # @param closer [ShellCloser] an optional object to automatically
+      #   close the active open remote shell when CommandExecutor garbarge
+      #   collects
+      def initialize(service, logger = nil, closer = nil)
+        @service        = service
+        @logger         = logger
+        @closer         = closer
+        @command_count  = 0
+      end
+
+      # Closes the open remote shell session. This method can be called
+      # multiple times, even if there is no open session.
+      def close
+        return if shell.nil?
+
+        service.close_shell(shell)
+        remove_finalizer
+        @shell = nil
+      end
+
+      # Opens a remote shell session for reuse. The maxiumum
+      # command-per-shell threshold is also determined the first time this
+      # method is invoked and cached for later invocations.
+      #
+      # @return [String] the remote shell session indentifier
+      def open
+        close
+        @shell = service.open_shell
+        add_finalizer(shell)
+        @command_count = 0
+        determine_max_commands unless max_commands
+        shell
+      end
+
+      # Runs a CMD command.
+      #
+      # @param command [String] the command to run on the remote system
+      # @param arguments [Array<String>] arguments to the command
+      # @yield [stdout, stderr] yields more live access the standard
+      #   output and standard error streams as they are returns, if
+      #   streaming behavior is desired
+      # @return [WinRM::Output] output object with stdout, stderr, and
+      #   exit code
+      def run_cmd(command, arguments = [], &block)
+        reset if command_count_exceeded?
+        ensure_open_shell!
+
+        @command_count += 1
+        result = nil
+        service.run_command(shell, command, arguments) do |command_id|
+          result = service.get_command_output(shell, command_id, &block)
+        end
+        result
+      end
+
+      # Run a Powershell script that resides on the local box.
+      #
+      # @param script_file [IO,String] an IO reference for reading the
+      #   Powershell script or the actual file contents
+      # @yield [stdout, stderr] yields more live access the standard
+      #   output and standard error streams as they are returns, if
+      #   streaming behavior is desired
+      # @return [WinRM::Output] output object with stdout, stderr, and
+      #   exit code
+      def run_powershell_script(script_file, &block)
+        # this code looks overly compact in an attempt to limit local
+        # variable assignments that may contain large strings and
+        # consequently bloat the Ruby VM
+        run_cmd(
+          "powershell",
+          [
+            "-encodedCommand",
+            ::WinRM::PowershellScript.new(
+              script_file.is_a?(IO) ? script_file.read : script_file
+            ).encoded
+          ],
+          &block
+        )
+      end
+
+      private
+
+      # @return [Integer] the default maximum number of commands which can be
+      #   executed in one remote shell session on "older" versions of Windows
+      # @api private
+      LEGACY_LIMIT = 15
+
+      # @return [Integer] the default maximum number of commands which can be
+      #   executed in one remote shell session on "modern" versions of Windows
+      # @api private
+      MODERN_LIMIT = 1500
+
+      # @return [String] the PowerShell command used to determine the version
+      #   of Windows
+      # @api private
+      PS1_OS_VERSION = "[environment]::OSVersion.Version.tostring()".freeze
+
+      # @return [Integer] the number of executed commands on the remote
+      #   shell session
+      # @api private
+      attr_accessor :command_count
+
+      # @return [#debug,#info] the logger
+      # @api private
+      attr_reader :logger
+
+      # @return [WinRM::WinRMWebService] a WinRM web service object
+      # @api private
+      attr_reader :service
+
+      # Creates a finalizer for this connection which will close the open
+      # remote shell session when the object is garabage collected or on
+      # Ruby VM shutdown.
+      #
+      # @param shell_id [String] the remote shell identifier
+      # @api private
+      def add_finalizer(shell_id)
+        ObjectSpace.define_finalizer(self, @closer.for(shell_id)) if @closer
+      end
+
+      # @return [true,false] whether or not the number of exeecuted commands
+      #   have exceeded the maxiumum threshold
+      # @api private
+      def command_count_exceeded?
+        command_count > max_commands.to_i
+      end
+
+      # Ensures that there is an open remote shell session.
+      #
+      # @raise [WinRM::WinRMError] if there is no open shell
+      # @api private
+      def ensure_open_shell!
+        if shell.nil?
+          raise ::WinRM::WinRMError, "#{self.class}#open must be called " \
+            "before any run methods are invoked"
+        end
+      end
+
+      # Determines the safe maximum number of commands that can be executed
+      # on a remote shell session by interrogating the remote host.
+      #
+      # @api private
+      def determine_max_commands
+        os_version = run_powershell_script(PS1_OS_VERSION).stdout.chomp
+        @max_commands = os_version < "6.2" ? LEGACY_LIMIT : MODERN_LIMIT
+        @max_commands -= 2 # to be safe
+      end
+
+      # Removes any finalizers for this connection.
+      #
+      # @api private
+      def remove_finalizer
+        ObjectSpace.undefine_finalizer(self) if @closer
+      end
+
+      # Closes the remote shell session and opens a new one.
+      #
+      # @api private
+      def reset
+        debug {
+          "Resetting WinRM shell (Max command limit is #{max_commands})"
+        }
+        open
+      end
+    end
+  end
+end

data/lib/winrm/transport/version.rb

@@ -20,6 +20,6 @@ module WinRM
 
   module Transport
 
-    VERSION = "1.0.3"
+    VERSION = "1.0.4"
   end
 end

data/winrm-transport.gemspec

@@ -10,7 +10,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Fletcher Nichol"]
   spec.email         = ["fnichol@nichol.ca"]
 
-  spec.summary       = "WinRM transport logic for re-using remote shells " \
+  spec.summary       = "[DEPRECATED] Please use the WinRM gem instead. " \
+                       "WinRM transport logic for re-using remote shells " \
                        "and uploading files. The original code was extracted " \
                        "from the Test Kitchen project and remains the " \
                        "primary reference use case."

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: winrm-transport
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - Fletcher Nichol
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-11-10 00:00:00.000000000 Z
+date: 2017-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: winrm
@@ -198,9 +198,9 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 2.6.2
-description: WinRM transport logic for re-using remote shells and uploading files.
-  The original code was extracted from the Test Kitchen project and remains the primary
-  reference use case.
+description: "[DEPRECATED] Please use the WinRM gem instead. WinRM transport logic
+  for re-using remote shells and uploading files. The original code was extracted
+  from the Test Kitchen project and remains the primary reference use case."
 email:
 - fnichol@nichol.ca
 executables: []
@@ -248,11 +248,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
-summary: WinRM transport logic for re-using remote shells and uploading files. The
-  original code was extracted from the Test Kitchen project and remains the primary
-  reference use case.
+summary: "[DEPRECATED] Please use the WinRM gem instead. WinRM transport logic for
+  re-using remote shells and uploading files. The original code was extracted from
+  the Test Kitchen project and remains the primary reference use case."
 test_files: []
 has_rdoc: