notifyme 0.4 → 1.0.0

data/lib/notifyme/check.rb

@@ -0,0 +1,16 @@
+module NotifyMe
+  class Check
+    class << self
+      def process(args = {})
+        unless %x{ps -e}.include? args.name
+          raise "Process #{args.name} is not running!"
+        end
+      end
+
+      def tcp(args = {})
+        require 'socket'
+        TCPSocket.new(args[:host], args[:port])
+      end
+    end
+  end
+end

data/lib/notifyme/log.rb

@@ -13,6 +13,7 @@ module NotifyMe
         begin
           require "notifyme/log/#{@logger}.rb"
         rescue Exception => e
+          raise "The #{@logger} is invalid."
         end
         NotifyMe::Log.const_get(@logger.capitalize).new @parameters
       end

data/lib/notifyme/start.rb

@@ -1,24 +1,54 @@
-require 'notifyme/task'
-require 'notifyme/log'
-
 module NotifyMe
 
-  VERSION = '0.4'
+  VERSION = '1.0.0'
+
+  autoload :Task, 'notifyme/task'
+  autoload :Log, 'notifyme/log'
+  autoload :Check, 'notifyme/check'
 
   class Start
     class << self
 
       # log 
-      @@log_args = nil
-      @@log_format = nil
-      @@log_directory = nil
+      @@log_args = [:stdout]
+      @@log_format = :text
+      @@log_directory = "/tmp"
 
       # tasks list
       @@tasks = []
 
       def run!
         puts 'NotifyMe v' + NotifyMe::VERSION
-        new(ARGV[0]).run
+        load_custom_check_functions
+        start = new(ARGV[0])
+        load_custom_check_tasks
+        start.run
+      end
+
+      def load_custom_check_functions
+        file = File.join(custom_notifyme_dir, "check.rb")
+        if File.exists? file
+          load file
+          puts "Loaded custom check functions from #{file}."
+        end        
+      end
+
+      def load_custom_check_tasks
+        task_files = File.join(custom_notifyme_dir, 'check', '*.rb')
+        Dir[task_files].each do |task_file|
+          load task_file
+          task_name = File.basename(task_file.sub('.rb', ''))
+          task_func = "check_#{task_name}"
+          if defined? task_func
+            task task_func do |t|
+              method(task_func).call t
+            end
+          end
+        end
+      end
+
+      def custom_notifyme_dir
+        File.join(ENV['HOME'], ".notifyme")
       end
 
       def config(&block)
@@ -29,6 +59,7 @@ module NotifyMe
 
       def task(name)
         raise 'Invalid task calls' unless block_given?
+        puts "Added task #{name}"
         task = NotifyMe::Task.new
         task.name = name
         task.logger ||= NotifyMe::Log::Base.new(@@log_args).logger
@@ -37,6 +68,15 @@ module NotifyMe
         @@tasks << task
       end
 
+      def check(name, args = {})
+        begin
+          NotifyMe::Check.method(name).call args
+          nil
+        rescue Exception => e
+          "Check #{name} failed: #{e}"
+        end
+      end
+
       def log(*args)
         @@log_args = args
       end
@@ -102,7 +142,7 @@ module NotifyMe
       return if @@log_directory.nil?
       log_file = File.join(@@log_directory, '/', "#{task_name}.log")
       File.open(log_file, 'a') do |f|
-        f.write "(#{Time.new.to_s}) #{command} : #{msg}\n"
+        f.write "[#{Time.new.to_s}] #{command} : #{msg}\n"
       end
     end
 

data/lib/notifyme/task.rb

@@ -12,7 +12,19 @@ module NotifyMe
       @command = get_command(cmd)
     end
 
+    def start_run_time
+      format_time @start_run_time
+    end
+
+    def end_run_time
+      format_time @start_run_time
+    end
+
     private
+    def format_time(time)
+      Time.at(time).strftime('%Y-%m-%d %H:%M:%S %Z')
+    end
+
     def get_command(cmd)
       return if cmd.nil?
 

data/notifyme_config.rb

@@ -26,9 +26,9 @@ NotifyMe::Start.config do
   # log :mail, :to_email => 'to@email.com'
 
   # :csv, :text, :xml, :json
-  log_format :json 
+  log_format :text
 
-  # log_directory '/tmp/notifyme'
+  log_directory '/tmp/notifyme'
 
   # add some tasks
 
@@ -37,27 +37,19 @@ NotifyMe::Start.config do
   # if one of the disks' space usage > 95%, notification will be sent.
   #
   task :checking_disk_usage do |t|
-    t.sleep_time = 60 
+    t.sleep_time = 60
     t.command = lambda {
-      if %x{df -h}.scan(/\s+(\d+)%\s+/).find {|pcent| pcent.first.to_i > 95} 
-        "Warnning: at least 1 disk space usage > 95%"
+      if %x{df -h}.scan(/\s+(\d+)%\s+/).find {|pcent| pcent.first.to_i > 95}
+        "Warning: at least 1 disk space usage > 95%"
       else
-        nil 
+        nil
       end
-    } 
+    }
   end
 
   task :checking_localhost_http do |t|
     t.sleep_time = 5
-    t.command = lambda { 
-      require 'socket'
-      begin
-        TCPSocket.new('localhost', 80)
-        nil
-      rescue Exception => e
-        e.to_s
-      end
-    } 
+    t.command = lambda { check :tcp, :host => 'localhost', :port => 80 }
     t.restart_command = lambda { %x{/etc/init.d/httpd start} }
   end
 end

metadata

@@ -1,11 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: notifyme
 version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 4
-  version: "0.4"
+  prerelease: 
+  version: 1.0.0
 platform: ruby
 authors: 
 - xianhua.zhou
@@ -13,8 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-09-03 00:00:00 +08:00
-default_executable: notifyme_daemon
+date: 2012-12-05 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: daemons
@@ -24,10 +20,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 1
-        - 0
         version: 1.1.0
   type: :runtime
   version_requirements: *id001
@@ -39,14 +31,10 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 4
-        - 2
         version: 1.4.2
   type: :runtime
   version_requirements: *id002
-description: NotifyMe takes care more than one tasks and process their results for you, it's similar to the *NIX's cronjob.
+description: NotifyMe takes care more than one tasks and process their results for you, it's similar to *NIX's cronjob.
 email: xianhua.zhou@gmail.com
 executables: 
 - notifyme_daemon
@@ -57,20 +45,19 @@ extra_rdoc_files: []
 
 files: 
 - lib/notifyme.rb
-- lib/vendor/smtp_add_tls_support.rb
 - lib/notifyme/log.rb
-- lib/notifyme/task.rb
 - lib/notifyme/log/mail.rb
 - lib/notifyme/log/stdout.rb
 - lib/notifyme/log/file.rb
 - lib/notifyme/start.rb
-- README.rdoc
+- lib/notifyme/check.rb
+- lib/notifyme/task.rb
+- lib/vendor/smtp_add_tls_support.rb
 - CHANGELOG
 - INSTALL
 - notifyme_config.rb
 - bin/notifyme_daemon
 - bin/notifyme
-has_rdoc: true
 homepage: http://github.com/xianhuazhou/NotifyMe
 licenses: []
 
@@ -84,21 +71,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: notifyme
-rubygems_version: 1.3.7
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: It's a kind of cronjob.

data/README.rdoc

@@ -1,90 +0,0 @@
-== Introduction
-
-NotifyMe is a script running as a cronjob in background,  can take care more than one tasks (by Ruby Threads), and push the result to different endpoints(stdout, mail, file etc.) with different formats such as xml, json, csv etc. depends on what's you need.
-
-== Installation
-
-gem install notifyme
-
-== Run it
-
-# run in the background
-
-$ notifyme_daemon start --(double dash here) /absolute/path/to/notifyme_config.rb
-
-# debug (use Ctrl + C to stop it)
-
-$ notifyme_daemon run --(double dash here) /absolute/path/to/notifyme_config.rb
-
-# stop
-
-$ notifyme_daemon stop
-
-== Example
-
-== Check HTTP Server (e.g. Nginx)
-
-  require 'socket'
-
-  NotifyMe::Start.config do
-    # output to the console
-    log :stdout
-
-    # output format is text
-    log_format :text
-
-    # define the task 
-    task :checking_http_server do |t| 
-
-      # running every 5 seconds
-      t.sleep_time = 5 
-
-      # checking command
-      t.command = lambda { 
-        begin
-          TCPSocket.new('localhost', 80) 
-          nil 
-        rescue Exception => e
-          e.to_s
-        end 
-      }   
-
-      # if the server is not running, the restart_command will be executed
-      t.restart_command = lambda { %x{/etc/init.d/nginx start} }
-    end 
-
-  end
-
-== Check the "cupsd" process (from "ps -e")
-
-  NotifyMe::Start.config do
-    log :stdout
-    log_format :json 
-    task :checking_cupsd do |t| 
-      t.sleep_time = 5 
-      t.command = lambda {
-        if %x{ps -e}.include? " cupsd"
-          nil 
-        else
-          "Warnning: the process cupsd is not running!"
-        end 
-      }   
-      t.restart_command = lambda {
-         `/etc/init.d/cups start`
-      }   
-    end 
-  end
-
-More please check the notifyme_config.rb file.
-
-== Output
-
-The output from every task's command will be processed (send to endpoint) only if the output is not empty, otherwise do nothing.
-
-== Version
-
-v 0.4
-
-== TODO
-
-Add some SPECS