capistrano-af83 0.1.0

data/LICENSE

@@ -0,0 +1,21 @@
+MIT LICENSE
+
+Copyright (c) af83
+
+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,70 @@
+Capistrano recipes for af83
+===========================
+
+We are [af83](http://dev.af83.com/). We develop web applications and most of
+them are deployed with [capistrano](https://github.com/capistrano/capistrano).
+The capistrano-af83 gem let us share recipes and good practices between our
+projects. It's an Open-Source project, so feel free to use it or just look at
+it for inspiration!
+
+
+How to use it?
+--------------
+
+Add it in the `Gemfile` and run `bundle update`:
+
+```ruby
+group :development do
+  gem 'capistrano-af83'  
+end
+```
+
+Then use of one the
+[examples](https://github.com/af83/capistrano-af83/blob/master/examples) of
+`config/deploy.rb` files and follow the comments for configuration.
+
+And finally test it on the dev environment:
+
+```sh
+cap dev deploy:setup
+cap dev deploy:check
+cap dev deploy
+```
+
+
+Capistrano extensions
+---------------------
+
+We use some capistrano extensions (capistrano-af83 depends on them):
+
+- [**multistage**](https://github.com/TechnoGate/capistrano-exts):
+  have a configuration per environment
+- [**capistrano_colors**](https://github.com/stjernstrom/capistrano_colors/):
+  colorize your capistrano output for better overview
+- [**capistrano-notification**](https://github.com/ursm/capistrano-notification):
+  notify the end of the deployment on IRC
+- [**sushi**](https://github.com/presskey/sushi):
+  add a recipe that starts a SSH connection to remote server
+- [**bundler**](http://gembundler.com/deploying.html):
+  automatically run bundle install on the remote server with deployment-friendly options
+
+
+Environments
+------------
+
+    +-----------+-------------+------------+----------------------------+
+    | Cap stage | Rails env   | Git branch | Host                       |
+    +-----------+-------------+------------+----------------------------+
+    | N/A       | development | master     | localhost                  |
+    | N/A       | test        | master     | localhost/jenkins          |
+    | dev       | dev         | master     | dev.{project}.af83.com     |
+    | staging   | staging     | staging    | staging.{project}.af83.com |
+    | prod      | production  | production | {project}.com              |
+    +-----------+-------------+------------+----------------------------+
+
+
+Credits
+-------
+
+Copyright (c) 2011 af83
+Released under the MIT license

data/lib/capistrano/af83.rb

@@ -0,0 +1,7 @@
+# This is our default stack
+
+require "capistrano"
+Capistrano::Configuration.instance.load_paths << File.dirname(__FILE__)
+Capistrano::Configuration.instance.load "af83/default"
+Capistrano::Configuration.instance.load "af83/environments"
+require "capistrano/af83/extensions"

data/lib/capistrano/af83/custom_maintenance_page.rb

@@ -0,0 +1,19 @@
+# Use a custom maintenance page
+
+# TODO explain how to use it
+
+namespace :deploy do
+  namespace :web do
+    task :disable, :roles => :web, :except => { :no_release => true } do
+      on_rollback { run "rm #{shared_path}/system/maintenance.html" }
+      require 'erb'
+      reason, deadline = ENV['REASON'], ENV['deadline']
+      template = File.read(File.join(File.dirname(__FILE__), "templates", "maintenance.rhtml"))
+      result = ERB.new(template).result(binding)
+      put result, "#{shared_path}/system/maintenance.html", :mode => 0644
+    end
+  end
+end
+
+before "deploy:cold", "deploy:web:disable"
+after  "deploy:cold", "deploy:web:enable"

data/lib/capistrano/af83/default.rb

@@ -0,0 +1,23 @@
+# Set default values
+
+default_run_options[:pty] = true
+
+# Obviously, we are git lovers
+depend :remote, :command, "git"
+set :scm,          :git
+set :scm_username, :af83
+set :repository,   "#{scm_username}@git.af83.com:#{appname}.git"
+
+set :use_sudo,     false
+set :deploy_via,   :remote_cache
+set (:application) { "#{rails_env}.#{appname}.af83.com" }
+set (:deploy_to)   { "/var/www/#{user}/#{rails_env}" }
+
+# I don't know why capistrano don't do the cleanup by default,
+# but it should be the case.
+set :keep_releases, 5
+after  "deploy:symlink", "deploy:cleanup"
+
+# TODO move this somewhere else
+depend :remote, :command, "bundle"
+set :bundle_cmd,    "bundle"

data/lib/capistrano/af83/environments.rb

@@ -0,0 +1,6 @@
+# Configure the 3 stages: dev, staging and production
+
+set :stages, %w(dev staging production)
+set :default_stage, "dev"
+
+# TODO find how to provide default values for branch, rails_env per stage

data/lib/capistrano/af83/es.rb

@@ -0,0 +1,17 @@
+# Add a recipe for Elastic Search
+
+namespace :es do
+  desc "Start Elastic Search if needed"
+  task :start do
+    run "cd #{release_path} && #{bundle_cmd} exec rake es:soft_start", :once => true
+  end
+
+  task :restart do
+    run "cd #{release_path} && #{bundle_cmd} exec rake es:running_restart", :once => true
+  end
+
+  desc "Recreate index and reindex last records for ES/Tire models"
+  task :rebuild_index do
+    run "cd #{current_path} && #{bundle_cmd} exec rake es:rebuild_index", :once => true
+  end
+end

data/lib/capistrano/af83/extensions.rb

@@ -0,0 +1,6 @@
+# Load the capistrano extensions
+require "capistrano_colors"
+require "capistrano-notification"
+require "capistrano/ext/multistage"
+require "sushi/ssh"
+require "bundler/capistrano"

data/lib/capistrano/af83/info.rb

@@ -0,0 +1,14 @@
+# Add the info task
+
+desc 'prints the configuration'
+task :info do
+  show = Proc.new {|var| puts "\t- #{var}: #{fetch var}\n\n" }
+  show.call "stage"
+  show.call "user"
+  show.call "appname"
+  show.call "application"
+  show.call "deploy_to"
+  show.call "repository"
+  show.call "branch"
+  show.call "rails_env"
+end

data/lib/capistrano/af83/js_routes.rb

@@ -0,0 +1,10 @@
+# Create a JS file with the Rails routes
+
+namespace :js do
+  desc "Create js routes"
+  task :create_routes do
+    run "cd #{release_path} && #{bundle_cmd} exec rake js:routes"
+  end
+end
+
+after "deploy:update_code", "js:create_routes"

data/lib/capistrano/af83/mongoid.rb

@@ -0,0 +1,22 @@
+# Use the config/mongoid/#{rails_env}.yml file for mongoid config
+
+namespace :mongoid do
+  desc "Copy mongoid config"
+  task :copy do
+    upload "config/mongoid/#{rails_env}.yml", "#{shared_path}/mongoid.yml", :via => :scp, :once => true
+  end
+
+  desc "Link the mongoid config in the release_path"
+  task :symlink do
+    run "ln -s #{shared_path}/mongoid.yml #{release_path}/config/mongoid.yml", :once => true
+  end
+
+  desc "Create MongoDB indexes"
+  task :index do
+    run "cd #{current_path} && #{bundle_cmd} exec rake db:mongoid:create_indexes", :once => true
+  end
+end
+
+after "deploy:finalize_update", "mongoid:copy"
+after "deploy:finalize_update", "mongoid:symlink"
+after "deploy:update_code", "mongoid:index"

data/lib/capistrano/af83/resque.rb

@@ -0,0 +1,20 @@
+# Add a recipe for resque
+
+namespace :resque do
+  desc "start resque queues"
+  task :start do
+    run "cd #{current_path} && #{bundle_cmd_cmd} exec rake resque:pool:start", :once => true
+  end
+
+  desc "stop resque queues"
+  task :stop do
+    run "cd #{current_path} && #{bundle_cmd_cmd} exec rake resque:pool:stop", :once => true
+  end
+
+  desc "restart resque queues"
+  task :restart do
+    run "cd #{current_path} && #{bundle_cmd_cmd} exec rake resque:pool:stop && sleep 1 && #{bundle} exec rake resque:pool:start", :once => true
+  end
+end
+
+after 'deploy:update_code', 'resque:restart'

data/lib/capistrano/af83/thin.rb

@@ -0,0 +1,15 @@
+# Use thin for deployment
+
+namespace :deploy do
+  task :start, :roles => :app do
+    run "cd #{current_path} && #{bundle_cmd} exec thin start -C #{shared_path}/thin.yml"
+  end
+
+  task :stop, :rules => :app do
+    run "cd #{current_path} && #{bundle_cmd} exec thin stop -C #{shared_path}/thin.yml"
+  end
+
+  task :restart, :roles => :app, :except => { :no_release => true }  do
+    run "cd #{current_path} && #{bundle_cmd} exec thin restart -C #{shared_path}/thin.yml"
+  end
+end

data/lib/capistrano/af83/unicorn.rb

@@ -0,0 +1,19 @@
+# Use unicorn for deployment
+
+namespace :deploy do
+  task :start, :roles => :app do
+    run "cd #{current_path} && #{bundle_cmd} exec unicorn -c config/unicorn.rb -E #{rails_env} -D"
+  end
+
+  task :stop, :roles => :app do
+    set :unicorn_pidfile, "#{shared_path}/pids/unicorn.pid"
+    run "if [ -e #{unicorn_pidfile} ] ; then kill -QUIT `cat #{unicorn_pidfile}` ; fi"
+  end
+
+  task :restart, :roles => :app  do
+    set :unicorn_pid, capture("cat #{shared_path}/pids/unicorn.pid").chomp
+    run "kill -USR2 #{unicorn_pid}"
+    sleep 1
+    run "kill -QUIT #{unicorn_pid}"
+  end
+end

data/lib/capistrano/af83/version.rb

@@ -0,0 +1,5 @@
+module Capistrano
+  module AF83
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-af83
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Bruno Michel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-12-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: &86118080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: *86118080
+- !ruby/object:Gem::Dependency
+  name: capistrano-ext
+  requirement: &86115750 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: *86115750
+- !ruby/object:Gem::Dependency
+  name: capistrano_colors
+  requirement: &86115510 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: *86115510
+- !ruby/object:Gem::Dependency
+  name: capistrano-notification
+  requirement: &86115150 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: *86115150
+- !ruby/object:Gem::Dependency
+  name: sushi
+  requirement: &86114760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: *86114760
+description: Capistrano recipes for af83
+email: bruno.michel@af83.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/capistrano/af83.rb
+- lib/capistrano/af83/custom_maintenance_page.rb
+- lib/capistrano/af83/default.rb
+- lib/capistrano/af83/environments.rb
+- lib/capistrano/af83/es.rb
+- lib/capistrano/af83/extensions.rb
+- lib/capistrano/af83/info.rb
+- lib/capistrano/af83/js_routes.rb
+- lib/capistrano/af83/mongoid.rb
+- lib/capistrano/af83/resque.rb
+- lib/capistrano/af83/thin.rb
+- lib/capistrano/af83/unicorn.rb
+- lib/capistrano/af83/version.rb
+homepage: https://github.com/af83/capistrano-af83
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.12
+signing_key: 
+specification_version: 3
+summary: Capistrano recipes for af83
+test_files: []
+has_rdoc: