garfield/wpscan
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Files
d6386c05a49837a079901fe58b3a81a9a53f66a6
wpscan/doc_yard/Browser/Options.html
Christian Mehlmauer d6386c05a4 docs
2013-05-28 19:52:50 +02:00

950 lines
20 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>
Module: Browser::Options
&mdash; Documentation by YARD 0.8.6.1
</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
<link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
<script type="text/javascript" charset="utf-8">
hasFrames = window.top.frames.main ? true : false;
relpath = '../';
framesUrl = "../frames.html#!" + escape(window.location.href);
</script>
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
</head>
<body>
<div id="header">
<div id="menu">
<a href="../_index.html">Index (O)</a> &raquo;
<span class='title'><span class='object_link'><a href="../Browser.html" title="Browser (class)">Browser</a></span></span>
&raquo;
<span class="title">Options</span>
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../class_list.html">
Class List
</a>
<a class="full_list_link" id="method_list_link"
href="../method_list.html">
Method List
</a>
<a class="full_list_link" id="file_list_link"
href="../file_list.html">
File List
</a>
</div>
<div class="clear"></div>
</div>
<iframe id="search_frame"></iframe>
<div id="content"><h1>Module: Browser::Options
</h1>
<dl class="box">
<dt class="r1">Included in:</dt>
<dd class="r1"><span class='object_link'><a href="../Browser.html" title="Browser (class)">Browser</a></span></dd>
<dt class="r2 last">Defined in:</dt>
<dd class="r2 last">lib/common/browser/options.rb</dd>
</dl>
<div class="clear"></div>
<h2>Constant Summary</h2>
<dl class="constants">
<dt id="USER_AGENT_MODES-constant" class="">USER_AGENT_MODES =
</dt>
<dd><pre class="code"><span class='qwords_beg'>%w{ </span><span class='tstring_content'>static</span><span class='words_sep'> </span><span class='tstring_content'>semi-static</span><span class='words_sep'> </span><span class='tstring_content'>random</span><span class='words_sep'> }</span></pre></dd>
</dl>
<h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#available_user_agents-instance_method" title="#available_user_agents (instance method)">- (Object) <strong>available_user_agents</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute available_user_agents.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#basic_auth-instance_method" title="#basic_auth (instance method)">- (Object) <strong>basic_auth</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute basic_auth.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#cache_ttl-instance_method" title="#cache_ttl (instance method)">- (Object) <strong>cache_ttl</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute cache_ttl.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#proxy-instance_method" title="#proxy (instance method)">- (Object) <strong>proxy</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute proxy.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#proxy_auth-instance_method" title="#proxy_auth (instance method)">- (Object) <strong>proxy_auth</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute proxy_auth.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#user_agent-instance_method" title="#user_agent (instance method)">- (String) <strong>user_agent</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>The user agent, according to the user_agent_mode.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#user_agent_mode-instance_method" title="#user_agent_mode (instance method)">- (Object) <strong>user_agent_mode</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute user_agent_mode.</p>
</div></span>
</li>
</ul>
<h2>
Instance Method Summary
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
</h2>
<ul class="summary">
<li class="protected ">
<span class="summary_signature">
<a href="#invalid_proxy_auth_format-instance_method" title="#invalid_proxy_auth_format (instance method)">- (Object) <strong>invalid_proxy_auth_format</strong> </a>
</span>
<span class="note title protected">protected</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#max_threads-instance_method" title="#max_threads (instance method)">- (Integer) <strong>max_threads</strong> </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#max_threads%3D-instance_method" title="#max_threads= (instance method)">- (Object) <strong>max_threads=</strong>(threads) </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="protected ">
<span class="summary_signature">
<a href="#override_config-instance_method" title="#override_config (instance method)">- (void) <strong>override_config</strong>(options = {}) </a>
</span>
<span class="note title protected">protected</span>
<span class="summary_desc"><div class='inline'>
<p>Override with the options if they are set.</p>
</div></span>
</li>
</ul>
<div id="instance_attr_details" class="attr_details">
<h2>Instance Attribute Details</h2>
<span id="available_user_agents=-instance_method"></span>
<div class="method_details first">
<h3 class="signature first" id="available_user_agents-instance_method">
- (<tt>Object</tt>) <strong>available_user_agents</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute available_user_agents</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
8
9
10</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/common/browser/options.rb', line 8</span>
<span class='kw'>def</span> <span class='id identifier rubyid_available_user_agents'>available_user_agents</span>
<span class='ivar'>@available_user_agents</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="basic_auth=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="basic_auth-instance_method">
- (<tt>Object</tt>) <strong>basic_auth</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute basic_auth</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
9
10
11</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/common/browser/options.rb', line 9</span>
<span class='kw'>def</span> <span class='id identifier rubyid_basic_auth'>basic_auth</span>
<span class='ivar'>@basic_auth</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="cache_ttl=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="cache_ttl-instance_method">
- (<tt>Object</tt>) <strong>cache_ttl</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute cache_ttl</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
8
9
10</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/common/browser/options.rb', line 8</span>
<span class='kw'>def</span> <span class='id identifier rubyid_cache_ttl'>cache_ttl</span>
<span class='ivar'>@cache_ttl</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="proxy=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="proxy-instance_method">
- (<tt>Object</tt>) <strong>proxy</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute proxy</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
9
10
11</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/common/browser/options.rb', line 9</span>
<span class='kw'>def</span> <span class='id identifier rubyid_proxy'>proxy</span>
<span class='ivar'>@proxy</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="proxy_auth=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="proxy_auth-instance_method">
- (<tt>Object</tt>) <strong>proxy_auth</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute proxy_auth</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
9
10
11</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/common/browser/options.rb', line 9</span>
<span class='kw'>def</span> <span class='id identifier rubyid_proxy_auth'>proxy_auth</span>
<span class='ivar'>@proxy_auth</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="user_agent=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="user_agent-instance_method">
- (<tt>String</tt>) <strong>user_agent</strong>
</h3><div class="docstring">
<div class="discussion">
<p>The user agent, according to the user_agent_mode</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>)</span>
&mdash;
<div class='inline'>
<p>The user agent, according to the user_agent_mode</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
68
69
70
71
72
73
74
75
76
77
78</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/common/browser/options.rb', line 68</span>
<span class='kw'>def</span> <span class='id identifier rubyid_user_agent'>user_agent</span>
<span class='kw'>case</span> <span class='ivar'>@user_agent_mode</span>
<span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>semi-static</span><span class='tstring_end'>'</span></span>
<span class='kw'>unless</span> <span class='ivar'>@user_agent</span>
<span class='ivar'>@user_agent</span> <span class='op'>=</span> <span class='ivar'>@available_user_agents</span><span class='period'>.</span><span class='id identifier rubyid_sample'>sample</span>
<span class='kw'>end</span>
<span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>random</span><span class='tstring_end'>'</span></span>
<span class='ivar'>@user_agent</span> <span class='op'>=</span> <span class='ivar'>@available_user_agents</span><span class='period'>.</span><span class='id identifier rubyid_sample'>sample</span>
<span class='kw'>end</span>
<span class='ivar'>@user_agent</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="user_agent_mode=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="user_agent_mode-instance_method">
- (<tt>Object</tt>) <strong>user_agent_mode</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute user_agent_mode</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
9
10
11</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/common/browser/options.rb', line 9</span>
<span class='kw'>def</span> <span class='id identifier rubyid_user_agent_mode'>user_agent_mode</span>
<span class='ivar'>@user_agent_mode</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="invalid_proxy_auth_format-instance_method">
- (<tt>Object</tt>) <strong>invalid_proxy_auth_format</strong> <span class="extras">(protected)</span>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
120
121
122</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/common/browser/options.rb', line 120</span>
<span class='kw'>def</span> <span class='id identifier rubyid_invalid_proxy_auth_format'>invalid_proxy_auth_format</span>
<span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Invalid proxy auth format, expected username:password or {proxy_username: username, proxy_password: password}</span><span class='tstring_end'>'</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="max_threads-instance_method">
- (<tt>Integer</tt>) <strong>max_threads</strong>
</h3><div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Integer</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
31
32
33</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/common/browser/options.rb', line 31</span>
<span class='kw'>def</span> <span class='id identifier rubyid_max_threads'>max_threads</span>
<span class='ivar'>@max_threads</span> <span class='op'>||</span> <span class='int'>1</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="max_threads=-instance_method">
- (<tt>Object</tt>) <strong>max_threads=</strong>(threads)
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
35
36
37
38
39
40
41
42</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/common/browser/options.rb', line 35</span>
<span class='kw'>def</span> <span class='id identifier rubyid_max_threads='>max_threads=</span><span class='lparen'>(</span><span class='id identifier rubyid_threads'>threads</span><span class='rparen'>)</span>
<span class='kw'>if</span> <span class='id identifier rubyid_threads'>threads</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Integer</span><span class='rparen'>)</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_threads'>threads</span> <span class='op'>&gt;</span> <span class='int'>0</span>
<span class='ivar'>@max_threads</span> <span class='op'>=</span> <span class='id identifier rubyid_threads'>threads</span>
<span class='ivar'>@hydra</span> <span class='op'>=</span> <span class='const'>Typhoeus</span><span class='op'>::</span><span class='const'>Hydra</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='label'>max_concurrency:</span> <span class='id identifier rubyid_threads'>threads</span><span class='rparen'>)</span>
<span class='kw'>else</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>max_threads must be an Integer &gt; 0</span><span class='tstring_end'>'</span></span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="override_config-instance_method">
- (<tt>void</tt>) <strong>override_config</strong>(options = {}) <span class="extras">(protected)</span>
</h3><div class="docstring">
<div class="discussion">
<p class="note returns_void">This method returns an undefined value.</p>
<p>Override with the options if they are set</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>options</span>
<span class='type'>(<tt>Hash</tt>)</span>
<em class="default">(defaults to: <tt>{}</tt>)</em>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
128
129
130
131
132
133
134</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/common/browser/options.rb', line 128</span>
<span class='kw'>def</span> <span class='id identifier rubyid_override_config'>override_config</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
<span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_option'>option</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='op'>|</span>
<span class='kw'>if</span> <span class='id identifier rubyid_value'>value</span> <span class='op'>!=</span> <span class='kw'>nil</span> <span class='kw'>and</span> <span class='const'>OPTIONS</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='id identifier rubyid_option'>option</span><span class='rparen'>)</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_send'>send</span><span class='lparen'>(</span><span class='symbol'>:#{</span><span class='id identifier rubyid_option'>option</span><span class='rbrace'>}</span><span class='tstring_content'>=</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Tue May 28 19:45:34 2013 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.6.1 (ruby-1.9.3).
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink