crontabinator 0.0.0

data/lib/crontabinator/built-in.rb

@@ -0,0 +1,2 @@
+set :crontab_log_level,             "info"
+set :crontab_templates_path,        "templates/crontab"

data/lib/crontabinator/check.rb

@@ -0,0 +1,24 @@
+namespace :crontab do
+  namespace :check do
+
+    desc 'Ensure all crontabinator specific settings are set, and warn and exit if not.'
+    before 'crontab:setup', :settings do
+      {
+        (File.dirname(__FILE__) + "/examples/config/deploy.rb") => 'config/deploy.rb',
+        (File.dirname(__FILE__) + "/examples/config/deploy/staging.rb") => "config/deploy/#{fetch(:stage)}.rb"
+      }.each do |abs, rel|
+        Rake::Task['deployinator:settings'].invoke(abs, rel)
+        Rake::Task['deployinator:settings'].reenable
+      end
+    end
+
+    namespace :settings do
+      desc 'Print example crontabinator specific settings for comparison.'
+      task :print do
+        set :print_all, true
+        Rake::Task['crontab:check:settings'].invoke
+      end
+    end
+
+  end
+end

data/lib/crontabinator/config.rb

@@ -0,0 +1,60 @@
+module Capistrano
+  module TaskEnhancements
+    alias_method :crontab_original_default_tasks, :default_tasks
+    def default_tasks
+      crontab_original_default_tasks + [
+        "crontabinator:write_built_in",
+        "crontabinator:write_example_configs",
+        "crontabinator:write_example_configs:in_place"
+      ]
+    end
+  end
+end
+
+namespace :crontabinator do
+
+  set :example, "_example"
+
+  desc "Write example config files (with '_example' appended to their names)."
+  task :write_example_configs do
+    run_locally do
+      execute "mkdir", "-p", "config/deploy", fetch(:crontab_templates_path)
+      {
+        "examples/Capfile"                    => "Capfile#{fetch(:example)}",
+        "examples/config/deploy.rb"           => "config/deploy#{fetch(:example)}.rb",
+        "examples/config/deploy/staging.rb"   => "config/deploy/staging#{fetch(:example)}.rb",
+        "examples/crontab.erb"                => "#{fetch(:crontab_templates_path)}/crontab#{fetch(:example)}.erb",
+      }.each do |source, destination|
+        config = File.read(File.dirname(__FILE__) + "/#{source}")
+        File.open("./#{destination}", 'w') { |f| f.write(config) }
+        info "Wrote '#{destination}'"
+      end
+      unless fetch(:example).empty?
+        info "Now remove the '#{fetch(:example)}' portion of their names or diff with existing files and add the needed lines."
+      end
+    end
+  end
+
+  desc 'Write example config files (will overwrite any existing config files).'
+  namespace :write_example_configs do
+    task :in_place do
+      set :example, ""
+      Rake::Task['crontabinator:write_example_configs'].invoke
+    end
+  end
+
+  desc 'Write a file showing the built-in overridable settings.'
+  task :write_built_in do
+    run_locally do
+      {
+        'built-in.rb'                         => 'built-in.rb',
+      }.each do |source, destination|
+        config = File.read(File.dirname(__FILE__) + "/#{source}")
+        File.open("./#{destination}", 'w') { |f| f.write(config) }
+        info "Wrote '#{destination}'"
+      end
+      info "Now examine the file and copy-paste into your deploy.rb or <stage>.rb and customize."
+    end
+  end
+
+end

data/lib/crontabinator/crontab.rb

@@ -0,0 +1,58 @@
+namespace :crontab do
+
+  desc "Idempotently setup Crontabs."
+  task :setup do
+    log_level = SSHKit.config.output_verbosity
+    log_level = "info" if log_level.nil?
+    SSHKit.config.output_verbosity = fetch(:crontab_log_level)
+
+    on roles(:cron) do |host|
+      fetch(:user_crontab_entries).each do |user, entries|
+        unless unix_user_exists?(user)
+          error "User #{user} does not exist even though you defined crontab settings for it - Skipping!"
+        else
+          set :crontab_entries, entries
+          template_path = File.expand_path("./#{fetch(:crontab_templates_path)}/crontab.erb")
+          generated_config_file = ERB.new(File.new(template_path).read, nil, '-').result(binding)
+          upload! StringIO.new(generated_config_file), "/tmp/crontab"
+          as :root do
+            execute("chown", "#{user}:#{user}", "/tmp/crontab")
+          end
+          as user do
+            execute "crontab", "/tmp/crontab"
+          end
+          as :root do
+            execute "rm", "/tmp/crontab"
+          end
+        end
+      end
+    end
+    SSHKit.config.output_verbosity = log_level
+  end
+
+  if Rake::Task.task_defined?("deploy:publishing")
+    after 'deploy:publishing', 'crontab:setup'
+  end
+
+  desc "Check the status of the Crontabs."
+  task :status do
+    log_level = SSHKit.config.output_verbosity
+    log_level = "info" if log_level.nil?
+    SSHKit.config.output_verbosity = fetch(:crontab_log_level)
+
+    on roles(:cron) do
+      fetch(:user_crontab_entries).each do |user, _|
+        as :root do
+          unless unix_user_exists?(user)
+            error "User #{user} does not exist even though you defined crontab settings for it - Skipping!"
+          else
+            info "Crontab for user #{user}:\n#{capture "crontab", "-u", user, "-l" if test "crontab", "-u", user, "-l"}"
+          end
+        end
+      end
+    end
+
+    SSHKit.config.output_verbosity = log_level
+  end
+
+end

data/lib/crontabinator/examples/Capfile

@@ -0,0 +1,4 @@
+# Load DSL and Setup Up Stages
+require 'capistrano/setup'
+
+require 'crontabinator'

data/lib/crontabinator/examples/config/deploy/staging.rb

@@ -0,0 +1,19 @@
+##### crontabinator
+### ------------------------------------------------------------------
+set :domain,                        "my-app.example.com"
+server fetch(:domain),
+  :user                             => fetch(:deployment_username),
+  :roles                            => ["cron"]
+set :user_crontab_entries,          {
+  "www-data"                          => [
+    "SHELL=/bin/bash",
+    "MAILTO=myemail@example.com",
+    "0 */4 * * * #{current_path}/script/myscript > /dev/null"
+  ],
+  "root"                              => [
+    "SHELL=/bin/bash",
+    "MAILTO=myemail@example.com",
+    "0 */4 * * * /usr/local/bin/myscript > /dev/null"
+  ]
+}
+### ------------------------------------------------------------------

data/lib/crontabinator/examples/config/deploy.rb

@@ -0,0 +1,8 @@
+# config valid only for Capistrano 3.2.1
+lock '3.2.1'
+
+##### crontabinator
+### ------------------------------------------------------------------
+#set :application,                   "my_app_name"
+set :deployment_username,           ENV['USER']
+### ------------------------------------------------------------------

data/lib/crontabinator/examples/crontab.erb

@@ -0,0 +1,3 @@
+<%- fetch(:crontab_entries).each do |entry| -%>
+<%= entry %>
+<%- end -%>

data/lib/crontabinator.rb

@@ -0,0 +1,8 @@
+require 'capistrano/setup'
+require 'erb'
+
+load 'crontabinator/crontab.rb'
+load 'crontabinator/config.rb'
+load 'crontabinator/check.rb'
+load 'crontabinator/built-in.rb'
+load 'deployinator/helpers.rb'

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: crontabinator
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+  prerelease: 
+platform: ruby
+authors:
+- david amick
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.1
+- !ruby/object:Gem::Dependency
+  name: deployinator
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.3.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.3.2
+- !ruby/object:Gem::Dependency
+  name: sshkit
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+description: Deploy Crontabs using an existing Cron Daemon
+email: davidamick@ctisolutionsinc.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/crontabinator.rb
+- lib/crontabinator/crontab.rb
+- lib/crontabinator/config.rb
+- lib/crontabinator/check.rb
+- lib/crontabinator/built-in.rb
+- lib/crontabinator/examples/Capfile
+- lib/crontabinator/examples/config/deploy.rb
+- lib/crontabinator/examples/config/deploy/staging.rb
+- lib/crontabinator/examples/crontab.erb
+homepage: https://github.com/snarlysodboxer/crontabinator
+licenses:
+- GNU
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- Cron Daemon
+rubyforge_project: 
+rubygems_version: 1.8.23.2
+signing_key: 
+specification_version: 3
+summary: Deploy Crontabs
+test_files: []