capitate 0.1.7

data/Capfile

@@ -0,0 +1,24 @@
+#
+# Capfile for running base install recipe
+#
+
+load 'deploy' if respond_to?(:namespace) # cap2 differentiator
+
+require 'lib/capitate'
+
+# Load recipes
+Dir["lib/recipes/**/*.rb"].each { |recipe| load recipe }
+
+require 'erb'
+
+# This should be overriden by project specific Capfile
+set :user, Proc.new { Capistrano::CLI.ui.ask('Bootstrap user: ') }
+
+# Roles
+role :base, Capistrano::CLI.ui.ask('Server: ')
+
+# Choose a profile
+set :profile, Proc.new { load profile.choose }
+
+# Reset the password var
+reset_password

data/History.txt

@@ -0,0 +1,22 @@
+== 0.1.5 ?
+
+* Renamed to 'capitate'
+* Moving centos specific recipes into separate namespace
+* Plugin: script.make_install
+* Documentation and explicitly fetching vars (for install tasks), showing useful error messages
+
+== 0.1.4 2008-02-07
+
+* Using capistrano's plugin architecture instead of hacking around
+
+== 0.1.3 2008-02-06
+
+* Fixing local recipes
+
+== 0.1.2 2008-02-06
+
+* Loading recipes from gem
+
+== 0.1.1 2008-02-06
+
+* Initial import

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Gabriel Handford
+
+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/Manifest.txt

@@ -0,0 +1,100 @@
+Capfile
+History.txt
+License.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/capitate
+config/hoe.rb
+config/requirements.rb
+lib/capitate.rb
+lib/capitate/cap_ext/connections.rb
+lib/capitate/cap_ext/extension_proxy.rb
+lib/capitate/cap_ext/variables.rb
+lib/capitate/config.rb
+lib/capitate/plugins/base.rb
+lib/capitate/plugins/gem.rb
+lib/capitate/plugins/package.rb
+lib/capitate/plugins/profiles.rb
+lib/capitate/plugins/script.rb
+lib/capitate/plugins/templates.rb
+lib/capitate/plugins/wget.rb
+lib/capitate/plugins/yum.rb
+lib/capitate/recipes.rb
+lib/capitate/version.rb
+lib/doc/centos/memcached.yml
+lib/doc/centos/mongrel_cluster.yml
+lib/doc/centos/monit.yml
+lib/doc/centos/mysql.yml
+lib/doc/centos/nginx.yml
+lib/doc/centos/sphinx.yml
+lib/doc/gems.yml
+lib/doc/install.yml
+lib/doc/memcached.yml
+lib/doc/mongrel_cluster.yml
+lib/doc/mysql.yml
+lib/doc/nginx.yml
+lib/doc/packages.yml
+lib/doc/rails.yml
+lib/profiles/centos-sick.rb
+lib/recipes/README
+lib/recipes/centos/README
+lib/recipes/centos/centos.rb
+lib/recipes/centos/imagemagick.rb
+lib/recipes/centos/memcached.rb
+lib/recipes/centos/mongrel_cluster.rb
+lib/recipes/centos/monit.rb
+lib/recipes/centos/mysql.rb
+lib/recipes/centos/nginx.rb
+lib/recipes/centos/ruby.rb
+lib/recipes/centos/sphinx.rb
+lib/recipes/deploy.rb
+lib/recipes/gems.rb
+lib/recipes/install.rb
+lib/recipes/memcached.rb
+lib/recipes/mongrel_cluster.rb
+lib/recipes/mysql.rb
+lib/recipes/nginx.rb
+lib/recipes/packages.rb
+lib/recipes/rails.rb
+lib/recipes/sphinx.rb
+lib/templates/capistrano/Capfile
+lib/templates/centos/setup_for_web.sh
+lib/templates/centos/sudoers
+lib/templates/memcached/memcached.initd.centos.erb
+lib/templates/memcached/memcached.monitrc.erb
+lib/templates/mongrel/mongrel_cluster.initd.erb
+lib/templates/mongrel/mongrel_cluster.monitrc.erb
+lib/templates/mongrel/mongrel_cluster.yml.erb
+lib/templates/monit/cert.sh
+lib/templates/monit/monit.cnf
+lib/templates/monit/monit.initd.centos.erb
+lib/templates/monit/monitrc.erb
+lib/templates/monit/patch_inittab.sh
+lib/templates/mysql/install_db.sql.erb
+lib/templates/mysql/mysql.monitrc.erb
+lib/templates/nginx/nginx.conf.erb
+lib/templates/nginx/nginx.initd.erb
+lib/templates/nginx/nginx.monitrc.erb
+lib/templates/nginx/nginx_vhost.conf.erb
+lib/templates/rails/database.yml.erb
+lib/templates/ruby/fix_openssl.sh
+lib/templates/sphinx/sphinx.conf.erb
+lib/templates/sphinx/sphinx.monitrc.erb
+lib/templates/sphinx/sphinx_app.initd.centos.erb
+script/destroy
+script/generate
+script/txt2html
+setup.rb
+tasks/capitate.rake
+tasks/deployment.rake
+tasks/environment.rake
+tasks/website.rake
+test/test_helper.rb
+test/test_recipes.rb
+test/test_templates.rb
+website/index.html
+website/index.txt
+website/javascripts/rounded_corners_lite.inc.js
+website/stylesheets/screen.css
+website/template.rhtml

data/README.txt

@@ -0,0 +1 @@
+See website/index.txt

data/Rakefile

@@ -0,0 +1,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/bin/capitate

@@ -0,0 +1,46 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.join(File.dirname(__FILE__), '..')
+
+begin
+  require 'capitate'
+rescue LoadError
+  require 'rubygems'
+  require 'capitate'
+end
+
+def usage
+  puts <<-EOS
+  
+    Capitate your project.
+    
+    Usage:
+    
+      #{$0} bootstrap
+    
+  EOS
+    
+  exit 1
+end
+
+class CapitateBin
+  class << self
+    include Capitate::Plugins::Templates    
+  end
+end
+
+puts <<-EOS
+
+  Generating capistrano configuration...
+  
+EOS
+  
+# Write Capfile
+CapitateBin.write("capistrano/Capfile", "Capfile")
+
+puts <<-EOS
+
+  You now need to create and set you deployment "profile" in the Capfile.
+  This is currently a manual process, see the documentation on profiles 
+  for more information.
+  
+EOS

data/config/hoe.rb

@@ -0,0 +1,70 @@
+require 'capitate/version'
+
+AUTHOR = 'Gabriel Handford'  # can also be an array of Authors
+EMAIL = "gabrielh@gmail.com"
+DESCRIPTION = "Capistrano recipe library for all types of remote tasks."
+GEM_NAME = 'capitate' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'capitate' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "gabe"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil 
+# UNCOMMENT IF REQUIRED: 
+# REV = `svn info`.each {|line| if line =~ /^Revision:/ then k,v = line.split(': '); break v.chomp; else next; end} rescue nil
+VERS = Capitate::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'capitate documentation',
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps 
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' } 
+    @extra_deps
+  end 
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.developer(AUTHOR, EMAIL)
+  p.description = DESCRIPTION
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+  
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  #p.extra_deps = []     # An array of rubygem dependencies [name, version], e.g. [ ['active_support', '>= 1.3.1'] ]
+  
+  #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  
+end
+
+CHANGES = hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+hoe.rsync_args = '-av --delete --ignore-errors'

data/config/requirements.rb

@@ -0,0 +1,17 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))
+
+require 'capitate'

data/lib/capitate/cap_ext/connections.rb

@@ -0,0 +1,95 @@
+# Patch to add ability to clear sessions/connections.
+module Capistrano::Configuration::Connections
+  
+  # Set the user to something new (but save the old user; reset_user will set it back).
+  # Takes care of invalidating current connections. Will force a re-login.
+  # 
+  # ==== Options
+  # +new_user+:: User to become
+  #
+  # ==== Examples
+  #   set_user("nginx")
+  #   # Do something as user nginx
+  #
+  def set_user(new_user)
+    backup_user = fetch(:user)
+    
+    return if backup_user == new_user
+    @backup_user = backup_user
+    
+    set :user, new_user
+    clear_sessions
+  end
+  
+  # Reset to the old user.
+  # Takes care of invalidating current connections. Will force a re-login.
+  # 
+  # ==== Examples
+  #   # User is "root"
+  #   set_user("nginx")
+  #   # Do something as user nginx
+  #   reset_user
+  #   # User is now root
+  #
+  def reset_user
+    set :user, @backup_user
+    @backup_user = nil
+    clear_sessions
+  end
+  
+  # Yields the previous user.
+  #
+  # ==== Options
+  # +new_user+:: User to become
+  #
+  # ==== Examples
+  #   new_user("nginx") do |old_user|
+  #     # Do something as user nginx
+  #   end
+  #   # Now as user old_user
+  #
+  def with_user(new_user, &block)
+    begin
+      set_user(new_user)
+      yield @backup_user
+    ensure
+      reset_user
+    end
+    
+    clear_sessions
+  end
+  
+  # Close all open sessions.
+  # Will force user to re-login.
+  def clear_sessions    
+    sessions.each do |key, session|
+      logger.info "Closing: #{key}"
+      session.close
+    end    
+    sessions.clear    
+    reset_password
+  end
+  
+  # Reset the password.
+  # Display the current user that is asking for the password.
+  def reset_password
+    set :password, Proc.new {
+      Capistrano::CLI.password_prompt("Password (for user: #{user}): ")
+    }
+  end
+    
+end
+
+# Debug connections
+# class Capistrano::SSH
+#   
+#   class << self  
+#   
+#     def connect_with_logging(server, options={}, &block)
+#       connect_without_logging(server, options, &block)
+#     end
+#   
+#     alias_method_chain :connect, :logging
+#   
+#   end
+# end

data/lib/capitate/cap_ext/extension_proxy.rb

@@ -0,0 +1,15 @@
+class Capistrano::ExtensionProxy 
+  
+  # Allow ability to include modules in plugins.
+  #
+  # ==== Options
+  # +mod+:: Module
+  #
+  # ==== Examples
+  #   include Capitate::Plugins::Yum
+  #
+  def include(mod)
+    self.class.send(:include, mod)
+  end
+  
+end

data/lib/capitate/cap_ext/variables.rb

@@ -0,0 +1,59 @@
+module Capitate
+  module CapExt
+    module Variables
+
+      def self.included(base) #:nodoc:
+        base.send :alias_method, :fetch_without_capitate, :fetch
+        base.send :alias_method, :fetch, :fetch_with_capitate
+      end
+    
+      # Fetch (alias method chained) variable.
+      # Displays usage message from recipe docs if variable not found.
+      #
+      # See capistrano fetch for usage info.
+      #
+      # Recipe docs are in lib/doc/the_namespace.yml
+      #
+      def fetch_with_capitate(variable, *args)
+        begin
+          fetch_without_capitate(variable, *args)
+        rescue IndexError
+          message = capitate.usage(variable)
+
+          if message.blank?
+            message = <<-EOS
+
+            Please set :#{variable} variable in your Capfile or profile.
+
+            EOS
+          end
+        
+          raise IndexError, "\n#{message}"
+        end        
+      end
+      
+      # Fetch or set and return default.
+      #
+      # ==== Options
+      # +variable+:: Variable to fetch
+      # +default+:: Default value if not set
+      # +args+:: ?
+      #
+      # ==== Examples
+      #   fetch_or_default(:memcached_port, 11211) => 11211
+      #   # Any calls to fetch(memcached_port) in the future will return this value 11211 (unless overriden)
+      #
+      def fetch_or_default(variable, default, *args)
+        begin
+          return fetch(variable, *args)
+        rescue IndexError
+          set variable, default
+        end
+        default
+      end
+    
+    end
+  end
+  
+end
+    

data/lib/capitate/config.rb

@@ -0,0 +1,106 @@
+require 'yaml'
+require 'highline'
+
+# DEPRECATED, not in use.
+#
+# Application configuration for helping generate Capfile and deploy.rb.
+#
+class Capitate::Config
+  
+  attr_accessor :application, :user, :deploy_to, :web_host
+  attr_accessor :db_host, :db_user, :db_pass, :db_name, :db_port
+  attr_accessor :sphinx_port, :sphinx_host
+  attr_accessor :repository, :recipes
+  attr_accessor :mongrel_port, :mongrel_size
+  attr_accessor :domain_name
+  
+  def initialize
+  end
+
+  # Expose the binding.
+  def get_binding
+    binding
+  end
+  
+  # Ask for property.
+  # 
+  # ==== Options
+  # +message+:: Prompt
+  # +property+:: Property
+  # +options+:: Options
+  # - :default, Default value, defaults to nil
+  # - :answer_type, Highline answer type, defaults to String
+  # - :auto_apply, If true and property is set don't ask for it
+  #
+  # ==== Examples
+  #   ask("Database port: ", "db_port", { :default => 3306, :answer_type => Integer })
+  #
+  def ask(message, property, options = {}, &block)    
+    # Options
+    default = options[:default] || nil    
+    answer_type = options[:answer_type] || String
+    auto_apply = options[:auto_apply]
+    
+    # Default to existing or default if set
+    existing = send(property.to_sym)
+    default = existing || default
+    
+    unless auto_apply and !existing.blank?
+      result = HighLine.new.ask(message, answer_type) { |q| 
+        q.default = default unless default.blank?
+        yield q if block_given?
+      }
+  
+      send("#{property}=", result)
+    end
+  end
+  
+  # For property, set to value if blank.
+  def set_default(property, value)
+    v = send(property.to_sym)
+    send("#{property}=", value) if v.blank?
+  end
+
+  # Save to yaml.
+  def save(path)
+    File.open(path, "w") { |f| f.puts self.to_yaml }
+  end
+  
+  # Build config from asking.
+  # 
+  # ==== Options
+  # +auto_apply+:: For values, if set, then don't ask for it
+  #
+  def ask_all(auto_apply = false)
+    
+    options = { :auto_apply => auto_apply }
+    
+    ask("Application name: ", "application", options)
+    ask("User (to run application as): ", "user", options.merge({ :default => application }))
+    
+    ask("Deploy to: ", "deploy_to", options.merge({ :default => "/var/www/apps/#{application}" }))  
+    ask("Web host: ", "web_host", options)
+    
+    ask("Database host: ", "db_host", options.merge({ :default => web_host }))
+    ask("Database user: ", "db_user", options.merge({ :default => user }))
+    ask("Database password: ", "db_pass", options)
+    ask("Database name: ", "db_name", options.merge({ :default => application }))
+
+    ask("Database port: ", "db_port", options.merge({ :default => 3306, :answer_type => Integer }))
+    
+    ask("Sphinx host: ", "sphinx_host", options.merge({ :default => "127.0.0.1" }))
+    ask("Sphinx port: ", "sphinx_port", options.merge({ :default => 3312, :answer_type => Integer }))
+    
+    default_repos = YAML.load(`svn info`)["URL"] rescue nil
+    ask("Repository uri: ", "repository", options.merge({ :default => default_repos }))
+    
+    ask("Mongrel starting port: ", "mongrel_port", options.merge({ :answer_type => Integer }))
+    ask("Number of mongrels: ", "mongrel_size", options.merge({ :answer_type => Integer }))
+    
+    ask("Domain name (for nginx vhost; no www prefix): ", "domain_name", options)    
+    
+    # Load default recipes if not set
+    set_default("recipes", YAML.load_file(File.dirname(__FILE__) + "/recipes.yml"))    
+  end
+  
+end

data/lib/capitate/plugins/base.rb

@@ -0,0 +1,85 @@
+require 'erb'
+require 'yaml'
+
+# Capitate base capistrano plugin
+module Capitate::Plugins::Base
+  
+  # Project root
+  def root
+    if respond_to?(:fetch)
+      return fetch(:project_root)
+    else
+      RAILS_ROOT
+    end
+  end
+    
+  # Path relative to project root
+  def relative_to_root(path = nil, check_exist = false)
+    if path
+      root_path = File.join(root, path)
+    else
+      root_path = root
+    end
+    
+    # Check for file existance
+    if check_exist and !File.exist?(root_path)
+      raise <<-EOS
+        
+        File not found: #{File.expand_path(root_path)}
+        
+        This is loaded for the capitate plugin. View the README in:
+        #{File.expand_path(File.dirname(__FILE__) + "/../doc/README")}
+      EOS
+    end
+    
+    root_path
+  end  
+  
+  # Documentation (yaml) for current task (namespace).
+  # 
+  # ==== Examples
+  #   capitate.current_task_docs => { "task_name" => { "variable" => "The usage docs" } }
+  #
+  def current_task_doc
+    path = File.dirname(__FILE__) + "/../../doc/" + current_task.namespace.fully_qualified_name.to_s.gsub(":", "/") + ".yml"
+    puts "Current task doc: #{path}"
+    return YAML.load_file(path) if File.exist?(path)
+    nil
+  end
+  
+  # Usage for variable from current task documentation.
+  #
+  # ==== Options
+  # +var+:: Variable
+  # 
+  # ==== Examples
+  #   usage(:gem_list) => "The usage for gem_list variable from the doc/the_namespace.yml file."
+  # 
+  def usage(var)
+    task_doc = current_task_doc
+    task_name = current_task.name.to_s
+    var_name = var.to_s
+    if task_doc and task_doc.has_key?(task_name)    
+      var_usage = task_doc[task_name][var_name] 
+      return <<-EOS
+      
+      Please set :#{var_name} variable in your Capfile, deploy.rb or profile.
+      
+      Usage: 
+      
+#{indent_doc(var_usage)}
+      
+      EOS
+    end
+  end
+  
+  
+  def indent_doc(s, amount = 8)
+    return nil if s.blank?
+    indentation = (0..amount).collect { |n| " " }.join
+    s.split("\n").collect { |sp| "#{indentation}#{sp}"}.join("\n")
+  end
+    
+end
+
+Capistrano.plugin :capitate, Capitate::Plugins::Base