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/SteamCondenser/Error/Timeout.html ADDED Viewed

@@ -0,0 +1,254 @@
+<!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>
+  Exception: SteamCondenser::Error::Timeout
+    &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 (T)</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="../Error.html" title="SteamCondenser::Error (class)">Error</a></span></span>
+     &raquo;
+    <span class="title">Timeout</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>Exception: SteamCondenser::Error::Timeout
+</h1>
+<dl class="box">
+    <dt class="r1">Inherits:</dt>
+    <dd class="r1">
+      <span class="inheritName"><span class='object_link'><a href="../Error.html" title="SteamCondenser::Error (class)">SteamCondenser::Error</a></span></span>
+        <ul class="fullTree">
+          <li>Object</li>
+            <li class="next">StandardError</li>
+            <li class="next"><span class='object_link'><a href="../Error.html" title="SteamCondenser::Error (class)">SteamCondenser::Error</a></span></li>
+            <li class="next">SteamCondenser::Error::Timeout</li>
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      </dd>
+    <dt class="r2 last">Defined in:</dt>
+    <dd class="r2 last">lib/steam-condenser/error/timeout.rb</dd>
+</dl>
+<div class="clear"></div>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+  <div class="note notetag">
+    <strong>Note:</strong>
+    <div class='inline'><p>SteamSocket.timeout= allows to set a custom timeout for socket
+operations</p>
+</div>
+  </div>
+<p>This error class indicates that an operation could not be finished within a
+reasonable amount of time</p>
+<p>This usually indicates that a server could not be contacted because of
+network problems.</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>Instance Attribute Summary</h2>
+  <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="../Error.html" title="SteamCondenser::Error (class)">SteamCondenser::Error</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="../Error.html#cause-instance_method" title="SteamCondenser::Error#cause (method)">#cause</a></span></p>
+    <h2>
+      Instance Method Summary
+      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
+    </h2>
+    <ul class="summary">
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#initialize-instance_method" title="#initialize (instance method)">- (Timeout) <strong>initialize</strong> </a>
+  </span>
+    <span class="note title constructor">constructor</span>
+    <span class="summary_desc"><div class='inline'><p>Creates a new <code>Error::Timeout</code> instance.</p>
+</div></span>
+</li>
+    </ul>
+  <div id="constructor_details" class="method_details_list">
+  <h2>Constructor Details</h2>
+    <div class="method_details first">
+  <h3 class="signature first" id="initialize-instance_method">
+    - (<tt><span class='object_link'><a href="" title="SteamCondenser::Error::Timeout (class)">Timeout</a></span></tt>) <strong>initialize</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Creates a new <code>Error::Timeout</code> instance</p>
+  </div>
+</div>
+<div class="tags">
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+22
+23
+24</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/error/timeout.rb', line 22</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_initialize identifier id'>initialize</span>
+  <span class='rubyid_super super kw'>super</span> <span class='string val'>'The operation timed out.'</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:45 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/SteamCondenser/Error/WebApi.html ADDED Viewed

@@ -0,0 +1,354 @@
+<!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>
+  Exception: SteamCondenser::Error::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="../Error.html" title="SteamCondenser::Error (class)">Error</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>Exception: SteamCondenser::Error::WebApi
+</h1>
+<dl class="box">
+    <dt class="r1">Inherits:</dt>
+    <dd class="r1">
+      <span class="inheritName"><span class='object_link'><a href="../Error.html" title="SteamCondenser::Error (class)">SteamCondenser::Error</a></span></span>
+        <ul class="fullTree">
+          <li>Object</li>
+            <li class="next">StandardError</li>
+            <li class="next"><span class='object_link'><a href="../Error.html" title="SteamCondenser::Error (class)">SteamCondenser::Error</a></span></li>
+            <li class="next">SteamCondenser::Error::WebApi</li>
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      </dd>
+    <dt class="r2 last">Defined in:</dt>
+    <dd class="r2 last">lib/steam-condenser/error/web_api.rb</dd>
+</dl>
+<div class="clear"></div>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    <p>This error is raised when a Steam Web API request or a related action
+fails. This can have various reasons like an invalid Web API key or a
+broken request.</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">See Also:</p>
+  <ul class="see">
+      <li><span class='object_link'><a href="" title="SteamCondenser::Error::WebApi (class)">WebApi</a></span></li>
+  </ul>
+<p class="tag_title">Author:</p>
+<ul class="author">
+    <li>
+        <div class='inline'><p>Sebastian Staudt</p>
+</div>
+    </li>
+</ul>
+</div>
+  <h2>Instance Attribute Summary</h2>
+  <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="../Error.html" title="SteamCondenser::Error (class)">SteamCondenser::Error</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="../Error.html#cause-instance_method" title="SteamCondenser::Error#cause (method)">#cause</a></span></p>
+    <h2>
+      Instance Method Summary
+      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
+    </h2>
+    <ul class="summary">
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#initialize-instance_method" title="#initialize (instance method)">- (WebApi) <strong>initialize</strong>(cause, status_code = nil, status_message = '') </a>
+  </span>
+    <span class="note title constructor">constructor</span>
+    <span class="summary_desc"><div class='inline'><p>Creates a new <code>Error::WebApi</code> with an error message according to the given <code>cause</code>.</p>
+</div></span>
+</li>
+    </ul>
+  <div id="constructor_details" class="method_details_list">
+  <h2>Constructor Details</h2>
+    <div class="method_details first">
+  <h3 class="signature first" id="initialize-instance_method">
+    - (<tt><span class='object_link'><a href="" title="SteamCondenser::Error::WebApi (class)">WebApi</a></span></tt>) <strong>initialize</strong>(cause, status_code = nil, status_message = '')
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Creates a new <code>Error::WebApi</code> with an error message according to the
+given <code>cause</code>. If this cause is <code>:status_bad</code> (which will origin from the
+Web API itself) or <code>:http_error</code> the details about this failed request
+will be taken from <code>status_code</code> and <code>status_message</code>.</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>cause</span>
+        <span class='type'>(<tt>:http_error</tt>, <tt>:invalid_key</tt>, <tt>:status_bad</tt>, <tt>:unauthorized</tt>)</span>
+        &mdash;
+        <div class='inline'><p>A
+symbolic name for the problem which caused this error:</p>
+<ul>
+<li><code>:http_error</code>: An error during the HTTP request itself will
+result in an error with this reason.</li>
+<li><code>:invalid_key</code>: This occurs when trying to set a Web API key
+that isn&#39;t valid, i.e. a 128 bit integer in a hexadecimal
+string.</li>
+<li><code>:status_bad</code>: This is caused by a successful request that fails
+for some Web API internal reason (e.g. an invalid argument).
+Details about this failed request will be taken from
+<code>status_code</code> and <code>status_message</code>.</li>
+<li><code>:unauthorized</code>: This happens when a Steam Web API request is
+rejected as unauthorized. This most likely means that you did
+not specify a valid Web API key using WebApi.api_key=. A Web
+API key can be obtained from
+<a href="http://steamcommunity.com/dev/apikey">http://steamcommunity.com/dev/apikey</a>.</li>
+</ul>
+<p>Other undefined reasons will cause a generic error message.</p>
+</div>
+    </li>
+    <li>
+        <span class='name'>status_code</span>
+        <span class='type'>(<tt>Fixnum</tt>)</span>
+        <em class="default">(defaults to: <tt>nil</tt>)</em>
+        &mdash;
+        <div class='inline'><p>The HTTP status code returned by the Web API</p>
+</div>
+    </li>
+    <li>
+        <span class='name'>status_message</span>
+        <span class='type'>(<tt>String</tt>)</span>
+        <em class="default">(defaults to: <tt>''</tt>)</em>
+        &mdash;
+        <div class='inline'><p>The status message returned in the
+response</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+45
+46
+47
+48
+49
+50
+51
+52
+53
+54
+55
+56
+57
+58
+59
+60</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/steam-condenser/error/web_api.rb', line 45</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='rubyid_cause identifier id'>cause</span><span class='comma token'>,</span> <span class='rubyid_status_code identifier id'>status_code</span> <span class='assign token'>=</span> <span class='rubyid_nil nil kw'>nil</span><span class='comma token'>,</span> <span class='rubyid_status_message identifier id'>status_message</span> <span class='assign token'>=</span> <span class='string val'>''</span><span class='rparen token'>)</span>
+  <span class='rubyid_case case kw'>case</span> <span class='rubyid_cause identifier id'>cause</span>
+    <span class='rubyid_when when kw'>when</span> <span class='symbol val'>:http_error</span> <span class='rubyid_then then kw'>then</span>
+      <span class='rubyid_message identifier id'>message</span> <span class='assign token'>=</span> <span class='dstring node'>&quot;The Web API request has failed due to an HTTP error: #{status_message} (status code: #{status_code}).&quot;</span>
+    <span class='rubyid_when when kw'>when</span> <span class='symbol val'>:invalid_key</span> <span class='rubyid_then then kw'>then</span>
+      <span class='rubyid_message identifier id'>message</span> <span class='assign token'>=</span> <span class='string val'>'This is not a valid Steam Web API key.'</span>
+    <span class='rubyid_when when kw'>when</span> <span class='symbol val'>:status_bad</span> <span class='rubyid_then then kw'>then</span>
+      <span class='rubyid_message identifier id'>message</span> <span class='assign token'>=</span> <span class='dstring node'>&quot;The Web API request failed with the following error: #{status_message} (status code: #{status_code}).&quot;</span>
+    <span class='rubyid_when when kw'>when</span> <span class='symbol val'>:unauthorized</span> <span class='rubyid_then then kw'>then</span>
+      <span class='rubyid_message identifier id'>message</span> <span class='assign token'>=</span> <span class='string val'>'Your Web API request has been rejected. You most likely did not specify a valid Web API key.'</span>
+    <span class='rubyid_else else kw'>else</span>
+      <span class='rubyid_message identifier id'>message</span> <span class='assign token'>=</span> <span class='string val'>'An unexpected error occured while executing a Web API request.'</span>
+  <span class='rubyid_end end kw'>end</span>
+  <span class='rubyid_super super kw'>super</span> <span class='rubyid_message identifier id'>message</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:45 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>