capistrano-webserver 0.1.1

data/Manifest

@@ -0,0 +1,5 @@
+README.rdoc
+Rakefile
+capistrano-webserver.gemspec
+lib/webserver/apache.rb
+Manifest

data/README.rdoc

@@ -0,0 +1,63 @@
+= Capistrano WebServer 
+
+The purpose of this gem is to provide a common interface to handling webserver related functions within capistrano deploy scripts.
+The contents of this file are still a bit of a work in progress.
+
+= Server Support
+
+Currently, only apache is supported.
+
+= Configuration
+
+== Common variables
+
+[webserver_config]	<b>default: config/webserver/webserver.conf</b>
+			the file to use for webserver configuration. For apache, this might be the file
+			containing the VirtualHost block of the site in which the project
+			will be running.
+[webserver_link]	<b>default: true</b>
+			Use a symlink from the webserver configuration directory to the project configuration file.
+			If this is set to false, the file will be copied to the webserver configuration directory.
+[webserver_restart]	<b>default: true</b>
+			Should the webserver be restarted after configuration is updated.
+
+== Module variables
+
+[webserver_dir]		This is defined by the capistrano_webserver modules. For apache, this would generally point to
+			sites-enabled directory under the ServerRoot. (eg: /etc/apache2/sites-enabled)
+
+= Tasks
+
+Each webserver library will implement the following capistrano tasks. These tasks will only run on servers with the :web role.
+
+== webserver:configuration
+
+This task will handle linking or copying the configuration file from the project directory to the webserver directory.
+
+== webserver:restart
+
+This task will restart the webserver.
+
+== webserver:stop
+
+This task will stop the webserver.
+
+== webserver:start
+
+This task will start the webserver.
+
+= Usage
+
+Install the gem:
+
+	gem install capistrano-webserver
+
+Put the following code into your capistrano deploy.rb (or other) file. For now, only apache is supported. Later, support for other webservers will be added.
+
+	require 'webserver/apache'
+
+If your configuration or webserver requires a restart after code deploy, simply add the following hook. This will work by default, careful of overriding the variable 'webserver_restart'.
+
+	after 'deploy:update_code', 'webserver:configuration'
+
+In the case of Apache, you do not need this. You should not need to restart the Apache server after every deploy.

data/Rakefile

@@ -0,0 +1,14 @@
+require 'rubygems'  
+require 'rake'  
+require 'echoe'  
+  
+Echoe.new('capistrano-webserver', '0.1.1') do |p|  
+  p.description     = "Common way to manage webserver configuration using capistrano"
+  p.url             = "http://github.com/dashonet/capistrano-webserver"  
+  p.author          = "Shawn Catanzarite"  
+  p.email           = "shawn@dasho.net"
+  p.ignore_pattern  = ["tmp/*", "script/*","nbproject/**","nbproject/private/*"]
+  p.development_dependencies = ["capistrano"]  
+end  
+  
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }  

data/capistrano-webserver.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{capistrano-webserver}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Shawn Catanzarite"]
+  s.date = %q{2011-05-02}
+  s.description = %q{Common way to manage webserver configuration using capistrano}
+  s.email = %q{shawn@dasho.net}
+  s.extra_rdoc_files = ["README.rdoc", "lib/webserver/apache.rb"]
+  s.files = ["README.rdoc", "Rakefile", "capistrano-webserver.gemspec", "lib/webserver/apache.rb", "Manifest"]
+  s.homepage = %q{http://github.com/dashonet/capistrano-webserver}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Capistrano-webserver", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{capistrano-webserver}
+  s.rubygems_version = %q{1.6.2}
+  s.summary = %q{Common way to manage webserver configuration using capistrano}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<capistrano>, [">= 0"])
+    else
+      s.add_dependency(%q<capistrano>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<capistrano>, [">= 0"])
+  end
+end

data/lib/webserver/apache.rb

@@ -0,0 +1,71 @@
+Capistrano::Configuration.instance(true).load do
+
+  ## common variables
+  set :webserver_link,    true
+  set :webserver_config,  "config/webserver/webserver.conf"
+  set :webserver_restart, true
+
+  ## apache specific variables
+  set :webserver_init,    "/etc/init.d/apache2"
+  set :webserver_dir,     "/etc/apache2/sites-enabled"
+
+  after "deploy:setup", "webserver:setup"
+
+  namespace :webserver do
+    desc <<-DESC
+      setup webserver directories.
+
+      creates a directory under the shared resources directory for webserver
+      related files
+    DESC
+    task :setup, :roles => :web do
+      run "mkdir -p #{shared_path}/webserver"
+    end
+
+    desc <<-DESC
+    update configuration.
+
+    Upload the webserver configuration file to the shared resources directory
+    and create a link (or copy to) the webserver configuration directory
+
+    This task is designed to push the file directly, rather than use the deployed
+    application directory. This means you will not need to do a deploy just to
+    update configuration files for the webserver.
+    DESC
+    task :configuration, :roles => :web do
+      # upload the file
+      upload "#{webserver_config}", "#{shared_path}/webserver/#{application}"
+      
+      # remove the old file / link
+      run "#{try_sudo} rm -f #{webserver_dir}/#{application}"
+      
+      # link or copy file from shared to webserver directory
+      if webserver_link == true
+        run "#{try_sudo} ln -sf #{shared_path}/webserver/#{application} #{webserver_dir}/#{application}"
+      else
+        run "#{try_sudo} cp #{shared_path}/webserver/#{application} #{webserver_dir}/#{application}"
+      end
+
+      # restart the webserver
+      if webserver_restart == true
+        webserver.restart
+      end
+    end
+
+    desc "start webserver (apache)"
+    task :start, :roles => :web do
+      run "#{try_sudo} #{webserver_init} start"
+    end
+
+    desc "stop webserver (apache)"
+    task :stop, :roles => :web do
+      run "#{try_sudo} #{webserver_init} stop"
+    end
+
+    desc "restart webserver (apache)"
+    task :restart, :roles => :web do
+      run "#{try_sudo} #{webserver_init} restart"
+    end
+
+  end
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification 
+name: capistrano-webserver
+version: !ruby/object:Gem::Version 
+  hash: 25
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
+platform: ruby
+authors: 
+- Shawn Catanzarite
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-02 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: capistrano
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: Common way to manage webserver configuration using capistrano
+email: shawn@dasho.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- lib/webserver/apache.rb
+files: 
+- README.rdoc
+- Rakefile
+- capistrano-webserver.gemspec
+- lib/webserver/apache.rb
+- Manifest
+has_rdoc: true
+homepage: http://github.com/dashonet/capistrano-webserver
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Capistrano-webserver
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 11
+      segments: 
+      - 1
+      - 2
+      version: "1.2"
+requirements: []
+
+rubyforge_project: capistrano-webserver
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Common way to manage webserver configuration using capistrano
+test_files: []
+