mediawiki-gateway 0.3.3 → 0.3.4
Sign up to get free protection for your applications and to get access to all the features.
- data/doc/classes/MediaWiki/Config.html +12 -12
- data/doc/classes/MediaWiki/Gateway.html +397 -334
- data/doc/created.rid +1 -1
- data/doc/files/lib/media_wiki/gateway_rb.html +1 -1
- data/doc/fr_method_index.html +4 -2
- data/lib/media_wiki.rb +1 -1
- data/lib/media_wiki/gateway.rb +40 -13
- data/mediawiki-gateway.gemspec +3 -2
- data/spec/gateway_spec.rb +17 -0
- metadata +4 -4
@@ -86,8 +86,8 @@
|
|
86
86
|
<h3 class="section-bar">Methods</h3>
|
87
87
|
|
88
88
|
<div class="name-list">
|
89
|
-
<a href="#
|
90
|
-
<a href="#
|
89
|
+
<a href="#M000034">abort</a>
|
90
|
+
<a href="#M000033">new</a>
|
91
91
|
</div>
|
92
92
|
</div>
|
93
93
|
|
@@ -157,19 +157,19 @@
|
|
157
157
|
<div id="methods">
|
158
158
|
<h3 class="section-bar">Public Class methods</h3>
|
159
159
|
|
160
|
-
<div id="method-
|
161
|
-
<a name="
|
160
|
+
<div id="method-M000033" class="method-detail">
|
161
|
+
<a name="M000033"></a>
|
162
162
|
|
163
163
|
<div class="method-heading">
|
164
|
-
<a href="#
|
164
|
+
<a href="#M000033" class="method-signature">
|
165
165
|
<span class="method-name">new</span><span class="method-args">(args, type = "read")</span>
|
166
166
|
</a>
|
167
167
|
</div>
|
168
168
|
|
169
169
|
<div class="method-description">
|
170
170
|
<p><a class="source-toggle" href="#"
|
171
|
-
onclick="toggleCode('
|
172
|
-
<div class="method-source-code" id="
|
171
|
+
onclick="toggleCode('M000033-source');return false;">[Source]</a></p>
|
172
|
+
<div class="method-source-code" id="M000033-source">
|
173
173
|
<pre>
|
174
174
|
<span class="ruby-comment cmt"># File lib/media_wiki/config.rb, line 10</span>
|
175
175
|
10: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">args</span>, <span class="ruby-identifier">type</span> = <span class="ruby-value str">"read"</span>)
|
@@ -230,19 +230,19 @@
|
|
230
230
|
|
231
231
|
<h3 class="section-bar">Public Instance methods</h3>
|
232
232
|
|
233
|
-
<div id="method-
|
234
|
-
<a name="
|
233
|
+
<div id="method-M000034" class="method-detail">
|
234
|
+
<a name="M000034"></a>
|
235
235
|
|
236
236
|
<div class="method-heading">
|
237
|
-
<a href="#
|
237
|
+
<a href="#M000034" class="method-signature">
|
238
238
|
<span class="method-name">abort</span><span class="method-args">(error)</span>
|
239
239
|
</a>
|
240
240
|
</div>
|
241
241
|
|
242
242
|
<div class="method-description">
|
243
243
|
<p><a class="source-toggle" href="#"
|
244
|
-
onclick="toggleCode('
|
245
|
-
<div class="method-source-code" id="
|
244
|
+
onclick="toggleCode('M000034-source');return false;">[Source]</a></p>
|
245
|
+
<div class="method-source-code" id="M000034-source">
|
246
246
|
<pre>
|
247
247
|
<span class="ruby-comment cmt"># File lib/media_wiki/config.rb, line 62</span>
|
248
248
|
62: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">abort</span>(<span class="ruby-identifier">error</span>)
|
@@ -110,6 +110,8 @@
|
|
110
110
|
<a href="#M000026">semantic_query</a>
|
111
111
|
<a href="#M000014">undelete</a>
|
112
112
|
<a href="#M000018">upload</a>
|
113
|
+
<a href="#M000031">valid_page?</a>
|
114
|
+
<a href="#M000032">warning</a>
|
113
115
|
</div>
|
114
116
|
</div>
|
115
117
|
|
@@ -177,6 +179,10 @@ href="http://en.wikipedia.org/w/api.php">en.wikipedia.org/w/api.php</a>")
|
|
177
179
|
Options:
|
178
180
|
</p>
|
179
181
|
<dl>
|
182
|
+
<dt>:ignorewarnings</dt><dd>Log API warnings and invalid page titles, instead of aborting with an
|
183
|
+
error.
|
184
|
+
|
185
|
+
</dd>
|
180
186
|
<dt>:limit</dt><dd>Maximum number of results returned per <a
|
181
187
|
href="Gateway.html#M000017">search</a> (see <a
|
182
188
|
href="http://www.mediawiki.org/wiki/API:Query_-_Lists#Limits">www.mediawiki.org/wiki/API:Query_-_Lists#Limits</a>),
|
@@ -206,22 +212,22 @@ returns 503 Service Unavailable, defaults to 10 seconds.
|
|
206
212
|
onclick="toggleCode('M000007-source');return false;">[Source]</a></p>
|
207
213
|
<div class="method-source-code" id="M000007-source">
|
208
214
|
<pre>
|
209
|
-
<span class="ruby-comment cmt"># File lib/media_wiki/gateway.rb, line
|
210
|
-
|
211
|
-
|
212
|
-
|
213
|
-
|
214
|
-
|
215
|
-
|
216
|
-
|
217
|
-
|
218
|
-
|
219
|
-
|
220
|
-
|
221
|
-
|
222
|
-
|
223
|
-
|
224
|
-
|
215
|
+
<span class="ruby-comment cmt"># File lib/media_wiki/gateway.rb, line 24</span>
|
216
|
+
24: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">url</span>, <span class="ruby-identifier">options</span>={})
|
217
|
+
25: <span class="ruby-identifier">default_options</span> = {
|
218
|
+
26: <span class="ruby-identifier">:limit</span> =<span class="ruby-operator">></span> <span class="ruby-value">500</span>,
|
219
|
+
27: <span class="ruby-identifier">:loglevel</span> =<span class="ruby-operator">></span> <span class="ruby-constant">Logger</span><span class="ruby-operator">::</span><span class="ruby-constant">WARN</span>,
|
220
|
+
28: <span class="ruby-identifier">:maxlag</span> =<span class="ruby-operator">></span> <span class="ruby-value">5</span>,
|
221
|
+
29: <span class="ruby-identifier">:retry_count</span> =<span class="ruby-operator">></span> <span class="ruby-value">3</span>,
|
222
|
+
30: <span class="ruby-identifier">:retry_delay</span> =<span class="ruby-operator">></span> <span class="ruby-value">10</span>
|
223
|
+
31: }
|
224
|
+
32: <span class="ruby-ivar">@options</span> = <span class="ruby-identifier">default_options</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">options</span>)
|
225
|
+
33: <span class="ruby-ivar">@wiki_url</span> = <span class="ruby-identifier">url</span>
|
226
|
+
34: <span class="ruby-ivar">@log</span> = <span class="ruby-constant">Logger</span>.<span class="ruby-identifier">new</span>(<span class="ruby-constant">STDERR</span>)
|
227
|
+
35: <span class="ruby-ivar">@log</span>.<span class="ruby-identifier">level</span> = <span class="ruby-ivar">@options</span>[<span class="ruby-identifier">:loglevel</span>]
|
228
|
+
36: <span class="ruby-ivar">@headers</span> = { <span class="ruby-value str">"User-Agent"</span> =<span class="ruby-operator">></span> <span class="ruby-node">"MediaWiki::Gateway/#{MediaWiki::VERSION}"</span> }
|
229
|
+
37: <span class="ruby-ivar">@cookies</span> = {}
|
230
|
+
38: <span class="ruby-keyword kw">end</span>
|
225
231
|
</pre>
|
226
232
|
</div>
|
227
233
|
</div>
|
@@ -259,23 +265,23 @@ Returns array of page titles (empty if no matches)
|
|
259
265
|
onclick="toggleCode('M000016-source');return false;">[Source]</a></p>
|
260
266
|
<div class="method-source-code" id="M000016-source">
|
261
267
|
<pre>
|
262
|
-
<span class="ruby-comment cmt"># File lib/media_wiki/gateway.rb, line
|
263
|
-
|
264
|
-
|
265
|
-
|
266
|
-
|
267
|
-
|
268
|
-
|
269
|
-
|
270
|
-
|
271
|
-
|
272
|
-
|
273
|
-
|
274
|
-
|
275
|
-
|
276
|
-
|
277
|
-
|
278
|
-
|
268
|
+
<span class="ruby-comment cmt"># File lib/media_wiki/gateway.rb, line 196</span>
|
269
|
+
196: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">backlinks</span>(<span class="ruby-identifier">title</span>, <span class="ruby-identifier">filter</span> = <span class="ruby-value str">"all"</span>)
|
270
|
+
197: <span class="ruby-identifier">titles</span> = []
|
271
|
+
198: <span class="ruby-identifier">blcontinue</span> = <span class="ruby-keyword kw">nil</span>
|
272
|
+
199: <span class="ruby-keyword kw">begin</span>
|
273
|
+
200: <span class="ruby-identifier">form_data</span> =
|
274
|
+
201: {<span class="ruby-value str">'action'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'query'</span>,
|
275
|
+
202: <span class="ruby-value str">'list'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'backlinks'</span>,
|
276
|
+
203: <span class="ruby-value str">'bltitle'</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">title</span>,
|
277
|
+
204: <span class="ruby-value str">'blfilterredir'</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">filter</span>,
|
278
|
+
205: <span class="ruby-value str">'bllimit'</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@options</span>[<span class="ruby-identifier">:limit</span>] }
|
279
|
+
206: <span class="ruby-identifier">form_data</span>[<span class="ruby-value str">'blcontinue'</span>] = <span class="ruby-identifier">blcontinue</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">blcontinue</span>
|
280
|
+
207: <span class="ruby-identifier">res</span>, <span class="ruby-identifier">blcontinue</span> = <span class="ruby-identifier">make_api_request</span>(<span class="ruby-identifier">form_data</span>, <span class="ruby-value str">'//query-continue/backlinks/@blcontinue'</span>)
|
281
|
+
208: <span class="ruby-identifier">titles</span> <span class="ruby-operator">+=</span> <span class="ruby-constant">REXML</span><span class="ruby-operator">::</span><span class="ruby-constant">XPath</span>.<span class="ruby-identifier">match</span>(<span class="ruby-identifier">res</span>, <span class="ruby-value str">"//bl"</span>).<span class="ruby-identifier">map</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">x</span><span class="ruby-operator">|</span> <span class="ruby-identifier">x</span>.<span class="ruby-identifier">attributes</span>[<span class="ruby-value str">"title"</span>] }
|
282
|
+
209: <span class="ruby-keyword kw">end</span> <span class="ruby-keyword kw">while</span> <span class="ruby-identifier">blcontinue</span>
|
283
|
+
210: <span class="ruby-identifier">titles</span>
|
284
|
+
211: <span class="ruby-keyword kw">end</span>
|
279
285
|
</pre>
|
280
286
|
</div>
|
281
287
|
</div>
|
@@ -326,12 +332,12 @@ href="Gateway.html#M000007">new</a> one (useful for bulk loads)
|
|
326
332
|
onclick="toggleCode('M000011-source');return false;">[Source]</a></p>
|
327
333
|
<div class="method-source-code" id="M000011-source">
|
328
334
|
<pre>
|
329
|
-
<span class="ruby-comment cmt"># File lib/media_wiki/gateway.rb, line
|
330
|
-
|
331
|
-
|
332
|
-
|
333
|
-
|
334
|
-
|
335
|
+
<span class="ruby-comment cmt"># File lib/media_wiki/gateway.rb, line 116</span>
|
336
|
+
116: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">create</span>(<span class="ruby-identifier">title</span>, <span class="ruby-identifier">content</span>, <span class="ruby-identifier">options</span>={})
|
337
|
+
117: <span class="ruby-identifier">form_data</span> = {<span class="ruby-value str">'action'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'edit'</span>, <span class="ruby-value str">'title'</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">title</span>, <span class="ruby-value str">'text'</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">content</span>, <span class="ruby-value str">'summary'</span> =<span class="ruby-operator">></span> (<span class="ruby-identifier">options</span>[<span class="ruby-identifier">:summary</span>] <span class="ruby-operator">||</span> <span class="ruby-value str">""</span>), <span class="ruby-value str">'token'</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">get_token</span>(<span class="ruby-value str">'edit'</span>, <span class="ruby-identifier">title</span>)}
|
338
|
+
118: <span class="ruby-identifier">form_data</span>[<span class="ruby-value str">'createonly'</span>] = <span class="ruby-value str">""</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:overwrite</span>]
|
339
|
+
119: <span class="ruby-identifier">make_api_request</span>(<span class="ruby-identifier">form_data</span>)
|
340
|
+
120: <span class="ruby-keyword kw">end</span>
|
335
341
|
</pre>
|
336
342
|
</div>
|
337
343
|
</div>
|
@@ -360,11 +366,11 @@ support deleting multiple pages at a time.)
|
|
360
366
|
onclick="toggleCode('M000013-source');return false;">[Source]</a></p>
|
361
367
|
<div class="method-source-code" id="M000013-source">
|
362
368
|
<pre>
|
363
|
-
<span class="ruby-comment cmt"># File lib/media_wiki/gateway.rb, line
|
364
|
-
|
365
|
-
|
366
|
-
|
367
|
-
|
369
|
+
<span class="ruby-comment cmt"># File lib/media_wiki/gateway.rb, line 146</span>
|
370
|
+
146: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">delete</span>(<span class="ruby-identifier">title</span>)
|
371
|
+
147: <span class="ruby-identifier">form_data</span> = {<span class="ruby-value str">'action'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'delete'</span>, <span class="ruby-value str">'title'</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">title</span>, <span class="ruby-value str">'token'</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">get_token</span>(<span class="ruby-value str">'delete'</span>, <span class="ruby-identifier">title</span>)}
|
372
|
+
148: <span class="ruby-identifier">make_api_request</span>(<span class="ruby-identifier">form_data</span>)
|
373
|
+
149: <span class="ruby-keyword kw">end</span>
|
368
374
|
</pre>
|
369
375
|
</div>
|
370
376
|
</div>
|
@@ -391,17 +397,17 @@ href="Gateway.html#M000021">download</a>.
|
|
391
397
|
onclick="toggleCode('M000021-source');return false;">[Source]</a></p>
|
392
398
|
<div class="method-source-code" id="M000021-source">
|
393
399
|
<pre>
|
394
|
-
<span class="ruby-comment cmt"># File lib/media_wiki/gateway.rb, line
|
395
|
-
|
396
|
-
|
397
|
-
|
398
|
-
|
399
|
-
|
400
|
-
|
401
|
-
|
402
|
-
|
403
|
-
|
404
|
-
|
400
|
+
<span class="ruby-comment cmt"># File lib/media_wiki/gateway.rb, line 381</span>
|
401
|
+
381: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">download</span>(<span class="ruby-identifier">file_name</span>, <span class="ruby-identifier">options</span>={})
|
402
|
+
382: <span class="ruby-identifier">options</span>[<span class="ruby-value str">'iiprop'</span>] = <span class="ruby-value str">'url'</span>
|
403
|
+
383:
|
404
|
+
384: <span class="ruby-identifier">attributes</span> = <span class="ruby-identifier">image_info</span>(<span class="ruby-identifier">file_name</span>, <span class="ruby-identifier">options</span>)
|
405
|
+
385: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">attributes</span>
|
406
|
+
386: <span class="ruby-constant">RestClient</span>.<span class="ruby-identifier">get</span> <span class="ruby-identifier">attributes</span>[<span class="ruby-value str">'url'</span>]
|
407
|
+
387: <span class="ruby-keyword kw">else</span>
|
408
|
+
388: <span class="ruby-keyword kw">nil</span>
|
409
|
+
389: <span class="ruby-keyword kw">end</span>
|
410
|
+
390: <span class="ruby-keyword kw">end</span>
|
405
411
|
</pre>
|
406
412
|
</div>
|
407
413
|
</div>
|
@@ -432,11 +438,11 @@ Returns <a href="../MediaWiki.html">MediaWiki</a> XML dump
|
|
432
438
|
onclick="toggleCode('M000023-source');return false;">[Source]</a></p>
|
433
439
|
<div class="method-source-code" id="M000023-source">
|
434
440
|
<pre>
|
435
|
-
<span class="ruby-comment cmt"># File lib/media_wiki/gateway.rb, line
|
436
|
-
|
437
|
-
|
438
|
-
|
439
|
-
|
441
|
+
<span class="ruby-comment cmt"># File lib/media_wiki/gateway.rb, line 412</span>
|
442
|
+
412: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">export</span>(<span class="ruby-identifier">page_titles</span>)
|
443
|
+
413: <span class="ruby-identifier">form_data</span> = {<span class="ruby-value str">'action'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'query'</span>, <span class="ruby-value str">'titles'</span> =<span class="ruby-operator">></span> [<span class="ruby-identifier">page_titles</span>].<span class="ruby-identifier">join</span>(<span class="ruby-value str">'|'</span>), <span class="ruby-value str">'export'</span> =<span class="ruby-operator">></span> <span class="ruby-keyword kw">nil</span>, <span class="ruby-value str">'exportnowrap'</span> =<span class="ruby-operator">></span> <span class="ruby-keyword kw">nil</span>}
|
444
|
+
414: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">make_api_request</span>(<span class="ruby-identifier">form_data</span>)
|
445
|
+
415: <span class="ruby-keyword kw">end</span>
|
440
446
|
</pre>
|
441
447
|
</div>
|
442
448
|
</div>
|
@@ -464,16 +470,16 @@ version)
|
|
464
470
|
onclick="toggleCode('M000025-source');return false;">[Source]</a></p>
|
465
471
|
<div class="method-source-code" id="M000025-source">
|
466
472
|
<pre>
|
467
|
-
<span class="ruby-comment cmt"># File lib/media_wiki/gateway.rb, line
|
468
|
-
|
469
|
-
|
470
|
-
|
471
|
-
|
472
|
-
|
473
|
-
|
474
|
-
|
475
|
-
|
476
|
-
|
473
|
+
<span class="ruby-comment cmt"># File lib/media_wiki/gateway.rb, line 433</span>
|
474
|
+
433: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">extensions</span>
|
475
|
+
434: <span class="ruby-identifier">form_data</span> = { <span class="ruby-value str">'action'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'query'</span>, <span class="ruby-value str">'meta'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'siteinfo'</span>, <span class="ruby-value str">'siprop'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'extensions'</span> }
|
476
|
+
435: <span class="ruby-identifier">res</span> = <span class="ruby-identifier">make_api_request</span>(<span class="ruby-identifier">form_data</span>)
|
477
|
+
436: <span class="ruby-constant">REXML</span><span class="ruby-operator">::</span><span class="ruby-constant">XPath</span>.<span class="ruby-identifier">match</span>(<span class="ruby-identifier">res</span>, <span class="ruby-value str">"//ext"</span>).<span class="ruby-identifier">inject</span>(<span class="ruby-constant">Hash</span>.<span class="ruby-identifier">new</span>) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">extensions</span>, <span class="ruby-identifier">extension</span><span class="ruby-operator">|</span>
|
478
|
+
437: <span class="ruby-identifier">name</span> = <span class="ruby-identifier">extension</span>.<span class="ruby-identifier">attributes</span>[<span class="ruby-value str">"name"</span>] <span class="ruby-operator">||</span> <span class="ruby-value str">""</span>
|
479
|
+
438: <span class="ruby-identifier">extensions</span>[<span class="ruby-identifier">name</span>] = <span class="ruby-identifier">extension</span>.<span class="ruby-identifier">attributes</span>[<span class="ruby-value str">"version"</span>]
|
480
|
+
439: <span class="ruby-identifier">extensions</span>
|
481
|
+
440: <span class="ruby-keyword kw">end</span>
|
482
|
+
441: <span class="ruby-keyword kw">end</span>
|
477
483
|
</pre>
|
478
484
|
</div>
|
479
485
|
</div>
|
@@ -505,16 +511,14 @@ Returns content of page as string, nil if the page does not exist.
|
|
505
511
|
onclick="toggleCode('M000009-source');return false;">[Source]</a></p>
|
506
512
|
<div class="method-source-code" id="M000009-source">
|
507
513
|
<pre>
|
508
|
-
<span class="ruby-comment cmt"># File lib/media_wiki/gateway.rb, line
|
509
|
-
|
510
|
-
|
511
|
-
|
512
|
-
|
513
|
-
|
514
|
-
|
515
|
-
|
516
|
-
67: <span class="ruby-keyword kw">end</span>
|
517
|
-
68: <span class="ruby-keyword kw">end</span>
|
514
|
+
<span class="ruby-comment cmt"># File lib/media_wiki/gateway.rb, line 61</span>
|
515
|
+
61: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">get</span>(<span class="ruby-identifier">page_title</span>)
|
516
|
+
62: <span class="ruby-identifier">form_data</span> = {<span class="ruby-value str">'action'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'query'</span>, <span class="ruby-value str">'prop'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'revisions'</span>, <span class="ruby-value str">'rvprop'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'content'</span>, <span class="ruby-value str">'titles'</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">page_title</span>}
|
517
|
+
63: <span class="ruby-identifier">page</span> = <span class="ruby-identifier">make_api_request</span>(<span class="ruby-identifier">form_data</span>).<span class="ruby-identifier">first</span>.<span class="ruby-identifier">elements</span>[<span class="ruby-value str">"query/pages/page"</span>]
|
518
|
+
64: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">valid_page?</span> <span class="ruby-identifier">page</span>
|
519
|
+
65: <span class="ruby-identifier">page</span>.<span class="ruby-identifier">elements</span>[<span class="ruby-value str">"revisions/rev"</span>].<span class="ruby-identifier">text</span> <span class="ruby-operator">||</span> <span class="ruby-value str">""</span>
|
520
|
+
66: <span class="ruby-keyword kw">end</span>
|
521
|
+
67: <span class="ruby-keyword kw">end</span>
|
518
522
|
</pre>
|
519
523
|
</div>
|
520
524
|
</div>
|
@@ -579,34 +583,36 @@ Output:
|
|
579
583
|
onclick="toggleCode('M000020-source');return false;">[Source]</a></p>
|
580
584
|
<div class="method-source-code" id="M000020-source">
|
581
585
|
<pre>
|
582
|
-
<span class="ruby-comment cmt"># File lib/media_wiki/gateway.rb, line
|
583
|
-
|
584
|
-
|
585
|
-
|
586
|
-
|
587
|
-
|
588
|
-
|
589
|
-
|
590
|
-
|
591
|
-
|
592
|
-
|
593
|
-
|
594
|
-
|
595
|
-
|
596
|
-
|
597
|
-
|
598
|
-
|
599
|
-
|
600
|
-
|
601
|
-
|
602
|
-
|
603
|
-
|
604
|
-
|
605
|
-
|
606
|
-
|
607
|
-
|
608
|
-
|
609
|
-
|
586
|
+
<span class="ruby-comment cmt"># File lib/media_wiki/gateway.rb, line 348</span>
|
587
|
+
348: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">image_info</span>(<span class="ruby-identifier">file_name_or_page_id</span>, <span class="ruby-identifier">options</span>={})
|
588
|
+
349: <span class="ruby-identifier">options</span>[<span class="ruby-value str">'iiprop'</span>] = <span class="ruby-identifier">options</span>[<span class="ruby-value str">'iiprop'</span>].<span class="ruby-identifier">join</span>(<span class="ruby-value str">'|'</span>) \
|
589
|
+
350: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value str">'iiprop'</span>].<span class="ruby-identifier">respond_to?</span>(<span class="ruby-identifier">:join</span>)
|
590
|
+
351: <span class="ruby-identifier">form_data</span> = <span class="ruby-identifier">options</span>.<span class="ruby-identifier">merge</span>(
|
591
|
+
352: <span class="ruby-value str">'action'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'query'</span>,
|
592
|
+
353: <span class="ruby-value str">'prop'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'imageinfo'</span>,
|
593
|
+
354: <span class="ruby-value str">'redirects'</span> =<span class="ruby-operator">></span> <span class="ruby-keyword kw">true</span>
|
594
|
+
355: )
|
595
|
+
356:
|
596
|
+
357: <span class="ruby-keyword kw">case</span> <span class="ruby-identifier">file_name_or_page_id</span>
|
597
|
+
358: <span class="ruby-keyword kw">when</span> <span class="ruby-constant">Fixnum</span>
|
598
|
+
359: <span class="ruby-identifier">form_data</span>[<span class="ruby-value str">'pageids'</span>] = <span class="ruby-identifier">file_name_or_page_id</span>
|
599
|
+
360: <span class="ruby-keyword kw">else</span>
|
600
|
+
361: <span class="ruby-identifier">form_data</span>[<span class="ruby-value str">'titles'</span>] = <span class="ruby-node">"File:#{file_name_or_page_id}"</span>
|
601
|
+
362: <span class="ruby-keyword kw">end</span>
|
602
|
+
363:
|
603
|
+
364: <span class="ruby-identifier">xml</span>, <span class="ruby-identifier">dummy</span> = <span class="ruby-identifier">make_api_request</span>(<span class="ruby-identifier">form_data</span>)
|
604
|
+
365: <span class="ruby-identifier">page</span> = <span class="ruby-identifier">xml</span>.<span class="ruby-identifier">elements</span>[<span class="ruby-value str">"query/pages/page"</span>]
|
605
|
+
366: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">valid_page?</span> <span class="ruby-identifier">page</span>
|
606
|
+
367: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">xml</span>.<span class="ruby-identifier">elements</span>[<span class="ruby-value str">"query/redirects/r"</span>]
|
607
|
+
368: <span class="ruby-comment cmt"># We're dealing with redirect here.</span>
|
608
|
+
369: <span class="ruby-identifier">image_info</span>(<span class="ruby-identifier">page</span>.<span class="ruby-identifier">attributes</span>[<span class="ruby-value str">"pageid"</span>].<span class="ruby-identifier">to_i</span>, <span class="ruby-identifier">options</span>)
|
609
|
+
370: <span class="ruby-keyword kw">else</span>
|
610
|
+
371: <span class="ruby-identifier">page</span>.<span class="ruby-identifier">elements</span>[<span class="ruby-value str">"imageinfo/ii"</span>].<span class="ruby-identifier">attributes</span>
|
611
|
+
372: <span class="ruby-keyword kw">end</span>
|
612
|
+
373: <span class="ruby-keyword kw">else</span>
|
613
|
+
374: <span class="ruby-keyword kw">nil</span>
|
614
|
+
375: <span class="ruby-keyword kw">end</span>
|
615
|
+
376: <span class="ruby-keyword kw">end</span>
|
610
616
|
</pre>
|
611
617
|
</div>
|
612
618
|
</div>
|
@@ -640,14 +646,14 @@ href="Gateway.html#M000022">import</a>><page/><page/>…
|
|
640
646
|
onclick="toggleCode('M000022-source');return false;">[Source]</a></p>
|
641
647
|
<div class="method-source-code" id="M000022-source">
|
642
648
|
<pre>
|
643
|
-
<span class="ruby-comment cmt"># File lib/media_wiki/gateway.rb, line
|
644
|
-
|
645
|
-
|
646
|
-
|
647
|
-
|
648
|
-
|
649
|
-
|
650
|
-
|
649
|
+
<span class="ruby-comment cmt"># File lib/media_wiki/gateway.rb, line 399</span>
|
650
|
+
399: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">import</span>(<span class="ruby-identifier">xmlfile</span>)
|
651
|
+
400: <span class="ruby-identifier">form_data</span> = { <span class="ruby-value str">"action"</span> =<span class="ruby-operator">></span> <span class="ruby-value str">"import"</span>,
|
652
|
+
401: <span class="ruby-value str">"xml"</span> =<span class="ruby-operator">></span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">xmlfile</span>),
|
653
|
+
402: <span class="ruby-value str">"token"</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">get_token</span>(<span class="ruby-value str">'import'</span>, <span class="ruby-value str">'Main Page'</span>), <span class="ruby-comment cmt"># NB: dummy page name</span>
|
654
|
+
403: <span class="ruby-value str">"format"</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'xml'</span> }
|
655
|
+
404: <span class="ruby-identifier">make_api_request</span>(<span class="ruby-identifier">form_data</span>)
|
656
|
+
405: <span class="ruby-keyword kw">end</span>
|
651
657
|
</pre>
|
652
658
|
</div>
|
653
659
|
</div>
|
@@ -680,25 +686,25 @@ Returns array of page titles (empty if no matches)
|
|
680
686
|
onclick="toggleCode('M000015-source');return false;">[Source]</a></p>
|
681
687
|
<div class="method-source-code" id="M000015-source">
|
682
688
|
<pre>
|
683
|
-
<span class="ruby-comment cmt"># File lib/media_wiki/gateway.rb, line
|
684
|
-
|
685
|
-
|
686
|
-
|
687
|
-
|
688
|
-
|
689
|
-
|
690
|
-
|
691
|
-
|
692
|
-
|
693
|
-
|
694
|
-
|
695
|
-
|
696
|
-
|
697
|
-
|
698
|
-
|
699
|
-
|
700
|
-
|
701
|
-
|
689
|
+
<span class="ruby-comment cmt"># File lib/media_wiki/gateway.rb, line 171</span>
|
690
|
+
171: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">list</span>(<span class="ruby-identifier">key</span>)
|
691
|
+
172: <span class="ruby-identifier">titles</span> = []
|
692
|
+
173: <span class="ruby-identifier">apfrom</span> = <span class="ruby-keyword kw">nil</span>
|
693
|
+
174: <span class="ruby-identifier">key</span>, <span class="ruby-identifier">namespace</span> = <span class="ruby-identifier">key</span>.<span class="ruby-identifier">split</span>(<span class="ruby-value str">":"</span>, <span class="ruby-value">2</span>).<span class="ruby-identifier">reverse</span>
|
694
|
+
175: <span class="ruby-identifier">namespace</span> = <span class="ruby-identifier">namespaces_by_prefix</span>[<span class="ruby-identifier">namespace</span>] <span class="ruby-operator">||</span> <span class="ruby-value">0</span>
|
695
|
+
176: <span class="ruby-keyword kw">begin</span>
|
696
|
+
177: <span class="ruby-identifier">form_data</span> =
|
697
|
+
178: {<span class="ruby-value str">'action'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'query'</span>,
|
698
|
+
179: <span class="ruby-value str">'list'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'allpages'</span>,
|
699
|
+
180: <span class="ruby-value str">'apfrom'</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">apfrom</span>,
|
700
|
+
181: <span class="ruby-value str">'apprefix'</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">key</span>,
|
701
|
+
182: <span class="ruby-value str">'aplimit'</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@options</span>[<span class="ruby-identifier">:limit</span>],
|
702
|
+
183: <span class="ruby-value str">'apnamespace'</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">namespace</span>}
|
703
|
+
184: <span class="ruby-identifier">res</span>, <span class="ruby-identifier">apfrom</span> = <span class="ruby-identifier">make_api_request</span>(<span class="ruby-identifier">form_data</span>, <span class="ruby-value str">'//query-continue/allpages/@apfrom'</span>)
|
704
|
+
185: <span class="ruby-identifier">titles</span> <span class="ruby-operator">+=</span> <span class="ruby-constant">REXML</span><span class="ruby-operator">::</span><span class="ruby-constant">XPath</span>.<span class="ruby-identifier">match</span>(<span class="ruby-identifier">res</span>, <span class="ruby-value str">"//p"</span>).<span class="ruby-identifier">map</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">x</span><span class="ruby-operator">|</span> <span class="ruby-identifier">x</span>.<span class="ruby-identifier">attributes</span>[<span class="ruby-value str">"title"</span>] }
|
705
|
+
186: <span class="ruby-keyword kw">end</span> <span class="ruby-keyword kw">while</span> <span class="ruby-identifier">apfrom</span>
|
706
|
+
187: <span class="ruby-identifier">titles</span>
|
707
|
+
188: <span class="ruby-keyword kw">end</span>
|
702
708
|
</pre>
|
703
709
|
</div>
|
704
710
|
</div>
|
@@ -736,13 +742,13 @@ Throws error if <a href="Gateway.html#M000008">login</a> fails
|
|
736
742
|
onclick="toggleCode('M000008-source');return false;">[Source]</a></p>
|
737
743
|
<div class="method-source-code" id="M000008-source">
|
738
744
|
<pre>
|
739
|
-
<span class="ruby-comment cmt"># File lib/media_wiki/gateway.rb, line
|
740
|
-
|
741
|
-
|
742
|
-
|
743
|
-
|
744
|
-
|
745
|
-
|
745
|
+
<span class="ruby-comment cmt"># File lib/media_wiki/gateway.rb, line 49</span>
|
746
|
+
49: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">login</span>(<span class="ruby-identifier">username</span>, <span class="ruby-identifier">password</span>, <span class="ruby-identifier">domain</span> = <span class="ruby-value str">'local'</span>)
|
747
|
+
50: <span class="ruby-identifier">form_data</span> = {<span class="ruby-value str">'action'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'login'</span>, <span class="ruby-value str">'lgname'</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">username</span>, <span class="ruby-value str">'lgpassword'</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">password</span>, <span class="ruby-value str">'lgdomain'</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">domain</span>}
|
748
|
+
51: <span class="ruby-identifier">make_api_request</span>(<span class="ruby-identifier">form_data</span>)
|
749
|
+
52: <span class="ruby-ivar">@password</span> = <span class="ruby-identifier">password</span>
|
750
|
+
53: <span class="ruby-ivar">@username</span> = <span class="ruby-identifier">username</span>
|
751
|
+
54: <span class="ruby-keyword kw">end</span>
|
746
752
|
</pre>
|
747
753
|
</div>
|
748
754
|
</div>
|
@@ -802,14 +808,14 @@ href="Gateway.html#M000011">create</a> the redirect anyway.
|
|
802
808
|
onclick="toggleCode('M000012-source');return false;">[Source]</a></p>
|
803
809
|
<div class="method-source-code" id="M000012-source">
|
804
810
|
<pre>
|
805
|
-
<span class="ruby-comment cmt"># File lib/media_wiki/gateway.rb, line
|
806
|
-
|
807
|
-
|
808
|
-
|
809
|
-
|
810
|
-
|
811
|
-
|
812
|
-
|
811
|
+
<span class="ruby-comment cmt"># File lib/media_wiki/gateway.rb, line 135</span>
|
812
|
+
135: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">move</span>(<span class="ruby-identifier">from</span>, <span class="ruby-identifier">to</span>, <span class="ruby-identifier">options</span>={})
|
813
|
+
136: <span class="ruby-identifier">valid_options</span> = <span class="ruby-node">%w(movesubpages movetalk noredirect reason watch unwatch)</span>
|
814
|
+
137: <span class="ruby-identifier">options</span>.<span class="ruby-identifier">keys</span>.<span class="ruby-identifier">each</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">opt</span><span class="ruby-operator">|</span> <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-node">"Unknown option '#{opt}'"</span>) <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">valid_options</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">opt</span>.<span class="ruby-identifier">to_s</span>)}
|
815
|
+
138:
|
816
|
+
139: <span class="ruby-identifier">form_data</span> = <span class="ruby-identifier">options</span>.<span class="ruby-identifier">merge</span>({<span class="ruby-value str">'action'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'move'</span>, <span class="ruby-value str">'from'</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">from</span>, <span class="ruby-value str">'to'</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">to</span>, <span class="ruby-value str">'token'</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">get_token</span>(<span class="ruby-value str">'move'</span>, <span class="ruby-identifier">from</span>)})
|
817
|
+
140: <span class="ruby-identifier">make_api_request</span>(<span class="ruby-identifier">form_data</span>)
|
818
|
+
141: <span class="ruby-keyword kw">end</span>
|
813
819
|
</pre>
|
814
820
|
</div>
|
815
821
|
</div>
|
@@ -835,16 +841,16 @@ Returns array of namespaces (name => id)
|
|
835
841
|
onclick="toggleCode('M000024-source');return false;">[Source]</a></p>
|
836
842
|
<div class="method-source-code" id="M000024-source">
|
837
843
|
<pre>
|
838
|
-
<span class="ruby-comment cmt"># File lib/media_wiki/gateway.rb, line
|
839
|
-
|
840
|
-
|
841
|
-
|
842
|
-
|
843
|
-
|
844
|
-
|
845
|
-
|
846
|
-
|
847
|
-
|
844
|
+
<span class="ruby-comment cmt"># File lib/media_wiki/gateway.rb, line 420</span>
|
845
|
+
420: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">namespaces_by_prefix</span>
|
846
|
+
421: <span class="ruby-identifier">form_data</span> = { <span class="ruby-value str">'action'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'query'</span>, <span class="ruby-value str">'meta'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'siteinfo'</span>, <span class="ruby-value str">'siprop'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'namespaces'</span> }
|
847
|
+
422: <span class="ruby-identifier">res</span> = <span class="ruby-identifier">make_api_request</span>(<span class="ruby-identifier">form_data</span>)
|
848
|
+
423: <span class="ruby-constant">REXML</span><span class="ruby-operator">::</span><span class="ruby-constant">XPath</span>.<span class="ruby-identifier">match</span>(<span class="ruby-identifier">res</span>, <span class="ruby-value str">"//ns"</span>).<span class="ruby-identifier">inject</span>(<span class="ruby-constant">Hash</span>.<span class="ruby-identifier">new</span>) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">namespaces</span>, <span class="ruby-identifier">namespace</span><span class="ruby-operator">|</span>
|
849
|
+
424: <span class="ruby-identifier">prefix</span> = <span class="ruby-identifier">namespace</span>.<span class="ruby-identifier">attributes</span>[<span class="ruby-value str">"canonical"</span>] <span class="ruby-operator">||</span> <span class="ruby-value str">""</span>
|
850
|
+
425: <span class="ruby-identifier">namespaces</span>[<span class="ruby-identifier">prefix</span>] = <span class="ruby-identifier">namespace</span>.<span class="ruby-identifier">attributes</span>[<span class="ruby-value str">"id"</span>].<span class="ruby-identifier">to_i</span>
|
851
|
+
426: <span class="ruby-identifier">namespaces</span>
|
852
|
+
427: <span class="ruby-keyword kw">end</span>
|
853
|
+
428: <span class="ruby-keyword kw">end</span>
|
848
854
|
</pre>
|
849
855
|
</div>
|
850
856
|
</div>
|
@@ -876,12 +882,12 @@ not exist.
|
|
876
882
|
onclick="toggleCode('M000019-source');return false;">[Source]</a></p>
|
877
883
|
<div class="method-source-code" id="M000019-source">
|
878
884
|
<pre>
|
879
|
-
<span class="ruby-comment cmt"># File lib/media_wiki/gateway.rb, line
|
880
|
-
|
881
|
-
|
882
|
-
|
883
|
-
|
884
|
-
|
885
|
+
<span class="ruby-comment cmt"># File lib/media_wiki/gateway.rb, line 316</span>
|
886
|
+
316: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">redirect?</span>(<span class="ruby-identifier">page_title</span>)
|
887
|
+
317: <span class="ruby-identifier">form_data</span> = {<span class="ruby-value str">'action'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'query'</span>, <span class="ruby-value str">'prop'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'info'</span>, <span class="ruby-value str">'titles'</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">page_title</span>}
|
888
|
+
318: <span class="ruby-identifier">page</span> = <span class="ruby-identifier">make_api_request</span>(<span class="ruby-identifier">form_data</span>).<span class="ruby-identifier">first</span>.<span class="ruby-identifier">elements</span>[<span class="ruby-value str">"query/pages/page"</span>]
|
889
|
+
319: <span class="ruby-operator">!</span><span class="ruby-operator">!</span>(<span class="ruby-identifier">valid_page?</span>(<span class="ruby-identifier">page</span>) <span class="ruby-keyword kw">and</span> <span class="ruby-identifier">page</span>.<span class="ruby-identifier">attributes</span>[<span class="ruby-value str">"redirect"</span>])
|
890
|
+
320: <span class="ruby-keyword kw">end</span>
|
885
891
|
</pre>
|
886
892
|
</div>
|
887
893
|
</div>
|
@@ -931,32 +937,32 @@ Returns rendered page as string, or nil if the page does not exist
|
|
931
937
|
onclick="toggleCode('M000010-source');return false;">[Source]</a></p>
|
932
938
|
<div class="method-source-code" id="M000010-source">
|
933
939
|
<pre>
|
934
|
-
<span class="ruby-comment cmt"># File lib/media_wiki/gateway.rb, line
|
935
|
-
|
936
|
-
|
937
|
-
|
938
|
-
|
939
|
-
|
940
|
-
|
941
|
-
|
942
|
-
|
943
|
-
|
944
|
-
|
945
|
-
|
946
|
-
|
947
|
-
|
948
|
-
|
949
|
-
|
950
|
-
|
951
|
-
|
952
|
-
|
953
|
-
|
954
|
-
|
955
|
-
|
956
|
-
|
957
|
-
|
958
|
-
|
959
|
-
|
940
|
+
<span class="ruby-comment cmt"># File lib/media_wiki/gateway.rb, line 80</span>
|
941
|
+
80: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">render</span>(<span class="ruby-identifier">page_title</span>, <span class="ruby-identifier">options</span> = {})
|
942
|
+
81: <span class="ruby-identifier">form_data</span> = {<span class="ruby-value str">'action'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'parse'</span>, <span class="ruby-value str">'page'</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">page_title</span>}
|
943
|
+
82:
|
944
|
+
83: <span class="ruby-identifier">valid_options</span> = <span class="ruby-node">%w(linkbase noeditsections noimages)</span>
|
945
|
+
84: <span class="ruby-comment cmt"># Check options</span>
|
946
|
+
85: <span class="ruby-identifier">options</span>.<span class="ruby-identifier">keys</span>.<span class="ruby-identifier">each</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">opt</span><span class="ruby-operator">|</span> <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-node">"Unknown option '#{opt}'"</span>) <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">valid_options</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">opt</span>.<span class="ruby-identifier">to_s</span>)}
|
947
|
+
86:
|
948
|
+
87: <span class="ruby-identifier">rendered</span> = <span class="ruby-keyword kw">nil</span>
|
949
|
+
88: <span class="ruby-identifier">parsed</span> = <span class="ruby-identifier">make_api_request</span>(<span class="ruby-identifier">form_data</span>).<span class="ruby-identifier">first</span>.<span class="ruby-identifier">elements</span>[<span class="ruby-value str">"parse"</span>]
|
950
|
+
89: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">parsed</span>.<span class="ruby-identifier">attributes</span>[<span class="ruby-value str">"revid"</span>] <span class="ruby-operator">!=</span> <span class="ruby-value str">'0'</span>
|
951
|
+
90: <span class="ruby-identifier">rendered</span> = <span class="ruby-identifier">parsed</span>.<span class="ruby-identifier">elements</span>[<span class="ruby-value str">"text"</span>].<span class="ruby-identifier">text</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp re">/<!--(.|\s)*?-->/</span>, <span class="ruby-value str">''</span>)
|
952
|
+
91: <span class="ruby-comment cmt"># OPTIMIZE: unifiy the keys in +options+ like symbolize_keys! but w/o</span>
|
953
|
+
92: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value str">"linkbase"</span>] <span class="ruby-keyword kw">or</span> <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:linkbase</span>]
|
954
|
+
93: <span class="ruby-identifier">linkbase</span> = <span class="ruby-identifier">options</span>[<span class="ruby-value str">"linkbase"</span>] <span class="ruby-operator">||</span> <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:linkbase</span>]
|
955
|
+
94: <span class="ruby-identifier">rendered</span> = <span class="ruby-identifier">rendered</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp re">/\shref="\/wiki\/([\w\(\)_\-\.%\d:,]*)"/</span>, <span class="ruby-value str">' href="'</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">linkbase</span> <span class="ruby-operator">+</span> <span class="ruby-value str">'/wiki/\1"'</span>)
|
956
|
+
95: <span class="ruby-keyword kw">end</span>
|
957
|
+
96: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value str">"noeditsections"</span>] <span class="ruby-keyword kw">or</span> <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:noeditsections</span>]
|
958
|
+
97: <span class="ruby-identifier">rendered</span> = <span class="ruby-identifier">rendered</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp re">/<span class="editsection">\[.+\]<\/span>/</span>, <span class="ruby-value str">''</span>)
|
959
|
+
98: <span class="ruby-keyword kw">end</span>
|
960
|
+
99: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value str">"noimages"</span>] <span class="ruby-keyword kw">or</span> <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:noimages</span>]
|
961
|
+
100: <span class="ruby-identifier">rendered</span> = <span class="ruby-identifier">rendered</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp re">/<img.*\/>/</span>, <span class="ruby-value str">''</span>)
|
962
|
+
101: <span class="ruby-keyword kw">end</span>
|
963
|
+
102: <span class="ruby-keyword kw">end</span>
|
964
|
+
103: <span class="ruby-identifier">rendered</span>
|
965
|
+
104: <span class="ruby-keyword kw">end</span>
|
960
966
|
</pre>
|
961
967
|
</div>
|
962
968
|
</div>
|
@@ -996,29 +1002,29 @@ Returns array of page titles (empty if no matches)
|
|
996
1002
|
onclick="toggleCode('M000017-source');return false;">[Source]</a></p>
|
997
1003
|
<div class="method-source-code" id="M000017-source">
|
998
1004
|
<pre>
|
999
|
-
<span class="ruby-comment cmt"># File lib/media_wiki/gateway.rb, line
|
1000
|
-
|
1001
|
-
|
1002
|
-
|
1003
|
-
|
1004
|
-
|
1005
|
-
|
1006
|
-
|
1007
|
-
|
1008
|
-
|
1009
|
-
|
1010
|
-
|
1011
|
-
|
1012
|
-
|
1013
|
-
|
1014
|
-
|
1015
|
-
|
1016
|
-
|
1017
|
-
|
1018
|
-
|
1019
|
-
|
1020
|
-
|
1021
|
-
|
1005
|
+
<span class="ruby-comment cmt"># File lib/media_wiki/gateway.rb, line 220</span>
|
1006
|
+
220: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">search</span>(<span class="ruby-identifier">key</span>, <span class="ruby-identifier">namespaces</span>=<span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">limit</span>=<span class="ruby-ivar">@options</span>[<span class="ruby-identifier">:limit</span>])
|
1007
|
+
221: <span class="ruby-identifier">titles</span> = []
|
1008
|
+
222: <span class="ruby-identifier">offset</span> = <span class="ruby-keyword kw">nil</span>
|
1009
|
+
223: <span class="ruby-identifier">in_progress</span> = <span class="ruby-keyword kw">true</span>
|
1010
|
+
224:
|
1011
|
+
225: <span class="ruby-identifier">form_data</span> = { <span class="ruby-value str">'action'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'query'</span>,
|
1012
|
+
226: <span class="ruby-value str">'list'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'search'</span>,
|
1013
|
+
227: <span class="ruby-value str">'srwhat'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'text'</span>,
|
1014
|
+
228: <span class="ruby-value str">'srsearch'</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">key</span>,
|
1015
|
+
229: <span class="ruby-value str">'srlimit'</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">limit</span>
|
1016
|
+
230: }
|
1017
|
+
231: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">namespaces</span>
|
1018
|
+
232: <span class="ruby-identifier">namespaces</span> = [ <span class="ruby-identifier">namespaces</span> ] <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">namespaces</span>.<span class="ruby-identifier">kind_of?</span> <span class="ruby-constant">Array</span>
|
1019
|
+
233: <span class="ruby-identifier">form_data</span>[<span class="ruby-value str">'srnamespace'</span>] = <span class="ruby-identifier">namespaces</span>.<span class="ruby-identifier">map!</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">ns</span><span class="ruby-operator">|</span> <span class="ruby-identifier">namespaces_by_prefix</span>[<span class="ruby-identifier">ns</span>] <span class="ruby-keyword kw">end</span>.<span class="ruby-identifier">join</span>(<span class="ruby-value str">'|'</span>)
|
1020
|
+
234: <span class="ruby-keyword kw">end</span>
|
1021
|
+
235: <span class="ruby-keyword kw">begin</span>
|
1022
|
+
236: <span class="ruby-identifier">form_data</span>[<span class="ruby-value str">'sroffset'</span>] = <span class="ruby-identifier">offset</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">offset</span>
|
1023
|
+
237: <span class="ruby-identifier">res</span>, <span class="ruby-identifier">offset</span> = <span class="ruby-identifier">make_api_request</span>(<span class="ruby-identifier">form_data</span>, <span class="ruby-value str">'//query-continue/search/@sroffset'</span>)
|
1024
|
+
238: <span class="ruby-identifier">titles</span> <span class="ruby-operator">+=</span> <span class="ruby-constant">REXML</span><span class="ruby-operator">::</span><span class="ruby-constant">XPath</span>.<span class="ruby-identifier">match</span>(<span class="ruby-identifier">res</span>, <span class="ruby-value str">"//p"</span>).<span class="ruby-identifier">map</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">x</span><span class="ruby-operator">|</span> <span class="ruby-identifier">x</span>.<span class="ruby-identifier">attributes</span>[<span class="ruby-value str">"title"</span>] }
|
1025
|
+
239: <span class="ruby-keyword kw">end</span> <span class="ruby-keyword kw">while</span> <span class="ruby-identifier">offset</span>
|
1026
|
+
240: <span class="ruby-identifier">titles</span>
|
1027
|
+
241: <span class="ruby-keyword kw">end</span>
|
1022
1028
|
</pre>
|
1023
1029
|
</div>
|
1024
1030
|
</div>
|
@@ -1053,13 +1059,13 @@ Returns result as an HTML string
|
|
1053
1059
|
onclick="toggleCode('M000026-source');return false;">[Source]</a></p>
|
1054
1060
|
<div class="method-source-code" id="M000026-source">
|
1055
1061
|
<pre>
|
1056
|
-
<span class="ruby-comment cmt"># File lib/media_wiki/gateway.rb, line
|
1057
|
-
|
1058
|
-
|
1059
|
-
|
1060
|
-
|
1061
|
-
|
1062
|
-
|
1062
|
+
<span class="ruby-comment cmt"># File lib/media_wiki/gateway.rb, line 449</span>
|
1063
|
+
449: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">semantic_query</span>(<span class="ruby-identifier">query</span>, <span class="ruby-identifier">params</span> = [])
|
1064
|
+
450: <span class="ruby-identifier">params</span> <span class="ruby-operator"><<</span> <span class="ruby-value str">"format=list"</span>
|
1065
|
+
451: <span class="ruby-identifier">form_data</span> = { <span class="ruby-value str">'action'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'parse'</span>, <span class="ruby-value str">'prop'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'text'</span>, <span class="ruby-value str">'text'</span> =<span class="ruby-operator">></span> <span class="ruby-node">"{{#ask:#{query}|#{params.join('|')}}}"</span> }
|
1066
|
+
452: <span class="ruby-identifier">xml</span>, <span class="ruby-identifier">dummy</span> = <span class="ruby-identifier">make_api_request</span>(<span class="ruby-identifier">form_data</span>)
|
1067
|
+
453: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">xml</span>.<span class="ruby-identifier">elements</span>[<span class="ruby-value str">"parse/text"</span>].<span class="ruby-identifier">text</span>
|
1068
|
+
454: <span class="ruby-keyword kw">end</span>
|
1063
1069
|
</pre>
|
1064
1070
|
</div>
|
1065
1071
|
</div>
|
@@ -1091,16 +1097,16 @@ href="Gateway.html#M000014">undelete</a>
|
|
1091
1097
|
onclick="toggleCode('M000014-source');return false;">[Source]</a></p>
|
1092
1098
|
<div class="method-source-code" id="M000014-source">
|
1093
1099
|
<pre>
|
1094
|
-
<span class="ruby-comment cmt"># File lib/media_wiki/gateway.rb, line
|
1095
|
-
|
1096
|
-
|
1097
|
-
|
1098
|
-
|
1099
|
-
|
1100
|
-
|
1101
|
-
|
1102
|
-
|
1103
|
-
|
1100
|
+
<span class="ruby-comment cmt"># File lib/media_wiki/gateway.rb, line 156</span>
|
1101
|
+
156: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">undelete</span>(<span class="ruby-identifier">title</span>)
|
1102
|
+
157: <span class="ruby-identifier">token</span> = <span class="ruby-identifier">get_undelete_token</span>(<span class="ruby-identifier">title</span>)
|
1103
|
+
158: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">token</span>
|
1104
|
+
159: <span class="ruby-identifier">form_data</span> = {<span class="ruby-value str">'action'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'undelete'</span>, <span class="ruby-value str">'title'</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">title</span>, <span class="ruby-value str">'token'</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">token</span> }
|
1105
|
+
160: <span class="ruby-identifier">make_api_request</span>(<span class="ruby-identifier">form_data</span>).<span class="ruby-identifier">first</span>.<span class="ruby-identifier">elements</span>[<span class="ruby-value str">"undelete"</span>].<span class="ruby-identifier">attributes</span>[<span class="ruby-value str">"revisions"</span>].<span class="ruby-identifier">to_i</span>
|
1106
|
+
161: <span class="ruby-keyword kw">else</span>
|
1107
|
+
162: <span class="ruby-value">0</span> <span class="ruby-comment cmt"># No revisions to undelete</span>
|
1108
|
+
163: <span class="ruby-keyword kw">end</span>
|
1109
|
+
164: <span class="ruby-keyword kw">end</span>
|
1104
1110
|
</pre>
|
1105
1111
|
</div>
|
1106
1112
|
</div>
|
@@ -1203,40 +1209,40 @@ Examples:
|
|
1203
1209
|
onclick="toggleCode('M000018-source');return false;">[Source]</a></p>
|
1204
1210
|
<div class="method-source-code" id="M000018-source">
|
1205
1211
|
<pre>
|
1206
|
-
<span class="ruby-comment cmt"># File lib/media_wiki/gateway.rb, line
|
1207
|
-
|
1208
|
-
|
1209
|
-
|
1210
|
-
|
1211
|
-
|
1212
|
-
|
1213
|
-
|
1214
|
-
|
1215
|
-
|
1216
|
-
|
1217
|
-
|
1218
|
-
|
1219
|
-
|
1220
|
-
|
1221
|
-
|
1222
|
-
|
1223
|
-
|
1224
|
-
|
1225
|
-
|
1226
|
-
|
1227
|
-
|
1228
|
-
|
1229
|
-
|
1230
|
-
|
1231
|
-
|
1232
|
-
|
1233
|
-
|
1234
|
-
|
1235
|
-
|
1236
|
-
|
1237
|
-
|
1238
|
-
|
1239
|
-
|
1212
|
+
<span class="ruby-comment cmt"># File lib/media_wiki/gateway.rb, line 277</span>
|
1213
|
+
277: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">upload</span>(<span class="ruby-identifier">path</span>, <span class="ruby-identifier">options</span>={})
|
1214
|
+
278: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:description</span>]
|
1215
|
+
279: <span class="ruby-identifier">options</span>[<span class="ruby-value str">'text'</span>] = <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:description</span>]
|
1216
|
+
280: <span class="ruby-identifier">options</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">:description</span>)
|
1217
|
+
281: <span class="ruby-keyword kw">end</span>
|
1218
|
+
282:
|
1219
|
+
283: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:target</span>]
|
1220
|
+
284: <span class="ruby-identifier">options</span>[<span class="ruby-value str">'filename'</span>] = <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:target</span>]
|
1221
|
+
285: <span class="ruby-identifier">options</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">:target</span>)
|
1222
|
+
286: <span class="ruby-keyword kw">end</span>
|
1223
|
+
287:
|
1224
|
+
288: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:summary</span>]
|
1225
|
+
289: <span class="ruby-identifier">options</span>[<span class="ruby-value str">'text'</span>] <span class="ruby-operator">||=</span> <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:summary</span>]
|
1226
|
+
290: <span class="ruby-identifier">options</span>[<span class="ruby-value str">'comment'</span>] = <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:summary</span>]
|
1227
|
+
291: <span class="ruby-identifier">options</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">:summary</span>)
|
1228
|
+
292: <span class="ruby-keyword kw">end</span>
|
1229
|
+
293:
|
1230
|
+
294: <span class="ruby-identifier">options</span>[<span class="ruby-value str">'comment'</span>] <span class="ruby-operator">||=</span> <span class="ruby-value str">"Uploaded by MediaWiki::Gateway"</span>
|
1231
|
+
295: <span class="ruby-identifier">options</span>[<span class="ruby-value str">'file'</span>] = <span class="ruby-constant">File</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">path</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">path</span>
|
1232
|
+
296: <span class="ruby-identifier">full_name</span> = <span class="ruby-identifier">path</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">options</span>[<span class="ruby-value str">'url'</span>]
|
1233
|
+
297: <span class="ruby-identifier">options</span>[<span class="ruby-value str">'filename'</span>] <span class="ruby-operator">||=</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">basename</span>(<span class="ruby-identifier">full_name</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">full_name</span>
|
1234
|
+
298:
|
1235
|
+
299: <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>.<span class="ruby-identifier">new</span>(
|
1236
|
+
300: <span class="ruby-value str">"One of the 'file', 'url' or 'sessionkey' options must be specified!"</span>
|
1237
|
+
301: ) <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">options</span>[<span class="ruby-value str">'file'</span>] <span class="ruby-operator">||</span> <span class="ruby-identifier">options</span>[<span class="ruby-value str">'url'</span>] <span class="ruby-operator">||</span> <span class="ruby-identifier">options</span>[<span class="ruby-value str">'sessionkey'</span>]
|
1238
|
+
302:
|
1239
|
+
303: <span class="ruby-identifier">form_data</span> = <span class="ruby-identifier">options</span>.<span class="ruby-identifier">merge</span>(
|
1240
|
+
304: <span class="ruby-value str">'action'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'upload'</span>,
|
1241
|
+
305: <span class="ruby-value str">'token'</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">get_token</span>(<span class="ruby-value str">'edit'</span>, <span class="ruby-identifier">options</span>[<span class="ruby-value str">'filename'</span>])
|
1242
|
+
306: )
|
1243
|
+
307:
|
1244
|
+
308: <span class="ruby-identifier">make_api_request</span>(<span class="ruby-identifier">form_data</span>)
|
1245
|
+
309: <span class="ruby-keyword kw">end</span>
|
1240
1246
|
</pre>
|
1241
1247
|
</div>
|
1242
1248
|
</div>
|
@@ -1262,25 +1268,25 @@ Otherwise return XML root
|
|
1262
1268
|
onclick="toggleCode('M000030-source');return false;">[Source]</a></p>
|
1263
1269
|
<div class="method-source-code" id="M000030-source">
|
1264
1270
|
<pre>
|
1265
|
-
<span class="ruby-comment cmt"># File lib/media_wiki/gateway.rb, line
|
1266
|
-
|
1267
|
-
|
1268
|
-
|
1269
|
-
|
1270
|
-
|
1271
|
-
|
1272
|
-
|
1273
|
-
|
1274
|
-
|
1275
|
-
|
1276
|
-
|
1277
|
-
|
1278
|
-
|
1279
|
-
|
1280
|
-
|
1281
|
-
|
1282
|
-
|
1283
|
-
|
1271
|
+
<span class="ruby-comment cmt"># File lib/media_wiki/gateway.rb, line 518</span>
|
1272
|
+
518: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">get_response</span>(<span class="ruby-identifier">res</span>)
|
1273
|
+
519: <span class="ruby-keyword kw">begin</span>
|
1274
|
+
520: <span class="ruby-identifier">doc</span> = <span class="ruby-constant">REXML</span><span class="ruby-operator">::</span><span class="ruby-constant">Document</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">res</span>).<span class="ruby-identifier">root</span>
|
1275
|
+
521: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">REXML</span><span class="ruby-operator">::</span><span class="ruby-constant">ParseException</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
|
1276
|
+
522: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"Response is not XML. Are you sure you are pointing to api.php?"</span>
|
1277
|
+
523: <span class="ruby-keyword kw">end</span>
|
1278
|
+
524: <span class="ruby-identifier">log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-node">"RES: #{doc}"</span>)
|
1279
|
+
525: <span class="ruby-identifier">raise</span> <span class="ruby-node">"Response does not contain Mediawiki API XML: #{res}"</span> <span class="ruby-keyword kw">unless</span> [ <span class="ruby-value str">"api"</span>, <span class="ruby-value str">"mediawiki"</span> ].<span class="ruby-identifier">include?</span> <span class="ruby-identifier">doc</span>.<span class="ruby-identifier">name</span>
|
1280
|
+
526: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">doc</span>.<span class="ruby-identifier">elements</span>[<span class="ruby-value str">"error"</span>]
|
1281
|
+
527: <span class="ruby-identifier">code</span> = <span class="ruby-identifier">doc</span>.<span class="ruby-identifier">elements</span>[<span class="ruby-value str">"error"</span>].<span class="ruby-identifier">attributes</span>[<span class="ruby-value str">"code"</span>]
|
1282
|
+
528: <span class="ruby-identifier">info</span> = <span class="ruby-identifier">doc</span>.<span class="ruby-identifier">elements</span>[<span class="ruby-value str">"error"</span>].<span class="ruby-identifier">attributes</span>[<span class="ruby-value str">"info"</span>]
|
1283
|
+
529: <span class="ruby-identifier">raise</span> <span class="ruby-node">"API error: code '#{code}', info '#{info}'"</span>
|
1284
|
+
530: <span class="ruby-keyword kw">end</span>
|
1285
|
+
531: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">doc</span>.<span class="ruby-identifier">elements</span>[<span class="ruby-value str">"warnings"</span>]
|
1286
|
+
532: <span class="ruby-identifier">warning</span>(<span class="ruby-node">"API warning: #{doc.elements["warnings"].children.map {|e| e.text}.join(", ")}"</span>)
|
1287
|
+
533: <span class="ruby-keyword kw">end</span>
|
1288
|
+
534: <span class="ruby-identifier">doc</span>
|
1289
|
+
535: <span class="ruby-keyword kw">end</span>
|
1284
1290
|
</pre>
|
1285
1291
|
</div>
|
1286
1292
|
</div>
|
@@ -1306,14 +1312,14 @@ href="Gateway.html#M000012">move</a>’)
|
|
1306
1312
|
onclick="toggleCode('M000027-source');return false;">[Source]</a></p>
|
1307
1313
|
<div class="method-source-code" id="M000027-source">
|
1308
1314
|
<pre>
|
1309
|
-
<span class="ruby-comment cmt"># File lib/media_wiki/gateway.rb, line
|
1310
|
-
|
1311
|
-
|
1312
|
-
|
1313
|
-
|
1314
|
-
|
1315
|
-
|
1316
|
-
|
1315
|
+
<span class="ruby-comment cmt"># File lib/media_wiki/gateway.rb, line 459</span>
|
1316
|
+
459: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">get_token</span>(<span class="ruby-identifier">type</span>, <span class="ruby-identifier">page_titles</span>)
|
1317
|
+
460: <span class="ruby-identifier">form_data</span> = {<span class="ruby-value str">'action'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'query'</span>, <span class="ruby-value str">'prop'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'info'</span>, <span class="ruby-value str">'intoken'</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">type</span>, <span class="ruby-value str">'titles'</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">page_titles</span>}
|
1318
|
+
461: <span class="ruby-identifier">res</span>, <span class="ruby-identifier">dummy</span> = <span class="ruby-identifier">make_api_request</span>(<span class="ruby-identifier">form_data</span>)
|
1319
|
+
462: <span class="ruby-identifier">token</span> = <span class="ruby-identifier">res</span>.<span class="ruby-identifier">elements</span>[<span class="ruby-value str">"query/pages/page"</span>].<span class="ruby-identifier">attributes</span>[<span class="ruby-identifier">type</span> <span class="ruby-operator">+</span> <span class="ruby-value str">"token"</span>]
|
1320
|
+
463: <span class="ruby-identifier">raise</span> <span class="ruby-node">"User is not permitted to perform this operation: #{type}"</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">token</span>.<span class="ruby-identifier">nil?</span>
|
1321
|
+
464: <span class="ruby-identifier">token</span>
|
1322
|
+
465: <span class="ruby-keyword kw">end</span>
|
1317
1323
|
</pre>
|
1318
1324
|
</div>
|
1319
1325
|
</div>
|
@@ -1333,18 +1339,18 @@ href="Gateway.html#M000012">move</a>’)
|
|
1333
1339
|
onclick="toggleCode('M000028-source');return false;">[Source]</a></p>
|
1334
1340
|
<div class="method-source-code" id="M000028-source">
|
1335
1341
|
<pre>
|
1336
|
-
<span class="ruby-comment cmt"># File lib/media_wiki/gateway.rb, line
|
1337
|
-
|
1338
|
-
|
1339
|
-
|
1340
|
-
|
1341
|
-
|
1342
|
-
|
1343
|
-
|
1344
|
-
|
1345
|
-
|
1346
|
-
|
1347
|
-
|
1342
|
+
<span class="ruby-comment cmt"># File lib/media_wiki/gateway.rb, line 467</span>
|
1343
|
+
467: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">get_undelete_token</span>(<span class="ruby-identifier">page_titles</span>)
|
1344
|
+
468: <span class="ruby-identifier">form_data</span> = {<span class="ruby-value str">'action'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'query'</span>, <span class="ruby-value str">'list'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'deletedrevs'</span>, <span class="ruby-value str">'prop'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'info'</span>, <span class="ruby-value str">'drprop'</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'token'</span>, <span class="ruby-value str">'titles'</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">page_titles</span>}
|
1345
|
+
469: <span class="ruby-identifier">res</span>, <span class="ruby-identifier">dummy</span> = <span class="ruby-identifier">make_api_request</span>(<span class="ruby-identifier">form_data</span>)
|
1346
|
+
470: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">res</span>.<span class="ruby-identifier">elements</span>[<span class="ruby-value str">"query/deletedrevs/page"</span>]
|
1347
|
+
471: <span class="ruby-identifier">token</span> = <span class="ruby-identifier">res</span>.<span class="ruby-identifier">elements</span>[<span class="ruby-value str">"query/deletedrevs/page"</span>].<span class="ruby-identifier">attributes</span>[<span class="ruby-value str">"token"</span>]
|
1348
|
+
472: <span class="ruby-identifier">raise</span> <span class="ruby-node">"User is not permitted to perform this operation: #{type}"</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">token</span>.<span class="ruby-identifier">nil?</span>
|
1349
|
+
473: <span class="ruby-identifier">token</span>
|
1350
|
+
474: <span class="ruby-keyword kw">else</span>
|
1351
|
+
475: <span class="ruby-keyword kw">nil</span>
|
1352
|
+
476: <span class="ruby-keyword kw">end</span>
|
1353
|
+
477: <span class="ruby-keyword kw">end</span>
|
1348
1354
|
</pre>
|
1349
1355
|
</div>
|
1350
1356
|
</div>
|
@@ -1381,35 +1387,92 @@ Returns XML document
|
|
1381
1387
|
onclick="toggleCode('M000029-source');return false;">[Source]</a></p>
|
1382
1388
|
<div class="method-source-code" id="M000029-source">
|
1383
1389
|
<pre>
|
1384
|
-
<span class="ruby-comment cmt"># File lib/media_wiki/gateway.rb, line
|
1385
|
-
|
1386
|
-
|
1387
|
-
|
1388
|
-
|
1389
|
-
|
1390
|
-
|
1391
|
-
|
1392
|
-
|
1393
|
-
|
1394
|
-
|
1395
|
-
|
1396
|
-
|
1397
|
-
|
1398
|
-
|
1399
|
-
|
1400
|
-
|
1401
|
-
|
1402
|
-
|
1403
|
-
|
1404
|
-
|
1405
|
-
|
1406
|
-
|
1407
|
-
|
1408
|
-
|
1409
|
-
|
1410
|
-
|
1411
|
-
|
1412
|
-
|
1390
|
+
<span class="ruby-comment cmt"># File lib/media_wiki/gateway.rb, line 486</span>
|
1391
|
+
486: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">make_api_request</span>(<span class="ruby-identifier">form_data</span>, <span class="ruby-identifier">continue_xpath</span>=<span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">retry_count</span>=<span class="ruby-value">1</span>)
|
1392
|
+
487: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">form_data</span>.<span class="ruby-identifier">kind_of?</span> <span class="ruby-constant">Hash</span>
|
1393
|
+
488: <span class="ruby-identifier">form_data</span>[<span class="ruby-value str">'format'</span>] = <span class="ruby-value str">'xml'</span>
|
1394
|
+
489: <span class="ruby-identifier">form_data</span>[<span class="ruby-value str">'maxlag'</span>] = <span class="ruby-ivar">@options</span>[<span class="ruby-identifier">:maxlag</span>]
|
1395
|
+
490: <span class="ruby-keyword kw">end</span>
|
1396
|
+
491: <span class="ruby-identifier">log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-node">"REQ: #{form_data.inspect}, #{@cookies.inspect}"</span>)
|
1397
|
+
492: <span class="ruby-constant">RestClient</span>.<span class="ruby-identifier">post</span>(<span class="ruby-ivar">@wiki_url</span>, <span class="ruby-identifier">form_data</span>, <span class="ruby-ivar">@headers</span>.<span class="ruby-identifier">merge</span>({<span class="ruby-identifier">:cookies</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@cookies</span>})) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">response</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span><span class="ruby-operator">|</span>
|
1398
|
+
493: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">response</span>.<span class="ruby-identifier">code</span> <span class="ruby-operator">==</span> <span class="ruby-value">503</span> <span class="ruby-keyword kw">and</span> <span class="ruby-identifier">retry_count</span> <span class="ruby-operator"><</span> <span class="ruby-ivar">@options</span>[<span class="ruby-identifier">:retry_count</span>]
|
1399
|
+
494: <span class="ruby-identifier">log</span>.<span class="ruby-identifier">warn</span>(<span class="ruby-node">"503 Service Unavailable: #{response.body}. Retry in #{@options[:retry_delay]} seconds."</span>)
|
1400
|
+
495: <span class="ruby-identifier">sleep</span> <span class="ruby-ivar">@options</span>[<span class="ruby-identifier">:retry_delay</span>]
|
1401
|
+
496: <span class="ruby-identifier">make_api_request</span>(<span class="ruby-identifier">form_data</span>, <span class="ruby-identifier">continue_xpath</span>, <span class="ruby-identifier">retry_count</span> <span class="ruby-operator">+</span> <span class="ruby-value">1</span>)
|
1402
|
+
497: <span class="ruby-keyword kw">end</span>
|
1403
|
+
498: <span class="ruby-comment cmt"># Check response for errors and return XML</span>
|
1404
|
+
499: <span class="ruby-identifier">raise</span> <span class="ruby-node">"API error, bad response: #{response}"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">response</span>.<span class="ruby-identifier">code</span> <span class="ruby-operator">>=</span> <span class="ruby-value">200</span> <span class="ruby-keyword kw">and</span> <span class="ruby-identifier">response</span>.<span class="ruby-identifier">code</span> <span class="ruby-operator"><</span> <span class="ruby-value">300</span>
|
1405
|
+
500: <span class="ruby-identifier">doc</span> = <span class="ruby-identifier">get_response</span>(<span class="ruby-identifier">response</span>.<span class="ruby-identifier">dup</span>)
|
1406
|
+
501: <span class="ruby-keyword kw">if</span>(<span class="ruby-identifier">form_data</span>[<span class="ruby-value str">'action'</span>] <span class="ruby-operator">==</span> <span class="ruby-value str">'login'</span>)
|
1407
|
+
502: <span class="ruby-identifier">login_result</span> = <span class="ruby-identifier">doc</span>.<span class="ruby-identifier">elements</span>[<span class="ruby-value str">"login"</span>].<span class="ruby-identifier">attributes</span>[<span class="ruby-value str">'result'</span>]
|
1408
|
+
503: <span class="ruby-ivar">@cookies</span>.<span class="ruby-identifier">merge!</span>(<span class="ruby-identifier">response</span>.<span class="ruby-identifier">cookies</span>)
|
1409
|
+
504: <span class="ruby-keyword kw">case</span> <span class="ruby-identifier">login_result</span>
|
1410
|
+
505: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"Success"</span> <span class="ruby-keyword kw">then</span> <span class="ruby-comment cmt"># do nothing</span>
|
1411
|
+
506: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"NeedToken"</span> <span class="ruby-keyword kw">then</span> <span class="ruby-identifier">make_api_request</span>(<span class="ruby-identifier">form_data</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-value str">'lgtoken'</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">doc</span>.<span class="ruby-identifier">elements</span>[<span class="ruby-value str">"login"</span>].<span class="ruby-identifier">attributes</span>[<span class="ruby-value str">"token"</span>]))
|
1412
|
+
507: <span class="ruby-keyword kw">else</span> <span class="ruby-identifier">raise</span> <span class="ruby-value str">"Login failed: "</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">login_result</span>
|
1413
|
+
508: <span class="ruby-keyword kw">end</span>
|
1414
|
+
509: <span class="ruby-keyword kw">end</span>
|
1415
|
+
510: <span class="ruby-identifier">continue</span> = (<span class="ruby-identifier">continue_xpath</span> <span class="ruby-keyword kw">and</span> <span class="ruby-identifier">doc</span>.<span class="ruby-identifier">elements</span>[<span class="ruby-value str">'query-continue'</span>]) <span class="ruby-operator">?</span> <span class="ruby-constant">REXML</span><span class="ruby-operator">::</span><span class="ruby-constant">XPath</span>.<span class="ruby-identifier">first</span>(<span class="ruby-identifier">doc</span>, <span class="ruby-identifier">continue_xpath</span>).<span class="ruby-identifier">value</span> <span class="ruby-operator">:</span> <span class="ruby-keyword kw">nil</span>
|
1416
|
+
511: <span class="ruby-keyword kw">return</span> [<span class="ruby-identifier">doc</span>, <span class="ruby-identifier">continue</span>]
|
1417
|
+
512: <span class="ruby-keyword kw">end</span>
|
1418
|
+
513: <span class="ruby-keyword kw">end</span>
|
1419
|
+
</pre>
|
1420
|
+
</div>
|
1421
|
+
</div>
|
1422
|
+
</div>
|
1423
|
+
|
1424
|
+
<div id="method-M000031" class="method-detail">
|
1425
|
+
<a name="M000031"></a>
|
1426
|
+
|
1427
|
+
<div class="method-heading">
|
1428
|
+
<a href="#M000031" class="method-signature">
|
1429
|
+
<span class="method-name">valid_page?</span><span class="method-args">(page)</span>
|
1430
|
+
</a>
|
1431
|
+
</div>
|
1432
|
+
|
1433
|
+
<div class="method-description">
|
1434
|
+
<p><a class="source-toggle" href="#"
|
1435
|
+
onclick="toggleCode('M000031-source');return false;">[Source]</a></p>
|
1436
|
+
<div class="method-source-code" id="M000031-source">
|
1437
|
+
<pre>
|
1438
|
+
<span class="ruby-comment cmt"># File lib/media_wiki/gateway.rb, line 537</span>
|
1439
|
+
537: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">valid_page?</span>(<span class="ruby-identifier">page</span>)
|
1440
|
+
538: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">false</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">page</span>
|
1441
|
+
539: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">false</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">page</span>.<span class="ruby-identifier">attributes</span>[<span class="ruby-value str">"missing"</span>]
|
1442
|
+
540: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">page</span>.<span class="ruby-identifier">attributes</span>[<span class="ruby-value str">"invalid"</span>]
|
1443
|
+
541: <span class="ruby-identifier">warning</span>(<span class="ruby-node">"Invalid title '#{page.attributes["title"]}'"</span>)
|
1444
|
+
542: <span class="ruby-keyword kw">else</span>
|
1445
|
+
543: <span class="ruby-keyword kw">true</span>
|
1446
|
+
544: <span class="ruby-keyword kw">end</span>
|
1447
|
+
545: <span class="ruby-keyword kw">end</span>
|
1448
|
+
</pre>
|
1449
|
+
</div>
|
1450
|
+
</div>
|
1451
|
+
</div>
|
1452
|
+
|
1453
|
+
<div id="method-M000032" class="method-detail">
|
1454
|
+
<a name="M000032"></a>
|
1455
|
+
|
1456
|
+
<div class="method-heading">
|
1457
|
+
<a href="#M000032" class="method-signature">
|
1458
|
+
<span class="method-name">warning</span><span class="method-args">(msg)</span>
|
1459
|
+
</a>
|
1460
|
+
</div>
|
1461
|
+
|
1462
|
+
<div class="method-description">
|
1463
|
+
<p><a class="source-toggle" href="#"
|
1464
|
+
onclick="toggleCode('M000032-source');return false;">[Source]</a></p>
|
1465
|
+
<div class="method-source-code" id="M000032-source">
|
1466
|
+
<pre>
|
1467
|
+
<span class="ruby-comment cmt"># File lib/media_wiki/gateway.rb, line 547</span>
|
1468
|
+
547: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">warning</span>(<span class="ruby-identifier">msg</span>)
|
1469
|
+
548: <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@options</span>[<span class="ruby-identifier">:ignorewarnings</span>]
|
1470
|
+
549: <span class="ruby-identifier">log</span>.<span class="ruby-identifier">warn</span>(<span class="ruby-identifier">msg</span>)
|
1471
|
+
550: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">false</span>
|
1472
|
+
551: <span class="ruby-keyword kw">else</span>
|
1473
|
+
552: <span class="ruby-identifier">raise</span> <span class="ruby-identifier">msg</span>
|
1474
|
+
553: <span class="ruby-keyword kw">end</span>
|
1475
|
+
554: <span class="ruby-keyword kw">end</span>
|
1413
1476
|
</pre>
|
1414
1477
|
</div>
|
1415
1478
|
</div>
|