capistrano-delayed-job 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c7bad2495a9ab3aa196b5baa2a60a3f1bf1cd647
+  data.tar.gz: 360b7828d6f2cb4e0aea819569173c286d2b975f
+SHA512:
+  metadata.gz: e73baaf94c73eeadb5594e73da815f1f0a7ba5e0c4250f747e405639e41832e837328e25cbba201d21ecd9ecbad38572ef4abc3d8263563d7dfd608711fabc79
+  data.tar.gz: ec6d5df4eb93dfede6e36994f2d3c6552a881870a7c89d87b3c6e80a60fc550526553f753b8233f4180e0d839d5943f6e896508983393239b23f8e20ee68bff7

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+/vendor/ruby
+.idea

data/Gemfile

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

data/LICENSE.md

@@ -0,0 +1,19 @@
+Copyright (c) 2014 Ruben Stranders
+
+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,115 @@
+# Capistrano::DelayedJob
+
+Capistrano tasks for automatic DelayedJob configuration.
+
+Goals of this plugin:
+
+* automatic DelayedJob configuration for Rails apps
+* **no manual ssh** to the server required
+
+Specifics:
+
+* generates an init script on the server for Delayed job
+* capistrano tasks for management, example: `delayed_job:restart`<br/>
+see below for all available tasks
+
+`capistrano-delayed-job` works only with Capistrano 3!
+
+Inspired by
+[capistrano-nginx-unicorn](https://github.com/bruno-/capistrano-nginx-unicorn) and [capistrano-recipes](https://github.com/mattdbridges/capistrano-recipes).
+
+### Installation
+
+Add this to `Gemfile`:
+
+    group :development do
+      gem 'capistrano', '~> 3.1'
+      gem 'capistrano-delayed-job', '~> 1.0'
+    end
+
+And then:
+
+    $ bundle install
+
+### Setup and usage
+
+Add this line to `Capfile`
+
+    require 'capistrano/delayed_job'
+
+**Setup task**
+
+Make sure the `deploy_to` path exists and has the right privileges on the
+server (i.e. `/var/www/myapp`).<br/>
+Or just install
+[capistrano-safe-deploy-to](https://github.com/bruno-/capistrano-safe-deploy-to)
+plugin and don't think about it.
+
+To setup the DelayedJob on the servers with the `delayed_job_server_role` (default `:app`) run:
+
+    $ bundle exec cap production setup
+    
+This will generate the init script for delayed job.
+
+### Configuration
+
+As described in the Usage section, this plugin works with minimal setup.
+However, configuration is possible.
+
+You'll find the options and their defaults below.
+
+In order to override the default, put the option in the stage file, for example:
+
+    # in config/deploy/production.rb
+    set :delayed_job_workers, 10
+
+Defaults are listed near option name in the first line.
+
+* `set :delayed_job_workers` # defaults to 1<br/>
+The number of workers to run on each server.
+
+* `set :delayed_job_server_roles, "[:app]"`<br/>
+The roles on which the DelayedJob should run.
+
+* `set :delayed_job_service, -> { "delayed_job_#{fetch(:application)}_#{fetch(:stage)}" }`<br/>
+The name of the service that DelayedJob uses.
+
+### Template customization
+
+If you want to change default templates, you can generate them using
+`rails generator`:
+
+    $ bundle exec rails g capistrano:delayed_job:config
+
+This will copy default templates to `config/deploy/templates` directory, so you
+can customize them as you like, and capistrano tasks will use this templates
+instead of default.
+
+You can also provide path, where to generate templates:
+
+    $ bundle exec rails g capistrano:delayed_job:config config/templates
+
+### More Capistrano automation?
+
+If you'd like to streamline your Capistrano deploys, you might want to check
+these zero-configuration, plug-n-play plugins:
+
+- [capistrano-unicorn-nginx](https://github.com/bruno-/capistrano-unicorn-nginx)<br/>
+no-configuration unicorn and nginx setup with sensible defaults
+- [capistrano-postgresql](https://github.com/bruno-/capistrano-postgresql)<br/>
+plugin that automates postgresql configuration and setup
+- [capistrano-rbenv-install](https://github.com/bruno-/capistrano-rbenv-install)<br/>
+would you like Capistrano to install rubies for you?
+- [capistrano-safe-deploy-to](https://github.com/bruno-/capistrano-safe-deploy-to)<br/>
+if you're annoyed that Capistrano does **not** create a deployment path for the
+app on the server (default `/var/www/myapp`), this is what you need!
+
+### Bug reports and pull requests
+
+...are very welcome!
+
+### Thanks
+
+[@bruno-](https://github.com/bruno-) - for his
+[capistrano-unicorn-nginx](https://github.com/bruno-/capistrano-unicorn-nginx) plugin on which this
+one is based.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/capistrano-delayed-job.gemspec

@@ -0,0 +1,35 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'capistrano/delayed_job/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "capistrano-delayed-job"
+  gem.version       = Capistrano::DelayedJob::VERSION
+  gem.authors       = ["Ruben Stranders"]
+  gem.email         = ["r.stranders@gmail.com"]
+  gem.description   = <<-EOF.gsub(/^\s+/, '')
+    Capistrano tasks for automatic and sensible DelayedJob configuration.
+
+    Enables zero downtime deployments of Rails applications. Configs can be
+    copied to the application using generators and easily customized.
+
+    Works *only* with Capistrano 3+.
+
+    Inspired by https://github.com/bruno-/capistrano-unicorn-nginx and http://bl.ocks.org/dv/10370719
+  EOF
+  gem.summary       = "Capistrano tasks for automatic and sensible DelayedJob configuration."
+  gem.homepage      = "https://github.com/capistrano-plugins/capistrano-delayed-job"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "capistrano", ">= 3.1"
+  gem.add_dependency "sshkit", ">= 1.2.0"
+
+  gem.add_dependency "daemons", ">= 1.1"
+
+  gem.add_development_dependency "rake"
+end

data/lib/capistrano/delayed_job.rb

@@ -0,0 +1,2 @@
+require 'capistrano/dsl/delayed_job_paths'
+load File.expand_path("../tasks/delayed_job.rake", __FILE__)

data/lib/capistrano/delayed_job/helpers.rb

@@ -0,0 +1,38 @@
+require 'erb'
+
+module Capistrano
+  module DelayedJob
+    module Helpers
+
+      def bundle_delayed_job(*args)
+        SSHKit::Command.new(:bundle, :exec, "script/delayed_job", args).to_command
+      end
+
+      def dj_template(template_name)
+        config_file = "#{fetch(:templates_path)}/#{template_name}"
+        # if no customized file, proceed with default
+        unless File.exists?(config_file)
+          config_file = File.join(File.dirname(__FILE__), "../../generators/capistrano/delayed_job/templates/#{template_name}")
+        end
+        StringIO.new(ERB.new(File.read(config_file)).result(binding))
+      end
+
+      def file_exists?(path)
+        test "[ -e #{path} ]"
+      end
+
+      def deploy_user
+        capture :id, '-un'
+      end
+
+      def sudo_upload!(from, to)
+        filename = File.basename(to)
+        to_dir = File.dirname(to)
+        tmp_file = "#{fetch(:tmp_dir)}/#{filename}"
+        upload! from, tmp_file
+        sudo :mv, tmp_file, to_dir
+      end
+
+    end
+  end
+end

data/lib/capistrano/delayed_job/version.rb

@@ -0,0 +1,5 @@
+module Capistrano
+  module DelayedJob
+    VERSION = "1.0.0"
+  end
+end

data/lib/capistrano/dsl/delayed_job_paths.rb

@@ -0,0 +1,15 @@
+module Capistrano
+  module DSL
+    module DelayedJobPaths
+
+      def delayed_job_initd_file
+        "/etc/init.d/#{fetch(:delayed_job_service)}"
+      end
+
+      def current_path
+        deploy_path.join('current')
+      end
+
+    end
+  end
+end

data/lib/capistrano/tasks/delayed_job.rake

@@ -0,0 +1,52 @@
+require 'capistrano/dsl/delayed_job_paths'
+require 'capistrano/delayed_job/helpers'
+
+include Capistrano::DelayedJob::Helpers
+include Capistrano::DSL::DelayedJobPaths
+
+namespace :load do
+  task :defaults do
+    set :delayed_job_workers, 1
+    set :delayed_job_service, -> { "delayed_job_#{fetch(:application)}_#{fetch(:stage)}" }
+
+    set :delayed_job_server_roles, [:app]
+  end
+end
+
+namespace :delayed_job do
+
+  task :defaults do
+    on roles fetch(:delayed_job_server_roles) do
+      set :delayed_job_user, fetch(:delayed_job_user, deploy_user)
+    end
+  end
+
+  desc 'Setup DelayedJob initializer'
+  task :setup do
+    on roles fetch(:delayed_job_server_roles) do
+      sudo_upload! dj_template('delayed_job_init.erb'), delayed_job_initd_file
+      execute :chmod, '+x', delayed_job_initd_file
+      sudo 'update-rc.d', '-f', fetch(:delayed_job_service), 'defaults'
+    end
+  end
+
+  before :setup, :defaults
+
+  %w[start stop restart].each do |command|
+    desc "#{command} delayed_job"
+    task command do
+      on roles fetch(:delayed_job_server_roles) do
+        sudo :service, "#{fetch(:delayed_job_service)} #{command}"
+      end
+    end
+  end
+end
+
+namespace :deploy do
+  after :publishing, 'delayed_job:restart'
+end
+
+desc 'Server setup tasks'
+task :setup do
+  invoke 'delayed_job:setup'
+end

data/lib/generators/capistrano/delayed_job/USAGE.md

@@ -0,0 +1,9 @@
+To create local delayed_job configuration files call
+
+    bundle exec rails generate capistrano:delayed_job:config [path]
+
+The default path is "config/deploy/templates". You can override it like so:
+
+    bundle rails generate capistrano:delayed_job:config "config/templates"
+
+If you override templates path, don't forget to set "templates_path" variable in your deploy.rb

data/lib/generators/capistrano/delayed_job/config_generator.rb

@@ -0,0 +1,17 @@
+module Capistrano
+  module DelayedJob
+    module Generators
+      class ConfigGenerator < Rails::Generators::Base
+        desc "Create local DelayedJob configuration files for customization"
+        source_root File.expand_path('../templates', __FILE__)
+        argument :templates_path, type: :string,
+          default: "config/deploy/templates",
+          banner: "path to templates"
+
+        def copy_template
+          copy_file "delayed_job_init.erb", "#{templates_path}/delayed_job_init.erb"
+        end
+      end
+    end
+  end
+end

data/lib/generators/capistrano/delayed_job/templates/delayed_job_init.erb

@@ -0,0 +1,48 @@
+#! /bin/sh
+ 
+### BEGIN INIT INFO
+# Provides:          delayed_job
+# Required-Start:    $remote_fs $syslog
+# Required-Stop:	 $remote_fs $syslog
+# Default-Start:     2 3 4 5
+# Default-Stop:		 0 1 6
+# Short-Description: Manage delayed jobs for application <%= fetch(:application) %> , environment <%= fetch(:rails_env) %>
+# Description:       Start, stop, restart delayed jobs for application <%= fetch(:application) %>, environment <%= fetch(:rails_env) %>
+### END INIT INFO
+ 
+N=/etc/init.d/delayed_job
+APP_ROOT=<%= current_path %>
+AS_USER=<%= fetch(:delayed_job_user) %>
+service="delayed_job"
+
+
+ 
+set -e
+
+interact() {
+    op="$1"
+    echo "Invoking DelayedJob with command '$op'"
+    CMD="cd $APP_ROOT && HOME=/home/$AS_USER RAILS_ENV=<%= fetch(:rails_env) %> nice -n 15 <%= bundle_delayed_job("$op -n", fetch(:delayed_job_workers))%>"
+
+    if [ "$(id -un)" = "$AS_USER" ]; then
+        eval $CMD
+    else
+        su -c "$CMD" - $AS_USER
+    fi
+}
+ 
+case "$1" in
+    start|stop)
+        interact "$1"
+        ;;
+    reload|restart|force-reload)
+        interact "stop"
+        sleep 1s
+        interact "start"
+        ;;
+    *)
+        usage
+        ;;
+esac
+ 
+exit 0

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-delayed-job
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Ruben Stranders
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: sshkit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: daemons
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |
+  Capistrano tasks for automatic and sensible DelayedJob configuration.
+  Enables zero downtime deployments of Rails applications. Configs can be
+  copied to the application using generators and easily customized.
+  Works *only* with Capistrano 3+.
+  Inspired by https://github.com/bruno-/capistrano-unicorn-nginx and http://bl.ocks.org/dv/10370719
+email:
+- r.stranders@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- capistrano-delayed-job.gemspec
+- lib/capistrano-delayed-job.rb
+- lib/capistrano/delayed_job.rb
+- lib/capistrano/delayed_job/helpers.rb
+- lib/capistrano/delayed_job/version.rb
+- lib/capistrano/dsl/delayed_job_paths.rb
+- lib/capistrano/tasks/delayed_job.rake
+- lib/generators/capistrano/delayed_job/USAGE.md
+- lib/generators/capistrano/delayed_job/config_generator.rb
+- lib/generators/capistrano/delayed_job/templates/delayed_job_init.erb
+homepage: https://github.com/capistrano-plugins/capistrano-delayed-job
+licenses: []
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Capistrano tasks for automatic and sensible DelayedJob configuration.
+test_files: []