terminal-notifier 1.8.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fae5b013616ebd7f4511c2949c3cffb6475d9cb4
-  data.tar.gz: e5b4e8c7cea64c8ab937ed72ea12ee81bb73050f
+  metadata.gz: fef9492e8e3563546fe5358647649031585b01fa
+  data.tar.gz: 9c9604dd1f3fd959e691e7c7e67d05da5ec13001
 SHA512:
-  metadata.gz: 403cdb78cf741009db3a64815369001835082ea8690c71138f7723b8a904e3f0fcf6b38babdb1b777418db87deb2af975a08e5547d22bd7ad26b4975f8fe700e
-  data.tar.gz: eb4d72aa0ab3fac697c6b5d0900c4eca016c579986356733df4e34beaacde75734f081a53c8332f930445a80c0027c2adb759662858002a4fd440f35d61e9fd8
+  metadata.gz: 1a6d520de804fc3c57f5b95f1e4889ab5e6e087a4888190f24fe8ad8a100482c6101bf1eb705e3732c4df0b861927132e0f3ff1d6ef44b859ca7952caddf5bd7
+  data.tar.gz: 696b031ece86bfd7948c990279745f044cae51a31509fe36f56699b4c5f9713fcd2385947cbf08eb5f4f2bc909c820b6379e1a5d607178fb3a3f636c7aca6401

data/README.markdown

@@ -2,7 +2,7 @@
 
 A simple Ruby wrapper around the [`terminal-notifier`][HOMEPAGE] command-line
 tool, which allows you to send User Notifications to the Notification Center on
-Mac OS X 10.10, or higher.
+macOS 10.10, or higher.
 
 
 ## Installation
@@ -22,7 +22,7 @@ Examples are:
 TerminalNotifier.notify('Hello World')
 TerminalNotifier.notify('Hello World', :title => 'Ruby', :subtitle => 'Programming Language')
 TerminalNotifier.notify('Hello World', :activate => 'com.apple.Safari')
-TerminalNotifier.notify('Hello World', :open => 'http://twitter.com/alloy')
+TerminalNotifier.notify('Hello World', :open => 'http://twitter.com/julienXX')
 TerminalNotifier.notify('Hello World', :execute => 'say "OMG"')
 TerminalNotifier.notify('Hello World', :group => Process.pid)
 TerminalNotifier.notify('Hello World', :sender => 'com.apple.Safari')
@@ -43,6 +43,6 @@ copyright of Apple.
 
 See [LICENSE][LICENSE] for details.
 
-[HOMEPAGE]: https://github.com/alloy/terminal-notifier
-[README]: https://github.com/alloy/terminal-notifier/blob/master/README.markdown
-[LICENSE]: https://github.com/alloy/terminal-notifier/blob/master/Ruby/LICENSE
+[HOMEPAGE]: https://github.com/julienXX/terminal-notifier
+[README]: https://github.com/julienXX/terminal-notifier/blob/master/README.markdown
+[LICENSE]: https://github.com/julienXX/terminal-notifier/blob/master/Ruby/LICENSE

data/lib/terminal-notifier.rb

@@ -3,10 +3,10 @@ require 'shellwords'
 require 'rbconfig'
 
 module TerminalNotifier
-  BIN_PATH = File.expand_path('../../vendor/terminal-notifier', __FILE__)
+  BIN_PATH = File.expand_path('../../vendor/terminal-notifier/terminal-notifier.app/Contents/MacOS/terminal-notifier', __FILE__)
 
   class UnsupportedPlatformError < StandardError; end
-  # Returns wether or not the current platform is Mac OS X 10.10, or higher.
+  # Returns wether or not the current platform is macOS 10.10, or higher.
   def self.available?
     @available ||= (/darwin|mac os/ =~ RbConfig::CONFIG['host_os']) && Gem::Version.new(version) > Gem::Version.new('10.10')
   end
@@ -27,16 +27,47 @@ module TerminalNotifier
       end
       result
     else
-      STDERR.print "terminal-notifier is only supported on Mac OS X 10.10, or higher."
+      STDERR.print "terminal-notifier is only supported on macOS 10.10, or higher."
     end
   end
 
+  # Cleans up the result of a notification, making it easier to work it
+  #
+  # The result of a notification is downcased, then groups of 1 or more
+  # non-word characters are replaced with an underscore, before being
+  # symbolised.
+  #
+  # If the reply option was given, then instead of going through the
+  # above process, the result is returned with no changes as a string.
+  #
+  # If the always_string param is set to true, a the result is returned
+  # with no changes as a string, like above.
+  #
+  # Examples are:
+  #
+  # notify_result('Test', {}) #=> :test
+  # notify_result('No, sir', {}) #=> :no_sir
+  # notify_result('@timeout', {}) #=> :_timeout
+  # notify_result('@closeaction', {}) #=> :_closeaction
+  # notify_result('I like pie', {reply: true}) #=> 'I like pie'
+  # notify_result('I do not like pie', {'reply' => true}) #=> 'I do not like pie'
+  # notify_result('@timeout', {'reply' => true}) #=> '@timeout'
+  # notify_result('I may like pie', {}) #=> :i_may_like_pie
+  def notify_result(result, options, always_string = false)
+    if options[:reply] || options['reply'] || always_string
+      result
+    else
+      result.length == 0 || result.downcase.gsub(/\W+/,'_').to_sym
+    end
+  end
+  module_function :notify_result
+
   # Sends a User Notification and returns whether or not it was a success.
   #
   # The available options are `:title`, `:group`, `:activate`, `:open`,
   # `:execute`, `:sender`, and `:sound`. For a description of each option see:
   #
-  #   https://github.com/alloy/terminal-notifier/blob/master/README.markdown
+  #   https://github.com/julienXX/terminal-notifier/blob/master/README.markdown
   #
   # Examples are:
   #
@@ -44,15 +75,15 @@ module TerminalNotifier
   #   TerminalNotifier.notify('Hello World', :title => 'Ruby')
   #   TerminalNotifier.notify('Hello World', :group => Process.pid)
   #   TerminalNotifier.notify('Hello World', :activate => 'com.apple.Safari')
-  #   TerminalNotifier.notify('Hello World', :open => 'http://twitter.com/alloy')
+  #   TerminalNotifier.notify('Hello World', :open => 'http://twitter.com/julienXX')
   #   TerminalNotifier.notify('Hello World', :execute => 'say "OMG"')
   #   TerminalNotifier.notify('Hello World', :sender => 'com.apple.Safari')
   #   TerminalNotifier.notify('Hello World', :sound => 'default')
   #
   # Raises if not supported on the current platform.
-  def notify(message, options = {}, verbose = false)
-    TerminalNotifier.execute(verbose, options.merge(:message => message))
-    $? && $?.success?
+  def notify(message, options = {}, verbose = false, always_string = false)
+    result = TerminalNotifier.execute(verbose, options.merge(:message => message))
+    $? && $?.success? && notify_result(result, options, always_string)
   end
   module_function :notify
 

data/vendor/terminal-notifier/LICENSE.md

@@ -0,0 +1,9 @@
+All the works are available under the MIT license. Except for ‘Terminal.icns’, which is a copy of Apple’s Terminal.app icon and as such is copyright of Apple.
+
+Copyright (C) 2012-2016 Eloy Durán eloy.de.enige@gmail.com, Julien Blanchard julien@sideburns.eu
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/vendor/terminal-notifier/README.markdown

@@ -0,0 +1,256 @@
+# terminal-notifier
+
+terminal-notifier is a command-line tool to send macOS User Notifications,
+which are available on macOS 10.10 and higher.
+
+
+## News
+
+[alerter](https://github.com/vjeantet/alerter) features were merged in terminal-notifier 1.7. This led to some issues and even more issues in the 1.8 release. We decided with [Valère Jeantet](https://github.com/vjeantet) to rollback this merge.
+
+From now on terminal-notifier won't have the sticky notification feature nor the actions buttons. If you need them please use [alerter](https://github.com/vjeantet/alerter). I also want to follow [semver](http://semver.org) hence this latest version starts at 2.0.0.
+
+Sticking to two smaller specialized tools will hopefully make them easier to maintain and less error prone.
+
+
+## Caveats
+
+* It is currently packaged as an application bundle, because `NSUserNotification`
+  does not work from a ‘Foundation tool’. [radar://11956694](radar://11956694)
+
+* If you intend to package terminal-notifier with your app to distribute it on the Mac App Store, please use 1.5.2; version 1.6.0+ uses a private method override, which is not allowed in the App Store Guidelines.
+
+* If you're using macOS < 10.10 you should use terminal-notifier 1.6.3.
+
+* If you're looking for sticky notifications or more actions on a notification please use [alerter](https://github.com/vjeantet/alerter)
+
+## Download
+
+Prebuilt binaries are available from the
+[releases section](https://github.com/julienXX/terminal-notifier/releases).
+
+Or if you want to use this from
+[Ruby](https://github.com/julienXX/terminal-notifier/tree/master/Ruby), you can
+install it through RubyGems:
+
+```
+$ [sudo] gem install terminal-notifier
+```
+
+You can also install it via [Homebrew](https://github.com/mxcl/homebrew):
+```
+$ brew install terminal-notifier
+```
+
+## Usage
+
+```
+$ ./terminal-notifier.app/Contents/MacOS/terminal-notifier -[message|group|list] [VALUE|ID|ID] [options]
+```
+
+In order to use terminal-notifier, you have to call the binary _inside_ the
+application bundle.
+
+The Ruby gem, which wraps this tool, _does_ have a bin wrapper. If installed
+you can simply do:
+
+```
+$ terminal-notifier -[message|group|list] [VALUE|ID|ID] [options]
+```
+
+This will obviously be a bit slower than using the tool without the wrapper.
+
+
+### Example Uses
+
+Display piped data with a sound:
+```
+$ echo 'Piped Message Data!' | terminal-notifier -sound default
+```
+
+![Example 1](assets/Example_1.png)
+
+Use a custom icon:
+```
+$ terminal-notifier -title ProjectX -subtitle "new tag detected" -message "Finished" -appIcon http://vjeantet.fr/images/logo.png
+```
+
+![Example 3](assets/Example_3.png)
+
+Open an URL when the notification is clicked:
+```
+$ terminal-notifier -title '💰' -message 'Check your Apple stock!' -open 'http://finance.yahoo.com/q?s=AAPL'
+```
+
+![Example 4](assets/Example_4.png)
+
+Open an app when the notification is clicked:
+```
+$ terminal-notifier -group 'address-book-sync' -title 'Address Book Sync' -subtitle 'Finished' -message 'Imported 42 contacts.' -activate 'com.apple.AddressBook'
+```
+
+![Example 5](assets/Example_5.png)
+
+
+### Options
+
+At a minimum, you must specify either the `-message` , the `-remove`, or the
+`-list` option.
+
+-------------------------------------------------------------------------------
+
+`-message VALUE`  **[required]**
+
+The message body of the notification.
+
+If you pipe data into terminal-notifier, you can omit this option,
+and the piped data will become the message body instead.
+
+-------------------------------------------------------------------------------
+
+`-title VALUE`
+
+The title of the notification. This defaults to ‘Terminal’.
+
+-------------------------------------------------------------------------------
+
+`-subtitle VALUE`
+
+The subtitle of the notification.
+
+-------------------------------------------------------------------------------
+
+`-sound NAME`
+
+Play the `NAME` sound when the notification appears.
+Sound names are listed in Sound Preferences.
+
+Use the special `NAME` “default” for the default notification sound.
+
+-------------------------------------------------------------------------------
+
+`-group ID`
+
+Specifies the notification’s ‘group’. For any ‘group’, only _one_
+notification will ever be shown, replacing previously posted notifications.
+
+A notification can be explicitly removed with the `-remove` option (see
+below).
+
+Example group IDs:
+
+* The sender’s name (to scope the notifications by tool).
+* The sender’s process ID (to scope the notifications by a unique process).
+* The current working directory (to scope notifications by project).
+
+-------------------------------------------------------------------------------
+
+`-remove ID`  **[required]**
+
+Remove a previous notification from the `ID` ‘group’, if one exists.
+
+Use the special `ID` “ALL” to remove all messages.
+
+-------------------------------------------------------------------------------
+
+`-list ID` **[required]**
+
+Lists details about the specified ‘group’ `ID`.
+
+Use the special `ID` “ALL” to list details about all currently active messages.
+
+The output of this command is tab-separated, which makes it easy to parse.
+
+-------------------------------------------------------------------------------
+
+`-activate ID`
+
+Activate the application specified by `ID` when the user clicks the
+notification.
+
+You can find the bundle identifier (`CFBundleIdentifier`) of an application in its `Info.plist` file
+_inside_ the application bundle.
+
+Examples application IDs are:
+
+* `com.apple.Terminal` to activate Terminal.app
+* `com.apple.Safari` to activate Safari.app
+
+-------------------------------------------------------------------------------
+
+`-sender ID`
+
+Fakes the sender application of the notification. This uses the specified
+application’s icon, and will launch it when the notification is clicked.
+
+Using this option fakes the sender application, so that the notification system
+will launch that application when the notification is clicked. Because of this
+it is important to note that you cannot combine this with options like
+`-execute` and `-activate` which depend on the sender of the notification to be
+‘terminal-notifier’ to perform its work.
+
+For information on the `ID`, see the `-activate` option.
+
+-------------------------------------------------------------------------------
+
+`-appIcon PATH`
+
+Specify an image `PATH` to display instead of the application icon.
+
+**WARNING: This option is subject to change, since it relies on a private method.**
+
+-------------------------------------------------------------------------------
+
+`-contentImage PATH`
+
+Specify an image `PATH` to attach inside of the notification.
+
+**WARNING: This option is subject to change since it relies on a private method.**
+
+-------------------------------------------------------------------------------
+
+`-open URL`
+
+Open `URL` when the user clicks the notification. This can be a web or file URL,
+or any custom URL scheme.
+
+-------------------------------------------------------------------------------
+
+`-execute COMMAND`
+
+Run the shell command `COMMAND` when the user clicks the notification.
+
+-------------------------------------------------------------------------------
+
+`-ignoreDnD`
+
+Ignore Do Not Disturb settings and unconditionally show the notification.
+
+**WARNING: This option is subject to change since it relies on a private method.**
+
+## License
+
+All the works are available under the MIT license. **Except** for
+‘Terminal.icns’, which is a copy of Apple’s Terminal.app icon and as such is
+copyright of Apple.
+
+Copyright (C) 2012-2017 Eloy Durán <eloy.de.enige@gmail.com>, Julien Blanchard
+<julien@sideburns.eu>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/vendor/terminal-notifier/Ruby/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/vendor/terminal-notifier/Ruby/Gemfile.lock

@@ -0,0 +1,23 @@
+PATH
+  remote: .
+  specs:
+    terminal-notifier (1.5.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    bacon (1.1.0)
+    metaclass (0.0.1)
+    mocha (0.11.4)
+      metaclass (~> 0.0.1)
+    mocha-on-bacon (0.2.0)
+      mocha (>= 0.9.8)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bacon
+  mocha
+  mocha-on-bacon
+  terminal-notifier!

data/vendor/terminal-notifier/Ruby/LICENSE

@@ -0,0 +1,24 @@
+All the works are available under the MIT license. **Except** for
+‘Terminal.icns’, which is a copy of Apple’s Terminal.app icon and as such is
+copyright of Apple.
+
+Copyright (C) 2012-2013 Eloy Durán <eloy.de.enige@gmail.com>, Julien Blanchard
+<julien@sideburns.eu>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/vendor/terminal-notifier/Ruby/README.markdown

@@ -0,0 +1,48 @@
+# TerminalNotifier
+
+A simple Ruby wrapper around the [`terminal-notifier`][HOMEPAGE] command-line
+tool, which allows you to send User Notifications to the Notification Center on
+macOS 10.10, or higher.
+
+
+## Installation
+
+```
+$ gem install terminal-notifier
+```
+
+
+## Usage
+
+For full information on all the options, see the tool’s [README][README].
+
+Examples are:
+
+```ruby
+TerminalNotifier.notify('Hello World')
+TerminalNotifier.notify('Hello World', :title => 'Ruby', :subtitle => 'Programming Language')
+TerminalNotifier.notify('Hello World', :activate => 'com.apple.Safari')
+TerminalNotifier.notify('Hello World', :open => 'http://twitter.com/julienXX')
+TerminalNotifier.notify('Hello World', :execute => 'say "OMG"')
+TerminalNotifier.notify('Hello World', :group => Process.pid)
+TerminalNotifier.notify('Hello World', :sender => 'com.apple.Safari')
+TerminalNotifier.notify('Hello World', :sound => 'default')
+
+TerminalNotifier.remove(Process.pid)
+
+TerminalNotifier.list(Process.pid)
+TerminalNotifier.list
+```
+
+
+## License
+
+All the works are available under the MIT license. **Except** for
+‘Terminal.icns’, which is a copy of Apple’s Terminal.app icon and as such is
+copyright of Apple.
+
+See [LICENSE][LICENSE] for details.
+
+[HOMEPAGE]: https://github.com/julienXX/terminal-notifier
+[README]: https://github.com/julienXX/terminal-notifier/blob/master/README.markdown
+[LICENSE]: https://github.com/julienXX/terminal-notifier/blob/master/Ruby/LICENSE