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

@@ -0,0 +1,1461 @@
+<!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::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'><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">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: SteamCondenser::Community::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">SteamCondenser::Community::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="SteamCondenser::Community::XMLData (module)">XMLData</a></span></dd>
+    <dt class="r1 last">Defined in:</dt>
+    <dd class="r1 last">lib/steam-condenser/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="SteamCondenser::Community::AlienSwarmStats (class)">AlienSwarmStats</a></span>, <span class='object_link'><a href="CSSStats.html" title="SteamCondenser::Community::CSSStats (class)">CSSStats</a></span>, <span class='object_link'><a href="DefenseGridStats.html" title="SteamCondenser::Community::DefenseGridStats (class)">DefenseGridStats</a></span>, <span class='object_link'><a href="DoDSStats.html" title="SteamCondenser::Community::DoDSStats (class)">DoDSStats</a></span>, <span class='object_link'><a href="L4D2Stats.html" title="SteamCondenser::Community::L4D2Stats (class)">L4D2Stats</a></span>, <span class='object_link'><a href="L4DStats.html" title="SteamCondenser::Community::L4DStats (class)">L4DStats</a></span>, <span class='object_link'><a href="Portal2Stats.html" title="SteamCondenser::Community::Portal2Stats (class)">Portal2Stats</a></span>, <span class='object_link'><a href="TF2Stats.html" title="SteamCondenser::Community::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="SteamCondenser::Community::XMLData (module)">XMLData</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="XMLData.html#parse-instance_method" title="SteamCondenser::Community::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="SteamCondenser::Community::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="../Error.html" title="SteamCondenser::Error (class)">Error</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">
+105
+106
+107
+108
+109
+110
+111
+112
+113
+114
+115
+116
+117
+118
+119</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/community/game_stats.rb', line 105</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_user_id identifier id'>user_id</span><span class='comma token'>,</span> <span class='rubyid_game_id identifier id'>game_id</span><span class='rparen token'>)</span>
+  <span class='rubyid_parse identifier id'>parse</span> <span class='dstring node'>&quot;#{self.class.base_url(user_id, game_id)}?xml=all&quot;</span>
+  <span class='rubyid_@user ivar id'>@user</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='rubyid_user_id identifier id'>user_id</span><span class='comma token'>,</span> <span class='rubyid_false false kw'>false</span>
+  <span class='rubyid_error identifier id'>error</span> <span class='assign token'>=</span> <span class='rubyid_@xml_data ivar id'>@xml_data</span><span class='lbrack token'>[</span><span class='string val'>'error'</span><span class='rbrack token'>]</span>
+  <span class='rubyid_raise identifier id'>raise</span> <span class='rubyid_SteamCondenser constant id'>SteamCondenser</span><span class='colon2 op'>::</span><span class='rubyid_Error constant id'>Error</span><span class='comma token'>,</span> <span class='rubyid_error identifier id'>error</span> <span class='rubyid_unless unless_mod kw'>unless</span> <span class='rubyid_error identifier id'>error</span><span class='dot token'>.</span><span class='rubyid_nil? fid id'>nil?</span>
+  <span class='rubyid_@privacy_state ivar id'>@privacy_state</span> <span class='assign token'>=</span> <span class='rubyid_@xml_data ivar id'>@xml_data</span><span class='lbrack token'>[</span><span class='string val'>'privacyState'</span><span class='rbrack token'>]</span>
+  <span class='rubyid_if if kw'>if</span> <span class='rubyid_public? fid id'>public?</span>
+    <span class='rubyid_app_id identifier id'>app_id</span>        <span class='assign token'>=</span> <span class='rubyid_@xml_data ivar id'>@xml_data</span><span class='lbrack token'>[</span><span class='string val'>'game'</span><span class='rbrack token'>]</span><span class='lbrack token'>[</span><span class='string val'>'gameLink'</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='rubyid_match identifier id'>match</span><span class='lparen token'>(</span><span class='regexp val'>/http:\/\/steamcommunity\.com\/+app\/+([1-9][0-9]*)/</span><span class='rparen token'>)</span><span class='lbrack token'>[</span><span class='integer val'>1</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='rubyid_to_i identifier id'>to_i</span>
+    <span class='rubyid_@game ivar id'>@game</span>         <span class='assign token'>=</span> <span class='rubyid_SteamGame constant id'>SteamGame</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span> <span class='rubyid_app_id identifier id'>app_id</span><span class='comma token'>,</span> <span class='rubyid_@xml_data ivar id'>@xml_data</span><span class='lbrack token'>[</span><span class='string val'>'game'</span><span class='rbrack token'>]</span>
+    <span class='rubyid_@hours_played ivar id'>@hours_played</span> <span class='assign token'>=</span> <span class='rubyid_@xml_data ivar id'>@xml_data</span><span class='lbrack token'>[</span><span class='string val'>'stats'</span><span class='rbrack token'>]</span><span class='lbrack token'>[</span><span class='string val'>'hoursPlayed'</span><span class='rbrack token'>]</span> <span class='rubyid_unless unless_mod kw'>unless</span> <span class='rubyid_@xml_data ivar id'>@xml_data</span><span class='lbrack token'>[</span><span class='string val'>'stats'</span><span class='rbrack token'>]</span><span class='lbrack token'>[</span><span class='string val'>'hoursPlayed'</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='rubyid_nil? fid id'>nil?</span>
+  <span class='rubyid_end end kw'>end</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="game-instance_method">
+    - (<tt><span class='object_link'><a href="SteamGame.html" title="SteamCondenser::Community::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="SteamCondenser::Community::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">
+26
+27
+28</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/community/game_stats.rb', line 26</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_game identifier id'>game</span>
+  <span class='rubyid_@game ivar id'>@game</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="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">
+31
+32
+33</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/community/game_stats.rb', line 31</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_hours_played identifier id'>hours_played</span>
+  <span class='rubyid_@hours_played ivar id'>@hours_played</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="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">
+36
+37
+38</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/community/game_stats.rb', line 36</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_privacy_state identifier id'>privacy_state</span>
+  <span class='rubyid_@privacy_state ivar id'>@privacy_state</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="user-instance_method">
+    - (<tt><span class='object_link'><a href="SteamId.html" title="SteamCondenser::Community::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="SteamCondenser::Community::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">
+41
+42
+43</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/community/game_stats.rb', line 41</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_user identifier id'>user</span>
+  <span class='rubyid_@user ivar id'>@user</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="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">
+50
+51
+52
+53
+54
+55
+56
+57
+58</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/community/game_stats.rb', line 50</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_base_url identifier id'>base_url</span><span class='lparen token'>(</span><span class='rubyid_user_id identifier id'>user_id</span><span class='comma token'>,</span> <span class='rubyid_game_id identifier id'>game_id</span><span class='rparen token'>)</span>
+  <span class='rubyid_game_url identifier id'>game_url</span> <span class='assign token'>=</span> <span class='rubyid_game_id identifier id'>game_id</span><span class='dot token'>.</span><span class='rubyid_is_a? fid id'>is_a?</span><span class='lparen token'>(</span><span class='rubyid_Fixnum constant id'>Fixnum</span><span class='rparen token'>)</span> <span class='question op'>?</span> <span class='dstring node'>&quot;appid/#{game_id}&quot;</span> <span class='colon op'>:</span> <span class='rubyid_game_id identifier id'>game_id</span>
+  <span class='rubyid_if if kw'>if</span> <span class='rubyid_user_id identifier id'>user_id</span><span class='dot token'>.</span><span class='rubyid_is_a? fid id'>is_a?</span> <span class='rubyid_Fixnum constant id'>Fixnum</span>
+    <span class='dstring node'>&quot;http://steamcommunity.com/profiles/#{user_id}/stats/#{game_url}&quot;</span>
+  <span class='rubyid_else else kw'>else</span>
+    <span class='dstring node'>&quot;http://steamcommunity.com/id/#{user_id}/stats/#{game_url}&quot;</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="create_game_stats-class_method">
+    + (<tt><span class='object_link'><a href="" title="SteamCondenser::Community::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="SteamCondenser::Community::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">
+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
+94
+95
+96</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/community/game_stats.rb', line 67</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_create_game_stats identifier id'>create_game_stats</span><span class='lparen token'>(</span><span class='rubyid_steam_id identifier id'>steam_id</span><span class='comma token'>,</span> <span class='rubyid_game_name identifier id'>game_name</span><span class='rparen token'>)</span>
+  <span class='rubyid_case case kw'>case</span> <span class='rubyid_game_name identifier id'>game_name</span>
+    <span class='rubyid_when when kw'>when</span> <span class='string val'>'alienswarm'</span>
+      <span class='rubyid_require identifier id'>require</span> <span class='string val'>'steam-condenser/community/alien_swarm/alien_swarm_stats'</span>
+      <span class='rubyid_AlienSwarmStats constant id'>AlienSwarmStats</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='rubyid_steam_id identifier id'>steam_id</span><span class='rparen token'>)</span>
+    <span class='rubyid_when when kw'>when</span> <span class='string val'>'cs:s'</span>
+      <span class='rubyid_require identifier id'>require</span> <span class='string val'>'steam-condenser/community/css/css_stats'</span>
+      <span class='rubyid_CSSStats constant id'>CSSStats</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='rubyid_steam_id identifier id'>steam_id</span><span class='rparen token'>)</span>
+    <span class='rubyid_when when kw'>when</span> <span class='string val'>'defensegrid:awakening'</span>
+      <span class='rubyid_require identifier id'>require</span> <span class='string val'>'steam-condenser/community/defense_grid/defense_grid_stats'</span>
+      <span class='rubyid_DefenseGridStats constant id'>DefenseGridStats</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='rubyid_steam_id identifier id'>steam_id</span><span class='rparen token'>)</span>
+    <span class='rubyid_when when kw'>when</span> <span class='string val'>'dod:s'</span>
+      <span class='rubyid_require identifier id'>require</span> <span class='string val'>'steam-condenser/community/dods/dods_stats'</span>
+      <span class='rubyid_DoDSStats constant id'>DoDSStats</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='rubyid_steam_id identifier id'>steam_id</span><span class='rparen token'>)</span>
+    <span class='rubyid_when when kw'>when</span> <span class='string val'>'l4d'</span>
+      <span class='rubyid_require identifier id'>require</span> <span class='string val'>'steam-condenser/community/l4d/l4d_stats'</span>
+      <span class='rubyid_L4DStats constant id'>L4DStats</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='rubyid_steam_id identifier id'>steam_id</span><span class='rparen token'>)</span>
+    <span class='rubyid_when when kw'>when</span> <span class='string val'>'l4d2'</span>
+      <span class='rubyid_require identifier id'>require</span> <span class='string val'>'steam-condenser/community/l4d/l4d2_stats'</span>
+      <span class='rubyid_L4D2Stats constant id'>L4D2Stats</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='rubyid_steam_id identifier id'>steam_id</span><span class='rparen token'>)</span>
+    <span class='rubyid_when when kw'>when</span> <span class='string val'>'portal2'</span>
+      <span class='rubyid_require identifier id'>require</span> <span class='string val'>'steam-condenser/community/portal2/portal2_stats'</span>
+      <span class='rubyid_Portal2Stats constant id'>Portal2Stats</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span> <span class='rubyid_steam_id identifier id'>steam_id</span>
+    <span class='rubyid_when when kw'>when</span> <span class='string val'>'tf2'</span>
+      <span class='rubyid_require identifier id'>require</span> <span class='string val'>'steam-condenser/community/tf2/tf2_stats'</span>
+      <span class='rubyid_TF2Stats constant id'>TF2Stats</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='rubyid_steam_id identifier id'>steam_id</span><span class='rparen token'>)</span>
+    <span class='rubyid_else else kw'>else</span>
+      <span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='rubyid_steam_id identifier id'>steam_id</span><span class='comma token'>,</span> <span class='rubyid_game_name identifier id'>game_name</span><span class='rparen token'>)</span>
+  <span class='rubyid_end end kw'>end</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="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>
+</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="SteamCondenser::Community::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">
+126
+127
+128
+129
+130
+131
+132
+133
+134
+135
+136
+137
+138
+139</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/community/game_stats.rb', line 126</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_achievements identifier id'>achievements</span>
+  <span class='rubyid_return return kw'>return</span> <span class='rubyid_unless unless_mod kw'>unless</span> <span class='rubyid_public? fid id'>public?</span>
+  <span class='rubyid_if if kw'>if</span> <span class='rubyid_@achievements ivar id'>@achievements</span><span class='dot token'>.</span><span class='rubyid_nil? fid id'>nil?</span>
+    <span class='rubyid_@achievements ivar id'>@achievements</span> <span class='assign token'>=</span> <span class='rubyid_Array constant id'>Array</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span>
+    <span class='rubyid_@xml_data ivar id'>@xml_data</span><span class='lbrack token'>[</span><span class='string val'>'achievements'</span><span class='rbrack token'>]</span><span class='lbrack token'>[</span><span class='string val'>'achievement'</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_achievement identifier id'>achievement</span><span class='bitor op'>|</span>
+      <span class='rubyid_@achievements ivar id'>@achievements</span> <span class='lshft op'>&lt;&lt;</span> <span class='rubyid_GameAchievement constant id'>GameAchievement</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='rubyid_@user ivar id'>@user</span><span class='comma token'>,</span> <span class='rubyid_@game ivar id'>@game</span><span class='comma token'>,</span> <span class='rubyid_achievement identifier id'>achievement</span><span class='rparen token'>)</span>
+    <span class='rubyid_end end kw'>end</span>
+    <span class='rubyid_@achievements_done ivar id'>@achievements_done</span> <span class='assign token'>=</span> <span class='rubyid_@achievements ivar id'>@achievements</span><span class='dot token'>.</span><span class='rubyid_reject identifier id'>reject</span><span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='rubyid_a identifier id'>a</span><span class='bitor op'>|</span> <span class='notop op'>!</span><span class='rubyid_a identifier id'>a</span><span class='dot token'>.</span><span class='rubyid_unlocked? fid id'>unlocked?</span> <span class='rbrace token'>}</span><span class='dot token'>.</span><span class='rubyid_size identifier id'>size</span>
+  <span class='rubyid_end end kw'>end</span>
+  <span class='rubyid_@achievements ivar id'>@achievements</span>
+<span class='rubyid_end end 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="SteamCondenser::Community::GameStats#achievements (method)">#achievements</a></span></li>
+  </ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+148
+149
+150
+151</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/community/game_stats.rb', line 148</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_achievements_done identifier id'>achievements_done</span>
+  <span class='rubyid_achievements identifier id'>achievements</span> <span class='rubyid_if if_mod kw'>if</span> <span class='rubyid_@achievements_done ivar id'>@achievements_done</span><span class='dot token'>.</span><span class='rubyid_nil? fid id'>nil?</span>
+  <span class='rubyid_@achievements_done ivar id'>@achievements_done</span>
+<span class='rubyid_end end 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="SteamCondenser::Community::GameStats#achievements_done (method)">#achievements_done</a></span></li>
+  </ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+160
+161
+162</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/community/game_stats.rb', line 160</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_achievements_percentage identifier id'>achievements_percentage</span>
+  <span class='rubyid_achievements_done identifier id'>achievements_done</span><span class='dot token'>.</span><span class='rubyid_to_f identifier id'>to_f</span> <span class='div op'>/</span> <span class='rubyid_@achievements ivar id'>@achievements</span><span class='dot token'>.</span><span class='rubyid_size identifier id'>size</span>
+<span class='rubyid_end end 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">
+168
+169
+170</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/community/game_stats.rb', line 168</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_base_url identifier id'>base_url</span>
+  <span class='rubyid_self self kw'>self</span><span class='dot token'>.</span><span class='rubyid_class identifier id'>class</span><span class='dot token'>.</span><span class='rubyid_base_url identifier id'>base_url</span> <span class='rubyid_@user ivar id'>@user</span><span class='dot token'>.</span><span class='rubyid_id identifier id'>id</span><span class='comma token'>,</span> <span class='rubyid_@game ivar id'>@game</span><span class='dot token'>.</span><span class='rubyid_id identifier id'>id</span>
+<span class='rubyid_end end 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">
+175
+176
+177</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/community/game_stats.rb', line 175</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_public? fid id'>public?</span>
+  <span class='rubyid_@privacy_state ivar id'>@privacy_state</span> <span class='eq op'>==</span> <span class='string val'>'public'</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:47:49 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>