Files
Sightstone/doc/Sightstone.html
danijoo 425daf66c1 docs
2013-12-15 02:01:47 +01:00

1332 lines
24 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>
Class: Sightstone
&mdash; Documentation by YARD 0.8.7.3
</title>
<link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
<link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
<script type="text/javascript" charset="utf-8">
hasFrames = window.top.frames.main ? true : false;
relpath = '';
framesUrl = "frames.html#!" + escape(window.location.href);
</script>
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
</head>
<body>
<div id="header">
<div id="menu">
<a href="_index.html">Index (S)</a> &raquo;
<span class="title">Sightstone</span>
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="class_list.html">
Class List
</a>
<a class="full_list_link" id="method_list_link"
href="method_list.html">
Method List
</a>
<a class="full_list_link" id="file_list_link"
href="file_list.html">
File List
</a>
</div>
<div class="clear"></div>
</div>
<iframe id="search_frame"></iframe>
<div id="content"><h1>Class: Sightstone
</h1>
<dl class="box">
<dt class="r1">Inherits:</dt>
<dd class="r1">
<span class="inheritName">Object</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">Sightstone</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
<dt class="r2 last">Defined in:</dt>
<dd class="r2 last">lib/sightstone.rb</dd>
</dl>
<div class="clear"></div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>This is the main class of the Sightstone gem. All calls should be
perfomrmed through this class.</p>
</div>
</div>
<div class="tags">
</div>
<h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#api_key-instance_method" title="#api_key (instance method)">- (String) <strong>api_key</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Your api key.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#champion-instance_method" title="#champion (instance method)">- (Object) <strong>champion</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute champion.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#Champion-instance_method" title="#Champion (instance method)">- (ChampionModule) <strong>Champion</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>module to call the champion api.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#game-instance_method" title="#game (instance method)">- (Object) <strong>game</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute game.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#Game-instance_method" title="#Game (instance method)">- (GameModule) <strong>Game</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>module to call the game api.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#League-instance_method" title="#League (instance method)">- (LeagueModule) <strong>League</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>module to call the leagues api.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#league-instance_method" title="#league (instance method)">- (Object) <strong>league</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute league.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#region-instance_method" title="#region (instance method)">- (String) <strong>region</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>The default region.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#stats-instance_method" title="#stats (instance method)">- (Object) <strong>stats</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute stats.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#Stats-instance_method" title="#Stats (instance method)">- (StatsModule) <strong>Stats</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>module to call the stats api.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#summoner-instance_method" title="#summoner (instance method)">- (SummonerModule) <strong>summoner</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Module to call the summoners api.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#Team-instance_method" title="#Team (instance method)">- (TeamModule) <strong>Team</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>module to call the team api.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#team-instance_method" title="#team (instance method)">- (Object) <strong>team</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute team.</p>
</div></span>
</li>
</ul>
<h2>
Instance Method Summary
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">- (Sightstone) <strong>initialize</strong>(api_key, region = &#39;euw&#39;) </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>A new instance of Sightstone.</p>
</div></span>
</li>
</ul>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
- (<tt><span class='object_link'><a href="" title="Sightstone (class)">Sightstone</a></span></tt>) <strong>initialize</strong>(api_key, region = &#39;euw&#39;)
</h3><div class="docstring">
<div class="discussion">
<p>Returns a new instance of Sightstone</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>api_key</span>
<span class='type'>(<tt>String</tt>)</span>
&mdash;
<div class='inline'>
<p>Riot developer api key</p>
</div>
</li>
<li>
<span class='name'>region</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;euw&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>The default region to be used. See riots dev. page for supported regions.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
27
28
29
30
31
32
33
34
35
36
37</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sightstone.rb', line 27</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_api_key'>api_key</span><span class='comma'>,</span> <span class='id identifier rubyid_region'>region</span><span class='op'>=</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>euw</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
<span class='ivar'>@api_key</span> <span class='op'>=</span> <span class='id identifier rubyid_api_key'>api_key</span>
<span class='ivar'>@region</span> <span class='op'>=</span> <span class='id identifier rubyid_region'>region</span>
<span class='ivar'>@summoner</span> <span class='op'>=</span> <span class='const'>SummonerModule</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='kw'>self</span><span class='rparen'>)</span>
<span class='ivar'>@champion</span> <span class='op'>=</span> <span class='const'>ChampionModule</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='kw'>self</span><span class='rparen'>)</span>
<span class='ivar'>@game</span> <span class='op'>=</span> <span class='const'>GameModule</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='kw'>self</span><span class='rparen'>)</span>
<span class='ivar'>@league</span> <span class='op'>=</span> <span class='const'>LeagueModule</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='kw'>self</span><span class='rparen'>)</span>
<span class='ivar'>@stats</span> <span class='op'>=</span> <span class='const'>StatsModule</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='kw'>self</span><span class='rparen'>)</span>
<span class='ivar'>@team</span> <span class='op'>=</span> <span class='const'>TeamModule</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='kw'>self</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_attr_details" class="attr_details">
<h2>Instance Attribute Details</h2>
<span id="api_key=-instance_method"></span>
<div class="method_details first">
<h3 class="signature first" id="api_key-instance_method">
- (<tt>String</tt>) <strong>api_key</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Your api key</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>)</span>
&mdash;
<div class='inline'>
<p>the current value of api_key</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
19
20
21</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sightstone.rb', line 19</span>
<span class='kw'>def</span> <span class='id identifier rubyid_api_key'>api_key</span>
<span class='ivar'>@api_key</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="champion=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="champion-instance_method">
- (<tt>Object</tt>) <strong>champion</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute champion</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
23
24
25</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sightstone.rb', line 23</span>
<span class='kw'>def</span> <span class='id identifier rubyid_champion'>champion</span>
<span class='ivar'>@champion</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="Champion=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="Champion-instance_method">
- (<tt>ChampionModule</tt>) <strong>Champion</strong>
</h3><div class="docstring">
<div class="discussion">
<p>module to call the champion api</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>ChampionModule</tt>)</span>
&mdash;
<div class='inline'>
<p>the current value of Champion</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
19
20
21</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sightstone.rb', line 19</span>
<span class='kw'>def</span> <span class='const'>Champion</span>
<span class='ivar'>@Champion</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="game=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="game-instance_method">
- (<tt>Object</tt>) <strong>game</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute game</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
23
24
25</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sightstone.rb', line 23</span>
<span class='kw'>def</span> <span class='id identifier rubyid_game'>game</span>
<span class='ivar'>@game</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="Game=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="Game-instance_method">
- (<tt><span class='object_link'><a href="GameModule.html" title="GameModule (class)">GameModule</a></span></tt>) <strong>Game</strong>
</h3><div class="docstring">
<div class="discussion">
<p>module to call the game api</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="GameModule.html" title="GameModule (class)">GameModule</a></span></tt>)</span>
&mdash;
<div class='inline'>
<p>the current value of Game</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
19
20
21</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sightstone.rb', line 19</span>
<span class='kw'>def</span> <span class='const'>Game</span>
<span class='ivar'>@Game</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="League=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="League-instance_method">
- (<tt><span class='object_link'><a href="LeagueModule.html" title="LeagueModule (class)">LeagueModule</a></span></tt>) <strong>League</strong>
</h3><div class="docstring">
<div class="discussion">
<p>module to call the leagues api</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="LeagueModule.html" title="LeagueModule (class)">LeagueModule</a></span></tt>)</span>
&mdash;
<div class='inline'>
<p>the current value of League</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
19
20
21</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sightstone.rb', line 19</span>
<span class='kw'>def</span> <span class='const'>League</span>
<span class='ivar'>@League</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="league=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="league-instance_method">
- (<tt>Object</tt>) <strong>league</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute league</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
23
24
25</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sightstone.rb', line 23</span>
<span class='kw'>def</span> <span class='id identifier rubyid_league'>league</span>
<span class='ivar'>@league</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="region=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="region-instance_method">
- (<tt>String</tt>) <strong>region</strong>
</h3><div class="docstring">
<div class="discussion">
<p>The default region</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>)</span>
&mdash;
<div class='inline'>
<p>the current value of region</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
19
20
21</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sightstone.rb', line 19</span>
<span class='kw'>def</span> <span class='id identifier rubyid_region'>region</span>
<span class='ivar'>@region</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="stats=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="stats-instance_method">
- (<tt>Object</tt>) <strong>stats</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute stats</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
23
24
25</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sightstone.rb', line 23</span>
<span class='kw'>def</span> <span class='id identifier rubyid_stats'>stats</span>
<span class='ivar'>@stats</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="Stats=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="Stats-instance_method">
- (<tt>StatsModule</tt>) <strong>Stats</strong>
</h3><div class="docstring">
<div class="discussion">
<p>module to call the stats api</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>StatsModule</tt>)</span>
&mdash;
<div class='inline'>
<p>the current value of Stats</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
19
20
21</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sightstone.rb', line 19</span>
<span class='kw'>def</span> <span class='const'>Stats</span>
<span class='ivar'>@Stats</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="summoner=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="summoner-instance_method">
- (<tt><span class='object_link'><a href="SummonerModule.html" title="SummonerModule (class)">SummonerModule</a></span></tt>) <strong>summoner</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Module to call the summoners api</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="SummonerModule.html" title="SummonerModule (class)">SummonerModule</a></span></tt>)</span>
&mdash;
<div class='inline'>
<p>the current value of summoner</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
19
20
21</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sightstone.rb', line 19</span>
<span class='kw'>def</span> <span class='id identifier rubyid_summoner'>summoner</span>
<span class='ivar'>@summoner</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="Team=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="Team-instance_method">
- (<tt><span class='object_link'><a href="TeamModule.html" title="TeamModule (class)">TeamModule</a></span></tt>) <strong>Team</strong>
</h3><div class="docstring">
<div class="discussion">
<p>module to call the team api</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="TeamModule.html" title="TeamModule (class)">TeamModule</a></span></tt>)</span>
&mdash;
<div class='inline'>
<p>the current value of Team</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
19
20
21</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sightstone.rb', line 19</span>
<span class='kw'>def</span> <span class='const'>Team</span>
<span class='ivar'>@Team</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="team=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="team-instance_method">
- (<tt>Object</tt>) <strong>team</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute team</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
23
24
25</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sightstone.rb', line 23</span>
<span class='kw'>def</span> <span class='id identifier rubyid_team'>team</span>
<span class='ivar'>@team</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Sun Dec 15 01:56:08 2013 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.3 (ruby-2.0.0).
</div>
</body>
</html>