moxiworks_platform 0.13.7 → 0.13.8

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,1078 @@
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: MoxiworksPlatform::Credentials
8
+
9
+ &mdash; Documentation by YARD 0.9.5
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 = "MoxiworksPlatform::Credentials";
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"></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="../MoxiworksPlatform.html" title="MoxiworksPlatform (module)">MoxiworksPlatform</a></span></span>
41
+ &raquo;
42
+ <span class="title">Credentials</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
+ <iframe id="search_frame" src="../class_list.html"></iframe>
63
+
64
+ <div id="content"><h1>Class: MoxiworksPlatform::Credentials
65
+
66
+
67
+
68
+ </h1>
69
+ <div class="box_info">
70
+
71
+ <dl>
72
+ <dt>Inherits:</dt>
73
+ <dd>
74
+ <span class="inheritName">Object</span>
75
+
76
+ <ul class="fullTree">
77
+ <li>Object</li>
78
+
79
+ <li class="next">MoxiworksPlatform::Credentials</li>
80
+
81
+ </ul>
82
+ <a href="#" class="inheritanceTree">show all</a>
83
+
84
+ </dd>
85
+ </dl>
86
+
87
+
88
+
89
+
90
+
91
+
92
+
93
+
94
+
95
+
96
+
97
+ <dl>
98
+ <dt>Defined in:</dt>
99
+ <dd>lib/moxiworks_platform/credentials.rb</dd>
100
+ </dl>
101
+
102
+ </div>
103
+
104
+ <h2>Overview</h2><div class="docstring">
105
+ <div class="discussion">
106
+
107
+ <h1 id="label-Moxi+Works+Platform+Credentials">Moxi Works Platform Credentials</h1>
108
+
109
+ <p>A Singleton class used for authorization on the Moxi Works Platform</p>
110
+
111
+
112
+ </div>
113
+ </div>
114
+ <div class="tags">
115
+
116
+
117
+ </div>
118
+
119
+
120
+
121
+ <h2>Class Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
122
+ <ul class="summary">
123
+
124
+ <li class="public ">
125
+ <span class="summary_signature">
126
+
127
+ <a href="#instance-class_method" title="instance (class method)">.<strong>instance</strong> &#x21d2; Object </a>
128
+
129
+
130
+
131
+ </span>
132
+
133
+
134
+
135
+
136
+
137
+
138
+
139
+
140
+
141
+
142
+
143
+
144
+ <span class="summary_desc"><div class='inline'>
145
+ <p>Singleton instance of MoxiworksPlatform::Credentials.</p>
146
+ </div></span>
147
+
148
+ </li>
149
+
150
+
151
+ <li class="public ">
152
+ <span class="summary_signature">
153
+
154
+ <a href="#platform_identifier-class_method" title="platform_identifier (class method)">.<strong>platform_identifier</strong> &#x21d2; String </a>
155
+
156
+
157
+
158
+ </span>
159
+
160
+
161
+
162
+
163
+
164
+
165
+
166
+
167
+
168
+
169
+
170
+
171
+ <span class="summary_desc"><div class='inline'>
172
+ <p>The Moxi Works Platform Identifier associated with the
173
+ MoxiworksPlatform::Credentials instance.</p>
174
+ </div></span>
175
+
176
+ </li>
177
+
178
+
179
+ <li class="public ">
180
+ <span class="summary_signature">
181
+
182
+ <a href="#platform_secret-class_method" title="platform_secret (class method)">.<strong>platform_secret</strong> &#x21d2; String </a>
183
+
184
+
185
+
186
+ </span>
187
+
188
+
189
+
190
+
191
+
192
+
193
+
194
+
195
+
196
+
197
+
198
+
199
+ <span class="summary_desc"><div class='inline'>
200
+ <p>The Moxi Works Platform Secret associated with the
201
+ MoxiworksPlatform::Credentials instance.</p>
202
+ </div></span>
203
+
204
+ </li>
205
+
206
+
207
+ </ul>
208
+
209
+
210
+
211
+
212
+
213
+ <h2>
214
+ Class Method Summary
215
+ <small><a href="#" class="summary_toggle">collapse</a></small>
216
+ </h2>
217
+
218
+ <ul class="summary">
219
+
220
+ <li class="public ">
221
+ <span class="summary_signature">
222
+
223
+ <a href="#new-class_method" title="new (class method)">.<strong>new</strong>(*args, &amp;block) &#x21d2; MoxiWorksPlatform::Credentials </a>
224
+
225
+
226
+
227
+ </span>
228
+
229
+
230
+
231
+
232
+
233
+
234
+
235
+
236
+
237
+ <span class="summary_desc"><div class='inline'></div></span>
238
+
239
+ </li>
240
+
241
+
242
+ <li class="public ">
243
+ <span class="summary_signature">
244
+
245
+ <a href="#set%3F-class_method" title="set? (class method)">.<strong>set?</strong> &#x21d2; Boolean </a>
246
+
247
+
248
+
249
+ </span>
250
+
251
+
252
+
253
+
254
+
255
+
256
+
257
+
258
+
259
+ <span class="summary_desc"><div class='inline'>
260
+ <p>whether the required values for authorization have been set in the
261
+ Singleton instance of MoxiworksPlatform::Credentials.</p>
262
+ </div></span>
263
+
264
+ </li>
265
+
266
+
267
+ </ul>
268
+
269
+ <h2>
270
+ Instance Method Summary
271
+ <small><a href="#" class="summary_toggle">collapse</a></small>
272
+ </h2>
273
+
274
+ <ul class="summary">
275
+
276
+ <li class="public ">
277
+ <span class="summary_signature">
278
+
279
+ <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(platform_identifier, platform_secret) &#x21d2; Credentials </a>
280
+
281
+
282
+
283
+ </span>
284
+
285
+
286
+ <span class="note title constructor">constructor</span>
287
+
288
+
289
+
290
+
291
+
292
+
293
+
294
+
295
+ <span class="summary_desc"><div class='inline'>
296
+ <p>A new instance of Credentials.</p>
297
+ </div></span>
298
+
299
+ </li>
300
+
301
+
302
+ <li class="public ">
303
+ <span class="summary_signature">
304
+
305
+ <a href="#inspect-instance_method" title="#inspect (instance method)">#<strong>inspect</strong> &#x21d2; Object </a>
306
+
307
+
308
+
309
+ </span>
310
+
311
+
312
+
313
+
314
+
315
+
316
+ <span class="private note title">private</span>
317
+
318
+
319
+ <span class="summary_desc"><div class='inline'>
320
+ <p>Removing the secret access key from the default inspect string.</p>
321
+ </div></span>
322
+
323
+ </li>
324
+
325
+
326
+ <li class="public ">
327
+ <span class="summary_signature">
328
+
329
+ <a href="#platform_identifier-instance_method" title="#platform_identifier (instance method)">#<strong>platform_identifier</strong> &#x21d2; String </a>
330
+
331
+
332
+
333
+ </span>
334
+
335
+
336
+
337
+
338
+
339
+
340
+
341
+
342
+
343
+ <span class="summary_desc"><div class='inline'>
344
+ <p>The Moxi Works Platform Identifier associated with the
345
+ MoxiworksPlatform::Credentials instance.</p>
346
+ </div></span>
347
+
348
+ </li>
349
+
350
+
351
+ <li class="public ">
352
+ <span class="summary_signature">
353
+
354
+ <a href="#platform_secret-instance_method" title="#platform_secret (instance method)">#<strong>platform_secret</strong> &#x21d2; String </a>
355
+
356
+
357
+
358
+ </span>
359
+
360
+
361
+
362
+
363
+
364
+
365
+
366
+
367
+
368
+ <span class="summary_desc"><div class='inline'>
369
+ <p>The Moxi Works Platform Secret associated with the
370
+ MoxiworksPlatform::Credentials instance.</p>
371
+ </div></span>
372
+
373
+ </li>
374
+
375
+
376
+ <li class="public ">
377
+ <span class="summary_signature">
378
+
379
+ <a href="#set%3F-instance_method" title="#set? (instance method)">#<strong>set?</strong> &#x21d2; Boolean </a>
380
+
381
+
382
+
383
+ </span>
384
+
385
+
386
+
387
+
388
+
389
+
390
+
391
+
392
+
393
+ <span class="summary_desc"><div class='inline'>
394
+ <p>whether the required values for authorization have been set in the
395
+ Singleton instance of MoxiworksPlatform::Credentials.</p>
396
+ </div></span>
397
+
398
+ </li>
399
+
400
+
401
+ </ul>
402
+
403
+
404
+ <div id="constructor_details" class="method_details_list">
405
+ <h2>Constructor Details</h2>
406
+
407
+ <div class="method_details first">
408
+ <h3 class="signature first" id="initialize-instance_method">
409
+
410
+ #<strong>initialize</strong>(platform_identifier, platform_secret) &#x21d2; <tt><span class='object_link'><a href="" title="MoxiworksPlatform::Credentials (class)">Credentials</a></span></tt>
411
+
412
+
413
+
414
+
415
+
416
+ </h3><div class="docstring">
417
+ <div class="discussion">
418
+
419
+ <p>Returns a new instance of Credentials</p>
420
+
421
+
422
+ </div>
423
+ </div>
424
+ <div class="tags">
425
+ <p class="tag_title">Parameters:</p>
426
+ <ul class="param">
427
+
428
+ <li>
429
+
430
+ <span class='name'>platform_id</span>
431
+
432
+
433
+ <span class='type'>(<tt>String</tt>)</span>
434
+
435
+
436
+
437
+ &mdash;
438
+ <div class='inline'>
439
+ <p>Your provided Moxi Works Platform Identifier</p>
440
+ </div>
441
+
442
+ </li>
443
+
444
+ <li>
445
+
446
+ <span class='name'>platform_secret</span>
447
+
448
+
449
+ <span class='type'>(<tt>String</tt>)</span>
450
+
451
+
452
+
453
+ &mdash;
454
+ <div class='inline'>
455
+ <p>Your provided Moxi Works Platform Secret</p>
456
+ </div>
457
+
458
+ </li>
459
+
460
+ </ul>
461
+
462
+
463
+ </div><table class="source_code">
464
+ <tr>
465
+ <td>
466
+ <pre class="lines">
467
+
468
+
469
+ 69
470
+ 70
471
+ 71
472
+ 72
473
+ 73
474
+ 74</pre>
475
+ </td>
476
+ <td>
477
+ <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/credentials.rb', line 69</span>
478
+
479
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_platform_identifier'>platform_identifier</span><span class='comma'>,</span> <span class='id identifier rubyid_platform_secret'>platform_secret</span><span class='rparen'>)</span>
480
+ <span class='kw'>return</span> <span class='kw'>if</span> <span class='const'>MoxiworksPlatform</span><span class='op'>::</span><span class='const'>Credentials</span><span class='period'>.</span><span class='id identifier rubyid_instance'>instance</span>
481
+ <span class='const'>MoxiworksPlatform</span><span class='op'>::</span><span class='const'>Credentials</span><span class='period'>.</span><span class='id identifier rubyid_platform_identifier'>platform_identifier</span> <span class='op'>=</span> <span class='id identifier rubyid_platform_identifier'>platform_identifier</span>
482
+ <span class='const'>MoxiworksPlatform</span><span class='op'>::</span><span class='const'>Credentials</span><span class='period'>.</span><span class='id identifier rubyid_platform_secret'>platform_secret</span> <span class='op'>=</span> <span class='id identifier rubyid_platform_secret'>platform_secret</span>
483
+ <span class='const'>MoxiworksPlatform</span><span class='op'>::</span><span class='const'>Credentials</span><span class='period'>.</span><span class='id identifier rubyid_instance'>instance</span> <span class='op'>=</span> <span class='kw'>self</span>
484
+ <span class='kw'>end</span></pre>
485
+ </td>
486
+ </tr>
487
+ </table>
488
+ </div>
489
+
490
+ </div>
491
+
492
+ <div id="class_attr_details" class="attr_details">
493
+ <h2>Class Attribute Details</h2>
494
+
495
+
496
+ <span id="instance=-class_method"></span>
497
+ <div class="method_details first">
498
+ <h3 class="signature first" id="instance-class_method">
499
+
500
+ .<strong>instance</strong> &#x21d2; <tt>Object</tt>
501
+
502
+
503
+
504
+
505
+
506
+ </h3><div class="docstring">
507
+ <div class="discussion">
508
+
509
+ <p>Singleton instance of MoxiworksPlatform::Credentials</p>
510
+
511
+
512
+ </div>
513
+ </div>
514
+ <div class="tags">
515
+
516
+
517
+ </div><table class="source_code">
518
+ <tr>
519
+ <td>
520
+ <pre class="lines">
521
+
522
+
523
+ 14
524
+ 15
525
+ 16</pre>
526
+ </td>
527
+ <td>
528
+ <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/credentials.rb', line 14</span>
529
+
530
+ <span class='kw'>def</span> <span class='id identifier rubyid_instance'>instance</span>
531
+ <span class='ivar'>@instance</span>
532
+ <span class='kw'>end</span></pre>
533
+ </td>
534
+ </tr>
535
+ </table>
536
+ </div>
537
+
538
+
539
+ <span id="platform_identifier=-class_method"></span>
540
+ <div class="method_details ">
541
+ <h3 class="signature " id="platform_identifier-class_method">
542
+
543
+ .<strong>platform_identifier</strong> &#x21d2; <tt>String</tt>
544
+
545
+
546
+
547
+
548
+
549
+ </h3><div class="docstring">
550
+ <div class="discussion">
551
+
552
+ <p>The Moxi Works Platform Identifier associated with the
553
+ MoxiworksPlatform::Credentials instance</p>
554
+
555
+ <p>This should be set when MoxiworksPlafform::Credentials is instantiated</p>
556
+
557
+
558
+ </div>
559
+ </div>
560
+ <div class="tags">
561
+
562
+ <p class="tag_title">Returns:</p>
563
+ <ul class="return">
564
+
565
+ <li>
566
+
567
+
568
+ <span class='type'>(<tt>String</tt>)</span>
569
+
570
+
571
+
572
+ </li>
573
+
574
+ </ul>
575
+
576
+ </div><table class="source_code">
577
+ <tr>
578
+ <td>
579
+ <pre class="lines">
580
+
581
+
582
+ 23
583
+ 24
584
+ 25</pre>
585
+ </td>
586
+ <td>
587
+ <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/credentials.rb', line 23</span>
588
+
589
+ <span class='kw'>def</span> <span class='id identifier rubyid_platform_identifier'>platform_identifier</span>
590
+ <span class='ivar'>@platform_identifier</span>
591
+ <span class='kw'>end</span></pre>
592
+ </td>
593
+ </tr>
594
+ </table>
595
+ </div>
596
+
597
+
598
+ <span id="platform_secret=-class_method"></span>
599
+ <div class="method_details ">
600
+ <h3 class="signature " id="platform_secret-class_method">
601
+
602
+ .<strong>platform_secret</strong> &#x21d2; <tt>String</tt>
603
+
604
+
605
+
606
+
607
+
608
+ </h3><div class="docstring">
609
+ <div class="discussion">
610
+
611
+ <p>The Moxi Works Platform Secret associated with the
612
+ MoxiworksPlatform::Credentials instance</p>
613
+
614
+ <p>This should be set when MoxiworksPlafform::Credentials is instantiated</p>
615
+
616
+
617
+ </div>
618
+ </div>
619
+ <div class="tags">
620
+
621
+ <p class="tag_title">Returns:</p>
622
+ <ul class="return">
623
+
624
+ <li>
625
+
626
+
627
+ <span class='type'>(<tt>String</tt>)</span>
628
+
629
+
630
+
631
+ </li>
632
+
633
+ </ul>
634
+
635
+ </div><table class="source_code">
636
+ <tr>
637
+ <td>
638
+ <pre class="lines">
639
+
640
+
641
+ 32
642
+ 33
643
+ 34</pre>
644
+ </td>
645
+ <td>
646
+ <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/credentials.rb', line 32</span>
647
+
648
+ <span class='kw'>def</span> <span class='id identifier rubyid_platform_secret'>platform_secret</span>
649
+ <span class='ivar'>@platform_secret</span>
650
+ <span class='kw'>end</span></pre>
651
+ </td>
652
+ </tr>
653
+ </table>
654
+ </div>
655
+
656
+ </div>
657
+
658
+
659
+ <div id="class_method_details" class="method_details_list">
660
+ <h2>Class Method Details</h2>
661
+
662
+
663
+ <div class="method_details first">
664
+ <h3 class="signature first" id="new-class_method">
665
+
666
+ .<strong>new</strong>(*args, &amp;block) &#x21d2; <tt>MoxiWorksPlatform::Credentials</tt>
667
+
668
+
669
+
670
+
671
+
672
+ </h3><div class="docstring">
673
+ <div class="discussion">
674
+
675
+
676
+ </div>
677
+ </div>
678
+ <div class="tags">
679
+
680
+ <div class="examples">
681
+ <p class="tag_title">Examples:</p>
682
+
683
+
684
+ <pre class="example code"><code><span class='id identifier rubyid_platform_identifier'>platform_identifier</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>abc1234</span><span class='tstring_end'>&#39;</span></span>
685
+ <span class='id identifier rubyid_platform_secret'>platform_secret</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>secret</span><span class='tstring_end'>&#39;</span></span>
686
+ <span class='const'>MoxiworksPlatform</span><span class='op'>::</span><span class='const'>Credentials</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_platform_identifier'>platform_identifier</span><span class='comma'>,</span> <span class='id identifier rubyid_platform_secret'>platform_secret</span><span class='rparen'>)</span></code></pre>
687
+
688
+ </div>
689
+ <p class="tag_title">Parameters:</p>
690
+ <ul class="param">
691
+
692
+ <li>
693
+
694
+ <span class='name'>platform_id</span>
695
+
696
+
697
+ <span class='type'>(<tt>String</tt>)</span>
698
+
699
+
700
+
701
+ &mdash;
702
+ <div class='inline'>
703
+ <p>Your provided Moxi Works Platform Identifier</p>
704
+ </div>
705
+
706
+ </li>
707
+
708
+ <li>
709
+
710
+ <span class='name'>platform_secret</span>
711
+
712
+
713
+ <span class='type'>(<tt>String</tt>)</span>
714
+
715
+
716
+
717
+ &mdash;
718
+ <div class='inline'>
719
+ <p>Your provided Moxi Works Platform Secret</p>
720
+ </div>
721
+
722
+ </li>
723
+
724
+ </ul>
725
+
726
+ <p class="tag_title">Returns:</p>
727
+ <ul class="return">
728
+
729
+ <li>
730
+
731
+
732
+ <span class='type'>(<tt>MoxiWorksPlatform::Credentials</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
+ 45
747
+ 46
748
+ 47
749
+ 48
750
+ 49
751
+ 50
752
+ 51
753
+ 52
754
+ 53
755
+ 54</pre>
756
+ </td>
757
+ <td>
758
+ <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/credentials.rb', line 45</span>
759
+
760
+ <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
761
+ <span class='id identifier rubyid_pid'>pid</span> <span class='op'>=</span> <span class='id identifier rubyid_args'>args</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span>
762
+ <span class='id identifier rubyid_ps'>ps</span> <span class='op'>=</span> <span class='id identifier rubyid_args'>args</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span>
763
+ <span class='kw'>return</span> <span class='const'>MoxiworksPlatform</span><span class='op'>::</span><span class='const'>Credentials</span><span class='period'>.</span><span class='id identifier rubyid_instance'>instance</span> <span class='kw'>if</span>
764
+ <span class='const'>MoxiworksPlatform</span><span class='op'>::</span><span class='const'>Credentials</span><span class='period'>.</span><span class='id identifier rubyid_instance'>instance</span> <span class='kw'>and</span>
765
+ <span class='lparen'>(</span><span class='id identifier rubyid_pid'>pid</span> <span class='op'>==</span> <span class='const'>MoxiworksPlatform</span><span class='op'>::</span><span class='const'>Credentials</span><span class='period'>.</span><span class='id identifier rubyid_platform_identifier'>platform_identifier</span> <span class='kw'>and</span>
766
+ <span class='id identifier rubyid_ps'>ps</span> <span class='op'>==</span> <span class='const'>MoxiworksPlatform</span><span class='op'>::</span><span class='const'>Credentials</span><span class='period'>.</span><span class='id identifier rubyid_platform_secret'>platform_secret</span><span class='rparen'>)</span>
767
+
768
+ <span class='kw'>super</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
769
+ <span class='kw'>end</span></pre>
770
+ </td>
771
+ </tr>
772
+ </table>
773
+ </div>
774
+
775
+ <div class="method_details ">
776
+ <h3 class="signature " id="set?-class_method">
777
+
778
+ .<strong>set?</strong> &#x21d2; <tt>Boolean</tt>
779
+
780
+
781
+
782
+
783
+
784
+ </h3><div class="docstring">
785
+ <div class="discussion">
786
+
787
+ <p>whether the required values for authorization have been set in the
788
+ Singleton instance of MoxiworksPlatform::Credentials</p>
789
+
790
+
791
+ </div>
792
+ </div>
793
+ <div class="tags">
794
+
795
+ <p class="tag_title">Returns:</p>
796
+ <ul class="return">
797
+
798
+ <li>
799
+
800
+
801
+ <span class='type'>(<tt>Boolean</tt>)</span>
802
+
803
+
804
+
805
+ &mdash;
806
+ <div class='inline'>
807
+ <p>Returns `true` if the access key id and secret access key are both set.</p>
808
+ </div>
809
+
810
+ </li>
811
+
812
+ </ul>
813
+
814
+ </div><table class="source_code">
815
+ <tr>
816
+ <td>
817
+ <pre class="lines">
818
+
819
+
820
+ 59
821
+ 60
822
+ 61
823
+ 62
824
+ 63
825
+ 64</pre>
826
+ </td>
827
+ <td>
828
+ <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/credentials.rb', line 59</span>
829
+
830
+ <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_set?'>set?</span>
831
+ <span class='kw'>not</span> <span class='lparen'>(</span><span class='lparen'>(</span><span class='id identifier rubyid_platform_identifier'>platform_identifier</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='kw'>or</span>
832
+ <span class='id identifier rubyid_platform_identifier'>platform_identifier</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span><span class='rparen'>)</span> <span class='kw'>or</span>
833
+ <span class='lparen'>(</span><span class='id identifier rubyid_platform_secret'>platform_secret</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='kw'>or</span>
834
+ <span class='id identifier rubyid_platform_secret'>platform_secret</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span><span class='rparen'>)</span><span class='rparen'>)</span>
835
+ <span class='kw'>end</span></pre>
836
+ </td>
837
+ </tr>
838
+ </table>
839
+ </div>
840
+
841
+ </div>
842
+
843
+ <div id="instance_method_details" class="method_details_list">
844
+ <h2>Instance Method Details</h2>
845
+
846
+
847
+ <div class="method_details first">
848
+ <h3 class="signature first" id="inspect-instance_method">
849
+
850
+ #<strong>inspect</strong> &#x21d2; <tt>Object</tt>
851
+
852
+
853
+
854
+
855
+
856
+ </h3><div class="docstring">
857
+ <div class="discussion">
858
+ <p class="note private">
859
+ <strong>This method is part of a private API.</strong>
860
+ You should avoid using this method if possible, as it may be removed or be changed in the future.
861
+ </p>
862
+
863
+ <p>Removing the secret access key from the default inspect string.</p>
864
+
865
+
866
+ </div>
867
+ </div>
868
+ <div class="tags">
869
+
870
+
871
+ </div><table class="source_code">
872
+ <tr>
873
+ <td>
874
+ <pre class="lines">
875
+
876
+
877
+ 103
878
+ 104
879
+ 105</pre>
880
+ </td>
881
+ <td>
882
+ <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/credentials.rb', line 103</span>
883
+
884
+ <span class='kw'>def</span> <span class='id identifier rubyid_inspect'>inspect</span>
885
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>#&lt;</span><span class='embexpr_beg'>#{</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span><span class='embexpr_end'>}</span><span class='tstring_content'> platform_identifier=</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_platform_identifier'>platform_identifier</span><span class='period'>.</span><span class='id identifier rubyid_inspect'>inspect</span><span class='embexpr_end'>}</span><span class='tstring_content'>&gt;</span><span class='tstring_end'>&quot;</span></span>
886
+ <span class='kw'>end</span></pre>
887
+ </td>
888
+ </tr>
889
+ </table>
890
+ </div>
891
+
892
+ <div class="method_details ">
893
+ <h3 class="signature " id="platform_identifier-instance_method">
894
+
895
+ #<strong>platform_identifier</strong> &#x21d2; <tt>String</tt>
896
+
897
+
898
+
899
+
900
+
901
+ </h3><div class="docstring">
902
+ <div class="discussion">
903
+
904
+ <p>The Moxi Works Platform Identifier associated with the
905
+ MoxiworksPlatform::Credentials instance</p>
906
+
907
+ <p>This should be set when MoxiworksPlafform::Credentials is instantiated</p>
908
+
909
+
910
+ </div>
911
+ </div>
912
+ <div class="tags">
913
+
914
+ <p class="tag_title">Returns:</p>
915
+ <ul class="return">
916
+
917
+ <li>
918
+
919
+
920
+ <span class='type'>(<tt>String</tt>)</span>
921
+
922
+
923
+
924
+ </li>
925
+
926
+ </ul>
927
+
928
+ </div><table class="source_code">
929
+ <tr>
930
+ <td>
931
+ <pre class="lines">
932
+
933
+
934
+ 81
935
+ 82
936
+ 83</pre>
937
+ </td>
938
+ <td>
939
+ <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/credentials.rb', line 81</span>
940
+
941
+ <span class='kw'>def</span> <span class='id identifier rubyid_platform_identifier'>platform_identifier</span>
942
+ <span class='const'>MoxiworksPlatform</span><span class='op'>::</span><span class='const'>Credentials</span><span class='period'>.</span><span class='id identifier rubyid_platform_identifier'>platform_identifier</span>
943
+ <span class='kw'>end</span></pre>
944
+ </td>
945
+ </tr>
946
+ </table>
947
+ </div>
948
+
949
+ <div class="method_details ">
950
+ <h3 class="signature " id="platform_secret-instance_method">
951
+
952
+ #<strong>platform_secret</strong> &#x21d2; <tt>String</tt>
953
+
954
+
955
+
956
+
957
+
958
+ </h3><div class="docstring">
959
+ <div class="discussion">
960
+
961
+ <p>The Moxi Works Platform Secret associated with the
962
+ MoxiworksPlatform::Credentials instance</p>
963
+
964
+ <p>This should be set when MoxiworksPlafform::Credentials is instantiated</p>
965
+
966
+
967
+ </div>
968
+ </div>
969
+ <div class="tags">
970
+
971
+ <p class="tag_title">Returns:</p>
972
+ <ul class="return">
973
+
974
+ <li>
975
+
976
+
977
+ <span class='type'>(<tt>String</tt>)</span>
978
+
979
+
980
+
981
+ </li>
982
+
983
+ </ul>
984
+
985
+ </div><table class="source_code">
986
+ <tr>
987
+ <td>
988
+ <pre class="lines">
989
+
990
+
991
+ 90
992
+ 91
993
+ 92</pre>
994
+ </td>
995
+ <td>
996
+ <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/credentials.rb', line 90</span>
997
+
998
+ <span class='kw'>def</span> <span class='id identifier rubyid_platform_secret'>platform_secret</span>
999
+ <span class='const'>MoxiworksPlatform</span><span class='op'>::</span><span class='const'>Credentials</span><span class='period'>.</span><span class='id identifier rubyid_platform_secret'>platform_secret</span>
1000
+ <span class='kw'>end</span></pre>
1001
+ </td>
1002
+ </tr>
1003
+ </table>
1004
+ </div>
1005
+
1006
+ <div class="method_details ">
1007
+ <h3 class="signature " id="set?-instance_method">
1008
+
1009
+ #<strong>set?</strong> &#x21d2; <tt>Boolean</tt>
1010
+
1011
+
1012
+
1013
+
1014
+
1015
+ </h3><div class="docstring">
1016
+ <div class="discussion">
1017
+
1018
+ <p>whether the required values for authorization have been set in the
1019
+ Singleton instance of MoxiworksPlatform::Credentials</p>
1020
+
1021
+
1022
+ </div>
1023
+ </div>
1024
+ <div class="tags">
1025
+
1026
+ <p class="tag_title">Returns:</p>
1027
+ <ul class="return">
1028
+
1029
+ <li>
1030
+
1031
+
1032
+ <span class='type'>(<tt>Boolean</tt>)</span>
1033
+
1034
+
1035
+
1036
+ &mdash;
1037
+ <div class='inline'>
1038
+ <p>Returns `true` if the access key id and secret access key are both set.</p>
1039
+ </div>
1040
+
1041
+ </li>
1042
+
1043
+ </ul>
1044
+
1045
+ </div><table class="source_code">
1046
+ <tr>
1047
+ <td>
1048
+ <pre class="lines">
1049
+
1050
+
1051
+ 97
1052
+ 98
1053
+ 99</pre>
1054
+ </td>
1055
+ <td>
1056
+ <pre class="code"><span class="info file"># File 'lib/moxiworks_platform/credentials.rb', line 97</span>
1057
+
1058
+ <span class='kw'>def</span> <span class='id identifier rubyid_set?'>set?</span>
1059
+ <span class='const'>MoxiworksPlatform</span><span class='op'>::</span><span class='const'>Credentials</span><span class='period'>.</span><span class='id identifier rubyid_set?'>set?</span>
1060
+ <span class='kw'>end</span></pre>
1061
+ </td>
1062
+ </tr>
1063
+ </table>
1064
+ </div>
1065
+
1066
+ </div>
1067
+
1068
+ </div>
1069
+
1070
+ <div id="footer">
1071
+ Generated on Fri Apr 20 10:00:19 2018 by
1072
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1073
+ 0.9.5 (ruby-2.2.4).
1074
+ </div>
1075
+
1076
+ </div>
1077
+ </body>
1078
+ </html>