reckoner 0.4.0 → 0.9.2

data/Gemfile

@@ -0,0 +1,3 @@
+source 'http://rubygems.org'
+
+gem 'mail'

data/History.txt

@@ -1,3 +1,7 @@
+=== 0.9.0 / 2010-3-31
+* Moving to github and gemcutter
+* Switched to new 'mail' gem instead of rolling my own
+
 === 0.2.0 / 2009-06-19
 
 * Still more to do:

data/README.txt

@@ -1,6 +1,6 @@
 = reckoner
 
-* http://reckoner.rubyforge.com
+* http://github.com/geoffk/reckoner
 
 == DESCRIPTION:
 
@@ -26,16 +26,16 @@ the CONFIG FILE argument or from stdin.
 
 *Options*
 
-  -d --debug Output debugging information
-
-  -q --quiet Suppress the check output
-
-  -c --checks=FILE Specifies a Ruby file that contains
-  additional checks that can be performed.
+    -d, --debug                      Output debugging information
+    -q, --quiet                      Do not print final report
+    -e, --email-off                  Do not send email, even if configured
+    -c, --checks=FILE                Additional checks file
+    -s, --sample-config FILE         Create a sample config named FILE
 
 == REQUIREMENTS:
 
 * Ruby
+* Ruby 'mail' gem
 
 == INSTALL:
 

data/lib/main.rb

@@ -2,13 +2,13 @@ require 'net/smtp'
 require 'rubygems'
 require 'yaml'
 require 'optparse'
-require 'ftools'
+require 'fileutils'
+require 'mail'
 
 require 'rfile.rb'
 require 'abstract_check.rb'
-require 'reckoner'
-require 'sendmail'
-require 'sample'
+require 'reckoner.rb'
+require 'sample.rb'
 
 =begin rdoc
 The Main class ties together the core Reckoner functionality
@@ -97,24 +97,25 @@ class Main
 
   def send_email(cm,mail_config)
     raise "Mail section must have a 'to' parameter" unless mail_config['to']
-    mailobj = Sendmail.new(mail_config['sendmail_path'],
-                           mail_config['sendmail_options'])
 
-    from = mail_config['from'] || ENV['USER']
     always_mail = mail_config['always_mail'] || true
-    subject = mail_config['subject_prefix'] || 'Reckoner:'
-    subject.strip!
-    subject << ' '
+
+    mail = Mail.new
+    mail[:from] = mail_config['from'] || ENV['USER'] + '@' + ENV['HOSTNAME']
+    mail[:to] = mail_config['to']
+
+    prefix = mail_config['subject_prefix'] || 'Reckoner:'  
+    prefix.strip
 
     if !cm.errors.empty?
-      subject << "Found #{cm.errors.length} problem(s)"
-      body = cm.errors.join("\n")
-      mailobj.send(mail_config['to'],from,subject,body)
+      mail[:subject] = "#{prefix} Found #{cm.errors.length} problem(s)"
+      mail[:body] = cm.errors.join("\n")
     elsif always_mail
-      subject << "No problems found"
-      body = "No problems found"
-      mailobj.send(mail_config['to'],from,subject,body)
+      mail[:subject] = "#{prefix} No problems found"
+      mail[:body] = "No problems found"
     end
+
+    mail.deliver!
   end
 
   def output_results(cm)

data/lib/reckoner.rb

@@ -58,6 +58,8 @@ class Reckoner
 
       base_path = checks.delete('base_path')
 
+      files = [files] unless files.is_a? Array
+
       files.each do |f|
         if base_path
           file_path = File.join(base_path,f.strip)

data/lib/sample.rb

@@ -47,8 +47,6 @@ mail:
   to: DESTINATION EMAIL ADDRESS
   #from: defaults to current user 
   #subject_prefix: "RECKONER:"
-  #sendmail_path: sendmail
-  #sendmail_options: -i -t
   #always_email: true
 
 SAMPLE

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: reckoner
 version: !ruby/object:Gem::Version 
-  version: 0.4.0
+  prerelease: false
+  segments: 
+  - 0
+  - 9
+  - 2
+  version: 0.9.2
 platform: ruby
 authors: 
 - Geoff Kloess
@@ -9,94 +14,77 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-02 00:00:00 -07:00
+date: 2010-03-31 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: hoe
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  name: mail
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 2.2.0
-    version: 
-description: |-
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: |
   Ruby Reckoner is an easily-configurable program that monitors
   files and can send notifications when it finds problems.
   
   Currently it can only check that files exist, have been updated
   recently and that they have a minimum size, however it is easy to add
   your own checks written in Ruby.
-email: 
-- geoff.kloess@gmail.com
+
+email: geoff.kloess@gmail.com
 executables: 
 - reckoner
 extensions: []
 
-extra_rdoc_files: 
-- History.txt
-- Manifest.txt
-- README.txt
+extra_rdoc_files: []
+
 files: 
+- Gemfile
 - History.txt
-- Manifest.txt
 - README.txt
-- Rakefile
 - bin/reckoner
-- lib/main.rb
-- lib/reckoner.rb
 - lib/abstract_check.rb
 - lib/rfile.rb
+- lib/standard_checks.rb
+- lib/main.rb
 - lib/sendmail.rb
+- lib/reckoner.rb
 - lib/sample.rb
-- lib/standard_checks.rb
-- test/support.rb
-- test/test_abstract_check.rb
-- test/test_exist.rb
-- test/test_freshness.rb
-- test/test_main.rb
-- test/test_minimum_size.rb
-- test/test_rfile.rb
-- test/test_support.rb
-- test/files/one-k.bin
-- test/files/additional_checks.rb
 has_rdoc: true
-homepage: http://reckoner.rubyforge.com
+homepage: http://github.com/geoffk/reckoner
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --main
-- README.txt
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
-rubyforge_project: reckoner
-rubygems_version: 1.3.4
+rubyforge_project: 
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
-summary: Ruby Reckoner is an easily-configurable program that monitors files and can send notifications when it finds problems
-test_files: 
-- test/test_abstract_check.rb
-- test/test_exist.rb
-- test/test_freshness.rb
-- test/test_main.rb
-- test/test_minimum_size.rb
-- test/test_reckoner.rb
-- test/test_rfile.rb
-- test/test_support.rb
+summary: Checks user-specified files and sends alert emails when not found.
+test_files: []
+

data/Manifest.txt

@@ -1,22 +0,0 @@
-History.txt
-Manifest.txt
-README.txt
-Rakefile
-bin/reckoner
-lib/main.rb
-lib/reckoner.rb
-lib/abstract_check.rb
-lib/rfile.rb
-lib/sendmail.rb
-lib/sample.rb
-lib/standard_checks.rb
-test/support.rb
-test/test_abstract_check.rb
-test/test_exist.rb
-test/test_freshness.rb
-test/test_main.rb
-test/test_minimum_size.rb
-test/test_rfile.rb
-test/test_support.rb
-test/files/one-k.bin
-test/files/additional_checks.rb

data/Rakefile

@@ -1,11 +0,0 @@
-# -*- ruby -*-
-
-require 'rubygems'
-require 'hoe'
-
-Hoe.spec 'reckoner' do
-  # self.rubyforge_name = 'reckonerx' # if different than 'reckoner'
-  self.developer('Geoff Kloess', 'geoff.kloess@gmail.com')
-end
-
-# vim: syntax=ruby

data/test/files/additional_checks.rb

@@ -1,10 +0,0 @@
-
-class Extension < AbstractCheck
-
-  def check(path_obj,options)
-    unless path_obj.extname == options.strip
-      add_error 'is not a txt file'
-    end
-  end
-end
-

data/test/support.rb

@@ -1,41 +0,0 @@
-####
-# Offers support for running backup check tests
-
-require 'fileutils'
-
-module BackupCheckSupport
-  include FileUtils
-
-  ROOT = '/tmp/file_verifier_tests'
-
-  #Makes a set of file that meet the specified options
-  def makef(root,name,options = {})
-    mkdir root unless File.exists?(root.to_s)
-    if name.is_a? Hash
-      name.each do |k,n|
-        makef File.join(root,k.to_s),n,options
-      end
-    elsif name.is_a? Array
-      name.each do |n|
-        makef(root,n,options)
-      end
-    elsif name.is_a?(String) || name.is_a?(Symbol)
-      path = File.join(root,name.to_s)
-      touch path
-      File.chmod(options[:chmod],path) if options[:chmod]
-      File.utime(options[:atime],options[:atime],path) if options[:atime]
-    end
-  end
-
-  #Converts days to seconds
-  def d2s(days)
-    days * 24 * 60 * 60
-  end
-
-  #Determines if the object has any errors matching the regular
-  #expression.
-  def has_error(cmain,reg)
-    cmain.errors.any?{|msg| reg.match msg}
-  end
-
-end

data/test/test_abstract_check.rb

@@ -1,36 +0,0 @@
-require 'test/support'
-require 'lib/main'
-require 'test/unit'
-
-class TestCheck < AbstractCheck
-  check_name 'test_check'
-end
-
-class TestCheckTwo < AbstractCheck
-end
-
-class AbstractTest < Test::Unit::TestCase
-  include BackupCheckSupport
-
-  #Test that the name of a test is set correctly and
-  #that it can be over-ridden.
-  def test_abstract_check
-    assert_equal 'test_check', TestCheck.get_check_name
-    assert_equal 'test_check_two', TestCheckTwo.get_check_name
-
-    tc2 = TestCheckTwo.new('.')
-    assert tc2.is_a?(AbstractCheck)
-  end
-
-  def test_unit_parse
-    uhash = { /^inch/ => 1, /^feet/ => 12, /^foot/ => 12, 'default' => 1 }
-    ac = AbstractCheck.new(__FILE__)
-    assert_equal 1, ac.unit_parse("1", uhash)
-    assert_equal 1, ac.unit_parse("1 inch", uhash)
-    assert_equal 1, ac.unit_parse("1inch", uhash)
-    assert_equal 1.5, ac.unit_parse("1.5inch", uhash)
-    assert_equal 12, ac.unit_parse("1 foot", uhash)
-    assert_equal 24, ac.unit_parse("2 feet", uhash)
-  end
-
-end

data/test/test_exist.rb

@@ -1,36 +0,0 @@
-require 'test/support'
-require 'lib/main'
-require 'test/unit'
-
-class ExistsTest < Test::Unit::TestCase
-  include BackupCheckSupport
-
-  def setup
-    @root = '/tmp/test'
-    makef(@root,['one','two','three'])
-  end
-
-  def teardown
-    rm_rf @root
-  end
-
-  def test_files_exist
-    cm = Reckoner.new()
-    cm.check('test'=> {'files'=>'/tmp/test/one'})
-    assert cm.errors.empty?
-
-    cm.check('test'=> {'files'=>['/tmp/test/one','/tmp/test/two']})
-    assert cm.errors.empty?
-    
-    cm.check('test'=> {'base_path'=>'/tmp/test','files'=>['one','two']})
-    assert cm.errors.empty?
-  end
-
-  def test_errors
-    cm = Reckoner.new(nil)
-    cm.check('test'=>{'files'=>'nofile'})
-    assert_equal 1,cm.errors.length
-    assert has_error(cm,/does not exist/)
-  end
-
-end

data/test/test_freshness.rb

@@ -1,49 +0,0 @@
-require 'test/unit'
-require 'date'
-require 'test/support'
-require 'lib/main'
-
-class FreshnessTest < Test::Unit::TestCase
-  include BackupCheckSupport
-
-  def setup
-    makef(ROOT,['one','two','three', 
-                 {'dir' => ['four','five']}], :atime => Time.now - d2s(10))
-    makef(ROOT,'six', :atime => Time.now - d2s(1))
-    @cm = Reckoner.new()
-  end
-
-  def teardown
-    rm_rf ROOT
-  end
-
-  def test_single_file_success
-    @cm.check('test'=> {'files'=>File.join(ROOT,'one'), 'freshness' => '20'})
-    assert @cm.errors.empty?
-
-    @cm.check('test'=> {'files'=>File.join(ROOT,'six'), 'freshness' => '30 hours'})
-    assert @cm.errors.empty?
-  end
-
-  def test_single_file_failure
-    @cm.check('test'=> {'files'=>File.join(ROOT,'one'), 'freshness' => '5'})
-    assert_equal 1, @cm.errors.length
-    assert has_error(@cm,/file is too old/)
-  end
-
-  def test_hour_failure
-    @cm.check('test'=> {'files'=>File.join(ROOT,'six'), 'freshness' => '22 hours'})
-    assert_equal 1, @cm.errors.length
-    assert has_error(@cm,/file is too old/)
-  end
-
-  def test_recursive_success
-    hundred_days_ago = Time.now - d2s(100)
-    File.utime(hundred_days_ago,hundred_days_ago,ROOT)
-    assert_equal File.mtime(ROOT).to_s,hundred_days_ago.to_s
-    
-    @cm.check('test'=> {'files'=>ROOT, 'freshness' => '20'})
-    assert @cm.errors.empty?
-  end
-
-end

data/test/test_main.rb

@@ -1,60 +0,0 @@
-require 'test/unit'
-require 'date'
-require 'test/support'
-require 'lib/main'
-
-class MainTest < Test::Unit::TestCase
-  include BackupCheckSupport
-
-  def setup
-    makef(ROOT,[{'d1' => ['d1f1', 'd1f2', 'd1f3']},
-                'f4','h1.txt',
-                ['f5', 'f6', 'f7'],
-                {'d2' => ['d2f1', 'd2f2']}])
-    @good_config = <<-CONFIG
-      check:
-        default_check:
-          base_path: #{ROOT}
-        f4:
-          files: f4
-        d1:
-          files: [d1, d1/d1f1]
-    CONFIG
-  end
-
-  def teardown
-    rm_rf ROOT
-  end
-
-  def test_simple
-    m = Main.new([])
-    out = m.run_config(@good_config)
-    assert(/No failed checks/.match(out))
-  end
-
-  def test_sample_config
-    fname = ROOT + '/sample.yaml'
-    m1 = Main.new(['-s',fname])
-    m1.run_reckoner
-    assert File.exists?(fname)
-
-    m2 = Main.new(['-e',fname])
-    out = m2.run_reckoner
-    assert(/Reckoner found a problem with '\/etc\/fake-file'/.match(out))
-    assert out.split("\n").length > 4
-  end
-
-  def test_additional_checks
-    m1 = Main.new(['-c','test/files/additional_checks.rb'])
-    out = m1.run_config <<-CONFIG
-      check:
-        default_check:
-          base_path: #{ROOT}
-        txt:
-          files: [d1, h1.txt]
-          extension: .txt
-     CONFIG
-    assert_equal 2,out.split("\n").length
-    assert(/Extension found a problem with '\/tmp\/file_verifier_tests\/d1'/.match(out))
-  end
-end

data/test/test_minimum_size.rb

@@ -1,33 +0,0 @@
-require 'test/unit'
-require 'date'
-require 'test/support'
-require 'lib/main'
-
-class MinimumSizeTest < Test::Unit::TestCase
-  include BackupCheckSupport
-
-  def setup
-    @cm = Reckoner.new()
-    @bin = File.join('test','files','one-k.bin')
-  end
-
-  def test_file_right_size
-    @cm.check('test'=> {'files'=>@bin, 'minimum_size' => '1'})
-    assert @cm.errors.empty?
-  end
-
-  def test_file_too_small
-    @cm.check('test'=> {'files'=>@bin, 'minimum_size' => '2048'})
-    assert_equal 1, @cm.errors.length
-    assert has_error(@cm,/file is too small/)
-  end
-
-  def kilobyte_parsing
-    @cm.check('test'=> {'files'=>@bin, 'minimum_size' => '1kb'})
-    assert @cm.errors.empty?
-
-    @cm.check('test'=> {'files'=>@bin, 'minimum_size' => '2kb'})
-    assert_equal 1, @cm.errors.length
-    assert has_error(@cm,/file is too small/)
-  end
-end

data/test/test_reckoner.rb

@@ -1,38 +0,0 @@
-require 'test/unit'
-require 'date'
-require 'test/support'
-require 'lib/main'
-
-class ReckonerTest < Test::Unit::TestCase
-  include BackupCheckSupport
-
-  def setup
-    makef(ROOT,['one','two','three'], :atime => Time.now - d2s(10))
-    @cm = Reckoner.new()
-  end
-
-  def teardown
-    rm_rf ROOT
-  end
-
-  def test_non_existant_check
-    assert_raise RuntimeError do
-      @cm.check('test'=> {'files'=> File.join(ROOT,'one'), 'nocheck' => '20'})
-    end
-  end
-
-  def test_multiple_files
-    @cm.check('test'=> {'files'=> [File.join(ROOT,'one'), File.join(ROOT,'two')]})
-    assert @cm.errors.empty?
-
-    @cm.check('test'=> {'files'=> [File.join(ROOT,'one'), 
-                                   File.join(ROOT,'blah'),
-                                   File.join(ROOT,'two'),
-                                   File.join(ROOT,'other'),
-                                  ]})
-    assert_equal 2, @cm.errors.length
-    assert(/file does not exist/.match(@cm.errors[0]))
-    assert(/file does not exist/.match(@cm.errors[1]))
-  end
-
-end

data/test/test_rfile.rb

@@ -1,37 +0,0 @@
-require 'test/unit'
-require 'date'
-require 'test/support'
-require 'lib/main'
-
-class RFileTest < Test::Unit::TestCase
-  include BackupCheckSupport
-
-  def setup
-    makef(ROOT,[{:d1 => [:f1, :f2, :f3]},
-                {:d2 => [{ :d3 => :f3 }, :f4]}])
-    @cfile = RFile.new(ROOT)
-  end
-
-  def teardown
-    rm_rf ROOT
-  end
-
-  def test_methods
-    assert_equal @cfile.path, ROOT
-    assert_equal @cfile.atime, File.atime(ROOT)
-    assert_equal @cfile.mtime, File.mtime(ROOT)
-    assert_equal @cfile.stat, File.stat(ROOT)
-    assert_equal @cfile.basename, File.basename(ROOT)
-    assert_equal @cfile.expand_path, File.expand_path(ROOT)
-  end
-
-  def test_recurse_functions
-    assert_equal 9, @cfile.sub_node_array.length
-    assert_equal 5, @cfile.sub_node_array(:directories => false).length
-    assert_equal 4, @cfile.sub_node_array(:files => false).length
-
-    assert @cfile.all_sub_nodes?{|f| f.basename.length == 2 || f.directory? } 
-    assert @cfile.any_sub_node?{|f| f.basename == 'f3' } 
-  end
-
-end

data/test/test_support.rb

@@ -1,28 +0,0 @@
-require 'test/unit'
-require 'date'
-require 'test/support'
-
-class SupportTest < Test::Unit::TestCase
-  include BackupCheckSupport
-
-  def test_makef
-    makef(ROOT,[{'d1' => ['d1f1', 'd1f2', 'd1f3']},
-                'f4',
-                ['f5', 'f6', 'f7'],
-                {'d2' => ['d2f1', 'd2f2']}])
-
-    assert File.exists?(File.join(ROOT,'d1'))
-    assert File.exists?(File.join(ROOT,'f4'))
-    assert File.exists?(File.join(ROOT,'f5'))
-    assert File.exists?(File.join(ROOT,'f6'))
-    assert File.exists?(File.join(ROOT,'f7'))
-    assert File.exists?(File.join(ROOT,'d1','d1f1'))
-    assert File.exists?(File.join(ROOT,'d1','d1f2'))
-    assert File.exists?(File.join(ROOT,'d1','d1f3'))
-    assert File.exists?(File.join(ROOT,'d2'))
-    assert File.exists?(File.join(ROOT,'d2','d2f1'))
-    assert File.exists?(File.join(ROOT,'d2','d2f2'))
-    rm_rf ROOT
-  end
-
-end