watzon
/
arachnid
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 3 Wiki Activity

Add docs

This commit is contained in:
Chris Watson 2019-06-26 20:25:07 -07:00
parent 32bf4d89b8
commit 41291aa54b
No known key found for this signature in database
GPG Key ID: 37DAEF5F446370A4
29 changed files with 17069 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.gitignore vendored
View File

@ -1,4 +1,3 @@
/docs/
/lib/ /lib/
/bin/ /bin/
/.shards/ /.shards/

794
docs/Arachnid.html Normal file
View File

@ -0,0 +1,794 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.29.0">
<link href="css/style.css" rel="stylesheet" type="text/css">
<script type="text/javascript" src="js/doc.js"></script>
<script type="text/javascript">
CrystalDoc.base_path = "";
</script>
<meta id="repository-name" content="github.com/watzon/arachnid">
<title>Arachnid - github.com/watzon/arachnid</title>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
<input type="search" class="search-input" placeholder="Search..." spellcheck="false" aria-label="Search">
</div>
<div class="repository-links">
<a href="index.html">README</a>
</div>
</div>
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
<div class="types-list">
<ul>
<li class="parent open current" data-id="github.com/watzon/arachnid/Arachnid" data-name="arachnid">
<a href="Arachnid.html">Arachnid</a>
<ul>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Agent" data-name="arachnid::agent">
<a href="Arachnid/Agent.html">Agent</a>
<ul>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions" data-name="arachnid::agent::actions">
<a href="Arachnid/Agent/Actions.html">Actions</a>
<ul>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/Action" data-name="arachnid::agent::actions::action">
<a href="Arachnid/Agent/Actions/Action.html">Action</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/Paused" data-name="arachnid::agent::actions::paused">
<a href="Arachnid/Agent/Actions/Paused.html">Paused</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/RuntimeError" data-name="arachnid::agent::actions::runtimeerror">
<a href="Arachnid/Agent/Actions/RuntimeError.html">RuntimeError</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/SkipLink" data-name="arachnid::agent::actions::skiplink">
<a href="Arachnid/Agent/Actions/SkipLink.html">SkipLink</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/SkipResource" data-name="arachnid::agent::actions::skipresource">
<a href="Arachnid/Agent/Actions/SkipResource.html">SkipResource</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Queue" data-name="arachnid::agent::queue">
<a href="Arachnid/Agent/Queue.html">Queue</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/AuthCredential" data-name="arachnid::authcredential">
<a href="Arachnid/AuthCredential.html">AuthCredential</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/AuthStore" data-name="arachnid::authstore">
<a href="Arachnid/AuthStore.html">AuthStore</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/CookieJar" data-name="arachnid::cookiejar">
<a href="Arachnid/CookieJar.html">CookieJar</a>
</li>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Document" data-name="arachnid::document">
<a href="Arachnid/Document.html">Document</a>
<ul>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Document/HTML" data-name="arachnid::document::html">
<a href="Arachnid/Document/HTML.html">HTML</a>
<ul>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Document/HTML/Tag" data-name="arachnid::document::html::tag">
<a href="Arachnid/Document/HTML/Tag.html">Tag</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Resource" data-name="arachnid::resource">
<a href="Arachnid/Resource.html">Resource</a>
<ul>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/ContentTypes" data-name="arachnid::resource::contenttypes">
<a href="Arachnid/Resource/ContentTypes.html">ContentTypes</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/Cookies" data-name="arachnid::resource::cookies">
<a href="Arachnid/Resource/Cookies.html">Cookies</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/HTML" data-name="arachnid::resource::html">
<a href="Arachnid/Resource/HTML.html">HTML</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/StatusCodes" data-name="arachnid::resource::statuscodes">
<a href="Arachnid/Resource/StatusCodes.html">StatusCodes</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Rules" data-name="arachnid::rules(t)">
<a href="Arachnid/Rules.html">Rules</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/SessionCache" data-name="arachnid::sessioncache">
<a href="Arachnid/SessionCache.html">SessionCache</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/URI" data-name="uri">
<a href="URI.html">URI</a>
</li>
</ul>
</div>
</div>
<div class="main-content">
<h1 class="type-name">
<span class="kind">module</span> Arachnid
</h1>
<h2>Extended Modules</h2>
<ul class="other-types-list">
<li class="other-type"><a href="Arachnid.html">Arachnid</a></li>
</ul>
<h2>Defined in:</h2>
<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/version.cr#L1" target="_blank">
arachnid/version.cr
</a>
<br/>
<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/resource/content_types.cr#L1" target="_blank">
arachnid/resource/content_types.cr
</a>
<br/>
<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/resource/cookies.cr#L1" target="_blank">
arachnid/resource/cookies.cr
</a>
<br/>
<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/resource/html.cr#L3" target="_blank">
arachnid/resource/html.cr
</a>
<br/>
<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/resource/status_codes.cr#L1" target="_blank">
arachnid/resource/status_codes.cr
</a>
<br/>
<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/document/html.cr#L3" target="_blank">
arachnid/document/html.cr
</a>
<br/>
<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/resource.cr#L11" target="_blank">
arachnid/resource.cr
</a>
<br/>
<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/agent/sanitizers.cr#L1" target="_blank">
arachnid/agent/sanitizers.cr
</a>
<br/>
<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/rules.cr#L1" target="_blank">
arachnid/rules.cr
</a>
<br/>
<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/agent/filters.cr#L3" target="_blank">
arachnid/agent/filters.cr
</a>
<br/>
<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/agent/events.cr#L3" target="_blank">
arachnid/agent/events.cr
</a>
<br/>
<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/agent/actions.cr#L1" target="_blank">
arachnid/agent/actions.cr
</a>
<br/>
<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/agent/robots.cr#L1" target="_blank">
arachnid/agent/robots.cr
</a>
<br/>
<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/session_cache.cr#L4" target="_blank">
arachnid/session_cache.cr
</a>
<br/>
<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/cookie_jar.cr#L1" target="_blank">
arachnid/cookie_jar.cr
</a>
<br/>
<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/auth_credential.cr#L1" target="_blank">
arachnid/auth_credential.cr
</a>
<br/>
<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/auth_store.cr#L6" target="_blank">
arachnid/auth_store.cr
</a>
<br/>
<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/agent.cr#L11" target="_blank">
arachnid/agent.cr
</a>
<br/>
<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/arachnid.cr#L4" target="_blank">
arachnid/arachnid.cr
</a>
<br/>
<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/agent/queue.cr#L5" target="_blank">
arachnid/agent/queue.cr
</a>
<br/>
<h2>Constant Summary</h2>
<dl>
<dt class="entry-const" id="VERSION">
<strong>VERSION</strong> = <code><span class="s">&quot;0.1.0&quot;</span></code>
</dt>
</dl>
<h2>Class Method Summary</h2>
<ul class="list-summary">
<li class="entry-summary">
<a href="#connect_timeout%3AInt32-class-method" class="signature"><strong>.connect_timeout</strong> : Int32</a>
<div class="summary"><p>Connect timeout.</p></div>
</li>
<li class="entry-summary">
<a href="#connect_timeout%3D%28connect_timeout%3AInt32%29-class-method" class="signature"><strong>.connect_timeout=</strong>(connect_timeout : Int32)</a>
<div class="summary"><p>Connect timeout.</p></div>
</li>
<li class="entry-summary">
<a href="#do_not_track%3D%28do_not_track%3ABool%29-class-method" class="signature"><strong>.do_not_track=</strong>(do_not_track : Bool)</a>
<div class="summary"><p>Should we set the DNT (Do Not Track) header?</p></div>
</li>
<li class="entry-summary">
<a href="#do_not_track%3F%3ABool-class-method" class="signature"><strong>.do_not_track?</strong> : Bool</a>
<div class="summary"><p>Should we set the DNT (Do Not Track) header?</p></div>
</li>
<li class="entry-summary">
<a href="#max_redirects%3AInt32-class-method" class="signature"><strong>.max_redirects</strong> : Int32</a>
<div class="summary"><p>Maximum amount of redirects to follow</p></div>
</li>
<li class="entry-summary">
<a href="#max_redirects%3D%28max_redirects%3AInt32%29-class-method" class="signature"><strong>.max_redirects=</strong>(max_redirects : Int32)</a>
<div class="summary"><p>Maximum amount of redirects to follow</p></div>
</li>
<li class="entry-summary">
<a href="#read_timeout%3AInt32-class-method" class="signature"><strong>.read_timeout</strong> : Int32</a>
<div class="summary"><p>Read timeout.</p></div>
</li>
<li class="entry-summary">
<a href="#read_timeout%3D%28read_timeout%3AInt32%29-class-method" class="signature"><strong>.read_timeout=</strong>(read_timeout : Int32)</a>
<div class="summary"><p>Read timeout.</p></div>
</li>
<li class="entry-summary">
<a href="#robots%3D%28robots%3ABool%29-class-method" class="signature"><strong>.robots=</strong>(robots : Bool)</a>
<div class="summary"><p>Specifies whether robots.txt should be honored globally</p></div>
</li>
<li class="entry-summary">
<a href="#robots%3F%3ABool-class-method" class="signature"><strong>.robots?</strong> : Bool</a>
<div class="summary"><p>Specifies whether robots.txt should be honored globally</p></div>
</li>
<li class="entry-summary">
<a href="#user_agent%3AString-class-method" class="signature"><strong>.user_agent</strong> : String</a>
<div class="summary"><p>The User-Agent string used by all Agent objects by default.</p></div>
</li>
<li class="entry-summary">
<a href="#user_agent%3D%28user_agent%3AString%29-class-method" class="signature"><strong>.user_agent=</strong>(user_agent : String)</a>
<div class="summary"><p>The User-Agent string used by all Agent objects by default.</p></div>
</li>
</ul>
<h2>Instance Method Summary</h2>
<ul class="list-summary">
<li class="entry-summary">
<a href="#host%28name%2C%2A%2Aoptions%2C%26block%3AAgent-%3E%29-instance-method" class="signature"><strong>#host</strong>(name, **options, &block : Agent -> )</a>
<div class="summary"><p>See <code><a href="Arachnid/Agent.html#host%28url%2C%2A%2Aoptions%2C%26block%3AAgent-%3E%29-class-method">Agent.host</a></code></p></div>
</li>
<li class="entry-summary">
<a href="#site%28url%2C%2A%2Aoptions%2C%26block%3AAgent-%3E%29-instance-method" class="signature"><strong>#site</strong>(url, **options, &block : Agent -> )</a>
<div class="summary"><p>See <code><a href="Arachnid/Agent.html#site%28url%2C%2A%2Aoptions%2C%26block%3AAgent-%3E%29-class-method">Agent.site</a></code></p></div>
</li>
<li class="entry-summary">
<a href="#start_at%28url%2C%2A%2Aoptions%2C%26block%3AAgent-%3E%29-instance-method" class="signature"><strong>#start_at</strong>(url, **options, &block : Agent -> )</a>
<div class="summary"><p>See <code><a href="Arachnid/Agent.html#start_at%28url%2C%2A%2Aoptions%2C%26block%3AAgent-%3E%29-class-method">Agent.start_at</a></code></p></div>
</li>
</ul>
<div class="methods-inherited">
</div>
<h2>Class Method Detail</h2>
<div class="entry-detail" id="connect_timeout:Int32-class-method">
<div class="signature">
def self.<strong>connect_timeout</strong> : Int32
<a class="method-permalink" href="#connect_timeout%3AInt32-class-method">#</a>
</div>
<div class="doc"><p>Connect timeout.</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/arachnid.cr#L19" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="connect_timeout=(connect_timeout:Int32)-class-method">
<div class="signature">
def self.<strong>connect_timeout=</strong>(connect_timeout : Int32)
<a class="method-permalink" href="#connect_timeout%3D%28connect_timeout%3AInt32%29-class-method">#</a>
</div>
<div class="doc"><p>Connect timeout.</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/arachnid.cr#L23" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="do_not_track=(do_not_track:Bool)-class-method">
<div class="signature">
def self.<strong>do_not_track=</strong>(do_not_track : Bool)
<a class="method-permalink" href="#do_not_track%3D%28do_not_track%3ABool%29-class-method">#</a>
</div>
<div class="doc"><p>Should we set the DNT (Do Not Track) header?</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/arachnid.cr#L17" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="do_not_track?:Bool-class-method">
<div class="signature">
def self.<strong>do_not_track?</strong> : Bool
<a class="method-permalink" href="#do_not_track%3F%3ABool-class-method">#</a>
</div>
<div class="doc"><p>Should we set the DNT (Do Not Track) header?</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/arachnid.cr#L13" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="max_redirects:Int32-class-method">
<div class="signature">
def self.<strong>max_redirects</strong> : Int32
<a class="method-permalink" href="#max_redirects%3AInt32-class-method">#</a>
</div>
<div class="doc"><p>Maximum amount of redirects to follow</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/arachnid.cr#L16" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="max_redirects=(max_redirects:Int32)-class-method">
<div class="signature">
def self.<strong>max_redirects=</strong>(max_redirects : Int32)
<a class="method-permalink" href="#max_redirects%3D%28max_redirects%3AInt32%29-class-method">#</a>
</div>
<div class="doc"><p>Maximum amount of redirects to follow</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/arachnid.cr#L20" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="read_timeout:Int32-class-method">
<div class="signature">
def self.<strong>read_timeout</strong> : Int32
<a class="method-permalink" href="#read_timeout%3AInt32-class-method">#</a>
</div>
<div class="doc"><p>Read timeout.</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/arachnid.cr#L22" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="read_timeout=(read_timeout:Int32)-class-method">
<div class="signature">
def self.<strong>read_timeout=</strong>(read_timeout : Int32)
<a class="method-permalink" href="#read_timeout%3D%28read_timeout%3AInt32%29-class-method">#</a>
</div>
<div class="doc"><p>Read timeout.</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/arachnid.cr#L26" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="robots=(robots:Bool)-class-method">
<div class="signature">
def self.<strong>robots=</strong>(robots : Bool)
<a class="method-permalink" href="#robots%3D%28robots%3ABool%29-class-method">#</a>
</div>
<div class="doc"><p>Specifies whether robots.txt should be honored globally</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/arachnid.cr#L14" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="robots?:Bool-class-method">
<div class="signature">
def self.<strong>robots?</strong> : Bool
<a class="method-permalink" href="#robots%3F%3ABool-class-method">#</a>
</div>
<div class="doc"><p>Specifies whether robots.txt should be honored globally</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/arachnid.cr#L10" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="user_agent:String-class-method">
<div class="signature">
def self.<strong>user_agent</strong> : String
<a class="method-permalink" href="#user_agent%3AString-class-method">#</a>
</div>
<div class="doc"><p>The User-Agent string used by all Agent objects by default.</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/arachnid.cr#L25" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="user_agent=(user_agent:String)-class-method">
<div class="signature">
def self.<strong>user_agent=</strong>(user_agent : String)
<a class="method-permalink" href="#user_agent%3D%28user_agent%3AString%29-class-method">#</a>
</div>
<div class="doc"><p>The User-Agent string used by all Agent objects by default.</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/arachnid.cr#L29" target="_blank">View source</a>]
</div>
</div>
<h2>Instance Method Detail</h2>
<div class="entry-detail" id="host(name,**options,&amp;block:Agent-&gt;)-instance-method">
<div class="signature">
def <strong>host</strong>(name, **options, &block : <a href="Arachnid/Agent.html">Agent</a> -> )
<a class="method-permalink" href="#host%28name%2C%2A%2Aoptions%2C%26block%3AAgent-%3E%29-instance-method">#</a>
</div>
<div class="doc"><p>See <code><a href="Arachnid/Agent.html#host%28url%2C%2A%2Aoptions%2C%26block%3AAgent-%3E%29-class-method">Agent.host</a></code></p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/arachnid.cr#L31" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="site(url,**options,&amp;block:Agent-&gt;)-instance-method">
<div class="signature">
def <strong>site</strong>(url, **options, &block : <a href="Arachnid/Agent.html">Agent</a> -> )
<a class="method-permalink" href="#site%28url%2C%2A%2Aoptions%2C%26block%3AAgent-%3E%29-instance-method">#</a>
</div>
<div class="doc"><p>See <code><a href="Arachnid/Agent.html#site%28url%2C%2A%2Aoptions%2C%26block%3AAgent-%3E%29-class-method">Agent.site</a></code></p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/arachnid.cr#L36" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="start_at(url,**options,&amp;block:Agent-&gt;)-instance-method">
<div class="signature">
def <strong>start_at</strong>(url, **options, &block : <a href="Arachnid/Agent.html">Agent</a> -> )
<a class="method-permalink" href="#start_at%28url%2C%2A%2Aoptions%2C%26block%3AAgent-%3E%29-instance-method">#</a>
</div>
<div class="doc"><p>See <code><a href="Arachnid/Agent.html#start_at%28url%2C%2A%2Aoptions%2C%26block%3AAgent-%3E%29-class-method">Agent.start_at</a></code></p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/arachnid.cr#L26" target="_blank">View source</a>]
</div>
</div>
</div>
</body>
</html>

3710
docs/Arachnid/Agent.html Normal file
View File

File diff suppressed because it is too large Load Diff

251
docs/Arachnid/Agent/Actions.html Normal file
View File

@ -0,0 +1,251 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.29.0">
<link href="../../css/style.css" rel="stylesheet" type="text/css">
<script type="text/javascript" src="../../js/doc.js"></script>
<script type="text/javascript">
CrystalDoc.base_path = "../../";
</script>
<meta id="repository-name" content="github.com/watzon/arachnid">
<title>Arachnid::Agent::Actions - github.com/watzon/arachnid</title>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
<input type="search" class="search-input" placeholder="Search..." spellcheck="false" aria-label="Search">
</div>
<div class="repository-links">
<a href="../../index.html">README</a>
</div>
</div>
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
<div class="types-list">
<ul>
<li class="parent open current" data-id="github.com/watzon/arachnid/Arachnid" data-name="arachnid">
<a href="../../Arachnid.html">Arachnid</a>
<ul>
<li class="parent open current" data-id="github.com/watzon/arachnid/Arachnid/Agent" data-name="arachnid::agent">
<a href="../../Arachnid/Agent.html">Agent</a>
<ul>
<li class="parent open current" data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions" data-name="arachnid::agent::actions">
<a href="../../Arachnid/Agent/Actions.html">Actions</a>
<ul>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/Action" data-name="arachnid::agent::actions::action">
<a href="../../Arachnid/Agent/Actions/Action.html">Action</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/Paused" data-name="arachnid::agent::actions::paused">
<a href="../../Arachnid/Agent/Actions/Paused.html">Paused</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/RuntimeError" data-name="arachnid::agent::actions::runtimeerror">
<a href="../../Arachnid/Agent/Actions/RuntimeError.html">RuntimeError</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/SkipLink" data-name="arachnid::agent::actions::skiplink">
<a href="../../Arachnid/Agent/Actions/SkipLink.html">SkipLink</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/SkipResource" data-name="arachnid::agent::actions::skipresource">
<a href="../../Arachnid/Agent/Actions/SkipResource.html">SkipResource</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Queue" data-name="arachnid::agent::queue">
<a href="../../Arachnid/Agent/Queue.html">Queue</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/AuthCredential" data-name="arachnid::authcredential">
<a href="../../Arachnid/AuthCredential.html">AuthCredential</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/AuthStore" data-name="arachnid::authstore">
<a href="../../Arachnid/AuthStore.html">AuthStore</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/CookieJar" data-name="arachnid::cookiejar">
<a href="../../Arachnid/CookieJar.html">CookieJar</a>
</li>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Document" data-name="arachnid::document">
<a href="../../Arachnid/Document.html">Document</a>
<ul>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Document/HTML" data-name="arachnid::document::html">
<a href="../../Arachnid/Document/HTML.html">HTML</a>
<ul>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Document/HTML/Tag" data-name="arachnid::document::html::tag">
<a href="../../Arachnid/Document/HTML/Tag.html">Tag</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Resource" data-name="arachnid::resource">
<a href="../../Arachnid/Resource.html">Resource</a>
<ul>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/ContentTypes" data-name="arachnid::resource::contenttypes">
<a href="../../Arachnid/Resource/ContentTypes.html">ContentTypes</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/Cookies" data-name="arachnid::resource::cookies">
<a href="../../Arachnid/Resource/Cookies.html">Cookies</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/HTML" data-name="arachnid::resource::html">
<a href="../../Arachnid/Resource/HTML.html">HTML</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/StatusCodes" data-name="arachnid::resource::statuscodes">
<a href="../../Arachnid/Resource/StatusCodes.html">StatusCodes</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Rules" data-name="arachnid::rules(t)">
<a href="../../Arachnid/Rules.html">Rules</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/SessionCache" data-name="arachnid::sessioncache">
<a href="../../Arachnid/SessionCache.html">SessionCache</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/URI" data-name="uri">
<a href="../../URI.html">URI</a>
</li>
</ul>
</div>
</div>
<div class="main-content">
<h1 class="type-name">
<span class="kind">module</span> Arachnid::Agent::Actions
</h1>
<h2>Defined in:</h2>
<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/agent/actions.cr#L3" target="_blank">
arachnid/agent/actions.cr
</a>
<br/>
<div class="methods-inherited">
</div>
</div>
</body>
</html>

308
docs/Arachnid/Agent/Actions/Action.html Normal file
View File

@ -0,0 +1,308 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.29.0">
<link href="../../../css/style.css" rel="stylesheet" type="text/css">
<script type="text/javascript" src="../../../js/doc.js"></script>
<script type="text/javascript">
CrystalDoc.base_path = "../../../";
</script>
<meta id="repository-name" content="github.com/watzon/arachnid">
<title>Arachnid::Agent::Actions::Action - github.com/watzon/arachnid</title>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
<input type="search" class="search-input" placeholder="Search..." spellcheck="false" aria-label="Search">
</div>
<div class="repository-links">
<a href="../../../index.html">README</a>
</div>
</div>
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
<div class="types-list">
<ul>
<li class="parent open current" data-id="github.com/watzon/arachnid/Arachnid" data-name="arachnid">
<a href="../../../Arachnid.html">Arachnid</a>
<ul>
<li class="parent open current" data-id="github.com/watzon/arachnid/Arachnid/Agent" data-name="arachnid::agent">
<a href="../../../Arachnid/Agent.html">Agent</a>
<ul>
<li class="parent open current" data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions" data-name="arachnid::agent::actions">
<a href="../../../Arachnid/Agent/Actions.html">Actions</a>
<ul>
<li class=" current" data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/Action" data-name="arachnid::agent::actions::action">
<a href="../../../Arachnid/Agent/Actions/Action.html">Action</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/Paused" data-name="arachnid::agent::actions::paused">
<a href="../../../Arachnid/Agent/Actions/Paused.html">Paused</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/RuntimeError" data-name="arachnid::agent::actions::runtimeerror">
<a href="../../../Arachnid/Agent/Actions/RuntimeError.html">RuntimeError</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/SkipLink" data-name="arachnid::agent::actions::skiplink">
<a href="../../../Arachnid/Agent/Actions/SkipLink.html">SkipLink</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/SkipResource" data-name="arachnid::agent::actions::skipresource">
<a href="../../../Arachnid/Agent/Actions/SkipResource.html">SkipResource</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Queue" data-name="arachnid::agent::queue">
<a href="../../../Arachnid/Agent/Queue.html">Queue</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/AuthCredential" data-name="arachnid::authcredential">
<a href="../../../Arachnid/AuthCredential.html">AuthCredential</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/AuthStore" data-name="arachnid::authstore">
<a href="../../../Arachnid/AuthStore.html">AuthStore</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/CookieJar" data-name="arachnid::cookiejar">
<a href="../../../Arachnid/CookieJar.html">CookieJar</a>
</li>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Document" data-name="arachnid::document">
<a href="../../../Arachnid/Document.html">Document</a>
<ul>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Document/HTML" data-name="arachnid::document::html">
<a href="../../../Arachnid/Document/HTML.html">HTML</a>
<ul>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Document/HTML/Tag" data-name="arachnid::document::html::tag">
<a href="../../../Arachnid/Document/HTML/Tag.html">Tag</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Resource" data-name="arachnid::resource">
<a href="../../../Arachnid/Resource.html">Resource</a>
<ul>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/ContentTypes" data-name="arachnid::resource::contenttypes">
<a href="../../../Arachnid/Resource/ContentTypes.html">ContentTypes</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/Cookies" data-name="arachnid::resource::cookies">
<a href="../../../Arachnid/Resource/Cookies.html">Cookies</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/HTML" data-name="arachnid::resource::html">
<a href="../../../Arachnid/Resource/HTML.html">HTML</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/StatusCodes" data-name="arachnid::resource::statuscodes">
<a href="../../../Arachnid/Resource/StatusCodes.html">StatusCodes</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Rules" data-name="arachnid::rules(t)">
<a href="../../../Arachnid/Rules.html">Rules</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/SessionCache" data-name="arachnid::sessioncache">
<a href="../../../Arachnid/SessionCache.html">SessionCache</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/URI" data-name="uri">
<a href="../../../URI.html">URI</a>
</li>
</ul>
</div>
</div>
<div class="main-content">
<h1 class="type-name">
<span class="kind">class</span> Arachnid::Agent::Actions::Action
</h1>
<ul class="superclass-hierarchy"><li class="superclass"><a href="../../../Arachnid/Agent/Actions/Action.html">Arachnid::Agent::Actions::Action</a></li><li class="superclass"><a href="../../../Arachnid/Agent/Actions/RuntimeError.html">Arachnid::Agent::Actions::RuntimeError</a></li><li class="superclass">Exception</li><li class="superclass">Reference</li><li class="superclass">Object</li></ul>
<h2>Overview</h2>
<p>The base <code><a href="../../../Arachnid/Agent/Actions.html">Actions</a></code> exceptions class</p>
<h2>Direct Known Subclasses</h2>
<ul class="other-types-list">
<li class="other-type"><a href="../../../Arachnid/Agent/Actions/Paused.html">Arachnid::Agent::Actions::Paused</a></li>
<li class="other-type"><a href="../../../Arachnid/Agent/Actions/SkipLink.html">Arachnid::Agent::Actions::SkipLink</a></li>
<li class="other-type"><a href="../../../Arachnid/Agent/Actions/SkipResource.html">Arachnid::Agent::Actions::SkipResource</a></li>
</ul>
<h2>Defined in:</h2>
<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/agent/actions.cr#L9" target="_blank">
arachnid/agent/actions.cr
</a>
<br/>
<div class="methods-inherited">
</div>
</div>
</body>
</html>

307
docs/Arachnid/Agent/Actions/Paused.html Normal file
View File

@ -0,0 +1,307 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.29.0">
<link href="../../../css/style.css" rel="stylesheet" type="text/css">
<script type="text/javascript" src="../../../js/doc.js"></script>
<script type="text/javascript">
CrystalDoc.base_path = "../../../";
</script>
<meta id="repository-name" content="github.com/watzon/arachnid">
<title>Arachnid::Agent::Actions::Paused - github.com/watzon/arachnid</title>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
<input type="search" class="search-input" placeholder="Search..." spellcheck="false" aria-label="Search">
</div>
<div class="repository-links">
<a href="../../../index.html">README</a>
</div>
</div>
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
<div class="types-list">
<ul>
<li class="parent open current" data-id="github.com/watzon/arachnid/Arachnid" data-name="arachnid">
<a href="../../../Arachnid.html">Arachnid</a>
<ul>
<li class="parent open current" data-id="github.com/watzon/arachnid/Arachnid/Agent" data-name="arachnid::agent">
<a href="../../../Arachnid/Agent.html">Agent</a>
<ul>
<li class="parent open current" data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions" data-name="arachnid::agent::actions">
<a href="../../../Arachnid/Agent/Actions.html">Actions</a>
<ul>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/Action" data-name="arachnid::agent::actions::action">
<a href="../../../Arachnid/Agent/Actions/Action.html">Action</a>
</li>
<li class=" current" data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/Paused" data-name="arachnid::agent::actions::paused">
<a href="../../../Arachnid/Agent/Actions/Paused.html">Paused</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/RuntimeError" data-name="arachnid::agent::actions::runtimeerror">
<a href="../../../Arachnid/Agent/Actions/RuntimeError.html">RuntimeError</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/SkipLink" data-name="arachnid::agent::actions::skiplink">
<a href="../../../Arachnid/Agent/Actions/SkipLink.html">SkipLink</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/SkipResource" data-name="arachnid::agent::actions::skipresource">
<a href="../../../Arachnid/Agent/Actions/SkipResource.html">SkipResource</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Queue" data-name="arachnid::agent::queue">
<a href="../../../Arachnid/Agent/Queue.html">Queue</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/AuthCredential" data-name="arachnid::authcredential">
<a href="../../../Arachnid/AuthCredential.html">AuthCredential</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/AuthStore" data-name="arachnid::authstore">
<a href="../../../Arachnid/AuthStore.html">AuthStore</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/CookieJar" data-name="arachnid::cookiejar">
<a href="../../../Arachnid/CookieJar.html">CookieJar</a>
</li>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Document" data-name="arachnid::document">
<a href="../../../Arachnid/Document.html">Document</a>
<ul>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Document/HTML" data-name="arachnid::document::html">
<a href="../../../Arachnid/Document/HTML.html">HTML</a>
<ul>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Document/HTML/Tag" data-name="arachnid::document::html::tag">
<a href="../../../Arachnid/Document/HTML/Tag.html">Tag</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Resource" data-name="arachnid::resource">
<a href="../../../Arachnid/Resource.html">Resource</a>
<ul>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/ContentTypes" data-name="arachnid::resource::contenttypes">
<a href="../../../Arachnid/Resource/ContentTypes.html">ContentTypes</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/Cookies" data-name="arachnid::resource::cookies">
<a href="../../../Arachnid/Resource/Cookies.html">Cookies</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/HTML" data-name="arachnid::resource::html">
<a href="../../../Arachnid/Resource/HTML.html">HTML</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/StatusCodes" data-name="arachnid::resource::statuscodes">
<a href="../../../Arachnid/Resource/StatusCodes.html">StatusCodes</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Rules" data-name="arachnid::rules(t)">
<a href="../../../Arachnid/Rules.html">Rules</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/SessionCache" data-name="arachnid::sessioncache">
<a href="../../../Arachnid/SessionCache.html">SessionCache</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/URI" data-name="uri">
<a href="../../../URI.html">URI</a>
</li>
</ul>
</div>
</div>
<div class="main-content">
<h1 class="type-name">
<span class="kind">class</span> Arachnid::Agent::Actions::Paused
</h1>
<ul class="superclass-hierarchy"><li class="superclass"><a href="../../../Arachnid/Agent/Actions/Paused.html">Arachnid::Agent::Actions::Paused</a></li><li class="superclass"><a href="../../../Arachnid/Agent/Actions/Action.html">Arachnid::Agent::Actions::Action</a></li><li class="superclass"><a href="../../../Arachnid/Agent/Actions/RuntimeError.html">Arachnid::Agent::Actions::RuntimeError</a></li><li class="superclass">Exception</li><li class="superclass">Reference</li><li class="superclass">Object</li></ul>
<h2>Overview</h2>
<p>Exception used to pause a running <code><a href="../../../Arachnid/Agent.html">Agent</a></code></p>
<h2>Defined in:</h2>
<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/agent/actions.cr#L12" target="_blank">
arachnid/agent/actions.cr
</a>
<br/>
<div class="methods-inherited">
</div>
</div>
</body>
</html>

294
docs/Arachnid/Agent/Actions/RuntimeError.html Normal file
View File

@ -0,0 +1,294 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.29.0">
<link href="../../../css/style.css" rel="stylesheet" type="text/css">
<script type="text/javascript" src="../../../js/doc.js"></script>
<script type="text/javascript">
CrystalDoc.base_path = "../../../";
</script>
<meta id="repository-name" content="github.com/watzon/arachnid">
<title>Arachnid::Agent::Actions::RuntimeError - github.com/watzon/arachnid</title>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
<input type="search" class="search-input" placeholder="Search..." spellcheck="false" aria-label="Search">
</div>
<div class="repository-links">
<a href="../../../index.html">README</a>
</div>
</div>
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
<div class="types-list">
<ul>
<li class="parent open current" data-id="github.com/watzon/arachnid/Arachnid" data-name="arachnid">
<a href="../../../Arachnid.html">Arachnid</a>
<ul>
<li class="parent open current" data-id="github.com/watzon/arachnid/Arachnid/Agent" data-name="arachnid::agent">
<a href="../../../Arachnid/Agent.html">Agent</a>
<ul>
<li class="parent open current" data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions" data-name="arachnid::agent::actions">
<a href="../../../Arachnid/Agent/Actions.html">Actions</a>
<ul>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/Action" data-name="arachnid::agent::actions::action">
<a href="../../../Arachnid/Agent/Actions/Action.html">Action</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/Paused" data-name="arachnid::agent::actions::paused">
<a href="../../../Arachnid/Agent/Actions/Paused.html">Paused</a>
</li>
<li class=" current" data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/RuntimeError" data-name="arachnid::agent::actions::runtimeerror">
<a href="../../../Arachnid/Agent/Actions/RuntimeError.html">RuntimeError</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/SkipLink" data-name="arachnid::agent::actions::skiplink">
<a href="../../../Arachnid/Agent/Actions/SkipLink.html">SkipLink</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/SkipResource" data-name="arachnid::agent::actions::skipresource">
<a href="../../../Arachnid/Agent/Actions/SkipResource.html">SkipResource</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Queue" data-name="arachnid::agent::queue">
<a href="../../../Arachnid/Agent/Queue.html">Queue</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/AuthCredential" data-name="arachnid::authcredential">
<a href="../../../Arachnid/AuthCredential.html">AuthCredential</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/AuthStore" data-name="arachnid::authstore">
<a href="../../../Arachnid/AuthStore.html">AuthStore</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/CookieJar" data-name="arachnid::cookiejar">
<a href="../../../Arachnid/CookieJar.html">CookieJar</a>
</li>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Document" data-name="arachnid::document">
<a href="../../../Arachnid/Document.html">Document</a>
<ul>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Document/HTML" data-name="arachnid::document::html">
<a href="../../../Arachnid/Document/HTML.html">HTML</a>
<ul>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Document/HTML/Tag" data-name="arachnid::document::html::tag">
<a href="../../../Arachnid/Document/HTML/Tag.html">Tag</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Resource" data-name="arachnid::resource">
<a href="../../../Arachnid/Resource.html">Resource</a>
<ul>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/ContentTypes" data-name="arachnid::resource::contenttypes">
<a href="../../../Arachnid/Resource/ContentTypes.html">ContentTypes</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/Cookies" data-name="arachnid::resource::cookies">
<a href="../../../Arachnid/Resource/Cookies.html">Cookies</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/HTML" data-name="arachnid::resource::html">
<a href="../../../Arachnid/Resource/HTML.html">HTML</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/StatusCodes" data-name="arachnid::resource::statuscodes">
<a href="../../../Arachnid/Resource/StatusCodes.html">StatusCodes</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Rules" data-name="arachnid::rules(t)">
<a href="../../../Arachnid/Rules.html">Rules</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/SessionCache" data-name="arachnid::sessioncache">
<a href="../../../Arachnid/SessionCache.html">SessionCache</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/URI" data-name="uri">
<a href="../../../URI.html">URI</a>
</li>
</ul>
</div>
</div>
<div class="main-content">
<h1 class="type-name">
<span class="kind">class</span> Arachnid::Agent::Actions::RuntimeError
</h1>
<ul class="superclass-hierarchy"><li class="superclass"><a href="../../../Arachnid/Agent/Actions/RuntimeError.html">Arachnid::Agent::Actions::RuntimeError</a></li><li class="superclass">Exception</li><li class="superclass">Reference</li><li class="superclass">Object</li></ul>
<h2>Overview</h2>
<p>A Runtime Error</p>
<h2>Direct Known Subclasses</h2>
<ul class="other-types-list">
<li class="other-type"><a href="../../../Arachnid/Agent/Actions/Action.html">Arachnid::Agent::Actions::Action</a></li>
</ul>
<h2>Defined in:</h2>
<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/agent/actions.cr#L6" target="_blank">
arachnid/agent/actions.cr
</a>
<br/>
<div class="methods-inherited">
</div>
</div>
</body>
</html>

307
docs/Arachnid/Agent/Actions/SkipLink.html Normal file
View File

@ -0,0 +1,307 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.29.0">
<link href="../../../css/style.css" rel="stylesheet" type="text/css">
<script type="text/javascript" src="../../../js/doc.js"></script>
<script type="text/javascript">
CrystalDoc.base_path = "../../../";
</script>
<meta id="repository-name" content="github.com/watzon/arachnid">
<title>Arachnid::Agent::Actions::SkipLink - github.com/watzon/arachnid</title>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
<input type="search" class="search-input" placeholder="Search..." spellcheck="false" aria-label="Search">
</div>
<div class="repository-links">
<a href="../../../index.html">README</a>
</div>
</div>
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
<div class="types-list">
<ul>
<li class="parent open current" data-id="github.com/watzon/arachnid/Arachnid" data-name="arachnid">
<a href="../../../Arachnid.html">Arachnid</a>
<ul>
<li class="parent open current" data-id="github.com/watzon/arachnid/Arachnid/Agent" data-name="arachnid::agent">
<a href="../../../Arachnid/Agent.html">Agent</a>
<ul>
<li class="parent open current" data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions" data-name="arachnid::agent::actions">
<a href="../../../Arachnid/Agent/Actions.html">Actions</a>
<ul>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/Action" data-name="arachnid::agent::actions::action">
<a href="../../../Arachnid/Agent/Actions/Action.html">Action</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/Paused" data-name="arachnid::agent::actions::paused">
<a href="../../../Arachnid/Agent/Actions/Paused.html">Paused</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/RuntimeError" data-name="arachnid::agent::actions::runtimeerror">
<a href="../../../Arachnid/Agent/Actions/RuntimeError.html">RuntimeError</a>
</li>
<li class=" current" data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/SkipLink" data-name="arachnid::agent::actions::skiplink">
<a href="../../../Arachnid/Agent/Actions/SkipLink.html">SkipLink</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/SkipResource" data-name="arachnid::agent::actions::skipresource">
<a href="../../../Arachnid/Agent/Actions/SkipResource.html">SkipResource</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Queue" data-name="arachnid::agent::queue">
<a href="../../../Arachnid/Agent/Queue.html">Queue</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/AuthCredential" data-name="arachnid::authcredential">
<a href="../../../Arachnid/AuthCredential.html">AuthCredential</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/AuthStore" data-name="arachnid::authstore">
<a href="../../../Arachnid/AuthStore.html">AuthStore</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/CookieJar" data-name="arachnid::cookiejar">
<a href="../../../Arachnid/CookieJar.html">CookieJar</a>
</li>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Document" data-name="arachnid::document">
<a href="../../../Arachnid/Document.html">Document</a>
<ul>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Document/HTML" data-name="arachnid::document::html">
<a href="../../../Arachnid/Document/HTML.html">HTML</a>
<ul>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Document/HTML/Tag" data-name="arachnid::document::html::tag">
<a href="../../../Arachnid/Document/HTML/Tag.html">Tag</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Resource" data-name="arachnid::resource">
<a href="../../../Arachnid/Resource.html">Resource</a>
<ul>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/ContentTypes" data-name="arachnid::resource::contenttypes">
<a href="../../../Arachnid/Resource/ContentTypes.html">ContentTypes</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/Cookies" data-name="arachnid::resource::cookies">
<a href="../../../Arachnid/Resource/Cookies.html">Cookies</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/HTML" data-name="arachnid::resource::html">
<a href="../../../Arachnid/Resource/HTML.html">HTML</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/StatusCodes" data-name="arachnid::resource::statuscodes">
<a href="../../../Arachnid/Resource/StatusCodes.html">StatusCodes</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Rules" data-name="arachnid::rules(t)">
<a href="../../../Arachnid/Rules.html">Rules</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/SessionCache" data-name="arachnid::sessioncache">
<a href="../../../Arachnid/SessionCache.html">SessionCache</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/URI" data-name="uri">
<a href="../../../URI.html">URI</a>
</li>
</ul>
</div>
</div>
<div class="main-content">
<h1 class="type-name">
<span class="kind">class</span> Arachnid::Agent::Actions::SkipLink
</h1>
<ul class="superclass-hierarchy"><li class="superclass"><a href="../../../Arachnid/Agent/Actions/SkipLink.html">Arachnid::Agent::Actions::SkipLink</a></li><li class="superclass"><a href="../../../Arachnid/Agent/Actions/Action.html">Arachnid::Agent::Actions::Action</a></li><li class="superclass"><a href="../../../Arachnid/Agent/Actions/RuntimeError.html">Arachnid::Agent::Actions::RuntimeError</a></li><li class="superclass">Exception</li><li class="superclass">Reference</li><li class="superclass">Object</li></ul>
<h2>Overview</h2>
<p>Exception which causes a running <code><a href="../../../Arachnid/Agent.html">Agent</a></code> to skip a link.</p>
<h2>Defined in:</h2>
<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/agent/actions.cr#L15" target="_blank">
arachnid/agent/actions.cr
</a>
<br/>
<div class="methods-inherited">
</div>
</div>
</body>
</html>

307
docs/Arachnid/Agent/Actions/SkipResource.html Normal file
View File

@ -0,0 +1,307 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.29.0">
<link href="../../../css/style.css" rel="stylesheet" type="text/css">
<script type="text/javascript" src="../../../js/doc.js"></script>
<script type="text/javascript">
CrystalDoc.base_path = "../../../";
</script>
<meta id="repository-name" content="github.com/watzon/arachnid">
<title>Arachnid::Agent::Actions::SkipResource - github.com/watzon/arachnid</title>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
<input type="search" class="search-input" placeholder="Search..." spellcheck="false" aria-label="Search">
</div>
<div class="repository-links">
<a href="../../../index.html">README</a>
</div>
</div>
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
<div class="types-list">
<ul>
<li class="parent open current" data-id="github.com/watzon/arachnid/Arachnid" data-name="arachnid">
<a href="../../../Arachnid.html">Arachnid</a>
<ul>
<li class="parent open current" data-id="github.com/watzon/arachnid/Arachnid/Agent" data-name="arachnid::agent">
<a href="../../../Arachnid/Agent.html">Agent</a>
<ul>
<li class="parent open current" data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions" data-name="arachnid::agent::actions">
<a href="../../../Arachnid/Agent/Actions.html">Actions</a>
<ul>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/Action" data-name="arachnid::agent::actions::action">
<a href="../../../Arachnid/Agent/Actions/Action.html">Action</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/Paused" data-name="arachnid::agent::actions::paused">
<a href="../../../Arachnid/Agent/Actions/Paused.html">Paused</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/RuntimeError" data-name="arachnid::agent::actions::runtimeerror">
<a href="../../../Arachnid/Agent/Actions/RuntimeError.html">RuntimeError</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/SkipLink" data-name="arachnid::agent::actions::skiplink">
<a href="../../../Arachnid/Agent/Actions/SkipLink.html">SkipLink</a>
</li>
<li class=" current" data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/SkipResource" data-name="arachnid::agent::actions::skipresource">
<a href="../../../Arachnid/Agent/Actions/SkipResource.html">SkipResource</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Queue" data-name="arachnid::agent::queue">
<a href="../../../Arachnid/Agent/Queue.html">Queue</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/AuthCredential" data-name="arachnid::authcredential">
<a href="../../../Arachnid/AuthCredential.html">AuthCredential</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/AuthStore" data-name="arachnid::authstore">
<a href="../../../Arachnid/AuthStore.html">AuthStore</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/CookieJar" data-name="arachnid::cookiejar">
<a href="../../../Arachnid/CookieJar.html">CookieJar</a>
</li>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Document" data-name="arachnid::document">
<a href="../../../Arachnid/Document.html">Document</a>
<ul>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Document/HTML" data-name="arachnid::document::html">
<a href="../../../Arachnid/Document/HTML.html">HTML</a>
<ul>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Document/HTML/Tag" data-name="arachnid::document::html::tag">
<a href="../../../Arachnid/Document/HTML/Tag.html">Tag</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Resource" data-name="arachnid::resource">
<a href="../../../Arachnid/Resource.html">Resource</a>
<ul>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/ContentTypes" data-name="arachnid::resource::contenttypes">
<a href="../../../Arachnid/Resource/ContentTypes.html">ContentTypes</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/Cookies" data-name="arachnid::resource::cookies">
<a href="../../../Arachnid/Resource/Cookies.html">Cookies</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/HTML" data-name="arachnid::resource::html">
<a href="../../../Arachnid/Resource/HTML.html">HTML</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/StatusCodes" data-name="arachnid::resource::statuscodes">
<a href="../../../Arachnid/Resource/StatusCodes.html">StatusCodes</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Rules" data-name="arachnid::rules(t)">
<a href="../../../Arachnid/Rules.html">Rules</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/SessionCache" data-name="arachnid::sessioncache">
<a href="../../../Arachnid/SessionCache.html">SessionCache</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/URI" data-name="uri">
<a href="../../../URI.html">URI</a>
</li>
</ul>
</div>
</div>
<div class="main-content">
<h1 class="type-name">
<span class="kind">class</span> Arachnid::Agent::Actions::SkipResource
</h1>
<ul class="superclass-hierarchy"><li class="superclass"><a href="../../../Arachnid/Agent/Actions/SkipResource.html">Arachnid::Agent::Actions::SkipResource</a></li><li class="superclass"><a href="../../../Arachnid/Agent/Actions/Action.html">Arachnid::Agent::Actions::Action</a></li><li class="superclass"><a href="../../../Arachnid/Agent/Actions/RuntimeError.html">Arachnid::Agent::Actions::RuntimeError</a></li><li class="superclass">Exception</li><li class="superclass">Reference</li><li class="superclass">Object</li></ul>
<h2>Overview</h2>
<p>Exception which caises a running <code><a href="../../../Arachnid/Agent.html">Agent</a></code> to skip a resource.</p>
<h2>Defined in:</h2>
<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/agent/actions.cr#L18" target="_blank">
arachnid/agent/actions.cr
</a>
<br/>
<div class="methods-inherited">
</div>
</div>
</body>
</html>

436
docs/Arachnid/Agent/Queue.html Normal file
View File

@ -0,0 +1,436 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.29.0">
<link href="../../css/style.css" rel="stylesheet" type="text/css">
<script type="text/javascript" src="../../js/doc.js"></script>
<script type="text/javascript">
CrystalDoc.base_path = "../../";
</script>
<meta id="repository-name" content="github.com/watzon/arachnid">
<title>Arachnid::Agent::Queue - github.com/watzon/arachnid</title>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
<input type="search" class="search-input" placeholder="Search..." spellcheck="false" aria-label="Search">
</div>
<div class="repository-links">
<a href="../../index.html">README</a>
</div>
</div>
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
<div class="types-list">
<ul>
<li class="parent open current" data-id="github.com/watzon/arachnid/Arachnid" data-name="arachnid">
<a href="../../Arachnid.html">Arachnid</a>
<ul>
<li class="parent open current" data-id="github.com/watzon/arachnid/Arachnid/Agent" data-name="arachnid::agent">
<a href="../../Arachnid/Agent.html">Agent</a>
<ul>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions" data-name="arachnid::agent::actions">
<a href="../../Arachnid/Agent/Actions.html">Actions</a>
<ul>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/Action" data-name="arachnid::agent::actions::action">
<a href="../../Arachnid/Agent/Actions/Action.html">Action</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/Paused" data-name="arachnid::agent::actions::paused">
<a href="../../Arachnid/Agent/Actions/Paused.html">Paused</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/RuntimeError" data-name="arachnid::agent::actions::runtimeerror">
<a href="../../Arachnid/Agent/Actions/RuntimeError.html">RuntimeError</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/SkipLink" data-name="arachnid::agent::actions::skiplink">
<a href="../../Arachnid/Agent/Actions/SkipLink.html">SkipLink</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/SkipResource" data-name="arachnid::agent::actions::skipresource">
<a href="../../Arachnid/Agent/Actions/SkipResource.html">SkipResource</a>
</li>
</ul>
</li>
<li class=" current" data-id="github.com/watzon/arachnid/Arachnid/Agent/Queue" data-name="arachnid::agent::queue">
<a href="../../Arachnid/Agent/Queue.html">Queue</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/AuthCredential" data-name="arachnid::authcredential">
<a href="../../Arachnid/AuthCredential.html">AuthCredential</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/AuthStore" data-name="arachnid::authstore">
<a href="../../Arachnid/AuthStore.html">AuthStore</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/CookieJar" data-name="arachnid::cookiejar">
<a href="../../Arachnid/CookieJar.html">CookieJar</a>
</li>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Document" data-name="arachnid::document">
<a href="../../Arachnid/Document.html">Document</a>
<ul>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Document/HTML" data-name="arachnid::document::html">
<a href="../../Arachnid/Document/HTML.html">HTML</a>
<ul>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Document/HTML/Tag" data-name="arachnid::document::html::tag">
<a href="../../Arachnid/Document/HTML/Tag.html">Tag</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Resource" data-name="arachnid::resource">
<a href="../../Arachnid/Resource.html">Resource</a>
<ul>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/ContentTypes" data-name="arachnid::resource::contenttypes">
<a href="../../Arachnid/Resource/ContentTypes.html">ContentTypes</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/Cookies" data-name="arachnid::resource::cookies">
<a href="../../Arachnid/Resource/Cookies.html">Cookies</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/HTML" data-name="arachnid::resource::html">
<a href="../../Arachnid/Resource/HTML.html">HTML</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/StatusCodes" data-name="arachnid::resource::statuscodes">
<a href="../../Arachnid/Resource/StatusCodes.html">StatusCodes</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Rules" data-name="arachnid::rules(t)">
<a href="../../Arachnid/Rules.html">Rules</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/SessionCache" data-name="arachnid::sessioncache">
<a href="../../Arachnid/SessionCache.html">SessionCache</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/URI" data-name="uri">
<a href="../../URI.html">URI</a>
</li>
</ul>
</div>
</div>
<div class="main-content">
<h1 class="type-name">
<span class="kind">class</span> Arachnid::Agent::Queue
</h1>
<ul class="superclass-hierarchy"><li class="superclass"><a href="../../Arachnid/Agent/Queue.html">Arachnid::Agent::Queue</a></li><li class="superclass">Reference</li><li class="superclass">Object</li></ul>
<h2>Defined in:</h2>
<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/agent/queue.cr#L7" target="_blank">
arachnid/agent/queue.cr
</a>
<br/>
<h2>Constructors</h2>
<ul class="list-summary">
<li class="entry-summary">
<a href="#new%28array%3Dnil%2Cpool_size%3Dnil%29-class-method" class="signature"><strong>.new</strong>(array = <span class="n">nil</span>, pool_size = <span class="n">nil</span>)</a>
</li>
</ul>
<h2>Instance Method Summary</h2>
<ul class="list-summary">
<li class="entry-summary">
<a href="#clear-instance-method" class="signature"><strong>#clear</strong></a>
</li>
<li class="entry-summary">
<a href="#enqueue%28item%29-instance-method" class="signature"><strong>#enqueue</strong>(item)</a>
</li>
<li class="entry-summary">
<a href="#mutex%3AMutex-instance-method" class="signature"><strong>#mutex</strong> : Mutex</a>
</li>
<li class="entry-summary">
<a href="#mutex%3D%28mutex%3AMutex%29-instance-method" class="signature"><strong>#mutex=</strong>(mutex : Mutex)</a>
</li>
<li class="entry-summary">
<a href="#queued%3F%28url%29-instance-method" class="signature"><strong>#queued?</strong>(url)</a>
</li>
<li class="entry-summary">
<a href="#run%28%26block%3AURI-%3E%29-instance-method" class="signature"><strong>#run</strong>(&block : URI -> )</a>
</li>
</ul>
<div class="methods-inherited">
</div>
<h2>Constructor Detail</h2>
<div class="entry-detail" id="new(array=nil,pool_size=nil)-class-method">
<div class="signature">
def self.<strong>new</strong>(array = <span class="n">nil</span>, pool_size = <span class="n">nil</span>)
<a class="method-permalink" href="#new%28array%3Dnil%2Cpool_size%3Dnil%29-class-method">#</a>
</div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/agent/queue.cr#L17" target="_blank">View source</a>]
</div>
</div>
<h2>Instance Method Detail</h2>
<div class="entry-detail" id="clear-instance-method">
<div class="signature">
def <strong>clear</strong>
<a class="method-permalink" href="#clear-instance-method">#</a>
</div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/agent/queue.cr#L32" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="enqueue(item)-instance-method">
<div class="signature">
def <strong>enqueue</strong>(item)
<a class="method-permalink" href="#enqueue%28item%29-instance-method">#</a>
</div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/agent/queue.cr#L28" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="mutex:Mutex-instance-method">
<div class="signature">
def <strong>mutex</strong> : Mutex
<a class="method-permalink" href="#mutex%3AMutex-instance-method">#</a>
</div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/agent/queue.cr#L17" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="mutex=(mutex:Mutex)-instance-method">
<div class="signature">
def <strong>mutex=</strong>(mutex : Mutex)
<a class="method-permalink" href="#mutex%3D%28mutex%3AMutex%29-instance-method">#</a>
</div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/agent/queue.cr#L21" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="queued?(url)-instance-method">
<div class="signature">
def <strong>queued?</strong>(url)
<a class="method-permalink" href="#queued%3F%28url%29-instance-method">#</a>
</div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/agent/queue.cr#L36" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="run(&amp;block:URI-&gt;)-instance-method">
<div class="signature">
def <strong>run</strong>(&block : <a href="../../URI.html">URI</a> -> )
<a class="method-permalink" href="#run%28%26block%3AURI-%3E%29-instance-method">#</a>
</div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/agent/queue.cr#L56" target="_blank">View source</a>]
</div>
</div>
</div>
</body>
</html>

404
docs/Arachnid/AuthCredential.html Normal file
View File

@ -0,0 +1,404 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.29.0">
<link href="../css/style.css" rel="stylesheet" type="text/css">
<script type="text/javascript" src="../js/doc.js"></script>
<script type="text/javascript">
CrystalDoc.base_path = "../";
</script>
<meta id="repository-name" content="github.com/watzon/arachnid">
<title>Arachnid::AuthCredential - github.com/watzon/arachnid</title>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
<input type="search" class="search-input" placeholder="Search..." spellcheck="false" aria-label="Search">
</div>
<div class="repository-links">
<a href="../index.html">README</a>
</div>
</div>
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
<div class="types-list">
<ul>
<li class="parent open current" data-id="github.com/watzon/arachnid/Arachnid" data-name="arachnid">
<a href="../Arachnid.html">Arachnid</a>
<ul>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Agent" data-name="arachnid::agent">
<a href="../Arachnid/Agent.html">Agent</a>
<ul>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions" data-name="arachnid::agent::actions">
<a href="../Arachnid/Agent/Actions.html">Actions</a>
<ul>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/Action" data-name="arachnid::agent::actions::action">
<a href="../Arachnid/Agent/Actions/Action.html">Action</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/Paused" data-name="arachnid::agent::actions::paused">
<a href="../Arachnid/Agent/Actions/Paused.html">Paused</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/RuntimeError" data-name="arachnid::agent::actions::runtimeerror">
<a href="../Arachnid/Agent/Actions/RuntimeError.html">RuntimeError</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/SkipLink" data-name="arachnid::agent::actions::skiplink">
<a href="../Arachnid/Agent/Actions/SkipLink.html">SkipLink</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/SkipResource" data-name="arachnid::agent::actions::skipresource">
<a href="../Arachnid/Agent/Actions/SkipResource.html">SkipResource</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Queue" data-name="arachnid::agent::queue">
<a href="../Arachnid/Agent/Queue.html">Queue</a>
</li>
</ul>
</li>
<li class=" current" data-id="github.com/watzon/arachnid/Arachnid/AuthCredential" data-name="arachnid::authcredential">
<a href="../Arachnid/AuthCredential.html">AuthCredential</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/AuthStore" data-name="arachnid::authstore">
<a href="../Arachnid/AuthStore.html">AuthStore</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/CookieJar" data-name="arachnid::cookiejar">
<a href="../Arachnid/CookieJar.html">CookieJar</a>
</li>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Document" data-name="arachnid::document">
<a href="../Arachnid/Document.html">Document</a>
<ul>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Document/HTML" data-name="arachnid::document::html">
<a href="../Arachnid/Document/HTML.html">HTML</a>
<ul>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Document/HTML/Tag" data-name="arachnid::document::html::tag">
<a href="../Arachnid/Document/HTML/Tag.html">Tag</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Resource" data-name="arachnid::resource">
<a href="../Arachnid/Resource.html">Resource</a>
<ul>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/ContentTypes" data-name="arachnid::resource::contenttypes">
<a href="../Arachnid/Resource/ContentTypes.html">ContentTypes</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/Cookies" data-name="arachnid::resource::cookies">
<a href="../Arachnid/Resource/Cookies.html">Cookies</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/HTML" data-name="arachnid::resource::html">
<a href="../Arachnid/Resource/HTML.html">HTML</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/StatusCodes" data-name="arachnid::resource::statuscodes">
<a href="../Arachnid/Resource/StatusCodes.html">StatusCodes</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Rules" data-name="arachnid::rules(t)">
<a href="../Arachnid/Rules.html">Rules</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/SessionCache" data-name="arachnid::sessioncache">
<a href="../Arachnid/SessionCache.html">SessionCache</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/URI" data-name="uri">
<a href="../URI.html">URI</a>
</li>
</ul>
</div>
</div>
<div class="main-content">
<h1 class="type-name">
<span class="kind">struct</span> Arachnid::AuthCredential
</h1>
<ul class="superclass-hierarchy"><li class="superclass"><a href="../Arachnid/AuthCredential.html">Arachnid::AuthCredential</a></li><li class="superclass">Struct</li><li class="superclass">Value</li><li class="superclass">Object</li></ul>
<h2>Overview</h2>
<p>Represents HTTP Authentication credentials for a website.</p>
<h2>Defined in:</h2>
<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/auth_credential.cr#L3" target="_blank">
arachnid/auth_credential.cr
</a>
<br/>
<h2>Constructors</h2>
<ul class="list-summary">
<li class="entry-summary">
<a href="#new%28username%3AString%2Cpassword%3AString%29-class-method" class="signature"><strong>.new</strong>(username : String, password : String)</a>
</li>
</ul>
<h2>Instance Method Summary</h2>
<ul class="list-summary">
<li class="entry-summary">
<a href="#clone-instance-method" class="signature"><strong>#clone</strong></a>
</li>
<li class="entry-summary">
<a href="#copy_with%28username_username%3D%40username%2Cpassword_password%3D%40password%29-instance-method" class="signature"><strong>#copy_with</strong>(username _username = @username, password _password = @password)</a>
</li>
<li class="entry-summary">
<a href="#password%3AString-instance-method" class="signature"><strong>#password</strong> : String</a>
</li>
<li class="entry-summary">
<a href="#username%3AString-instance-method" class="signature"><strong>#username</strong> : String</a>
</li>
</ul>
<div class="methods-inherited">
</div>
<h2>Constructor Detail</h2>
<div class="entry-detail" id="new(username:String,password:String)-class-method">
<div class="signature">
def self.<strong>new</strong>(username : String, password : String)
<a class="method-permalink" href="#new%28username%3AString%2Cpassword%3AString%29-class-method">#</a>
</div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/auth_credential.cr#L3" target="_blank">View source</a>]
</div>
</div>
<h2>Instance Method Detail</h2>
<div class="entry-detail" id="clone-instance-method">
<div class="signature">
def <strong>clone</strong>
<a class="method-permalink" href="#clone-instance-method">#</a>
</div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/auth_credential.cr#L3" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="copy_with(username_username=@username,password_password=@password)-instance-method">
<div class="signature">
def <strong>copy_with</strong>(username _username = @username, password _password = @password)
<a class="method-permalink" href="#copy_with%28username_username%3D%40username%2Cpassword_password%3D%40password%29-instance-method">#</a>
</div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/auth_credential.cr#L3" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="password:String-instance-method">
<div class="signature">
def <strong>password</strong> : String
<a class="method-permalink" href="#password%3AString-instance-method">#</a>
</div>
<br/>
<div>
</div>
</div>
<div class="entry-detail" id="username:String-instance-method">
<div class="signature">
def <strong>username</strong> : String
<a class="method-permalink" href="#username%3AString-instance-method">#</a>
</div>
<br/>
<div>
</div>
</div>
</div>
</body>
</html>

458
docs/Arachnid/AuthStore.html Normal file
View File

@ -0,0 +1,458 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.29.0">
<link href="../css/style.css" rel="stylesheet" type="text/css">
<script type="text/javascript" src="../js/doc.js"></script>
<script type="text/javascript">
CrystalDoc.base_path = "../";
</script>
<meta id="repository-name" content="github.com/watzon/arachnid">
<title>Arachnid::AuthStore - github.com/watzon/arachnid</title>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
<input type="search" class="search-input" placeholder="Search..." spellcheck="false" aria-label="Search">
</div>
<div class="repository-links">
<a href="../index.html">README</a>
</div>
</div>
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
<div class="types-list">
<ul>
<li class="parent open current" data-id="github.com/watzon/arachnid/Arachnid" data-name="arachnid">
<a href="../Arachnid.html">Arachnid</a>
<ul>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Agent" data-name="arachnid::agent">
<a href="../Arachnid/Agent.html">Agent</a>
<ul>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions" data-name="arachnid::agent::actions">
<a href="../Arachnid/Agent/Actions.html">Actions</a>
<ul>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/Action" data-name="arachnid::agent::actions::action">
<a href="../Arachnid/Agent/Actions/Action.html">Action</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/Paused" data-name="arachnid::agent::actions::paused">
<a href="../Arachnid/Agent/Actions/Paused.html">Paused</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/RuntimeError" data-name="arachnid::agent::actions::runtimeerror">
<a href="../Arachnid/Agent/Actions/RuntimeError.html">RuntimeError</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/SkipLink" data-name="arachnid::agent::actions::skiplink">
<a href="../Arachnid/Agent/Actions/SkipLink.html">SkipLink</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/SkipResource" data-name="arachnid::agent::actions::skipresource">
<a href="../Arachnid/Agent/Actions/SkipResource.html">SkipResource</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Queue" data-name="arachnid::agent::queue">
<a href="../Arachnid/Agent/Queue.html">Queue</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/AuthCredential" data-name="arachnid::authcredential">
<a href="../Arachnid/AuthCredential.html">AuthCredential</a>
</li>
<li class=" current" data-id="github.com/watzon/arachnid/Arachnid/AuthStore" data-name="arachnid::authstore">
<a href="../Arachnid/AuthStore.html">AuthStore</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/CookieJar" data-name="arachnid::cookiejar">
<a href="../Arachnid/CookieJar.html">CookieJar</a>
</li>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Document" data-name="arachnid::document">
<a href="../Arachnid/Document.html">Document</a>
<ul>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Document/HTML" data-name="arachnid::document::html">
<a href="../Arachnid/Document/HTML.html">HTML</a>
<ul>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Document/HTML/Tag" data-name="arachnid::document::html::tag">
<a href="../Arachnid/Document/HTML/Tag.html">Tag</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Resource" data-name="arachnid::resource">
<a href="../Arachnid/Resource.html">Resource</a>
<ul>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/ContentTypes" data-name="arachnid::resource::contenttypes">
<a href="../Arachnid/Resource/ContentTypes.html">ContentTypes</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/Cookies" data-name="arachnid::resource::cookies">
<a href="../Arachnid/Resource/Cookies.html">Cookies</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/HTML" data-name="arachnid::resource::html">
<a href="../Arachnid/Resource/HTML.html">HTML</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/StatusCodes" data-name="arachnid::resource::statuscodes">
<a href="../Arachnid/Resource/StatusCodes.html">StatusCodes</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Rules" data-name="arachnid::rules(t)">
<a href="../Arachnid/Rules.html">Rules</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/SessionCache" data-name="arachnid::sessioncache">
<a href="../Arachnid/SessionCache.html">SessionCache</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/URI" data-name="uri">
<a href="../URI.html">URI</a>
</li>
</ul>
</div>
</div>
<div class="main-content">
<h1 class="type-name">
<span class="kind">class</span> Arachnid::AuthStore
</h1>
<ul class="superclass-hierarchy"><li class="superclass"><a href="../Arachnid/AuthStore.html">Arachnid::AuthStore</a></li><li class="superclass">Reference</li><li class="superclass">Object</li></ul>
<h2>Defined in:</h2>
<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/auth_store.cr#L7" target="_blank">
arachnid/auth_store.cr
</a>
<br/>
<h2>Instance Method Summary</h2>
<ul class="list-summary">
<li class="entry-summary">
<a href="#%5B%5D%28url%29-instance-method" class="signature"><strong>#[]</strong>(url)</a>
<div class="summary"><p>Given a URL, return the most specific matching auth credential.</p></div>
</li>
<li class="entry-summary">
<a href="#%5B%5D%3D%28url%2Cauth%29-instance-method" class="signature"><strong>#[]=</strong>(url, auth)</a>
<div class="summary"><p>Add an auth credential to the store for the supplied base URL.</p></div>
</li>
<li class="entry-summary">
<a href="#add%28url%2Cusername%2Cpassword%29-instance-method" class="signature"><strong>#add</strong>(url, username, password)</a>
<div class="summary"><p>Convenience method to add username and password credentials for a named URL.</p></div>
</li>
<li class="entry-summary">
<a href="#clear%21-instance-method" class="signature"><strong>#clear!</strong></a>
<div class="summary"><p>Clear the contents of the auth store.</p></div>
</li>
<li class="entry-summary">
<a href="#for_url%28url%29-instance-method" class="signature"><strong>#for_url</strong>(url)</a>
<div class="summary"><p>Returns the base64 encoded authorization string for the URL or <code>nil</code> if no authorization exists.</p></div>
</li>
<li class="entry-summary">
<a href="#inspect-instance-method" class="signature"><strong>#inspect</strong></a>
<div class="summary"><p>Inspect the auth store</p></div>
</li>
<li class="entry-summary">
<a href="#size-instance-method" class="signature"><strong>#size</strong></a>
<div class="summary"><p>Size of the current auth store (number of URL paths stored)</p></div>
</li>
</ul>
<div class="methods-inherited">
</div>
<h2>Instance Method Detail</h2>
<div class="entry-detail" id="[](url)-instance-method">
<div class="signature">
def <strong>[]</strong>(url)
<a class="method-permalink" href="#%5B%5D%28url%29-instance-method">#</a>
</div>
<div class="doc"><p>Given a URL, return the most specific matching auth credential.</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/auth_store.cr#L11" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="[]=(url,auth)-instance-method">
<div class="signature">
def <strong>[]=</strong>(url, auth)
<a class="method-permalink" href="#%5B%5D%3D%28url%2Cauth%29-instance-method">#</a>
</div>
<div class="doc"><p>Add an auth credential to the store for the supplied base URL.</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/auth_store.cr#L34" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="add(url,username,password)-instance-method">
<div class="signature">
def <strong>add</strong>(url, username, password)
<a class="method-permalink" href="#add%28url%2Cusername%2Cpassword%29-instance-method">#</a>
</div>
<div class="doc"><p>Convenience method to add username and password credentials
for a named URL.</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/auth_store.cr#L50" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="clear!-instance-method">
<div class="signature">
def <strong>clear!</strong>
<a class="method-permalink" href="#clear%21-instance-method">#</a>
</div>
<div class="doc"><p>Clear the contents of the auth store.</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/auth_store.cr#L63" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="for_url(url)-instance-method">
<div class="signature">
def <strong>for_url</strong>(url)
<a class="method-permalink" href="#for_url%28url%29-instance-method">#</a>
</div>
<div class="doc"><p>Returns the base64 encoded authorization string for the URL
or <code>nil</code> if no authorization exists.</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/auth_store.cr#L56" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="inspect-instance-method">
<div class="signature">
def <strong>inspect</strong>
<a class="method-permalink" href="#inspect-instance-method">#</a>
</div>
<div class="doc"><p>Inspect the auth store</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/auth_store.cr#L74" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="size-instance-method">
<div class="signature">
def <strong>size</strong>
<a class="method-permalink" href="#size-instance-method">#</a>
</div>
<div class="doc"><p>Size of the current auth store (number of URL paths stored)</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/auth_store.cr#L69" target="_blank">View source</a>]
</div>
</div>
</div>
</body>
</html>

562
docs/Arachnid/CookieJar.html Normal file
View File

@ -0,0 +1,562 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.29.0">
<link href="../css/style.css" rel="stylesheet" type="text/css">
<script type="text/javascript" src="../js/doc.js"></script>
<script type="text/javascript">
CrystalDoc.base_path = "../";
</script>
<meta id="repository-name" content="github.com/watzon/arachnid">
<title>Arachnid::CookieJar - github.com/watzon/arachnid</title>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
<input type="search" class="search-input" placeholder="Search..." spellcheck="false" aria-label="Search">
</div>
<div class="repository-links">
<a href="../index.html">README</a>
</div>
</div>
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
<div class="types-list">
<ul>
<li class="parent open current" data-id="github.com/watzon/arachnid/Arachnid" data-name="arachnid">
<a href="../Arachnid.html">Arachnid</a>
<ul>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Agent" data-name="arachnid::agent">
<a href="../Arachnid/Agent.html">Agent</a>
<ul>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions" data-name="arachnid::agent::actions">
<a href="../Arachnid/Agent/Actions.html">Actions</a>
<ul>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/Action" data-name="arachnid::agent::actions::action">
<a href="../Arachnid/Agent/Actions/Action.html">Action</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/Paused" data-name="arachnid::agent::actions::paused">
<a href="../Arachnid/Agent/Actions/Paused.html">Paused</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/RuntimeError" data-name="arachnid::agent::actions::runtimeerror">
<a href="../Arachnid/Agent/Actions/RuntimeError.html">RuntimeError</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/SkipLink" data-name="arachnid::agent::actions::skiplink">
<a href="../Arachnid/Agent/Actions/SkipLink.html">SkipLink</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/SkipResource" data-name="arachnid::agent::actions::skipresource">
<a href="../Arachnid/Agent/Actions/SkipResource.html">SkipResource</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Queue" data-name="arachnid::agent::queue">
<a href="../Arachnid/Agent/Queue.html">Queue</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/AuthCredential" data-name="arachnid::authcredential">
<a href="../Arachnid/AuthCredential.html">AuthCredential</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/AuthStore" data-name="arachnid::authstore">
<a href="../Arachnid/AuthStore.html">AuthStore</a>
</li>
<li class=" current" data-id="github.com/watzon/arachnid/Arachnid/CookieJar" data-name="arachnid::cookiejar">
<a href="../Arachnid/CookieJar.html">CookieJar</a>
</li>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Document" data-name="arachnid::document">
<a href="../Arachnid/Document.html">Document</a>
<ul>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Document/HTML" data-name="arachnid::document::html">
<a href="../Arachnid/Document/HTML.html">HTML</a>
<ul>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Document/HTML/Tag" data-name="arachnid::document::html::tag">
<a href="../Arachnid/Document/HTML/Tag.html">Tag</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Resource" data-name="arachnid::resource">
<a href="../Arachnid/Resource.html">Resource</a>
<ul>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/ContentTypes" data-name="arachnid::resource::contenttypes">
<a href="../Arachnid/Resource/ContentTypes.html">ContentTypes</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/Cookies" data-name="arachnid::resource::cookies">
<a href="../Arachnid/Resource/Cookies.html">Cookies</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/HTML" data-name="arachnid::resource::html">
<a href="../Arachnid/Resource/HTML.html">HTML</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/StatusCodes" data-name="arachnid::resource::statuscodes">
<a href="../Arachnid/Resource/StatusCodes.html">StatusCodes</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Rules" data-name="arachnid::rules(t)">
<a href="../Arachnid/Rules.html">Rules</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/SessionCache" data-name="arachnid::sessioncache">
<a href="../Arachnid/SessionCache.html">SessionCache</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/URI" data-name="uri">
<a href="../URI.html">URI</a>
</li>
</ul>
</div>
</div>
<div class="main-content">
<h1 class="type-name">
<span class="kind">class</span> Arachnid::CookieJar
</h1>
<ul class="superclass-hierarchy"><li class="superclass"><a href="../Arachnid/CookieJar.html">Arachnid::CookieJar</a></li><li class="superclass">Reference</li><li class="superclass">Object</li></ul>
<h2>Overview</h2>
<p>As hosts are scanned their cookies are stored here.</p>
<h2>Included Modules</h2>
<ul class="other-types-list">
<li class="other-type">Enumerable(HTTP::Cookies)</li>
</ul>
<h2>Defined in:</h2>
<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/cookie_jar.cr#L3" target="_blank">
arachnid/cookie_jar.cr
</a>
<br/>
<h2>Constructors</h2>
<ul class="list-summary">
<li class="entry-summary">
<a href="#new-class-method" class="signature"><strong>.new</strong></a>
<div class="summary"><p>Creates a new <code><a href="../Arachnid/CookieJar.html">CookieJar</a></code></p></div>
</li>
</ul>
<h2>Instance Method Summary</h2>
<ul class="list-summary">
<li class="entry-summary">
<a href="#%5B%5D%28host%3AString%29-instance-method" class="signature"><strong>#[]</strong>(host : String)</a>
<div class="summary"><p>Returns all relevant cookies in a single string for the named host or domain.</p></div>
</li>
<li class="entry-summary">
<a href="#%5B%5D%3D%28host%3AString%2Ccookies%3AHTTP%3A%3ACookies%29-instance-method" class="signature"><strong>#[]=</strong>(host : String, cookies : HTTP::Cookies)</a>
<div class="summary"><p>Add a cookie to the jar for a particular domain.</p></div>
</li>
<li class="entry-summary">
<a href="#clear%21-instance-method" class="signature"><strong>#clear!</strong></a>
<div class="summary"><p>Clear out the jar, removing all stored cookies.</p></div>
</li>
<li class="entry-summary">
<a href="#cookies_for_host%28host%29-instance-method" class="signature"><strong>#cookies_for_host</strong>(host)</a>
<div class="summary"><p>Returns raw cookie value pairs for a given host.</p></div>
</li>
<li class="entry-summary">
<a href="#each%28%26block%29-instance-method" class="signature"><strong>#each</strong>(&block)</a>
<div class="summary"><p>Iterates over the host-name and cookie value pairs in the jar.</p></div>
</li>
<li class="entry-summary">
<a href="#for_host%28host%29-instance-method" class="signature"><strong>#for_host</strong>(host)</a>
<div class="summary"><p>Returns the pre-encoded Cookie for a given host.</p></div>
</li>
<li class="entry-summary">
<a href="#from_resource%28resource%29-instance-method" class="signature"><strong>#from_resource</strong>(resource)</a>
<div class="summary"><p>Retrieve cookies for a domain from the response.</p></div>
</li>
<li class="entry-summary">
<a href="#inspect-instance-method" class="signature"><strong>#inspect</strong></a>
<div class="summary"><p>Inspects the cookie jar.</p></div>
</li>
<li class="entry-summary">
<a href="#size-instance-method" class="signature"><strong>#size</strong></a>
<div class="summary"><p>Size of the cookie jar.</p></div>
</li>
</ul>
<div class="methods-inherited">
</div>
<h2>Constructor Detail</h2>
<div class="entry-detail" id="new-class-method">
<div class="signature">
def self.<strong>new</strong>
<a class="method-permalink" href="#new-class-method">#</a>
</div>
<div class="doc"><p>Creates a new <code><a href="../Arachnid/CookieJar.html">CookieJar</a></code></p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/cookie_jar.cr#L13" target="_blank">View source</a>]
</div>
</div>
<h2>Instance Method Detail</h2>
<div class="entry-detail" id="[](host:String)-instance-method">
<div class="signature">
def <strong>[]</strong>(host : String)
<a class="method-permalink" href="#%5B%5D%28host%3AString%29-instance-method">#</a>
</div>
<div class="doc"><p>Returns all relevant cookies in a single string for the named
host or domain.</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/cookie_jar.cr#L28" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="[]=(host:String,cookies:HTTP::Cookies)-instance-method">
<div class="signature">
def <strong>[]=</strong>(host : String, cookies : HTTP::Cookies)
<a class="method-permalink" href="#%5B%5D%3D%28host%3AString%2Ccookies%3AHTTP%3A%3ACookies%29-instance-method">#</a>
</div>
<div class="doc"><p>Add a cookie to the jar for a particular domain.</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/cookie_jar.cr#L33" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="clear!-instance-method">
<div class="signature">
def <strong>clear!</strong>
<a class="method-permalink" href="#clear%21-instance-method">#</a>
</div>
<div class="doc"><p>Clear out the jar, removing all stored cookies.</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/cookie_jar.cr#L102" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="cookies_for_host(host)-instance-method">
<div class="signature">
def <strong>cookies_for_host</strong>(host)
<a class="method-permalink" href="#cookies_for_host%28host%29-instance-method">#</a>
</div>
<div class="doc"><p>Returns raw cookie value pairs for a given host. Includes cookies
set on parent domains.</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/cookie_jar.cr#L80" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="each(&amp;block)-instance-method">
<div class="signature">
def <strong>each</strong>(&block)
<a class="method-permalink" href="#each%28%26block%29-instance-method">#</a>
</div>
<div class="doc"><p>Iterates over the host-name and cookie value pairs in the jar.</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/cookie_jar.cr#L20" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="for_host(host)-instance-method">
<div class="signature">
def <strong>for_host</strong>(host)
<a class="method-permalink" href="#for_host%28host%29-instance-method">#</a>
</div>
<div class="doc"><p>Returns the pre-encoded Cookie for a given host.</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/cookie_jar.cr#L63" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="from_resource(resource)-instance-method">
<div class="signature">
def <strong>from_resource</strong>(resource)
<a class="method-permalink" href="#from_resource%28resource%29-instance-method">#</a>
</div>
<div class="doc"><p>Retrieve cookies for a domain from the response.</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/cookie_jar.cr#L51" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="inspect-instance-method">
<div class="signature">
def <strong>inspect</strong>
<a class="method-permalink" href="#inspect-instance-method">#</a>
</div>
<div class="doc"><p>Inspects the cookie jar.</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/cookie_jar.cr#L115" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="size-instance-method">
<div class="signature">
def <strong>size</strong>
<a class="method-permalink" href="#size-instance-method">#</a>
</div>
<div class="doc"><p>Size of the cookie jar.</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/cookie_jar.cr#L110" target="_blank">View source</a>]
</div>
</div>
</div>
</body>
</html>

251
docs/Arachnid/Document.html Normal file
View File

@ -0,0 +1,251 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.29.0">
<link href="../css/style.css" rel="stylesheet" type="text/css">
<script type="text/javascript" src="../js/doc.js"></script>
<script type="text/javascript">
CrystalDoc.base_path = "../";
</script>
<meta id="repository-name" content="github.com/watzon/arachnid">
<title>Arachnid::Document - github.com/watzon/arachnid</title>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
<input type="search" class="search-input" placeholder="Search..." spellcheck="false" aria-label="Search">
</div>
<div class="repository-links">
<a href="../index.html">README</a>
</div>
</div>
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
<div class="types-list">
<ul>
<li class="parent open current" data-id="github.com/watzon/arachnid/Arachnid" data-name="arachnid">
<a href="../Arachnid.html">Arachnid</a>
<ul>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Agent" data-name="arachnid::agent">
<a href="../Arachnid/Agent.html">Agent</a>
<ul>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions" data-name="arachnid::agent::actions">
<a href="../Arachnid/Agent/Actions.html">Actions</a>
<ul>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/Action" data-name="arachnid::agent::actions::action">
<a href="../Arachnid/Agent/Actions/Action.html">Action</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/Paused" data-name="arachnid::agent::actions::paused">
<a href="../Arachnid/Agent/Actions/Paused.html">Paused</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/RuntimeError" data-name="arachnid::agent::actions::runtimeerror">
<a href="../Arachnid/Agent/Actions/RuntimeError.html">RuntimeError</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/SkipLink" data-name="arachnid::agent::actions::skiplink">
<a href="../Arachnid/Agent/Actions/SkipLink.html">SkipLink</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/SkipResource" data-name="arachnid::agent::actions::skipresource">
<a href="../Arachnid/Agent/Actions/SkipResource.html">SkipResource</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Queue" data-name="arachnid::agent::queue">
<a href="../Arachnid/Agent/Queue.html">Queue</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/AuthCredential" data-name="arachnid::authcredential">
<a href="../Arachnid/AuthCredential.html">AuthCredential</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/AuthStore" data-name="arachnid::authstore">
<a href="../Arachnid/AuthStore.html">AuthStore</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/CookieJar" data-name="arachnid::cookiejar">
<a href="../Arachnid/CookieJar.html">CookieJar</a>
</li>
<li class="parent open current" data-id="github.com/watzon/arachnid/Arachnid/Document" data-name="arachnid::document">
<a href="../Arachnid/Document.html">Document</a>
<ul>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Document/HTML" data-name="arachnid::document::html">
<a href="../Arachnid/Document/HTML.html">HTML</a>
<ul>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Document/HTML/Tag" data-name="arachnid::document::html::tag">
<a href="../Arachnid/Document/HTML/Tag.html">Tag</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Resource" data-name="arachnid::resource">
<a href="../Arachnid/Resource.html">Resource</a>
<ul>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/ContentTypes" data-name="arachnid::resource::contenttypes">
<a href="../Arachnid/Resource/ContentTypes.html">ContentTypes</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/Cookies" data-name="arachnid::resource::cookies">
<a href="../Arachnid/Resource/Cookies.html">Cookies</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/HTML" data-name="arachnid::resource::html">
<a href="../Arachnid/Resource/HTML.html">HTML</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/StatusCodes" data-name="arachnid::resource::statuscodes">
<a href="../Arachnid/Resource/StatusCodes.html">StatusCodes</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Rules" data-name="arachnid::rules(t)">
<a href="../Arachnid/Rules.html">Rules</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/SessionCache" data-name="arachnid::sessioncache">
<a href="../Arachnid/SessionCache.html">SessionCache</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/URI" data-name="uri">
<a href="../URI.html">URI</a>
</li>
</ul>
</div>
</div>
<div class="main-content">
<h1 class="type-name">
<span class="kind">module</span> Arachnid::Document
</h1>
<h2>Defined in:</h2>
<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/document/html.cr#L4" target="_blank">
arachnid/document/html.cr
</a>
<br/>
<div class="methods-inherited">
</div>
</div>
</body>
</html>

559
docs/Arachnid/Document/HTML.html Normal file
View File

@ -0,0 +1,559 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.29.0">
<link href="../../css/style.css" rel="stylesheet" type="text/css">
<script type="text/javascript" src="../../js/doc.js"></script>
<script type="text/javascript">
CrystalDoc.base_path = "../../";
</script>
<meta id="repository-name" content="github.com/watzon/arachnid">
<title>Arachnid::Document::HTML - github.com/watzon/arachnid</title>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
<input type="search" class="search-input" placeholder="Search..." spellcheck="false" aria-label="Search">
</div>
<div class="repository-links">
<a href="../../index.html">README</a>
</div>
</div>
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
<div class="types-list">
<ul>
<li class="parent open current" data-id="github.com/watzon/arachnid/Arachnid" data-name="arachnid">
<a href="../../Arachnid.html">Arachnid</a>
<ul>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Agent" data-name="arachnid::agent">
<a href="../../Arachnid/Agent.html">Agent</a>
<ul>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions" data-name="arachnid::agent::actions">
<a href="../../Arachnid/Agent/Actions.html">Actions</a>
<ul>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/Action" data-name="arachnid::agent::actions::action">
<a href="../../Arachnid/Agent/Actions/Action.html">Action</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/Paused" data-name="arachnid::agent::actions::paused">
<a href="../../Arachnid/Agent/Actions/Paused.html">Paused</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/RuntimeError" data-name="arachnid::agent::actions::runtimeerror">
<a href="../../Arachnid/Agent/Actions/RuntimeError.html">RuntimeError</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/SkipLink" data-name="arachnid::agent::actions::skiplink">
<a href="../../Arachnid/Agent/Actions/SkipLink.html">SkipLink</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/SkipResource" data-name="arachnid::agent::actions::skipresource">
<a href="../../Arachnid/Agent/Actions/SkipResource.html">SkipResource</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Queue" data-name="arachnid::agent::queue">
<a href="../../Arachnid/Agent/Queue.html">Queue</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/AuthCredential" data-name="arachnid::authcredential">
<a href="../../Arachnid/AuthCredential.html">AuthCredential</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/AuthStore" data-name="arachnid::authstore">
<a href="../../Arachnid/AuthStore.html">AuthStore</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/CookieJar" data-name="arachnid::cookiejar">
<a href="../../Arachnid/CookieJar.html">CookieJar</a>
</li>
<li class="parent open current" data-id="github.com/watzon/arachnid/Arachnid/Document" data-name="arachnid::document">
<a href="../../Arachnid/Document.html">Document</a>
<ul>
<li class="parent open current" data-id="github.com/watzon/arachnid/Arachnid/Document/HTML" data-name="arachnid::document::html">
<a href="../../Arachnid/Document/HTML.html">HTML</a>
<ul>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Document/HTML/Tag" data-name="arachnid::document::html::tag">
<a href="../../Arachnid/Document/HTML/Tag.html">Tag</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Resource" data-name="arachnid::resource">
<a href="../../Arachnid/Resource.html">Resource</a>
<ul>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/ContentTypes" data-name="arachnid::resource::contenttypes">
<a href="../../Arachnid/Resource/ContentTypes.html">ContentTypes</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/Cookies" data-name="arachnid::resource::cookies">
<a href="../../Arachnid/Resource/Cookies.html">Cookies</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/HTML" data-name="arachnid::resource::html">
<a href="../../Arachnid/Resource/HTML.html">HTML</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/StatusCodes" data-name="arachnid::resource::statuscodes">
<a href="../../Arachnid/Resource/StatusCodes.html">StatusCodes</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Rules" data-name="arachnid::rules(t)">
<a href="../../Arachnid/Rules.html">Rules</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/SessionCache" data-name="arachnid::sessioncache">
<a href="../../Arachnid/SessionCache.html">SessionCache</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/URI" data-name="uri">
<a href="../../URI.html">URI</a>
</li>
</ul>
</div>
</div>
<div class="main-content">
<h1 class="type-name">
<span class="kind">struct</span> Arachnid::Document::HTML
</h1>
<ul class="superclass-hierarchy"><li class="superclass"><a href="../../Arachnid/Document/HTML.html">Arachnid::Document::HTML</a></li><li class="superclass">Struct</li><li class="superclass">Value</li><li class="superclass">Object</li></ul>
<h2>Defined in:</h2>
<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/document/html.cr#L5" target="_blank">
arachnid/document/html.cr
</a>
<br/>
<h2>Constructors</h2>
<ul class="list-summary">
<li class="entry-summary">
<a href="#new%28content%3AString%29-class-method" class="signature"><strong>.new</strong>(content : String)</a>
</li>
</ul>
<h2>Class Method Summary</h2>
<ul class="list-summary">
<li class="entry-summary">
<a href="#css_query_to_xpath%28query%3AString%29%3AString-class-method" class="signature"><strong>.css_query_to_xpath</strong>(query : String) : String</a>
<div class="summary"><p>Transform the css query into an xpath query</p></div>
</li>
<li class="entry-summary">
<a href="#parse%28content%3AString%29-class-method" class="signature"><strong>.parse</strong>(content : String)</a>
</li>
</ul>
<h2>Instance Method Summary</h2>
<ul class="list-summary">
<li class="entry-summary">
<a href="#at_css%28query%3AString%29-instance-method" class="signature"><strong>#at_css</strong>(query : String)</a>
<div class="summary"><p>Find first node corresponding to the css query and return <code><a href="../../Arachnid/Document/HTML/Tag.html">HTML::Tag</a></code> if found or <code>nil</code> if not found</p></div>
</li>
<li class="entry-summary">
<a href="#at_id%28id_name%3AString%29%3ATag%3F-instance-method" class="signature"><strong>#at_id</strong>(id_name : String) : Tag?</a>
<div class="summary"><p>Find a node by its id and return a <code><a href="../../Arachnid/Document/HTML/Tag.html">HTML::Tag</a></code> found or <code>nil</code> if not found</p></div>
</li>
<li class="entry-summary">
<a href="#at_tag%28tag_name%3AString%29%3ATag%3F-instance-method" class="signature"><strong>#at_tag</strong>(tag_name : String) : Tag?</a>
<div class="summary"><p>Find first tag by tag name and return <code><a href="../../Arachnid/Document/HTML/Tag.html">HTML::Tag</a></code> if found or <code>nil</code> if not found</p></div>
</li>
<li class="entry-summary">
<a href="#css%28query%3AString%2C%26block%29%3AArray%28Tag%29-instance-method" class="signature"><strong>#css</strong>(query : String, &block) : Array(Tag)</a>
<div class="summary"><p>Find all nodes corresponding to the css query and yield <code><a href="../../Arachnid/Document/HTML/Tag.html">HTML::Tag</a></code> found or <code>nil</code> if not found</p></div>
</li>
<li class="entry-summary">
<a href="#where_class%28class_name%3AString%2C%26block%29%3AArray%28Tag%29-instance-method" class="signature"><strong>#where_class</strong>(class_name : String, &block) : Array(Tag)</a>
<div class="summary"><p>Find all nodes by classname and yield <code><a href="../../Arachnid/Document/HTML/Tag.html">HTML::Tag</a></code> founded</p></div>
</li>
<li class="entry-summary">
<a href="#where_tag%28tag_name%3AString%2C%26block%29%3AArray%28Tag%29-instance-method" class="signature"><strong>#where_tag</strong>(tag_name : String, &block) : Array(Tag)</a>
<div class="summary"><p>Find all nodes by tag name and yield <code><a href="../../Arachnid/Document/HTML/Tag.html">HTML::Tag</a></code> if found</p></div>
</li>
</ul>
<h2>Macro Summary</h2>
<ul class="list-summary">
<li class="entry-summary">
<a href="#method_missing%28call%29-macro" class="signature"><strong>method_missing</strong>(call)</a>
</li>
</ul>
<div class="methods-inherited">
</div>
<h2>Constructor Detail</h2>
<div class="entry-detail" id="new(content:String)-class-method">
<div class="signature">
def self.<strong>new</strong>(content : String)
<a class="method-permalink" href="#new%28content%3AString%29-class-method">#</a>
</div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/document/html.cr#L18" target="_blank">View source</a>]
</div>
</div>
<h2>Class Method Detail</h2>
<div class="entry-detail" id="css_query_to_xpath(query:String):String-class-method">
<div class="signature">
def self.<strong>css_query_to_xpath</strong>(query : String) : String
<a class="method-permalink" href="#css_query_to_xpath%28query%3AString%29%3AString-class-method">#</a>
</div>
<div class="doc"><p>Transform the css query into an xpath query</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/document/html.cr#L33" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="parse(content:String)-class-method">
<div class="signature">
def self.<strong>parse</strong>(content : String)
<a class="method-permalink" href="#parse%28content%3AString%29-class-method">#</a>
</div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/document/html.cr#L28" target="_blank">View source</a>]
</div>
</div>
<h2>Instance Method Detail</h2>
<div class="entry-detail" id="at_css(query:String)-instance-method">
<div class="signature">
def <strong>at_css</strong>(query : String)
<a class="method-permalink" href="#at_css%28query%3AString%29-instance-method">#</a>
</div>
<div class="doc"><p>Find first node corresponding to the css query and return
<code><a href="../../Arachnid/Document/HTML/Tag.html">HTML::Tag</a></code> if found or <code>nil</code> if not found</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/document/html.cr#L107" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="at_id(id_name:String):Tag?-instance-method">
<div class="signature">
def <strong>at_id</strong>(id_name : String) : <a href="../../Arachnid/Document/HTML/Tag.html">Tag</a>?
<a class="method-permalink" href="#at_id%28id_name%3AString%29%3ATag%3F-instance-method">#</a>
</div>
<div class="doc"><p>Find a node by its id and return a
<code><a href="../../Arachnid/Document/HTML/Tag.html">HTML::Tag</a></code> found or <code>nil</code> if not found</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/document/html.cr#L88" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="at_tag(tag_name:String):Tag?-instance-method">
<div class="signature">
def <strong>at_tag</strong>(tag_name : String) : <a href="../../Arachnid/Document/HTML/Tag.html">Tag</a>?
<a class="method-permalink" href="#at_tag%28tag_name%3AString%29%3ATag%3F-instance-method">#</a>
</div>
<div class="doc"><p>Find first tag by tag name and return
<code><a href="../../Arachnid/Document/HTML/Tag.html">HTML::Tag</a></code> if found or <code>nil</code> if not found</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/document/html.cr#L50" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="css(query:String,&amp;block):Array(Tag)-instance-method">
<div class="signature">
def <strong>css</strong>(query : String, &block) : Array(<a href="../../Arachnid/Document/HTML/Tag.html">Tag</a>)
<a class="method-permalink" href="#css%28query%3AString%2C%26block%29%3AArray%28Tag%29-instance-method">#</a>
</div>
<div class="doc"><p>Find all nodes corresponding to the css query and yield
<code><a href="../../Arachnid/Document/HTML/Tag.html">HTML::Tag</a></code> found or <code>nil</code> if not found</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/document/html.cr#L96" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="where_class(class_name:String,&amp;block):Array(Tag)-instance-method">
<div class="signature">
def <strong>where_class</strong>(class_name : String, &block) : Array(<a href="../../Arachnid/Document/HTML/Tag.html">Tag</a>)
<a class="method-permalink" href="#where_class%28class_name%3AString%2C%26block%29%3AArray%28Tag%29-instance-method">#</a>
</div>
<div class="doc"><p>Find all nodes by classname and yield
<code><a href="../../Arachnid/Document/HTML/Tag.html">HTML::Tag</a></code> founded</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/document/html.cr#L74" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="where_tag(tag_name:String,&amp;block):Array(Tag)-instance-method">
<div class="signature">
def <strong>where_tag</strong>(tag_name : String, &block) : Array(<a href="../../Arachnid/Document/HTML/Tag.html">Tag</a>)
<a class="method-permalink" href="#where_tag%28tag_name%3AString%2C%26block%29%3AArray%28Tag%29-instance-method">#</a>
</div>
<div class="doc"><p>Find all nodes by tag name and yield
<code><a href="../../Arachnid/Document/HTML/Tag.html">HTML::Tag</a></code> if found</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/document/html.cr#L61" target="_blank">View source</a>]
</div>
</div>
<h2>Macro Detail</h2>
<div class="entry-detail" id="method_missing(call)-macro">
<div class="signature">
macro <strong>method_missing</strong>(call)
<a class="method-permalink" href="#method_missing%28call%29-macro">#</a>
</div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/document/html.cr#L16" target="_blank">View source</a>]
</div>
</div>
</div>
</body>
</html>

500
docs/Arachnid/Document/HTML/Tag.html Normal file
View File

@ -0,0 +1,500 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.29.0">
<link href="../../../css/style.css" rel="stylesheet" type="text/css">
<script type="text/javascript" src="../../../js/doc.js"></script>
<script type="text/javascript">
CrystalDoc.base_path = "../../../";
</script>
<meta id="repository-name" content="github.com/watzon/arachnid">
<title>Arachnid::Document::HTML::Tag - github.com/watzon/arachnid</title>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
<input type="search" class="search-input" placeholder="Search..." spellcheck="false" aria-label="Search">
</div>
<div class="repository-links">
<a href="../../../index.html">README</a>
</div>
</div>
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
<div class="types-list">
<ul>
<li class="parent open current" data-id="github.com/watzon/arachnid/Arachnid" data-name="arachnid">
<a href="../../../Arachnid.html">Arachnid</a>
<ul>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Agent" data-name="arachnid::agent">
<a href="../../../Arachnid/Agent.html">Agent</a>
<ul>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions" data-name="arachnid::agent::actions">
<a href="../../../Arachnid/Agent/Actions.html">Actions</a>
<ul>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/Action" data-name="arachnid::agent::actions::action">
<a href="../../../Arachnid/Agent/Actions/Action.html">Action</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/Paused" data-name="arachnid::agent::actions::paused">
<a href="../../../Arachnid/Agent/Actions/Paused.html">Paused</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/RuntimeError" data-name="arachnid::agent::actions::runtimeerror">
<a href="../../../Arachnid/Agent/Actions/RuntimeError.html">RuntimeError</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/SkipLink" data-name="arachnid::agent::actions::skiplink">
<a href="../../../Arachnid/Agent/Actions/SkipLink.html">SkipLink</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/SkipResource" data-name="arachnid::agent::actions::skipresource">
<a href="../../../Arachnid/Agent/Actions/SkipResource.html">SkipResource</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Queue" data-name="arachnid::agent::queue">
<a href="../../../Arachnid/Agent/Queue.html">Queue</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/AuthCredential" data-name="arachnid::authcredential">
<a href="../../../Arachnid/AuthCredential.html">AuthCredential</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/AuthStore" data-name="arachnid::authstore">
<a href="../../../Arachnid/AuthStore.html">AuthStore</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/CookieJar" data-name="arachnid::cookiejar">
<a href="../../../Arachnid/CookieJar.html">CookieJar</a>
</li>
<li class="parent open current" data-id="github.com/watzon/arachnid/Arachnid/Document" data-name="arachnid::document">
<a href="../../../Arachnid/Document.html">Document</a>
<ul>
<li class="parent open current" data-id="github.com/watzon/arachnid/Arachnid/Document/HTML" data-name="arachnid::document::html">
<a href="../../../Arachnid/Document/HTML.html">HTML</a>
<ul>
<li class=" current" data-id="github.com/watzon/arachnid/Arachnid/Document/HTML/Tag" data-name="arachnid::document::html::tag">
<a href="../../../Arachnid/Document/HTML/Tag.html">Tag</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Resource" data-name="arachnid::resource">
<a href="../../../Arachnid/Resource.html">Resource</a>
<ul>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/ContentTypes" data-name="arachnid::resource::contenttypes">
<a href="../../../Arachnid/Resource/ContentTypes.html">ContentTypes</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/Cookies" data-name="arachnid::resource::cookies">
<a href="../../../Arachnid/Resource/Cookies.html">Cookies</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/HTML" data-name="arachnid::resource::html">
<a href="../../../Arachnid/Resource/HTML.html">HTML</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/StatusCodes" data-name="arachnid::resource::statuscodes">
<a href="../../../Arachnid/Resource/StatusCodes.html">StatusCodes</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Rules" data-name="arachnid::rules(t)">
<a href="../../../Arachnid/Rules.html">Rules</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/SessionCache" data-name="arachnid::sessioncache">
<a href="../../../Arachnid/SessionCache.html">SessionCache</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/URI" data-name="uri">
<a href="../../../URI.html">URI</a>
</li>
</ul>
</div>
</div>
<div class="main-content">
<h1 class="type-name">
<span class="kind">struct</span> Arachnid::Document::HTML::Tag
</h1>
<ul class="superclass-hierarchy"><li class="superclass"><a href="../../../Arachnid/Document/HTML/Tag.html">Arachnid::Document::HTML::Tag</a></li><li class="superclass">Struct</li><li class="superclass">Value</li><li class="superclass">Object</li></ul>
<h2>Overview</h2>
<p>Represents an HTML Tag</p>
<h2>Defined in:</h2>
<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/document/html.cr#L150" target="_blank">
arachnid/document/html.cr
</a>
<br/>
<h2>Constructors</h2>
<ul class="list-summary">
<li class="entry-summary">
<a href="#new%28node%3AXML%3A%3ANode%29-class-method" class="signature"><strong>.new</strong>(node : XML::Node)</a>
</li>
</ul>
<h2>Instance Method Summary</h2>
<ul class="list-summary">
<li class="entry-summary">
<a href="#children%3AArray%28Tag%29-instance-method" class="signature"><strong>#children</strong> : Array(Tag)</a>
</li>
<li class="entry-summary">
<a href="#classname%3AString%3F-instance-method" class="signature"><strong>#classname</strong> : String?</a>
</li>
<li class="entry-summary">
<a href="#content%3AString-instance-method" class="signature"><strong>#content</strong> : String</a>
</li>
<li class="entry-summary">
<a href="#has_class%3F%28klass%3AString%29%3ABool-instance-method" class="signature"><strong>#has_class?</strong>(klass : String) : Bool</a>
</li>
<li class="entry-summary">
<a href="#node%3AXML%3A%3ANode-instance-method" class="signature"><strong>#node</strong> : XML::Node</a>
</li>
<li class="entry-summary">
<a href="#parent%3ATag%3F-instance-method" class="signature"><strong>#parent</strong> : Tag?</a>
</li>
<li class="entry-summary">
<a href="#tagname%3AString-instance-method" class="signature"><strong>#tagname</strong> : String</a>
</li>
</ul>
<h2>Macro Summary</h2>
<ul class="list-summary">
<li class="entry-summary">
<a href="#method_missing%28call%29-macro" class="signature"><strong>method_missing</strong>(call)</a>
</li>
</ul>
<div class="methods-inherited">
</div>
<h2>Constructor Detail</h2>
<div class="entry-detail" id="new(node:XML::Node)-class-method">
<div class="signature">
def self.<strong>new</strong>(node : XML::Node)
<a class="method-permalink" href="#new%28node%3AXML%3A%3ANode%29-class-method">#</a>
</div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/document/html.cr#L155" target="_blank">View source</a>]
</div>
</div>
<h2>Instance Method Detail</h2>
<div class="entry-detail" id="children:Array(Tag)-instance-method">
<div class="signature">
def <strong>children</strong> : Array(<a href="../../../Arachnid/Document/HTML/Tag.html">Tag</a>)
<a class="method-permalink" href="#children%3AArray%28Tag%29-instance-method">#</a>
</div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/document/html.cr#L177" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="classname:String?-instance-method">
<div class="signature">
def <strong>classname</strong> : String?
<a class="method-permalink" href="#classname%3AString%3F-instance-method">#</a>
</div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/document/html.cr#L158" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="content:String-instance-method">
<div class="signature">
def <strong>content</strong> : String
<a class="method-permalink" href="#content%3AString-instance-method">#</a>
</div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/document/html.cr#L166" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="has_class?(klass:String):Bool-instance-method">
<div class="signature">
def <strong>has_class?</strong>(klass : String) : Bool
<a class="method-permalink" href="#has_class%3F%28klass%3AString%29%3ABool-instance-method">#</a>
</div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/document/html.cr#L187" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="node:XML::Node-instance-method">
<div class="signature">
def <strong>node</strong> : XML::Node
<a class="method-permalink" href="#node%3AXML%3A%3ANode-instance-method">#</a>
</div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/document/html.cr#L153" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="parent:Tag?-instance-method">
<div class="signature">
def <strong>parent</strong> : <a href="../../../Arachnid/Document/HTML/Tag.html">Tag</a>?
<a class="method-permalink" href="#parent%3ATag%3F-instance-method">#</a>
</div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/document/html.cr#L170" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="tagname:String-instance-method">
<div class="signature">
def <strong>tagname</strong> : String
<a class="method-permalink" href="#tagname%3AString-instance-method">#</a>
</div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/document/html.cr#L162" target="_blank">View source</a>]
</div>
</div>
<h2>Macro Detail</h2>
<div class="entry-detail" id="method_missing(call)-macro">
<div class="signature">
macro <strong>method_missing</strong>(call)
<a class="method-permalink" href="#method_missing%28call%29-macro">#</a>
</div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/document/html.cr#L153" target="_blank">View source</a>]
</div>
</div>
</div>
</body>
</html>

1522
docs/Arachnid/Resource.html Normal file
View File

File diff suppressed because it is too large Load Diff

952
docs/Arachnid/Resource/ContentTypes.html Normal file
View File

@ -0,0 +1,952 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.29.0">
<link href="../../css/style.css" rel="stylesheet" type="text/css">
<script type="text/javascript" src="../../js/doc.js"></script>
<script type="text/javascript">
CrystalDoc.base_path = "../../";
</script>
<meta id="repository-name" content="github.com/watzon/arachnid">
<title>Arachnid::Resource::ContentTypes - github.com/watzon/arachnid</title>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
<input type="search" class="search-input" placeholder="Search..." spellcheck="false" aria-label="Search">
</div>
<div class="repository-links">
<a href="../../index.html">README</a>
</div>
</div>
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
<div class="types-list">
<ul>
<li class="parent open current" data-id="github.com/watzon/arachnid/Arachnid" data-name="arachnid">
<a href="../../Arachnid.html">Arachnid</a>
<ul>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Agent" data-name="arachnid::agent">
<a href="../../Arachnid/Agent.html">Agent</a>
<ul>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions" data-name="arachnid::agent::actions">
<a href="../../Arachnid/Agent/Actions.html">Actions</a>
<ul>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/Action" data-name="arachnid::agent::actions::action">
<a href="../../Arachnid/Agent/Actions/Action.html">Action</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/Paused" data-name="arachnid::agent::actions::paused">
<a href="../../Arachnid/Agent/Actions/Paused.html">Paused</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/RuntimeError" data-name="arachnid::agent::actions::runtimeerror">
<a href="../../Arachnid/Agent/Actions/RuntimeError.html">RuntimeError</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/SkipLink" data-name="arachnid::agent::actions::skiplink">
<a href="../../Arachnid/Agent/Actions/SkipLink.html">SkipLink</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/SkipResource" data-name="arachnid::agent::actions::skipresource">
<a href="../../Arachnid/Agent/Actions/SkipResource.html">SkipResource</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Queue" data-name="arachnid::agent::queue">
<a href="../../Arachnid/Agent/Queue.html">Queue</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/AuthCredential" data-name="arachnid::authcredential">
<a href="../../Arachnid/AuthCredential.html">AuthCredential</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/AuthStore" data-name="arachnid::authstore">
<a href="../../Arachnid/AuthStore.html">AuthStore</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/CookieJar" data-name="arachnid::cookiejar">
<a href="../../Arachnid/CookieJar.html">CookieJar</a>
</li>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Document" data-name="arachnid::document">
<a href="../../Arachnid/Document.html">Document</a>
<ul>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Document/HTML" data-name="arachnid::document::html">
<a href="../../Arachnid/Document/HTML.html">HTML</a>
<ul>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Document/HTML/Tag" data-name="arachnid::document::html::tag">
<a href="../../Arachnid/Document/HTML/Tag.html">Tag</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="parent open current" data-id="github.com/watzon/arachnid/Arachnid/Resource" data-name="arachnid::resource">
<a href="../../Arachnid/Resource.html">Resource</a>
<ul>
<li class=" current" data-id="github.com/watzon/arachnid/Arachnid/Resource/ContentTypes" data-name="arachnid::resource::contenttypes">
<a href="../../Arachnid/Resource/ContentTypes.html">ContentTypes</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/Cookies" data-name="arachnid::resource::cookies">
<a href="../../Arachnid/Resource/Cookies.html">Cookies</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/HTML" data-name="arachnid::resource::html">
<a href="../../Arachnid/Resource/HTML.html">HTML</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/StatusCodes" data-name="arachnid::resource::statuscodes">
<a href="../../Arachnid/Resource/StatusCodes.html">StatusCodes</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Rules" data-name="arachnid::rules(t)">
<a href="../../Arachnid/Rules.html">Rules</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/SessionCache" data-name="arachnid::sessioncache">
<a href="../../Arachnid/SessionCache.html">SessionCache</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/URI" data-name="uri">
<a href="../../URI.html">URI</a>
</li>
</ul>
</div>
</div>
<div class="main-content">
<h1 class="type-name">
<span class="kind">module</span> Arachnid::Resource::ContentTypes
</h1>
<h2>Direct including types</h2>
<ul class="other-types-list">
<li class="other-type"><a href="../../Arachnid/Resource.html">Arachnid::Resource</a></li>
</ul>
<h2>Defined in:</h2>
<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/resource/content_types.cr#L3" target="_blank">
arachnid/resource/content_types.cr
</a>
<br/>
<h2>Instance Method Summary</h2>
<ul class="list-summary">
<li class="entry-summary">
<a href="#atom%3F-instance-method" class="signature"><strong>#atom?</strong></a>
<div class="summary"><p>Determines if the resource is an Atom feed.</p></div>
</li>
<li class="entry-summary">
<a href="#avi%3F-instance-method" class="signature"><strong>#avi?</strong></a>
</li>
<li class="entry-summary">
<a href="#content_charset-instance-method" class="signature"><strong>#content_charset</strong></a>
<div class="summary"><p>The charset included in the Content-Type.</p></div>
</li>
<li class="entry-summary">
<a href="#content_type-instance-method" class="signature"><strong>#content_type</strong></a>
<div class="summary"><p>The Content-Type of the resource.</p></div>
</li>
<li class="entry-summary">
<a href="#content_types-instance-method" class="signature"><strong>#content_types</strong></a>
<div class="summary"><p>The content types of the resource.</p></div>
</li>
<li class="entry-summary">
<a href="#css%3F-instance-method" class="signature"><strong>#css?</strong></a>
<div class="summary"><p>Determines if the resource is a CSS stylesheet.</p></div>
</li>
<li class="entry-summary">
<a href="#directory%3F-instance-method" class="signature"><strong>#directory?</strong></a>
<div class="summary"><p>Determines if the resource is a Directory Listing.</p></div>
</li>
<li class="entry-summary">
<a href="#flash%3F-instance-method" class="signature"><strong>#flash?</strong></a>
</li>
<li class="entry-summary">
<a href="#gif%3F-instance-method" class="signature"><strong>#gif?</strong></a>
</li>
<li class="entry-summary">
<a href="#html%3F-instance-method" class="signature"><strong>#html?</strong></a>
<div class="summary"><p>Determines if the resource is HTML document.</p></div>
</li>
<li class="entry-summary">
<a href="#image%3F-instance-method" class="signature"><strong>#image?</strong></a>
<div class="summary"><p>Determine if the resource is an image.</p></div>
</li>
<li class="entry-summary">
<a href="#is_content_type%3F%28type%3AString%7CRegex%29-instance-method" class="signature"><strong>#is_content_type?</strong>(type : String | Regex)</a>
<div class="summary"><p>Determines if any of the content-types of the resource include a given type.</p></div>
</li>
<li class="entry-summary">
<a href="#javascript%3F-instance-method" class="signature"><strong>#javascript?</strong></a>
<div class="summary"><p>Determines if the resource is JavaScript.</p></div>
</li>
<li class="entry-summary">
<a href="#jpg%3F-instance-method" class="signature"><strong>#jpg?</strong></a>
</li>
<li class="entry-summary">
<a href="#json%3F-instance-method" class="signature"><strong>#json?</strong></a>
<div class="summary"><p>Determines if the resource is JSON.</p></div>
</li>
<li class="entry-summary">
<a href="#mp4%3F-instance-method" class="signature"><strong>#mp4?</strong></a>
</li>
<li class="entry-summary">
<a href="#ms_word%3F-instance-method" class="signature"><strong>#ms_word?</strong></a>
<div class="summary"><p>Determines if the resource is a MS Word document.</p></div>
</li>
<li class="entry-summary">
<a href="#pdf%3F-instance-method" class="signature"><strong>#pdf?</strong></a>
<div class="summary"><p>Determines if the resource is a PDF document.</p></div>
</li>
<li class="entry-summary">
<a href="#plain_text%3F-instance-method" class="signature"><strong>#plain_text?</strong></a>
<div class="summary"><p>Determines if the resource is plain-text.</p></div>
</li>
<li class="entry-summary">
<a href="#png%3F-instance-method" class="signature"><strong>#png?</strong></a>
</li>
<li class="entry-summary">
<a href="#quicktime%3F-instance-method" class="signature"><strong>#quicktime?</strong></a>
</li>
<li class="entry-summary">
<a href="#rss%3F-instance-method" class="signature"><strong>#rss?</strong></a>
<div class="summary"><p>Determines if the resource is a RSS feed.</p></div>
</li>
<li class="entry-summary">
<a href="#svg%3F-instance-method" class="signature"><strong>#svg?</strong></a>
</li>
<li class="entry-summary">
<a href="#text%3F-instance-method" class="signature"><strong>#text?</strong></a>
<div class="summary"><p>Determines if the resource is plain-text.</p></div>
</li>
<li class="entry-summary">
<a href="#video%3F-instance-method" class="signature"><strong>#video?</strong></a>
</li>
<li class="entry-summary">
<a href="#wmv%3F-instance-method" class="signature"><strong>#wmv?</strong></a>
</li>
<li class="entry-summary">
<a href="#xml%3F-instance-method" class="signature"><strong>#xml?</strong></a>
<div class="summary"><p>Determines if the resource is XML document.</p></div>
</li>
<li class="entry-summary">
<a href="#xsl%3F-instance-method" class="signature"><strong>#xsl?</strong></a>
<div class="summary"><p>Determines if the resource is XML Stylesheet (XSL).</p></div>
</li>
<li class="entry-summary">
<a href="#zip%3F-instance-method" class="signature"><strong>#zip?</strong></a>
<div class="summary"><p>Determines if the resource is a ZIP archive.</p></div>
</li>
</ul>
<div class="methods-inherited">
</div>
<h2>Instance Method Detail</h2>
<div class="entry-detail" id="atom?-instance-method">
<div class="signature">
def <strong>atom?</strong>
<a class="method-permalink" href="#atom%3F-instance-method">#</a>
</div>
<div class="doc"><p>Determines if the resource is an Atom feed.</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/resource/content_types.cr#L96" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="avi?-instance-method">
<div class="signature">
def <strong>avi?</strong>
<a class="method-permalink" href="#avi%3F-instance-method">#</a>
</div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/resource/content_types.cr#L144" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="content_charset-instance-method">
<div class="signature">
def <strong>content_charset</strong>
<a class="method-permalink" href="#content_charset-instance-method">#</a>
</div>
<div class="doc"><p>The charset included in the Content-Type.</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/resource/content_types.cr#L15" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="content_type-instance-method">
<div class="signature">
def <strong>content_type</strong>
<a class="method-permalink" href="#content_type-instance-method">#</a>
</div>
<div class="doc"><p>The Content-Type of the resource.</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/resource/content_types.cr#L5" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="content_types-instance-method">
<div class="signature">
def <strong>content_types</strong>
<a class="method-permalink" href="#content_types-instance-method">#</a>
</div>
<div class="doc"><p>The content types of the resource.</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/resource/content_types.cr#L10" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="css?-instance-method">
<div class="signature">
def <strong>css?</strong>
<a class="method-permalink" href="#css%3F-instance-method">#</a>
</div>
<div class="doc"><p>Determines if the resource is a CSS stylesheet.</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/resource/content_types.cr#L86" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="directory?-instance-method">
<div class="signature">
def <strong>directory?</strong>
<a class="method-permalink" href="#directory%3F-instance-method">#</a>
</div>
<div class="doc"><p>Determines if the resource is a Directory Listing.</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/resource/content_types.cr#L56" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="flash?-instance-method">
<div class="signature">
def <strong>flash?</strong>
<a class="method-permalink" href="#flash%3F-instance-method">#</a>
</div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/resource/content_types.cr#L156" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="gif?-instance-method">
<div class="signature">
def <strong>gif?</strong>
<a class="method-permalink" href="#gif%3F-instance-method">#</a>
</div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/resource/content_types.cr#L124" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="html?-instance-method">
<div class="signature">
def <strong>html?</strong>
<a class="method-permalink" href="#html%3F-instance-method">#</a>
</div>
<div class="doc"><p>Determines if the resource is HTML document.</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/resource/content_types.cr#L61" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="image?-instance-method">
<div class="signature">
def <strong>image?</strong>
<a class="method-permalink" href="#image%3F-instance-method">#</a>
</div>
<div class="doc"><p>Determine if the resource is an image.</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/resource/content_types.cr#L116" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="is_content_type?(type:String|Regex)-instance-method">
<div class="signature">
def <strong>is_content_type?</strong>(type : String | Regex)
<a class="method-permalink" href="#is_content_type%3F%28type%3AString%7CRegex%29-instance-method">#</a>
</div>
<div class="doc"><p>Determines if any of the content-types of the resource include a given
type.</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/resource/content_types.cr#L33" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="javascript?-instance-method">
<div class="signature">
def <strong>javascript?</strong>
<a class="method-permalink" href="#javascript%3F-instance-method">#</a>
</div>
<div class="doc"><p>Determines if the resource is JavaScript.</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/resource/content_types.cr#L76" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="jpg?-instance-method">
<div class="signature">
def <strong>jpg?</strong>
<a class="method-permalink" href="#jpg%3F-instance-method">#</a>
</div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/resource/content_types.cr#L128" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="json?-instance-method">
<div class="signature">
def <strong>json?</strong>
<a class="method-permalink" href="#json%3F-instance-method">#</a>
</div>
<div class="doc"><p>Determines if the resource is JSON.</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/resource/content_types.cr#L81" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="mp4?-instance-method">
<div class="signature">
def <strong>mp4?</strong>
<a class="method-permalink" href="#mp4%3F-instance-method">#</a>
</div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/resource/content_types.cr#L140" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="ms_word?-instance-method">
<div class="signature">
def <strong>ms_word?</strong>
<a class="method-permalink" href="#ms_word%3F-instance-method">#</a>
</div>
<div class="doc"><p>Determines if the resource is a MS Word document.</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/resource/content_types.cr#L101" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="pdf?-instance-method">
<div class="signature">
def <strong>pdf?</strong>
<a class="method-permalink" href="#pdf%3F-instance-method">#</a>
</div>
<div class="doc"><p>Determines if the resource is a PDF document.</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/resource/content_types.cr#L106" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="plain_text?-instance-method">
<div class="signature">
def <strong>plain_text?</strong>
<a class="method-permalink" href="#plain_text%3F-instance-method">#</a>
</div>
<div class="doc"><p>Determines if the resource is plain-text.</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/resource/content_types.cr#L46" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="png?-instance-method">
<div class="signature">
def <strong>png?</strong>
<a class="method-permalink" href="#png%3F-instance-method">#</a>
</div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/resource/content_types.cr#L120" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="quicktime?-instance-method">
<div class="signature">
def <strong>quicktime?</strong>
<a class="method-permalink" href="#quicktime%3F-instance-method">#</a>
</div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/resource/content_types.cr#L152" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="rss?-instance-method">
<div class="signature">
def <strong>rss?</strong>
<a class="method-permalink" href="#rss%3F-instance-method">#</a>
</div>
<div class="doc"><p>Determines if the resource is a RSS feed.</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/resource/content_types.cr#L91" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="svg?-instance-method">
<div class="signature">
def <strong>svg?</strong>
<a class="method-permalink" href="#svg%3F-instance-method">#</a>
</div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/resource/content_types.cr#L132" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="text?-instance-method">
<div class="signature">
def <strong>text?</strong>
<a class="method-permalink" href="#text%3F-instance-method">#</a>
</div>
<div class="doc"><p>Determines if the resource is plain-text.</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/resource/content_types.cr#L51" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="video?-instance-method">
<div class="signature">
def <strong>video?</strong>
<a class="method-permalink" href="#video%3F-instance-method">#</a>
</div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/resource/content_types.cr#L136" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="wmv?-instance-method">
<div class="signature">
def <strong>wmv?</strong>
<a class="method-permalink" href="#wmv%3F-instance-method">#</a>
</div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/resource/content_types.cr#L148" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="xml?-instance-method">
<div class="signature">
def <strong>xml?</strong>
<a class="method-permalink" href="#xml%3F-instance-method">#</a>
</div>
<div class="doc"><p>Determines if the resource is XML document.</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/resource/content_types.cr#L66" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="xsl?-instance-method">
<div class="signature">
def <strong>xsl?</strong>
<a class="method-permalink" href="#xsl%3F-instance-method">#</a>
</div>
<div class="doc"><p>Determines if the resource is XML Stylesheet (XSL).</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/resource/content_types.cr#L71" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="zip?-instance-method">
<div class="signature">
def <strong>zip?</strong>
<a class="method-permalink" href="#zip%3F-instance-method">#</a>
</div>
<div class="doc"><p>Determines if the resource is a ZIP archive.</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/resource/content_types.cr#L111" target="_blank">View source</a>]
</div>
</div>
</div>
</body>
</html>

332
docs/Arachnid/Resource/Cookies.html Normal file
View File

@ -0,0 +1,332 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.29.0">
<link href="../../css/style.css" rel="stylesheet" type="text/css">
<script type="text/javascript" src="../../js/doc.js"></script>
<script type="text/javascript">
CrystalDoc.base_path = "../../";
</script>
<meta id="repository-name" content="github.com/watzon/arachnid">
<title>Arachnid::Resource::Cookies - github.com/watzon/arachnid</title>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
<input type="search" class="search-input" placeholder="Search..." spellcheck="false" aria-label="Search">
</div>
<div class="repository-links">
<a href="../../index.html">README</a>
</div>
</div>
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
<div class="types-list">
<ul>
<li class="parent open current" data-id="github.com/watzon/arachnid/Arachnid" data-name="arachnid">
<a href="../../Arachnid.html">Arachnid</a>
<ul>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Agent" data-name="arachnid::agent">
<a href="../../Arachnid/Agent.html">Agent</a>
<ul>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions" data-name="arachnid::agent::actions">
<a href="../../Arachnid/Agent/Actions.html">Actions</a>
<ul>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/Action" data-name="arachnid::agent::actions::action">
<a href="../../Arachnid/Agent/Actions/Action.html">Action</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/Paused" data-name="arachnid::agent::actions::paused">
<a href="../../Arachnid/Agent/Actions/Paused.html">Paused</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/RuntimeError" data-name="arachnid::agent::actions::runtimeerror">
<a href="../../Arachnid/Agent/Actions/RuntimeError.html">RuntimeError</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/SkipLink" data-name="arachnid::agent::actions::skiplink">
<a href="../../Arachnid/Agent/Actions/SkipLink.html">SkipLink</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/SkipResource" data-name="arachnid::agent::actions::skipresource">
<a href="../../Arachnid/Agent/Actions/SkipResource.html">SkipResource</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Queue" data-name="arachnid::agent::queue">
<a href="../../Arachnid/Agent/Queue.html">Queue</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/AuthCredential" data-name="arachnid::authcredential">
<a href="../../Arachnid/AuthCredential.html">AuthCredential</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/AuthStore" data-name="arachnid::authstore">
<a href="../../Arachnid/AuthStore.html">AuthStore</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/CookieJar" data-name="arachnid::cookiejar">
<a href="../../Arachnid/CookieJar.html">CookieJar</a>
</li>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Document" data-name="arachnid::document">
<a href="../../Arachnid/Document.html">Document</a>
<ul>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Document/HTML" data-name="arachnid::document::html">
<a href="../../Arachnid/Document/HTML.html">HTML</a>
<ul>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Document/HTML/Tag" data-name="arachnid::document::html::tag">
<a href="../../Arachnid/Document/HTML/Tag.html">Tag</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="parent open current" data-id="github.com/watzon/arachnid/Arachnid/Resource" data-name="arachnid::resource">
<a href="../../Arachnid/Resource.html">Resource</a>
<ul>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/ContentTypes" data-name="arachnid::resource::contenttypes">
<a href="../../Arachnid/Resource/ContentTypes.html">ContentTypes</a>
</li>
<li class=" current" data-id="github.com/watzon/arachnid/Arachnid/Resource/Cookies" data-name="arachnid::resource::cookies">
<a href="../../Arachnid/Resource/Cookies.html">Cookies</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/HTML" data-name="arachnid::resource::html">
<a href="../../Arachnid/Resource/HTML.html">HTML</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/StatusCodes" data-name="arachnid::resource::statuscodes">
<a href="../../Arachnid/Resource/StatusCodes.html">StatusCodes</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Rules" data-name="arachnid::rules(t)">
<a href="../../Arachnid/Rules.html">Rules</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/SessionCache" data-name="arachnid::sessioncache">
<a href="../../Arachnid/SessionCache.html">SessionCache</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/URI" data-name="uri">
<a href="../../URI.html">URI</a>
</li>
</ul>
</div>
</div>
<div class="main-content">
<h1 class="type-name">
<span class="kind">module</span> Arachnid::Resource::Cookies
</h1>
<h2>Direct including types</h2>
<ul class="other-types-list">
<li class="other-type"><a href="../../Arachnid/Resource.html">Arachnid::Resource</a></li>
</ul>
<h2>Defined in:</h2>
<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/resource/cookies.cr#L3" target="_blank">
arachnid/resource/cookies.cr
</a>
<br/>
<h2>Constant Summary</h2>
<dl>
<dt class="entry-const" id="RESERVED_COOKIE_NAMES">
<strong>RESERVED_COOKIE_NAMES</strong> = <code><span class="t">Regex</span>.<span class="k">new</span>(<span class="s">&quot;^(?:Path|Expires|Domain|Secure|HTTPOnly)$&quot;</span>, <span class="n">:ignore_case</span>)</code>
</dt>
<dd class="entry-const-doc">
<p>Reserved names used within Cookie strings</p>
</dd>
</dl>
<h2>Instance Method Summary</h2>
<ul class="list-summary">
<li class="entry-summary">
<a href="#cookie-instance-method" class="signature"><strong>#cookie</strong></a>
<div class="summary"><p>The raw Cookie String sent along with the resource.</p></div>
</li>
<li class="entry-summary">
<a href="#cookies-instance-method" class="signature"><strong>#cookies</strong></a>
<div class="summary"><p>The Cookie values sent along with the resource.</p></div>
</li>
</ul>
<div class="methods-inherited">
</div>
<h2>Instance Method Detail</h2>
<div class="entry-detail" id="cookie-instance-method">
<div class="signature">
def <strong>cookie</strong>
<a class="method-permalink" href="#cookie-instance-method">#</a>
</div>
<div class="doc"><p>The raw Cookie String sent along with the resource.</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/resource/cookies.cr#L8" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="cookies-instance-method">
<div class="signature">
def <strong>cookies</strong>
<a class="method-permalink" href="#cookies-instance-method">#</a>
</div>
<div class="doc"><p>The Cookie values sent along with the resource.</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/resource/cookies.cr#L13" target="_blank">View source</a>]
</div>
</div>
</div>
</body>
</html>

705
docs/Arachnid/Resource/HTML.html Normal file
View File

@ -0,0 +1,705 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.29.0">
<link href="../../css/style.css" rel="stylesheet" type="text/css">
<script type="text/javascript" src="../../js/doc.js"></script>
<script type="text/javascript">
CrystalDoc.base_path = "../../";
</script>
<meta id="repository-name" content="github.com/watzon/arachnid">
<title>Arachnid::Resource::HTML - github.com/watzon/arachnid</title>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
<input type="search" class="search-input" placeholder="Search..." spellcheck="false" aria-label="Search">
</div>
<div class="repository-links">
<a href="../../index.html">README</a>
</div>
</div>
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
<div class="types-list">
<ul>
<li class="parent open current" data-id="github.com/watzon/arachnid/Arachnid" data-name="arachnid">
<a href="../../Arachnid.html">Arachnid</a>
<ul>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Agent" data-name="arachnid::agent">
<a href="../../Arachnid/Agent.html">Agent</a>
<ul>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions" data-name="arachnid::agent::actions">
<a href="../../Arachnid/Agent/Actions.html">Actions</a>
<ul>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/Action" data-name="arachnid::agent::actions::action">
<a href="../../Arachnid/Agent/Actions/Action.html">Action</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/Paused" data-name="arachnid::agent::actions::paused">
<a href="../../Arachnid/Agent/Actions/Paused.html">Paused</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/RuntimeError" data-name="arachnid::agent::actions::runtimeerror">
<a href="../../Arachnid/Agent/Actions/RuntimeError.html">RuntimeError</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/SkipLink" data-name="arachnid::agent::actions::skiplink">
<a href="../../Arachnid/Agent/Actions/SkipLink.html">SkipLink</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/SkipResource" data-name="arachnid::agent::actions::skipresource">
<a href="../../Arachnid/Agent/Actions/SkipResource.html">SkipResource</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Queue" data-name="arachnid::agent::queue">
<a href="../../Arachnid/Agent/Queue.html">Queue</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/AuthCredential" data-name="arachnid::authcredential">
<a href="../../Arachnid/AuthCredential.html">AuthCredential</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/AuthStore" data-name="arachnid::authstore">
<a href="../../Arachnid/AuthStore.html">AuthStore</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/CookieJar" data-name="arachnid::cookiejar">
<a href="../../Arachnid/CookieJar.html">CookieJar</a>
</li>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Document" data-name="arachnid::document">
<a href="../../Arachnid/Document.html">Document</a>
<ul>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Document/HTML" data-name="arachnid::document::html">
<a href="../../Arachnid/Document/HTML.html">HTML</a>
<ul>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Document/HTML/Tag" data-name="arachnid::document::html::tag">
<a href="../../Arachnid/Document/HTML/Tag.html">Tag</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="parent open current" data-id="github.com/watzon/arachnid/Arachnid/Resource" data-name="arachnid::resource">
<a href="../../Arachnid/Resource.html">Resource</a>
<ul>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/ContentTypes" data-name="arachnid::resource::contenttypes">
<a href="../../Arachnid/Resource/ContentTypes.html">ContentTypes</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/Cookies" data-name="arachnid::resource::cookies">
<a href="../../Arachnid/Resource/Cookies.html">Cookies</a>
</li>
<li class=" current" data-id="github.com/watzon/arachnid/Arachnid/Resource/HTML" data-name="arachnid::resource::html">
<a href="../../Arachnid/Resource/HTML.html">HTML</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/StatusCodes" data-name="arachnid::resource::statuscodes">
<a href="../../Arachnid/Resource/StatusCodes.html">StatusCodes</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Rules" data-name="arachnid::rules(t)">
<a href="../../Arachnid/Rules.html">Rules</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/SessionCache" data-name="arachnid::sessioncache">
<a href="../../Arachnid/SessionCache.html">SessionCache</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/URI" data-name="uri">
<a href="../../URI.html">URI</a>
</li>
</ul>
</div>
</div>
<div class="main-content">
<h1 class="type-name">
<span class="kind">module</span> Arachnid::Resource::HTML
</h1>
<h2>Overview</h2>
<p><span class="flag orange">TODO</span> Create enumerable methods for the methods that take a block</p>
<h2>Direct including types</h2>
<ul class="other-types-list">
<li class="other-type"><a href="../../Arachnid/Resource.html">Arachnid::Resource</a></li>
</ul>
<h2>Defined in:</h2>
<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/resource/html.cr#L6" target="_blank">
arachnid/resource/html.cr
</a>
<br/>
<h2>Instance Method Summary</h2>
<ul class="list-summary">
<li class="entry-summary">
<a href="#each%28%26block%29-instance-method" class="signature"><strong>#each</strong>(&block)</a>
<div class="summary"><p>Enumerates over every URL in the resource.</p></div>
</li>
<li class="entry-summary">
<a href="#each_image%28%26block%3AURI-%3E%29-instance-method" class="signature"><strong>#each_image</strong>(&block : URI -> )</a>
</li>
<li class="entry-summary">
<a href="#each_link%28%26block%3AURI-%3E%29-instance-method" class="signature"><strong>#each_link</strong>(&block : URI -> )</a>
<div class="summary"><p>Enumerates over every link in the resource.</p></div>
</li>
<li class="entry-summary">
<a href="#each_mailto%28%26block%29-instance-method" class="signature"><strong>#each_mailto</strong>(&block)</a>
<div class="summary"><p>Enumerates over every <code>mailto:</code> link in the resource.</p></div>
</li>
<li class="entry-summary">
<a href="#each_meta_redirect%28%26block%3AURI-%3E%29-instance-method" class="signature"><strong>#each_meta_redirect</strong>(&block : URI -> )</a>
<div class="summary"><p>Enumerates over the meta-redirect links in the resource.</p></div>
</li>
<li class="entry-summary">
<a href="#each_redirect%28%26block%3AURI-%3E%29-instance-method" class="signature"><strong>#each_redirect</strong>(&block : URI -> )</a>
<div class="summary"><p>Enumerates over every HTTP or meta-redirect link in the resource.</p></div>
</li>
<li class="entry-summary">
<a href="#each_resource%28%26block%3AURI-%3E%29-instance-method" class="signature"><strong>#each_resource</strong>(&block : URI -> )</a>
</li>
<li class="entry-summary">
<a href="#each_script%28%26block%3AURI-%3E%29-instance-method" class="signature"><strong>#each_script</strong>(&block : URI -> )</a>
</li>
<li class="entry-summary">
<a href="#each_url%28%26block%3AURI-%3E%29-instance-method" class="signature"><strong>#each_url</strong>(&block : URI -> )</a>
<div class="summary"><p>Enumerates over every URL in the resource.</p></div>
</li>
<li class="entry-summary">
<a href="#each_video%28%26block%3AURI-%3E%29-instance-method" class="signature"><strong>#each_video</strong>(&block : URI -> )</a>
</li>
<li class="entry-summary">
<a href="#links-instance-method" class="signature"><strong>#links</strong></a>
<div class="summary"><p>The links from within the resource.</p></div>
</li>
<li class="entry-summary">
<a href="#mailtos-instance-method" class="signature"><strong>#mailtos</strong></a>
<div class="summary"><p><code>mailto:</code> links in the resource.</p></div>
</li>
<li class="entry-summary">
<a href="#meta_redirect%3F-instance-method" class="signature"><strong>#meta_redirect?</strong></a>
<div class="summary"><p>Returns a boolean indicating whether or not resource-level meta redirects are present in this resource.</p></div>
</li>
<li class="entry-summary">
<a href="#meta_redirects-instance-method" class="signature"><strong>#meta_redirects</strong></a>
<div class="summary"><p>The meta-redirect links of the resource.</p></div>
</li>
<li class="entry-summary">
<a href="#redirects_to-instance-method" class="signature"><strong>#redirects_to</strong></a>
<div class="summary"><p>URLs that this document redirects to.</p></div>
</li>
<li class="entry-summary">
<a href="#title-instance-method" class="signature"><strong>#title</strong></a>
<div class="summary"><p>The title of the HTML resource.</p></div>
</li>
<li class="entry-summary">
<a href="#to_absolute%28link%29-instance-method" class="signature"><strong>#to_absolute</strong>(link)</a>
<div class="summary"><p>Normalizes and expands a given link into a proper URI.</p></div>
</li>
<li class="entry-summary">
<a href="#urls-instance-method" class="signature"><strong>#urls</strong></a>
<div class="summary"><p>Absolute URIs from within the resource.</p></div>
</li>
</ul>
<div class="methods-inherited">
</div>
<h2>Instance Method Detail</h2>
<div class="entry-detail" id="each(&amp;block)-instance-method">
<div class="signature">
def <strong>each</strong>(&block)
<a class="method-permalink" href="#each%28%26block%29-instance-method">#</a>
</div>
<div class="doc"><p>Enumerates over every URL in the resource.</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/resource/html.cr#L167" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="each_image(&amp;block:URI-&gt;)-instance-method">
<div class="signature">
def <strong>each_image</strong>(&block : <a href="../../URI.html">URI</a> -> )
<a class="method-permalink" href="#each_image%28%26block%3AURI-%3E%29-instance-method">#</a>
</div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/resource/html.cr#L119" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="each_link(&amp;block:URI-&gt;)-instance-method">
<div class="signature">
def <strong>each_link</strong>(&block : <a href="../../URI.html">URI</a> -> )
<a class="method-permalink" href="#each_link%28%26block%3AURI-%3E%29-instance-method">#</a>
</div>
<div class="doc"><p>Enumerates over every link in the resource.</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/resource/html.cr#L75" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="each_mailto(&amp;block)-instance-method">
<div class="signature">
def <strong>each_mailto</strong>(&block)
<a class="method-permalink" href="#each_mailto%28%26block%29-instance-method">#</a>
</div>
<div class="doc"><p>Enumerates over every <code>mailto:</code> link in the resource.</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/resource/html.cr#L61" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="each_meta_redirect(&amp;block:URI-&gt;)-instance-method">
<div class="signature">
def <strong>each_meta_redirect</strong>(&block : <a href="../../URI.html">URI</a> -> )
<a class="method-permalink" href="#each_meta_redirect%28%26block%3AURI-%3E%29-instance-method">#</a>
</div>
<div class="doc"><p>Enumerates over the meta-redirect links in the resource.</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/resource/html.cr#L17" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="each_redirect(&amp;block:URI-&gt;)-instance-method">
<div class="signature">
def <strong>each_redirect</strong>(&block : <a href="../../URI.html">URI</a> -> )
<a class="method-permalink" href="#each_redirect%28%26block%3AURI-%3E%29-instance-method">#</a>
</div>
<div class="doc"><p>Enumerates over every HTTP or meta-redirect link in the resource.</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/resource/html.cr#L45" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="each_resource(&amp;block:URI-&gt;)-instance-method">
<div class="signature">
def <strong>each_resource</strong>(&block : <a href="../../URI.html">URI</a> -> )
<a class="method-permalink" href="#each_resource%28%26block%3AURI-%3E%29-instance-method">#</a>
</div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/resource/html.cr#L111" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="each_script(&amp;block:URI-&gt;)-instance-method">
<div class="signature">
def <strong>each_script</strong>(&block : <a href="../../URI.html">URI</a> -> )
<a class="method-permalink" href="#each_script%28%26block%3AURI-%3E%29-instance-method">#</a>
</div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/resource/html.cr#L102" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="each_url(&amp;block:URI-&gt;)-instance-method">
<div class="signature">
def <strong>each_url</strong>(&block : <a href="../../URI.html">URI</a> -> )
<a class="method-permalink" href="#each_url%28%26block%3AURI-%3E%29-instance-method">#</a>
</div>
<div class="doc"><p>Enumerates over every URL in the resource.</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/resource/html.cr#L158" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="each_video(&amp;block:URI-&gt;)-instance-method">
<div class="signature">
def <strong>each_video</strong>(&block : <a href="../../URI.html">URI</a> -> )
<a class="method-permalink" href="#each_video%28%26block%3AURI-%3E%29-instance-method">#</a>
</div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/resource/html.cr#L136" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="links-instance-method">
<div class="signature">
def <strong>links</strong>
<a class="method-permalink" href="#links-instance-method">#</a>
</div>
<div class="doc"><p>The links from within the resource.</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/resource/html.cr#L151" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="mailtos-instance-method">
<div class="signature">
def <strong>mailtos</strong>
<a class="method-permalink" href="#mailtos-instance-method">#</a>
</div>
<div class="doc"><p><code>mailto:</code> links in the resource.</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/resource/html.cr#L70" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="meta_redirect?-instance-method">
<div class="signature">
def <strong>meta_redirect?</strong>
<a class="method-permalink" href="#meta_redirect%3F-instance-method">#</a>
</div>
<div class="doc"><p>Returns a boolean indicating whether or not resource-level meta
redirects are present in this resource.</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/resource/html.cr#L33" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="meta_redirects-instance-method">
<div class="signature">
def <strong>meta_redirects</strong>
<a class="method-permalink" href="#meta_redirects-instance-method">#</a>
</div>
<div class="doc"><p>The meta-redirect links of the resource.</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/resource/html.cr#L38" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="redirects_to-instance-method">
<div class="signature">
def <strong>redirects_to</strong>
<a class="method-permalink" href="#redirects_to-instance-method">#</a>
</div>
<div class="doc"><p>URLs that this document redirects to.</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/resource/html.cr#L56" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="title-instance-method">
<div class="signature">
def <strong>title</strong>
<a class="method-permalink" href="#title-instance-method">#</a>
</div>
<div class="doc"><p>The title of the HTML resource.</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/resource/html.cr#L10" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="to_absolute(link)-instance-method">
<div class="signature">
def <strong>to_absolute</strong>(link)
<a class="method-permalink" href="#to_absolute%28link%29-instance-method">#</a>
</div>
<div class="doc"><p>Normalizes and expands a given link into a proper URI.</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/resource/html.cr#L179" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="urls-instance-method">
<div class="signature">
def <strong>urls</strong>
<a class="method-permalink" href="#urls-instance-method">#</a>
</div>
<div class="doc"><p>Absolute URIs from within the resource.</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/resource/html.cr#L172" target="_blank">View source</a>]
</div>
</div>
</div>
</body>
</html>

493
docs/Arachnid/Resource/StatusCodes.html Normal file
View File

@ -0,0 +1,493 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.29.0">
<link href="../../css/style.css" rel="stylesheet" type="text/css">
<script type="text/javascript" src="../../js/doc.js"></script>
<script type="text/javascript">
CrystalDoc.base_path = "../../";
</script>
<meta id="repository-name" content="github.com/watzon/arachnid">
<title>Arachnid::Resource::StatusCodes - github.com/watzon/arachnid</title>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
<input type="search" class="search-input" placeholder="Search..." spellcheck="false" aria-label="Search">
</div>
<div class="repository-links">
<a href="../../index.html">README</a>
</div>
</div>
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
<div class="types-list">
<ul>
<li class="parent open current" data-id="github.com/watzon/arachnid/Arachnid" data-name="arachnid">
<a href="../../Arachnid.html">Arachnid</a>
<ul>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Agent" data-name="arachnid::agent">
<a href="../../Arachnid/Agent.html">Agent</a>
<ul>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions" data-name="arachnid::agent::actions">
<a href="../../Arachnid/Agent/Actions.html">Actions</a>
<ul>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/Action" data-name="arachnid::agent::actions::action">
<a href="../../Arachnid/Agent/Actions/Action.html">Action</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/Paused" data-name="arachnid::agent::actions::paused">
<a href="../../Arachnid/Agent/Actions/Paused.html">Paused</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/RuntimeError" data-name="arachnid::agent::actions::runtimeerror">
<a href="../../Arachnid/Agent/Actions/RuntimeError.html">RuntimeError</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/SkipLink" data-name="arachnid::agent::actions::skiplink">
<a href="../../Arachnid/Agent/Actions/SkipLink.html">SkipLink</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/SkipResource" data-name="arachnid::agent::actions::skipresource">
<a href="../../Arachnid/Agent/Actions/SkipResource.html">SkipResource</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Queue" data-name="arachnid::agent::queue">
<a href="../../Arachnid/Agent/Queue.html">Queue</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/AuthCredential" data-name="arachnid::authcredential">
<a href="../../Arachnid/AuthCredential.html">AuthCredential</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/AuthStore" data-name="arachnid::authstore">
<a href="../../Arachnid/AuthStore.html">AuthStore</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/CookieJar" data-name="arachnid::cookiejar">
<a href="../../Arachnid/CookieJar.html">CookieJar</a>
</li>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Document" data-name="arachnid::document">
<a href="../../Arachnid/Document.html">Document</a>
<ul>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Document/HTML" data-name="arachnid::document::html">
<a href="../../Arachnid/Document/HTML.html">HTML</a>
<ul>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Document/HTML/Tag" data-name="arachnid::document::html::tag">
<a href="../../Arachnid/Document/HTML/Tag.html">Tag</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="parent open current" data-id="github.com/watzon/arachnid/Arachnid/Resource" data-name="arachnid::resource">
<a href="../../Arachnid/Resource.html">Resource</a>
<ul>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/ContentTypes" data-name="arachnid::resource::contenttypes">
<a href="../../Arachnid/Resource/ContentTypes.html">ContentTypes</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/Cookies" data-name="arachnid::resource::cookies">
<a href="../../Arachnid/Resource/Cookies.html">Cookies</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/HTML" data-name="arachnid::resource::html">
<a href="../../Arachnid/Resource/HTML.html">HTML</a>
</li>
<li class=" current" data-id="github.com/watzon/arachnid/Arachnid/Resource/StatusCodes" data-name="arachnid::resource::statuscodes">
<a href="../../Arachnid/Resource/StatusCodes.html">StatusCodes</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Rules" data-name="arachnid::rules(t)">
<a href="../../Arachnid/Rules.html">Rules</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/SessionCache" data-name="arachnid::sessioncache">
<a href="../../Arachnid/SessionCache.html">SessionCache</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/URI" data-name="uri">
<a href="../../URI.html">URI</a>
</li>
</ul>
</div>
</div>
<div class="main-content">
<h1 class="type-name">
<span class="kind">module</span> Arachnid::Resource::StatusCodes
</h1>
<h2>Direct including types</h2>
<ul class="other-types-list">
<li class="other-type"><a href="../../Arachnid/Resource.html">Arachnid::Resource</a></li>
</ul>
<h2>Defined in:</h2>
<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/resource/status_codes.cr#L3" target="_blank">
arachnid/resource/status_codes.cr
</a>
<br/>
<h2>Instance Method Summary</h2>
<ul class="list-summary">
<li class="entry-summary">
<a href="#bad_request%3F-instance-method" class="signature"><strong>#bad_request?</strong></a>
<div class="summary"><p>Determines if the response code is <code>400</code>.</p></div>
</li>
<li class="entry-summary">
<a href="#code-instance-method" class="signature"><strong>#code</strong></a>
<div class="summary"><p>The response code from the resource.</p></div>
</li>
<li class="entry-summary">
<a href="#forbidden%3F-instance-method" class="signature"><strong>#forbidden?</strong></a>
<div class="summary"><p>Determines if the response code is <code>403</code>.</p></div>
</li>
<li class="entry-summary">
<a href="#had_internal_server_error%3F-instance-method" class="signature"><strong>#had_internal_server_error?</strong></a>
<div class="summary"><p>Determines if the response code is <code>500</code>.</p></div>
</li>
<li class="entry-summary">
<a href="#missing%3F-instance-method" class="signature"><strong>#missing?</strong></a>
<div class="summary"><p>Determines if the response code is <code>404</code>.</p></div>
</li>
<li class="entry-summary">
<a href="#ok%3F-instance-method" class="signature"><strong>#ok?</strong></a>
<div class="summary"><p>Determines if the response code is <code>200</code>.</p></div>
</li>
<li class="entry-summary">
<a href="#redirect%3F-instance-method" class="signature"><strong>#redirect?</strong></a>
<div class="summary"><p>Determines if the response code is <code>300</code>, <code>301</code>, <code>302</code>, <code>303</code> or <code>307</code>.</p></div>
</li>
<li class="entry-summary">
<a href="#timedout%3F-instance-method" class="signature"><strong>#timedout?</strong></a>
<div class="summary"><p>Determines if the response code is <code>308</code>.</p></div>
</li>
<li class="entry-summary">
<a href="#unauthorized%3F-instance-method" class="signature"><strong>#unauthorized?</strong></a>
<div class="summary"><p>Determines if the response code is <code>401</code>.</p></div>
</li>
</ul>
<div class="methods-inherited">
</div>
<h2>Instance Method Detail</h2>
<div class="entry-detail" id="bad_request?-instance-method">
<div class="signature">
def <strong>bad_request?</strong>
<a class="method-permalink" href="#bad_request%3F-instance-method">#</a>
</div>
<div class="doc"><p>Determines if the response code is <code>400</code>.</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/resource/status_codes.cr#L20" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="code-instance-method">
<div class="signature">
def <strong>code</strong>
<a class="method-permalink" href="#code-instance-method">#</a>
</div>
<div class="doc"><p>The response code from the resource.</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/resource/status_codes.cr#L5" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="forbidden?-instance-method">
<div class="signature">
def <strong>forbidden?</strong>
<a class="method-permalink" href="#forbidden%3F-instance-method">#</a>
</div>
<div class="doc"><p>Determines if the response code is <code>403</code>.</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/resource/status_codes.cr#L30" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="had_internal_server_error?-instance-method">
<div class="signature">
def <strong>had_internal_server_error?</strong>
<a class="method-permalink" href="#had_internal_server_error%3F-instance-method">#</a>
</div>
<div class="doc"><p>Determines if the response code is <code>500</code>.</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/resource/status_codes.cr#L40" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="missing?-instance-method">
<div class="signature">
def <strong>missing?</strong>
<a class="method-permalink" href="#missing%3F-instance-method">#</a>
</div>
<div class="doc"><p>Determines if the response code is <code>404</code>.</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/resource/status_codes.cr#L35" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="ok?-instance-method">
<div class="signature">
def <strong>ok?</strong>
<a class="method-permalink" href="#ok%3F-instance-method">#</a>
</div>
<div class="doc"><p>Determines if the response code is <code>200</code>.</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/resource/status_codes.cr#L10" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="redirect?-instance-method">
<div class="signature">
def <strong>redirect?</strong>
<a class="method-permalink" href="#redirect%3F-instance-method">#</a>
</div>
<div class="doc"><p>Determines if the response code is <code>300</code>, <code>301</code>, <code>302</code>, <code>303</code>
or <code>307</code>. Also checks for "soft" redirects added at the resource
level by a meta refresh tag.</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/resource/status_codes.cr#L47" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="timedout?-instance-method">
<div class="signature">
def <strong>timedout?</strong>
<a class="method-permalink" href="#timedout%3F-instance-method">#</a>
</div>
<div class="doc"><p>Determines if the response code is <code>308</code>.</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/resource/status_codes.cr#L15" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="unauthorized?-instance-method">
<div class="signature">
def <strong>unauthorized?</strong>
<a class="method-permalink" href="#unauthorized%3F-instance-method">#</a>
</div>
<div class="doc"><p>Determines if the response code is <code>401</code>.</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/resource/status_codes.cr#L25" target="_blank">View source</a>]
</div>
</div>
</div>
</body>
</html>

461
docs/Arachnid/Rules.html Normal file
View File

@ -0,0 +1,461 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.29.0">
<link href="../css/style.css" rel="stylesheet" type="text/css">
<script type="text/javascript" src="../js/doc.js"></script>
<script type="text/javascript">
CrystalDoc.base_path = "../";
</script>
<meta id="repository-name" content="github.com/watzon/arachnid">
<title>Arachnid::Rules(T) - github.com/watzon/arachnid</title>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
<input type="search" class="search-input" placeholder="Search..." spellcheck="false" aria-label="Search">
</div>
<div class="repository-links">
<a href="../index.html">README</a>
</div>
</div>
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
<div class="types-list">
<ul>
<li class="parent open current" data-id="github.com/watzon/arachnid/Arachnid" data-name="arachnid">
<a href="../Arachnid.html">Arachnid</a>
<ul>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Agent" data-name="arachnid::agent">
<a href="../Arachnid/Agent.html">Agent</a>
<ul>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions" data-name="arachnid::agent::actions">
<a href="../Arachnid/Agent/Actions.html">Actions</a>
<ul>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/Action" data-name="arachnid::agent::actions::action">
<a href="../Arachnid/Agent/Actions/Action.html">Action</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/Paused" data-name="arachnid::agent::actions::paused">
<a href="../Arachnid/Agent/Actions/Paused.html">Paused</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/RuntimeError" data-name="arachnid::agent::actions::runtimeerror">
<a href="../Arachnid/Agent/Actions/RuntimeError.html">RuntimeError</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/SkipLink" data-name="arachnid::agent::actions::skiplink">
<a href="../Arachnid/Agent/Actions/SkipLink.html">SkipLink</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/SkipResource" data-name="arachnid::agent::actions::skipresource">
<a href="../Arachnid/Agent/Actions/SkipResource.html">SkipResource</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Queue" data-name="arachnid::agent::queue">
<a href="../Arachnid/Agent/Queue.html">Queue</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/AuthCredential" data-name="arachnid::authcredential">
<a href="../Arachnid/AuthCredential.html">AuthCredential</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/AuthStore" data-name="arachnid::authstore">
<a href="../Arachnid/AuthStore.html">AuthStore</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/CookieJar" data-name="arachnid::cookiejar">
<a href="../Arachnid/CookieJar.html">CookieJar</a>
</li>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Document" data-name="arachnid::document">
<a href="../Arachnid/Document.html">Document</a>
<ul>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Document/HTML" data-name="arachnid::document::html">
<a href="../Arachnid/Document/HTML.html">HTML</a>
<ul>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Document/HTML/Tag" data-name="arachnid::document::html::tag">
<a href="../Arachnid/Document/HTML/Tag.html">Tag</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Resource" data-name="arachnid::resource">
<a href="../Arachnid/Resource.html">Resource</a>
<ul>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/ContentTypes" data-name="arachnid::resource::contenttypes">
<a href="../Arachnid/Resource/ContentTypes.html">ContentTypes</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/Cookies" data-name="arachnid::resource::cookies">
<a href="../Arachnid/Resource/Cookies.html">Cookies</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/HTML" data-name="arachnid::resource::html">
<a href="../Arachnid/Resource/HTML.html">HTML</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/StatusCodes" data-name="arachnid::resource::statuscodes">
<a href="../Arachnid/Resource/StatusCodes.html">StatusCodes</a>
</li>
</ul>
</li>
<li class=" current" data-id="github.com/watzon/arachnid/Arachnid/Rules" data-name="arachnid::rules(t)">
<a href="../Arachnid/Rules.html">Rules</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/SessionCache" data-name="arachnid::sessioncache">
<a href="../Arachnid/SessionCache.html">SessionCache</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/URI" data-name="uri">
<a href="../URI.html">URI</a>
</li>
</ul>
</div>
</div>
<div class="main-content">
<h1 class="type-name">
<span class="kind">class</span> Arachnid::Rules(T)
</h1>
<ul class="superclass-hierarchy"><li class="superclass"><a href="../Arachnid/Rules.html">Arachnid::Rules(T)</a></li><li class="superclass">Reference</li><li class="superclass">Object</li></ul>
<h2>Overview</h2>
<p>The <code><a href="../Arachnid/Rules.html">Rules</a></code> class represents collections of acceptance and rejection
rules, which are used to filter data.</p>
<h2>Defined in:</h2>
<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/rules.cr#L4" target="_blank">
arachnid/rules.cr
</a>
<br/>
<h2>Constructors</h2>
<ul class="list-summary">
<li class="entry-summary">
<a href="#new%28accept%3AArray%28Proc%28T%3F%2CBool%29%7CT%7CRegex%7CString%29%3F%3Dnil%2Creject%3AArray%28Proc%28T%3F%2CBool%29%7CT%7CRegex%7CString%29%3F%3Dnil%29-class-method" class="signature"><strong>.new</strong>(accept : Array(Proc(T?, Bool) | T | Regex | String)? = <span class="n">nil</span>, reject : Array(Proc(T?, Bool) | T | Regex | String)? = <span class="n">nil</span>)</a>
<div class="summary"><p>Creates a new <code><a href="../Arachnid/Rules.html">Rules</a></code> object.</p></div>
</li>
</ul>
<h2>Instance Method Summary</h2>
<ul class="list-summary">
<li class="entry-summary">
<a href="#accept%3AArray%28Proc%28T%3F%2CBool%29%7CT%7CRegex%7CString%29-instance-method" class="signature"><strong>#accept</strong> : Array(Proc(T?, Bool) | T | Regex | String)</a>
<div class="summary"><p>Accept rules</p></div>
</li>
<li class="entry-summary">
<a href="#accept%3D%28value%29-instance-method" class="signature"><strong>#accept=</strong>(value)</a>
</li>
<li class="entry-summary">
<a href="#accept%3F%28data%3AT%29-instance-method" class="signature"><strong>#accept?</strong>(data : T)</a>
<div class="summary"><p>Determines whether the data should be accepted or rejected.</p></div>
</li>
<li class="entry-summary">
<a href="#reject%3AArray%28Proc%28T%3F%2CBool%29%7CT%7CRegex%7CString%29-instance-method" class="signature"><strong>#reject</strong> : Array(Proc(T?, Bool) | T | Regex | String)</a>
<div class="summary"><p>Reject rules</p></div>
</li>
<li class="entry-summary">
<a href="#reject%3D%28value%29-instance-method" class="signature"><strong>#reject=</strong>(value)</a>
</li>
<li class="entry-summary">
<a href="#reject%3F%28data%3AT%29-instance-method" class="signature"><strong>#reject?</strong>(data : T)</a>
<div class="summary"><p>Determines whether the data should be rejected or accepted.</p></div>
</li>
</ul>
<div class="methods-inherited">
</div>
<h2>Constructor Detail</h2>
<div class="entry-detail" id="new(accept:Array(Proc(T?,Bool)|T|Regex|String)?=nil,reject:Array(Proc(T?,Bool)|T|Regex|String)?=nil)-class-method">
<div class="signature">
def self.<strong>new</strong>(accept : Array(Proc(T?, Bool) | T | Regex | String)? = <span class="n">nil</span>, reject : Array(Proc(T?, Bool) | T | Regex | String)? = <span class="n">nil</span>)
<a class="method-permalink" href="#new%28accept%3AArray%28Proc%28T%3F%2CBool%29%7CT%7CRegex%7CString%29%3F%3Dnil%2Creject%3AArray%28Proc%28T%3F%2CBool%29%7CT%7CRegex%7CString%29%3F%3Dnil%29-class-method">#</a>
</div>
<div class="doc"><p>Creates a new <code><a href="../Arachnid/Rules.html">Rules</a></code> object.</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/rules.cr#L12" target="_blank">View source</a>]
</div>
</div>
<h2>Instance Method Detail</h2>
<div class="entry-detail" id="accept:Array(Proc(T?,Bool)|T|Regex|String)-instance-method">
<div class="signature">
def <strong>accept</strong> : Array(Proc(T?, Bool) | T | Regex | String)
<a class="method-permalink" href="#accept%3AArray%28Proc%28T%3F%2CBool%29%7CT%7CRegex%7CString%29-instance-method">#</a>
</div>
<div class="doc"><p>Accept rules</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/rules.cr#L8" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="accept=(value)-instance-method">
<div class="signature">
def <strong>accept=</strong>(value)
<a class="method-permalink" href="#accept%3D%28value%29-instance-method">#</a>
</div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/rules.cr#L25" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="accept?(data:T)-instance-method">
<div class="signature">
def <strong>accept?</strong>(data : T)
<a class="method-permalink" href="#accept%3F%28data%3AT%29-instance-method">#</a>
</div>
<div class="doc"><p>Determines whether the data should be accepted or rejected.</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/rules.cr#L18" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="reject:Array(Proc(T?,Bool)|T|Regex|String)-instance-method">
<div class="signature">
def <strong>reject</strong> : Array(Proc(T?, Bool) | T | Regex | String)
<a class="method-permalink" href="#reject%3AArray%28Proc%28T%3F%2CBool%29%7CT%7CRegex%7CString%29-instance-method">#</a>
</div>
<div class="doc"><p>Reject rules</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/rules.cr#L11" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="reject=(value)-instance-method">
<div class="signature">
def <strong>reject=</strong>(value)
<a class="method-permalink" href="#reject%3D%28value%29-instance-method">#</a>
</div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/rules.cr#L34" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="reject?(data:T)-instance-method">
<div class="signature">
def <strong>reject?</strong>(data : T)
<a class="method-permalink" href="#reject%3F%28data%3AT%29-instance-method">#</a>
</div>
<div class="doc"><p>Determines whether the data should be rejected or accepted.</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/rules.cr#L30" target="_blank">View source</a>]
</div>
</div>
</div>
</body>
</html>

618
docs/Arachnid/SessionCache.html Normal file
View File

@ -0,0 +1,618 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.29.0">
<link href="../css/style.css" rel="stylesheet" type="text/css">
<script type="text/javascript" src="../js/doc.js"></script>
<script type="text/javascript">
CrystalDoc.base_path = "../";
</script>
<meta id="repository-name" content="github.com/watzon/arachnid">
<title>Arachnid::SessionCache - github.com/watzon/arachnid</title>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
<input type="search" class="search-input" placeholder="Search..." spellcheck="false" aria-label="Search">
</div>
<div class="repository-links">
<a href="../index.html">README</a>
</div>
</div>
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
<div class="types-list">
<ul>
<li class="parent open current" data-id="github.com/watzon/arachnid/Arachnid" data-name="arachnid">
<a href="../Arachnid.html">Arachnid</a>
<ul>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Agent" data-name="arachnid::agent">
<a href="../Arachnid/Agent.html">Agent</a>
<ul>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions" data-name="arachnid::agent::actions">
<a href="../Arachnid/Agent/Actions.html">Actions</a>
<ul>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/Action" data-name="arachnid::agent::actions::action">
<a href="../Arachnid/Agent/Actions/Action.html">Action</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/Paused" data-name="arachnid::agent::actions::paused">
<a href="../Arachnid/Agent/Actions/Paused.html">Paused</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/RuntimeError" data-name="arachnid::agent::actions::runtimeerror">
<a href="../Arachnid/Agent/Actions/RuntimeError.html">RuntimeError</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/SkipLink" data-name="arachnid::agent::actions::skiplink">
<a href="../Arachnid/Agent/Actions/SkipLink.html">SkipLink</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/SkipResource" data-name="arachnid::agent::actions::skipresource">
<a href="../Arachnid/Agent/Actions/SkipResource.html">SkipResource</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Queue" data-name="arachnid::agent::queue">
<a href="../Arachnid/Agent/Queue.html">Queue</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/AuthCredential" data-name="arachnid::authcredential">
<a href="../Arachnid/AuthCredential.html">AuthCredential</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/AuthStore" data-name="arachnid::authstore">
<a href="../Arachnid/AuthStore.html">AuthStore</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/CookieJar" data-name="arachnid::cookiejar">
<a href="../Arachnid/CookieJar.html">CookieJar</a>
</li>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Document" data-name="arachnid::document">
<a href="../Arachnid/Document.html">Document</a>
<ul>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Document/HTML" data-name="arachnid::document::html">
<a href="../Arachnid/Document/HTML.html">HTML</a>
<ul>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Document/HTML/Tag" data-name="arachnid::document::html::tag">
<a href="../Arachnid/Document/HTML/Tag.html">Tag</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Resource" data-name="arachnid::resource">
<a href="../Arachnid/Resource.html">Resource</a>
<ul>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/ContentTypes" data-name="arachnid::resource::contenttypes">
<a href="../Arachnid/Resource/ContentTypes.html">ContentTypes</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/Cookies" data-name="arachnid::resource::cookies">
<a href="../Arachnid/Resource/Cookies.html">Cookies</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/HTML" data-name="arachnid::resource::html">
<a href="../Arachnid/Resource/HTML.html">HTML</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/StatusCodes" data-name="arachnid::resource::statuscodes">
<a href="../Arachnid/Resource/StatusCodes.html">StatusCodes</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Rules" data-name="arachnid::rules(t)">
<a href="../Arachnid/Rules.html">Rules</a>
</li>
<li class=" current" data-id="github.com/watzon/arachnid/Arachnid/SessionCache" data-name="arachnid::sessioncache">
<a href="../Arachnid/SessionCache.html">SessionCache</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/URI" data-name="uri">
<a href="../URI.html">URI</a>
</li>
</ul>
</div>
</div>
<div class="main-content">
<h1 class="type-name">
<span class="kind">class</span> Arachnid::SessionCache
</h1>
<ul class="superclass-hierarchy"><li class="superclass"><a href="../Arachnid/SessionCache.html">Arachnid::SessionCache</a></li><li class="superclass">Reference</li><li class="superclass">Object</li></ul>
<h2>Overview</h2>
<p>Stores active HTTP Sessions organized by scheme, host-name and port.</p>
<h2>Defined in:</h2>
<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/session_cache.cr#L6" target="_blank">
arachnid/session_cache.cr
</a>
<br/>
<h2>Constructors</h2>
<ul class="list-summary">
<li class="entry-summary">
<a href="#new%28read_timeout%3AInt32%3F%3Dnil%2Cconnect_timeout%3AInt32%3F%3Dnil%2Cmax_redirects%3AInt32%3F%3Dnil%2Cdo_not_track%3ABool%3F%3Dnil%29-class-method" class="signature"><strong>.new</strong>(read_timeout : Int32? = <span class="n">nil</span>, connect_timeout : Int32? = <span class="n">nil</span>, max_redirects : Int32? = <span class="n">nil</span>, do_not_track : Bool? = <span class="n">nil</span>)</a>
<div class="summary"><p>Create a new session cache</p></div>
</li>
</ul>
<h2>Instance Method Summary</h2>
<ul class="list-summary">
<li class="entry-summary">
<a href="#%5B%5D%28url%29-instance-method" class="signature"><strong>#[]</strong>(url)</a>
<div class="summary"><p>Provides an active session for a given URL.</p></div>
</li>
<li class="entry-summary">
<a href="#active%3F%28url%29-instance-method" class="signature"><strong>#active?</strong>(url)</a>
<div class="summary"><p>Determines if there is an active session for the given URL</p></div>
</li>
<li class="entry-summary">
<a href="#clear-instance-method" class="signature"><strong>#clear</strong></a>
<div class="summary"><p>Clears the session cache</p></div>
</li>
<li class="entry-summary">
<a href="#connect_timeout%3AInt32-instance-method" class="signature"><strong>#connect_timeout</strong> : Int32</a>
<div class="summary"><p>Optional connect timeout.</p></div>
</li>
<li class="entry-summary">
<a href="#connect_timeout%3D%28connect_timeout%3AInt32%29-instance-method" class="signature"><strong>#connect_timeout=</strong>(connect_timeout : Int32)</a>
<div class="summary"><p>Optional connect timeout.</p></div>
</li>
<li class="entry-summary">
<a href="#do_not_track%3D%28do_not_track%3ABool%29-instance-method" class="signature"><strong>#do_not_track=</strong>(do_not_track : Bool)</a>
<div class="summary"><p>Should we set a DNT (Do Not Track) header?</p></div>
</li>
<li class="entry-summary">
<a href="#do_not_track%3F%3ABool-instance-method" class="signature"><strong>#do_not_track?</strong> : Bool</a>
<div class="summary"><p>Should we set a DNT (Do Not Track) header?</p></div>
</li>
<li class="entry-summary">
<a href="#kill%21%28url%29-instance-method" class="signature"><strong>#kill!</strong>(url)</a>
<div class="summary"><p>Destroys an HTTP session for the given scheme, host, and port.</p></div>
</li>
<li class="entry-summary">
<a href="#max_redirects%3AInt32%3F-instance-method" class="signature"><strong>#max_redirects</strong> : Int32?</a>
<div class="summary"><p>Max redirects to follow.</p></div>
</li>
<li class="entry-summary">
<a href="#max_redirects%3D%28max_redirects%3AInt32%3F%29-instance-method" class="signature"><strong>#max_redirects=</strong>(max_redirects : Int32?)</a>
<div class="summary"><p>Max redirects to follow.</p></div>
</li>
<li class="entry-summary">
<a href="#read_timeout%3AInt32-instance-method" class="signature"><strong>#read_timeout</strong> : Int32</a>
<div class="summary"><p>Optional read timeout.</p></div>
</li>
<li class="entry-summary">
<a href="#read_timeout%3D%28read_timeout%3AInt32%29-instance-method" class="signature"><strong>#read_timeout=</strong>(read_timeout : Int32)</a>
<div class="summary"><p>Optional read timeout.</p></div>
</li>
</ul>
<div class="methods-inherited">
</div>
<h2>Constructor Detail</h2>
<div class="entry-detail" id="new(read_timeout:Int32?=nil,connect_timeout:Int32?=nil,max_redirects:Int32?=nil,do_not_track:Bool?=nil)-class-method">
<div class="signature">
def self.<strong>new</strong>(read_timeout : Int32? = <span class="n">nil</span>, connect_timeout : Int32? = <span class="n">nil</span>, max_redirects : Int32? = <span class="n">nil</span>, do_not_track : Bool? = <span class="n">nil</span>)
<a class="method-permalink" href="#new%28read_timeout%3AInt32%3F%3Dnil%2Cconnect_timeout%3AInt32%3F%3Dnil%2Cmax_redirects%3AInt32%3F%3Dnil%2Cdo_not_track%3ABool%3F%3Dnil%29-class-method">#</a>
</div>
<div class="doc"><p>Create a new session cache</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/session_cache.cr#L23" target="_blank">View source</a>]
</div>
</div>
<h2>Instance Method Detail</h2>
<div class="entry-detail" id="[](url)-instance-method">
<div class="signature">
def <strong>[]</strong>(url)
<a class="method-permalink" href="#%5B%5D%28url%29-instance-method">#</a>
</div>
<div class="doc"><p>Provides an active session for a given URL.</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/session_cache.cr#L47" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="active?(url)-instance-method">
<div class="signature">
def <strong>active?</strong>(url)
<a class="method-permalink" href="#active%3F%28url%29-instance-method">#</a>
</div>
<div class="doc"><p>Determines if there is an active session for the given URL</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/session_cache.cr#L36" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="clear-instance-method">
<div class="signature">
def <strong>clear</strong>
<a class="method-permalink" href="#clear-instance-method">#</a>
</div>
<div class="doc"><p>Clears the session cache</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/session_cache.cr#L102" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="connect_timeout:Int32-instance-method">
<div class="signature">
def <strong>connect_timeout</strong> : Int32
<a class="method-permalink" href="#connect_timeout%3AInt32-instance-method">#</a>
</div>
<div class="doc"><p>Optional connect timeout.</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/session_cache.cr#L14" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="connect_timeout=(connect_timeout:Int32)-instance-method">
<div class="signature">
def <strong>connect_timeout=</strong>(connect_timeout : Int32)
<a class="method-permalink" href="#connect_timeout%3D%28connect_timeout%3AInt32%29-instance-method">#</a>
</div>
<div class="doc"><p>Optional connect timeout.</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/session_cache.cr#L18" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="do_not_track=(do_not_track:Bool)-instance-method">
<div class="signature">
def <strong>do_not_track=</strong>(do_not_track : Bool)
<a class="method-permalink" href="#do_not_track%3D%28do_not_track%3ABool%29-instance-method">#</a>
</div>
<div class="doc"><p>Should we set a DNT (Do Not Track) header?</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/session_cache.cr#L24" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="do_not_track?:Bool-instance-method">
<div class="signature">
def <strong>do_not_track?</strong> : Bool
<a class="method-permalink" href="#do_not_track%3F%3ABool-instance-method">#</a>
</div>
<div class="doc"><p>Should we set a DNT (Do Not Track) header?</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/session_cache.cr#L20" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="kill!(url)-instance-method">
<div class="signature">
def <strong>kill!</strong>(url)
<a class="method-permalink" href="#kill%21%28url%29-instance-method">#</a>
</div>
<div class="doc"><p>Destroys an HTTP session for the given scheme, host, and port.</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/session_cache.cr#L89" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="max_redirects:Int32?-instance-method">
<div class="signature">
def <strong>max_redirects</strong> : Int32?
<a class="method-permalink" href="#max_redirects%3AInt32%3F-instance-method">#</a>
</div>
<div class="doc"><p>Max redirects to follow.</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/session_cache.cr#L17" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="max_redirects=(max_redirects:Int32?)-instance-method">
<div class="signature">
def <strong>max_redirects=</strong>(max_redirects : Int32?)
<a class="method-permalink" href="#max_redirects%3D%28max_redirects%3AInt32%3F%29-instance-method">#</a>
</div>
<div class="doc"><p>Max redirects to follow.</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/session_cache.cr#L21" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="read_timeout:Int32-instance-method">
<div class="signature">
def <strong>read_timeout</strong> : Int32
<a class="method-permalink" href="#read_timeout%3AInt32-instance-method">#</a>
</div>
<div class="doc"><p>Optional read timeout.</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/session_cache.cr#L11" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="read_timeout=(read_timeout:Int32)-instance-method">
<div class="signature">
def <strong>read_timeout=</strong>(read_timeout : Int32)
<a class="method-permalink" href="#read_timeout%3D%28read_timeout%3AInt32%29-instance-method">#</a>
</div>
<div class="doc"><p>Optional read timeout.</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/session_cache.cr#L15" target="_blank">View source</a>]
</div>
</div>
</div>
</body>
</html>

415
docs/URI.html Normal file
View File

@ -0,0 +1,415 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.29.0">
<link href="css/style.css" rel="stylesheet" type="text/css">
<script type="text/javascript" src="js/doc.js"></script>
<script type="text/javascript">
CrystalDoc.base_path = "";
</script>
<meta id="repository-name" content="github.com/watzon/arachnid">
<title>URI - github.com/watzon/arachnid</title>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
<input type="search" class="search-input" placeholder="Search..." spellcheck="false" aria-label="Search">
</div>
<div class="repository-links">
<a href="index.html">README</a>
</div>
</div>
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
<div class="types-list">
<ul>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid" data-name="arachnid">
<a href="Arachnid.html">Arachnid</a>
<ul>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Agent" data-name="arachnid::agent">
<a href="Arachnid/Agent.html">Agent</a>
<ul>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions" data-name="arachnid::agent::actions">
<a href="Arachnid/Agent/Actions.html">Actions</a>
<ul>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/Action" data-name="arachnid::agent::actions::action">
<a href="Arachnid/Agent/Actions/Action.html">Action</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/Paused" data-name="arachnid::agent::actions::paused">
<a href="Arachnid/Agent/Actions/Paused.html">Paused</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/RuntimeError" data-name="arachnid::agent::actions::runtimeerror">
<a href="Arachnid/Agent/Actions/RuntimeError.html">RuntimeError</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/SkipLink" data-name="arachnid::agent::actions::skiplink">
<a href="Arachnid/Agent/Actions/SkipLink.html">SkipLink</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/SkipResource" data-name="arachnid::agent::actions::skipresource">
<a href="Arachnid/Agent/Actions/SkipResource.html">SkipResource</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Queue" data-name="arachnid::agent::queue">
<a href="Arachnid/Agent/Queue.html">Queue</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/AuthCredential" data-name="arachnid::authcredential">
<a href="Arachnid/AuthCredential.html">AuthCredential</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/AuthStore" data-name="arachnid::authstore">
<a href="Arachnid/AuthStore.html">AuthStore</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/CookieJar" data-name="arachnid::cookiejar">
<a href="Arachnid/CookieJar.html">CookieJar</a>
</li>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Document" data-name="arachnid::document">
<a href="Arachnid/Document.html">Document</a>
<ul>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Document/HTML" data-name="arachnid::document::html">
<a href="Arachnid/Document/HTML.html">HTML</a>
<ul>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Document/HTML/Tag" data-name="arachnid::document::html::tag">
<a href="Arachnid/Document/HTML/Tag.html">Tag</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Resource" data-name="arachnid::resource">
<a href="Arachnid/Resource.html">Resource</a>
<ul>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/ContentTypes" data-name="arachnid::resource::contenttypes">
<a href="Arachnid/Resource/ContentTypes.html">ContentTypes</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/Cookies" data-name="arachnid::resource::cookies">
<a href="Arachnid/Resource/Cookies.html">Cookies</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/HTML" data-name="arachnid::resource::html">
<a href="Arachnid/Resource/HTML.html">HTML</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/StatusCodes" data-name="arachnid::resource::statuscodes">
<a href="Arachnid/Resource/StatusCodes.html">StatusCodes</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Rules" data-name="arachnid::rules(t)">
<a href="Arachnid/Rules.html">Rules</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/SessionCache" data-name="arachnid::sessioncache">
<a href="Arachnid/SessionCache.html">SessionCache</a>
</li>
</ul>
</li>
<li class=" current" data-id="github.com/watzon/arachnid/URI" data-name="uri">
<a href="URI.html">URI</a>
</li>
</ul>
</div>
</div>
<div class="main-content">
<h1 class="type-name">
<span class="kind">class</span> URI
</h1>
<ul class="superclass-hierarchy"><li class="superclass"><a href="URI.html">URI</a></li><li class="superclass">Reference</li><li class="superclass">Object</li></ul>
<h2>Overview</h2>
<p><code>Punycode</code> provides an interface for IDNA encoding (RFC 5980),
which is defined in RFC 3493</p>
<p>Implementation based on Mathias Bynens <code>punnycode.js</code> project
https://github.com/bestiejs/punycode.js/</p>
<p>RFC 3492:
Method to use non-ascii characters as host name of URI
https://www.ietf.org/rfc/rfc3492.txt</p>
<p>RFC 5980:
Internationalized Domain Names in Application
https://www.ietf.org/rfc/rfc5980.txt</p>
<h2>Defined in:</h2>
<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/extensions/uri.cr#L4" target="_blank">
arachnid/extensions/uri.cr
</a>
<br/>
<h2>Class Method Summary</h2>
<ul class="list-summary">
<li class="entry-summary">
<a href="#expand_path%28path%29-class-method" class="signature"><strong>.expand_path</strong>(path)</a>
<div class="summary"><p>Expands a URI decoded path, into a proper absolute path.</p></div>
</li>
</ul>
<h2>Instance Method Summary</h2>
<ul class="list-summary">
<li class="entry-summary">
<a href="#merge%28oth%29-instance-method" class="signature"><strong>#merge</strong>(oth)</a>
</li>
<li class="entry-summary">
<a href="#merge_path%28base%2Crel%29-instance-method" class="signature"><strong>#merge_path</strong>(base, rel)</a>
</li>
<li class="entry-summary">
<a href="#split_path%28path%29-instance-method" class="signature"><strong>#split_path</strong>(path)</a>
</li>
</ul>
<div class="methods-inherited">
</div>
<h2>Class Method Detail</h2>
<div class="entry-detail" id="expand_path(path)-class-method">
<div class="signature">
def self.<strong>expand_path</strong>(path)
<a class="method-permalink" href="#expand_path%28path%29-class-method">#</a>
</div>
<div class="doc"><p>Expands a URI decoded path, into a proper absolute path.</p>
<p>@param [String] path
The path from a URI.</p>
<p>@return [String]
The expanded path.</p>
<p>@example
URI.expand_path("./path")
# => "path"</p>
<p>@example
URI.expand_path("test/../path")
# => "path"</p>
<p>@example
URI.expand_path("/test/path/")
# => "/test/path/"</p>
<p>@example
URI.expand_path("/test/../path")
# => "/path"</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/extensions/uri.cr#L30" target="_blank">View source</a>]
</div>
</div>
<h2>Instance Method Detail</h2>
<div class="entry-detail" id="merge(oth)-instance-method">
<div class="signature">
def <strong>merge</strong>(oth)
<a class="method-permalink" href="#merge%28oth%29-instance-method">#</a>
</div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/extensions/uri.cr#L132" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="merge_path(base,rel)-instance-method">
<div class="signature">
def <strong>merge_path</strong>(base, rel)
<a class="method-permalink" href="#merge_path%28base%2Crel%29-instance-method">#</a>
</div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/extensions/uri.cr#L70" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="split_path(path)-instance-method">
<div class="signature">
def <strong>split_path</strong>(path)
<a class="method-permalink" href="#split_path%28path%29-instance-method">#</a>
</div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/extensions/uri.cr#L66" target="_blank">View source</a>]
</div>
</div>
</div>
</body>
</html>

629
docs/css/style.css Normal file
View File

@ -0,0 +1,629 @@
html, body {
background: #FFFFFF;
position: relative;
margin: 0;
padding: 0;
width: 100%;
height: 100%;
overflow: hidden;
}
body {
font-family: "Avenir", "Tahoma", "Lucida Sans", "Lucida Grande", Verdana, Arial, sans-serif;
color: #333;
line-height: 1.5;
}
a {
color: #263F6C;
}
a:visited {
color: #112750;
}
h1, h2, h3, h4, h5, h6 {
margin: 35px 0 25px;
color: #444444;
}
h1.type-name {
color: #47266E;
margin: 20px 0 30px;
background-color: #F8F8F8;
padding: 10px 12px;
border: 1px solid #EBEBEB;
border-radius: 2px;
}
h2 {
border-bottom: 1px solid #E6E6E6;
padding-bottom: 5px;
}
body {
display: flex;
}
.sidebar, .main-content {
overflow: auto;
}
.sidebar {
width: 30em;
color: #F8F4FD;
background-color: #2E1052;
padding: 0 0 30px;
box-shadow: inset -3px 0 4px rgba(0,0,0,.35);
line-height: 1.2;
}
.sidebar .search-box {
padding: 8px 9px;
}
.sidebar input {
display: block;
box-sizing: border-box;
margin: 0;
padding: 5px;
font: inherit;
font-family: inherit;
line-height: 1.2;
width: 100%;
border: 0;
outline: 0;
border-radius: 2px;
box-shadow: 0px 3px 5px rgba(0,0,0,.25);
transition: box-shadow .12s;
}
.sidebar input:focus {
box-shadow: 0px 5px 6px rgba(0,0,0,.5);
}
.sidebar input::-webkit-input-placeholder { /* Chrome/Opera/Safari */
color: #C8C8C8;
font-size: 14px;
text-indent: 2px;
}
.sidebar input::-moz-placeholder { /* Firefox 19+ */
color: #C8C8C8;
font-size: 14px;
text-indent: 2px;
}
.sidebar input:-ms-input-placeholder { /* IE 10+ */
color: #C8C8C8;
font-size: 14px;
text-indent: 2px;
}
.sidebar input:-moz-placeholder { /* Firefox 18- */
color: #C8C8C8;
font-size: 14px;
text-indent: 2px;
}
.sidebar ul {
margin: 0;
padding: 0;
list-style: none outside;
}
.sidebar li {
display: block;
position: relative;
}
.types-list li.hide {
display: none;
}
.sidebar a {
text-decoration: none;
color: inherit;
transition: color .14s;
}
.types-list a {
display: block;
padding: 5px 15px 5px 30px;
}
.types-list {
display: block;
}
.sidebar a:focus {
outline: 1px solid #D1B7F1;
}
.types-list a {
padding: 5px 15px 5px 30px;
}
.sidebar .current > a,
.sidebar a:hover {
color: #866BA6;
}
.repository-links {
padding: 5px 15px 5px 30px;
}
.types-list li ul {
overflow: hidden;
height: 0;
max-height: 0;
transition: 1s ease-in-out;
}
.types-list li.parent {
padding-left: 30px;
}
.types-list li.parent::before {
box-sizing: border-box;
content: "▼";
display: block;
width: 30px;
height: 30px;
position: absolute;
top: 0;
left: 0;
text-align: center;
color: white;
font-size: 8px;
line-height: 30px;
transform: rotateZ(-90deg);
cursor: pointer;
transition: .2s linear;
}
.types-list li.parent > a {
padding-left: 0;
}
.types-list li.parent.open::before {
transform: rotateZ(0);
}
.types-list li.open > ul {
height: auto;
max-height: 1000em;
}
.main-content {
padding: 0 30px 30px 30px;
width: 100%;
}
.kind {
font-size: 60%;
color: #866BA6;
}
.superclass-hierarchy {
margin: -15px 0 30px 0;
padding: 0;
list-style: none outside;
font-size: 80%;
}
.superclass-hierarchy .superclass {
display: inline-block;
margin: 0 7px 0 0;
padding: 0;
}
.superclass-hierarchy .superclass + .superclass::before {
content: "<";
margin-right: 7px;
}
.other-types-list li {
display: inline-block;
}
.other-types-list,
.list-summary {
margin: 0 0 30px 0;
padding: 0;
list-style: none outside;
}
.entry-const {
font-family: Menlo, Monaco, Consolas, 'Courier New', Courier, monospace;
}
.entry-const code {
white-space: pre-wrap;
}
.entry-summary {
padding-bottom: 4px;
}
.superclass-hierarchy .superclass a,
.other-type a,
.entry-summary .signature {
padding: 4px 8px;
margin-bottom: 4px;
display: inline-block;
background-color: #f8f8f8;
color: #47266E;
border: 1px solid #f0f0f0;
text-decoration: none;
border-radius: 3px;
font-family: Menlo, Monaco, Consolas, 'Courier New', Courier, monospace;
transition: background .15s, border-color .15s;
}
.superclass-hierarchy .superclass a:hover,
.other-type a:hover,
.entry-summary .signature:hover {
background: #D5CAE3;
border-color: #624288;
}
.entry-summary .summary {
padding-left: 32px;
}
.entry-summary .summary p {
margin: 12px 0 16px;
}
.entry-summary a {
text-decoration: none;
}
.entry-detail {
padding: 30px 0;
}
.entry-detail .signature {
position: relative;
padding: 5px 15px;
margin-bottom: 10px;
display: block;
border-radius: 5px;
background-color: #f8f8f8;
color: #47266E;
border: 1px solid #f0f0f0;
font-family: Menlo, Monaco, Consolas, 'Courier New', Courier, monospace;
transition: .2s ease-in-out;
}
.entry-detail:target .signature {
background-color: #D5CAE3;
border: 1px solid #624288;
}
.entry-detail .signature .method-permalink {
position: absolute;
top: 0;
left: -35px;
padding: 5px 15px;
text-decoration: none;
font-weight: bold;
color: #624288;
opacity: .4;
transition: opacity .2s;
}
.entry-detail .signature .method-permalink:hover {
opacity: 1;
}
.entry-detail:target .signature .method-permalink {
opacity: 1;
}
.methods-inherited {
padding-right: 10%;
line-height: 1.5em;
}
.methods-inherited h3 {
margin-bottom: 4px;
}
.methods-inherited a {
display: inline-block;
text-decoration: none;
color: #47266E;
}
.methods-inherited a:hover {
text-decoration: underline;
color: #6C518B;
}
.methods-inherited .tooltip>span {
background: #D5CAE3;
padding: 4px 8px;
border-radius: 3px;
margin: -4px -8px;
}
.methods-inherited .tooltip * {
color: #47266E;
}
pre {
padding: 10px 20px;
margin-top: 4px;
border-radius: 3px;
line-height: 1.45;
overflow: auto;
color: #333;
background: #fdfdfd;
font-size: 14px;
border: 1px solid #eee;
}
code {
font-family: Menlo, Monaco, Consolas, 'Courier New', Courier, monospace;
}
:not(pre) > code {
background-color: rgba(40,35,30,0.05);
padding: 0.2em 0.4em;
font-size: 85%;
border-radius: 3px;
}
span.flag {
padding: 2px 4px 1px;
border-radius: 3px;
margin-right: 3px;
font-size: 11px;
border: 1px solid transparent;
}
span.flag.orange {
background-color: #EE8737;
color: #FCEBDD;
border-color: #EB7317;
}
span.flag.yellow {
background-color: #E4B91C;
color: #FCF8E8;
border-color: #B69115;
}
span.flag.green {
background-color: #469C14;
color: #E2F9D3;
border-color: #34700E;
}
span.flag.red {
background-color: #BF1919;
color: #F9ECEC;
border-color: #822C2C;
}
span.flag.purple {
background-color: #2E1052;
color: #ECE1F9;
border-color: #1F0B37;
}
.tooltip>span {
position: absolute;
opacity: 0;
display: none;
pointer-events: none;
}
.tooltip:hover>span {
display: inline-block;
opacity: 1;
}
.c {
color: #969896;
}
.n {
color: #0086b3;
}
.t {
color: #0086b3;
}
.s {
color: #183691;
}
.i {
color: #7f5030;
}
.k {
color: #a71d5d;
}
.o {
color: #a71d5d;
}
.m {
color: #795da3;
}
.hidden {
display: none;
}
.search-results {
font-size: 90%;
line-height: 1.3;
}
.search-results mark {
color: inherit;
background: transparent;
font-weight: bold;
}
.search-result {
padding: 5px 8px 5px 5px;
cursor: pointer;
border-left: 5px solid transparent;
transform: translateX(-3px);
transition: all .2s, background-color 0s, border .02s;
min-height: 3.2em;
}
.search-result.current {
border-left-color: #ddd;
background-color: rgba(200,200,200,0.4);
transform: translateX(0);
transition: all .2s, background-color .5s, border 0s;
}
.search-result.current:hover,
.search-result.current:focus {
border-left-color: #866BA6;
}
.search-result:not(.current):nth-child(2n) {
background-color: rgba(255,255,255,.06);
}
.search-result__title {
font-size: 105%;
word-break: break-all;
line-height: 1.1;
padding: 3px 0;
}
.search-result__title strong {
font-weight: normal;
}
.search-results .search-result__title > a {
padding: 0;
display: block;
}
.search-result__title > a > .args {
color: #dddddd;
font-weight: 300;
transition: inherit;
font-size: 88%;
line-height: 1.2;
letter-spacing: -.02em;
}
.search-result__title > a > .args * {
color: inherit;
}
.search-result a,
.search-result a:hover {
color: inherit;
}
.search-result:not(.current):hover .search-result__title > a,
.search-result:not(.current):focus .search-result__title > a,
.search-result__title > a:focus {
color: #866BA6;
}
.search-result:not(.current):hover .args,
.search-result:not(.current):focus .args {
color: #6a5a7d;
}
.search-result__type {
color: #e8e8e8;
font-weight: 300;
}
.search-result__doc {
color: #bbbbbb;
font-size: 90%;
}
.search-result__doc p {
margin: 0;
text-overflow: ellipsis;
display: -webkit-box;
-webkit-box-orient: vertical;
-webkit-line-clamp: 2;
overflow: hidden;
line-height: 1.2em;
max-height: 2.4em;
}
.js-modal-visible .modal-background {
display: flex;
}
.main-content {
position: relative;
}
.modal-background {
position: absolute;
display: none;
height: 100%;
width: 100%;
background: rgba(120,120,120,.4);
z-index: 100;
align-items: center;
justify-content: center;
}
.usage-modal {
max-width: 90%;
background: #fff;
border: 2px solid #ccc;
border-radius: 9px;
padding: 5px 15px 20px;
min-width: 50%;
color: #555;
position: relative;
transform: scale(.5);
transition: transform 200ms;
}
.js-modal-visible .usage-modal {
transform: scale(1);
}
.usage-modal > .close-button {
position: absolute;
right: 15px;
top: 8px;
color: #aaa;
font-size: 27px;
cursor: pointer;
}
.usage-modal > .close-button:hover {
text-shadow: 2px 2px 2px #ccc;
color: #999;
}
.modal-title {
margin: 0;
text-align: center;
font-weight: normal;
color: #666;
border-bottom: 2px solid #ddd;
padding: 10px;
}
.usage-list {
padding: 0;
margin: 13px;
}
.usage-list > li {
padding: 5px 2px;
overflow: auto;
padding-left: 100px;
min-width: 12em;
}
.usage-modal kbd {
background: #eee;
border: 1px solid #ccc;
border-bottom-width: 2px;
border-radius: 3px;
padding: 3px 8px;
font-family: monospace;
margin-right: 2px;
display: inline-block;
}
.usage-key {
float: left;
clear: left;
margin-left: -100px;
margin-right: 12px;
}

473
docs/index.html Normal file
View File

File diff suppressed because one or more lines are too long

1
docs/index.json Normal file
View File

File diff suppressed because one or more lines are too long

1019
docs/js/doc.js Normal file
View File

File diff suppressed because it is too large Load Diff

1
docs/search-index.js Normal file
View File

File diff suppressed because one or more lines are too long