winrm-elevated 0.4.0 → 1.0.0

data/spec/spec_helper.rb

@@ -1,46 +1,58 @@
-# encoding: UTF-8
-require 'winrm'
-require 'winrm-elevated'
-require_relative 'matchers'
-
-# Creates a WinRM connection for integration tests
-module ConnectionHelper
-  def winrm_connection
-    WinRM::WinRMWebService.new(
-      winrm_config['endpoint'],
-      winrm_config['auth_type'].to_sym,
-      user: username,
-      pass: password,
-      basic_auth_only: true)
-  end
-
-  def elevated_runner
-    @elevated_runner ||= WinRM::Elevated::Runner.new(winrm_connection.create_executor)
-  end
-
-  def winrm_config
-    unless @winrm_config
-      path = File.expand_path("#{File.dirname(__FILE__)}/config.yml")
-      unless File.exist?(path)
-        path = File.expand_path("#{File.dirname(__FILE__)}/config-example.yml")
-      end
-      @winrm_config = YAML.load(File.read(path))
-      @winrm_config['endpoint'] = ENV['winrm_endpoint'] if ENV['winrm_endpoint']
-      @winrm_config['options']['user'] = ENV['winrm_user'] if ENV['winrm_user']
-      @winrm_config['options']['pass'] = ENV['winrm_pass'] if ENV['winrm_pass']
-    end
-    @winrm_config
-  end
-
-  def username
-    winrm_config['options']['user']
-  end
-
-  def password
-    winrm_config['options']['pass']
-  end
-end
-
-RSpec.configure do |config|
-  config.include(ConnectionHelper)
-end
+# encoding: UTF-8
+require 'winrm'
+require 'winrm-elevated'
+require_relative 'matchers'
+
+# Creates a WinRM connection for integration tests
+module ConnectionHelper
+  def winrm_connection
+    WinRM::Connection.new(winrm_config)
+  end
+
+  def elevated_shell
+    @elevated_shell ||= winrm_connection.shell(:elevated)
+  end
+
+  def winrm_config
+    unless @winrm_config
+      path = File.expand_path("#{File.dirname(__FILE__)}/config.yml")
+      unless File.exist?(path)
+        path = File.expand_path("#{File.dirname(__FILE__)}/config-example.yml")
+      end
+      @winrm_config = symbolize_keys(YAML.load(File.read(path)))
+      @winrm_config[:endpoint] = ENV['winrm_endpoint'] if ENV['winrm_endpoint']
+      @winrm_config[:user] = ENV['winrm_user'] if ENV['winrm_user']
+      @winrm_config[:password] = ENV['winrm_password'] if ENV['winrm_password']
+    end
+    @winrm_config
+  end
+
+  def username
+    winrm_config[:user]
+  end
+
+  def password
+    winrm_config[:password]
+  end
+
+  # rubocop:disable Metrics/MethodLength
+  def symbolize_keys(hash)
+    hash.each_with_object({}) do |(key, value), result|
+      new_key = case key
+                when String then key.to_sym
+                else key
+                end
+      new_value = case value
+                  when Hash then symbolize_keys(value)
+                  else value
+                  end
+      result[new_key] = new_value
+      result
+    end
+  end
+  # rubocop:enable Metrics/MethodLength
+end
+
+RSpec.configure do |config|
+  config.include(ConnectionHelper)
+end

data/winrm-elevated.gemspec

@@ -1,33 +1,33 @@
-# encoding: UTF-8
-require 'date'
-
-version = File.read(File.expand_path('../VERSION', __FILE__)).strip
-
-Gem::Specification.new do |s|
-  s.platform = Gem::Platform::RUBY
-  s.name = 'winrm-elevated'
-  s.version = version
-  s.date = Date.today.to_s
-
-  s.author = ['Shawn Neal']
-  s.email = ['sneal@sneal.net']
-  s.homepage = 'https://github.com/WinRb/winrm-elevated'
-
-  s.summary = 'Ruby library for running commands as elevated'
-  s.description = <<-EOF
-    Ruby library for running commands via WinRM as elevated through a scheduled task
-  EOF
-  s.license = 'Apache-2.0'
-
-  s.files = `git ls-files`.split(/\n/)
-  s.require_path = 'lib'
-  s.rdoc_options = %w(-x test/ -x examples/)
-  s.extra_rdoc_files = %w(README.md LICENSE)
-
-  s.required_ruby_version = '>= 1.9.0'
-  s.add_runtime_dependency 'winrm', '~> 1.5'
-  s.add_runtime_dependency 'winrm-fs', '~> 0.4.2'
-  s.add_development_dependency 'rspec', '~> 3.2'
-  s.add_development_dependency 'rake', '~> 10.3'
-  s.add_development_dependency 'rubocop', '~> 0.28'
-end
+# encoding: UTF-8
+require 'date'
+
+version = File.read(File.expand_path('../VERSION', __FILE__)).strip
+
+Gem::Specification.new do |s|
+  s.platform = Gem::Platform::RUBY
+  s.name = 'winrm-elevated'
+  s.version = version
+  s.date = Date.today.to_s
+
+  s.author = ['Shawn Neal']
+  s.email = ['sneal@sneal.net']
+  s.homepage = 'https://github.com/WinRb/winrm-elevated'
+
+  s.summary = 'Ruby library for running commands as elevated'
+  s.description = <<-EOF
+    Ruby library for running commands via WinRM as elevated through a scheduled task
+  EOF
+  s.license = 'Apache-2.0'
+
+  s.files = `git ls-files`.split(/\n/)
+  s.require_path = 'lib'
+  s.rdoc_options = %w(-x test/ -x examples/)
+  s.extra_rdoc_files = %w(README.md LICENSE)
+
+  s.required_ruby_version = '>= 1.9.0'
+  s.add_runtime_dependency 'winrm', '~> 2.0'
+  s.add_runtime_dependency 'winrm-fs', '~> 1.0'
+  s.add_development_dependency 'rspec', '~> 3.2'
+  s.add_development_dependency 'rake', '~> 10.3'
+  s.add_development_dependency 'rubocop', '~> 0.28'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: winrm-elevated
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Shawn Neal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-20 00:00:00.000000000 Z
+date: 2016-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: winrm
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: winrm-fs
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.2
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.2
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -80,8 +80,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.28'
-description: |2
-      Ruby library for running commands via WinRM as elevated through a scheduled task
+description: "    Ruby library for running commands via WinRM as elevated through
+  a scheduled task\n"
 email:
 - sneal@sneal.net
 executables: []
@@ -102,8 +102,8 @@ files:
 - appveyor.yml
 - changelog.md
 - lib/winrm-elevated.rb
-- lib/winrm-elevated/runner.rb
 - lib/winrm-elevated/scripts/elevated_shell.ps1
+- lib/winrm/shells/elevated.rb
 - spec/config-example.yml
 - spec/matchers.rb
 - spec/powershell_elevated_spec.rb
@@ -133,7 +133,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.6
 signing_key: 
 specification_version: 4
 summary: Ruby library for running commands as elevated

data/lib/winrm-elevated/runner.rb

@@ -1,83 +0,0 @@
-# encoding: UTF-8
-#
-# Copyright 2015 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 'winrm'
-require 'winrm-fs'
-require 'securerandom'
-
-module WinRM
-  module Elevated
-    # Runs PowerShell commands elevated via a scheduled task
-    class Runner
-      # Creates a new Elevated Runner instance
-      # @param [CommandExecutor] a winrm CommandExecutor
-      def initialize(executor)
-        @executor = executor
-        @winrm_file_transporter = WinRM::FS::Core::FileTransporter.new(executor)
-        @elevated_shell_path = 'c:/windows/temp/winrm-elevated-shell-' + SecureRandom.uuid + '.ps1'
-        @uploaded            = nil
-      end
-
-      # Run a command or PowerShell script elevated without any of the
-      # restrictions that WinRM puts in place.
-      #
-      # @param [String] The command or PS script to wrap in a scheduled task
-      # @param [String] The admin user name to execute the scheduled task as
-      # @param [String] The admin user password
-      #
-      # @return [Hash] :stdout and :stderr
-      def powershell_elevated(script, username, password, &block)
-        # if an IO object is passed read it, otherwise assume the contents of the file were passed
-        script_text = script.respond_to?(:read) ? script.read : script
-
-        upload_elevated_shell_wrapper_script
-        wrapped_script = wrap_in_scheduled_task(script_text, username, password)
-        @executor.run_cmd(wrapped_script, &block)
-      end
-
-      private
-
-      def upload_elevated_shell_wrapper_script
-        return if @uploaded
-        with_temp_file do |temp_file|
-          @winrm_file_transporter.upload(temp_file, @elevated_shell_path)
-          @uploaded = true
-        end
-      end
-
-      def with_temp_file
-        file = Tempfile.new(['winrm-elevated-shell', 'ps1'])
-        file.write(elevated_shell_script_content)
-        file.fsync
-        file.close
-        yield file.path
-      ensure
-        file.close
-        file.unlink
-      end
-
-      def elevated_shell_script_content
-        IO.read(File.expand_path('../scripts/elevated_shell.ps1', __FILE__))
-      end
-
-      def wrap_in_scheduled_task(script_text, username, password)
-        ps_script = WinRM::PowershellScript.new(script_text)
-        "powershell -executionpolicy bypass -file \"#{@elevated_shell_path}\" " \
-          "-username \"#{username}\" -password \"#{password}\" -encoded_command \"#{ps_script.encoded}\""
-      end
-    end
-  end
-end