umami-ruby 0.1.0
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.
- checksums.yaml +7 -0
- data/.yardopts +10 -0
- data/CHANGELOG.md +5 -0
- data/LICENSE.txt +21 -0
- data/README.md +118 -0
- data/Rakefile +4 -0
- data/docs/Umami/APIError.html +146 -0
- data/docs/Umami/AuthenticationError.html +142 -0
- data/docs/Umami/Client.html +6056 -0
- data/docs/Umami/ClientError.html +150 -0
- data/docs/Umami/Configuration.html +745 -0
- data/docs/Umami/ConfigurationError.html +142 -0
- data/docs/Umami/Error.html +138 -0
- data/docs/Umami/NotFoundError.html +150 -0
- data/docs/Umami/ServerError.html +150 -0
- data/docs/Umami.html +456 -0
- data/docs/_index.html +216 -0
- data/docs/class_list.html +51 -0
- data/docs/css/common.css +1 -0
- data/docs/css/full_list.css +58 -0
- data/docs/css/style.css +497 -0
- data/docs/file.CHANGELOG.html +77 -0
- data/docs/file.LICENSE.html +70 -0
- data/docs/file.README.html +182 -0
- data/docs/file_list.html +66 -0
- data/docs/frames.html +22 -0
- data/docs/index.html +182 -0
- data/docs/js/app.js +314 -0
- data/docs/js/full_list.js +216 -0
- data/docs/js/jquery.js +4 -0
- data/docs/method_list.html +475 -0
- data/docs/top-level-namespace.html +110 -0
- data/lib/umami/client.rb +599 -0
- data/lib/umami/configuration.rb +63 -0
- data/lib/umami/errors.rb +22 -0
- data/lib/umami/version.rb +5 -0
- data/lib/umami.rb +35 -0
- data/sig/umami/ruby.rbs +6 -0
- metadata +156 -0
|
@@ -0,0 +1,745 @@
|
|
|
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: Umami::Configuration
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.9.36
|
|
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 = "Umami::Configuration";
|
|
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> »
|
|
40
|
+
<span class='title'><span class='object_link'><a href="../Umami.html" title="Umami (module)">Umami</a></span></span>
|
|
41
|
+
»
|
|
42
|
+
<span class="title">Configuration</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: Umami::Configuration
|
|
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">Umami::Configuration</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/umami/configuration.rb</dd>
|
|
98
|
+
</dl>
|
|
99
|
+
|
|
100
|
+
</div>
|
|
101
|
+
|
|
102
|
+
|
|
103
|
+
|
|
104
|
+
<h2>
|
|
105
|
+
Constant Summary
|
|
106
|
+
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
|
|
107
|
+
</h2>
|
|
108
|
+
|
|
109
|
+
<dl class="constants">
|
|
110
|
+
|
|
111
|
+
<dt id="UMAMI_CLOUD_URL-constant" class="">UMAMI_CLOUD_URL =
|
|
112
|
+
|
|
113
|
+
</dt>
|
|
114
|
+
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>https://api.umami.is</span><span class='tstring_end'>"</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
|
|
115
|
+
|
|
116
|
+
</dl>
|
|
117
|
+
|
|
118
|
+
|
|
119
|
+
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
|
|
123
|
+
<ul class="summary">
|
|
124
|
+
|
|
125
|
+
<li class="public ">
|
|
126
|
+
<span class="summary_signature">
|
|
127
|
+
|
|
128
|
+
<a href="#access_token-instance_method" title="#access_token (instance method)">#<strong>access_token</strong> ⇒ Object </a>
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
</span>
|
|
133
|
+
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute access_token.</p>
|
|
146
|
+
</div></span>
|
|
147
|
+
|
|
148
|
+
</li>
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
<li class="public ">
|
|
152
|
+
<span class="summary_signature">
|
|
153
|
+
|
|
154
|
+
<a href="#password-instance_method" title="#password (instance method)">#<strong>password</strong> ⇒ Object </a>
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
</span>
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
<span class="note title readonly">readonly</span>
|
|
164
|
+
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute password.</p>
|
|
174
|
+
</div></span>
|
|
175
|
+
|
|
176
|
+
</li>
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
<li class="public ">
|
|
180
|
+
<span class="summary_signature">
|
|
181
|
+
|
|
182
|
+
<a href="#request_timeout-instance_method" title="#request_timeout (instance method)">#<strong>request_timeout</strong> ⇒ Object </a>
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
</span>
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
|
|
191
|
+
<span class="note title readonly">readonly</span>
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
|
|
201
|
+
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute request_timeout.</p>
|
|
202
|
+
</div></span>
|
|
203
|
+
|
|
204
|
+
</li>
|
|
205
|
+
|
|
206
|
+
|
|
207
|
+
<li class="public ">
|
|
208
|
+
<span class="summary_signature">
|
|
209
|
+
|
|
210
|
+
<a href="#uri_base-instance_method" title="#uri_base (instance method)">#<strong>uri_base</strong> ⇒ Object </a>
|
|
211
|
+
|
|
212
|
+
|
|
213
|
+
|
|
214
|
+
</span>
|
|
215
|
+
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
|
|
225
|
+
|
|
226
|
+
|
|
227
|
+
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute uri_base.</p>
|
|
228
|
+
</div></span>
|
|
229
|
+
|
|
230
|
+
</li>
|
|
231
|
+
|
|
232
|
+
|
|
233
|
+
<li class="public ">
|
|
234
|
+
<span class="summary_signature">
|
|
235
|
+
|
|
236
|
+
<a href="#username-instance_method" title="#username (instance method)">#<strong>username</strong> ⇒ Object </a>
|
|
237
|
+
|
|
238
|
+
|
|
239
|
+
|
|
240
|
+
</span>
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
|
|
245
|
+
<span class="note title readonly">readonly</span>
|
|
246
|
+
|
|
247
|
+
|
|
248
|
+
|
|
249
|
+
|
|
250
|
+
|
|
251
|
+
|
|
252
|
+
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute username.</p>
|
|
256
|
+
</div></span>
|
|
257
|
+
|
|
258
|
+
</li>
|
|
259
|
+
|
|
260
|
+
|
|
261
|
+
</ul>
|
|
262
|
+
|
|
263
|
+
|
|
264
|
+
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
<h2>
|
|
268
|
+
Instance Method Summary
|
|
269
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
270
|
+
</h2>
|
|
271
|
+
|
|
272
|
+
<ul class="summary">
|
|
273
|
+
|
|
274
|
+
<li class="public ">
|
|
275
|
+
<span class="summary_signature">
|
|
276
|
+
|
|
277
|
+
<a href="#cloud%3F-instance_method" title="#cloud? (instance method)">#<strong>cloud?</strong> ⇒ Boolean </a>
|
|
278
|
+
|
|
279
|
+
|
|
280
|
+
|
|
281
|
+
</span>
|
|
282
|
+
|
|
283
|
+
|
|
284
|
+
|
|
285
|
+
|
|
286
|
+
|
|
287
|
+
|
|
288
|
+
|
|
289
|
+
|
|
290
|
+
|
|
291
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
292
|
+
|
|
293
|
+
</li>
|
|
294
|
+
|
|
295
|
+
|
|
296
|
+
<li class="public ">
|
|
297
|
+
<span class="summary_signature">
|
|
298
|
+
|
|
299
|
+
<a href="#credentials=-instance_method" title="#credentials= (instance method)">#<strong>credentials=</strong>(creds) ⇒ Object </a>
|
|
300
|
+
|
|
301
|
+
|
|
302
|
+
|
|
303
|
+
</span>
|
|
304
|
+
|
|
305
|
+
|
|
306
|
+
|
|
307
|
+
|
|
308
|
+
|
|
309
|
+
|
|
310
|
+
|
|
311
|
+
|
|
312
|
+
|
|
313
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
314
|
+
|
|
315
|
+
</li>
|
|
316
|
+
|
|
317
|
+
|
|
318
|
+
<li class="public ">
|
|
319
|
+
<span class="summary_signature">
|
|
320
|
+
|
|
321
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong> ⇒ Configuration </a>
|
|
322
|
+
|
|
323
|
+
|
|
324
|
+
|
|
325
|
+
</span>
|
|
326
|
+
|
|
327
|
+
|
|
328
|
+
<span class="note title constructor">constructor</span>
|
|
329
|
+
|
|
330
|
+
|
|
331
|
+
|
|
332
|
+
|
|
333
|
+
|
|
334
|
+
|
|
335
|
+
|
|
336
|
+
|
|
337
|
+
<span class="summary_desc"><div class='inline'><p>A new instance of Configuration.</p>
|
|
338
|
+
</div></span>
|
|
339
|
+
|
|
340
|
+
</li>
|
|
341
|
+
|
|
342
|
+
|
|
343
|
+
</ul>
|
|
344
|
+
|
|
345
|
+
|
|
346
|
+
<div id="constructor_details" class="method_details_list">
|
|
347
|
+
<h2>Constructor Details</h2>
|
|
348
|
+
|
|
349
|
+
<div class="method_details first">
|
|
350
|
+
<h3 class="signature first" id="initialize-instance_method">
|
|
351
|
+
|
|
352
|
+
#<strong>initialize</strong> ⇒ <tt><span class='object_link'><a href="" title="Umami::Configuration (class)">Configuration</a></span></tt>
|
|
353
|
+
|
|
354
|
+
|
|
355
|
+
|
|
356
|
+
|
|
357
|
+
|
|
358
|
+
</h3><div class="docstring">
|
|
359
|
+
<div class="discussion">
|
|
360
|
+
<p>Returns a new instance of Configuration.</p>
|
|
361
|
+
|
|
362
|
+
|
|
363
|
+
</div>
|
|
364
|
+
</div>
|
|
365
|
+
<div class="tags">
|
|
366
|
+
|
|
367
|
+
|
|
368
|
+
</div><table class="source_code">
|
|
369
|
+
<tr>
|
|
370
|
+
<td>
|
|
371
|
+
<pre class="lines">
|
|
372
|
+
|
|
373
|
+
|
|
374
|
+
7
|
|
375
|
+
8
|
|
376
|
+
9
|
|
377
|
+
10
|
|
378
|
+
11
|
|
379
|
+
12
|
|
380
|
+
13</pre>
|
|
381
|
+
</td>
|
|
382
|
+
<td>
|
|
383
|
+
<pre class="code"><span class="info file"># File 'lib/umami/configuration.rb', line 7</span>
|
|
384
|
+
|
|
385
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span>
|
|
386
|
+
<span class='ivar'>@uri_base</span> <span class='op'>=</span> <span class='kw'>nil</span>
|
|
387
|
+
<span class='ivar'>@request_timeout</span> <span class='op'>=</span> <span class='int'>120</span>
|
|
388
|
+
<span class='ivar'>@access_token</span> <span class='op'>=</span> <span class='kw'>nil</span>
|
|
389
|
+
<span class='ivar'>@username</span> <span class='op'>=</span> <span class='kw'>nil</span>
|
|
390
|
+
<span class='ivar'>@password</span> <span class='op'>=</span> <span class='kw'>nil</span>
|
|
391
|
+
<span class='kw'>end</span></pre>
|
|
392
|
+
</td>
|
|
393
|
+
</tr>
|
|
394
|
+
</table>
|
|
395
|
+
</div>
|
|
396
|
+
|
|
397
|
+
</div>
|
|
398
|
+
|
|
399
|
+
<div id="instance_attr_details" class="attr_details">
|
|
400
|
+
<h2>Instance Attribute Details</h2>
|
|
401
|
+
|
|
402
|
+
|
|
403
|
+
<span id="access_token=-instance_method"></span>
|
|
404
|
+
<div class="method_details first">
|
|
405
|
+
<h3 class="signature first" id="access_token-instance_method">
|
|
406
|
+
|
|
407
|
+
#<strong>access_token</strong> ⇒ <tt>Object</tt>
|
|
408
|
+
|
|
409
|
+
|
|
410
|
+
|
|
411
|
+
|
|
412
|
+
|
|
413
|
+
</h3><div class="docstring">
|
|
414
|
+
<div class="discussion">
|
|
415
|
+
<p>Returns the value of attribute access_token.</p>
|
|
416
|
+
|
|
417
|
+
|
|
418
|
+
</div>
|
|
419
|
+
</div>
|
|
420
|
+
<div class="tags">
|
|
421
|
+
|
|
422
|
+
|
|
423
|
+
</div><table class="source_code">
|
|
424
|
+
<tr>
|
|
425
|
+
<td>
|
|
426
|
+
<pre class="lines">
|
|
427
|
+
|
|
428
|
+
|
|
429
|
+
5
|
|
430
|
+
6
|
|
431
|
+
7</pre>
|
|
432
|
+
</td>
|
|
433
|
+
<td>
|
|
434
|
+
<pre class="code"><span class="info file"># File 'lib/umami/configuration.rb', line 5</span>
|
|
435
|
+
|
|
436
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_access_token'>access_token</span>
|
|
437
|
+
<span class='ivar'>@access_token</span>
|
|
438
|
+
<span class='kw'>end</span></pre>
|
|
439
|
+
</td>
|
|
440
|
+
</tr>
|
|
441
|
+
</table>
|
|
442
|
+
</div>
|
|
443
|
+
|
|
444
|
+
|
|
445
|
+
<span id=""></span>
|
|
446
|
+
<div class="method_details ">
|
|
447
|
+
<h3 class="signature " id="password-instance_method">
|
|
448
|
+
|
|
449
|
+
#<strong>password</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
|
450
|
+
|
|
451
|
+
|
|
452
|
+
|
|
453
|
+
|
|
454
|
+
|
|
455
|
+
</h3><div class="docstring">
|
|
456
|
+
<div class="discussion">
|
|
457
|
+
<p>Returns the value of attribute password.</p>
|
|
458
|
+
|
|
459
|
+
|
|
460
|
+
</div>
|
|
461
|
+
</div>
|
|
462
|
+
<div class="tags">
|
|
463
|
+
|
|
464
|
+
|
|
465
|
+
</div><table class="source_code">
|
|
466
|
+
<tr>
|
|
467
|
+
<td>
|
|
468
|
+
<pre class="lines">
|
|
469
|
+
|
|
470
|
+
|
|
471
|
+
5
|
|
472
|
+
6
|
|
473
|
+
7</pre>
|
|
474
|
+
</td>
|
|
475
|
+
<td>
|
|
476
|
+
<pre class="code"><span class="info file"># File 'lib/umami/configuration.rb', line 5</span>
|
|
477
|
+
|
|
478
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_password'>password</span>
|
|
479
|
+
<span class='ivar'>@password</span>
|
|
480
|
+
<span class='kw'>end</span></pre>
|
|
481
|
+
</td>
|
|
482
|
+
</tr>
|
|
483
|
+
</table>
|
|
484
|
+
</div>
|
|
485
|
+
|
|
486
|
+
|
|
487
|
+
<span id=""></span>
|
|
488
|
+
<div class="method_details ">
|
|
489
|
+
<h3 class="signature " id="request_timeout-instance_method">
|
|
490
|
+
|
|
491
|
+
#<strong>request_timeout</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
|
492
|
+
|
|
493
|
+
|
|
494
|
+
|
|
495
|
+
|
|
496
|
+
|
|
497
|
+
</h3><div class="docstring">
|
|
498
|
+
<div class="discussion">
|
|
499
|
+
<p>Returns the value of attribute request_timeout.</p>
|
|
500
|
+
|
|
501
|
+
|
|
502
|
+
</div>
|
|
503
|
+
</div>
|
|
504
|
+
<div class="tags">
|
|
505
|
+
|
|
506
|
+
|
|
507
|
+
</div><table class="source_code">
|
|
508
|
+
<tr>
|
|
509
|
+
<td>
|
|
510
|
+
<pre class="lines">
|
|
511
|
+
|
|
512
|
+
|
|
513
|
+
5
|
|
514
|
+
6
|
|
515
|
+
7</pre>
|
|
516
|
+
</td>
|
|
517
|
+
<td>
|
|
518
|
+
<pre class="code"><span class="info file"># File 'lib/umami/configuration.rb', line 5</span>
|
|
519
|
+
|
|
520
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_request_timeout'>request_timeout</span>
|
|
521
|
+
<span class='ivar'>@request_timeout</span>
|
|
522
|
+
<span class='kw'>end</span></pre>
|
|
523
|
+
</td>
|
|
524
|
+
</tr>
|
|
525
|
+
</table>
|
|
526
|
+
</div>
|
|
527
|
+
|
|
528
|
+
|
|
529
|
+
<span id="uri_base=-instance_method"></span>
|
|
530
|
+
<div class="method_details ">
|
|
531
|
+
<h3 class="signature " id="uri_base-instance_method">
|
|
532
|
+
|
|
533
|
+
#<strong>uri_base</strong> ⇒ <tt>Object</tt>
|
|
534
|
+
|
|
535
|
+
|
|
536
|
+
|
|
537
|
+
|
|
538
|
+
|
|
539
|
+
</h3><div class="docstring">
|
|
540
|
+
<div class="discussion">
|
|
541
|
+
<p>Returns the value of attribute uri_base.</p>
|
|
542
|
+
|
|
543
|
+
|
|
544
|
+
</div>
|
|
545
|
+
</div>
|
|
546
|
+
<div class="tags">
|
|
547
|
+
|
|
548
|
+
|
|
549
|
+
</div><table class="source_code">
|
|
550
|
+
<tr>
|
|
551
|
+
<td>
|
|
552
|
+
<pre class="lines">
|
|
553
|
+
|
|
554
|
+
|
|
555
|
+
5
|
|
556
|
+
6
|
|
557
|
+
7</pre>
|
|
558
|
+
</td>
|
|
559
|
+
<td>
|
|
560
|
+
<pre class="code"><span class="info file"># File 'lib/umami/configuration.rb', line 5</span>
|
|
561
|
+
|
|
562
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_uri_base'>uri_base</span>
|
|
563
|
+
<span class='ivar'>@uri_base</span>
|
|
564
|
+
<span class='kw'>end</span></pre>
|
|
565
|
+
</td>
|
|
566
|
+
</tr>
|
|
567
|
+
</table>
|
|
568
|
+
</div>
|
|
569
|
+
|
|
570
|
+
|
|
571
|
+
<span id=""></span>
|
|
572
|
+
<div class="method_details ">
|
|
573
|
+
<h3 class="signature " id="username-instance_method">
|
|
574
|
+
|
|
575
|
+
#<strong>username</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
|
576
|
+
|
|
577
|
+
|
|
578
|
+
|
|
579
|
+
|
|
580
|
+
|
|
581
|
+
</h3><div class="docstring">
|
|
582
|
+
<div class="discussion">
|
|
583
|
+
<p>Returns the value of attribute username.</p>
|
|
584
|
+
|
|
585
|
+
|
|
586
|
+
</div>
|
|
587
|
+
</div>
|
|
588
|
+
<div class="tags">
|
|
589
|
+
|
|
590
|
+
|
|
591
|
+
</div><table class="source_code">
|
|
592
|
+
<tr>
|
|
593
|
+
<td>
|
|
594
|
+
<pre class="lines">
|
|
595
|
+
|
|
596
|
+
|
|
597
|
+
5
|
|
598
|
+
6
|
|
599
|
+
7</pre>
|
|
600
|
+
</td>
|
|
601
|
+
<td>
|
|
602
|
+
<pre class="code"><span class="info file"># File 'lib/umami/configuration.rb', line 5</span>
|
|
603
|
+
|
|
604
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_username'>username</span>
|
|
605
|
+
<span class='ivar'>@username</span>
|
|
606
|
+
<span class='kw'>end</span></pre>
|
|
607
|
+
</td>
|
|
608
|
+
</tr>
|
|
609
|
+
</table>
|
|
610
|
+
</div>
|
|
611
|
+
|
|
612
|
+
</div>
|
|
613
|
+
|
|
614
|
+
|
|
615
|
+
<div id="instance_method_details" class="method_details_list">
|
|
616
|
+
<h2>Instance Method Details</h2>
|
|
617
|
+
|
|
618
|
+
|
|
619
|
+
<div class="method_details first">
|
|
620
|
+
<h3 class="signature first" id="cloud?-instance_method">
|
|
621
|
+
|
|
622
|
+
#<strong>cloud?</strong> ⇒ <tt>Boolean</tt>
|
|
623
|
+
|
|
624
|
+
|
|
625
|
+
|
|
626
|
+
|
|
627
|
+
|
|
628
|
+
</h3><div class="docstring">
|
|
629
|
+
<div class="discussion">
|
|
630
|
+
|
|
631
|
+
|
|
632
|
+
</div>
|
|
633
|
+
</div>
|
|
634
|
+
<div class="tags">
|
|
635
|
+
|
|
636
|
+
<p class="tag_title">Returns:</p>
|
|
637
|
+
<ul class="return">
|
|
638
|
+
|
|
639
|
+
<li>
|
|
640
|
+
|
|
641
|
+
|
|
642
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
643
|
+
|
|
644
|
+
|
|
645
|
+
|
|
646
|
+
</li>
|
|
647
|
+
|
|
648
|
+
</ul>
|
|
649
|
+
|
|
650
|
+
</div><table class="source_code">
|
|
651
|
+
<tr>
|
|
652
|
+
<td>
|
|
653
|
+
<pre class="lines">
|
|
654
|
+
|
|
655
|
+
|
|
656
|
+
36
|
|
657
|
+
37
|
|
658
|
+
38</pre>
|
|
659
|
+
</td>
|
|
660
|
+
<td>
|
|
661
|
+
<pre class="code"><span class="info file"># File 'lib/umami/configuration.rb', line 36</span>
|
|
662
|
+
|
|
663
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_cloud?'>cloud?</span>
|
|
664
|
+
<span class='ivar'>@access_token</span> <span class='op'>&&</span> <span class='ivar'>@uri_base</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
|
|
665
|
+
<span class='kw'>end</span></pre>
|
|
666
|
+
</td>
|
|
667
|
+
</tr>
|
|
668
|
+
</table>
|
|
669
|
+
</div>
|
|
670
|
+
|
|
671
|
+
<div class="method_details ">
|
|
672
|
+
<h3 class="signature " id="credentials=-instance_method">
|
|
673
|
+
|
|
674
|
+
#<strong>credentials=</strong>(creds) ⇒ <tt>Object</tt>
|
|
675
|
+
|
|
676
|
+
|
|
677
|
+
|
|
678
|
+
|
|
679
|
+
|
|
680
|
+
</h3><div class="docstring">
|
|
681
|
+
<div class="discussion">
|
|
682
|
+
|
|
683
|
+
|
|
684
|
+
</div>
|
|
685
|
+
</div>
|
|
686
|
+
<div class="tags">
|
|
687
|
+
|
|
688
|
+
<p class="tag_title">Raises:</p>
|
|
689
|
+
<ul class="raise">
|
|
690
|
+
|
|
691
|
+
<li>
|
|
692
|
+
|
|
693
|
+
|
|
694
|
+
<span class='type'>(<tt><span class='object_link'><a href="ConfigurationError.html" title="Umami::ConfigurationError (class)">Umami::ConfigurationError</a></span></tt>)</span>
|
|
695
|
+
|
|
696
|
+
|
|
697
|
+
|
|
698
|
+
</li>
|
|
699
|
+
|
|
700
|
+
</ul>
|
|
701
|
+
|
|
702
|
+
</div><table class="source_code">
|
|
703
|
+
<tr>
|
|
704
|
+
<td>
|
|
705
|
+
<pre class="lines">
|
|
706
|
+
|
|
707
|
+
|
|
708
|
+
27
|
|
709
|
+
28
|
|
710
|
+
29
|
|
711
|
+
30
|
|
712
|
+
31
|
|
713
|
+
32
|
|
714
|
+
33
|
|
715
|
+
34</pre>
|
|
716
|
+
</td>
|
|
717
|
+
<td>
|
|
718
|
+
<pre class="code"><span class="info file"># File 'lib/umami/configuration.rb', line 27</span>
|
|
719
|
+
|
|
720
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_credentials='>credentials=</span><span class='lparen'>(</span><span class='id identifier rubyid_creds'>creds</span><span class='rparen'>)</span>
|
|
721
|
+
<span class='id identifier rubyid_raise'>raise</span> <span class='const'><span class='object_link'><a href="../Umami.html" title="Umami (module)">Umami</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="ConfigurationError.html" title="Umami::ConfigurationError (class)">ConfigurationError</a></span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Both username and password are required</span><span class='tstring_end'>"</span></span> <span class='kw'>unless</span> <span class='id identifier rubyid_creds'>creds</span><span class='lbracket'>[</span><span class='symbol'>:username</span><span class='rbracket'>]</span> <span class='op'>&&</span> <span class='id identifier rubyid_creds'>creds</span><span class='lbracket'>[</span><span class='symbol'>:password</span><span class='rbracket'>]</span>
|
|
722
|
+
|
|
723
|
+
<span class='ivar'>@username</span> <span class='op'>=</span> <span class='id identifier rubyid_creds'>creds</span><span class='lbracket'>[</span><span class='symbol'>:username</span><span class='rbracket'>]</span>
|
|
724
|
+
<span class='ivar'>@password</span> <span class='op'>=</span> <span class='id identifier rubyid_creds'>creds</span><span class='lbracket'>[</span><span class='symbol'>:password</span><span class='rbracket'>]</span>
|
|
725
|
+
<span class='ivar'>@access_token</span> <span class='op'>=</span> <span class='kw'>nil</span>
|
|
726
|
+
<span class='id identifier rubyid_validate_configuration'>validate_configuration</span>
|
|
727
|
+
<span class='kw'>end</span></pre>
|
|
728
|
+
</td>
|
|
729
|
+
</tr>
|
|
730
|
+
</table>
|
|
731
|
+
</div>
|
|
732
|
+
|
|
733
|
+
</div>
|
|
734
|
+
|
|
735
|
+
</div>
|
|
736
|
+
|
|
737
|
+
<div id="footer">
|
|
738
|
+
Generated on Mon Jul 22 17:42:41 2024 by
|
|
739
|
+
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
740
|
+
0.9.36 (ruby-3.2.2).
|
|
741
|
+
</div>
|
|
742
|
+
|
|
743
|
+
</div>
|
|
744
|
+
</body>
|
|
745
|
+
</html>
|