rubycron 0.2.3 → 0.2.4

data/Gemfile

@@ -1,8 +1,9 @@
-source :rubygems
+source 'https://rubygems.org'
 
-gem "mail"
+gem "mail", ">= 2.4.4"
 
 group :test do
   gem "rspec", "~> 2.0"
-  gem "simplecov"
+  gem "simplecov", "~> 0.7.1"
+  gem "rake", ">= 0.9.2.2"
 end

data/README.md

@@ -17,6 +17,13 @@ This gem depends on [Mikel's wonderful mail gem](https://github.com/mikel/mail).
 
 By default, RubyCron assumes you have a local smtp server running on port 25 in order to send mail.
 
+### Tested on
+
+* ruby-1.8.7-p371 [ i686 ]
+* ruby-1.9.2-p320 [ x86_64 ]
+* ruby-1.9.3-p327 [ x86_64 ]
+* jruby-1.7.3 [ x86_64 ]
+
 ## Usage
 
 ### Configure the basics
@@ -157,7 +164,7 @@ Note that in the latter case the values of the directives specified within the R
 
 ## License
 
-Copyright (c) 2011 - 2012, Bart Kamphorst
+Copyright (c) 2011 - 2013, Bart Kamphorst
 
 (Modified BSD License)
 
@@ -184,4 +191,4 @@ DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 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.
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/lib/rubycron.rb

@@ -1,169 +1,2 @@
-# Copyright (c) Bart Kamphorst <rubycron@kamphorst.com>, 2011 - 2012.
-# Licensed under the modified BSD License. All rights reserved.
-
-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, :template, :smtpsettings, :logfile, :verbose
-  attr_reader   :warnings, :errors, :report
-  
-    def initialize(args = nil)
-      @warnings, @errors = [], []
-      
-      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
-        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)
-      if yml.is_a?(Hash)
-        return yml
-      else
-        terminate "Could not load the YAML configuration."
-      end
-    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)
-      elsif @smtpsettings.nil?
-        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, $stderr = STDOUT, STDERR
-        raise e
-    end
-        
-    def terminate(message)
-      $stderr.puts "## Cannot complete job. Reason: #{message}" unless ENV['RSPEC']
-      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)
-        send_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 ENV['RSPEC']
-      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 send_report
-      @report       = ERB.new(File.read(@template)).result(binding)      
-      @mailsubject  = "Cron report for #{name}: #{@warnings.size} warnings & #{@errors.size} errors" unless @mailsubject
-      
-      mailfrom      = @mailfrom
-      mailto        = @mailto
-      mailsubject   = @mailsubject
-      mailbody      = @report
-    
-      if @smtpsettings
-        smtpsettings = @smtpsettings 
-        Mail.defaults do
-          delivery_method :smtp, smtpsettings
-        end
-      end
-      
-      mail = Mail.new do
-        from    mailfrom
-        to      mailto
-        subject mailsubject
-        body    mailbody
-      end
-
-      mail.deliver!
-      rescue => e
-        terminate(e.message)      
-    end  
-  end
-end
+require 'rubycron/main'
+require 'rubycron/version'

data/lib/rubycron/main.rb

@@ -0,0 +1,168 @@
+# Copyright (c) Bart Kamphorst <rubycron@kamphorst.com>, 2011 - 2013.
+# Licensed under the modified BSD License. All rights reserved.
+
+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, :template, :smtpsettings, :logfile, :verbose
+  attr_reader   :warnings, :errors, :report
+  
+    def initialize(args = nil)
+      @warnings, @errors = [], []
+      
+      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
+        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)
+      if yml.is_a?(Hash)
+        return yml
+      else
+        terminate "Could not load the YAML configuration."
+      end
+    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)
+      elsif @smtpsettings.nil?
+        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, $stderr = STDOUT, STDERR
+        raise e
+    end
+        
+    def terminate(message)
+      $stderr.puts "## Cannot complete job. Reason: #{message}" unless ENV['RSPEC']
+      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)
+        send_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 send_report
+      @report       = ERB.new(File.read(@template)).result(binding)      
+      @mailsubject  = "Cron report for #{name}: #{@warnings.size} warnings & #{@errors.size} errors" unless @mailsubject
+      
+      mailfrom      = @mailfrom
+      mailto        = @mailto
+      mailsubject   = @mailsubject
+      mailbody      = @report
+    
+      if @smtpsettings
+        smtpsettings = @smtpsettings 
+        Mail.defaults do
+          delivery_method :smtp, smtpsettings
+        end
+      end
+      
+      mail = Mail.new do
+        from    mailfrom
+        to      mailto
+        subject mailsubject
+        body    mailbody
+      end
+
+      mail.deliver!
+      rescue => e
+        terminate(e.message)      
+    end  
+  end
+end

data/lib/rubycron/version.rb

@@ -0,0 +1,3 @@
+module RubyCron
+  VERSION = "0.2.4"
+end

data/sample/test.rcj

@@ -1,8 +1,9 @@
 #!/usr/bin/env ruby 
 
 require 'rubygems'
-require 'rubycron'
+require 'RubyCron'
 include RubyCron
+require 'tmpdir'
 
 rcj = RubyCronJob.new(
   :author     => 'John Doe',
@@ -14,12 +15,14 @@ rcj = RubyCronJob.new(
   :verbose    => false )
 
 rcj.execute do 
-  unless File.directory?('/tmp')
-    warning "Something awry is going on with /tmp."
+  unless File.directory?(Dir.tmpdir)
+    warning "Something awry is going on with the tmp directory."
   end
   begin
-  File.open('/tmp/rubycrontest', 'w') do |f|
-    f.write("Test completed successfully.")
+  Dir.mktmpdir do |dir|
+    File.open(File.join(dir, 'rubycrontest'), 'w') do |f|
+      f.write("Test completed successfully.")
+    end
   end
   rescue => e
     error "Something went wrong trying to write to file: #{e.message}"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubycron
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-18 00:00:00.000000000 Z
+date: 2013-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mail
@@ -32,17 +32,17 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.7.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.7.1
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -70,7 +70,9 @@ files:
 - README.md
 - Gemfile
 - lib/rubycron.rb
-- lib/report.erb
+- lib/rubycron/main.rb
+- lib/rubycron/report.erb
+- lib/rubycron/version.rb
 - sample/test.rcj
 - bin/rcjrunner.rb
 homepage: https://github.com/bartkamphorst/rubycron