mirror of
https://github.com/mistergibson/gxg-framework.git
synced 2026-08-15 03:46:00 -07:00
848 lines
86 KiB
HTML
848 lines
86 KiB
HTML
<!DOCTYPE html>
|
|
|
|
<html>
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
|
|
<title>class GxG::Networking::HttpClient - 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-clear_cache">#clear_cache</a>
|
|
|
|
<li ><a href="#method-i-cookies">#cookies</a>
|
|
|
|
<li ><a href="#method-i-delete">#delete</a>
|
|
|
|
<li ><a href="#method-i-get">#get</a>
|
|
|
|
<li ><a href="#method-i-post">#post</a>
|
|
|
|
<li ><a href="#method-i-put">#put</a>
|
|
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</nav>
|
|
|
|
<main role="main" aria-labelledby="class-GxG::Networking::HttpClient">
|
|
<h1 id="class-GxG::Networking::HttpClient" class="class">
|
|
class GxG::Networking::HttpClient
|
|
</h1>
|
|
|
|
<section class="description">
|
|
|
|
</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 5228</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>()
|
|
<span class="ruby-ivar">@cookie</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-clear_cache" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">clear_cache</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="clear_cache-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 5233</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">clear_cache</span>()
|
|
<span class="ruby-ivar">@cookie</span> = <span class="ruby-keyword">nil</span>
|
|
<span class="ruby-keyword">true</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method-i-cookies" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">cookies</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="cookies-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 5238</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">cookies</span>()
|
|
<span class="ruby-ivar">@cookie</span>.<span class="ruby-identifier">clone</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method-i-delete" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">delete</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="delete-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 5635</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">delete</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">options</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Hash</span>)
|
|
<span class="ruby-identifier">options</span> = {}
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">scheme</span>.<span class="ruby-identifier">downcase</span> <span class="ruby-operator">==</span> <span class="ruby-string">"https"</span>
|
|
<span class="ruby-identifier">options</span>[<span class="ruby-value">:use_ssl</span>] = <span class="ruby-keyword">true</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">is_any?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">URI</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTP</span>, <span class="ruby-operator">::</span><span class="ruby-constant">URI</span><span class="ruby-operator">::</span><span class="ruby-constant">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">port</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">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:proxy</span>].<span class="ruby-identifier">user</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:proxy</span>].<span class="ruby-identifier">password</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">user</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">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">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-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-identifier">keys</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span>
|
|
<span class="ruby-identifier">client_parameters</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">options</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-identifier">server</span> = <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTP</span>.<span class="ruby-identifier">start</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">client_parameters</span>)
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:pem_file</span>].<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">String</span>)
|
|
<span class="ruby-identifier">pem_file</span> = <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">read</span>(<span class="ruby-identifier">options</span>[<span class="ruby-value">:pem_file</span>])
|
|
<span class="ruby-identifier">server</span>.<span class="ruby-identifier">use_ssl</span> = <span class="ruby-keyword">true</span>
|
|
<span class="ruby-identifier">server</span>.<span class="ruby-identifier">cert</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">X509</span><span class="ruby-operator">::</span><span class="ruby-constant">Certificate</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">pem_file</span>)
|
|
<span class="ruby-identifier">server</span>.<span class="ruby-identifier">key</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">PKey</span><span class="ruby-operator">::</span><span class="ruby-constant">RSA</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">pem_file</span>, <span class="ruby-identifier">options</span>[<span class="ruby-value">:pem_password</span>])
|
|
<span class="ruby-identifier">server</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_PEER</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@cookie</span>
|
|
<span class="ruby-identifier">request</span> = <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTP</span><span class="ruby-operator">::</span><span class="ruby-constant">Delete</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">request_uri</span>, {<span class="ruby-string">'Cookie'</span> <span class="ruby-operator">=></span> <span class="ruby-ivar">@cookie</span>})
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-identifier">request</span> = <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTP</span><span class="ruby-operator">::</span><span class="ruby-constant">Delete</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">request_uri</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-comment"># basic auth</span>
|
|
<span class="ruby-identifier">request</span>.<span class="ruby-identifier">basic_auth</span>(<span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">user</span>, <span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">password</span>)
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-identifier">response</span> = <span class="ruby-identifier">server</span>.<span class="ruby-identifier">request</span>(<span class="ruby-identifier">request</span>)
|
|
<span class="ruby-identifier">response_code</span> = <span class="ruby-identifier">response</span>.<span class="ruby-identifier">code</span>.<span class="ruby-identifier">to_i</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:follow_redirects</span>]
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">response_code</span> <span class="ruby-operator">>=</span> <span class="ruby-value">300</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">response_code</span> <span class="ruby-operator"><</span> <span class="ruby-value">400</span>
|
|
<span class="ruby-comment"># Process Redirect</span>
|
|
<span class="ruby-identifier">redirect_count</span> = <span class="ruby-value">1</span>
|
|
<span class="ruby-identifier">location</span> = <span class="ruby-identifier">response</span>[<span class="ruby-string">'location'</span>]
|
|
<span class="ruby-keyword">while</span> <span class="ruby-identifier">location</span> <span class="ruby-keyword">do</span>
|
|
<span class="ruby-comment">#</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@cookie</span>
|
|
<span class="ruby-identifier">redirect_request</span> = <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTP</span><span class="ruby-operator">::</span><span class="ruby-constant">Delete</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">location</span>, {<span class="ruby-string">'Cookie'</span> <span class="ruby-operator">=></span> <span class="ruby-ivar">@cookie</span>})
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-identifier">redirect_request</span> = <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTP</span><span class="ruby-operator">::</span><span class="ruby-constant">Delete</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">location</span>)
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-identifier">redirect_response</span> = <span class="ruby-identifier">server</span>.<span class="ruby-identifier">request</span>(<span class="ruby-identifier">redirect_request</span>)
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">redirect_response</span>.<span class="ruby-identifier">code</span>.<span class="ruby-identifier">to_i</span> <span class="ruby-operator">==</span> <span class="ruby-value">200</span>
|
|
<span class="ruby-identifier">response</span> = <span class="ruby-identifier">redirect_response</span>
|
|
<span class="ruby-identifier">response_code</span> = <span class="ruby-value">200</span>
|
|
<span class="ruby-keyword">break</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">redirect_response</span>[<span class="ruby-string">'location'</span>]
|
|
<span class="ruby-identifier">redirect_count</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">redirect_count</span> <span class="ruby-operator">></span> <span class="ruby-value">9</span>
|
|
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Exception</span>, <span class="ruby-string">"Circular redirect chain suspected (10 or more redirects)"</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-identifier">response_code</span> = <span class="ruby-identifier">redirect_response</span>.<span class="ruby-identifier">code</span>.<span class="ruby-identifier">to_i</span>
|
|
<span class="ruby-identifier">location</span> = <span class="ruby-identifier">redirect_response</span>[<span class="ruby-string">'location'</span>]
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-keyword">break</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-comment">#</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">response</span>.<span class="ruby-identifier">code</span>.<span class="ruby-identifier">to_i</span> <span class="ruby-operator">==</span> <span class="ruby-value">200</span>
|
|
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">true</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Exception</span>, <span class="ruby-node">"Error occured: Code #{response.code}"</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Exception</span>, <span class="ruby-string">"You MUST provide a valid HTTP URI"</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">:url</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_url</span>, <span class="ruby-value">:options</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">options</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-get" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">get</span><span
|
|
class="method-args">(the_url=nil, options={:follow_redirects => true})</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="get-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 5242</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">get</span>(<span class="ruby-identifier">the_url</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">options</span>={<span class="ruby-value">:follow_redirects</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">true</span>})
|
|
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">nil</span>
|
|
<span class="ruby-keyword">begin</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">is_any?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">URI</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTP</span>, <span class="ruby-operator">::</span><span class="ruby-constant">URI</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTPS</span>)
|
|
<span class="ruby-identifier">the_url</span> = <span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">dup</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:query</span>].<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Hash</span>)
|
|
<span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">query</span> = <span class="ruby-operator">::</span><span class="ruby-constant">URI</span>.<span class="ruby-identifier">encode_www_form</span>(<span class="ruby-identifier">options</span>[<span class="ruby-value">:query</span>])
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:follow_redirects</span>] <span class="ruby-operator">==</span> <span class="ruby-keyword">false</span>
|
|
<span class="ruby-identifier">options</span>.<span class="ruby-identifier">merge</span>({<span class="ruby-value">:follow_redirects</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">true</span>})
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-comment">#</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">scheme</span>.<span class="ruby-identifier">downcase</span> <span class="ruby-operator">==</span> <span class="ruby-string">"https"</span>
|
|
<span class="ruby-identifier">options</span>[<span class="ruby-value">:use_ssl</span>] = <span class="ruby-keyword">true</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-comment"># sets following values by its accessor.</span>
|
|
<span class="ruby-comment"># The keys are ca_file, ca_path, cert, cert_store, ciphers,</span>
|
|
<span class="ruby-comment"># close_on_empty_response, key, open_timeout, read_timeout, ssl_timeout,</span>
|
|
<span class="ruby-comment"># ssl_version, use_ssl, verify_callback, verify_depth and verify_mode.</span>
|
|
<span class="ruby-comment"># If you set :use_ssl as true, you can use https and default value of</span>
|
|
<span class="ruby-comment"># verify_mode is set as OpenSSL::SSL::VERIFY_PEER.</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">port</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">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:proxy</span>].<span class="ruby-identifier">user</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:proxy</span>].<span class="ruby-identifier">password</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">user</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">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">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-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-identifier">keys</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span>
|
|
<span class="ruby-identifier">client_parameters</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">options</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-identifier">client</span> = <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTP</span>.<span class="ruby-identifier">start</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">client_parameters</span>)
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:pem_file</span>].<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">String</span>)
|
|
<span class="ruby-identifier">pem_file</span> = <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">read</span>(<span class="ruby-identifier">options</span>[<span class="ruby-value">:pem_file</span>])
|
|
<span class="ruby-identifier">client</span>.<span class="ruby-identifier">use_ssl</span> = <span class="ruby-keyword">true</span>
|
|
<span class="ruby-identifier">client</span>.<span class="ruby-identifier">cert</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">X509</span><span class="ruby-operator">::</span><span class="ruby-constant">Certificate</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">pem_file</span>)
|
|
<span class="ruby-identifier">client</span>.<span class="ruby-identifier">key</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">PKey</span><span class="ruby-operator">::</span><span class="ruby-constant">RSA</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">pem_file</span>, <span class="ruby-identifier">options</span>[<span class="ruby-value">:pem_password</span>])
|
|
<span class="ruby-identifier">client</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_PEER</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@cookie</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:header</span>].<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Hash</span>)
|
|
<span class="ruby-identifier">request</span> = <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTP</span><span class="ruby-operator">::</span><span class="ruby-constant">Get</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">request_uri</span>, {<span class="ruby-string">'Cookie'</span> <span class="ruby-operator">=></span> <span class="ruby-ivar">@cookie</span>}.<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">options</span>[<span class="ruby-value">:header</span>]))
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-identifier">request</span> = <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTP</span><span class="ruby-operator">::</span><span class="ruby-constant">Get</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">request_uri</span>, {<span class="ruby-string">'Cookie'</span> <span class="ruby-operator">=></span> <span class="ruby-ivar">@cookie</span>})
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:header</span>].<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Hash</span>)
|
|
<span class="ruby-identifier">request</span> = <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTP</span><span class="ruby-operator">::</span><span class="ruby-constant">Get</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">request_uri</span>, <span class="ruby-identifier">options</span>[<span class="ruby-value">:header</span>])
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-identifier">request</span> = <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTP</span><span class="ruby-operator">::</span><span class="ruby-constant">Get</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">request_uri</span>)
|
|
<span class="ruby-keyword">end</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-comment"># basic auth</span>
|
|
<span class="ruby-identifier">request</span>.<span class="ruby-identifier">basic_auth</span>(<span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">user</span>, <span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">password</span>)
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-identifier">response</span> = <span class="ruby-identifier">client</span>.<span class="ruby-identifier">request</span>(<span class="ruby-identifier">request</span>)
|
|
<span class="ruby-ivar">@cookie</span> = <span class="ruby-identifier">response</span>.<span class="ruby-identifier">response</span>[<span class="ruby-string">'set-cookie'</span>]
|
|
<span class="ruby-identifier">response_code</span> = <span class="ruby-identifier">response</span>.<span class="ruby-identifier">code</span>.<span class="ruby-identifier">to_i</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:follow_redirects</span>]
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">response_code</span> <span class="ruby-operator">>=</span> <span class="ruby-value">300</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">response_code</span> <span class="ruby-operator"><</span> <span class="ruby-value">400</span>
|
|
<span class="ruby-comment"># Process Redirect</span>
|
|
<span class="ruby-identifier">redirect_count</span> = <span class="ruby-value">1</span>
|
|
<span class="ruby-identifier">location</span> = <span class="ruby-identifier">response</span>[<span class="ruby-string">'location'</span>]
|
|
<span class="ruby-keyword">while</span> <span class="ruby-identifier">location</span> <span class="ruby-keyword">do</span>
|
|
<span class="ruby-comment">#</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@cookie</span>
|
|
<span class="ruby-identifier">redirect_request</span> = <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTP</span><span class="ruby-operator">::</span><span class="ruby-constant">Get</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">location</span>, {<span class="ruby-string">'Cookie'</span> <span class="ruby-operator">=></span> <span class="ruby-ivar">@cookie</span>})
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-identifier">redirect_request</span> = <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTP</span><span class="ruby-operator">::</span><span class="ruby-constant">Get</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">location</span>)
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-identifier">redirect_response</span> = <span class="ruby-identifier">client</span>.<span class="ruby-identifier">request</span>(<span class="ruby-identifier">redirect_request</span>)
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">redirect_response</span>.<span class="ruby-identifier">code</span>.<span class="ruby-identifier">to_i</span> <span class="ruby-operator">==</span> <span class="ruby-value">200</span>
|
|
<span class="ruby-identifier">response</span> = <span class="ruby-identifier">redirect_response</span>
|
|
<span class="ruby-identifier">response_code</span> = <span class="ruby-value">200</span>
|
|
<span class="ruby-ivar">@cookie</span> = <span class="ruby-identifier">response</span>.<span class="ruby-identifier">response</span>[<span class="ruby-string">'set-cookie'</span>]
|
|
<span class="ruby-keyword">break</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">redirect_response</span>[<span class="ruby-string">'location'</span>]
|
|
<span class="ruby-ivar">@cookie</span> = <span class="ruby-identifier">redirect_response</span>.<span class="ruby-identifier">response</span>[<span class="ruby-string">'set-cookie'</span>]
|
|
<span class="ruby-identifier">redirect_count</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">redirect_count</span> <span class="ruby-operator">></span> <span class="ruby-value">9</span>
|
|
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Exception</span>, <span class="ruby-string">"Circular redirect chain suspected (10 or more redirects)"</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-identifier">response_code</span> = <span class="ruby-identifier">redirect_response</span>.<span class="ruby-identifier">code</span>.<span class="ruby-identifier">to_i</span>
|
|
<span class="ruby-identifier">location</span> = <span class="ruby-identifier">redirect_response</span>[<span class="ruby-string">'location'</span>]
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-keyword">break</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-comment">#</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:save_as</span>].<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">String</span>)
|
|
<span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-identifier">options</span>[<span class="ruby-value">:save_as</span>].<span class="ruby-identifier">to_s</span>, <span class="ruby-string">'w'</span>, <span class="ruby-value">0644</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">the_io</span><span class="ruby-operator">|</span>
|
|
<span class="ruby-identifier">response</span>.<span class="ruby-identifier">read_body</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">data_chunk</span><span class="ruby-operator">|</span>
|
|
<span class="ruby-identifier">the_io</span>.<span class="ruby-identifier">write</span>(<span class="ruby-identifier">data_chunk</span>)
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-comment"># Return open file handle r/w to saved file.</span>
|
|
<span class="ruby-identifier">result</span> = <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-identifier">the_io</span>.<span class="ruby-identifier">path</span>, <span class="ruby-string">"w+"</span>)
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:stream_to</span>].<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-constant">Database</span><span class="ruby-operator">::</span><span class="ruby-constant">PersistedArray</span>)
|
|
<span class="ruby-identifier">the_accumulator</span> = <span class="ruby-identifier">options</span>[<span class="ruby-value">:stream_to</span>]
|
|
<span class="ruby-identifier">buffer</span> = <span class="ruby-operator">::</span><span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-constant">ByteArray</span>.<span class="ruby-identifier">new</span>
|
|
<span class="ruby-identifier">response</span>.<span class="ruby-identifier">read_body</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">data_chunk</span><span class="ruby-operator">|</span>
|
|
<span class="ruby-identifier">chunk_ranges</span> = <span class="ruby-operator">::</span><span class="ruby-constant">GxG</span>.<span class="ruby-identifier">apportioned_ranges</span>(<span class="ruby-identifier">data_chunk</span>.<span class="ruby-identifier">bytesize</span>,<span class="ruby-value">65536</span>)
|
|
<span class="ruby-identifier">chunk_ranges</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">the_range</span><span class="ruby-operator">|</span>
|
|
<span class="ruby-keyword">if</span> (<span class="ruby-identifier">buffer</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">data_chunk</span>[(<span class="ruby-identifier">the_range</span>)].<span class="ruby-identifier">bytesize</span>) <span class="ruby-operator"><=</span> <span class="ruby-value">65536</span>
|
|
<span class="ruby-identifier">buffer</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">data_chunk</span>[(<span class="ruby-identifier">the_range</span>)]
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">buffer</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">==</span> <span class="ruby-value">65536</span>
|
|
<span class="ruby-identifier">the_accumulator</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">buffer</span>.<span class="ruby-identifier">clone</span>
|
|
<span class="ruby-identifier">the_accumulator</span>[(<span class="ruby-identifier">the_accumulator</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">-</span> <span class="ruby-value">1</span>)].<span class="ruby-identifier">unload</span>
|
|
<span class="ruby-identifier">buffer</span>.<span class="ruby-identifier">clear</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-identifier">the_size</span> = <span class="ruby-identifier">buffer</span>.<span class="ruby-identifier">size</span>
|
|
<span class="ruby-identifier">buffer</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">data_chunk</span>[(<span class="ruby-identifier">the_range</span>)][(<span class="ruby-value">0</span><span class="ruby-operator">..</span>((<span class="ruby-value">65536</span> <span class="ruby-operator">-</span> <span class="ruby-identifier">the_size</span>) <span class="ruby-operator">-</span> <span class="ruby-value">1</span>))]
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">buffer</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">==</span> <span class="ruby-value">65536</span>
|
|
<span class="ruby-identifier">the_accumulator</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">buffer</span>.<span class="ruby-identifier">clone</span>
|
|
<span class="ruby-identifier">the_accumulator</span>[(<span class="ruby-identifier">the_accumulator</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">-</span> <span class="ruby-value">1</span>)].<span class="ruby-identifier">unload</span>
|
|
<span class="ruby-identifier">buffer</span>.<span class="ruby-identifier">clear</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-identifier">buffer</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">data_chunk</span>[(<span class="ruby-identifier">the_range</span>)][((<span class="ruby-value">65536</span> <span class="ruby-operator">-</span> <span class="ruby-identifier">the_size</span>)<span class="ruby-operator">..</span><span class="ruby-value">-1</span>)]
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-comment">#</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">buffer</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span>
|
|
<span class="ruby-identifier">the_accumulator</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">buffer</span>.<span class="ruby-identifier">clone</span>
|
|
<span class="ruby-identifier">the_accumulator</span>[(<span class="ruby-identifier">the_accumulator</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">-</span> <span class="ruby-value">1</span>)].<span class="ruby-identifier">unload</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">response_code</span> <span class="ruby-operator">==</span> <span class="ruby-value">200</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:save_as</span>] <span class="ruby-operator">==</span> <span class="ruby-keyword">nil</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:stream_to</span>] <span class="ruby-operator">==</span> <span class="ruby-keyword">nil</span>
|
|
<span class="ruby-comment"># Process response</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:raw_response</span>]
|
|
<span class="ruby-identifier">result</span> = <span class="ruby-identifier">response</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:to_ruby</span>] <span class="ruby-operator">==</span> <span class="ruby-keyword">true</span>
|
|
<span class="ruby-identifier">response_hash</span> = {}
|
|
<span class="ruby-identifier">response_hash</span> = <span class="ruby-identifier">response</span>.<span class="ruby-identifier">to_hash</span>.<span class="ruby-identifier">process</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">entry</span>, <span class="ruby-identifier">the_key</span><span class="ruby-operator">|</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_key</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Symbol</span>)
|
|
<span class="ruby-identifier">entry</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-identifier">returns</span>({<span class="ruby-value">:new_selector</span> <span class="ruby-operator">=></span> (<span class="ruby-identifier">the_key</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">to_sym</span>), <span class="ruby-value">:result</span> <span class="ruby-operator">=></span> (<span class="ruby-identifier">entry</span>)})
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-identifier">response_hash</span>[<span class="ruby-value">:header</span>] = <span class="ruby-identifier">response</span>.<span class="ruby-identifier">header</span>
|
|
<span class="ruby-comment">#</span>
|
|
<span class="ruby-identifier">body_text</span> = (<span class="ruby-identifier">response</span>.<span class="ruby-identifier">body</span>.<span class="ruby-identifier">transcode</span>({<span class="ruby-value">:replace</span> <span class="ruby-operator">=></span> <span class="ruby-string">"."</span>},<span class="ruby-operator">::</span><span class="ruby-constant">Encoding</span><span class="ruby-operator">::</span><span class="ruby-constant">UTF_8</span>))
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">body_text</span>.<span class="ruby-identifier">xml?</span>()
|
|
<span class="ruby-identifier">response_hash</span>[<span class="ruby-value">:body</span>] = <span class="ruby-identifier">body_text</span>.<span class="ruby-identifier">from_xml</span>()
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">body_text</span>.<span class="ruby-identifier">html?</span>()
|
|
<span class="ruby-identifier">response_hash</span>[<span class="ruby-value">:body</span>] = <span class="ruby-identifier">body_text</span>.<span class="ruby-identifier">from_html</span>()
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Exception</span>, <span class="ruby-string">"Failed to retrieve either XML or HTML as data."</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-comment">#</span>
|
|
<span class="ruby-identifier">result</span> = <span class="ruby-identifier">response_hash</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-comment"># Default output:</span>
|
|
<span class="ruby-identifier">result</span> = <span class="ruby-identifier">response</span>.<span class="ruby-identifier">body</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:save_as</span>]
|
|
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Exception</span>, <span class="ruby-node">"Error occured: Code #{response.code}"</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Exception</span>, <span class="ruby-string">"You MUST provide a valid HTTP URI"</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">:url</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_url</span>, <span class="ruby-value">:options</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">options</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-post" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">post</span><span
|
|
class="method-args">(the_url=nil, form_data=nil, options={})</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="post-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 5534</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">post</span>(<span class="ruby-identifier">the_url</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">form_data</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">options</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Hash</span>)
|
|
<span class="ruby-identifier">options</span> = {}
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">scheme</span>.<span class="ruby-identifier">downcase</span> <span class="ruby-operator">==</span> <span class="ruby-string">"https"</span>
|
|
<span class="ruby-identifier">options</span>[<span class="ruby-value">:use_ssl</span>] = <span class="ruby-keyword">true</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">is_any?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">URI</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTP</span>, <span class="ruby-operator">::</span><span class="ruby-constant">URI</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTPS</span>)
|
|
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">form_data</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Hash</span>)
|
|
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Exception</span>, <span class="ruby-string">"You MUST provide valid form data (in the form of a Hash)"</span>
|
|
<span class="ruby-keyword">end</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">port</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">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:proxy</span>].<span class="ruby-identifier">user</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:proxy</span>].<span class="ruby-identifier">password</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">user</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">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">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-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-identifier">keys</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span>
|
|
<span class="ruby-identifier">client_parameters</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">options</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-identifier">server</span> = <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTP</span>.<span class="ruby-identifier">start</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">client_parameters</span>)
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:pem_file</span>].<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">String</span>)
|
|
<span class="ruby-identifier">pem_file</span> = <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">read</span>(<span class="ruby-identifier">options</span>[<span class="ruby-value">:pem_file</span>])
|
|
<span class="ruby-identifier">server</span>.<span class="ruby-identifier">use_ssl</span> = <span class="ruby-keyword">true</span>
|
|
<span class="ruby-identifier">server</span>.<span class="ruby-identifier">cert</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">X509</span><span class="ruby-operator">::</span><span class="ruby-constant">Certificate</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">pem_file</span>)
|
|
<span class="ruby-identifier">server</span>.<span class="ruby-identifier">key</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">PKey</span><span class="ruby-operator">::</span><span class="ruby-constant">RSA</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">pem_file</span>, <span class="ruby-identifier">options</span>[<span class="ruby-value">:pem_password</span>])
|
|
<span class="ruby-identifier">server</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_PEER</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@cookie</span>
|
|
<span class="ruby-identifier">request</span> = <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTP</span><span class="ruby-operator">::</span><span class="ruby-constant">Post</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">request_uri</span>, {<span class="ruby-string">'Cookie'</span> <span class="ruby-operator">=></span> <span class="ruby-ivar">@cookie</span>})
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-identifier">request</span> = <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTP</span><span class="ruby-operator">::</span><span class="ruby-constant">Post</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">request_uri</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-comment"># basic auth</span>
|
|
<span class="ruby-identifier">request</span>.<span class="ruby-identifier">basic_auth</span>(<span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">user</span>, <span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">password</span>)
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-identifier">request</span>.<span class="ruby-identifier">set_form_data</span>(<span class="ruby-identifier">form_data</span>)
|
|
<span class="ruby-identifier">response</span> = <span class="ruby-identifier">server</span>.<span class="ruby-identifier">request</span>(<span class="ruby-identifier">request</span>)
|
|
<span class="ruby-identifier">response_code</span> = <span class="ruby-identifier">response</span>.<span class="ruby-identifier">code</span>.<span class="ruby-identifier">to_i</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:follow_redirects</span>]
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">response_code</span> <span class="ruby-operator">>=</span> <span class="ruby-value">300</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">response_code</span> <span class="ruby-operator"><</span> <span class="ruby-value">400</span>
|
|
<span class="ruby-comment"># Process Redirect</span>
|
|
<span class="ruby-identifier">redirect_count</span> = <span class="ruby-value">1</span>
|
|
<span class="ruby-identifier">location</span> = <span class="ruby-identifier">response</span>[<span class="ruby-string">'location'</span>]
|
|
<span class="ruby-keyword">while</span> <span class="ruby-identifier">location</span> <span class="ruby-keyword">do</span>
|
|
<span class="ruby-comment">#</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@cookie</span>
|
|
<span class="ruby-identifier">redirect_request</span> = <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTP</span><span class="ruby-operator">::</span><span class="ruby-constant">Post</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">location</span>, {<span class="ruby-string">'Cookie'</span> <span class="ruby-operator">=></span> <span class="ruby-ivar">@cookie</span>})
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-identifier">redirect_request</span> = <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTP</span><span class="ruby-operator">::</span><span class="ruby-constant">Post</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">location</span>)
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-identifier">redirect_request</span>.<span class="ruby-identifier">set_form_data</span>(<span class="ruby-identifier">form_data</span>)
|
|
<span class="ruby-identifier">redirect_response</span> = <span class="ruby-identifier">server</span>.<span class="ruby-identifier">request</span>(<span class="ruby-identifier">redirect_request</span>)
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">redirect_response</span>.<span class="ruby-identifier">code</span>.<span class="ruby-identifier">to_i</span> <span class="ruby-operator">==</span> <span class="ruby-value">200</span>
|
|
<span class="ruby-identifier">response</span> = <span class="ruby-identifier">redirect_response</span>
|
|
<span class="ruby-identifier">response_code</span> = <span class="ruby-value">200</span>
|
|
<span class="ruby-keyword">break</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">redirect_response</span>[<span class="ruby-string">'location'</span>]
|
|
<span class="ruby-identifier">redirect_count</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">redirect_count</span> <span class="ruby-operator">></span> <span class="ruby-value">9</span>
|
|
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Exception</span>, <span class="ruby-string">"Circular redirect chain suspected (10 or more redirects)"</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-identifier">response_code</span> = <span class="ruby-identifier">redirect_response</span>.<span class="ruby-identifier">code</span>.<span class="ruby-identifier">to_i</span>
|
|
<span class="ruby-identifier">location</span> = <span class="ruby-identifier">redirect_response</span>[<span class="ruby-string">'location'</span>]
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-keyword">break</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-comment">#</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">response</span>.<span class="ruby-identifier">code</span>.<span class="ruby-identifier">to_i</span> <span class="ruby-operator">==</span> <span class="ruby-value">200</span>
|
|
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">true</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Exception</span>, <span class="ruby-node">"Error occured: Code #{response.code}"</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Exception</span>, <span class="ruby-string">"You MUST provide a valid HTTP URI"</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">:url</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_url</span>, <span class="ruby-value">:form_data</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">form_data</span>, <span class="ruby-value">:options</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">options</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-put" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">put</span><span
|
|
class="method-args">(the_url=nil, data=nil, options={})</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="put-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 5433</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">put</span>(<span class="ruby-identifier">the_url</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">data</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">options</span>={})
|
|
<span class="ruby-comment">#</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">options</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Hash</span>)
|
|
<span class="ruby-identifier">options</span> = {}
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">scheme</span>.<span class="ruby-identifier">downcase</span> <span class="ruby-operator">==</span> <span class="ruby-string">"https"</span>
|
|
<span class="ruby-identifier">options</span>[<span class="ruby-value">:use_ssl</span>] = <span class="ruby-keyword">true</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">is_any?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">URI</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTP</span>, <span class="ruby-operator">::</span><span class="ruby-constant">URI</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTPS</span>)
|
|
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">data</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">Exception</span>, <span class="ruby-string">"You MUST provide valid PUT data (in the form of a String: 'parameter = value')"</span>
|
|
<span class="ruby-keyword">end</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">port</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">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:proxy</span>].<span class="ruby-identifier">user</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:proxy</span>].<span class="ruby-identifier">password</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">user</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">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">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-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-identifier">keys</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span>
|
|
<span class="ruby-identifier">client_parameters</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">options</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-identifier">server</span> = <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTP</span>.<span class="ruby-identifier">start</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">client_parameters</span>)
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:pem_file</span>].<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">String</span>)
|
|
<span class="ruby-identifier">pem_file</span> = <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">read</span>(<span class="ruby-identifier">options</span>[<span class="ruby-value">:pem_file</span>])
|
|
<span class="ruby-identifier">server</span>.<span class="ruby-identifier">use_ssl</span> = <span class="ruby-keyword">true</span>
|
|
<span class="ruby-identifier">server</span>.<span class="ruby-identifier">cert</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">X509</span><span class="ruby-operator">::</span><span class="ruby-constant">Certificate</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">pem_file</span>)
|
|
<span class="ruby-identifier">server</span>.<span class="ruby-identifier">key</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">PKey</span><span class="ruby-operator">::</span><span class="ruby-constant">RSA</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">pem_file</span>, <span class="ruby-identifier">options</span>[<span class="ruby-value">:pem_password</span>])
|
|
<span class="ruby-identifier">server</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_PEER</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-comment">#</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@cookie</span>
|
|
<span class="ruby-identifier">request</span> = <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTP</span><span class="ruby-operator">::</span><span class="ruby-constant">Put</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">request_uri</span>,<span class="ruby-identifier">data</span>, {<span class="ruby-string">'Cookie'</span> <span class="ruby-operator">=></span> <span class="ruby-ivar">@cookie</span>})
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-identifier">request</span> = <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTP</span><span class="ruby-operator">::</span><span class="ruby-constant">Put</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">request_uri</span>,<span class="ruby-identifier">data</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-comment"># basic auth</span>
|
|
<span class="ruby-identifier">request</span>.<span class="ruby-identifier">basic_auth</span>(<span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">user</span>, <span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">password</span>)
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-identifier">response</span> = <span class="ruby-identifier">server</span>.<span class="ruby-identifier">request</span>(<span class="ruby-identifier">request</span>)
|
|
<span class="ruby-identifier">response_code</span> = <span class="ruby-identifier">response</span>.<span class="ruby-identifier">code</span>.<span class="ruby-identifier">to_i</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:follow_redirects</span>]
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">response_code</span> <span class="ruby-operator">>=</span> <span class="ruby-value">300</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">response_code</span> <span class="ruby-operator"><</span> <span class="ruby-value">400</span>
|
|
<span class="ruby-comment"># Process Redirect</span>
|
|
<span class="ruby-identifier">redirect_count</span> = <span class="ruby-value">1</span>
|
|
<span class="ruby-identifier">location</span> = <span class="ruby-identifier">response</span>[<span class="ruby-string">'location'</span>]
|
|
<span class="ruby-keyword">while</span> <span class="ruby-identifier">location</span> <span class="ruby-keyword">do</span>
|
|
<span class="ruby-comment">#</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@cookie</span>
|
|
<span class="ruby-identifier">redirect_request</span> = <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTP</span><span class="ruby-operator">::</span><span class="ruby-constant">Put</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">location</span>, {<span class="ruby-string">'Cookie'</span> <span class="ruby-operator">=></span> <span class="ruby-ivar">@cookie</span>})
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-identifier">redirect_request</span> = <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTP</span><span class="ruby-operator">::</span><span class="ruby-constant">Put</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">location</span>)
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-identifier">redirect_response</span> = <span class="ruby-identifier">server</span>.<span class="ruby-identifier">request</span>(<span class="ruby-identifier">redirect_request</span>)
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">redirect_response</span>.<span class="ruby-identifier">code</span>.<span class="ruby-identifier">to_i</span> <span class="ruby-operator">==</span> <span class="ruby-value">200</span>
|
|
<span class="ruby-identifier">response</span> = <span class="ruby-identifier">redirect_response</span>
|
|
<span class="ruby-identifier">response_code</span> = <span class="ruby-value">200</span>
|
|
<span class="ruby-keyword">break</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">redirect_response</span>[<span class="ruby-string">'location'</span>]
|
|
<span class="ruby-identifier">redirect_count</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">redirect_count</span> <span class="ruby-operator">></span> <span class="ruby-value">9</span>
|
|
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Exception</span>, <span class="ruby-string">"Circular redirect chain suspected (10 or more redirects)"</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-identifier">response_code</span> = <span class="ruby-identifier">redirect_response</span>.<span class="ruby-identifier">code</span>.<span class="ruby-identifier">to_i</span>
|
|
<span class="ruby-identifier">location</span> = <span class="ruby-identifier">redirect_response</span>[<span class="ruby-string">'location'</span>]
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-keyword">break</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-comment">#</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">response</span>.<span class="ruby-identifier">code</span>.<span class="ruby-identifier">to_i</span> <span class="ruby-operator">==</span> <span class="ruby-value">200</span>
|
|
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">true</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Exception</span>, <span class="ruby-node">"Error occured: Code #{response.code}"</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Exception</span>, <span class="ruby-string">"You MUST provide a valid HTTP URI"</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">:url</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_url</span>, <span class="ruby-value">:form_data</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">data</span>, <span class="ruby-value">:options</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">options</span>}})
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-identifier">result</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>
|
|
|