ghost 0.3.0 → 1.0.0.pre

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2008 Bodaniel Jeanes
+Copyright (c) 2008-2012 Bodaniel Jeanes
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/bin/ghost

@@ -1,133 +1,5 @@
 #!/usr/bin/env ruby
-#
-#  Created by Bodaniel Jeanes on 2008-8-19.
-#  Copyright (c) 2008. All rights reserved.
 
-require File.expand_path(File.dirname(__FILE__) + '/../lib/ghost')
-require 'open-uri'
+require 'ghost/cli'
 
-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> OR <hostname> (will lookup ip)
-       #{script_name} delete <hostname>
-       #{script_name} delete_matching <pattern>
-       #{script_name} list [<filter>]
-       #{script_name} empty
-       #{script_name} export
-       #{script_name} import <file>
-"""
-  exit(exit_code)
-end
-
-begin
-  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 = Ghost::Host.add(*ARGV)
-          puts "  [Adding] #{host.name} -> #{host.ip}"
-          exit 0
-        rescue SocketError
-          $stderr.puts "Cannot find IP for host"
-          exit 3
-        rescue Ghost::RecordExists
-          $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 = Ghost::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', 'del', 'remove', 'rm'
-      if ARGV.size == 2
-        Ghost::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 'delete_matching'
-      if ARGV.size == 2
-        matched = Ghost::Host.delete_matching(ARGV[1])
-        if matched.empty?
-          puts "  No matching entries found"
-        else
-          matched.each { |h| puts "  [Deleting] #{h}" }
-        end
-        exit 0
-      else
-        $stderr.puts "The delete_matching subcommand requires a hostname pattern.\n\n"
-        help_text 2
-      end
-    when 'list'
-      filter = %r|#{ARGV[1]}| if ARGV.size == 2
-
-      hosts = Ghost::Host.list
-
-      if filter
-        hosts.reject! { |host| host.name !~ filter && host.ip !~ filter }
-      end
-
-      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] "
-      Ghost::Host.empty!
-      puts "Done."
-      exit 0
-    when 'export'
-      hosts = Ghost::Host.list
-      hosts.each do |host|
-        puts "#{host.name} #{host.ip}"
-      end
-      exit 0
-    when 'import'
-      if ARGV.size == 2
-        begin
-          import_file = open(ARGV[1])
-          import_file.each_line do |line|
-            host_infos = line.strip.split(' ', 2)
-            host = Ghost::Host.add(*host_infos)
-            puts "  [Adding] #{host.name} -> #{host.ip}"
-          end
-          exit 0
-        rescue
-          $stderr.puts "Cannot import. A problem occured while opening the import file."
-          exit 5
-        end
-      else
-        $stderr.puts "The import command requires an input file.\n\n"
-        help_text 6
-      end
-    else
-      $stderr.puts "Invalid option: #{ARGV[0]}"
-      help_text 1
-    end
-  end
-rescue Errno::EACCES
-  $stderr.puts "Please re-run as root or using sudo"
-  exit 3
-end
+Ghost::Cli.new.parse

data/lib/ghost.rb

@@ -1,22 +1,9 @@
 $: << File.dirname(__FILE__)
 
 module Ghost
-  class RecordExists < StandardError
-  end
 end
 
-require 'rbconfig'
+require 'ghost/version'
+require 'ghost/host'
+require 'ghost/store'
 
-case RbConfig::CONFIG['host_os']
-when /darwin/
-  productVersion = `/usr/bin/sw_vers -productVersion`.strip
-  if productVersion =~ /^10\.7\.[2-9]{1}$/
-    require 'ghost/linux-host'
-  else
-    require 'ghost/mac-host'
-  end
-when /linux/
-  require 'ghost/linux-host'
-end
-
-require 'ghost/ssh_config'

data/lib/ghost/cli.rb

@@ -0,0 +1,60 @@
+require 'ghost'
+
+require 'optparse'
+require 'optparse/version'
+
+module Ghost
+  class Cli
+    attr_accessor :out, :parser
+
+    def initialize(out = STDOUT)
+      self.out  = out
+
+      setup_parser
+    end
+
+    def parse(args = ARGV)
+      parser.parse! args
+
+      arg = args.shift.to_s
+
+      if (task = tasks[arg])
+        task.perform(*args)
+      else
+        abort "No such task"
+      end
+    rescue Errno::EACCES
+      abort "Insufficient privileges. Try using `sudo` or running as root."
+    end
+
+    private
+
+    def setup_parser
+      self.parser = OptionParser.new do |o|
+        o.on_tail '-v', '--version' do
+          puts parser.ver
+          exit
+        end
+      end
+
+      parser.program_name = "ghost"
+      parser.version = Ghost::VERSION
+    end
+
+    def print(*args)
+      out.print(*args)
+    end
+
+    def puts(*args)
+      out.puts(*args)
+    end
+
+    # TODO: should output to STDERR
+    def abort(*args)
+      puts *args
+      exit 1
+    end
+  end
+end
+
+require 'ghost/cli/task'

data/lib/ghost/cli/task.rb

@@ -0,0 +1,71 @@
+require 'unindent'
+
+module Ghost
+  class Cli
+    class Task
+      attr_accessor :out
+
+      class << self
+        attr_accessor :name
+
+        def desc(str = nil)
+          if str
+            @desc = str
+          else
+            @desc
+          end
+        end
+
+        def help
+          if block_given?
+            @help = yield.unindent
+          else
+            @help
+          end
+        end
+      end
+
+      def initialize(out)
+        self.out = out
+      end
+
+      def perform(*); end
+      def description; end
+      def help; end
+
+      private
+
+      def puts(*args)
+        out.puts(*args)
+      end
+
+      def print(*args)
+        out.print(*args)
+      end
+
+      def abort(*args)
+        out.puts(*args)
+        exit 1
+      end
+    end
+
+    def tasks
+      @tasks ||= Hash[self.class.tasks.map { |name, task| [name, task.new(out)] }]
+    end
+
+    class << self
+      def task(*names, &block)
+        task = Class.new(Task, &block)
+        names.map!(&:to_s)
+        task.name = names.first
+        names.each { |name| tasks[name] = task }
+      end
+
+      def tasks
+        @tasks ||= {}
+      end
+    end
+  end
+end
+
+Dir[File.dirname(__FILE__) + "/task/*.rb"].each { |f| require(f) }

data/lib/ghost/cli/task/add.rb

@@ -0,0 +1,25 @@
+Ghost::Cli.task :add do
+  desc "Add a host"
+  def perform(host, ip = nil)
+    host = Ghost::Host.new(*[host, ip].compact)
+    Ghost.store.add(host)
+    puts "[Adding] #{host.name} -> #{host.ip}"
+  rescue Ghost::Host::NotResolvable
+    abort "Unable to resolve IP address for target host #{ip.inspect}."
+  end
+
+  help do
+    <<-EOF.unindent
+    Usage: ghost add <local host name> [<remote host name>|<IP address>]
+
+    #{desc}.
+
+    If a second parameter is not provided, it defaults to 127.0.0.1
+
+    Examples:
+      ghost add my-localhost          # points to 127.0.0.1
+      ghost add google.dev google.com # points to the IP of google.com
+      ghost add router 192.168.1.1    # points to 192.168.1.1
+    EOF
+  end
+end

data/lib/ghost/cli/task/delete.rb

@@ -0,0 +1,30 @@
+Ghost::Cli.task :delete, :rm, :del, :remove do
+  desc "Remove a ghost-managed host"
+  def perform(host)
+    host = /#{$1}/i if %r[^/(.+)/$] =~ host
+    Ghost.store.delete(host)
+  end
+
+  help do
+    <<-EOF.unindent
+    Usage: ghost delete <host name|regex>
+
+    #{desc}.
+
+    The delete task accepts either a literal host name, or a regular
+    expression, notated with surrounding forward slashes (/). If a
+    host name is provided, it will delete only the entries whose host
+    names are equal to the provided host name. If a regular expression
+    is provided, all entries whose host names match the regular
+    expression will be deleted.
+
+    Depending on your shell, you may need to escape or quote the
+    regular expression to ensure that the shell doesn't perform
+    expansion on the expression.
+
+    Examples:
+      ghost delete foo.com       # will delete foo.com
+      ghost delete /^fo+\\.com$/  # will delete fo.com, fooooo.com, etc.
+    EOF
+  end
+end

data/lib/ghost/cli/task/empty.rb

@@ -0,0 +1,18 @@
+Ghost::Cli.task :empty do
+  desc "Clear all ghost-managed hosts"
+
+  def perform
+    print "[Emptying] "
+    Ghost.store.empty
+    puts "Done."
+  end
+
+  help do
+    <<-EOF.unindent
+    Usage: ghost empty
+
+    The empty task will delete all ghost-managed hosts from
+    the host store.
+    EOF
+  end
+end

data/lib/ghost/cli/task/export.rb

@@ -0,0 +1,19 @@
+Ghost::Cli.task :export do
+  desc "Export all hosts in /etc/hosts format"
+  def perform
+    Ghost.store.all.each do |host|
+      puts "#{host.ip} #{host.name}"
+    end
+  end
+
+  help do
+    <<-EOF.unindent
+    Usage: ghost export
+
+    #{desc}.
+
+    The export will be printed to standard out.
+    EOF
+  end
+end
+

data/lib/ghost/cli/task/help.rb

@@ -0,0 +1,41 @@
+Ghost::Cli.task :help, nil do
+  def perform(name=nil)
+    return overview unless name
+
+    task = tasks_by_name[name]
+    abort "No help for task '#{name}'" unless task && task.help
+
+    puts task.help
+  end
+
+  private
+
+  def overview
+    puts "USAGE: ghost <task> [<args>]"
+    puts ""
+    puts "The ghost tasks are:"
+
+    tasks_to_show do |name, desc|
+      puts "  #{name}     #{desc}"
+    end
+
+    puts ""
+    puts "See 'ghost help <task>' for more information on a specific task."
+  end
+
+  def tasks_by_name
+    Ghost::Cli.tasks
+  end
+
+  def tasks
+    tasks_by_name.values.uniq
+  end
+
+  def tasks_to_show
+    size = tasks.map { |t| t.name.length }.max
+    tasks.sort_by(&:name).each do |task|
+      next unless task.desc
+      yield task.name.ljust(size), task.desc
+    end
+  end
+end

data/lib/ghost/cli/task/import.rb

@@ -0,0 +1,25 @@
+Ghost::Cli.task :import do
+  desc "Import hosts in /etc/hosts format"
+  def perform(*files)
+    files.each do |file|
+      File.readlines(file).each do |line|
+        ip, name = *line.split(/\s+/)
+        host = Ghost::Host.new(name, ip)
+        Ghost.store.add(host)
+        puts "[Adding] #{host.name} -> #{host.ip}"
+      end
+    end
+  end
+
+  help do
+    <<-EOF.unindent
+    Usage: ghost import file1 [file2 [file3 ...]]
+
+    #{desc}.
+
+    Each file provided will be read in as an import file. The
+    behavior for duplicate or conflicting entries is not currently
+    defined.
+    EOF
+  end
+end