devdnsd 1.0.0

data/.gitignore

@@ -0,0 +1,21 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+
+# RubyMine
+.idea/

data/.yardopts

@@ -0,0 +1 @@
+--exclude lib/devdnsd/patches/.+ --exclude utils/ -m markdown

data/Gemfile

@@ -0,0 +1,9 @@
+# encoding: utf-8
+#
+# This file is part of the devdnsd gem. Copyright (C) 2012 and above Shogun <shogun_panda@me.com>.
+# Licensed under the MIT license, which can be found at http://www.opensource.org/licenses/mit-license.php.
+#
+
+source "http://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,93 @@
+PATH
+  remote: .
+  specs:
+    devdnsd (1.0.0)
+      cowtech-extensions (~> 2.1.0)
+      gli (~> 1.6.0)
+      rainbow (~> 1.1.0)
+      rexec (~> 1.4.1)
+      rubydns (~> 0.4.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionpack (3.2.6)
+      activemodel (= 3.2.6)
+      activesupport (= 3.2.6)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.1)
+      rack (~> 1.4.0)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.1.3)
+    activemodel (3.2.6)
+      activesupport (= 3.2.6)
+      builder (~> 3.0.0)
+    activesupport (3.2.6)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    builder (3.0.0)
+    coderay (1.0.7)
+    cowtech-extensions (2.1.3)
+      actionpack (~> 3.0)
+      tzinfo (~> 0.3.33)
+    diff-lcs (1.1.3)
+    erubis (2.7.0)
+    eventmachine (0.12.10)
+    github-markup (0.7.2)
+    gli (1.6.0)
+    hike (1.2.1)
+    i18n (0.6.0)
+    journey (1.0.4)
+    method_source (0.8)
+    multi_json (1.3.6)
+    net-dns (0.7.1)
+    pry (0.9.10)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.3.1)
+    rack (1.4.1)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    rainbow (1.1.4)
+    redcarpet (2.1.1)
+    rexec (1.4.1)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.0)
+    rspec-expectations (2.11.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.1)
+    rubydns (0.4.1)
+      eventmachine
+      rexec
+    simplecov (0.6.4)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.5.3)
+    simplecov-html (0.5.3)
+    slop (3.3.2)
+    sprockets (2.1.3)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    tilt (1.3.3)
+    tzinfo (0.3.33)
+    yard (0.8.2.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  devdnsd!
+  github-markup (~> 0.7.0)
+  net-dns (~> 0.7.0)
+  pry (~> 0.9.9)
+  redcarpet (~> 2.1.0)
+  rspec (~> 2.11.0)
+  simplecov (~> 0.6.0)
+  yard (~> 0.8.0)

data/README.md

@@ -0,0 +1,79 @@
+# devdnsd
+
+A small DNS server to enable local .dev domain resolution.
+http://github.com/ShogunPanda/devdnsd
+
+## Description
+
+DevDNSd is a small DNS server which add a resolver to the system only for single TLD (by default, **.dev**). This way you can access your local application by typing every kind of url, i.e. *locallapp.dev*.
+
+Of course, DevDNSd is inspired by [pow](https://github.com/37signals/pow), but it only provides DNS functionalities, delegating the setup of a web-server to the user.
+
+## Basic usage
+
+1. Install the gem:
+
+	`gem install devdnsd`
+
+2. Install the service:
+
+	`devdnsd install`
+
+**You're done!**
+
+## Advanced usage
+
+Just type `devdns help` and you'll see all available options.
+
+## Configuration
+
+By defaults, DevDNSd uses a configuration file in `~/.devdnsd_config`, but you can change the path using the `--config` switch.
+
+The file is a plain Ruby file with a single `config` object that supports the following directives.
+
+* `foreground`: If run the application in foreground.
+* `address`: The IP to bind, 0.0.0.0 by default.
+* `port`: The port to bind, 7771 by default.
+* `tld`: The TLD to handle.
+* `log_file`: The default log file. Not used if run in foreground.
+* `log_level`: The default log level. Valid values are from 0 to 5 where 0 means "all messages".
+* `add_rule`: Add a rule to the server. See section *Rules* below.
+
+## Rules
+
+DevDNSd has a nice rules system for matching name.
+You can add rules by calling `config.add_rule(...)` into the configuration file.
+
+The first argument of the function is the name you want to match. You can use regular expressions and this is highly recommended if you want to pass a block to the method (see below).
+
+The second argument should be the IP associated to the name. If the first argument is a regexp with groups, you can use the standard Ruby `String#gsub` substitution syntax for the reply.
+You can also use `false` to reject matching for this nameserver. In this case the next nameserver for the system will be used. You can skip this argument if you pass a block to the function.
+If you return `nil` from the block, then you'll be responsible to set the response via the [`transaction`](http://rubydoc.info/gems/rubydns/RubyDNS/Transaction) variable.
+
+The third argument can optionally be the record type for the resolv. By default is `:A`.
+This argument is ignored if you pass the block, as it assumes that the second argument is the record type.
+
+If you pass a block to the method, its return code will be taken as the result of the resolving. So if you return `false` then the resolving will be rejected. The block takes three arguments, `match`, `type` and `transaction`. If you used regular expression for the first argument, then `match` will contain all the match information for the name.
+
+For some examples of rules, see the `config/devdnsd_config.sample` file into the repository.
+
+## Remarks
+
+DevDNSd as a local resolver is tightly coupled with the OSX name resolution system, so it is only available for MacOSX.
+
+You can, anyway, run the software as DNS server.
+
+## Contributing to devdns
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (C) 2012 and above Shogun <[shogun_panda@me.com](mailto:shogun_panda@me.com)>.
+Licensed under the MIT license, which can be found at [http://www.opensource.org/licenses/mit-license.php](http://www.opensource.org/licenses/mit-license.php).

data/Rakefile

@@ -0,0 +1,18 @@
+# encoding: utf-8
+#
+# This file is part of the cowtech-extensions gem. Copyright (C) 2011 and above Shogun <shogun_panda@me.com>.
+# Licensed under the MIT license, which can be found at http://www.opensource.org/licenses/mit-license.php.
+#
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new("spec")
+
+namespace :spec do
+  desc "Run all specs with coverage"
+  task :coverage do
+    ENV["DEVDNSD_COVERAGE"] = "TRUE"
+    Rake::Task["spec"].invoke
+  end
+end

data/bin/devdnsd

@@ -0,0 +1,77 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+#
+# This file is part of the devdnsd gem. Copyright (C) 2012 and above Shogun <shogun_panda@me.com>.
+# Licensed under the MIT license, which can be found at http://www.opensource.org/licenses/mit-license.php.
+#
+
+require "rubygems"
+require "devdnsd"
+
+# TODO: Replace GLI with another library.
+
+include GLI
+program_desc("A small DNS server to enable local domain resolution.")
+version(DevDNSd::Version::STRING)
+
+desc("Do not ask any confirmation.")
+switch([:f, :force])
+
+desc("The TLD to handle.")
+default_value("dev")
+arg_name("TLD")
+flag([:t,:tld])
+
+desc("The port to bind.")
+default_value(7771)
+arg_name("PORT")
+flag([:p,:port])
+
+desc("The default configuration file.")
+default_value("~/.devdnsd_config")
+arg_name("FILE")
+flag([:c, :config])
+
+desc("The default log file. Not used if run in foreground.")
+default_value("/var/log/devdnsd.log")
+arg_name("LOG")
+flag([:l, :log])
+
+desc("The default log level. Valid values are from 0 to 5 where 0 means \"all messages\".")
+default_value(1)
+arg_name("LEVEL")
+flag([:L, :log_level])
+
+desc("Starts the server.")
+command [:s, :start] do |c|
+  c.desc("Do not daemonize.")
+  c.switch [:n, :foreground]
+
+  c.action do |globals, locals, args|
+    DevDNSd::Application.instance(globals, locals, args).action_start()
+  end
+end
+
+desc("Stops the server.")
+command [:t, :stop] do |c|
+  c.action do |globals, locals, args|
+    DevDNSd::Application.instance(globals, locals, args).action_stop()
+  end
+end
+
+desc("Install the server.")
+command [:i, :install] do |c|
+  c.action do |globals, locals, args|
+    DevDNSd::Application.instance(globals, locals, args).action_install()
+  end
+end
+
+desc("Uninstall the server.")
+command [:u, :uninstall] do |c|
+  c.action do |globals, locals, args|
+    DevDNSd::Application.instance(globals, locals, args).action_uninstall()
+  end
+end
+
+ARGV << "help" if ARGV.length == 0
+exit(GLI.run(ARGV))

data/config/devdnsd_config.sample

@@ -0,0 +1,24 @@
+config.add_rule("match_1.dev", "10.0.1.1")
+
+config.add_rule("match_2.dev", "10.0.2.1", :MX)
+
+config.add_rule("match_3.dev") do "10.0.3.1" end
+
+config.add_rule("match_4.dev", :CNAME) do "10.0.4.1" end
+
+
+config.add_rule(/match_5_(\d+)\.dev/, "10.0.5.$1")
+
+config.add_rule(/match_6_(\d+).dev/, "10.0.6.$1", :PTR)
+
+config.add_rule(/match_7_(\d+).dev/) do "10.0.7.$1" end
+
+config.add_rule(/match_8_(\d+).dev/, :PTR) do "10.0.8.$1" end
+
+
+config.add_rule("match_9.dev") do false end
+
+config.add_rule("match_10.dev", [:A, :MX]) do |match, type, transaction| type == :A ? "10.0.10.1" : "10.0.10.2" end
+
+
+config.add_rule("quit.dev") do DevDNSd::Application.quit end

data/devdnsd.gemspec

@@ -0,0 +1,40 @@
+# encoding: utf-8
+#
+# This file is part of the devdnsd gem. Copyright (C) 2012 and above Shogun <shogun_panda@me.com>.
+# Licensed under the MIT license, which can be found at http://www.opensource.org/licenses/mit-license.php.
+#
+
+require "./lib/devdnsd/version"
+
+Gem::Specification.new do |gem|
+  gem.name = "devdnsd"
+  gem.version = DevDNSd::Version::STRING
+  gem.authors = ["Shogun"]
+  gem.email = ["shogun_panda@me.com"]
+  gem.homepage = "http://github.com/ShogunPanda/devdnsd"
+  gem.summary = %q{A small DNS server to enable local domain resolution.}
+  gem.description = %q{A small DNS server to enable local domain resolution.}
+
+  gem.rubyforge_project = "devdnsd"
+  gem.files = `git ls-files`.split("\n")
+  gem.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.require_paths = ["lib"]
+  #gem.platform = Gem::Platform::CURRENT
+
+  gem.add_dependency("rubydns", "~> 0.4.0")
+  gem.add_dependency("cowtech-extensions", "~> 2.1.0")
+  gem.add_dependency("gli", "~> 1.6.0")
+  gem.add_dependency("rexec", "~> 1.4.1")
+  gem.add_dependency("rainbow", "~> 1.1.0")
+
+  gem.add_development_dependency("rspec", "~> 2.11.0")
+  gem.add_development_dependency("simplecov", "~> 0.6.0")
+  gem.add_development_dependency("pry", "~> 0.9.9")
+  gem.add_development_dependency("net-dns", "~> 0.7.0")
+  gem.add_development_dependency("yard", "~> 0.8.0")
+  gem.add_development_dependency("redcarpet", "~> 2.1.0")
+  gem.add_development_dependency("github-markup", "~> 0.7.0")
+end
+
+

data/lib/devdnsd.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+#
+# This file is part of the devdns gem. Copyright (C) 2012 and above Shogun <shogun_panda@me.com>.
+# Licensed under the MIT license, which can be found at http://www.opensource.org/licenses/mit-license.php.
+#
+
+require "rubygems"
+require "rubydns"
+require "gli"
+require "rexec/daemon"
+require "pathname"
+require "rainbow"
+require "cowtech-extensions"
+require "rbconfig"
+
+Cowtech::Extensions.load!
+
+require "devdnsd/application"
+require "devdnsd/configuration"
+require "devdnsd/errors"
+require "devdnsd/logger"
+require "devdnsd/rule"
+require "devdnsd/version" if !defined?(DevDNSd::Version)

data/lib/devdnsd/application.rb

@@ -0,0 +1,366 @@
+# encoding: utf-8
+#
+# This file is part of the devdns gem. Copyright (C) 2012 and above Shogun <shogun_panda@me.com>.
+# Licensed under the MIT license, which can be found at http://www.opensource.org/licenses/mit-license.php.
+#
+
+# A small DNS server to enable local .dev domain resolution.
+module DevDNSd
+  # The main DevDNSd application.
+  class Application < RExec::Daemon::Base
+    # Class for ANY DNS request.
+    ANY_REQUEST = Resolv::DNS::Resource::IN::ANY
+
+    # List of classes handled in case of DNS request with resource class ANY.
+    ANY_CLASSES = [Resolv::DNS::Resource::IN::A, Resolv::DNS::Resource::IN::AAAA, Resolv::DNS::Resource::IN::ANY, Resolv::DNS::Resource::IN::CNAME, Resolv::DNS::Resource::IN::HINFO, Resolv::DNS::Resource::IN::MINFO, Resolv::DNS::Resource::IN::MX, Resolv::DNS::Resource::IN::NS, Resolv::DNS::Resource::IN::PTR, Resolv::DNS::Resource::IN::SOA, Resolv::DNS::Resource::IN::TXT]
+
+    # The {Configuration Configuration} of this application.
+    attr_reader :config
+
+    # The arguments passed via command-line.
+    attr_reader :args
+
+    # The {Logger Logger} for this application.
+    attr_accessor :logger
+
+    # Creates a new application.
+    #
+    # @param globals [Hash] Global options.
+    # @param locals [Hash] Local command options.
+    # @param args [Array] Extra arguments.
+    def initialize(globals = {}, locals = {}, args = [])
+      @args = {
+        :global => globals,
+        :local => locals,
+        :args => args
+      }
+
+      # Setup logger
+      DevDNSd::Logger.start_time = Time.now
+      @logger = DevDNSd::Logger.create(DevDNSd::Logger.get_real_file(@args[:global][:log_file]) || DevDNSd::Logger.default_file, Logger::INFO)
+
+      # Open configuration
+      begin
+        @config = DevDNSd::Configuration.new(@args[:global][:config], self, {
+          :foreground => @args[:local][:foreground],
+          :log_file => @args[:global][:log_file],
+          :log_level => @args[:global][:log_level],
+          :tld => @args[:global][:tld],
+          :port => @args[:global][:port]
+        })
+        @logger = nil
+        @logger = self.get_logger
+
+      rescue DevDNSd::Errors::InvalidConfiguration, DevDNSd::Errors::InvalidRule => e
+        @logger.fatal(e.message)
+        raise SystemExit
+      end
+
+      self
+    end
+
+    # Check if we are running on MacOS X.
+    # System services are only available on that platform.
+    #
+    # @return [Boolean] `true` if the current platform is MacOS X, `false` otherwise.
+    def is_osx?
+      Config::CONFIG['host_os'] =~ /^darwin/
+    end
+
+    # Gets the current logger of the application.
+    #
+    # @return [Logger] The current logger of the application.
+    def get_logger
+      @logger ||= DevDNSd::Logger.create(@config.foreground ? DevDNSd::Logger.default_file : @config.log_file, @config.log_level, @log_formatter)
+    end
+
+    # Gets the path for the resolver file.
+    #
+    # @param tld [String] The TLD to manage.
+    # @return [String] The path for the resolver file.
+    def resolver_path(tld = nil)
+      tld ||= @config.tld
+      "/etc/resolver/#{tld}"
+    end
+
+    # Gets the path for the launch agent file.
+    #
+    # @param name [String] The base name for the agent.
+    # @return [String] The path for the launch agent file.
+    def launch_agent_path(name = "it.cowtech.devdnsd")
+      ENV["HOME"] + "/Library/LaunchAgents/#{name}.plist"
+    end
+
+    # Executes a shell command.
+    #
+    # @param command [String] The command to execute.
+    # @return [Boolean] `true` if command succeeded, `false` otherwise.
+    def execute_command(command)
+      system(command)
+    end
+
+    # Updates DNS cache.
+    #
+    # @return [Boolean] `true` if command succeeded, `false` otherwise.
+    def dns_update
+      @logger.info("Flushing DNS cache and resolvers ...")
+      self.execute_command("dscacheutil -flushcache")
+    end
+
+    # Starts the DNS server.
+    #
+    # @return [Object] The result of stop callbacks.
+    def perform_server
+      RubyDNS::run_server(:listen => [[:udp, @config.address, @config.port.to_integer]]) do
+        self.logger = Application.instance.logger
+
+        match(/.+/, Application::ANY_REQUEST) do |match_data, transaction|
+          transaction.append_question!
+
+          Application.instance.config.rules.each do |rule|
+            begin
+              # Get the subset of handled class that is valid for the rule
+              resource_classes = Application::ANY_CLASSES & rule.resource_class.ensure_array
+
+              if resource_classes.present? then
+                resource_classes.each do |resource_class| # Now for every class
+                  matches = rule.match_host(match_data[0])
+                  Application.instance.process_rule(rule, resource_class, rule.is_regexp? ? matches : nil, transaction) if matches
+                end
+              end
+            rescue Exception => e
+              raise e
+            end
+          end
+        end
+
+        # Default DNS handler
+        otherwise do |transaction|
+          transaction.failure!(:NXDomain)
+        end
+
+        # Attach event handlers
+        self.on(:start) do
+          Application.instance.on_start
+        end
+
+        self.on(:stop) do
+          Application.instance.on_stop
+        end
+      end
+    end
+
+    # Processes a DNS rule.
+    #
+    # @param rule [Rule] The rule to process.
+    # @param type [Class] The type of request.
+    # @param match_or_transaction [MatchData|nil] If the rule pattern was a Regexp, then this holds the match data, otherwise `nil` is passed.
+    # @param transaction [Transaction] The current DNS transaction (http://rubydoc.info/gems/rubydns/RubyDNS/Transaction).
+    # @return A reply for the request if matched, otherwise `false` or `nil`.
+    def process_rule(rule, type, match_data, transaction)
+      is_regex = rule.match.is_a?(Regexp)
+      type = DevDNSd::Rule.resource_class_to_symbol(type)
+
+      Application.instance.logger.debug("Found match on #{rule.match} with type #{type}.")
+
+      if !rule.block.nil? then
+        reply = rule.block.call(match_data, type, transaction)
+      else
+        reply = rule.reply
+      end
+
+      if is_regex && reply && match_data[0] then
+        reply = match_data[0].gsub(rule.match, reply.gsub("$", "\\"))
+      end
+
+      Application.instance.logger.debug(reply ? "Reply is #{reply} with type #{type}." : "No reply found.")
+
+      if reply then
+        options = rule.options
+
+        final_reply = []
+
+        case type
+          when :MX
+            preference = options.delete(:preference)
+            preference = 10 if !preference.is_integer?
+            final_reply << preference
+        end
+
+        if [:A, :AAAA].include?(type) then
+          final_reply << reply
+        else
+          final_reply << Resolv::DNS::Name.create(reply)
+        end
+
+        final_reply << options.merge({:resource_class => DevDNSd::Rule.symbol_to_resource_class(type)})
+        transaction.respond!(*final_reply)
+      elsif reply == false then
+        false
+      else
+        reply
+      end
+    end
+
+    # Starts the server in background.
+    #
+    # @return [Boolean] `true` if action succedeed, `false` otherwise.
+    def action_start
+      logger = self.get_logger
+
+      logger.info("Starting DevDNSd ...")
+
+      if @config.foreground then
+        self.perform_server
+      else
+        RExec::Daemon::Controller.start(self.class)
+      end
+
+      true
+    end
+
+    # Stops the server in background.
+    #
+    # @return [Boolean] `true` if action succedeed, `false` otherwise.
+    def action_stop
+      RExec::Daemon::Controller.stop(self.class)
+
+      true
+    end
+
+    # Installs the server into the system.
+    #
+    # @return [Boolean] `true` if action succedeed, `false` otherwise.
+    def action_install
+      logger = get_logger
+
+      if !self.is_osx? then
+        logger.fatal("Install DevDNSd as a local resolver is only available on MacOSX.")
+        return false
+      end
+
+      resolver_file = self.resolver_path
+      launch_agent = self.launch_agent_path
+
+      # Installs the resolver
+      begin
+        logger.info("Installing the resolver in #{resolver_file} ...")
+
+        open(resolver_file, "w") {|f|
+          f.write("nameserver 127.0.0.1\n")
+          f.write("port #{@config.port}")
+          f.flush
+        }
+      rescue => e
+        logger.error("Cannot create the resolver file.")
+        return false
+      end
+
+      begin
+        logger.info("Creating the launch agent in #{launch_agent} ...")
+
+        args = $ARGV ? $ARGV[0, $ARGV.length - 1] : ["A"]
+
+        plist = {"KeepAlive" => true, "Label" => "it.cowtech.devdnsd", "Program" => (Pathname.new(Dir.pwd) + $0).to_s, "ProgramArguments" => args, "RunAtLoad" => true}
+        File.open(launch_agent, "w") {|f|
+          f.write(plist.to_json)
+          f.flush
+        }
+        self.execute_command("plutil -convert binary1 \"#{launch_agent}\"")
+      rescue => e
+        logger.error("Cannot create the launch agent.")
+        return false
+      end
+
+      begin
+        logger.info("Loading the launch agent ...")
+        self.execute_command("launchctl load -w \"#{launch_agent}\" > /dev/null 2>&1")
+      rescue => e
+        logger.error("Cannot load the launch agent.")
+        return false
+      end
+
+      self.dns_update
+
+      true
+    end
+
+    # Uninstalls the server from the system.
+    #
+    # @return [Boolean] `true` if action succedeed, `false` otherwise.
+    def action_uninstall
+      logger = self.get_logger
+
+      if !self.is_osx? then
+        logger.fatal("Install DevDNSd as a local resolver is only available on MacOSX.")
+        return false
+      end
+
+      resolver_file = self.resolver_path
+      launch_agent = self.launch_agent_path
+
+      # Remove the resolver
+      begin
+        logger.info("Deleting the resolver #{resolver_file} ...")
+        File.delete(resolver_file)
+      rescue => e
+        logger.warn("Cannot delete the resolver file.")
+        return false
+      end
+
+      # Unload the launch agent.
+      begin
+        self.execute_command("launchctl unload -w \"#{launch_agent}\" > /dev/null 2>&1")
+      rescue => e
+        logger.warn("Cannot unload the launch agent.")
+      end
+
+      # Delete the launch agent.
+      begin
+        logger.info("Deleting the launch agent #{launch_agent} ...")
+        File.delete(launch_agent)
+      rescue => e
+        logger.warn("Cannot delete the launch agent.")
+        return false
+      end
+
+      self.dns_update
+
+      true
+    end
+
+    # This method is called when the server starts. By default is a no-op.
+    #
+    # @return [NilClass] `nil`.
+    def on_start
+    end
+
+    # This method is called when the server stop.
+    #
+    # @return [NilClass] `nil`.
+    def on_stop
+    end
+
+    # Returns a unique (singleton) instance of the application.
+    # @param globals [Hash] Global options.
+    # @param locals [Hash] Local command options.
+    # @param args [Array] Extra arguments.
+    # @return [Application] The unique (singleton) instance of the application.
+    def self.instance(globals = {}, locals = {}, args = [], force = false)
+      @@instance = nil if force
+      @@instance ||= Application.new(globals, locals, args)
+    end
+
+    # Runs the application in foreground.
+    #
+    # @see #perform_server
+    def self.run
+      self.instance.perform_server
+    end
+
+    # Stops the application.
+    def self.quit
+      EventMachine.stop
+    end
+  end
+end