vagrant-notify 0.5.6 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e815d8366c2310e48ee25a05e77ac87338c2dec8
-  data.tar.gz: 5879a33968786bfbc76c1879f94025450eb16acd
+SHA256:
+  metadata.gz: 8409030b38ffe90cf4f105a0ca94d95cf3e4a7dfb733cf7eb97d645d98f47cf1
+  data.tar.gz: c0a08020ba70555cbb88a1faad8be6923dcdbf4eea186dade504a1ad497c9825
 SHA512:
-  metadata.gz: 073a9a590caea2049c0fe203754a6cb68e3533665680920ccd7a99a7470c63d6c2718e0c426e3f4c15350eccb5feb8d47286d127391500ee2516aadbda21ead2
-  data.tar.gz: 7e5112adff7a124289b01f3eb8d7182bd75fde71a1173eb725be8572503a5075e1303e22179ee59763625a7ef1b301c3574e2f8a84df1b2c0def36ac223a785d
+  metadata.gz: ac522b11e032bec6c29efd6f49e9d2c570a06247e098a65bbba53a97a850c9ce13812f68a33fd77519c85c6d2c3f0c3a2dcb018a83ece3ced342b0d890d89bb0
+  data.tar.gz: 9b10bfc83de8be00ae61b77e4fa82415df1aaf39374f5e88cbfec267dd4c52a4d32e257d46848c066357c909fb90010016aa324592ce7232711078ba4a37bfa9

data/.gitignore

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

data/.travis.yml

@@ -1,4 +1,6 @@
 language: ruby
 bundler_args: --without development
 rvm:
-  - 2.3.3
+  - 2.7.1
+before_install:
+    - gem install bundler

data/CHANGELOG.md

@@ -1,4 +1,19 @@
+## [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)

data/README.md

@@ -60,7 +60,7 @@ 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#L81-L83)._
+[cloud providers](lib/vagrant-notify/plugin.rb#L81-L84)._
 
 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. 
 
@@ -71,6 +71,28 @@ Vagrant.configure(2) do |config|
 end
 ```
 
+By default local server uses ***notify_send*** command 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._

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|
   s.send cmd, 0
 end

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

@@ -32,16 +32,21 @@ 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 || true") {|type, data| ruby_check = data }
+          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

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/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.6"
+    VERSION = "0.6.0"
   end
 end

data/spec/action/install_command_spec.rb

@@ -46,6 +46,6 @@ describe Vagrant::Notify::Action::InstallCommand do
   end
 
   it 'verify if ruby is installed on guest' do
-    communicator.should have_received(:sudo).with("which ruby || true")
+    communicator.should have_received(:sudo).with("which ruby 2>/dev/null || true")
   end
 end

data/spec/action/start_server_spec.rb

@@ -6,7 +6,8 @@ require 'vagrant-notify/server'
 
 describe Vagrant::Notify::Action::StartServer do
   let(:app)           { lambda { |env| } }
-  let(:config)        { mock(notify: stub(enable: true)) }
+  let(:sender_params_str) { "[--app-name {app_name}] [--urgency {urgency}] [--expire-time {expire_time}] [--icon {icon}] [--category {category}] [--hint {hint}] {message}"}
+  let(:config)        { mock(notify: stub(enable: true, sender_app: 'notify-send', sender_params_str: sender_params_str, sender_params_escape: false)) }
   let(:ui)            { mock(success: true)}
   let(:id)            { '425e799c-1293-4939-bo39-263lcc7457e8' }
   let(:provider_name) { 'virtualbox' }
@@ -37,4 +38,4 @@ describe Vagrant::Notify::Action::StartServer do
   # end
 
   pending 'identifies the next available port'
-end
+end

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\"")
     end
   end
 

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-notify
 version: !ruby/object:Gem::Version
-  version: 0.5.6
+  version: 0.6.0
 platform: ruby
 authors:
 - Fabio Rehm
 - Tony Baltazar
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-09-30 00:00:00.000000000 Z
+date: 2020-09-06 00:00:00.000000000 Z
 dependencies: []
 description: A Vagrant plugin that forwards `notify-send` from guest to host machine
   and notifies provisioning status
@@ -68,7 +68,7 @@ files:
 homepage: https://github.com/fgrehm/vagrant-notify
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -83,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