mirror of
https://github.com/mistergibson/gxg-framework.git
synced 2026-08-15 11:54:29 -07:00
443 lines
22 KiB
HTML
443 lines
22 KiB
HTML
<!DOCTYPE html>
|
|
|
|
<html>
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
|
|
<title>class GxG::Networking::XmlrpcClient - RDoc Documentation</title>
|
|
|
|
<script type="text/javascript">
|
|
var rdoc_rel_prefix = "../../";
|
|
var index_rel_prefix = "../../";
|
|
</script>
|
|
|
|
<script src="../../js/navigation.js" defer></script>
|
|
<script src="../../js/search.js" defer></script>
|
|
<script src="../../js/search_index.js" defer></script>
|
|
<script src="../../js/searcher.js" defer></script>
|
|
<script src="../../js/darkfish.js" defer></script>
|
|
|
|
<link href="../../css/fonts.css" rel="stylesheet">
|
|
<link href="../../css/rdoc.css" rel="stylesheet">
|
|
|
|
|
|
|
|
<body id="top" role="document" class="class">
|
|
<nav role="navigation">
|
|
<div id="project-navigation">
|
|
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
|
|
<h2>
|
|
<a href="../../index.html" rel="home">Home</a>
|
|
</h2>
|
|
|
|
<div id="table-of-contents-navigation">
|
|
<a href="../../table_of_contents.html#pages">Pages</a>
|
|
<a href="../../table_of_contents.html#classes">Classes</a>
|
|
<a href="../../table_of_contents.html#methods">Methods</a>
|
|
</div>
|
|
</div>
|
|
|
|
<div id="search-section" role="search" class="project-section initially-hidden">
|
|
<form action="#" method="get" accept-charset="utf-8">
|
|
<div id="search-field-wrapper">
|
|
<input id="search-field" role="combobox" aria-label="Search"
|
|
aria-autocomplete="list" aria-controls="search-results"
|
|
type="text" name="search" placeholder="Search" spellcheck="false"
|
|
title="Type to search, Up and Down to navigate, Enter to load">
|
|
</div>
|
|
|
|
<ul id="search-results" aria-label="Search Results"
|
|
aria-busy="false" aria-expanded="false"
|
|
aria-atomic="false" class="initially-hidden"></ul>
|
|
</form>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<div id="class-metadata">
|
|
|
|
<div id="parent-class-section" class="nav-section">
|
|
<h3>Parent</h3>
|
|
|
|
|
|
<p class="link"><a href="../../Object.html">Object</a>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<!-- Method Quickref -->
|
|
<div id="method-list-section" class="nav-section">
|
|
<h3>Methods</h3>
|
|
|
|
<ul class="link-list" role="directory">
|
|
|
|
<li ><a href="#method-c-new">::new</a>
|
|
|
|
<li ><a href="#method-i-callmethod">#callmethod</a>
|
|
|
|
<li ><a href="#method-i-closed-3F">#closed?</a>
|
|
|
|
<li ><a href="#method-i-interface">#interface</a>
|
|
|
|
<li ><a href="#method-i-login">#login</a>
|
|
|
|
<li ><a href="#method-i-logout">#logout</a>
|
|
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</nav>
|
|
|
|
<main role="main" aria-labelledby="class-GxG::Networking::XmlrpcClient">
|
|
<h1 id="class-GxG::Networking::XmlrpcClient" class="class">
|
|
class GxG::Networking::XmlrpcClient
|
|
</h1>
|
|
|
|
<section class="description">
|
|
|
|
<p>XMLRPC Classes:</p>
|
|
|
|
</section>
|
|
|
|
|
|
<section id="5Buntitled-5D" class="documentation-section">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
|
|
<header>
|
|
<h3>Public Class Methods</h3>
|
|
</header>
|
|
|
|
|
|
<div id="method-c-new" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">new</span><span
|
|
class="method-args">()</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="new-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 2341</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>()
|
|
<span class="ruby-ivar">@client</span> = <span class="ruby-keyword">nil</span>
|
|
<span class="ruby-ivar">@interface</span> = <span class="ruby-keyword">nil</span>
|
|
<span class="ruby-keyword">self</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</section>
|
|
|
|
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
|
|
<header>
|
|
<h3>Public Instance Methods</h3>
|
|
</header>
|
|
|
|
|
|
<div id="method-i-callmethod" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">callmethod</span><span
|
|
class="method-args">(the_method = nil, arguments = nil)</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="callmethod-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 2404</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">callmethod</span>(<span class="ruby-identifier">the_method</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">arguments</span> = <span class="ruby-keyword">nil</span>)
|
|
<span class="ruby-comment"># The +method+ parameter is converted into a String and should</span>
|
|
<span class="ruby-comment"># be a valid XML-RPC method-name.</span>
|
|
<span class="ruby-comment">#</span>
|
|
<span class="ruby-comment"># Each parameter of +args+ must be of one of the following types,</span>
|
|
<span class="ruby-comment"># where Hash, Struct and Array can contain any of these listed _types_:</span>
|
|
<span class="ruby-comment">#</span>
|
|
<span class="ruby-comment"># * Fixnum, Bignum</span>
|
|
<span class="ruby-comment"># * TrueClass, FalseClass, +true+, +false+</span>
|
|
<span class="ruby-comment"># * String, Symbol</span>
|
|
<span class="ruby-comment"># * Float</span>
|
|
<span class="ruby-comment"># * Hash, Struct</span>
|
|
<span class="ruby-comment"># * Array</span>
|
|
<span class="ruby-comment"># * Date, Time, XMLRPC::DateTime</span>
|
|
<span class="ruby-comment"># * XMLRPC::Base64</span>
|
|
<span class="ruby-comment"># * A Ruby object which class includes XMLRPC::Marshallable</span>
|
|
<span class="ruby-comment"># (only if Config::ENABLE_MARSHALLABLE is +true+).</span>
|
|
<span class="ruby-comment"># That object is converted into a hash, with one additional key/value</span>
|
|
<span class="ruby-comment"># pair <code>___class___</code> which contains the class name</span>
|
|
<span class="ruby-comment"># for restoring that object later.</span>
|
|
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">nil</span>
|
|
<span class="ruby-keyword">begin</span>
|
|
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">the_method</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">String</span>)
|
|
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"You MUST provide a valid method String."</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@client</span>
|
|
<span class="ruby-identifier">calldata</span> = []
|
|
<span class="ruby-identifier">calldata</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">the_method</span>
|
|
<span class="ruby-comment">#</span>
|
|
<span class="ruby-comment"># TODO: scour arguments structure for type conversions to be done.</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">arguments</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Array</span>)
|
|
<span class="ruby-identifier">arguments</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">entry</span><span class="ruby-operator">|</span>
|
|
<span class="ruby-identifier">calldata</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">entry</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">arguments</span>
|
|
<span class="ruby-identifier">calldata</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">arguments</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-identifier">result</span> = <span class="ruby-ivar">@client</span>.<span class="ruby-identifier">call</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">calldata</span>)
|
|
<span class="ruby-comment"># TODO: scour result structure for type conversions to gxg standard.</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>
|
|
<span class="ruby-identifier">log_error</span>({<span class="ruby-value">:error</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>, <span class="ruby-value">:parameters</span> <span class="ruby-operator">=></span> {<span class="ruby-value">:method</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_method</span>, <span class="ruby-value">:arguments</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">arguments</span>}})
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-identifier">result</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method-i-closed-3F" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">closed?</span><span
|
|
class="method-args">()</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="closed-3F-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 2396</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">closed?</span>()
|
|
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@client</span>
|
|
<span class="ruby-keyword">false</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-keyword">true</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method-i-interface" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">interface</span><span
|
|
class="method-args">()</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="interface-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 2452</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">interface</span>()
|
|
<span class="ruby-keyword">begin</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@client</span>
|
|
<span class="ruby-keyword">unless</span> <span class="ruby-ivar">@interface</span>
|
|
<span class="ruby-ivar">@interface</span> = <span class="ruby-ivar">@client</span>.<span class="ruby-identifier">call</span>(<span class="ruby-string">"interface"</span>)
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">unless</span> <span class="ruby-ivar">@interface</span>
|
|
<span class="ruby-ivar">@interface</span> = <span class="ruby-ivar">@client</span>.<span class="ruby-identifier">call</span>(<span class="ruby-string">"Interface"</span>)
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>
|
|
<span class="ruby-comment"># log_error({:error => the_error, :parameters => {}})</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-ivar">@interface</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method-i-login" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">login</span><span
|
|
class="method-args">(the_url=nil, options={})</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="login-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 2347</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">login</span>(<span class="ruby-identifier">the_url</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">options</span>={})
|
|
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">false</span>
|
|
<span class="ruby-keyword">begin</span>
|
|
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">URI</span><span class="ruby-operator">::</span><span class="ruby-constant">Generic</span>)
|
|
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"You MUST provide a valid URI."</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:use_ssl</span>] <span class="ruby-operator">==</span> <span class="ruby-keyword">true</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">scheme</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">downcase</span> <span class="ruby-operator">==</span> <span class="ruby-string">'https'</span>
|
|
<span class="ruby-identifier">client_parameters</span> = [(<span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">hostname</span>), (<span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">path</span>), (<span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">port</span> <span class="ruby-operator">||</span> <span class="ruby-value">443</span>)]
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-identifier">client_parameters</span> = [(<span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">hostname</span>), (<span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">path</span>), (<span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">port</span> <span class="ruby-operator">||</span> <span class="ruby-value">80</span>)]
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:proxy</span>].<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">URI</span><span class="ruby-operator">::</span><span class="ruby-constant">Generic</span>)
|
|
<span class="ruby-identifier">client_parameters</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:proxy</span>].<span class="ruby-identifier">host</span>
|
|
<span class="ruby-identifier">client_parameters</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:proxy</span>].<span class="ruby-identifier">port</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-identifier">client_parameters</span> <span class="ruby-operator"><<</span> <span class="ruby-keyword">nil</span>
|
|
<span class="ruby-identifier">client_parameters</span> <span class="ruby-operator"><<</span> <span class="ruby-keyword">nil</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">user</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">password</span>
|
|
<span class="ruby-identifier">client_parameters</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">user</span>
|
|
<span class="ruby-identifier">client_parameters</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">password</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-identifier">client_parameters</span> <span class="ruby-operator"><<</span> <span class="ruby-keyword">nil</span>
|
|
<span class="ruby-identifier">client_parameters</span> <span class="ruby-operator"><<</span> <span class="ruby-keyword">nil</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:use_ssl</span>] <span class="ruby-operator">==</span> <span class="ruby-keyword">true</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">scheme</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">downcase</span> <span class="ruby-operator">==</span> <span class="ruby-string">'https'</span>
|
|
<span class="ruby-identifier">client_parameters</span> <span class="ruby-operator"><<</span> <span class="ruby-keyword">true</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-identifier">client_parameters</span> <span class="ruby-operator"><<</span> <span class="ruby-keyword">nil</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:timeout</span>].<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Numeric</span>)
|
|
<span class="ruby-identifier">client_parameters</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:timeout</span>].<span class="ruby-identifier">to_i</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-identifier">client_parameters</span> <span class="ruby-operator"><<</span> <span class="ruby-value">30</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-ivar">@client</span> = <span class="ruby-operator">::</span><span class="ruby-constant">XMLRPC</span><span class="ruby-operator">::</span><span class="ruby-constant">Client</span>.<span class="ruby-identifier">new</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">client_parameters</span>)
|
|
<span class="ruby-identifier">this</span>().<span class="ruby-identifier">interface</span>()
|
|
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">true</span>
|
|
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>
|
|
<span class="ruby-identifier">log_error</span>({<span class="ruby-value">:error</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>, <span class="ruby-value">:parameters</span> <span class="ruby-operator">=></span> {<span class="ruby-value">:url</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_url</span>}})
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-identifier">result</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method-i-logout" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">logout</span><span
|
|
class="method-args">()</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="logout-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 2391</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">logout</span>()
|
|
<span class="ruby-ivar">@client</span> = <span class="ruby-keyword">nil</span>
|
|
<span class="ruby-keyword">true</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</section>
|
|
|
|
</section>
|
|
</main>
|
|
|
|
|
|
<footer id="validator-badges" role="contentinfo">
|
|
<p><a href="https://validator.w3.org/check/referer">Validate</a>
|
|
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.1.2.
|
|
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
|
|
</footer>
|
|
|