RubyGems - steam-condenser - Versions diffs - 1.3.6 → 1.3.7 - Mend

steam-condenser 1.3.6 → 1.3.7

Files changed (500) hide show

data/doc/TF2GoldenWrench.html ADDED Viewed

@@ -0,0 +1,760 @@
+<!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: TF2GoldenWrench
+    &mdash; Metior — API Documentation
+</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 (T)</a> &raquo;
+    <span class="title">TF2GoldenWrench</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: TF2GoldenWrench
+</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">TF2GoldenWrench</li>
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      </dd>
+    <dt class="r2 last">Defined in:</dt>
+    <dd class="r2 last">lib/steam/community/tf2/tf2_golden_wrench.rb</dd>
+</dl>
+<div class="clear"></div>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    <p>Represents the special Team Fortress 2 item Golden Wrench. It includes the
+ID of the item, the serial number of the wrench, a reference to the SteamID
+of the owner and the date this player crafted the wrench</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Author:</p>
+<ul class="author">
+    <li>
+        <div class='inline'><p>Sebastian Staudt</p>
+</div>
+    </li>
+</ul>
+</div>
+  <h2>Constant Summary</h2>
+    <dl class="constants">
+        <dt id="golden_wrenches-classvariable" class="">@@golden_wrenches =
+        </dt>
+        <dd><pre class="code"><span class='rubyid_nil nil kw'>nil</span>
+</pre></dd>
+    </dl>
+  <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
+  <ul class="summary">
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#date-instance_method" title="#date (instance method)">- (Time) <strong>date</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'><p>Returns the date this Golden Wrench has been crafted.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#id-instance_method" title="#id (instance method)">- (Fixnum) <strong>id</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'><p>Returns the unique item ID of this Golden Wrench.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#number-instance_method" title="#number (instance method)">- (Fixnum) <strong>number</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'><p>Returns the serial number of this Golden Wrench.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#owner-instance_method" title="#owner (instance method)">- (SteamId) <strong>owner</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'><p>Returns the SteamID of the owner of this Golden Wrench.</p>
+</div></span>
+</li>
+  </ul>
+    <h2>
+      Class Method Summary
+      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
+    </h2>
+    <ul class="summary">
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#golden_wrenches-class_method" title="golden_wrenches (class method)">+ (Array&lt;GoldenWrench&gt;) <strong>golden_wrenches</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Returns all Golden Wrenches.</p>
+</div></span>
+</li>
+    </ul>
+    <h2>
+      Instance Method Summary
+      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
+    </h2>
+    <ul class="summary">
+        <li class="private ">
+  <span class="summary_signature">
+      <a href="#initialize-instance_method" title="#initialize (instance method)">- (TF2GoldenWrench) <strong>initialize</strong>(wrench_data) </a>
+  </span>
+    <span class="note title constructor">constructor</span>
+  <span class="note title private">private</span>
+    <span class="summary_desc"><div class='inline'><p>Creates a new instance of a Golden Wrench with the given data.</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="TF2GoldenWrench (class)">TF2GoldenWrench</a></span></tt>) <strong>initialize</strong>(wrench_data)  <span class="extras">(private)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Creates a new instance of a Golden Wrench with the given data</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>wrench_data</span>
+        <span class='type'>(<tt>Hash&lt;Symbol, Object&gt;</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The JSON data for this wrench</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+63
+64
+65
+66
+67
+68</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/tf2/tf2_golden_wrench.rb', line 63</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='rubyid_wrench_data identifier id'>wrench_data</span><span class='rparen token'>)</span>
+  <span class='rubyid_@date ivar id'>@date</span>   <span class='assign token'>=</span> <span class='rubyid_Time constant id'>Time</span><span class='dot token'>.</span><span class='rubyid_at identifier id'>at</span><span class='lparen token'>(</span><span class='rubyid_wrench_data identifier id'>wrench_data</span><span class='lbrack token'>[</span><span class='symbol val'>:timestamp</span><span class='rbrack token'>]</span><span class='rparen token'>)</span>
+  <span class='rubyid_@id ivar id'>@id</span>     <span class='assign token'>=</span> <span class='rubyid_wrench_data identifier id'>wrench_data</span><span class='lbrack token'>[</span><span class='symbol val'>:itemID</span><span class='rbrack token'>]</span>
+  <span class='rubyid_@number ivar id'>@number</span> <span class='assign token'>=</span> <span class='rubyid_wrench_data identifier id'>wrench_data</span><span class='lbrack token'>[</span><span class='symbol val'>:wrenchNumber</span><span class='rbrack token'>]</span>
+  <span class='rubyid_@owner ivar id'>@owner</span>  <span class='assign token'>=</span> <span class='rubyid_SteamId constant id'>SteamId</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='rubyid_wrench_data identifier id'>wrench_data</span><span class='lbrack token'>[</span><span class='symbol val'>:steamID</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='rubyid_false false kw'>false</span><span class='rparen token'>)</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+</div>
+  <div id="instance_attr_details" class="attr_details">
+    <h2>Instance Attribute Details</h2>
+      <span id=""></span>
+      <div class="method_details first">
+  <h3 class="signature first" id="date-instance_method">
+    - (<tt>Time</tt>) <strong>date</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the date this Golden Wrench has been crafted</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Time</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The crafting date of this wrench</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+21
+22
+23</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/tf2/tf2_golden_wrench.rb', line 21</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_date identifier id'>date</span>
+  <span class='rubyid_@date ivar id'>@date</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id=""></span>
+      <div class="method_details ">
+  <h3 class="signature " id="id-instance_method">
+    - (<tt>Fixnum</tt>) <strong>id</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the unique item ID of this Golden Wrench</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Fixnum</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The ID of this wrench</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+26
+27
+28</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/tf2/tf2_golden_wrench.rb', line 26</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_id identifier id'>id</span>
+  <span class='rubyid_@id ivar id'>@id</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id=""></span>
+      <div class="method_details ">
+  <h3 class="signature " id="number-instance_method">
+    - (<tt>Fixnum</tt>) <strong>number</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the serial number of this Golden Wrench</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Fixnum</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The serial of this wrench</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+31
+32
+33</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/tf2/tf2_golden_wrench.rb', line 31</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_number identifier id'>number</span>
+  <span class='rubyid_@number ivar id'>@number</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id=""></span>
+      <div class="method_details ">
+  <h3 class="signature " id="owner-instance_method">
+    - (<tt><span class='object_link'><a href="SteamId.html" title="SteamId (class)">SteamId</a></span></tt>) <strong>owner</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the SteamID of the owner of this Golden Wrench</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="SteamId.html" title="SteamId (class)">SteamId</a></span></tt>)</span>
+        &mdash;
+        <div class='inline'><p>The owner of this wrench</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+36
+37
+38</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/tf2/tf2_golden_wrench.rb', line 36</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_owner identifier id'>owner</span>
+  <span class='rubyid_@owner ivar id'>@owner</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+  </div>
+  <div id="class_method_details" class="method_details_list">
+    <h2>Class Method Details</h2>
+      <div class="method_details first">
+  <h3 class="signature first" id="golden_wrenches-class_method">
+    + (<tt>Array&lt;GoldenWrench&gt;</tt>) <strong>golden_wrenches</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns all Golden Wrenches</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Array&lt;GoldenWrench&gt;</tt>)</span>
+        &mdash;
+        <div class='inline'><p>All Golden Wrenches</p>
+</div>
+    </li>
+</ul>
+<p class="tag_title">Raises:</p>
+<ul class="raise">
+    <li>
+        <span class='type'>(<tt><span class='object_link'><a href="SteamCondenserError.html" title="SteamCondenserError (class)">SteamCondenserError</a></span></tt>)</span>
+        &mdash;
+        <div class='inline'><p>if an error occurs querying the Web API or
+the Steam Community</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+45
+46
+47
+48
+49
+50
+51
+52
+53
+54
+55
+56</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/tf2/tf2_golden_wrench.rb', line 45</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_self self kw'>self</span><span class='dot token'>.</span><span class='rubyid_golden_wrenches identifier id'>golden_wrenches</span>
+  <span class='rubyid_if if kw'>if</span> <span class='rubyid_@@golden_wrenches ivar id'>@@golden_wrenches</span><span class='dot token'>.</span><span class='rubyid_nil? fid id'>nil?</span>
+    <span class='rubyid_@@golden_wrenches ivar id'>@@golden_wrenches</span> <span class='assign token'>=</span> <span class='lbrack token'>[</span><span class='rbrack token'>]</span>
+    <span class='rubyid_data identifier id'>data</span> <span class='assign token'>=</span> <span class='rubyid_MultiJson constant id'>MultiJson</span><span class='dot token'>.</span><span class='rubyid_load identifier id'>load</span><span class='lparen token'>(</span><span class='rubyid_WebApi constant id'>WebApi</span><span class='dot token'>.</span><span class='rubyid_json identifier id'>json</span><span class='lparen token'>(</span><span class='string val'>'ITFItems_440'</span><span class='comma token'>,</span> <span class='string val'>'GetGoldenWrenches'</span><span class='comma token'>,</span> <span class='integer val'>2</span><span class='rparen token'>)</span><span class='comma token'>,</span> <span class='lbrace token'>{</span> <span class='symbol val'>:symbolize_keys</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='rubyid_true true kw'>true</span> <span class='rbrace token'>}</span><span class='rparen token'>)</span>
+    <span class='rubyid_data identifier id'>data</span><span class='lbrack token'>[</span><span class='symbol val'>:results</span><span class='rbrack token'>]</span><span class='lbrack token'>[</span><span class='symbol val'>:wrenches</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='rubyid_each identifier id'>each</span> <span class='rubyid_do do kw'>do</span> <span class='bitor op'>|</span><span class='rubyid_wrench_data identifier id'>wrench_data</span><span class='bitor op'>|</span>
+      <span class='rubyid_@@golden_wrenches ivar id'>@@golden_wrenches</span> <span class='lshft op'>&lt;&lt;</span> <span class='rubyid_TF2GoldenWrench constant id'>TF2GoldenWrench</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='rubyid_wrench_data identifier id'>wrench_data</span><span class='rparen token'>)</span>
+    <span class='rubyid_end end kw'>end</span>
+  <span class='rubyid_end end kw'>end</span>
+  <span class='rubyid_@@golden_wrenches ivar id'>@@golden_wrenches</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+  </div>
+</div>
+    <div id="footer">
+  Generated on Mon Sep  2 07:13:15 2013 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.8.7 (ruby-1.8.7).
+</div>
+  </body>
+</html>