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/SteamCondenser/Community/GameStatsSchema.html ADDED Viewed

@@ -0,0 +1,771 @@
+<!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: SteamCondenser::Community::GameStatsSchema
+    &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 (G)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../../SteamCondenser.html" title="SteamCondenser (module)">SteamCondenser</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Community.html" title="SteamCondenser::Community (module)">Community</a></span></span>
+     &raquo;
+    <span class="title">GameStatsSchema</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: SteamCondenser::Community::GameStatsSchema
+</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">SteamCondenser::Community::GameStatsSchema</li>
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      </dd>
+      <dt class="r2">Includes:</dt>
+      <dd class="r2"><span class='object_link'><a href="Cacheable.html" title="SteamCondenser::Community::Cacheable (module)">Cacheable</a></span></dd>
+    <dt class="r1 last">Defined in:</dt>
+    <dd class="r1 last">lib/steam-condenser/community/game_stats_schema.rb</dd>
+</dl>
+<div class="clear"></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="#achievements-instance_method" title="#achievements (instance method)">- (Array&lt;GameAchievement&gt;) <strong>achievements</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'></div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#app_id-instance_method" title="#app_id (instance method)">- (Object) <strong>app_id</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'><p>Returns the value of attribute app_id.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#app_name-instance_method" title="#app_name (instance method)">- (Object) <strong>app_name</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'><p>Returns the value of attribute app_name.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#app_version-instance_method" title="#app_version (instance method)">- (Object) <strong>app_version</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'><p>Returns the value of attribute app_version.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#stats_values-instance_method" title="#stats_values (instance method)">- (Object) <strong>stats_values</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'><p>Returns the value of attribute stats_values.</p>
+</div></span>
+</li>
+  </ul>
+  <h3 class="inherited">Attributes included from <span class='object_link'><a href="Cacheable.html" title="SteamCondenser::Community::Cacheable (module)">Cacheable</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="Cacheable.html#fetch_time-instance_method" title="SteamCondenser::Community::Cacheable#fetch_time (method)">#fetch_time</a></span></p>
+    <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="#fetch-instance_method" title="#fetch (instance method)">- (Object) <strong>fetch</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'></div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#initialize-instance_method" title="#initialize (instance method)">- (GameStatsSchema) <strong>initialize</strong>(app_id, fetch = true, bypass_cache = false) </a>
+  </span>
+    <span class="note title constructor">constructor</span>
+    <span class="summary_desc"><div class='inline'><p>A new instance of GameStatsSchema.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#inspect-instance_method" title="#inspect (instance method)">- (Object) <strong>inspect</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'></div></span>
+</li>
+    </ul>
+  <h3 class="inherited">Methods included from <span class='object_link'><a href="Cacheable.html" title="SteamCondenser::Community::Cacheable (module)">Cacheable</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="Cacheable.html#cache-instance_method" title="SteamCondenser::Community::Cacheable#cache (method)">#cache</a></span>, <span class='object_link'><a href="Cacheable.html#cache_id_value-instance_method" title="SteamCondenser::Community::Cacheable#cache_id_value (method)">#cache_id_value</a></span>, <span class='object_link'><a href="Cacheable.html#cache_ids-instance_method" title="SteamCondenser::Community::Cacheable#cache_ids (method)">#cache_ids</a></span>, <span class='object_link'><a href="Cacheable.html#cached_instance-instance_method" title="SteamCondenser::Community::Cacheable#cached_instance (method)">#cached_instance</a></span>, <span class='object_link'><a href="Cacheable.html#fetched%3F-instance_method" title="SteamCondenser::Community::Cacheable#fetched? (method)">#fetched?</a></span>, <span class='object_link'><a href="Cacheable.html#included-class_method" title="SteamCondenser::Community::Cacheable.included (method)">included</a></span></p>
+<div id="constructor_details" class="method_details_list">
+  <h2>Constructor Details</h2>
+    <div class="method_details first">
+  <h3 class="signature first" id="initialize-instance_method">
+    - (<tt><span class='object_link'><a href="" title="SteamCondenser::Community::GameStatsSchema (class)">GameStatsSchema</a></span></tt>) <strong>initialize</strong>(app_id, fetch = true, bypass_cache = false)
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns a new instance of GameStatsSchema</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>fetch</span>
+        <span class='type'>(<tt>Boolean</tt>)</span>
+        &mdash;
+        <div class='inline'><p>if <code>true</code> the object&#39;s data is fetched after
+creation</p>
+</div>
+    </li>
+    <li>
+        <span class='name'>bypass_cache</span>
+        <span class='type'>(<tt>Boolean</tt>)</span>
+        &mdash;
+        <div class='inline'><p>if <code>true</code> the object&#39;s data is fetched again
+even if it has been cached already</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+30
+31
+32</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/community/game_stats_schema.rb', line 30</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_app_id identifier id'>app_id</span><span class='rparen token'>)</span>
+  <span class='rubyid_@app_id ivar id'>@app_id</span> <span class='assign token'>=</span> <span class='rubyid_app_id identifier id'>app_id</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="achievements-instance_method">
+    - (<tt>Array&lt;<span class='object_link'><a href="GameAchievement.html" title="SteamCondenser::Community::GameAchievement (class)">GameAchievement</a></span>&gt;</tt>) <strong>achievements</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Array&lt;<span class='object_link'><a href="GameAchievement.html" title="SteamCondenser::Community::GameAchievement (class)">GameAchievement</a></span>&gt;</tt>)</span>
+    </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/steam-condenser/community/game_stats_schema.rb', line 19</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_achievements identifier id'>achievements</span>
+  <span class='rubyid_@achievements ivar id'>@achievements</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="app_id-instance_method">
+    - (<tt>Object</tt>) <strong>app_id</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the value of attribute app_id</p>
+  </div>
+</div>
+<div class="tags">
+</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-condenser/community/game_stats_schema.rb', line 21</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_app_id identifier id'>app_id</span>
+  <span class='rubyid_@app_id ivar id'>@app_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="app_name-instance_method">
+    - (<tt>Object</tt>) <strong>app_name</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the value of attribute app_name</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/steam-condenser/community/game_stats_schema.rb', line 23</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_app_name identifier id'>app_name</span>
+  <span class='rubyid_@app_name ivar id'>@app_name</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="app_version-instance_method">
+    - (<tt>Object</tt>) <strong>app_version</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the value of attribute app_version</p>
+  </div>
+</div>
+<div class="tags">
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+25
+26
+27</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/community/game_stats_schema.rb', line 25</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_app_version identifier id'>app_version</span>
+  <span class='rubyid_@app_version ivar id'>@app_version</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="stats_values-instance_method">
+    - (<tt>Object</tt>) <strong>stats_values</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the value of attribute stats_values</p>
+  </div>
+</div>
+<div class="tags">
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+27
+28
+29</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/community/game_stats_schema.rb', line 27</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_stats_values identifier id'>stats_values</span>
+  <span class='rubyid_@stats_values ivar id'>@stats_values</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+  </div>
+  <div id="instance_method_details" class="method_details_list">
+    <h2>Instance Method Details</h2>
+      <div class="method_details first">
+  <h3 class="signature first" id="fetch-instance_method">
+    - (<tt>Object</tt>) <strong>fetch</strong>
+</h3><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+34
+35
+36
+37
+38
+39
+40
+41
+42
+43
+44
+45
+46
+47
+48</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/community/game_stats_schema.rb', line 34</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_fetch identifier id'>fetch</span>
+  <span class='rubyid_params identifier id'>params</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span> <span class='symbol val'>:appid</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='rubyid_@app_id ivar id'>@app_id</span> <span class='rbrace token'>}</span>
+  <span class='rubyid_schema identifier id'>schema</span> <span class='assign 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'>'ISteamUserStats'</span><span class='comma token'>,</span> <span class='string val'>'GetSchemaForGame'</span><span class='comma token'>,</span> <span class='integer val'>2</span><span class='comma token'>,</span> <span class='rubyid_params identifier id'>params</span><span class='rparen token'>)</span><span class='lbrack token'>[</span><span class='symbol val'>:game</span><span class='rbrack token'>]</span>
+  <span class='rubyid_@app_name ivar id'>@app_name</span>    <span class='assign token'>=</span> <span class='rubyid_schema identifier id'>schema</span><span class='lbrack token'>[</span><span class='symbol val'>:gameName</span><span class='rbrack token'>]</span>
+  <span class='rubyid_@app_version ivar id'>@app_version</span> <span class='assign token'>=</span> <span class='rubyid_schema identifier id'>schema</span><span class='lbrack token'>[</span><span class='symbol val'>:gameVersion</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='rubyid_to_i identifier id'>to_i</span>
+  <span class='rubyid_@stats_values ivar id'>@stats_values</span> <span class='assign token'>=</span> <span class='rubyid_Hash constant id'>Hash</span><span class='lbrack token'>[</span><span class='rubyid_schema identifier id'>schema</span><span class='lbrack token'>[</span><span class='symbol val'>:availableGameStats</span><span class='rbrack token'>]</span><span class='lbrack token'>[</span><span class='symbol val'>:stats</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='rubyid_map identifier id'>map</span> <span class='rubyid_do do kw'>do</span> <span class='bitor op'>|</span><span class='rubyid_data identifier id'>data</span><span class='bitor op'>|</span>
+    <span class='lbrack token'>[</span><span class='rubyid_data identifier id'>data</span><span class='lbrack token'>[</span><span class='symbol val'>:name</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='rubyid_GameStatsValue constant id'>GameStatsValue</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='rubyid_self self kw'>self</span><span class='comma token'>,</span> <span class='rubyid_data identifier id'>data</span><span class='rparen token'>)</span><span class='rbrack token'>]</span>
+  <span class='rubyid_end end kw'>end</span><span class='rbrack token'>]</span>
+  <span class='rubyid_@achievements ivar id'>@achievements</span> <span class='assign token'>=</span> <span class='rubyid_schema identifier id'>schema</span><span class='lbrack token'>[</span><span class='symbol val'>:availableGameStats</span><span class='rbrack token'>]</span><span class='lbrack token'>[</span><span class='symbol val'>:achievements</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='rubyid_map identifier id'>map</span> <span class='rubyid_do do kw'>do</span> <span class='bitor op'>|</span><span class='rubyid_data identifier id'>data</span><span class='bitor op'>|</span>
+    <span class='rubyid_GameAchievement constant id'>GameAchievement</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span> <span class='rubyid_self self kw'>self</span><span class='comma token'>,</span> <span class='rubyid_data identifier id'>data</span>
+  <span class='rubyid_end end kw'>end</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="inspect-instance_method">
+    - (<tt>Object</tt>) <strong>inspect</strong>
+</h3><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+50
+51
+52</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/community/game_stats_schema.rb', line 50</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_inspect identifier id'>inspect</span>
+  <span class='dstring node'>&quot;#&lt;#{self.class}:#@app_id \&quot;#@app_name\&quot; (#@app_version)&gt;&quot;</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+  </div>
+</div>
+    <div id="footer">
+  Generated on Wed Aug 14 21:48:02 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>