rarbg 1.1.0 → 1.1.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/.github/ISSUE_TEMPLATE.md +21 -0
- data/.travis.yml +3 -3
- data/.yardopts +1 -0
- data/CHANGELOG.md +10 -1
- data/README.md +11 -8
- data/Rakefile +2 -0
- data/docs/RARBG.html +195 -0
- data/docs/RARBG/API.html +1309 -0
- data/docs/RARBG/APIError.html +135 -0
- data/docs/_config.yml +2 -0
- data/docs/_index.html +135 -0
- data/docs/class_list.html +51 -0
- data/docs/css/common.css +1 -0
- data/docs/css/full_list.css +58 -0
- data/docs/css/style.css +496 -0
- data/docs/file.CHANGELOG.html +221 -0
- data/docs/file.LICENSE.html +92 -0
- data/docs/file.README.html +236 -0
- data/docs/file_list.html +66 -0
- data/docs/frames.html +17 -0
- data/docs/index.html +236 -0
- data/docs/js/app.js +292 -0
- data/docs/js/full_list.js +216 -0
- data/docs/js/jquery.js +4 -0
- data/docs/method_list.html +107 -0
- data/docs/top-level-namespace.html +110 -0
- data/lib/rarbg/api.rb +8 -6
- data/lib/rarbg/version.rb +1 -1
- data/rarbg.gemspec +1 -1
- metadata +25 -4
data/docs/file_list.html
ADDED
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
5
|
+
<meta charset="utf-8" />
|
|
6
|
+
|
|
7
|
+
<link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen" charset="utf-8" />
|
|
8
|
+
|
|
9
|
+
<link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
|
|
14
|
+
|
|
15
|
+
<script type="text/javascript" charset="utf-8" src="js/full_list.js"></script>
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
<title>File List</title>
|
|
19
|
+
<base id="base_target" target="_parent" />
|
|
20
|
+
</head>
|
|
21
|
+
<body>
|
|
22
|
+
<div id="content">
|
|
23
|
+
<div class="fixed_header">
|
|
24
|
+
<h1 id="full_list_header">File List</h1>
|
|
25
|
+
<div id="full_list_nav">
|
|
26
|
+
|
|
27
|
+
<span><a target="_self" href="class_list.html">
|
|
28
|
+
Classes
|
|
29
|
+
</a></span>
|
|
30
|
+
|
|
31
|
+
<span><a target="_self" href="method_list.html">
|
|
32
|
+
Methods
|
|
33
|
+
</a></span>
|
|
34
|
+
|
|
35
|
+
<span><a target="_self" href="file_list.html">
|
|
36
|
+
Files
|
|
37
|
+
</a></span>
|
|
38
|
+
|
|
39
|
+
</div>
|
|
40
|
+
|
|
41
|
+
<div id="search">Search: <input type="text" /></div>
|
|
42
|
+
</div>
|
|
43
|
+
|
|
44
|
+
<ul id="full_list" class="file">
|
|
45
|
+
|
|
46
|
+
|
|
47
|
+
<li id="object_README" class="odd">
|
|
48
|
+
<div class="item"><span class="object_link"><a href="index.html" title="README">README</a></span></div>
|
|
49
|
+
</li>
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
<li id="object_CHANGELOG" class="even">
|
|
53
|
+
<div class="item"><span class="object_link"><a href="file.CHANGELOG.html" title="CHANGELOG">CHANGELOG</a></span></div>
|
|
54
|
+
</li>
|
|
55
|
+
|
|
56
|
+
|
|
57
|
+
<li id="object_LICENSE" class="odd">
|
|
58
|
+
<div class="item"><span class="object_link"><a href="file.LICENSE.html" title="LICENSE">LICENSE</a></span></div>
|
|
59
|
+
</li>
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
|
|
63
|
+
</ul>
|
|
64
|
+
</div>
|
|
65
|
+
</body>
|
|
66
|
+
</html>
|
data/docs/frames.html
ADDED
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<title>Documentation by YARD 0.9.16</title>
|
|
6
|
+
</head>
|
|
7
|
+
<script type="text/javascript" charset="utf-8">
|
|
8
|
+
var match = unescape(window.location.hash).match(/^#!(.+)/);
|
|
9
|
+
var name = match ? match[1] : 'index.html';
|
|
10
|
+
name = name.replace(/^(\w+):\/\//, '').replace(/^\/\//, '');
|
|
11
|
+
window.top.location = name;
|
|
12
|
+
</script>
|
|
13
|
+
<noscript>
|
|
14
|
+
<h1>Oops!</h1>
|
|
15
|
+
<h2>YARD requires JavaScript!</h2>
|
|
16
|
+
</noscript>
|
|
17
|
+
</html>
|
data/docs/index.html
ADDED
|
@@ -0,0 +1,236 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="UTF-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
+
<title>
|
|
7
|
+
File: README
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.9.16
|
|
10
|
+
|
|
11
|
+
</title>
|
|
12
|
+
|
|
13
|
+
<link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
|
|
14
|
+
|
|
15
|
+
<link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
|
|
16
|
+
|
|
17
|
+
<script type="text/javascript" charset="utf-8">
|
|
18
|
+
pathId = "README";
|
|
19
|
+
relpath = '';
|
|
20
|
+
</script>
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
|
|
24
|
+
|
|
25
|
+
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
</head>
|
|
29
|
+
<body>
|
|
30
|
+
<div class="nav_wrap">
|
|
31
|
+
<iframe id="nav" src="class_list.html?1"></iframe>
|
|
32
|
+
<div id="resizer"></div>
|
|
33
|
+
</div>
|
|
34
|
+
|
|
35
|
+
<div id="main" tabindex="-1">
|
|
36
|
+
<div id="header">
|
|
37
|
+
<div id="menu">
|
|
38
|
+
|
|
39
|
+
<a href="_index.html">Index</a> »
|
|
40
|
+
<span class="title">File: README</span>
|
|
41
|
+
|
|
42
|
+
</div>
|
|
43
|
+
|
|
44
|
+
<div id="search">
|
|
45
|
+
|
|
46
|
+
<a class="full_list_link" id="class_list_link"
|
|
47
|
+
href="class_list.html">
|
|
48
|
+
|
|
49
|
+
<svg width="24" height="24">
|
|
50
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
|
51
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
|
52
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
|
53
|
+
</svg>
|
|
54
|
+
</a>
|
|
55
|
+
|
|
56
|
+
</div>
|
|
57
|
+
<div class="clear"></div>
|
|
58
|
+
</div>
|
|
59
|
+
|
|
60
|
+
<div id="content"><div id='filecontents'>
|
|
61
|
+
<h1 id="label-RARBG">RARBG</h1>
|
|
62
|
+
|
|
63
|
+
<p><a href="https://rubygems.org/gems/rarbg"><img
|
|
64
|
+
src="https://img.shields.io/gem/v/rarbg.svg?colorB=brightgreen"></a> <a
|
|
65
|
+
href="https://travis-ci.org/epistrephein/rarbg"><img
|
|
66
|
+
src="https://travis-ci.org/epistrephein/rarbg.svg?branch=master"></a> <a
|
|
67
|
+
href="https://depfu.com/github/epistrephein/rarbg?project_id=5845"><img
|
|
68
|
+
src="https://badges.depfu.com/badges/32877a5a58ad7eb3f5db321d85a23c1b/overview.svg"></a>
|
|
69
|
+
<a
|
|
70
|
+
href="https://codeclimate.com/github/epistrephein/rarbg/maintainability"><img
|
|
71
|
+
src="https://api.codeclimate.com/v1/badges/adf6a91b754bb4aaacf2/maintainability"></a>
|
|
72
|
+
<a
|
|
73
|
+
href="https://codeclimate.com/github/epistrephein/rarbg/test_coverage"><img
|
|
74
|
+
src="https://api.codeclimate.com/v1/badges/adf6a91b754bb4aaacf2/test_coverage"></a>
|
|
75
|
+
<a href="https://inch-ci.org/github/epistrephein/rarbg"><img
|
|
76
|
+
src="https://inch-ci.org/github/epistrephein/rarbg.svg?branch=master"></a>
|
|
77
|
+
<a href="https://epistrephein.github.io/rarbg"><img
|
|
78
|
+
src="https://img.shields.io/badge/docs-yard-blue.svg"></a></p>
|
|
79
|
+
|
|
80
|
+
<p>Ruby wrapper for the RARBG Torrent API.</p>
|
|
81
|
+
|
|
82
|
+
<h2 id="label-Installation">Installation</h2>
|
|
83
|
+
|
|
84
|
+
<p>Install as a gem</p>
|
|
85
|
+
|
|
86
|
+
<pre class="code ruby"><code class="ruby">$ gem install rarbg</code></pre>
|
|
87
|
+
|
|
88
|
+
<p>Or add it to your Gemfile and execute <code>bundle install</code></p>
|
|
89
|
+
|
|
90
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>rarbg</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>~> 1.0</span><span class='tstring_end'>'</span></span>
|
|
91
|
+
</code></pre>
|
|
92
|
+
|
|
93
|
+
<h2 id="label-Usage">Usage</h2>
|
|
94
|
+
|
|
95
|
+
<p>This gem wraps all API methods available from <a
|
|
96
|
+
href="https://torrentapi.org/apidocs_v2.txt">RARBG TorrentAPI</a>.</p>
|
|
97
|
+
|
|
98
|
+
<p>An authentication token is automatically generated on first request, stored
|
|
99
|
+
with timestamp and renewed every 800 seconds.</p>
|
|
100
|
+
|
|
101
|
+
<p>Rate limit (1req/2s) is automatically enforced.</p>
|
|
102
|
+
|
|
103
|
+
<h4 id="label-Getting+started">Getting started</h4>
|
|
104
|
+
|
|
105
|
+
<p>Require the gem and initialize a new <code>RARBG::API</code> object.</p>
|
|
106
|
+
|
|
107
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>rarbg</span><span class='tstring_end'>'</span></span>
|
|
108
|
+
|
|
109
|
+
<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="RARBG/API.html" title="RARBG::API (class)">API</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="RARBG/API.html#initialize-instance_method" title="RARBG::API#initialize (method)">new</a></span></span>
|
|
110
|
+
</code></pre>
|
|
111
|
+
|
|
112
|
+
<h4 id="label-Methods">Methods</h4>
|
|
113
|
+
|
|
114
|
+
<p>Use <a
|
|
115
|
+
href="https://epistrephein.github.io/rarbg/RARBG/API.html#list-instance_method">list</a>
|
|
116
|
+
to list torrents. Additional parameters are passed as keyword arguments and
|
|
117
|
+
can be mixed together.</p>
|
|
118
|
+
|
|
119
|
+
<p>All successful method calls return an array of hashes (or an empty array
|
|
120
|
+
for no results).</p>
|
|
121
|
+
|
|
122
|
+
<pre class="code ruby"><code class="ruby"><span class='comment'># List last 100 torrents.
|
|
123
|
+
</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='rparen'>)</span>
|
|
124
|
+
|
|
125
|
+
<span class='comment'># List torrents with at least 20 seeders, sorted by seeders.
|
|
126
|
+
</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'>20</span><span class='comma'>,</span> <span class='label'>sort:</span> <span class='symbol'>:seeders</span><span class='rparen'>)</span>
|
|
127
|
+
|
|
128
|
+
<span class='comment'># List torrents with extended json infos.
|
|
129
|
+
</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'>format:</span> <span class='symbol'>:json_extended</span><span class='rparen'>)</span>
|
|
130
|
+
</code></pre>
|
|
131
|
+
|
|
132
|
+
<p>Use <a
|
|
133
|
+
href="https://epistrephein.github.io/rarbg/RARBG/API.html#search-instance_method">search</a>
|
|
134
|
+
to search torrents. One search type parameter among <code>string</code>,
|
|
135
|
+
<code>imdb</code>, <code>themoviedb</code> and <code>tvdb</code> is
|
|
136
|
+
required.</p>
|
|
137
|
+
|
|
138
|
+
<pre class="code ruby"><code class="ruby"><span class='comment'># Search torrents using literal string query.
|
|
139
|
+
</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'>'</span><span class='tstring_content'>Force Awakens</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
|
140
|
+
|
|
141
|
+
<span class='comment'># Search by IMDB id, in `Movies/x264/1080` and `Movies/x264/720`.
|
|
142
|
+
</span><span class='comment'># Note that 'tt' can be omitted when passing an IMDB id.
|
|
143
|
+
</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'>'</span><span class='tstring_content'>tt2488496</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='label'>category:</span> <span class='lbracket'>[</span><span class='int'>44</span><span class='comma'>,</span> <span class='int'>45</span><span class='rbracket'>]</span><span class='rparen'>)</span>
|
|
144
|
+
|
|
145
|
+
<span class='comment'># Search unranked torrents by TheMovieDB id, sorted by last.
|
|
146
|
+
</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'>themoviedb:</span> <span class='int'>140607</span><span class='comma'>,</span> <span class='label'>ranked:</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='label'>sort:</span> <span class='symbol'>:last</span><span class='rparen'>)</span>
|
|
147
|
+
</code></pre>
|
|
148
|
+
|
|
149
|
+
<p>These methods are also available from the top module namespace for
|
|
150
|
+
convenience.</p>
|
|
151
|
+
|
|
152
|
+
<pre class="code ruby"><code class="ruby"><span class='const'><span class='object_link'><a href="RARBG.html" title="RARBG (module)">RARBG</a></span></span><span class='period'>.</span><span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span><span class='label'>sort:</span> <span class='symbol'>:leechers</span><span class='comma'>,</span> <span class='label'>min_leechers:</span> <span class='int'>10</span><span class='rparen'>)</span>
|
|
153
|
+
|
|
154
|
+
<span class='const'><span class='object_link'><a href="RARBG.html" title="RARBG (module)">RARBG</a></span></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'>'</span><span class='tstring_content'>Star Wars</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='label'>category:</span> <span class='lbracket'>[</span><span class='int'>48</span><span class='rbracket'>]</span><span class='rparen'>)</span>
|
|
155
|
+
</code></pre>
|
|
156
|
+
|
|
157
|
+
<p>A list of name/id pairs for each category is available for quick lookup.</p>
|
|
158
|
+
|
|
159
|
+
<pre class="code ruby"><code class="ruby"><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="RARBG.html#CATEGORIES-constant" title="RARBG::CATEGORIES (constant)">CATEGORIES</a></span></span>
|
|
160
|
+
<span class='comment'># => { "Movies/XVID" => 14,
|
|
161
|
+
</span><span class='comment'># "Movies/XVID/720" => 48,
|
|
162
|
+
</span><span class='comment'># "Movies/x264" => 17,
|
|
163
|
+
</span><span class='comment'># ...
|
|
164
|
+
</span><span class='comment'># }
|
|
165
|
+
</span></code></pre>
|
|
166
|
+
|
|
167
|
+
<h4 id="label-Errors">Errors</h4>
|
|
168
|
+
|
|
169
|
+
<p>API endpoint errors will raise a <code>RARBG::APIError</code> exception
|
|
170
|
+
with the API error message.</p>
|
|
171
|
+
|
|
172
|
+
<pre class="code ruby"><code class="ruby"><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'>sort:</span> <span class='symbol'>:name</span><span class='rparen'>)</span>
|
|
173
|
+
<span class='comment'># => RARBG::APIError: Invalid sort
|
|
174
|
+
</span>
|
|
175
|
+
<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'>'</span><span class='tstring_content'>Star Wars</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='label'>min_seeders:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>notanumber</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
|
176
|
+
<span class='comment'># => RARBG::APIError: Invalid value for min_seeders
|
|
177
|
+
</span>
|
|
178
|
+
<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'>'</span><span class='tstring_content'>tt0121765</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
|
179
|
+
<span class='comment'># => RARBG::APIError: Service unavailable (503)
|
|
180
|
+
</span></code></pre>
|
|
181
|
+
|
|
182
|
+
<p>Parameter validation errors on client side will raise an
|
|
183
|
+
<code>ArgumentError</code>.</p>
|
|
184
|
+
|
|
185
|
+
<pre class="code ruby"><code class="ruby"><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='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>a string instead of an hash</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
|
186
|
+
<span class='comment'># => ArgumentError: Expected params hash
|
|
187
|
+
</span>
|
|
188
|
+
<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'>limit:</span> <span class='int'>50</span><span class='rparen'>)</span>
|
|
189
|
+
<span class='comment'># => ArgumentError: At least one parameter required among string, imdb, tvdb, themoviedb for search mode.
|
|
190
|
+
</span></code></pre>
|
|
191
|
+
|
|
192
|
+
<h2 id="label-Contributing">Contributing</h2>
|
|
193
|
+
|
|
194
|
+
<p>Bug reports and pull requests are welcome on <a
|
|
195
|
+
href="https://github.com/epistrephein/rarbg">GitHub</a>.</p>
|
|
196
|
+
|
|
197
|
+
<p>This project is intended to be a safe, welcoming space for collaboration,
|
|
198
|
+
and contributors are expected to adhere to the <a
|
|
199
|
+
href="https://github.com/epistrephein/rarbg/blob/master/CODE_OF_CONDUCT.md">Code
|
|
200
|
+
of Conduct</a>.</p>
|
|
201
|
+
|
|
202
|
+
<p>You can contribute changes by forking the project and submitting a pull
|
|
203
|
+
request. To get started:</p>
|
|
204
|
+
<ol><li>
|
|
205
|
+
<p>Fork the repo</p>
|
|
206
|
+
</li><li>
|
|
207
|
+
<p>Install the dependencies (<code>bin/setup</code>)</p>
|
|
208
|
+
</li><li>
|
|
209
|
+
<p>Create your feature branch (<code>git checkout -b my-new-feature</code>)</p>
|
|
210
|
+
</li><li>
|
|
211
|
+
<p>Commit your changes (<code>git commit -am 'Add some
|
|
212
|
+
feature'</code>)</p>
|
|
213
|
+
</li><li>
|
|
214
|
+
<p>Pass the test suite (<code>rake spec</code>)</p>
|
|
215
|
+
</li><li>
|
|
216
|
+
<p>Push to the branch (<code>git push origin my-new-feature</code>)</p>
|
|
217
|
+
</li><li>
|
|
218
|
+
<p>Create a new pull request</p>
|
|
219
|
+
</li></ol>
|
|
220
|
+
|
|
221
|
+
<h2 id="label-License">License</h2>
|
|
222
|
+
|
|
223
|
+
<p>This gem is released as open source under the terms of the <a
|
|
224
|
+
href="https://github.com/epistrephein/rarbg/blob/master/LICENSE">MIT
|
|
225
|
+
License</a>.</p>
|
|
226
|
+
</div></div>
|
|
227
|
+
|
|
228
|
+
<div id="footer">
|
|
229
|
+
Generated on Fri Oct 19 11:11:03 2018 by
|
|
230
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
231
|
+
0.9.16 (ruby-2.4.5).
|
|
232
|
+
</div>
|
|
233
|
+
|
|
234
|
+
</div>
|
|
235
|
+
</body>
|
|
236
|
+
</html>
|
data/docs/js/app.js
ADDED
|
@@ -0,0 +1,292 @@
|
|
|
1
|
+
(function() {
|
|
2
|
+
|
|
3
|
+
var localStorage = {}, sessionStorage = {};
|
|
4
|
+
try { localStorage = window.localStorage; } catch (e) { }
|
|
5
|
+
try { sessionStorage = window.sessionStorage; } catch (e) { }
|
|
6
|
+
|
|
7
|
+
function createSourceLinks() {
|
|
8
|
+
$('.method_details_list .source_code').
|
|
9
|
+
before("<span class='showSource'>[<a href='#' class='toggleSource'>View source</a>]</span>");
|
|
10
|
+
$('.toggleSource').toggle(function() {
|
|
11
|
+
$(this).parent().nextAll('.source_code').slideDown(100);
|
|
12
|
+
$(this).text("Hide source");
|
|
13
|
+
},
|
|
14
|
+
function() {
|
|
15
|
+
$(this).parent().nextAll('.source_code').slideUp(100);
|
|
16
|
+
$(this).text("View source");
|
|
17
|
+
});
|
|
18
|
+
}
|
|
19
|
+
|
|
20
|
+
function createDefineLinks() {
|
|
21
|
+
var tHeight = 0;
|
|
22
|
+
$('.defines').after(" <a href='#' class='toggleDefines'>more...</a>");
|
|
23
|
+
$('.toggleDefines').toggle(function() {
|
|
24
|
+
tHeight = $(this).parent().prev().height();
|
|
25
|
+
$(this).prev().css('display', 'inline');
|
|
26
|
+
$(this).parent().prev().height($(this).parent().height());
|
|
27
|
+
$(this).text("(less)");
|
|
28
|
+
},
|
|
29
|
+
function() {
|
|
30
|
+
$(this).prev().hide();
|
|
31
|
+
$(this).parent().prev().height(tHeight);
|
|
32
|
+
$(this).text("more...");
|
|
33
|
+
});
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
function createFullTreeLinks() {
|
|
37
|
+
var tHeight = 0;
|
|
38
|
+
$('.inheritanceTree').toggle(function() {
|
|
39
|
+
tHeight = $(this).parent().prev().height();
|
|
40
|
+
$(this).parent().toggleClass('showAll');
|
|
41
|
+
$(this).text("(hide)");
|
|
42
|
+
$(this).parent().prev().height($(this).parent().height());
|
|
43
|
+
},
|
|
44
|
+
function() {
|
|
45
|
+
$(this).parent().toggleClass('showAll');
|
|
46
|
+
$(this).parent().prev().height(tHeight);
|
|
47
|
+
$(this).text("show all");
|
|
48
|
+
});
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
function searchFrameButtons() {
|
|
52
|
+
$('.full_list_link').click(function() {
|
|
53
|
+
toggleSearchFrame(this, $(this).attr('href'));
|
|
54
|
+
return false;
|
|
55
|
+
});
|
|
56
|
+
window.addEventListener('message', function(e) {
|
|
57
|
+
if (e.data === 'navEscape') {
|
|
58
|
+
$('#nav').slideUp(100);
|
|
59
|
+
$('#search a').removeClass('active inactive');
|
|
60
|
+
$(window).focus();
|
|
61
|
+
}
|
|
62
|
+
});
|
|
63
|
+
|
|
64
|
+
$(window).resize(function() {
|
|
65
|
+
if ($('#search:visible').length === 0) {
|
|
66
|
+
$('#nav').removeAttr('style');
|
|
67
|
+
$('#search a').removeClass('active inactive');
|
|
68
|
+
$(window).focus();
|
|
69
|
+
}
|
|
70
|
+
});
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
function toggleSearchFrame(id, link) {
|
|
74
|
+
var frame = $('#nav');
|
|
75
|
+
$('#search a').removeClass('active').addClass('inactive');
|
|
76
|
+
if (frame.attr('src') === link && frame.css('display') !== "none") {
|
|
77
|
+
frame.slideUp(100);
|
|
78
|
+
$('#search a').removeClass('active inactive');
|
|
79
|
+
}
|
|
80
|
+
else {
|
|
81
|
+
$(id).addClass('active').removeClass('inactive');
|
|
82
|
+
if (frame.attr('src') !== link) frame.attr('src', link);
|
|
83
|
+
frame.slideDown(100);
|
|
84
|
+
}
|
|
85
|
+
}
|
|
86
|
+
|
|
87
|
+
function linkSummaries() {
|
|
88
|
+
$('.summary_signature').click(function() {
|
|
89
|
+
document.location = $(this).find('a').attr('href');
|
|
90
|
+
});
|
|
91
|
+
}
|
|
92
|
+
|
|
93
|
+
function summaryToggle() {
|
|
94
|
+
$('.summary_toggle').click(function(e) {
|
|
95
|
+
e.preventDefault();
|
|
96
|
+
localStorage.summaryCollapsed = $(this).text();
|
|
97
|
+
$('.summary_toggle').each(function() {
|
|
98
|
+
$(this).text($(this).text() == "collapse" ? "expand" : "collapse");
|
|
99
|
+
var next = $(this).parent().parent().nextAll('ul.summary').first();
|
|
100
|
+
if (next.hasClass('compact')) {
|
|
101
|
+
next.toggle();
|
|
102
|
+
next.nextAll('ul.summary').first().toggle();
|
|
103
|
+
}
|
|
104
|
+
else if (next.hasClass('summary')) {
|
|
105
|
+
var list = $('<ul class="summary compact" />');
|
|
106
|
+
list.html(next.html());
|
|
107
|
+
list.find('.summary_desc, .note').remove();
|
|
108
|
+
list.find('a').each(function() {
|
|
109
|
+
$(this).html($(this).find('strong').html());
|
|
110
|
+
$(this).parent().html($(this)[0].outerHTML);
|
|
111
|
+
});
|
|
112
|
+
next.before(list);
|
|
113
|
+
next.toggle();
|
|
114
|
+
}
|
|
115
|
+
});
|
|
116
|
+
return false;
|
|
117
|
+
});
|
|
118
|
+
if (localStorage.summaryCollapsed == "collapse") {
|
|
119
|
+
$('.summary_toggle').first().click();
|
|
120
|
+
} else { localStorage.summaryCollapsed = "expand"; }
|
|
121
|
+
}
|
|
122
|
+
|
|
123
|
+
function constantSummaryToggle() {
|
|
124
|
+
$('.constants_summary_toggle').click(function(e) {
|
|
125
|
+
e.preventDefault();
|
|
126
|
+
localStorage.summaryCollapsed = $(this).text();
|
|
127
|
+
$('.constants_summary_toggle').each(function() {
|
|
128
|
+
$(this).text($(this).text() == "collapse" ? "expand" : "collapse");
|
|
129
|
+
var next = $(this).parent().parent().nextAll('dl.constants').first();
|
|
130
|
+
if (next.hasClass('compact')) {
|
|
131
|
+
next.toggle();
|
|
132
|
+
next.nextAll('dl.constants').first().toggle();
|
|
133
|
+
}
|
|
134
|
+
else if (next.hasClass('constants')) {
|
|
135
|
+
var list = $('<dl class="constants compact" />');
|
|
136
|
+
list.html(next.html());
|
|
137
|
+
list.find('dt').each(function() {
|
|
138
|
+
$(this).addClass('summary_signature');
|
|
139
|
+
$(this).text( $(this).text().split('=')[0]);
|
|
140
|
+
if ($(this).has(".deprecated").length) {
|
|
141
|
+
$(this).addClass('deprecated');
|
|
142
|
+
};
|
|
143
|
+
});
|
|
144
|
+
// Add the value of the constant as "Tooltip" to the summary object
|
|
145
|
+
list.find('pre.code').each(function() {
|
|
146
|
+
console.log($(this).parent());
|
|
147
|
+
var dt_element = $(this).parent().prev();
|
|
148
|
+
var tooltip = $(this).text();
|
|
149
|
+
if (dt_element.hasClass("deprecated")) {
|
|
150
|
+
tooltip = 'Deprecated. ' + tooltip;
|
|
151
|
+
};
|
|
152
|
+
dt_element.attr('title', tooltip);
|
|
153
|
+
});
|
|
154
|
+
list.find('.docstring, .tags, dd').remove();
|
|
155
|
+
next.before(list);
|
|
156
|
+
next.toggle();
|
|
157
|
+
}
|
|
158
|
+
});
|
|
159
|
+
return false;
|
|
160
|
+
});
|
|
161
|
+
if (localStorage.summaryCollapsed == "collapse") {
|
|
162
|
+
$('.constants_summary_toggle').first().click();
|
|
163
|
+
} else { localStorage.summaryCollapsed = "expand"; }
|
|
164
|
+
}
|
|
165
|
+
|
|
166
|
+
function generateTOC() {
|
|
167
|
+
if ($('#filecontents').length === 0) return;
|
|
168
|
+
var _toc = $('<ol class="top"></ol>');
|
|
169
|
+
var show = false;
|
|
170
|
+
var toc = _toc;
|
|
171
|
+
var counter = 0;
|
|
172
|
+
var tags = ['h2', 'h3', 'h4', 'h5', 'h6'];
|
|
173
|
+
var i;
|
|
174
|
+
if ($('#filecontents h1').length > 1) tags.unshift('h1');
|
|
175
|
+
for (i = 0; i < tags.length; i++) { tags[i] = '#filecontents ' + tags[i]; }
|
|
176
|
+
var lastTag = parseInt(tags[0][1], 10);
|
|
177
|
+
$(tags.join(', ')).each(function() {
|
|
178
|
+
if ($(this).parents('.method_details .docstring').length != 0) return;
|
|
179
|
+
if (this.id == "filecontents") return;
|
|
180
|
+
show = true;
|
|
181
|
+
var thisTag = parseInt(this.tagName[1], 10);
|
|
182
|
+
if (this.id.length === 0) {
|
|
183
|
+
var proposedId = $(this).attr('toc-id');
|
|
184
|
+
if (typeof(proposedId) != "undefined") this.id = proposedId;
|
|
185
|
+
else {
|
|
186
|
+
var proposedId = $(this).text().replace(/[^a-z0-9-]/ig, '_');
|
|
187
|
+
if ($('#' + proposedId).length > 0) { proposedId += counter; counter++; }
|
|
188
|
+
this.id = proposedId;
|
|
189
|
+
}
|
|
190
|
+
}
|
|
191
|
+
if (thisTag > lastTag) {
|
|
192
|
+
for (i = 0; i < thisTag - lastTag; i++) {
|
|
193
|
+
var tmp = $('<ol/>'); toc.append(tmp); toc = tmp;
|
|
194
|
+
}
|
|
195
|
+
}
|
|
196
|
+
if (thisTag < lastTag) {
|
|
197
|
+
for (i = 0; i < lastTag - thisTag; i++) toc = toc.parent();
|
|
198
|
+
}
|
|
199
|
+
var title = $(this).attr('toc-title');
|
|
200
|
+
if (typeof(title) == "undefined") title = $(this).text();
|
|
201
|
+
toc.append('<li><a href="#' + this.id + '">' + title + '</a></li>');
|
|
202
|
+
lastTag = thisTag;
|
|
203
|
+
});
|
|
204
|
+
if (!show) return;
|
|
205
|
+
html = '<div id="toc"><p class="title hide_toc"><a href="#"><strong>Table of Contents</strong></a></p></div>';
|
|
206
|
+
$('#content').prepend(html);
|
|
207
|
+
$('#toc').append(_toc);
|
|
208
|
+
$('#toc .hide_toc').toggle(function() {
|
|
209
|
+
$('#toc .top').slideUp('fast');
|
|
210
|
+
$('#toc').toggleClass('hidden');
|
|
211
|
+
$('#toc .title small').toggle();
|
|
212
|
+
}, function() {
|
|
213
|
+
$('#toc .top').slideDown('fast');
|
|
214
|
+
$('#toc').toggleClass('hidden');
|
|
215
|
+
$('#toc .title small').toggle();
|
|
216
|
+
});
|
|
217
|
+
}
|
|
218
|
+
|
|
219
|
+
function navResizeFn(e) {
|
|
220
|
+
if (e.which !== 1) {
|
|
221
|
+
navResizeFnStop();
|
|
222
|
+
return;
|
|
223
|
+
}
|
|
224
|
+
|
|
225
|
+
sessionStorage.navWidth = e.pageX.toString();
|
|
226
|
+
$('.nav_wrap').css('width', e.pageX);
|
|
227
|
+
$('.nav_wrap').css('-ms-flex', 'inherit');
|
|
228
|
+
}
|
|
229
|
+
|
|
230
|
+
function navResizeFnStop() {
|
|
231
|
+
$(window).unbind('mousemove', navResizeFn);
|
|
232
|
+
window.removeEventListener('message', navMessageFn, false);
|
|
233
|
+
}
|
|
234
|
+
|
|
235
|
+
function navMessageFn(e) {
|
|
236
|
+
if (e.data.action === 'mousemove') navResizeFn(e.data.event);
|
|
237
|
+
if (e.data.action === 'mouseup') navResizeFnStop();
|
|
238
|
+
}
|
|
239
|
+
|
|
240
|
+
function navResizer() {
|
|
241
|
+
$('#resizer').mousedown(function(e) {
|
|
242
|
+
e.preventDefault();
|
|
243
|
+
$(window).mousemove(navResizeFn);
|
|
244
|
+
window.addEventListener('message', navMessageFn, false);
|
|
245
|
+
});
|
|
246
|
+
$(window).mouseup(navResizeFnStop);
|
|
247
|
+
|
|
248
|
+
if (sessionStorage.navWidth) {
|
|
249
|
+
navResizeFn({which: 1, pageX: parseInt(sessionStorage.navWidth, 10)});
|
|
250
|
+
}
|
|
251
|
+
}
|
|
252
|
+
|
|
253
|
+
function navExpander() {
|
|
254
|
+
var done = false, timer = setTimeout(postMessage, 500);
|
|
255
|
+
function postMessage() {
|
|
256
|
+
if (done) return;
|
|
257
|
+
clearTimeout(timer);
|
|
258
|
+
var opts = { action: 'expand', path: pathId };
|
|
259
|
+
document.getElementById('nav').contentWindow.postMessage(opts, '*');
|
|
260
|
+
done = true;
|
|
261
|
+
}
|
|
262
|
+
|
|
263
|
+
window.addEventListener('message', function(event) {
|
|
264
|
+
if (event.data === 'navReady') postMessage();
|
|
265
|
+
return false;
|
|
266
|
+
}, false);
|
|
267
|
+
}
|
|
268
|
+
|
|
269
|
+
function mainFocus() {
|
|
270
|
+
var hash = window.location.hash;
|
|
271
|
+
if (hash !== '' && $(hash)[0]) {
|
|
272
|
+
$(hash)[0].scrollIntoView();
|
|
273
|
+
}
|
|
274
|
+
|
|
275
|
+
setTimeout(function() { $('#main').focus(); }, 10);
|
|
276
|
+
}
|
|
277
|
+
|
|
278
|
+
$(document).ready(function() {
|
|
279
|
+
navResizer();
|
|
280
|
+
navExpander();
|
|
281
|
+
createSourceLinks();
|
|
282
|
+
createDefineLinks();
|
|
283
|
+
createFullTreeLinks();
|
|
284
|
+
searchFrameButtons();
|
|
285
|
+
linkSummaries();
|
|
286
|
+
summaryToggle();
|
|
287
|
+
constantSummaryToggle();
|
|
288
|
+
generateTOC();
|
|
289
|
+
mainFocus();
|
|
290
|
+
});
|
|
291
|
+
|
|
292
|
+
})();
|