easy-deployment 0.0.8

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Able Technology
+
+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/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Able Technology
+
+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,31 @@
+# Easy::Deployment
+
+This gem is for encapsulating Abletech's common deployment patterns using capistrano.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'easy-deployment', :git => "git@github.com:AbleTech/easy-deployment.git"
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install easy-deployment
+
+## Usage
+
+Run:
+
+    $ rails g easy:deployment
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,5 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new('spec')

data/easy-deployment.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/easy-deployment/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors          = ["Jeremy Olliver", "Nigel Ramsay", "Shevaun Coker"]
+  gem.email             =  ["jeremy.olliver@gmail.com", "nigel.ramsay@abletech.co.nz", "shevaun.coker@abletech.co.nz"]
+  gem.description    = %q{Easy deployment: includes a generator, and capistrano configuration}
+  gem.summary       = %q{Gem for encapsulating abletech's deployment practices}
+  gem.homepage     = ""
+
+  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.name          = "easy-deployment"
+  gem.require_paths = ["lib"]
+  gem.version       = Easy::Deployment::VERSION
+  
+
+  gem.add_runtime_dependency 'rails', '>= 3.0.0'
+  gem.add_runtime_dependency 'capistrano'
+  gem.add_runtime_dependency 'capistrano-ext'
+  gem.add_runtime_dependency 'capistrano_colors'
+
+  gem.add_development_dependency 'bundler'
+  gem.add_development_dependency 'rspec', '~> 2.8'
+end

data/lib/easy-deployment.rb

@@ -0,0 +1,3 @@
+require "easy-deployment/version"
+require 'easy/generators/deployment_generator'
+require 'easy/generators/stage_generator'

data/lib/easy-deployment/version.rb

@@ -0,0 +1,5 @@
+module Easy
+  module Deployment
+    VERSION = "0.0.8"
+  end
+end

data/lib/easy/deployment/backup.rb

@@ -0,0 +1,19 @@
+# To load this capistrano configuration, require 'easy/deployment/backup' from deploy.rb
+Capistrano::Configuration.instance(:must_exist).load do
+  namespace :easy do
+    namespace :backup do
+      desc "Creates the shared folders that backup requires"
+      task :setup, :except => { :no_release => true } do
+        run "mkdir -p #{shared_path}/backup/data"
+      end
+
+      desc "Adds a symbolic link from the s3.yml file in the shared/backup into the current/config folder"
+      task :symlink_s3_config do
+        run "ln -sf #{shared_path}/backup/s3.yml #{current_path}/config/s3.yml"
+      end
+    end
+  end
+
+  after 'deploy:setup', 'easy:backup:setup'
+  after 'deploy:symlink', 'easy:backup:symlink_s3_config'
+end

data/lib/easy/deployment/capistrano.rb

@@ -0,0 +1,39 @@
+# Define some defaults for capistrano deploys.
+# To load this capistrano configuraiton, require 'easy/deployment/capistrano' from deploy.rb
+
+Capistrano::Configuration.instance(:must_exist).load do
+
+  # ssh options
+  set :use_sudo, false
+  ssh_options[:forward_agent] = true # run `ssh-add ;` to ensure your identity file is added
+  default_run_options[:pty] = true
+
+  namespace :deploy do
+    # By default, we deploy using passenger as an app server
+    task :start do ; end
+    task :stop do ; end
+    task :restart, :roles => :app, :except => { :no_release => true } do
+      run "touch #{File.join(current_path,'tmp','restart.txt')}"
+    end
+
+    desc "[internal] Copies the application configuration files for this environment"
+    task :configure do
+      if File.exists?("./config/deploy/#{stage}/database.yml")
+        run "cp #{release_path}/config/deploy/#{stage}/database.yml #{release_path}/config/database.yml"
+      else
+        puts "Skipping copying of config/deploy/#{stage}/database.yml as the file is not present"
+      end
+    end
+
+  end
+
+  namespace :web do
+    desc "Configure this site & Reload the apache configuration"
+    task :configure do
+      run "cp -f #{current_path}/config/deploy/#{stage}/apache/* /etc/apache2/sites-enabled/"
+      run "sudo apache2ctl -k graceful"
+    end
+  end
+
+  after "deploy:update_code", "deploy:configure"
+end

data/lib/easy/deployment/logrotate.rb

@@ -0,0 +1,11 @@
+# To load this capistrano configuration, require 'easy/deployment/logrotate' from deploy.rb
+Capistrano::Configuration.instance(:must_exist).load do
+  namespace :easy do
+    namespace :logrotate do
+      desc "Copies the application logrotate file into /etc/logrotate.d"
+      task :setup, :except => { :no_release => true } do
+        run "cp #{current_path}/config/deploy/#{stage}/logrotate.conf /etc/logrotate.d/#{application}.conf"
+      end
+    end
+  end
+end

data/lib/easy/deployment/whenever.rb

@@ -0,0 +1,20 @@
+# To load this capistrano configuration, require 'easy/deployment/whenever' from deploy.rb
+Capistrano::Configuration.instance(:must_exist).load do
+  namespace :easy do
+    namespace :whenever do
+      desc "Removes this application's entries from the user's crontab file"
+      task :clear_crontab do
+        run "cd #{release_path} && #{bundle_cmd} exec whenever -f #{release_path}/config/deploy/#{rails_env}/whenever.rb --clear-crontab #{application}"
+      end
+
+      desc "Updates this application's crontab file entries"
+      task :update_crontab do
+        run "cd #{current_path} && #{bundle_cmd} exec whenever -f #{current_path}/config/deploy/#{rails_env}/whenever.rb --update-crontab #{application} --set \"current_path=#{current_path}&bundle_cmd=#{fetch(:bundle_cmd, 'bundle')}&rails_env=#{rails_env}&application=#{application}\""
+      end
+    end
+  end
+
+  after "deploy:update_code", "easy:whenever:clear_crontab"
+  after "deploy:symlink", "easy:whenever:update_crontab"
+  after "deploy:rollback", "easy:whenever:update_crontab"
+end

data/lib/easy/generators/deployment_generator.rb

@@ -0,0 +1,57 @@
+require 'rails/generators'
+require 'optparse'
+
+module Easy
+  class DeploymentGenerator < Rails::Generators::Base
+    source_root File.join(File.dirname(__FILE__), "templates") # Where templates are copied from
+
+    def application_name
+      Rails.application.class.name.split("::").first.underscore # surely there's a better way than this
+    end
+
+    desc %{Generates standard able technology deployment script using capistrano}
+
+    def create_deployment_files
+      options = parse_options(ARGV)
+
+      # If there was a deploy.rb initially, let the generator prompt to handle conflicts. Otherwise remove the default capistrano one, so we can override it silently with our template without being prompted
+      deploy_file_already_existed = File.exist?(File.join(destination_root, "config", "deploy.rb"))
+      capify!
+      remove_file("config/deploy.rb") unless deploy_file_already_existed # Removing this means we aren't prompted to overwrite if we only have the default capistrano deploy.rb
+      # Write our default deploy.rb
+      copy_file("deploy.rb.tt", "config/deploy.rb")
+
+      # Generate all stages specified
+      options[:stages] ||= %w(staging production)
+      options[:stages].each do |stage|
+        generate("easy:stage", stage)
+      end
+
+      info = %{
+Easy Deployment Config now setup!
+
+TODO:
+  * Set the correct git repository in config/deploy.rb
+}
+      options[:stages].each do |stage|
+        info += "  * Set the ip address for staging in config/deploy/#{stage}.rb && the apache config in config/deploy/#{stage}/apache/#{application_name}"
+      end
+      puts info
+      true
+    end
+
+    private
+
+    # TODO: surely there's a better option parser built into thor, or the generators themselves?
+    def parse_options(args)
+      opts = {}
+      OptionParser.new do |opt|
+        opt.on("-s", "--stages" "Stages to generate") do |s|
+          opts[:stages] = s.split(",") if s.present?
+        end
+      end.parse(args)
+      opts
+    end
+
+  end
+end

data/lib/easy/generators/logrotate_generator.rb

@@ -0,0 +1,21 @@
+require 'rails/generators'
+
+module Easy
+  class LogrotateGenerator < Rails::Generators::NamedBase
+    source_root File.join(File.dirname(__FILE__), "templates") # Where templates are copied from
+
+    desc %{Generate a new logrotate.conf file for the given environment name\ne.g. rails g easy:logrotate workshop}
+
+    def generate_stage
+      # directory("stage", "config/#{name}")
+
+      # Ensure we have a config/deploy/<env-name>/logrotate.rb
+      # dest = "config/deploy/#{name}/logrotate.conf"
+      # in_root do
+      #   unless File.exist?(dest)
+      #     run("cp config/environments/production.rb #{dest}")
+      #   end
+      # end
+    end
+  end
+end

data/lib/easy/generators/stage_generator.rb

@@ -0,0 +1,23 @@
+require 'rails/generators'
+
+module Easy
+  class StageGenerator < Rails::Generators::NamedBase
+    source_root File.join(File.dirname(__FILE__), "templates") # Where templates are copied from
+
+    desc %{Generate a new deployment script for the given environment name\ne.g. rails g easy:stage workshop}
+
+    def generate_stage
+      directory("stage", "config/deploy/#{name}")
+      copy_file("stage.rb.tt", "config/deploy/#{name}.rb")
+
+      # Ensure we have a config/environments/<env-name>.rb
+      dest = "config/environments/#{name}.rb"
+      in_root do
+        unless File.exist?(dest)
+          run("cp config/environments/production.rb #{dest}")
+        end
+      end
+    end
+
+  end
+end

data/lib/easy/generators/templates/deploy.rb.tt

@@ -0,0 +1,28 @@
+require "capistrano/ext/multistage"
+require "capistrano_colors"
+require "bundler/capistrano"
+begin
+  require "easy/deployment/capistrano"
+rescue LoadError
+  $stderr.puts "couldn't load easy-deployment gem, try `bundle install` and running again with `bundle exec cap <stage> deploy`"
+  exit(1)
+end
+
+set :stages, %w(staging production)
+set :default_stage, "staging"
+
+set :application, "<%= application_name %>" # TODO: edit application name
+set :deploy_to,   "/var/apps/#{application}"
+
+# TODO: fill in git repo
+# set :repository,  "git@github.com:AbleTech/easy-deployment.git"
+set :scm, :git
+set :deploy_via, :remote_cache
+set :git_shallow_clone, 1
+
+
+# If deploying with RVM:
+# Add gem 'rvm' to the development group in Gemfile, and uncomment following lines
+# require "rvm/capistrano"
+# set :rvm_type, :system
+# set :rvm_ruby_string, '1.9.2-p290'

data/lib/easy/generators/templates/stage.rb.tt

@@ -0,0 +1,6 @@
+# role :web, "<<%= name %>-ip-address>"                   # Your HTTP server, Apache/etc
+# role :app, "<<%= name %>-ip-address>"                   # This may be the same as your `Web` server
+# role :db,  "<<%= name %>-ip-address>", :primary => true # This is where Rails migrations will run
+
+set :branch, "master"
+set :rails_env, "<%= name %>"

data/lib/easy/generators/templates/stage/apache/%application_name%.tt

@@ -0,0 +1,10 @@
+<VirtualHost <<%= name %>-ip-address>:80>
+   ServerName <%= name %>.<%= application_name %>.co.nz
+
+   DocumentRoot /var/apps/<%= application_name %>/current/public
+   RailsEnv <%= name %>
+   <Directory /var/apps/<%= application_name %>/current/public>
+      AllowOverride all
+      Options -MultiViews
+   </Directory>
+</VirtualHost>

data/spec/easy_deployment_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper.rb'
+
+describe Easy::Deployment do
+  it "has a version number" do
+    Easy::Deployment::VERSION.should be_present
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper.rb"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require 'rubygems'
+require 'bundler'
+
+require 'easy-deployment'
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: easy-deployment
+version: !ruby/object:Gem::Version
+  version: 0.0.8
+  prerelease: 
+platform: ruby
+authors:
+- Jeremy Olliver
+- Nigel Ramsay
+- Shevaun Coker
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &70127454527720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70127454527720
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: &70127454526800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70127454526800
+- !ruby/object:Gem::Dependency
+  name: capistrano-ext
+  requirement: &70127454525720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70127454525720
+- !ruby/object:Gem::Dependency
+  name: capistrano_colors
+  requirement: &70127458468000 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70127458468000
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70127458494460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70127458494460
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70127458520500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :development
+  prerelease: false
+  version_requirements: *70127458520500
+description: ! 'Easy deployment: includes a generator, and capistrano configuration'
+email:
+- jeremy.olliver@gmail.com
+- nigel.ramsay@abletech.co.nz
+- shevaun.coker@abletech.co.nz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- easy-deployment.gemspec
+- lib/easy-deployment.rb
+- lib/easy-deployment/version.rb
+- lib/easy/deployment/backup.rb
+- lib/easy/deployment/capistrano.rb
+- lib/easy/deployment/logrotate.rb
+- lib/easy/deployment/whenever.rb
+- lib/easy/generators/deployment_generator.rb
+- lib/easy/generators/logrotate_generator.rb
+- lib/easy/generators/stage_generator.rb
+- lib/easy/generators/templates/deploy.rb.tt
+- lib/easy/generators/templates/stage.rb.tt
+- lib/easy/generators/templates/stage/apache/%application_name%.tt
+- spec/easy_deployment_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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'
+      segments:
+      - 0
+      hash: 2386324280416784437
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2386324280416784437
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.16
+signing_key: 
+specification_version: 3
+summary: Gem for encapsulating abletech's deployment practices
+test_files:
+- spec/easy_deployment_spec.rb
+- spec/spec_helper.rb