growl_notify_osascript 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rspec

@@ -0,0 +1 @@
+--colour

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in growl_notify.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,9 @@
+# Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :version => 2, :cli => '--color --format doc' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+  watch('growl_notify.gemspec')  { "spec" }
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Scott Davis
+
+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/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+
+desc 'Default: run specs.'
+task :default => :spec
+
+desc "Run specs"
+RSpec::Core::RakeTask.new

data/Readme.md

@@ -0,0 +1,68 @@
+# GrowlNotifyOsascript
+
+This is a fork of Scott Davis' excellent [GrowlNotify gem](https://github.com/scottdavis/growl_notify).
+
+The original is based on the rb-appscript bindings to Applescript, which unfortunately doesn't support Kernel::fork. This gem uses Applescript piped through the osascript utility instead.
+
+## Usage
+
+### Configuring
+
+    GrowlNotify.config do |config|
+      config.notifications = ["Compass Application", "Someother Notification"]
+      config.default_notifications = ["Compass Application"] 
+      config.application_name = "My Application" #this shows up in the growl applications list in systems settings
+    end
+
+You can also set a globally scoped icon:
+
+    GrowlNotify.config do |config|
+      config.notifications = ["Compass Application", "Someother Notification"]
+      config.default_notifications = ["Compass Application"] 
+      config.application_name = "My Application" #this shoes up in the growl applications list in systems settings
+      config.icon = File.join("SOME PATH")
+    end
+    
+### Using
+
+#### Notification levels:
+
+1. very_low: `GrowlNotify.very_low(:title => 'HELLO WORLD', :description => 'Man that was cool')`
+2. moderate: `GrowlNotify.moderate(:title => 'HELLO WORLD', :description => 'Man that was cool')`
+3. normal: `GrowlNotify.normal(:title => 'HELLO WORLD', :description => 'Man that was cool')`
+4. high: `GrowlNotify.high(:title => 'HELLO WORLD', :description => 'Man that was cool')`
+5. emergency: `GrowlNotify.emergency(:title => 'HELLO WORLD', :description => 'Man that was cool')`
+
+#### Sticky messages
+
+`GrowlNotify.sticky!(:title => 'HELLO WORLD', :description => 'Man that was cool')`
+
+#### Options
+  
+    {:title => 'no title', :application_name => "My Application", :description => 'no description', :sticky => false, :priority => 0, :with_name => "Compass Application", :icon => <file path>}
+
+1. title - Title of message box
+2. description - Body of your message
+3. icon - Icon to show - pretty much all image formats are supported
+4. priority - importance of message from -2 very_low .. 2 emergency
+5. sticky - boolean if want the message to stick to the screen
+6. application_name - This is set from configs but you can override it
+7. with_name - must me one of your set default notifications by default its set to the first one
+
+#### Error Handling
+
+If the growl application is not installed on the system `GrowlNotify` will throw a `GrowlNotFound` exception.
+
+## Author
+
+  GrowlNotify is written by [Scott Davis](http://sdavis.info)
+  
+  Scott is a Developer for the Space Telescope Science Institute in Baltimore, MD - [Hubble Space Telescope](http://hubblesite.org)
+  
+  [Twitter](http://twitter.com/jetviper21)
+
+  GrowlNotifyOsascript was hacked together by [Inge Jørgensen](http://elektronaut.no)
+
+## Copyright
+
+Copyright (c) 2011 Scott Davis. See LICENSE.txt for further details.

data/growl_notify_osascript.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "growl_notify_osascript"
+
+Gem::Specification.new do |s|
+  #s.name        = "growl_notify_osascript"
+  s.name        = "growl_notify_osascript"
+  s.version     = GrowlNotifyOsascript::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Inge Jørgensen"]
+  s.email       = ["inge@elektronaut.no"]
+  s.homepage    = "https://github.com/elektronaut/growl_notify_osascript"
+  s.summary     = %q{Port of Sam Davis' growl_notify gem without the Appscript dependency}
+  s.description = %q{Port of Sam Davis' growl_notify gem without the Appscript dependency}
+
+  s.rubyforge_project = "growl_notify_osascript"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'guard-rspec'
+  s.add_development_dependency 'mocha'
+    
+end

data/lib/growl_notify.rb

@@ -0,0 +1,6 @@
+require 'growl_notify_osascript'
+
+# Alias as GrowlNotify
+unless Object.const_defined?('GrowlNotify')
+  GrowlNotify = GrowlNotifyOsascript
+end

data/lib/growl_notify_osascript.rb

@@ -0,0 +1,125 @@
+# encoding: utf-8
+
+require 'open3'
+
+class GrowlNotifyOsascript
+  VERSION = "0.0.1"
+  class GrowlNotFound < Exception; end
+  class << self
+    
+    attr_accessor :application_name, :default_notifications, :notifications, :icon
+    @application_name = "Ruby Growl"
+    @default_notifications = []
+    @notifications = []
+    @icon = nil
+    
+    def config(&block)
+      block.call(self)
+      register
+    end
+    
+    def escape(string)
+      '"' + string.to_s.gsub('"', '\"') + '"'
+    end
+
+    def run_script(script)
+  	  output = Open3.popen3('osascript') do |i, o, ts|
+  	    i.puts script
+  	    i.close
+  	    o.gets
+	    end
+      output ? output.strip : nil
+    end
+
+    def reset!
+      [:application_name, :default_notifications, :notifications, :icon].each do |meth|
+        send(:"#{meth}=", nil)
+      end
+    end
+
+    def to_applescript(hash)
+      hash.map do |key, value|
+        unless value.nil?
+          name = key.to_s.gsub('_', ' ')
+          if value.kind_of?(Array)
+            "#{name} {" + value.map{|v| escape(v)}.join(', ') + "}" 
+          else
+            "#{name} " + escape(value)
+          end
+        end
+      end.compact.join(' ')
+    end
+
+    def register
+      raise GrowlNotFound unless running?
+      
+      script = "tell application id \"com.Growl.GrowlHelperApp\"\n" + 
+               "register " +
+               to_applescript(
+                 :as_application => @application_name,
+                 :all_notifications => @notifications,
+                 :default_notifications => @default_notifications
+               ) + 
+               "\nend tell"
+               
+      run_script(script)
+    end
+    
+    def running?
+      script = "tell application \"System Events\"\n" +
+      	       "set isRunning to count of (every process whose bundle identifier is \"com.Growl.GrowlHelperApp\") > 0\n" +
+               "end tell"
+      run_script(script) == 'true'
+    end
+
+    def send_notification(options= {})
+      raise GrowlNotFound unless running?
+      defaults = {:title => 'no title', :application_name => @application_name, :description => 'no description', :sticky => false, :priority => 0, :with_name => notifications.first}
+      local_icon = @icon
+      local_icon = options.delete(:icon) if options.include?(:icon)
+      if local_icon
+        defaults.merge!(:image_from_location => local_icon)
+      end
+      
+      opts = defaults.merge(options)
+      
+      script = "tell application id \"com.Growl.GrowlHelperApp\"\n" + 
+               "notify " +
+               to_applescript(opts) +
+               "\nend tell"
+      
+      run_script(script)
+    end
+    
+    def very_low(options={})
+      options.merge!(:priority => -2)
+      send_notification(options)
+    end
+    
+    def moderate(options={})
+      options.merge!(:priority => -1)
+      send_notification(options)
+    end
+    
+    def normal(options={})
+      options.merge!(:priority => 0)
+      send_notification(options)      
+    end
+    
+    def high(options={})
+      options.merge!(:priority => 1)
+      send_notification(options)
+    end
+    
+    def emergency(options={})
+      options.merge!(:priority => 2)
+      send_notification(options)
+    end
+    
+    def sticky!(options={})
+      options.merge!(:sticky => true)
+      send_notification(options)
+    end
+  end
+
+end

data/spec/growl_notify_osascript_spec.rb

@@ -0,0 +1,108 @@
+require 'spec_helper'
+ICON = File.join(File.expand_path('../', __FILE__), 'growl_icon.png')
+describe GrowlNotifyOsascript do
+  it "should reset the configs" do
+    GrowlNotifyOsascript.config do |config|
+      config.notifications = config.default_notifications = ["foo"]
+      config.application_name = config.notifications.first
+    end
+    GrowlNotifyOsascript.notifications.should == ["foo"]
+    GrowlNotifyOsascript.reset!
+    GrowlNotifyOsascript.notifications.should be_nil
+  end
+  after :each do
+    GrowlNotifyOsascript.reset!
+  end
+  
+  context 'application not found' do
+    before do
+      GrowlNotifyOsascript.stubs(:running?).returns(false)
+    end
+    
+    it "should raise correct error" do
+      lambda {
+        GrowlNotifyOsascript.config do |config|
+          config.notifications = config.default_notifications = ["Compass Application"]
+          config.application_name = config.notifications.first
+        end
+        GrowlNotifyOsascript.normal(:title => 'GrowlNotifyOsascript Spec', :description => 'This is my "normal" message').should be_nil
+      }.should raise_error GrowlNotifyOsascript::GrowlNotFound
+    end
+  end
+  
+  context 'default' do
+    before do
+      GrowlNotifyOsascript.config do |config|
+        config.notifications = config.default_notifications = ["Compass Application"]
+        config.application_name = config.notifications.first
+      end
+    end
+  
+    it "should send a growl notification with icon" do
+      GrowlNotifyOsascript.send_notification(:title => 'GrowlNotifyOsascript Spec', :description => 'This is my descripton', :icon => ICON).should be_nil
+    end
+  end
+  
+  context 'no icon' do
+    before do
+      GrowlNotifyOsascript.config do |config|
+        config.notifications = config.default_notifications = ["Compass Application"]
+        config.application_name = config.notifications.first
+      end
+    end
+  
+    it "should send a growl notification with icon" do
+      GrowlNotifyOsascript.send_notification(:title => 'GrowlNotifyOsascript Spec', :description => 'This is my descripton no icon').should be_nil
+    end
+  end
+  
+  context 'config with icon' do
+     before do
+        GrowlNotifyOsascript.config do |config|
+          config.notifications = config.default_notifications = ["Compass Application"]
+          config.application_name = config.notifications.first
+          config.icon = ICON
+        end
+      end
+
+      it "should send a growl notification with icon" do
+        GrowlNotifyOsascript.send_notification(:title => 'GrowlNotifyOsascript Spec', :description => 'This is my descripton with a global icon').should be_nil
+      end
+  end
+  
+  context "helper methods" do
+    before do
+       GrowlNotifyOsascript.config do |config|
+         config.notifications = config.default_notifications = ["Compass Application"]
+         config.application_name = config.notifications.first
+         config.icon = ICON
+       end
+     end
+
+     it "should send 'very low'" do
+       GrowlNotifyOsascript.very_low(:title => 'GrowlNotifyOsascript Spec', :description => 'This is my "very_low" message').should be_nil
+     end
+     
+     it "should send 'moderate'" do
+       GrowlNotifyOsascript.moderate(:title => 'GrowlNotifyOsascript Spec', :description => 'This is my "moderate" message').should be_nil
+     end
+     
+     it "should send 'normal'" do
+       GrowlNotifyOsascript.normal(:title => 'GrowlNotifyOsascript Spec', :description => 'This is my "normal" message').should be_nil
+     end
+     
+     it "should send 'high'" do
+       GrowlNotifyOsascript.high(:title => 'GrowlNotifyOsascript Spec', :description => 'This is my "high" message').should be_nil
+     end
+     
+     it "should send 'emergency'" do
+       GrowlNotifyOsascript.emergency(:title => 'GrowlNotifyOsascript Spec', :description => 'This is my "emergency" message').should be_nil
+     end
+     
+     it "should send 'sticky'" do
+       GrowlNotifyOsascript.sticky!(:title => 'GrowlNotifyOsascript Spec', :description => 'This is my "Sticky!" message').should be_nil
+     end
+     
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'growl_notify_osascript'
+
+RSpec.configure do |config|
+  config.mock_with :mocha
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification 
+name: growl_notify_osascript
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- "Inge J\xC3\xB8rgensen"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-11-24 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: guard-rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: Port of Sam Davis' growl_notify gem without the Appscript dependency
+email: 
+- inge@elektronaut.no
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- Rakefile
+- Readme.md
+- growl_notify_osascript.gemspec
+- lib/growl_notify.rb
+- lib/growl_notify_osascript.rb
+- spec/growl_icon.png
+- spec/growl_notify_osascript_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: https://github.com/elektronaut/growl_notify_osascript
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: growl_notify_osascript
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Port of Sam Davis' growl_notify gem without the Appscript dependency
+test_files: 
+- spec/growl_icon.png
+- spec/growl_notify_osascript_spec.rb
+- spec/spec_helper.rb