rubycron 0.1 → 0.2

data/README.md

@@ -15,7 +15,7 @@ By letting RubyCron deal with warnings, errors, and sending reports, you can foc
 
 This gem depends on [Mikel's wonderful mail gem](https://github.com/mikel/mail).
 
-In order to send mail, it assumes you have a local smtp server running on port 25.
+By default, RubyCron assumes you have a local smtp server running on port 25 in order to send mail.
 
 ## Usage
 
@@ -23,11 +23,9 @@ In order to send mail, it assumes you have a local smtp server running on port 2
 
 Open a new file, require and include RubyCron, and then initialize a new RubyCronJob as follows:
 
-	rcj = RubyCronJob.new do |script|
-  		script.author     = 'John Doe'
-  		script.name       = 'test'
-		script.mailto     = 'john@doe.com'
-	end
+	rcj = RubyCronJob.new( 	:author => 'John Doe',
+  							:name   => 'test',
+							:mailto => 'john@doe.com' )
 
 ### Write your cronjob
 
@@ -72,9 +70,9 @@ Simply feed your rubycronjob to rcjrunner.rb as a command-line argument in your
 
 ### I now get all these reports, but I really only care if the job fails! 
 
-Sorting through hundreds of cron mails per day that report successful runs may be gratifying at times, but most sane people only care to be notified when their cronjobs fail. Not to worry, just add to following line to the RubyCronJob's initialization. 
+Sorting through hundreds of cron mails per day that report successful runs may be gratifying at times, but most sane people only care to be notified when their cronjobs fail. Not to worry, just add the following line to the RubyCronJob's initialization hash. 
 
-	script.mailon	= :error
+	:mailon	=> :error
 
 RubyCron will now only report when errors occurred during the run. Other options are :none, :warning and :all (default).
 
@@ -82,35 +80,84 @@ RubyCron will now only report when errors occurred during the run. Other options
 
 Of course. Use 
 
-	script.mailfrom   = 'root@doe.com'
+	:mailfrom => 'root@doe.com'
 
 to change the From:-header.
 
+### Do I really have to configure a local smtp server to send mail?
+
+No. You can use other smtp servers for delivery like so:
+
+	smtpsettings = { 	:address              => 'smtp.gmail.com',
+            			:port                 => 587,
+            			:domain               => 'your.host.name',
+		            	:user_name            => '<username>',
+		            	:password             => '<password>',
+		            	:authentication       => 'plain',
+		            	:enable_starttls_auto => true  }
+            
+	rcj = RubyCronJob.new(  :author     	=> 'John Doe',
+					 		:name       	=> 'test',
+						 	:mailto     	=> 'john@doe.com',
+						 	:mailfrom   	=> 'root@doe.com',
+							:smtpsettings 	=> smtpsettings )
+
 ### I want my cronjob to stop running when there are errors.
 
 No problem. You can configure this behavior with
 
-	script.exiton	= :all
+	:exiton	=> :all
 
 Valid values are :none, :warning, :error, :all.
 
+### Is there a way to manipulate the content of the email reports?
+
+There sure is. Simply write your own ERB template, and tell the RubyCronJob about it with the :template directive.
+
+	rcj = RubyCronJob.new(
+		:author     	=> 'John Doe',
+	 	:name       	=> 'test',
+	 	:mailto     	=> 'john@doe.com',
+	 	:mailfrom   	=> 'root@doe.com',
+		:template 		=> 'my_template.erb' )
+
+Note that from inside the ERB template (my_template.erb in the above example) you have access to the @warnings and @errors arrays.
+
 ### May I please see some output while I'm developing my cronjob?
 
 Output to stdout and stderr can be very useful when debugging your cronjob. Just set the verbose flag to true:
 
-	script.verbose	= true
+	:verbose => true
 
 ### As a sysadmin, I like grepping through files. Can I have a log file please?
 
 Yes. Set a file path in RubyCronJob's logfile variable, and all output will be redirected to file:
 
-	script.logfile	= '/tmp/rcjlogfile'
+	:logfile => '/tmp/rcjlogfile'
 
 Note that you will still receive email reports when you enable file logging. 
 
+### I like all these different options, but can't I set some of them globally for all my cronjobs?
+
+Anything to prevent redundancy, right? Use the :configfile and :configurl directives to point towards YAML files that hold your configuration hashes. For instance, this works:
+
+	rcj = RubyCronJob.new( :configfile => "my_config_file.yml" )
+
+Or this:
+
+	rcj = RubyCronJob.new( :configurl => "http://www.foo.bar/my_config.yml")
+
+Or even a combination:
+
+	rcj = RubyCronJob.new(  :configfile => "my_config_file.yml",
+							:configurl 	=> "http://www.foo.bar/my_config.yml",
+							:author    	=> 'John Doe' )
+	
+Note that in the latter case the values of the directives specified within the RubyCronJob itself will take precedence over the file or url directives.
+
 ## License
 
-Copyright (c) 2011, Bart Kamphorst
+Copyright (c) 2011 - 2012, Bart Kamphorst
 
 (Modified BSD License)
 

data/bin/rcjrunner.rb

@@ -1,11 +1,11 @@
 #!/usr/bin/env ruby
 
 require 'rubygems'
-require 'RubyCron'
+require 'rubycron'
 include RubyCron
 
-if ARGV.empty? || ARGV.size > 1 
-  $stderr.puts "## Usage: rcjrunner.rb <rubycronjob>"
-else
+if ARGV[0]
   instance_eval File.read(ARGV[0])
+else
+  $stderr.puts "## Usage: rcjrunner.rb <rubycronjob>"
 end

data/lib/rubycron.rb

@@ -1,4 +1,4 @@
-# Copyright (c) Bart Kamphorst <rubycron@kamphorst.com>, 2011
+# Copyright (c) Bart Kamphorst <rubycron@kamphorst.com>, 2011 - 2012.
 # Licensed under the modified BSD License. All rights reserved.
 
 module RubyCron
@@ -6,36 +6,88 @@ module RubyCron
   class RubyCronJob
   
   require 'net/smtp'
+  require 'yaml'
+  require 'open-uri'
   require 'rubygems'
   require 'mail'
   require 'erb'
   
-  attr_accessor :name, :author, :mailto, :mailfrom, :mailsubject, :mailon, :exiton, :logfile, :verbose
+  attr_accessor :name, :author, :mailto, :mailfrom, :mailsubject, :mailon, :exiton, :template, :smtpsettings, :logfile, :verbose
+  attr_reader   :warnings, :errors
   
-    def initialize(&block)
+    def initialize(args = nil)
       @warnings, @errors = [], []
-
-      instance_eval(&block)
-      terminate("Cannot connect to local smtp server.") unless smtp_connection?
-      terminate("This job has no name.") unless self.name 
-      terminate("This job has no author.") unless self.author
-      terminate("No To: header was set. ") unless self.mailto
       
-      self.mailfrom ||= 'root@localhost' 
-      self.verbose  ||= false 
-      self.mailon = :all unless self.mailon && [:none, :warning, :error, :all].include?(self.mailon)
-      self.exiton = :all unless self.exiton && [:none, :warning, :error, :all].include?(self.exiton)
-
-      if self.logfile
-        $stdout.reopen(self.logfile, "a")
-        $stdout.sync = true
-        $stderr.reopen($stdout)
+      case args
+        when NilClass then yield self if block_given?
+        when Proc     then instance_eval(args)
+        when Hash     then 
+          
+          args = load_config(:file, args[:configfile]).merge(args) if args[:configfile]
+          args = load_config(:url, args[:configurl]).merge(args)   if args[:configurl] 
+          
+          args.each do |key, value|
+            instance_variable_set("@#{key}", value) if value
+          end
+        else terminate "Expected a hash or a block to initialize, but instead received a #{args.class} object."
       end
+            
+      check_sanity
+      
       rescue => e
-        $stdout = STDOUT
         terminate(e.message)
     end
     
+    def load_config(source_type, source)
+      if source_type == :file
+        io = File.open(source) if File.file?(source)
+      elsif source_type == :url
+        io = open(source)
+      end
+      yml = YAML::load(io)
+      return yml if yml.is_a?(Hash)
+      return {}
+    end
+    
+    def check_sanity
+      
+      raise "This job has no name."   unless @name 
+      raise "This job has no author." unless @author
+      raise "No To: header was set. " unless @mailto
+      
+      check_smtp_settings
+      set_defaults
+      enable_file_logging if @logfile  
+  
+    end
+    
+    def check_smtp_settings     
+      if @smtpsettings
+        raise "SMTP settings have to be passed in as a hash." unless @smtpsettings.instance_of?(Hash)
+        raise "SMTP settings should include at least an address (:address)." unless @smtpsettings.keys.include?(:address)
+        raise "SMTP settings should include at least a port number (:port)." unless @smtpsettings.keys.include?(:port)
+      else
+        raise "Cannot connect to local smtp server." unless smtp_connection?
+      end
+    end
+    
+    def set_defaults
+      @mailfrom       ||= 'root@localhost' 
+      @verbose        ||= false 
+      @template       ||= File.join(File.dirname(__FILE__), '/report.erb')
+      @mailon = :all unless self.mailon && [:none, :warning, :error, :all].include?(self.mailon)
+      @exiton = :all unless self.exiton && [:none, :warning, :error, :all].include?(self.exiton)
+    end
+    
+    def enable_file_logging
+      $stdout.reopen(@logfile, "a")
+      $stdout.sync = true
+      $stderr.reopen($stdout)
+      rescue => e
+        $stdout = STDOUT
+        raise e
+    end
+        
     def terminate(message)
       $stderr.puts "## Cannot complete job. Reason: #{message}"
       exit 1
@@ -85,12 +137,19 @@ module RubyCron
     # an erb template file, and mikel's excellent mail gem. 
     private
     def report
-      self.mailsubject = "Cron report for #{name}: #{@warnings.size} warnings & #{@errors.size} errors" unless self.mailsubject
-      mailfrom = self.mailfrom
-      mailto = self.mailto
-      mailsubject = self.mailsubject
-      mailbody = ERB.new(File.read(File.join(File.dirname(__FILE__), '/report.erb'))).result(binding)
+      @mailsubject  = "Cron report for #{name}: #{@warnings.size} warnings & #{@errors.size} errors" unless @mailsubject
+      mailfrom      = @mailfrom
+      mailto        = @mailto
+      mailsubject   = @mailsubject
+      mailbody      = ERB.new(File.read(@template)).result(binding)
     
+      if @smtpsettings
+        smtpsettings = @smtpsettings 
+        Mail.defaults do
+          delivery_method :smtp, smtpsettings
+        end
+      end
+      
       mail = Mail.new do
         from    mailfrom
         to      mailto

data/sample/test.rcj

@@ -1,18 +1,17 @@
 #!/usr/bin/env ruby 
 
 require 'rubygems'
-require 'RubyCron'
+require 'rubycron'
 include RubyCron
 
-rcj = RubyCronJob.new do |script|
-  script.author     = 'John Doe'
-  script.name       = 'test'
-  script.mailto     = 'john@doe.com'
-  script.mailfrom   = 'root@doe.com'
-  script.mailon     = :all
-  script.exiton     = :none
-  script.verbose    = false
-end
+rcj = RubyCronJob.new(
+  :author     => 'John Doe',
+  :name       => 'test',
+  :mailto     => 'john@doe.com',
+  :mailfrom   => 'root@doe.com',
+  :mailon     => :all,
+  :exiton     => :none,
+  :verbose    => false )
 
 rcj.execute do 
   unless File.directory?('/tmp')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubycron
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: '0.2'
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-19 00:00:00.000000000 +02:00
-default_executable: 
+date: 2012-01-27 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mail
-  requirement: &2160625260 !ruby/object:Gem::Requirement
+  requirement: &2153384820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,7 +21,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2160625260
+  version_requirements: *2153384820
 description: Write clean cronjobs in Ruby, and get reporting for free!
 email: rubycron@kamphorst.com
 executables: []
@@ -36,7 +35,6 @@ files:
 - lib/report.erb
 - sample/test.rcj
 - bin/rcjrunner.rb
-has_rdoc: true
 homepage: https://github.com/bartkamphorst/rubycron
 licenses: []
 post_install_message: 
@@ -57,7 +55,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: Simplifies your Ruby cronjobs by automating the reporting process.