notifies 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NDU5OGYwMWVkNGY0NjE2M2YxYTE0OGExNTgxZDE3NjU0OTc0OGUxNg==
+  data.tar.gz: !binary |-
+    OWM3M2EzY2RmMGU1ODFiMDdhMjI5OTUyMThlYjBlYmQ5ZWFkZmRjMw==
+SHA512:
+  metadata.gz: !binary |-
+    MjQ0N2MxYjA2NTAzMTc4M2UyYjhmYzBjNTY3MThiZmZkMGE3MDczOTgxMzU3
+    NTA4NzAyMjZiMzIzOTEyMDk4ZDY3Y2U2NTQxMjViYTY2MzM4NWU1YWYyMDQ5
+    MjJiN2ExYzdhYzE0MzZlMDc3ZWJiYThlNjcyMzg5MGY0NGU4NzI=
+  data.tar.gz: !binary |-
+    MmFiN2ZjY2RjN2M3YjgxOGU3NjQ1NGRlYjg3ZjQ2M2FlOTFkMDU0YTNkNjEy
+    NWE2NzljMjAyZjJiMDU4YWEzNzljYjFjZjY1MTkzMDg2ODEwMzg4ODc2NjA1
+    N2IxMGI5YWIxNmE0MWViNWJlMzVhY2UxOWFkYmZkZmU3MTI0ZmI=

data/Gemfile

@@ -0,0 +1,17 @@
+source "https://rubygems.org"
+
+gem 'growl', '~> 1.0.3'
+gem 'terminal-notifier-guard', '~> 1.5.3'
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem 'bundler'
+  gem 'rake'
+  gem 'rspec'
+  gem 'jeweler'
+  gem 'gem-release'
+  gem 'rake-version'
+  gem 'simplecov'
+  gem 'coveralls', require: false
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Simon Oulevay (Alpha Hydrae)
+
+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/README.md

@@ -0,0 +1,76 @@
+# notifies
+
+**Simple notifications with Growl and OS X Notification Center.**
+
+[![Gem Version](https://badge.fury.io/rb/notifies.png)](http://badge.fury.io/rb/notifies)
+[![Dependency Status](https://gemnasium.com/AlphaHydrae/notifies.png)](https://gemnasium.com/AlphaHydrae/notifies)
+[![Build Status](https://secure.travis-ci.org/AlphaHydrae/notifies.png)](http://travis-ci.org/AlphaHydrae/notifies)
+[![Coverage Status](https://coveralls.io/repos/AlphaHydrae/notifies/badge.png?branch=master)](https://coveralls.io/r/AlphaHydrae/notifies?branch=master)
+
+## Installation
+
+In your Gemfile:
+
+```rb
+gem 'notifies', '~> 0.1.0'
+```
+
+Manually:
+
+    gem install notifies
+
+## Usage
+
+It's as simple as:
+
+```rb
+Notifies.notify 'Hello World!'
+```
+
+This will automatically select and use the first available notifier.
+
+The method returns:
+
+* `true` if everything worked;
+* `nil` if no notifier is available on your system;
+* `false` if the notifier failed.
+
+### Notification Options
+
+The following options are available:
+
+* `:type` - The type of notification. With some notifiers this changes the icon.
+            This must be either `:ok`, `:info`, `:warning` or `:error`. By default, `:info` is selected.
+* `:title` - The title of the notification. This is set by the notifier by default (e.g. "growlnotify" for the Growl notifier).
+* `:subtitle` - An optional subtitle.
+* `:icon` - Custom icon. Only supported with Growl, see [the documentation](https://github.com/visionmedia/growl#normaized-icons).
+
+```rb
+Notifies.notify 'Hello World!', type: :ok, title: 'My App', subtitle: 'Notifications'
+```
+
+### Aliases
+
+You can uses these aliases instead of passing the `:type` option:
+
+```rb
+Notifies.notify_ok 'It works!'
+Notifies.notify_info 'Useful information'
+Notifies.notify_warning 'Beware'
+Notifies.notify_error 'Broken'
+```
+
+## Contributing
+
+* [Fork](https://help.github.com/articles/fork-a-repo)
+* Create a topic branch - `git checkout -b my_branch`
+* Push to your branch - `git push origin my_branch`
+* Create a [pull request](http://help.github.com/pull-requests/) from your branch
+
+Please add a changelog entry for new features and bug fixes.
+Writing specs will get your code pulled faster.
+
+## Meta
+
+* **Author:** Simon Oulevay (Alpha Hydrae)
+* **License:** MIT (see [LICENSE.txt](https://raw.github.com/AlphaHydrae/notifies/master/LICENSE.txt))

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/bin/notifies

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+require File.join(File.dirname(__FILE__), '../lib/notifies')
+
+# TODO: implement command line with commander
+Notifies.notify ARGV.shift

data/lib/notifies.rb

@@ -0,0 +1,93 @@
+# encoding: UTF-8
+
+module Notifies
+  VERSION = '0.1.0'
+  NOTIFIERS = {}
+  @@enabled = true
+
+  class Error < StandardError; end
+  class UnknownNotifierError < Error
+    
+    def initialize msg
+      super "Unknown notifier(s) #{msg}"
+    end
+  end
+
+  def self.notify msg, options = {}
+    return false if !@@enabled or (options.key?(:enabled) and !options[:enabled])
+    n = notifier options
+    n ? n.notify(msg, options) : nil
+  end
+
+  class << self
+    [ :ok, :info, :warning, :error ].each do |type|
+      define_method "notify_#{type}" do |*args|
+        options = args.last.kind_of?(Hash) ? args.last : {}.tap{ |h| args << h }
+        options[:type] = type
+        notify *args
+      end
+    end
+  end
+
+  def self.notifier *args
+    options = args.last.kind_of?(Hash) ? args.pop : {}
+
+    if key = args.shift
+      raise UnknownNotifierError.new(key.inspect) unless n = NOTIFIERS[key]
+      return !options[:available] || n && n.available? ? n : nil
+    end
+
+    ordered_notifiers(options).each_pair do |key,notifier|
+      return notifier if notifier.available?
+    end
+
+    nil
+  end
+
+  def self.preferred
+    NOTIFIERS.keys
+  end
+
+  def self.prefer *keys
+    NOTIFIERS.replace(ordered_notifiers(preferred: keys.flatten)).keys
+  end
+
+  def self.enabled= enabled
+    @@enabled = !!enabled
+  end
+
+  def self.enabled?
+    @@enabled
+  end
+
+  def self.register key, notifier
+    # TODO: test key override
+    NOTIFIERS[key] = notifier
+  end
+
+  def self.register_defaults
+    register :notification_center, Notifies::NotificationCenter
+    register :growl, Notifies::Growl
+  end
+
+  private
+
+  def self.ordered_notifiers options = {}
+    return NOTIFIERS unless options[:preferred]
+
+    keys = [ options.delete(:preferred) ].flatten.uniq
+    unknown_keys = keys.reject{ |k| NOTIFIERS[k] }
+    raise UnknownNotifierError.new(unknown_keys.collect{ |k| k.inspect }.join(', ')) unless unknown_keys.empty?
+
+    notifiers = NOTIFIERS.dup
+
+    Hash.new.tap do |ordered|
+      keys.each{ |k| ordered[k] = notifiers.delete k }
+      notifiers.each_pair{ |k,v| ordered[k] = v }
+    end
+  end
+end
+
+Dir[File.join File.dirname(__FILE__), File.basename(__FILE__, '.*'), '*.rb'].each{ |lib| require lib }
+
+Notifies.register_defaults

data/lib/notifies/growl.rb

@@ -0,0 +1,34 @@
+# encoding: UTF-8
+require 'growl'
+
+module Notifies
+
+  class Growl
+
+    def self.available?
+      !!::Growl.installed?
+    end
+
+    def self.notify msg, options = {}
+      method = METHODS[options.delete(:type)] || :notify_info
+      ::Growl.send method, msg, growl_options(options)
+    end
+
+    private
+
+    METHODS = {
+      ok: :notify_ok,
+      info: :notify_info,
+      warning: :notify_warning,
+      error: :notify_error
+    }
+
+    def self.growl_options options = {}
+      Hash.new.tap do |h|
+        h[:name] = options[:title] if options[:title]
+        h[:title] = options[:subtitle] if options[:subtitle]
+        h[:icon] = options[:icon] if options[:icon]
+      end
+    end
+  end
+end

data/lib/notifies/notification_center.rb

@@ -0,0 +1,33 @@
+# encoding: UTF-8
+require 'terminal-notifier-guard'
+
+module Notifies
+
+  class NotificationCenter
+
+    def self.available?
+      !!TerminalNotifier::Guard.available?
+    end
+
+    def self.notify msg, options = {}
+      method = METHODS[options.delete(:type)] || :notify
+      TerminalNotifier::Guard.send method, msg, terminal_notifier_options(options)
+    end
+
+    private
+
+    METHODS = {
+      ok: :success,
+      info: :notify,
+      warning: :pending,
+      error: :failed
+    }
+
+    def self.terminal_notifier_options options = {}
+      Hash.new.tap do |h|
+        h[:title] = options[:title] if options[:title]
+        h[:subtitle] = options[:subtitle] if options[:subtitle]
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,194 @@
+--- !ruby/object:Gem::Specification
+name: notifies
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- AlphaHydrae
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: growl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+- !ruby/object:Gem::Dependency
+  name: terminal-notifier-guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.3
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: gem-release
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake-version
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby notifications with Growl and OS X Notification Center.
+email: hydrae.alpha@gmail.com
+executables:
+- notifies
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- Gemfile
+- LICENSE.txt
+- README.md
+- VERSION
+- bin/notifies
+- lib/notifies.rb
+- lib/notifies/growl.rb
+- lib/notifies/notification_center.rb
+homepage: http://github.com/AlphaHydrae/notifies
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.5
+signing_key: 
+specification_version: 4
+summary: Simple notifications.
+test_files: []