blertr 0.1.0

data/lib/blertr.rb

@@ -0,0 +1,2 @@
+
+require 'blertr/control'

data/scripts/blertr

@@ -0,0 +1,52 @@
+#!/usr/bin/env bash
+
+export HOME="${HOME%%+(\/)}" # Remove trailing slashes if they exist on HOME
+
+if [[ -z "${blertr_path:-}" ]]
+then
+
+  if [[ -z "${blertr_prefix:-}" ]]
+  then
+    true ${blertr_user_install_flag:=0}
+    if (( UID > 0 || blertr_user_install_flag == 1 ))
+    then
+      blertr_prefix="$HOME"
+    else
+      blertr_prefix="/usr/local"
+    fi
+  fi
+
+  if [[ -z "${blertr_path:-}" ]]
+  then
+    if [[ "$blertr_prefix" = "$HOME" ]]
+    then
+      blertr_path="${blertr_prefix}/.blertr"
+    else
+      blertr_path="${blertr_prefix}/blertr"
+    fi
+  fi
+
+  export blertr_path="${blertr_path%%+(\/)}"
+  true ${blertr_bin_path:="$blertr_path/bin"}
+  export blertr_bin_path="${blertr_bin_path%%+(\/)}"
+fi
+
+if [[ -n "${blertr_path}" && -d "$blertr_path" ]]
+then
+  true ${blertr_scripts_path:="$blertr_path/scripts"}
+
+  for script in preexec cli
+  do
+    if [[ -f "$blertr_scripts_path/$script" ]]
+    then
+      source "$blertr_scripts_path/$script"
+    else
+      printf "WARNING:
+      Could not source '$blertr_scripts_path/$script' as file does not exist.
+      Blertr will likely not work as expected.\n"
+    fi
+  done
+fi
+
+
+

data/scripts/cli

@@ -0,0 +1,28 @@
+#!/usr/bin/env bash
+
+# called before each command and starts stopwatch
+function preexec () {
+	export PREEXEC_CMD="$BASH_COMMAND"
+	export PREEXEC_TIME=$(date +'%s')
+}
+
+# called after each command, stops stopwatch
+# and notifies if time elpsed exceeds threshold
+function precmd () {
+	stop=$(date +'%s')
+	start=${PREEXEC_TIME:-$stop}
+	let elapsed=$stop-$start
+	min=${PREEXEC_MIN:-5}
+
+  if [ $elapsed -gt $min ]; 
+  then
+    if [[ -f "$blertr_bin_path/blert_now" ]]
+    then
+      $blertr_bin_path/blert_now "${PREEXEC_CMD:-Terminal Command}" $elapsed
+    fi
+  fi
+  unset PREEXEC_TIME
+}
+
+preexec_install
+

data/scripts/preexec

@@ -0,0 +1,196 @@
+#!/bin/bash
+
+# preexec.bash -- Bash support for ZSH-like 'preexec' and 'precmd' functions.
+
+# The 'preexec' function is executed before each interactive command is
+# executed, with the interactive command as its argument.  The 'precmd'
+# function is executed before each prompt is displayed.
+
+# To use, in order:
+
+#  1. source this file
+#  2. define 'preexec' and/or 'precmd' functions (AFTER sourcing this file),
+#  3. as near as possible to the end of your shell setup, run 'preexec_install'
+#     to kick everything off.
+
+# Note: this module requires 2 bash features which you must not otherwise be
+# using: the "DEBUG" trap, and the "PROMPT_COMMAND" variable.  preexec_install
+# will override these and if you override one or the other this _will_ break.
+
+# This is known to support bash3, as well as *mostly* support bash2.05b.  It
+# has been tested with the default shells on MacOS X 10.4 "Tiger", Ubuntu 5.10
+# "Breezy Badger", Ubuntu 6.06 "Dapper Drake", and Ubuntu 6.10 "Edgy Eft".
+
+
+# Copy screen-run variables from the remote host, if they're available.
+
+if [[ "$SCREEN_RUN_HOST" == "" ]]
+then
+    SCREEN_RUN_HOST="$LC_SCREEN_RUN_HOST"
+    SCREEN_RUN_USER="$LC_SCREEN_RUN_USER"
+fi
+
+# This variable describes whether we are currently in "interactive mode";
+# i.e. whether this shell has just executed a prompt and is waiting for user
+# input.  It documents whether the current command invoked by the trace hook is
+# run interactively by the user; it's set immediately after the prompt hook,
+# and unset as soon as the trace hook is run.
+preexec_interactive_mode=""
+
+# Default do-nothing implementation of preexec.
+function preexec () {
+    true
+}
+
+# Default do-nothing implementation of precmd.
+function precmd () {
+    true
+}
+
+# This function is installed as the PROMPT_COMMAND; it is invoked before each
+# interactive prompt display.  It sets a variable to indicate that the prompt
+# was just displayed, to allow the DEBUG trap, below, to know that the next
+# command is likely interactive.
+function preexec_invoke_cmd () {
+    precmd
+    preexec_interactive_mode="yes"
+}
+
+# This function is installed as the DEBUG trap.  It is invoked before each
+# interactive prompt display.  Its purpose is to inspect the current
+# environment to attempt to detect if the current command is being invoked
+# interactively, and invoke 'preexec' if so.
+function preexec_invoke_exec () {
+    if [[ -n "$COMP_LINE" ]]
+    then
+        # We're in the middle of a completer.  This obviously can't be
+        # an interactively issued command.
+        return
+    fi
+    if [[ -z "$preexec_interactive_mode" ]]
+    then
+        # We're doing something related to displaying the prompt.  Let the
+        # prompt set the title instead of me.
+        return
+    else
+        # If we're in a subshell, then the prompt won't be re-displayed to put
+        # us back into interactive mode, so let's not set the variable back.
+        # In other words, if you have a subshell like
+        #   (sleep 1; sleep 2)
+        # You want to see the 'sleep 2' as a set_command_title as well.
+        if [[ 0 -eq "$BASH_SUBSHELL" ]]
+        then
+            preexec_interactive_mode=""
+        fi
+    fi
+    if [[ "preexec_invoke_cmd" == "$BASH_COMMAND" ]]
+    then
+        # Sadly, there's no cleaner way to detect two prompts being displayed
+        # one after another.  This makes it important that PROMPT_COMMAND
+        # remain set _exactly_ as below in preexec_install.  Let's switch back
+        # out of interactive mode and not trace any of the commands run in
+        # precmd.
+
+        # Given their buggy interaction between BASH_COMMAND and debug traps,
+        # versions of bash prior to 3.1 can't detect this at all.
+        preexec_interactive_mode=""
+        return
+    fi
+
+    # In more recent versions of bash, this could be set via the "BASH_COMMAND"
+    # variable, but using history here is better in some ways: for example, "ps
+    # auxf | less" will show up with both sides of the pipe if we use history,
+    # but only as "ps auxf" if not.
+    local this_command=`history 1 | sed -e "s/^[ ]*[0-9]*[ ]*//g"`;
+
+    # If none of the previous checks have earlied out of this function, then
+    # the command is in fact interactive and we should invoke the user's
+    # preexec hook with the running command as an argument.
+    preexec "$this_command"
+}
+
+# Execute this to set up preexec and precmd execution.
+function preexec_install () {
+
+    # *BOTH* of these options need to be set for the DEBUG trap to be invoked
+    # in ( ) subshells.  This smells like a bug in bash to me.  The null stderr
+    # redirections are to quiet errors on bash2.05 (i.e. OSX's default shell)
+    # where the options can't be set, and it's impossible to inherit the trap
+    # into subshells.
+
+    set -o functrace > /dev/null 2>&1
+    shopt -s extdebug > /dev/null 2>&1
+
+    # Finally, install the actual traps.
+    PROMPT_COMMAND=preexec_invoke_cmd
+    trap 'preexec_invoke_exec' DEBUG
+}
+
+# Since this is the reason that 99% of everybody is going to bother with a
+# pre-exec hook anyway, we'll include it in this module.
+
+# Change the title of the xterm.
+function preexec_xterm_title () {
+    local title="$1"
+    echo -ne "\e]0;$title\007"
+}
+
+function preexec_screen_title () {
+    local title="$1"
+    echo -ne "\ek$1\e\\"
+}
+
+# Abbreviate the "user@host" string as much as possible to preserve space in
+# screen titles.  Elide the host if the host is the same, elide the user if the
+# user is the same.
+function preexec_screen_user_at_host () {
+    local RESULT=""
+    if [[ "$SCREEN_RUN_HOST" == "$SCREEN_HOST" ]]
+    then
+        return
+    else
+        if [[ "$SCREEN_RUN_USER" == "$USER" ]]
+        then
+            echo -n "@${SCREEN_HOST}"
+        else
+            echo -n "${USER}@${SCREEN_HOST}"
+        fi
+    fi
+}
+
+function preexec_xterm_title_install () {
+    # These functions are defined here because they only make sense with the
+    # preexec_install below.
+    function precmd () {
+        preexec_xterm_title "${TERM} - ${USER}@${SCREEN_HOST} `dirs -0` $PROMPTCHAR"
+        if [[ "$TERM" == screen ]]
+        then
+            preexec_screen_title "`preexec_screen_user_at_host`${PROMPTCHAR}"
+        fi
+    }
+
+    function preexec () {
+        preexec_xterm_title "${TERM} - $1 {`dirs -0`} (${USER}@${SCREEN_HOST})"
+        if [[ $TERM == screen ]]
+        then
+            local cutit="$1"
+            local cmdtitle=`echo "$cutit" | cut -d " " -f 1`
+            if [[ "$cmdtitle" == "exec" ]]
+            then
+                local cmdtitle=`echo "$cutit" | cut -d " " -f 2`
+            fi
+            if [[ "$cmdtitle" == "screen" ]]
+            then
+                # Since stacked screens are quite common, it would be nice to
+                # just display them as '$$'.
+                local cmdtitle="${PROMPTCHAR}"
+            else
+                local cmdtitle=":$cmdtitle"
+            fi
+            preexec_screen_title "`preexec_screen_user_at_host`${PROMPTCHAR}$cmdtitle"
+        fi
+    }
+
+    preexec_install
+}
+

data/spec/blacklist_spec.rb

@@ -0,0 +1,68 @@
+
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Blertr::Blacklist do
+  before(:each) do
+    @blacklist_path = File.expand_path(destination_root + "/blacklist.yaml")
+    @blacklist = Blertr::Blacklist.new(@blacklist_path)
+  end
+
+  after(:each) do
+    @blacklist.clear
+  end
+
+  it "should load blank blacklist" do
+    blacklist_path = File.expand_path(destination_root + "/fakelist.yaml")
+    blacklist = Blertr::Blacklist.new(blacklist_path)
+    blacklist.list.should == []
+  end
+
+  it "should add name" do
+    name = "git"
+    @blacklist.add name
+    @blacklist.list.should == [name]
+    another_name = "ssh"
+    @blacklist.add another_name
+    @blacklist.list.should == [name,another_name]
+  end
+
+  it "should store names" do
+    name = "git"
+    @blacklist.add name
+    another_name = "ssh"
+    @blacklist.add another_name
+    another_blacklist = Blertr::Blacklist.new(@blacklist_path)
+    another_blacklist.list.should == [name, another_name]
+  end
+
+  it "should indicate blocked programs" do
+    names = ["git", "ssh", "once_over" "dadada"]
+    not_blocked = ["cp", "ssl", "screen", "mv"]
+    blacklist_path = File.expand_path(destination_root + "/blacklist.yaml")
+    blacklist = Blertr::Blacklist.new(blacklist_path)
+    names.each do |name|
+      blacklist.add name
+      blacklist.blacklisted?(name).should == true
+      not_blocked.each {|np| blacklist.blacklisted?(np).should == false}
+    end
+    blacklist.clear
+  end
+
+  it "should handle full commands" do
+    commands = [["git diff","git diff"], ["ssh", "ssh 123@123.com"], ["cp", "cp /ma/da ./da/ma"]]
+
+    commands.each do |name, command|
+      @blacklist.add name
+      @blacklist.blacklisted?(command).should == true
+    end
+  end
+
+  it "should not exclude similar commands" do
+    commands = [["git diff","git diff", "git log"], ["ssh", "ssh 123@123.com", "scp 123@123.com"], ["cp", "cp /ma/da ./da/ma"]]
+    commands.each do |name, command, similar_command|
+      @blacklist.add name
+      @blacklist.blacklisted?(command).should == true
+      @blacklist.blacklisted?(similar_command).should == false
+    end
+  end
+end

data/spec/control_spec.rb

@@ -0,0 +1,39 @@
+
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Blertr::Control do
+  before(:each) do
+  end
+
+  it "should load notifiers" do
+    Blertr::Control::notifiers.empty?.should_not == true
+    notifier_names = Blertr::Control::notifiers.collect {|n| n.name}
+    notifier_names.include?('mail').should == true
+    notifier_names.include?(nil).should == false
+  end
+
+  it "should distinguish notifier names" do
+    notifier_names = Blertr::Control::notifiers.collect {|n| n.name}
+    notifier_names.each {|name| Blertr::Control::is_notifier?(name).should == true}
+  end
+
+  it "should distinguish bad notifier names" do
+    bad_names = ["asdf", 123, nil, "DdDdDd"]
+    bad_names.each {|name| Blertr::Control::is_notifier?(name).should == false}
+  end
+
+  it "should distinguish alias names" do
+    alias_names = ["mail", "tweet"]
+    alias_names.each {|name| Blertr::Control::is_notifier?(name).should == true}
+  end
+
+  it "should get notifier with name" do
+    notifier = Blertr::Control::notifier_with_name 'mail'
+    notifier.name.should == 'mail'
+  end
+
+  it "should return nil for invalid notifier" do
+    notifier = Blertr::Control::notifier_with_name 'caterall'
+    notifier.should == nil
+  end
+end

data/spec/growl_notifier_spec.rb

@@ -0,0 +1,18 @@
+
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'blertr/growl_notifier'
+
+describe Blertr::GrowlNotifier do
+  before(:each) do
+    @notifier = Blertr::GrowlNotifier.new
+  end
+
+  it "should have a name" do
+    @notifier.name.should == "growl"
+  end
+
+  it "should be able to alert" do
+    #TODO: fix to be only true if growl_notify is installed
+    @notifier.can_alert?.should == true
+  end
+end

data/spec/mail_notifier_spec.rb

@@ -0,0 +1,48 @@
+
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'blertr/mail_notifier'
+
+
+describe Blertr::MailNotifier do
+  before(:each) do
+    @notifier = Blertr::MailNotifier.new
+  end
+
+  it "should have a name" do
+    @notifier.name.should == "mail"
+  end
+
+  it "should have aliases" do
+    @notifier.names.include?("mail").should == true
+  end
+
+  it "should have options" do
+    @notifier.options.empty?.should == false
+    @notifier.options[:username].class.should == String
+    @notifier.options[:time].class.should == Fixnum
+  end
+
+  it "should be capable of alerting" do
+    @notifier.can_alert?.should == true
+  end
+
+  it "should alert if time is in range" do
+    @notifier.options[:time] = 20
+    @notifier.will_alert?("name", 21).should == true
+    @notifier.will_alert?("name", 19).should == false
+    @notifier.options[:time] = 19
+    @notifier.will_alert?("name", 19).should == true
+    @notifier.will_alert?("name", 20000).should == true
+    @notifier.options[:time] = 20001
+    @notifier.will_alert?("name", 20000).should == false
+  end
+
+  it "should save new time" do
+    old_time = @notifier.options[:time]
+    new_time = old_time + 100
+    @notifier.set_time new_time
+    @notifier.options[:time].should == new_time
+    @notifier.set_time old_time
+    @notifier.options[:time].should == old_time
+  end
+end

data/spec/message_spec.rb

@@ -0,0 +1,63 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Blertr::Message do
+  describe "basic functionality" do
+    before(:each) do
+      @command = "cp -r ./ddd/aaa /aaa/ddd"
+      @short_name = "cp"
+      @seconds = 240
+      @message = Blertr::Message.new(@command, @seconds)
+    end
+
+    it "should output command name" do
+      @message.command.should == @command
+    end
+
+    it "should output time in seconds" do
+      @message.seconds.should == @seconds
+    end
+
+    it "should output command short name" do
+      @message.command_short_name.should == @short_name
+    end
+  end
+  describe "time string" do
+    before(:each) do
+      @command = "cp -r ./ddd/aaa /aaa/ddd"
+      @short_name = "cp"
+      @message = Blertr::Message.new(@command, 0)
+      @one_min = 60
+      @min_per_hour = 60
+    end
+
+    it "should describe time in seconds" do
+      [0, 10, 20, 35, 45, 55, 59].each do |seconds|
+        @message.seconds = seconds
+        @message.time_string.should == "#{seconds} seconds"
+      end
+      @message.seconds = 1
+      @message.time_string.should == "1 second"
+    end
+
+    it "should describe time in minutes" do
+      @message.seconds = 60
+      @message.time_string.should == "1 minute"
+      (2..59).each do |min|
+        seconds = min * @one_min
+        @message.seconds = seconds
+        @message.time_string.should == "#{min} minutes"
+      end
+    end
+
+    it "should describe time in hours" do
+      hour = 60 * 60
+      @message.seconds = hour
+      @message.time_string.should == "1 hour"
+      (2..59).each do |hour|
+        seconds = hour * @one_min * @min_per_hour
+        @message.seconds = seconds
+        @message.time_string.should == "#{hour.to_f} hours"
+      end
+    end
+  end
+end

data/spec/notifier_spec.rb

@@ -0,0 +1,26 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'blertr/notifier'
+
+describe Blertr::Notifier do
+  before(:each) do
+    @notifier = Blertr::Notifier.new
+  end
+
+  it "should have no default name" do
+    @notifier.name.should == nil
+  end
+
+
+  it "should not have any options" do
+    @notifier.options.empty?.should == true
+  end
+
+  it "should not be able to alert" do
+    @notifier.can_alert?.should == false
+  end
+
+  it "should not alert by default" do
+    @notifier.will_alert?("name", 233).should == false
+  end
+
+end

data/spec/options_spec.rb

@@ -0,0 +1,44 @@
+
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'blertr/options'
+
+describe Blertr::Options do
+  before(:each) do
+    @mail_options = Blertr::Options::options_for("mail")
+  end
+
+  it "should get options given name" do
+    @mail_options.class.should == Hash
+    @mail_options.empty?.should_not == true
+    @mail_options[:username].should_not == nil
+  end
+
+  it "should have a valid config path and files" do
+    config_file = Blertr::Options::config_file_for("mail")
+    config_path = Blertr::Options::config_path
+    File.exists?(config_file).should == true
+    File.directory?(config_path).should == true
+    config_files = Dir.glob(File.join(config_path, "*_config.yaml"))
+    config_files.empty?.should == false
+  end
+
+  it "should be blank for missing notifiers" do
+    Blertr::Options::remove_optons_for "missing"
+    missing_options = Blertr::Options::options_for("missing")
+    missing_options.empty?.should == true
+  end
+
+  it "should create for new notifiers" do
+    missing_options = Blertr::Options::options_for("missing")
+    missing_options.empty?.should == true
+
+    missing_options[:time] = 123
+    missing_options[:status] = "help"
+    Blertr::Options::save_options_for "missing", missing_options
+
+    not_missing_options = Blertr::Options::options_for("missing")
+    not_missing_options.empty?.should == false
+
+    Blertr::Options::remove_optons_for "missing"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,43 @@
+$TESTING=true
+
+require 'simplecov'
+SimpleCov.start do
+  add_group 'Libraries', 'lib'
+  add_group 'Specs', 'spec'
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
+require 'blertr'
+require 'stringio'
+
+require 'rdoc'
+require 'rspec'
+
+# Load fixtures
+#load File.join(File.dirname(__FILE__), "fixtures", "simple_pipeline.rb")
+
+RSpec.configure do |config|
+  def capture(stream)
+    begin
+      stream = stream.to_s
+      eval "$#{stream} = StringIO.new"
+      yield
+      result = eval("$#{stream}").string
+    ensure
+      eval("$#{stream} = #{stream.upcase}")
+    end
+
+    result
+  end
+
+  def source_root
+    File.join(File.dirname(__FILE__), 'fixtures')
+  end
+
+  def destination_root
+    File.join(File.dirname(__FILE__), 'sandbox')
+  end
+
+  alias :silence :capture
+end
+

data/spec/time_parser_spec.rb

@@ -0,0 +1,32 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Blertr::TimeParser do
+  before(:each) do
+  end
+
+  it "should convert time words" do
+    ["seconds", "second", "sec", "secs", "s"].each do |sec_word|
+      Blertr::TimeParser.convert_word(sec_word).should == 1
+    end
+
+    ["min", "mins", "minutes", "minute", "m"].each do |min_word|
+      Blertr::TimeParser.convert_word(min_word).should == 60
+    end
+
+    ["h", "hrs", "hours", "hour"].each do |hr_word|
+      Blertr::TimeParser.convert_word(hr_word).should == (60 * 60)
+    end
+
+    ["d", "days", "day"].each do |day_word|
+      Blertr::TimeParser.convert_word(day_word).should == (60 * 60 * 24)
+    end
+  end
+
+  it "should convert to seconds" do
+    conversions = [["1 day", (60*60*24)], ["123", 123], ["2 mins", 120],
+                   ["36 hours", (60*60*36)], ["1 second", 1], ["5 minutes", (60*5)]]
+    conversions.each do |string, seconds|
+      Blertr::TimeParser.to_seconds(string).should == seconds
+    end
+  end
+end