dwh 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.
Files changed (104) hide show
  1. checksums.yaml +7 -0
  2. data/.rubocop.yml +36 -0
  3. data/CHANGELOG.md +5 -0
  4. data/LICENSE +21 -0
  5. data/README.md +130 -0
  6. data/Rakefile +42 -0
  7. data/docs/DWH/Adapters/Adapter.html +3053 -0
  8. data/docs/DWH/Adapters/Athena.html +1704 -0
  9. data/docs/DWH/Adapters/Boolean.html +121 -0
  10. data/docs/DWH/Adapters/Druid.html +1626 -0
  11. data/docs/DWH/Adapters/DuckDb.html +2012 -0
  12. data/docs/DWH/Adapters/MySql.html +1704 -0
  13. data/docs/DWH/Adapters/OpenAuthorizable/ClassMethods.html +265 -0
  14. data/docs/DWH/Adapters/OpenAuthorizable.html +1102 -0
  15. data/docs/DWH/Adapters/Postgres.html +2000 -0
  16. data/docs/DWH/Adapters/Snowflake.html +1662 -0
  17. data/docs/DWH/Adapters/SqlServer.html +2084 -0
  18. data/docs/DWH/Adapters/Trino.html +1835 -0
  19. data/docs/DWH/Adapters.html +129 -0
  20. data/docs/DWH/AuthenticationError.html +142 -0
  21. data/docs/DWH/Behaviors.html +767 -0
  22. data/docs/DWH/Capabilities.html +748 -0
  23. data/docs/DWH/Column.html +1115 -0
  24. data/docs/DWH/ConfigError.html +143 -0
  25. data/docs/DWH/ConnectionError.html +143 -0
  26. data/docs/DWH/DWHError.html +138 -0
  27. data/docs/DWH/ExecutionError.html +143 -0
  28. data/docs/DWH/Factory.html +1133 -0
  29. data/docs/DWH/Functions/Arrays.html +505 -0
  30. data/docs/DWH/Functions/Dates.html +1644 -0
  31. data/docs/DWH/Functions/ExtractDatePart.html +804 -0
  32. data/docs/DWH/Functions/Nulls.html +377 -0
  33. data/docs/DWH/Functions.html +846 -0
  34. data/docs/DWH/Logger.html +258 -0
  35. data/docs/DWH/OAuthError.html +138 -0
  36. data/docs/DWH/Settings.html +658 -0
  37. data/docs/DWH/StreamingStats.html +804 -0
  38. data/docs/DWH/Table.html +1260 -0
  39. data/docs/DWH/TableStats.html +583 -0
  40. data/docs/DWH/TokenExpiredError.html +142 -0
  41. data/docs/DWH/UnsupportedCapability.html +135 -0
  42. data/docs/DWH.html +220 -0
  43. data/docs/_index.html +471 -0
  44. data/docs/class_list.html +54 -0
  45. data/docs/css/common.css +1 -0
  46. data/docs/css/full_list.css +58 -0
  47. data/docs/css/style.css +503 -0
  48. data/docs/file.README.html +210 -0
  49. data/docs/file.adapters.html +514 -0
  50. data/docs/file.creating-adapters.html +497 -0
  51. data/docs/file.getting-started.html +288 -0
  52. data/docs/file.usage.html +446 -0
  53. data/docs/file_list.html +79 -0
  54. data/docs/frames.html +22 -0
  55. data/docs/guides/adapters.md +445 -0
  56. data/docs/guides/creating-adapters.md +430 -0
  57. data/docs/guides/getting-started.md +225 -0
  58. data/docs/guides/usage.md +378 -0
  59. data/docs/index.html +210 -0
  60. data/docs/js/app.js +344 -0
  61. data/docs/js/full_list.js +242 -0
  62. data/docs/js/jquery.js +4 -0
  63. data/docs/method_list.html +2038 -0
  64. data/docs/top-level-namespace.html +110 -0
  65. data/lib/dwh/adapters/athena.rb +359 -0
  66. data/lib/dwh/adapters/druid.rb +267 -0
  67. data/lib/dwh/adapters/duck_db.rb +235 -0
  68. data/lib/dwh/adapters/my_sql.rb +235 -0
  69. data/lib/dwh/adapters/open_authorizable.rb +215 -0
  70. data/lib/dwh/adapters/postgres.rb +250 -0
  71. data/lib/dwh/adapters/snowflake.rb +489 -0
  72. data/lib/dwh/adapters/sql_server.rb +257 -0
  73. data/lib/dwh/adapters/trino.rb +213 -0
  74. data/lib/dwh/adapters.rb +363 -0
  75. data/lib/dwh/behaviors.rb +67 -0
  76. data/lib/dwh/capabilities.rb +39 -0
  77. data/lib/dwh/column.rb +79 -0
  78. data/lib/dwh/errors.rb +29 -0
  79. data/lib/dwh/factory.rb +125 -0
  80. data/lib/dwh/functions/arrays.rb +42 -0
  81. data/lib/dwh/functions/dates.rb +162 -0
  82. data/lib/dwh/functions/extract_date_part.rb +70 -0
  83. data/lib/dwh/functions/nulls.rb +31 -0
  84. data/lib/dwh/functions.rb +86 -0
  85. data/lib/dwh/logger.rb +50 -0
  86. data/lib/dwh/settings/athena.yml +77 -0
  87. data/lib/dwh/settings/base.yml +81 -0
  88. data/lib/dwh/settings/databricks.yml +51 -0
  89. data/lib/dwh/settings/druid.yml +59 -0
  90. data/lib/dwh/settings/duckdb.yml +44 -0
  91. data/lib/dwh/settings/mysql.yml +67 -0
  92. data/lib/dwh/settings/postgres.yml +30 -0
  93. data/lib/dwh/settings/redshift.yml +52 -0
  94. data/lib/dwh/settings/snowflake.yml +45 -0
  95. data/lib/dwh/settings/sqlserver.yml +80 -0
  96. data/lib/dwh/settings/trino.yml +77 -0
  97. data/lib/dwh/settings.rb +79 -0
  98. data/lib/dwh/streaming_stats.rb +69 -0
  99. data/lib/dwh/table.rb +105 -0
  100. data/lib/dwh/table_stats.rb +51 -0
  101. data/lib/dwh/version.rb +5 -0
  102. data/lib/dwh.rb +54 -0
  103. data/sig/dwh.rbs +4 -0
  104. metadata +231 -0
data/docs/DWH/Adapters/OpenAuthorizable.html ADDED
@@ -0,0 +1,1102 @@
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: DWH::Adapters::OpenAuthorizable
8
+
9
+ &mdash; Documentation by YARD 0.9.37
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 = "DWH::Adapters::OpenAuthorizable";
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 (O)</a> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../../DWH.html" title="DWH (module)">DWH</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Adapters.html" title="DWH::Adapters (module)">Adapters</a></span></span>
41
+ &raquo;
42
+ <span class="title">OpenAuthorizable</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: DWH::Adapters::OpenAuthorizable
63
+
64
+
65
+
66
+ </h1>
67
+ <div class="box_info">
68
+
69
+
70
+
71
+
72
+
73
+
74
+
75
+
76
+
77
+ <dl>
78
+ <dt>Included in:</dt>
79
+ <dd><span class='object_link'><a href="Snowflake.html" title="DWH::Adapters::Snowflake (class)">Snowflake</a></span></dd>
80
+ </dl>
81
+
82
+
83
+
84
+ <dl>
85
+ <dt>Defined in:</dt>
86
+ <dd>lib/dwh/adapters/open_authorizable.rb</dd>
87
+ </dl>
88
+
89
+ </div>
90
+
91
+ <h2>Overview</h2><div class="docstring">
92
+ <div class="discussion">
93
+ <p>OpenAuthorizable aka OAuth module will add functionality
94
+ to get and refresh access tokens for databases that supported
95
+ OAuth.</p>
96
+
97
+ <p>To use this module include it in your adapter and call the oauth_with
98
+ class method.</p>
99
+
100
+
101
+ </div>
102
+ </div>
103
+ <div class="tags">
104
+
105
+ <div class="examples">
106
+ <h4 class="tag_title">Examples:</h4>
107
+
108
+
109
+ <h5 class="example_title"><div class='inline'><p>Endpoint that needs to use instance to generate</p>
110
+ </div></h5>
111
+
112
+ <pre class="example code"><code><span class='id identifier rubyid_oauth_with'>oauth_with</span> <span class='label'>authorize:</span> <span class='tlambda'>-&gt;</span><span class='lparen'>(</span><span class='id identifier rubyid_adapter'>adapter</span><span class='rparen'>)</span> <span class='tlambeg'>{</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>url</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_config'>config</span><span class='lbracket'>[</span><span class='symbol'>:val</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='label'>tokenize:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>http://blue.com</span><span class='tstring_end'>&quot;</span></span></code></pre>
113
+
114
+
115
+ <h5 class="example_title"><div class='inline'><p>Get authorization_url</p>
116
+ </div></h5>
117
+
118
+ <pre class="example code"><code><span class='id identifier rubyid_adapter'>adapter</span><span class='period'>.</span><span class='id identifier rubyid_authorization_url'>authorization_url</span>
119
+ <span class='const'>Then</span> <span class='id identifier rubyid_capture'>capture</span> <span class='id identifier rubyid_the'>the</span> <span class='id identifier rubyid_code'>code</span> <span class='kw'>and</span> <span class='id identifier rubyid_gen'>gen</span> <span class='id identifier rubyid_tokens'>tokens</span></code></pre>
120
+
121
+
122
+ <h5 class="example_title"><div class='inline'><p>Generate acess tokens</p>
123
+ </div></h5>
124
+
125
+ <pre class="example code"><code><span class='id identifier rubyid_adapter'>adapter</span><span class='period'>.</span><span class='id identifier rubyid_generate_oauth_tokens'>generate_oauth_tokens</span><span class='lparen'>(</span><span class='id identifier rubyid_code_from_authorization'>code_from_authorization</span><span class='rparen'>)</span>
126
+ <span class='comment'># this will also apply the tokens</span></code></pre>
127
+
128
+
129
+ <h5 class="example_title"><div class='inline'><p>Reuse cached tokens</p>
130
+ </div></h5>
131
+
132
+ <pre class="example code"><code><span class='id identifier rubyid_adapter'>adapter</span><span class='period'>.</span><span class='id identifier rubyid_apply_oauth_tokens'>apply_oauth_tokens</span><span class='lparen'>(</span><span class='label'>access_token:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>myaccesstoken</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='label'>refresh_token:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>rtoken</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='label'>expires_at:</span> <span class='const'>Time</span><span class='period'>.</span><span class='id identifier rubyid_now'>now</span><span class='rparen'>)</span></code></pre>
133
+
134
+ </div>
135
+
136
+
137
+ </div><h2>Defined Under Namespace</h2>
138
+ <p class="children">
139
+
140
+
141
+ <strong class="modules">Modules:</strong> <span class='object_link'><a href="OpenAuthorizable/ClassMethods.html" title="DWH::Adapters::OpenAuthorizable::ClassMethods (module)">ClassMethods</a></span>
142
+
143
+
144
+
145
+
146
+ </p>
147
+
148
+
149
+
150
+
151
+
152
+
153
+
154
+
155
+ <h2>
156
+ Class Method Summary
157
+ <small><a href="#" class="summary_toggle">collapse</a></small>
158
+ </h2>
159
+
160
+ <ul class="summary">
161
+
162
+ <li class="public ">
163
+ <span class="summary_signature">
164
+
165
+ <a href="#included-class_method" title="included (class method)">.<strong>included</strong>(base) &#x21d2; Object </a>
166
+
167
+
168
+
169
+ </span>
170
+
171
+
172
+
173
+
174
+
175
+
176
+
177
+
178
+
179
+ <span class="summary_desc"><div class='inline'>
180
+ </div></span>
181
+
182
+ </li>
183
+
184
+
185
+ </ul>
186
+
187
+ <h2>
188
+ Instance Method Summary
189
+ <small><a href="#" class="summary_toggle">collapse</a></small>
190
+ </h2>
191
+
192
+ <ul class="summary">
193
+
194
+ <li class="public ">
195
+ <span class="summary_signature">
196
+
197
+ <a href="#apply_oauth_tokens-instance_method" title="#apply_oauth_tokens (instance method)">#<strong>apply_oauth_tokens</strong>(access_token:, refresh_token: nil, expires_at: nil) &#x21d2; Object </a>
198
+
199
+
200
+
201
+ </span>
202
+
203
+
204
+
205
+
206
+
207
+
208
+
209
+
210
+
211
+ <span class="summary_desc"><div class='inline'><p>You can reuse existing tokens that were saved outside of this app by passing it here.</p>
212
+ </div></span>
213
+
214
+ </li>
215
+
216
+
217
+ <li class="public ">
218
+ <span class="summary_signature">
219
+
220
+ <a href="#authorization_url-instance_method" title="#authorization_url (instance method)">#<strong>authorization_url</strong>(state: SecureRandom.hex(16), scope: nil) &#x21d2; Object </a>
221
+
222
+
223
+
224
+ </span>
225
+
226
+
227
+
228
+
229
+
230
+
231
+
232
+
233
+
234
+ <span class="summary_desc"><div class='inline'><p>Generate authorization URL for user to visit.</p>
235
+ </div></span>
236
+
237
+ </li>
238
+
239
+
240
+ <li class="public ">
241
+ <span class="summary_signature">
242
+
243
+ <a href="#generate_oauth_tokens-instance_method" title="#generate_oauth_tokens (instance method)">#<strong>generate_oauth_tokens</strong>(authorization_code) &#x21d2; Object </a>
244
+
245
+
246
+
247
+ </span>
248
+
249
+
250
+
251
+
252
+
253
+
254
+
255
+
256
+
257
+ <span class="summary_desc"><div class='inline'><p>Takes the given authorization code and generates new access and refresh tokens.</p>
258
+ </div></span>
259
+
260
+ </li>
261
+
262
+
263
+ <li class="public ">
264
+ <span class="summary_signature">
265
+
266
+ <a href="#oauth_access_token-instance_method" title="#oauth_access_token (instance method)">#<strong>oauth_access_token</strong> &#x21d2; String </a>
267
+
268
+
269
+
270
+ </span>
271
+
272
+
273
+
274
+
275
+
276
+
277
+
278
+
279
+
280
+ <span class="summary_desc"><div class='inline'><p>This will return the current access_token or if it expired and refresh_token token is available it will generate a new token.</p>
281
+ </div></span>
282
+
283
+ </li>
284
+
285
+
286
+ <li class="public ">
287
+ <span class="summary_signature">
288
+
289
+ <a href="#oauth_authenticated%3F-instance_method" title="#oauth_authenticated? (instance method)">#<strong>oauth_authenticated?</strong> &#x21d2; Boolean </a>
290
+
291
+
292
+
293
+ </span>
294
+
295
+
296
+
297
+
298
+
299
+
300
+
301
+
302
+
303
+ <span class="summary_desc"><div class='inline'><p>Check if we have a valid access token.</p>
304
+ </div></span>
305
+
306
+ </li>
307
+
308
+
309
+ <li class="public ">
310
+ <span class="summary_signature">
311
+
312
+ <a href="#oauth_settings-instance_method" title="#oauth_settings (instance method)">#<strong>oauth_settings</strong> &#x21d2; Object </a>
313
+
314
+
315
+
316
+ </span>
317
+
318
+
319
+
320
+
321
+
322
+
323
+
324
+
325
+
326
+ <span class="summary_desc"><div class='inline'>
327
+ </div></span>
328
+
329
+ </li>
330
+
331
+
332
+ <li class="public ">
333
+ <span class="summary_signature">
334
+
335
+ <a href="#oauth_token_info-instance_method" title="#oauth_token_info (instance method)">#<strong>oauth_token_info</strong> &#x21d2; Object </a>
336
+
337
+
338
+
339
+ </span>
340
+
341
+
342
+
343
+
344
+
345
+
346
+
347
+
348
+
349
+ <span class="summary_desc"><div class='inline'><p>Get current state of tokens.</p>
350
+ </div></span>
351
+
352
+ </li>
353
+
354
+
355
+ <li class="public ">
356
+ <span class="summary_signature">
357
+
358
+ <a href="#oauth_tokenization_url-instance_method" title="#oauth_tokenization_url (instance method)">#<strong>oauth_tokenization_url</strong> &#x21d2; Object </a>
359
+
360
+
361
+
362
+ </span>
363
+
364
+
365
+
366
+
367
+
368
+
369
+
370
+
371
+
372
+ <span class="summary_desc"><div class='inline'>
373
+ </div></span>
374
+
375
+ </li>
376
+
377
+
378
+ <li class="public ">
379
+ <span class="summary_signature">
380
+
381
+ <a href="#refresh_access_token-instance_method" title="#refresh_access_token (instance method)">#<strong>refresh_access_token</strong> &#x21d2; Object </a>
382
+
383
+
384
+
385
+ </span>
386
+
387
+
388
+
389
+
390
+
391
+
392
+
393
+
394
+
395
+ <span class="summary_desc"><div class='inline'><p>Refresh access token using refresh token.</p>
396
+ </div></span>
397
+
398
+ </li>
399
+
400
+
401
+ <li class="public ">
402
+ <span class="summary_signature">
403
+
404
+ <a href="#validate_oauth_config-instance_method" title="#validate_oauth_config (instance method)">#<strong>validate_oauth_config</strong> &#x21d2; Object </a>
405
+
406
+
407
+
408
+ </span>
409
+
410
+
411
+
412
+
413
+
414
+
415
+
416
+
417
+
418
+ <span class="summary_desc"><div class='inline'>
419
+ </div></span>
420
+
421
+ </li>
422
+
423
+
424
+ </ul>
425
+
426
+
427
+
428
+
429
+ <div id="class_method_details" class="method_details_list">
430
+ <h2>Class Method Details</h2>
431
+
432
+
433
+ <div class="method_details first">
434
+ <h3 class="signature first" id="included-class_method">
435
+
436
+ .<strong>included</strong>(base) &#x21d2; <tt>Object</tt>
437
+
438
+
439
+
440
+
441
+
442
+ </h3><table class="source_code">
443
+ <tr>
444
+ <td>
445
+ <pre class="lines">
446
+
447
+
448
+ 40
449
+ 41
450
+ 42
451
+ 43
452
+ 44
453
+ 45
454
+ 46</pre>
455
+ </td>
456
+ <td>
457
+ <pre class="code"><span class="info file"># File 'lib/dwh/adapters/open_authorizable.rb', line 40</span>
458
+
459
+ <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_included'>included</span><span class='lparen'>(</span><span class='id identifier rubyid_base'>base</span><span class='rparen'>)</span>
460
+ <span class='id identifier rubyid_base'>base</span><span class='period'>.</span><span class='id identifier rubyid_extend'>extend</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="OpenAuthorizable/ClassMethods.html" title="DWH::Adapters::OpenAuthorizable::ClassMethods (module)">ClassMethods</a></span></span><span class='rparen'>)</span>
461
+ <span class='id identifier rubyid_base'>base</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span> <span class='symbol'>:oauth_client_id</span><span class='comma'>,</span> <span class='const'>String</span><span class='comma'>,</span> <span class='label'>required:</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='label'>message:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>OAuth client_id</span><span class='tstring_end'>&#39;</span></span>
462
+ <span class='id identifier rubyid_base'>base</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span> <span class='symbol'>:oauth_client_secret</span><span class='comma'>,</span> <span class='const'>String</span><span class='comma'>,</span> <span class='label'>required:</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='label'>message:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>OAuth client_secret</span><span class='tstring_end'>&#39;</span></span>
463
+ <span class='id identifier rubyid_base'>base</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span> <span class='symbol'>:oauth_redirect_uri</span><span class='comma'>,</span> <span class='const'>String</span><span class='comma'>,</span> <span class='label'>required:</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='label'>message:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>OAuth redirect_uri</span><span class='tstring_end'>&#39;</span></span>
464
+ <span class='id identifier rubyid_base'>base</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span> <span class='symbol'>:oauth_scope</span><span class='comma'>,</span> <span class='const'>String</span><span class='comma'>,</span> <span class='label'>required:</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='label'>message:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>OAuth redirect_url</span><span class='tstring_end'>&#39;</span></span>
465
+ <span class='kw'>end</span></pre>
466
+ </td>
467
+ </tr>
468
+ </table>
469
+ </div>
470
+
471
+ </div>
472
+
473
+ <div id="instance_method_details" class="method_details_list">
474
+ <h2>Instance Method Details</h2>
475
+
476
+
477
+ <div class="method_details first">
478
+ <h3 class="signature first" id="apply_oauth_tokens-instance_method">
479
+
480
+ #<strong>apply_oauth_tokens</strong>(access_token:, refresh_token: nil, expires_at: nil) &#x21d2; <tt>Object</tt>
481
+
482
+
483
+
484
+
485
+
486
+ </h3><div class="docstring">
487
+ <div class="discussion">
488
+ <p>You can reuse existing tokens that were saved outside
489
+ of this app by passing it here. This could be tokens
490
+ cached from a previous call to @see #generate_oauth_tokens</p>
491
+
492
+ <p>param access_token [String] the access token</p>
493
+
494
+
495
+ </div>
496
+ </div>
497
+ <div class="tags">
498
+ <p class="tag_title">Parameters:</p>
499
+ <ul class="param">
500
+
501
+ <li>
502
+
503
+ <span class='name'>refresh_token</span>
504
+
505
+
506
+ <span class='type'>(<tt>String</tt>)</span>
507
+
508
+
509
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
510
+
511
+
512
+ &mdash;
513
+ <div class='inline'><p>optional refresh token</p>
514
+ </div>
515
+
516
+ </li>
517
+
518
+ </ul>
519
+
520
+
521
+ </div><table class="source_code">
522
+ <tr>
523
+ <td>
524
+ <pre class="lines">
525
+
526
+
527
+ 69
528
+ 70
529
+ 71
530
+ 72
531
+ 73</pre>
532
+ </td>
533
+ <td>
534
+ <pre class="code"><span class="info file"># File 'lib/dwh/adapters/open_authorizable.rb', line 69</span>
535
+
536
+ <span class='kw'>def</span> <span class='id identifier rubyid_apply_oauth_tokens'>apply_oauth_tokens</span><span class='lparen'>(</span><span class='label'>access_token:</span><span class='comma'>,</span> <span class='label'>refresh_token:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>expires_at:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
537
+ <span class='ivar'>@oauth_access_token</span> <span class='op'>=</span> <span class='id identifier rubyid_access_token'>access_token</span>
538
+ <span class='ivar'>@oauth_refresh_token</span> <span class='op'>=</span> <span class='id identifier rubyid_refresh_token'>refresh_token</span>
539
+ <span class='ivar'>@token_expires_at</span> <span class='op'>=</span> <span class='id identifier rubyid_expires_at'>expires_at</span>
540
+ <span class='kw'>end</span></pre>
541
+ </td>
542
+ </tr>
543
+ </table>
544
+ </div>
545
+
546
+ <div class="method_details ">
547
+ <h3 class="signature " id="authorization_url-instance_method">
548
+
549
+ #<strong>authorization_url</strong>(state: SecureRandom.hex(16), scope: nil) &#x21d2; <tt>Object</tt>
550
+
551
+
552
+
553
+
554
+
555
+ </h3><div class="docstring">
556
+ <div class="discussion">
557
+ <p>Generate authorization URL for user to visit</p>
558
+
559
+
560
+ </div>
561
+ </div>
562
+ <div class="tags">
563
+
564
+
565
+ </div><table class="source_code">
566
+ <tr>
567
+ <td>
568
+ <pre class="lines">
569
+
570
+
571
+ 49
572
+ 50
573
+ 51
574
+ 52
575
+ 53
576
+ 54
577
+ 55
578
+ 56
579
+ 57
580
+ 58
581
+ 59
582
+ 60
583
+ 61</pre>
584
+ </td>
585
+ <td>
586
+ <pre class="code"><span class="info file"># File 'lib/dwh/adapters/open_authorizable.rb', line 49</span>
587
+
588
+ <span class='kw'>def</span> <span class='id identifier rubyid_authorization_url'>authorization_url</span><span class='lparen'>(</span><span class='label'>state:</span> <span class='const'>SecureRandom</span><span class='period'>.</span><span class='id identifier rubyid_hex'>hex</span><span class='lparen'>(</span><span class='int'>16</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='label'>scope:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
589
+ <span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span>
590
+ <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>response_type</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>code</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
591
+ <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>client_id</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_oauth_client_id'>oauth_client_id</span><span class='comma'>,</span>
592
+ <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>redirect_uri</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_oauth_redirect_uri'>oauth_redirect_uri</span><span class='comma'>,</span>
593
+ <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>state</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_state'>state</span><span class='comma'>,</span>
594
+ <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>scope</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_scope'>scope</span> <span class='op'>||</span> <span class='id identifier rubyid_oauth_scope'>oauth_scope</span> <span class='op'>||</span> <span class='id identifier rubyid_oauth_settings'>oauth_settings</span><span class='lbracket'>[</span><span class='symbol'>:default_scope</span><span class='rbracket'>]</span>
595
+ <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_compact'>compact</span>
596
+
597
+ <span class='id identifier rubyid_uri'>uri</span> <span class='op'>=</span> <span class='const'>URI</span><span class='lparen'>(</span><span class='id identifier rubyid_oauth_settings'>oauth_settings</span><span class='lbracket'>[</span><span class='symbol'>:authorize</span><span class='rbracket'>]</span><span class='rparen'>)</span>
598
+ <span class='id identifier rubyid_uri'>uri</span><span class='period'>.</span><span class='id identifier rubyid_query'>query</span> <span class='op'>=</span> <span class='const'>URI</span><span class='period'>.</span><span class='id identifier rubyid_encode_www_form'>encode_www_form</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
599
+ <span class='id identifier rubyid_uri'>uri</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>
600
+ <span class='kw'>end</span></pre>
601
+ </td>
602
+ </tr>
603
+ </table>
604
+ </div>
605
+
606
+ <div class="method_details ">
607
+ <h3 class="signature " id="generate_oauth_tokens-instance_method">
608
+
609
+ #<strong>generate_oauth_tokens</strong>(authorization_code) &#x21d2; <tt>Object</tt>
610
+
611
+
612
+
613
+
614
+
615
+ </h3><div class="docstring">
616
+ <div class="discussion">
617
+ <p>Takes the given authorization code and generates new
618
+ access and refresh tokens. It will also apply them.</p>
619
+
620
+
621
+ </div>
622
+ </div>
623
+ <div class="tags">
624
+ <p class="tag_title">Parameters:</p>
625
+ <ul class="param">
626
+
627
+ <li>
628
+
629
+ <span class='name'>authorization_code</span>
630
+
631
+
632
+ <span class='type'>(<tt>String</tt>)</span>
633
+
634
+
635
+
636
+ &mdash;
637
+ <div class='inline'><p>this code should come from
638
+ the redirect that is captured from the #authorization_url</p>
639
+ </div>
640
+
641
+ </li>
642
+
643
+ </ul>
644
+
645
+
646
+ </div><table class="source_code">
647
+ <tr>
648
+ <td>
649
+ <pre class="lines">
650
+
651
+
652
+ 79
653
+ 80
654
+ 81
655
+ 82
656
+ 83
657
+ 84
658
+ 85
659
+ 86
660
+ 87
661
+ 88
662
+ 89
663
+ 90
664
+ 91
665
+ 92</pre>
666
+ </td>
667
+ <td>
668
+ <pre class="code"><span class="info file"># File 'lib/dwh/adapters/open_authorizable.rb', line 79</span>
669
+
670
+ <span class='kw'>def</span> <span class='id identifier rubyid_generate_oauth_tokens'>generate_oauth_tokens</span><span class='lparen'>(</span><span class='id identifier rubyid_authorization_code'>authorization_code</span><span class='rparen'>)</span>
671
+ <span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span>
672
+ <span class='label'>grant_type:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>authorization_code</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
673
+ <span class='label'>code:</span> <span class='id identifier rubyid_authorization_code'>authorization_code</span><span class='comma'>,</span>
674
+ <span class='label'>redirect_uri:</span> <span class='id identifier rubyid_oauth_redirect_uri'>oauth_redirect_uri</span>
675
+ <span class='rbrace'>}</span>
676
+
677
+ <span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='id identifier rubyid_oauth_http_client'>oauth_http_client</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='id identifier rubyid_oauth_tokenization_url'>oauth_tokenization_url</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_req'>req</span><span class='op'>|</span>
678
+ <span class='id identifier rubyid_req'>req</span><span class='period'>.</span><span class='id identifier rubyid_headers'>headers</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Content-Type</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>application/x-www-form-urlencoded</span><span class='tstring_end'>&#39;</span></span>
679
+ <span class='id identifier rubyid_req'>req</span><span class='period'>.</span><span class='id identifier rubyid_headers'>headers</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Authorization</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_basic_auth_header'>basic_auth_header</span>
680
+ <span class='id identifier rubyid_req'>req</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span> <span class='op'>=</span> <span class='const'>URI</span><span class='period'>.</span><span class='id identifier rubyid_encode_www_form'>encode_www_form</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
681
+ <span class='kw'>end</span>
682
+ <span class='id identifier rubyid_oauth_token_response'>oauth_token_response</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span>
683
+ <span class='kw'>end</span></pre>
684
+ </td>
685
+ </tr>
686
+ </table>
687
+ </div>
688
+
689
+ <div class="method_details ">
690
+ <h3 class="signature " id="oauth_access_token-instance_method">
691
+
692
+ #<strong>oauth_access_token</strong> &#x21d2; <tt>String</tt>
693
+
694
+
695
+
696
+
697
+
698
+ </h3><div class="docstring">
699
+ <div class="discussion">
700
+ <p>This will return the current access_token or
701
+ if it expired and refresh_token token is available
702
+ it will generate a new token.</p>
703
+
704
+
705
+ </div>
706
+ </div>
707
+ <div class="tags">
708
+
709
+ <p class="tag_title">Returns:</p>
710
+ <ul class="return">
711
+
712
+ <li>
713
+
714
+
715
+ <span class='type'>(<tt>String</tt>)</span>
716
+
717
+
718
+
719
+ &mdash;
720
+ <div class='inline'><p>access token</p>
721
+ </div>
722
+
723
+ </li>
724
+
725
+ </ul>
726
+ <p class="tag_title">Raises:</p>
727
+ <ul class="raise">
728
+
729
+ <li>
730
+
731
+
732
+ <span class='type'>(<tt><span class='object_link'><a href="../AuthenticationError.html" title="DWH::AuthenticationError (class)">AuthenticationError</a></span></tt>)</span>
733
+
734
+
735
+
736
+ </li>
737
+
738
+ </ul>
739
+
740
+ </div><table class="source_code">
741
+ <tr>
742
+ <td>
743
+ <pre class="lines">
744
+
745
+
746
+ 118
747
+ 119
748
+ 120
749
+ 121
750
+ 122
751
+ 123
752
+ 124
753
+ 125
754
+ 126
755
+ 127
756
+ 128
757
+ 129
758
+ 130</pre>
759
+ </td>
760
+ <td>
761
+ <pre class="code"><span class="info file"># File 'lib/dwh/adapters/open_authorizable.rb', line 118</span>
762
+
763
+ <span class='kw'>def</span> <span class='id identifier rubyid_oauth_access_token'>oauth_access_token</span>
764
+ <span class='kw'>if</span> <span class='id identifier rubyid_token_expired?'>token_expired?</span> <span class='op'>&amp;&amp;</span> <span class='ivar'>@oauth_refresh_token</span>
765
+ <span class='id identifier rubyid_refresh_access_token'>refresh_access_token</span>
766
+
767
+ <span class='comment'># return token unless exception was raised
768
+ </span> <span class='ivar'>@oauth_access_token</span>
769
+ <span class='kw'>elsif</span> <span class='ivar'>@oauth_access_token</span>
770
+ <span class='ivar'>@oauth_access_token</span>
771
+ <span class='kw'>else</span>
772
+ <span class='id identifier rubyid_raise'>raise</span> <span class='const'><span class='object_link'><a href="../AuthenticationError.html" title="DWH::AuthenticationError (class)">AuthenticationError</a></span></span><span class='comma'>,</span>
773
+ <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Access token was never set. Either run the auth flow or set the tokens via apply_oauth_tokens method.</span><span class='tstring_end'>&#39;</span></span>
774
+ <span class='kw'>end</span>
775
+ <span class='kw'>end</span></pre>
776
+ </td>
777
+ </tr>
778
+ </table>
779
+ </div>
780
+
781
+ <div class="method_details ">
782
+ <h3 class="signature " id="oauth_authenticated?-instance_method">
783
+
784
+ #<strong>oauth_authenticated?</strong> &#x21d2; <tt><span class='object_link'><a href="Boolean.html" title="DWH::Adapters::Boolean (class)">Boolean</a></span></tt>
785
+
786
+
787
+
788
+
789
+
790
+ </h3><div class="docstring">
791
+ <div class="discussion">
792
+ <p>Check if we have a valid access token</p>
793
+
794
+
795
+ </div>
796
+ </div>
797
+ <div class="tags">
798
+
799
+ <p class="tag_title">Returns:</p>
800
+ <ul class="return">
801
+
802
+ <li>
803
+
804
+
805
+ <span class='type'>(<tt><span class='object_link'><a href="Boolean.html" title="DWH::Adapters::Boolean (class)">Boolean</a></span></tt>)</span>
806
+
807
+
808
+
809
+ </li>
810
+
811
+ </ul>
812
+
813
+ </div><table class="source_code">
814
+ <tr>
815
+ <td>
816
+ <pre class="lines">
817
+
818
+
819
+ 133
820
+ 134
821
+ 135</pre>
822
+ </td>
823
+ <td>
824
+ <pre class="code"><span class="info file"># File 'lib/dwh/adapters/open_authorizable.rb', line 133</span>
825
+
826
+ <span class='kw'>def</span> <span class='id identifier rubyid_oauth_authenticated?'>oauth_authenticated?</span>
827
+ <span class='ivar'>@oauth_access_token</span> <span class='op'>&amp;&amp;</span> <span class='op'>!</span><span class='id identifier rubyid_token_expired?'>token_expired?</span>
828
+ <span class='kw'>end</span></pre>
829
+ </td>
830
+ </tr>
831
+ </table>
832
+ </div>
833
+
834
+ <div class="method_details ">
835
+ <h3 class="signature " id="oauth_settings-instance_method">
836
+
837
+ #<strong>oauth_settings</strong> &#x21d2; <tt>Object</tt>
838
+
839
+
840
+
841
+
842
+
843
+ </h3><table class="source_code">
844
+ <tr>
845
+ <td>
846
+ <pre class="lines">
847
+
848
+
849
+ 156
850
+ 157
851
+ 158
852
+ 159
853
+ 160</pre>
854
+ </td>
855
+ <td>
856
+ <pre class="code"><span class="info file"># File 'lib/dwh/adapters/open_authorizable.rb', line 156</span>
857
+
858
+ <span class='kw'>def</span> <span class='id identifier rubyid_oauth_settings'>oauth_settings</span>
859
+ <span class='ivar'>@oauth_settings</span> <span class='op'>||=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_oauth_settings'>oauth_settings</span><span class='period'>.</span><span class='id identifier rubyid_transform_values'>transform_values</span> <span class='kw'>do</span>
860
+ <span class='id identifier rubyid_it'>it</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Proc</span><span class='rparen'>)</span> <span class='op'>?</span> <span class='id identifier rubyid_it'>it</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='kw'>self</span><span class='rparen'>)</span> <span class='op'>:</span> <span class='id identifier rubyid_it'>it</span>
861
+ <span class='kw'>end</span>
862
+ <span class='kw'>end</span></pre>
863
+ </td>
864
+ </tr>
865
+ </table>
866
+ </div>
867
+
868
+ <div class="method_details ">
869
+ <h3 class="signature " id="oauth_token_info-instance_method">
870
+
871
+ #<strong>oauth_token_info</strong> &#x21d2; <tt>Object</tt>
872
+
873
+
874
+
875
+
876
+
877
+ </h3><div class="docstring">
878
+ <div class="discussion">
879
+ <p>Get current state of tokens</p>
880
+
881
+
882
+ </div>
883
+ </div>
884
+ <div class="tags">
885
+
886
+
887
+ </div><table class="source_code">
888
+ <tr>
889
+ <td>
890
+ <pre class="lines">
891
+
892
+
893
+ 138
894
+ 139
895
+ 140
896
+ 141
897
+ 142
898
+ 143
899
+ 144
900
+ 145
901
+ 146</pre>
902
+ </td>
903
+ <td>
904
+ <pre class="code"><span class="info file"># File 'lib/dwh/adapters/open_authorizable.rb', line 138</span>
905
+
906
+ <span class='kw'>def</span> <span class='id identifier rubyid_oauth_token_info'>oauth_token_info</span>
907
+ <span class='lbrace'>{</span>
908
+ <span class='label'>access_token:</span> <span class='ivar'>@oauth_access_token</span><span class='comma'>,</span>
909
+ <span class='label'>refresh_token:</span> <span class='ivar'>@oauth_refresh_token</span><span class='comma'>,</span>
910
+ <span class='label'>expires_at:</span> <span class='ivar'>@token_expires_at</span><span class='comma'>,</span>
911
+ <span class='label'>expired:</span> <span class='id identifier rubyid_token_expired?'>token_expired?</span><span class='comma'>,</span>
912
+ <span class='label'>authenticated:</span> <span class='id identifier rubyid_oauth_authenticated?'>oauth_authenticated?</span>
913
+ <span class='rbrace'>}</span>
914
+ <span class='kw'>end</span></pre>
915
+ </td>
916
+ </tr>
917
+ </table>
918
+ </div>
919
+
920
+ <div class="method_details ">
921
+ <h3 class="signature " id="oauth_tokenization_url-instance_method">
922
+
923
+ #<strong>oauth_tokenization_url</strong> &#x21d2; <tt>Object</tt>
924
+
925
+
926
+
927
+
928
+
929
+ </h3><table class="source_code">
930
+ <tr>
931
+ <td>
932
+ <pre class="lines">
933
+
934
+
935
+ 162
936
+ 163
937
+ 164</pre>
938
+ </td>
939
+ <td>
940
+ <pre class="code"><span class="info file"># File 'lib/dwh/adapters/open_authorizable.rb', line 162</span>
941
+
942
+ <span class='kw'>def</span> <span class='id identifier rubyid_oauth_tokenization_url'>oauth_tokenization_url</span>
943
+ <span class='id identifier rubyid_oauth_settings'>oauth_settings</span><span class='lbracket'>[</span><span class='symbol'>:tokenize</span><span class='rbracket'>]</span>
944
+ <span class='kw'>end</span></pre>
945
+ </td>
946
+ </tr>
947
+ </table>
948
+ </div>
949
+
950
+ <div class="method_details ">
951
+ <h3 class="signature " id="refresh_access_token-instance_method">
952
+
953
+ #<strong>refresh_access_token</strong> &#x21d2; <tt>Object</tt>
954
+
955
+
956
+
957
+
958
+
959
+ </h3><div class="docstring">
960
+ <div class="discussion">
961
+ <p>Refresh access token using refresh token</p>
962
+
963
+
964
+ </div>
965
+ </div>
966
+ <div class="tags">
967
+
968
+ <p class="tag_title">Raises:</p>
969
+ <ul class="raise">
970
+
971
+ <li>
972
+
973
+
974
+ <span class='type'>(<tt><span class='object_link'><a href="../AuthenticationError.html" title="DWH::AuthenticationError (class)">AuthenticationError</a></span></tt>)</span>
975
+
976
+
977
+
978
+ </li>
979
+
980
+ </ul>
981
+
982
+ </div><table class="source_code">
983
+ <tr>
984
+ <td>
985
+ <pre class="lines">
986
+
987
+
988
+ 95
989
+ 96
990
+ 97
991
+ 98
992
+ 99
993
+ 100
994
+ 101
995
+ 102
996
+ 103
997
+ 104
998
+ 105
999
+ 106
1000
+ 107
1001
+ 108
1002
+ 109
1003
+ 110</pre>
1004
+ </td>
1005
+ <td>
1006
+ <pre class="code"><span class="info file"># File 'lib/dwh/adapters/open_authorizable.rb', line 95</span>
1007
+
1008
+ <span class='kw'>def</span> <span class='id identifier rubyid_refresh_access_token'>refresh_access_token</span>
1009
+ <span class='id identifier rubyid_raise'>raise</span> <span class='const'><span class='object_link'><a href="../AuthenticationError.html" title="DWH::AuthenticationError (class)">AuthenticationError</a></span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>No refresh token available</span><span class='tstring_end'>&#39;</span></span> <span class='kw'>unless</span> <span class='ivar'>@oauth_refresh_token</span>
1010
+
1011
+ <span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span>
1012
+ <span class='label'>grant_type:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>refresh_token</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
1013
+ <span class='label'>refresh_token:</span> <span class='ivar'>@oauth_refresh_token</span>
1014
+ <span class='rbrace'>}</span>
1015
+
1016
+ <span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='id identifier rubyid_oauth_http_client'>oauth_http_client</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='id identifier rubyid_oauth_tokenization_url'>oauth_tokenization_url</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_req'>req</span><span class='op'>|</span>
1017
+ <span class='id identifier rubyid_req'>req</span><span class='period'>.</span><span class='id identifier rubyid_headers'>headers</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Content-Type</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>application/x-www-form-urlencoded</span><span class='tstring_end'>&#39;</span></span>
1018
+ <span class='id identifier rubyid_req'>req</span><span class='period'>.</span><span class='id identifier rubyid_headers'>headers</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Authorization</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_basic_auth_header'>basic_auth_header</span>
1019
+ <span class='id identifier rubyid_req'>req</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span> <span class='op'>=</span> <span class='const'>URI</span><span class='period'>.</span><span class='id identifier rubyid_encode_www_form'>encode_www_form</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
1020
+ <span class='kw'>end</span>
1021
+
1022
+ <span class='id identifier rubyid_oauth_token_response'>oauth_token_response</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span>
1023
+ <span class='kw'>end</span></pre>
1024
+ </td>
1025
+ </tr>
1026
+ </table>
1027
+ </div>
1028
+
1029
+ <div class="method_details ">
1030
+ <h3 class="signature " id="validate_oauth_config-instance_method">
1031
+
1032
+ #<strong>validate_oauth_config</strong> &#x21d2; <tt>Object</tt>
1033
+
1034
+
1035
+
1036
+
1037
+
1038
+ </h3><div class="docstring">
1039
+ <div class="discussion">
1040
+
1041
+
1042
+
1043
+ </div>
1044
+ </div>
1045
+ <div class="tags">
1046
+
1047
+ <p class="tag_title">Raises:</p>
1048
+ <ul class="raise">
1049
+
1050
+ <li>
1051
+
1052
+
1053
+ <span class='type'>(<tt><span class='object_link'><a href="../ConfigError.html" title="DWH::ConfigError (class)">ConfigError</a></span></tt>)</span>
1054
+
1055
+
1056
+
1057
+ </li>
1058
+
1059
+ </ul>
1060
+
1061
+ </div><table class="source_code">
1062
+ <tr>
1063
+ <td>
1064
+ <pre class="lines">
1065
+
1066
+
1067
+ 148
1068
+ 149
1069
+ 150
1070
+ 151
1071
+ 152
1072
+ 153
1073
+ 154</pre>
1074
+ </td>
1075
+ <td>
1076
+ <pre class="code"><span class="info file"># File 'lib/dwh/adapters/open_authorizable.rb', line 148</span>
1077
+
1078
+ <span class='kw'>def</span> <span class='id identifier rubyid_validate_oauth_config'>validate_oauth_config</span>
1079
+ <span class='id identifier rubyid_raise'>raise</span> <span class='const'><span class='object_link'><a href="../ConfigError.html" title="DWH::ConfigError (class)">ConfigError</a></span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Missing config: oauth_client_id. Required for OAuth.</span><span class='tstring_end'>&#39;</span></span> <span class='kw'>unless</span> <span class='id identifier rubyid_config'>config</span><span class='lbracket'>[</span><span class='symbol'>:oauth_client_id</span><span class='rbracket'>]</span>
1080
+ <span class='id identifier rubyid_raise'>raise</span> <span class='const'><span class='object_link'><a href="../ConfigError.html" title="DWH::ConfigError (class)">ConfigError</a></span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Missing config: oauth_client_secret. Required for OAuth.</span><span class='tstring_end'>&#39;</span></span> <span class='kw'>unless</span> <span class='id identifier rubyid_config'>config</span><span class='lbracket'>[</span><span class='symbol'>:oauth_client_secret</span><span class='rbracket'>]</span>
1081
+ <span class='id identifier rubyid_raise'>raise</span> <span class='const'><span class='object_link'><a href="../ConfigError.html" title="DWH::ConfigError (class)">ConfigError</a></span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Missing config: oauth_redirect_url. Required for OAuth.</span><span class='tstring_end'>&#39;</span></span> <span class='kw'>unless</span> <span class='id identifier rubyid_config'>config</span><span class='lbracket'>[</span><span class='symbol'>:oauth_redirect_uri</span><span class='rbracket'>]</span>
1082
+
1083
+ <span class='id identifier rubyid_oauth_settings'>oauth_settings</span>
1084
+ <span class='kw'>end</span></pre>
1085
+ </td>
1086
+ </tr>
1087
+ </table>
1088
+ </div>
1089
+
1090
+ </div>
1091
+
1092
+ </div>
1093
+
1094
+ <div id="footer">
1095
+ Generated on Fri Aug 22 08:31:21 2025 by
1096
+ <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1097
+ 0.9.37 (ruby-3.4.4).
1098
+ </div>
1099
+
1100
+ </div>
1101
+ </body>
1102
+ </html>