RubyGems - steam-condenser - Versions diffs - 1.3.9 → 1.3.10 - Mend

steam-condenser 1.3.9 → 1.3.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (958) hide show

data/pkg/steam-condenser-1.3.9/doc/GameStats.html ADDED

@@ -0,0 +1,1501 @@
+<!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: GameStats
+    &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">GameStats</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: GameStats
+</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">GameStats</li>
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      </dd>
+      <dt class="r2">Includes:</dt>
+      <dd class="r2"><span class='object_link'><a href="XMLData.html" title="XMLData (module)">XMLData</a></span></dd>
+    <dt class="r1 last">Defined in:</dt>
+    <dd class="r1 last">lib/steam/community/game_stats.rb</dd>
+</dl>
+<div class="clear"></div>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+<p>This class represents the game statistics for a single user and a
+specific
+game</p>
+<p>It is subclassed for individual games if the games provide special
+statistics
+that are unique to this game.</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><div id="subclasses">
+  <h2>Direct Known Subclasses</h2>
+  <p class="children"><span class='object_link'><a href="AlienSwarmStats.html" title="AlienSwarmStats (class)">AlienSwarmStats</a></span>, <span class='object_link'><a href="CSSStats.html" title="CSSStats (class)">CSSStats</a></span>, <span class='object_link'><a href="DefenseGridStats.html" title="DefenseGridStats (class)">DefenseGridStats</a></span>, <span class='object_link'><a href="DoDSStats.html" title="DoDSStats (class)">DoDSStats</a></span>, <span class='object_link'><a href="L4D2Stats.html" title="L4D2Stats (class)">L4D2Stats</a></span>, <span class='object_link'><a href="L4DStats.html" title="L4DStats (class)">L4DStats</a></span>, <span class='object_link'><a href="Portal2Stats.html" title="Portal2Stats (class)">Portal2Stats</a></span>, <span class='object_link'><a href="TF2Stats.html" title="TF2Stats (class)">TF2Stats</a></span></p>
+</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="#game-instance_method" title="#game (instance method)">- (SteamGame) <strong>game</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'>
+<p>Returns the game these stats belong to.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#hours_played-instance_method" title="#hours_played (instance method)">- (String) <strong>hours_played</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'>
+<p>Returns the number of hours this game has been played by the player.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#privacy_state-instance_method" title="#privacy_state (instance method)">- (String) <strong>privacy_state</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'>
+<p>Returns the privacy setting of the Steam ID profile.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#user-instance_method" title="#user (instance method)">- (SteamId) <strong>user</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'>
+<p>Returns the Steam ID of the player these stats belong to.</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="#base_url-class_method" title="base_url (class method)">+ (Object) <strong>base_url</strong>(user_id, game_id) </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Returns the base Steam Communtiy URL for the given player and game IDs.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#create_game_stats-class_method" title="create_game_stats (class method)">+ (GameStats) <strong>create_game_stats</strong>(steam_id, game_name) </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Creates a <code>GameStats</code> (or one of its subclasses) instance for
+the given user and game.</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="#achievements-instance_method" title="#achievements (instance method)">- (Array&lt;GameAchievement&gt;) <strong>achievements</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Returns the achievements for this stats&#39; user and game.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#achievements_done-instance_method" title="#achievements_done (instance method)">- (Fixnum) <strong>achievements_done</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Returns the number of achievements done by this player.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#achievements_percentage-instance_method" title="#achievements_percentage (instance method)">- (Float) <strong>achievements_percentage</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Returns the percentage of achievements done by this player.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#base_url-instance_method" title="#base_url (instance method)">- (String) <strong>base_url</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Returns the base Steam Communtiy URL for the stats contained in this
+object.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#initialize-instance_method" title="#initialize (instance method)">- (GameStats) <strong>initialize</strong>(user_id, game_id) </a>
+  </span>
+    <span class="note title constructor">constructor</span>
+    <span class="summary_desc"><div class='inline'>
+<p>Creates a <code>GameStats</code> object and fetches data from the Steam
+Community for the given user and game.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#public%3F-instance_method" title="#public? (instance method)">- (Boolean) <strong>public?</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Returns whether this Steam ID is publicly accessible.</p>
+</div></span>
+</li>
+    </ul>
+  <h3 class="inherited">Methods included from <span class='object_link'><a href="XMLData.html" title="XMLData (module)">XMLData</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="XMLData.html#parse-instance_method" title="XMLData#parse (method)">#parse</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="GameStats (class)">GameStats</a></span></tt>) <strong>initialize</strong>(user_id, game_id)
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Creates a <code>GameStats</code> object and fetches data from the Steam
+Community for
+the given user and game</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>user_id</span>
+        <span class='type'>(<tt>String</tt>, <tt>Fixnum</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>The custom URL or the 64bit Steam ID of the
+user</p>
+</div>
+    </li>
+    <li>
+        <span class='name'>game_id</span>
+        <span class='type'>(<tt>String</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>The application ID or friendly name of the game</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 the stats cannot be fetched</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+102
+103
+104
+105
+106
+107
+108
+109
+110
+111
+112
+113
+114
+115
+116</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/game_stats.rb', line 102</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_user_id'>user_id</span><span class='comma'>,</span> <span class='id identifier rubyid_game_id'>game_id</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_parse'>parse</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_base_url'>base_url</span><span class='lparen'>(</span><span class='id identifier rubyid_user_id'>user_id</span><span class='comma'>,</span> <span class='id identifier rubyid_game_id'>game_id</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_content'>?xml=all</span><span class='tstring_end'>&quot;</span></span>
+  <span class='ivar'>@user</span> <span class='op'>=</span> <span class='const'>SteamId</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='id identifier rubyid_user_id'>user_id</span><span class='comma'>,</span> <span class='kw'>false</span>
+  <span class='id identifier rubyid_error'>error</span> <span class='op'>=</span> <span class='ivar'>@xml_data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>error</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
+  <span class='id identifier rubyid_raise'>raise</span> <span class='const'>SteamCondenserError</span><span class='comma'>,</span> <span class='id identifier rubyid_error'>error</span> <span class='kw'>unless</span> <span class='id identifier rubyid_error'>error</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
+  <span class='ivar'>@privacy_state</span> <span class='op'>=</span> <span class='ivar'>@xml_data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>privacyState</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
+  <span class='kw'>if</span> <span class='id identifier rubyid_public?'>public?</span>
+    <span class='id identifier rubyid_app_id'>app_id</span>        <span class='op'>=</span> <span class='ivar'>@xml_data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>game</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>gameLink</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_match'>match</span><span class='lparen'>(</span><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>http:\/\/steamcommunity\.com\/+app\/+([1-9][0-9]*)</span><span class='regexp_end'>/</span></span><span class='rparen'>)</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span>
+    <span class='ivar'>@game</span>         <span class='op'>=</span> <span class='const'>SteamGame</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='id identifier rubyid_app_id'>app_id</span><span class='comma'>,</span> <span class='ivar'>@xml_data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>game</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
+    <span class='ivar'>@hours_played</span> <span class='op'>=</span> <span class='ivar'>@xml_data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>stats</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>hoursPlayed</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='kw'>unless</span> <span class='ivar'>@xml_data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>stats</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>hoursPlayed</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
+  <span class='kw'>end</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=""></span>
+      <div class="method_details first">
+  <h3 class="signature first" id="game-instance_method">
+    - (<tt><span class='object_link'><a href="SteamGame.html" title="SteamGame (class)">SteamGame</a></span></tt>) <strong>game</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns the game these stats belong to</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="SteamGame.html" title="SteamGame (class)">SteamGame</a></span></tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>The game object</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+24
+25
+26</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/game_stats.rb', line 24</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=""></span>
+      <div class="method_details ">
+  <h3 class="signature " id="hours_played-instance_method">
+    - (<tt>String</tt>) <strong>hours_played</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns the number of hours this game has been played by the player</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 number of hours this game has been played</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+29
+30
+31</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/game_stats.rb', line 29</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_hours_played'>hours_played</span>
+  <span class='ivar'>@hours_played</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id=""></span>
+      <div class="method_details ">
+  <h3 class="signature " id="privacy_state-instance_method">
+    - (<tt>String</tt>) <strong>privacy_state</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns the privacy setting of the Steam ID profile</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 privacy setting of the Steam ID</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+34
+35
+36</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/game_stats.rb', line 34</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_privacy_state'>privacy_state</span>
+  <span class='ivar'>@privacy_state</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id=""></span>
+      <div class="method_details ">
+  <h3 class="signature " id="user-instance_method">
+    - (<tt><span class='object_link'><a href="SteamId.html" title="SteamId (class)">SteamId</a></span></tt>) <strong>user</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns the Steam ID of the player these stats belong to</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 Steam ID instance of the player</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+39
+40
+41</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/game_stats.rb', line 39</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_user'>user</span>
+  <span class='ivar'>@user</span>
+<span class='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="base_url-class_method">
+    + (<tt>Object</tt>) <strong>base_url</strong>(user_id, game_id)
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns the base Steam Communtiy URL for the given player and game IDs</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>user_id</span>
+        <span class='type'>(<tt>Fixnum</tt>, <tt>String</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>The 64bit SteamID or custom URL of the user</p>
+</div>
+    </li>
+    <li>
+        <span class='name'>game_id</span>
+        <span class='type'>(<tt>Fixnum</tt>, <tt>String</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>The application ID or short name of the
+game</p>
+</div>
+    </li>
+</ul>
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'></span>
+        <div class='inline'>
+<p>The base URL used for the given stats IDs</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+47
+48
+49
+50
+51
+52
+53
+54
+55</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/game_stats.rb', line 47</span>
+<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_base_url'>base_url</span><span class='lparen'>(</span><span class='id identifier rubyid_user_id'>user_id</span><span class='comma'>,</span> <span class='id identifier rubyid_game_id'>game_id</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_game_url'>game_url</span> <span class='op'>=</span> <span class='id identifier rubyid_game_id'>game_id</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Fixnum</span><span class='rparen'>)</span> <span class='op'>?</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>appid/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_game_id'>game_id</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span> <span class='op'>:</span> <span class='id identifier rubyid_game_id'>game_id</span>
+  <span class='kw'>if</span> <span class='id identifier rubyid_user_id'>user_id</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span> <span class='const'>Fixnum</span>
+    <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>http://steamcommunity.com/profiles/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_user_id'>user_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/stats/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_game_url'>game_url</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
+  <span class='kw'>else</span>
+    <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>http://steamcommunity.com/id/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_user_id'>user_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/stats/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_game_url'>game_url</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
+  <span class='kw'>end</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="create_game_stats-class_method">
+    + (<tt><span class='object_link'><a href="" title="GameStats (class)">GameStats</a></span></tt>) <strong>create_game_stats</strong>(steam_id, game_name)
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Creates a <code>GameStats</code> (or one of its subclasses) instance for
+the given
+user and game</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>steam_id</span>
+        <span class='type'>(<tt>String</tt>, <tt>Fixnum</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>The custom URL or the 64bit Steam ID of
+the user</p>
+</div>
+    </li>
+    <li>
+        <span class='name'>game_name</span>
+        <span class='type'>(<tt>String</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>The friendly name of the game</p>
+</div>
+    </li>
+</ul>
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt><span class='object_link'><a href="" title="GameStats (class)">GameStats</a></span></tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>The game stats object for the given user and game</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+64
+65
+66
+67
+68
+69
+70
+71
+72
+73
+74
+75
+76
+77
+78
+79
+80
+81
+82
+83
+84
+85
+86
+87
+88
+89
+90
+91
+92
+93</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/game_stats.rb', line 64</span>
+<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_create_game_stats'>create_game_stats</span><span class='lparen'>(</span><span class='id identifier rubyid_steam_id'>steam_id</span><span class='comma'>,</span> <span class='id identifier rubyid_game_name'>game_name</span><span class='rparen'>)</span>
+  <span class='kw'>case</span> <span class='id identifier rubyid_game_name'>game_name</span>
+    <span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>alienswarm</span><span class='tstring_end'>&#39;</span></span>
+      <span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>steam/community/alien_swarm/alien_swarm_stats</span><span class='tstring_end'>&#39;</span></span>
+      <span class='const'>AlienSwarmStats</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_steam_id'>steam_id</span><span class='rparen'>)</span>
+    <span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>cs:s</span><span class='tstring_end'>&#39;</span></span>
+      <span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>steam/community/css/css_stats</span><span class='tstring_end'>&#39;</span></span>
+      <span class='const'>CSSStats</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_steam_id'>steam_id</span><span class='rparen'>)</span>
+    <span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>defensegrid:awakening</span><span class='tstring_end'>&#39;</span></span>
+      <span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>steam/community/defense_grid/defense_grid_stats</span><span class='tstring_end'>&#39;</span></span>
+      <span class='const'>DefenseGridStats</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_steam_id'>steam_id</span><span class='rparen'>)</span>
+    <span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>dod:s</span><span class='tstring_end'>&#39;</span></span>
+      <span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>steam/community/dods/dods_stats</span><span class='tstring_end'>&#39;</span></span>
+      <span class='const'>DoDSStats</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_steam_id'>steam_id</span><span class='rparen'>)</span>
+    <span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>l4d</span><span class='tstring_end'>&#39;</span></span>
+      <span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>steam/community/l4d/l4d_stats</span><span class='tstring_end'>&#39;</span></span>
+      <span class='const'>L4DStats</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_steam_id'>steam_id</span><span class='rparen'>)</span>
+    <span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>l4d2</span><span class='tstring_end'>&#39;</span></span>
+      <span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>steam/community/l4d/l4d2_stats</span><span class='tstring_end'>&#39;</span></span>
+      <span class='const'>L4D2Stats</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_steam_id'>steam_id</span><span class='rparen'>)</span>
+    <span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>portal2</span><span class='tstring_end'>&#39;</span></span>
+      <span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>steam/community/portal2/portal2_stats</span><span class='tstring_end'>&#39;</span></span>
+      <span class='const'>Portal2Stats</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='id identifier rubyid_steam_id'>steam_id</span>
+    <span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>tf2</span><span class='tstring_end'>&#39;</span></span>
+      <span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>steam/community/tf2/tf2_stats</span><span class='tstring_end'>&#39;</span></span>
+      <span class='const'>TF2Stats</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_steam_id'>steam_id</span><span class='rparen'>)</span>
+    <span class='kw'>else</span>
+      <span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_steam_id'>steam_id</span><span class='comma'>,</span> <span class='id identifier rubyid_game_name'>game_name</span><span class='rparen'>)</span>
+  <span class='kw'>end</span>
+<span class='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="achievements-instance_method">
+    - (<tt>Array&lt;<span class='object_link'><a href="GameAchievement.html" title="GameAchievement (class)">GameAchievement</a></span>&gt;</tt>) <strong>achievements</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns the achievements for this stats&#39; user and game</p>
+<p>If the achievements&#39; data hasn&#39;t been parsed yet, parsing is done
+now.</p>
+  </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="GameAchievement (class)">GameAchievement</a></span>&gt;</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>All achievements belonging to this game</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+123
+124
+125
+126
+127
+128
+129
+130
+131
+132
+133
+134
+135
+136</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/game_stats.rb', line 123</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_achievements'>achievements</span>
+  <span class='kw'>return</span> <span class='kw'>unless</span> <span class='id identifier rubyid_public?'>public?</span>
+  <span class='kw'>if</span> <span class='ivar'>@achievements</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
+    <span class='ivar'>@achievements</span> <span class='op'>=</span> <span class='const'>Array</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
+    <span class='ivar'>@xml_data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>achievements</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>achievement</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_achievement'>achievement</span><span class='op'>|</span>
+      <span class='ivar'>@achievements</span> <span class='op'>&lt;&lt;</span> <span class='const'>GameAchievement</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='ivar'>@user</span><span class='comma'>,</span> <span class='ivar'>@game</span><span class='comma'>,</span> <span class='id identifier rubyid_achievement'>achievement</span><span class='rparen'>)</span>
+    <span class='kw'>end</span>
+    <span class='ivar'>@achievements_done</span> <span class='op'>=</span> <span class='ivar'>@achievements</span><span class='period'>.</span><span class='id identifier rubyid_reject'>reject</span><span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_a'>a</span><span class='op'>|</span> <span class='op'>!</span><span class='id identifier rubyid_a'>a</span><span class='period'>.</span><span class='id identifier rubyid_unlocked?'>unlocked?</span> <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_size'>size</span>
+  <span class='kw'>end</span>
+  <span class='ivar'>@achievements</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="achievements_done-instance_method">
+    - (<tt>Fixnum</tt>) <strong>achievements_done</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns the number of achievements done by this player</p>
+<p>If achievements haven&#39;t been parsed yet for this player and this
+game,
+parsing is done now.</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 number of achievements completed</p>
+</div>
+    </li>
+</ul>
+  <p class="tag_title">See Also:</p>
+  <ul class="see">
+      <li><span class='object_link'><a href="#achievements-instance_method" title="GameStats#achievements (method)">#achievements</a></span></li>
+  </ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+145
+146
+147
+148</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/game_stats.rb', line 145</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_achievements_done'>achievements_done</span>
+  <span class='id identifier rubyid_achievements'>achievements</span> <span class='kw'>if</span> <span class='ivar'>@achievements_done</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
+  <span class='ivar'>@achievements_done</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="achievements_percentage-instance_method">
+    - (<tt>Float</tt>) <strong>achievements_percentage</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns the percentage of achievements done by this player</p>
+<p>If achievements haven&#39;t been parsed yet for this player and this
+game,
+parsing is done now.</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Float</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>The percentage of achievements completed</p>
+</div>
+    </li>
+</ul>
+  <p class="tag_title">See Also:</p>
+  <ul class="see">
+      <li><span class='object_link'><a href="#achievements_done-instance_method" title="GameStats#achievements_done (method)">#achievements_done</a></span></li>
+  </ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+157
+158
+159</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/game_stats.rb', line 157</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_achievements_percentage'>achievements_percentage</span>
+  <span class='id identifier rubyid_achievements_done'>achievements_done</span><span class='period'>.</span><span class='id identifier rubyid_to_f'>to_f</span> <span class='op'>/</span> <span class='ivar'>@achievements</span><span class='period'>.</span><span class='id identifier rubyid_size'>size</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="base_url-instance_method">
+    - (<tt>String</tt>) <strong>base_url</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns the base Steam Communtiy URL for the stats contained in this object</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 base URL used for queries on these stats</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+164
+165
+166</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/game_stats.rb', line 164</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_base_url'>base_url</span>
+  <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_base_url'>base_url</span> <span class='ivar'>@user</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span> <span class='ivar'>@game</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="public?-instance_method">
+    - (<tt>Boolean</tt>) <strong>public?</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns whether this Steam ID is publicly accessible</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Boolean</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p><code>true</code> if this Steam ID is publicly accessible</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+171
+172
+173</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/game_stats.rb', line 171</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_public?'>public?</span>
+  <span class='ivar'>@privacy_state</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>public</span><span class='tstring_end'>&#39;</span></span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+  </div>
+</div>
+    <div id="footer">
+  Generated on Tue Jul 22 07:10:21 2014 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>