passenger-recipes 0.1.2

data/History.txt

@@ -0,0 +1,14 @@
+=== v0.1.2
+2008-09-12
+
+* The 'adduser' command in deploy:setup had :centos and :ubuntu criss-crossed.  Also, updated some of the task 
+  descriptions, and cleaned up some unused variables.
+
+* Started to recognize the :target_os property.  It currently supports :centos and :ubuntu for values, and only affects 
+  the output given by deploy:setup.
+
+=== v0.1.1
+2008-08-25
+* Loosened the dependency on capistrano-extensions from =0.1.2 to >=0.1.2.  capistrano-extensions jumped to 0.1.3 today.
+  
+  

data/Manifest.txt

@@ -0,0 +1,8 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/passenger-recipes.rb
+lib/passenger-recipes/passenger.rb
+lib/passenger-recipes/version.rb
+passenger-recipes.gemspec

data/README.txt

@@ -0,0 +1,84 @@
+= passenger-recipes
+
+* http://github.com/jtrupiano/passenger-recipes/tree/master
+
+== DESCRIPTION:
+This gem provides a set of recipes for deploying with Passenger.  It's much
+more restrictive than Capistrano in the sense that it 'locks down' some 
+aspects of what Capistrano actually allows.  See the FEATURES section
+below for more specific details.
+
+== INCOMPLETE ==
+* Missing a detailed sample config file
+* This README is still quite sparse-- add in summaries for each new task
+* Describe changes to default deploy recipes
+* Discuss dependencies a bit more
+* Implement OS-specific default values (Ubuntu and CentOS at a minimum)
+
+== FEATURES/PROBLEMS:
+
+* Enforces non-root deployment.  The deploy:setup task does not actually 
+  execute anything, but rather outputs a set of instructions for you 
+  to manually execute.  The reason for this is that certain aspects of 
+  setting up a server require root access.  Incremental deployment, by 
+  contrast, does not require this level of privilege.  As such, we 
+  recommend that you take care of setting up your server by yourself.
+  
+  Note: to "lift" this restriction, you can simply override the 
+  :ensure_not_root function.  However, this is not recommended, 
+  considering Apache needs to own all of your files.  e.g.
+  
+  def ensure_not_root; end
+
+* Sets up a symlink in the shared directory (passenger.conf) that is
+  updated on each successive deploy.  This allows you to change your
+  apache config through a deployment.  Note that you'll need sudoer
+  privilege to restart apache (deploy:with_restart) to restart apache.
+
+* NEW PROPERTIES --> DEFAULTS
+  # Where is the apache config snippet 
+  :apache_conf --> {"#{latest_release}/config/#{rails_env}/apache.conf"}
+
+  # Which group does apache run as
+  :apache_group --> www-data
+  
+  # Full path to the graceful restart command of apache
+  :apache_restart_cmd --> /usr/sbin/apache2ctl
+
+== SYNOPSIS:
+
+  FIX (code sample of usage)
+
+== REQUIREMENTS:
+
+* capistrano-extensions 0.1.1
+
+== INSTALL:
+
+* rake gem
+* sudo gem install pkg/passenger-recipes-0.1.1.gem --local
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 FIX
+
+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/Rakefile

@@ -0,0 +1,33 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './lib/passenger-recipes.rb'
+require "./lib/passenger-recipes/version"
+
+PKG_NAME      = "passenger-recipes"
+PKG_BUILD     = ENV['PKG_BUILD'] ? '.' + ENV['PKG_BUILD'] : ''
+version = PassengerRecipes::Version::STRING.dup
+if ENV['SNAPSHOT'].to_i == 1
+  version << "." << Time.now.utc.strftime("%Y%m%d%H%M%S")
+end
+PKG_VERSION   = version
+PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
+
+Hoe.new(PKG_NAME, PKG_VERSION) do |p|
+  p.rubyforge_name = 'johntrupiano' # if different than lowercase project name
+  p.developer('John Trupiano', 'jtrupiano@gmail.com')
+  p.name = PKG_NAME
+  p.version = PKG_VERSION
+  p.author = "John Trupiano"
+  p.email = "jtrupiano@gmail.com"
+  p.description = %q(An opinionated set of capistrano recipes built on top of capistrano-extensions tailored for Phusion Passenger)
+  p.summary = p.description # More details later??
+  p.remote_rdoc_dir = PKG_NAME # Release to /PKG_NAME
+  #  p.changes = p.paragraphs_of('CHANGELOG', 0..1).join("\n\n")
+  p.extra_deps << ["capistrano-extensions", ">= 0.1.4"]
+  p.need_zip = true
+  p.need_tar = false
+end
+
+# vim: syntax=Ruby

data/lib/passenger-recipes.rb

@@ -0,0 +1,2 @@
+gem 'capistrano-extensions', '>= 0.1.2' # explicitly require capistrano-extensions version 0.1.2
+

data/lib/passenger-recipes/passenger.rb

@@ -0,0 +1,167 @@
+Capistrano::Configuration.instance(:must_exist).load do
+  abort "passenger-recipes is not compatible with Capistrano 1.x." unless respond_to?(:namespace)
+
+  # Load in the common stuff
+  require 'capistrano-extensions/deploy'
+  puts "Loading Passenger Recipes"
+
+  # Override these at your own discretion!
+  _cset(:apache_conf) {"#{latest_release}/config/#{rails_env}/apache.conf"}
+  _cset(:apache_group, "www-data")
+  #_cset(:apache_restart_cmd, "/usr/sbin/apache2ctl")
+
+  def ensure_not_root
+    raise "Do not deploy as root" if user == "root"
+  end
+
+  # Finally, our passenger-specific recipes.
+  namespace :deploy do
+    desc <<-DESC
+      [passenger]: Displays onscreen the set of privileged tasks you should manually 
+      execute on your server.  We advise you to manually execute these as root,
+      and then proceed with deployment using a non-privileged user.  Execute this task
+      for specific instructions.
+    DESC
+    task :setup, :except => { :no_release => true } do
+      puts "\nBy default, passenger-recipes is configured such that deploy:setup does not execute any remote commands.  All of these tasks should be executed manually on your server using an appropriately-privileged user account.\n\n"
+      puts "To get accurate values for the commands below, you should set the following variables: :apache_group, :deploy_to, :user, :application, and :target_os (only :ubuntu and :centos are supported)\n\n"
+      apache_grp = fetch(:apache_group, "<apache_group>")
+      
+      case fetch(:target_os, :ubuntu).to_sym
+      when :ubuntu
+        adduser     = "adduser --ingroup #{apache_grp} #{user}"
+        link_target = "/etc/apache2/sites-enabled/#{application}.conf"
+      when :centos
+        adduser     = "useradd -G #{apache_grp} #{user}"
+        link_target = "/etc/httpd/conf.d/#{application}.conf"
+      end
+      puts <<-TEXT
+        1) $> #{adduser}
+        2) $> mkdir -p #{releases_path} #{content_path} #{log_path}
+        3) $> ln -fs #{shared_path}/passenger.conf #{link_target}
+        4) $> chown -R #{user}:#{apache_grp} #{deploy_to} #{log_path}
+        5) $> chmod 750 #{log_path} #{deploy_to}
+        6) mysql> CREATE DATABASE #{db['database']};
+                  GRANT ALL PRIVILEGES ON #{db['database']}.* TO '#{db['username']}'@localhost IDENTIFIED BY '#{db['password']}';
+      TEXT
+    end
+    
+    desc <<-DESC
+      [passenger]: Executes a cold deployment.  Assumes that the steps detailed in deploy:setup have
+      been manually executed, and that no previous releases have been deployed (or that they have all
+      been removed).  Note that this task runs deploy:check before allowing you to deploy.
+    DESC
+    task :cold do
+      ensure_not_root
+      check # let's not deploy if are dependencies aren't met
+      transaction do
+        update
+        load_schema
+        link_apache_config
+        restart_apache
+      end
+    end
+    
+    desc <<-DESC
+      [passenger]: Executes an iterative deployment.  Assumes the app is already up and running.
+      Invoke this task directly if there are no changes to your Apache config file.  Otherwise,
+      invoke deploy:with_restart.
+    DESC
+    task :default do
+      ensure_not_root
+      check # let's not deploy if are dependencies aren't met
+      transaction do
+        update
+        migrate
+        link_apache_config
+        restart_app
+      end
+    end
+    
+    desc <<-DESC
+      [passenger]: Just a regular deploy that also hard restarts apache.  This task should be invoked
+      when the apache config file is changed.  Otherwise deploy is sufficient.
+    DESC
+    task :with_restart do
+      default
+      restart_apache
+    end
+
+    desc <<-DESC
+      [internal] [passenger]: Drops a symlink into apache's sites-enabled directory.  This task
+      should be followed by a restart of apache.
+    DESC
+    task :link_apache_config, :roles => :app do
+      server_file = "#{shared_path}/passenger.conf"
+      on_rollback { run "ln -fs #{previous_release}/config/#{rails_env}/apache.conf #{server_file}" }
+      run "ln -fs #{apache_conf} #{server_file}"
+    end
+    
+    desc <<-DESC
+      [passenger]: Outputs a message to the user telling them to manually log in and restart apache.
+      Could potentially allow you to actually execute a command by checking to see if the user has exec
+      rights on the file (via a dependency), but I'm just not sure if we want to allow the deployment
+      user to restart apache. 
+    DESC
+    # Hard restarts apache-- the command for this is configurable via the :apache_restart_cmd property.
+    task :restart_apache, :roles => :app do
+      puts "********** LOG INTO THE SERVER AND RESTART APACHE NOW SO THAT YOUR NEW PASSENGER SITE WILL BE SERVED UP ********"
+      #run "#{apache_restart_cmd} restart"
+    end
+    
+    desc <<-DESC
+      [passenger]: Soft restarts Passenger by touching /tmp/restart.txt, forcing Apache to reload 
+      the Rails context on the next request.
+    DESC
+    task :restart_app, :roles => :app do
+      run "touch #{latest_release}/tmp/restart.txt"
+    end
+    
+    # Overwritten
+    desc <<-DESC
+      [internal] [passenger]: Touches up the released code. This is called by update_code \
+      after the basic deploy finishes. It assumes a Rails project was deployed, \
+      so if you are deploying something else, you may want to override this \
+      task with your own environment's requirements.
+
+      This task will make the release group-writable (if the :group_writable \
+      variable is set to true, which is the default). It will then set up \
+      symlinks to the shared directory for the log and tmp directories, and \
+      will lastly touch all assets in public/images, public/stylesheets, and \
+      public/javascripts so that the times are consistent (so that asset \
+      timestamping works).  This touch process is only carried out if the \
+      :normalize_asset_timestamps variable is set to true, which is the default.
+    DESC
+    task :finalize_update, :except => { :no_release => true } do
+      run "chmod -R g+w #{latest_release}" if fetch(:group_writable, true)
+
+      # mkdir -p is making sure that the directories are there for some SCM's that don't
+      # save empty folders
+      run <<-CMD
+        rm -rf #{latest_release}/log &&
+        mkdir -p #{latest_release}/public &&
+        mkdir -p #{latest_release}/tmp &&
+        ln -s #{log_path} #{latest_release}/log
+      CMD
+
+      create_shared_file_column_dirs # defined in capistrano-extensions
+      
+      if fetch(:normalize_asset_timestamps, true)
+        stamp = Time.now.utc.strftime("%Y%m%d%H%M.%S")
+        asset_paths = %w(images stylesheets javascripts).map { |p| "#{latest_release}/public/#{p}" }.join(" ")
+        run "find #{asset_paths} -exec touch -t #{stamp} {} ';'; true", :env => { "TZ" => "UTC" }
+      end
+    end
+
+  end
+  
+  desc <<-DESC
+    [internal] [passenger]: Loads the schema.rb file using rake db:schema:load.
+    This task is invoked during deploy:cold.  migrate is used in deploy:default.
+  DESC
+  task :load_schema, :roles => :db, :only => { :primary => true } do
+    rake = fetch(:rake, "rake")
+
+    run "cd #{release_path}; #{rake} RAILS_ENV=#{rails_env} db:schema:load"
+  end
+end

data/lib/passenger-recipes/version.rb

@@ -0,0 +1,20 @@
+module PassengerRecipes
+  module Version #:nodoc:
+    # A method for comparing versions of required modules. It expects two
+    # arrays of integers as parameters, the first being the minimum version
+    # required, and the second being the actual version available. It returns
+    # true if the actual version is at least equal to the required version.
+    def self.check(required, actual) #:nodoc:
+      required = required.map { |v| "%06d" % v }.join(".")
+      actual   = actual.map { |v| "%06d" % v }.join(".")
+      return actual >= required
+    end
+
+    MAJOR = 0
+    MINOR = 1
+    TINY  = 2
+
+    STRING = [MAJOR, MINOR, TINY].join(".")
+  end
+end
+

data/passenger-recipes.gemspec

@@ -0,0 +1,35 @@
+Gem::Specification.new do |s|
+  s.name = %q{passenger-recipes}
+  s.version = "0.1.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["John Trupiano"]
+  s.date = %q{2008-09-12}
+  s.description = %q{An opinionated set of capistrano recipes built on top of capistrano-extensions tailored for Phusion Passenger}
+  s.email = %q{jtrupiano@gmail.com}
+  s.extra_rdoc_files = ["History.txt", "Manifest.txt", "README.txt"]
+  s.files = ["History.txt", "Manifest.txt", "README.txt", "Rakefile", "passenger-recipes.gemspec", "lib/passenger-recipes.rb", "lib/passenger-recipes/passenger.rb", "lib/passenger-recipes/version.rb"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/jtrupiano/passenger-recipes/tree/master}
+  s.rdoc_options = ["--main", "README.txt"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{johntrupiano}
+  s.rubygems_version = %q{1.2.0}
+  s.summary = %q{An opinionated set of capistrano recipes built on top of capistrano-extensions tailored for Phusion Passenger}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if current_version >= 3 then
+      s.add_runtime_dependency(%q<capistrano-extensions>, [">= 0.1.4"])
+      s.add_development_dependency(%q<hoe>, [">= 1.7.0"])
+    else
+      s.add_dependency(%q<capistrano-extensions>, [">= 0.1.4"])
+      s.add_dependency(%q<hoe>, [">= 1.7.0"])
+    end
+  else
+    s.add_dependency(%q<capistrano-extensions>, [">= 0.1.4"])
+    s.add_dependency(%q<hoe>, [">= 1.7.0"])
+  end
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification 
+name: passenger-recipes
+version: !ruby/object:Gem::Version 
+  version: 0.1.2
+platform: ruby
+authors: 
+- John Trupiano
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-09-12 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: capistrano-extensions
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.1.4
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.7.0
+    version: 
+description: An opinionated set of capistrano recipes built on top of capistrano-extensions tailored for Phusion Passenger
+email: jtrupiano@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- lib/passenger-recipes.rb
+- lib/passenger-recipes/passenger.rb
+- lib/passenger-recipes/version.rb
+- passenger-recipes.gemspec
+has_rdoc: true
+homepage: http://github.com/jtrupiano/passenger-recipes/tree/master
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: johntrupiano
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: An opinionated set of capistrano recipes built on top of capistrano-extensions tailored for Phusion Passenger
+test_files: []
+