steam-condenser 1.3.9 → 1.3.10

data/doc/GameLeaderboard.html

@@ -17,7 +17,7 @@
 <script type="text/javascript" charset="utf-8">
   hasFrames = window.top.frames.main ? true : false;
   relpath = '';
-  framesUrl = "frames.html#!" + escape(window.location.href);
+  framesUrl = "frames.html#!GameLeaderboard.html";
 </script>
 
 
@@ -1197,8 +1197,7 @@ SteamID and his/her friends.</p>
       
         &mdash;
         <div class='inline'>
-<p>if an error occurs while fetching the
-leaderboards</p>
+<p>if an error occurs while fetching the leaderboards</p>
 </div>
       
     </li>
@@ -1274,8 +1273,7 @@ leaderboards</p>
     
 <p>Returns the entry on this leaderboard for the user with the given SteamID</p>
 
-<p>raise [SteamCondenserException] if an error occurs while fetching the
-
+<p>raise [SteamCondenserException] if an error occurs while fetching the 
 leaderboard</p>
 
 
@@ -1296,8 +1294,7 @@ leaderboard</p>
       
         &mdash;
         <div class='inline'>
-<p>The 64bit SteamID or the <code>SteamId</code> object
-of the user</p>
+<p>The 64bit SteamID or the <code>SteamId</code> object of the user</p>
 </div>
       
     </li>
@@ -1395,12 +1392,10 @@ of the user</p>
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>Returns an array of entries on this leaderboard for the user with the
-given
+<p>Returns an array of entries on this leaderboard for the user with the given
 SteamID and his/her friends</p>
 
-<p>raise [SteamCondenserException] if an error occurs while fetching the
-
+<p>raise [SteamCondenserException] if an error occurs while fetching the 
 leaderboard</p>
 
 
@@ -1421,8 +1416,7 @@ leaderboard</p>
       
         &mdash;
         <div class='inline'>
-<p>The 64bit SteamID or the <code>SteamId</code> object
-of the user</p>
+<p>The 64bit SteamID or the <code>SteamId</code> object of the user</p>
 </div>
       
     </li>
@@ -1441,8 +1435,7 @@ of the user</p>
       
         &mdash;
         <div class='inline'>
-<p>The entries of the user and his/her
-friends</p>
+<p>The entries of the user and his/her friends</p>
 </div>
       
     </li>
@@ -1511,12 +1504,10 @@ friends</p>
     
 <p>Returns the entries on this leaderboard for a given rank range</p>
 
-<p>The range is inclusive and a maximum of 5001 entries can be returned in
-a
+<p>The range is inclusive and a maximum of 5001 entries can be returned in a
 single request.</p>
 
-<p>raise [SteamCondenserException] if an error occurs while fetching the
-
+<p>raise [SteamCondenserException] if an error occurs while fetching the 
 leaderboard</p>
 
 
@@ -1572,8 +1563,7 @@ leaderboard</p>
       
         &mdash;
         <div class='inline'>
-<p>The entries that match the given rank
-range</p>
+<p>The entries that match the given rank range</p>
 </div>
       
     </li>
@@ -1732,9 +1722,9 @@ range</p>
 </div>
 
     <div id="footer">
-  Generated on Tue Jul 22 07:10:30 2014 by
+  Generated on Sun Jan  4 13:06:11 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.8.7.3 (ruby-2.0.0).
+  0.8.7.6 (ruby-2.2.0).
 </div>
 
   </body>

data/doc/GameLeaderboardEntry.html

@@ -17,7 +17,7 @@
 <script type="text/javascript" charset="utf-8">
   hasFrames = window.top.frames.main ? true : false;
   relpath = '';
-  framesUrl = "frames.html#!" + escape(window.location.href);
+  framesUrl = "frames.html#!GameLeaderboardEntry.html";
 </script>
 
 
@@ -326,8 +326,7 @@
       
         &mdash;
         <div class='inline'>
-<p>The XML data of the leaderboard of
-the leaderboard entry</p>
+<p>The XML data of the leaderboard of the leaderboard entry</p>
 </div>
       
     </li>
@@ -633,9 +632,9 @@ the leaderboard entry</p>
 </div>
 
     <div id="footer">
-  Generated on Tue Jul 22 07:10:32 2014 by
+  Generated on Sun Jan  4 13:06:13 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.8.7.3 (ruby-2.0.0).
+  0.8.7.6 (ruby-2.2.0).
 </div>
 
   </body>

data/doc/GameServer.html

@@ -17,7 +17,7 @@
 <script type="text/javascript" charset="utf-8">
   hasFrames = window.top.frames.main ? true : false;
   relpath = '';
-  framesUrl = "frames.html#!" + escape(window.location.href);
+  framesUrl = "frames.html#!GameServer.html";
 </script>
 
 
@@ -95,10 +95,8 @@
 <h2>Overview</h2><div class="docstring">
   <div class="discussion">
     
-<p>This module is included by classes representing different game
-server
-implementations and provides the basic functionality to communicate
-with
+<p>This module is included by classes representing different game server
+implementations and provides the basic functionality to communicate with
 them using the common query protocol</p>
 
 
@@ -830,8 +828,7 @@ information.</p>
       
         &mdash;
         <div class='inline'>
-<p>The attributes with the corresponding values
-for this player</p>
+<p>The attributes with the corresponding values for this player</p>
 </div>
       
     </li>
@@ -932,8 +929,7 @@ for this player</p>
     
 <p>Sends the specified request to the server and handles the returned response</p>
 
-<p>Depending on the given request type this will fill the various
-data
+<p>Depending on the given request type this will fill the various data
 attributes of the server object.</p>
 
 
@@ -972,12 +968,9 @@ attributes of the server object.</p>
       
         &mdash;
         <div class='inline'>
-<p>Whether the request should be repeated,
-if the replied packet isn&#39;t
-expected. This is useful to handle
-missing challenge numbers, which will be
-automatically filled in,
-although not requested explicitly.</p>
+<p>Whether the request should be repeated, if the replied packet isn&#39;t
+expected. This is useful to handle missing challenge numbers, which will be
+automatically filled in, although not requested explicitly.</p>
 </div>
       
     </li>
@@ -996,8 +989,7 @@ although not requested explicitly.</p>
       
         &mdash;
         <div class='inline'>
-<p>if either the request type or the response
-packet is not known</p>
+<p>if either the request type or the response packet is not known</p>
 </div>
       
     </li>
@@ -1183,10 +1175,8 @@ packet is not known</p>
       
         &mdash;
         <div class='inline'>
-<p>Either an IP address, a DNS name or one of them
-combined with the port
-number. If a port number is given, e.g.
-&#39;server.example.com:27016&#39;
+<p>Either an IP address, a DNS name or one of them combined with the port
+number. If a port number is given, e.g. &#39;server.example.com:27016&#39;
 it will override the second argument.</p>
 </div>
       
@@ -1270,12 +1260,10 @@ it will override the second argument.</p>
     
 <p>Returns the last measured response time of this server</p>
 
-<p>If the latency hasn&#39;t been measured yet, it is done when calling
-this
+<p>If the latency hasn&#39;t been measured yet, it is done when calling this
 method for the first time.</p>
 
-<p>If this information is vital to you, be sure to call
-<span class='object_link'><a href="#update_ping-instance_method" title="GameServer#update_ping (method)">#update_ping</a></span>
+<p>If this information is vital to you, be sure to call <span class='object_link'><a href="#update_ping-instance_method" title="GameServer#update_ping (method)">#update_ping</a></span>
 regularly to stay up-to-date.</p>
 
 
@@ -1346,14 +1334,11 @@ regularly to stay up-to-date.</p>
     
 <p>Returns a list of players currently playing on this server</p>
 
-<p>If the players haven&#39;t been fetched yet, it is done when calling
-this
+<p>If the players haven&#39;t been fetched yet, it is done when calling this
 method for the first time.</p>
 
-<p>As the players and their scores change quite often be sure to update
-this
-list regularly by calling <span class='object_link'><a href="#update_players-instance_method" title="GameServer#update_players (method)">#update_players</a></span> if you rely on
-this
+<p>As the players and their scores change quite often be sure to update this
+list regularly by calling <span class='object_link'><a href="#update_players-instance_method" title="GameServer#update_players (method)">#update_players</a></span> if you rely on this
 information.</p>
 
 
@@ -1376,10 +1361,8 @@ information.</p>
       
         &mdash;
         <div class='inline'>
-<p>The RCON password of this server may be
-provided to gather more detailed
-information on the players, like
-STEAM_IDs.</p>
+<p>The RCON password of this server may be provided to gather more detailed
+information on the players, like STEAM_IDs.</p>
 </div>
       
     </li>
@@ -1449,8 +1432,7 @@ STEAM_IDs.</p>
     <div class="note abstract">
   <strong>This method is abstract.</strong>
   <div class='inline'>
-<p>Must be be implemented by including classes to handle the
-authentication</p>
+<p>Must be be implemented by including classes to handle the authentication</p>
 </div>
 </div>
 
@@ -1621,8 +1603,7 @@ authentication</p>
     <div class="note abstract">
   <strong>This method is abstract.</strong>
   <div class='inline'>
-<p>Must be be implemented by including classes to handle the command
-execution</p>
+<p>Must be be implemented by including classes to handle the command execution</p>
 </div>
 </div>
 
@@ -1784,18 +1765,14 @@ execution</p>
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>Returns the settings applied on the server. These settings are also
-called
+<p>Returns the settings applied on the server. These settings are also called
 rules.</p>
 
 <p>If the rules haven&#39;t been fetched yet, it is done when calling this
-method
-for the first time.</p>
+method for the first time.</p>
 
 <p>As the rules usually don&#39;t change often, there&#39;s almost no need to
-update
-this hash. But if you need to, you can achieve this by
-calling
+update this hash. But if you need to, you can achieve this by calling
 <span class='object_link'><a href="#update_rules-instance_method" title="GameServer#update_rules (method)">#update_rules</a></span>.</p>
 
 
@@ -1927,16 +1904,12 @@ calling
     
 <p>Returns a hash with basic information on the server.</p>
 
-<p>If the server information haven&#39;t been fetched yet, it is done
-when
+<p>If the server information haven&#39;t been fetched yet, it is done when
 calling this method for the first time.</p>
 
-<p>The server information usually only changes on map change and when
-players
-join or leave. As the latter changes can be monitored by
-calling
-<span class='object_link'><a href="#update_players-instance_method" title="GameServer#update_players (method)">#update_players</a></span>, there&#39;s no need to call
-<span class='object_link'><a href="#update_server_info-instance_method" title="GameServer#update_server_info (method)">#update_server_info</a></span> very
+<p>The server information usually only changes on map change and when players
+join or leave. As the latter changes can be monitored by calling
+<span class='object_link'><a href="#update_players-instance_method" title="GameServer#update_players (method)">#update_players</a></span>, there&#39;s no need to call <span class='object_link'><a href="#update_server_info-instance_method" title="GameServer#update_server_info (method)">#update_server_info</a></span> very
 often.</p>
 
 
@@ -2024,8 +1997,7 @@ often.</p>
       
         &mdash;
         <div class='inline'>
-<p>Available information about the server in a human-readable
-format</p>
+<p>Available information about the server in a human-readable format</p>
 </div>
       
     </li>
@@ -2117,14 +2089,11 @@ format</p>
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>Sends a A2S_SERVERQUERY_GETCHALLENGE request to the server and updates
-the
+<p>Sends a A2S_SERVERQUERY_GETCHALLENGE request to the server and updates the
 challenge number used to communicate with this server</p>
 
-<p>There&#39;s usually no need to call this method explicitly,
-because
-<span class='object_link'><a href="#handle_response_for_request-instance_method" title="GameServer#handle_response_for_request (method)">#handle_response_for_request</a></span> will automatically get the challenge
-number
+<p>There&#39;s usually no need to call this method explicitly, because
+<span class='object_link'><a href="#handle_response_for_request-instance_method" title="GameServer#handle_response_for_request (method)">#handle_response_for_request</a></span> will automatically get the challenge number
 when the server assigns a new one.</p>
 
 
@@ -2175,12 +2144,10 @@ when the server assigns a new one.</p>
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>Sends a A2S_INFO request to the server and measures the time needed for
-the
+<p>Sends a A2S_INFO request to the server and measures the time needed for the
 reply</p>
 
-<p>If this information is vital to you, be sure to call this method
-regularly
+<p>If this information is vital to you, be sure to call this method regularly
 to stay up-to-date.</p>
 
 
@@ -2256,13 +2223,10 @@ to stay up-to-date.</p>
   <div class="discussion">
     
 <p>Sends a A2S_PLAYERS request to the server and updates the players&#39; data
-for
-this server</p>
+for this server</p>
 
-<p>As the players and their scores change quite often be sure to update
-this
-list regularly by calling this method if you rely on this
-information.</p>
+<p>As the players and their scores change quite often be sure to update this
+list regularly by calling this method if you rely on this information.</p>
 
 
   </div>
@@ -2284,10 +2248,8 @@ information.</p>
       
         &mdash;
         <div class='inline'>
-<p>The RCON password of this server may be
-provided to gather more detailed
-information on the players, like
-STEAM_IDs.</p>
+<p>The RCON password of this server may be provided to gather more detailed
+information on the players, like STEAM_IDs.</p>
 </div>
       
     </li>
@@ -2377,13 +2339,11 @@ STEAM_IDs.</p>
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>Sends a A2S_RULES request to the server and updates the rules of
-this
+<p>Sends a A2S_RULES request to the server and updates the rules of this
 server</p>
 
 <p>As the rules usually don&#39;t change often, there&#39;s almost no need to
-update
-this hash. But if you need to, you can achieve this by calling this
+update this hash. But if you need to, you can achieve this by calling this
 method.</p>
 
 
@@ -2434,16 +2394,12 @@ method.</p>
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>Sends a A2S_INFO request to the server and updates this server&#39;s
-basic
+<p>Sends a A2S_INFO request to the server and updates this server&#39;s basic
 information</p>
 
-<p>The server information usually only changes on map change and when
-players
-join or leave. As the latter changes can be monitored by
-calling
-<span class='object_link'><a href="#update_players-instance_method" title="GameServer#update_players (method)">#update_players</a></span>, there&#39;s no need to call this method very
-often.</p>
+<p>The server information usually only changes on map change and when players
+join or leave. As the latter changes can be monitored by calling
+<span class='object_link'><a href="#update_players-instance_method" title="GameServer#update_players (method)">#update_players</a></span>, there&#39;s no need to call this method very often.</p>
 
 
   </div>
@@ -2486,9 +2442,9 @@ often.</p>
 </div>
 
     <div id="footer">
-  Generated on Tue Jul 22 07:10:16 2014 by
+  Generated on Sun Jan  4 13:05:55 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.8.7.3 (ruby-2.0.0).
+  0.8.7.6 (ruby-2.2.0).
 </div>
 
   </body>

data/doc/GameStats.html

@@ -17,7 +17,7 @@
 <script type="text/javascript" charset="utf-8">
   hasFrames = window.top.frames.main ? true : false;
   relpath = '';
-  framesUrl = "frames.html#!" + escape(window.location.href);
+  framesUrl = "frames.html#!GameStats.html";
 </script>
 
 
@@ -106,13 +106,11 @@
 <h2>Overview</h2><div class="docstring">
   <div class="discussion">
     
-<p>This class represents the game statistics for a single user and a
-specific
+<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>
+statistics that are unique to this game.</p>
 
 
   </div>
@@ -512,8 +510,7 @@ Community for the given user and game.</p>
   <div class="discussion">
     
 <p>Creates a <code>GameStats</code> object and fetches data from the Steam
-Community for
-the given user and game</p>
+Community for the given user and game</p>
 
 
   </div>
@@ -533,8 +530,7 @@ the given user and game</p>
       
         &mdash;
         <div class='inline'>
-<p>The custom URL or the 64bit Steam ID of the
-user</p>
+<p>The custom URL or the 64bit Steam ID of the user</p>
 </div>
       
     </li>
@@ -925,8 +921,7 @@ user</p>
       
         &mdash;
         <div class='inline'>
-<p>The application ID or short name of the
-game</p>
+<p>The application ID or short name of the game</p>
 </div>
       
     </li>
@@ -998,8 +993,7 @@ game</p>
   <div class="discussion">
     
 <p>Creates a <code>GameStats</code> (or one of its subclasses) instance for
-the given
-user and game</p>
+the given user and game</p>
 
 
   </div>
@@ -1019,8 +1013,7 @@ user and game</p>
       
         &mdash;
         <div class='inline'>
-<p>The custom URL or the 64bit Steam ID of
-the user</p>
+<p>The custom URL or the 64bit Steam ID of the user</p>
 </div>
       
     </li>
@@ -1241,8 +1234,7 @@ now.</p>
     
 <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,
+<p>If achievements haven&#39;t been parsed yet for this player and this game,
 parsing is done now.</p>
 
 
@@ -1313,8 +1305,7 @@ parsing is done now.</p>
     
 <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,
+<p>If achievements haven&#39;t been parsed yet for this player and this game,
 parsing is done now.</p>
 
 
@@ -1492,9 +1483,9 @@ parsing is done now.</p>
 </div>
 
     <div id="footer">
-  Generated on Tue Jul 22 07:10:21 2014 by
+  Generated on Sun Jan  4 13:06:02 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.8.7.3 (ruby-2.0.0).
+  0.8.7.6 (ruby-2.2.0).
 </div>
 
   </body>