cron_helper 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bd964229c9cdbfb7aa11cd0002df11496f72c8d7
+  data.tar.gz: e83495556082032e5c6d582e03ed6ec8ed03df45
+SHA512:
+  metadata.gz: aa50228bb6f65b2434d89959b756e436d3cbb1fa82f7c81b9bd71b49fc464f3b4252242329c16ccf84b2a580d1c1d7d99f669d70656fe98750e4e2fa9810be27
+  data.tar.gz: 0a7748d1ab42cd61e0b0b922e6d7c92f9622fc5ca92e8bab9d6445336a207fa5981559ca4ea9f516cf9d65a1505632ef5c2eaa10859165698ed1b80b4e136fd8

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cron_helper.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Chad Remesch
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,96 @@
+# CronHelper
+
+The Cron Helper gem is designed to add a few additional features to cron jobs created with the [Whenever](https://github.com/javan/whenever) gem.
+
+Features include:
+* File based locking to prevent jobs from running if they are already running.  This is especially useful if a job takes longer than it should (such as an hourly cron that happens to take two hours to run).
+* Stdout and Stderr interception.
+* The concept of "tasks" within a job (more on this below) for ordering and exception handling.
+* Custom handling of output (write your own email handling, custom logging, alerting, etc).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cron_helper'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cron_helper
+
+## Usage
+
+For your typical Rails or Ruby app, you will first want to create your ````ApplicationJob````.
+This is the class that all of your custom jobs should inherit from.
+Here you put methods that are shared by all your custom jobs.
+
+```ruby
+class ApplicationJob < CronHelper::Job
+end
+```
+
+Next you will create your app specific job classes.
+The idea is to pick logical names that relate to how they are going to be scheduled and grouped.
+Inside of each class you will register your tasks.
+
+```ruby
+class HourlyJob < ApplicationJob
+  register :do_some_work
+  register :do_some_other_work
+  register :do_even_more_work
+
+  private
+
+  def do_some_work
+    raise 'I am a task that breaks quite often.'
+  end
+
+  def do_some_other_work
+    puts 'I am a task that loves to talk.'
+    STDERR.puts 'I even like to talk about errors.'
+  end
+
+  def do_even_more_work
+    # I am a silent champion of a task.
+  end
+end
+```
+Finally you will schedule your jobs using the [Whenever](https://github.com/javan/whenever]) gem.
+Below is an example config/schedule.rb that also forces your jobs to run at a low priority.
+Running jobs at a low priority is recommended when your server has other roles (web, app, db, etc).
+
+```ruby
+job_type :runner,  "cd :path && nice -n 20 script/rails runner -e :environment ':task' :output"
+
+every 1.hour do
+  runner('Cron::Hourly.new.run')
+end
+```
+
+## Tasks
+Think of tasks as methods with exception protection and ordering.
+Tasks are guaranteed to run in the order you register them.
+They are also guaranteed to run even if a previous task encountered an exception.
+This gives you control over creating new tasks without having to worry about breaking old ones.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/cron_helper.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "cron_helper"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/cron_helper.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cron_helper/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cron_helper"
+  spec.version       = CronHelper::VERSION
+  spec.authors       = ["Chad Remesch"]
+  spec.email         = ["chad@remesch.com"]
+
+  spec.summary       = %q{Cron Helper adds addition features to cron jobs scheduled by the Whenever gem.}
+  spec.homepage      = "https://github.com/chadrem/cron_helper"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/cron_helper.rb

@@ -0,0 +1,6 @@
+require 'cron_helper/version'
+require 'cron_helper/job'
+
+module CronHelper
+end
+

data/lib/cron_helper/job.rb

@@ -0,0 +1,103 @@
+module CronHelper
+  class Job
+    def self.register(method_name)
+      @cron_methods ||= []
+      @cron_methods << method_name
+    end
+
+    def run
+      backup_streams
+      hijack_streams
+
+      result = ''
+
+      file_lock do
+        cron_methods.each do |m|
+          @output.truncate(0)
+
+          begin
+            send(m)
+          rescue Exception => e
+            @output.string.chomp!
+            puts "\n" if @output.string.length > 0
+            puts "EXCEPTION #{e.class} (#{e.message.chomp})\n#{e.backtrace.join("\n")}\n"
+          ensure
+            if @output.string.length > 0
+              result << "#######################################################\n"
+              result << "#{self.class.to_s}##{m.to_s}\n"
+              result << "#######################################################\n"
+              result << "#{@output.string.chomp}\n"
+              result << "---\n\n"
+            end
+          end
+        end
+      end
+    ensure
+      restore_streams
+      output_handler(result)
+    end
+
+    private
+
+    def output_handler(output)
+      puts output
+    end
+
+    def cron_methods
+      self.class.instance_variable_get('@cron_methods') || []
+    end
+
+    def backup_streams
+      @stderr_backup = $stderr
+      @stdout_backup = $stdout
+    end
+
+    def restore_streams
+      return unless @stderr_backup && @stdout_backup
+
+      $stderr = @stderr_backup
+      $stdout = @stdout_backup
+
+      @stderr_backup = @stdout_backup = nil
+    end
+
+    def hijack_streams
+      @output = $stderr = $stdout = StringIO.new
+    end
+
+    def file_lock(&block)
+      FileUtils.mkdir_p(lock_dir_path)
+
+      File.open(lock_file_path, File::RDWR|File::CREAT, 0644) do |f|
+        unless f.flock(File::LOCK_EX|File::LOCK_NB)
+          puts "CRON FAILED TO LOCK (#{cron_name} at #{Time.zone.now})"
+          return
+        end
+
+        begin
+          yield
+        rescue Exception => e
+          puts "CRON EXCEPTION (#{cron_name} at #{Time.zone.now}): #{e.message}\n#{e.backtrace}"
+        ensure
+          f.flock(File::LOCK_UN)
+        end
+      end
+    end
+
+    def cron_name
+      return self.class.to_s
+    end
+
+    def lock_dir_path
+      return File.join(Rails.root, 'tmp', 'crons')
+    end
+
+    def lock_file_name
+      return "#{cron_name}.lock"
+    end
+
+    def lock_file_path
+      return File.join(lock_dir_path, lock_file_name)
+    end
+  end
+end

data/lib/cron_helper/version.rb

@@ -0,0 +1,3 @@
+module CronHelper
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: cron_helper
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chad Remesch
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-01-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: 
+email:
+- chad@remesch.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cron_helper.gemspec
+- lib/cron_helper.rb
+- lib/cron_helper/job.rb
+- lib/cron_helper/version.rb
+homepage: https://github.com/chadrem/cron_helper
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Cron Helper adds addition features to cron jobs scheduled by the Whenever
+  gem.
+test_files: []