capistrano_webfaction_recipes 0.0.1

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/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Fire-Dragon-DoL
+
+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,38 @@
+# CapistranoWebfactionRecipes
+
+This is a simple gem that provides some useful capistrano recipes to handle a Webfaction shared hosting.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'capistrano_webfaction_recipes'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capistrano_webfaction_recipes
+
+## Usage
+
+Require the gem files in your deploy.rb file:
+
+    require 'capistrano_webfaction_recipes/all'
+
+Or (better) create a deploy.rb file through the generator by running:
+
+    rails generate webfaction:install
+
+Fill the options interactively, this will generate a nice deploy.rb file, ready to be used.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/capistrano_webfaction_recipes.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'capistrano_webfaction_recipes/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "capistrano_webfaction_recipes"
+  spec.version       = CapistranoWebfactionRecipes::VERSION
+  spec.authors       = ["Fire-Dragon-DoL"]
+  spec.email         = []
+  spec.description   = "Gem container for some nice webfaction recipes plus a standard deploy file that can be created with a generator"
+  spec.summary       = "A collection of recipes to handle webfaction shared hosting"
+  spec.homepage      = "https://github.com/Fire-Dragon-DoL/capistrano_webfaction_recipes"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+  spec.required_ruby_version = '>= 1.9.3'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_dependency "capistrano", "2.15.4"
+  spec.add_dependency "rails", "~> 3.2.13"
+  spec.add_dependency "colored", "~> 1.2"
+end

data/lib/capistrano_webfaction_recipes/all.rb

@@ -0,0 +1,3 @@
+require File.expand_path("../recipes/helpers", __FILE__)
+require File.expand_path("../recipes/tasks", __FILE__)
+require File.expand_path("../recipes/webfaction", __FILE__)

data/lib/capistrano_webfaction_recipes/recipes/helpers.rb

@@ -0,0 +1,46 @@
+# encoding: utf-8
+require 'active_support/all'
+require 'action_pack'
+require 'action_view'
+
+module Helpers
+
+  extend ::ActionView::Helpers::NumberHelper
+
+  module Characters
+
+    def self.success
+      "✓ "
+    end
+
+    def self.success_fat
+      "✔ "
+    end
+
+    def self.failure
+      "✕ "
+    end
+
+    def self.failure_fat
+      "✖ "
+    end
+
+    def self.up
+      "↑"
+    end
+
+    def self.down
+      "↓"
+    end
+
+    def self.left
+      "←"
+    end
+
+    def self.right
+      "→"
+    end
+
+  end
+
+end

data/lib/capistrano_webfaction_recipes/recipes/tasks.rb

@@ -0,0 +1,194 @@
+require 'colored'
+require 'active_support/all'
+require File.expand_path("../helpers", __FILE__)
+
+Capistrano::Configuration.instance(:must_exist).load do
+
+  namespace :server_performance do
+    desc "Get CPU and RAM usage"
+    task :default do
+      cpu_usage = capture("ps --no-headers -u #{fetch(:user)} -o pcpu | awk '{cpu += $1} END {print cpu}'").to_i
+      ram_usage = capture("ps --no-headers -u #{fetch(:user)} -o rss | awk '{rss += $1} END {print rss}'").to_i.kilobytes
+      puts "CPU usage: #{ Helpers.number_to_percentage(cpu_usage, precision: 0) }".bold
+      puts "RAM usage: #{ Helpers.number_to_human_size(ram_usage) }".bold
+      # run "echo CPU and RAM: `ps --no-headers -u #{fetch(:user)} -o pcpu,rss | awk '{cpu += $1; rss += $2} END {print cpu, rss}'`"
+    end
+
+    desc "Get CPU and RAM usage with process table"
+    task :full do
+      server_performance
+      run "ps -u #{fetch(:user)} -o rss,etime,pid,command" do
+        |channel, stream, data|
+        print data.to_s
+      end
+      server_performance.default
+    end
+  end
+
+  desc "Load schema from schema.rb"
+  task :schema_load do
+    run "cd #{fetch(:current_path)}; bundle exec rake db:schema:load RAILS_ENV=#{fetch(:rails_env)}"
+  end
+
+  desc "Seed the database"
+  task :db_seed do
+    run "cd #{fetch(:current_path)}; bundle exec rake db:seed RAILS_ENV=#{fetch(:rails_env)} RAILS_RAKE_TASK=1"
+  end
+
+  desc "Symlink an external assets directory, uploaded through FTP for example"
+  task :external_assets_symlink do
+    on_rollback do
+      # Deletes the symlink
+      if exists?(:external_assets_path)
+        fetch(:external_assets_path).each do |external_path|
+          assets_basename = File.basename(external_path)
+          run "rm -rf #{fetch(:current_path)}/public/#{assets_basename}"
+        end
+      end
+    end
+
+    if exists?(:external_assets_path)
+      fetch(:external_assets_path).each do |external_path|
+        assets_basename = File.basename(external_path)
+        run "rm -rf #{fetch(:current_path)}/public/#{assets_basename}"
+        run "ln -s #{external_path} #{fetch(:current_path)}/public/#{assets_basename}"
+      end
+    else
+      print "No external asset path available"
+    end
+  end
+  after 'deploy:create_symlink', 'external_assets_symlink'
+
+  desc "Display shell environment variables"
+  task :show_env do
+    if exists?(:default_environment)
+      biggest_key_size = 0
+      fetch(:default_environment).each do |key, value|
+        str_key = key.to_s
+        biggest_key_size = str_key.size if biggest_key_size < str_key.size
+      end
+
+      real_environment = {}
+      fetch(:default_environment).each do |key, value|
+        real_environment[key] = capture("echo $#{ key }")
+      end
+      real_environment.each do |key, value|
+        print "#{ key }".ljust(biggest_key_size)
+        puts " = #{ value }"
+      end
+    else
+      puts "No environment set"
+    end
+  end
+
+  desc "Install given gem name"
+  task :gem_install do
+    if exists?(:name)
+      run "gem install #{fetch(:name)}" do |channel, stream, data|
+        print data.to_s
+      end
+    else
+      puts 'To install gem you must use -S name=value'
+    end
+  end
+
+  namespace :logs do
+
+    desc "Read the production log file interactively"
+    task :watch do
+      if exists?(:log_file_path)
+        stream("tail -f #{fetch(:log_file_path)}")
+      else
+        print "No log_file_path set\n"
+      end
+    end
+
+  end
+
+  desc "Display local gemfile path"
+  task :show_gemfile_path do
+    puts "Local:  #{fetch(:local_gemfile_path)}".bold
+    puts "Remote: #{fetch(:deploy_to)}/Gemfile".bold
+  end
+
+  # XXX: Everything is commented because the install is already implemented, while
+  #      the update tasks require to setup the rails environment and other variables
+  # namespace :bundle do
+
+  #   desc "Run update with bundle"
+  #   task :update do
+  #     run "cd #{fetch(:current_path)}; bundle update"
+  #   end
+
+  #   desc "Run bundle install and update"
+  #   task :default do
+  #     bundle.install
+  #     bundle.update
+  #   end
+  # end
+
+  namespace :deploy do
+
+    desc "Print paths"
+    task :paths do
+      puts fetch(:deploy_to).to_s
+      puts fetch(:current_path).to_s
+    end
+
+    desc "Cleanup everything, deleting old releases"
+    task :cleanup_all do
+      set :keep_releases, 0
+      cleanup
+    end
+
+    desc "Cleanup everything except last"
+    task :cleanup_all_but_one do
+      set :keep_releases, 1
+      cleanup
+    end
+
+    # FIXME: Some recipes here are not behaving correctly
+    # desc "Setup the project and loads the database"
+    # task :cold do
+    #   transaction do
+    #     update
+    #     schema_load
+    #     start
+    #   end
+    # end
+
+    # namespace :full do
+    #   desc "Install gems, setup database with load, restart server"
+    #   task :default do
+    #     transaction do
+    #       update
+    #       bundle
+    #       schema_load
+    #       start
+    #     end
+    #   end
+
+    #   desc "Install gems, setup database with load, seed database, restart server"
+    #   task :seed do
+    #     transaction do
+    #       update
+    #       bundle
+    #       schema_load
+    #       db_seed
+    #       start
+    #     end
+    #   end
+
+    #   desc "Run migrate instead of load"
+    #   task :migrate do
+    #     transaction do
+    #       update
+    #       bundle
+    #       migrate
+    #       start
+    #     end
+    #   end
+    # end
+  end
+
+end

data/lib/capistrano_webfaction_recipes/recipes/webfaction.rb

@@ -0,0 +1,79 @@
+require 'colored'
+require 'active_support/all'
+require File.expand_path("../helpers", __FILE__)
+
+Capistrano::Configuration.instance(:must_exist).load do
+  set(:log_file_path) { "#{fetch(:deploy_to)}/nginx/logs/error.log" }
+
+  desc "String usable to print in shell for SSH variable sets"
+  task :env_command do
+    puts "export PATH=$PWD/bin:$PATH; export GEM_HOME=$PWD/gems; export RUBYLIB=$PWD/lib"
+  end
+
+  namespace :webapp do
+
+    desc "Prepare webapp for capistrano deployment"
+    task :prepare do
+      # Replace hello_world in current
+      run "cd #{fetch(:deploy_to)}; rm -rf hello_world/"
+      run "cd #{fetch(:deploy_to)}/nginx/conf; sed -i 's/hello_world/current/g' nginx.conf"
+    end
+
+  end
+
+  namespace :deploy do
+
+    desc "Restart server"
+    task :restart do
+      run "#{fetch(:deploy_to)}/bin/restart"
+    end
+
+    desc "Start server"
+    task :start do
+      run "#{fetch(:deploy_to)}/bin/start"
+    end
+
+    desc "Stop server"
+    task :stop do
+      run "#{fetch(:deploy_to)}/bin/stop"
+    end
+
+    namespace :webfaction do
+
+      desc "Setup the application, deploy it, migrate database"
+      task :setup do
+        webapp.prepare
+        bundle.install_without_deploy
+      end
+
+      desc "Setup the application, deploy it, migrate database"
+      task :full do
+        webapp.prepare
+        deploy.full.default
+      end
+
+    end
+
+  end
+
+  namespace :bundle do
+
+    desc "Install bundle without deploy"
+    task :install_without_deploy do
+      if exists?(:local_gemfile_path)
+        upload(fetch(:local_gemfile_path), "#{fetch(:deploy_to)}/Gemfile")
+        env_to_ignore = ""
+        if exists?(:bundle_without)
+          env_to_ignore = " --without #{fetch(:bundle_without).join(' ')}"
+        end
+        run "cd #{fetch(:deploy_to)}; bundle install#{env_to_ignore}; rm -f Gemfile; rm -f Gemfile.lock" do |channel, stream, data|
+          print data.to_s
+        end
+      else
+        puts 'Requires :local_gemfile_path to be set'
+      end
+    end
+
+  end
+
+end

data/lib/capistrano_webfaction_recipes/version.rb

@@ -0,0 +1,3 @@
+module CapistranoWebfactionRecipes
+  VERSION = "0.0.1"
+end

data/lib/capistrano_webfaction_recipes.rb

@@ -0,0 +1 @@
+require "capistrano_webfaction_recipes/version"

data/lib/generators/webfaction/install/install_generator.rb

@@ -0,0 +1,33 @@
+require 'rails'
+require 'active_support/all'
+
+module Webfaction
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+
+      source_root File.expand_path('../templates', __FILE__)
+
+      desc "Creates a deploy file that is well organized and makes easy webfaction task usage"
+
+      def copy_deploy
+        target_file = 'config/deploy.rb'
+        if File.exists?(target_file)
+          unless yes?('Deploy file already exists and will be overwritten, would you like to continue?')
+            puts 'Operation aborted'
+            return
+          end
+          remove_file(target_file)
+        end
+        @rails_app_root_dir_name        = File.basename(Dir.pwd)
+        @server_ssh_user                = ask('Insert your server ssh username')
+        @server_ssh_user                = 'PUT_SERVER_SSH_USER' if @server_ssh_user.blank?
+        @remote_rails_app_root_dir_name = ask('Insert your remote rails application root directory name')
+        @remote_rails_app_root_dir_name = 'PUT_REMOTE_RAILS_APP_ROOT_DIR_NAME' if @remote_rails_app_root_dir_name.blank?
+        @bitbucket_user                 = ask('Insert your bitbucket username')
+        @bitbucket_user                 = 'PUT_BITBUCKET_USER' if @bitbucket_user.blank?
+        template "deploy.rb.erb", target_file
+      end
+
+    end
+  end
+end

data/lib/generators/webfaction/install/templates/deploy.rb.erb

@@ -0,0 +1,46 @@
+require 'bundler/capistrano'
+require 'capistrano_webfaction_recipes/all'
+
+# Webfaction settings
+set :application,           '<%= @rails_app_root_dir_name %>'
+set :user,                  '<%= @server_ssh_user %>'
+set :branch,                :master
+set :ssh_options,           { forward_agent: true }
+set :app_short,             '<%= @remote_rails_app_root_dir_name %>'
+set :external_assets_path,  []
+set :local_gemfile_path,    File.expand_path('../../Gemfile', __FILE__)
+set :bitbucket,             '<%= @bitbucket_user %>'
+set :uploaded_assets_paths, []
+
+# Calculated options
+# logger.level              = Capistrano::Logger::INFO
+default_run_options[:pty] = true
+
+set(:repository)   { "git@bitbucket.org:#{fetch(:bitbucket)}/#{fetch(:application)}.git" }
+set(:deploy_to)    { "/home/#{fetch(:user)}/webapps/#{fetch(:app_short)}" }
+set(:scm_username) { fetch(:user) }
+
+set :deploy_via,          :remote_cache
+
+set :stages,              %w(production staging)
+set :default_stage,       'production'
+require                   'capistrano/ext/multistage'
+
+set :scm,                 :git
+set :migrate_env,         '' # Not using :production because of a capistrano issue
+set :bundle_without,      [:development, :test]
+set :use_sudo,            false
+set(:default_environment) do
+  {
+    'RAILS_ENV' => fetch(:migrate_env).to_s,
+    'PATH'      => "#{fetch(:deploy_to)}/bin:$PATH",
+    'GEM_HOME'  => "#{fetch(:deploy_to)}/gems",
+    'RUBYLIB'   => "#{fetch(:deploy_to)}/lib"
+  }
+end
+if exists?(:uploaded_assets_paths)
+  set(:shared_children, []) unless exists?(:shared_children)
+  set(:shared_children, fetch(:shared_children) + fetch(:uploaded_assets_paths))
+end
+
+server "#{fetch(:user)}.webfactional.com", :web, :app, :db, primary: true

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: capistrano_webfaction_recipes
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Fire-Dragon-DoL
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.15.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.15.4
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.13
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.13
+- !ruby/object:Gem::Dependency
+  name: colored
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: Gem container for some nice webfaction recipes plus a standard deploy
+  file that can be created with a generator
+email: []
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- capistrano_webfaction_recipes.gemspec
+- lib/capistrano_webfaction_recipes.rb
+- lib/capistrano_webfaction_recipes/all.rb
+- lib/capistrano_webfaction_recipes/recipes/helpers.rb
+- lib/capistrano_webfaction_recipes/recipes/tasks.rb
+- lib/capistrano_webfaction_recipes/recipes/webfaction.rb
+- lib/capistrano_webfaction_recipes/version.rb
+- lib/generators/webfaction/install/install_generator.rb
+- lib/generators/webfaction/install/templates/deploy.rb.erb
+homepage: https://github.com/Fire-Dragon-DoL/capistrano_webfaction_recipes
+licenses:
+- MIT
+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: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A collection of recipes to handle webfaction shared hosting
+test_files: []