riotgames_api 0.1.1 → 0.1.2

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.
Files changed (33) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +0 -1
  3. data/.yardopts +5 -0
  4. data/LICENSE +21 -0
  5. data/README.md +1 -1
  6. data/docs/RiotAPI.html +384 -0
  7. data/docs/RiotAPI/ChampionMastery.html +1319 -0
  8. data/docs/RiotAPI/Client.html +514 -0
  9. data/docs/RiotAPI/ClientNotConfiguredError.html +124 -0
  10. data/docs/RiotAPI/InvalidRequestError.html +124 -0
  11. data/docs/RiotAPI/ResponseError.html +284 -0
  12. data/docs/RiotAPI/Summoner.html +1080 -0
  13. data/docs/_index.html +173 -0
  14. data/docs/class_list.html +51 -0
  15. data/docs/css/common.css +1 -0
  16. data/docs/css/full_list.css +58 -0
  17. data/docs/css/style.css +496 -0
  18. data/docs/file.README.html +112 -0
  19. data/docs/file_list.html +56 -0
  20. data/docs/frames.html +17 -0
  21. data/docs/index.html +112 -0
  22. data/docs/js/app.js +292 -0
  23. data/docs/js/full_list.js +216 -0
  24. data/docs/js/jquery.js +4 -0
  25. data/docs/method_list.html +307 -0
  26. data/docs/top-level-namespace.html +110 -0
  27. data/lib/riot_api.rb +14 -4
  28. data/lib/riot_api/client.rb +16 -15
  29. data/lib/riot_api/resources/champion_mastery.rb +99 -0
  30. data/lib/riot_api/resources/summoner.rb +43 -2
  31. data/lib/riot_api/version.rb +1 -1
  32. data/riotgames_api.gemspec +3 -0
  33. metadata +68 -2
data/docs/RiotAPI/Client.html ADDED
@@ -0,0 +1,514 @@
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: RiotAPI::Client
8
+
9
+ &mdash; Documentation by YARD 0.9.18
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ pathId = "RiotAPI::Client";
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 (C)</a> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../RiotAPI.html" title="RiotAPI (module)">RiotAPI</a></span></span>
41
+ &raquo;
42
+ <span class="title">Client</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: RiotAPI::Client
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">RiotAPI::Client</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/riot_api/client.rb</dd>
98
+ </dl>
99
+
100
+ </div>
101
+
102
+ <h2>Overview</h2><div class="docstring">
103
+ <div class="discussion">
104
+ <p>The +RiotAPI::Client+ class is resposible to handle HTTP requests between the library and the
105
+ Riot Games API.</p>
106
+
107
+
108
+ </div>
109
+ </div>
110
+ <div class="tags">
111
+
112
+
113
+ </div>
114
+
115
+ <h2>
116
+ Constant Summary
117
+ <small><a href="#" class="constants_summary_toggle">collapse</a></small>
118
+ </h2>
119
+
120
+ <dl class="constants">
121
+
122
+ <dt id="BASE_URLS-constant" class="">BASE_URLS =
123
+
124
+ </dt>
125
+ <dd><pre class="code"><span class='lbrace'>{</span>
126
+ <span class='comment'># Regional endpoints
127
+ </span> <span class='label'>br:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>https://br1.api.riotgames.com</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
128
+ <span class='label'>eune:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>https://eun1.api.riotgames.com</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
129
+ <span class='label'>euw:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>https://euw1.api.riotgames.com</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
130
+ <span class='label'>jp:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>https://jp1.api.riotgames.com</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
131
+ <span class='label'>kr:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>https://kr.api.riotgames.com</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
132
+ <span class='label'>lan:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>https://la1.api.riotgames.com</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
133
+ <span class='label'>las:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>https://la2.api.riotgames.com</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
134
+ <span class='label'>na:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>https://na1.api.riotgames.com</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
135
+ <span class='label'>oce:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>https://oc1.api.riotgames.com</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
136
+ <span class='label'>tr:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>https://tr1.api.riotgames.com</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
137
+ <span class='label'>ru:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>https://ru.api.riotgames.com</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
138
+ <span class='label'>pbe:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>https://pbe1.api.riotgames.com</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
139
+
140
+ <span class='comment'># Regional proxies
141
+ </span> <span class='label'>americas:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>https://americas.api.riotgames.com</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
142
+ <span class='label'>europe:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>https://europe.api.riotgames.com</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
143
+ <span class='label'>asia:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>https://asia.api.riotgames.com</span><span class='tstring_end'>&quot;</span></span>
144
+ <span class='rbrace'>}</span></pre></dd>
145
+
146
+ </dl>
147
+
148
+
149
+
150
+
151
+
152
+ <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
153
+ <ul class="summary">
154
+
155
+ <li class="public ">
156
+ <span class="summary_signature">
157
+
158
+ <a href="#api_key-instance_method" title="#api_key (instance method)">#<strong>api_key</strong> &#x21d2; Object </a>
159
+
160
+
161
+
162
+ </span>
163
+
164
+
165
+
166
+
167
+ <span class="note title readonly">readonly</span>
168
+
169
+
170
+
171
+
172
+
173
+
174
+
175
+
176
+
177
+ <span class="summary_desc"><div class='inline'><p>Returns the value of attribute api_key.</p>
178
+ </div></span>
179
+
180
+ </li>
181
+
182
+
183
+ </ul>
184
+
185
+
186
+
187
+
188
+
189
+ <h2>
190
+ Instance Method Summary
191
+ <small><a href="#" class="summary_toggle">collapse</a></small>
192
+ </h2>
193
+
194
+ <ul class="summary">
195
+
196
+ <li class="public ">
197
+ <span class="summary_signature">
198
+
199
+ <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(api_key) &#x21d2; Client </a>
200
+
201
+
202
+
203
+ </span>
204
+
205
+
206
+ <span class="note title constructor">constructor</span>
207
+
208
+
209
+
210
+
211
+
212
+
213
+
214
+
215
+ <span class="summary_desc"><div class='inline'><p>A new instance of Client.</p>
216
+ </div></span>
217
+
218
+ </li>
219
+
220
+
221
+ <li class="public ">
222
+ <span class="summary_signature">
223
+
224
+ <a href="#request-instance_method" title="#request (instance method)">#<strong>request</strong>(method, path, region, params = {}) &#x21d2; Hash </a>
225
+
226
+
227
+
228
+ </span>
229
+
230
+
231
+
232
+
233
+
234
+
235
+
236
+
237
+
238
+ <span class="summary_desc"><div class='inline'><p>Makes an HTTP request to the Riot Games API, based on the selected +region+.</p>
239
+ </div></span>
240
+
241
+ </li>
242
+
243
+
244
+ </ul>
245
+
246
+
247
+ <div id="constructor_details" class="method_details_list">
248
+ <h2>Constructor Details</h2>
249
+
250
+ <div class="method_details first">
251
+ <h3 class="signature first" id="initialize-instance_method">
252
+
253
+ #<strong>initialize</strong>(api_key) &#x21d2; <tt><span class='object_link'><a href="" title="RiotAPI::Client (class)">Client</a></span></tt>
254
+
255
+
256
+
257
+
258
+
259
+ </h3><div class="docstring">
260
+ <div class="discussion">
261
+ <p>Returns a new instance of Client</p>
262
+
263
+
264
+ </div>
265
+ </div>
266
+ <div class="tags">
267
+
268
+
269
+ </div><table class="source_code">
270
+ <tr>
271
+ <td>
272
+ <pre class="lines">
273
+
274
+
275
+ 32
276
+ 33
277
+ 34
278
+ 35
279
+ 36
280
+ 37
281
+ 38</pre>
282
+ </td>
283
+ <td>
284
+ <pre class="code"><span class="info file"># File 'lib/riot_api/client.rb', line 32</span>
285
+
286
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_api_key'>api_key</span><span class='rparen'>)</span>
287
+ <span class='kw'>if</span> <span class='id identifier rubyid_api_key'>api_key</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>||</span> <span class='id identifier rubyid_api_key'>api_key</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
288
+ <span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>The API key must be informed</span><span class='tstring_end'>&quot;</span></span>
289
+ <span class='kw'>end</span>
290
+
291
+ <span class='ivar'>@api_key</span> <span class='op'>=</span> <span class='id identifier rubyid_api_key'>api_key</span>
292
+ <span class='kw'>end</span></pre>
293
+ </td>
294
+ </tr>
295
+ </table>
296
+ </div>
297
+
298
+ </div>
299
+
300
+ <div id="instance_attr_details" class="attr_details">
301
+ <h2>Instance Attribute Details</h2>
302
+
303
+
304
+ <span id=""></span>
305
+ <div class="method_details first">
306
+ <h3 class="signature first" id="api_key-instance_method">
307
+
308
+ #<strong>api_key</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
309
+
310
+
311
+
312
+
313
+
314
+ </h3><div class="docstring">
315
+ <div class="discussion">
316
+ <p>Returns the value of attribute api_key</p>
317
+
318
+
319
+ </div>
320
+ </div>
321
+ <div class="tags">
322
+
323
+
324
+ </div><table class="source_code">
325
+ <tr>
326
+ <td>
327
+ <pre class="lines">
328
+
329
+
330
+ 9
331
+ 10
332
+ 11</pre>
333
+ </td>
334
+ <td>
335
+ <pre class="code"><span class="info file"># File 'lib/riot_api/client.rb', line 9</span>
336
+
337
+ <span class='kw'>def</span> <span class='id identifier rubyid_api_key'>api_key</span>
338
+ <span class='ivar'>@api_key</span>
339
+ <span class='kw'>end</span></pre>
340
+ </td>
341
+ </tr>
342
+ </table>
343
+ </div>
344
+
345
+ </div>
346
+
347
+
348
+ <div id="instance_method_details" class="method_details_list">
349
+ <h2>Instance Method Details</h2>
350
+
351
+
352
+ <div class="method_details first">
353
+ <h3 class="signature first" id="request-instance_method">
354
+
355
+ #<strong>request</strong>(method, path, region, params = {}) &#x21d2; <tt>Hash</tt>
356
+
357
+
358
+
359
+
360
+
361
+ </h3><div class="docstring">
362
+ <div class="discussion">
363
+ <p>Makes an HTTP request to the Riot Games API, based on the selected +region+. If the response
364
+ status is different than HTTP 200, it will raise a +RiotAPI::ResponseError+ exception.</p>
365
+
366
+
367
+ </div>
368
+ </div>
369
+ <div class="tags">
370
+ <p class="tag_title">Parameters:</p>
371
+ <ul class="param">
372
+
373
+ <li>
374
+
375
+ <span class='name'>method</span>
376
+
377
+
378
+ <span class='type'>(<tt>Symbol</tt>)</span>
379
+
380
+
381
+
382
+ &mdash;
383
+ <div class='inline'><p>The HTTP method to use, e.g.: +:get+, +:post+, etc.</p>
384
+ </div>
385
+
386
+ </li>
387
+
388
+ <li>
389
+
390
+ <span class='name'>path</span>
391
+
392
+
393
+ <span class='type'>(<tt>String</tt>)</span>
394
+
395
+
396
+
397
+ &mdash;
398
+ <div class='inline'><p>The request path, e.g.: +/matches/1+</p>
399
+ </div>
400
+
401
+ </li>
402
+
403
+ <li>
404
+
405
+ <span class='name'>region</span>
406
+
407
+
408
+ <span class='type'>(<tt>Symbol</tt>)</span>
409
+
410
+
411
+
412
+ &mdash;
413
+ <div class='inline'><p>The League of Legends region to request. The supported list of regions are listed on +RiotAPI::Client::BASE_URLS+.</p>
414
+ </div>
415
+
416
+ </li>
417
+
418
+ <li>
419
+
420
+ <span class='name'>params</span>
421
+
422
+
423
+ <span class='type'>(<tt>Hash</tt>)</span>
424
+
425
+
426
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
427
+
428
+
429
+ &mdash;
430
+ <div class='inline'><p>The request parameters, e.g.: +{ name: &quot;Example&quot; }+</p>
431
+ </div>
432
+
433
+ </li>
434
+
435
+ </ul>
436
+
437
+ <p class="tag_title">Returns:</p>
438
+ <ul class="return">
439
+
440
+ <li>
441
+
442
+
443
+ <span class='type'>(<tt>Hash</tt>)</span>
444
+
445
+
446
+
447
+ &mdash;
448
+ <div class='inline'><p>The request response</p>
449
+ </div>
450
+
451
+ </li>
452
+
453
+ </ul>
454
+
455
+ </div><table class="source_code">
456
+ <tr>
457
+ <td>
458
+ <pre class="lines">
459
+
460
+
461
+ 48
462
+ 49
463
+ 50
464
+ 51
465
+ 52
466
+ 53
467
+ 54
468
+ 55
469
+ 56
470
+ 57
471
+ 58
472
+ 59
473
+ 60
474
+ 61
475
+ 62
476
+ 63</pre>
477
+ </td>
478
+ <td>
479
+ <pre class="code"><span class="info file"># File 'lib/riot_api/client.rb', line 48</span>
480
+
481
+ <span class='kw'>def</span> <span class='id identifier rubyid_request'>request</span><span class='lparen'>(</span><span class='id identifier rubyid_method'>method</span><span class='comma'>,</span> <span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='id identifier rubyid_region'>region</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
482
+ <span class='kw'>unless</span> <span class='const'><span class='object_link'><a href="#BASE_URLS-constant" title="RiotAPI::Client::BASE_URLS (constant)">BASE_URLS</a></span></span><span class='period'>.</span><span class='id identifier rubyid_key?'>key?</span><span class='lparen'>(</span><span class='id identifier rubyid_region'>region</span><span class='rparen'>)</span>
483
+ <span class='id identifier rubyid_raise'>raise</span> <span class='const'><span class='object_link'><a href="../RiotAPI.html" title="RiotAPI (module)">RiotAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="InvalidRequestError.html" title="RiotAPI::InvalidRequestError (class)">InvalidRequestError</a></span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>The informed region is not supported. Select one of the following: </span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="#BASE_URLS-constant" title="RiotAPI::Client::BASE_URLS (constant)">BASE_URLS</a></span></span><span class='period'>.</span><span class='id identifier rubyid_keys'>keys</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
484
+ <span class='kw'>end</span>
485
+
486
+ <span class='id identifier rubyid_url'>url</span> <span class='op'>=</span> <span class='const'>URI</span><span class='period'>.</span><span class='id identifier rubyid_escape'>escape</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="#BASE_URLS-constant" title="RiotAPI::Client::BASE_URLS (constant)">BASE_URLS</a></span></span><span class='lbracket'>[</span><span class='id identifier rubyid_region'>region</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path'>path</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
487
+
488
+ <span class='id identifier rubyid_params'>params</span><span class='period'>.</span><span class='id identifier rubyid_merge!'>merge!</span><span class='lparen'>(</span><span class='lbrace'>{</span> <span class='label'>api_key:</span> <span class='ivar'>@api_key</span> <span class='rbrace'>}</span><span class='rparen'>)</span>
489
+
490
+ <span class='kw'>case</span> <span class='id identifier rubyid_method'>method</span>
491
+ <span class='kw'>when</span> <span class='symbol'>:get</span>
492
+ <span class='id identifier rubyid_request_get'>request_get</span><span class='lparen'>(</span><span class='const'>URI</span><span class='lparen'>(</span><span class='id identifier rubyid_url'>url</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
493
+ <span class='kw'>else</span>
494
+ <span class='id identifier rubyid_raise'>raise</span> <span class='const'><span class='object_link'><a href="../RiotAPI.html" title="RiotAPI (module)">RiotAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="InvalidRequestError.html" title="RiotAPI::InvalidRequestError (class)">InvalidRequestError</a></span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>The method </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_method'>method</span><span class='embexpr_end'>}</span><span class='tstring_content'> is not allowed</span><span class='tstring_end'>&quot;</span></span>
495
+ <span class='kw'>end</span>
496
+ <span class='kw'>end</span></pre>
497
+ </td>
498
+ </tr>
499
+ </table>
500
+ </div>
501
+
502
+ </div>
503
+
504
+ </div>
505
+
506
+ <div id="footer">
507
+ Generated on Mon Apr 1 18:45:16 2019 by
508
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
509
+ 0.9.18 (ruby-2.6.2).
510
+ </div>
511
+
512
+ </div>
513
+ </body>
514
+ </html>