vagrant-notify 0.5.3 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f220061039ad0bc6f804c6561f05ae7c8bed22c1
-  data.tar.gz: 5d602de0a1ad6a73f2de0276971c3851cd98661e
+SHA256:
+  metadata.gz: c1465c9895322fd9c935e8217b9232edd8c7bf8b1d2acce838ea4fdc503f4573
+  data.tar.gz: fdac2a4778a4eb69411321c146d5b99e2c4c3c7a79a14e6e53752ab82dd2c332
 SHA512:
-  metadata.gz: eefc2a70255f14d573238f69e78d097e143e4b401653255cf2e0ae1f848f4b0ae8df6e265deb82fbe1c083819d54f55b4be271aa91aa8dcaeeae91a9fd2d488e
-  data.tar.gz: 211c6257ee813b170a21ab18a05c5bcf0505e331dc8cac93041923036dac5f338b8124bd7e220af0e9d4b114e783f826e039b6bad4b73b691b4e3566dfcf5f3f
+  metadata.gz: 340cc11227f68d407b83c8b1d5741e0c9fe3d07c11acc055788af4dc00a665f48c267cd9dace64251486e82cd1ceea4510b991d3df89980e24d1f2bd65b06e5c
+  data.tar.gz: a90102d0f68f30b4fc5c5661da637a1da117f49aefe474edbe1e8a4e81246b6d182deb059ebca111f39586ce4b98da4fa2c249025863ddde5694fe1e07d90a5a

data/.gitignore

@@ -17,3 +17,4 @@ test/version_tmp
 tmp
 /development/.vagrant
 .DS_Store
+.idea/

data/.travis.yml

@@ -1,5 +1,6 @@
 language: ruby
 bundler_args: --without development
 rvm:
-  - 2.0.0
-  - 2.3.0
+  - 2.7.1
+before_install:
+    - gem install bundler

data/CHANGELOG.md

@@ -1,3 +1,47 @@
+## [0.6.1](https://github.com/fgrehm/vagrant-notify/compare/v0.6.0...v0.6.1) (December 23, 2020)
+IMPROVEMENTS
+
+  - Improving notification server startup.
+
+BUG FIXES
+
+  - avoid error `newline at the end of hostname (SocketError)` [[GH-44]](https://github.com/fgrehm/vagrant-notify/pull/44)
+
+## [0.6.0](https://github.com/fgrehm/vagrant-notify/compare/v0.5.6...v0.6.0) (September 5, 2020)
+IMPROVEMENTS
+
+  - Support for custom notifcation application without the need of a notify-send wrapper script.
+  - Ensure plugin plays nice with read-only boxes.
+  - Updating gem dependencies versions and newer version of Ruby for Travis CI testing.
+
+BUG FIXES
+
+  - Fixnum deprecation warning. [[GH-40]](https://github.com/fgrehm/vagrant-notify/issues/40)
+
+## [0.5.6](https://github.com/fgrehm/vagrant-notify/compare/v0.5.5...v0.5.6) (September 29, 2017)
+IMPROVEMENTS
+
+  - AppleScript wrapper script.
+
+BUG FIXES
+
+  - `vagrant resume` bug fix. [[GH-39]](https://github.com/fgrehm/vagrant-notify/issues/39)
+
+## [0.5.5](https://github.com/fgrehm/vagrant-notify/compare/v0.5.4...v0.5.5) (May 13, 2017)
+IMPROVEMENTS
+
+  - Support for Hyper-V and VMWare Workstation providers. [[GH-32]](https://github.com/fgrehm/vagrant-notify/issues/32) [[GH-33]](https://github.com/fgrehm/vagrant-notify/issues/33)
+  - Disable plugin for google, vultr, vcloudair, skytap, and scaleway cloud providers.
+
+BUG FIXES
+  - Notifcation server suspend fix on VMWare Fusion.
+
+## [0.5.4](https://github.com/fgrehm/vagrant-notify/compare/v0.5.3...v0.5.4) (May 4, 2017)
+IMPROVEMENTS
+
+  - Display warning if Ruby is not installed on guest. [[GH-35]](https://github.com/fgrehm/vagrant-notify/issues/35)
+  - Shell name included in provision notify message. [[GH-21]](https://github.com/fgrehm/vagrant-notify/issues/21)
+
 ## [0.5.3](https://github.com/fgrehm/vagrant-notify/compare/v0.5.2...v0.5.3) (November 18, 2016)
 IMPROVEMENTS
 

data/Gemfile

@@ -13,6 +13,6 @@ end
 group :development, :test do
   gem 'vagrant',     github: 'mitchellh/vagrant'
   gem 'rake'
-  gem 'rspec',       '~> 2.13.0'
+  gem 'rspec',       '~> 2.99.0'
   gem 'rspec-spies'
 end

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2012-2016 Fabio Rehm
+Copyright (c) 2012-2020 Fabio Rehm
 
 MIT License
 

data/README.md

@@ -21,7 +21,7 @@ $ vagrant plugin install vagrant-notify
 ### `notify-send` from guest VMs
 
 Whenever you run `vagrant up`, a Ruby [TCPServer](http://www.ruby-doc.org/stdlib-1.9.3/libdoc/socket/rdoc/TCPServer.html)
-will fire up on a port within the [usable port range](https://github.com/mitchellh/vagrant/blob/master/config/default.rb#L14)
+will fire up on a port within the [usable port range](https://www.vagrantup.com/docs/vagrantfile/machine_settings.html)
 and a Ruby [script](https://github.com/fgrehm/vagrant-notify/blob/master/files/notify-send.erb)
 will be copied over to the guest machine to replace the original `notify-send`
 command.
@@ -44,7 +44,7 @@ Since Linux distributions have `notify-send` pre-installed, everything should wo
 
 Check out our OS X notify-send compatible [scripts](https://github.com/fgrehm/vagrant-notify/tree/master/examples#os-x).
 
-### Windows (beta)
+### Windows
 
 Check out our Windows notify-send compatible [scripts](https://github.com/fgrehm/vagrant-notify/tree/master/examples#windows).
 
@@ -60,9 +60,9 @@ end
 ```
 
 _Please note that as of v0.5.1, the notification server will automatically be disabled for any of the following
-[cloud providers](lib/vagrant-notify/plugin.rb#L77-L79)._
+[cloud providers](lib/vagrant-notify/plugin.rb#L81-L84)._
 
-By default, the notification server is binded to [local interfaces](lib/vagrant-notify/plugin.rb#L82-L86). For networking different than your provider's default network configuration, you can use the ***notify.bind\_ip*** configuration option to bind the notification server onto a different local ip address. 
+By default, the notification server is binded to [local interfaces](lib/vagrant-notify/plugin.rb#L86-L93). For networking different than your provider's default network configuration, you can use the ***notify.bind\_ip*** configuration option to bind the notification server onto a different local ip address. 
 
 ```ruby
 Vagrant.configure(2) do |config|
@@ -71,6 +71,28 @@ Vagrant.configure(2) do |config|
 end
 ```
 
+By default the local notification server uses the ***notify_send*** command in your host PATH for displaying notifications, there is a possibility to use different app without wrapper scripts:
+* ***notify.sender\_app*** configuration option is used for specifing application name (default: `notify-send`)
+* ***notify.sender\_params\_str*** defines how params for applications will be passed (default: `[--app-name {app_name}] [--urgency {urgency}] [--expire-time {expire_time}] [--icon {icon}] [--category {category}] [--hint {hint}] {message}`). You can use these variables (escaped by `{` and `}` characters) here:
+  * ***urgency*** - urgency level for notification
+  * ***expire\_time*** - when notification will expire?
+  * ***app\_name*** - application name
+  * ***icon*** - icon for the notification (can be multiple, devided by comma)
+  * ***category*** - category for the notification (can be multiple, devided by comma)
+  * ***hint*** - icon for the notification (need to use this format: TYPE:NAME:VALUE)
+  * ***message*** - message to send
+* ***notify.sender\_params\_escape*** - should params will be escaped when passed to script (default: `true`)
+
+This is example how to to run notifications with build-in MacOS X notifications support:
+```ruby
+Vagrant.configure(2) do |config|
+  config.vm.box = "ubuntu/trusty64"
+  config.notify.sender_params_str = '-e \'display notification {message} sound name \"default\"\''
+  config.notify.sender_app = 'osascript'
+  config.notify.sender_params_escape = true
+end
+```
+
 **WARNING**
 
 _Do **NOT** bind the notification server to an IP accessible over a network! The notification server does not have any authentication and doing so will leave your system vulnerable to remote command execution._
@@ -81,9 +103,11 @@ vagrant-notify supports the following providers:
 
   - VirtualBox
   - Docker
+  - Hyper-V
   - [LXC](https://github.com/fgrehm/vagrant-lxc)
   - [Parallels](https://github.com/Parallels/vagrant-parallels)
   - [VMWare Fusion](https://www.vagrantup.com/vmware)
+  - [VMWare Workstation](https://www.vagrantup.com/vmware)
 
 vagrant-notify has been tested and known to work with Linux, Solaris 11, FreeBSD, OpenBSD, and NetBSD guests. (notify-send icon forwarding feature is not supported on BSD guests)
 

data/examples/README.md

@@ -11,16 +11,15 @@ growlnotify -t "Vagrant VM" -m "$*"
 
 ## OS X
 
-The `notify-send` script can forward the message to either
+The easiest configuration is using the built-in [AppleScript](https://github.com/fgrehm/vagrant-notify/blob/master/examples/osx/applescript/notify-send.rb) support for notifications. Alternatively, you can also create a `notify-send` script that forwards messages to other third party notifications applications like
 [Growl](http://growl.info/) with [GrowlNotify](http://growl.info/downloads) (version 1.2.2 is free but unreliable)
 or to the [Notification Center](http://support.apple.com/kb/HT5362) available on OS X 10.8+
 using f.ex. [terminal-notifier](https://github.com/alloy/terminal-notifier).
 
-
+* [AppleScript wrapper script](https://github.com/fgrehm/vagrant-notify/blob/master/examples/osx/applescript/notify-send.rb)
 * [terminal-notifier wrapper script](https://github.com/fgrehm/vagrant-notify/blob/master/examples/osx/terminal-notifier/notify-send.rb)
 * [growlnotify wrapper script](https://github.com/fgrehm/vagrant-notify/blob/master/examples/osx/growl_for_mac/notify-send.rb)
 
-
 ## Windows
 
 You can use the freeware application [notify-send for Windows](http://vaskovsky.net/notify-send/), make sure the notify-send binary is available on `Path`. Or you can create your own notify-send program and compile it to an .exe binary executable.
@@ -44,3 +43,9 @@ Compile using [PS1toEXE](https://github.com/aravindvcyber/PS1toEXE):
 
 
 * [Notification Center](https://github.com/fgrehm/vagrant-notify/blob/master/examples/windows/notification-center/notify-send.ps1)
+
+##### Hyper-V
+
+Due to Hyper-V's [networking configuration limitation within Vagrant](https://www.vagrantup.com/docs/hyperv/limitations.html). You will most likely need to manually ***bind*** the vagrant-notify notification server to whatever gateway your virtual NAT switch is using. See https://github.com/fgrehm/vagrant-notify#configuration 
+
+[Default NATSwitch IP](https://github.com/fgrehm/vagrant-notify/blob/master/lib/vagrant-notify/plugin.rb#L84) used by vagrant-notify.

data/examples/osx/applescript/notify-send.rb

@@ -0,0 +1,34 @@
+#!/usr/bin/env ruby
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+# Example OS X (>= 10.9) applescript notify-send wrapper script.
+
+require 'optparse'
+
+
+options = {}
+OptionParser.new do |opts|
+  opts.on('-u', '--urgency LEVEL')           { |v| options[:u] = v } # Option gets removed
+  opts.on('-t', '--expire-time TIME')        { |v| options[:t] = v } # Option gets removed
+  opts.on('-a', '--app-name APP_NAME')       { |v| options[:a] = v } # TO DO: Set to -title
+  opts.on('-i', '--icon ICON[,ICON...]')     { |v| options[:i] = v } # Option gets removed
+  opts.on('-c', '--category TYPE[,TYPE...]') { |v| options[:c] = v } # Option gets removed
+  opts.on('-h', '--hint TYPE:NAME:VALUE')    { |v| options[:h] = v } # Option gets removed
+  opts.on('-v', '--version')                 { |v| options[:v] = v } # Option gets removed
+end.parse!
+
+
+if ARGV.length == 0
+  puts "No summary specified"
+  exit 1
+elsif ARGV.length == 1
+  message = "\"#{ARGV[0]}\""
+elsif ARGV.length == 2
+  message = "\"#{ARGV[0]}\" with title \"#{ARGV[1]}\""
+else
+  puts "Invalid number of options."
+  exit 1
+end
+
+system "osascript -e 'display notification #{message} sound name \"default\"'"

data/files/notify-send.erb

@@ -8,39 +8,34 @@ require 'rubygems'
 require 'socket'
 require 'optparse'
 require 'fileutils'
+require 'json'
 
 options = {}
 OptionParser.new do |opts|
-  opts.banner = "Usage: notify-send.rb [options]"
-
-  opts.on('-u', '--urgency LEVEL')           { |v| options[:u] = v }
-  opts.on('-t', '--expire-time TIME')        { |v| options[:t] = v }
-  opts.on('-a', '--app-name APP_NAME')       { |v| options[:a] = v }
-  opts.on('-i', '--icon ICON[,ICON...]')     { |v| options[:i] = v }
-  opts.on('-c', '--category TYPE[,TYPE...]') { |v| options[:c] = v }
-  opts.on('-h', '--hint TYPE:NAME:VALUE')    { |v| options[:h] = v }
-  opts.on('-v', '--version')                 { |v| options[:v] = v }
-
+opts.banner = "Usage: notify-send.rb TITLE [MESSAGE] [options]"
+
+  opts.on('-u', '--urgency LEVEL')           { |v| options[:urgency] = v }
+  opts.on('-t', '--expire-time TIME')        { |v| options[:expire_time] = v }
+  opts.on('-a', '--app-name APP_NAME')       { |v| options[:app_name] = v }
+  opts.on('-i', '--icon ICON[,ICON...]')     { |v| options[:icon] = v }
+  opts.on('-c', '--category TYPE[,TYPE...]') { |v| options[:category] = v }
+  opts.on('-h', '--hint TYPE:NAME:VALUE')    { |v| options[:hint] = v }
+  opts.on('-v', '--version')                 { |v| options[:version] = v }
 end.parse!
 
+options[:title]=ARGV.pop
+options[:message]=ARGV.pop if ARGV.length > 0
+
 # BSD guests do not support shared folders
 unless RUBY_PLATFORM =~ /freebsd|openbsd|netbsd/
-  if options[:i]
-    new_filename = options[:i].gsub('/', '-')
-    FileUtils.cp options[:i], "<%= shared_folder %>/#{new_filename}"
-    options[:i]  = new_filename
+  if options[:icon]
+    new_filename = options[:icon].gsub('/', '-')
+    FileUtils.cp options[:icon], "<%= shared_folder %>/#{new_filename}"
+    options[:icon]  = new_filename
   end
 end
 
-cmd = options.map do |key, value|
-  "-#{key} '#{value}'"
-end.join(' ')
-
-# All single quotes part of the message get removed.
-# TODO: Need to escape values.
-unless ARGV.empty?
-  cmd << ARGV.map{|a| " '#{a.gsub(/'/, "")}'"}.join(' ')
-end
+cmd = JSON.generate(options, quirks_mode: true)
 
 # VirtualBox is the only provider that can communicate with 127.0.0.1, others will have to use default private networking
 if "<%= provider_name %>" == "virtualbox"
@@ -53,7 +48,6 @@ else
   client_ip = "<%= client_ip %>"
 end
 
-
-TCPSocket.open client_ip, <%= host_port %> do |s|
+TCPSocket.open client_ip.strip, <%= host_port %> do |s|
   s.send cmd, 0
 end

data/lib/vagrant-notify/action/install_command.rb

@@ -11,6 +11,7 @@ module Vagrant
           
           path = compile_command(env, 'notify-send.erb')
           install_command_on_guest(env, path)
+          check_if_ruby_on_guest(env)
 
           @app.call env
         end
@@ -31,10 +32,23 @@ module Vagrant
         def install_command_on_guest(env, command_path)
           source = env[:tmp_path].join 'vagrant-notify-send'
           env[:machine].communicate.upload(source.to_s, '/tmp/notify-send')
-          env[:machine].communicate.sudo('mv /usr/bin/{notify-send,notify-send.bkp}; exit 0')
-          env[:machine].communicate.sudo('mv /tmp/notify-send /usr/bin/notify-send && chmod +x /usr/bin/notify-send')
-          if RUBY_PLATFORM =~ /mswin|msys|mingw|cygwin|bccwin|wince|emc/
-            env[:machine].communicate.sudo("sed 's/\r\$//' -i /usr/bin/notify-send") # dos2unix
+          
+          begin
+            env[:machine].communicate.sudo('mv /usr/bin/{notify-send,notify-send.bkp}; exit 0')
+            env[:machine].communicate.sudo('mv /tmp/notify-send /usr/bin/notify-send && chmod +x /usr/bin/notify-send')
+            if RUBY_PLATFORM =~ /mswin|msys|mingw|cygwin|bccwin|wince|emc/
+              env[:machine].communicate.sudo("sed 's/\r\$//' -i /usr/bin/notify-send") # dos2unix
+            end
+          rescue => msg
+            env[:machine].ui.warn("vagrant-notify: failed to install /usr/bin/notify-send onto #{env[:machine].name}.\n#{msg}")
+          end
+        end
+
+        def check_if_ruby_on_guest(env)
+          ruby_check = ''
+          env[:machine].communicate.sudo("which ruby 2>/dev/null || true") {|type, data| ruby_check = data }
+          if ruby_check.empty?
+            env[:machine].ui.warn("Ruby is not installed on '#{env[:machine].name}' guest VM! vagrant-notify will not work until a version of Ruby is installed.")
           end
         end
       end

data/lib/vagrant-notify/action/notify_provisioning_status.rb

@@ -7,8 +7,8 @@ module Vagrant
         end
 
         def call(env)
-
-          system("notify-send '[#{env[:machine].name}] Provisioning with \"#{env[:provisioner_name]}\"...'") unless env[:machine].config.notify.enable == false
+          message = notify_provision_messages(env) unless env[:machine].config.notify.enable == false
+          system(message[:start]) unless env[:machine].config.notify.enable == false
 
           begin
             @app.call(env)
@@ -16,9 +16,20 @@ module Vagrant
             system("notify-send '[#{env[:machine].name}] \"#{env[:provisioner_name]}\" provision failed!'") unless env[:machine].config.notify.enable == false
             env[:machine].ui.error("#{msg}")
           else
-            system("notify-send '[#{env[:machine].name}] Finished provisioning with \"#{env[:provisioner_name]}\"'") unless env[:machine].config.notify.enable == false
+            system(message[:end]) unless env[:machine].config.notify.enable == false
           end
+        end
 
+        def notify_provision_messages(env)
+          message = Hash.new
+          if env[:provisioner_name].to_s == 'shell' and env[:provisioner].config.name
+            message[:start] = "notify-send '[#{env[:machine].name}] Provisioning with \"#{env[:provisioner_name]} (#{env[:provisioner].config.name})\"...'"
+            message[:end] = "notify-send '[#{env[:machine].name}] Finished provisioning with \"#{env[:provisioner_name]} (#{env[:provisioner].config.name})\"'" 
+          else
+            message[:start] = "notify-send '[#{env[:machine].name}] Provisioning with \"#{env[:provisioner_name]}\"...'"
+            message[:end] = "notify-send '[#{env[:machine].name}] Finished provisioning with \"#{env[:provisioner_name]}\"'"
+          end
+          return message
         end
       end
     end

data/lib/vagrant-notify/action/set_shared_folder.rb

@@ -9,7 +9,7 @@ module Vagrant
         def call(env)         
           begin
             unless env[:machine].config.notify.enable == false 
-              host_dir = Pathname("/tmp/vagrant-notify/#{env[:machine].id}")
+              host_dir = Pathname("/tmp/vagrant-notify/#{env[:machine].index_uuid}")
               FileUtils.mkdir_p host_dir.to_s unless host_dir.exist?
               env[:machine].config.vm.synced_folder host_dir, "/tmp/vagrant-notify", id: "vagrant-notify"
             end

data/lib/vagrant-notify/action/start_server.rb

@@ -20,10 +20,15 @@ module Vagrant
           
           return if env[:machine].config.notify.enable == false
 
-          port = next_available_port(env[:notify_data][:bind_ip])
+          bind_ip=env[:notify_data][:bind_ip]
+
+          port = next_available_port(bind_ip)
+          sender_app = '"' + env[:machine].config.notify.sender_app + '"'
+          sender_params_str = '"' + env[:machine].config.notify.sender_params_str + '"'
+          sender_params_escape = (env[:machine].config.notify.sender_params_escape) ? 1 : 0
 
           if which('ruby')
-            env[:notify_data][:pid]  = Process.spawn("ruby #{dir}/server.rb #{id} #{port} #{env[:notify_data][:bind_ip]} #{provider_name}")
+            env[:notify_data][:pid] = Process.spawn("ruby", "#{dir}/server.rb", "#{id}", "#{port}", "#{bind_ip}", "#{sender_app}", "#{sender_params_str}", "#{sender_params_escape}", "#{provider_name}")
             env[:notify_data][:port] = port
 
             sleep 5

data/lib/vagrant-notify/action/stop_server.rb

@@ -11,8 +11,10 @@ module Vagrant
           return if env[:machine].config.notify.enable == false
 
           if env[:machine].state.id == :running
-            env[:machine].communicate.sudo('rm /usr/bin/notify-send; exit 0')
-            env[:machine].communicate.sudo('mv /usr/bin/{notify-send.bkp,notify-send}; exit 0')
+            begin
+              env[:machine].communicate.sudo('rm /usr/bin/notify-send; exit 0')
+              env[:machine].communicate.sudo('mv /usr/bin/{notify-send.bkp,notify-send}; exit 0')
+            end
           end
 
           @app.call env

data/lib/vagrant-notify/config.rb

@@ -1,10 +1,27 @@
 module Vagrant
   module Notify
     class Config < Vagrant.plugin(2, :config)
-      attr_accessor :enable, :bind_ip
+
+      # Enable?
+      attr_accessor :enable
+
+      # Bind IP
+      attr_accessor :bind_ip
+
+      # Notify send application
+      attr_accessor :sender_app
+
+      # Notify send params string
+      attr_accessor :sender_params_str
+
+      # Sender params escape
+      attr_accessor :sender_params_escape
 
       def initialize()
         @enable  = UNSET_VALUE
+        @sender_app = UNSET_VALUE
+        @sender_params_str = UNSET_VALUE
+        @sender_params_escape = UNSET_VALUE
       end
 
       def validate(machine)
@@ -18,18 +35,20 @@ module Vagrant
 
         if @enable != 0
           if @enable != false && @enable != true
-            errors << "Unknown option: #{@enable}"
+            errors << "Unknown option for enable: #{@enable}"
           end
         end
 
+        if @sender_params_escape != false && @sender_params_escape != true && @sender_params_escape != UNSET_VALUE
+          errors << "Unknown option for @sender_params_escape: #{@sender_params_escape}"
+        end
+
         if backed_by_supported_provider?(machine)
           if @bind_ip.is_a?(String)
             require "resolv"
             unless @bind_ip =~ Resolv::IPv4::Regex
               errors << "Invalid bind IP address: #{@bind_ip}"
             end
-          elsif @bind_ip.is_a?(FalseClass) || @bind_ip.is_a?(Fixnum) || @bind_ip.is_a?(Array) || @bind_ip.is_a?(Hash)
-            errors << "Unknown bind IP address: #{@bind_ip}"
           else
             @bind_ip = SUPPORTED_PROVIDERS[machine.provider_name]
           end
@@ -44,6 +63,9 @@ module Vagrant
 
       def finalize!
         @enable = 0 if @enable == UNSET_VALUE
+        @sender_app = "notify-send" if @sender_app == UNSET_VALUE
+        @sender_params_str = "[--app-name {app_name}] [--urgency {urgency}] [--expire-time {expire_time}] [--icon {icon}] [--category {category}] [--hint {hint}] {title} [{message}]" if @sender_params_str == UNSET_VALUE
+        @sender_params_escape = true if @sender_app == UNSET_VALUE
       end
 
       private

data/lib/vagrant-notify/plugin.rb

@@ -11,6 +11,7 @@ module Vagrant
 
       start_server_hook = lambda do |hook|
         require_relative './action'
+        hook.before Vagrant::Action::Builtin::WaitForCommunicator, Vagrant::Action::Builtin::ConfigValidate
         hook.after Vagrant::Action::Builtin::WaitForCommunicator, Vagrant::Notify::Action.action_start_server
       end
 
@@ -48,9 +49,13 @@ module Vagrant
 
         # Third party provider plugins:
         if defined?(HashiCorp::VagrantVMwarefusion)
-          require 'vagrant-parallels/action'
+          require 'vagrant-vmware-fusion/action'
           hook.before HashiCorp::VagrantVMwarefusion::Action::Suspend, Vagrant::Notify::Action.action_stop_server
         end
+        if defined?(HashiCorp::VagrantVMwareworkstation)
+          require 'vagrant-vmware-workstation/action'
+          hook.before HashiCorp::VagrantVMwareworkstation::Action::Suspend, Vagrant::Notify::Action.action_stop_server
+        end
         if defined?(VagrantPlugins::Parallels)
           require 'vagrant-parallels/action'
           hook.before VagrantPlugins::Parallels::Action::Suspend, Vagrant::Notify::Action.action_stop_server
@@ -76,13 +81,15 @@ module Vagrant
   # Keep an eye on https://github.com/mitchellh/vagrant/wiki/Available-Vagrant-Plugins#wiki-providers for more.
   CLOUD_PROVIDERS = %w( aws cloudstack digital_ocean hp joyent openstack rackspace
                           softlayer proxmox managed azure brightbox cloudstack vcloud
-                          vsphere )
+                          vsphere google vultr vcloudair skytap scaleway )
 
   # Supported providers and default IPs used to bind the notifcation server too.
   SUPPORTED_PROVIDERS = { :virtualbox     => '127.0.0.1',
                           :docker         => '172.17.0.1',
+                          :hyperv         => '172.21.21.1',
                           :lxc            => '10.0.3.1',
                           :parallels      => '10.211.55.2',
-                          :vmware_fusion  => '192.168.172.1'
+                          :vmware_fusion  => '192.168.172.1',
+                          :vmware_workstation => '192.168.38.1'
                         }
 end

data/lib/vagrant-notify/server.rb

@@ -1,14 +1,19 @@
 require 'socket'
+require 'json'
+require 'tmpdir'
 
 module Vagrant
   module Notify
     class Server
       HTTP_RESPONSE = "Hi! You just reached the vagrant notification server"
 
-      def self.run(id, port, bind_ip, machine_name='default', provider='virtualbox')
-        #id           = env[:machine].id
-        #machine_name = env[:machine].name
-        #provider     = env[:machine].provider_name
+      def self.run(id, port, bind_ip, sender_app, sender_params_str, sender_params_escape, machine_name='default', provider='virtualbox')
+        #id                   = env[:machine].id
+        #machine_name         = env[:machine].name
+        #provider             = env[:machine].provider_name
+        #sender_app           = env[:machine].config.sender_app
+        #sender_params_str    = env[:machine].config.sender_params_str
+        #sender_params_escape = env[:machine].config.sender_params_escape
 
         if __FILE__ == $0
           begin
@@ -16,7 +21,7 @@ module Vagrant
           rescue
               exit 1
           end
-          server = self.new(id, machine_name, provider)
+          server = self.new(id, sender_app, sender_params_str, sender_params_escape, machine_name, provider)
 
           # Have to wrap this in a begin/rescue block so we can be certain the server is running at all times.
           begin
@@ -33,10 +38,13 @@ module Vagrant
         end
       end
 
-      def initialize(id, machine_name = :default, provider = :virtualbox)
+      def initialize(id, sender_app, sender_params_str, sender_params_escape, machine_name = :default, provider = :virtualbox)
         @id           = id
         @machine_name = machine_name
         @provider     = provider
+        @sender_app = sender_app
+        @sender_params_str = sender_params_str
+        @sender_params_escape = sender_params_escape
       end
 
       def receive_data(client)
@@ -44,8 +52,10 @@ module Vagrant
         if http_request?(args)
           client.puts HTTP_RESPONSE
         else
-          fix_icon_path!(args)
-          system("notify-send #{args}")
+          json_data=JSON.parse(args)
+          parsed_args=map_params_str(json_data)
+          fix_icon_path! parsed_args
+          system "#{@sender_app} #{parsed_args}"
         end
         client.close
       rescue => ex
@@ -54,12 +64,59 @@ module Vagrant
 
       private
 
+      # Maps params str with values
+      #
+      #@param data        [Map]     Array values map
+      #
+      #@return [String]
+      def map_params_str(data)
+        cmd=@sender_params_str + ''
+        cmd.gsub! '%', '%%'
+
+        replace=[]
+        cmd.scan(/\[[^\]]+\]/).each do |part|
+          variable=part[/\{[^\}]+\}/][1..-2]
+          if data.key? variable
+            replace << part[1..-2].sub('{' + variable + '}', escape_param(data[variable]))
+            cmd.sub! part, '%'+replace.length.to_s+'$s'
+          else
+            cmd.sub! part, ''
+          end
+        end
+
+        cmd.scan(/\{[^\}]+\}/).each do |part|
+          variable=part[1..-2]
+          if data.key? variable
+            replace << escape_param(data[variable])
+            cmd.sub! part, '%'+replace.length.to_s+'$s'
+          end
+        end
+        cmd % replace
+      end
+
       def log(message)
-        File.open("/tmp/vagrant-notify-error-#{@id}.log", 'a+') do |log|
+        File.open(@log_path, 'a+') do |log|
           log.puts "#{message}"
         end
       end
 
+      # Escapes param
+      #
+      #@param param [String] Param
+      #
+      #@return [String]
+      def escape_param(param)
+        return param unless @sender_params_escape
+        '"' + param.gsub('"', "\\\"").gsub("'", "\\'").gsub("\\", "\\\\") + '"'
+      end
+
+      # Gets log path
+      #
+      #@return [String]
+      def log_path
+        File.join Dir.tmpdir(), "vagrant-notify-error-#{@id}.log"
+      end
+
       def read_args(client)
         ''.tap do |args|
           while tmp = client.gets and tmp !~ /^\s*$/
@@ -88,5 +145,8 @@ end
 id = ARGV[0]
 port = ARGV[1]
 bind_ip = ARGV[2]
+sender_app = ARGV[3]
+sender_params_str = ARGV[4]
+sender_params_escape = ARGV[5]
 
-Vagrant::Notify::Server.run(id, port, bind_ip)
+Vagrant::Notify::Server.run id, port, bind_ip, sender_app, sender_params_str, sender_params_escape

data/lib/vagrant-notify/version.rb

@@ -1,5 +1,5 @@
 module Vagrant
   module Notify
-    VERSION = "0.5.3"
+    VERSION = "0.6.1"
   end
 end

data/spec/action/install_command_spec.rb

@@ -5,11 +5,13 @@ require 'vagrant-notify/action/install_command'
 
 describe Vagrant::Notify::Action::InstallCommand do
   let(:app)              { lambda { |env| } }
-  let(:config)           { mock(notify: stub(enable: true, bind_ip: "127.0.0.1")) }
+  let(:config)           { double(notify: double(enable: true, bind_ip: "127.0.0.1")) }
   let(:env)              { {notify_data: {port: host_port}, machine: machine, tmp_path: tmp_path} }
   let(:host_port)        { 12345 }
-  let(:machine)          { mock(communicate: communicator, config: config, provider_name: provider_name) }
-  let(:communicator)     { mock(upload: true, sudo: true) }
+  let(:ui)               { double(warn: true)}
+  let(:name)             { 'test-vm' }
+  let(:machine)          { double(communicate: communicator, config: config, provider_name: provider_name, ui: ui, name: name) }
+  let(:communicator)     { double(upload: true, sudo: true) }
   let(:host_ip)          { '192.168.1.2' }
   let(:provider_name)    { 'virtualbox' }
   let(:tmp_path)         { Pathname.new(Dir.mktmpdir) }
@@ -32,14 +34,18 @@ describe Vagrant::Notify::Action::InstallCommand do
   end
 
   it 'uploads compiled command script over to guest machine' do
-    communicator.should have_received(:upload).with(tmp_cmd_path.to_s, guest_tmp_path)
+    communicator.should have_received(:upload).with(tmp_cmd_path.to_s, guest_tmp_path).at_most(2).times
   end
 
   it 'creates a backup for the available command' do
-    communicator.should have_received(:sudo).with("mv /usr/bin/{notify-send,notify-send.bkp}; exit 0")
+    communicator.should have_received(:sudo).with("mv /usr/bin/{notify-send,notify-send.bkp}; exit 0").at_most(3).times
   end
 
   it 'installs command for all users' do
-    communicator.should have_received(:sudo).with("mv #{guest_tmp_path} #{guest_path} && chmod +x #{guest_path}")
+    communicator.should have_received(:sudo).with("mv #{guest_tmp_path} #{guest_path} && chmod +x #{guest_path}").at_most(3).times
+  end
+
+  it 'verify if ruby is installed on guest' do
+    communicator.should have_received(:sudo).with("which ruby 2>/dev/null || true").at_most(3).times
   end
 end

data/spec/action/prepare_data_spec.rb

@@ -5,7 +5,7 @@ require 'vagrant-notify/action/prepare_data'
 describe Vagrant::Notify::Action::PrepareData do
   let(:data_dir) { Pathname.new(Dir.mktmpdir) }
   let(:app)      { lambda { |env| } }
-  let(:env)      { {machine: mock(data_dir: data_dir)} }
+  let(:env)      { {machine: double(data_dir: data_dir)} }
 
   subject { described_class.new(app, env) }
 

data/spec/action/server_is_running_spec.rb

@@ -12,7 +12,7 @@ describe Vagrant::Notify::Action::ServerIsRunning do
     let(:pid) { nil }
 
     it 'sets the result to false' do
-      env[:result].should be_false
+      env[:result].should be_falsey
     end
   end
 
@@ -26,7 +26,7 @@ describe Vagrant::Notify::Action::ServerIsRunning do
       end
 
       it 'sets the result to true' do
-        env[:result].should be_true
+        env[:result].should be_truthy
       end
     end
 
@@ -37,7 +37,7 @@ describe Vagrant::Notify::Action::ServerIsRunning do
       end
 
       it 'sets the result to false' do
-        env[:result].should be_false
+        env[:result].should be_falsey
       end
     end
   end

data/spec/action/start_server_spec.rb

@@ -6,11 +6,12 @@ require 'vagrant-notify/server'
 
 describe Vagrant::Notify::Action::StartServer do
   let(:app)           { lambda { |env| } }
-  let(:config)        { mock(notify: stub(enable: true)) }
-  let(:ui)            { mock(success: true)}
+  let(:sender_params_str) { "[--app-name {app_name}] [--urgency {urgency}] [--expire-time {expire_time}] [--icon {icon}] [--category {category}] [--hint {hint}] {message}"}
+  let(:config)        { double(notify: double(enable: true, sender_app: 'notify-send', sender_params_str: sender_params_str, sender_params_escape: false)) }
+  let(:ui)            { double(success: true)}
   let(:id)            { '425e799c-1293-4939-bo39-263lcc7457e8' }
   let(:provider_name) { 'virtualbox' }
-  let(:machine)       { mock(state: stub(id: :stopped), ui: ui, id: id, config: config,  provider_name: provider_name) }
+  let(:machine)       { double(state: double(id: :stopped), ui: ui, id: id, config: config,  provider_name: provider_name) }
   let(:env)           { {notify_data: {bind_ip: "127.0.0.1"}, machine: machine} }
   let(:pid)           { '42' }
   let(:port)          { '1234' }
@@ -36,5 +37,5 @@ describe Vagrant::Notify::Action::StartServer do
   #  env[:notify_data][:pid].should be_nil
   # end
 
-  pending 'identifies the next available port'
-end
+  #pending 'identifies the next available port'
+end

data/spec/action/stop_server_spec.rb

@@ -4,10 +4,10 @@ require 'vagrant-notify/action/stop_server'
 
 describe Vagrant::Notify::Action::StopServer do
   let(:app)          { lambda { |env| } }
-  let(:config)       { mock(notify: stub(enable: true)) }
-  let(:communicator) { mock(sudo: true) }
-  let(:ui)           { mock(success: true) }
-  let(:machine)      { mock(communicate: communicator, state: stub(id: :running), ui: ui, config: config) }
+  let(:config)       { double(notify: double(enable: true)) }
+  let(:communicator) { double(sudo: true) }
+  let(:ui)           { double(success: true) }
+  let(:machine)      { double(communicate: communicator, state: double(id: :running), ui: ui, config: config) }
   let(:env)          { {notify_data: {pid: pid, port: 1234}, machine: machine} }
   let(:pid)          { '42' }
   let(:port)         { described_class::PORT }
@@ -20,7 +20,7 @@ describe Vagrant::Notify::Action::StopServer do
   end
 
   it 'kills the notification server' do
-    Process.should have_received(:kill).with('KILL', pid.to_i)
+    Process.should have_received(:kill).with('KILL', pid.to_i).at_most(2).times
   end
 
   it "removes server PID from notify data" do

data/spec/server_spec.rb

@@ -1,16 +1,20 @@
 require 'vagrant-notify/server'
 
 describe Vagrant::Notify::Server do
-  let(:arguments)  { "-- '20 examples, 1 failure\n10 seconds'" }
+  let(:arguments)  { '{"message":"It Works!"}' }
   let(:client)     { StringIO.new(arguments) }
+  let(:sender_app) { 'notify-send' }
+  let(:sender_params_str) { "[--app-name {app_name}] [--urgency {urgency}] [--expire-time {expire_time}] [--icon {icon}] [--category {category}] [--hint {hint}] {message}" }
+  let(:sender_params_escape) { true }
   let(:machine_id) { 'machine-id' }
+  let(:return_string) { '"It Works!"'}
 
-  subject { described_class.new(machine_id) }
+  subject { described_class.new(machine_id, sender_app, sender_params_str, sender_params_escape) }
 
   before { subject.stub(:system => true) }
 
   it 'runs notify-send with received data from client' do
-    subject.should_receive(:system).with("notify-send #{arguments}")
+    subject.should_receive(:system).with("#{sender_app}       #{return_string}") #server.rb needs to be updated so it strips this exta white space in the response
     subject.receive_data(client)
   end
 
@@ -20,12 +24,12 @@ describe Vagrant::Notify::Server do
   end
 
   context 'notification with an icon' do
-    let(:arguments) { "-i 'foo/bar.jpg'" }
+    let(:arguments) { '{"icon":"-tmp-foo-bar.jpg","message":"Test message"}' }
 
     before { subject.receive_data(client) }
 
     it 'rewrites icon path before sending the notification' do
-      subject.should have_received(:system).with("notify-send -i '/tmp/vagrant-notify/#{machine_id}/foo-bar.jpg'")
+      subject.should have_received(:system).with("#{sender_app}    --icon \"-tmp-foo-bar.jpg\"   \"Test message\"").at_most(2).times
     end
   end
 
@@ -39,7 +43,7 @@ describe Vagrant::Notify::Server do
     before { subject.receive_data(client) }
 
     it 'responds with a friendly message' do
-      client.should have_received(:puts).with(described_class::HTTP_RESPONSE)
+      client.should have_received(:puts).with(described_class::HTTP_RESPONSE).at_most(2).times
     end
 
     it 'does not issue system commands' do
@@ -47,7 +51,7 @@ describe Vagrant::Notify::Server do
     end
 
     it 'closes connection' do
-      client.should have_received(:close)
+      client.should have_received(:close).at_most(2).times
     end
   end
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-notify
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.6.1
 platform: ruby
 authors:
 - Fabio Rehm
 - Tony Baltazar
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-11-19 00:00:00.000000000 Z
+date: 2020-12-24 00:00:00.000000000 Z
 dependencies: []
 description: A Vagrant plugin that forwards `notify-send` from guest to host machine
   and notifies provisioning status
@@ -32,6 +32,7 @@ files:
 - Rakefile
 - development/Vagrantfile
 - examples/README.md
+- examples/osx/applescript/notify-send.rb
 - examples/osx/growl_for_mac/notify-send.rb
 - examples/osx/terminal-notifier/notify-send.rb
 - examples/windows/growl_for_windows/notify-send.rb
@@ -67,7 +68,7 @@ files:
 homepage: https://github.com/fgrehm/vagrant-notify
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -82,9 +83,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: A Vagrant plugin that forwards `notify-send` from guest to host machine and
   notifies provisioning status