vagrant-multi-putty 1.2.0 → 1.4.0

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.sw[op]

data/README.md

@@ -17,9 +17,9 @@ $ vagrant plugin install vagrant-multi-putty
 ### Putty Binary
 Download: http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
 
-Download the putty executable for your platform and place it's location on your
-PATH variable. Seek your operating system manual for instructions on how to
-modify your PATH variable.
+Download the putty executable for your platform and add it's location to your
+PATH environment variable. Seek your operating system manual for instructions
+on how to modify your PATH variable.
 
 ### SSH Private Key conversion using PuTTYgen
 Download: http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
@@ -37,7 +37,7 @@ or convert a private key of your own.
  5. Save the key using the filename of "insecure_private_key.ppk".
 
 Note: If you do not explicity set the config.putty.private_key_path variable,
-you need to convert the insecure_private_key and store it with the a ".ppk"
+you need to convert the insecure_private_key and store it with a ".ppk"
 extension. The vagrant-multi-putty plugin appends this extension automatically.
 
 ## Configuration
@@ -53,12 +53,38 @@ vagrant-multi-putty:
 All other config.ssh options should work for vagrant-multi-putty just like they
 do for vagrant ssh.
 
-There are currently two additional configuration parameters available:
+There are currently a few additional configuration parameters available:
 
 *    config.putty.username: Overrides the username set with
      config.ssh.username.
 *    config.putty.private_key_path: Used to explicity  set the path to the
      private key variable.
+*    config.putty.modal: change vagrant-multi-putty to use modal window mode.
+     Execute putty and block the terminal until all putty processes have exited.
+     Can be set on the command line with -m or --modal. This is false by default.
+*    config.putty.after_modal: Configure a post hook block that will be called
+     once all child putty processes have exited and modal mode is enabled. The
+     default block is empty.
+
+#### Example usage of after_modal post hook
+This is an example which uses the the win32-activate gem written by nazoking. This
+only works on windows since win32-activate uses the win32 API.
+
+Github Page: https://github.com/nazoking/win32-activate
+
+After all putty windows are closed, the terminal window used to run the 'vagrant putty'
+command will be brought into focus and placed on top of all open windows.
+```
+Vagrant.configure("2") do |config|
+  # always modal mode
+  config.putty.modal = true
+  # set hook.
+  config.putty.after_modal do
+    require 'win32/activate'
+    Win32::Activate.active
+  end
+end
+```
 
 ## Usage
 Basic usage:

data/lib/vagrant-multi-putty/command.rb

@@ -5,7 +5,7 @@ require 'optparse'
 module VagrantMultiPutty
   class Command < Vagrant.plugin(2, :command)
     def execute
-      options = {}
+      options = {:modal => @env.config_global.putty.modal }
       opts = OptionParser.new do |opts|
         opts.banner = "Usage: vagrant putty [vm-name...] [-- extra putty args]"
 
@@ -13,6 +13,10 @@ module VagrantMultiPutty
           options[:plain_auth] = p
         end
 
+        opts.on("-m", "--modal", "Block until all spawned putty processes have exited") do |m|
+          options[:modal] = m
+        end
+
         opts.separator ""
       end
 
@@ -33,13 +37,21 @@ module VagrantMultiPutty
       # detach the process from vagrant.
       with_target_vms(argv) do |vm|
         @logger.info("Launching putty session to: #{vm.name}")
-        putty_connect(vm, putty_args, plain_auth=options[:plain_auth])
+        putty_connect(vm, putty_args, options)
+      end
+
+      if options[:modal]
+        Process.wait(0, Process::WNOHANG)
+        @env.config_global.putty.after_modal_hook.call
       end
+
       return 0
     end
 
-    def putty_connect(vm, args, plain_auth=False)
+    def putty_connect(vm, args, options={})
+      # This isn't called by vagrant automatically.
       vm.config.putty.finalize!
+
       ssh_info = vm.ssh_info
       # If ssh_info is nil, the machine is not ready for ssh.
       raise Vagrant::Errors::SSHNotReady if ssh_info.nil?
@@ -50,20 +62,20 @@ module VagrantMultiPutty
       @logger.debug("Putty Private Key: #{pk_path}")
 
       # Load options from machine ssh_info.
-      options = [ssh_info[:host]]
+      ssh_options = [ssh_info[:host]]
       # config.putty.username overrides the machines ssh_info username.
-      options += ["-l", vm.config.putty.username || ssh_info[:username]]
-      options += ["-P", ssh_info[:port].to_s]
-      options += ["-i", pk_path] if !plain_auth
-      options += ["-X"] if ssh_info[:forward_x11]
-      options += ["-A"] if ssh_info[:forward_agent]
+      ssh_options += ["-l", vm.config.putty.username || ssh_info[:username]]
+      ssh_options += ["-P", ssh_info[:port].to_s]
+      ssh_options += ["-i", pk_path] unless options[:plain_auth]
+      ssh_options += ["-X"] if ssh_info[:forward_x11]
+      ssh_options += ["-A"] if ssh_info[:forward_agent]
 
       # Add in additional args from the command line.
-      options.concat(args) if !args.nil?
+      ssh_options.concat(args) if !args.nil?
 
       # Spawn putty and detach it so we can move on.
       @logger.debug("Putty cmd line options: #{options.to_s}")
-      pid = spawn("putty", *options)
+      pid = spawn("putty", *ssh_options)
       @logger.debug("Putty Child Pid: #{pid}")
       Process.detach(pid)
     end

data/lib/vagrant-multi-putty/config.rb

@@ -1,16 +1,30 @@
 module VagrantMultiPutty
   class PuttyConfig < Vagrant.plugin(2, :config)
-    attr_accessor :username
-    attr_accessor :private_key_path
+	attr_accessor :username
+	attr_accessor :private_key_path
+	attr_accessor :after_modal_hook
+	attr_accessor :modal
 
-    def initialize
-      @username = UNSET_VALUE
-      @private_key_path = UNSET_VALUE
-    end
+	def after_modal &proc
+	  @after_modal_hook = proc
+	end
 
-    def finalize!
-      @username = nil if @username == UNSET_VALUE
-      @private_key_path = nil if @private_key_path == UNSET_VALUE
-    end
+	def initialize
+	  @username = UNSET_VALUE
+	  @private_key_path = UNSET_VALUE
+	  @after_modal_hook = UNSET_VALUE
+	  @modal = UNSET_VALUE
+	end
+
+	def finalize!
+	  @username = nil if @username == UNSET_VALUE
+	  @private_key_path = nil if @private_key_path == UNSET_VALUE
+	  @after_modal_hook = Proc{  } if @after_modal_hook == UNSET_VALUE
+	  @modal = false if @modal == UNSET_VALUE
+	end
+
+	def validate(machine)
+	  {}
+	end
   end
 end

data/lib/vagrant-multi-putty/version.rb

@@ -1,3 +1,3 @@
 module VagrantMultiPutty
-  VERSION = "1.2.0"
+  VERSION = "1.4.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-multi-putty
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-20 00:00:00.000000000 Z
+date: 2013-11-01 00:00:00.000000000 Z
 dependencies: []
 description: Vagrant plugin to allow VM ssh with PuTTY (multi-vm supported)
 email:
@@ -18,6 +18,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
 - Gemfile
 - LICENSE
 - README.md
@@ -41,6 +42,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -108176497
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: