vagrant-notify 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e3f06401113919234836bb523fe7c76febdde45b
-  data.tar.gz: f7cb2652a42a65b648adbfda7eb700e769a8d28b
+  metadata.gz: 147e8cd55fe84bc3a668961b660d1390ed5d7e34
+  data.tar.gz: 315a4ec49f89f72c9a73b5ac03df91274ea56289
 SHA512:
-  metadata.gz: 42f8ed1ad51e9de58df011dc50d5949d852fd852d19248f708558e119ee6f9a25ecd2895c0727671a3dbdb9913dd0650635febb1b8a65034cc3c359e73e4c92d
-  data.tar.gz: 809382012aaf777f192da1152bc360254d142f5b178540256b1f7e342781bfdd4dda55cf92cd32b36e8c767ed0a29ebcf5d893dec8d8feae311cacaffb0cbcc6
+  metadata.gz: ed87d3c11b85beea60b89d4d6a7982ccd2f5a93ddafe85497914bce996220b15a6921364d1d9d9e966fda3e84641c71e02eeb53454e5a738bfa220950a1dba1a
+  data.tar.gz: aeb2356140cf699eb676b461ec6e2ba9f972b0f1cded0bce2d1e97988ad8fcaead4fa8d90e584e7fa0f1c7399d724d19f613f5b120781fe8aa2d640a5e36b68c

data/CHANGELOG.md

@@ -1,4 +1,14 @@
+## [0.5.1](https://github.com/fgrehm/vagrant-notify/compare/v0.5.0...v0.5.1) (July 23, 2016)
+IMPROVEMENTS
+  - New config option to disable plugin. [[GH-6]]
+  - Plugin will automatically be disabled for cloud providers. [[GH-15]]
+  - Solaris 11 and BSD guests are now supported.
+  - Windows snarl wrapper script.
+  - OS X growlnotify 1.2.2 wrapper script.
+
+BUG FIXES
 
+  - All single quotes that are part of the title or message get removed.
 
 ## [0.5.0](https://github.com/fgrehm/vagrant-notify/compare/v0.4.0...v0.5.0) (June 21, 2016)
 

data/Gemfile.lock

@@ -19,7 +19,7 @@ GIT
 PATH
   remote: .
   specs:
-    vagrant-notify (0.5.0)
+    vagrant-notify (0.5.1)
 
 GEM
   remote: https://rubygems.org/
@@ -91,4 +91,4 @@ DEPENDENCIES
   vagrant-notify!
 
 BUNDLED WITH
-   1.10.6
+   1.12.2

data/README.md

@@ -55,14 +55,24 @@ A (too) primitive script integrating with Growl:
 growlnotify -t "Vagrant VM" -m "$*"
 ```
 
-See example [scripts](https://github.com/fgrehm/vagrant-notify/tree/master/examples).
+Check out our OS X notify-send compatible [scripts](https://github.com/fgrehm/vagrant-notify/tree/master/examples).
 
 ### Windows (beta)
 
 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`.
 
-See example [scripts](https://github.com/fgrehm/vagrant-notify/tree/master/examples).
+Check out our Windows notify-send compatible [scripts](https://github.com/fgrehm/vagrant-notify/tree/master/examples).
 
+## Configuration
+
+Notifcation server is enabled by default on all VMs. You can individually disable the plugin by adding the following to your `Vagrantfile`
+
+```ruby
+config.notify.enable = false
+```
+
+_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#L72-74)_
 
 ## Demo
 

data/development/Vagrantfile

@@ -5,9 +5,10 @@ Vagrant.require_plugin 'vagrant-notify'
 Vagrant.require_plugin 'vagrant-lxc'
 
 Vagrant.configure("2") do |config|
-  config.vm.box = "raring64"
+  config.vm.box = "ubuntu/trusty64"
   config.vm.synced_folder "../", "/vagrant", id: 'vagrant-root'
 
   config.vm.define :vm1
   config.vm.define :vm2
+  config.notify.enable = true
 end

data/examples/README.md

@@ -3,14 +3,20 @@
 ## OS X
 
 * [terminal-notifier](https://github.com/alloy/terminal-notifier) [wrapper script](https://github.com/fgrehm/vagrant-notify/blob/master/examples/osx/notify-send_terminal-notifier) 
+* [growlnotify](http://growl.info/downloads) [wrapper script](https://github.com/fgrehm/vagrant-notify/blob/master/examples/osx/notify-send_growl_for_mac)
 
 
 ## Windows
 
+**IMPORTANT:** In addition of `notify-send` being in your `path`, the `notify-send` wrapper script has to be binary executable.
+Compiling using ocra:
+
+    ocra --output notify-send windows/notify-send_growl_for_snarl
+
+
 * [Growl for Windows](http://www.growlforwindows.com/gfw/default.aspx) [wrapper script](https://github.com/fgrehm/vagrant-notify/blob/master/examples/windows/notify-send_growl_for_windows)
 
-**IMPORTANT:** `notify-send` wrapper script has to be binary executable. Also as with `notify-send`, `growlnotify.exe` needs to be is in your `path`. 
+`growlnotify.exe` needs to be is in your `path`. 
 
-Compiling using ocra:
 
-    ocra --output notify-send windows/notify-send_growl_for_windows
+* [Snarl](http://snarl.fullphat.net/) [wrapper script](https://github.com/fgrehm/vagrant-notify/blob/master/examples/windows/notify-send_snarl)

data/examples/osx/notify-send_growl_for_mac

@@ -0,0 +1,38 @@
+#!/usr/bin/env ruby
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+# Example OS X growlnotify 1.2.2 notify-send wrapper script.
+
+require 'optparse'
+
+
+options = {}
+OptionParser.new do |opts|
+  opts.on('-u', '--urgency LEVEL')           { |v| options[:u] = v } # TO DO: set to --priority
+  opts.on('-t', '--expire-time TIME')        { |v| options[:t] = v } # Option gets removed
+  opts.on('-a', '--app-name APP_NAME')       { |v| options[:a] = v } # Set to --name 
+  opts.on('-i', '--icon ICON[,ICON...]')     { |v| options[:i] = v } # Set to --image
+  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 = "--message '#{ARGV[0]}'"
+  message << " --name #{options[:a]}" if options.include?(:a) 
+  message << " --image #{options[:i]}" if options.include?(:i)
+elsif ARGV.length == 2
+  message = "--title '#{ARGV[0]}' --message '#{ARGV[1]}'"
+  message << " --name #{options[:a]}" if options.include?(:a)
+  message << " --image #{options[:i]}" if options.include?(:i)
+else
+  puts "Invalid number of options."
+  exit 1
+end
+
+system("growlnotify #{message} 2>/dev/null")

data/examples/osx/notify-send_terminal-notifier

@@ -27,7 +27,8 @@ elsif ARGV.length == 1
 elsif ARGV.length == 2
   message = "-title '\\#{ARGV[0]}' -message '\\#{ARGV[1]}'"
 else
-  message = ARGV.map{|a| a =~ /-(title|message)/ ? a : "'\\#{a}'"}.join(' ')
+  puts "Invalid number of options."
+  exit 1
 end
 
 system("terminal-notifier -sound default #{message}")

data/examples/windows/notify-send_growl_for_windows

@@ -25,12 +25,12 @@ if ARGV.length == 0
   puts "No summary specified"
 elsif ARGV.length == 1
   message = "'#{ARGV[0]}'"
-  system("growlnotify.exe \"#{message}\"")
 elsif ARGV.length == 2
   title = "/t:'#{ARGV[0]}'"
   message = "'#{ARGV[1]}'"
-  system("growlnotify.exe \"#{title}\" \"#{message}\"")
 else
-  message = ARGV.map{|a| "'#{a}'"}.join(' ')
-  system("growlnotify.exe \"#{message}\"")
+  puts "Invalid number of options."
+  exit 1
 end
+
+system("growlnotify.exe \"#{message}\"")

data/examples/windows/notify-send_snarl

@@ -0,0 +1,44 @@
+#!/usr/bin/env ruby
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+# Example MS-Windows Snarl SNP/HTTP notify-send wrapper script.
+
+require 'optparse'
+require 'uri'
+require "net/http"
+
+
+options = {}
+OptionParser.new do |opts|
+  opts.on('-u', '--urgency LEVEL')           { |v| options[:u] = v } # TO DO: set to priority
+  opts.on('-t', '--expire-time TIME')        { |v| options[:t] = v } # Set to timeout (notify-send milliseconds to snarl seconds)
+  opts.on('-a', '--app-name APP_NAME')       { |v| options[:a] = v } # Option gets removed
+  opts.on('-i', '--icon ICON[,ICON...]')     { |v| options[:i] = v } # Option gets removed (Snarl does not properly handle masked git-bash/cygwin absoute paths)
+  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 = "notify?text='#{ARGV[0]}'"
+  message << "&timeout=#{options[:t].to_i / 1000}'" if options.include?(:t)
+elsif ARGV.length == 2
+  message = "notify?title='#{ARGV[0]}'&text='#{ARGV[1]}'"
+  message << "&timeout=#{options[:t].to_i / 1000}'" if options.include?(:t)
+else
+  puts "Invalid number of options."
+  exit 1
+end
+
+enc_uri = URI.escape(message)
+uri = URI.parse("http://127.0.0.1/#{enc_uri}")
+#puts uri
+
+Net::HTTP.get_response(uri)
+
+

data/files/notify-send.erb

@@ -1,4 +1,4 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
 # -*- mode: ruby -*-
 # vi: set ft=ruby :
 
@@ -36,10 +36,15 @@ end.join(' ')
 
 # TODO: Need to escape values
 unless ARGV.empty?
-  cmd << ARGV.map{|a| " '#{a}'"}.join(' ')
+  cmd << ARGV.map{|a| " '#{a.gsub(/'/, "")}'"}.join(' ')
+end
+
+if RUBY_PLATFORM =~ /linux/
+  client_ip = `ip route|awk '/default/ {print $3}'`
+elsif RUBY_PLATFORM =~ /solaris|freebsd|openbsd|netbsd/
+  client_ip = `netstat -r|awk '/default/ {print $2}'`
 end
 
-client_ip = `ip route|grep default|awk '{print $3}'`
 TCPSocket.open client_ip, <%= host_port %> do |s|
   s.send cmd, 0
 end

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

@@ -7,6 +7,8 @@ module Vagrant
         end
 
         def call(env)
+          return if env[:machine].config.notify.enable == false
+          
           path = compile_command(env, 'notify-send.erb')
           install_command_on_guest(env, path)
 

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

@@ -6,11 +6,17 @@ module Vagrant
           @app = app
         end
 
-        def call(env)
-          host_dir = Pathname("/tmp/vagrant-notify/#{env[:machine].id}")
-          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"
-          @app.call(env)
+        def call(env)         
+          begin
+            unless env[:machine].config.notify.enable == false 
+              host_dir = Pathname("/tmp/vagrant-notify/#{env[:machine].id}")
+              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
+            @app.call(env)
+            rescue
+              env[:machine].ui.warn("vagrant-notify: guest does not support the shared folder capability.")
+          end
         end
       end
     end

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

@@ -17,6 +17,8 @@ module Vagrant
           port = next_available_port
           id = env[:machine].id
           dir = File.expand_path('../../', __FILE__)
+          
+          return if env[:machine].config.notify.enable == false
 
           if which('ruby')
             env[:notify_data][:pid]  = Process.spawn("ruby #{dir}/server.rb #{id} #{port}")
@@ -29,6 +31,7 @@ module Vagrant
           end
 
           @app.call env
+
         end
 
         def next_available_port

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

@@ -7,6 +7,9 @@ module Vagrant
         end
 
         def call(env)
+          
+          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')

data/lib/vagrant-notify/action.rb

@@ -63,7 +63,11 @@ module Vagrant
                 if env2[:result]
                   env[:machine].ui.success("vagrant-notify-server pid: #{env2[:notify_data][:pid]}")
                 else
-                  env[:machine].ui.error("No vagrant-notify server detected.")
+                  if env[:machine].config.notify.enable == false
+                    env[:machine].ui.error("No vagrant-notify server detected. Disabled in Vagrantfile")
+                  else
+                    env[:machine].ui.error("No vagrant-notify server detected.")
+                  end
                 end
               end
             end

data/lib/vagrant-notify/config.rb

@@ -0,0 +1,39 @@
+module Vagrant
+  module Notify
+    class Config < Vagrant.plugin(2, :config)
+      attr_accessor :enable
+
+      def initialize()
+        @enable = UNSET_VALUE
+      end
+
+      def validate(machine)
+        errors = _detected_errors
+
+        if backed_by_cloud_provider?(machine)
+          machine.ui.warn("Disabling vagrant-notify, cloud provider #{machine.provider_name} in use.")
+
+          @enable = false
+        end
+
+        if @enable != 0
+          if @enable != false && @enable != true
+            errors << "Unknown option: #{@enable}"
+
+            { "notify" => errors }
+          end
+        end
+      end
+
+      def finalize!
+        @enable = 0 if @enable == UNSET_VALUE
+      end
+
+      private
+
+      def backed_by_cloud_provider?(machine)
+        CLOUD_PROVIDERS.include?(machine.provider_name.to_s)
+      end
+    end
+  end
+end

data/lib/vagrant-notify/plugin.rb

@@ -59,6 +59,17 @@ module Vagrant
         require_relative 'command'
         Vagrant::Notify::Command
       end
+
+      config(:notify) do
+        require_relative 'config'
+        Vagrant::Notify::Config
+      end
     end
   end
+ 
+  # 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 )
 end

data/lib/vagrant-notify/version.rb

@@ -1,5 +1,5 @@
 module Vagrant
   module Notify
-    VERSION = "0.5.0"
+    VERSION = "0.5.1"
   end
 end

data/spec/action/install_command_spec.rb

@@ -5,9 +5,10 @@ require 'vagrant-notify/action/install_command'
 
 describe Vagrant::Notify::Action::InstallCommand do
   let(:app)              { lambda { |env| } }
+  let(:config)           { mock(notify: stub(enable: true)) }
   let(:env)              { {notify_data: {port: host_port}, machine: machine, tmp_path: tmp_path} }
   let(:host_port)        { 12345 }
-  let(:machine)          { mock(communicate: communicator) }
+  let(:machine)          { mock(communicate: communicator, config: config) }
   let(:communicator)     { mock(upload: true, sudo: true) }
   let(:host_ip)          { '192.168.1.2' }
   let(:tmp_path)         { Pathname.new(Dir.mktmpdir) }

data/spec/action/start_server_spec.rb

@@ -6,9 +6,10 @@ 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(:id)         { '425e799c-1293-4939-bo39-263lcc7457e8' }
-  let(:machine)    { mock(state: stub(id: :stopped), ui: ui, id: id) }
+  let(:machine)    { mock(state: stub(id: :stopped), ui: ui, id: id, config: config) }
   let(:env)        { {notify_data: {}, machine: machine} }
   let(:pid)        { '42' }
   let(:port)       { '1234' }

data/spec/action/stop_server_spec.rb

@@ -4,9 +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) }
+  let(:ui)           { mock(success: true) }
+  let(:machine)      { mock(communicate: communicator, state: stub(id: :running), ui: ui, config: config) }
   let(:env)          { {notify_data: {pid: pid, port: 1234}, machine: machine} }
   let(:pid)          { '42' }
   let(:port)         { described_class::PORT }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-notify
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Fabio Rehm
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-22 00:00:00.000000000 Z
+date: 2016-07-23 00:00:00.000000000 Z
 dependencies: []
 description: A Vagrant plugin that forwards `notify-send` from guest to host machine
   and notifies provisioning status
@@ -32,8 +32,10 @@ files:
 - Rakefile
 - development/Vagrantfile
 - examples/README.md
+- examples/osx/notify-send_growl_for_mac
 - examples/osx/notify-send_terminal-notifier
 - examples/windows/notify-send_growl_for_windows
+- examples/windows/notify-send_snarl
 - files/notify-send.erb
 - lib/vagrant-notify.rb
 - lib/vagrant-notify/action.rb
@@ -47,6 +49,7 @@ files:
 - lib/vagrant-notify/action/stop_server.rb
 - lib/vagrant-notify/action/windows/process_info.rb
 - lib/vagrant-notify/command.rb
+- lib/vagrant-notify/config.rb
 - lib/vagrant-notify/data.rb
 - lib/vagrant-notify/plugin.rb
 - lib/vagrant-notify/server.rb