rubycron 0.1

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gem "mail"

data/README.md

@@ -0,0 +1,140 @@
+# RubyCron
+
+Define your cronjobs in your favorite language, and get reporting for free!
+
+By letting RubyCron deal with warnings, errors, and sending reports, you can focus on writing clean and effective cronjobs in Ruby.
+
+## Author
+
+* Bart Kamphorst
+
+## Installation
+	#> gem install rubycron
+
+### Dependencies 
+
+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.
+
+## Usage
+
+### Configure the basics
+
+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
+
+### Write your cronjob
+
+Call RubyCronJob's execute method, and define your cronjob within the do-end block.
+
+	rcj.execute do 
+	  unless File.directory?('/tmp')
+	    warning "Something awry is going on with /tmp."
+	  end
+	  begin
+	  File.open('/tmp/rubycrontest', 'w') do |f|
+	  	f.write("Test completed successfully.")
+	  end
+	  rescue => e
+	    error "Something went wrong trying to write to file: #{e.message}"
+	  end
+	end
+	
+That's it! Now when you run this cronjob, you will receive a report by email.
+
+## Set up Cron
+
+To activate the cronjob, add it to your crontab like any other cronjob. There are, however, two ways to do this: run the RubyCronJob as a stand-alone script, or have the RubyCronJob be executed by rcjrunner.rb.
+
+### Stand-alone
+
+For the stand-alone option, add a crontab entry like so:
+	
+	min		hour	mday	month	wday	command
+	* 		* 		* 		* 		* 		test.rcj
+
+For this to work properly, make sure your rubycronjob (test.rcj in this example) starts with a shebang and is executable.
+
+### Using rcjrunner.rb
+
+Simply feed your rubycronjob to rcjrunner.rb as a command-line argument in your crontab entry:
+	
+	min		hour	mday	month	wday	command
+	* 		* 		* 		* 		* 		rcjrunner.rb test.rcj
+
+## Other configuration options
+
+### 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. 
+
+	script.mailon	= :error
+
+RubyCron will now only report when errors occurred during the run. Other options are :none, :warning and :all (default).
+
+### All emails originate from root@localhost. Can I change that?
+
+Of course. Use 
+
+	script.mailfrom   = 'root@doe.com'
+
+to change the From:-header.
+
+### I want my cronjob to stop running when there are errors.
+
+No problem. You can configure this behavior with
+
+	script.exiton	= :all
+
+Valid values are :none, :warning, :error, :all.
+
+### 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
+
+### 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'
+
+Note that you will still receive email reports when you enable file logging. 
+
+## License
+
+Copyright (c) 2011, Bart Kamphorst
+
+(Modified BSD License)
+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright
+  notice, this list of conditions and the following disclaimer.
+* Redistributions in binary form must reproduce the above copyright
+  notice, this list of conditions and the following disclaimer in the
+  documentation and/or other materials provided with the distribution.
+* Neither the name of the organization nor the
+  names of its contributors may be used to endorse or promote products
+  derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/bin/rcjrunner.rb

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

data/lib/report.erb

@@ -0,0 +1,25 @@
+This is your RubyCron mailer reporting on <%= self.name %>.
+
+There were <%= @warnings.size %> warnings and <%= @errors.size %> errors during the last run, which started at 
+<%= @starttime %> and ended at <%= @endtime %>.
+<% unless @warnings.empty? %>
+<%= "These were the warnings:" %>
+<% @warnings.each_with_index do |warning, index| %> 
+<%=	index + 1 %>: <%= warning %>
+<%=	"============================================================" %>
+<% end %> <% end %>
+<% unless @errors.empty? %>
+<%= "These were the errors:" %>
+<% @errors.each_with_index do |error, index| %> 
+<%=	index + 1 %>: <%= error %>
+<%=	"============================================================" %>
+<% end %> <% end %>
+<% if @warnings.empty? && @errors.empty? %>
+<%= "There were no problems to report. Have a nice day!" %>
+<% else %>
+<%= "Please look into these matters asap." %>
+<% end %>
+
+
+
+## Powered by RubyCron.

data/lib/rubycron.rb

@@ -0,0 +1,106 @@
+# Copyright (c) Bart Kamphorst <rubycron@kamphorst.com>, 2011
+# Licensed under the modified BSD License. All rights reserved.
+
+module RubyCron
+
+  class RubyCronJob
+  
+  require 'net/smtp'
+  require 'rubygems'
+  require 'mail'
+  require 'erb'
+  
+  attr_accessor :name, :author, :mailto, :mailfrom, :mailsubject, :mailon, :exiton, :logfile, :verbose
+  
+    def initialize(&block)
+      @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)
+      end
+      rescue => e
+        $stdout = STDOUT
+        terminate(e.message)
+    end
+    
+    def terminate(message)
+      $stderr.puts "## Cannot complete job. Reason: #{message}"
+      exit 1
+    end
+    
+    # Execute a given block of code (the cronjob), rescue encountered errors, 
+    # and send a report about it if necessary.
+    def execute(&block)
+      @starttime = Time.now
+      puts "\nStarting run of #{self.name} at #{@starttime}.\n----"  if self.verbose || self.logfile
+      instance_eval(&block)
+    rescue Exception => e
+      @errors << e.message
+      terminate(e.message) if exiton == (:error || :all)
+    ensure
+      @endtime = Time.now
+      if self.verbose || self.logfile
+        puts "Run ended at #{@endtime}.\n----"  
+        puts "Number of warnings: #{@warnings.size}" 
+        puts "Number of errors  : #{@errors.size}" 
+      end
+      unless self.mailon == :none || (@warnings.empty? && @errors.empty? && self.mailon != :all)
+        report
+      end 
+    end
+   
+    def warning(message)
+     $stderr.puts message if self.verbose || self.logfile
+     raise "Configured to exit on warning." if exiton == (:warning || :all)
+     @warnings << message
+    end
+
+    def error(message)
+      $stderr.puts message if self.verbose || self.logfile
+      raise "Configured to exit on error." if exiton == (:error || :all) 
+      @errors << message
+    end
+    
+    private 
+    def smtp_connection?
+      return true if Net::SMTP.start('localhost', 25)
+      rescue 
+        return false
+    end
+    
+    # Report on the status of the cronjob through the use of
+    # 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)
+    
+      mail = Mail.new do
+        from    mailfrom
+        to      mailto
+        subject mailsubject
+        body    mailbody
+      end
+
+      mail.deliver!
+      rescue => e
+        terminate(e.message)      
+    end  
+  end
+end

data/sample/test.rcj

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby 
+
+require 'rubygems'
+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.execute do 
+  unless File.directory?('/tmp')
+    warning "Something awry is going on with /tmp."
+  end
+  begin
+  File.open('/tmp/rubycrontest', 'w') do |f|
+    f.write("Test completed successfully.")
+  end
+  rescue => e
+    error "Something went wrong trying to write to file: #{e.message}"
+  end
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: rubycron
+version: !ruby/object:Gem::Version
+  version: '0.1'
+  prerelease: 
+platform: ruby
+authors:
+- Bart Kamphorst
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-10-19 00:00:00.000000000 +02:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: &2160625260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2160625260
+description: Write clean cronjobs in Ruby, and get reporting for free!
+email: rubycron@kamphorst.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- README.md
+- Gemfile
+- lib/rubycron.rb
+- lib/report.erb
+- sample/test.rcj
+- bin/rcjrunner.rb
+has_rdoc: true
+homepage: https://github.com/bartkamphorst/rubycron
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Simplifies your Ruby cronjobs by automating the reporting process.
+test_files: []