RubyGems - rmobio - Versions diffs - 1.1.31 → 1.1.32 - Mend

rmobio 1.1.31 → 1.1.32

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 (522) hide show

data/lib/rmobio/doc/classes/Rmobio/Cas/MobioValidationResponse.html ADDED Viewed

@@ -0,0 +1,170 @@
+<?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: Rmobio::Cas::MobioValidationResponse</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">Rmobio::Cas::MobioValidationResponse</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../../../files/cas_rb.html">
+                cas.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>Parent:</strong></td>
+            <td>
+                CASClient::ValidationResponse
+            </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="#M000062">new</a>&nbsp;&nbsp;
+      <a href="#M000063">parse_uuid</a>&nbsp;&nbsp;
+      </div>
+    </div>
+  </div>
+    <!-- if includes -->
+    <div id="section">
+    <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">uuid</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-M000062" class="method-detail">
+        <a name="M000062"></a>
+        <div class="method-heading">
+          <a href="MobioValidationResponse.src/M000062.html" target="Code" class="method-signature"
+            onclick="popupCode('MobioValidationResponse.src/M000062.html');return false;">
+          <span class="method-name">new</span><span class="method-args">(raw_text)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Parse out our custom attributes
+</p>
+        </div>
+      </div>
+      <h3 class="section-bar">Public Instance methods</h3>
+      <div id="method-M000063" class="method-detail">
+        <a name="M000063"></a>
+        <div class="method-heading">
+          <a href="MobioValidationResponse.src/M000063.html" target="Code" class="method-signature"
+            onclick="popupCode('MobioValidationResponse.src/M000063.html');return false;">
+          <span class="method-name">parse_uuid</span><span class="method-args">(raw_text)</span>
+          </a>
+        </div>
+        <div class="method-description">
+        </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/lib/rmobio/doc/classes/Rmobio/Cas/MobioValidationResponse.src/M000062.html ADDED Viewed

@@ -0,0 +1,19 @@
+<?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>
+<head>
+  <title>new (Rmobio::Cas::MobioValidationResponse)</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 cas.rb, line 44</span>
+      <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">raw_text</span>)
+        <span class="ruby-identifier">parse</span>(<span class="ruby-identifier">raw_text</span>)
+        <span class="ruby-identifier">parse_uuid</span>(<span class="ruby-identifier">raw_text</span>)
+      <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

data/lib/rmobio/doc/classes/Rmobio/Cas/MobioValidationResponse.src/M000063.html ADDED Viewed

@@ -0,0 +1,31 @@
+<?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>
+<head>
+  <title>parse_uuid (Rmobio::Cas::MobioValidationResponse)</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 cas.rb, line 49</span>
+      <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">parse_uuid</span>(<span class="ruby-identifier">raw_text</span>)
+        <span class="ruby-identifier">raise</span> <span class="ruby-constant">BadResponseException</span>,
+          <span class="ruby-value str">&quot;CAS response is empty/blank.&quot;</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">raw_text</span>.<span class="ruby-identifier">blank?</span>
+        <span class="ruby-ivar">@xml</span> = <span class="ruby-identifier">check_and_parse_xml</span>(<span class="ruby-identifier">raw_text</span>)
+        <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">is_success?</span>
+          <span class="ruby-ivar">@uuid</span> = <span class="ruby-ivar">@xml</span>.<span class="ruby-identifier">elements</span>[<span class="ruby-value str">&quot;cas:uuid&quot;</span>].<span class="ruby-identifier">text</span>.<span class="ruby-identifier">strip</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@xml</span>.<span class="ruby-identifier">elements</span>[<span class="ruby-value str">&quot;cas:uuid&quot;</span>]
+          <span class="ruby-constant">RAILS_DEFAULT_LOGGER</span>.<span class="ruby-identifier">info</span> <span class="ruby-value str">'CAS: Successfully authenticated user '</span> <span class="ruby-operator">+</span> <span class="ruby-ivar">@uuid</span>.<span class="ruby-identifier">to_s</span> <span class="ruby-operator">+</span>
+            <span class="ruby-value str">'...'</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-keyword kw">not</span> <span class="ruby-keyword kw">defined?</span> <span class="ruby-constant">RAILS_DEFAULT_LOGGER</span>
+        <span class="ruby-keyword kw">else</span>
+          <span class="ruby-comment cmt"># this should never happen, since the response should already have</span>
+          <span class="ruby-comment cmt"># been recognized as invalid</span>
+          <span class="ruby-identifier">raise</span> <span class="ruby-constant">BadResponseException</span>, <span class="ruby-node">&quot;BAD CAS RESPONSE:\n#{raw_text.inspect}\n\nXML DOC:\n#{@xml.inspect}&quot;</span>
+        <span class="ruby-keyword kw">end</span>
+      <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

data/lib/rmobio/doc/classes/Rmobio/Cas/MobioValidationResponse.src/M000193.html ADDED Viewed

@@ -0,0 +1,19 @@
+<?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>
+<head>
+  <title>new (Rmobio::Cas::MobioValidationResponse)</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 cas.rb, line 44</span>
+      <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">raw_text</span>)
+        <span class="ruby-identifier">parse</span>(<span class="ruby-identifier">raw_text</span>)
+        <span class="ruby-identifier">parse_uuid</span>(<span class="ruby-identifier">raw_text</span>)
+      <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

data/lib/rmobio/doc/classes/Rmobio/Cas/MobioValidationResponse.src/M000194.html ADDED Viewed

@@ -0,0 +1,31 @@
+<?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>
+<head>
+  <title>parse_uuid (Rmobio::Cas::MobioValidationResponse)</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 cas.rb, line 49</span>
+      <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">parse_uuid</span>(<span class="ruby-identifier">raw_text</span>)
+        <span class="ruby-identifier">raise</span> <span class="ruby-constant">BadResponseException</span>,
+          <span class="ruby-value str">&quot;CAS response is empty/blank.&quot;</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">raw_text</span>.<span class="ruby-identifier">blank?</span>
+        <span class="ruby-ivar">@xml</span> = <span class="ruby-identifier">check_and_parse_xml</span>(<span class="ruby-identifier">raw_text</span>)
+        <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">is_success?</span>
+          <span class="ruby-ivar">@uuid</span> = <span class="ruby-ivar">@xml</span>.<span class="ruby-identifier">elements</span>[<span class="ruby-value str">&quot;cas:uuid&quot;</span>].<span class="ruby-identifier">text</span>.<span class="ruby-identifier">strip</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@xml</span>.<span class="ruby-identifier">elements</span>[<span class="ruby-value str">&quot;cas:uuid&quot;</span>]
+          <span class="ruby-constant">RAILS_DEFAULT_LOGGER</span>.<span class="ruby-identifier">info</span> <span class="ruby-value str">'CAS: Successfully authenticated user '</span> <span class="ruby-operator">+</span> <span class="ruby-ivar">@uuid</span>.<span class="ruby-identifier">to_s</span> <span class="ruby-operator">+</span>
+            <span class="ruby-value str">'...'</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-keyword kw">not</span> <span class="ruby-keyword kw">defined?</span> <span class="ruby-constant">RAILS_DEFAULT_LOGGER</span>
+        <span class="ruby-keyword kw">else</span>
+          <span class="ruby-comment cmt"># this should never happen, since the response should already have</span>
+          <span class="ruby-comment cmt"># been recognized as invalid</span>
+          <span class="ruby-identifier">raise</span> <span class="ruby-constant">BadResponseException</span>, <span class="ruby-node">&quot;BAD CAS RESPONSE:\n#{raw_text.inspect}\n\nXML DOC:\n#{@xml.inspect}&quot;</span>
+        <span class="ruby-keyword kw">end</span>
+      <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

data/lib/rmobio/doc/classes/Rmobio/ClientInfo.html ADDED Viewed

@@ -0,0 +1,274 @@
+<?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: Rmobio::ClientInfo</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">Rmobio::ClientInfo</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../../files/client_info_rb.html">
+                client_info.rb
+                </a>
+        <br />
+            </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="#M000052">checkClient</a>&nbsp;&nbsp;
+      <a href="#M000054">getDeviceAttrValue</a>&nbsp;&nbsp;
+      <a href="#M000055">get_device_info</a>&nbsp;&nbsp;
+      <a href="#M000053">paramsFromXml</a>&nbsp;&nbsp;
+      </div>
+    </div>
+  </div>
+    <!-- if includes -->
+    <div id="section">
+    <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Instance methods</h3>
+      <div id="method-M000052" class="method-detail">
+        <a name="M000052"></a>
+        <div class="method-heading">
+          <a href="ClientInfo.src/M000052.html" target="Code" class="method-signature"
+            onclick="popupCode('ClientInfo.src/M000052.html');return false;">
+          <span class="method-name">checkClient</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <h2><a href="ClientInfo.html#M000052">checkClient</a></h2>
+<h3>The method checks the client type, version and family by analyzing the request header.</h3>
+<h3>HTTP_ACCEPT</h3>
+<ul>
+<li>If header contains application/pxml =&gt; &#8216;xf&#8217; (xforms client)
+</li>
+<li>If header contains wml or wap =&gt; &#8216;wap&#8216;
+</li>
+<li>If header contains applicaton/html =&gt; &#8216;html&#8216;
+</li>
+<li>Otherwise, default to html =&gt; &#8216;html&#8216;
+</li>
+</ul>
+<pre>
+ If xf cient, the &quot;POST&quot; parameters are parsed to name/value pairs in params
+</pre>
+<h3>HTTP_CLIENT_INFO_URL</h3>
+<ul>
+<li>If header exists =&gt; 0.8 client
+</li>
+<li>If header doesn&#8216;t exist =&gt; 0.6 client
+</li>
+</ul>
+<pre>
+ Samle of what HTTP_CLIENT_INFO_URL returns:
+ http://homer.mobiolabs.com/hub/devicecap/devices/capability?id=0.6.28:Motorola:V3
+</pre>
+<h3>HTTP_MOBIO_AGENT</h3>
+<ul>
+<li>If header contains WM5 =&gt; Window Mobile family
+</li>
+</ul>
+<h2>Return Codes</h2>
+<pre>
+ The method returns the following instance varables:
+ @client     =&gt; 'xf' or 'html' or 'wap'
+ params[]   =&gt; array contains name/value pairs of all parameters from POST request
+ @paramsdoc  =&gt; POST request in xml (parsed by hpricot)
+ @xml =&gt; rxml transformer for the client type
+ @client_version =&gt; '0.6' or '0.8'
+</pre>
+        </div>
+      </div>
+      <div id="method-M000054" class="method-detail">
+        <a name="M000054"></a>
+        <div class="method-heading">
+          <a href="ClientInfo.src/M000054.html" target="Code" class="method-signature"
+            onclick="popupCode('ClientInfo.src/M000054.html');return false;">
+          <span class="method-name">getDeviceAttrValue</span><span class="method-args">(attribute, default)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <h2><a href="ClientInfo.html#M000054">getDeviceAttrValue</a>(attribute, default)</h2>
+<h3>To get the value for a device attribute</h3>
+<pre>
+ This utility queries the device capability service to get the value for
+ a particular device attribute.
+</pre>
+<h3>Sample device url:</h3>
+<pre>
+ http://homer.mobiolabs.com/hub/devicecap/devices/capability?id=0.6.28:Motorola:V3
+</pre>
+<h3>Sample device attributes:</h3>
+<pre>
+ &lt;mob:Client&gt;
+  &lt;mob:client-id&gt;.0.6.28:Sony-Ericsson:Z800&lt;/mob:client-id&gt;
+  &lt;mob:name&gt;Sony-Ericsson/Z800&lt;/mob:name&gt;
+  &lt;mob:height&gt;220&lt;/mob:height&gt;
+  &lt;mob:width&gt;176&lt;/mob:width&gt;
+  &lt;mob:bit-depth&gt;0&lt;/mob:bit-depth&gt;
+  &lt;mob:memory&gt;1.5 MB&lt;/mob:memory&gt;
+  &lt;mob:memory-heap&gt;0&lt;/mob:memory-heap&gt;
+  &lt;mob:memory-rms&gt;0&lt;/mob:memory-rms&gt;
+ &lt;/mob:Client&gt;
+</pre>
+<h3>parameter</h3>
+<ul>
+<li>attribute =&gt; the device attribute string, ex: &quot;width&quot;,
+&quot;height&quot;
+</li>
+<li>default =&gt; default value if attribute is not available in the
+client_info_url
+</li>
+</ul>
+<h3>return</h3>
+<pre>
+ Value of the attribute
+</pre>
+        </div>
+      </div>
+      <div id="method-M000055" class="method-detail">
+        <a name="M000055"></a>
+        <div class="method-heading">
+          <a href="ClientInfo.src/M000055.html" target="Code" class="method-signature"
+            onclick="popupCode('ClientInfo.src/M000055.html');return false;">
+          <span class="method-name">get_device_info</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <h2><a href="ClientInfo.html#M000055">get_device_info</a></h2>
+<h3>For asset management</h3>
+<h3>Sample device url:</h3>
+<pre>
+ http://homer.mobiolabs.com/hub/devicecap/devices/capability?id=0.6.28:Motorola:V3
+ All client attributes are stored in Hash plus &quot;iconsize&quot; which is &quot;13&quot; or &quot;17&quot;
+ If device width is null or 0, it defaults to '176' for asset to work.
+</pre>
+        </div>
+      </div>
+      <div id="method-M000053" class="method-detail">
+        <a name="M000053"></a>
+        <div class="method-heading">
+          <a href="ClientInfo.src/M000053.html" target="Code" class="method-signature"
+            onclick="popupCode('ClientInfo.src/M000053.html');return false;">
+          <span class="method-name">paramsFromXml</span><span class="method-args">(xml,parentname)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+creates params[] array from xml in argument xml
+</p>
+        </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>