ghost 0.2.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Bodaniel Jeanes
+
+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

@@ -0,0 +1,95 @@
+Ghost
+=====
+
+A gem that allows you to create, list, and modify local hostnames
+with ease in linux and OS (more to come)...
+
+Requirements
+============
+
+Unix-based OS (for now)
+
+Intended Usage
+==============
+
+This gem is designed primarily for web developers who need to add
+and modify hostnames to their system for virtual hosts on their
+local/remote web server. However, it could be of use to other people
+who would otherwise modify their `/etc/hosts` file manually and 
+flush the cache.
+
+Command
+-------
+
+    $ ghost add mydevsite.local
+      [Adding] mydevsite.local -> 127.0.0.1
+
+    $ ghost add staging-server.local 67.207.136.164
+      [Adding] staging-server.local -> 67.207.136.164
+
+    $ ghost list
+    Listing 2 host(s):
+      mydevsite.local      -> 127.0.0.1
+      staging-server.local -> 67.207.136.164
+
+    $ ghost delete mydevsite.local
+      [Deleting] mydevsite.local
+
+    $ ghost list
+    Listing 1 host(s):
+      staging-server.local -> 67.207.136.164
+
+    $ ghost modify staging-server.local 64.233.167.99
+      [Modifying] staging-server.local -> 64.233.167.99
+
+    $ ghost list
+    Listing 1 host(s):
+      staging-server.local -> 64.233.167.99
+
+    $ ghost empty
+      [Emptying] Done.
+
+    $ ghost list
+    Listing 0 host(s):
+
+Library
+-------
+
+There is also a library that can be used in Ruby scripts. The `ghost` 
+command is a wrapper for the library. View the source of `bin/ghost` 
+to see how to use the library.
+
+Installation
+============
+
+    sudo gem install ghost
+    
+Contributors
+============
+
+* [Bodaniel Jeanes](http://github.com/bjeanes)
+* [Mitchell V Riley](http://github.com/mitchellvriley)
+
+Legal Stuff
+===========
+
+Copyright (c) 2008 Bodaniel Jeanes
+
+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,28 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'rubygems/specification'
+require 'date'
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }
+
+
+#### MISC TASKS ####
+
+desc "list tasks"
+task :default do
+  puts `rake -T`.grep(/^[^(].*$/)
+end
+
+desc "Outstanding TODO's"  
+task :todo do  
+  files = ["**/*.{rb,rake}" "bin/*", "README.mkdn"]
+  
+  File.open('TODO','w') do |f|
+      FileList[*files].egrep(/TODO|FIXME/) do |file, line, text|
+      output = "#{file}:#{line} - #{text.chomp.gsub(/^\s+|\s+$/ , "")}"
+    
+      puts output
+      f.puts output
+    end
+  end
+end

data/bin/ghost

@@ -0,0 +1,82 @@
+#!/usr/bin/env ruby
+#
+#  Created by Bodaniel Jeanes on 2008-8-19.
+#  Copyright (c) 2008. All rights reserved.
+
+begin
+  require 'rubygems'
+rescue LoadError
+  # no rubygems to load, so we fail silently
+end
+require 'ghost'
+
+def help_text(exit_code = 0)
+  script_name = File.basename $0
+  puts """USAGE: #{script_name} add <hostname> [<ip=127.0.1.1>]
+       #{script_name} modify <hostname> <ip>
+       #{script_name} delete <hostname>
+       #{script_name} list
+       #{script_name} empty
+"""
+  exit(exit_code)
+end
+
+if ARGV.size.zero? || ['-h', '--help', 'help'].include?(ARGV.first)
+  help_text
+else  
+  case ARGV[0]
+  when 'add':
+    if [2,3].include?(ARGV.size)
+      begin
+        ARGV.shift
+        host = Host.add(*ARGV)
+        puts "  [Adding] #{host.name} -> #{host.ip}"
+        exit 0
+      rescue
+        $stderr.puts "Cannot overwrite an existing entry. Use the modify subcommand"
+        exit 3
+      end
+    else
+      $stderr.puts "The add subcommand requires at least a hostname.\n\n"
+      help_text 2
+    end
+  when 'modify':
+    if ARGV.size == 3
+      ARGV.shift
+      ARGV << true
+      host = Host.add(*ARGV)
+      puts "  [Modifying] #{host.name} -> #{host.ip}"
+      exit 0
+    else
+      $stderr.puts "The modify subcommand requires a hostname and an IP.\n\n"
+      help_text 4
+    end
+  when 'delete':
+    if ARGV.size == 2
+      Host.delete(ARGV[1])
+      puts "  [Deleting] #{ARGV[1]}"
+      exit 0
+    else  
+      $stderr.puts "The delete subcommand requires a hostname.\n\n"
+      help_text 2
+    end
+  when 'list':
+    hosts = Host.list
+    pad = hosts.max{|a,b| a.to_s.length <=> b.to_s.length }.to_s.length
+    
+    puts "Listing #{hosts.size} host(s):"
+    
+    hosts.each do |host|
+      puts "#{host.name.rjust(pad+2)} -> #{host.ip}"
+    end
+    exit 0
+  when 'empty':  
+    print "  [Emptying] "
+    Host.empty!
+    puts "Done."
+    exit 0
+  else
+    $stderr.puts "Invalid option: #{ARGV[0]}"
+    help_text 1
+  end
+end

data/lib/ghost.rb

@@ -0,0 +1,8 @@
+$: << File.dirname(__FILE__)
+
+case RUBY_PLATFORM
+when /darwin/
+  require 'ghost/mac-host'
+when /linux/
+  require 'ghost/linux-host'
+end

data/lib/ghost/linux-host.rb

@@ -0,0 +1,79 @@
+class Host
+  attr_reader :host, :ip
+
+  def initialize(host, ip)
+    @host = host
+    @ip = ip
+  end
+  
+  def ==(other)
+    @host == other.host && @ip = other.ip
+  end
+  
+  alias :to_s :host
+  alias :name :host
+  alias :hostname :host
+  
+  @@hosts_file = '/etc/hosts'
+  @@permanent_hosts = [Host.new("localhost",      "127.0.0.1"),
+                       Host.new(`hostname`.chomp, "127.0.0.1")]
+  class << self
+    protected :new
+    
+    def list
+      entries = []
+      File.open(@@hosts_file).each do |line|
+        next if line =~ /^#/
+        if line =~ /^(\d+\.\d+\.\d+\.\d+) (.*)/
+          ip = $1
+          hosts = $2.split(' ')
+          hosts.each {|host| entries << Host.new(host, ip) }
+        end
+      end
+      entries.delete_if {|host| @@permanent_hosts.include? host }
+      entries
+    end
+
+    def add(host, ip = "127.0.0.1", force = false)
+      if find_by_host(host).nil? || force
+        delete(host)
+        new_host = Host.new(host, ip)
+        
+        hosts = list
+        hosts << new_host
+        write_out!(hosts)
+        
+        new_host
+      else
+        raise "Can not overwrite existing record"
+      end      
+    end
+    
+    def find_by_host(hostname)
+      list.find{|host| host.hostname == hostname }
+    end
+    
+    def find_by_ip(ip)
+      list.find_all{|host| host.ip == ip }
+    end
+    
+    def empty!
+      write_out!([])
+    end
+    
+    def delete(name)
+      hosts = list
+      hosts = hosts.delete_if {|host| host.name == name }
+      write_out!(hosts)
+    end
+
+    protected
+
+    def write_out!(hosts)
+      hosts += @@permanent_hosts
+      # Har har! inject!
+      output = hosts.inject("") {|s, h| s + "#{h.ip} #{h.hostname}\n" }
+      File.open(@@hosts_file, 'w') {|f| f.print output }
+    end
+  end
+end

data/lib/ghost/mac-host.rb

@@ -0,0 +1,97 @@
+class Host
+  ListCmd = "dscl localhost -list /Local/Default/Hosts 2>&1"
+  ReadCmd = "dscl localhost -read /Local/Default/Hosts/%s 2>&1"
+  CreateCmd = "sudo dscl localhost -create /Local/Default/Hosts/%s IPAddress %s 2>&1"
+  DeleteCmd = "sudo dscl localhost -delete /Local/Default/Hosts/%s 2>&1"
+  
+  class << self
+    protected :new
+    
+    def list
+      list = `#{ListCmd}`
+      list.collect { |host| Host.new(host.chomp) }
+    end
+
+    def add(host, ip = "127.0.0.1", force = false)
+      if find_by_host(host).nil? || force
+        `#{CreateCmd % [host, ip]}`
+        flush!
+        find_by_host(host)
+      else
+        raise "Can not overwrite existing record"
+      end      
+    end
+    
+    def find_by_host(host)
+      @hosts ||= {}
+      @hosts[host] ||= begin
+        output = `#{ReadCmd % host}`
+      
+        if output =~ /eDSRecordNotFound/
+          nil
+        else
+          host = parse_host(output)
+          ip = parse_ip(output)
+        
+          Host.new(host, ip)
+        end
+      end
+    end
+    
+    def find_by_ip(ip)
+      nil
+    end
+    
+    def empty!
+      list.each { |h| delete(h) }
+      nil
+    end
+    
+    def delete(host)
+      `#{DeleteCmd % host.to_s}`
+      flush!
+    end
+    
+    # Flushes the DNS Cache
+    def flush!
+      `dscacheutil -flushcache`
+      @hosts = {}
+      true
+    end
+    
+    protected
+    def parse_host(output)
+      parse_value(output, 'RecordName')
+    end
+    
+    def parse_ip(output)
+      parse_value(output, 'IPAddress')
+    end
+    
+    def parse_value(output, key)
+      match = output.match(Regexp.new("^#{key}: (.*)$"))
+      match[1] unless match.nil?
+    end
+  end
+  
+  def initialize(host, ip=nil)
+    @host = host
+    @ip = ip
+  end
+  
+  def hostname
+    @host
+  end
+  alias :to_s :hostname
+  alias :host :hostname
+  alias :name :hostname
+  
+  def ip
+    @ip ||= self.class.send(:parse_ip, dump)
+  end
+  
+  private
+  def dump
+    @dump ||= `#{ReadCmd % hostname}`
+  end
+end

data/spec/ghost_spec.rb

@@ -0,0 +1,120 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+# Warning: these tests will delete all hostnames in the system. Please back them up first
+
+Host.empty!
+
+describe Host, ".list" do
+  after(:each) { Host.empty! }
+  
+  it "should return an array" do
+    Host.list.should be_instance_of(Array)
+  end
+  
+  it "should contain instances of Host" do
+    Host.add('ghost-test-hostname.local')
+    Host.list.first.should be_instance_of(Host)
+  end
+end
+
+describe Host do
+  after(:each) { Host.empty! }
+  
+  it "should have an IP" do
+    hostname = 'ghost-test-hostname.local'
+    
+    Host.add(hostname)
+    host = Host.list.first
+    host.ip.should eql('127.0.0.1')
+    
+    Host.empty!
+    
+    ip = '169.254.23.121'
+    host = Host.add(hostname, ip)
+    host.ip.should eql(ip)
+  end
+  
+  it "should have a hostname" do
+    hostname = 'ghost-test-hostname.local'
+    
+    Host.add(hostname)
+    host = Host.list.first
+    host.hostname.should eql(hostname)
+    
+    Host.empty!
+    
+    ip = '169.254.23.121'
+    Host.add(hostname, ip)
+    host.hostname.should eql(hostname)
+  end
+  
+  it ".to_s should return hostname" do
+    hostname = 'ghost-test-hostname.local'
+    
+    Host.add(hostname)
+    host = Host.list.first
+    host.to_s.should eql(hostname)
+  end
+end
+
+describe Host, "finder methods" do
+  after(:all) { Host.empty! }
+  before(:all) do
+    Host.add('abc.local')
+    Host.add('def.local')
+    Host.add('efg.local', '10.2.2.4')
+  end
+  
+  it "should return valid Host when searching for host name" do
+    Host.find_by_host('abc.local').should be_instance_of(Host)
+  end
+  
+end
+
+describe Host, ".add" do
+  after(:each) { Host.empty! }
+  
+  it "should return Host object when passed hostname" do
+    Host.add('ghost-test-hostname.local').should be_instance_of(Host)
+  end
+  
+  it "should return Host object when passed hostname" do
+    Host.add('ghost-test-hostname.local', '10.0.0.2').should be_instance_of(Host)
+  end
+  
+  it "should raise error if hostname already exists and not add a duplicate" do
+    Host.empty!
+    Host.add('ghost-test-hostname.local')
+    lambda { Host.add('ghost-test-hostname.local') }.should raise_error
+    Host.list.should have(1).thing
+  end
+  
+  it "should overwrite existing hostname if forced" do
+    hostname = 'ghost-test-hostname.local'
+    
+    Host.empty!
+    Host.add(hostname)
+    
+    Host.list.first.hostname.should eql(hostname)
+    Host.list.first.ip.should eql('127.0.0.1')
+    
+    Host.add(hostname, '10.0.0.1', true)
+    Host.list.first.hostname.should eql(hostname)
+    Host.list.first.ip.should eql('10.0.0.1')
+    
+    Host.list.should have(1).thing
+  end
+end
+
+describe Host, ".empty!" do
+  it "should empty the hostnames" do
+    Host.add('ghost-test-hostname.local') # add a hostname to be sure
+    Host.empty!
+    Host.list.should have(0).things
+  end
+end
+
+describe Host, ".backup and", Host, ".restore" do
+  it "should return a yaml file of all hosts and IPs when backing up"
+  it "should empty the hosts and restore only the ones in given yaml"
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+$TESTING=true
+$:.push File.join(File.dirname(__FILE__), '..', 'lib')
+require 'ghost'

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification 
+name: ghost
+version: !ruby/object:Gem::Version 
+  version: 0.2.0
+platform: ruby
+authors: 
+- Bodaniel Jeanes
+autorequire: ghost
+bindir: bin
+cert_chain: []
+
+date: 2009-03-29 00:00:00 +10:00
+default_executable: 
+dependencies: []
+
+description: Allows you to create, list, and modify .local hostnames in 10.5 with ease
+email: me@bjeanes.com
+executables: 
+- ghost
+extensions: []
+
+extra_rdoc_files: 
+- README
+- LICENSE
+- TODO
+files: 
+- LICENSE
+- README
+- Rakefile
+- TODO
+- bin/ghost
+- lib/ghost
+- lib/ghost/linux-host.rb
+- lib/ghost/mac-host.rb
+- lib/ghost.rb
+- spec/ghost_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/bjeanes/ghost
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+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: ghost
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: Allows you to create, list, and modify .local hostnames in 10.5 with ease
+test_files: []
+