dnsruby 1.1

data/EVENTMACHINE

@@ -0,0 +1,64 @@
+Using the Dnsruby EventMachine code
+===============================================================
+
+Dnsruby can use either its inbuilt (pure Ruby) event loop, or
+EventMachine (a native extension to Ruby which must be installed
+on the local platform).
+
+
+Configuring Dnsruby to use EventMachine
+----------------------------------------------------------------
+
+I left a couple of switches in Dnsruby::Resolver :
+
+    Dnsruby::Resolver.use_eventmachine(on=true)
+    Dnsruby::Resolver.start_eventmachine_loop(on=true)
+
+The first of these tells Dnsruby to use EventMachine, rather
+ than its own event loop.
+
+The second tells Dnsruby whether to start the EventMachine loop
+or not. 
+
+If standard Dnsruby client code is used, then Dnsruby needs to 
+call EventMachine::run{} in order to start the EventMachine loop.
+However, if more than one EventMachine loop is started in a Ruby
+process, then the process terminates. 
+
+So, if client code is written in an EventMachine style, contained
+in an EventMachine::run{} call, then it will need to tell Dnsruby 
+NOT to start the EventMachine loop (on pain of sudden death!).
+
+
+
+Example code
+----------------------------------------------------------------
+
+Here is an example of using the code in an EventMachine style :
+
+require 'Dnsruby'
+require 'eventmachine'
+res = Dnsruby::Resolver.new
+Dnsruby::Resolver.use_eventmachine
+Dnsruby::Resolver.start_eventmachine_loop(false)
+EventMachine::run {
+  df = res.send_async(Dnsruby::Message.new("example.com"))
+  df.callback {|msg| 
+     puts "Response : #{msg}"
+     EM.stop}
+  df.errback {|msg, err|
+     puts "Response : #{msg}"
+     puts "Error: #{err}"
+     EM.stop}
+}
+
+And an example in a normal Dnsruby style :
+
+require 'Dnsruby'
+res = Dnsruby::Resolver.new
+Dnsruby::Resolver.use_eventmachine
+Dnsruby::Resolver.start_eventmachine_loop(true) # default
+q = Queue.new
+id = res.send_async(Dnsruby::Message.new("example.com"),q)
+id, response, error = q.pop
+

data/README

@@ -0,0 +1,63 @@
+Dnsruby
+=======
+
+Dnsruby is a pure Ruby DNS client library which implements a
+stub resolver. It aims to comply with all DNS RFCs, including
+DNSSEC NSEC3 support.
+
+Dnsruby presents a new API for DNS. It is based on Ruby's core
+resolv.rb Resolv API, but has been much extended to provide a
+complete DNS implementation.
+
+Dnsruby runs a single I/O thread to handle all concurrent
+queries. It is also able to use EventMachine if it is installed.
+It is therefore suitable for high volume DNS applications.
+
+The following is a (non-exhaustive) list of features :
+
+o Implemented RRs :  A, AAAA, AFSDB, ANY, CERT, CNAME, DNAME,
+     HINFO, ISDN, LOC, MB, MG, MINFO, MR, MX, NAPTR, NS, NSAP,
+     OPT, PTR, PX, RP, RT, SOA, SPF, SRV, TKEY, TSIG, TXT, WKS,
+     X25
+
+o Generic RR types supported (RFC3597)
+
+o (Signed) Zone transfer (AXFR and IXFR) supported
+
+o (Signed) Dyamic updates supported
+
+o DNSSEC support in progress
+
+Dependencies
+============
+
+Dnsruby can run with no dependencies. However, if you wish to
+use TSIG or DNSSEC then the OpenSSL library must be available.
+This is a part of the Ruby standard library, but appears not to
+be present on all Ruby platforms. If it is not available, then 
+the test code will not run the tests which require it. Code which
+attempts to use the library (if it is not present) will raise an
+exception.
+
+If EventMachine is to be used, then the EventMachine library must
+be present on the platform. If the EventMachine library is not 
+present then the test code will not run the EventMachine tests.
+
+Demo code
+=========
+
+The demo folder contains some example programs using Dnsruby.
+These examples include 
+
+Online tests
+============
+
+Nominet operate a test server which the Dnsruby test code queries.
+If this server is not available then some of the online tests will 
+not be run.
+
+
+Contact
+=======
+
+Use dnsruby rubyforge forums, or contact : alexd@nominet.org.uk

data/doc/classes/Dnsruby.html

@@ -0,0 +1,463 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>Module: Dnsruby</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+
+    elemStyle = elem.style;
+    
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+
+    return true;
+  }
+  
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  
+  // ]]>
+  </script>
+
+</head>
+<body>
+
+
+
+    <div id="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Module</strong></td>
+          <td class="class-name-in-header">Dnsruby</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../files/lib/Dnsruby/code_mapper_rb.html">
+                lib/Dnsruby/code_mapper.rb
+                </a>
+        <br />
+                <a href="../files/lib/Dnsruby/Config_rb.html">
+                lib/Dnsruby/Config.rb
+                </a>
+        <br />
+                <a href="../files/lib/Dnsruby/DNS_rb.html">
+                lib/Dnsruby/DNS.rb
+                </a>
+        <br />
+                <a href="../files/lib/Dnsruby/dnssec_rb.html">
+                lib/Dnsruby/dnssec.rb
+                </a>
+        <br />
+                <a href="../files/lib/Dnsruby/event_machine_interface_rb.html">
+                lib/Dnsruby/event_machine_interface.rb
+                </a>
+        <br />
+                <a href="../files/lib/Dnsruby/Hosts_rb.html">
+                lib/Dnsruby/Hosts.rb
+                </a>
+        <br />
+                <a href="../files/lib/Dnsruby/ipv4_rb.html">
+                lib/Dnsruby/ipv4.rb
+                </a>
+        <br />
+                <a href="../files/lib/Dnsruby/ipv6_rb.html">
+                lib/Dnsruby/ipv6.rb
+                </a>
+        <br />
+                <a href="../files/lib/Dnsruby/message_rb.html">
+                lib/Dnsruby/message.rb
+                </a>
+        <br />
+                <a href="../files/lib/Dnsruby/name_rb.html">
+                lib/Dnsruby/name.rb
+                </a>
+        <br />
+                <a href="../files/lib/Dnsruby/Resolver_rb.html">
+                lib/Dnsruby/Resolver.rb
+                </a>
+        <br />
+                <a href="../files/lib/Dnsruby/resource/A_rb.html">
+                lib/Dnsruby/resource/A.rb
+                </a>
+        <br />
+                <a href="../files/lib/Dnsruby/resource/AAAA_rb.html">
+                lib/Dnsruby/resource/AAAA.rb
+                </a>
+        <br />
+                <a href="../files/lib/Dnsruby/resource/AFSDB_rb.html">
+                lib/Dnsruby/resource/AFSDB.rb
+                </a>
+        <br />
+                <a href="../files/lib/Dnsruby/resource/CERT_rb.html">
+                lib/Dnsruby/resource/CERT.rb
+                </a>
+        <br />
+                <a href="../files/lib/Dnsruby/resource/DNSKEY_rb.html">
+                lib/Dnsruby/resource/DNSKEY.rb
+                </a>
+        <br />
+                <a href="../files/lib/Dnsruby/resource/domain_name_rb.html">
+                lib/Dnsruby/resource/domain_name.rb
+                </a>
+        <br />
+                <a href="../files/lib/Dnsruby/resource/DS_rb.html">
+                lib/Dnsruby/resource/DS.rb
+                </a>
+        <br />
+                <a href="../files/lib/Dnsruby/resource/generic_rb.html">
+                lib/Dnsruby/resource/generic.rb
+                </a>
+        <br />
+                <a href="../files/lib/Dnsruby/resource/HINFO_rb.html">
+                lib/Dnsruby/resource/HINFO.rb
+                </a>
+        <br />
+                <a href="../files/lib/Dnsruby/resource/IN_rb.html">
+                lib/Dnsruby/resource/IN.rb
+                </a>
+        <br />
+                <a href="../files/lib/Dnsruby/resource/ISDN_rb.html">
+                lib/Dnsruby/resource/ISDN.rb
+                </a>
+        <br />
+                <a href="../files/lib/Dnsruby/resource/LOC_rb.html">
+                lib/Dnsruby/resource/LOC.rb
+                </a>
+        <br />
+                <a href="../files/lib/Dnsruby/resource/MINFO_rb.html">
+                lib/Dnsruby/resource/MINFO.rb
+                </a>
+        <br />
+                <a href="../files/lib/Dnsruby/resource/MX_rb.html">
+                lib/Dnsruby/resource/MX.rb
+                </a>
+        <br />
+                <a href="../files/lib/Dnsruby/resource/NAPTR_rb.html">
+                lib/Dnsruby/resource/NAPTR.rb
+                </a>
+        <br />
+                <a href="../files/lib/Dnsruby/resource/NSAP_rb.html">
+                lib/Dnsruby/resource/NSAP.rb
+                </a>
+        <br />
+                <a href="../files/lib/Dnsruby/resource/NSEC_rb.html">
+                lib/Dnsruby/resource/NSEC.rb
+                </a>
+        <br />
+                <a href="../files/lib/Dnsruby/resource/NSEC3_rb.html">
+                lib/Dnsruby/resource/NSEC3.rb
+                </a>
+        <br />
+                <a href="../files/lib/Dnsruby/resource/NSEC3PARAM_rb.html">
+                lib/Dnsruby/resource/NSEC3PARAM.rb
+                </a>
+        <br />
+                <a href="../files/lib/Dnsruby/resource/OPT_rb.html">
+                lib/Dnsruby/resource/OPT.rb
+                </a>
+        <br />
+                <a href="../files/lib/Dnsruby/resource/PX_rb.html">
+                lib/Dnsruby/resource/PX.rb
+                </a>
+        <br />
+                <a href="../files/lib/Dnsruby/resource/resource_rb.html">
+                lib/Dnsruby/resource/resource.rb
+                </a>
+        <br />
+                <a href="../files/lib/Dnsruby/resource/RP_rb.html">
+                lib/Dnsruby/resource/RP.rb
+                </a>
+        <br />
+                <a href="../files/lib/Dnsruby/resource/RRSIG_rb.html">
+                lib/Dnsruby/resource/RRSIG.rb
+                </a>
+        <br />
+                <a href="../files/lib/Dnsruby/resource/RT_rb.html">
+                lib/Dnsruby/resource/RT.rb
+                </a>
+        <br />
+                <a href="../files/lib/Dnsruby/resource/SOA_rb.html">
+                lib/Dnsruby/resource/SOA.rb
+                </a>
+        <br />
+                <a href="../files/lib/Dnsruby/resource/SPF_rb.html">
+                lib/Dnsruby/resource/SPF.rb
+                </a>
+        <br />
+                <a href="../files/lib/Dnsruby/resource/SRV_rb.html">
+                lib/Dnsruby/resource/SRV.rb
+                </a>
+        <br />
+                <a href="../files/lib/Dnsruby/resource/TKEY_rb.html">
+                lib/Dnsruby/resource/TKEY.rb
+                </a>
+        <br />
+                <a href="../files/lib/Dnsruby/resource/TSIG_rb.html">
+                lib/Dnsruby/resource/TSIG.rb
+                </a>
+        <br />
+                <a href="../files/lib/Dnsruby/resource/TXT_rb.html">
+                lib/Dnsruby/resource/TXT.rb
+                </a>
+        <br />
+                <a href="../files/lib/Dnsruby/resource/X25_rb.html">
+                lib/Dnsruby/resource/X25.rb
+                </a>
+        <br />
+                <a href="../files/lib/Dnsruby/select_thread_rb.html">
+                lib/Dnsruby/select_thread.rb
+                </a>
+        <br />
+                <a href="../files/lib/Dnsruby/SingleResolver_rb.html">
+                lib/Dnsruby/SingleResolver.rb
+                </a>
+        <br />
+                <a href="../files/lib/Dnsruby/TheLog_rb.html">
+                lib/Dnsruby/TheLog.rb
+                </a>
+        <br />
+                <a href="../files/lib/Dnsruby/update_rb.html">
+                lib/Dnsruby/update.rb
+                </a>
+        <br />
+                <a href="../files/lib/Dnsruby/zone_transfer_rb.html">
+                lib/Dnsruby/zone_transfer.rb
+                </a>
+        <br />
+                <a href="../files/lib/dnsruby_rb.html">
+                lib/dnsruby.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+
+        </table>
+    </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+
+
+  <div id="contextContent">
+
+    <div id="description">
+      <h1><a href="Dnsruby.html">Dnsruby</a> library</h1>
+<p>
+<a href="Dnsruby.html">Dnsruby</a> is a thread-aware <a
+href="Dnsruby/DNS.html">DNS</a> stub resolver library written in Ruby.
+</p>
+<p>
+It is based on resolv.rb, the standard Ruby <a
+href="Dnsruby/DNS.html">DNS</a> implementation, but gives a complete <a
+href="Dnsruby/DNS.html">DNS</a> implementation, including DNSSEC.
+</p>
+<p>
+The <a href="Dnsruby/Resolv.html">Resolv</a> class can be used to resolve
+addresses using /etc/hosts and /etc/resolv.conf, or the <a
+href="Dnsruby/DNS.html">DNS</a> class can be used to make <a
+href="Dnsruby/DNS.html">DNS</a> queries. These interfaces will attempt to
+apply the default domain and searchlist when resolving names.
+</p>
+<p>
+The <a href="Dnsruby/Resolver.html">Resolver</a> and <a
+href="Dnsruby/SingleResolver.html">SingleResolver</a> interfaces allow
+finer control of individual messages. The <a
+href="Dnsruby/Resolver.html">Resolver</a> class sends queries to multiple
+resolvers using various retry mechanisms. The <a
+href="Dnsruby/SingleResolver.html">SingleResolver</a> class is used by <a
+href="Dnsruby/Resolver.html">Resolver</a> to send individual Messages to
+individual resolvers.
+</p>
+<p>
+<a href="Dnsruby/Resolver.html">Resolver</a> queries return <a
+href="Dnsruby/Message.html">Dnsruby::Message</a> objects. <a
+href="Dnsruby/Message.html">Message</a> objects have five sections:
+</p>
+<ul>
+<li>The header section, a <a href="Dnsruby/Header.html">Dnsruby::Header</a>
+object.
+
+</li>
+<li>The question section, a list of <a
+href="Dnsruby/Question.html">Dnsruby::Question</a> objects.
+
+</li>
+<li>The answer section, a list of Dnsruby::Resource objects.
+
+</li>
+<li>The authority section, a list of Dnsruby::Resource objects.
+
+</li>
+<li>The additional section, a list of Dnsruby::Resource objects.
+
+</li>
+</ul>
+<h2>example</h2>
+<pre>
+  p Dnsruby::Resolv.getaddress(&quot;www.ruby-lang.org&quot;)
+  p Dnsruby::Resolv.getname(&quot;210.251.121.214&quot;)
+
+  Dnsruby::DNS.open {|dns|
+    p dns.getresources(&quot;www.ruby-lang.org&quot;, Dnsruby::Types.A).collect {|r| r.address}
+    p dns.getresources(&quot;ruby-lang.org&quot;, 'MX').collect {|r| [r.exchange.to_s, r.preference]}
+  }
+</pre>
+<h2>exceptions</h2>
+<ul>
+<li><a href="Dnsruby/ResolvError.html">ResolvError</a> &lt; StandardError
+
+</li>
+<li><a href="Dnsruby/ResolvTimeout.html">ResolvTimeout</a> &lt; TimeoutError
+
+</li>
+<li><a href="Dnsruby/NXDomain.html">NXDomain</a> &lt; <a
+href="Dnsruby/ResolvError.html">ResolvError</a>
+
+</li>
+<li><a href="Dnsruby/FormErr.html">FormErr</a> &lt; <a
+href="Dnsruby/ResolvError.html">ResolvError</a>
+
+</li>
+<li><a href="Dnsruby/ServFail.html">ServFail</a> &lt; <a
+href="Dnsruby/ResolvError.html">ResolvError</a>
+
+</li>
+<li><a href="Dnsruby/NotImp.html">NotImp</a> &lt; <a
+href="Dnsruby/ResolvError.html">ResolvError</a>
+
+</li>
+<li><a href="Dnsruby/Refused.html">Refused</a> &lt; <a
+href="Dnsruby/ResolvError.html">ResolvError</a>
+
+</li>
+<li><a href="Dnsruby/OtherResolvError.html">OtherResolvError</a> &lt; <a
+href="Dnsruby/ResolvError.html">ResolvError</a>
+
+</li>
+</ul>
+<h2>I/O</h2>
+<p>
+<a href="Dnsruby.html">Dnsruby</a> implements a pure Ruby event loop to
+perform I/O. <a href="Dnsruby.html">Dnsruby</a> can also use EventMachine
+to perform I/O, if it is available on the platform - but it must be enabled
+through the <a href="Dnsruby/Resolver.html">Dnsruby::Resolver</a> class
+</p>
+<h2>DNSSEC</h2>
+<p>
+<a href="Dnsruby.html">Dnsruby</a> supports DNSSEC and NSEC3. DNSSEC
+support is on by default, but applications which wish to verify responses
+locally will need to make explicit verification calls. See <a
+href="Dnsruby/Dnssec.html">Dnsruby::Dnssec</a> for more details.
+</p>
+<h2>Bugs</h2>
+<ul>
+<li>NIS is not supported.
+
+</li>
+<li>/etc/nsswitch.conf is not supported.
+
+</li>
+<li><a href="Dnsruby/IPv6.html">IPv6</a> is not supported.
+
+</li>
+</ul>
+
+    </div>
+
+
+   </div>
+
+
+  </div>
+
+
+    <!-- if includes -->
+
+    <div id="section">
+
+    <div id="class-list">
+      <h3 class="section-bar">Classes and Modules</h3>
+
+      Class <a href="Dnsruby/Algorithms.html" class="link">Dnsruby::Algorithms</a><br />
+Class <a href="Dnsruby/Classes.html" class="link">Dnsruby::Classes</a><br />
+Class <a href="Dnsruby/CodeMapper.html" class="link">Dnsruby::CodeMapper</a><br />
+Class <a href="Dnsruby/Config.html" class="link">Dnsruby::Config</a><br />
+Class <a href="Dnsruby/DNS.html" class="link">Dnsruby::DNS</a><br />
+Class <a href="Dnsruby/DecodeError.html" class="link">Dnsruby::DecodeError</a><br />
+Class <a href="Dnsruby/Dnssec.html" class="link">Dnsruby::Dnssec</a><br />
+Class <a href="Dnsruby/EncodeError.html" class="link">Dnsruby::EncodeError</a><br />
+Class <a href="Dnsruby/FormErr.html" class="link">Dnsruby::FormErr</a><br />
+Class <a href="Dnsruby/Header.html" class="link">Dnsruby::Header</a><br />
+Class <a href="Dnsruby/Hosts.html" class="link">Dnsruby::Hosts</a><br />
+Class <a href="Dnsruby/IPv4.html" class="link">Dnsruby::IPv4</a><br />
+Class <a href="Dnsruby/IPv6.html" class="link">Dnsruby::IPv6</a><br />
+Class <a href="Dnsruby/Message.html" class="link">Dnsruby::Message</a><br />
+Class <a href="Dnsruby/MetaTypes.html" class="link">Dnsruby::MetaTypes</a><br />
+Class <a href="Dnsruby/Modes.html" class="link">Dnsruby::Modes</a><br />
+Class <a href="Dnsruby/NXDomain.html" class="link">Dnsruby::NXDomain</a><br />
+Class <a href="Dnsruby/Name.html" class="link">Dnsruby::Name</a><br />
+Class <a href="Dnsruby/NotImp.html" class="link">Dnsruby::NotImp</a><br />
+Class <a href="Dnsruby/OpCode.html" class="link">Dnsruby::OpCode</a><br />
+Class <a href="Dnsruby/OtherResolvError.html" class="link">Dnsruby::OtherResolvError</a><br />
+Class <a href="Dnsruby/QTypes.html" class="link">Dnsruby::QTypes</a><br />
+Class <a href="Dnsruby/Question.html" class="link">Dnsruby::Question</a><br />
+Class <a href="Dnsruby/RCode.html" class="link">Dnsruby::RCode</a><br />
+Class <a href="Dnsruby/RR.html" class="link">Dnsruby::RR</a><br />
+Class <a href="Dnsruby/RRSet.html" class="link">Dnsruby::RRSet</a><br />
+Class <a href="Dnsruby/Refused.html" class="link">Dnsruby::Refused</a><br />
+Class <a href="Dnsruby/Resolv.html" class="link">Dnsruby::Resolv</a><br />
+Class <a href="Dnsruby/ResolvError.html" class="link">Dnsruby::ResolvError</a><br />
+Class <a href="Dnsruby/ResolvTimeout.html" class="link">Dnsruby::ResolvTimeout</a><br />
+Class <a href="Dnsruby/Resolver.html" class="link">Dnsruby::Resolver</a><br />
+Class <a href="Dnsruby/ServFail.html" class="link">Dnsruby::ServFail</a><br />
+Class <a href="Dnsruby/SingleResolver.html" class="link">Dnsruby::SingleResolver</a><br />
+Class <a href="Dnsruby/TheLog.html" class="link">Dnsruby::TheLog</a><br />
+Class <a href="Dnsruby/Types.html" class="link">Dnsruby::Types</a><br />
+Class <a href="Dnsruby/Update.html" class="link">Dnsruby::Update</a><br />
+Class <a href="Dnsruby/VerifyError.html" class="link">Dnsruby::VerifyError</a><br />
+Class <a href="Dnsruby/ZoneTransfer.html" class="link">Dnsruby::ZoneTransfer</a><br />
+
+    </div>
+
+
+
+
+      
+
+
+    <!-- if method_list -->
+
+
+  </div>
+
+
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>