<?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: RestClient::Payload::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">RestClient::Payload::Base</td> </tr> <tr class="top-aligned-row"> <td><strong>In:</strong></td> <td> <a href="../../../files/lib/rest-client-1_6_3/lib/restclient/payload_rb.html"> lib/rest-client-1.6.3/lib/restclient/payload.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="#M000296">build_stream</a> <a href="#M000304">close</a> <a href="#M000299">flatten_params</a> <a href="#M000300">flatten_params_array</a> <a href="#M000301">headers</a> <a href="#M000305">inspect</a> <a href="#M000303">length</a> <a href="#M000295">new</a> <a href="#M000297">read</a> <a href="#M000306">short_inspect</a> <a href="#M000302">size</a> <a href="#M000298">to_s</a> </div> </div> </div> <!-- if includes --> <div id="section"> <!-- if method_list --> <div id="methods"> <h3 class="section-bar">Public Class methods</h3> <div id="method-M000295" class="method-detail"> <a name="M000295"></a> <div class="method-heading"> <a href="#M000295" class="method-signature"> <span class="method-name">new</span><span class="method-args">(params)</span> </a> </div> <div class="method-description"> <p><a class="source-toggle" href="#" onclick="toggleCode('M000295-source');return false;">[Source]</a></p> <div class="method-source-code" id="M000295-source"> <pre> <span class="ruby-comment cmt"># File lib/rest-client-1.6.3/lib/restclient/payload.rb, line 37</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">params</span>) <span class="ruby-identifier">build_stream</span>(<span class="ruby-identifier">params</span>) <span class="ruby-keyword kw">end</span> </pre> </div> </div> </div> <h3 class="section-bar">Public Instance methods</h3> <div id="method-M000296" class="method-detail"> <a name="M000296"></a> <div class="method-heading"> <a href="#M000296" class="method-signature"> <span class="method-name">build_stream</span><span class="method-args">(params)</span> </a> </div> <div class="method-description"> <p><a class="source-toggle" href="#" onclick="toggleCode('M000296-source');return false;">[Source]</a></p> <div class="method-source-code" id="M000296-source"> <pre> <span class="ruby-comment cmt"># File lib/rest-client-1.6.3/lib/restclient/payload.rb, line 41</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">build_stream</span>(<span class="ruby-identifier">params</span>) <span class="ruby-ivar">@stream</span> = <span class="ruby-constant">StringIO</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">params</span>) <span class="ruby-ivar">@stream</span>.<span class="ruby-identifier">seek</span>(<span class="ruby-value">0</span>) <span class="ruby-keyword kw">end</span> </pre> </div> </div> </div> <div id="method-M000304" class="method-detail"> <a name="M000304"></a> <div class="method-heading"> <a href="#M000304" class="method-signature"> <span class="method-name">close</span><span class="method-args">()</span> </a> </div> <div class="method-description"> <p><a class="source-toggle" href="#" onclick="toggleCode('M000304-source');return false;">[Source]</a></p> <div class="method-source-code" id="M000304-source"> <pre> <span class="ruby-comment cmt"># File lib/rest-client-1.6.3/lib/restclient/payload.rb, line 93</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">close</span> <span class="ruby-ivar">@stream</span>.<span class="ruby-identifier">close</span> <span class="ruby-keyword kw">end</span> </pre> </div> </div> </div> <div id="method-M000299" class="method-detail"> <a name="M000299"></a> <div class="method-heading"> <a href="#M000299" class="method-signature"> <span class="method-name">flatten_params</span><span class="method-args">(params, parent_key = nil)</span> </a> </div> <div class="method-description"> <p> Flatten parameters by converting hashes of hashes to flat hashes {keys1 => {keys2 => value}} will be transformed into [keys1[key2], value] </p> <p><a class="source-toggle" href="#" onclick="toggleCode('M000299-source');return false;">[Source]</a></p> <div class="method-source-code" id="M000299-source"> <pre> <span class="ruby-comment cmt"># File lib/rest-client-1.6.3/lib/restclient/payload.rb, line 54</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">flatten_params</span>(<span class="ruby-identifier">params</span>, <span class="ruby-identifier">parent_key</span> = <span class="ruby-keyword kw">nil</span>) <span class="ruby-identifier">result</span> = [] <span class="ruby-identifier">params</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">key</span>, <span class="ruby-identifier">value</span><span class="ruby-operator">|</span> <span class="ruby-identifier">calculated_key</span> = <span class="ruby-identifier">parent_key</span> <span class="ruby-value">? </span><span class="ruby-node">"#{parent_key}[#{handle_key(key)}]"</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">handle_key</span>(<span class="ruby-identifier">key</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">value</span>.<span class="ruby-identifier">is_a?</span> <span class="ruby-constant">Hash</span> <span class="ruby-identifier">result</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">flatten_params</span>(<span class="ruby-identifier">value</span>, <span class="ruby-identifier">calculated_key</span>) <span class="ruby-keyword kw">elsif</span> <span class="ruby-identifier">value</span>.<span class="ruby-identifier">is_a?</span> <span class="ruby-constant">Array</span> <span class="ruby-identifier">result</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">flatten_params_array</span>(<span class="ruby-identifier">value</span>, <span class="ruby-identifier">calculated_key</span>) <span class="ruby-keyword kw">else</span> <span class="ruby-identifier">result</span> <span class="ruby-operator"><<</span> [<span class="ruby-identifier">calculated_key</span>, <span class="ruby-identifier">value</span>] <span class="ruby-keyword kw">end</span> <span class="ruby-keyword kw">end</span> <span class="ruby-identifier">result</span> <span class="ruby-keyword kw">end</span> </pre> </div> </div> </div> <div id="method-M000300" class="method-detail"> <a name="M000300"></a> <div class="method-heading"> <a href="#M000300" class="method-signature"> <span class="method-name">flatten_params_array</span><span class="method-args">(value, calculated_key)</span> </a> </div> <div class="method-description"> <p><a class="source-toggle" href="#" onclick="toggleCode('M000300-source');return false;">[Source]</a></p> <div class="method-source-code" id="M000300-source"> <pre> <span class="ruby-comment cmt"># File lib/rest-client-1.6.3/lib/restclient/payload.rb, line 69</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">flatten_params_array</span> <span class="ruby-identifier">value</span>, <span class="ruby-identifier">calculated_key</span> <span class="ruby-identifier">result</span> = [] <span class="ruby-identifier">value</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">elem</span><span class="ruby-operator">|</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">elem</span>.<span class="ruby-identifier">is_a?</span> <span class="ruby-constant">Hash</span> <span class="ruby-identifier">result</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">flatten_params</span>(<span class="ruby-identifier">elem</span>, <span class="ruby-identifier">calculated_key</span>) <span class="ruby-keyword kw">elsif</span> <span class="ruby-identifier">elem</span>.<span class="ruby-identifier">is_a?</span> <span class="ruby-constant">Array</span> <span class="ruby-identifier">result</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">flatten_params_array</span>(<span class="ruby-identifier">elem</span>, <span class="ruby-identifier">calculated_key</span>) <span class="ruby-keyword kw">else</span> <span class="ruby-identifier">result</span> <span class="ruby-operator"><<</span> [<span class="ruby-node">"#{calculated_key}[]"</span>, <span class="ruby-identifier">elem</span>] <span class="ruby-keyword kw">end</span> <span class="ruby-keyword kw">end</span> <span class="ruby-identifier">result</span> <span class="ruby-keyword kw">end</span> </pre> </div> </div> </div> <div id="method-M000301" class="method-detail"> <a name="M000301"></a> <div class="method-heading"> <a href="#M000301" class="method-signature"> <span class="method-name">headers</span><span class="method-args">()</span> </a> </div> <div class="method-description"> <p><a class="source-toggle" href="#" onclick="toggleCode('M000301-source');return false;">[Source]</a></p> <div class="method-source-code" id="M000301-source"> <pre> <span class="ruby-comment cmt"># File lib/rest-client-1.6.3/lib/restclient/payload.rb, line 83</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">headers</span> {<span class="ruby-value str">'Content-Length'</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">size</span>.<span class="ruby-identifier">to_s</span>} <span class="ruby-keyword kw">end</span> </pre> </div> </div> </div> <div id="method-M000305" class="method-detail"> <a name="M000305"></a> <div class="method-heading"> <a href="#M000305" class="method-signature"> <span class="method-name">inspect</span><span class="method-args">()</span> </a> </div> <div class="method-description"> <p><a class="source-toggle" href="#" onclick="toggleCode('M000305-source');return false;">[Source]</a></p> <div class="method-source-code" id="M000305-source"> <pre> <span class="ruby-comment cmt"># File lib/rest-client-1.6.3/lib/restclient/payload.rb, line 97</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">inspect</span> <span class="ruby-identifier">result</span> = <span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">inspect</span> <span class="ruby-ivar">@stream</span>.<span class="ruby-identifier">seek</span>(<span class="ruby-value">0</span>) <span class="ruby-identifier">result</span> <span class="ruby-keyword kw">end</span> </pre> </div> </div> </div> <div id="method-M000303" class="method-detail"> <a name="M000303"></a> <div class="method-heading"> <span class="method-name">length</span><span class="method-args">()</span> </div> <div class="method-description"> <p> Alias for <a href="Base.html#M000302">size</a> </p> </div> </div> <div id="method-M000297" class="method-detail"> <a name="M000297"></a> <div class="method-heading"> <a href="#M000297" class="method-signature"> <span class="method-name">read</span><span class="method-args">(bytes=nil)</span> </a> </div> <div class="method-description"> <p><a class="source-toggle" href="#" onclick="toggleCode('M000297-source');return false;">[Source]</a></p> <div class="method-source-code" id="M000297-source"> <pre> <span class="ruby-comment cmt"># File lib/rest-client-1.6.3/lib/restclient/payload.rb, line 46</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">read</span>(<span class="ruby-identifier">bytes</span>=<span class="ruby-keyword kw">nil</span>) <span class="ruby-ivar">@stream</span>.<span class="ruby-identifier">read</span>(<span class="ruby-identifier">bytes</span>) <span class="ruby-keyword kw">end</span> </pre> </div> </div> </div> <div id="method-M000306" class="method-detail"> <a name="M000306"></a> <div class="method-heading"> <a href="#M000306" class="method-signature"> <span class="method-name">short_inspect</span><span class="method-args">()</span> </a> </div> <div class="method-description"> <p><a class="source-toggle" href="#" onclick="toggleCode('M000306-source');return false;">[Source]</a></p> <div class="method-source-code" id="M000306-source"> <pre> <span class="ruby-comment cmt"># File lib/rest-client-1.6.3/lib/restclient/payload.rb, line 103</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">short_inspect</span> (<span class="ruby-identifier">size</span> <span class="ruby-operator">></span> <span class="ruby-value">500</span> <span class="ruby-operator">?</span> <span class="ruby-node">"#{size} byte(s) length"</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">inspect</span>) <span class="ruby-keyword kw">end</span> </pre> </div> </div> </div> <div id="method-M000302" class="method-detail"> <a name="M000302"></a> <div class="method-heading"> <a href="#M000302" class="method-signature"> <span class="method-name">size</span><span class="method-args">()</span> </a> </div> <div class="method-description"> <p><a class="source-toggle" href="#" onclick="toggleCode('M000302-source');return false;">[Source]</a></p> <div class="method-source-code" id="M000302-source"> <pre> <span class="ruby-comment cmt"># File lib/rest-client-1.6.3/lib/restclient/payload.rb, line 87</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">size</span> <span class="ruby-ivar">@stream</span>.<span class="ruby-identifier">size</span> <span class="ruby-keyword kw">end</span> </pre> </div> </div> </div> <div id="method-M000298" class="method-detail"> <a name="M000298"></a> <div class="method-heading"> <span class="method-name">to_s</span><span class="method-args">(bytes=nil)</span> </div> <div class="method-description"> <p> Alias for <a href="Base.html#M000297">read</a> </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>