capistrano-kyan 0.2.10

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f90cdf9ffdea5aa1252cc080bebd70f433bf6bd8
+  data.tar.gz: 18a7cea51bf15c2989130a95d58831911bff9fd0
+SHA512:
+  metadata.gz: 744495bd147632d31375f6bc52ac4f91ef3ea4bd02f79d3dbdc913058d531d871e2d97bcb715632bafa31e96007891833a31a8c6d9c2e87ad27d45f3d03f59b2
+  data.tar.gz: e9e3f017ccac238dd000abb7a2cb6dc3ac44787e1c8020f29bae55e69e378ddf4cd48156b57b9e0a826d1f4308d7a62ee28575101dc9a3e0129e76418beaa338

data/.gitignore

@@ -0,0 +1,41 @@
+!.gitignore
+*.gem
+*.rbc
+*.sw[a-p]
+*.tmproj
+*.tmproject
+*.un~
+*~
+.DS_Store
+.Spotlight-V100
+.Trashes
+._*
+.bundle
+.config
+.directory
+.elc
+.redcar
+.yardoc
+/.emacs.desktop
+/.emacs.desktop.lock
+Desktop.ini
+Gemfile.lock
+Icon?
+InstalledFiles
+Session.vim
+Thumbs.db
+\#*\#
+_yardoc
+auto-save-list
+coverage
+doc/
+lib/bundler/man
+pkg
+pkg/*
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+tmtags
+tramp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Duncan Robertson
+
+MIT License
+
+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,73 @@
+# Capistrano Kyan
+
+Capistrano plugin that includes a collection of tasks we find useful here at Kyan.
+
+## Usage
+
+### Setup
+
+Add the library to your `Gemfile`:
+
+```ruby
+group :development do
+  gem 'capistrano-kyan', :git => "https://github.com/kyan/capistrano-kyan.git", :require => false
+end
+```
+
+And load it into your deployment script `config/deploy.rb`:
+
+```ruby
+require 'capistrano-kyan'
+```
+
+Add kyan vhost task hook:
+
+```ruby
+after "deploy:setup", "kyan:vhost:setup"
+```
+
+Add kyan db task hook:
+
+```ruby
+after "deploy:setup", "kyan:db:setup"
+```
+
+### Test
+
+First, make sure you're running the latest release:
+
+```
+cap deploy:setup
+```
+
+Then you can test each individual task:
+
+```
+cap kyan:db:setup
+cap kyan:vhost:setup
+```
+
+## Configuration
+
+You can modify any of the following options in your `deploy.rb` config.
+
+- `vhost_env` - Set vhost environment. Default to `rails_env` variable.
+- `vhost_tmpl_path` - Set vhost template path. Default to `config/deploy`.
+- `vhost_tmpl_name` - Set vhost template name. Default to `vhost.conf.erb`.
+- `vhost_server_path` - Set vhost server path. Default to `/etc/nginx/sites-enabled`.
+- `vhost_server_name` - Set vhost server name. Default to `File.basename(deploy_to)`.
+
+I'm assuming you are using capistrano multistage.
+
+## Available Tasks
+
+To get a list of all capistrano tasks, run `cap -T`:
+
+```
+cap kyan:db:setup               # Creates a database.yml file in the apps shared path.
+cap kyan:vhost:setup            # Creates and symlinks an Nginx virtualhost entry.
+```
+
+## License
+
+See LICENSE file for details.

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+require 'bundler/gem_tasks'

data/capistrano-kyan.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'capistrano-kyan/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "capistrano-kyan"
+  gem.version       = CapistranoKyan::VERSION
+  gem.authors       = ["Duncan Robertson"]
+  gem.email         = ["duncan@kyan.com"]
+  gem.description   = %q{Capistrano tasks for database.yml and vhost creation}
+  gem.summary       = %q{A bunch of useful Capistrano tasks}
+  gem.homepage      = "http://github.com/kyan/capistrano-kyan"
+
+  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_development_dependency 'rake'
+
+  gem.add_runtime_dependency 'capistrano'
+end

data/lib/capistrano-kyan/capistrano_integration.rb

@@ -0,0 +1,200 @@
+require 'capistrano'
+require 'capistrano/version'
+
+module CapistranoKyan
+  class CapistranoIntegration
+    TASKS = [
+      'deploy:seed',
+      'deploy:add_env',
+      'kyan:db:setup',
+      'kyan:vhost:setup',
+      'kyan:vhost:show',
+      'nginx:start',
+      'nginx:stop',
+      'nginx:restart',
+      'nginx:reload',
+      'foreman:export',
+      'foreman:start',
+      'foreman:stop',
+      'foreman:restart'
+    ]
+
+    def self.load_into(capistrano_config)
+      capistrano_config.load do
+        before(CapistranoIntegration::TASKS) do
+          _cset(:app_env)             { (fetch(:rails_env) rescue 'staging') }
+          _cset(:vhost_env)           { fetch(:app_env) }
+          _cset(:vhost_tmpl_path)     { 'config/vhosts' }
+          _cset(:vhost_tmpl_name)     { 'vhost.conf.erb' }
+          _cset(:vhost_server_path)   { '/etc/nginx/sites-enabled' }
+          _cset(:vhost_server_name)   { File.basename(deploy_to) rescue fetch(:app_env) }
+        end
+
+        def appize(app, prefix = 'staging')
+          "#{app.gsub('.','_')}_#{prefix}"
+        end
+
+        def tmpl_server_location
+          run "mkdir -p #{shared_path}/config"
+          File.join(shared_path, 'config', "#{File.basename(deploy_to)}.conf")
+        end
+
+        def symlink(target, link)
+          run "ln -nfs #{target} #{link}"
+        end
+
+        def parse_template(template)
+          ERB.new(File.read(template), nil , '-').result(binding)
+        end
+
+        def build_vhost(path, name)
+          [
+            File.join(path, name),
+            File.join(File.dirname(__FILE__),'../../templates/vhost.conf.erb')
+          ].each do |template|
+            if File.file? template
+              return parse_template(template)
+            end
+          end
+        end
+
+        namespace :deploy do
+          desc "Load the database with seed data"
+          task :seed do
+            run "cd #{current_path}; bundle exec rake db:seed RAILS_ENV=#{app_env}"
+          end
+
+          task :add_env do
+            put "RAILS_ENV=#{app_env}", "#{release_path}/.env"
+          end
+        end
+
+        after "deploy:finalize_update", "deploy:add_env"
+
+        namespace :nginx do
+          task :start, :roles => :app, :except => { :no_release => true } do
+            run "sudo /etc/init.d/nginx start"
+          end
+
+          task :stop, :roles => :app, :except => { :no_release => true } do
+            run "sudo /etc/init.d/nginx stop"
+          end
+
+          task :restart, :roles => :app, :except => { :no_release => true } do
+            run "sudo /etc/init.d/nginx restart"
+          end
+
+          task :reload, :roles => :app, :except => { :no_release => true } do
+            run "sudo /etc/init.d/nginx reload"
+          end
+        end
+
+        namespace :foreman do
+          desc "Export the Procfile to Ubuntu's upstart scripts"
+          task :export, :roles => :app do
+            run "cd #{release_path} && sudo foreman export upstart /etc/init -a #{vhost_server_name} -u #{user} -l #{shared_path}/log"
+          end
+          desc "Start the application services"
+          task :start, :roles => :app do
+            run "sudo start #{vhost_server_name}"
+          end
+
+          desc "Stop the application services"
+          task :stop, :roles => :app do
+            run "sudo stop #{vhost_server_name}"
+          end
+
+          desc "Restart the application services"
+          task :restart, :roles => :app do
+            run "sudo start #{vhost_server_name} || sudo restart #{vhost_server_name}"
+          end
+        end
+
+        namespace :kyan do
+          #
+          # vhost cap tasks
+          #
+          namespace :vhost do
+            desc <<-DESC
+              Creates and symlinks an Nginx virtualhost entry.
+
+              By default, this task uses a builtin template which you
+              see the output with rake kyan:vhost:show. If you need to
+              customise this, you can create your own erb template and
+              update the :vhost_tmpl_path and :vhost_tmpl_name variables.
+            DESC
+            task :setup, :except => { :no_release => true } do
+              if tmpl = build_vhost(vhost_tmpl_path, vhost_tmpl_name)
+                put tmpl, tmpl_server_location
+                symlink(tmpl_server_location, vhost_server_path)
+              else
+                puts "Could not find a suitable template."
+              end
+            end
+
+            desc "Displays the vhost that will be uploaded to server"
+            task :show, :except => { :no_release => true } do
+              puts build_vhost(vhost_tmpl_path, vhost_tmpl_name)
+            end
+          end
+
+          #
+          # database.yml cap tasks
+          #
+          namespace :db do
+            desc <<-DESC
+              Creates a database.yml file in the apps shared path.
+            DESC
+            task :setup, :except => { :no_release => true } do
+
+              require 'digest/sha1'
+              app = appize(application, fetch(:stage))
+              database = fetch(:db_database, app)
+              username = fetch(:db_username, app)
+              password = Capistrano::CLI.ui.ask("DB password for #{database} (empty for default): ")
+              password = password.empty? ? Digest::SHA1.hexdigest(database) : password
+
+              default_template = <<-EOF
+      base: &base
+        encoding: utf8
+        adapter: postgresql
+        pool: <%= fetch(:db_pool, 5) %>
+        host: <%= fetch(:db_host, 'localhost') %>
+      <%= fetch(:stage) %>:
+        database: <%= database %>
+        username: <%= username %>
+        password: <%= password %>
+        <<: *base
+              EOF
+
+              location = fetch(:template_dir, "config/deploy") + '/database.yml.erb'
+              template = File.file?(location) ? File.read(location) : default_template
+              config = ERB.new(template, nil , '-')
+
+              run "mkdir -p #{shared_path}/config"
+              put config.result(binding), "#{shared_path}/config/database.yml"
+            end
+
+            #
+            # Updates the symlink for database.yml file to the just deployed release.
+            #
+            task :symlink, :except => { :no_release => true } do
+              path_to_appl_database_yml = "#{release_path}/config/database.yml"
+              path_to_conf_database_yml = "#{shared_path}/config/database.yml"
+
+              run "ln -nfs #{path_to_conf_database_yml} #{path_to_appl_database_yml}"
+            end
+          end
+
+          after "deploy:finalize_update", "kyan:db:symlink"
+        end
+      end
+    end
+  end
+end
+
+if Capistrano::Configuration.instance
+  CapistranoKyan::CapistranoIntegration.load_into(Capistrano::Configuration.instance)
+else
+  abort "Capinstrano-kyan requires Capistrano 2"
+end

data/lib/capistrano-kyan/version.rb

@@ -0,0 +1,3 @@
+module CapistranoKyan
+  VERSION = "0.2.10"
+end

data/lib/capistrano-kyan.rb

@@ -0,0 +1,2 @@
+require "capistrano-kyan/version"
+require "capistrano-kyan/capistrano_integration"

data/templates/vhost.conf.erb

@@ -0,0 +1,15 @@
+server {
+  listen 80;
+  server_name <%= vhost_server_name %>;
+  root <%= current_path %>/public;
+  passenger_enabled on;
+  rails_env <%= vhost_env %>;
+
+  # serve static content directly
+  location ~* \.(ico|jpg|gif|png|swf|html)$ {
+    if (-f $request_filename) {
+      expires max;
+      break;
+    }
+  }
+}

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-kyan
+version: !ruby/object:Gem::Version
+  version: 0.2.10
+platform: ruby
+authors:
+- Duncan Robertson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-11 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Capistrano tasks for database.yml and vhost creation
+email:
+- duncan@kyan.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- capistrano-kyan.gemspec
+- lib/capistrano-kyan.rb
+- lib/capistrano-kyan/capistrano_integration.rb
+- lib/capistrano-kyan/version.rb
+- templates/vhost.conf.erb
+homepage: http://github.com/kyan/capistrano-kyan
+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.0.14
+signing_key: 
+specification_version: 4
+summary: A bunch of useful Capistrano tasks
+test_files: []