pingmon 0.2

data/.gitignore

@@ -0,0 +1,3 @@
+pkg/*
+*.gem
+.bundle

data/Gemfile

@@ -0,0 +1,4 @@
+source :gemcutter
+
+# Specify your gem's dependencies in pingmon.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,48 @@
+PATH
+  remote: .
+  specs:
+    pingmon (0.1)
+      eventmachine (~> 0.12.10)
+      pony (~> 1.0.1)
+      rufus-scheduler (~> 2.0.6)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.0.1)
+    diff-lcs (1.1.2)
+    eventmachine (0.12.10)
+    i18n (0.4.2)
+    mail (2.2.9)
+      activesupport (>= 2.3.6)
+      i18n (~> 0.4.1)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.16)
+    polyglot (0.3.1)
+    pony (1.0.1)
+      mail (> 2.0)
+    rspec (2.0.1)
+      rspec-core (~> 2.0.1)
+      rspec-expectations (~> 2.0.1)
+      rspec-mocks (~> 2.0.1)
+    rspec-core (2.0.1)
+    rspec-expectations (2.0.1)
+      diff-lcs (>= 1.1.2)
+    rspec-mocks (2.0.1)
+      rspec-core (~> 2.0.1)
+      rspec-expectations (~> 2.0.1)
+    rufus-scheduler (2.0.6)
+    treetop (1.4.8)
+      polyglot (>= 0.3.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (>= 1.0.0)
+  eventmachine (~> 0.12.10)
+  pingmon!
+  pony (~> 1.0.1)
+  rspec (~> 2.0.1)
+  rufus-scheduler (~> 2.0.6)

data/README.md

@@ -0,0 +1,73 @@
+# PingMon: A stupid local-networking host 'ping' monitoring tool
+
+One day at work I needed to periodically ping a host on our local network. Then I
+thought it would be great (well... just nice) that when the pings were unsuccessful
+I would get notified by email.
+
+I was learning Ruby at that time and, instead of writing a simple shell script and set a cron job
+I thought... *Maybe I could write a script in Ruby for this*, *Maybe I could practice
+writing some tests*, *I could even create a gem and learn how it's done*, etc.
+
+And this is the result:
+
+A *stupid* monitoring tool which periodically pings a host and sends an email
+notification when it becomes unavailable.
+
+*It's been done merely for learning purposes so don't be too harsh on the code.*
+
+### Installation & Usage
+
+1. Install the gem as usual by entering:
+        $ gem install pingmon
+
+2. PingMon needs a *YAML configuration file* to operate, which is usually:
+`~/.pingmon.yml`. To make PingMon create that file for you, type:
+        $ pingmon build-config
+
+3. Edit `~/.pingmon.yml` to suit your needs.
+
+4. Finally, type `pingmon` on your prompt and have fun! ;)
+
+#### .pingmon.yml options
+
+There are a number of options you can tweak in the `.pingmon.yml` config file. They
+are pretty self-explanatory but I'll explain some of them here:
+
+- **host:** specifies the host to 'ping' to.
+- **mode:** PingMon operation mode which should be one of `monitor` or `ping`. In
+`ping` mode, PingMon will ping the host specified one time only (for testing
+purposes). When in `monitor` mode, PingMon will ping the host specified periodically
+following the `monitor_interval` option.
+- **monitor_interval:** when set to `monitor` mode it specifies the delay between
+*pings* to check the host status. ex: Setting it to `15m` will ping the `host`
+*every* 15 minutes.
+- **notify_when_down:** `true` or `false`. Tells PingMon to send an email notification
+when host can't be reached.
+- **notify_to:** whom to notify (if more than one, comma separated). ex: `user@domain.com`
+- **transport:** `:sendmail` or `:smtp`. `:sendmail` may only work on unix/linux OS
+variants.
+- **smtp_options:** when `transport:` is set to `:smtp` you should specify this
+options. They are passed *as is* to `Pony.mail` method.
+
+For more help, please take a look at the sample config file `config/pingmon.yml` or
+at the one PingMon generates for you when you type `pingmon build-config` which is
+usually located at: `$HOME/.pingmon.yml`.
+
+### External Dependencies
+
+PingMon depends on the following gems:
+
+- [eventmachine](http://github.com/eventmachine/eventmachine) ~> 0.12.10
+- [rufus-scheduler](http://github.com/jmettraux/rufus-scheduler) ~> 2.0.6
+- [pony](http://github.com/adamwiggins/pony) ~> 1.0.1
+
+Notes:
+
+- [eventmachine](http://github.com/eventmachine/eventmachine) and [rufus-scheduler](http://github.com/jmettraux/rufus-scheduler) are used when doing "pings" in monitor mode.
+- [Pony](http://github.com/adamwiggins/pony) adds the mail sending logic
+- This requirements are specified in the gemspec as well.
+
+---
+
+Coded by Estanislau Trepat, released under the MIT License: [http://www.opensource.org/licenses/mit-license.php](http://www.opensource.org/licenses/mit-license.php)
+

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/VERSION

@@ -0,0 +1 @@
+0.2

data/bin/pingmon

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.dirname(__FILE__) + "/../lib"
+require 'pingmon'
+
+def usage(why = nil)
+	puts "failed because: #{why}" if why
+	puts "usage:\tpingmon [build-config] [/path/to/pingmon.yml]"
+end
+
+usage("wrong number of args") if ARGV.size != 0 && ARGV.size != 1
+
+if ARGV.size == 1 && ARGV.first.strip == 'build-config'
+  PingMon::Config.build_config
+  ARGV.shift
+end
+
+begin
+  PingMon.log = ENV['PINGMON_LOG'] || 'stdout'
+  PingMon.execute_from_config(ARGV.first || PingMon::DEFAULT_CONFIG_FILE)
+rescue PingMon::ConfigFileNotFound => e
+  puts "WTF! #{e.message}"
+  puts "If this is your first time using pingmon you should run \`pingmon build-config\`." if ARGV.size == 0
+rescue StandardError => e
+  puts "WTF! #{e.message}"
+rescue SystemExit, Interrupt
+  puts "See ya!"
+end
+

data/config/pingmon.yml

@@ -0,0 +1,26 @@
+# pingmon config options
+config:
+  # host to be monitored
+  host: 192.168.0.7
+  # mode (ping/monitor)
+  mode: monitor
+  # monitor (ping) host every 2 minutes (if set to monitor mode)
+  monitor_interval: 2m
+  # wether it should send 'down' notifications by email
+  notify_when_down: true
+  # whom to notify (if more than one, comma separated)
+  notify_to: estanis.trepat@inson.es
+  # from address
+  from_address: estanis.trepat@inson.es
+  # :sendmail or :smtp (options below). :sendmail may only work on unix/linux
+  transport: :sendmail
+  # smtp_options ( if transport is set to :smtp. They are passed *as is* to `Pony.mail` method )
+  smtp_options:
+    address: your.smtpserver.com
+    port: 25
+    enable_starttls_auto: false
+    user_name: auser
+    password: apassword
+    authentication: :plain
+    domain: smtpserver.com
+

data/lib/pingmon.rb

@@ -0,0 +1,88 @@
+require 'ping'
+require 'erb'
+require 'yaml'
+require 'rubygems'
+require 'pony'
+require 'eventmachine'
+require 'rufus/scheduler'
+
+require File.dirname(__FILE__) + '/pingmon/config.rb'
+require File.dirname(__FILE__) + '/pingmon/pinger.rb'
+require File.dirname(__FILE__) + '/pingmon/monitor.rb'
+require File.dirname(__FILE__) + '/pingmon/version.rb'
+
+module PingMon
+  DEFAULT_CONFIG_FILE = File.expand_path('~/.pingmon.yml')
+
+  def self.ping(config=PingMon::Config.new)
+    p = PingMon::Pinger.new(config)
+    p.ping
+  end
+
+  def self.monitor(config=PingMon::Config.new)
+    m = PingMon::Monitor.new(config)
+    m.monitor
+  end
+
+  def self.execute_from_config(config_file=PingMon::DEFAULT_CONFIG_FILE)
+    config = PingMon::Config.new(config_file).load
+    raise "wrong mode" unless %w(ping monitor).include?(config.mode)
+
+    case config.mode
+      when "ping"
+        self.ping(config)
+      when "monitor"
+        self.monitor(config)
+    end
+  end
+
+  @@log = nil
+
+  # value may be a logger instance or a string: 'stdout'|'stderr'|'an actual filename'
+  def self.log= log
+    @@log = create_log log
+  end
+
+  def self.log
+    @@log
+  end
+
+  # Create a log that respond to << like a logger
+  # param can be 'stdout', 'stderr', a string (then we will log to that file) or a logger (then we return it)
+  def self.create_log param
+    if param
+      if param.is_a? String
+        if param == 'stdout'
+          stdout_logger = Class.new do
+            def << obj
+              STDOUT.puts obj
+            end
+          end
+          stdout_logger.new
+        elsif param == 'stderr'
+          stderr_logger = Class.new do
+            def << obj
+              STDERR.puts obj
+            end
+          end
+          stderr_logger.new
+        else
+          file_logger = Class.new do
+            attr_writer :target_file
+
+            def << obj
+              File.open(@target_file, 'a') { |f| f.puts obj }
+            end
+          end
+          logger = file_logger.new
+          logger.target_file = param
+          logger
+        end
+      else
+        param
+      end
+    end
+  end
+
+end
+

data/lib/pingmon/config.rb

@@ -0,0 +1,46 @@
+require 'ftools'
+
+module PingMon
+  class ConfigFileNotFound < StandardError
+  end
+
+  class Config
+    def initialize(config_file=PingMon::DEFAULT_CONFIG_FILE)
+      @config_file = config_file
+      @loaded = false
+    end
+
+    attr_accessor :config_file
+
+    def load
+      raise ConfigFileNotFound.new("Configuration file '#{config_file}' could not be found!") unless File.exists?(config_file)
+
+      PingMon.log << "Loading configuration from '#{@config_file}'" if PingMon.log
+
+      text = ERB.new(File.read(config_file)).result
+      hash = YAML.load(text)
+
+      base_config = (hash.symbolize_keys[:config]).stringify_keys
+      base_config.keys.each do |key|
+        instance_variable_set("@#{key}", base_config[key])
+        self.class.class_eval do
+          define_method(key.to_sym) { instance_variable_get("@#{key}") }
+        end
+      end
+      @loaded = true
+
+      self
+    end
+
+    def loaded?
+      @loaded
+    end
+
+    def self.build_config(where=PingMon::DEFAULT_CONFIG_FILE)
+      from = File.dirname(__FILE__) + '/../../config/pingmon.yml'
+      File.copy(File.expand_path(from), where)
+      PingMon.Log << "Created configuration file '#{where}'." if PingMon.log
+    end
+  end
+end
+

data/lib/pingmon/monitor.rb

@@ -0,0 +1,23 @@
+module PingMon
+  class Monitor
+    def initialize(configuration=Config.new)
+      @config = configuration
+    end
+
+    def monitor
+      @config.load unless @config.loaded?
+
+      PingMon.log << "Monitoring host '#{@config.host}'. Will ping every '#{@config.monitor_interval}'." if PingMon.log
+
+      EM.run {
+        pinger = Pinger.new(@config)
+        scheduler = Rufus::Scheduler::EmScheduler.start_new
+
+        scheduler.every @config.monitor_interval do
+          pinger.ping
+        end
+      }
+    end
+  end
+end
+

data/lib/pingmon/pinger.rb

@@ -0,0 +1,49 @@
+module PingMon
+  class Pinger
+    def self.ping(host)
+      ::Ping.pingecho(host)
+    end
+
+    def initialize(configuration=Config.new)
+      @config = configuration
+    end
+
+    def ping
+      @config.load unless @config.loaded?
+
+      PingMon.log << "[#{Time.now}] - Pinging host '#{@config.host}'." if PingMon.log
+      result = PingMon::Pinger.ping(@config.host)
+      unless result
+        PingMon.log << "[#{Time.now}] - '#{@config.host}' appears to be: DOWN. Sending notification." if PingMon.log
+        notify_down_status if @config.notify_when_down
+      else
+        PingMon.log << "[#{Time.now}] - '#{@config.host}' appears to be: UP." if PingMon.log
+      end
+
+      result
+    end
+
+    def host
+      @config.host if @config.loaded?
+    end
+
+    protected
+      def notify_down_status
+        params = build_pony_params_hash
+        Pony.mail(params)
+      end
+
+      def build_pony_params_hash
+        hash = {
+          :to => @config.notify_to,
+          :from => @config.from_address,
+          :subject => "Monitored host '#{@config.host}' seems to be down",
+          :body => "Ping to #{@config.host} failed at #{Time.now}!",
+          :via => @config.transport
+        }
+        hash[:via_options] = @config.smtp_options.symbolize_keys if hash[:via] == :smtp
+        return hash
+      end
+  end
+end
+

data/lib/pingmon/version.rb

@@ -0,0 +1,8 @@
+module PingMon
+  def self.version
+    version_path = File.dirname(__FILE__) + "/../../VERSION"
+    return File.read(version_path).chomp if File.file?(version_path)
+    "0.0"
+  end
+end
+

data/pingmon.gemspec

@@ -0,0 +1,45 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path("../lib/pingmon/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name                = %q{pingmon}
+  s.version             = PingMon.version
+  s.platform            = Gem::Platform::RUBY
+  s.authors             = ["Estanislau Trepat"]
+  s.email               = %q{estanis@etrepat.com}
+  s.homepage            = "http://github.com/etrepat/pingmon"
+  s.summary             = "A stupid local-networking host 'ping' monitoring tool"
+  s.description         = %[
+A stupid monitoring tool which periodically pings a host and sends an email
+notification when it becomes unavailable. It was created merely for learning
+purposes and became my first gem.
+  ]
+  s.date                = %q{2010-07-24}
+
+  s.required_rubygems_version = ">= 1.3.6"
+  s.rubyforge_project         = "pingmon"
+
+  s.add_development_dependency "bundler", ">= 1.0.0"
+  s.add_development_dependency "rspec", "~> 2.0.1"
+
+  s.add_dependency "pony", "~> 1.0.1"
+  s.add_dependency "eventmachine", "~> 0.12.10"
+  s.add_dependency "rufus-scheduler", "~> 2.0.6"
+
+  s.files               = `git ls-files`.split("\n")
+  s.executables         = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact
+  s.require_path        = 'lib'
+  s.default_executable  = %q{pingmon}
+
+  s.post_install_message = %[
+===========================================================================
+Welcome to PingMon!
+
+You may need to run \`pingmon build-config\` now if this is your first time
+using pingmon. If not... well... you should just do... nothing ;).
+
+Cheers!
+===========================================================================
+  ]
+end
+

metadata

@@ -0,0 +1,169 @@
+--- !ruby/object:Gem::Specification 
+name: pingmon
+version: !ruby/object:Gem::Version 
+  hash: 15
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  version: "0.2"
+platform: ruby
+authors: 
+- Estanislau Trepat
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-24 00:00:00 +02:00
+default_executable: pingmon
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 2
+        - 0
+        - 1
+        version: 2.0.1
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: pony
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 21
+        segments: 
+        - 1
+        - 0
+        - 1
+        version: 1.0.1
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: eventmachine
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 59
+        segments: 
+        - 0
+        - 12
+        - 10
+        version: 0.12.10
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rufus-scheduler
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 0
+        - 6
+        version: 2.0.6
+  type: :runtime
+  version_requirements: *id005
+description: "\n\
+  A stupid monitoring tool which periodically pings a host and sends an email\n\
+  notification when it becomes unavailable. It was created merely for learning\n\
+  purposes and became my first gem.\n  "
+email: estanis@etrepat.com
+executables: 
+- pingmon
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- VERSION
+- bin/pingmon
+- config/pingmon.yml
+- lib/pingmon.rb
+- lib/pingmon/config.rb
+- lib/pingmon/monitor.rb
+- lib/pingmon/pinger.rb
+- lib/pingmon/version.rb
+- pingmon.gemspec
+has_rdoc: true
+homepage: http://github.com/etrepat/pingmon
+licenses: []
+
+post_install_message: "\n\
+  ===========================================================================\n\
+  Welcome to PingMon!\n\n\
+  You may need to run `pingmon build-config` now if this is your first time\n\
+  using pingmon. If not... well... you should just do... nothing ;).\n\n\
+  Cheers!\n\
+  ===========================================================================\n  "
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: pingmon
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A stupid local-networking host 'ping' monitoring tool
+test_files: []
+