hostess 0.1.1

data/README

@@ -0,0 +1,11 @@
+Hostess
+=======
+
+A simple tool for adding local directories as virtual hosts in a local apache installation. It probably only works well on a Mac, but we're scratching our own itch here.
+
+Usage
+-----
+
+    $ sudo hostess create mysite.local /Users/myuser/Sites/mysite
+
+This will create a new virtual host in your Apache configuration, setup your Mac's DNS to respond to that domain name, and restart Apache to make the new virtual host live.

data/Rakefile

@@ -0,0 +1,114 @@
+require "rubygems"
+require "rake/gempackagetask"
+require "rake/rdoctask"
+
+task :default => :package do
+  puts "Don't forget to write some tests!"
+end
+
+# This builds the actual gem. For details of what all these options
+# mean, and other ones you can add, check the documentation here:
+#
+#   http://rubygems.org/read/chapter/20
+#
+spec = Gem::Specification.new do |s|
+  
+  # Change these as appropriate
+  s.name              = "hostess"
+  s.version           = "0.1.1"
+  s.summary           = "Manage simple apache virtual hosts"
+  s.author            = "Chris Roos, James Adam"
+  s.email             = "chris@chrisroos.co.uk"
+  s.homepage          = "http://chrisroos.co.uk"
+
+  s.has_rdoc          = false
+  
+  # You should probably have a README of some kind. Change the filename
+  # as appropriate
+  s.extra_rdoc_files  = %w(README)
+  s.rdoc_options      = %w(--main README)
+  
+  s.require_paths     = ['bin']
+
+  # Add any extra files to include in the gem (like your README)
+  s.files             = %w(README Rakefile) + Dir.glob("{bin}/**/*")
+  s.executables       = FileList["bin/**"].map { |f| File.basename(f) }
+  
+  # If you want to depend on other gems, add them here, along with any
+  # relevant versions
+  # s.add_dependency("some_other_gem", "~> 0.1.0")
+  
+  # If your tests use any gems, include them here
+  # s.add_development_dependency("mocha")
+
+  # If you want to publish automatically to rubyforge, you'll may need
+  # to tweak this, and the publishing task below too.
+  s.rubyforge_project = "hostess"
+end
+
+# This task actually builds the gem. We also regenerate a static 
+# .gemspec file, which is useful if something (i.e. GitHub) will
+# be automatically building a gem for this project. If you're not
+# using GitHub, edit as appropriate.
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+  
+  # Generate the gemspec file for github.
+  file = File.dirname(__FILE__) + "/#{spec.name}.gemspec"
+  File.open(file, "w") {|f| f << spec.to_ruby }
+end
+
+# Generate documentation
+Rake::RDocTask.new do |rd|
+  
+  rd.rdoc_files.include("lib/**/*.rb")
+  rd.rdoc_dir = "rdoc"
+end
+
+desc 'Clear out RDoc and generated packages'
+task :clean => [:clobber_rdoc, :clobber_package] do
+  rm "#{spec.name}.gemspec"
+end
+
+# If you want to publish to RubyForge automatically, here's a simple 
+# task to help do that. If you don't, just get rid of this.
+# Be sure to set up your Rubyforge account details with the Rubyforge
+# gem; you'll need to run `rubyforge setup` and `rubyforge config` at
+# the very least.
+begin
+  require "rake/contrib/sshpublisher"
+  namespace :rubyforge do
+    
+    desc "Release gem and RDoc documentation to RubyForge"
+    task :release => ["rubyforge:release:gem", "rubyforge:release:docs"]
+    
+    namespace :release do
+      desc "Release a new version of this gem"
+      task :gem => [:package] do
+        require 'rubyforge'
+        rubyforge = RubyForge.new
+        rubyforge.configure
+        rubyforge.login
+        rubyforge.userconfig['release_notes'] = spec.summary
+        path_to_gem = File.join(File.dirname(__FILE__), "pkg", "#{spec.name}-#{spec.version}.gem")
+        puts "Publishing #{spec.name}-#{spec.version.to_s} to Rubyforge..."
+        rubyforge.add_release(spec.rubyforge_project, spec.name, spec.version.to_s, path_to_gem)
+      end
+    
+      desc "Publish RDoc to RubyForge."
+      task :docs => [:rdoc] do
+        config = YAML.load(
+            File.read(File.expand_path('~/.rubyforge/user-config.yml'))
+        )
+ 
+        host = "#{config['username']}@rubyforge.org"
+        remote_dir = "/var/www/gforge-projects/hostess/" # Should be the same as the rubyforge project name
+        local_dir = 'rdoc'
+ 
+        Rake::SshDirPublisher.new(host, remote_dir, local_dir).upload
+      end
+    end
+  end
+rescue LoadError
+  puts "Rake SshDirPublisher is unavailable or your rubyforge environment is not configured."
+end

data/bin/hostess

@@ -0,0 +1,145 @@
+#! /usr/bin/env ruby
+
+require 'erb'
+require 'fileutils'
+require 'pathname'
+
+module Hostess
+  SCRIPT              = File.basename($0)
+  APACHE_CONFIG_DIR   = Pathname.new('/') + 'etc' + 'apache2'
+  APACHE_CONFIG       = APACHE_CONFIG_DIR + 'httpd.conf'
+  VHOSTS_DIR          = APACHE_CONFIG_DIR + "#{SCRIPT}_vhosts"
+  class Options
+    attr_reader :action, :domain, :directory
+    def initialize(action=nil, domain=nil, directory=nil)
+      @action, @domain, @directory = action, domain, directory
+    end
+    def directory
+      File.expand_path(@directory) if @directory
+    end
+    def display_banner_and_return
+      puts banner
+      exit
+    end
+    def valid?
+      valid_create? or valid_delete? or valid_list? or valid_help?
+    end
+    private
+      def valid_create?
+        @action == 'create' and domain and directory
+      end
+      def valid_delete?
+        @action == 'delete' and domain
+      end
+      def valid_list?
+        @action == 'list'
+      end
+      def valid_help?
+        @action == 'help'
+      end
+      def banner
+<<EndBanner
+  Usage:
+    #{SCRIPT} create domain directory - create a new virtual host
+    #{SCRIPT} delete domain           - delete a virtual host
+    #{SCRIPT} list                    - list #{SCRIPT} virtual hosts
+    #{SCRIPT} help                    - this info
+EndBanner
+      end
+  end
+  class VirtualHost
+    def initialize(options)
+      @options = options
+    end
+    def execute!
+      __send__(@options.action)
+    end
+    def create
+      warn_and_return unless sudoer?
+      setup_apache_config
+      create_vhost_directory
+      create_apache_log_directory
+      system "dscl localhost -create /Local/Default/Hosts/#{@options.domain} IPAddress 127.0.0.1"
+      File.open(config_filename, 'w') { |f| f.puts(vhost_config) }
+      restart_apache
+    end
+    def delete
+      warn_and_return unless sudoer?
+      system "dscl localhost -delete /Local/Default/Hosts/#{@options.domain}"
+      File.delete(config_filename)
+      restart_apache
+    end
+    def list
+      Dir[File.join(VHOSTS_DIR, '*.conf')].each do |config_file|
+        puts File.basename(config_file, '.conf')
+      end
+    end
+    def help
+      @options.display_banner_and_return
+    end
+    private
+      def apache_log_directory
+        File.expand_path(File.join('~', 'tmp', SCRIPT, 'log', @options.domain))
+      end
+      def create_apache_log_directory
+        FileUtils.mkdir_p(apache_log_directory)
+      end
+      def warn_and_return
+        puts "Please use sudo to use this utility to create or delete virtual hosts"
+        exit
+      end
+      def sudoer?
+        # A proxy for actually knowing whether or not the user has all required privileges
+        File.stat(APACHE_CONFIG).writable?
+      end
+      def vhost_config
+        domain, directory = @options.domain, @options.directory
+        template = <<-EOT
+        <VirtualHost *:80>
+          ServerName <%= domain %>
+          DocumentRoot <%= directory %>
+          <Directory <%= directory %>>
+            AllowOverride All
+            allow from all
+          </Directory>
+          <DirectoryMatch "^/.*/\.svn/">
+            ErrorDocument 403 /404.html
+            Order allow,deny
+            Deny from all
+            Satisfy All
+          </DirectoryMatch>
+          ErrorLog <%= File.join(apache_log_directory, 'error_log') %>
+          CustomLog <%= File.join(apache_log_directory, 'access_log') %> common
+          #RewriteLogLevel 3
+          RewriteLog <%= File.join(apache_log_directory, 'rewrite_log') %>
+        </VirtualHost>
+        EOT
+        ERB.new(template).result(binding)
+      end
+      def config_filename
+        File.join(VHOSTS_DIR, "#{@options.domain}.conf")
+      end
+      def setup_apache_config
+        unless File.read(APACHE_CONFIG).include?("Include #{File.join(VHOSTS_DIR, '*.conf')}")
+          File.open(APACHE_CONFIG, 'a') do |file|
+            file.puts ""
+            file.puts ""
+            file.puts "# Line added by #{SCRIPT}"
+            file.puts "NameVirtualHost *:80"
+            file.puts "Include #{File.join(VHOSTS_DIR, '*.conf')}"
+          end
+        end
+      end
+      def create_vhost_directory
+        FileUtils.mkdir_p(VHOSTS_DIR)
+      end
+      def restart_apache
+        `apachectl restart`
+      end
+  end
+end
+
+options = Hostess::Options.new(*ARGV)
+options.display_banner_and_return unless options.valid?
+
+Hostess::VirtualHost.new(options).execute!

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification 
+name: hostess
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- Chris Roos, James Adam
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-15 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: 
+email: chris@chrisroos.co.uk
+executables: 
+- hostess
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- README
+- Rakefile
+- bin/hostess
+has_rdoc: true
+homepage: http://chrisroos.co.uk
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README
+require_paths: 
+- bin
+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: hostess
+rubygems_version: 1.3.3
+signing_key: 
+specification_version: 3
+summary: Manage simple apache virtual hosts
+test_files: []
+