RubyGems - gandirb - Versions diffs - 1.0 → 1.1.1 - Mend

gandirb 1.0 → 1.1.1

Files changed (41) hide show

data/CHANGELOG +14 -1
data/Gemfile +3 -0
data/README.rdoc +36 -0
data/Rakefile +8 -17
data/gandirb.gemspec +23 -24
data/lib/gandi/base.rb +28 -28
data/lib/gandi/domain.rb +7 -8
data/lib/gandi/domain_modules/contact.rb +1 -1
data/lib/gandi/domain_modules/operations.rb +1 -1
data/lib/gandi/domain_modules/redirection.rb +2 -2
data/lib/gandi/version.rb +3 -0
data/lib/gandi.rb +3 -4
data/test/gandi/domain_test.rb +7 -8
metadata +98 -89
data/README +0 -35
data/rdoc/classes/Gandi/Base.html +0 -397
data/rdoc/classes/Gandi/DataError.html +0 -111
data/rdoc/classes/Gandi/Domain.html +0 -623
data/rdoc/classes/Gandi/DomainModules/Contact.html +0 -246
data/rdoc/classes/Gandi/DomainModules/Host.html +0 -227
data/rdoc/classes/Gandi/DomainModules/NameServers.html +0 -226
data/rdoc/classes/Gandi/DomainModules/Operations.html +0 -229
data/rdoc/classes/Gandi/DomainModules/Redirection.html +0 -215
data/rdoc/classes/Gandi/DomainModules.html +0 -136
data/rdoc/classes/Gandi/ServerError.html +0 -111
data/rdoc/classes/Gandi.html +0 -153
data/rdoc/created.rid +0 -1
data/rdoc/files/README.html +0 -162
data/rdoc/files/lib/gandi/base_rb.html +0 -109
data/rdoc/files/lib/gandi/domain_modules/contact_rb.html +0 -101
data/rdoc/files/lib/gandi/domain_modules/host_rb.html +0 -101
data/rdoc/files/lib/gandi/domain_modules/name_servers_rb.html +0 -101
data/rdoc/files/lib/gandi/domain_modules/operations_rb.html +0 -101
data/rdoc/files/lib/gandi/domain_modules/redirection_rb.html +0 -101
data/rdoc/files/lib/gandi/domain_rb.html +0 -101
data/rdoc/files/lib/gandi_rb.html +0 -101
data/rdoc/fr_class_index.html +0 -38
data/rdoc/fr_file_index.html +0 -36
data/rdoc/fr_method_index.html +0 -83
data/rdoc/index.html +0 -24
data/rdoc/rdoc-style.css +0 -208

data/README DELETED Viewed

@@ -1,35 +0,0 @@
-= Gandirb - Ruby library for using Gandi XML-RPC API
-This is a ruby library for using Gandi XML-RPC API.
-It should only support the domain and mail API, but may be extensible enough to add hosting in the future.
-== Howto
-See http://wiki.gandi.net/fr/api-xml/docs/domain for the full documentation on the API.
-Note the session_id doesn't have to be explicitly provided when calling a method.
-It should also be noted that the ruby xml-rpc lib seems to have a bug with the ssl support, resulting in a timeout of 15 seconds.
-After this time the current connection won't work and result in various exception.
-This lib takes this issue into account and provides a workaround by restarting the connection. See the code comments for more details.
-Quick example :
-gandi_session = Gandi::Domain.login 'XXYYY-Gandi', 'mypasswd', Gandi::Domain::TEST_URL #omit the last param for real url
-gandi_session.account_currency # => "EUR"
-gandi_session.domain_available ["mycoolwebsite.com"] # => {"mycoolwebsite.com"=>true}
-gandi_session.domain_available "mycoolwebsite.com" # => true #rubyfied syntax
-gandi_session.domain_list # => ["mypersonalwebsite.com"]
-Detailed RDoc documentation for each method is available using rake rdoc.
-== TODO
-* Tests
-* Finish adding and cleaning up domain and mail methods
-* Better handling of failures and server exceptions, and stricter params checking
-* Gemification (with Jeweler)
-== Copyright
-Copyright (c) 2009 Pickabee. Released under the MIT licence, see LICENSE for details.
-Some parts inspired by http://github.com/jerome/gandi/tree

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

@@ -1,397 +0,0 @@
-<?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 DELETED Viewed

@@ -1,111 +0,0 @@
-<?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>