RubyGems - rarbg - Versions diffs - 1.1.1 → 1.2.0 - Mend

rarbg 1.1.1 → 1.2.0

Files changed (43) hide show

checksums.yaml +4 -4
data/.github/CODEOWNERS +4 -0
data/.github/{ISSUE_TEMPLATE.md → ISSUE_TEMPLATE/BUG_REPORT.md} +11 -7
data/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md +18 -0
data/.github/PULL_REQUEST_TEMPLATE.md +14 -0
data/.gitignore +4 -0
data/.rspec +1 -1
data/.rubocop.yml +27 -0
data/.travis.yml +1 -0
data/CHANGELOG.md +25 -8
data/CONTRIBUTING.md +92 -0
data/Gemfile +0 -1
data/LICENSE +1 -1
data/README.md +11 -3
data/Rakefile +3 -1
data/lib/rarbg.rb +3 -3
data/lib/rarbg/api.rb +30 -29
data/lib/rarbg/categories.rb +2 -2
data/lib/rarbg/version.rb +2 -2
data/rarbg.gemspec +10 -9
data/spec/rarbg/token_spec.rb +1 -1
data/spec/spec_helper.rb +6 -0
metadata +38 -40
data/docs/RARBG.html +0 -195
data/docs/RARBG/API.html +0 -1309
data/docs/RARBG/APIError.html +0 -135
data/docs/_config.yml +0 -2
data/docs/_index.html +0 -135
data/docs/class_list.html +0 -51
data/docs/css/common.css +0 -1
data/docs/css/full_list.css +0 -58
data/docs/css/style.css +0 -496
data/docs/file.CHANGELOG.html +0 -221
data/docs/file.LICENSE.html +0 -92
data/docs/file.README.html +0 -236
data/docs/file_list.html +0 -66
data/docs/frames.html +0 -17
data/docs/index.html +0 -236
data/docs/js/app.js +0 -292
data/docs/js/full_list.js +0 -216
data/docs/js/jquery.js +0 -4
data/docs/method_list.html +0 -107
data/docs/top-level-namespace.html +0 -110

@@ -1,1309 +0,0 @@
-<!DOCTYPE html>
-<html>
-  <head>
-    <meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1.0">
-<title>
-  Class: RARBG::API
-    &mdash; Documentation by YARD 0.9.16
-</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">
-  pathId = "RARBG::API";
-  relpath = '../';
-</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 class="nav_wrap">
-      <iframe id="nav" src="../class_list.html?1"></iframe>
-      <div id="resizer"></div>
-    </div>
-    <div id="main" tabindex="-1">
-      <div id="header">
-        <div id="menu">
-    <a href="../_index.html">Index (A)</a> &raquo;
-    <span class='title'><span class='object_link'><a href="../RARBG.html" title="RARBG (module)">RARBG</a></span></span>
-     &raquo;
-    <span class="title">API</span>
-</div>
-        <div id="search">
-    <a class="full_list_link" id="class_list_link"
-        href="../class_list.html">
-        <svg width="24" height="24">
-          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
-          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
-          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
-        </svg>
-    </a>
-</div>
-        <div class="clear"></div>
-      </div>
-      <div id="content"><h1>Class: RARBG::API
-</h1>
-<div class="box_info">
-  <dl>
-    <dt>Inherits:</dt>
-    <dd>
-      <span class="inheritName">Object</span>
-        <ul class="fullTree">
-          <li>Object</li>
-            <li class="next">RARBG::API</li>
-        </ul>
-        <a href="#" class="inheritanceTree">show all</a>
-    </dd>
-  </dl>
-  <dl>
-    <dt>Defined in:</dt>
-    <dd>lib/rarbg/api.rb</dd>
-  </dl>
-</div>
-<h2>Overview</h2><div class="docstring">
-  <div class="discussion">
-<p>Base class for RARBG API.</p>
-  </div>
-</div>
-<div class="tags">
-</div>
-    <h2>
-      Constant Summary
-      <small><a href="#" class="constants_summary_toggle">collapse</a></small>
-    </h2>
-    <dl class="constants">
-        <dt id="API_ENDPOINT-constant" class="">API_ENDPOINT =
-          <div class="docstring">
-  <div class="discussion">
-<p>RARBG API endpoint.</p>
-  </div>
-</div>
-<div class="tags">
-</div>
-        </dt>
-        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>https://torrentapi.org/pubapi_v2.php</span><span class='tstring_end'>&#39;</span></span></pre></dd>
-        <dt id="APP_ID-constant" class="">APP_ID =
-          <div class="docstring">
-  <div class="discussion">
-<p>App name identifier.</p>
-  </div>
-</div>
-<div class="tags">
-</div>
-        </dt>
-        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>rarbg-rubygem</span><span class='tstring_end'>&#39;</span></span></pre></dd>
-        <dt id="TOKEN_EXPIRATION-constant" class="">TOKEN_EXPIRATION =
-          <div class="docstring">
-  <div class="discussion">
-<p>Default token expiration time.</p>
-  </div>
-</div>
-<div class="tags">
-</div>
-        </dt>
-        <dd><pre class="code"><span class='int'>800</span></pre></dd>
-        <dt id="RATE_LIMIT-constant" class="">RATE_LIMIT =
-          <div class="docstring">
-  <div class="discussion">
-<p>Default API rate limit.</p>
-  </div>
-</div>
-<div class="tags">
-</div>
-        </dt>
-        <dd><pre class="code"><span class='float'>2.1</span></pre></dd>
-    </dl>
-  <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
-  <ul class="summary">
-      <li class="public ">
-  <span class="summary_signature">
-      <a href="#conn-instance_method" title="#conn (instance method)">#<strong>conn</strong>  &#x21d2; Faraday::Connection </a>
-  </span>
-      <span class="note title readonly">readonly</span>
-    <span class="summary_desc"><div class='inline'>
-<p>The Faraday connection object.</p>
-</div></span>
-</li>
-      <li class="public ">
-  <span class="summary_signature">
-      <a href="#last_request-instance_method" title="#last_request (instance method)">#<strong>last_request</strong>  &#x21d2; Integer </a>
-  </span>
-      <span class="note title readonly">readonly</span>
-    <span class="summary_desc"><div class='inline'>
-<p>The monotonic timestamp of the last request performed.</p>
-</div></span>
-</li>
-      <li class="public ">
-  <span class="summary_signature">
-      <a href="#token-instance_method" title="#token (instance method)">#<strong>token</strong>  &#x21d2; String </a>
-  </span>
-      <span class="note title readonly">readonly</span>
-    <span class="summary_desc"><div class='inline'>
-<p>The token used for authentication.</p>
-</div></span>
-</li>
-      <li class="public ">
-  <span class="summary_signature">
-      <a href="#token_time-instance_method" title="#token_time (instance method)">#<strong>token_time</strong>  &#x21d2; Integer </a>
-  </span>
-      <span class="note title readonly">readonly</span>
-    <span class="summary_desc"><div class='inline'>
-<p>The monotonic timestamp of the token request.</p>
-</div></span>
-</li>
-  </ul>
-    <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)">#<strong>initialize</strong>  &#x21d2; API </a>
-  </span>
-    <span class="note title constructor">constructor</span>
-    <span class="summary_desc"><div class='inline'>
-<p>Initialize a new istance of <code>RARBG::API</code>.</p>
-</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#list-instance_method" title="#list (instance method)">#<strong>list</strong>(params = {})  &#x21d2; Array&lt;Hash&gt; </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>
-<p>List torrents.</p>
-</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#search-instance_method" title="#search (instance method)">#<strong>search</strong>(params = {})  &#x21d2; Array&lt;Hash&gt; </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>
-<p>Search torrents.</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">
-    #<strong>initialize</strong>  &#x21d2; <tt><span class='object_link'><a href="" title="RARBG::API (class)">API</a></span></tt>
-</h3><div class="docstring">
-  <div class="discussion">
-<p>Initialize a new istance of <code>RARBG::API</code>.</p>
-  </div>
-</div>
-<div class="tags">
-  <div class="examples">
-    <p class="tag_title">Examples:</p>
-      <pre class="example code"><code><span class='id identifier rubyid_rarbg'>rarbg</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../RARBG.html" title="RARBG (module)">RARBG</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="" title="RARBG::API (class)">API</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span></code></pre>
-  </div>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-41
-42
-43
-44
-45
-46
-47
-48
-49
-50
-51
-52
-53
-54</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/rarbg/api.rb', line 41</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span>
-  <span class='ivar'>@conn</span> <span class='op'>=</span> <span class='const'>Faraday</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='label'>url:</span> <span class='const'><span class='object_link'><a href="#API_ENDPOINT-constant" title="RARBG::API::API_ENDPOINT (constant)">API_ENDPOINT</a></span></span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_conn'>conn</span><span class='op'>|</span>
-    <span class='id identifier rubyid_conn'>conn</span><span class='period'>.</span><span class='id identifier rubyid_request'>request</span>  <span class='symbol'>:json</span>
-    <span class='id identifier rubyid_conn'>conn</span><span class='period'>.</span><span class='id identifier rubyid_response'>response</span> <span class='symbol'>:json</span>
-    <span class='id identifier rubyid_conn'>conn</span><span class='period'>.</span><span class='id identifier rubyid_response'>response</span> <span class='symbol'>:logger</span> <span class='kw'>if</span> <span class='gvar'>$VERBOSE</span>
-    <span class='id identifier rubyid_conn'>conn</span><span class='period'>.</span><span class='id identifier rubyid_adapter'>adapter</span>  <span class='const'>Faraday</span><span class='period'>.</span><span class='id identifier rubyid_default_adapter'>default_adapter</span>
-    <span class='id identifier rubyid_conn'>conn</span><span class='period'>.</span><span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_timeout'>timeout</span> <span class='op'>=</span> <span class='int'>90</span>
-    <span class='id identifier rubyid_conn'>conn</span><span class='period'>.</span><span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_open_timeout'>open_timeout</span> <span class='op'>=</span> <span class='int'>10</span>
-    <span class='id identifier rubyid_conn'>conn</span><span class='period'>.</span><span class='id identifier rubyid_headers'>headers</span><span class='lbracket'>[</span><span class='symbol'>:user_agent</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="#APP_ID-constant" title="RARBG::API::APP_ID (constant)">APP_ID</a></span></span>
-    <span class='id identifier rubyid_conn'>conn</span><span class='period'>.</span><span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:app_id</span><span class='rbracket'>]</span>      <span class='op'>=</span> <span class='const'><span class='object_link'><a href="#APP_ID-constant" title="RARBG::API::APP_ID (constant)">APP_ID</a></span></span>
-  <span class='kw'>end</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-</div>
-  <div id="instance_attr_details" class="attr_details">
-    <h2>Instance Attribute Details</h2>
-      <span id=""></span>
-      <div class="method_details first">
-  <h3 class="signature first" id="conn-instance_method">
-    #<strong>conn</strong>  &#x21d2; <tt>Faraday::Connection</tt>  <span class="extras">(readonly)</span>
-</h3><div class="docstring">
-  <div class="discussion">
-<p>Returns the Faraday connection object.</p>
-  </div>
-</div>
-<div class="tags">
-<p class="tag_title">Returns:</p>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt>Faraday::Connection</tt>)</span>
-        &mdash;
-        <div class='inline'>
-<p>the Faraday connection object.</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/rarbg/api.rb', line 26</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_conn'>conn</span>
-  <span class='ivar'>@conn</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <span id=""></span>
-      <div class="method_details ">
-  <h3 class="signature " id="last_request-instance_method">
-    #<strong>last_request</strong>  &#x21d2; <tt>Integer</tt>  <span class="extras">(readonly)</span>
-</h3><div class="docstring">
-  <div class="discussion">
-<p>Returns the monotonic timestamp of the last request performed.</p>
-  </div>
-</div>
-<div class="tags">
-<p class="tag_title">Returns:</p>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt>Integer</tt>)</span>
-        &mdash;
-        <div class='inline'>
-<p>the monotonic timestamp of the last request performed.</p>
-</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-35
-36
-37</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/rarbg/api.rb', line 35</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_last_request'>last_request</span>
-  <span class='ivar'>@last_request</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <span id=""></span>
-      <div class="method_details ">
-  <h3 class="signature " id="token-instance_method">
-    #<strong>token</strong>  &#x21d2; <tt>String</tt>  <span class="extras">(readonly)</span>
-</h3><div class="docstring">
-  <div class="discussion">
-<p>Returns the token used for authentication.</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 token used for authentication.</p>
-</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-29
-30
-31</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/rarbg/api.rb', line 29</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_token'>token</span>
-  <span class='ivar'>@token</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <span id=""></span>
-      <div class="method_details ">
-  <h3 class="signature " id="token_time-instance_method">
-    #<strong>token_time</strong>  &#x21d2; <tt>Integer</tt>  <span class="extras">(readonly)</span>
-</h3><div class="docstring">
-  <div class="discussion">
-<p>Returns the monotonic timestamp of the token request.</p>
-  </div>
-</div>
-<div class="tags">
-<p class="tag_title">Returns:</p>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt>Integer</tt>)</span>
-        &mdash;
-        <div class='inline'>
-<p>the monotonic timestamp of the token request.</p>
-</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-32
-33
-34</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/rarbg/api.rb', line 32</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_token_time'>token_time</span>
-  <span class='ivar'>@token_time</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-  </div>
-  <div id="instance_method_details" class="method_details_list">
-    <h2>Instance Method Details</h2>
-      <div class="method_details first">
-  <h3 class="signature first" id="list-instance_method">
-    #<strong>list</strong>(params = {})  &#x21d2; <tt>Array&lt;Hash&gt;</tt>
-</h3><div class="docstring">
-  <div class="discussion">
-<p>List torrents.</p>
-  </div>
-</div>
-<div class="tags">
-  <div class="examples">
-    <p class="tag_title">Examples:</p>
-        <p class="example_title"><div class='inline'>
-<p>List last 100 ranked torrents in <code>Movies/x264/1080</code></p>
-</div></p>
-      <pre class="example code"><code><span class='id identifier rubyid_rarbg'>rarbg</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../RARBG.html" title="RARBG (module)">RARBG</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="" title="RARBG::API (class)">API</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="RARBG::API#initialize (method)">new</a></span></span>
-<span class='id identifier rubyid_rarbg'>rarbg</span><span class='period'>.</span><span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span><span class='label'>limit:</span> <span class='int'>100</span><span class='comma'>,</span> <span class='label'>ranked:</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='label'>category:</span> <span class='lbracket'>[</span><span class='int'>44</span><span class='rbracket'>]</span><span class='rparen'>)</span></code></pre>
-        <p class="example_title"><div class='inline'>
-<p>List torrents with at least 50 seeders</p>
-</div></p>
-      <pre class="example code"><code><span class='id identifier rubyid_rarbg'>rarbg</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../RARBG.html" title="RARBG (module)">RARBG</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="" title="RARBG::API (class)">API</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="RARBG::API#initialize (method)">new</a></span></span>
-<span class='id identifier rubyid_rarbg'>rarbg</span><span class='period'>.</span><span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span><span class='label'>min_seeders:</span> <span class='int'>50</span><span class='rparen'>)</span></code></pre>
-  </div>
-<p class="tag_title">Parameters:</p>
-<ul class="param">
-    <li>
-        <span class='name'>params</span>
-        <span class='type'>(<tt>Hash</tt>)</span>
-        <em class="default">(defaults to: <tt>{}</tt>)</em>
-        &mdash;
-        <div class='inline'>
-<p>A customizable set of parameters.</p>
-</div>
-    </li>
-</ul>
-    <p class="tag_title">Options Hash (<tt>params</tt>):</p>
-    <ul class="option">
-        <li>
-          <span class="name">:category</span>
-          <span class="type">(<tt>Array&lt;Integer&gt;</tt>)</span>
-          <span class="default">
-          </span>
-            &mdash; <div class='inline'>
-<p>Filter results by category.</p>
-</div>
-        </li>
-        <li>
-          <span class="name">:format</span>
-          <span class="type">(<tt>Symbol</tt>)</span>
-          <span class="default">
-          </span>
-            &mdash; <div class='inline'>
-<p>Format results. Valid values: <code>:json</code>,
-<code>:json_extended</code>. Default: <code>:json</code>.</p>
-</div>
-        </li>
-        <li>
-          <span class="name">:limit</span>
-          <span class="type">(<tt>Integer</tt>)</span>
-          <span class="default">
-          </span>
-            &mdash; <div class='inline'>
-<p>Limit results number. Valid values: <code>25</code>, <code>50</code>,
-<code>100</code>. Default: <code>25</code>.</p>
-</div>
-        </li>
-        <li>
-          <span class="name">:min_seeders</span>
-          <span class="type">(<tt>Integer</tt>)</span>
-          <span class="default">
-          </span>
-            &mdash; <div class='inline'>
-<p>Filter results by minimum seeders.</p>
-</div>
-        </li>
-        <li>
-          <span class="name">:min_leechers</span>
-          <span class="type">(<tt>Integer</tt>)</span>
-          <span class="default">
-          </span>
-            &mdash; <div class='inline'>
-<p>Filter results by minimum leechers.</p>
-</div>
-        </li>
-        <li>
-          <span class="name">:ranked</span>
-          <span class="type">(<tt>Boolean</tt>)</span>
-          <span class="default">
-          </span>
-            &mdash; <div class='inline'>
-<p>Include/exclude unranked torrents. Default: <code>true</code>.</p>
-</div>
-        </li>
-        <li>
-          <span class="name">:sort</span>
-          <span class="type">(<tt>Symbol</tt>)</span>
-          <span class="default">
-          </span>
-            &mdash; <div class='inline'>
-<p>Sort results. Valid values: <code>:last</code>, <code>:seeders</code>,
-<code>:leechers</code>. Default: <code>:last</code>.</p>
-</div>
-        </li>
-    </ul>
-<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>Return torrents that match the specified parameters.</p>
-</div>
-    </li>
-</ul>
-<p class="tag_title">Raises:</p>
-<ul class="raise">
-    <li>
-        <span class='type'>(<tt>ArgumentError</tt>)</span>
-        &mdash;
-        <div class='inline'>
-<p>Exception raised if <code>params</code> is not an <code>Hash</code>.</p>
-</div>
-    </li>
-    <li>
-        <span class='type'>(<tt><span class='object_link'><a href="APIError.html" title="RARBG::APIError (class)">RARBG::APIError</a></span></tt>)</span>
-        &mdash;
-        <div class='inline'>
-<p>Exception raised when request fails or endpoint responds with an error.</p>
-</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-86
-87
-88
-89
-90
-91
-92
-93
-94</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/rarbg/api.rb', line 86</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_list'>list</span><span class='lparen'>(</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_raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Expected params hash</span><span class='tstring_end'>&#39;</span></span> <span class='kw'>unless</span> <span class='id identifier rubyid_params'>params</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Hash</span><span class='rparen'>)</span>
-  <span class='id identifier rubyid_params'>params</span><span class='period'>.</span><span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span>
-    <span class='label'>mode:</span>   <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>list</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
-    <span class='label'>token:</span>  <span class='id identifier rubyid_token?'>token?</span>
-  <span class='rparen'>)</span>
-  <span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <h3 class="signature " id="search-instance_method">
-    #<strong>search</strong>(params = {})  &#x21d2; <tt>Array&lt;Hash&gt;</tt>
-</h3><div class="docstring">
-  <div class="discussion">
-<p>Search torrents.</p>
-  </div>
-</div>
-<div class="tags">
-  <div class="examples">
-    <p class="tag_title">Examples:</p>
-        <p class="example_title"><div class='inline'>
-<p>Search by IMDb ID, sorted by leechers and in extended format.</p>
-</div></p>
-      <pre class="example code"><code><span class='id identifier rubyid_rarbg'>rarbg</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../RARBG.html" title="RARBG (module)">RARBG</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="" title="RARBG::API (class)">API</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="RARBG::API#initialize (method)">new</a></span></span>
-<span class='id identifier rubyid_rarbg'>rarbg</span><span class='period'>.</span><span class='id identifier rubyid_search'>search</span><span class='lparen'>(</span><span class='label'>imdb:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>tt012831</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='label'>sort:</span> <span class='symbol'>:leechers</span><span class='comma'>,</span> <span class='label'>format:</span> <span class='symbol'>:json_extended</span><span class='rparen'>)</span></code></pre>
-        <p class="example_title"><div class='inline'>
-<p>Search unranked torrents by string, with at least 2 seeders.</p>
-</div></p>
-      <pre class="example code"><code><span class='id identifier rubyid_rarbg'>rarbg</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../RARBG.html" title="RARBG (module)">RARBG</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="" title="RARBG::API (class)">API</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="RARBG::API#initialize (method)">new</a></span></span>
-<span class='id identifier rubyid_rarbg'>rarbg</span><span class='period'>.</span><span class='id identifier rubyid_search'>search</span><span class='lparen'>(</span><span class='label'>string:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Star Wars</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='label'>ranked:</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='label'>min_seeders:</span> <span class='int'>2</span><span class='rparen'>)</span></code></pre>
-  </div>
-<p class="tag_title">Parameters:</p>
-<ul class="param">
-    <li>
-        <span class='name'>params</span>
-        <span class='type'>(<tt>Hash</tt>)</span>
-        <em class="default">(defaults to: <tt>{}</tt>)</em>
-        &mdash;
-        <div class='inline'>
-<p>A customizable set of parameters.</p>
-</div>
-    </li>
-</ul>
-    <p class="tag_title">Options Hash (<tt>params</tt>):</p>
-    <ul class="option">
-        <li>
-          <span class="name">:string</span>
-          <span class="type">(<tt>String</tt>)</span>
-          <span class="default">
-          </span>
-            &mdash; <div class='inline'>
-<p>Search by string.</p>
-</div>
-        </li>
-        <li>
-          <span class="name">:imdb</span>
-          <span class="type">(<tt>String</tt>)</span>
-          <span class="default">
-          </span>
-            &mdash; <div class='inline'>
-<p>Search by IMDb id.</p>
-</div>
-        </li>
-        <li>
-          <span class="name">:tvdb</span>
-          <span class="type">(<tt>String</tt>)</span>
-          <span class="default">
-          </span>
-            &mdash; <div class='inline'>
-<p>Search by TVDB id.</p>
-</div>
-        </li>
-        <li>
-          <span class="name">:themoviedb</span>
-          <span class="type">(<tt>String</tt>)</span>
-          <span class="default">
-          </span>
-            &mdash; <div class='inline'>
-<p>Search by The Movie DB id.</p>
-</div>
-        </li>
-        <li>
-          <span class="name">:category</span>
-          <span class="type">(<tt>Array&lt;Integer&gt;</tt>)</span>
-          <span class="default">
-          </span>
-            &mdash; <div class='inline'>
-<p>Filter results by category.</p>
-</div>
-        </li>
-        <li>
-          <span class="name">:format</span>
-          <span class="type">(<tt>Symbol</tt>)</span>
-          <span class="default">
-          </span>
-            &mdash; <div class='inline'>
-<p>Format results. Valid values: <code>:json</code>,
-<code>:json_extended</code>. Default: <code>:json</code></p>
-</div>
-        </li>
-        <li>
-          <span class="name">:limit</span>
-          <span class="type">(<tt>Integer</tt>)</span>
-          <span class="default">
-          </span>
-            &mdash; <div class='inline'>
-<p>Limit results number. Valid values: <code>25</code>, <code>50</code>,
-<code>100</code>. Default: <code>25</code>.</p>
-</div>
-        </li>
-        <li>
-          <span class="name">:min_seeders</span>
-          <span class="type">(<tt>Integer</tt>)</span>
-          <span class="default">
-          </span>
-            &mdash; <div class='inline'>
-<p>Filter results by minimum seeders.</p>
-</div>
-        </li>
-        <li>
-          <span class="name">:min_leechers</span>
-          <span class="type">(<tt>Integer</tt>)</span>
-          <span class="default">
-          </span>
-            &mdash; <div class='inline'>
-<p>Filter results by minimum leechers.</p>
-</div>
-        </li>
-        <li>
-          <span class="name">:ranked</span>
-          <span class="type">(<tt>Boolean</tt>)</span>
-          <span class="default">
-          </span>
-            &mdash; <div class='inline'>
-<p>Include/exclude unranked torrents. Default: <code>true</code>.</p>
-</div>
-        </li>
-        <li>
-          <span class="name">:sort</span>
-          <span class="type">(<tt>Symbol</tt>)</span>
-          <span class="default">
-          </span>
-            &mdash; <div class='inline'>
-<p>Sort results. Valid values: <code>:last</code>, <code>:seeders</code>,
-<code>:leechers</code>. Default: <code>:last</code>.</p>
-</div>
-        </li>
-    </ul>
-<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>Return torrents that match the specified parameters.</p>
-</div>
-    </li>
-</ul>
-<p class="tag_title">Raises:</p>
-<ul class="raise">
-    <li>
-        <span class='type'>(<tt>ArgumentError</tt>)</span>
-        &mdash;
-        <div class='inline'>
-<p>Exception raised if <code>params</code> is not an <code>Hash</code>.</p>
-</div>
-    </li>
-    <li>
-        <span class='type'>(<tt>ArgumentError</tt>)</span>
-        &mdash;
-        <div class='inline'>
-<p>Exception raised if no search type param is passed (among
-<code>string</code>, <code>imdb</code>, <code>tvdb</code>,
-<code>themoviedb</code>).</p>
-</div>
-    </li>
-    <li>
-        <span class='type'>(<tt><span class='object_link'><a href="APIError.html" title="RARBG::APIError (class)">RARBG::APIError</a></span></tt>)</span>
-        &mdash;
-        <div class='inline'>
-<p>Exception raised when request fails or endpoint responds with an error.</p>
-</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-133
-134
-135
-136
-137
-138
-139
-140
-141</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/rarbg/api.rb', line 133</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_search'>search</span><span class='lparen'>(</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_raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Expected params hash</span><span class='tstring_end'>&#39;</span></span> <span class='kw'>unless</span> <span class='id identifier rubyid_params'>params</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Hash</span><span class='rparen'>)</span>
-  <span class='id identifier rubyid_params'>params</span><span class='period'>.</span><span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span>
-    <span class='label'>mode:</span>   <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>search</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
-    <span class='label'>token:</span>  <span class='id identifier rubyid_token?'>token?</span>
-  <span class='rparen'>)</span>
-  <span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-  </div>
-</div>
-      <div id="footer">
-  Generated on Fri Oct 19 11:11:04 2018 by
-  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.16 (ruby-2.4.5).
-</div>
-    </div>
-  </body>
-</html>