heel 0.2.0

data/lib/heel/error_handler.rb

@@ -0,0 +1,27 @@
+require 'heel'
+require 'erb'
+
+module Heel
+
+    class ErrorHandler < ::Mongrel::HttpHandler
+
+        attr_reader :template
+
+        def initialize(options = {})
+            @template = ::ERB.new File.read(File.join(APP_RESOURCE_DIR,"error.rhtml"))
+        end
+
+        def process(request,response)
+            status = response.status
+            if status != 200 then 
+                message = ::Mongrel::HTTP_STATUS_CODES[status]
+                base_uri = ::Mongrel::HttpRequest.unescape(request.params[Mongrel::Const::REQUEST_URI])
+
+                response.start(status) do |head,out|
+                    head['Content-Type'] = 'text/html'
+                    out.write(template.result(binding))
+                end
+            end
+        end
+    end
+end

data/lib/heel/gemspec.rb

@@ -0,0 +1,49 @@
+require 'rubygems'
+require 'heel/specification'
+require 'heel/version'
+require 'rake'
+
+module Heel
+    SPEC = Heel::Specification.new do |spec|
+                spec.name               = "heel"
+                spec.version            = Heel::VERSION
+                spec.rubyforge_project  = "copiousfreetime"
+                spec.author             = "Jeremy Hinegardner"
+                spec.email              = "jeremy@hinegardner.org"
+                spec.homepage           = "http://copiousfreetime.rubyforge.org/heel/"
+
+                spec.summary            = "A mongrel based static file webserver."
+                spec.description        = <<-DESC
+                Heel is a mongrel based webserver to quickly and easily
+                serve up the contents of a directory as webpages.
+                DESC
+
+                spec.extra_rdoc_files   = FileList["CHANGES", "LICENSE", "README"]
+                spec.has_rdoc           = true
+                spec.rdoc_main          = "README"
+                spec.rdoc_options       = [ "--line-numbers" , "--inline-source" ]
+
+                spec.test_files         = FileList["spec/**/*.rb"]
+                spec.executable         = spec.name
+                spec.files              = spec.test_files + spec.extra_rdoc_files + 
+                                          FileList["lib/**/*.rb", "resources/**/*"]
+
+                spec.add_dependency("mongrel", ">= 1.0.1")
+                spec.add_dependency("launchy", ">= 0.1.2")
+                spec.add_dependency("mime-types", ">= 1.15")
+                
+                spec.required_ruby_version  = ">= 1.8.5"
+
+                spec.platform = Gem::Platform::RUBY
+
+                spec.remote_user        = "jjh"
+                spec.local_rdoc_dir     = "doc/rdoc"
+                spec.remote_rdoc_dir    = ""
+                spec.local_coverage_dir = "doc/coverage"
+
+                spec.remote_site_dir    = "#{spec.name}/"
+
+           end
+end
+
+

data/lib/heel/server.rb

@@ -0,0 +1,216 @@
+require 'heel'
+require 'ostruct'
+require 'daemons/daemonize'
+require 'launchy'
+require 'tmpdir'
+require 'fileutils'
+
+module Heel
+    class Server
+
+        attr_accessor :options
+        attr_accessor :parsed_options
+
+        attr_reader :stdout
+        attr_reader :stderr
+        attr_reader :stdin
+        
+      
+        class << self
+            # thank you Jamis - from Capistrano
+            def home_directory # :nodoc:
+                ENV["HOME"] ||
+                    (ENV["HOMEPATH"] && "#{ENV["HOMEDRIVE"]}#{ENV["HOMEPATH"]}") ||
+                    "/"
+            end
+        end
+
+        DEFAULT_DIRECTORY = File.join(home_directory,".heel")
+        DEFAULT_PID_FILE  = File.join(DEFAULT_DIRECTORY,"heel.pid")
+        DEFAULT_LOG_FILE  = File.join(DEFAULT_DIRECTORY,"heel.log")
+
+        def initialize(argv = [])
+            argv ||= []
+
+            set_io
+            
+            @options        = default_options
+            @parsed_options = ::OpenStruct.new
+            @parser         = option_parser
+            @error_message  = nil
+
+            begin
+                @parser.parse!(argv)
+            rescue ::OptionParser::ParseError => pe
+                msg = ["#{@parser.program_name}: #{pe}",
+                        "Try `#{@parser.program_name} --help` for more information"]
+                @error_message = msg.join("\n")
+            end
+        end
+
+        def default_options
+            if @default_options.nil? then
+                @default_options                 = ::OpenStruct.new
+                @default_options.show_version    = false
+                @default_options.show_help       = false
+                @default_options.address         = "0.0.0.0"
+                @default_options.port            = 4331
+                @default_options.document_root   = Dir.pwd
+                @default_options.daemonize       = false
+                @default_options.kill            = false
+            end
+            return @default_options
+        end
+
+        def option_parser
+            OptionParser.new do |op|
+                op.separator ""
+
+                op.on("-a", "--address ADDRESS", "Address to bind to",
+                                        "(default: #{default_options.address})") do |add|
+                    @parsed_options.address = add
+                end
+
+                op.on("-d", "--daemonize", "Run daemonized in the background") do 
+                    @parsed_options.daemonize = true
+                end
+
+                op.on("-h", "--help", "Display this text") do 
+                    @parsed_options.show_help = true
+                end
+                
+                op.on("-k", "--kill", "Kill an existing daemonized heel process") do
+                    @parsed_options.kill = true
+                end
+
+                op.on("-p", "--port PORT", Integer, "Port to bind to",
+                                        "(default: #{default_options.port})") do |port|
+                    @parsed_options.port = port
+                end
+
+                op.on("-r","--root ROOT", 
+                      "Set the document root"," (default: #{default_options.document_root})") do |document_root|
+                    @parsed_options.document_root = File.expand_path(document_root)
+                    raise ::OptionParser::ParseError, "#{@parsed_options.document_root} is not a valid directory" if not File.directory?(@parsed_options.document_root)
+               end
+
+                op.on("-v", "--version", "Show version") do 
+                    @parsed_options.show_version = true
+                end
+            end
+        end
+
+        def merge_options
+            options = default_options.marshal_dump
+            @parsed_options.marshal_dump.each_pair do |key,value|
+                options[key] = value
+            end
+
+            @options = OpenStruct.new(options)
+        end
+
+        # set the IO objects in a single method call.  This is really only for testing 
+        # instrumentation
+        def set_io(stdin = $stdin, stdout = $stdout ,setderr = $stderr)
+            @stdin  = stdin
+            @stdout = stdout
+            @stderr = stderr
+        end
+
+        # if Version or Help options are set, then output the appropriate information instead of 
+        # running the server.
+        def error_version_help_kill
+            if @parsed_options.show_version then
+                @stdout.puts "#{@parser.program_name}: version #{Heel::VERSION}"
+                exit 0
+            elsif @parsed_options.show_help then
+                @stdout.puts @parser.to_s
+                exit 0
+            elsif @error_message then
+                @stdout.puts @error_message
+                exit 1
+            elsif @parsed_options.kill then
+                kill_existing_proc
+            end
+        end
+        
+        # kill an already running background heel process
+        def kill_existing_proc
+            if File.exists?(DEFAULT_PID_FILE) then
+                begin
+                    pid = open(DEFAULT_PID_FILE).read.to_i
+                    @stdout.puts "Sending TERM to process #{pid}"
+                    Process.kill("TERM", pid)
+                rescue Errno::ESRCH
+                    @stdout.puts "Process does not exist. Removing stale pid file."
+                    File.unlink(DEFAULT_PID_FILE)
+                end
+            else
+                @stdout.puts "No pid file exists, no process to kill"
+            end
+            @stdout.puts "Done."
+            exit 0
+        end
+           
+        # setup the directory that heel will use as the location to run from, where its logs will
+        # be stored and its PID file if backgrounded.
+        def setup_heel_dir
+            if not File.exists?(DEFAULT_DIRECTORY) then
+                FileUtils.mkdir_p(DEFAULT_DIRECTORY)
+                @stdout.puts "Created #{DEFAULT_DIRECTORY}"
+                @stdout.puts "PID file #{DEFAULT_PID_FILE} is stored here"
+                @stdout.puts "along with the log #{DEFAULT_LOG_FILE}"
+            end
+        end
+
+        # run the heel server with the current options.
+        def run
+            
+            error_version_help_kill
+            merge_options
+            setup_heel_dir
+            
+            document_root = options.document_root
+            background_me = options.daemonize
+            stats = ::Mongrel::StatisticsFilter.new(:sample_rate => 1)
+            config = ::Mongrel::Configurator.new :host => options.address, :port => options.port, :pid_file => DEFAULT_PID_FILE do
+                if background_me then
+                    if File.exists?(DEFAULT_PID_FILE) then
+                        log "ERROR: PID File #{DEFAULT_PID_FILE} already exists.  Heel may already be running."
+                        log "ERROR: Check the Log file #{DEFAULT_LOG_FILE}"
+                        log "ERROR: Heel will not start until the .pid file is cleared."
+                        exit 1
+                    end
+                    daemonize({:cwd => DEFAULT_DIRECTORY, :log_file => DEFAULT_LOG_FILE})
+                end
+                
+                listener do
+                    uri "/", :handler => stats
+                    uri "/", :handler => Heel::DirHandler.new({:document_root => document_root})
+                    uri "/", :handler => Heel::ErrorHandler.new
+                    uri "/icons", :handler => Heel::DirHandler.new({ :document_root => 
+                                                                          File.join(APP_RESOURCE_DIR, "famfamfam", "icons")})
+                    uri "/status", :handler => ::Mongrel::StatusHandler.new(:stats_filter => stats)
+                end
+
+                setup_signals
+            end
+            
+            config.run
+            config.log "heel running at http://#{options.address}:#{options.port} with document root #{options.document_root}"
+                        
+            if background_me then
+                config.write_pid_file
+            else
+                config.log "Use Ctrl-C to stop."
+            end
+            
+            config.log "Launching your browser..."
+            ::Launchy.do_magic("http://#{options.address}:#{options.port}/")
+            
+            config.join
+            
+        end
+        
+    end
+end

data/lib/heel/specification.rb

@@ -0,0 +1,128 @@
+require 'rubygems'
+require 'rubygems/specification'
+require 'rake'
+
+module Heel
+    # Add some additional items to Gem::Specification
+    # A Heel::Specification adds additional pieces of information the
+    # typical gem specification
+    class Specification 
+
+        RUBYFORGE_ROOT = "/var/www/gforge-projects/"
+      
+        # user that accesses remote site
+        attr_accessor :remote_user
+
+        # remote host, default 'rubyforge.org'
+        attr_accessor :remote_host
+
+        # name the rdoc main
+        attr_accessor :rdoc_main
+
+        # local directory in development holding the generated rdoc
+        # default 'doc'
+        attr_accessor :local_rdoc_dir
+
+        # remote directory for storing rdoc, default 'doc'
+        attr_accessor :remote_rdoc_dir
+
+        # local directory for coverage report
+        attr_accessor :local_coverage_dir
+        
+        # remote directory for storing coverage reports
+        # This defaults to 'coverage'
+        attr_accessor :remote_coverage_dir
+
+        # local directory for generated website, default +site/public+
+        attr_accessor :local_site_dir
+       
+        # remote directory relative to +remote_root+ for the website.
+        # website.
+        attr_accessor :remote_site_dir
+
+        # is a .tgz to be created?, default 'true'
+        attr_accessor :need_tar
+
+        # is a .zip to be created, default 'true'
+        attr_accessor :need_zip
+
+
+        def initialize
+            @remote_user = nil
+            @remote_host = "rubyforge.org"
+
+            @rdoc_main              = "README"
+            @local_rdoc_dir         = "doc"
+            @remote_rdoc_dir        = "doc"
+            @local_coverage_dir     = "coverage"
+            @remote_coverage_dir    = "coverage"
+            @local_site_dir         = "site/public"
+            @remote_site_dir        = "."
+            
+            @need_tar   = true
+            @need_zip   = true
+
+            @spec                   = Gem::Specification.new
+
+            yield self if block_given?
+
+            # update rdoc options to take care of the rdoc_main if it is
+            # there, and add a default title if one is not given
+            if not @spec.rdoc_options.include?("--main") then
+                @spec.rdoc_options.concat(["--main", rdoc_main])
+            end
+
+            if not @spec.rdoc_options.include?("--title") then
+                @spec.rdoc_options.concat(["--title","'#{name} -- #{summary}'"])
+            end
+        end
+
+        # if this gets set then it overwrites what would be the
+        # rubyforge default.  If rubyforge project is not set then use
+        # name.  If rubyforge project and name are set, but they are
+        # different then assume that name is a subproject of the
+        # rubyforge project
+        def remote_root 
+            if rubyforge_project.nil? or 
+                rubyforge_project == name then
+                return RUBYFORGE_ROOT + "#{name}/"
+            else
+                return RUBYFORGE_ROOT + "#{rubyforge_project}/#{name}/"
+            end
+        end
+
+        # rdoc files is the same as what would be generated during gem
+        # installation. That is, everything in the require paths plus
+        # the extra_rdoc_files
+        #
+        def rdoc_files 
+            flist = extra_rdoc_files.dup
+            @spec.require_paths.each do |rp|
+                flist << FileList["#{rp}/**/*.rb"]
+            end
+            flist.flatten.uniq
+        end
+
+        # calculate the remote directories
+        def remote_root_location
+            "#{remote_user}@#{remote_host}:#{remote_root}"
+        end
+           
+        def remote_rdoc_location
+            remote_root_location + @remote_rdoc_dir
+        end
+
+        def remote_coverage_location
+            remote_root_loation + @remote_coverage_dir
+        end
+
+        def remote_site_location
+            remote_root_location + @remote_site_dir
+        end
+
+        # we delegate any other calls to spec
+        def method_missing(method_id,*params,&block)
+            @spec.send method_id, *params, &block
+        end
+    end
+end

data/lib/heel/version.rb

@@ -0,0 +1,21 @@
+require 'heel'
+
+module Heel
+    class Version
+        MAJOR   = 0 
+        MINOR   = 2 
+        BUILD   = 0 
+
+        class << self
+            def to_a
+                [MAJOR, MINOR, BUILD]
+            end
+
+            def to_s
+                to_a.join(".")
+            end
+        end
+    end 
+    VERSION = Version.to_s
+end
+

data/resources/error.rhtml

@@ -0,0 +1,68 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
+    <head>
+        <title>Error <%= status %> </title>
+        <style type="text/css">
+            body { font-family: Verdana, Arial, Helvetica, sans-serif; background-color: #e0e0e0;}
+            div.wrap { 
+                background: transparent;
+                text-align: left;
+                width: 400px;
+                margin-top: 100px;
+                margin-left: auto;
+                margin-right: auto;
+            }
+            div.box {
+                border-left: 1px solid #333;
+                border-right: 1px solid #333;
+                background: #FFF;
+                display: block;
+            }
+            img { padding-right: 20px;} 
+            h1 { display: inline; font-weight: bold; }
+            h2 { display: inline; font-weight: bold; padding-left: 25px;text-align: center;}
+            div.header { font-size: x-large; }
+            div.content { font-size: x-large; border: 0; padding: 10px 25px 10px 25px;}
+            div.footer { text-align: right; width: 400px; }
+
+            .curved { background: transparent;}
+            .curved .c1, .curved .c2, .curved .c3, .curved .c4 {
+                display: block;
+                overflow: hidden;
+                height: 1px;
+                font-size: 1px;
+            }
+            .curved .c2, .curved .c3, .curved .c4 {
+                background: #fff;
+                border-left: 1px solid #000;
+                border-right: 1px solid #000;
+            }
+            .c1 { margin: 0 5px 0 5px; background: #000; }
+            .c2 { margin: 0 3px 0 3px; border-left: 2px solid #000; border-right: 2px solid #000; }
+            .c3 { margin: 0 2px 0 2px; }
+            .c4 { margin: 0 1px 0 1px; }
+        </style>
+    </head>
+    <body>
+        <div class="wrap">
+            <div class="header">
+                Requested URL: <%= base_uri %>
+            </div>
+            <div class="curved">
+                <b class="c1"></b><b class="c2"></b><b class="c3"></b><b class="c4"></b> 
+                <div class="box">
+                    <div class="content">
+                        <img src="/icons/error.png"><h1>Error <%= status %></h1>
+                        <br />
+                        <h2><%= message %></h2>
+                    </div>
+                </div>
+                <b class="c4"></b><b class="c3"></b><b class="c2"></b><b class="c1"></b>
+            </div>
+            <div class="footer">
+                <a href="<%= Heel::SPEC::homepage %>">heel</a>/v<%= Heel::VERSION %>
+            </div>
+        </div>
+    </body>
+</html>