Dnsruby 0.6.0 → 1.0

data/EVENTMACHINE

@@ -60,5 +60,5 @@ 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 = q.pop
+id, response, error = q.pop
 

data/README

@@ -1,8 +1,9 @@
 Dnsruby
 =======
 
-Dnsruby is a pure Ruby DNS implementation. It aims to comply
-with all DNS RFCs, including DNSSEC NSEC3 support.
+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
@@ -16,19 +17,47 @@ 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, TKEY, TSIG,
-     TSIG,TXT, WKS, X25
+     OPT, PTR, PX, RP, RT, SOA, SPF, SRV, TKEY, TSIG, TXT, WKS,
+     X25
 
 o Generic RR types supported (RFC3597)
 
-o Zone transfer (AXFR and IXFR) supported
+o (Signed) Zone transfer (AXFR and IXFR) supported
 
-o Dyamic updates 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
+Use dnsruby rubyforge forums, or contact : alexd@nominet.org.uk

data/doc/classes/Dnsruby.html

@@ -243,7 +243,8 @@
     <div id="description">
       <h1><a href="Dnsruby.html">Dnsruby</a> library</h1>
 <p>
-<a href="Dnsruby.html">Dnsruby</a> is a resolver library written in Ruby.
+<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
@@ -273,17 +274,25 @@ individual resolvers.
 href="Dnsruby/Message.html">Dnsruby::Message</a> objects. <a
 href="Dnsruby/Message.html">Message</a> objects have five sections:
 </p>
-<pre>
- * The header section, a Dnsruby::Header object.
+<ul>
+<li>The header section, a <a href="Dnsruby/Header.html">Dnsruby::Header</a>
+object.
 
- * The question section, a list of Dnsruby::Question objects.
+</li>
+<li>The question section, a list of <a
+href="Dnsruby/Question.html">Dnsruby::Question</a> objects.
 
- * The answer section, a list of Dnsruby::Resource objects.
+</li>
+<li>The answer section, a list of Dnsruby::Resource objects.
 
- * The authority section, a list of Dnsruby::Resource objects.
+</li>
+<li>The authority section, a list of Dnsruby::Resource objects.
 
- * The additional section, a list of Dnsruby::Resource objects.
-</pre>
+</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;)
@@ -295,23 +304,45 @@ href="Dnsruby/Message.html">Message</a> objects have five sections:
   }
 </pre>
 <h2>exceptions</h2>
-<pre>
-  * ResolvError &lt; StandardError
+<ul>
+<li><a href="Dnsruby/ResolvError.html">ResolvError</a> &lt; StandardError
 
-  * ResolvTimeout &lt; TimeoutError
+</li>
+<li><a href="Dnsruby/ResolvTimeout.html">ResolvTimeout</a> &lt; TimeoutError
 
-  * NXDomain &lt; ResolvError
+</li>
+<li><a href="Dnsruby/NXDomain.html">NXDomain</a> &lt; <a
+href="Dnsruby/ResolvError.html">ResolvError</a>
 
-  * FormErr &lt; ResolvError
+</li>
+<li><a href="Dnsruby/FormErr.html">FormErr</a> &lt; <a
+href="Dnsruby/ResolvError.html">ResolvError</a>
 
-  * ServFail &lt; ResolvError
+</li>
+<li><a href="Dnsruby/ServFail.html">ServFail</a> &lt; <a
+href="Dnsruby/ResolvError.html">ResolvError</a>
 
-  * NotImp &lt; ResolvError
+</li>
+<li><a href="Dnsruby/NotImp.html">NotImp</a> &lt; <a
+href="Dnsruby/ResolvError.html">ResolvError</a>
 
-  * Refused &lt; ResolvError
+</li>
+<li><a href="Dnsruby/Refused.html">Refused</a> &lt; <a
+href="Dnsruby/ResolvError.html">ResolvError</a>
 
-  * OtherResolvError &lt; ResolvError
-</pre>
+</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>Bugs</h2>
 <ul>
 <li>NIS is not supported.

data/doc/classes/Dnsruby/Classes.html

@@ -88,8 +88,8 @@
       <h3 class="section-bar">Methods</h3>
 
       <div class="name-list">
-      <a href="#M000159">unknown_code</a>&nbsp;&nbsp;
-      <a href="#M000158">unknown_string</a>&nbsp;&nbsp;
+      <a href="#M000157">unknown_code</a>&nbsp;&nbsp;
+      <a href="#M000156">unknown_string</a>&nbsp;&nbsp;
       </div>
     </div>
 
@@ -154,12 +154,12 @@ HESIOD = 4 # RFC 1035
     <div id="methods">
       <h3 class="section-bar">Public Instance methods</h3>
 
-      <div id="method-M000159" class="method-detail">
-        <a name="M000159"></a>
+      <div id="method-M000157" class="method-detail">
+        <a name="M000157"></a>
 
         <div class="method-heading">
-          <a href="Classes.src/M000159.html" target="Code" class="method-signature"
-            onclick="popupCode('Classes.src/M000159.html');return false;">
+          <a href="Classes.src/M000157.html" target="Code" class="method-signature"
+            onclick="popupCode('Classes.src/M000157.html');return false;">
           <span class="method-name">unknown_code</span><span class="method-args">(arg)</span>
           </a>
         </div>
@@ -168,12 +168,12 @@ HESIOD = 4 # RFC 1035
         </div>
       </div>
 
-      <div id="method-M000158" class="method-detail">
-        <a name="M000158"></a>
+      <div id="method-M000156" class="method-detail">
+        <a name="M000156"></a>
 
         <div class="method-heading">
-          <a href="Classes.src/M000158.html" target="Code" class="method-signature"
-            onclick="popupCode('Classes.src/M000158.html');return false;">
+          <a href="Classes.src/M000156.html" target="Code" class="method-signature"
+            onclick="popupCode('Classes.src/M000156.html');return false;">
           <span class="method-name">unknown_string</span><span class="method-args">(arg)</span>
           </a>
         </div>

data/doc/classes/Dnsruby/Classes.src/{M000158.html → M000156.html}

@@ -10,7 +10,7 @@
   <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
 </head>
 <body class="standalone-code">
-  <pre><span class="ruby-comment cmt"># File lib/dnsruby.rb, line 131</span>
+  <pre><span class="ruby-comment cmt"># File lib/dnsruby.rb, line 132</span>
     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">unknown_string</span>(<span class="ruby-identifier">arg</span>)
       <span class="ruby-keyword kw">if</span> (<span class="ruby-identifier">arg</span><span class="ruby-operator">=~</span><span class="ruby-regexp re">/^CLASS/i</span>)
         <span class="ruby-constant">Classes</span>.<span class="ruby-identifier">add_pair</span>(<span class="ruby-identifier">arg</span>, <span class="ruby-identifier">arg</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-value str">'CLASS'</span>, <span class="ruby-value str">''</span>).<span class="ruby-identifier">to_i</span>)

data/doc/classes/Dnsruby/Classes.src/M000157.html

@@ -5,19 +5,15 @@
 
 <html>
 <head>
-  <title>unknown_string (Dnsruby::Classes)</title>
+  <title>unknown_code (Dnsruby::Classes)</title>
   <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
   <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
 </head>
 <body class="standalone-code">
-  <pre><span class="ruby-comment cmt"># File lib/dnsruby.rb, line 123</span>
-    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">unknown_string</span>(<span class="ruby-identifier">arg</span>)
-      <span class="ruby-keyword kw">if</span> (<span class="ruby-identifier">arg</span><span class="ruby-operator">=~</span><span class="ruby-regexp re">/^CLASS/i</span>)
-        <span class="ruby-constant">Classes</span>.<span class="ruby-identifier">add_pair</span>(<span class="ruby-identifier">arg</span>, <span class="ruby-identifier">arg</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-value str">'CLASS'</span>, <span class="ruby-value str">''</span>).<span class="ruby-identifier">to_i</span>)
-        <span class="ruby-identifier">set_string</span>(<span class="ruby-identifier">arg</span>)
-      <span class="ruby-keyword kw">else</span>
-        <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-node">&quot;String #{arg} not a member of #{self.class}&quot;</span>)
-      <span class="ruby-keyword kw">end</span>
+  <pre><span class="ruby-comment cmt"># File lib/dnsruby.rb, line 141</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">unknown_code</span>(<span class="ruby-identifier">arg</span>)
+      <span class="ruby-constant">Classes</span>.<span class="ruby-identifier">add_pair</span>(<span class="ruby-value str">'CLASS'</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">arg</span>.<span class="ruby-identifier">to_s</span>, <span class="ruby-identifier">arg</span>)
+      <span class="ruby-identifier">set_code</span>(<span class="ruby-identifier">arg</span>)
     <span class="ruby-keyword kw">end</span></pre>
 </body>
 </html>

data/doc/classes/Dnsruby/CodeMapper.html

@@ -108,17 +108,17 @@ Example :
       <h3 class="section-bar">Methods</h3>
 
       <div class="name-list">
-      <a href="#M000139">&lt;=&gt;</a>&nbsp;&nbsp;
-      <a href="#M000140">==</a>&nbsp;&nbsp;
-      <a href="#M000133">add_pair</a>&nbsp;&nbsp;
-      <a href="#M000136">inspect</a>&nbsp;&nbsp;
-      <a href="#M000131">maxcode</a>&nbsp;&nbsp;
-      <a href="#M000141">regexp</a>&nbsp;&nbsp;
-      <a href="#M000134">set_code</a>&nbsp;&nbsp;
-      <a href="#M000135">set_string</a>&nbsp;&nbsp;
-      <a href="#M000138">to_code</a>&nbsp;&nbsp;
-      <a href="#M000137">to_string</a>&nbsp;&nbsp;
-      <a href="#M000132">update</a>&nbsp;&nbsp;
+      <a href="#M000141">&lt;=&gt;</a>&nbsp;&nbsp;
+      <a href="#M000142">==</a>&nbsp;&nbsp;
+      <a href="#M000135">add_pair</a>&nbsp;&nbsp;
+      <a href="#M000138">inspect</a>&nbsp;&nbsp;
+      <a href="#M000133">maxcode</a>&nbsp;&nbsp;
+      <a href="#M000143">regexp</a>&nbsp;&nbsp;
+      <a href="#M000136">set_code</a>&nbsp;&nbsp;
+      <a href="#M000137">set_string</a>&nbsp;&nbsp;
+      <a href="#M000140">to_code</a>&nbsp;&nbsp;
+      <a href="#M000139">to_string</a>&nbsp;&nbsp;
+      <a href="#M000134">update</a>&nbsp;&nbsp;
       </div>
     </div>
 
@@ -188,12 +188,12 @@ Example :
     <div id="methods">
       <h3 class="section-bar">Public Class methods</h3>
 
-      <div id="method-M000133" class="method-detail">
-        <a name="M000133"></a>
+      <div id="method-M000135" class="method-detail">
+        <a name="M000135"></a>
 
         <div class="method-heading">
-          <a href="CodeMapper.src/M000133.html" target="Code" class="method-signature"
-            onclick="popupCode('CodeMapper.src/M000133.html');return false;">
+          <a href="CodeMapper.src/M000135.html" target="Code" class="method-signature"
+            onclick="popupCode('CodeMapper.src/M000135.html');return false;">
           <span class="method-name">add_pair</span><span class="method-args">(string, code)</span>
           </a>
         </div>
@@ -205,12 +205,12 @@ Add new a code to the <a href="CodeMapper.html">CodeMapper</a>
         </div>
       </div>
 
-      <div id="method-M000131" class="method-detail">
-        <a name="M000131"></a>
+      <div id="method-M000133" class="method-detail">
+        <a name="M000133"></a>
 
         <div class="method-heading">
-          <a href="CodeMapper.src/M000131.html" target="Code" class="method-signature"
-            onclick="popupCode('CodeMapper.src/M000131.html');return false;">
+          <a href="CodeMapper.src/M000133.html" target="Code" class="method-signature"
+            onclick="popupCode('CodeMapper.src/M000133.html');return false;">
           <span class="method-name">maxcode</span><span class="method-args">()</span>
           </a>
         </div>
@@ -219,12 +219,12 @@ Add new a code to the <a href="CodeMapper.html">CodeMapper</a>
         </div>
       </div>
 
-      <div id="method-M000141" class="method-detail">
-        <a name="M000141"></a>
+      <div id="method-M000143" class="method-detail">
+        <a name="M000143"></a>
 
         <div class="method-heading">
-          <a href="CodeMapper.src/M000141.html" target="Code" class="method-signature"
-            onclick="popupCode('CodeMapper.src/M000141.html');return false;">
+          <a href="CodeMapper.src/M000143.html" target="Code" class="method-signature"
+            onclick="popupCode('CodeMapper.src/M000143.html');return false;">
           <span class="method-name">regexp</span><span class="method-args">()</span>
           </a>
         </div>
@@ -237,12 +237,12 @@ href="CodeMapper.html">CodeMapper</a>.
         </div>
       </div>
 
-      <div id="method-M000138" class="method-detail">
-        <a name="M000138"></a>
+      <div id="method-M000140" class="method-detail">
+        <a name="M000140"></a>
 
         <div class="method-heading">
-          <a href="CodeMapper.src/M000138.html" target="Code" class="method-signature"
-            onclick="popupCode('CodeMapper.src/M000138.html');return false;">
+          <a href="CodeMapper.src/M000140.html" target="Code" class="method-signature"
+            onclick="popupCode('CodeMapper.src/M000140.html');return false;">
           <span class="method-name">to_code</span><span class="method-args">(arg)</span>
           </a>
         </div>
@@ -251,12 +251,12 @@ href="CodeMapper.html">CodeMapper</a>.
         </div>
       </div>
 
-      <div id="method-M000137" class="method-detail">
-        <a name="M000137"></a>
+      <div id="method-M000139" class="method-detail">
+        <a name="M000139"></a>
 
         <div class="method-heading">
-          <a href="CodeMapper.src/M000137.html" target="Code" class="method-signature"
-            onclick="popupCode('CodeMapper.src/M000137.html');return false;">
+          <a href="CodeMapper.src/M000139.html" target="Code" class="method-signature"
+            onclick="popupCode('CodeMapper.src/M000139.html');return false;">
           <span class="method-name">to_string</span><span class="method-args">(arg)</span>
           </a>
         </div>
@@ -265,12 +265,12 @@ href="CodeMapper.html">CodeMapper</a>.
         </div>
       </div>
 
-      <div id="method-M000132" class="method-detail">
-        <a name="M000132"></a>
+      <div id="method-M000134" class="method-detail">
+        <a name="M000134"></a>
 
         <div class="method-heading">
-          <a href="CodeMapper.src/M000132.html" target="Code" class="method-signature"
-            onclick="popupCode('CodeMapper.src/M000132.html');return false;">
+          <a href="CodeMapper.src/M000134.html" target="Code" class="method-signature"
+            onclick="popupCode('CodeMapper.src/M000134.html');return false;">
           <span class="method-name">update</span><span class="method-args">()</span>
           </a>
         </div>
@@ -285,12 +285,12 @@ constants
 
       <h3 class="section-bar">Public Instance methods</h3>
 
-      <div id="method-M000139" class="method-detail">
-        <a name="M000139"></a>
+      <div id="method-M000141" class="method-detail">
+        <a name="M000141"></a>
 
         <div class="method-heading">
-          <a href="CodeMapper.src/M000139.html" target="Code" class="method-signature"
-            onclick="popupCode('CodeMapper.src/M000139.html');return false;">
+          <a href="CodeMapper.src/M000141.html" target="Code" class="method-signature"
+            onclick="popupCode('CodeMapper.src/M000141.html');return false;">
           <span class="method-name">&lt;=&gt;</span><span class="method-args">(other)</span>
           </a>
         </div>
@@ -299,12 +299,12 @@ constants
         </div>
       </div>
 
-      <div id="method-M000140" class="method-detail">
-        <a name="M000140"></a>
+      <div id="method-M000142" class="method-detail">
+        <a name="M000142"></a>
 
         <div class="method-heading">
-          <a href="CodeMapper.src/M000140.html" target="Code" class="method-signature"
-            onclick="popupCode('CodeMapper.src/M000140.html');return false;">
+          <a href="CodeMapper.src/M000142.html" target="Code" class="method-signature"
+            onclick="popupCode('CodeMapper.src/M000142.html');return false;">
           <span class="method-name">==</span><span class="method-args">(other)</span>
           </a>
         </div>
@@ -313,12 +313,12 @@ constants
         </div>
       </div>
 
-      <div id="method-M000136" class="method-detail">
-        <a name="M000136"></a>
+      <div id="method-M000138" class="method-detail">
+        <a name="M000138"></a>
 
         <div class="method-heading">
-          <a href="CodeMapper.src/M000136.html" target="Code" class="method-signature"
-            onclick="popupCode('CodeMapper.src/M000136.html');return false;">
+          <a href="CodeMapper.src/M000138.html" target="Code" class="method-signature"
+            onclick="popupCode('CodeMapper.src/M000138.html');return false;">
           <span class="method-name">inspect</span><span class="method-args">()</span>
           </a>
         </div>
@@ -327,12 +327,12 @@ constants
         </div>
       </div>
 
-      <div id="method-M000134" class="method-detail">
-        <a name="M000134"></a>
+      <div id="method-M000136" class="method-detail">
+        <a name="M000136"></a>
 
         <div class="method-heading">
-          <a href="CodeMapper.src/M000134.html" target="Code" class="method-signature"
-            onclick="popupCode('CodeMapper.src/M000134.html');return false;">
+          <a href="CodeMapper.src/M000136.html" target="Code" class="method-signature"
+            onclick="popupCode('CodeMapper.src/M000136.html');return false;">
           <span class="method-name">set_code</span><span class="method-args">(arg)</span>
           </a>
         </div>
@@ -341,12 +341,12 @@ constants
         </div>
       </div>
 
-      <div id="method-M000135" class="method-detail">
-        <a name="M000135"></a>
+      <div id="method-M000137" class="method-detail">
+        <a name="M000137"></a>
 
         <div class="method-heading">
-          <a href="CodeMapper.src/M000135.html" target="Code" class="method-signature"
-            onclick="popupCode('CodeMapper.src/M000135.html');return false;">
+          <a href="CodeMapper.src/M000137.html" target="Code" class="method-signature"
+            onclick="popupCode('CodeMapper.src/M000137.html');return false;">
           <span class="method-name">set_string</span><span class="method-args">(arg)</span>
           </a>
         </div>