cacophony 0.0.2

data/.gitignore

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

data/Gemfile

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

data/README.rdoc

@@ -0,0 +1,35 @@
+= Cacophony notifier
+
+* Author: David Lyons (http://loadedfingers.com)
+
+== 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.
+The various notifiers are configured in ~/.cacophony, or via a config file passed via -c option.
+
+== Requirements
+
+* ruby 1.9.x
+* trollop
+* Growl (if you want growl notifications)
+
+== Install
+
+    sudo gem install cacophony
+
+Running cacophony for the first time will prompt you to create a sample configuration file, which you can edit as appropriate.
+
+== Usage
+
+Some examples:
+
+    cacophony -m 'just a message'
+    ./long_task_is_long | cacophony 
+    ./long_task_is_long | cacophony -t 'job output:'
+    ./long_task_is_long && cacophony -m 'coffee break over'
+
+
+== Developers
+You can add customer notifiers by adding a class to lib/notifiers/. They must follow the naming pattern xNotifier, copy one of the existing classes for method signatures.

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/bin/cacophony

@@ -0,0 +1,80 @@
+#!/usr/bin/ruby
+
+require 'yaml'
+require 'trollop'
+require 'fcntl'
+require 'fileutils'
+
+require 'cacophony'
+
+#resolve symlinks FIX WHEN IN GEM
+THIS_FILE = File.symlink?(__FILE__) ? File.readlink(__FILE__) : __FILE__
+GEM_PATH = File.join('..','lib',File.dirname(THIS_FILE) )
+
+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"
+  banner <<-EOS
+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.
+
+Usage:
+    cacophony [-options] [message]
+
+Examples:
+    ./long_task_is_long | cacophony 
+    ./long_task_is_long | cacophony -t 'job output:'
+    ./long_task_is_long && cacophony -m 'coffee break over'
+  
+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
+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):"
+  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 "Please edit this file to configure cacophony, and run again."
+    exit
+  end
+end
+
+
+CONF_FILE_PATH = opts[:conf_file] || File.join(File.expand_path('~'), '.cacophony')
+begin
+  CONFIG = YAML.load_file(CONF_FILE_PATH)
+rescue
+  Trollop::die "could not load config file: #{CONF_FILE_PATH}"
+end
+
+output = []
+
+
+if STDIN.fcntl(Fcntl::F_GETFL, 0) == 0
+  ARGF.each do |line| 
+    puts line
+    output << line
+  end
+else
+  #output << ''
+end
+
+message = (opts[:message] == DEFAULT_MSG && m =  ARGV.shift) ? m : opts[:message]
+title = opts[:title]
+
+notifer = Cacophony::Notifier.new(CONFIG)
+notifer.notify(title, message, output)

data/cacophony.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "cacophony/version"
+
+Gem::Specification.new do |s|
+  s.name        = "cacophony"
+  s.version     = Cacophony::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Dave Lyons"]
+  s.email       = ["dalyons@gmail.com"]
+  s.homepage    = "http://www.loadedfingers.com"
+  s.summary     = %q{Broadcast messages from programs and the command line}
+  s.description = %q{see summary}
+
+  #s.rubyforge_project = "cacophony"
+
+  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_dependency('trollop')
+end

data/config/cacophony_sample.yaml

@@ -0,0 +1,19 @@
+#Cacophony sample config.
+#Each availible notifier type is listed here, along with its options.
+#To enable a notifier, uncomment it and set the options you require.
+
+##Growl notifer uses growl. 
+##Please ensure 'Listen for availible notifications' and 'allow remote application registration' are ticked in System Preferences->Growl.
+#growl_notifier:
+#  use_growl_gem: false   
+#  sticky: true
+
+##Email notifier sends emails, below is a sample config for sending via gmail
+#email_notifier:
+#  server: smtp.gmail.com
+#  port: 587
+#  tls: true
+#  username: USERNAME
+#  password: PASSWORD
+#  to_address: [addy1@gmail.com, addy2@somewhere.com]
+#  from_address: cacophony@test.com

data/lib/cacophony/version.rb

@@ -0,0 +1,3 @@
+module Cacophony
+  VERSION = "0.0.2"
+end

data/lib/cacophony.rb

@@ -0,0 +1,34 @@
+#require all the notifiers
+require 'cacophony/version'
+Dir.glob(File.join(File.dirname(__FILE__), 'notifiers', '*.rb')) {|f| require f}
+
+
+module Cacophony
+  class Notifier
+
+    def initialize(conf)
+      raise 'need configuration hash' unless conf.is_a?(Hash) && conf.any?
+      @conf = conf
+    end
+
+    def notify(title, message, data)
+
+      threads = []
+      @conf.each do |notifier_type, opts|
+        begin
+          klass = Object.const_get(notifier_type.split('_').map(&:capitalize).join)
+        rescue 
+            raise "Invalid configuration option(s): #{notifier_type}"
+        end
+
+        threads << Thread.new do
+          notifier = klass.new(opts || {} )
+          puts "Cacophony broadcasting via #{notifier_type.split('_').map(&:capitalize).join(' ')}"
+          notifier.notify(message, title, data)
+        end
+      end
+
+      threads.each{|t| t.join}
+    end
+  end
+end

data/lib/notifiers/email_notifier.rb

@@ -0,0 +1,47 @@
+
+require 'net/smtp'
+
+
+class EmailNotifier
+
+  def initialize(opts={})
+    @opts = opts
+    @from = opts['from'] || "Your sentient shell <shell@donotfearus.com>"
+    @to = opts['to'] || "Puny human"
+    @subject = opts['subject'] || "Job Complete"
+    @server = opts['server'] || 'localhost'
+    @port = opts['port'] || 25
+    @username = opts['username'] || nil
+    @password = opts['password'] || nil
+    @method = opts['method'] || :plain
+    @to_addresses = opts['to_address'].to_a
+    @from_address = opts['from_address'] || ''
+    @tls = opts['tls'] || false
+
+  end
+
+  def notify(message, title, data)
+
+    details = message.dup
+    details << "\n" + (data.any? ? "Last #{RESULTS_SIZE} lines...\n\n#{data.last(50).join}" : "No output.")
+
+    @to_addresses.each do |address|
+
+      msg = <<MESSAGE_END
+From: #{@from}
+To: #{@to}
+Subject: #{title}: #{@subject}
+
+#{details}
+
+MESSAGE_END
+
+      smtp = Net::SMTP.new @server, @port
+      smtp.enable_starttls if @tls
+      smtp.start(@server, @username, @password, @method.to_sym) do 
+        smtp.send_message(msg, @from_address, address)
+      end
+    end
+  end
+
+end

data/lib/notifiers/growl_notifier.rb

@@ -0,0 +1,38 @@
+begin
+  require 'ruby-growl'
+  GROWL_GEM = true
+rescue LoadError
+  GROWL_GEM = false
+end
+
+class GrowlNotifier
+  def initialize(opts = {})
+    @server = opts['server'] || '127.0.0.1'
+    @sticky = opts['sticky'] || false
+    @use_growl_gem = opts['use_growl_gem'] == false ? false : true 
+    @output_lines = opts['output_lines'] || 2
+  end
+
+  def notify(message, title = '', data = [])
+    msg = message.dup
+    if data.any?
+      msg << "\n\n" 
+      #msg <<  "......#{data.length - @output_lines} more lines\n"  
+      #(@output_lines - 1).downto(0).each{|i| msg << "#{data.length - i}: #{data[i]}"}
+      data.last(@output_lines).each_with_index{|line,i| msg << "#{data.length - i}: #{line}"}
+      msg <<  "......#{data.length - @output_lines} more lines"  
+    end
+    (@use_growl_gem && GROWL_GEM) ? notify_via_gem(msg, title) : notify_via_binary(msg, title)
+  end
+
+ private 
+  def notify_via_gem(message, title)
+    growl = Growl.new "127.0.0.1", "ruby-growl",["ruby-growl_Notification"]
+    growl.notify "ruby-growl_Notification", title, message
+  end
+
+  def notify_via_binary(message, title)
+    growl_bin = File.join(GEM_PATH, 'bin', 'growlnotify')
+    system %{#{growl_bin} -m "#{msg}" "#{title}" #{"-s" if @sticky}}
+  end
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: cacophony
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Dave Lyons
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-09 00:00:00 +11:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: trollop
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: see summary
+email: 
+- dalyons@gmail.com
+executables: 
+- cacophony
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.rdoc
+- Rakefile
+- bin/cacophony
+- cacophony.gemspec
+- config/cacophony_sample.yaml
+- lib/cacophony.rb
+- lib/cacophony/version.rb
+- lib/growlnotify
+- lib/notifiers/email_notifier.rb
+- lib/notifiers/growl_notifier.rb
+has_rdoc: true
+homepage: http://www.loadedfingers.com
+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"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.0
+signing_key: 
+specification_version: 3
+summary: Broadcast messages from programs and the command line
+test_files: []
+