airblade-fyi 0.0.3

data/.gitignore

@@ -0,0 +1 @@
+.DS_Store

data/README.md

@@ -0,0 +1,80 @@
+# FYI
+
+Be informed about task execution.
+
+
+## Synopsis
+
+    fyi some_command
+  
+
+## Examples
+
+    fyi ls -lt
+    fyi "ls -lt | grep total"
+    fyi "cd /var/www/apps/current && /opt/ree/bin/rake RAILS_ENV=production thinking_sphinx:index"
+
+
+## Description
+
+The `fyi` command executes `some_command` and tells you what
+happened.  This is useful when `some_command` is executed
+asynchronously, e.g. via cron, and you want to know how it
+went without cluttering up your crontab with pipe redirections.
+
+When `fyi` executes `some_command` it captures standard out, 
+standard error, and whether `some_command` succeeded or failed.
+These are then reported by any notifiers you have configured.
+Success is defined by a 0 exit code and failure by a non-zero
+exit code.
+
+
+## Notifiers
+
+The default notifier is the `Log` notifier.  This writes to
+`fyi.log` in the process's home directory unless you configure
+it otherwise (see below).
+
+One other notifier is currently available: the `Email` notifier.
+Simply configure it (see below) to use it.  You can switch
+success notifications on and off and failure notifications
+on and off independently.  By default this notifier will only
+email you when `some_command` fails.
+
+To provide additional notifiers, e.g. Campfire / HTTP / Jabber,
+add a class in `lib/notifiers/` and configure it (see below).
+`fyi` will automatically instantiate it, configure it and use
+it.
+
+A notifier must:
+
+* subclass Fyi::Notifier
+* accept an options hash at initialisation (populated from
+  configuration).
+* respond to `notify(command, result, output, error = '')`
+
+
+## Installation
+
+    sudo gem install fyi
+
+
+## Configuration
+
+Configure `fyi` with a YAML file at `<home>/.fyi`, where
+`<home>` is the process's home directory.
+
+Each top-level key should be the name of a notifier class.
+The key-value pairs in each notifier section are passed in
+a hash to the notifier class at instantiation.
+
+
+## Problems 
+
+Please use GitHub's [issue tracker](http://github.com/airblade/fyi/issues).
+
+
+## Intellectual Property
+
+Copyright (c) 2009 Andy Stewart (boss@airbladesoftware.com).
+Released under the MIT licence.

data/Rakefile

@@ -0,0 +1,15 @@
+require 'rake' 
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = 'fyi'
+    gemspec.summary = 'Be informed about task execution.'
+    gemspec.email = 'boss@airbladesoftware.com'
+    gemspec.homepage = 'http://github.com/airblade/fyi'
+    gemspec.authors = ['Andy Stewart']
+    gemspec.add_dependency('pony')
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.3

data/bin/fyi

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
+require 'fyi'
+Fyi.run ARGV.join(' ')

data/config_example.yml

@@ -0,0 +1,17 @@
+#
+# Move this to ~/.fyi
+#
+
+log:
+  file: /var/log/fyi.log
+email:
+  on_success: yes
+  from: fyi@yourdomain.com
+  to: you@yourdomain.com
+  smtp:
+    host: smtp.yourserver.com
+    port: 25
+    user: username
+    password: password
+    auth: :login
+    domain: yourdomain.com

data/fyi.gemspec

@@ -0,0 +1,52 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{fyi}
+  s.version = "0.0.3"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Andy Stewart"]
+  s.date = %q{2009-08-08}
+  s.default_executable = %q{fyi}
+  s.email = %q{boss@airbladesoftware.com}
+  s.executables = ["fyi"]
+  s.extra_rdoc_files = [
+    "README.md"
+  ]
+  s.files = [
+    ".gitignore",
+     "README.md",
+     "Rakefile",
+     "VERSION",
+     "bin/fyi",
+     "config_example.yml",
+     "fyi.gemspec",
+     "lib/fyi.rb",
+     "lib/fyi/config.rb",
+     "lib/fyi/core_ext.rb",
+     "lib/fyi/notifiers/email.rb",
+     "lib/fyi/notifiers/log.rb"
+  ]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/airblade/fyi}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Be informed about task execution.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<pony>, [">= 0"])
+    else
+      s.add_dependency(%q<pony>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<pony>, [">= 0"])
+  end
+end

data/lib/fyi.rb

@@ -0,0 +1,55 @@
+require 'rubygems'
+require 'open4'
+require 'fyi/config'
+require 'fyi/core_ext'
+
+#
+# See /bin/fyi for documentation.
+#
+class Fyi
+  def self.run(command)
+    new(command).run
+  end
+
+  def initialize(command)
+    @command = command
+    @config = Config.new
+  end
+
+  def run
+    # Borrowed from CI Joe.
+    out, err, status = '', '', nil
+    status = Open4.popen4(@command) do |@pid, stdin, stdout, stderr|
+      err, out = stderr.read.strip, stdout.read.strip
+    end
+    status.exitstatus.to_i == 0 ? run_succeeded(out) : run_failed(out, err)
+  rescue Object => e
+    run_failed('', e.to_s)
+  end
+
+  private
+
+  def run_succeeded output
+    notify :success, output
+  end
+
+  def run_failed output, error
+    notify :failure, output, error
+  end
+
+  def notify result, output, error = ''
+    notifiers.each do |notifier|
+      notifier.notify @command, result, output, error
+    end
+  end
+
+  # Instantiate and configure notifiers as per the config.
+  def notifiers
+    @config.notifiers.map do |klass_name, options|
+      require "fyi/notifiers/#{klass_name}"
+      klass = constantize "Fyi::Notifier::#{klass_name.capitalize}"
+      klass.send :new, options
+    end
+  end
+
+end

data/lib/fyi/config.rb

@@ -0,0 +1,29 @@
+class Fyi
+  class Config
+
+    def notifiers
+      config
+    end
+
+    private
+
+    def config
+      defaults = { 'log' => {} }
+      conf = YAML::load(config_file) rescue {}
+      defaults.merge(conf)
+    end
+
+    def config_file
+      File.read config_file_path
+    end
+
+    def config_file_path
+      File.join home_dir, '.fyi'
+    end
+
+    def home_dir
+      ENV['HOME']
+    end
+
+  end
+end

data/lib/fyi/core_ext.rb

@@ -0,0 +1,44 @@
+# Lifted from ActiveSupport.
+#
+# Ruby 1.9 introduces an inherit argument for Module#const_get and
+# #const_defined? and changes their default behavior.
+if Module.method(:const_get).arity == 1
+  # Tries to find a constant with the name specified in the argument string:
+  #
+  # "Module".constantize # => Module
+  # "Test::Unit".constantize # => Test::Unit
+  #
+  # The name is assumed to be the one of a top-level constant, no matter whether
+  # it starts with "::" or not. No lexical context is taken into account:
+  #
+  # C = 'outside'
+  # module M
+  # C = 'inside'
+  # C # => 'inside'
+  # "C".constantize # => 'outside', same as ::C
+  # end
+  #
+  # NameError is raised when the name is not in CamelCase or the constant is
+  # unknown.
+  def constantize(camel_cased_word)
+    names = camel_cased_word.split('::')
+    names.shift if names.empty? || names.first.empty?
+
+    constant = Object
+    names.each do |name|
+      constant = constant.const_defined?(name) ? constant.const_get(name) : constant.const_missing(name)
+    end
+    constant
+  end
+else
+  def constantize(camel_cased_word) #:nodoc:
+    names = camel_cased_word.split('::')
+    names.shift if names.empty? || names.first.empty?
+
+    constant = Object
+    names.each do |name|
+      constant = constant.const_get(name, false) || constant.const_missing(name)
+    end
+    constant
+  end
+end

data/lib/fyi/notifiers/email.rb

@@ -0,0 +1,83 @@
+require 'pony'
+
+class Fyi
+  class Notifier
+    # Emails the results of command execution via SMTP.
+    #
+    # By default only failures are emailed.
+    class Email
+
+      # Options you may supply:
+      #
+      # +from+: the from address
+      # +to+: the to address
+      # +on_success+: whether to notify when the command succeeded.
+      #   Optional.  Defaults to false.
+      # +on_failure+: whether to notify when the command failed.
+      #   Optional.  Defaults to true.
+      # +smtp+: you should supply SMTP config options under this key.
+      #
+      # SMTP config options are:
+      # +host+
+      # +port+
+      # +user+
+      # +password+
+      # +auth+
+      # +domain+
+      def initialize options
+        @from = options['from']
+        @to   = options['to']
+        @smtp = symbolize_keys options['smtp']
+        @on_success = options['on_success']
+        # Notify of failures by default.
+        @on_failure = options.has_key?('on_failure') ? options['on_failure'] : true
+      end
+
+      def notify command, result, output, error = ''
+        send_email(command, result, output, error) if should_notify?(result)
+      end
+
+      private
+
+      def should_notify?(result)
+        (result == :success && @on_success) || (result == :failure && @on_failure)
+      end
+
+      def send_email command, result, output, error
+        Pony.mail :to      => @to,
+                  :from    => @from,
+                  :subject => subject(command, result),
+                  :body    => body(command, output, error),
+                  :via     => :smtp,
+                  :smtp    => @smtp
+      end
+
+      def subject command, result
+        "[#{result.to_s.upcase}] #{truncate command}"
+      end
+
+      def body command, output, error
+        <<END
+command: #{command}
+
+stdout: #{output}
+
+stderr: #{error}
+END
+      end
+
+      def truncate string, length = 30
+        if string.length > length
+          "#{string[0..(length - 3)]}..."
+        else
+          string
+        end
+      end
+
+      def symbolize_keys hsh
+        hsh.inject({}) { |h,(k,v)| h[k.to_sym] = v; h }
+      end
+
+    end
+  end
+end

data/lib/fyi/notifiers/log.rb

@@ -0,0 +1,48 @@
+require 'logger'
+
+class Fyi
+  class Notifier
+    # Logs command execution to a file.
+    #
+    # The log level depends on the execution result: INFO if the
+    # command succeeded, WARN if it failed.
+    class Log
+      attr_reader :logger
+      
+      # Options you can supply:
+      # +file+: full path to a log file.  Defaults to +fyi.log+ in
+      # the process's home directory.
+      def initialize options
+        log_file = options['file'] || default_log_file
+        @logger = Logger.new log_file
+      end
+
+      def notify command, result, output, error = ''
+        logger.log severity(result), message(command, result, output, error)
+      end
+
+      private
+
+      def severity result
+        result == :success ? Logger::INFO : Logger::WARN
+      end
+
+      def message command, result, output, error
+        <<END
+command: #{command}
+status: #{result.to_s.upcase}
+stdout: #{output}
+stderr: #{error}
+END
+      end
+
+      def default_log_file
+        File.join home_dir, 'fyi.log'
+      end
+
+      def home_dir
+        ENV['HOME']
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: airblade-fyi
+version: !ruby/object:Gem::Version 
+  version: 0.0.3
+platform: ruby
+authors: 
+- Andy Stewart
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-08 00:00:00 -07:00
+default_executable: fyi
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: pony
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: boss@airbladesoftware.com
+executables: 
+- fyi
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- .gitignore
+- README.md
+- Rakefile
+- VERSION
+- bin/fyi
+- config_example.yml
+- fyi.gemspec
+- lib/fyi.rb
+- lib/fyi/config.rb
+- lib/fyi/core_ext.rb
+- lib/fyi/notifiers/email.rb
+- lib/fyi/notifiers/log.rb
+has_rdoc: true
+homepage: http://github.com/airblade/fyi
+licenses: 
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 2
+summary: Be informed about task execution.
+test_files: []
+