hoster 0.1.2

data/README.md

@@ -0,0 +1,56 @@
+Hoster
+=====
+
+Summary
+-------
+
+A *cross-platform* gem that allows you to create, list, and modify local hostnames with ease. This gem was inspired by (and largely based on) the [ghost gem](http://github.com/bjeanes/ghost/tree/master) by Bodaniel Jeanes.
+
+Hoster directly modifies the *hosts* file on you machine to add/remove entries. Because of this, Hoster must be executed as root user (or via *sudo*)
+
+
+Usage
+-----
+
+    $ hoster add testsite.com (defaults to 127.0.0.1)
+      
+    $ hoster add testsite.com 192.168.1.150
+      
+    $ hoster modify testsite.com 192.168.1.149
+      
+    $ hoster remove testsite.com
+      
+    $ hoster list (prints entire hosts file)
+    
+    $ hoster list 127.0.0.1
+
+
+Installation
+------------
+
+    sudo gem install sant0sk1-hoster --source http://gems.github.com/
+
+
+License
+-------
+
+Copyright (c) 2009 Jerod Santo
+
+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/bin/hoster

@@ -0,0 +1,72 @@
+#!/usr/bin/env ruby
+#
+#  Created by Jerod Santo on 2009-01-13
+#  Copyright (c) 2009. All rights reserved.
+
+begin
+  require 'rubygems'
+  require 'hoster'
+rescue LoadError
+  # no rubygems to load, so we fail silently
+end
+
+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} remove <hostname>
+       #{script_name} list [<ip>=all]
+"""
+  exit(exit_code)
+end
+
+if ARGV.size.zero? || ['-h', '--help', 'help'].include?(ARGV.first)
+  help_text
+else
+  hosts = Hosts.new()
+  case ARGV[0]
+  when 'add':
+    if ARGV.size == 2
+      ARGV.shift
+      hosts.add(ARGV[0])
+      hosts.display
+      exit 0
+    elsif ARGV.size == 3
+      ARGV.shift
+      hosts.add(ARGV[0],ARGV[1])
+      hosts.display(ARGV[1])
+    else
+      $stderr.puts "The 'add' command requires at least a hostname.\n\n"
+      help_text 2
+    end
+  when 'modify':
+    if ARGV.size == 3
+      ARGV.shift
+      hosts.modify(ARGV[0],ARGV[1])
+      hosts.display(ARGV[1])
+      exit 0
+    else
+      $stderr.puts "The 'modify' command requires a hostname and an IP.\n\n"
+      help_text 4
+    end
+  when 'remove':
+    if ARGV.size == 2
+      hosts.remove(ARGV[1])
+      puts "  Removed #{ARGV[1]}"
+      exit 0
+    else  
+      $stderr.puts "The 'remove' command requires a hostname.\n\n"
+      help_text 2
+    end
+  when 'list':
+    if ARGV.size == 2
+      hosts.display(ARGV[1])
+    else
+      puts hosts.dump
+    end
+    exit 0
+  else
+    $stderr.puts "Invalid option: #{ARGV[0]}"
+    help_text 1
+  end
+end

data/lib/hoster/hosts.rb

@@ -0,0 +1,106 @@
+class Hosts
+
+  # disclaimer: I didn't test this because I didn't have windows around.
+  if RUBY_PLATFORM =~ /mswin32/
+    @@default_hosts_path = 'C:\WINDOWS\system32\drivers\etc\hosts'
+  else
+    @@default_hosts_path = '/etc/hosts'
+  end
+
+  attr_reader :entries
+
+  def initialize(hosts_path = @@default_hosts_path)
+    @hosts_path = hosts_path
+    @entries    = extract_entries
+  end
+
+  def dump
+    File.open(@hosts_path,"r") { |f| f.read }
+  end
+
+  def add(host, ip_address = "127.0.0.1")
+    if @entries.has_key?(ip_address)
+      @entries[ip_address] << host
+    else
+      @entries[ip_address] = [host]
+    end
+    write_changes!
+  end
+
+  def remove(host)
+    @entries.each_pair { |key,value| value.delete_if { |v| v == host } }
+    write_changes!
+  end
+  
+  def modify(host, ip_address)
+    host_exists = false
+    @entries.each_value { |v| host_exists = true if v.include?(host) }
+    if host_exists
+      remove(host)
+      add(host,ip_address)
+    else
+      raise "#{host} does not exist. Please use 'add' command instead."
+    end
+  end
+  
+  def display(ip_address="127.0.0.1")
+    puts "  #{ip_address} = #{@entries.values_at(ip_address).join(' ')}\n"
+  end
+
+  private
+
+  def extract_entries
+    entries = Hash.new
+    File.open(@hosts_path,"r").each do |line|
+      if line =~ /^(\d+\.\d+\.\d+\.\d+) (.*)/
+        ip_address = $1
+        hosts_list = $2.split(' ')
+        if entries.has_key?(ip_address)
+          hosts_list.each do |host|
+            entries[ip_address] << host
+          end
+        else
+          entries[ip_address] = hosts_list
+        end
+      end
+    end
+    entries
+  end
+  
+  def write_changes!
+    @entries.each do |entry|
+      append_this     = true
+      entry_exists    = false
+
+      begin
+        File.open(@hosts_path,"r+") do |file|
+          lines = file.readlines
+          lines.each_with_index do |line,index|
+            if line =~ /#{entry.first}/
+              if entry_exists || entry.last.empty?
+                lines.delete_at(index)
+              else
+                lines[index] = "#{entry.first} #{entry.last.join(' ')}\n"
+                # update the state of this entry
+                append_this  = false
+                entry_exists = true
+              end
+            end
+          end
+          file.pos = 0
+          file.print lines
+          file.truncate(file.pos)
+        end
+        if append_this && !entry.last.empty?
+          File.open(@hosts_path,"a") do |file|
+            file.print "#{entry.first} #{entry.last.join(' ')}\n"
+          end
+        end
+    rescue Errno::EACCES
+      puts "You do not have permission to edit #{@hosts_path}. Run as root or use 'sudo'"
+      exit 1
+    end
+    end
+  end
+
+end

data/lib/hoster.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH << File.dirname(__FILE__)
+require 'hoster/hosts'

data/test/test_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'lib')
+require 'hoster'

data/test/test_hoster.rb

@@ -0,0 +1,90 @@
+require File.dirname(__FILE__) + '/test_helper'
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+BaseFile = <<CONTENT
+127.0.0.1 localhost
+127.0.1.1 localhost
+192.168.1.1 router.com router
+192.168.1.2 localhost
+127.0.0.1 test.com
+192.168.1.2 local.host
+CONTENT
+
+ModifiedFile = <<CONTENT
+127.0.0.1 localhost test.com test.dev
+127.0.1.1 localhost
+192.168.1.1 router router.org
+192.168.1.2 localhost local.host
+192.165.0.1 test.net
+CONTENT
+
+class TestHoster < Test::Unit::TestCase
+  context "Reading and parsing hosts file" do
+    setup do
+      File.open("test/hosts","w") do |file|
+        file.puts BaseFile
+      end
+      @hoster = Hosts.new("test/hosts")
+    end
+
+    should "create an object that stores a Hash" do
+      assert_kind_of Hash, @hoster.entries
+    end
+
+    should "assign ip addresses as hash keys" do
+      assert @hoster.entries.has_key?("127.0.0.1")
+    end
+
+    should "store a hosts array as hash values" do
+      assert_kind_of Array, @hoster.entries.values.first
+    end
+
+    should "map multiple hosts to ip addresses on the same line" do
+      assert_equal "router.com", @hoster.entries["192.168.1.1"].first
+      assert_equal "router", @hoster.entries["192.168.1.1"].last
+    end
+
+    should "map multiple hosts to same ip address on different lines" do
+      assert_equal "localhost", @hoster.entries["127.0.0.1"].first
+      assert_equal "test.com", @hoster.entries["127.0.0.1"].last
+    end
+
+  end
+
+  context "Manipulating hosts file" do
+    setup do
+      File.open("test/hosts","w") do |file|
+        file.puts BaseFile
+      end
+      @hoster = Hosts.new("test/hosts")
+    end
+
+    should "add a host to the correct line for specified ip address" do
+      assert_equal 2, @hoster.entries["192.168.1.1"].size
+      @hoster.add("router.org","192.168.1.1")
+      assert_equal 3, @hoster.entries["192.168.1.1"].size
+    end
+
+    should "remove correct host from line for specified ip address" do
+      assert_equal 2, @hoster.entries["192.168.1.1"].size
+      @hoster.remove("router.com")
+      assert_equal 1, @hoster.entries["192.168.1.1"].size
+      assert_equal "router", @hoster.entries["192.168.1.1"].first
+    end
+    
+    should "add a new ip address if it doesn't exist" do
+      @hoster.add("test.net","192.165.0.1")
+      assert_equal "test.net", @hoster.entries["192.165.0.1"].first
+    end
+
+    should "write correct changes to file" do
+      @hoster.add("test.dev")
+      @hoster.add("router.org","192.168.1.1")
+      @hoster.add("test.net","192.165.0.1")
+      @hoster.remove("router.com")
+      assert_equal ModifiedFile, @hoster.dump
+    end
+  end
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification 
+name: hoster
+version: !ruby/object:Gem::Version 
+  version: 0.1.2
+platform: ruby
+authors: 
+- Jerod Santo
+autorequire: hoster
+bindir: bin
+cert_chain: []
+
+date: 2009-09-26 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: 
+email: jerod.santo@gmail.com
+executables: 
+- hoster
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.md
+- bin/hoster
+- lib/hoster/hosts.rb
+- lib/hoster.rb
+has_rdoc: true
+homepage: http://github.com/sant0sk1/hoster
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+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: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Allows you to easily modify your local hosts file using one simple command
+test_files: 
+- test/test_helper.rb
+- test/test_hoster.rb