cronic 0.1.0

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+== 0.1.0 2012-11-27
+
+* Initial release

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Jens Krämer
+
+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,125 @@
+Cronic
+======
+
+Motivation
+----------
+
+While nothing is wrong with Unix cron, it is not the best choice for
+regular jobs that require to be run in the context of your Rails
+application. Spinning up an instance of the application every 10 minutes
+for a job that needs to run this frequently is just a waste of CPU cycles, let
+alone the increased memory usage in case different jobs are running in
+parallel.
+
+Building blocks
+---------------
+
+Cronic itself is only a tiny bit of glue code and a Rails generator.
+
+The scheduling itself is done by [Rufus
+Scheduler](https://github.com/jmettraux/rufus-scheduler) . I like this
+particular library because it allows you fine grained control over which
+jobs may be run in parallel and which have to be run in sequence via
+mutexes. It also can avoid overlapping with long running jobs. These are
+things that you have to take care of yourself when using Unix cron.
+The daemonizing part is provided by
+[Dante](https://github.com/bazaarlabs/dante), which is amazingly easy
+to use and 'just works'.
+Optional Airbrake integration is also included.
+
+
+Usage
+-----
+
+Three easy steps:
+
+**Add Cronic to your Gemfile and run Bundler**
+
+    echo "gem 'cronic'" >> Gemfile
+    bundle install
+
+**Run the Rails generator and create job definitions**
+
+    rails g cronic
+
+This will set up `script/cronic`, which you will use to start / stop the
+daemon. It also creates the `config/cronic.d` directory where you will
+store your job definitions. Have a look at `config/cronic.d/sample.rb`
+to get an idea of how to define your jobs. For more information, be sure
+to visit the Rufus-Scheduler documentation. Every method that is
+available on a Rufus::Scheduler instance can be called in the job
+definition files located in `config/cronic.d`.
+
+**Run it**
+
+    script/cronic -d -l log/cronic.log -P tmp/pids/cronic.pid
+
+This will run cronic daemonized, logging to log/cronic.log, with a pid
+file located in tmp/pids. To run in the forground for testing purposes,
+just run the script without any parameters.
+
+In order to stop the daemon, run
+
+    script/cronic -k -P tmp/pids/cronic.pid
+
+
+Error handling
+--------------
+
+Any exception thrown during job execution will be caught and logged to
+STDOUT (which goes into the log file specified on the command line).  If
+you have [Airbrake](https://github.com/airbrake/airbrake) set up for
+your application, exceptions will also be reported via
+`Airbrake.notify`.
+
+
+Capistrano
+----------
+
+In order to stop / start / restart Cronic automatically when deploying
+with capistrano, follow these steps:
+
+**Include the Cronic recipes in your Capfile or deploy.rb**
+
+    require 'cronic/recipes'
+
+**Hook Cronic tasks to Capistrano's tasks**
+
+    after "deploy:stop",    "cronic:stop"
+    after "deploy:start",   "cronic:start"
+    after "deploy:restart", "cronic:restart"
+
+**Optional: customize task behaviour**
+
+    set :rails_env, 'production'  # this is the default
+
+    # relative to current_path, defaults to log/cronic.log
+    set :cronic_log, 'some/log/file'
+
+    # relative to current_path, defaults to tmp/pids/cronic.pid
+    set :cronic_pid, 'some/pid/file'
+ 
+    # custom role to have it run on a special server
+    role :cron, 'dedicated.cron.server'
+    set :cronic_server_role, :cron
+
+
+Monitoring
+----------
+
+The [Dante docs](https://github.com/bazaarlabs/dante) have an example
+god script that you can use as a starting point for ensuring your
+cronic daemon stays up and running.
+
+
+Copyright
+---------
+
+Copyright 2012 Jens Krämer, jk@jkraemer.net
+See [LICENSE](https://github.com/jkraemer/cronic/blob/master/LICENSE)
+for details.
+
+
+
+
+

data/lib/cronic.rb

@@ -0,0 +1 @@
+require "cronic/scheduler"

data/lib/cronic/recipes.rb

@@ -0,0 +1,58 @@
+# Capistrano Recipes for managing the cronic daemon
+#
+# Add these callbacks to have the cronic process restart when the server
+# is restarted:
+#
+#   after "deploy:stop",    "cronic:stop"
+#   after "deploy:start",   "cronic:start"
+#   after "deploy:restart", "cronic:restart"
+#
+# To only spawn the cronic daemon on a specific server specify the
+# cronic_server_role:
+#
+#   set :cronic_server_role, :cron
+#
+# You may change the log and pid file locations by defining :cronic_log and
+# :cronic_pid. The RAILS_ENV defaults to production and may be changed by
+# setting :rails_env.
+#
+
+Capistrano::Configuration.instance.load do
+  namespace :cronic do
+    def rails_env
+      "RAILS_ENV=#{fetch(:rails_env, 'production')}"
+    end
+
+    def roles
+      fetch(:cronic_server_role, :app)
+    end
+
+    def cronic_log
+      fetch :cronic_log, 'log/cronic.log'
+    end
+
+    def cronic_pid
+      fetch :cronic_pid, 'tmp/pids/cronic.pid'
+    end
+
+    def cronic_command
+      fetch(:cronic_command, "script/cronic")
+    end
+
+    desc "Stop the cronic process"
+    task :stop, :roles => lambda { roles } do
+      run "cd #{current_path};#{rails_env} #{cronic_command} -k -P #{cronic_pid}"
+    end
+
+    desc "Start the cronic process"
+    task :start, :roles => lambda { roles } do
+      run "cd #{current_path};#{rails_env} #{cronic_command} -d -l #{cronic_log} -P #{cronic_pid}"
+    end
+
+    desc "Restart the cronic process"
+    task :restart, :roles => lambda { roles } do
+      stop
+      start
+    end
+  end
+end

data/lib/cronic/scheduler.rb

@@ -0,0 +1,42 @@
+require 'rufus/scheduler'
+
+begin
+  require 'airbrake'
+rescue LoadError
+  # ignore
+end
+
+module Cronic
+  class Scheduler
+
+    def initialize
+      @rufus_scheduler = Rufus::Scheduler.start_new
+      setup_exception_handler
+    end
+
+    def load_jobs(file)
+      @rufus_scheduler.instance_eval IO.read file
+    end
+
+    # blocks until the scheduler exits for some reason
+    def join
+      @rufus_scheduler.join
+    end
+
+    private
+
+    def setup_exception_handler
+      @rufus_scheduler.class_eval do
+        define_method :handle_exception do |job, exception|
+          puts "job #{job.job_id} caught exception '#{exception}'"
+          if defined?(Airbrake)
+            Airbrake.notify exception
+          else
+            puts exception.backtrace.join("\n")
+          end
+        end
+      end
+    end
+
+  end
+end

data/lib/cronic/version.rb

@@ -0,0 +1,3 @@
+module Cronic
+  VERSION = '0.1.0'
+end

data/lib/generators/cronic_generator.rb

@@ -0,0 +1,14 @@
+class CronicGenerator < Rails::Generators::Base
+  source_root File.expand_path("../../../templates", __FILE__)
+
+  desc "Creates the script/cronic daemon control script and sets up job samples in config/cronic.d"
+
+  def create_scheduler_script
+    copy_file "script/cronic"
+    chmod 'script/cronic', 0755
+  end
+
+  def create_jobs_dir
+    directory "config/cronic.d"
+  end
+end

data/recipes/cronic.rb

@@ -0,0 +1 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'cronic', 'recipes'))

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: cronic
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Jens Krämer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rufus-scheduler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.17
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.17
+- !ruby/object:Gem::Dependency
+  name: dante
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.5
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3'
+description: Taking advantage of Rufus Scheduler and Dante to provide a long running
+  daemon for cron like jobs to be run in the context of your Rails application, without
+  loading the full environment each and every time a job is run.
+email:
+- jk@jkraemer.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/cronic/recipes.rb
+- lib/cronic/scheduler.rb
+- lib/cronic/version.rb
+- lib/cronic.rb
+- lib/generators/cronic_generator.rb
+- recipes/cronic.rb
+- LICENSE
+- CHANGELOG.md
+- README.md
+homepage: http://github.com/jkraemer/cronic
+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: 1.3.6
+requirements: []
+rubyforge_project: cronic
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Cron like scheduler daemon for Rails applications
+test_files: []