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/WebApi.html ADDED Viewed

@@ -0,0 +1,1099 @@
+<!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: 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">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: WebApi
+</h1>
+<dl class="box">
+    <dt class="r1 last">Defined in:</dt>
+    <dd class="r1 last">lib/steam/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</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='kw'>nil</span></pre></dd>
+        <dt id="secure-classvariable" class="">@@secure =
+        </dt>
+        <dd><pre class="code"><span class='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)">+ (String) <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>
+  <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">
+26
+27
+28</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/web_api.rb', line 26</span>
+<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_api_key'>api_key</span>
+  <span class='cvar'>@@api_key</span>
+<span class='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="WebApiError.html" title="WebApiError (class)">WebApiError</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">
+36
+37
+38
+39
+40
+41
+42</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/web_api.rb', line 36</span>
+<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_api_key='>api_key=</span><span class='lparen'>(</span><span class='id identifier rubyid_api_key'>api_key</span><span class='rparen'>)</span>
+  <span class='kw'>unless</span> <span class='id identifier rubyid_api_key'>api_key</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>||</span> <span class='id identifier rubyid_api_key'>api_key</span><span class='period'>.</span><span class='id identifier rubyid_match'>match</span><span class='lparen'>(</span><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>^[0-9A-F]{32}$</span><span class='regexp_end'>/</span></span><span class='rparen'>)</span>
+    <span class='id identifier rubyid_raise'>raise</span> <span class='const'>WebApiError</span><span class='comma'>,</span> <span class='symbol'>:invalid_key</span>
+  <span class='kw'>end</span>
+  <span class='cvar'>@@api_key</span> <span class='op'>=</span> <span class='id identifier rubyid_api_key'>api_key</span>
+<span class='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="WebApiError.html" title="WebApiError (class)">WebApiError</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">
+117
+118
+119
+120
+121
+122
+123
+124
+125
+126
+127
+128
+129
+130
+131
+132
+133
+134
+135
+136
+137</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/web_api.rb', line 117</span>
+<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='id identifier rubyid_format'>format</span><span class='comma'>,</span> <span class='id identifier rubyid_interface'>interface</span><span class='comma'>,</span> <span class='id identifier rubyid_method'>method</span><span class='comma'>,</span> <span class='id identifier rubyid_version'>version</span> <span class='op'>=</span> <span class='int'>1</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_version'>version</span> <span class='op'>=</span> <span class='id identifier rubyid_version'>version</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='period'>.</span><span class='id identifier rubyid_rjust'>rjust</span><span class='lparen'>(</span><span class='int'>4</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>0</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='symbol'>:key</span> <span class='op'>=&gt;</span> <span class='const'>WebApi</span><span class='period'>.</span><span class='id identifier rubyid_api_key'>api_key</span> <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span> <span class='id identifier rubyid_params'>params</span> <span class='kw'>unless</span> <span class='const'>WebApi</span><span class='period'>.</span><span class='id identifier rubyid_api_key'>api_key</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
+  <span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='symbol'>:format</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_format'>format</span> <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span> <span class='id identifier rubyid_params'>params</span>
+  <span class='id identifier rubyid_protocol'>protocol</span> <span class='op'>=</span> <span class='cvar'>@@secure</span> <span class='op'>?</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>https</span><span class='tstring_end'>&#39;</span></span> <span class='op'>:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>http</span><span class='tstring_end'>&#39;</span></span>
+  <span class='id identifier rubyid_url'>url</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_protocol'>protocol</span><span class='embexpr_end'>}</span><span class='tstring_content'>://api.steampowered.com/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_interface'>interface</span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_method'>method</span><span class='embexpr_end'>}</span><span class='tstring_content'>/v</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_version'>version</span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='tstring_end'>&quot;</span></span> <span class='op'>+</span>
+        <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>?</span><span class='tstring_end'>&#39;</span></span> <span class='op'>+</span> <span class='id identifier rubyid_params'>params</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_k'>k</span><span class='comma'>,</span><span class='id identifier rubyid_v'>v</span><span class='op'>|</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_k'>k</span><span class='embexpr_end'>}</span><span class='tstring_content'>=</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_v'>v</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span> <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>&amp;</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
+  <span class='kw'>begin</span>
+    <span class='kw'>if</span> <span class='gvar'>$DEBUG</span>
+      <span class='id identifier rubyid_debug_url'>debug_url</span> <span class='op'>=</span> <span class='cvar'>@@api_key</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>?</span> <span class='id identifier rubyid_url'>url</span> <span class='op'>:</span> <span class='id identifier rubyid_url'>url</span><span class='period'>.</span><span class='id identifier rubyid_gsub'>gsub</span><span class='lparen'>(</span><span class='cvar'>@@api_key</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>SECRET</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
+      <span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Querying Steam Web API: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_debug_url'>debug_url</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>if</span> <span class='gvar'>$DEBUG</span>
+    <span class='kw'>end</span>
+    <span class='id identifier rubyid_open'>open</span><span class='lparen'>(</span><span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='lbrace'>{</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Content-Type</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>application/x-www-form-urlencoded</span><span class='tstring_end'>&#39;</span></span> <span class='comma'>,</span><span class='symbol'>:proxy</span> <span class='op'>=&gt;</span> <span class='kw'>true</span> <span class='rbrace'>}</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_read'>read</span>
+  <span class='kw'>rescue</span> <span class='const'>OpenURI</span><span class='op'>::</span><span class='const'>HTTPError</span>
+    <span class='id identifier rubyid_status'>status</span> <span class='op'>=</span> <span class='gvar'>$!</span><span class='period'>.</span><span class='id identifier rubyid_io'>io</span><span class='period'>.</span><span class='id identifier rubyid_status'>status</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span>
+    <span class='id identifier rubyid_status'>status</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='id identifier rubyid_status'>status</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='kw'>unless</span> <span class='id identifier rubyid_status'>status</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span> <span class='const'>Array</span>
+    <span class='id identifier rubyid_raise'>raise</span> <span class='const'>WebApiError</span><span class='comma'>,</span> <span class='symbol'>:unauthorized</span> <span class='kw'>if</span> <span class='id identifier rubyid_status'>status</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span> <span class='op'>==</span> <span class='int'>401</span>
+    <span class='id identifier rubyid_raise'>raise</span> <span class='const'>WebApiError</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='symbol'>:http_error</span><span class='comma'>,</span> <span class='id identifier rubyid_status'>status</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span><span class='comma'>,</span> <span class='id identifier rubyid_status'>status</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span>
+  <span class='kw'>end</span>
+<span class='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">
+58
+59
+60
+61</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/web_api.rb', line 58</span>
+<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_interfaces'>interfaces</span>
+  <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='id identifier rubyid_json'>json</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>ISteamWebAPIUtil</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>GetSupportedAPIList</span><span class='tstring_end'>&#39;</span></span>
+  <span class='const'>MultiJson</span><span class='period'>.</span><span class='id identifier rubyid_load'>load</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='lbrace'>{</span> <span class='symbol'>:symbolize_keys</span> <span class='op'>=&gt;</span> <span class='kw'>true</span> <span class='rbrace'>}</span><span class='rparen'>)</span><span class='lbracket'>[</span><span class='symbol'>:apilist</span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='symbol'>:interfaces</span><span class='rbracket'>]</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="json-class_method">
+    + (<tt>String</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 JSON-encoded string.</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>String</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The raw 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="WebApiError.html" title="WebApiError (class)">WebApiError</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">
+75
+76
+77</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/web_api.rb', line 75</span>
+<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_json'>json</span><span class='lparen'>(</span><span class='id identifier rubyid_interface'>interface</span><span class='comma'>,</span> <span class='id identifier rubyid_method'>method</span><span class='comma'>,</span> <span class='id identifier rubyid_version'>version</span> <span class='op'>=</span> <span class='int'>1</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_get'>get</span> <span class='symbol'>:json</span><span class='comma'>,</span> <span class='id identifier rubyid_interface'>interface</span><span class='comma'>,</span> <span class='id identifier rubyid_method'>method</span><span class='comma'>,</span> <span class='id identifier rubyid_version'>version</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span>
+<span class='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="WebApiError.html" title="WebApiError (class)">WebApiError</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">
+91
+92
+93
+94
+95
+96
+97
+98
+99
+100
+101</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/web_api.rb', line 91</span>
+<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_json!'>json!</span><span class='lparen'>(</span><span class='id identifier rubyid_interface'>interface</span><span class='comma'>,</span> <span class='id identifier rubyid_method'>method</span><span class='comma'>,</span> <span class='id identifier rubyid_version'>version</span> <span class='op'>=</span> <span class='int'>1</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='id identifier rubyid_json'>json</span> <span class='id identifier rubyid_interface'>interface</span><span class='comma'>,</span> <span class='id identifier rubyid_method'>method</span><span class='comma'>,</span> <span class='id identifier rubyid_version'>version</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span>
+  <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='const'>MultiJson</span><span class='period'>.</span><span class='id identifier rubyid_load'>load</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='lbrace'>{</span> <span class='symbol'>:symbolize_keys</span> <span class='op'>=&gt;</span> <span class='kw'>true</span> <span class='rbrace'>}</span><span class='rparen'>)</span><span class='lbracket'>[</span><span class='symbol'>:result</span><span class='rbracket'>]</span>
+  <span class='id identifier rubyid_status'>status</span> <span class='op'>=</span> <span class='id identifier rubyid_result'>result</span><span class='lbracket'>[</span><span class='symbol'>:status</span><span class='rbracket'>]</span>
+  <span class='kw'>if</span> <span class='id identifier rubyid_status'>status</span> <span class='op'>!=</span> <span class='int'>1</span>
+    <span class='id identifier rubyid_raise'>raise</span> <span class='const'>WebApiError</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='symbol'>:status_bad</span><span class='comma'>,</span> <span class='id identifier rubyid_status'>status</span><span class='comma'>,</span> <span class='id identifier rubyid_result'>result</span><span class='lbracket'>[</span><span class='symbol'>:statusDetail</span><span class='rbracket'>]</span>
+  <span class='kw'>end</span>
+  <span class='id identifier rubyid_result'>result</span>
+<span class='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">
+47
+48
+49</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam/community/web_api.rb', line 47</span>
+<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_secure='>secure=</span><span class='lparen'>(</span><span class='id identifier rubyid_secure'>secure</span><span class='rparen'>)</span>
+  <span class='cvar'>@@secure</span> <span class='op'>=</span> <span class='op'>!</span><span class='op'>!</span><span class='id identifier rubyid_secure'>secure</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+  </div>
+</div>
+    <div id="footer">
+  Generated on Sun Oct 27 11:01:17 2013 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.8.7.1 (ruby-2.0.0).
+</div>
+  </body>
+</html>