terminal-notifier 1.5.1 → 1.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: df54c916daa2fd90c76fa0801d0053f301c70b71
-  data.tar.gz: 9df4279db02aa1923acb0a2d13c5067fff803259
+  metadata.gz: b08bd293cf43906f2a2981022d9437f0a6758210
+  data.tar.gz: d64d013c3d638884daace7310cbde29cf618f9a0
 SHA512:
-  metadata.gz: 1cb1bd4ad3e9010a7b9e51446658a3a8c71209b08edc0611307959b0c12401fcb3af5c756c57ecbc547bb36ab538353f9af7648e40eb381a05bec80d754c51ca
-  data.tar.gz: 78090121c50d0fda6dae2187509b2bfc5996b345fc18d23cd7ca6806adb6cdd29b3d1cd67fda1d3eebc4dac2efadbb27f15a1d4f0301750ac009939fab56153e
+  metadata.gz: 1209ea24eb31275b6f1d6cc42b67c3ab2d557aa27d049d338f16a9f3fcef08a2cd084f5370501a4f412e587cef86bf9d5d193ba819b232dfbe00cef8dffd2340
+  data.tar.gz: 4e0f15e611525579d5117c39df8fdea49a0ffb8488a8bca7a41fbbfbb3aef93285d869739faf807ab5ca2855073ad02439312c6725ac13f579599f273a982c6c

data/lib/terminal-notifier.rb

@@ -25,7 +25,7 @@ module TerminalNotifier
     end
   end
 
-  # Sends a User Notification and returns wether or not it was a success.
+  # 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:

data/vendor/terminal-notifier/README.markdown

@@ -1,24 +1,28 @@
 # terminal-notifier
 
 terminal-notifier is a command-line tool to send Mac OS X User Notifications,
-which are available in Mac OS X 10.8.
+which are available in Mac OS X 10.8 and higher.
 
-It is currently packaged as an application bundle, because `NSUserNotification`
-does not work from a ‘Foundation tool’. [radar://11956694](radar://11956694)
 
-The Notification Center _always_ uses the application’s own icon, there’s
-currently no way to specify a custom icon for a notification. The only way to
-use this tool with your own icon is to include a build of terminal-notifier
-with your icon instead.
+## Caveats
 
-This tool will be used by [Kicker](https://github.com/alloy/kicker) to show the
-status of commands which are executed due to filesystem changes. (v3.0.0)
+* The Notification Center _always_ uses the application’s own icon, there’s
+  currently no way to specify a custom icon for a notification. The only way to
+  use this tool with your own icon is to use the `-sender` option or include a
+  build of terminal-notifier with your icon and **a different bundle identifier**
+  instead. (If you do not change the bundle identifier, launch services will use
+  a cached version of the icon.)
+
+  However, you _can_ use unicode symbols and emojis. See the examples.
+
+* It is currently packaged as an application bundle, because `NSUserNotification`
+  does not work from a ‘Foundation tool’. [radar://11956694](radar://11956694)
 
 
 ## Download
 
-Prebuilt binaries, which are code-signed and ready to use, are available from
-the [downloads section](https://github.com/alloy/terminal-notifier/downloads).
+Prebuilt binaries are available from the
+[releases section](https://github.com/alloy/terminal-notifier/releases).
 
 Or if you want to use this from
 [Ruby](https://github.com/alloy/terminal-notifier/tree/master/Ruby), you can
@@ -28,6 +32,10 @@ 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
 
@@ -47,6 +55,14 @@ $ terminal-notifier -[message|group|list] [VALUE|ID|ID] [options]
 
 This will obviously be a bit slower than using the tool without the wrapper.
 
+Some examples are:
+
+```
+$ echo 'Piped Message Data!' | terminal-notifier -sound default
+$ terminal-notifier -title '💰' -message 'Check your Apple stock!' -open 'http://finance.yahoo.com/q?s=AAPL'
+$ terminal-notifier -group 'address-book-sync' -title 'Address Book Sync' -subtitle 'Finished' -message 'Imported 42 contacts.' -activate 'com.apple.AddressBook'
+```
+
 
 #### Options
 
@@ -59,6 +75,9 @@ option or the `-list` option.
 
 The message body of the notification.
 
+Note that if this option is omitted and data is piped to the application, that
+data will be used instead.
+
 -------------------------------------------------------------------------------
 
 `-title VALUE`
@@ -73,6 +92,13 @@ The subtitle of the notification.
 
 -------------------------------------------------------------------------------
 
+`-sound NAME`
+
+The name of a sound to play when the notification appears. The names are listed
+in Sound Preferences. Use 'default' for the default notification sound.
+
+-------------------------------------------------------------------------------
+
 `-group ID`
 
 Specifies the ‘group’ a notification belongs to. For any ‘group’ only _one_
@@ -120,6 +146,21 @@ Examples are:
 
 -------------------------------------------------------------------------------
 
+`-sender ID`
+
+Specifying this will make it appear as if the notification was send by that
+application instead, including using its icon.
+
+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.
+
+-------------------------------------------------------------------------------
+
 `-open URL`
 
 Specifies a resource to be opened when the user clicks the notification. This
@@ -138,7 +179,7 @@ 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 Eloy Durán <eloy.de.enige@gmail.com>
+Copyright (C) 2012-2013 Eloy Durán <eloy.de.enige@gmail.com>
 
 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

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,23 @@
+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>
+
+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
+Mac OS X 10.8, 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/alloy')
+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/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

data/vendor/terminal-notifier/Ruby/Rakefile

@@ -0,0 +1,44 @@
+def version
+  @version ||= begin
+    plist = File.expand_path('../../Terminal Notifier/Terminal Notifier-Info.plist', __FILE__)
+    `/usr/libexec/PlistBuddy -c 'Print :CFBundleShortVersionString' '#{plist}'`.strip
+  end
+end
+
+def filename
+  "terminal-notifier-#{version}"
+end
+
+def zipfile
+  "#{filename}.zip"
+end
+
+task :clean do
+  rm zipfile
+  rm_rf "vendor"
+end
+
+desc "Fetch latest build from the GitHub releases"
+task :update_build do
+  unless File.exist?(zipfile)
+    sh "curl -L -O 'https://github.com/alloy/terminal-notifier/releases/download/#{version}/terminal-notifier-#{version}.zip'"
+  end
+
+  rm_rf "vendor"
+  mkdir "vendor"
+
+  sh "unzip -o -d vendor #{zipfile}"
+  mv "vendor/#{filename}", "vendor/terminal-notifier"
+end
+
+desc "Build gem"
+task :gem => :update_build do
+  sh "gem build terminal-notifier.gemspec"
+end
+
+desc "Run specs"
+task :spec do
+  sh "bundle exec ruby spec/terminal-notifier_spec.rb"
+end
+
+task :default => :spec

data/vendor/terminal-notifier/Ruby/bin/terminal-notifier

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+if $0 == __FILE__
+  $:.unshift File.expand_path('../../lib', __FILE__)
+end
+
+require 'terminal-notifier'
+
+if !ARGV.include?("-message") && !STDIN.tty?
+  ARGV.push(*["-message", STDIN.read.chomp])
+end
+
+exec TerminalNotifier::BIN_PATH, *ARGV

data/vendor/terminal-notifier/Ruby/lib/terminal-notifier.rb

@@ -0,0 +1,87 @@
+require 'shellwords'
+
+module TerminalNotifier
+  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.8, or higher.
+  def self.available?
+    @available ||= `uname`.strip == 'Darwin' && `sw_vers -productVersion`.strip >= '10.8'
+  end
+
+  def self.execute(verbose, options)
+    if available?
+      command = [BIN_PATH, *options.map { |k,v| v = v.to_s; ["-#{k}", "#{Shellwords.escape(v[0,1])}#{v[1..-1]}"] }.flatten]
+      command = Shellwords.join(command) if RUBY_VERSION < '1.9'
+      result = ''
+      IO.popen(command) do |stdout|
+        output = stdout.read
+        STDOUT.print output if verbose
+        result << output
+      end
+      result
+    else
+      raise UnsupportedPlatformError, "terminal-notifier is only supported on Mac OS X 10.8, or higher."
+    end
+  end
+
+  # 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
+  #
+  # Examples are:
+  #
+  #   TerminalNotifier.notify('Hello World')
+  #   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', :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?
+  end
+  module_function :notify
+
+  # Removes a notification that was previously sent with the specified
+  # ‘group’ ID, if one exists.
+  #
+  # If no ‘group’ ID is given, all notifications are removed.
+  def remove(group = 'ALL', verbose = false)
+    TerminalNotifier.execute(verbose, :remove => group)
+    $?.success?
+  end
+  module_function :remove
+
+  LIST_FIELDS = [:group, :title, :subtitle, :message, :delivered_at].freeze
+
+  # If a ‘group’ ID is given, and a notification for that group exists,
+  # returns a hash with details about the notification.
+  #
+  # If no ‘group’ ID is given, an array of hashes describing all
+  # notifications.
+  #
+  # If no information is available this will return `nil`.
+  def list(group = 'ALL', verbose = false)
+    output = TerminalNotifier.execute(verbose, :list => group)
+    return if output.strip.empty?
+
+    require 'time'
+    notifications = output.split("\n")[1..-1].map do |line|
+      LIST_FIELDS.zip(line.split("\t")).inject({}) do |hash, (key, value)|
+        hash[key] = key == :delivered_at ? Time.parse(value) : (value unless value == '(null)')
+        hash
+      end
+    end
+
+    group == 'ALL' ? notifications : notifications.first
+  end
+  module_function :list
+end

data/vendor/terminal-notifier/Ruby/spec/terminal-notifier_spec.rb

@@ -0,0 +1,72 @@
+require 'rubygems'
+require 'bacon'
+require 'mocha'
+require 'mocha-on-bacon'
+
+Bacon.summary_at_exit
+
+$:.unshift File.expand_path('../../lib', __FILE__)
+require 'terminal-notifier'
+
+describe "TerminalNotifier" do
+  it "executes the tool with the given options and properly escapes the message" do
+    command = [TerminalNotifier::BIN_PATH, '-message', '\[ZOMG] "OH YEAH"']
+    command = Shellwords.join(command) if RUBY_VERSION < '1.9'
+    IO.expects(:popen).with(command).yields(StringIO.new('output'))
+    TerminalNotifier.execute(false, :message => '[ZOMG] "OH YEAH"')
+  end
+
+  it "returns the result output of the command" do
+    TerminalNotifier.execute(false, 'help' => '').should == `'#{TerminalNotifier::BIN_PATH}' -help`
+  end
+
+  it "sends a notification" do
+    TerminalNotifier.expects(:execute).with(false, :message => 'ZOMG', :group => 'important stuff')
+    TerminalNotifier.notify('ZOMG', :group => 'important stuff')
+  end
+
+  it "removes a notification" do
+    TerminalNotifier.expects(:execute).with(false, :remove => 'important stuff')
+    TerminalNotifier.remove('important stuff')
+  end
+
+  it "by default removes all the notifications" do
+    TerminalNotifier.expects(:execute).with(false, :remove => 'ALL')
+    TerminalNotifier.remove
+  end
+
+  it "returns `nil` if no notification was found to list info for" do
+    TerminalNotifier.expects(:execute).with(false, :list => 'important stuff').returns('')
+    TerminalNotifier.list('important stuff').should == nil
+  end
+
+  it "returns info about a notification posted in a specific group" do
+    TerminalNotifier.expects(:execute).with(false, :list => 'important stuff').
+      returns("GroupID\tTitle\tSubtitle\tMessage\tDelivered At\n" \
+              "important stuff\tTerminal\t(null)\tExecute: rake spec\t2012-08-06 19:45:30 +0000")
+    TerminalNotifier.list('important stuff').should == {
+      :group => 'important stuff',
+      :title => 'Terminal', :subtitle => nil, :message => 'Execute: rake spec',
+      :delivered_at => Time.parse('2012-08-06 19:45:30 +0000')
+    }
+  end
+
+  it "by default returns a list of all notification" do
+    TerminalNotifier.expects(:execute).with(false, :list => 'ALL').
+      returns("GroupID\tTitle\tSubtitle\tMessage\tDelivered At\n" \
+              "important stuff\tTerminal\t(null)\tExecute: rake spec\t2012-08-06 19:45:30 +0000\n" \
+              "(null)\t(null)\tSubtle\tBe subtle!\t2012-08-07 19:45:30 +0000")
+    TerminalNotifier.list.should == [
+      {
+        :group => 'important stuff',
+        :title => 'Terminal', :subtitle => nil, :message => 'Execute: rake spec',
+        :delivered_at => Time.parse('2012-08-06 19:45:30 +0000')
+      },
+      {
+        :group => nil,
+        :title => nil, :subtitle => 'Subtle', :message => 'Be subtle!',
+        :delivered_at => Time.parse('2012-08-07 19:45:30 +0000')
+      }
+    ]
+  end
+end