blertr 0.1.0

data/.autotest

@@ -0,0 +1,11 @@
+require 'autotest/fsevent'
+require 'autotest/growl'
+
+Autotest.add_hook :initialize do |at|
+  at.clear_mappings
+  at.add_exception(/\.git/)
+  at.add_exception(/spec\/sandbox/)
+  at.add_mapping(%r{^spec/.*_spec}) {|filename,_| at.files_matching %r{#{filename}}}
+  at.add_mapping(%r{}) {|_,_| at.files_matching %r{spec/.*_spec}}
+end
+

data/.gitignore

@@ -0,0 +1,5 @@
+.bundle/*
+update/*
+coverage/*
+*.swp
+spec/sandbox/*

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,52 @@
+PATH
+  remote: .
+  specs:
+    blertr (0.1.0)
+      twitter (~> 1.6.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.2.6)
+    diff-lcs (1.1.2)
+    faraday (0.6.1)
+      addressable (~> 2.2.4)
+      multipart-post (~> 1.1.0)
+      rack (>= 1.1.0, < 2)
+    faraday_middleware (0.6.5)
+      faraday (~> 0.6.0)
+    hashie (1.0.0)
+    multi_json (1.0.3)
+    multi_xml (0.2.2)
+    multipart-post (1.1.2)
+    rack (1.3.0)
+    rdoc (2.5.11)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+    simple_oauth (0.1.5)
+    simplecov (0.4.2)
+      simplecov-html (~> 0.4.4)
+    simplecov-html (0.4.5)
+    twitter (1.6.0)
+      faraday (~> 0.6.1)
+      faraday_middleware (~> 0.6.3)
+      hashie (~> 1.0.0)
+      multi_json (~> 1.0.0)
+      multi_xml (~> 0.2.0)
+      simple_oauth (~> 0.1.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  blertr!
+  bundler (~> 1.0)
+  rdoc (~> 2.5)
+  rspec (~> 2.3)
+  simplecov (~> 0.4)

data/bin/blert

@@ -0,0 +1,29 @@
+#!/usr/bin/env bash
+
+# Run the command, including arguments with spaces
+"$@"
+status=$?
+
+# decide which status to use
+if [ "$status" == "0" ] ; then
+    result="completed"
+else
+    result="FAILED ($status)"
+fi
+
+# decide which notifier we have
+env growlnotify -h > /dev/null 2> /dev/null
+has_growl=$?
+env notify-send > /dev/null 2> /dev/null
+has_libnotify=$?
+
+# notify the user, growl or libnotify
+if [ "$has_growl" == "0" ] ; then
+    growlnotify -m "Script '$@' $result" -n "Blert Notification"
+elif [ "$has_libnotify" == "0" ] ; then
+    notify-send "Script '$@' $result" "Blert Notification" &
+fi
+
+# exit with the original status
+exit $status
+

data/bin/blert_now

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby -W0
+
+$:.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
+
+require 'blertr'
+
+# interface between shell and ruby code
+# not meant to be called directly by user
+#
+# input from shell is the command name that ran
+# and how many seconds it ran for
+
+command_name = ARGV[0]
+command_seconds = ARGV[1].to_i
+if command_name and command_seconds
+  Blertr::Control::alert command_name, command_seconds
+else
+  puts "usage: blertr_now command time_taken"
+end
+

data/bin/blertr

@@ -0,0 +1,106 @@
+#!/usr/bin/env ruby
+
+$:.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
+
+require 'blertr'
+
+action = ARGV.shift
+parameters = ARGV
+
+def add_services services, time
+  puts services
+end
+
+def help
+  help_string = <<EOS
+-=[ Welcome to Blertr - Notifications for Bash commands ]=-
+
+Usage: blertr [command] [command parameters]
+
+Commands:
+    help       Output this help message
+
+    install    Add symlinks to your system to allow
+               Blertr to function properly
+
+    uninstall  Remove symlinks and other setup process
+               Effectively uninstalling Blertr
+    
+    info       Pass in a notifier name to get the 
+               information it is using to send notifications
+               Example: blertr info email
+
+    exclude    Pass in a shell command to prevent Blertr from
+               sending notifications when that command is 
+               executed
+               Example: blertr exclude ssh
+   
+    time       Pass in a notifier name and a time string to
+               set the time required to pass before the
+               notifier sends a message for a command
+               Example: blertr time email 5 minutes
+               This would make blertr send an email only if
+               the command executing took longer than 5 mins
+EOS
+  puts help_string
+end
+
+def take_action action, parameters
+  case action
+  when "help"
+    help
+  when "install"
+    blertr_path = File.expand_path(File.join(File.dirname(__FILE__), ".."))
+    blertr_symlink = File.expand_path("~/.blertr")
+    if File.exists? blertr_symlink
+      puts "ERROR: Blertr appears to already be installed.\nUninstall with blertr remove"
+    else
+      puts "creating symlink from #{blertr_path} to #{blertr_symlink}"
+      system("ln -s #{blertr_path} #{blertr_symlink}")
+      puts "Blertr is now (almost) installed!\nPut this at the bottom of your .bashrc file:"
+      puts "[[ -s \"$HOME/.blertr/scripts/blertr\" ]] && . \"$HOME/.blertr/scripts/blertr\""
+    end
+  when "uninstall"
+    blertr_symlink = File.expand_path("~/.blertr")
+    if File.exists? blertr_symlink
+      puts "Removing ~/.blertr"
+      system("rm #{blertr_symlink}")
+      puts "Blertr is now (almost) uninstalled.\nRemove from .bashrc file:"
+      puts "[[ -s \"$HOME/.blertr/scripts/blertr\" ]] && . \"$HOME/.blertr/scripts/blertr\""
+    else
+      puts "ERROR: it doesn't look like Blertr is installed"
+    end
+  when "info"
+    puts "getting info"
+  when "status"
+    puts "getting status"
+  when "exclude"
+    name = parameters.join(" ")
+    puts "Excluding #{name} from Blertr alerts"
+    Blertr::Blacklist.new.add(name)
+  when "time"
+    notifier_found = false
+    notifiers = parameters.shift.split(",")
+    notifiers.each do |notifier|
+      if Blertr::Control::is_notifier? notifier
+        notifier_found = true
+        new_time = parameters.join(" ")
+        Blertr::Control::change_time notifier, new_time
+      end
+    end
+
+    if !notifier_found
+      puts "Sorry, #{action} isn't a notifier."
+      puts "Use blertr status for a list of all notifiers"
+    end
+  else
+      puts "Sorry, #{action} isn't a recognized command"
+      puts "use blertr help to get a list of availible commands."
+  end
+end
+
+if action
+  take_action action.downcase, parameters
+else
+  puts "usage blertr [command] [command parameters]"
+end

data/blertr.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/blertr/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.add_development_dependency "bundler", "~> 1.0"
+  s.add_development_dependency "rdoc", "~> 2.5"
+  s.add_development_dependency "rspec", "~> 2.3"
+  s.add_development_dependency "simplecov", "~> 0.4"
+  s.add_dependency "twitter", "~> 1.6.0"
+  s.authors = ['Jim Vallandingham']
+  s.description = %q{Bash Alerts: alerts for when bash scripts and commands complete}
+  s.email = 'vvv@gmail.com'
+  s.executables = `git ls-files -- bin/*`.split("\n").map{|f| File.basename(f)}
+  s.extra_rdoc_files = ['LICENSE.textile', 'README.textile']
+  s.files = `git ls-files`.split("\n")
+  s.homepage = 'http://github.com/vlandham/blertr'
+  s.name = 'blertr'
+  s.rdoc_options = ['--charset=UTF-8']
+  s.require_paths = ['lib']
+  s.required_rubygems_version = Gem::Requirement.new('>= 1.3.6')
+  s.summary = s.description
+  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.version = Blertr::VERSION.dup
+end
+

data/config/blacklist.yaml

@@ -0,0 +1,6 @@
+--- 
+- autotest
+- ssh
+- git diff
+- irb
+- man

data/config/growl_config.yaml

@@ -0,0 +1 @@
+time: 6

data/config/mail_config.yaml

@@ -0,0 +1,5 @@
+--- 
+:username: blertr.app
+:password: The.blert$
+:to: vlandham@gmail.com
+:time: 300

data/lib/blertr/blacklist.rb

@@ -0,0 +1,58 @@
+require 'fileutils'
+
+module Blertr
+  class Blacklist
+    attr_accessor :path, :list
+
+    def self.path
+      File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "config", "blacklist.yaml"))
+    end
+
+    def initialize path = Blacklist::path
+      @path = path
+      @list = []
+      if !File.exists?(@path)
+        create
+      end
+      yaml_data = YAML::load(open(@path))
+      @list = yaml_data.to_a if yaml_data
+    end
+
+    def add name
+      @list << conform(name)
+      save @list
+    end
+
+    def conform name
+      name.downcase.strip
+    end
+
+    def blacklisted? command
+      rtn = false
+      @list.each do |name|
+        if command =~ /^#{name}/
+          rtn = true
+          return rtn
+        end
+      end
+      rtn
+    end
+
+    def clear
+      if File.exists? @path
+        FileUtils.rm(@path)
+      end
+    end
+
+    def save new_list
+      File.open(@path, 'w') do |file|
+        file.puts(YAML::dump(new_list))
+      end
+    end
+
+    def create
+      system("touch #{@path}")
+    end
+  end
+
+end

data/lib/blertr/control.rb

@@ -0,0 +1,68 @@
+require 'blertr/message'
+require 'blertr/mail_notifier'
+require 'blertr/growl_notifier'
+require 'blertr/twitter_notifier'
+require 'blertr/time_parser'
+require 'blertr/blacklist.rb'
+
+module Blertr
+  class Control
+    # Sends out alert from each notifier if
+    # time passed is long enough
+    def self.alert command_name, command_time
+      blacklist = Blacklist.new
+      if !blacklist.blacklisted?(command_name)
+        message = Message.new(command_name, command_time)
+        notifiers.each do |notifier|
+          if notifier.will_alert?(message.command, message.seconds)
+            fork do
+              begin
+                notifier.alert message
+              rescue
+                puts "problem with #{notifier.name} alert"
+              end
+              exit
+            end
+          end
+        end
+      end
+    end
+
+    def self.notifiers
+      noters = []
+      noters << MailNotifier.new
+      noters << GrowlNotifier.new
+      noters << TwitterNotifier.new
+      noters
+    end
+
+    def self.notifier_with_name name
+      notifiers.each do |notifier|
+        if name == notifier.name
+          return notifier
+        end
+        if notifier.names.include? name
+          return notifier
+        end
+      end
+      nil
+    end
+
+    def self.is_notifier? name
+      notifier_with_name(name) != nil
+    end
+
+    def self.change_time name, time_string
+      time_seconds = TimeParser::to_seconds time_string
+      if time_seconds.nil?
+        puts "ERROR: not valid time: #{time_string}"
+      else
+        notifier = notifier_with_name name
+        if notifier
+          puts "setting #{name} to alert after #{time_seconds} seconds"
+          notifier.set_time time_seconds
+        end
+      end
+    end
+  end
+end

data/lib/blertr/growl_notifier.rb

@@ -0,0 +1,20 @@
+require 'blertr/notifier'
+
+module Blertr
+  class GrowlNotifier < Notifier
+    def initialize
+      super
+      @names = ["growl"]
+    end
+
+    def alert message
+      #TODO: look to supporting other growl frameworks on other OSs
+      system("growlnotify -n \"Terminal\" -m \"took #{message.time_string}\" \"#{message.command}\"")
+    end
+
+    def can_alert?
+      results = %x[which growlnotify]
+      !results.nil? and !results.empty?
+    end
+  end
+end

data/lib/blertr/mail_notifier.rb

@@ -0,0 +1,37 @@
+require 'blertr/notifier'
+require 'net/smtp'
+
+module Blertr
+  class MailNotifier < Notifier
+    def initialize
+      super
+      @names = ["mail", "email"]
+    end
+
+    def alert message
+      username = options[:username]
+      password = options[:password]
+      receiver = options[:to]
+      msg = create_message(message)
+      smtp = Net::SMTP.new 'smtp.gmail.com', 587
+      smtp.enable_starttls
+      smtp.start('gmail.com', username, password, :login) do
+        smtp.send_message(msg, "#{username}@gmail.com", receiver)
+      end
+    end
+
+    def create_message message
+      msg = "Subject: #{message.command_short_name} is done!\n"
+      msg += "#{message.command_short_name} has completed.\nCommand: #{message.command}\nTime: #{message.time_string}\n"
+      msg
+    end
+
+    def can_alert?
+      rtn = true
+      rtn &= options[:username]
+      rtn &= options[:password]
+      rtn &= options[:to]
+      rtn
+    end
+  end
+end

data/lib/blertr/message.rb

@@ -0,0 +1,40 @@
+module Blertr
+  class Message
+    SECS_IN_MIN = 60
+    MIN_IN_HOUR = 60
+    SEC_RANGE = (2..59)
+    ONE_MIN_RANGE = (60..119)
+    MINS_RANGE = (120..(SECS_IN_MIN * MIN_IN_HOUR - 1))
+    attr_accessor :command, :seconds
+
+    def initialize command, time
+      self.command = command.strip
+      self.seconds = time.to_i
+    end
+
+    def command_short_name
+      self.command.split(/ /)[0]
+    end
+
+    def time_string
+      case seconds
+      when 1
+        "1 second"
+      when 0, SEC_RANGE
+        "#{seconds} seconds"
+      when ONE_MIN_RANGE
+        "1 minute"
+      when MINS_RANGE
+        mins = seconds / SECS_IN_MIN
+        "#{mins} minutes"
+      else
+        hours = (seconds.to_f / SECS_IN_MIN.to_f / MIN_IN_HOUR.to_f).round(2)
+        if hours == 1.0
+          "1 hour"
+        else
+          "#{hours} hours"
+        end
+      end
+    end
+  end
+end

data/lib/blertr/notifier.rb

@@ -0,0 +1,50 @@
+require 'yaml'
+require 'blertr/options'
+
+module Blertr
+  class Notifier
+    attr_reader :names
+    def initialize
+      @names = []
+    end
+
+    def name
+      (!@names or @names.empty?) ? nil : @names[0]
+    end
+
+    def options
+      @options ||= Options::options_for name
+      @options
+    end
+
+    def set_time new_time
+      opts = options
+      opts[:time] = new_time
+      Options::save_options_for name, opts
+    end
+
+    def will_alert? name, time
+      rtn = self.can_alert?
+      if rtn
+        rtn = in_time_window? time
+      end
+      rtn
+    end
+
+    def alert message
+    end
+
+    def in_time_window? time
+      rtn = false
+      time_min = options[:time]
+      if time_min and time >= time_min
+        rtn = true
+      end
+      rtn
+    end
+
+    def can_alert?
+      false
+    end
+  end
+end

data/lib/blertr/options.rb

@@ -0,0 +1,42 @@
+require 'fileutils'
+
+module Blertr
+  class Options
+    def self.options_for name
+      rtn = {}
+      if File.exists? config_file_for(name)
+        yaml_data = YAML::load(open(config_file_for(name)))
+        if yaml_data
+          rtn = Hash[yaml_data.map {|k,v| [k.to_sym, v]}]
+        end
+      end
+      rtn
+    end
+
+    def self.save_options_for name, new_options
+      file = config_file_for name
+      File.open(file, 'w') do |file|
+        file.puts(YAML::dump(new_options))
+      end
+    end
+
+    def self.remove_optons_for name
+      file = config_file_for name
+      if File.exists? file
+        FileUtils.rm(file)
+      end
+    end
+
+    def self.config_path
+      File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "config"))
+    end
+
+    def self.config_file_for name
+      if name
+        File.join(config_path, "#{name}_config.yaml")
+      else
+        ""
+      end
+    end
+  end
+end

data/lib/blertr/time_parser.rb

@@ -0,0 +1,37 @@
+module Blertr
+  class TimeParser
+    SECONDS_IN_MIN = 60
+    SECONDS_IN_HOUR = 3600
+    SECONDS_IN_DAY = 86400
+
+    def self.to_seconds time_string
+      time_seconds = 0
+      if time_string =~ /^(\d+)$/
+        # only digits. assume seconds
+        time_seconds = $1.to_i
+      elsif time_string =~ /^(\d+)\s+(\w+)$/
+        # digits and words
+        digits = $1.to_i
+        mult = convert_word $2
+        time_seconds = digits * mult
+      end
+      time_seconds = time_seconds > 0 ? time_seconds : nil
+
+      time_seconds
+    end
+
+    def self.convert_word input_word
+      multiplier = 1
+      if input_word =~ /^s/
+        multiplier = 1
+      elsif input_word =~ /^m/
+        multiplier = SECONDS_IN_MIN
+      elsif input_word =~ /^(h|hour|hr)/
+        multiplier = SECONDS_IN_HOUR
+      elsif input_word =~ /^d/
+        multiplier = SECONDS_IN_DAY
+      end
+      multiplier
+    end
+  end
+end

data/lib/blertr/twitter_notifier.rb

@@ -0,0 +1,42 @@
+
+require 'blertr/notifier'
+
+module Blertr
+  class TwitterNotifier < Notifier
+    def initialize
+      super
+      @names = ["twitter", "tweet", "twit"]
+    end
+
+    def alert message
+      Twitter.configure do |config|
+        config.consumer_key = options[:consumer_key]
+        config.consumer_secret = options[:consumer_secret]
+        config.oauth_token = options[:oauth_token]
+        config.oauth_token_secret = options[:oauth_token_secret]
+      end
+      msg = message message.command_short_name, command.time_string
+      Twitter.update(msg)
+    end
+
+    def message name, time
+      user = options[:to].nil? ? "" : "@#{options[:to]}"
+      msg = "#{user} #{name} is done! Took #{time}"
+      msg
+    end
+
+    def can_alert?
+      rtn = true
+      begin
+        require 'rubygems'
+        require 'twitter'
+      rescue LoadError => e
+        rtn = false
+      end
+      if rtn
+        [:consumer_key, :consumer_secret, :oauth_token, :oauth_token_secret].each { |key| rtn &= options[key]}
+      end
+      rtn
+    end
+  end
+end

data/lib/blertr/version.rb

@@ -0,0 +1,3 @@
+module Blertr
+  VERSION = "0.1.0".freeze
+end