garfield/wpscan
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Files
8896f8bf79de8b52fdff90c74879beb491dcb5b6
wpscan/doc_yard/Browser.html
Christian Mehlmauer 8896f8bf79 docs
2013-08-11 08:58:28 +02:00

1228 lines
38 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>
Class: Browser
&mdash; Documentation by YARD 0.8.5.2
</title>
<link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
<link rel="stylesheet" href="css/common.css" type="text/css" media="screen" 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 (B)</a> &raquo;
<span class="title">Browser</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>Class: Browser
</h1>
<dl class="box">
<dt class="r1">Inherits:</dt>
<dd class="r1">
<span class="inheritName">Object</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">Browser</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
<dt class="r2">Extended by:</dt>
<dd class="r2"><span class='object_link'><a href="Browser/Actions.html" title="Browser::Actions (module)">Actions</a></span></dd>
<dt class="r1">Includes:</dt>
<dd class="r1"><span class='object_link'><a href="Browser/Options.html" title="Browser::Options (module)">Options</a></span></dd>
<dt class="r2 last">Defined in:</dt>
<dd class="r2 last">lib/common/browser.rb<span class="defines">,<br />
lib/common/browser/actions.rb,<br /> lib/common/browser/options.rb</span>
</dd>
</dl>
<div class="clear"></div>
<h2>Defined Under Namespace</h2>
<p class="children">
<strong class="modules">Modules:</strong> <span class='object_link'><a href="Browser/Actions.html" title="Browser::Actions (module)">Actions</a></span>, <span class='object_link'><a href="Browser/Options.html" title="Browser::Options (module)">Options</a></span>
</p>
<h2>Constant Summary</h2>
<dl class="constants">
<dt id="OPTIONS-constant" class="">OPTIONS =
</dt>
<dd><pre class="code"><span class='lbracket'>[</span>
<span class='symbol'>:available_user_agents</span><span class='comma'>,</span>
<span class='symbol'>:basic_auth</span><span class='comma'>,</span>
<span class='symbol'>:cache_ttl</span><span class='comma'>,</span>
<span class='symbol'>:max_threads</span><span class='comma'>,</span>
<span class='symbol'>:user_agent</span><span class='comma'>,</span>
<span class='symbol'>:user_agent_mode</span><span class='comma'>,</span>
<span class='symbol'>:proxy</span><span class='comma'>,</span>
<span class='symbol'>:proxy_auth</span><span class='comma'>,</span>
<span class='symbol'>:request_timeout</span><span class='comma'>,</span>
<span class='symbol'>:connect_timeout</span>
<span class='rbracket'>]</span></pre></dd>
<dt id="instance-classvariable" class="">@@instance =
</dt>
<dd><pre class="code"><span class='kw'>nil</span></pre></dd>
</dl>
<h3 class="inherited">Constants included
from <span class='object_link'><a href="Browser/Options.html" title="Browser::Options (module)">Options</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Browser/Options.html#USER_AGENT_MODES-constant" title="Browser::Options::USER_AGENT_MODES (constant)">Options::USER_AGENT_MODES</a></span></p>
<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="#cache_dir-instance_method" title="#cache_dir (instance method)">- (Object) <strong>cache_dir</strong> </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute cache_dir.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#config_file-instance_method" title="#config_file (instance method)">- (Object) <strong>config_file</strong> </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute config_file.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#hydra-instance_method" title="#hydra (instance method)">- (Object) <strong>hydra</strong> </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute hydra.</p>
</div></span>
</li>
</ul>
<h3 class="inherited">Attributes included from <span class='object_link'><a href="Browser/Options.html" title="Browser::Options (module)">Options</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Browser/Options.html#available_user_agents-instance_method" title="Browser::Options#available_user_agents (method)">#available_user_agents</a></span>, <span class='object_link'><a href="Browser/Options.html#basic_auth-instance_method" title="Browser::Options#basic_auth (method)">#basic_auth</a></span>, <span class='object_link'><a href="Browser/Options.html#cache_ttl-instance_method" title="Browser::Options#cache_ttl (method)">#cache_ttl</a></span>, <span class='object_link'><a href="Browser/Options.html#connect_timeout-instance_method" title="Browser::Options#connect_timeout (method)">#connect_timeout</a></span>, <span class='object_link'><a href="Browser/Options.html#proxy-instance_method" title="Browser::Options#proxy (method)">#proxy</a></span>, <span class='object_link'><a href="Browser/Options.html#proxy_auth-instance_method" title="Browser::Options#proxy_auth (method)">#proxy_auth</a></span>, <span class='object_link'><a href="Browser/Options.html#request_timeout-instance_method" title="Browser::Options#request_timeout (method)">#request_timeout</a></span>, <span class='object_link'><a href="Browser/Options.html#user_agent-instance_method" title="Browser::Options#user_agent (method)">#user_agent</a></span>, <span class='object_link'><a href="Browser/Options.html#user_agent_mode-instance_method" title="Browser::Options#user_agent_mode (method)">#user_agent_mode</a></span></p>
<h2>
Class Method Summary
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
</h2>
<ul class="summary">
<li class="private ">
<span class="summary_signature">
<a href="#append_params_header_field-class_method" title="append_params_header_field (class method)">+ (Array) <strong>append_params_header_field</strong>(params = {}, field, field_value) </a>
</span>
<span class="note title private">private</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#instance-class_method" title="instance (class method)">+ (Browser) <strong>instance</strong>(options = {}) </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#reset-class_method" title="reset (class method)">+ (Object) <strong>reset</strong> </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
</ul>
<h2>
Instance Method Summary
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#forge_request-instance_method" title="#forge_request (instance method)">- (Typhoeus::Request) <strong>forge_request</strong>(url, params = {}) </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">- (Browser) <strong>initialize</strong>(options = {}) </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#load_config-instance_method" title="#load_config (instance method)">- (void) <strong>load_config</strong>(config_file = nil) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>If an option was set but is not in the new config_file it's value is kept.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#merge_request_params-instance_method" title="#merge_request_params (instance method)">- (Hash) <strong>merge_request_params</strong>(params = {}) </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
</ul>
<h3 class="inherited">Methods included from <span class='object_link'><a href="Browser/Actions.html" title="Browser::Actions (module)">Actions</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Browser/Actions.html#get-instance_method" title="Browser::Actions#get (method)">get</a></span>, <span class='object_link'><a href="Browser/Actions.html#get_and_follow_location-instance_method" title="Browser::Actions#get_and_follow_location (method)">get_and_follow_location</a></span>, <span class='object_link'><a href="Browser/Actions.html#head-instance_method" title="Browser::Actions#head (method)">head</a></span>, <span class='object_link'><a href="Browser/Actions.html#post-instance_method" title="Browser::Actions#post (method)">post</a></span>, <span class='object_link'><a href="Browser/Actions.html#process-instance_method" title="Browser::Actions#process (method)">process</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="Browser/Options.html" title="Browser::Options (module)">Options</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Browser/Options.html#invalid_proxy_auth_format-instance_method" title="Browser::Options#invalid_proxy_auth_format (method)">#invalid_proxy_auth_format</a></span>, <span class='object_link'><a href="Browser/Options.html#max_threads-instance_method" title="Browser::Options#max_threads (method)">#max_threads</a></span>, <span class='object_link'><a href="Browser/Options.html#max_threads%3D-instance_method" title="Browser::Options#max_threads= (method)">#max_threads=</a></span>, <span class='object_link'><a href="Browser/Options.html#override_config-instance_method" title="Browser::Options#override_config (method)">#override_config</a></span></p>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
- (<tt><span class='object_link'><a href="" title="Browser (class)">Browser</a></span></tt>) <strong>initialize</strong>(options = {})
</h3><div class="docstring">
<div class="discussion">
</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">
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/common/browser.rb', line 31</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</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='ivar'>@config_file</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:config_file</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='const'>CONF_DIR</span> <span class='op'>+</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/browser.conf.json</span><span class='tstring_end'>'</span></span>
<span class='ivar'>@cache_dir</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:cache_dir</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='const'>CACHE_DIR</span> <span class='op'>+</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/browser</span><span class='tstring_end'>'</span></span>
<span class='id identifier rubyid_load_config'>load_config</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='rparen'>)</span>
<span class='kw'>unless</span> <span class='ivar'>@hydra</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='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_max_threads'>max_threads</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='ivar'>@cache</span> <span class='op'>=</span> <span class='const'>TyphoeusCache</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='ivar'>@cache_dir</span><span class='rparen'>)</span>
<span class='ivar'>@cache</span><span class='period'>.</span><span class='id identifier rubyid_clean'>clean</span>
<span class='const'>Typhoeus</span><span class='op'>::</span><span class='const'>Config</span><span class='period'>.</span><span class='id identifier rubyid_cache'>cache</span> <span class='op'>=</span> <span class='ivar'>@cache</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_attr_details" class="attr_details">
<h2>Instance Attribute Details</h2>
<span id=""></span>
<div class="method_details first">
<h3 class="signature first" id="cache_dir-instance_method">
- (<tt>Object</tt>) <strong>cache_dir</strong> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute cache_dir</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
26
27
28</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/common/browser.rb', line 26</span>
<span class='kw'>def</span> <span class='id identifier rubyid_cache_dir'>cache_dir</span>
<span class='ivar'>@cache_dir</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="config_file-instance_method">
- (<tt>Object</tt>) <strong>config_file</strong> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute config_file</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
26
27
28</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/common/browser.rb', line 26</span>
<span class='kw'>def</span> <span class='id identifier rubyid_config_file'>config_file</span>
<span class='ivar'>@config_file</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="hydra-instance_method">
- (<tt>Object</tt>) <strong>hydra</strong> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute hydra</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
26
27
28</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/common/browser.rb', line 26</span>
<span class='kw'>def</span> <span class='id identifier rubyid_hydra'>hydra</span>
<span class='ivar'>@hydra</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="class_method_details" class="method_details_list">
<h2>Class Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="append_params_header_field-class_method">
+ (<tt><span class='object_link'><a href="Array.html" title="Array (class)">Array</a></span></tt>) <strong>append_params_header_field</strong>(params = {}, field, field_value) <span class="extras">(private)</span>
</h3><div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>params</span>
<span class='type'>(<tt>Hash</tt>)</span>
<em class="default">(defaults to: <tt>{}</tt>)</em>
</li>
<li>
<span class='name'>field</span>
<span class='type'>(<tt>String</tt>)</span>
</li>
<li>
<span class='name'>field_value</span>
<span class='type'>(<tt>Mixed</tt>)</span>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="Array.html" title="Array (class)">Array</a></span></tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
153
154
155
156
157
158
159
160</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/common/browser.rb', line 153</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_append_params_header_field'>append_params_header_field</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='id identifier rubyid_field'>field</span><span class='comma'>,</span> <span class='id identifier rubyid_field_value'>field_value</span><span class='rparen'>)</span>
<span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_params'>params</span><span class='period'>.</span><span class='id identifier rubyid_has_key?'>has_key?</span><span class='lparen'>(</span><span class='symbol'>:headers</span><span class='rparen'>)</span>
<span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='id identifier rubyid_params'>params</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='symbol'>:headers</span> <span class='op'>=&gt;</span> <span class='lbrace'>{</span> <span class='id identifier rubyid_field'>field</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_field_value'>field_value</span> <span class='rbrace'>}</span><span class='rparen'>)</span>
<span class='kw'>elsif</span> <span class='op'>!</span><span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:headers</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_has_key?'>has_key?</span><span class='lparen'>(</span><span class='id identifier rubyid_field'>field</span><span class='rparen'>)</span>
<span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:headers</span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='id identifier rubyid_field'>field</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_field_value'>field_value</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_params'>params</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="instance-class_method">
+ (<tt><span class='object_link'><a href="" title="Browser (class)">Browser</a></span></tt>) <strong>instance</strong>(options = {})
</h3><div class="docstring">
<div class="discussion">
</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>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="" title="Browser (class)">Browser</a></span></tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
53
54
55
56
57
58</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/common/browser.rb', line 53</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_instance'>instance</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='kw'>unless</span> <span class='cvar'>@@instance</span>
<span class='cvar'>@@instance</span> <span class='op'>=</span> <span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='cvar'>@@instance</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="reset-class_method">
+ (<tt>Object</tt>) <strong>reset</strong>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
60
61
62</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/common/browser.rb', line 60</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_reset'>reset</span>
<span class='cvar'>@@instance</span> <span class='op'>=</span> <span class='kw'>nil</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="forge_request-instance_method">
- (<tt><span class='object_link'><a href="Typhoeus/Request.html" title="Typhoeus::Request (class)">Typhoeus::Request</a></span></tt>) <strong>forge_request</strong>(url, params = {})
</h3><div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>url</span>
<span class='type'>(<tt>String</tt>)</span>
</li>
<li>
<span class='name'>params</span>
<span class='type'>(<tt>Hash</tt>)</span>
<em class="default">(defaults to: <tt>{}</tt>)</em>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="Typhoeus/Request.html" title="Typhoeus::Request (class)">Typhoeus::Request</a></span></tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
93
94
95</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/common/browser.rb', line 93</span>
<span class='kw'>def</span> <span class='id identifier rubyid_forge_request'>forge_request</span><span class='lparen'>(</span><span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
<span class='const'>Typhoeus</span><span class='op'>::</span><span class='const'>Request</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='id identifier rubyid_merge_request_params'>merge_request_params</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="load_config-instance_method">
- (<tt>void</tt>) <strong>load_config</strong>(config_file = nil)
</h3><div class="docstring">
<div class="discussion">
<p class="note returns_void">This method returns an undefined value.</p>
<p>If an option was set but is not in the new config_file it's value is kept</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>config_file</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/common/browser.rb', line 71</span>
<span class='kw'>def</span> <span class='id identifier rubyid_load_config'>load_config</span><span class='lparen'>(</span><span class='id identifier rubyid_config_file'>config_file</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
<span class='ivar'>@config_file</span> <span class='op'>=</span> <span class='id identifier rubyid_config_file'>config_file</span> <span class='op'>||</span> <span class='ivar'>@config_file</span>
<span class='kw'>if</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_symlink?'>symlink?</span><span class='lparen'>(</span><span class='ivar'>@config_file</span><span class='rparen'>)</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>[ERROR] Config file is a symlink.</span><span class='tstring_end'>'</span></span>
<span class='kw'>else</span>
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='const'>JSON</span><span class='period'>.</span><span class='id identifier rubyid_parse'>parse</span><span class='lparen'>(</span><span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_read'>read</span><span class='lparen'>(</span><span class='ivar'>@config_file</span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='const'>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='op'>|</span>
<span class='id identifier rubyid_option_name'>option_name</span> <span class='op'>=</span> <span class='id identifier rubyid_option'>option</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>
<span class='kw'>unless</span> <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='id identifier rubyid_option_name'>option_name</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</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_name'>option_name</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_data'>data</span><span class='lbracket'>[</span><span class='id identifier rubyid_option_name'>option_name</span><span class='rbracket'>]</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 class="method_details ">
<h3 class="signature " id="merge_request_params-instance_method">
- (<tt>Hash</tt>) <strong>merge_request_params</strong>(params = {})
</h3><div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>params</span>
<span class='type'>(<tt>Hash</tt>)</span>
<em class="default">(defaults to: <tt>{}</tt>)</em>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Hash</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/common/browser.rb', line 100</span>
<span class='kw'>def</span> <span class='id identifier rubyid_merge_request_params'>merge_request_params</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
<span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='const'>Browser</span><span class='period'>.</span><span class='id identifier rubyid_append_params_header_field'>append_params_header_field</span><span class='lparen'>(</span>
<span class='id identifier rubyid_params'>params</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>User-Agent</span><span class='tstring_end'>'</span></span><span class='comma'>,</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_user_agent'>user_agent</span>
<span class='rparen'>)</span>
<span class='kw'>if</span> <span class='ivar'>@proxy</span>
<span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='id identifier rubyid_params'>params</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='label'>proxy:</span> <span class='ivar'>@proxy</span><span class='rparen'>)</span>
<span class='kw'>if</span> <span class='ivar'>@proxy_auth</span>
<span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='id identifier rubyid_params'>params</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='label'>proxyauth:</span> <span class='ivar'>@proxy_auth</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='kw'>if</span> <span class='ivar'>@basic_auth</span>
<span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='const'>Browser</span><span class='period'>.</span><span class='id identifier rubyid_append_params_header_field'>append_params_header_field</span><span class='lparen'>(</span>
<span class='id identifier rubyid_params'>params</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Authorization</span><span class='tstring_end'>'</span></span><span class='comma'>,</span>
<span class='ivar'>@basic_auth</span>
<span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>if</span> <span class='ivar'>@request_timeout</span>
<span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='id identifier rubyid_params'>params</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='label'>timeout:</span> <span class='ivar'>@request_timeout</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>if</span> <span class='ivar'>@connect_timeout</span>
<span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='id identifier rubyid_params'>params</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='label'>connecttimeout:</span> <span class='ivar'>@connect_timeout</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='comment'># Used to enable the cache system if :cache_ttl &gt; 0
</span> <span class='kw'>unless</span> <span class='id identifier rubyid_params'>params</span><span class='period'>.</span><span class='id identifier rubyid_has_key?'>has_key?</span><span class='lparen'>(</span><span class='symbol'>:cache_ttl</span><span class='rparen'>)</span>
<span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='id identifier rubyid_params'>params</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='label'>cache_ttl:</span> <span class='ivar'>@cache_ttl</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='comment'># Disable SSL-Certificate checks
</span> <span class='id identifier rubyid_params'>params</span><span class='period'>.</span><span class='id identifier rubyid_merge!'>merge!</span><span class='lparen'>(</span><span class='label'>ssl_verifypeer:</span> <span class='kw'>false</span><span class='rparen'>)</span>
<span class='id identifier rubyid_params'>params</span><span class='period'>.</span><span class='id identifier rubyid_merge!'>merge!</span><span class='lparen'>(</span><span class='label'>ssl_verifyhost:</span> <span class='int'>0</span><span class='rparen'>)</span>
<span class='id identifier rubyid_params'>params</span><span class='period'>.</span><span class='id identifier rubyid_merge!'>merge!</span><span class='lparen'>(</span><span class='label'>cookiejar:</span> <span class='ivar'>@cache_dir</span> <span class='op'>+</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/cookie-jar</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
<span class='id identifier rubyid_params'>params</span><span class='period'>.</span><span class='id identifier rubyid_merge!'>merge!</span><span class='lparen'>(</span><span class='label'>cookiefile:</span> <span class='ivar'>@cache_dir</span> <span class='op'>+</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/cookie-jar</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
<span class='id identifier rubyid_params'>params</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Sun Aug 11 08:57:56 2013 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.5.2 (ruby-1.9.3).
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink