apacheconf 1.0.0

data/History.txt

@@ -0,0 +1,3 @@
+== 1.0.0 / 2007-09-24
+
+* Wrote the original.

data/Manifest.txt

@@ -0,0 +1,10 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/apacheconf
+lib/add_apache_site.rb
+lib/apacheconf.rb
+lib/example_site.yml
+lib/vhost.erb
+test/test_apacheconf.rb

data/README.txt

@@ -0,0 +1,56 @@
+apacheconf
+    by Alastair Brunton
+    http://www.iformis.com
+    http://www.simplyexcited.co.uk
+    
+== DESCRIPTION:
+  
+This is a simple apache configuration generator for making it easier to setup and enable sites
+within the ubuntu / debian apache configuration structure.
+
+== FEATURES/PROBLEMS:
+  
+* Ability to add a virtual host from a YAML file.
+* Enable / Disable the virtual host and reload the web server.
+
+== SYNOPSIS:
+
+config.yml.example includes example of what can be defined.
+
+apachconf site.yml
+apacheconf --overwrite site.yml (overwrites a configuration if it already exists)
+apacheconf --enable site.yml (enables the virtual host and reloads apache)
+apacheconf --disable site.yml (disables the virtual host and reloads apache)
+  
+== REQUIREMENTS:
+
+* Apache2 installed and configured to load vhosts using the sites-available and sites-enabled directories.
+
+== INSTALL:
+
+* sudo gem install apacheconf
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2007 Alastair Brunton
+
+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,17 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './lib/apacheconf.rb'
+
+Hoe.new('apacheconf', Apacheconf::VERSION) do |p|
+  p.rubyforge_name = 'apacheconf'
+  p.author = 'Alastair Brunton'
+  p.email = 'info@simplyexcited.co.uk'
+  p.summary = 'Simple config generator for apache the debian way.'
+  # p.description = p.paragraphs_of('README.txt', 2..5).join("\n\n")
+  # p.url = p.paragraphs_of('README.txt', 0).first.split(/\n/)[1..-1]
+  p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
+end
+
+# vim: syntax=Ruby

data/bin/apacheconf

@@ -0,0 +1,3 @@
+#! /usr/bin/env ruby
+load File.dirname(__FILE__) + '/../lib/add_apache_site.rb'
+

data/lib/add_apache_site.rb

@@ -0,0 +1,44 @@
+#!/usr/bin/ruby -w
+# This is the main meat of the apache config generator
+# Author: Alastair Brunton
+
+%w(erb yaml).each &method(:require)
+
+require "#{File.dirname(__FILE__)}/apacheconf"
+include ApacheHelper
+  
+if ARGV.include? '--example'
+  example = file:'example.yml'
+  error open(example).read 
+end
+
+error "Usage: add_apache_site [options] [config file]" if ARGV.empty?
+
+# pretty cool overwrite thing here
+overwrite = !(%w(-y -o -f --force --overwrite) & ARGV).empty?
+should_enable = !(%w(--enable --on) & ARGV).empty?
+should_disable = !(%w(--disable --off) & ARGV).empty?
+
+config   = YAML.load_file(ARGV.pop || 'vhost.yml')
+template = file:'vhost.erb'
+
+if should_enable
+  enable(config)
+  reload_apache
+  error "=> #{config['site_name']} enabled"
+end
+
+if should_disable
+  disable(config)
+  reload_apache
+  error "=> #{config['site_name']} disabled"
+end
+
+if File.exists?(out_file = get_out_file(config)) && !overwrite
+  error "=> #{out_file} already exists, won't overwrite it.  Quitting."
+else
+  open(out_file, 'w+').write(ERB.new(File.read(template), nil, '>').result(binding))
+  puts "=> Wrote #{out_file} successfully."
+end
+
+

data/lib/apacheconf.rb

@@ -0,0 +1,38 @@
+class Apacheconf
+  VERSION = '1.0.0'
+end
+
+module ApacheHelper
+
+  DEFAULT_APACHE = '/etc/apache2'
+
+  def error(message) puts(message) || exit end
+
+  # Great way to solve the problem of different file paths.
+  def file(file) "#{File.dirname(__FILE__)}/#{file}" end
+  
+  # Get the file where apache will write the vhost configuration.
+  def get_out_file(config)
+    config['apache_dir'] ||= DEFAULT_APACHE
+    "#{config['apache_dir']}/sites-available/#{config['site_name']}"
+  end
+
+  # Enable the vhost (run with the --enable or --on flag)
+  def enable(config)
+    config['apache_dir'] ||= DEFAULT_APACHE
+    `sudo ln -s #{config['apache_dir']}/sites-available/#{config['site_name']} #{config['apache_dir']}/sites-enabled/#{config['site_name']}`
+  end
+  
+  # Disable the vhost (run with --disable or --off flag)
+  def disable(config)
+    config['apache_dir'] ||= DEFAULT_APACHE
+    `sudo rm #{config['apache_dir']}/sites-enabled/#{config['site_name']}`
+  end
+  
+  
+  # This reloads apache assuming that this script exists for controlling it!
+  def reload_apache
+    `sudo /etc/init.d/apache2 reload`
+  end
+
+end

data/lib/example_site.yml

@@ -0,0 +1,5 @@
+# example apache site yaml configuration
+site_name: funsite
+document_root: /var/www/apps/funsite
+server_name: funsite.com    
+server_alias: www.funsite.com

data/lib/vhost.erb

@@ -0,0 +1,10 @@
+<VirtualHost *:80>
+    ServerName <%= config['server_name'] %>
+    
+    <% if config['server_alias'] %>
+    ServerAlias <%= config['server_alias'] %>
+    <% end %>
+    
+    DocumentRoot <%= config['document_root'] %>
+    
+</VirtualHost>

data/test/test_apacheconf.rb

@@ -0,0 +1,36 @@
+# Tests for the apacheconf generator.
+# Need to think about how best to do this.
+require 'test/unit'
+require File.dirname(__FILE__) + "/../lib/apacheconf"
+class TestApacheconf < Test::Unit::TestCase
+  
+  include ApacheHelper
+  
+  
+  def test_out_file
+    out_file = get_out_file(get_test_config)
+    assert_equal('/etc/apache2/sites-available/funsite', out_file)
+  end
+  
+  def test_no_args
+    exec_path = get_exec_path
+    op = `ruby #{exec_path}`
+    assert_equal("Usage: add_apache_site [options] [config file]\n", op)
+  end
+    
+  private
+  
+  def get_test_config
+    {
+      'site_name' => 'funsite',
+      'document_root' => '/var/www/apps/funsite',
+      'server_name' => 'funsite.com',
+      'server_alias' => 'www.funsite.com'
+     } 
+  end
+  
+  def get_exec_path
+    File.dirname(__FILE__) + '/../bin/apacheconf'
+  end
+  
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.4
+specification_version: 1
+name: apacheconf
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+date: 2007-09-27 00:00:00 +01:00
+summary: Simple config generator for apache the debian way.
+require_paths: 
+- lib
+email: info@simplyexcited.co.uk
+homepage: http://www.zenspider.com/ZSS/Products/apacheconf/
+rubyforge_project: apacheconf
+description: The author was too lazy to write a description
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDYDCCAkigAwIBAgIBADANBgkqhkiG9w0BAQUFADBWMQ0wCwYDVQQDDARpbmZv
+  MR0wGwYKCZImiZPyLGQBGRYNc2ltcGx5ZXhjaXRlZDESMBAGCgmSJomT8ixkARkW
+  AmNvMRIwEAYKCZImiZPyLGQBGRYCdWswHhcNMDcwOTI2MTEwMDUzWhcNMDgwOTI1
+  MTEwMDUzWjBWMQ0wCwYDVQQDDARpbmZvMR0wGwYKCZImiZPyLGQBGRYNc2ltcGx5
+  ZXhjaXRlZDESMBAGCgmSJomT8ixkARkWAmNvMRIwEAYKCZImiZPyLGQBGRYCdWsw
+  ggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDd7FKKv4PWTYhivLqWAo0N
+  9J20tF9TwZiZGAxUt0IJSuuSqLpJGKvENuNTZeF1fFbZWSqfqsd+Ft+nPIgOZfSl
+  2Q8sUGBlUEMXKt4nDL0o61iZG9mX5OpUipoYrLnebiLY2t+PB6sHWDYM2WkfsxTq
+  R5r/WqI7H6YVsWjwqrqCNFIFsqOl6p1asPSqVOuJXccXdDgdy2riXN9V6ziSGxZD
+  gC8UB37d4awM83As38eS81leIsRrSGOX33XJXrLDOA7FU7amCVlE2wtquBJlfnds
+  j/sAmCL2ESsKybTJAvujaLohg/xKR+NaOosBGZmGQwagiR2B9SX2jLo1VdvfXxWf
+  AgMBAAGjOTA3MAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQWBBRu/Fh5
+  9BmUIAUSGGTMMaKiDSAsLTANBgkqhkiG9w0BAQUFAAOCAQEA1wu2PjOaqIbwCtmN
+  lh2YkfZYEHBmCI/YW0jMpDVeulRPueWFAmEPQhql2rOxcBrfKQLPyXVH5yyvGeST
+  NRMFClPEq688EHjqpDA4lzChQn6k/cLfMc3iSqUkX+BlqMzmgcWHoXyx8Uf2j0lu
+  dsLhQMY4bC/XHYo8aQNC8wWbSdvodKjBrzwieeYdcIX2BX29xRXY2DV84VHU+w/V
+  GU5tmVjU+vg/G/Bfl5nXuHjbVFm95SDohYyXyZjRjumCLZGxh5SQSXgQ+ddo2Xz2
+  vE995UihOI18WiXfm9QrgBPOhxIcU5274MKP2YaqcjRQJ6nj1E3gfYrJrgnB9TPe
+  hono1A==
+  -----END CERTIFICATE-----
+
+post_install_message: 
+authors: 
+- Alastair Brunton
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- bin/apacheconf
+- lib/add_apache_site.rb
+- lib/apacheconf.rb
+- lib/example_site.yml
+- lib/vhost.erb
+- test/test_apacheconf.rb
+test_files: 
+- test/test_apacheconf.rb
+rdoc_options: 
+- --main
+- README.txt
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+executables: 
+- apacheconf
+extensions: []
+
+requirements: []
+
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.3.0
+    version: