multiserver_whenever 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Chris Powers
+ 
+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.rdoc

@@ -0,0 +1,94 @@
+= Multiserver Whenever
+
+<em>Created by Chris Powers 12/7/2010</em>
+
+Provides the <tt>multiserver_whenever</tt> command for generating host-specific 
+crontabs with role-based whenever files. This is very handy for when you need 
+to deploy different crontabs to different staging/production servers, but still 
+want to leverage the <tt>whenever</tt> gem's DSL and build tools.
+
+Learn all about the original <tt>whenever</tt> gem at https://github.com/javan/whenever.
+
+
+== Installation
+
+Just install the <tt>multiserver_whenever</tt> gem per usual:
+
+  gem install multiserver_whenever
+
+
+== Generating Document Structure with MultiserverWheneverize
+
+Taking off of the <tt>whenever</tt> gem's <tt>wheneverize</tt>, this gem provides 
+the <tt>multiserver_wheneverize</tt> command to generate the initial file structure:
+
+  cd /path/to/your_app
+  multiserver_wheneverize
+
+The generated file structure looks like:
+
+  - your_app/
+    - config/
+      - whenever.yml
+      - whenever/
+        - do_not_remove.rb
+        - example.rb
+
+
+== Configuration
+
+The <tt>config/whenever.yml</tt> file is a hash where the keys are server hostnames and
+the values are arrays of "roles".
+
+Let's say that I have two servers with hostnames <tt>app_server</tt> and <tt>db_server</tt>.
+I need to set app-related crontabs on <tt>app_server</tt>, db-related crontabs on
+<tt>db_server</tt> and some shared crontabs on both. To do this, I will first create three 
+whenever files in <tt>config/whenever</tt>:
+
+  - your_app/
+    - config/
+      - whenever.yml
+      - whenever/
+        - app.rb
+        - db.rb
+        - do_not_remove.rb
+        - shared.rb
+
+The contents of each of these files is regular <tt>whenever</tt> code (see https://github.com/javan/whenever).
+
+Then in our <tt>config/whenever.yml</tt> file we map our hostnames to the cron roles:
+
+  ---
+  app_server:
+    - app
+    - shared
+  db_server:
+    - db
+    - shared
+
+Now when you run the <tt>multiserver_whenever</tt> command on one of your servers, it will
+only apply the <tt>whenever</tt> files that are specified in your <tt>config/whenever.yml</tt>
+file.
+
+
+== Running <tt>multiserver_whenever</tt>
+
+If you are using the whenever <tt>rake</tt> and <tt>runner</tt> commands, you may need to
+specify a Rails environment. It defaults to using <tt>production</tt>, but you can simply
+pass a different environment to the <tt>multiserver_whenever</tt> command instead:
+
+  multiserver_whenever staging
+
+
+== Deployment with Capistrano
+
+In your Capistrano deployment code, you should be able to add something like this to run
+<tt>multiserver_whenever</tt> on deployment:
+
+  namespace :whenever do
+    desc "Update your whenever-generated crontabs"
+    task :update do
+      run "cd #{release_path}; multiserver_whenever #{rails_env}"
+    end
+    after "deploy:update", "whenever:update"
+  end

data/bin/multiserver_whenever

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+require File.expand_path(File.dirname(__FILE__) + '/../lib/multiserver_whenever.rb')
+
+env = ARGV.shift || 'production'
+whenever = MultiserverWhenever.new(:environment => env)
+whenever.clear!
+whenever.write!

data/bin/multiserver_wheneverize

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+require File.expand_path(File.dirname(__FILE__) + '/../lib/multiserver_wheneverizer.rb')
+
+w = MultiserverWheneverizer.new
+w.run!

data/lib/multiserver_whenever.rb

@@ -0,0 +1,89 @@
+require 'yaml'
+
+class MultiserverWhenever
+  def initialize(set_vars = {})
+    defaults = {:environment => 'production'}
+    @set_vars = defaults.merge(set_vars)
+  end
+  
+  def clear!
+    current_whenever_identifiers.each do |identifier|
+      whenever_with_vars "--load-file #{dummy_whenever_path} --clear-crontab #{identifier}"
+    end
+  end
+  
+  def write!
+    roles.each do |role|
+      relative_path = "config/whenever/#{role}.rb"
+      absolute_path = File.expand_path(relative_path)
+      whenever_with_vars "--load-file #{relative_path} --update-crontab #{absolute_path}"
+    end
+  end
+  
+  def current_whenever_identifiers
+    @identifiers ||= parse_identifiers
+  end
+  
+  def read_cron
+    command("crontab -l")
+  end
+  
+  def roles
+    [config[hostname]].flatten.compact
+  end
+  
+  def config
+    @config ||= YAML.load(read_config)
+  end
+  
+  def read_config
+    File.read("config/whenever.yml")
+  end
+  
+  def hostname
+    command('hostname')
+  end
+  
+  # So for some reason, the whenever command requires that the
+  # --load-file argument be passed, even if you are using the
+  # --clear-crontab argument to clear out outdated crontabs.
+  # 
+  # The problem is that you may need to clear out old crontab 
+  # data from cron that was generated by a whenever file that
+  # no longer exists, so you can't use it for the --load-file
+  # argument. As it's unnecessary anyways, I'm just going to use
+  # the config/whenever/do_not_remove.rb file anytime we're 
+  # clearing crontabs out. It's an "empty" file, but we need
+  # to keep it around.
+  # 
+  def dummy_whenever_path
+    "config/whenever/do_not_remove.rb"
+  end
+  
+  def parse_identifiers
+    lines = read_cron.split("\n")
+    lines = lines.select {|line| line =~ /^# Begin Whenever/ }
+    lines.map {|line| line.gsub("# Begin Whenever generated tasks for: ", '') }
+  end
+  
+  private
+  
+  def whenever_with_vars(opts)
+    unless @set_vars.empty?
+      query_string = @set_vars.inject([]) {|arr, tuple| arr << "#{tuple.first}=#{tuple.last}"}.join("&")
+      opts << " --set #{query_string}"
+    end
+    whenever(opts)
+  end
+  
+  def whenever(opts)
+    cmd = "whenever #{opts}"
+    puts cmd
+    %x{#{cmd}}
+  end
+  
+  def command(cmd)
+    %x{#{cmd}}.strip
+  end
+  
+end

data/lib/multiserver_wheneverizer.rb

@@ -0,0 +1,35 @@
+require 'fileutils'
+require 'erb'
+
+class MultiserverWheneverizer
+  def run!
+    write_config!
+    copy_whenever_files!
+  end
+  
+  def write_config!
+    FileUtils.mkdir_p("config")
+    File.open("config/whenever.yml", 'w') { |f| f.puts custom_config }
+  end
+  
+  def copy_whenever_files!
+    FileUtils.mkdir_p("config/whenever")
+    FileUtils.cp_r("#{gem_root}/templates/config/whenever/.", "config/whenever")
+  end
+  
+  def custom_config
+    ERB.new(File.read("#{gem_root}/templates/config/whenever.yml")).result(binding)
+  end
+  
+  def hostname
+    `hostname`.strip
+  end
+  
+  private
+  
+  def gem_root
+    @gem_root ||= File.expand_path File.dirname(File.dirname(__FILE__))
+  end
+  
+
+end

data/templates/config/whenever/do_not_remove.rb

@@ -0,0 +1,24 @@
+# HERE BE DRAGONS!
+# 
+#                       ___====-_  _-====___                      
+#                __--^^^      //     \\     ^^^--_                
+#               _-^         // (    ) \\         ^-_              
+#              -           //  |\^^/|  \\           -             
+#            _/           //   (0::0)   \\            \_          
+#           /            ((     \\//     ))             \         
+#         -               \\    (oo)    //               -        
+#        -                 \\  / \/ \  //                 -       
+#       -                   \\/      \//                   -      
+#     / /|           /\      (        )      /\           |\ \    
+#     |/ | /\_/\_/\_/  \_/\  (   /\   )  /\_/  \_/\_/\_/\ | \|    
+#     `  |/  V  V  `    V  \_(| |  | |)_/  V    '  V  V  \|  '    
+#        `   `  `       `   / | |  | | \   '       '  '   '       
+#                         <(  | |  | |  )>                        
+#                        <__\_| |  | |_\__>                       
+#                        ^^^^ ^^^  ^^^ ^^^^^                      
+# 
+# Seriously, though, please don't delete this file. It is required
+# for MultiserverWhenever.clear! to work correctly. See the file
+# lib/multiserver_whenever.rb for more information.
+# 
+# Or just stay here and admire the dragon.

data/templates/config/whenever/example.rb

@@ -0,0 +1,20 @@
+# Use this file to easily define all of your cron jobs.
+#
+# It's helpful, but not entirely necessary to understand cron before proceeding.
+# http://en.wikipedia.org/wiki/Cron
+
+# Example:
+#
+# set :output, "/path/to/my/cron_log.log"
+#
+# every 2.hours do
+#   command "/usr/bin/some_great_command"
+#   runner "MyModel.some_method"
+#   rake "some:great:rake:task"
+# end
+#
+# every 4.days do
+#   runner "AnotherModel.prune_old_records"
+# end
+
+# Learn more: http://github.com/javan/whenever

data/templates/config/whenever.yml

@@ -0,0 +1,3 @@
+---
+<%= hostname %>:
+  - example

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification 
+name: multiserver_whenever
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Chris Powers
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-07 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: whenever
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        - 6
+        - 2
+        version: 0.6.2
+  type: :runtime
+  version_requirements: *id001
+description: Provides the multiserver_whenever command for generating host-specific crontabs with role-based whenever files.
+email: chrisjpowers@gmail.com
+executables: 
+- multiserver_whenever
+- multiserver_wheneverize
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.rdoc
+- LICENSE
+- lib/multiserver_whenever.rb
+- lib/multiserver_wheneverizer.rb
+- templates/config/whenever.yml
+- templates/config/whenever/do_not_remove.rb
+- templates/config/whenever/example.rb
+- bin/multiserver_whenever
+- bin/multiserver_wheneverize
+has_rdoc: true
+homepage: http://github.com/chrisjpowers/multiserver_whenever
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Provides the multiserver_whenever command for generating host-specific crontabs with role-based whenever files.
+test_files: []
+