terminal-notifier-guard 1.4.2

data/README.markdown

@@ -0,0 +1,46 @@
+# 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.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/bin/terminal-notifier-failed

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+if $0 == __FILE__
+  $:.unshift File.expand_path('../../lib', __FILE__)
+end
+
+require 'terminal-notifier-guard'
+
+exec TerminalNotifier::Guard::Failed::BIN_PATH, *ARGV

data/bin/terminal-notifier-notify

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+if $0 == __FILE__
+  $:.unshift File.expand_path('../../lib', __FILE__)
+end
+
+require 'terminal-notifier-guard'
+
+exec TerminalNotifier::Guard::Notify::BIN_PATH, *ARGV

data/bin/terminal-notifier-pending

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+if $0 == __FILE__
+  $:.unshift File.expand_path('../../lib', __FILE__)
+end
+
+require 'terminal-notifier-guard'
+
+exec TerminalNotifier::Guard::Pending::BIN_PATH, *ARGV

data/bin/terminal-notifier-success

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+if $0 == __FILE__
+  $:.unshift File.expand_path('../../lib', __FILE__)
+end
+
+require 'terminal-notifier-guard'
+
+exec TerminalNotifier::Guard::Success::BIN_PATH, *ARGV

data/lib/terminal-notifier-guard.rb

@@ -0,0 +1,127 @@
+%w(failed notify pending success).each do |type|
+  require File.expand_path("../terminal_notifier/guard/#{type}", __FILE__)
+end
+
+module TerminalNotifier
+  module Guard
+    include TerminalNotifier::Guard::Notify
+    include TerminalNotifier::Guard::Success
+    include TerminalNotifier::Guard::Failed
+    include TerminalNotifier::Guard::Pending
+
+    # Returns wether or not the current platform is Mac OS X 10.8, or higher.
+    def self.available?
+      if @available.nil?
+        @available = `uname`.strip == 'Darwin' && `sw_vers -productVersion`.strip >= '10.8'
+      end
+      @available
+    end
+
+    def self.execute(verbose, options)
+      if available?
+        case options[:type]
+        when :failed
+          bin_path = TerminalNotifier::Guard::Failed::BIN_PATH
+        when :success
+          bin_path = TerminalNotifier::Guard::Success::BIN_PATH
+        when :pending
+          bin_path = TerminalNotifier::Guard::Pending::BIN_PATH
+        else
+          bin_path = TerminalNotifier::Guard::Notify::BIN_PATH
+        end
+        options.delete(:type) if options[:type]
+
+        command = [bin_path, *options.map { |k,v| ["-#{k}", v.to_s] }.flatten]
+        if RUBY_VERSION < '1.9'
+          require 'shellwords'
+          command = Shellwords.shelljoin(command)
+        end
+        result = ''
+        IO.popen(command) do |stdout|
+          output = stdout.read
+          STDOUT.print output if verbose
+          result << output
+        end
+        result
+      else
+        raise "terminal-notifier is only supported on Mac OS X 10.8, or higher."
+      end
+    end
+
+    # Sends a User Notification and returns wether or not it was a success.
+    #
+    # The available options are `:title`, `:group`, `:activate`, `:open`, and
+    # `:execute`. 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"')
+    #
+    # Raises if not supported on the current platform.
+    def notify(message, options = {}, verbose = false)
+      TerminalNotifier::Guard.execute(verbose, options.merge(:message => message))
+      $?.success?
+    end
+    module_function :notify
+
+    def failed(message, options = {}, verbose = false)
+      TerminalNotifier::Guard.execute(verbose, options.merge(:message => message, :type => :failed))
+      $?.success?
+    end
+    module_function :failed
+
+    def pending(message, options = {}, verbose = false)
+      TerminalNotifier::Guard.execute(verbose, options.merge(:message => message, :type => :pending))
+      $?.success?
+    end
+    module_function :pending
+
+    def success(message, options = {}, verbose = false)
+      TerminalNotifier::Guard.execute(verbose, options.merge(:message => message, :type => :success))
+      $?.success?
+    end
+    module_function :success
+
+    # 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::Guard.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::Guard.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
+end

data/lib/terminal_notifier/guard/failed.rb

@@ -0,0 +1,7 @@
+module TerminalNotifier
+  module Guard
+    module Failed
+      BIN_PATH = File.expand_path('../../../../vendor/terminal-notifier-failed.app/Contents/MacOS/terminal-notifier', __FILE__)
+    end
+  end
+end

data/lib/terminal_notifier/guard/notify.rb

@@ -0,0 +1,7 @@
+module TerminalNotifier
+  module Guard
+    module Notify
+      BIN_PATH = File.expand_path('../../../../vendor/terminal-notifier-notify.app/Contents/MacOS/terminal-notifier', __FILE__)
+    end
+  end
+end

data/lib/terminal_notifier/guard/pending.rb

@@ -0,0 +1,7 @@
+module TerminalNotifier
+  module Guard
+    module Pending
+      BIN_PATH = File.expand_path('../../../../vendor/terminal-notifier-pending.app/Contents/MacOS/terminal-notifier', __FILE__)
+    end
+  end
+end

data/lib/terminal_notifier/guard/success.rb

@@ -0,0 +1,7 @@
+module TerminalNotifier
+  module Guard
+    module Success
+      BIN_PATH = File.expand_path('../../../../vendor/terminal-notifier-success.app/Contents/MacOS/terminal-notifier', __FILE__)
+    end
+  end
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: terminal-notifier-guard
+version: !ruby/object:Gem::Version
+  version: 1.4.2
+  prerelease: 
+platform: ruby
+authors:
+- Eloy Duran
+- Wouter de Vos
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bacon
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha-on-bacon
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- wouter.de.vos@springest.com
+executables:
+- terminal-notifier-notify
+- terminal-notifier-success
+- terminal-notifier-failed
+- terminal-notifier-pending
+extensions: []
+extra_rdoc_files:
+- README.markdown
+files:
+- lib/terminal-notifier-guard.rb
+- lib/terminal_notifier/guard/failed.rb
+- lib/terminal_notifier/guard/notify.rb
+- lib/terminal_notifier/guard/pending.rb
+- lib/terminal_notifier/guard/success.rb
+- bin/terminal-notifier-failed
+- bin/terminal-notifier-notify
+- bin/terminal-notifier-pending
+- bin/terminal-notifier-success
+- README.markdown
+homepage: https://github.com/foxycoder/terminal-notifier
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2038140021858145580
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2038140021858145580
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Send User Notifications on Mac OS X 10.8 - with status icons.
+test_files: []