log_master 0.1.4 → 0.2.0

data/README.rdoc

@@ -1,6 +1,45 @@
-= log_master
+== log_master
 
-Description goes here.
+A simple library for mailing log (or whatever) files back to you!
+
+This was written as a failsafe for cron tasks who's output we wanted conditionally sent to
+one email address or another. The idea is that under normal conditions you don't want to spam
+your inbox with emails stating 'everything is fine.' Instead you can have it go directly into
+archive unless it has some idea that something is going wrong.
+
+== Installation
+  $ sudo gem install log_master
+
+== Instructions
+  $ log_master -p [--log-pattern] PATTERN [-c | --config PATH]
+
+Where PATTERN is a glob representing the files you would like to email and PATH is the path to
+a configuration file (defaults to config/log_master.rb)
+
+== Configuration
+
+You should put something like the following in config/log_master.rb
+
+  LogMaster::Configuration.configure do |config|  
+    config.title = "Cron Update Notice"
+    config.reporting = {:warn => /error/i, :error => /aborted/i}
+    config.failure_conditions = [:error]
+
+    config.recipients = {:success => 'success@example.com', :failure => 'failure@example.com' }
+
+    config.reply_to = "no-reply@likeassets.com"
+    config.from = "mail@likeassets.com"
+  end
+
+I only provided direct ActionMailer setters for from and reply_to as the intention is to let LogMaster
+determine via failure_conditions and its recipients attribute where the email should go. Feel free to fork
+and change this if it leaves something to be desired.
+
+== Customization
+
+The 'reporting' attribute can take a completely custom hash of 'name' => 'regexp' so you can define your
+own warning, failure, info or debug conditions. Only if it contains anything specified in 'failure_conditions'
+will it consider it a failure.
 
 == Note on Patches/Pull Requests
  

data/Rakefile

@@ -15,7 +15,7 @@ begin
     gem.email = "zbelzer@gmail.com"
     gem.homepage = "http://github.com/moneypools/log_master"
     gem.authors = ["Zachary Belzer"]
-    gem.add_dependency "actionmailer"
+    gem.add_dependency "actionmailer", ">= 2.2.2"
     gem.add_development_dependency "rspec"
     gem.add_development_dependency "email_spec", " >= 0.3.5"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings

data/VERSION

@@ -1 +1 @@
-0.1.4
+0.2.0

data/bin/log_master

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'optparse'
+require 'log_master'
+
+options = Hash.new
+log_pattern = nil
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: log_master [options]"
+  
+  opts.on('-p', '--log-pattern PATTERN', "A globbing pattern designating files to email") do |pattern|
+    log_pattern = pattern
+  end
+  
+  opts.on('-c', '--config [FILE]', 'A configuration file. Default: config/log_master.rb') do |file|
+    options[:file] = file if file
+  end
+end.parse!
+
+if log_pattern.nil? || log_pattern == ""
+  $stderr.puts "You must supply a log-pattern. See --help"
+  exit(1)
+end
+
+if files = Dir[log_pattern] and files.empty?
+  $stderr.puts "No files were found matching pattern '#{log_pattern}'"
+  exit(1)
+else
+  LogMaster::Director.execute(files, options)
+end

data/lib/log_master/director.rb

@@ -5,11 +5,17 @@ module LogMaster
   
     attr_accessor :reports, :logs
   
-    def initialize(files)
-      raise "LogMaster has not yet been configured" unless Configuration.configured?
-      @configuration = Configuration.instance
+    def self.execute(files, options={})
+      new(files, options).run
+    end
+  
+    def initialize(files, options={})
+      @options = options
+      @options[:file]       ||= 'config/log_master.rb'
+      
       @reports = {}
       
+      load_configuration
       create_log_files(files)
     end
     
@@ -17,6 +23,19 @@ module LogMaster
       aggregate!
       send_email
     end
+    
+    def load_configuration
+      require @options[:file] if File.exists?(@options[:file])
+    
+      # config = File.read(@options[:file])
+      # eval(config)
+      
+      if Configuration.configured?
+        @configuration = Configuration.instance
+      else
+        raise "[fail] LogMaster is not configured"
+      end
+    end
   
     def aggregate!
       logs.each do |l|

data/log_master.gemspec

@@ -5,13 +5,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{log_master}
-  s.version = "0.1.4"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Zachary Belzer"]
-  s.date = %q{2009-12-03}
+  s.date = %q{2010-01-15}
+  s.default_executable = %q{log_master}
   s.description = %q{Creates and emails a simple report for a set of log (or text) files. Useful for aggretating small log files.}
   s.email = %q{zbelzer@gmail.com}
+  s.executables = ["log_master"]
   s.extra_rdoc_files = [
     "LICENSE",
      "README.rdoc"
@@ -23,6 +25,7 @@ Gem::Specification.new do |s|
      "README.rdoc",
      "Rakefile",
      "VERSION",
+     "bin/log_master",
      "features/log_master.feature",
      "features/step_definitions/email_steps.rb",
      "features/step_definitions/log_master_steps.rb",
@@ -33,7 +36,6 @@ Gem::Specification.new do |s|
      "lib/log_master/director.rb",
      "lib/log_master/log_file.rb",
      "lib/log_master/notifier.rb",
-     "lib/log_master/rake/log_task.rb",
      "lib/templates/log_master/notifier/update_notification.html.erb",
      "log_master.gemspec",
      "spec/configuration_spec.rb",
@@ -43,8 +45,7 @@ Gem::Specification.new do |s|
      "spec/fixtures/log_without_errors.log",
      "spec/log_file_spec.rb",
      "spec/notification_spec.rb",
-     "spec/spec_helper.rb",
-     "tasks/log_master.rake"
+     "spec/spec_helper.rb"
   ]
   s.homepage = %q{http://github.com/moneypools/log_master}
   s.rdoc_options = ["--charset=UTF-8"]
@@ -64,16 +65,16 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<actionmailer>, [">= 0"])
+      s.add_runtime_dependency(%q<actionmailer>, [">= 2.2.2"])
       s.add_development_dependency(%q<rspec>, [">= 0"])
       s.add_development_dependency(%q<email_spec>, [">= 0.3.5"])
     else
-      s.add_dependency(%q<actionmailer>, [">= 0"])
+      s.add_dependency(%q<actionmailer>, [">= 2.2.2"])
       s.add_dependency(%q<rspec>, [">= 0"])
       s.add_dependency(%q<email_spec>, [">= 0.3.5"])
     end
   else
-    s.add_dependency(%q<actionmailer>, [">= 0"])
+    s.add_dependency(%q<actionmailer>, [">= 2.2.2"])
     s.add_dependency(%q<rspec>, [">= 0"])
     s.add_dependency(%q<email_spec>, [">= 0.3.5"])
   end

data/spec/director_spec.rb

@@ -3,6 +3,7 @@ require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 module LogMaster
   describe "Director" do
     before do
+      Configuration.stub!(:configured?).and_return(true)
       @files = %w(log_without_errors.log log_with_errors.log).map {|f| log_file_path(f) }
     end
     
@@ -11,9 +12,8 @@ module LogMaster
     end
     
     it "should raise error if not configured" do
-      Configuration.instance.reset_configured_status!
+      Configuration.stub!(:configured?).and_return(false)
       lambda {Director.new(@files)}.should raise_error
-      Configuration.configure {|c|} # Reset configured state
     end
   
     describe "aggregate" do
@@ -24,7 +24,6 @@ module LogMaster
       end
     end
     
-    
     describe "successful?" do
       it "should be true when no aggregate count for failure_conditions" do
         log_master = Director.new(log_file_path('log_without_errors.log'))

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: log_master
 version: !ruby/object:Gem::Version 
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors: 
 - Zachary Belzer
@@ -9,8 +9,8 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-03 00:00:00 -06:00
-default_executable: 
+date: 2010-01-15 00:00:00 -06:00
+default_executable: log_master
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: actionmailer
@@ -20,7 +20,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: "0"
+        version: 2.2.2
     version: 
 - !ruby/object:Gem::Dependency 
   name: rspec
@@ -44,8 +44,8 @@ dependencies:
     version: 
 description: Creates and emails a simple report for a set of log (or text) files. Useful for aggretating small log files.
 email: zbelzer@gmail.com
-executables: []
-
+executables: 
+- log_master
 extensions: []
 
 extra_rdoc_files: 
@@ -58,6 +58,7 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION
+- bin/log_master
 - features/log_master.feature
 - features/step_definitions/email_steps.rb
 - features/step_definitions/log_master_steps.rb
@@ -68,7 +69,6 @@ files:
 - lib/log_master/director.rb
 - lib/log_master/log_file.rb
 - lib/log_master/notifier.rb
-- lib/log_master/rake/log_task.rb
 - lib/templates/log_master/notifier/update_notification.html.erb
 - log_master.gemspec
 - spec/configuration_spec.rb
@@ -79,7 +79,6 @@ files:
 - spec/log_file_spec.rb
 - spec/notification_spec.rb
 - spec/spec_helper.rb
-- tasks/log_master.rake
 has_rdoc: true
 homepage: http://github.com/moneypools/log_master
 licenses: []

data/lib/log_master/rake/log_task.rb

@@ -1,20 +0,0 @@
-require 'log_master'
-
-module LogMaster
-  module Rake    
-    class LogTask < ::Rake::Task
-      attr_accessor :log_pattern
-      
-      protected
-      def execute(*args)
-        super
-        run_log_master
-      end
-    
-      def run_log_master
-        files = Dir[log_pattern]
-        LogMaster::Director.new(files).run
-      end
-    end
-  end
-end

data/tasks/log_master.rake

@@ -1,18 +0,0 @@
-namespace :log_master do
-  task :configure do
-    require 'actionmailer'
-    ActionMailer::Base.delivery_method = :sendmail
-    
-    LogMaster::Configuration.configure do |config|
-      config.title = "This is a sample email"
-      config.recipients = {:success => 'localhost', :failure => 'localhost' }
-      config.reporting = {:warn => /WARN/, :error => /ERROR/, :fatal => /FATAL/}
-      config.reply_to = "sender@example.com"
-    end
-  end
-  
-  desc "Runs log master on specified log file"
-  LogMaster::Rake::LogTask.define_task "test" => :configure do |t|
-    t.log_pattern = ENV['log_pattern'] || "spec/fixtures/log_with_errors.log"
-  end
-end