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

steam-condenser 1.3.6 → 1.3.7

Files changed (500) hide show

data/doc/file.CHANGELOG.html ADDED Viewed

@@ -0,0 +1,368 @@
+<!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>
+  File: CHANGELOG
+    &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</a> &raquo;
+    <span class="title">File: CHANGELOG</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"><div id='filecontents'><h2>Version 1.3.7 / 2013-09-02</h2>
+<ul>
+<li>[IMPROVEMENT] Improved handling of empty RCON responses</li>
+<li>[BUGFIX] Fixed Web API calls without a key</li>
+</ul>
+<h2>Version 1.3.6 / 2013-07-23</h2>
+<ul>
+<li>[SECURITY] Use HTTPS for Web API by default</li>
+<li>[ENHANCEMENT] bzip2-ruby is optional again for compatibility with Ruby 2.0.0
+             and JRuby</li>
+<li>[ENHANCEMENT] Improved code style in various places</li>
+<li>[BUGFIX] Changed to the correct GoldSrc master server port</li>
+<li>[BUGFIX] Fixed SourceSocket not failing when it should</li>
+<li>[BUGFIX] Fixed creating SteamId instances with <code>U_</code> IDs</li>
+</ul>
+<h2>Version 1.3.5 / 2013-03-29</h2>
+<ul>
+<li>[ENHANCEMENT] Adapted game item parsing to <em>DotA 2</em> API changes</li>
+<li>[SECURITY] Strip Wep API keys from debug output</li>
+<li>[BUGFIX] Fixed creating SteamId instances with <code>STEAM_</code> IDs</li>
+</ul>
+<h2>Version 1.3.4.1 / 2013-02-13</h2>
+<ul>
+<li>[BUGFIX] Corrected gem build for version 1.3.4</li>
+</ul>
+<h2>Version 1.3.4 / 2013-02-13</h2>
+<ul>
+<li>[BUGFIX] Fixed a regression in community error handling</li>
+</ul>
+<h2>Version 1.3.3 / 2013-02-12</h2>
+<ul>
+<li>[FEATURE] Added support for game ID in server info</li>
+<li>[ENHANCEMENT] Improved error handling for XML data</li>
+<li>[ENHANCEMENT] Simplified server info packets</li>
+</ul>
+<h2>Version 1.3.2 / 2013-02-04</h2>
+<ul>
+<li>[ENHANCEMENT] Improved detection of RCON bans</li>
+</ul>
+<h2>Version 1.3.1 / 2013-01-20</h2>
+<ul>
+<li>[ENHANCEMENT] Added support for preliminary inventory items</li>
+<li>[ENHANCEMENT] Further improved RCON connection handling</li>
+<li>[BUGFIX] Do not cache failed user groups and friends</li>
+<li>[BUGFIX] Fixed errors when creating cacheable classes</li>
+</ul>
+<h2>Version 1.3.0 / 2012-12-29</h2>
+<ul>
+<li>[FEATURE] Added support for new Web API interfaces</li>
+<li>[FEATURE] Added support for new Steam ID format (&quot;[U:#:#####]&quot;)</li>
+<li>[ENHANCEMENT] Vastly improved inventories</li>
+<li>[ENHANCEMENT] Better handling of RCON edge cases</li>
+<li>[ENHANCEMENT] Improved connection handling for RCON edge cases</li>
+<li>[BUGFIX] Fixed several community parsing issues</li>
+</ul>
+<h2>Version 1.2.1 / 2012-07-21</h2>
+<ul>
+<li>[FEATURE] Support for <em>DotA 2</em> (beta) inventories</li>
+<li>[ENHANCEMENT] Improved behavior of cacheable classes</li>
+<li>[ENHANCEMENT] Workaround for game URLs with duplicate slashes</li>
+</ul>
+<h2>Version 1.2.0 / 2012-04-24</h2>
+<ul>
+<li>[FEATURE] Support for game version checks</li>
+<li>[FEATURE] Support query for all Web API interfaces</li>
+<li>[FEATURE] Check game versions using its <code>steam.inf</code> file</li>
+<li>[FEATURE] Support for new Steam profile attributes</li>
+<li>[ENHANCEMENT] Improved fetching of community groups</li>
+<li>[ENHANCEMENT] Improved unit tests</li>
+<li>[ENHANCEMENT] Cleaned up community-related code</li>
+<li>[ENHANCEMENT] Use multi_xml for parsing XML</li>
+<li>[BUGFIX] Use <code>A2S_PLAYER</code> packet to challenge game servers</li>
+<li>[BUGFIX] Fixed several URL related problems</li>
+<li>[BUGFIX] Fixed Web API not working without an API key</li>
+<li>[PERFORMACE] Optimized fetching of Steam group members</li>
+</ul>
+<h2>Version 1.1.0 / 2011-12-13</h2>
+<ul>
+<li>[FEATURE] Support for leaderboards</li>
+<li>[FEATURE] Support for <em>Team Fortress 2</em> beta stats</li>
+<li>[ENHANCEMENT] Allow use of service names instead of port numbers</li>
+<li>[BUGFIX] Fixed sending master server heartbeats</li>
+<li>[BUGFIX] Fixed check for profile links</li>
+</ul>
+<h2>Version 1.0.2 / 2011-10-24</h2>
+<ul>
+<li>[ENHANCEMENT] Added API name and description to achievements</li>
+<li>[BUGFIX] Fixed handling of empty RCON responses</li>
+<li>[BUGFIX] Fixed <code>SourceServer.master</code></li>
+<li>[BUGFIX] Fixed parsing rules with empty values</li>
+<li>[BUGFIX] Fixed server info for some Source servers</li>
+<li>[BUGFIX] Fixed Rakefile encoding for Ruby 1.9</li>
+</ul>
+<h2>Version 1.0.1 / 2011-08-23</h2>
+<ul>
+<li>[BUGFIX] Fixed several packaging problems</li>
+</ul>
+<h2>Version 1.0.0 / 2011-08-18</h2>
+<ul>
+<li>[ENHANCEMENT] Added intuitive way to get master servers</li>
+<li>[ENHANCEMENT] Added a shortcut to get stats for a SteamGame</li>
+<li>[ENHANCEMENT] Added a way to bypass master server problems</li>
+<li>[ENHANCEMENT] Updated documentation</li>
+<li>[ENHANCEMENT] Improved code style</li>
+<li>[ENHANCEMENT] Updated achievement Web API to version 2</li>
+<li>[ENHANCEMENT] Updated application news Web API to version 2</li>
+<li>[ENHANCEMENT] Use Bundler instead of Ore</li>
+<li>[ENHANCEMENT] Use multi_json instead of json</li>
+<li>[BUGFIX] Fixed author field for application news</li>
+</ul>
+<h2>Version 0.14.0 / 2011-06-01</h2>
+<ul>
+<li>[FEATURE] Support for <em>Portal 2</em> stats</li>
+<li>[ENHANCEMENT] Updated documentation</li>
+<li>[ENHANCEMENT] Use <code>IEconItems</code> Web API interfaces for inventories</li>
+<li>[BUGFIX] Fixed consecutive Source RCON requests</li>
+<li>[BUGFIX] Fixed inventory caching</li>
+</ul>
+<h2>Version 0.13.1 / 2011-04-15</h2>
+<ul>
+<li>[BUGFIX] Fixed several problems when parsing RCON <code>status</code> output</li>
+</ul>
+<h2>Version 0.13.0 / 2011-04-12</h2>
+<ul>
+<li>[FEATURE] Support for Steam&#39;s Web API</li>
+<li>[FEATURE] Support for Steam application news</li>
+<li>[FEATURE] Support for <em>Team Fortress 2</em> inventories, golden wrenches</li>
+<li>[FEATURE] Support for master server heartbeating</li>
+<li>[FEATURE] Dynamic name resolution and automatic failover for master servers</li>
+<li>[ENHANCEMENT] Improved parsing of RCON <code>status</code> output</li>
+<li>[BUGFIX] Fixed pinging game servers</li>
+<li>[BUGFIX] Fixed <code>A2S_PLAYER</code> and <code>A2S_RULES</code> packet creation</li>
+<li>[BUGFIX] Fixed regular expression for game links</li>
+<li>[PERFORMANCE] Optimized RCON queries</li>
+<li>[PERFORMANCE] Fixed timeout calculation in <code>SteamSocket</code></li>
+<li>[PERFORMANCE] Lazy load zlib for compressed packets</li>
+</ul>
+<h2>Version 0.12.0 / 2010-12-29</h2>
+<ul>
+<li>[FEATURE] Support for <em>Alien Swarm</em> stats</li>
+<li>[FEATURE] Allow customization of socket timeouts</li>
+<li>[ENHANCEMENT] Moved from Jeweler to Ore</li>
+<li>[BUGFIX] Fixed stats for games without a specific implementation</li>
+</ul>
+<h2>Version 0.11.4 / 2010-11-07</h2>
+<ul>
+<li>[BUGFIX] Fixed split packet handling</li>
+<li>[BUGFIX] Fixed compatibility with Ruby 1.9</li>
+<li>[BUGFIX] Fix for a change in <em>CS:S</em>&#39; stats XML data</li>
+</ul>
+<h2>Version 0.11.3 / 2010-10-05</h2>
+<ul>
+<li>[BUGFIX] Fix for <code>SteamId#game_stats</code></li>
+</ul>
+<h2>Version 0.11.2 / 2010-09-08</h2>
+<ul>
+<li>[ENHANCEMENT] Provide the unlock date of achievements if available</li>
+<li>[BUGFIX] Removed workaround for GoldSrc master servers</li>
+<li>[BUGFIX] Compatibility fix for <code>StringIO</code> additions</li>
+</ul>
+<h2>Version 0.11.1 / 2010-07-05</h2>
+<ul>
+<li>[BUGFIX] Fixed parsing of RCON replies</li>
+</ul>
+<h2>Version 0.11.0 / 2010-07-02</h2>
+<ul>
+<li>[FEATURE] Support for <em>Counter-Strike: Source</em> stats</li>
+<li>[ENHANCEMENT] Adapt to common Ruby code conventions</li>
+<li>[BUGFIX] Fixed timouts for unresponsive master servers</li>
+<li>[BUGFIX] Fixed querying GoldSrc master servers</li>
+</ul>
+<h2>Version 0.10.1 / 2010-04-05</h2>
+<ul>
+<li>[FEATURE] Load servers&#39; Steam IDs from <code>S2A_INFO2</code> replies</li>
+<li>[BUGFIX] Fixed fetching group members</li>
+<li>[BUGFIX] Fixed cacheable community data</li>
+<li>[BUGFIX] Fixed check for EDF in <code>S2A_INFO2</code> replies</li>
+</ul>
+<h2>Version 0.10.0 / 2010-02-24</h2>
+<ul>
+<li>[FEATURE] Support for <em>Left4Dead 2</em> stats</li>
+<li>[FEATURE] Added conversion from 64bit to <code>STEAM_</code> IDs</li>
+<li>[ENHANCEMENT] Parse XML data to get a user&#39;s games</li>
+<li>[BUGFIX] Fixed parsing of deactivated community profiles</li>
+<li>[BUGFIX] Fixed loading additional player information for Source servers</li>
+</ul>
+<h2>Version 0.9.0 / 2009-09-16</h2>
+<ul>
+<li>[FEATURE] Support loading community groups of a user</li>
+<li>[FEATURE] Support for <em>Defense Grid: The Awakening</em> stats</li>
+<li>[ENHANCEMENT] Workaround for corrupt <code>S2A_RULES</code> replies</li>
+<li>[ENHANCEMENT] Supply a <code>VERSION</code> constant</li>
+<li>[BUGFIX] Fixed gem packaging</li>
+<li>[BUGFIX] Fixed handling of really long RCON replies</li>
+<li>[BUGFIX] Improved parsing of <code>S2A_RULES</code> packets</li>
+<li>[BUGFIX] Fixed compatibility with Ruby 1.9</li>
+<li>[PERFORMANCE] Added caching to <code>SteamGroup</code> and <code>SteamId</code></li>
+</ul>
+<h2>Version 0.8.0 / 2009-06-15</h2>
+<ul>
+<li>[FEATURE] Load additional player information via RCON</li>
+<li>[FEATURE] Support for <em>Day of Defeat: Source</em> stats</li>
+<li>[FEATURE] Support for <em>Left4Dead</em> stats</li>
+<li>[FEATURE] Support loading games of a user</li>
+<li>[ENHANCEMENT] Let <code>SteamCondenserError</code> inherit from <code>StandardError</code></li>
+<li>[ENHANCEMENT] Several improvements to Steam Community features</li>
+<li>[ENHANCEMENT] Several improvements to server queries</li>
+<li>[ENHANCEMENT] Use Jeweler for packaging</li>
+<li>[BUGFIX] Fixed problems with compressed packets</li>
+<li>[BUGFIX] Fixed parsing profiles without favorite or most played games</li>
+<li>[PERFORMANCE] Optimized server queries</li>
+</ul>
+<h2>Version 0.7.0 / 2009-03-02</h2>
+<ul>
+<li>[FEATURE] Support for <em>Team Fortress 2</em> stats and achievements</li>
+<li>[FEATURE] Support for split RCON replies</li>
+<li>[FEATURE] Support for compressed query replies</li>
+<li>[ENHANCEMENT] Better support for HTLV servers</li>
+<li>[ENHANCEMENT] XML cache for <code>GameStats</code></li>
+<li>[ENHANCEMENT] Use correct packet names</li>
+<li>[BUGFIX] Fixed fetching of <code>SteamId</code> data</li>
+<li>[BUGFIX] Fixed several GoldSrc RCON problems</li>
+</ul>
+<h2>Version 0.6.0 / 2008-10-23</h2>
+<ul>
+<li>[FEATURE] Support for Steam Community profiles</li>
+<li>[FEATURE] Support for game statistics</li>
+<li>[FEATURE] Support for RCON</li>
+</ul>
+<h2>Version 0.5.0 / 2008-08-10</h2>
+<ul>
+<li>[FEATURE] Support for GoldSrc and Source server queries</li>
+<li>[FEATURE] Support for master server queries</li>
+</ul>
+</div></div>
+    <div id="footer">
+  Generated on Mon Sep  2 07:12:46 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>

data/doc/file.CONTRIBUTING.html ADDED Viewed

@@ -0,0 +1,140 @@
+<!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>
+  File: CONTRIBUTING
+    &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</a> &raquo;
+    <span class="title">File: CONTRIBUTING</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"><div id='filecontents'><h1>Contribution Guidelines</h1>
+<p>First of all, each single contribution is appreciated, whether a typo fix,
+improved documentation, a fixed bug or a whole new feature.</p>
+<h2>Making your changes</h2>
+<ol>
+<li>Fork the repository on GitHub</li>
+<li>Create a topic branch with a descriptive name, e.g. <code>fix-issue-123</code> or
+<code>feature-x</code></li>
+<li>Make your modifications, complying with the
+<a href="#code-conventions">code conventions</a></li>
+<li>Commit small logical changes, each with a descriptive commit message.
+Please don&#39;t mix unrelated changes in a single commit.</li>
+</ol>
+<h2>Commit messages</h2>
+<p>Please format your commit messages as follows:</p>
+<pre class="code ruby"><code class="ruby"><span class='rubyid_Short constant id'>Short</span> <span class='rubyid_summary identifier id'>summary</span> <span class='rubyid_of identifier id'>of</span> <span class='rubyid_the identifier id'>the</span> <span class='rubyid_change identifier id'>change</span> <span class='lparen token'>(</span><span class='rubyid_up identifier id'>up</span> <span class='rubyid_to identifier id'>to</span> <span class='integer val'>50</span> <span class='rubyid_characters identifier id'>characters</span><span class='rparen token'>)</span>
+<span class='rubyid_Optionally constant id'>Optionally</span> <span class='rubyid_add identifier id'>add</span> <span class='rubyid_a identifier id'>a</span> <span class='rubyid_more identifier id'>more</span> <span class='rubyid_extensive identifier id'>extensive</span> <span class='rubyid_description identifier id'>description</span> <span class='rubyid_of identifier id'>of</span> <span class='rubyid_your identifier id'>your</span> <span class='rubyid_change identifier id'>change</span> <span class='rubyid_after identifier id'>after</span> <span class='rubyid_a identifier id'>a</span>
+<span class='rubyid_blank identifier id'>blank</span> <span class='rubyid_line identifier id'>line</span><span class='dot token'>.</span> <span class='rubyid_Wrap constant id'>Wrap</span> <span class='rubyid_the identifier id'>the</span> <span class='rubyid_lines identifier id'>lines</span> <span class='rubyid_in in kw'>in</span> <span class='rubyid_this identifier id'>this</span> <span class='rubyid_and and kw'>and</span> <span class='rubyid_the identifier id'>the</span> <span class='rubyid_following identifier id'>following</span> <span class='rubyid_paragraphs identifier id'>paragraphs</span> <span class='rubyid_after identifier id'>after</span>
+<span class='integer val'>72</span> <span class='rubyid_characters identifier id'>characters</span><span class='dot token'>.</span>
+</code></pre>
+<h2>Submitting your changes</h2>
+<ol>
+<li>Push your changes to a topic branch in your fork of the repository.</li>
+<li><a href="https://github.com/koraktor/steam-condenser-ruby/pull/new">Submit a pull request</a> to the original repository.
+Describe your changes as short as possible, but as detailed as needed for
+others to get an overview of your modifications.</li>
+<li><em>Optionally</em>, <a href="https://github.com/koraktor/steam-condenser/issues/new">open an issue</a> in the meta-repository if your change
+might be relevant to other implementations of Steam Condenser. Please add a
+link to your pull request.</li>
+</ol>
+<h2>Code conventions</h2>
+<ul>
+<li>White spaces:
+<ul>
+<li>Indent using 2 spaces</li>
+<li>Line endings must be line feeds (\n)</li>
+<li>Add a newline at end of file</li>
+</ul></li>
+<li>Name conventions:
+<ul>
+<li><code>UpperCamelCase</code> for classes and modules</li>
+<li><code>lower_case</code> for variables and methods</li>
+<li><code>UPPER_CASE</code> for constants</li>
+</ul></li>
+</ul>
+<h2>Further information</h2>
+<ul>
+<li><a href="https://help.github.com">General GitHub documentation</a></li>
+<li><a href="https://help.github.com/send-pull-requests">GitHub pull request documentation</a></li>
+<li><a href="https://groups.google.com/group/steam-condenser">Google group</a></li>
+<li>#steam-condenser on freenode.net</li>
+</ul>
+</div></div>
+    <div id="footer">
+  Generated on Mon Sep  2 07:12:46 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>