doc/RelayChat.html
<!DOCTYPE html>
<html>
<head>
<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
<title>class RelayChat - RDoc Documentation</title>
<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet">
<script type="text/javascript">
var rdoc_rel_prefix = "./";
</script>
<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script>
<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script>
<script type="text/javascript" charset="utf-8" src="./js/search.js"></script>
<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script>
<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script>
<body id="top" class="class">
<nav id="metadata">
<nav id="home-section" class="section">
<h3 class="section-header">
<a href="./index.html">Home</a>
<a href="./table_of_contents.html#classes">Classes</a>
<a href="./table_of_contents.html#methods">Methods</a>
</h3>
</nav>
<nav id="search-section" class="section project-section" class="initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<h3 class="section-header">
<input type="text" name="search" placeholder="Search" id="search-field"
title="Type to search, Up and Down to navigate, Enter to load">
</h3>
</form>
<ul id="search-results" class="initially-hidden"></ul>
</nav>
<div id="file-metadata">
<nav id="file-list-section" class="section">
<h3 class="section-header">Defined In</h3>
<ul>
<li>classes.rb
</ul>
</nav>
</div>
<div id="class-metadata">
<nav id="parent-class-section" class="section">
<h3 class="section-header">Parent</h3>
<p class="link">Object
</nav>
<!-- Method Quickref -->
<nav id="method-list-section" class="section">
<h3 class="section-header">Methods</h3>
<ul class="link-list">
<li ><a href="#method-c-new">::new</a>
<li ><a href="#method-i-connect">#connect</a>
<li ><a href="#method-i-send_to_channel">#send_to_channel</a>
<li ><a href="#method-i-send_to_user">#send_to_user</a>
</ul>
</nav>
</div>
<div id="project-metadata">
<nav id="fileindex-section" class="section project-section">
<h3 class="section-header">Pages</h3>
<ul>
<li class="file"><a href="./Gemfile.html">Gemfile</a>
<li class="file"><a href="./Gemfile_lock.html">Gemfile.lock</a>
<li class="file"><a href="./README_md.html">README</a>
<li class="file"><a href="./doc/created_rid.html">created.rid</a>
</ul>
</nav>
<nav id="classindex-section" class="section project-section">
<h3 class="section-header">Class and Module Index</h3>
<ul class="link-list">
<li><a href="./CryptoBox.html">CryptoBox</a>
<li><a href="./DatabaseBox.html">DatabaseBox</a>
<li><a href="./EncryptedAdapter.html">EncryptedAdapter</a>
<li><a href="./RbNaCl.html">RbNaCl</a>
<li><a href="./RelayChat.html">RelayChat</a>
<li><a href="./RestApi.html">RestApi</a>
<li><a href="./Starter.html">Starter</a>
</ul>
</nav>
</div>
</nav>
<div id="documentation">
<h1 class="class">class RelayChat</h1>
<div id="description" class="description">
<p>This module opens an IRC connection and saves all the raw irc data to the
database</p>
</div><!-- description -->
<section id="5Buntitled-5D" class="documentation-section">
<!-- Methods -->
<section id="public-class-5Buntitled-5D-method-details" class="method-section section">
<h3 class="section-header">Public Class Methods</h3>
<div id="method-c-new" class="method-detail ">
<div class="method-heading">
<span class="method-name">new</span><span
class="method-args">(server, port, channel, nick)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File classes.rb, line 80</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">server</span>, <span class="ruby-identifier">port</span>, <span class="ruby-identifier">channel</span>, <span class="ruby-identifier">nick</span>)
<span class="ruby-ivar">@server</span> = <span class="ruby-identifier">server</span>
<span class="ruby-ivar">@port</span> = <span class="ruby-identifier">port</span>
<span class="ruby-ivar">@channel</span> = <span class="ruby-identifier">channel</span>
<span class="ruby-ivar">@nick</span> = <span class="ruby-identifier">nick</span>
<span class="ruby-keyword">end</span></pre>
</div><!-- new-source -->
</div>
</div><!-- new-method -->
</section><!-- public-class-method-details -->
<section id="public-instance-5Buntitled-5D-method-details" class="method-section section">
<h3 class="section-header">Public Instance Methods</h3>
<div id="method-i-connect" class="method-detail ">
<div class="method-heading">
<span class="method-name">connect</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>connects to the given irc channel</p>
<div class="method-source-code" id="connect-source">
<pre><span class="ruby-comment"># File classes.rb, line 88</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">connect</span>
<span class="ruby-identifier">irc</span> = <span class="ruby-constant">IRCSocket</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@server</span>, <span class="ruby-ivar">@port</span>, <span class="ruby-keyword">true</span>)
<span class="ruby-identifier">irc</span>.<span class="ruby-identifier">connect</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">irc</span>.<span class="ruby-identifier">connected?</span>
<span class="ruby-identifier">irc</span>.<span class="ruby-identifier">nick</span> <span class="ruby-ivar">@nick</span>
<span class="ruby-identifier">irc</span>.<span class="ruby-identifier">user</span>(<span class="ruby-ivar">@nick</span>, <span class="ruby-value">0</span>, <span class="ruby-string">"*"</span>, <span class="ruby-ivar">@nick</span>)
<span class="ruby-identifier">sending</span> = <span class="ruby-constant">Thread</span>.<span class="ruby-identifier">new</span> {
<span class="ruby-comment"># this thread waits for a message sent by the user and sends it to the irc channel of this instance</span>
}
<span class="ruby-identifier">receiving</span> = <span class="ruby-constant">Thread</span>.<span class="ruby-identifier">new</span> {
<span class="ruby-comment"># this thread reads messages from this instance's irc and writes them to the database</span>
<span class="ruby-keyword">while</span> <span class="ruby-identifier">line</span> = <span class="ruby-identifier">irc</span>.<span class="ruby-identifier">read</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">line</span>.<span class="ruby-identifier">split</span>[<span class="ruby-value">1</span>] <span class="ruby-operator">==</span> <span class="ruby-string">'376'</span>
<span class="ruby-identifier">irc</span>.<span class="ruby-identifier">join</span> <span class="ruby-ivar">@channel</span>
<span class="ruby-keyword">end</span>
<span class="ruby-comment"># puts line # reactivate if a detailed unfiltered output of the irc server messages is desired</span>
<span class="ruby-identifier">msg</span> = <span class="ruby-constant">IRCParser</span>.<span class="ruby-identifier">parse_raw</span>(<span class="ruby-node">"#{line}\r\n"</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">msg</span>[<span class="ruby-value">1</span>].<span class="ruby-identifier">eql?</span> <span class="ruby-string">'JOIN'</span>
<span class="ruby-comment"># connected to channel</span>
<span class="ruby-identifier">puts</span> <span class="ruby-node">"joined channel #{@channel}@#{@server}"</span>
<span class="ruby-keyword">elsif</span> <span class="ruby-identifier">msg</span>[<span class="ruby-value">1</span>].<span class="ruby-identifier">eql?</span> <span class="ruby-string">'PRIVMSG'</span>
<span class="ruby-identifier">sender_nick</span> = <span class="ruby-identifier">msg</span>[<span class="ruby-value">0</span>].<span class="ruby-identifier">split</span>(<span class="ruby-string">'!~'</span>)[<span class="ruby-value">0</span>] <span class="ruby-comment"># strips off client and IP</span>
<span class="ruby-identifier">receiving_channel</span> = <span class="ruby-identifier">msg</span>[<span class="ruby-value">2</span>][<span class="ruby-value">0</span>]
<span class="ruby-identifier">message</span> = <span class="ruby-identifier">msg</span>[<span class="ruby-value">2</span>][<span class="ruby-value">1</span>]
<span class="ruby-identifier">adapter</span> = <span class="ruby-constant">EncryptedAdapter</span>.<span class="ruby-identifier">new</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">receiving_channel</span>.<span class="ruby-identifier">eql?</span> <span class="ruby-ivar">@nick</span>
<span class="ruby-comment"># received private message</span>
<span class="ruby-identifier">adapter</span>.<span class="ruby-identifier">write_encrypted_message</span>(<span class="ruby-constant">Time</span>.<span class="ruby-identifier">new</span>, <span class="ruby-node">"#{@channel.split('#')[1]}@#{@server}"</span>, <span class="ruby-keyword">true</span>, <span class="ruby-identifier">sender_nick</span>, <span class="ruby-identifier">message</span>, <span class="ruby-string">'nil'</span>)
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">adapter</span>.<span class="ruby-identifier">write_encrypted_message</span>(<span class="ruby-constant">Time</span>.<span class="ruby-identifier">new</span>, <span class="ruby-node">"#{@channel.split('#')[1]}@#{@server}"</span>, <span class="ruby-keyword">false</span>, <span class="ruby-identifier">sender_nick</span>, <span class="ruby-identifier">message</span>, <span class="ruby-string">'nil'</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
}
[<span class="ruby-identifier">sending</span>, <span class="ruby-identifier">receiving</span>].<span class="ruby-identifier">each</span>{ <span class="ruby-operator">|</span><span class="ruby-identifier">t</span><span class="ruby-operator">|</span> <span class="ruby-identifier">t</span>.<span class="ruby-identifier">join</span> }
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div><!-- connect-source -->
</div>
</div><!-- connect-method -->
<div id="method-i-send_to_channel" class="method-detail ">
<div class="method-heading">
<span class="method-name">send_to_channel</span><span
class="method-args">(message)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="send_to_channel-source">
<pre><span class="ruby-comment"># File classes.rb, line 132</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">send_to_channel</span>(<span class="ruby-identifier">message</span>)
<span class="ruby-keyword">end</span></pre>
</div><!-- send_to_channel-source -->
</div>
</div><!-- send_to_channel-method -->
<div id="method-i-send_to_user" class="method-detail ">
<div class="method-heading">
<span class="method-name">send_to_user</span><span
class="method-args">(user, message)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="send_to_user-source">
<pre><span class="ruby-comment"># File classes.rb, line 135</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">send_to_user</span>(<span class="ruby-identifier">user</span>, <span class="ruby-identifier">message</span>)
<span class="ruby-keyword">end</span></pre>
</div><!-- send_to_user-source -->
</div>
</div><!-- send_to_user-method -->
</section><!-- public-instance-method-details -->
</section><!-- 5Buntitled-5D -->
</div><!-- documentation -->
<footer id="validator-badges">
<p><a href="http://validator.w3.org/check/referer">[Validate]</a>
<p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 4.0.0.
<p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
</footer>