umami-ruby 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
data/docs/Umami.html ADDED
@@ -0,0 +1,456 @@
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
+ Module: Umami
8
+
9
+ &mdash; 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";
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 (U)</a> &raquo;
40
+
41
+
42
+ <span class="title">Umami</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>Module: Umami
63
+
64
+
65
+
66
+ </h1>
67
+ <div class="box_info">
68
+
69
+
70
+
71
+
72
+
73
+
74
+
75
+
76
+
77
+
78
+
79
+ <dl>
80
+ <dt>Defined in:</dt>
81
+ <dd>lib/umami.rb<span class="defines">,<br />
82
+ lib/umami/client.rb,<br /> lib/umami/errors.rb,<br /> lib/umami/version.rb,<br /> lib/umami/configuration.rb</span>
83
+ </dd>
84
+ </dl>
85
+
86
+ </div>
87
+
88
+ <h2>Defined Under Namespace</h2>
89
+ <p class="children">
90
+
91
+
92
+
93
+
94
+ <strong class="classes">Classes:</strong> <span class='object_link'><a href="Umami/APIError.html" title="Umami::APIError (class)">APIError</a></span>, <span class='object_link'><a href="Umami/AuthenticationError.html" title="Umami::AuthenticationError (class)">AuthenticationError</a></span>, <span class='object_link'><a href="Umami/Client.html" title="Umami::Client (class)">Client</a></span>, <span class='object_link'><a href="Umami/ClientError.html" title="Umami::ClientError (class)">ClientError</a></span>, <span class='object_link'><a href="Umami/Configuration.html" title="Umami::Configuration (class)">Configuration</a></span>, <span class='object_link'><a href="Umami/ConfigurationError.html" title="Umami::ConfigurationError (class)">ConfigurationError</a></span>, <span class='object_link'><a href="Umami/Error.html" title="Umami::Error (class)">Error</a></span>, <span class='object_link'><a href="Umami/NotFoundError.html" title="Umami::NotFoundError (class)">NotFoundError</a></span>, <span class='object_link'><a href="Umami/ServerError.html" title="Umami::ServerError (class)">ServerError</a></span>
95
+
96
+
97
+ </p>
98
+
99
+
100
+ <h2>
101
+ Constant Summary
102
+ <small><a href="#" class="constants_summary_toggle">collapse</a></small>
103
+ </h2>
104
+
105
+ <dl class="constants">
106
+
107
+ <dt id="VERSION-constant" class="">VERSION =
108
+
109
+ </dt>
110
+ <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>0.1.0</span><span class='tstring_end'>&quot;</span></span></pre></dd>
111
+
112
+ </dl>
113
+
114
+
115
+
116
+
117
+
118
+ <h2>Class Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
119
+ <ul class="summary">
120
+
121
+ <li class="public ">
122
+ <span class="summary_signature">
123
+
124
+ <a href="#configuration-class_method" title="configuration (class method)">.<strong>configuration</strong> &#x21d2; Object </a>
125
+
126
+
127
+
128
+ </span>
129
+
130
+
131
+
132
+
133
+
134
+
135
+
136
+
137
+
138
+
139
+
140
+
141
+ <span class="summary_desc"><div class='inline'></div></span>
142
+
143
+ </li>
144
+
145
+
146
+ <li class="public ">
147
+ <span class="summary_signature">
148
+
149
+ <a href="#logger-class_method" title="logger (class method)">.<strong>logger</strong> &#x21d2; Object </a>
150
+
151
+
152
+
153
+ </span>
154
+
155
+
156
+
157
+
158
+
159
+
160
+
161
+
162
+
163
+
164
+
165
+
166
+ <span class="summary_desc"><div class='inline'></div></span>
167
+
168
+ </li>
169
+
170
+
171
+ </ul>
172
+
173
+
174
+
175
+
176
+
177
+ <h2>
178
+ Class Method Summary
179
+ <small><a href="#" class="summary_toggle">collapse</a></small>
180
+ </h2>
181
+
182
+ <ul class="summary">
183
+
184
+ <li class="public ">
185
+ <span class="summary_signature">
186
+
187
+ <a href="#client-class_method" title="client (class method)">.<strong>client</strong>(options = {}) &#x21d2; Object </a>
188
+
189
+
190
+
191
+ </span>
192
+
193
+
194
+
195
+
196
+
197
+
198
+
199
+
200
+
201
+ <span class="summary_desc"><div class='inline'></div></span>
202
+
203
+ </li>
204
+
205
+
206
+ <li class="public ">
207
+ <span class="summary_signature">
208
+
209
+ <a href="#configure-class_method" title="configure (class method)">.<strong>configure</strong> {|configuration| ... } &#x21d2; Object </a>
210
+
211
+
212
+
213
+ </span>
214
+
215
+
216
+
217
+
218
+
219
+
220
+
221
+
222
+
223
+ <span class="summary_desc"><div class='inline'></div></span>
224
+
225
+ </li>
226
+
227
+
228
+ <li class="public ">
229
+ <span class="summary_signature">
230
+
231
+ <a href="#reset-class_method" title="reset (class method)">.<strong>reset</strong> &#x21d2; Object </a>
232
+
233
+
234
+
235
+ </span>
236
+
237
+
238
+
239
+
240
+
241
+
242
+
243
+
244
+
245
+ <span class="summary_desc"><div class='inline'></div></span>
246
+
247
+ </li>
248
+
249
+
250
+ </ul>
251
+
252
+
253
+
254
+ <div id="class_attr_details" class="attr_details">
255
+ <h2>Class Attribute Details</h2>
256
+
257
+
258
+ <span id="configuration=-class_method"></span>
259
+ <div class="method_details first">
260
+ <h3 class="signature first" id="configuration-class_method">
261
+
262
+ .<strong>configuration</strong> &#x21d2; <tt>Object</tt>
263
+
264
+
265
+
266
+
267
+
268
+ </h3><table class="source_code">
269
+ <tr>
270
+ <td>
271
+ <pre class="lines">
272
+
273
+
274
+ 14
275
+ 15
276
+ 16</pre>
277
+ </td>
278
+ <td>
279
+ <pre class="code"><span class="info file"># File 'lib/umami.rb', line 14</span>
280
+
281
+ <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_configuration'>configuration</span>
282
+ <span class='ivar'>@configuration</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="Umami/Configuration.html" title="Umami::Configuration (class)">Configuration</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Umami/Configuration.html#initialize-instance_method" title="Umami::Configuration#initialize (method)">new</a></span></span>
283
+ <span class='kw'>end</span></pre>
284
+ </td>
285
+ </tr>
286
+ </table>
287
+ </div>
288
+
289
+
290
+ <span id="logger=-class_method"></span>
291
+ <div class="method_details ">
292
+ <h3 class="signature " id="logger-class_method">
293
+
294
+ .<strong>logger</strong> &#x21d2; <tt>Object</tt>
295
+
296
+
297
+
298
+
299
+
300
+ </h3><table class="source_code">
301
+ <tr>
302
+ <td>
303
+ <pre class="lines">
304
+
305
+
306
+ 22
307
+ 23
308
+ 24
309
+ 25
310
+ 26</pre>
311
+ </td>
312
+ <td>
313
+ <pre class="code"><span class="info file"># File 'lib/umami.rb', line 22</span>
314
+
315
+ <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_logger'>logger</span>
316
+ <span class='ivar'>@logger</span> <span class='op'>||=</span> <span class='const'>Logger</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='gvar'>$stdout</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_tap'>tap</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_log'>log</span><span class='op'>|</span>
317
+ <span class='id identifier rubyid_log'>log</span><span class='period'>.</span><span class='id identifier rubyid_progname'>progname</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span>
318
+ <span class='kw'>end</span>
319
+ <span class='kw'>end</span></pre>
320
+ </td>
321
+ </tr>
322
+ </table>
323
+ </div>
324
+
325
+ </div>
326
+
327
+
328
+ <div id="class_method_details" class="method_details_list">
329
+ <h2>Class Method Details</h2>
330
+
331
+
332
+ <div class="method_details first">
333
+ <h3 class="signature first" id="client-class_method">
334
+
335
+ .<strong>client</strong>(options = {}) &#x21d2; <tt>Object</tt>
336
+
337
+
338
+
339
+
340
+
341
+ </h3><table class="source_code">
342
+ <tr>
343
+ <td>
344
+ <pre class="lines">
345
+
346
+
347
+ 32
348
+ 33
349
+ 34</pre>
350
+ </td>
351
+ <td>
352
+ <pre class="code"><span class="info file"># File 'lib/umami.rb', line 32</span>
353
+
354
+ <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_client'>client</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
355
+ <span class='const'><span class='object_link'><a href="Umami/Client.html" title="Umami::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Umami/Client.html#initialize-instance_method" title="Umami::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
356
+ <span class='kw'>end</span></pre>
357
+ </td>
358
+ </tr>
359
+ </table>
360
+ </div>
361
+
362
+ <div class="method_details ">
363
+ <h3 class="signature " id="configure-class_method">
364
+
365
+ .<strong>configure</strong> {|configuration| ... } &#x21d2; <tt>Object</tt>
366
+
367
+
368
+
369
+
370
+
371
+ </h3><div class="docstring">
372
+ <div class="discussion">
373
+
374
+
375
+ </div>
376
+ </div>
377
+ <div class="tags">
378
+
379
+ <p class="tag_title">Yields:</p>
380
+ <ul class="yield">
381
+
382
+ <li>
383
+
384
+
385
+ <span class='type'>(<tt><span class='object_link'><a href="#configuration-class_method" title="Umami.configuration (method)">configuration</a></span></tt>)</span>
386
+
387
+
388
+
389
+ </li>
390
+
391
+ </ul>
392
+
393
+ </div><table class="source_code">
394
+ <tr>
395
+ <td>
396
+ <pre class="lines">
397
+
398
+
399
+ 18
400
+ 19
401
+ 20</pre>
402
+ </td>
403
+ <td>
404
+ <pre class="code"><span class="info file"># File 'lib/umami.rb', line 18</span>
405
+
406
+ <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_configure'>configure</span>
407
+ <span class='kw'>yield</span><span class='lparen'>(</span><span class='id identifier rubyid_configuration'>configuration</span><span class='rparen'>)</span>
408
+ <span class='kw'>end</span></pre>
409
+ </td>
410
+ </tr>
411
+ </table>
412
+ </div>
413
+
414
+ <div class="method_details ">
415
+ <h3 class="signature " id="reset-class_method">
416
+
417
+ .<strong>reset</strong> &#x21d2; <tt>Object</tt>
418
+
419
+
420
+
421
+
422
+
423
+ </h3><table class="source_code">
424
+ <tr>
425
+ <td>
426
+ <pre class="lines">
427
+
428
+
429
+ 28
430
+ 29
431
+ 30</pre>
432
+ </td>
433
+ <td>
434
+ <pre class="code"><span class="info file"># File 'lib/umami.rb', line 28</span>
435
+
436
+ <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_reset'>reset</span>
437
+ <span class='ivar'>@configuration</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Umami/Configuration.html" title="Umami::Configuration (class)">Configuration</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Umami/Configuration.html#initialize-instance_method" title="Umami::Configuration#initialize (method)">new</a></span></span>
438
+ <span class='kw'>end</span></pre>
439
+ </td>
440
+ </tr>
441
+ </table>
442
+ </div>
443
+
444
+ </div>
445
+
446
+ </div>
447
+
448
+ <div id="footer">
449
+ Generated on Mon Jul 22 17:42:41 2024 by
450
+ <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
451
+ 0.9.36 (ruby-3.2.2).
452
+ </div>
453
+
454
+ </div>
455
+ </body>
456
+ </html>
data/docs/_index.html ADDED
@@ -0,0 +1,216 @@
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
+ Documentation by YARD 0.9.36
8
+
9
+ </title>
10
+
11
+ <link rel="stylesheet" href="css/style.css" type="text/css" />
12
+
13
+ <link rel="stylesheet" href="css/common.css" type="text/css" />
14
+
15
+ <script type="text/javascript">
16
+ pathId = null;
17
+ relpath = '';
18
+ </script>
19
+
20
+
21
+ <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
22
+
23
+ <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
24
+
25
+
26
+ </head>
27
+ <body>
28
+ <div class="nav_wrap">
29
+ <iframe id="nav" src="class_list.html?1"></iframe>
30
+ <div id="resizer"></div>
31
+ </div>
32
+
33
+ <div id="main" tabindex="-1">
34
+ <div id="header">
35
+ <div id="menu">
36
+
37
+ </div>
38
+
39
+ <div id="search">
40
+
41
+ <a class="full_list_link" id="class_list_link"
42
+ href="class_list.html">
43
+
44
+ <svg width="24" height="24">
45
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
46
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
47
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
48
+ </svg>
49
+ </a>
50
+
51
+ </div>
52
+ <div class="clear"></div>
53
+ </div>
54
+
55
+ <div id="content"><h1 class="noborder title">Documentation by YARD 0.9.36</h1>
56
+ <div id="listing">
57
+ <h1 class="alphaindex">Alphabetic Index</h1>
58
+
59
+ <h2>File Listing</h2>
60
+ <ul id="files" class="index_inline_list">
61
+
62
+
63
+ <li class="r1"><a href="index.html" title="README">README</a></li>
64
+
65
+
66
+ <li class="r2"><a href="file.CHANGELOG.html" title="CHANGELOG">CHANGELOG</a></li>
67
+
68
+
69
+ <li class="r1"><a href="file.LICENSE.html" title="LICENSE">LICENSE</a></li>
70
+
71
+
72
+ </ul>
73
+
74
+ <div class="clear"></div>
75
+ <h2>Namespace Listing A-Z</h2>
76
+
77
+
78
+
79
+
80
+ <table>
81
+ <tr>
82
+ <td valign='top' width="33%">
83
+
84
+
85
+ <ul id="alpha_A" class="alpha">
86
+ <li class="letter">A</li>
87
+ <ul>
88
+
89
+ <li>
90
+ <span class='object_link'><a href="Umami/APIError.html" title="Umami::APIError (class)">APIError</a></span>
91
+
92
+ <small>(Umami)</small>
93
+
94
+ </li>
95
+
96
+ <li>
97
+ <span class='object_link'><a href="Umami/AuthenticationError.html" title="Umami::AuthenticationError (class)">AuthenticationError</a></span>
98
+
99
+ <small>(Umami)</small>
100
+
101
+ </li>
102
+
103
+ </ul>
104
+ </ul>
105
+
106
+
107
+ <ul id="alpha_C" class="alpha">
108
+ <li class="letter">C</li>
109
+ <ul>
110
+
111
+ <li>
112
+ <span class='object_link'><a href="Umami/Client.html" title="Umami::Client (class)">Client</a></span>
113
+
114
+ <small>(Umami)</small>
115
+
116
+ </li>
117
+
118
+ <li>
119
+ <span class='object_link'><a href="Umami/ClientError.html" title="Umami::ClientError (class)">ClientError</a></span>
120
+
121
+ <small>(Umami)</small>
122
+
123
+ </li>
124
+
125
+ <li>
126
+ <span class='object_link'><a href="Umami/Configuration.html" title="Umami::Configuration (class)">Configuration</a></span>
127
+
128
+ <small>(Umami)</small>
129
+
130
+ </li>
131
+
132
+ <li>
133
+ <span class='object_link'><a href="Umami/ConfigurationError.html" title="Umami::ConfigurationError (class)">ConfigurationError</a></span>
134
+
135
+ <small>(Umami)</small>
136
+
137
+ </li>
138
+
139
+ </ul>
140
+ </ul>
141
+
142
+
143
+ <ul id="alpha_E" class="alpha">
144
+ <li class="letter">E</li>
145
+ <ul>
146
+
147
+ <li>
148
+ <span class='object_link'><a href="Umami/Error.html" title="Umami::Error (class)">Error</a></span>
149
+
150
+ <small>(Umami)</small>
151
+
152
+ </li>
153
+
154
+ </ul>
155
+ </ul>
156
+
157
+
158
+ <ul id="alpha_N" class="alpha">
159
+ <li class="letter">N</li>
160
+ <ul>
161
+
162
+ <li>
163
+ <span class='object_link'><a href="Umami/NotFoundError.html" title="Umami::NotFoundError (class)">NotFoundError</a></span>
164
+
165
+ <small>(Umami)</small>
166
+
167
+ </li>
168
+
169
+ </ul>
170
+ </ul>
171
+
172
+
173
+ <ul id="alpha_S" class="alpha">
174
+ <li class="letter">S</li>
175
+ <ul>
176
+
177
+ <li>
178
+ <span class='object_link'><a href="Umami/ServerError.html" title="Umami::ServerError (class)">ServerError</a></span>
179
+
180
+ <small>(Umami)</small>
181
+
182
+ </li>
183
+
184
+ </ul>
185
+ </ul>
186
+
187
+
188
+ <ul id="alpha_U" class="alpha">
189
+ <li class="letter">U</li>
190
+ <ul>
191
+
192
+ <li>
193
+ <span class='object_link'><a href="Umami.html" title="Umami (module)">Umami</a></span>
194
+
195
+ </li>
196
+
197
+ </ul>
198
+ </ul>
199
+
200
+ </td>
201
+ </tr>
202
+ </table>
203
+
204
+ </div>
205
+
206
+ </div>
207
+
208
+ <div id="footer">
209
+ Generated on Mon Jul 22 17:42:41 2024 by
210
+ <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
211
+ 0.9.36 (ruby-3.2.2).
212
+ </div>
213
+
214
+ </div>
215
+ </body>
216
+ </html>