landlord 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,8 @@
+source "http://rubygems.org"
+
+gem "handlebar"
+
+group :development do
+  gem "bundler"
+  gem "jeweler"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Scott Tadman
+
+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/README.rdoc

@@ -0,0 +1,14 @@
+= landlord
+
+Landlord is a tool for managing tenant applications.
+
+Examples:
+
+    landlord add example.com --redirect=www.example.com
+    landlord list
+    landlord show example.com
+
+== Copyright
+
+Copyright (c) 2012 Scott Tadman, The Working Group Inc. See LICENSE.txt for
+further details.

data/Rakefile

@@ -0,0 +1,29 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'rake'
+require 'jeweler'
+
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "landlord"
+  gem.homepage = "http://github.com/twg/landlord"
+  gem.license = "MIT"
+  gem.summary = %Q{Web server virtual-host tenant management tool}
+  gem.description = %Q{A command-line tool for managing multiple virtual-host configurations on a web server}
+  gem.email = "github@tadman.ca"
+  gem.authors = ["Scott Tadman"]
+  # dependencies defined in Gemfile
+end
+
+Jeweler::RubygemsDotOrgTasks.new

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/bin/landlord

@@ -0,0 +1,84 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+
+$LOAD_PATH << File.expand_path(File.join('..', 'lib'), File.dirname(__FILE__))
+
+require 'landlord'
+
+def show_version
+  puts "landlord #{Landlord::VERSION}"
+end
+
+# == Main ===================================================================
+
+action = nil
+
+options = {
+  :redirects => [ ],
+  :aliases => [ ]
+}
+
+OptionParser.new do |parser|
+  parser.banner = "Usage: landlord [options] command hostname [hostname [...]]"
+
+  parser.separator ""
+  parser.separator "Specific commands:"
+  
+  parser.separator "    %-32s %s" % [ 'add', 'Add a virtual host and configuration file' ]
+  parser.separator "    %-32s %s" % [ 'remove', 'Remove a virtual host configuration file' ]
+  parser.separator "    %-32s %s" % [ 'enable', 'Enable a virtual host configuration file' ]
+  parser.separator "    %-32s %s" % [ 'disable', 'Disable a virtual host configuration file' ]
+
+  parser.separator ""
+  parser.separator "Specific options:"
+
+  parser.on('-a', '--alias=s', 'Create an alias for this virtual host') do |s|
+    options[:aliases] << s
+  end
+  parser.on('-r', '--redirect=s', 'Create a redirect for this virtual host') do |s|
+    options[:redirects] << s
+  end
+  parser.on('-f', '--config=s', 'Specify an alternate configuration file') do |s|
+    options[:config] = s
+  end
+  parser.on('--verbose', 'Verbose mode') do
+    options[:verbose] = true
+  end
+  parser.on('-v', '--version', 'Display version number') do
+    show_version
+    exit(0)
+  end
+  parser.on('-h', '--help', 'Show this help') do
+    puts parser
+    exit(0)
+  end
+end.parse!.each do |arg|
+  case (arg)
+  when /\./
+    virtual_host = Landlord::VirtualHost.new(arg)
+  
+    if (action)
+      virtual_host.send(:"#{action}!")
+    else
+      puts "landlord: No command specified"
+      exit(-1)
+    end
+  when 'list'
+    Landlord::VirtualHost.each do |config|
+      puts config[:server_name]
+      if (aliases = config[:aliases])
+        aliases.each do |as_alias|
+          puts "\t+ #{as_alias} (Alias)"
+        end
+      end
+      if (redirects = config[:redirects])
+        redirects.each do |as_redirect|
+          puts "\t+ #{as_redirect} (Redirect)"
+        end
+      end
+    end
+  when 'add', 'remove', 'enable', 'disable'
+    action = arg.to_sym
+  end
+end

data/landlord.gemspec

@@ -0,0 +1,65 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "landlord"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Scott Tadman"]
+  s.date = "2012-01-27"
+  s.description = "A command-line tool for managing multiple virtual-host configurations on a web server"
+  s.email = "github@tadman.ca"
+  s.executables = ["landlord"]
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "bin/landlord",
+    "landlord.gemspec",
+    "lib/landlord.rb",
+    "lib/landlord/config.rb",
+    "lib/landlord/virtual_host.rb",
+    "templates/virtual_host.apache.conf",
+    "test/expected_results/example_virtual_host.conf",
+    "test/expected_results/example_virtual_host_with_aliases.conf",
+    "test/expected_results/example_virtual_host_with_redirects.conf",
+    "test/helper.rb",
+    "test/test_landlord.rb",
+    "test/test_landlord_config.rb",
+    "test/test_landlord_virtual_host.rb"
+  ]
+  s.homepage = "http://github.com/twg/landlord"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.11"
+  s.summary = "Web server virtual-host tenant management tool"
+
+  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_runtime_dependency(%q<handlebar>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+    else
+      s.add_dependency(%q<handlebar>, [">= 0"])
+      s.add_dependency(%q<bundler>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<handlebar>, [">= 0"])
+    s.add_dependency(%q<bundler>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+  end
+end
+

data/lib/landlord.rb

@@ -0,0 +1,28 @@
+require 'yaml'
+
+module Landlord
+  # == Constants ============================================================
+
+  VERSION = File.read(File.expand_path(File.join('..', 'VERSION'), File.dirname(__FILE__))).chomp.freeze
+
+  DEFAULT_CONFIG_PATH = '/etc/landlord.conf'.freeze
+
+  # == Submodules ===========================================================
+
+  autoload(:Config, 'landlord/config')
+  autoload(:VirtualHost, 'landlord/virtual_host')
+
+  # == Module Methods =======================================================
+  
+  def self.config_path=(path)
+    @config_path = path
+  end
+
+  def self.config_path
+    @config_path || DEFAULT_CONFIG_PATH
+  end
+  
+  def self.config
+    @config ||= Config.new(self.config_path)
+  end
+end

data/lib/landlord/config.rb

@@ -0,0 +1,33 @@
+require 'ostruct'
+
+class Landlord::Config < OpenStruct
+  # == Constants ============================================================
+  
+  DEFAULTS = {
+    :config_file => '/etc/landlord.conf'.freeze,
+    :template_dir => '/etc/landlord'.freeze,
+    :virtual_host_base_dir => '/web'.freeze,
+    :virtual_host_config_dir => '/etc/httpd/vhosts.d'.freeze,
+    :server_type => :apache,
+    :virtual_host_subdirs => %w[ . shared shared/log shared/config releases ]
+  }.freeze
+
+  # == Class Methods ========================================================
+
+  # == Instance Methods =====================================================
+  
+  def initialize(config_file = nil)
+    config = DEFAULTS
+    
+    if (config_file and File.exist?(config_file))
+      config = DEFAULTS.merge(YAML.load(File.read(config_file)))
+    end
+    
+    super(config)
+    
+    self.disabled_virtual_host_config_dir ||= File.expand_path(
+      'disabled',
+      self.virtual_host_config_dir
+    )
+  end
+end

data/lib/landlord/virtual_host.rb

@@ -0,0 +1,169 @@
+require 'handlebar'
+require 'fileutils'
+
+class Landlord::VirtualHost
+  # == Constants ============================================================
+
+  # == Class Methods ========================================================
+  
+  def self.each
+    Dir.glob(File.expand_path("*.conf", Landlord.config.virtual_host_config_dir)).each do |path|
+      config = {
+        :server_name => File.basename(path).sub(/\.conf$/, ''),
+        :aliases => [ ],
+        :redirects => [ ]
+      }
+      
+      File.open(path).readlines.each do |line|
+        line.chomp!
+        
+        if (line.match(/\# VirtualHost (.*)/))
+          aliases = $1.split(/\s+/)
+          
+          server_name = aliases.shift
+          
+          config[:aliases] += aliases
+        elsif (line.match(/\# VirtualHost:Redirect (.*)/))
+          redirects = $1.split(/\s+/)
+          
+          server_name = redirects.shift
+          
+          config[:redirects] += redirects
+        end
+      end
+      
+      yield(config)
+    end
+  end
+
+  # == Instance Methods =====================================================
+  
+  def initialize(server_name, options = nil)
+    @options = {
+      :server_name => server_name.freeze
+    }
+    
+    if (options)
+      @options.merge!(options)
+    end
+    
+    @options[:virtual_host_path] ||= File.expand_path(
+      @options[:server_name],
+      Landlord.config.virtual_host_base_dir
+    )
+  end
+  
+  def server_name
+    @options[:server_name]
+  end
+  
+  def config_file_path(group = nil)
+    File.expand_path(
+      "#{@options[:server_name]}.conf",
+      case (group)
+      when :disabled
+        Landlord.config.disabled_virtual_host_config_dir
+      else
+        Landlord.config.virtual_host_config_dir
+      end
+    )
+  end
+  
+  def config_template_path(type = nil)
+    conf_file = [
+      'virtual_host',
+      type || Landlord.config.server_type,
+      'conf'
+    ].join('.')
+
+    Landlord.config.virtual_host_template or
+      [
+        File.expand_path(
+          conf_file,
+          Landlord.config.template_dir
+        ),
+        File.expand_path(
+          File.join(
+            '..',
+            '..',
+            'templates',
+            conf_file
+          ),
+          File.dirname(__FILE__)
+        )
+      ].find do |path|
+        File.exist?(path)
+      end
+  end
+  
+  def config_file(type = nil)
+    Handlebar::Template.new(
+      File.read(self.config_template_path(type))
+    ).render(
+      :server_name => @options[:server_name],
+      :virtual_host_path => @options[:virtual_host_path],
+      :server_aliases => @options[:aliases] && @options[:aliases].join(' '),
+      :server_redirects => @options[:redirects] && @options[:redirects].collect do |redirect|
+        {
+          :server_name => @options[:server_name],
+          :redirect => redirect
+        }
+      end,
+      :rack_env => @options[:rack_env],
+      :rails_env => @options[:rails_env]
+    ).sub(/\n+\Z/, "\n")
+  end
+  
+  def enable!
+    _config_file_path = self.config_file_path
+    
+    if (File.exist?(_config_file_path))
+      # File already exists?!
+    else
+      File.rename(self.config_file_path(:disabled), _config_file_path)
+    end
+  end
+  
+  def disable!
+    _config_file_path = self.config_file_path
+    
+    if (File.exist?(_config_file_path))
+      File.rename(_config_file_path, self.config_file_path(:disabled))
+    end
+  end
+  
+  def add!
+    File.open(self.config_file_path, 'w') do |f|
+      f.write(self.config_file)
+    end
+    
+    _virtual_host_path = @options[:virtual_host_path]
+    
+    Landlord.config.virtual_host_subdirs.each do |dir|
+      _path = File.expand_path(
+        dir,
+        _virtual_host_path
+      )
+      
+      unless (File.exist?(_path))  
+        FileUtils.mkdir_p(_path)
+        
+        if (Landlord.config.chown_user and Landlord.config.chown_group)
+          FileUtils.chown_R(
+            Landlord.config.chown_user,
+            Landlord.config.chown_group,
+            _path
+          )
+        end
+      end
+    end
+  end
+  
+  def remove!
+    _config_file_path = self.config_file_path
+
+    if (File.exist?(_config_file_path))
+      File.unlink(_config_file_path)
+    end
+  end
+end

data/templates/virtual_host.apache.conf

@@ -0,0 +1,21 @@
+# VirtualHost {{server_name}} {{server_aliases}}
+<VirtualHost *:80>
+  ServerName {{server_name}}{{?server_aliases}}
+  ServerAlias {{server_aliases}}{{/}}{{?rack_env}}
+  
+  RackEnv {{rack_env}}{{/}}
+  
+  DocumentRoot {{virtual_host_path}}/current/public
+  
+  CustomLog {{virtual_host_path}}/shared/log/access.log combined
+  ErrorLog {{virtual_host_path}}/shared/log/error.log
+</VirtualHost>
+
+{{?server_redirects}}{{:server_redirects}}# VirtualHost:Redirect {{server_name}} {{redirect}}
+<VirtualHost *:80>
+  ServerName {{redirect}}
+  
+  RedirectMatch permanent /(.*) http://{{server_name}}/$1
+</VirtualHost>
+
+{{/}}{{/}}

data/test/expected_results/example_virtual_host.conf

@@ -0,0 +1,9 @@
+# VirtualHost example.com 
+<VirtualHost *:80>
+  ServerName example.com
+  
+  DocumentRoot /web/example.com/current/public
+  
+  CustomLog /web/example.com/shared/log/access.log combined
+  ErrorLog /web/example.com/shared/log/error.log
+</VirtualHost>

data/test/expected_results/example_virtual_host_with_aliases.conf

@@ -0,0 +1,10 @@
+# VirtualHost example.com example.net example.org
+<VirtualHost *:80>
+  ServerName example.com
+  ServerAlias example.net example.org
+  
+  DocumentRoot /web/example.com/current/public
+  
+  CustomLog /web/example.com/shared/log/access.log combined
+  ErrorLog /web/example.com/shared/log/error.log
+</VirtualHost>

data/test/expected_results/example_virtual_host_with_redirects.conf

@@ -0,0 +1,23 @@
+# VirtualHost example.com 
+<VirtualHost *:80>
+  ServerName example.com
+  
+  DocumentRoot /web/example.com/current/public
+  
+  CustomLog /web/example.com/shared/log/access.log combined
+  ErrorLog /web/example.com/shared/log/error.log
+</VirtualHost>
+
+# VirtualHost:Redirect example.com example.net
+<VirtualHost *:80>
+  ServerName example.net
+  
+  RedirectMatch permanent /(.*) http://example.com/$1
+</VirtualHost>
+
+# VirtualHost:Redirect example.com example.org
+<VirtualHost *:80>
+  ServerName example.org
+  
+  RedirectMatch permanent /(.*) http://example.com/$1
+</VirtualHost>

data/test/helper.rb

@@ -0,0 +1,28 @@
+require 'rubygems'
+require 'bundler'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'landlord'
+
+class Test::Unit::TestCase
+  def expected_result(name)
+    File.read(
+      File.expand_path(
+        File.join('expected_results', name),
+        File.dirname(__FILE__)
+      )
+    )
+  end
+end

data/test/test_landlord.rb

@@ -0,0 +1,10 @@
+require 'helper'
+
+class TestLandlord < Test::Unit::TestCase
+  def test_module
+    assert Landlord
+
+    assert Landlord::VERSION
+    assert !Landlord::VERSION.empty?
+  end
+end

data/test/test_landlord_config.rb

@@ -0,0 +1,9 @@
+require 'helper'
+
+class TestLandlordConfig < Test::Unit::TestCase
+  def test_module
+    config = Landlord::Config.new
+
+    assert_equal :apache, config.server_type
+  end
+end

data/test/test_landlord_virtual_host.rb

@@ -0,0 +1,38 @@
+require 'helper'
+
+class TestLandlordVirtualHost < Test::Unit::TestCase
+  def setup
+    Landlord.config.template_dir = File.expand_path(
+      File.join('..', 'templates'),
+      File.dirname(__FILE__)
+    )
+  end
+
+  def test_simple_config
+    virtual_host = Landlord::VirtualHost.new('example.com')
+    
+    assert virtual_host
+    
+    assert_equal 'example.com', virtual_host.server_name
+    
+    expected_conf = expected_result('example_virtual_host.conf')
+    
+    assert_equal expected_conf, virtual_host.config_file
+  end
+  
+  def test_config_with_aliases
+    virtual_host = Landlord::VirtualHost.new('example.com', :aliases => %w[ example.net example.org ])
+
+    expected_conf = expected_result('example_virtual_host_with_aliases.conf')
+    
+    assert_equal expected_conf, virtual_host.config_file
+  end
+
+  def test_config_with_redirects
+    virtual_host = Landlord::VirtualHost.new('example.com', :redirects => %w[ example.net example.org ])
+
+    expected_conf = expected_result('example_virtual_host_with_redirects.conf')
+    
+    assert_equal expected_conf, virtual_host.config_file
+  end
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: landlord
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Scott Tadman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: handlebar
+  requirement: &2158107120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2158107120
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &2158106540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2158106540
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &2158105700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2158105700
+description: A command-line tool for managing multiple virtual-host configurations
+  on a web server
+email: github@tadman.ca
+executables:
+- landlord
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/landlord
+- landlord.gemspec
+- lib/landlord.rb
+- lib/landlord/config.rb
+- lib/landlord/virtual_host.rb
+- templates/virtual_host.apache.conf
+- test/expected_results/example_virtual_host.conf
+- test/expected_results/example_virtual_host_with_aliases.conf
+- test/expected_results/example_virtual_host_with_redirects.conf
+- test/helper.rb
+- test/test_landlord.rb
+- test/test_landlord_config.rb
+- test/test_landlord_virtual_host.rb
+homepage: http://github.com/twg/landlord
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Web server virtual-host tenant management tool
+test_files: []