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

steam-condenser 1.3.7 → 1.3.8

Files changed (883) hide show

data/pkg/steam-condenser-1.3.7/doc/SteamCondenser/Community/WebApi.html ADDED Viewed

@@ -0,0 +1,1116 @@
+<!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>
+  Module: SteamCondenser::Community::WebApi
+    &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 (W)</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">WebApi</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>Module: SteamCondenser::Community::WebApi
+</h1>
+<dl class="box">
+      <dt class="r1">Includes:</dt>
+      <dd class="r1"><span class='object_link'><a href="../Logging.html" title="SteamCondenser::Logging (module)">Logging</a></span></dd>
+    <dt class="r2 last">Defined in:</dt>
+    <dd class="r2 last">lib/steam-condenser/community/web_api.rb</dd>
+</dl>
+<div class="clear"></div>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    <p>This module provides functionality for accessing Steam&#39;s Web API</p>
+<p>The Web API requires you to register a domain with your Steam account to
+acquire an API key. See <a href="http://steamcommunity.com/dev">http://steamcommunity.com/dev</a> for further details.</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>
+  <h2>Constant Summary</h2>
+    <dl class="constants">
+        <dt id="api_key-classvariable" class="">@@api_key =
+        </dt>
+        <dd><pre class="code"><span class='rubyid_nil nil kw'>nil</span>
+</pre></dd>
+        <dt id="secure-classvariable" class="">@@secure =
+        </dt>
+        <dd><pre class="code"><span class='rubyid_true true kw'>true</span>
+</pre></dd>
+    </dl>
+    <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="#api_key-class_method" title="api_key (class method)">+ (String) <strong>api_key</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Returns the Steam Web API key currently used by Steam Condenser.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#api_key%3D-class_method" title="api_key= (class method)">+ (Object) <strong>api_key=</strong>(api_key) </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Sets the Steam Web API key.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#get-class_method" title="get (class method)">+ (String) <strong>get</strong>(format, interface, method, version = 1, params = {}) </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Fetches data from Steam Web API using the specified interface, method and version.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#interfaces-class_method" title="interfaces (class method)">+ (Array&lt;Hash&gt;) <strong>interfaces</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Returns a raw list of interfaces and their methods that are available in Steam&#39;s Web API.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#json-class_method" title="json (class method)">+ (Hash&lt;Symbol, Object&gt;) <strong>json</strong>(interface, method, version = 1, params = {}) </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Fetches JSON data from Steam Web API using the specified interface, method and version.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#json%21-class_method" title="json! (class method)">+ (Hash&lt;Symbol, Object&gt;) <strong>json!</strong>(interface, method, version = 1, params = {}) </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Fetches JSON data from Steam Web API using the specified interface, method and version.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#secure%3D-class_method" title="secure= (class method)">+ (Object) <strong>secure=</strong>(secure) </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Sets whether HTTPS should be used for the communication with the Web API.</p>
+</div></span>
+</li>
+    </ul>
+  <h3 class="inherited">Methods included from <span class='object_link'><a href="../Logging.html" title="SteamCondenser::Logging (module)">Logging</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="../Logging.html#formatter%3D-class_method" title="SteamCondenser::Logging.formatter= (method)">formatter=</a></span>, <span class='object_link'><a href="../Logging.html#included-class_method" title="SteamCondenser::Logging.included (method)">included</a></span>, <span class='object_link'><a href="../Logging.html#level%3D-class_method" title="SteamCondenser::Logging.level= (method)">level=</a></span>, <span class='object_link'><a href="../Logging.html#log-instance_method" title="SteamCondenser::Logging#log (method)">#log</a></span>, <span class='object_link'><a href="../Logging.html#logdev%3D-class_method" title="SteamCondenser::Logging.logdev= (method)">logdev=</a></span></p>
+  <div id="class_method_details" class="method_details_list">
+    <h2>Class Method Details</h2>
+      <div class="method_details first">
+  <h3 class="signature first" id="api_key-class_method">
+    + (<tt>String</tt>) <strong>api_key</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the Steam Web API key currently used by Steam Condenser</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 currently active Steam Web API key</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+30
+31
+32</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/community/web_api.rb', line 30</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_api_key identifier id'>api_key</span>
+  <span class='rubyid_@@api_key ivar id'>@@api_key</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="api_key=-class_method">
+    + (<tt>Object</tt>) <strong>api_key=</strong>(api_key)
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Sets the Steam Web API key</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>api_key</span>
+        <span class='type'>(<tt>String</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The 128bit API key as a hexadecimal string that
+has to be requested from <a href="http://steamcommunity.com/dev">http://steamcommunity.com/dev</a></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/WebApi.html" title="SteamCondenser::Error::WebApi (class)">Error::WebApi</a></span></tt>)</span>
+        &mdash;
+        <div class='inline'><p>if the given API key is not a valid 128bit
+hexadecimal string</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+40
+41
+42
+43
+44
+45
+46</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/community/web_api.rb', line 40</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_api_key identifier id'>api_key</span><span class='assign token'>=</span><span class='lparen token'>(</span><span class='rubyid_api_key identifier id'>api_key</span><span class='rparen token'>)</span>
+  <span class='rubyid_unless unless kw'>unless</span> <span class='rubyid_api_key identifier id'>api_key</span><span class='dot token'>.</span><span class='rubyid_nil? fid id'>nil?</span> <span class='orop op'>||</span> <span class='rubyid_api_key identifier id'>api_key</span><span class='dot token'>.</span><span class='rubyid_match identifier id'>match</span><span class='lparen token'>(</span><span class='regexp val'>/^[0-9A-F]{32}$/</span><span class='rparen 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='colon2 op'>::</span><span class='rubyid_WebApi constant id'>WebApi</span><span class='comma token'>,</span> <span class='symbol val'>:invalid_key</span>
+  <span class='rubyid_end end kw'>end</span>
+  <span class='rubyid_@@api_key ivar id'>@@api_key</span> <span class='assign token'>=</span> <span class='rubyid_api_key identifier id'>api_key</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="get-class_method">
+    + (<tt>String</tt>) <strong>get</strong>(format, interface, method, version = 1, params = {})
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Fetches data from Steam Web API using the specified interface, method and
+version. Additional parameters are supplied via HTTP GET. Data is
+returned as a string in the given format.</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>format</span>
+        <span class='type'>(<tt>Symbol</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The format to load from the API (<code>:json</code>, <code>:vdf</code>,
+or <code>:xml</code>)</p>
+</div>
+    </li>
+    <li>
+        <span class='name'>interface</span>
+        <span class='type'>(<tt>String</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The Web API interface to call, e.g.
+<code>ISteamUser</code></p>
+</div>
+    </li>
+    <li>
+        <span class='name'>method</span>
+        <span class='type'>(<tt>String</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The Web API method to call, e.g.
+<code>GetPlayerSummaries</code></p>
+</div>
+    </li>
+    <li>
+        <span class='name'>version</span>
+        <span class='type'>(<tt>Fixnum</tt>)</span>
+        <em class="default">(defaults to: <tt>1</tt>)</em>
+        &mdash;
+        <div class='inline'><p>The API method version to use</p>
+</div>
+    </li>
+    <li>
+        <span class='name'>params</span>
+        <span class='type'>(<tt>Hash&lt;Symbol, Object&gt;</tt>)</span>
+        <em class="default">(defaults to: <tt>{}</tt>)</em>
+        &mdash;
+        <div class='inline'><p>Additional parameters to supply via
+HTTP GET</p>
+</div>
+    </li>
+</ul>
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>String</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The data as replied by the Web API in the desired format</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/WebApi.html" title="SteamCondenser::Error::WebApi (class)">Error::WebApi</a></span></tt>)</span>
+        &mdash;
+        <div class='inline'><p>if the request to Steam&#39;s Web API fails</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
+137
+138
+139</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/community/web_api.rb', line 123</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_get identifier id'>get</span><span class='lparen token'>(</span><span class='rubyid_format identifier id'>format</span><span class='comma token'>,</span> <span class='rubyid_interface identifier id'>interface</span><span class='comma token'>,</span> <span class='rubyid_method identifier id'>method</span><span class='comma token'>,</span> <span class='rubyid_version identifier id'>version</span> <span class='assign token'>=</span> <span class='integer val'>1</span><span class='comma token'>,</span> <span class='rubyid_params identifier id'>params</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
+  <span class='rubyid_version identifier id'>version</span> <span class='assign token'>=</span> <span class='rubyid_version identifier id'>version</span><span class='dot token'>.</span><span class='rubyid_to_s identifier id'>to_s</span><span class='dot token'>.</span><span class='rubyid_rjust identifier id'>rjust</span><span class='lparen token'>(</span><span class='integer val'>4</span><span class='comma token'>,</span> <span class='string val'>'0'</span><span class='rparen token'>)</span>
+  <span class='rubyid_params identifier id'>params</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span> <span class='symbol val'>:format</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='rubyid_format identifier id'>format</span><span class='comma token'>,</span> <span class='symbol val'>:key</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='rubyid_WebApi constant id'>WebApi</span><span class='dot token'>.</span><span class='rubyid_api_key identifier id'>api_key</span> <span class='rbrace token'>}</span><span class='dot token'>.</span><span class='rubyid_merge identifier id'>merge</span> <span class='rubyid_params identifier id'>params</span>
+  <span class='rubyid_protocol identifier id'>protocol</span> <span class='assign token'>=</span> <span class='rubyid_@@secure ivar id'>@@secure</span> <span class='question op'>?</span> <span class='string val'>'https'</span> <span class='colon op'>:</span> <span class='string val'>'http'</span>
+  <span class='rubyid_url identifier id'>url</span> <span class='assign token'>=</span> <span class='dstring node'>&quot;#{protocol}://api.steampowered.com/#{interface}/#{method}/v#{version}/&quot;</span> <span class='plus op'>+</span>
+        <span class='string val'>'?'</span> <span class='plus op'>+</span> <span class='rubyid_params identifier id'>params</span><span class='dot token'>.</span><span class='rubyid_map identifier id'>map</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='rubyid_k identifier id'>k</span><span class='comma token'>,</span><span class='rubyid_v identifier id'>v</span><span class='bitor op'>|</span> <span class='dstring node'>&quot;#{k}=#{v}&quot;</span> <span class='rbrace token'>}</span><span class='dot token'>.</span><span class='rubyid_join identifier id'>join</span><span class='lparen token'>(</span><span class='string val'>'&amp;'</span><span class='rparen token'>)</span>
+  <span class='rubyid_begin begin kw'>begin</span>
+    <span class='rubyid_log identifier id'>log</span><span class='dot token'>.</span><span class='rubyid_debug identifier id'>debug</span> <span class='dstring node'>&quot;Querying Steam Web API: #{url.gsub(@@api_key, 'SECRET')}&quot;</span>
+    <span class='rubyid_open identifier id'>open</span><span class='lparen token'>(</span><span class='rubyid_url identifier id'>url</span><span class='comma token'>,</span> <span class='lbrace token'>{</span> <span class='string val'>'Content-Type'</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='string val'>'application/x-www-form-urlencoded'</span> <span class='comma token'>,</span><span class='symbol val'>:proxy</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='rubyid_true true kw'>true</span> <span class='rbrace token'>}</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='rubyid_read identifier id'>read</span>
+  <span class='rubyid_rescue rescue kw'>rescue</span> <span class='rubyid_OpenURI constant id'>OpenURI</span><span class='colon2 op'>::</span><span class='rubyid_HTTPError constant id'>HTTPError</span>
+    <span class='rubyid_status identifier id'>status</span> <span class='assign token'>=</span> <span class='rubyid_$! gvar id'>$!</span><span class='dot token'>.</span><span class='rubyid_io identifier id'>io</span><span class='dot token'>.</span><span class='rubyid_status identifier id'>status</span><span class='lbrack token'>[</span><span class='integer val'>0</span><span class='rbrack token'>]</span>
+    <span class='rubyid_status identifier id'>status</span> <span class='assign token'>=</span> <span class='lbrack token'>[</span><span class='rubyid_status identifier id'>status</span><span class='comma token'>,</span> <span class='string val'>''</span><span class='rbrack token'>]</span> <span class='rubyid_unless unless_mod kw'>unless</span> <span class='rubyid_status identifier id'>status</span><span class='dot token'>.</span><span class='rubyid_is_a? fid id'>is_a?</span> <span class='rubyid_Array constant id'>Array</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='colon2 op'>::</span><span class='rubyid_WebApi constant id'>WebApi</span><span class='comma token'>,</span> <span class='symbol val'>:unauthorized</span> <span class='rubyid_if if_mod kw'>if</span> <span class='rubyid_status identifier id'>status</span><span class='lbrack token'>[</span><span class='integer val'>0</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='rubyid_to_i identifier id'>to_i</span> <span class='eq op'>==</span> <span class='integer val'>401</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='colon2 op'>::</span><span class='rubyid_WebApi constant id'>WebApi</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span> <span class='symbol val'>:http_error</span><span class='comma token'>,</span> <span class='rubyid_status identifier id'>status</span><span class='lbrack token'>[</span><span class='integer val'>0</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='rubyid_to_i identifier id'>to_i</span><span class='comma token'>,</span> <span class='rubyid_status identifier id'>status</span><span class='lbrack token'>[</span><span class='integer val'>1</span><span class='rbrack token'>]</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="interfaces-class_method">
+    + (<tt>Array&lt;Hash&gt;</tt>) <strong>interfaces</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns a raw list of interfaces and their methods that are available in
+Steam&#39;s Web API</p>
+<p>This can be used for reference when accessing interfaces and methods that
+have not yet been implemented by Steam Condenser.</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Array&lt;Hash&gt;</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The list of interfaces and methods</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+62
+63
+64</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/community/web_api.rb', line 62</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_interfaces identifier id'>interfaces</span>
+  <span class='rubyid_json identifier id'>json</span><span class='lparen token'>(</span><span class='string val'>'ISteamWebAPIUtil'</span><span class='comma token'>,</span> <span class='string val'>'GetSupportedAPIList'</span><span class='rparen token'>)</span><span class='lbrack token'>[</span><span class='symbol val'>:apilist</span><span class='rbrack token'>]</span><span class='lbrack token'>[</span><span class='symbol val'>:interfaces</span><span class='rbrack token'>]</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="json-class_method">
+    + (<tt>Hash&lt;Symbol, Object&gt;</tt>) <strong>json</strong>(interface, method, version = 1, params = {})
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Fetches JSON data from Steam Web API using the specified interface,
+method and version. Additional parameters are supplied via HTTP GET.
+Data is returned as a Hash containing the JSON data.</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>interface</span>
+        <span class='type'>(<tt>String</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The Web API interface to call, e.g.
+<code>ISteamUser</code></p>
+</div>
+    </li>
+    <li>
+        <span class='name'>method</span>
+        <span class='type'>(<tt>String</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The Web API method to call, e.g.
+<code>GetPlayerSummaries</code></p>
+</div>
+    </li>
+    <li>
+        <span class='name'>version</span>
+        <span class='type'>(<tt>Fixnum</tt>)</span>
+        <em class="default">(defaults to: <tt>1</tt>)</em>
+        &mdash;
+        <div class='inline'><p>The API method version to use</p>
+</div>
+    </li>
+    <li>
+        <span class='name'>params</span>
+        <span class='type'>(<tt>Hash&lt;Symbol, Object&gt;</tt>)</span>
+        <em class="default">(defaults to: <tt>{}</tt>)</em>
+        &mdash;
+        <div class='inline'><p>Additional parameters to supply via
+HTTP GET</p>
+</div>
+    </li>
+</ul>
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Hash&lt;Symbol, Object&gt;</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The JSON data replied to the request</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/WebApi.html" title="SteamCondenser::Error::WebApi (class)">Error::WebApi</a></span></tt>)</span>
+        &mdash;
+        <div class='inline'><p>if the request to Steam&#39;s Web API fails</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+79
+80
+81
+82</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/community/web_api.rb', line 79</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_json identifier id'>json</span><span class='lparen token'>(</span><span class='rubyid_interface identifier id'>interface</span><span class='comma token'>,</span> <span class='rubyid_method identifier id'>method</span><span class='comma token'>,</span> <span class='rubyid_version identifier id'>version</span> <span class='assign token'>=</span> <span class='integer val'>1</span><span class='comma token'>,</span> <span class='rubyid_params identifier id'>params</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
+  <span class='rubyid_data identifier id'>data</span> <span class='assign token'>=</span> <span class='rubyid_get identifier id'>get</span> <span class='symbol val'>:json</span><span class='comma token'>,</span> <span class='rubyid_interface identifier id'>interface</span><span class='comma token'>,</span> <span class='rubyid_method identifier id'>method</span><span class='comma token'>,</span> <span class='rubyid_version identifier id'>version</span><span class='comma token'>,</span> <span class='rubyid_params identifier id'>params</span>
+  <span class='rubyid_MultiJson constant id'>MultiJson</span><span class='dot token'>.</span><span class='rubyid_load identifier id'>load</span><span class='lparen token'>(</span><span class='rubyid_data identifier id'>data</span><span class='comma token'>,</span> <span class='lbrace token'>{</span> <span class='symbol val'>:symbolize_keys</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='rubyid_true true kw'>true</span> <span class='rbrace token'>}</span><span class='rparen token'>)</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="json!-class_method">
+    + (<tt>Hash&lt;Symbol, Object&gt;</tt>) <strong>json!</strong>(interface, method, version = 1, params = {})
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Fetches JSON data from Steam Web API using the specified interface,
+method and version. Additional parameters are supplied via HTTP GET.
+Data is returned as a Hash containing the JSON data.</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>interface</span>
+        <span class='type'>(<tt>String</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The Web API interface to call, e.g.
+<code>ISteamUser</code></p>
+</div>
+    </li>
+    <li>
+        <span class='name'>method</span>
+        <span class='type'>(<tt>String</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The Web API method to call, e.g.
+<code>GetPlayerSummaries</code></p>
+</div>
+    </li>
+    <li>
+        <span class='name'>version</span>
+        <span class='type'>(<tt>Fixnum</tt>)</span>
+        <em class="default">(defaults to: <tt>1</tt>)</em>
+        &mdash;
+        <div class='inline'><p>The API method version to use</p>
+</div>
+    </li>
+    <li>
+        <span class='name'>params</span>
+        <span class='type'>(<tt>Hash&lt;Symbol, Object&gt;</tt>)</span>
+        <em class="default">(defaults to: <tt>{}</tt>)</em>
+        &mdash;
+        <div class='inline'><p>Additional parameters to supply via
+HTTP GET</p>
+</div>
+    </li>
+</ul>
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Hash&lt;Symbol, Object&gt;</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The JSON data replied to the request</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/WebApi.html" title="SteamCondenser::Error::WebApi (class)">Error::WebApi</a></span></tt>)</span>
+        &mdash;
+        <div class='inline'><p>if the request to Steam&#39;s Web API fails</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+97
+98
+99
+100
+101
+102
+103
+104
+105
+106</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/community/web_api.rb', line 97</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_json! fid id'>json!</span><span class='lparen token'>(</span><span class='rubyid_interface identifier id'>interface</span><span class='comma token'>,</span> <span class='rubyid_method identifier id'>method</span><span class='comma token'>,</span> <span class='rubyid_version identifier id'>version</span> <span class='assign token'>=</span> <span class='integer val'>1</span><span class='comma token'>,</span> <span class='rubyid_params identifier id'>params</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
+  <span class='rubyid_result identifier id'>result</span> <span class='assign token'>=</span> <span class='rubyid_json identifier id'>json</span><span class='lparen token'>(</span><span class='rubyid_interface identifier id'>interface</span><span class='comma token'>,</span> <span class='rubyid_method identifier id'>method</span><span class='comma token'>,</span> <span class='rubyid_version identifier id'>version</span><span class='comma token'>,</span> <span class='rubyid_params identifier id'>params</span><span class='rparen token'>)</span><span class='lbrack token'>[</span><span class='symbol val'>:result</span><span class='rbrack token'>]</span>
+  <span class='rubyid_status identifier id'>status</span> <span class='assign token'>=</span> <span class='rubyid_result identifier id'>result</span><span class='lbrack token'>[</span><span class='symbol val'>:status</span><span class='rbrack token'>]</span>
+  <span class='rubyid_if if kw'>if</span> <span class='rubyid_status identifier id'>status</span> <span class='neq op'>!=</span> <span class='integer val'>1</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='colon2 op'>::</span><span class='rubyid_WebApi constant id'>WebApi</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span> <span class='symbol val'>:status_bad</span><span class='comma token'>,</span> <span class='rubyid_status identifier id'>status</span><span class='comma token'>,</span> <span class='rubyid_result identifier id'>result</span><span class='lbrack token'>[</span><span class='symbol val'>:statusDetail</span><span class='rbrack token'>]</span>
+  <span class='rubyid_end end kw'>end</span>
+  <span class='rubyid_result identifier id'>result</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="secure=-class_method">
+    + (<tt>Object</tt>) <strong>secure=</strong>(secure)
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Sets whether HTTPS should be used for the communication with the Web API</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>secure</span>
+        <span class='type'>(<tt>Boolean</tt>)</span>
+        &mdash;
+        <div class='inline'><p>Whether to use HTTPS</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+51
+52
+53</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/community/web_api.rb', line 51</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_secure identifier id'>secure</span><span class='assign token'>=</span><span class='lparen token'>(</span><span class='rubyid_secure identifier id'>secure</span><span class='rparen token'>)</span>
+  <span class='rubyid_@@secure ivar id'>@@secure</span> <span class='assign token'>=</span> <span class='notop op'>!</span><span class='notop op'>!</span><span class='rubyid_secure identifier id'>secure</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:40 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>