benotified 0.0.1

data.tar.gz.sig

@@ -0,0 +1,2 @@
+p�k�h�$�L%�3�9����Q\\��#߰�)#���T=��>��b
��ta�ߗ�������Z�?c>
+hϨY�ZLr&R���\ܮ���8.�zA��Jw3��ZR����f).�Tb1�

data/Gemfile

@@ -0,0 +1,5 @@
+source :rubygems
+
+gem "actionmailer", "3.0.1"
+gem "json_pure", "1.4.6"
+gem "log4r", "1.1.9"

data/Gemfile.lock

@@ -0,0 +1,51 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.1)
+      actionpack (= 3.0.1)
+      mail (~> 2.2.5)
+    actionpack (3.0.1)
+      activemodel (= 3.0.1)
+      activesupport (= 3.0.1)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.4.1)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.12)
+      rack-test (~> 0.5.4)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.1)
+      activesupport (= 3.0.1)
+      builder (~> 2.1.2)
+      i18n (~> 0.4.1)
+    activesupport (3.0.1)
+    builder (2.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    i18n (0.4.2)
+    json_pure (1.4.6)
+    log4r (1.1.9)
+    mail (2.2.14)
+      activesupport (>= 2.3.6)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.16)
+    polyglot (0.3.1)
+    rack (1.2.1)
+    rack-mount (0.6.13)
+      rack (>= 1.0.0)
+    rack-test (0.5.7)
+      rack (>= 1.0)
+    treetop (1.4.9)
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.24)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  actionmailer (= 3.0.1)
+  json_pure (= 1.4.6)
+  log4r (= 1.1.9)

data/Manifest

@@ -0,0 +1,28 @@
+Gemfile
+Gemfile.lock
+Manifest
+README.md
+Rakefile
+benotified.gemspec
+examples/monitor.rb
+lib/be_notified.rb
+lib/be_notified/commands.rb
+lib/be_notified/commands/host_not_alive.rb
+lib/be_notified/commands/number_of_files.rb
+lib/be_notified/commands/program_running.rb
+lib/be_notified/commands/size_of_file.rb
+lib/be_notified/configuration.rb
+lib/be_notified/monitor.rb
+lib/be_notified/notifier.rb
+lib/be_notified/version.rb
+lib/benotified.rb
+test/commands/test_host_not_alive.rb
+test/commands/test_number_of_files.rb
+test/commands/test_program_running.rb
+test/commands/test_size_of_file.rb
+test/notifiers/test_email_notifier.rb
+test/notifiers/test_log_notifier.rb
+test/test_configuration.rb
+test/test_helper.rb
+test/test_monitor.rb
+test/test_notifier.rb

data/README.md

@@ -0,0 +1,132 @@
+# BeNotified
+## Description
+
+This library monitors your programs or resources and notifies you by email or log if anything goes wrong.
+
+## Installation
+
+This gem is hosted on gemcutter.org
+
+	gem install be-notified
+
+## Usage
+
+	require 'be_notified'
+
+	BeNotified::Monitor.new do
+		alert_when "Something went wrong" do
+			# Put your code here 
+			# Return true if something went wrong 
+			# or false if everything was fine
+		end
+	end
+
+
+This library can be used in two different ways:
+
+__First:__ Run it from crontab to monitor some resources, for exmaple:
+
+	BeNotified::Monitor.new do
+		alert_when "Staging server is down" do
+			host_not_available?("staging.example.com")
+		end
+	end
+
+or
+
+
+	BeNotified::Monitor.new do
+		alert_when "Log file does not exist" do
+			File.exists?('/var/log/messages') == false
+		end
+	end
+	
+
+__Second:__ Wrap your program around it and be informed when something goes wrong. I will use imaginary program called db_updater as an example:
+
+	BeNotified::Monitor.new do
+		alert_when "Db was not updated" do
+			# Require your program here
+			require 'db_updater'
+		
+			# Get the count of the records before run
+			count_before_run = DBUpdater::Update::Record.all.count
+		
+			# Run your application
+			DBUpdater::Update.run
+		
+			# Get the count after the run
+			count_after_run = DBUpdater::Update::Record.all.count
+		
+			# Now decide if anything went wrong
+			count_after_run == count_before_run
+		end
+	end
+
+## Configuration file
+
+Options can be set up in the three different ways:
+
+__First:__ By default program will log to standard output.
+
+__Second:__ Define properties directly in the code. An example of setting email notification:
+
+	BeNotified::Monitor.new do
+		custom_options = {
+			:notifier_type  => BeNotified::Notifiers::Email
+	    :email => {
+	      :smtp_address => 'localhost',
+	      :smtp_port    => 25,
+	      :domain       => 'example.com',
+	      :username     => 'login',
+	      :password     => 'pass',
+	      :to           => 'to@example.com',
+	      :from         => 'from@example.com',
+	      :subject      => 'The Subject'
+	    }
+	  }
+
+		# Make sure you merge the options
+		configuration(custom_options)
+	end
+
+__Third:__ Create a file _.be\_notified_ in your home directory. It stores the configuration in JSON format. An example of setting application to log to the file:
+
+	{"logger_file":"/tmp/benotified.log"}
+
+# Helper Methods
+
+This library is shipped with some helper methods that can be used to monitor resources:
+
+* host\_not\_alive? - checks if a given host if alive or not
+	
+		alert_when "Staging server is down" do
+			host_not_available?("staging.example.com")
+		end
+
+* number\_of\_files - checks the number of files in a given directory
+
+		alert_when "Number of files on the desktop is greater then 50" do
+			number_of_files("/Users/dominik/Desktop") > 50
+		end
+	
+* program\_running? - checks if a given program is running
+
+		alert_when "Application server is not running" do
+			! program_running?("jboss")
+		end
+	
+* size\_of\_file - checks the size of a given file in GB, MB or KB
+
+		alert_when "JBoss log file is bigger then 1GB" do
+			size_of_file("/usr/local/jboss/server/default/log/server.log") > 1.GB
+		end
+
+# How to contribute
+
+1. Revise the code and suggest improvements / changes
+2. Write more helper methods
+3. Add new ways of notifying user
+
+
+

data/Rakefile

@@ -0,0 +1,24 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+require File.expand_path('../lib/be_notified/version', __FILE__)
+
+task :default => :test
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+Echoe.new('benotified', BeNotified::VERSION) do |p|
+  p.description    = "Library to monitor your programs and resources. It will notify you by email or just log the event if something goes wrong."
+  p.url            = "http://github.com/staskie/be-notified"
+  p.author         = "Dominik Staskiewicz"
+  p.email          = "stadominik @nospam@ gmail.com"
+  p.ignore_pattern = ["tmp/*", "script/*"]
+  p.development_dependencies = []
+end

data/benotified.gemspec

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{benotified}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Dominik Staskiewicz"]
+  s.cert_chain = ["/Users/dominik/Documents/keys/gem-public_cert.pem"]
+  s.date = %q{2011-01-19}
+  s.description = %q{Library to monitor your programs and resources. It will notify you by email or just log the event if something goes wrong.}
+  s.email = %q{stadominik @nospam@ gmail.com}
+  s.extra_rdoc_files = ["README.md", "lib/be_notified.rb", "lib/be_notified/commands.rb", "lib/be_notified/commands/host_not_alive.rb", "lib/be_notified/commands/number_of_files.rb", "lib/be_notified/commands/program_running.rb", "lib/be_notified/commands/size_of_file.rb", "lib/be_notified/configuration.rb", "lib/be_notified/monitor.rb", "lib/be_notified/notifier.rb", "lib/be_notified/version.rb", "lib/benotified.rb"]
+  s.files = ["Gemfile", "Gemfile.lock", "Manifest", "README.md", "Rakefile", "benotified.gemspec", "examples/monitor.rb", "lib/be_notified.rb", "lib/be_notified/commands.rb", "lib/be_notified/commands/host_not_alive.rb", "lib/be_notified/commands/number_of_files.rb", "lib/be_notified/commands/program_running.rb", "lib/be_notified/commands/size_of_file.rb", "lib/be_notified/configuration.rb", "lib/be_notified/monitor.rb", "lib/be_notified/notifier.rb", "lib/be_notified/version.rb", "lib/benotified.rb", "test/commands/test_host_not_alive.rb", "test/commands/test_number_of_files.rb", "test/commands/test_program_running.rb", "test/commands/test_size_of_file.rb", "test/notifiers/test_email_notifier.rb", "test/notifiers/test_log_notifier.rb", "test/test_configuration.rb", "test/test_helper.rb", "test/test_monitor.rb", "test/test_notifier.rb"]
+  s.homepage = %q{http://github.com/staskie/be-notified}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Benotified", "--main", "README.md"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{benotified}
+  s.rubygems_version = %q{1.3.7}
+  s.signing_key = %q{/Users/dominik/Documents/keys/gem-private_key.pem}
+  s.summary = %q{Library to monitor your programs and resources. It will notify you by email or just log the event if something goes wrong.}
+  s.test_files = ["test/commands/test_host_not_alive.rb", "test/commands/test_number_of_files.rb", "test/commands/test_program_running.rb", "test/commands/test_size_of_file.rb", "test/notifiers/test_email_notifier.rb", "test/notifiers/test_log_notifier.rb", "test/test_configuration.rb", "test/test_helper.rb", "test/test_monitor.rb", "test/test_notifier.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/examples/monitor.rb

@@ -0,0 +1,27 @@
+$:.push File.join(File.dirname(__FILE__), "../lib")
+
+require 'be_notified'
+
+
+BeNotified::Monitor.new do
+  
+  alert_when "Clean your desktop." do
+    number_of_files("/Users/dominik/Desktop") > 5
+  end
+  
+  alert_when "Number of jpg files on the desktop is greater then 2" do
+    number_of_files("/Users/dominik/Desktop", /jpg/i) > 2
+  end
+  
+  alert_when "Size of abc.txt if greater then 4 KB" do
+    size_of_file("/Users/dominik/Desktop/abc.txt") > 4.KB
+  end
+  
+  alert_when "Java prociess is not running" do
+    program_not_running?('java')
+  end
+  
+  alert_when "Staging server is down" do
+    host_not_alive?("192.168.1.2", 2)
+  end
+end

data/lib/be_notified.rb

@@ -0,0 +1,9 @@
+$:.push File.dirname(__FILE__)
+
+require 'be_notified/version'
+require 'be_notified/configuration'
+require 'be_notified/notifier'
+require 'be_notified/commands'
+require 'be_notified/monitor'
+
+

data/lib/be_notified/commands.rb

@@ -0,0 +1,13 @@
+module BeNotified
+  module Commands
+    # Hook method called when this module is included by some other class
+    # It loads all the command helpers
+    def self.included(base)
+      dir = File.join(File.dirname(__FILE__), 'commands')
+      
+      Dir.glob("#{dir}/*.rb").each do |command|
+        require command
+      end
+    end
+  end
+end

data/lib/be_notified/commands/host_not_alive.rb

@@ -0,0 +1,29 @@
+require 'socket'
+
+module BeNotified
+  module Commands
+    
+    # Check if a given host is up
+    #
+    # host - The String represending either the domain name or IP address
+    # packets - number of PING packets to send to the host
+    #
+    # For example:
+    #   host_not_alive?("example.com", 10)
+    #
+    # Returns true if no response from host
+    # Returns false if there was a response from host
+    def host_not_alive?(host, packets=5)
+      command = "ping -c #{packets} #{host}"
+      
+      run_system(command) !~ /64 bytes from/
+    end
+    
+    private
+    
+    # For stubbing
+    def run_system(command)
+      `#{command}`
+    end
+  end
+end

data/lib/be_notified/commands/number_of_files.rb

@@ -0,0 +1,33 @@
+module BeNotified
+  module Commands
+    
+    # Check number of files in a given folder
+    #
+    # directory - The String representing the name of the directory
+    # mask - Regexp to match the files
+    #
+    # For example:
+    #
+    #   number_of_files("/var/log")
+    #   number_of_files("/var/log", /\.log$/)
+    #
+    # Returns Integer, count of files in a directory
+    def number_of_files(directory, mask = nil)
+      raise ArgumentError, "Directory '#{directory}' not found" if ! File.exists?(directory)
+      raise ArgumentError, "Mask should be a Regexp"            if ! mask.nil? && ! (mask.kind_of? Regexp)
+      
+      count = 0
+      Dir.glob("#{directory}/*").each do |file|
+        next if ! File.file?(file)
+        
+        if mask.nil?
+          count += 1
+        else
+          count += 1 if file =~ Regexp.new(mask)
+        end
+      end
+      
+      count
+    end
+  end
+end

data/lib/be_notified/commands/program_running.rb

@@ -0,0 +1,46 @@
+module BeNotified
+  module Commands
+    
+    # Check if process is running
+    #
+    # name - The String represending the name of the process
+    #
+    # For example:
+    #
+    #   program_running?('netcat')
+    #
+    # Returns true if process is running
+    # Returns false if process is not running
+    # Raises RuntimeError if on Windows platform
+    def program_running?(name)
+      raise RuntimeError if running_on_windows?
+      
+      command = "ps -ef | grep -i #{name} | grep -v grep"
+      
+      # Run the command and check response
+      run_system(command) != ""
+    end
+    
+    # Check if process is not running
+    # Argument and example the same as above
+    # 
+    # Returns true if process is NOT running
+    # Returns false if process is running
+    # Raises RuntimeError if on Windows platform
+    def program_not_running?(name)
+      ! program_running?(name)
+    end
+    
+    private
+    
+    # For stubbing
+    def run_system(command)
+      `#{command}`
+    end
+    
+    # Check if on windows platform
+    def running_on_windows?
+      RUBY_PLATFORM =~ /mswin32/
+    end
+  end
+end