blertr 0.2.6 → 0.2.7

data/bin/blertr

@@ -2,180 +2,10 @@
 
 $:.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
 
-require 'blertr'
+require 'blertr/bin'
 
-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
-
-    upgrade    Updates current copy of blertr to latest version
-    
-    info       Pass in a notifier name to get the 
-               information it is using to send notifications
-               Example: blertr info email
-
-    status     For each notifier, Blertr lists if it currently can
-               send notifications and then lists any error messages
-               if it cannot. Useful for debuggin problems with notifiers
-
-    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
-
-    set        Pass in the notifier name, a configuration key, and
-               a value. Blertr will add this key / value to the 
-               notifiers config file.
-               Example: blertr set mail to user@gmail.com
-EOS
-  puts help_string
-end
-
-def take_action action, parameters
-  blertr_path = File.expand_path(File.join(File.dirname(__FILE__), ".."))
-  blertr_local_dir = File.expand_path("~/.blertr")
-  blertr_symlink = File.join(blertr_local_dir, "app")
-  case action
-  when "help"
-    help
-  when "install"
-    if File.exists? blertr_symlink
-      puts "ERROR: Blertr appears to already be installed.\nUninstall with blertr uninstall"
-    else
-      puts "creating #{blertr_local_dir} directory"
-      system("mkdir -p #{blertr_local_dir}")
-
-      puts "creating symlink from #{blertr_path} to #{blertr_symlink}"
-      system("ln -s #{blertr_path} #{blertr_symlink}")
-
-      config_dir = File.expand_path(Blertr::CONFIG_DIR_PATH)
-      if !File.exists?(config_dir)
-        blertr_config_dir = File.expand_path(File.join(File.dirname(__FILE__), "..", "config"))
-        puts "copying config files to #{blertr_path}"
-        system("cp -r #{blertr_config_dir} #{blertr_local_dir}")
-      end
-      puts "Blertr is now (almost) installed!\nPut this at the bottom of your .bashrc file:"
-      puts "[[ -s \"$HOME/.blertr/app/scripts/blertr\" ]] && . \"$HOME/.blertr/app/scripts/blertr\""
-    end
-  when "uninstall"
-    if File.exists? blertr_symlink
-      puts "Removing #{blertr_symlink}"
-      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 "upgrade"
-    commands = ["gem install blertr", "blertr uninstall", "blertr install"]
-    puts "Right now the upgrade process is very basic. Blertr will run:"
-    commands.each {|c| puts "$ #{c}"}
-    puts "This assumes that blertr is installed using rvm and doesn't require"
-    puts " sudo access."
-    puts "That ok? (y/n)"
-    response = gets
-    if ["y","Y","yes","Yes","YES"].include?(response.chomp)
-      puts "Ok, running commands now."
-      commands.each {|c| system(c)}
-    else
-      puts "You're the boss, exiting now."
-    end
-  when "info"
-    raw_name = parameters.shift
-    if Blertr::Control::is_notifier? raw_name
-      name = Blertr::Control::notifier_with_name(raw_name).name
-      info_hash = Blertr::Options.options_for name
-      puts "Configuration for: #{name}"
-      if info_hash.empty?
-        puts "No configuration file for #{name} or config file is empty"
-      else
-        info_hash.each do |key,value|
-          puts "#{key}: #{value}"
-        end
-      end
-    else
-      if !raw_name or (raw_name and raw_name.empty?)
-        puts "info requires the name of a notifier"
-      else
-        puts "Sorry, #{raw_name} is not a notifier"
-      end
-    end
-  when "status"
-    Blertr::Control::notifiers.each do |notifier|
-      notify_message = notifier.can_alert? ? "can alert" : "cannot alert"
-      puts "#{notifier.name}: #{notify_message}"
-      if !notifier.error_messages.empty?
-        notifier.error_messages.each {|err| puts "  #{err}"}
-      end
-    end
-  when "exclude"
-    name = parameters.join(" ")
-    puts "Excluding #{name} from Blertr alerts"
-    Blertr::Blacklist.new.add(name)
-  when "set"
-    notifier_name = parameters.shift
-    if Blertr::Control::is_notifier? notifier_name
-      key = parameters.shift
-      value = parameters.shift
-      if key and value
-        puts "Setting #{notifier_name}'s #{key} to #{value}"
-        Blertr::Control::notifier_with_name(notifier_name).set_option(key,value)
-      else
-        puts "set command requires a key and a value to set it to"
-        puts "example blertr set email to user@gmail.com"
-      end
-    else
-      puts "Sorry, #{action} isn't a notifier."
-      puts "Use blertr status for a list of all notifiers"
-    end
-  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]"
+if __FILE__ == $0
+  action = ARGV.shift
+  parameters = ARGV
+  Blertr::Bin::take_action action, parameters
 end

data/config/blacklist.yaml

@@ -8,3 +8,4 @@
 - vim
 - blertr
 - git log
+- emacs

data/lib/blertr/bin.rb

@@ -0,0 +1,207 @@
+
+require 'blertr'
+
+module Blertr
+  class Bin
+
+    def self.add_services services, time
+      puts services
+    end
+
+    def self.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
+
+    upgrade    Updates current copy of blertr to latest version
+    
+    info       Pass in a notifier name to get the 
+               information it is using to send notifications
+               Example: blertr info email
+
+    status     For each notifier, Blertr lists if it currently can
+               send notifications and then lists any error messages
+               if it cannot. Useful for debuggin problems with notifiers
+
+    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
+
+    set        Pass in the notifier name, a configuration key, and
+               a value. Blertr will add this key / value to the 
+               notifiers config file.
+               Example: blertr set mail to user@gmail.com
+EOS
+  puts help_string
+    end
+
+    def self.take_action action, parameters
+      parameters = [parameters].flatten.compact
+      blertr_path = File.expand_path(File.join(File.dirname(__FILE__), ".."))
+      blertr_local_dir = File.expand_path("~/.blertr")
+      blertr_symlink = File.join(blertr_local_dir, "app")
+      case action
+      when "help",nil
+        help
+      when "install"
+        if File.exists? blertr_symlink
+          puts "ERROR: Blertr appears to already be installed.\nUninstall with blertr uninstall"
+        else
+          puts "creating #{blertr_local_dir} directory"
+          system("mkdir -p #{blertr_local_dir}")
+
+          puts "creating symlink from #{blertr_path} to #{blertr_symlink}"
+          system("ln -s #{blertr_path} #{blertr_symlink}")
+
+          config_dir = File.expand_path(Blertr::CONFIG_DIR_PATH)
+          if !File.exists?(config_dir)
+            blertr_config_dir = File.expand_path(File.join(File.dirname(__FILE__), "..", "config"))
+            puts "copying config files to #{blertr_path}"
+            system("cp -r #{blertr_config_dir} #{blertr_local_dir}")
+          end
+          puts "Blertr is now (almost) installed!\nPut this at the bottom of your .bashrc file:"
+          puts "[[ -s \"$HOME/.blertr/app/scripts/blertr\" ]] && . \"$HOME/.blertr/app/scripts/blertr\""
+        end
+      when "uninstall"
+        if File.exists? blertr_symlink
+          puts "Removing #{blertr_symlink}"
+          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 "upgrade"
+        commands = ["gem install blertr", "blertr uninstall", "blertr install"]
+        puts "Right now the upgrade process is very basic. Blertr will run:"
+        commands.each {|c| puts "$ #{c}"}
+        puts "This assumes that blertr is installed using rvm and doesn't require"
+        puts " sudo access."
+        puts "That ok? (y/n)"
+        response = gets
+        if ["y","Y","yes","Yes","YES"].include?(response.chomp)
+          puts "Ok, running commands now."
+          commands.each {|c| system(c)}
+        else
+          puts "You're the boss, exiting now."
+        end
+      when "info"
+        raw_name = parameters.shift
+        raw_name = raw_name ? raw_name.strip : nil
+        raw_name = (raw_name and raw_name.empty?) ? nil : raw_name
+
+        names = []
+        if !raw_name
+          Blertr::Control::notifiers.each { |notifier| names << notifier.name}
+        else
+          if Blertr::Control::is_notifier? raw_name
+            names << Blertr::Control::notifier_with_name(raw_name).name
+          else
+            puts "Error: #{raw_name} is not a notifier"
+            puts "use blertr status to list all notifiers"
+          end
+        end
+
+        names.each do |name|
+          info_hash = Blertr::Options.options_for name
+          puts "Configuration for: #{name}"
+          if info_hash.empty?
+            puts "     No configuration file for #{name} or config file is empty"
+          else
+            info_hash.each do |key,value|
+              puts "     #{key}: #{value}"
+            end
+          end
+        end
+      when "status"
+        Blertr::Control::notifiers.each do |notifier|
+          notify_message = notifier.can_alert? ? "can alert" : "cannot alert"
+          puts "#{notifier.name}: #{notify_message}"
+          if !notifier.error_messages.empty?
+            notifier.error_messages.each {|err| puts "  #{err}"}
+          end
+        end
+      when "exclude"
+        name = parameters.join(" ").strip
+        unless !name or name.empty?
+          puts "Excluding #{name} from Blertr alerts"
+          Blertr::Blacklist.new.add(name)
+        else
+          puts "Error: excluding requires a command to exclude"
+          puts "Example: blertr exclude ssh"
+        end
+      when "set"
+        notifier_name = parameters.shift
+        if Blertr::Control::is_notifier? notifier_name
+          key = parameters.shift
+          value = parameters.shift
+          if key and value
+            puts "Setting #{notifier_name}'s #{key} to #{value}"
+            Blertr::Control::notifier_with_name(notifier_name).set_option(key,value)
+          else
+            puts "Error: set command requires a key and a value to set it to"
+            puts "Example: blertr set email to user@gmail.com"
+          end
+        else
+          puts "Error: #{notifier_name} isn't a notifier."
+          puts "Use blertr status for a list of all notifiers"
+        end
+      when "time"
+        if !parameters.empty?
+          notifier_found = false
+          notifiers = parameters.shift.strip.split(",")
+          notifiers.each do |notifier|
+            if Blertr::Control::is_notifier? notifier
+              notifier_found = true
+              new_time = parameters.join(" ").strip
+              unless new_time.empty?
+                Blertr::Control::change_time notifier, new_time
+              else
+                puts "Error: setting time requires a new time"
+                puts "Example: blertr time #{notifier} 5 minutes"
+              end
+            end
+          end
+
+          if !notifier_found
+            puts "Sorry, #{notifiers.join(",")} isn't a notifier."
+            puts "Use blertr status for a list of all notifiers"
+            puts "Example: blertr time mail 5 minutes"
+          end
+        else
+          puts "All Notifier Times:"
+          Blertr::Control::notifiers.each do |notifier|
+            notifier_time = "#{notifier.name}".ljust(20)
+            notifier_time += notifier.options[:time] ? "#{notifier.options[:time]} seconds" : "not set"
+            puts notifier_time
+          end
+          puts ""
+          puts "Use blertr time [notifier] [time]"
+          puts " to set time for notifier."
+          puts "Example: blertr time mail 5 minutes"
+        end
+      else
+        puts "Sorry, #{action} isn't a recognized command"
+        puts "use blertr help to get a list of availible commands."
+      end
+    end
+  end
+end

data/lib/blertr/blacklist.rb

@@ -1,11 +1,17 @@
 require 'fileutils'
+require 'blertr/constants'
 
 module Blertr
   class Blacklist
     attr_accessor :path, :list
 
     def self.path
-      File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "config", "blacklist.yaml"))
+      base_path = File.expand_path(CONFIG_DIR_PATH)
+      if File.exists?(base_path)
+        File.join(base_path, "blacklist.yaml")
+      else
+        File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "config", "blacklist.yaml"))
+      end
     end
 
     def initialize path = Blacklist::path
@@ -31,8 +37,20 @@ module Blertr
 
     def blacklisted? command
       rtn = false
-      @list.each do |name|
-        if command =~ /^#{name}/
+      command_fields = command.split(/ /)
+      list_matches = @list.collect {|name| name.split(/ /).zip(command_fields)}
+
+      list_matches.each do |match_set|
+        match = true
+        match_set.each do |excluded_section, command_section|
+          if (excluded_section and command_section) and
+            (excluded_section != command_section) and
+            (File.basename(excluded_section) != File.basename(command_section))
+            match = false
+          end
+        end
+
+        if match
           rtn = true
           return rtn
         end

data/lib/blertr/version.rb

@@ -1,3 +1,3 @@
 module Blertr
-  VERSION = "0.2.6".freeze
+  VERSION = "0.2.7".freeze
 end

data/spec/bin_spec.rb

@@ -0,0 +1,77 @@
+BIN = File.expand_path(File.join(File.dirname(__FILE__), "..", "bin", "blertr"))
+
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'blertr/bin'
+
+describe Blertr::Bin do
+  describe "blertr" do
+    before(:each) do
+      @bin = BIN
+    end
+
+    it "should exist" do
+      File.exists?(@bin).should == true
+    end
+
+    it "should be executable" do
+      File.executable?(@bin).should == true
+    end
+  end
+
+  describe "bin" do
+    before(:each) do
+      @bin = Blertr::Bin
+      @invalid_notifiers = ["", "maill", "mad", nil, "gr0wl", "ddd", "      dd     "]
+    end
+
+    it "should print help with no action or help action" do
+      actions = [nil, "help"]
+      actions.each do |action|
+        output = capture(:stdout) {@bin.take_action action, nil}
+        output.should match(/Welcome to Blertr/)
+      end
+    end
+
+    it "should print time for all notifiers with no time parameters" do
+      output = capture(:stdout) {@bin.take_action "time", nil}
+      output.should match(/All Notifier Times/)
+    end
+
+    it "should indicate notifier is invalid for invalid notifiers" do
+      output = capture(:stdout) {@bin.take_action "time", "not_notifier"}
+      output.should match(/isn't a notifier/)
+    end
+
+    it "should error if no time is given to set for notifier" do
+      output = capture(:stdout) {@bin.take_action "time", "mail"}
+      output.should match(/Error/)
+      output.should match(/requires a new time/)
+    end
+
+    it "should not set configs for invalid notifier" do
+      @invalid_notifiers.each do |notifier|
+        output = capture(:stdout) {@bin.take_action "set", notifier }
+        output.should match(/Error/)
+        output.should match(/isn't a notifier/)
+      end
+    end
+
+    it "should not exclude empty commands" do
+      invalid_exclusions = [nil, "", "          "]
+      invalid_exclusions.each do |ex|
+        output = capture(:stdout) {@bin.take_action "exclude", ex }
+        output.should match(/Error/)
+        output.should match(/requires .* command .* exclude/)
+      end
+    end
+
+    it "should show info of all notifiers if no notifier name given" do
+        output = capture(:stdout) {@bin.take_action "info", nil }
+        output.should match(/Configuration for: mail/)
+        output.should match(/Configuration for: twitter/)
+        output = capture(:stdout) {@bin.take_action "info", "     " }
+        output.should match(/Configuration for: mail/)
+        output.should match(/Configuration for: twitter/)
+    end
+  end
+end

data/spec/blacklist_spec.rb

@@ -49,7 +49,16 @@ describe Blertr::Blacklist do
   end
 
   it "should handle full commands" do
-    commands = [["git diff","git diff"], ["ssh", "ssh 123@123.com"], ["cp", "cp /ma/da ./da/ma"]]
+    commands = [["git diff","git diff"], ["ssh", "ssh 123@123.com"], ["cp", "cp /ma/da ./da/ma"], ["cp", "cp     "]]
+
+    commands.each do |name, command|
+      @blacklist.add name
+      @blacklist.blacklisted?(command).should == true
+    end
+  end
+
+  it "should handle relative commands" do
+    commands = [["git diff","../../git diff"], ["ssh", "/usr/bin/ssh         123@123.com"], ["cp", "/dev/../null/cp /ma/da ./dd/mz"]]
 
     commands.each do |name, command|
       @blacklist.add name
@@ -58,7 +67,7 @@ describe Blertr::Blacklist do
   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 = [["git diff","git diff", "git log"], ["ssh", "ssh 123@123.com", "scp 123@123.com"], ["cp", "cp /ma/da ./da/ma", "cpy /ma/da ./da/ma"], ["git diff", "../git diff", "../git log"], ["git diff", "git diff", "git dif"]]
     commands.each do |name, command, similar_command|
       @blacklist.add name
       @blacklist.blacklisted?(command).should == true

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blertr
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.2.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-02 00:00:00.000000000Z
+date: 2011-08-08 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2676140 !ruby/object:Gem::Requirement
+  requirement: &2650200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '1.0'
   type: :development
   prerelease: false
-  version_requirements: *2676140
+  version_requirements: *2650200
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &2675820 !ruby/object:Gem::Requirement
+  requirement: &2649890 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '2.5'
   type: :development
   prerelease: false
-  version_requirements: *2675820
+  version_requirements: *2649890
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2675590 !ruby/object:Gem::Requirement
+  requirement: &2649630 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '2.3'
   type: :development
   prerelease: false
-  version_requirements: *2675590
+  version_requirements: *2649630
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &2675320 !ruby/object:Gem::Requirement
+  requirement: &2649380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: '0.4'
   type: :development
   prerelease: false
-  version_requirements: *2675320
+  version_requirements: *2649380
 - !ruby/object:Gem::Dependency
   name: twitter
-  requirement: &2674970 !ruby/object:Gem::Requirement
+  requirement: &2649130 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,7 +65,7 @@ dependencies:
         version: 1.6.0
   type: :runtime
   prerelease: false
-  version_requirements: *2674970
+  version_requirements: *2649130
 description: Automatic alerts for when bash scripts and commands complete
 email: vvv@gmail.com
 executables:
@@ -89,6 +89,7 @@ files:
 - config/mail_config.yaml
 - config/notify_send_config.yaml
 - lib/blertr.rb
+- lib/blertr/bin.rb
 - lib/blertr/blacklist.rb
 - lib/blertr/constants.rb
 - lib/blertr/control.rb
@@ -105,6 +106,7 @@ files:
 - scripts/cli
 - scripts/preexec
 - scripts_bin/blert_now.rb
+- spec/bin_spec.rb
 - spec/blacklist_spec.rb
 - spec/control_spec.rb
 - spec/growl_notifier_spec.rb
@@ -140,6 +142,7 @@ signing_key:
 specification_version: 3
 summary: Automatic alerts for when bash scripts and commands complete
 test_files:
+- spec/bin_spec.rb
 - spec/blacklist_spec.rb
 - spec/control_spec.rb
 - spec/growl_notifier_spec.rb