RubyGems - gandirb - Versions diffs - 1.0 - Mend

gandirb 1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (45) hide show

data/CHANGELOG +1 -0
data/LICENSE +19 -0
data/README +35 -0
data/Rakefile +32 -0
data/gandirb.gemspec +34 -0
data/lib/gandi/base.rb +121 -0
data/lib/gandi/domain.rb +134 -0
data/lib/gandi/domain_modules/contact.rb +36 -0
data/lib/gandi/domain_modules/host.rb +29 -0
data/lib/gandi/domain_modules/mail.rb +80 -0
data/lib/gandi/domain_modules/name_servers.rb +28 -0
data/lib/gandi/domain_modules/operations.rb +30 -0
data/lib/gandi/domain_modules/redirection.rb +25 -0
data/lib/gandi.rb +9 -0
data/rdoc/classes/Gandi/Base.html +397 -0
data/rdoc/classes/Gandi/DataError.html +111 -0
data/rdoc/classes/Gandi/Domain.html +623 -0
data/rdoc/classes/Gandi/DomainModules/Contact.html +246 -0
data/rdoc/classes/Gandi/DomainModules/Host.html +227 -0
data/rdoc/classes/Gandi/DomainModules/NameServers.html +226 -0
data/rdoc/classes/Gandi/DomainModules/Operations.html +229 -0
data/rdoc/classes/Gandi/DomainModules/Redirection.html +215 -0
data/rdoc/classes/Gandi/DomainModules.html +136 -0
data/rdoc/classes/Gandi/ServerError.html +111 -0
data/rdoc/classes/Gandi.html +153 -0
data/rdoc/created.rid +1 -0
data/rdoc/files/README.html +162 -0
data/rdoc/files/lib/gandi/base_rb.html +109 -0
data/rdoc/files/lib/gandi/domain_modules/contact_rb.html +101 -0
data/rdoc/files/lib/gandi/domain_modules/host_rb.html +101 -0
data/rdoc/files/lib/gandi/domain_modules/name_servers_rb.html +101 -0
data/rdoc/files/lib/gandi/domain_modules/operations_rb.html +101 -0
data/rdoc/files/lib/gandi/domain_modules/redirection_rb.html +101 -0
data/rdoc/files/lib/gandi/domain_rb.html +101 -0
data/rdoc/files/lib/gandi_rb.html +101 -0
data/rdoc/fr_class_index.html +38 -0
data/rdoc/fr_file_index.html +36 -0
data/rdoc/fr_method_index.html +83 -0
data/rdoc/index.html +24 -0
data/rdoc/rdoc-style.css +208 -0
data/test/gandi/base_test.rb +188 -0
data/test/gandi/domain_test.rb +302 -0
data/test/gandi_test.rb +9 -0
data/test/test_helper.rb +9 -0
metadata +124 -0

data/rdoc/classes/Gandi/Base.html ADDED Viewed

@@ -0,0 +1,397 @@
+<?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>Class: Gandi::Base</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>Class</strong></td>
+          <td class="class-name-in-header">Gandi::Base</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../../files/lib/gandi/base_rb.html">
+                lib/gandi/base.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>Parent:</strong></td>
+            <td>
+                Object
+            </td>
+        </tr>
+        </table>
+    </div>
+  <!-- banner header -->
+  <div id="bodyContent">
+  <div id="contextContent">
+   </div>
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+      <div class="name-list">
+      <a href="#M000055">account_balance</a>&nbsp;&nbsp;
+      <a href="#M000056">account_currency</a>&nbsp;&nbsp;
+      <a href="#M000051">call</a>&nbsp;&nbsp;
+      <a href="#M000052">login</a>&nbsp;&nbsp;
+      <a href="#M000057">login</a>&nbsp;&nbsp;
+      <a href="#M000050">new</a>&nbsp;&nbsp;
+      <a href="#M000054">password</a>&nbsp;&nbsp;
+      <a href="#M000053">su</a>&nbsp;&nbsp;
+      </div>
+    </div>
+  </div>
+    <!-- if includes -->
+    <div id="section">
+    <div id="constants-list">
+      <h3 class="section-bar">Constants</h3>
+      <div class="name-list">
+        <table summary="Constants">
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">TIMEOUT_EXCEPTIONS</td>
+          <td>=</td>
+          <td class="context-item-value">[EOFError, Errno::EPIPE, OpenSSL::SSL::SSLError]</td>
+        </tr>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">URL</td>
+          <td>=</td>
+          <td class="context-item-value">&quot;https://api.gandi.net/xmlrpc/&quot;</td>
+        </tr>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">TEST_URL</td>
+          <td>=</td>
+          <td class="context-item-value">&quot;https://api.ote.gandi.net/xmlrpc/&quot;</td>
+        </tr>
+        </table>
+      </div>
+    </div>
+    <div id="attribute-list">
+      <h3 class="section-bar">Attributes</h3>
+      <div class="name-list">
+        <table>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">handler</td>
+          <td class="context-item-value">&nbsp;[R]&nbsp;</td>
+          <td class="context-item-desc"></td>
+        </tr>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">session_id</td>
+          <td class="context-item-value">&nbsp;[R]&nbsp;</td>
+          <td class="context-item-desc"></td>
+        </tr>
+        </table>
+      </div>
+    </div>
+    <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Class methods</h3>
+      <div id="method-M000057" class="method-detail">
+        <a name="M000057"></a>
+        <div class="method-heading">
+          <a href="#M000057" class="method-signature">
+          <span class="method-name">login</span><span class="method-args">(login, password, uri = nil)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000057-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000057-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/gandi/base.rb, line 69</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">login</span>(<span class="ruby-identifier">login</span>, <span class="ruby-identifier">password</span>, <span class="ruby-identifier">uri</span> = <span class="ruby-keyword kw">nil</span>)
+      <span class="ruby-identifier">client</span> = <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">login</span>, <span class="ruby-identifier">password</span>, <span class="ruby-identifier">uri</span>)
+      <span class="ruby-identifier">client</span>.<span class="ruby-identifier">login</span>
+      <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">client</span>
+    <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+      <div id="method-M000050" class="method-detail">
+        <a name="M000050"></a>
+        <div class="method-heading">
+          <a href="#M000050" class="method-signature">
+          <span class="method-name">new</span><span class="method-args">(login, password, uri = nil)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000050-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000050-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/gandi/base.rb, line 17</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">login</span>, <span class="ruby-identifier">password</span>, <span class="ruby-identifier">uri</span> = <span class="ruby-keyword kw">nil</span>)
+      <span class="ruby-ivar">@login</span> = <span class="ruby-identifier">login</span>
+      <span class="ruby-ivar">@password</span> = <span class="ruby-identifier">password</span>
+      <span class="ruby-ivar">@uri</span> = <span class="ruby-identifier">uri</span>
+      <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@uri</span>.<span class="ruby-identifier">nil?</span>
+        <span class="ruby-keyword kw">begin</span>
+          <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">const_get</span>(<span class="ruby-identifier">:URL</span>)
+        <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">NameError</span>
+          <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>.<span class="ruby-identifier">new</span> <span class="ruby-value str">&quot;You must provide an URL when using Gandi::Base directly&quot;</span>
+        <span class="ruby-keyword kw">end</span>
+      <span class="ruby-keyword kw">end</span>
+    <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+      <h3 class="section-bar">Public Instance methods</h3>
+      <div id="method-M000055" class="method-detail">
+        <a name="M000055"></a>
+        <div class="method-heading">
+          <a href="#M000055" class="method-signature">
+          <span class="method-name">account_balance</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Current prepaid account balance
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000055-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000055-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/gandi/base.rb, line 60</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">account_balance</span>
+      <span class="ruby-identifier">call</span>(<span class="ruby-value str">'account_balance'</span>)
+    <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+      <div id="method-M000056" class="method-detail">
+        <a name="M000056"></a>
+        <div class="method-heading">
+          <a href="#M000056" class="method-signature">
+          <span class="method-name">account_currency</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Currency name used with the prepaid account
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000056-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000056-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/gandi/base.rb, line 65</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">account_currency</span>
+      <span class="ruby-identifier">call</span>(<span class="ruby-value str">'account_currency'</span>)
+    <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+      <div id="method-M000051" class="method-detail">
+        <a name="M000051"></a>
+        <div class="method-heading">
+          <a href="#M000051" class="method-signature">
+          <span class="method-name">call</span><span class="method-args">(method, *arguments)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Calls a RPC method, transparently providing the session id
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000051-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000051-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/gandi/base.rb, line 31</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">call</span>(<span class="ruby-identifier">method</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">arguments</span>)
+      <span class="ruby-identifier">raise</span> <span class="ruby-value str">&quot;You have to log in before using methods requiring a session id&quot;</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">logged_in?</span>
+      <span class="ruby-identifier">raw_call</span>(<span class="ruby-identifier">method</span>.<span class="ruby-identifier">to_s</span>, <span class="ruby-ivar">@session_id</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">arguments</span>)
+    <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+      <div id="method-M000052" class="method-detail">
+        <a name="M000052"></a>
+        <div class="method-heading">
+          <a href="#M000052" class="method-signature">
+          <span class="method-name">login</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Instanciates a rpc handler and log in to the interface to retrieve a
+session id
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000052-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000052-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/gandi/base.rb, line 37</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">login</span>
+      <span class="ruby-ivar">@handler</span> = <span class="ruby-constant">XMLRPC</span><span class="ruby-operator">::</span><span class="ruby-constant">Client</span>.<span class="ruby-identifier">new_from_uri</span>(<span class="ruby-ivar">@uri</span>)
+      <span class="ruby-comment cmt">#Get rid of SSL warnings &quot;peer certificate won't be verified in this SSL session&quot;</span>
+      <span class="ruby-comment cmt">#See http://developer.amazonwebservices.com/connect/thread.jspa?threadID=37139</span>
+      <span class="ruby-comment cmt">#and http://blog.chmouel.com/2008/03/21/ruby-xmlrpc-over-a-self-certified-ssl-with-a-warning/</span>
+      <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@handler</span>.<span class="ruby-identifier">instance_variable_get</span>(<span class="ruby-value str">'@http'</span>).<span class="ruby-identifier">use_ssl?</span>
+        <span class="ruby-ivar">@handler</span>.<span class="ruby-identifier">instance_variable_get</span>(<span class="ruby-value str">'@http'</span>).<span class="ruby-identifier">instance_variable_get</span>(<span class="ruby-value str">&quot;@ssl_context&quot;</span>).<span class="ruby-identifier">verify_mode</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">SSL</span><span class="ruby-operator">::</span><span class="ruby-constant">VERIFY_NONE</span>
+      <span class="ruby-keyword kw">end</span>
+      <span class="ruby-ivar">@session_id</span> = <span class="ruby-identifier">raw_call</span>(<span class="ruby-value str">&quot;login&quot;</span>, <span class="ruby-ivar">@login</span>, <span class="ruby-ivar">@password</span>, <span class="ruby-keyword kw">false</span>)
+    <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+      <div id="method-M000054" class="method-detail">
+        <a name="M000054"></a>
+        <div class="method-heading">
+          <a href="#M000054" class="method-signature">
+          <span class="method-name">password</span><span class="method-args">(password)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Changes <a href="Base.html#M000054">password</a>
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000054-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000054-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/gandi/base.rb, line 54</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">password</span>(<span class="ruby-identifier">password</span>)
+      <span class="ruby-ivar">@password</span> = <span class="ruby-identifier">password</span>
+      <span class="ruby-identifier">call</span>(<span class="ruby-value str">&quot;password&quot;</span>, <span class="ruby-identifier">password</span>)
+    <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+      <div id="method-M000053" class="method-detail">
+        <a name="M000053"></a>
+        <div class="method-heading">
+          <a href="#M000053" class="method-signature">
+          <span class="method-name">su</span><span class="method-args">(handle)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Gets a <a href="Base.html#M000050">new</a> session id by switching to
+another handle
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000053-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000053-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/gandi/base.rb, line 49</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">su</span>(<span class="ruby-identifier">handle</span>)
+      <span class="ruby-ivar">@session_id</span> = <span class="ruby-identifier">call</span>(<span class="ruby-value str">&quot;su&quot;</span>, <span class="ruby-identifier">handle</span>)
+    <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+    </div>
+  </div>
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+</body>
+</html>

data/rdoc/classes/Gandi/DataError.html ADDED Viewed

@@ -0,0 +1,111 @@
+<?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>Class: Gandi::DataError</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>Class</strong></td>
+          <td class="class-name-in-header">Gandi::DataError</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../../files/lib/gandi_rb.html">
+                lib/gandi.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>Parent:</strong></td>
+            <td>
+                ArgumentError
+            </td>
+        </tr>
+        </table>
+    </div>
+  <!-- banner header -->
+  <div id="bodyContent">
+  <div id="contextContent">
+   </div>
+  </div>
+    <!-- if includes -->
+    <div id="section">
+    <!-- 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>