<?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: Rev::HttpEncoding</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">Rev::HttpEncoding</td>
</tr>
<tr class="top-aligned-row">
<td><strong>In:</strong></td>
<td>
<a href="../../files/lib/rev/http_client_rb.html">
lib/rev/http_client.rb
</a>
<br />
</td>
</tr>
</table>
</div>
<!-- banner header -->
<div id="bodyContent">
<div id="contextContent">
<div id="description">
<p>
Methods for building HTTP requests
</p>
</div>
</div>
<div id="method-list">
<h3 class="section-bar">Methods</h3>
<div class="name-list">
<a href="#M000018">encode_cookies</a>
<a href="#M000016">encode_field</a>
<a href="#M000017">encode_headers</a>
<a href="#M000012">encode_host</a>
<a href="#M000015">encode_param</a>
<a href="#M000014">encode_query</a>
<a href="#M000013">encode_request</a>
<a href="#M000009">escape</a>
<a href="#M000011">munge_header_keys</a>
<a href="#M000010">unescape</a>
</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">HTTP_REQUEST_HEADER</td>
<td>=</td>
<td class="context-item-value">"%s %s HTTP/1.1\r\n"</td>
</tr>
<tr class="top-aligned-row context-row">
<td class="context-item-name">FIELD_ENCODING</td>
<td>=</td>
<td class="context-item-value">"%s: %s\r\n"</td>
</tr>
</table>
</div>
</div>
<!-- if method_list -->
<div id="methods">
<h3 class="section-bar">Public Instance methods</h3>
<div id="method-M000018" class="method-detail">
<a name="M000018"></a>
<div class="method-heading">
<a href="HttpEncoding.src/M000018.html" target="Code" class="method-signature"
onclick="popupCode('HttpEncoding.src/M000018.html');return false;">
<span class="method-name">encode_cookies</span><span class="method-args">(cookies)</span>
</a>
</div>
<div class="method-description">
</div>
</div>
<div id="method-M000016" class="method-detail">
<a name="M000016"></a>
<div class="method-heading">
<a href="HttpEncoding.src/M000016.html" target="Code" class="method-signature"
onclick="popupCode('HttpEncoding.src/M000016.html');return false;">
<span class="method-name">encode_field</span><span class="method-args">(k, v)</span>
</a>
</div>
<div class="method-description">
<p>
Encode a field in an HTTP header
</p>
</div>
</div>
<div id="method-M000017" class="method-detail">
<a name="M000017"></a>
<div class="method-heading">
<a href="HttpEncoding.src/M000017.html" target="Code" class="method-signature"
onclick="popupCode('HttpEncoding.src/M000017.html');return false;">
<span class="method-name">encode_headers</span><span class="method-args">(head)</span>
</a>
</div>
<div class="method-description">
</div>
</div>
<div id="method-M000012" class="method-detail">
<a name="M000012"></a>
<div class="method-heading">
<a href="HttpEncoding.src/M000012.html" target="Code" class="method-signature"
onclick="popupCode('HttpEncoding.src/M000012.html');return false;">
<span class="method-name">encode_host</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
HTTP is kind of retarded that you have to specify a Host header, but if you
include port 80 then further redirects will tack on the :80 which is
annoying.
</p>
</div>
</div>
<div id="method-M000015" class="method-detail">
<a name="M000015"></a>
<div class="method-heading">
<a href="HttpEncoding.src/M000015.html" target="Code" class="method-signature"
onclick="popupCode('HttpEncoding.src/M000015.html');return false;">
<span class="method-name">encode_param</span><span class="method-args">(k, v)</span>
</a>
</div>
<div class="method-description">
<p>
URL encodes a single k=v parameter.
</p>
</div>
</div>
<div id="method-M000014" class="method-detail">
<a name="M000014"></a>
<div class="method-heading">
<a href="HttpEncoding.src/M000014.html" target="Code" class="method-signature"
onclick="popupCode('HttpEncoding.src/M000014.html');return false;">
<span class="method-name">encode_query</span><span class="method-args">(uri, query)</span>
</a>
</div>
<div class="method-description">
</div>
</div>
<div id="method-M000013" class="method-detail">
<a name="M000013"></a>
<div class="method-heading">
<a href="HttpEncoding.src/M000013.html" target="Code" class="method-signature"
onclick="popupCode('HttpEncoding.src/M000013.html');return false;">
<span class="method-name">encode_request</span><span class="method-args">(method, uri, query)</span>
</a>
</div>
<div class="method-description">
</div>
</div>
<div id="method-M000009" class="method-detail">
<a name="M000009"></a>
<div class="method-heading">
<a href="HttpEncoding.src/M000009.html" target="Code" class="method-signature"
onclick="popupCode('HttpEncoding.src/M000009.html');return false;">
<span class="method-name">escape</span><span class="method-args">(s)</span>
</a>
</div>
<div class="method-description">
<p>
Escapes a URI.
</p>
</div>
</div>
<div id="method-M000011" class="method-detail">
<a name="M000011"></a>
<div class="method-heading">
<a href="HttpEncoding.src/M000011.html" target="Code" class="method-signature"
onclick="popupCode('HttpEncoding.src/M000011.html');return false;">
<span class="method-name">munge_header_keys</span><span class="method-args">(head)</span>
</a>
</div>
<div class="method-description">
<p>
Map all header keys to a downcased string version
</p>
</div>
</div>
<div id="method-M000010" class="method-detail">
<a name="M000010"></a>
<div class="method-heading">
<a href="HttpEncoding.src/M000010.html" target="Code" class="method-signature"
onclick="popupCode('HttpEncoding.src/M000010.html');return false;">
<span class="method-name">unescape</span><span class="method-args">(s)</span>
</a>
</div>
<div class="method-description">
<p>
Unescapes a URI escaped string.
</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>