slingshot 1.0.0

data/History.txt

@@ -0,0 +1,10 @@
+== 0.0.1 2007-05-25
+
+* 1 major enhancement:
+  * Initial release
+  * Includes all server setup tasks
+
+== 1.0.0 2007-06-30
+
+* Version 1.0.0 Release!
+  * New! Improved! Better than Ever!

data/License.txt

@@ -0,0 +1,34 @@
+Copyright (c) 2007 Charles Brian Quinn, Highgroove Studios
+
+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.
+
+
+
+Includes Capistrano extensions and Gem Plugin to capistrano to allow 
+gem installation and selection
+
+Specifically makes use of the Gem plugin with modifications.
+
+--- 
+Capistrano library to install and manage Ruby Gems
+
+Copyright (c) 2006 Neil Wilson, Aldur Systems Ltd
+
+Licensed under the GNU Public License v2. No warranty is provided.

data/Manifest.txt

@@ -0,0 +1,19 @@
+History.txt
+License.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/slingshot.rb
+lib/slingshot/version.rb
+lib/slingshot/recipes.rb
+lib/slingshot/server_setup.rb
+lib/slingshot/gem_cap_plugin.rb
+scripts/txt2html
+setup.rb
+test/test_helper.rb
+test/test_slingshot.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,17 @@
+README for slingshot
+====================
+
+Slingshot is a set of server tasks for setting up a Slingshot Server.
+
+Created by the good folks at Highgroove Studios and Slingshot Hosting.
+
+For the latest, see:  http://slingshot.rubyforge.org/
+
+
+Contributors
+====================
+Charles Brian Quinn <cbq@highgroove.com>
+Derek Haynes <derek.haynes@highgroove.com>
+James Edward Gray II <james@highgroove.com>
+Andre Lewis <andre@earthcode.com> - testing, improvements, bugfixes
+Neil Wilson - original capistrano "Gem" plugin to install default gems

data/Rakefile

@@ -0,0 +1,123 @@
+require 'rubygems'
+require 'rake'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rake/packagetask'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'rake/contrib/rubyforgepublisher'
+require 'fileutils'
+require 'hoe'
+
+include FileUtils
+require File.join(File.dirname(__FILE__), 'lib', 'slingshot', 'version')
+
+AUTHOR = 'Charles Brian Quinn'
+EMAIL = "cbq@slingshothosting.com"
+DESCRIPTION = "Set of server setup tasks for use with Slingshot Hosting"
+GEM_NAME = 'slingshot'
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+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 ||= @config["username"]
+end
+
+RUBYFORGE_PROJECT = 'slingshot' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+NAME = "slingshot"
+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 = Slingshot::VERSION::STRING + (REV ? ".#{REV}" : "")
+CLEAN.include ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']
+RDOC_OPTS = ['--quiet', '--title', 'slingshot documentation',
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps 
+    @extra_deps.reject { |x| Array(x).first == 'hoe' } 
+  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.author = AUTHOR 
+  p.description = DESCRIPTION
+  p.email = EMAIL
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs = CLEAN  #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')
+
+desc 'Generate website files'
+task :website_generate do
+  Dir['website/**/*.txt'].each do |txt|
+    sh %{ ruby scripts/txt2html #{txt} > #{txt.gsub(/txt$/,'html')} }
+  end
+end
+
+desc 'Upload website files to rubyforge'
+task :website_upload do
+  host = "#{rubyforge_username}@rubyforge.org"
+  remote_dir = "/var/www/gforge-projects/#{PATH}/"
+  local_dir = 'website'
+  sh %{rsync -av #{local_dir}/ #{host}:#{remote_dir}}
+end
+
+desc 'Generate and upload website files'
+task :website => [:website_generate, :website_upload]
+
+desc 'Release the website and new gem version'
+task :deploy => [:check_version, :website, :release] do
+  puts "Remember to create SVN tag:"
+  puts "svn copy svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/trunk " +
+    "svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/tags/REL-#{VERS} "
+  puts "Suggested comment:"
+  puts "Tagging release #{CHANGES}"
+end
+
+desc 'Runs tasks website_generate and install_gem as a local deployment of the gem'
+task :local_deploy => [:website_generate, :install_gem]
+
+task :check_version do
+  unless ENV['VERSION']
+    puts 'Must pass a VERSION=x.y.z release version'
+    exit
+  end
+  unless ENV['VERSION'] == VERS
+    puts "Please update your version.rb to match the release version, currently #{VERS}"
+    exit
+  end
+end
+
+

data/lib/slingshot/gem_cap_plugin.rb

@@ -0,0 +1,97 @@
+# Capistrano library to install and manage Ruby Gems.
+#
+# ----
+# Copyright (c) 2006 Neil Wilson, Aldur Systems Ltd
+#
+# Licensed under the GNU Public License v2. No warranty is provided.
+#
+# Modified by Charles Brian Quinn cbq@highgroove.com
+# 
+require 'rubygems'
+require 'capistrano'
+# Installs within Capistrano as the plugin _gem_.
+# Prefix all calls to the library with <tt>gem.</tt>
+# Manages installing gems and versioned gems.
+module Gem
+
+  # Default install command
+  #
+  # * doesn't install documentation
+  # * installs all required dependencies automatically.
+  #
+  GEM_INSTALL="gem install -y --no-rdoc"
+
+  # Upgrade the *gem* system to the latest version. Runs via *sudo*
+  def update_system
+    sudo "gem update --system"
+  end
+
+  # Updates all the installed gems to the latest version. Runs via *sudo*.
+  # Don't use this command if any of the gems require a version selection.
+  def upgrade
+    sudo "gem update --no-rdoc"
+  end
+
+  # Removes old versions of gems from installation area.
+  def cleanup
+    sudo "gem cleanup"
+  end
+
+  # Installs the gems detailed in +packages+, selecting version +version+ if
+  # specified.
+  #
+  # +packages+ can be a single string or an array of strings.
+  #
+  # def install(packages, source=nil, version=nil)
+  def install(packages, options={})
+    sudo "#{GEM_INSTALL} #{options[:version] ? '-v '+options[:version].to_s : nil} " + 
+         "#{options[:source] ? '--source='+options[:source] : nil } " +
+         "#{packages.to_a.join(' ')}"
+  end
+
+  def uninstall(package)
+    sudo "gem uninstall #{package}" do |channel, stream, data|
+      data.each_line do |line|
+        if line =~ /\[Yn\]/
+          channel.send_data "Y\n"
+        end
+      end
+    end
+  end
+
+  # Auto selects a gem from a list and installs it.
+  #
+  # *gem* has no mechanism on the command line of disambiguating builds for
+  # different platforms, and instead asks the user. This method has the necessary
+  # conversation to select the +version+ relevant to +platform+ (or the one nearest
+  # the top of the list if you don't specify +version+).
+  # def select(package, source=nil, version=nil, platform='ruby')
+  def select(package, options={})
+    selections={}
+    cmd="#{GEM_INSTALL} #{options[:version] ? '-v '+options[:version].to_s : nil} " +
+        "#{package} " + 
+        "#{options[:source] ? '--source='+options[:source] : nil} " + 
+        "#{options[:extra_params] ? options[:extra_params] : nil}"
+    sudo cmd do |channel, stream, data|
+      data.each_line do | line |
+    case line
+    when /\s(\d+).*\(#{options[:platform]}\)/
+      if selections[channel[:host]].nil?
+        selections[channel[:host]]=$1.dup+"\n"
+        logger.info "Selecting #$&", "#{stream} :: #{channel[:host]}"
+      end
+    when /\s\d+\./
+      # Discard other selections from data stream
+    when /^>/
+      channel.send_data selections[channel[:host]]
+      logger.debug line, "#{stream} :: #{channel[:host]}"
+    else
+      logger.info line, "#{stream} :: #{channel[:host]}"
+    end
+      end
+    end
+  end
+
+end
+
+Capistrano.plugin :gem, Gem

data/lib/slingshot/recipes.rb

@@ -0,0 +1,230 @@
+# This library file includes tasks for configuring a Rails application.
+# 
+# TODO:
+#  * use rails pids dir construct (relinks and change mongrel config)
+#  
+Capistrano.configuration(:must_exist).load do
+
+# =============================================================================
+# DEFAULT VARIABLES
+# =============================================================================
+
+set :user,      "deploy"
+set :password,  "password"
+set :group,     "users"
+
+set :deploy_to, "/var/www/apps"
+
+set :server_name,       'daytona.slingshothosting.com'
+set :server_ip,         '1.2.3.4'
+set :server_fqdn,       'daytona.slingshothosting.com'
+
+set :domain_name,       'yourdomain.com'
+
+# your svn username and password
+set :svn_username,      user
+set :svn_password,      password
+
+# your database username and password
+set :database_username, user
+set :database_password, password
+
+set :deploy_username,   user
+set :deploy_password,   password
+
+# timezone can be any valid zoneinfo: EST, MST, PST8PDT, GMT
+set :server_timezone,   "GMT" 
+
+# =============================================================================
+# SOME SEMI-OPTIONAL SLINGSHOT VARIABLES 
+# =============================================================================
+
+# set this to the correct web start script
+set :web_server,          "apache2"
+set :path_to_web_server,  "/usr/local/apache2/"
+
+# set this to true to add an apache redirect rule to ensure domain requests to
+#  http://yourdomain.com/ are redirected to http://www.yourdomain.com/
+set :redirect_www_requests, true
+
+# ssl certificates must live in the /path/to/apache/conf/ssl directory
+set :configure_ssl, false  # set this to true to use SSL
+set :ssl_certificate_file, "#{server_name}.pem"
+set :ssl_certificate_key_file, "#{server_name}.key"
+set :ssl_ca_certificate_file, 'sf_issuing.crt'
+
+# set this to the correct db adapter and settings
+set :database, "mysql"
+set :database_host, "localhost"
+
+# saves space by only keeping last 3 when running cleanup
+set :keep_releases, 3 
+
+# issues svn export instead of checkout
+set :checkout, "export"
+
+# mongrel configuration:
+set :mongrel_conf, "#{current_path}/config/mongrel_cluster.yml"
+
+# number of mongrel servers to start
+set :mongrel_servers, 3
+
+# mongrel starting port
+set :mongrel_start_port, 8000
+
+# set this to true to manage your crontab through capistrano
+set :overwrite_crontab, false
+set :crontab_email, "root@localhost"
+
+set :mongrel_cluster_configuration_dir, "/etc/mongrel_cluster"
+set :rails_apache_configuration_dir, "/etc/rails"
+
+# =============================================================================
+# RAILS APPLICATION CONFIGURATION TASKS
+# =============================================================================
+
+desc "Tasks to execute before initial setup"
+task :before_setup do
+  sudo "mkdir -p #{File.dirname(deploy_to)}"
+  sudo "chown -R #{user}:#{group} #{File.dirname(deploy_to)}"
+
+  sudo "mkdir -p #{mongrel_cluster_configuration_dir}"
+  sudo "mkdir -p #{rails_apache_configuration_dir}"
+end
+
+desc "Tasks to execute after initial setup"
+task :after_setup do
+  
+  # make shared config dir to hold config files
+  run "mkdir -p #{deploy_to}/#{shared_dir}/config"
+
+  # make a shared tmp dir for sessions
+  run "mkdir -p #{deploy_to}/#{shared_dir}/tmp"
+  run "mkdir -p #{deploy_to}/#{shared_dir}/tmp/cache"
+  run "mkdir -p #{deploy_to}/#{shared_dir}/tmp/sessions"
+  run "mkdir -p #{deploy_to}/#{shared_dir}/tmp/sockets"
+  run "mkdir -p #{deploy_to}/#{shared_dir}/tmp/pids"
+  
+  # create any other shared dirs
+  # run "mkdir -p #{deploy_to}/#{shared_dir}/db"
+  # run "mkdir -p #{deploy_to}/#{shared_dir}/db/ferret_index"
+  
+  mongrel_configuration_setup
+  database_configuration_setup
+  apache_configuration_setup
+  apache_redirects_setup
+  crontab_configuration_setup
+  
+end
+
+desc "Tasks to execute after code update"
+task :after_update_code, :roles => [:app, :db] do
+  # relink shared deployment database configuration
+  run "ln -nfs #{deploy_to}/#{shared_dir}/config/database.yml #{release_path}/config/database.yml"
+
+  # relink shared deployment mongrel_cluster configuration
+  run "ln -nfs #{deploy_to}/#{shared_dir}/config/mongrel_cluster.yml #{release_path}/config/mongrel_cluster.yml"
+
+  # relink shared tmp dir (for session and cache data)
+  sudo "rm -rf #{release_path}/tmp"  # technically shouldn't be in svn
+  run "ln -nfs #{deploy_to}/#{shared_dir}/tmp #{release_path}/tmp"
+
+  # relink file storage dir
+  sudo "rm -rf #{release_path}/file_storage"  # technically shouldn't be in svn
+  run "ln -nfs #{deploy_to}/#{shared_dir}/file_storage #{release_path}/file_storage"
+  
+  # rebuild ferret index
+  # run "cd #{release_path} && RAILS_ENV=production rake search:build_index"
+end
+
+desc "Setup mongrel Configuration"
+task :mongrel_configuration_setup do
+
+  # generate a mongrel configuration file
+  mongrel_configuration = render :template => <<-EOF
+---
+cwd: #{deploy_to}/current
+port: "#{mongrel_start_port}"
+environment: production
+address: 127.0.0.1
+pid_file: #{deploy_to}/current/log/mongrel.pid
+log_file: #{deploy_to}/current/log/mongrel.log
+servers: #{mongrel_servers}
+user: #{user}
+group: #{group}
+
+EOF
+
+  # put mongrel configuration in shared config dir and link in /etc/mongrel_cluster
+  put mongrel_configuration, "#{deploy_to}/#{shared_dir}/config/mongrel_cluster.yml"
+  sudo "ln -nfs #{deploy_to}/#{shared_dir}/config/mongrel_cluster.yml /etc/mongrel_cluster/#{application}.yml"
+
+end
+
+desc "Setup Database Configuration"
+task :database_configuration_setup do
+  
+  # generate database configuration 
+  database_configuration = render :template => <<-EOF
+# Deployment database.yml
+login: &login
+  adapter: #{database}
+  username: #{database_username}
+  password: #{database_password}
+
+development:
+  database: #{application}_development
+  <<: *login
+
+test:
+  database: #{application}_test
+  <<: *login
+
+production:
+  database: #{application}_production
+  <<: *login
+
+EOF
+
+  # put database configuration in shared config dir
+  put database_configuration, "#{deploy_to}/#{shared_dir}/config/database.yml"
+end
+
+# =============================================================================
+# SLINGSHOT TASKS
+# =============================================================================
+
+desc "Restart the web server"
+task :restart_web, :roles => [:web] do
+  sudo "/etc/init.d/#{web_server} restart"
+end
+
+# =============================================================================
+# APPLICATION SPECIFIC TASKS
+# =============================================================================
+
+desc "Rebuild Ferret search index"
+task :ferret_index, :roles => [:app, :db] do
+  run("cd #{current_path} && RAILS_ENV=production rake search:build_index")
+  # run("chmod -R ugo+w #{current_path}/db/ferret_index")
+  # run("chmod -R ugo+r #{current_path}/db/ferret_index")
+end
+
+# =============================================================================
+# USEFUL TASKS
+# =============================================================================
+
+desc "Disables web site while deploying and in errors - used for long-running deploys"
+task :long_deploy do
+  transaction do
+    update_code
+    disable_web
+    symlink
+    migrate
+  end
+
+  restart
+  enable_web
+end
+
+end # end capistrano extensions