pingr 0.2.2 → 0.2.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,668 @@
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
+ Class: Pingr::SearchEngines::Base
8
+
9
+ &mdash; Pingr
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../../css/style.css" type="text/css" />
14
+
15
+ <link rel="stylesheet" href="../../css/common.css" type="text/css" />
16
+
17
+ <script type="text/javascript">
18
+ pathId = "Pingr::SearchEngines::Base";
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 (B)</a> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../../Pingr.html" title="Pingr (module)">Pingr</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../SearchEngines.html" title="Pingr::SearchEngines (module)">SearchEngines</a></span></span>
41
+ &raquo;
42
+ <span class="title">Base</span>
43
+
44
+ </div>
45
+
46
+ <div id="search">
47
+
48
+ <a class="full_list_link" id="class_list_link"
49
+ href="../../class_list.html">
50
+
51
+ <svg width="24" height="24">
52
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
53
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
54
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
55
+ </svg>
56
+ </a>
57
+
58
+ </div>
59
+ <div class="clear"></div>
60
+ </div>
61
+
62
+ <div id="content"><h1>Class: Pingr::SearchEngines::Base
63
+
64
+
65
+
66
+ </h1>
67
+ <div class="box_info">
68
+
69
+ <dl>
70
+ <dt>Inherits:</dt>
71
+ <dd>
72
+ <span class="inheritName">Object</span>
73
+
74
+ <ul class="fullTree">
75
+ <li>Object</li>
76
+
77
+ <li class="next">Pingr::SearchEngines::Base</li>
78
+
79
+ </ul>
80
+ <a href="#" class="inheritanceTree">show all</a>
81
+
82
+ </dd>
83
+ </dl>
84
+
85
+
86
+
87
+
88
+
89
+
90
+
91
+
92
+
93
+
94
+
95
+ <dl>
96
+ <dt>Defined in:</dt>
97
+ <dd>lib/pingr/search_engines/base.rb</dd>
98
+ </dl>
99
+
100
+ </div>
101
+
102
+ <h2>Overview</h2><div class="docstring">
103
+ <div class="discussion">
104
+ <p>The object created to ping a search engine with a sitemap</p>
105
+
106
+
107
+ </div>
108
+ </div>
109
+ <div class="tags">
110
+
111
+
112
+ </div><div id="subclasses">
113
+ <h2>Direct Known Subclasses</h2>
114
+ <p class="children"><span class='object_link'><a href="Bing.html" title="Pingr::SearchEngines::Bing (class)">Bing</a></span>, <span class='object_link'><a href="Google.html" title="Pingr::SearchEngines::Google (class)">Google</a></span></p>
115
+ </div>
116
+
117
+
118
+
119
+
120
+ <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
121
+ <ul class="summary">
122
+
123
+ <li class="public ">
124
+ <span class="summary_signature">
125
+
126
+ <a href="#sitemap_url-instance_method" title="#sitemap_url (instance method)">#<strong>sitemap_url</strong> &#x21d2; Object </a>
127
+
128
+
129
+
130
+ </span>
131
+
132
+
133
+
134
+
135
+ <span class="note title readonly">readonly</span>
136
+
137
+
138
+
139
+
140
+
141
+
142
+
143
+
144
+
145
+ <span class="summary_desc"><div class='inline'><p>Gets/Sets the String url of the sitemap we&#39;re submitting.</p>
146
+ </div></span>
147
+
148
+ </li>
149
+
150
+
151
+ </ul>
152
+
153
+
154
+
155
+
156
+
157
+ <h2>
158
+ Instance Method Summary
159
+ <small><a href="#" class="summary_toggle">collapse</a></small>
160
+ </h2>
161
+
162
+ <ul class="summary">
163
+
164
+ <li class="public ">
165
+ <span class="summary_signature">
166
+
167
+ <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(sitemap_url) &#x21d2; Object </a>
168
+
169
+
170
+
171
+ </span>
172
+
173
+
174
+ <span class="note title constructor">constructor</span>
175
+
176
+
177
+
178
+
179
+
180
+
181
+
182
+
183
+ <span class="summary_desc"><div class='inline'><p>Initialize a new ping request.</p>
184
+ </div></span>
185
+
186
+ </li>
187
+
188
+
189
+ <li class="private ">
190
+ <span class="summary_signature">
191
+
192
+ <a href="#logger-instance_method" title="#logger (instance method)">#<strong>logger</strong> &#x21d2; A </a>
193
+
194
+
195
+
196
+ </span>
197
+
198
+
199
+
200
+ <span class="note title private">private</span>
201
+
202
+
203
+
204
+
205
+
206
+ <span class="summary_desc"><div class='inline'><p>Private: A helper method to access Pingr::logger.</p>
207
+ </div></span>
208
+
209
+ </li>
210
+
211
+
212
+ <li class="public ">
213
+ <span class="summary_signature">
214
+
215
+ <a href="#ping-instance_method" title="#ping (instance method)">#<strong>ping</strong> &#x21d2; Object </a>
216
+
217
+
218
+
219
+ </span>
220
+
221
+
222
+
223
+
224
+
225
+
226
+
227
+
228
+
229
+ <span class="summary_desc"><div class='inline'><p>Perform the ping request (if in :live mode) Logs the success/failure of the ping in logger.</p>
230
+ </div></span>
231
+
232
+ </li>
233
+
234
+
235
+ <li class="private ">
236
+ <span class="summary_signature">
237
+
238
+ <a href="#ping_url-instance_method" title="#ping_url (instance method)">#<strong>ping_url</strong> &#x21d2; Object </a>
239
+
240
+
241
+
242
+ </span>
243
+
244
+
245
+
246
+ <span class="note title private">private</span>
247
+
248
+
249
+
250
+
251
+
252
+ <span class="summary_desc"><div class='inline'></div></span>
253
+
254
+ </li>
255
+
256
+
257
+ <li class="private ">
258
+ <span class="summary_signature">
259
+
260
+ <a href="#search_engine-instance_method" title="#search_engine (instance method)">#<strong>search_engine</strong> &#x21d2; Object </a>
261
+
262
+
263
+
264
+ </span>
265
+
266
+
267
+
268
+ <span class="note title private">private</span>
269
+
270
+
271
+
272
+
273
+
274
+ <span class="summary_desc"><div class='inline'></div></span>
275
+
276
+ </li>
277
+
278
+
279
+ </ul>
280
+
281
+
282
+ <div id="constructor_details" class="method_details_list">
283
+ <h2>Constructor Details</h2>
284
+
285
+ <div class="method_details first">
286
+ <h3 class="signature first" id="initialize-instance_method">
287
+
288
+ #<strong>initialize</strong>(sitemap_url) &#x21d2; <tt>Object</tt>
289
+
290
+
291
+
292
+
293
+
294
+ </h3><div class="docstring">
295
+ <div class="discussion">
296
+ <p>Initialize a new ping request</p>
297
+
298
+
299
+ </div>
300
+ </div>
301
+ <div class="tags">
302
+ <p class="tag_title">Parameters:</p>
303
+ <ul class="param">
304
+
305
+ <li>
306
+
307
+ <span class='name'>sitemap_url</span>
308
+
309
+
310
+ <span class='type'></span>
311
+
312
+
313
+
314
+ &mdash;
315
+ <div class='inline'><p>A String url of the sitemap we&#39;re submitting</p>
316
+ </div>
317
+
318
+ </li>
319
+
320
+ </ul>
321
+
322
+
323
+ </div><table class="source_code">
324
+ <tr>
325
+ <td>
326
+ <pre class="lines">
327
+
328
+
329
+ 18
330
+ 19
331
+ 20</pre>
332
+ </td>
333
+ <td>
334
+ <pre class="code"><span class="info file"># File 'lib/pingr/search_engines/base.rb', line 18</span>
335
+
336
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_sitemap_url'>sitemap_url</span><span class='rparen'>)</span>
337
+ <span class='ivar'>@sitemap_url</span> <span class='op'>=</span> <span class='id identifier rubyid_sitemap_url'>sitemap_url</span>
338
+ <span class='kw'>end</span></pre>
339
+ </td>
340
+ </tr>
341
+ </table>
342
+ </div>
343
+
344
+ </div>
345
+
346
+ <div id="instance_attr_details" class="attr_details">
347
+ <h2>Instance Attribute Details</h2>
348
+
349
+
350
+ <span id=""></span>
351
+ <div class="method_details first">
352
+ <h3 class="signature first" id="sitemap_url-instance_method">
353
+
354
+ #<strong>sitemap_url</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
355
+
356
+
357
+
358
+
359
+
360
+ </h3><div class="docstring">
361
+ <div class="discussion">
362
+ <p>Gets/Sets the String url of the sitemap we&#39;re submitting</p>
363
+
364
+
365
+ </div>
366
+ </div>
367
+ <div class="tags">
368
+
369
+
370
+ </div><table class="source_code">
371
+ <tr>
372
+ <td>
373
+ <pre class="lines">
374
+
375
+
376
+ 11
377
+ 12
378
+ 13</pre>
379
+ </td>
380
+ <td>
381
+ <pre class="code"><span class="info file"># File 'lib/pingr/search_engines/base.rb', line 11</span>
382
+
383
+ <span class='kw'>def</span> <span class='id identifier rubyid_sitemap_url'>sitemap_url</span>
384
+ <span class='ivar'>@sitemap_url</span>
385
+ <span class='kw'>end</span></pre>
386
+ </td>
387
+ </tr>
388
+ </table>
389
+ </div>
390
+
391
+ </div>
392
+
393
+
394
+ <div id="instance_method_details" class="method_details_list">
395
+ <h2>Instance Method Details</h2>
396
+
397
+
398
+ <div class="method_details first">
399
+ <h3 class="signature first" id="logger-instance_method">
400
+
401
+ #<strong>logger</strong> &#x21d2; <tt>A</tt> <span class="extras">(private)</span>
402
+
403
+
404
+
405
+
406
+
407
+ </h3><div class="docstring">
408
+ <div class="discussion">
409
+ <p>Private: A helper method to access Pingr::logger</p>
410
+
411
+
412
+ </div>
413
+ </div>
414
+ <div class="tags">
415
+
416
+ <p class="tag_title">Returns:</p>
417
+ <ul class="return">
418
+
419
+ <li>
420
+
421
+
422
+ <span class='type'>(<tt>A</tt>)</span>
423
+
424
+
425
+
426
+ &mdash;
427
+ <div class='inline'><p>Logger instance</p>
428
+ </div>
429
+
430
+ </li>
431
+
432
+ </ul>
433
+
434
+ </div><table class="source_code">
435
+ <tr>
436
+ <td>
437
+ <pre class="lines">
438
+
439
+
440
+ 57
441
+ 58
442
+ 59</pre>
443
+ </td>
444
+ <td>
445
+ <pre class="code"><span class="info file"># File 'lib/pingr/search_engines/base.rb', line 57</span>
446
+
447
+ <span class='kw'>def</span> <span class='id identifier rubyid_logger'>logger</span>
448
+ <span class='const'><span class='object_link'><a href="../../Pingr.html" title="Pingr (module)">Pingr</a></span></span><span class='period'>.</span><span class='id identifier rubyid_logger'><span class='object_link'><a href="../../Pingr.html#logger-class_method" title="Pingr.logger (method)">logger</a></span></span>
449
+ <span class='kw'>end</span></pre>
450
+ </td>
451
+ </tr>
452
+ </table>
453
+ </div>
454
+
455
+ <div class="method_details ">
456
+ <h3 class="signature " id="ping-instance_method">
457
+
458
+ #<strong>ping</strong> &#x21d2; <tt>Object</tt>
459
+
460
+
461
+
462
+
463
+
464
+ </h3><div class="docstring">
465
+ <div class="discussion">
466
+ <p>Perform the ping request (if in :live mode)
467
+ Logs the success/failure of the ping in logger.</p>
468
+
469
+
470
+ </div>
471
+ </div>
472
+ <div class="tags">
473
+
474
+ <p class="tag_title">Returns:</p>
475
+ <ul class="return">
476
+
477
+ <li>
478
+
479
+
480
+ <span class='type'></span>
481
+
482
+
483
+
484
+
485
+ <div class='inline'><p>true if ping was a success</p>
486
+ </div>
487
+
488
+ </li>
489
+
490
+ <li>
491
+
492
+
493
+ <span class='type'></span>
494
+
495
+
496
+
497
+
498
+ <div class='inline'><p>false if ping was not successful</p>
499
+ </div>
500
+
501
+ </li>
502
+
503
+ </ul>
504
+
505
+ </div><table class="source_code">
506
+ <tr>
507
+ <td>
508
+ <pre class="lines">
509
+
510
+
511
+ 27
512
+ 28
513
+ 29
514
+ 30
515
+ 31
516
+ 32
517
+ 33
518
+ 34
519
+ 35
520
+ 36
521
+ 37
522
+ 38
523
+ 39
524
+ 40
525
+ 41
526
+ 42</pre>
527
+ </td>
528
+ <td>
529
+ <pre class="code"><span class="info file"># File 'lib/pingr/search_engines/base.rb', line 27</span>
530
+
531
+ <span class='kw'>def</span> <span class='id identifier rubyid_ping'>ping</span>
532
+ <span class='kw'>return</span> <span class='kw'>true</span> <span class='kw'>unless</span> <span class='const'><span class='object_link'><a href="../../Pingr.html" title="Pingr (module)">Pingr</a></span></span><span class='period'>.</span><span class='id identifier rubyid_mode'><span class='object_link'><a href="../../Pingr.html#mode-class_method" title="Pingr.mode (method)">mode</a></span></span> <span class='op'>==</span> <span class='symbol'>:live</span>
533
+
534
+ <span class='id identifier rubyid_ssl'>ssl</span> <span class='op'>=</span> <span class='id identifier rubyid_ping_url'>ping_url</span><span class='period'>.</span><span class='id identifier rubyid_scheme'>scheme</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>https</span><span class='tstring_end'>&#39;</span></span>
535
+ <span class='const'>Net</span><span class='op'>::</span><span class='const'>HTTP</span><span class='period'>.</span><span class='id identifier rubyid_start'>start</span><span class='lparen'>(</span><span class='id identifier rubyid_ping_url'>ping_url</span><span class='period'>.</span><span class='id identifier rubyid_host'>host</span><span class='comma'>,</span> <span class='id identifier rubyid_ping_url'>ping_url</span><span class='period'>.</span><span class='id identifier rubyid_port'>port</span><span class='comma'>,</span> <span class='label'>use_ssl:</span> <span class='id identifier rubyid_ssl'>ssl</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_http'>http</span><span class='op'>|</span>
536
+ <span class='id identifier rubyid_request'>request</span> <span class='op'>=</span> <span class='const'>Net</span><span class='op'>::</span><span class='const'>HTTP</span><span class='op'>::</span><span class='const'>Get</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_ping_url'>ping_url</span><span class='rparen'>)</span>
537
+ <span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='id identifier rubyid_http'>http</span><span class='period'>.</span><span class='id identifier rubyid_request'>request</span><span class='lparen'>(</span><span class='id identifier rubyid_request'>request</span><span class='rparen'>)</span>
538
+ <span class='kw'>if</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_code'>code</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span> <span class='op'>=~</span> <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>200|301</span><span class='regexp_end'>/</span></span>
539
+ <span class='id identifier rubyid_logger'>logger</span><span class='period'>.</span><span class='id identifier rubyid_info'>info</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Pinged </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_search_engine'>search_engine</span><span class='embexpr_end'>}</span><span class='tstring_content'> Successfully - </span><span class='embexpr_beg'>#{</span><span class='const'>Time</span><span class='period'>.</span><span class='id identifier rubyid_now'>now</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
540
+ <span class='kw'>return</span> <span class='kw'>true</span>
541
+ <span class='kw'>else</span>
542
+ <span class='id identifier rubyid_logger'>logger</span><span class='period'>.</span><span class='id identifier rubyid_warn'>warn</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Error pinging </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_search_engine'>search_engine</span><span class='embexpr_end'>}</span><span class='tstring_content'>! (response code: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_code'>code</span><span class='embexpr_end'>}</span><span class='tstring_content'>)- </span><span class='embexpr_beg'>#{</span><span class='const'>Time</span><span class='period'>.</span><span class='id identifier rubyid_now'>now</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
543
+ <span class='kw'>return</span> <span class='kw'>false</span>
544
+ <span class='kw'>end</span>
545
+ <span class='kw'>end</span>
546
+ <span class='kw'>end</span></pre>
547
+ </td>
548
+ </tr>
549
+ </table>
550
+ </div>
551
+
552
+ <div class="method_details ">
553
+ <h3 class="signature " id="ping_url-instance_method">
554
+
555
+ #<strong>ping_url</strong> &#x21d2; <tt>Object</tt> <span class="extras">(private)</span>
556
+
557
+
558
+
559
+
560
+
561
+ </h3><div class="docstring">
562
+ <div class="discussion">
563
+
564
+
565
+ </div>
566
+ </div>
567
+ <div class="tags">
568
+
569
+ <p class="tag_title">Raises:</p>
570
+ <ul class="raise">
571
+
572
+ <li>
573
+
574
+
575
+ <span class='type'>(<tt>NotImplementedError</tt>)</span>
576
+
577
+
578
+
579
+ </li>
580
+
581
+ </ul>
582
+
583
+ </div><table class="source_code">
584
+ <tr>
585
+ <td>
586
+ <pre class="lines">
587
+
588
+
589
+ 46
590
+ 47
591
+ 48</pre>
592
+ </td>
593
+ <td>
594
+ <pre class="code"><span class="info file"># File 'lib/pingr/search_engines/base.rb', line 46</span>
595
+
596
+ <span class='kw'>def</span> <span class='id identifier rubyid_ping_url'>ping_url</span>
597
+ <span class='id identifier rubyid_raise'>raise</span> <span class='const'>NotImplementedError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Define ping_url in </span><span class='embexpr_beg'>#{</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
598
+ <span class='kw'>end</span></pre>
599
+ </td>
600
+ </tr>
601
+ </table>
602
+ </div>
603
+
604
+ <div class="method_details ">
605
+ <h3 class="signature " id="search_engine-instance_method">
606
+
607
+ #<strong>search_engine</strong> &#x21d2; <tt>Object</tt> <span class="extras">(private)</span>
608
+
609
+
610
+
611
+
612
+
613
+ </h3><div class="docstring">
614
+ <div class="discussion">
615
+
616
+
617
+ </div>
618
+ </div>
619
+ <div class="tags">
620
+
621
+ <p class="tag_title">Raises:</p>
622
+ <ul class="raise">
623
+
624
+ <li>
625
+
626
+
627
+ <span class='type'>(<tt>NotImplementedError</tt>)</span>
628
+
629
+
630
+
631
+ </li>
632
+
633
+ </ul>
634
+
635
+ </div><table class="source_code">
636
+ <tr>
637
+ <td>
638
+ <pre class="lines">
639
+
640
+
641
+ 50
642
+ 51
643
+ 52</pre>
644
+ </td>
645
+ <td>
646
+ <pre class="code"><span class="info file"># File 'lib/pingr/search_engines/base.rb', line 50</span>
647
+
648
+ <span class='kw'>def</span> <span class='id identifier rubyid_search_engine'>search_engine</span>
649
+ <span class='id identifier rubyid_raise'>raise</span> <span class='const'>NotImplementedError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Define search_engine in </span><span class='embexpr_beg'>#{</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
650
+ <span class='kw'>end</span></pre>
651
+ </td>
652
+ </tr>
653
+ </table>
654
+ </div>
655
+
656
+ </div>
657
+
658
+ </div>
659
+
660
+ <div id="footer">
661
+ Generated on Thu Aug 13 16:28:50 2020 by
662
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
663
+ 0.9.24 (ruby-2.6.6).
664
+ </div>
665
+
666
+ </div>
667
+ </body>
668
+ </html>