cacophony 0.0.3 → 0.0.4

data/README.rdoc

@@ -4,9 +4,8 @@
 
 == Caco-whatsie?
 
-Cacophony is a small program that broadcasts notifications via a variety of mechanisms, such as growl, email and twitter.
-It is great for notifiying you(or others) when a long running task is complete.
-It operates as a standalone executable, and it also can read from STDIN to pipe output from your tasks to the notifiers.
+Cacophony is a small library that broadcasts notifications via a variety of mechanisms, such as growl, email and twitter. All instances of cacophony can share a configuration file, which can be used to centralise notification configfuration for a variety of applications. Thus, you can manage the way notifications are sent from all applications from one config file. 
+It also comes with a command line executable which is great for notifiying you(or others) when a long running task is complete. It operates as a standalone executable, and it also can read from STDIN to pipe output from your tasks to the notifiers.
 The various notifiers are configured in ~/.cacophony, or via a config file passed via -c option.
 
 == Requirements
@@ -21,7 +20,20 @@ The various notifiers are configured in ~/.cacophony, or via a config file passe
 
 Running cacophony for the first time will prompt you to create a sample configuration file, which you can edit as appropriate.
 
-== Usage
+== Usage - Ruby library
+
+Some examples:
+
+    notifier = Cacophony::Notifier.new   #defaults to reading config from ~/.cacophony
+    notifier.notifiy('Witty title', 'informative message')
+
+    notifier = Cacophony::Notifier.new('~/.alternative_config_file')
+    notifier.notifiy('Witty title', 'informative message')
+
+    notifier = Cacophony::Notifier.new({:growl_notifier => {...}})  #pass config hash directly.
+    notifier.notifiy('Witty title', 'informative message')
+
+== Usage - Command line
 
 Some examples:
 

data/bin/cacophony

@@ -15,7 +15,6 @@ RESULTS_SIZE = 50
 DEFAULT_TITLE = 'Cacophony Notifier'
 DEFAULT_MSG = 'Task finished!'
 
-DEFAULT_CONF_PATH = '~/.cacophony'
 
 opts = Trollop::options do 
   version "Cacophony v#{Cacophony::VERSION}(c) 2011 David Lyons"
@@ -23,7 +22,7 @@ opts = Trollop::options do
 Cacophony is a small program that broadcasts notifications via a variety of mechanisms, such as growl, email and twitter.
 It is great for notifiying you(or others) when a long running task is complete.
 It operates as a standalone executable, and it also can read from STDIN to pipe output from your tasks to the notifiers.
-The various notifiers are configured in #{DEFAULT_CONF_PATH}, or via a config file passed via -c option.
+The various notifiers are configured in #{Cacophony::DEFAULT_CONF_PATH}, or via a config file passed via -c option.
 
 Usage:
     cacophony [-options] [message]
@@ -38,16 +37,16 @@ Options:
 EOS
   opt :message, "The message to send via the notifiers", :short => 'm', :type => String, :default => DEFAULT_MSG
   opt :title, "The title/subject to attach to messages", :short => 't', :type => String, :default => DEFAULT_TITLE
-  opt :conf_file, "Alternate location of config file (default: #{DEFAULT_CONF_PATH})", :short => 'c', :type => String
+  opt :conf_file, "Alternate location of config file (default: #{Cacophony::DEFAULT_CONF_PATH})", :short => 'c', :type => String
 end
 Trollop::die :conf_file, "must exist" unless File.exist?(opts[:conf_file]) if opts[:conf_file]
 
-unless opts[:conf_file] || File.exist?(File.expand_path(DEFAULT_CONF_PATH))
-  puts "No cacophony config file found at #{DEFAULT_CONF_PATH}."
-  print "Would you like me to create a sample config file at #{DEFAULT_CONF_PATH} for you? (y/n):"
+unless opts[:conf_file] || File.exist?(File.expand_path(Cacophony::DEFAULT_CONF_PATH))
+  puts "No cacophony config file found at #{Cacophony::DEFAULT_CONF_PATH}."
+  print "Would you like me to create a sample config file at #{Cacophony::DEFAULT_CONF_PATH} for you? (y/n):"
   if $stdin.getc == 'y'
-    puts "Copying sample to #{DEFAULT_CONF_PATH}."
-    FileUtils.cp(File.join(File.dirname(THIS_FILE), '..', 'config', 'cacophony_sample.yaml'), File.expand_path(DEFAULT_CONF_PATH))
+    puts "Copying sample to #{Cacophony::DEFAULT_CONF_PATH}."
+    FileUtils.cp(File.join(File.dirname(THIS_FILE), '..', 'config', 'cacophony_sample.yaml'), File.expand_path(Cacophony::DEFAULT_CONF_PATH))
     puts "Please edit this file to configure cacophony, and run again."
     exit
   end

data/lib/cacophony.rb

@@ -1,17 +1,32 @@
-#require all the notifiers
+require 'yaml'
 require 'cacophony/version'
+#require all the notifiers
 Dir.glob(File.join(File.dirname(__FILE__), 'notifiers', '*.rb')) {|f| require f}
 
 
 module Cacophony
+  DEFAULT_CONF_PATH = '~/.cacophony'
+
   class Notifier
 
-    def initialize(conf)
-      raise 'need configuration hash' unless conf.is_a?(Hash) && conf.any?
-      @conf = conf
+    def initialize(config_hash_or_filename = nil)
+      if config_hash_or_filename.is_a?(Hash)
+        @conf = config_hash_or_filename
+      elsif config_hash_or_filename.nil? || config_hash_or_filename.is_a?(String)
+        config_hash_or_filename ||= DEFAULT_CONF_PATH
+        path = File.expand_path(config_hash_or_filename)
+        begin 
+          @conf = YAML.load_file(path)
+        rescue 
+          raise "#{$!} couldn't read Cacophony config file from #{path} "
+        end
+
+      else
+        raise 'invalid config parameter.'
+      end
     end
 
-    def notify(title, message, data)
+    def notify(title, message, data = [])
 
       threads = []
       @conf.each do |notifier_type, opts|

data/lib/cacophony/version.rb

@@ -1,3 +1,3 @@
 module Cacophony
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

metadata

@@ -2,7 +2,7 @@
 name: cacophony
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors: 
 - Dave Lyons
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-09 00:00:00 +11:00
+date: 2011-02-14 00:00:00 +11:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency