745 lines
30 KiB
HTML
745 lines
30 KiB
HTML
<!DOCTYPE html>
|
|
|
|
<html>
|
|
<head>
|
|
<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
|
|
|
|
<title>class Browser - RDoc Documentation</title>
|
|
|
|
<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet">
|
|
|
|
<script type="text/javascript">
|
|
var rdoc_rel_prefix = "./";
|
|
</script>
|
|
|
|
<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script>
|
|
<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script>
|
|
<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script>
|
|
<script type="text/javascript" charset="utf-8" src="./js/search.js"></script>
|
|
<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script>
|
|
<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script>
|
|
|
|
|
|
<body id="top" class="class">
|
|
<nav id="metadata">
|
|
<nav id="home-section" class="section">
|
|
<h3 class="section-header">
|
|
<a href="./index.html">Home</a>
|
|
<a href="./table_of_contents.html#classes">Classes</a>
|
|
<a href="./table_of_contents.html#methods">Methods</a>
|
|
</h3>
|
|
</nav>
|
|
|
|
|
|
<nav id="search-section" class="section project-section" class="initially-hidden">
|
|
<form action="#" method="get" accept-charset="utf-8">
|
|
<h3 class="section-header">
|
|
<input type="text" name="search" placeholder="Search" id="search-field"
|
|
title="Type to search, Up and Down to navigate, Enter to load">
|
|
</h3>
|
|
</form>
|
|
|
|
<ul id="search-results" class="initially-hidden"></ul>
|
|
</nav>
|
|
|
|
|
|
<div id="file-metadata">
|
|
<nav id="file-list-section" class="section">
|
|
<h3 class="section-header">Defined In</h3>
|
|
<ul>
|
|
<li>lib/browser.rb
|
|
</ul>
|
|
</nav>
|
|
|
|
|
|
</div>
|
|
|
|
<div id="class-metadata">
|
|
|
|
<nav id="parent-class-section" class="section">
|
|
<h3 class="section-header">Parent</h3>
|
|
|
|
<p class="link"><a href="Object.html">Object</a>
|
|
|
|
</nav>
|
|
|
|
|
|
<!-- Method Quickref -->
|
|
<nav id="method-list-section" class="section">
|
|
<h3 class="section-header">Methods</h3>
|
|
|
|
<ul class="link-list">
|
|
|
|
<li><a href="#method-c-instance">::instance</a>
|
|
|
|
<li><a href="#method-c-reset">::reset</a>
|
|
|
|
<li><a href="#method-i-forge_request">#forge_request</a>
|
|
|
|
<li><a href="#method-i-get">#get</a>
|
|
|
|
<li><a href="#method-i-load_config">#load_config</a>
|
|
|
|
<li><a href="#method-i-max_threads-3D">#max_threads=</a>
|
|
|
|
<li><a href="#method-i-merge_request_params">#merge_request_params</a>
|
|
|
|
<li><a href="#method-i-post">#post</a>
|
|
|
|
<li><a href="#method-i-proxy_auth-3D">#proxy_auth=</a>
|
|
|
|
<li><a href="#method-i-raise_invalid_proxy_format">#raise_invalid_proxy_format</a>
|
|
|
|
<li><a href="#method-i-user_agent">#user_agent</a>
|
|
|
|
<li><a href="#method-i-user_agent_mode-3D">#user_agent_mode=</a>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</div>
|
|
|
|
<div id="project-metadata">
|
|
<nav id="fileindex-section" class="section project-section">
|
|
<h3 class="section-header">Pages</h3>
|
|
|
|
<ul>
|
|
|
|
<li class="file"><a href="./CREDITS.html">CREDITS</a>
|
|
|
|
<li class="file"><a href="./Gemfile.html">Gemfile</a>
|
|
|
|
<li class="file"><a href="./README.html">README</a>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
<nav id="classindex-section" class="section project-section">
|
|
<h3 class="section-header">Class and Module Index</h3>
|
|
|
|
<ul class="link-list">
|
|
|
|
<li><a href="./Array.html">Array</a>
|
|
|
|
<li><a href="./Browser.html">Browser</a>
|
|
|
|
<li><a href="./BruteForce.html">BruteForce</a>
|
|
|
|
<li><a href="./CacheFileStore.html">CacheFileStore</a>
|
|
|
|
<li><a href="./Exploit.html">Exploit</a>
|
|
|
|
<li><a href="./Generate_List.html">Generate_List</a>
|
|
|
|
<li><a href="./GitUpdater.html">GitUpdater</a>
|
|
|
|
<li><a href="./Malwares.html">Malwares</a>
|
|
|
|
<li><a href="./Object.html">Object</a>
|
|
|
|
<li><a href="./RpcClient.html">RpcClient</a>
|
|
|
|
<li><a href="./SvnUpdater.html">SvnUpdater</a>
|
|
|
|
<li><a href="./Svn_Parser.html">Svn_Parser</a>
|
|
|
|
<li><a href="./URI.html">URI</a>
|
|
|
|
<li><a href="./Updater.html">Updater</a>
|
|
|
|
<li><a href="./UpdaterFactory.html">UpdaterFactory</a>
|
|
|
|
<li><a href="./Vulnerable.html">Vulnerable</a>
|
|
|
|
<li><a href="./WebSite.html">WebSite</a>
|
|
|
|
<li><a href="./WpConfigBackup.html">WpConfigBackup</a>
|
|
|
|
<li><a href="./WpDetector.html">WpDetector</a>
|
|
|
|
<li><a href="./WpEnumerator.html">WpEnumerator</a>
|
|
|
|
<li><a href="./WpFullPathDisclosure.html">WpFullPathDisclosure</a>
|
|
|
|
<li><a href="./WpItem.html">WpItem</a>
|
|
|
|
<li><a href="./WpLoginProtection.html">WpLoginProtection</a>
|
|
|
|
<li><a href="./WpOptions.html">WpOptions</a>
|
|
|
|
<li><a href="./WpPlugin.html">WpPlugin</a>
|
|
|
|
<li><a href="./WpPlugins.html">WpPlugins</a>
|
|
|
|
<li><a href="./WpReadme.html">WpReadme</a>
|
|
|
|
<li><a href="./WpTarget.html">WpTarget</a>
|
|
|
|
<li><a href="./WpTheme.html">WpTheme</a>
|
|
|
|
<li><a href="./WpThemes.html">WpThemes</a>
|
|
|
|
<li><a href="./WpTimthumbs.html">WpTimthumbs</a>
|
|
|
|
<li><a href="./WpUser.html">WpUser</a>
|
|
|
|
<li><a href="./WpUsernames.html">WpUsernames</a>
|
|
|
|
<li><a href="./WpVersion.html">WpVersion</a>
|
|
|
|
<li><a href="./WpVulnerability.html">WpVulnerability</a>
|
|
|
|
<li><a href="./WpscanOptions.html">WpscanOptions</a>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</div>
|
|
</nav>
|
|
|
|
<div id="documentation">
|
|
<h1 class="class">class Browser</h1>
|
|
|
|
<div id="description" class="description">
|
|
|
|
</div><!-- description -->
|
|
|
|
|
|
|
|
|
|
<section id="5Buntitled-5D" class="documentation-section">
|
|
|
|
|
|
|
|
|
|
|
|
<!-- Constants -->
|
|
<section id="constants-list" class="section">
|
|
<h3 class="section-header">Constants</h3>
|
|
<dl>
|
|
|
|
<dt id="ACCESSOR_OPTIONS">ACCESSOR_OPTIONS
|
|
|
|
<dd class="description">
|
|
|
|
|
|
<dt id="USER_AGENT_MODES">USER_AGENT_MODES
|
|
|
|
<dd class="description">
|
|
|
|
|
|
</dl>
|
|
</section>
|
|
|
|
|
|
|
|
<!-- Attributes -->
|
|
<section id="attribute-method-details" class="method-section section">
|
|
<h3 class="section-header">Attributes</h3>
|
|
|
|
|
|
<div id="attribute-i-config_file" class="method-detail">
|
|
<div class="method-heading attribute-method-heading">
|
|
<span class="method-name">config_file</span><span
|
|
class="attribute-access-type">[R]</span>
|
|
</div>
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div id="attribute-i-hydra" class="method-detail">
|
|
<div class="method-heading attribute-method-heading">
|
|
<span class="method-name">hydra</span><span
|
|
class="attribute-access-type">[R]</span>
|
|
</div>
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</section><!-- attribute-method-details -->
|
|
|
|
|
|
<!-- Methods -->
|
|
|
|
<section id="public-class-5Buntitled-5D-method-details" class="method-section section">
|
|
<h3 class="section-header">Public Class Methods</h3>
|
|
|
|
|
|
<div id="method-c-instance" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">instance</span><span
|
|
class="method-args">(options = {})</span>
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="instance-source">
|
|
<pre><span class="ruby-comment"># File lib/browser.rb, line 60</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">instance</span>(<span class="ruby-identifier">options</span> = {})
|
|
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">@@instance</span>
|
|
<span class="ruby-identifier">@@instance</span> = <span class="ruby-identifier">new</span>(<span class="ruby-identifier">options</span>)
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-identifier">@@instance</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div><!-- instance-source -->
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div><!-- instance-method -->
|
|
|
|
|
|
<div id="method-c-reset" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">reset</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="reset-source">
|
|
<pre><span class="ruby-comment"># File lib/browser.rb, line 67</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">reset</span>
|
|
<span class="ruby-identifier">@@instance</span> = <span class="ruby-keyword">nil</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div><!-- reset-source -->
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div><!-- reset-method -->
|
|
|
|
|
|
</section><!-- public-class-method-details -->
|
|
|
|
<section id="public-instance-5Buntitled-5D-method-details" class="method-section section">
|
|
<h3 class="section-header">Public Instance Methods</h3>
|
|
|
|
|
|
<div id="method-i-forge_request" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">forge_request</span><span
|
|
class="method-args">(url, params = {})</span>
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="forge_request-source">
|
|
<pre><span class="ruby-comment"># File lib/browser.rb, line 167</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier">forge_request</span>(<span class="ruby-identifier">url</span>, <span class="ruby-identifier">params</span> = {})
|
|
<span class="ruby-constant">Typhoeus</span><span class="ruby-operator">::</span><span class="ruby-constant">Request</span>.<span class="ruby-identifier">new</span>(
|
|
<span class="ruby-identifier">url</span>.<span class="ruby-identifier">to_s</span>,
|
|
<span class="ruby-identifier">merge_request_params</span>(<span class="ruby-identifier">params</span>)
|
|
)
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div><!-- forge_request-source -->
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div><!-- forge_request-method -->
|
|
|
|
|
|
<div id="method-i-get" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">get</span><span
|
|
class="method-args">(url, params = {})</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/browser.rb, line 155</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier">get</span>(<span class="ruby-identifier">url</span>, <span class="ruby-identifier">params</span> = {})
|
|
<span class="ruby-identifier">run_request</span>(
|
|
<span class="ruby-identifier">forge_request</span>(<span class="ruby-identifier">url</span>, <span class="ruby-identifier">params</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-value">:method</span> =<span class="ruby-operator">></span> <span class="ruby-value">:get</span>))
|
|
)
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div><!-- get-source -->
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div><!-- get-method -->
|
|
|
|
|
|
<div id="method-i-load_config" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">load_config</span><span
|
|
class="method-args">(config_file = nil)</span>
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
<p>TODO reload hydra (if the .<a
|
|
href="Browser.html#method-i-load_config">#load_config</a> is called on a
|
|
browser object, hydra will not have the new @max_threads and
|
|
@request_timeout)</p>
|
|
|
|
|
|
|
|
<div class="method-source-code" id="load_config-source">
|
|
<pre><span class="ruby-comment"># File lib/browser.rb, line 127</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier">load_config</span>(<span class="ruby-identifier">config_file</span> = <span class="ruby-keyword">nil</span>)
|
|
<span class="ruby-ivar">@config_file</span> = <span class="ruby-identifier">config_file</span> <span class="ruby-operator">||</span> <span class="ruby-ivar">@config_file</span>
|
|
|
|
<span class="ruby-identifier">data</span> = <span class="ruby-constant">JSON</span>.<span class="ruby-identifier">parse</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">read</span>(<span class="ruby-ivar">@config_file</span>))
|
|
|
|
<span class="ruby-constant">ACCESSOR_OPTIONS</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">option</span><span class="ruby-operator">|</span>
|
|
<span class="ruby-identifier">option_name</span> = <span class="ruby-identifier">option</span>.<span class="ruby-identifier">to_s</span>
|
|
|
|
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">send</span>(<span class="ruby-value">:"#{option_name}="</span>, <span class="ruby-identifier">data</span>[<span class="ruby-identifier">option_name</span>])
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div><!-- load_config-source -->
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div><!-- load_config-method -->
|
|
|
|
|
|
<div id="method-i-max_threads-3D" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">max_threads=</span><span
|
|
class="method-args">(max_threads)</span>
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="max_threads-3D-source">
|
|
<pre><span class="ruby-comment"># File lib/browser.rb, line 96</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier">max_threads=</span>(<span class="ruby-identifier">max_threads</span>)
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">max_threads</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-keyword">or</span> <span class="ruby-identifier">max_threads</span> <span class="ruby-operator"><=</span> <span class="ruby-value">0</span>
|
|
<span class="ruby-identifier">max_threads</span> = <span class="ruby-value">1</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-ivar">@max_threads</span> = <span class="ruby-identifier">max_threads</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div><!-- max_threads-3D-source -->
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div><!-- max_threads-3D-method -->
|
|
|
|
|
|
<div id="method-i-merge_request_params" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">merge_request_params</span><span
|
|
class="method-args">(params = {})</span>
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="merge_request_params-source">
|
|
<pre><span class="ruby-comment"># File lib/browser.rb, line 174</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier">merge_request_params</span>(<span class="ruby-identifier">params</span> = {})
|
|
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@proxy</span>
|
|
<span class="ruby-identifier">params</span> = <span class="ruby-identifier">params</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-value">:proxy</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@proxy</span>)
|
|
|
|
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@proxy_auth</span>
|
|
<span class="ruby-identifier">params</span> = <span class="ruby-identifier">params</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-ivar">@proxy_auth</span>)
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span>
|
|
|
|
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@basic_auth</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-operator">!</span><span class="ruby-identifier">params</span>.<span class="ruby-identifier">has_key?</span>(<span class="ruby-value">:headers</span>)
|
|
<span class="ruby-identifier">params</span> = <span class="ruby-identifier">params</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-value">:headers</span> =<span class="ruby-operator">></span> {<span class="ruby-string">'Authorization'</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@basic_auth</span>})
|
|
<span class="ruby-keyword">elsif</span> <span class="ruby-operator">!</span><span class="ruby-identifier">params</span>[<span class="ruby-value">:headers</span>].<span class="ruby-identifier">has_key?</span>(<span class="ruby-string">'Authorization'</span>)
|
|
<span class="ruby-identifier">params</span>[<span class="ruby-value">:headers</span>][<span class="ruby-string">'Authorization'</span>] = <span class="ruby-ivar">@basic_auth</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span>
|
|
|
|
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">params</span>.<span class="ruby-identifier">has_key?</span>(<span class="ruby-value">:disable_ssl_host_verification</span>)
|
|
<span class="ruby-identifier">params</span> = <span class="ruby-identifier">params</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-value">:disable_ssl_host_verification</span> =<span class="ruby-operator">></span> <span class="ruby-keyword">true</span>)
|
|
<span class="ruby-keyword">end</span>
|
|
|
|
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">params</span>.<span class="ruby-identifier">has_key?</span>(<span class="ruby-value">:disable_ssl_peer_verification</span>)
|
|
<span class="ruby-identifier">params</span> = <span class="ruby-identifier">params</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-value">:disable_ssl_peer_verification</span> =<span class="ruby-operator">></span> <span class="ruby-keyword">true</span>)
|
|
<span class="ruby-keyword">end</span>
|
|
|
|
<span class="ruby-keyword">if</span> <span class="ruby-operator">!</span><span class="ruby-identifier">params</span>.<span class="ruby-identifier">has_key?</span>(<span class="ruby-value">:headers</span>)
|
|
<span class="ruby-identifier">params</span> = <span class="ruby-identifier">params</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-value">:headers</span> =<span class="ruby-operator">></span> {<span class="ruby-string">'user-agent'</span> =<span class="ruby-operator">></span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">user_agent</span>})
|
|
<span class="ruby-keyword">elsif</span> <span class="ruby-operator">!</span><span class="ruby-identifier">params</span>[<span class="ruby-value">:headers</span>].<span class="ruby-identifier">has_key?</span>(<span class="ruby-string">'user-agent'</span>)
|
|
<span class="ruby-identifier">params</span>[<span class="ruby-value">:headers</span>][<span class="ruby-string">'user-agent'</span>] = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">user_agent</span>
|
|
<span class="ruby-keyword">end</span>
|
|
|
|
<span class="ruby-comment"># Used to enable the cache system if :cache_timeout > 0</span>
|
|
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">params</span>.<span class="ruby-identifier">has_key?</span>(<span class="ruby-value">:cache_timeout</span>)
|
|
<span class="ruby-identifier">params</span> = <span class="ruby-identifier">params</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-value">:cache_timeout</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@cache_timeout</span>)
|
|
<span class="ruby-keyword">end</span>
|
|
|
|
<span class="ruby-identifier">params</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div><!-- merge_request_params-source -->
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div><!-- merge_request_params-method -->
|
|
|
|
|
|
<div id="method-i-post" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">post</span><span
|
|
class="method-args">(url, params = {})</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/browser.rb, line 161</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier">post</span>(<span class="ruby-identifier">url</span>, <span class="ruby-identifier">params</span> = {})
|
|
<span class="ruby-identifier">run_request</span>(
|
|
<span class="ruby-identifier">forge_request</span>(<span class="ruby-identifier">url</span>, <span class="ruby-identifier">params</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-value">:method</span> =<span class="ruby-operator">></span> <span class="ruby-value">:post</span>))
|
|
)
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div><!-- post-source -->
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div><!-- post-method -->
|
|
|
|
|
|
<div id="method-i-proxy_auth-3D" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">proxy_auth=</span><span
|
|
class="method-args">(auth)</span>
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="proxy_auth-3D-source">
|
|
<pre><span class="ruby-comment"># File lib/browser.rb, line 103</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier">proxy_auth=</span>(<span class="ruby-identifier">auth</span>)
|
|
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">auth</span>.<span class="ruby-identifier">nil?</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">auth</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Hash</span>)
|
|
<span class="ruby-keyword">if</span> <span class="ruby-operator">!</span><span class="ruby-identifier">auth</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-value">:proxy_username</span>) <span class="ruby-keyword">or</span> <span class="ruby-operator">!</span><span class="ruby-identifier">auth</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-value">:proxy_password</span>)
|
|
<span class="ruby-identifier">raise_invalid_proxy_format</span>()
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-ivar">@proxy_auth</span> = <span class="ruby-identifier">auth</span>
|
|
<span class="ruby-keyword">elsif</span> <span class="ruby-identifier">auth</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">String</span>)
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">matches</span> = <span class="ruby-regexp">%r{([^:]+):(.*)}</span>.<span class="ruby-identifier">match</span>(<span class="ruby-identifier">auth</span>)
|
|
<span class="ruby-ivar">@proxy_auth</span> = {<span class="ruby-value">:proxy_username</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">matches</span>[<span class="ruby-value">1</span>], <span class="ruby-value">:proxy_password</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">matches</span>[<span class="ruby-value">2</span>]}
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-identifier">raise_invalid_proxy_format</span>()
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-identifier">raise_invalid_proxy_format</span>()
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div><!-- proxy_auth-3D-source -->
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div><!-- proxy_auth-3D-method -->
|
|
|
|
|
|
<div id="method-i-raise_invalid_proxy_format" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">raise_invalid_proxy_format</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="raise_invalid_proxy_format-source">
|
|
<pre><span class="ruby-comment"># File lib/browser.rb, line 122</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier">raise_invalid_proxy_format</span>
|
|
<span class="ruby-identifier">raise</span> <span class="ruby-string">"Invalid proxy auth format, expected username:password or {:proxy_username => username, :proxy_password => password}"</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div><!-- raise_invalid_proxy_format-source -->
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div><!-- raise_invalid_proxy_format-method -->
|
|
|
|
|
|
<div id="method-i-user_agent" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">user_agent</span><span
|
|
class="method-args">()</span>
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
<p>return the user agent, according to the user_agent_mode</p>
|
|
|
|
|
|
|
|
<div class="method-source-code" id="user_agent-source">
|
|
<pre><span class="ruby-comment"># File lib/browser.rb, line 84</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier">user_agent</span>
|
|
<span class="ruby-keyword">case</span> <span class="ruby-ivar">@user_agent_mode</span>
|
|
<span class="ruby-keyword">when</span> <span class="ruby-string">"semi-static"</span>
|
|
<span class="ruby-keyword">unless</span> <span class="ruby-ivar">@user_agent</span>
|
|
<span class="ruby-ivar">@user_agent</span> = <span class="ruby-ivar">@available_user_agents</span>.<span class="ruby-identifier">sample</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">when</span> <span class="ruby-string">"random"</span>
|
|
<span class="ruby-ivar">@user_agent</span> = <span class="ruby-ivar">@available_user_agents</span>.<span class="ruby-identifier">sample</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-ivar">@user_agent</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div><!-- user_agent-source -->
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div><!-- user_agent-method -->
|
|
|
|
|
|
<div id="method-i-user_agent_mode-3D" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">user_agent_mode=</span><span
|
|
class="method-args">(ua_mode)</span>
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="user_agent_mode-3D-source">
|
|
<pre><span class="ruby-comment"># File lib/browser.rb, line 71</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier">user_agent_mode=</span>(<span class="ruby-identifier">ua_mode</span>)
|
|
<span class="ruby-identifier">ua_mode</span> <span class="ruby-operator">||=</span> <span class="ruby-string">"static"</span>
|
|
|
|
<span class="ruby-keyword">if</span> <span class="ruby-constant">USER_AGENT_MODES</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">ua_mode</span>)
|
|
<span class="ruby-ivar">@user_agent_mode</span> = <span class="ruby-identifier">ua_mode</span>
|
|
<span class="ruby-comment"># For semi-static user agent mode, the user agent has to be nil the first time (it will be set with the getter)</span>
|
|
<span class="ruby-ivar">@user_agent</span> = <span class="ruby-keyword">nil</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">ua_mode</span> <span class="ruby-operator">===</span> <span class="ruby-string">"semi-static"</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-identifier">raise</span> <span class="ruby-node">"Unknow user agent mode : '#{ua_mode}'"</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div><!-- user_agent_mode-3D-source -->
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div><!-- user_agent_mode-3D-method -->
|
|
|
|
|
|
</section><!-- public-instance-method-details -->
|
|
|
|
</section><!-- 5Buntitled-5D -->
|
|
|
|
</div><!-- documentation -->
|
|
|
|
|
|
<footer id="validator-badges">
|
|
<p><a href="http://validator.w3.org/check/referer">[Validate]</a>
|
|
<p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12.
|
|
<p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
|
|
</footer>
|
|
|