filestack 2.1.0 → 2.2.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (48) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +3 -0
  3. data/README.md +2 -2
  4. data/VERSION +1 -1
  5. data/docs/AV.html +557 -0
  6. data/docs/Filestack.html +115 -0
  7. data/docs/Filestack/Ruby.html +115 -0
  8. data/docs/FilestackClient.html +702 -0
  9. data/docs/FilestackCommon.html +884 -0
  10. data/docs/FilestackConfig.html +197 -0
  11. data/docs/FilestackFilelink.html +1277 -0
  12. data/docs/FilestackSecurity.html +654 -0
  13. data/docs/IntelligentState.html +729 -0
  14. data/docs/IntelligentUtils.html +1639 -0
  15. data/docs/MultipartUploadUtils.html +1543 -0
  16. data/docs/Transform.html +1152 -0
  17. data/docs/TransformConfig.html +138 -0
  18. data/docs/TransformUtils.html +272 -0
  19. data/docs/UploadUtils.html +673 -0
  20. data/docs/_index.html +227 -0
  21. data/docs/class_list.html +51 -0
  22. data/docs/css/common.css +1 -0
  23. data/docs/css/full_list.css +58 -0
  24. data/docs/css/style.css +492 -0
  25. data/docs/file.README.html +210 -0
  26. data/docs/file_list.html +56 -0
  27. data/docs/frames.html +17 -0
  28. data/docs/index.html +210 -0
  29. data/docs/js/app.js +248 -0
  30. data/docs/js/full_list.js +216 -0
  31. data/docs/js/jquery.js +4 -0
  32. data/docs/method_list.html +643 -0
  33. data/docs/top-level-namespace.html +145 -0
  34. data/examples/file_transformations.rb +6 -0
  35. data/examples/intelligent_upload.rb +7 -0
  36. data/examples/normal_upload.rb +5 -0
  37. data/examples/upload_external_url.rb +7 -0
  38. data/examples/upload_with_security.rb +6 -0
  39. data/examples/video_convert.rb +10 -0
  40. data/filestack-ruby.gemspec +1 -0
  41. data/lib/filestack/config.rb +9 -5
  42. data/lib/filestack/mixins/filestack_common.rb +17 -1
  43. data/lib/filestack/models/filelink.rb +8 -1
  44. data/lib/filestack/models/filestack_client.rb +17 -3
  45. data/lib/filestack/ruby/version.rb +1 -1
  46. data/lib/filestack/utils/multipart_upload_utils.rb +91 -36
  47. data/lib/filestack/utils/utils.rb +309 -1
  48. metadata +52 -3
@@ -0,0 +1,729 @@
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: IntelligentState
8
+
9
+ &mdash; Documentation by YARD 0.9.9
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 = "IntelligentState";
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 (I)</a> &raquo;
40
+
41
+
42
+ <span class="title">IntelligentState</span>
43
+
44
+ </div>
45
+
46
+ <div id="search">
47
+
48
+ <a class="full_list_link" id="class_list_link"
49
+ href="class_list.html">
50
+
51
+ <svg width="24" height="24">
52
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
53
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
54
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
55
+ </svg>
56
+ </a>
57
+
58
+ </div>
59
+ <div class="clear"></div>
60
+ </div>
61
+
62
+ <div id="content"><h1>Class: IntelligentState
63
+
64
+
65
+
66
+ </h1>
67
+ <div class="box_info">
68
+
69
+ <dl>
70
+ <dt>Inherits:</dt>
71
+ <dd>
72
+ <span class="inheritName">Object</span>
73
+
74
+ <ul class="fullTree">
75
+ <li>Object</li>
76
+
77
+ <li class="next">IntelligentState</li>
78
+
79
+ </ul>
80
+ <a href="#" class="inheritanceTree">show all</a>
81
+
82
+ </dd>
83
+ </dl>
84
+
85
+
86
+
87
+
88
+
89
+
90
+
91
+
92
+
93
+
94
+
95
+ <dl>
96
+ <dt>Defined in:</dt>
97
+ <dd>lib/filestack/utils/utils.rb</dd>
98
+ </dl>
99
+
100
+ </div>
101
+
102
+
103
+
104
+
105
+
106
+ <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
107
+ <ul class="summary">
108
+
109
+ <li class="public ">
110
+ <span class="summary_signature">
111
+
112
+ <a href="#error_type-instance_method" title="#error_type (instance method)">#<strong>error_type</strong> &#x21d2; Object </a>
113
+
114
+
115
+
116
+ </span>
117
+
118
+
119
+
120
+
121
+
122
+
123
+
124
+
125
+
126
+
127
+
128
+
129
+ <span class="summary_desc"><div class='inline'>
130
+ <p>Returns the value of attribute error_type.</p>
131
+ </div></span>
132
+
133
+ </li>
134
+
135
+
136
+ <li class="public ">
137
+ <span class="summary_signature">
138
+
139
+ <a href="#offset-instance_method" title="#offset (instance method)">#<strong>offset</strong> &#x21d2; Object </a>
140
+
141
+
142
+
143
+ </span>
144
+
145
+
146
+
147
+
148
+
149
+
150
+
151
+
152
+
153
+
154
+
155
+
156
+ <span class="summary_desc"><div class='inline'>
157
+ <p>Returns the value of attribute offset.</p>
158
+ </div></span>
159
+
160
+ </li>
161
+
162
+
163
+ <li class="public ">
164
+ <span class="summary_signature">
165
+
166
+ <a href="#ok-instance_method" title="#ok (instance method)">#<strong>ok</strong> &#x21d2; Object </a>
167
+
168
+
169
+
170
+ </span>
171
+
172
+
173
+
174
+
175
+
176
+
177
+
178
+
179
+
180
+
181
+
182
+
183
+ <span class="summary_desc"><div class='inline'>
184
+ <p>Returns the value of attribute ok.</p>
185
+ </div></span>
186
+
187
+ </li>
188
+
189
+
190
+ </ul>
191
+
192
+
193
+
194
+
195
+
196
+ <h2>
197
+ Instance Method Summary
198
+ <small><a href="#" class="summary_toggle">collapse</a></small>
199
+ </h2>
200
+
201
+ <ul class="summary">
202
+
203
+ <li class="public ">
204
+ <span class="summary_signature">
205
+
206
+ <a href="#add_retry-instance_method" title="#add_retry (instance method)">#<strong>add_retry</strong> &#x21d2; Object </a>
207
+
208
+
209
+
210
+ </span>
211
+
212
+
213
+
214
+
215
+
216
+
217
+
218
+
219
+
220
+ <span class="summary_desc"><div class='inline'></div></span>
221
+
222
+ </li>
223
+
224
+
225
+ <li class="public ">
226
+ <span class="summary_signature">
227
+
228
+ <a href="#alive%3F-instance_method" title="#alive? (instance method)">#<strong>alive?</strong> &#x21d2; Boolean </a>
229
+
230
+
231
+
232
+ </span>
233
+
234
+
235
+
236
+
237
+
238
+
239
+
240
+
241
+
242
+ <span class="summary_desc"><div class='inline'></div></span>
243
+
244
+ </li>
245
+
246
+
247
+ <li class="public ">
248
+ <span class="summary_signature">
249
+
250
+ <a href="#backoff-instance_method" title="#backoff (instance method)">#<strong>backoff</strong> &#x21d2; Object </a>
251
+
252
+
253
+
254
+ </span>
255
+
256
+
257
+
258
+
259
+
260
+
261
+
262
+
263
+
264
+ <span class="summary_desc"><div class='inline'></div></span>
265
+
266
+ </li>
267
+
268
+
269
+ <li class="public ">
270
+ <span class="summary_signature">
271
+
272
+ <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong> &#x21d2; IntelligentState </a>
273
+
274
+
275
+
276
+ </span>
277
+
278
+
279
+ <span class="note title constructor">constructor</span>
280
+
281
+
282
+
283
+
284
+
285
+
286
+
287
+
288
+ <span class="summary_desc"><div class='inline'>
289
+ <p>A new instance of IntelligentState.</p>
290
+ </div></span>
291
+
292
+ </li>
293
+
294
+
295
+ <li class="public ">
296
+ <span class="summary_signature">
297
+
298
+ <a href="#next_offset-instance_method" title="#next_offset (instance method)">#<strong>next_offset</strong> &#x21d2; Object </a>
299
+
300
+
301
+
302
+ </span>
303
+
304
+
305
+
306
+
307
+
308
+
309
+
310
+
311
+
312
+ <span class="summary_desc"><div class='inline'></div></span>
313
+
314
+ </li>
315
+
316
+
317
+ <li class="public ">
318
+ <span class="summary_signature">
319
+
320
+ <a href="#reset-instance_method" title="#reset (instance method)">#<strong>reset</strong> &#x21d2; Object </a>
321
+
322
+
323
+
324
+ </span>
325
+
326
+
327
+
328
+
329
+
330
+
331
+
332
+
333
+
334
+ <span class="summary_desc"><div class='inline'></div></span>
335
+
336
+ </li>
337
+
338
+
339
+ </ul>
340
+
341
+
342
+ <div id="constructor_details" class="method_details_list">
343
+ <h2>Constructor Details</h2>
344
+
345
+ <div class="method_details first">
346
+ <h3 class="signature first" id="initialize-instance_method">
347
+
348
+ #<strong>initialize</strong> &#x21d2; <tt><span class='object_link'><a href="" title="IntelligentState (class)">IntelligentState</a></span></tt>
349
+
350
+
351
+
352
+
353
+
354
+ </h3><div class="docstring">
355
+ <div class="discussion">
356
+
357
+ <p>Returns a new instance of IntelligentState</p>
358
+
359
+
360
+ </div>
361
+ </div>
362
+ <div class="tags">
363
+
364
+
365
+ </div><table class="source_code">
366
+ <tr>
367
+ <td>
368
+ <pre class="lines">
369
+
370
+
371
+ 13
372
+ 14
373
+ 15
374
+ 16
375
+ 17
376
+ 18
377
+ 19
378
+ 20
379
+ 21</pre>
380
+ </td>
381
+ <td>
382
+ <pre class="code"><span class="info file"># File 'lib/filestack/utils/utils.rb', line 13</span>
383
+
384
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span>
385
+ <span class='ivar'>@offset</span> <span class='op'>=</span> <span class='int'>524288</span>
386
+ <span class='ivar'>@ok</span> <span class='op'>=</span> <span class='kw'>true</span>
387
+ <span class='ivar'>@alive</span> <span class='op'>=</span> <span class='kw'>true</span>
388
+ <span class='ivar'>@retries</span> <span class='op'>=</span> <span class='int'>0</span>
389
+ <span class='ivar'>@backoff</span> <span class='op'>=</span> <span class='int'>1</span>
390
+ <span class='ivar'>@offset_index</span> <span class='op'>=</span> <span class='int'>0</span>
391
+ <span class='ivar'>@offset_sizes</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='int'>524288</span><span class='comma'>,</span> <span class='int'>262144</span><span class='comma'>,</span> <span class='int'>131072</span><span class='comma'>,</span> <span class='int'>65536</span><span class='comma'>,</span> <span class='int'>32768</span><span class='rbracket'>]</span>
392
+ <span class='kw'>end</span></pre>
393
+ </td>
394
+ </tr>
395
+ </table>
396
+ </div>
397
+
398
+ </div>
399
+
400
+ <div id="instance_attr_details" class="attr_details">
401
+ <h2>Instance Attribute Details</h2>
402
+
403
+
404
+ <span id="error_type=-instance_method"></span>
405
+ <div class="method_details first">
406
+ <h3 class="signature first" id="error_type-instance_method">
407
+
408
+ #<strong>error_type</strong> &#x21d2; <tt>Object</tt>
409
+
410
+
411
+
412
+
413
+
414
+ </h3><div class="docstring">
415
+ <div class="discussion">
416
+
417
+ <p>Returns the value of attribute error_type</p>
418
+
419
+
420
+ </div>
421
+ </div>
422
+ <div class="tags">
423
+
424
+
425
+ </div><table class="source_code">
426
+ <tr>
427
+ <td>
428
+ <pre class="lines">
429
+
430
+
431
+ 12
432
+ 13
433
+ 14</pre>
434
+ </td>
435
+ <td>
436
+ <pre class="code"><span class="info file"># File 'lib/filestack/utils/utils.rb', line 12</span>
437
+
438
+ <span class='kw'>def</span> <span class='id identifier rubyid_error_type'>error_type</span>
439
+ <span class='ivar'>@error_type</span>
440
+ <span class='kw'>end</span></pre>
441
+ </td>
442
+ </tr>
443
+ </table>
444
+ </div>
445
+
446
+
447
+ <span id="offset=-instance_method"></span>
448
+ <div class="method_details ">
449
+ <h3 class="signature " id="offset-instance_method">
450
+
451
+ #<strong>offset</strong> &#x21d2; <tt>Object</tt>
452
+
453
+
454
+
455
+
456
+
457
+ </h3><div class="docstring">
458
+ <div class="discussion">
459
+
460
+ <p>Returns the value of attribute offset</p>
461
+
462
+
463
+ </div>
464
+ </div>
465
+ <div class="tags">
466
+
467
+
468
+ </div><table class="source_code">
469
+ <tr>
470
+ <td>
471
+ <pre class="lines">
472
+
473
+
474
+ 12
475
+ 13
476
+ 14</pre>
477
+ </td>
478
+ <td>
479
+ <pre class="code"><span class="info file"># File 'lib/filestack/utils/utils.rb', line 12</span>
480
+
481
+ <span class='kw'>def</span> <span class='id identifier rubyid_offset'>offset</span>
482
+ <span class='ivar'>@offset</span>
483
+ <span class='kw'>end</span></pre>
484
+ </td>
485
+ </tr>
486
+ </table>
487
+ </div>
488
+
489
+
490
+ <span id="ok=-instance_method"></span>
491
+ <div class="method_details ">
492
+ <h3 class="signature " id="ok-instance_method">
493
+
494
+ #<strong>ok</strong> &#x21d2; <tt>Object</tt>
495
+
496
+
497
+
498
+
499
+
500
+ </h3><div class="docstring">
501
+ <div class="discussion">
502
+
503
+ <p>Returns the value of attribute ok</p>
504
+
505
+
506
+ </div>
507
+ </div>
508
+ <div class="tags">
509
+
510
+
511
+ </div><table class="source_code">
512
+ <tr>
513
+ <td>
514
+ <pre class="lines">
515
+
516
+
517
+ 12
518
+ 13
519
+ 14</pre>
520
+ </td>
521
+ <td>
522
+ <pre class="code"><span class="info file"># File 'lib/filestack/utils/utils.rb', line 12</span>
523
+
524
+ <span class='kw'>def</span> <span class='id identifier rubyid_ok'>ok</span>
525
+ <span class='ivar'>@ok</span>
526
+ <span class='kw'>end</span></pre>
527
+ </td>
528
+ </tr>
529
+ </table>
530
+ </div>
531
+
532
+ </div>
533
+
534
+
535
+ <div id="instance_method_details" class="method_details_list">
536
+ <h2>Instance Method Details</h2>
537
+
538
+
539
+ <div class="method_details first">
540
+ <h3 class="signature first" id="add_retry-instance_method">
541
+
542
+ #<strong>add_retry</strong> &#x21d2; <tt>Object</tt>
543
+
544
+
545
+
546
+
547
+
548
+ </h3><table class="source_code">
549
+ <tr>
550
+ <td>
551
+ <pre class="lines">
552
+
553
+
554
+ 27
555
+ 28
556
+ 29
557
+ 30</pre>
558
+ </td>
559
+ <td>
560
+ <pre class="code"><span class="info file"># File 'lib/filestack/utils/utils.rb', line 27</span>
561
+
562
+ <span class='kw'>def</span> <span class='id identifier rubyid_add_retry'>add_retry</span>
563
+ <span class='ivar'>@retries</span> <span class='op'>+=</span> <span class='int'>1</span>
564
+ <span class='ivar'>@alive</span> <span class='op'>=</span> <span class='kw'>false</span> <span class='kw'>if</span> <span class='ivar'>@retries</span> <span class='op'>&gt;=</span> <span class='int'>5</span>
565
+ <span class='kw'>end</span></pre>
566
+ </td>
567
+ </tr>
568
+ </table>
569
+ </div>
570
+
571
+ <div class="method_details ">
572
+ <h3 class="signature " id="alive?-instance_method">
573
+
574
+ #<strong>alive?</strong> &#x21d2; <tt>Boolean</tt>
575
+
576
+
577
+
578
+
579
+
580
+ </h3><div class="docstring">
581
+ <div class="discussion">
582
+
583
+
584
+ </div>
585
+ </div>
586
+ <div class="tags">
587
+
588
+ <p class="tag_title">Returns:</p>
589
+ <ul class="return">
590
+
591
+ <li>
592
+
593
+
594
+ <span class='type'>(<tt>Boolean</tt>)</span>
595
+
596
+
597
+
598
+ </li>
599
+
600
+ </ul>
601
+
602
+ </div><table class="source_code">
603
+ <tr>
604
+ <td>
605
+ <pre class="lines">
606
+
607
+
608
+ 23
609
+ 24
610
+ 25</pre>
611
+ </td>
612
+ <td>
613
+ <pre class="code"><span class="info file"># File 'lib/filestack/utils/utils.rb', line 23</span>
614
+
615
+ <span class='kw'>def</span> <span class='id identifier rubyid_alive?'>alive?</span>
616
+ <span class='ivar'>@alive</span>
617
+ <span class='kw'>end</span></pre>
618
+ </td>
619
+ </tr>
620
+ </table>
621
+ </div>
622
+
623
+ <div class="method_details ">
624
+ <h3 class="signature " id="backoff-instance_method">
625
+
626
+ #<strong>backoff</strong> &#x21d2; <tt>Object</tt>
627
+
628
+
629
+
630
+
631
+
632
+ </h3><table class="source_code">
633
+ <tr>
634
+ <td>
635
+ <pre class="lines">
636
+
637
+
638
+ 32
639
+ 33
640
+ 34</pre>
641
+ </td>
642
+ <td>
643
+ <pre class="code"><span class="info file"># File 'lib/filestack/utils/utils.rb', line 32</span>
644
+
645
+ <span class='kw'>def</span> <span class='id identifier rubyid_backoff'>backoff</span>
646
+ <span class='ivar'>@backoff</span> <span class='op'>=</span> <span class='int'>2</span> <span class='op'>**</span> <span class='id identifier rubyid_retries'>retries</span>
647
+ <span class='kw'>end</span></pre>
648
+ </td>
649
+ </tr>
650
+ </table>
651
+ </div>
652
+
653
+ <div class="method_details ">
654
+ <h3 class="signature " id="next_offset-instance_method">
655
+
656
+ #<strong>next_offset</strong> &#x21d2; <tt>Object</tt>
657
+
658
+
659
+
660
+
661
+
662
+ </h3><table class="source_code">
663
+ <tr>
664
+ <td>
665
+ <pre class="lines">
666
+
667
+
668
+ 36
669
+ 37
670
+ 38
671
+ 39
672
+ 40</pre>
673
+ </td>
674
+ <td>
675
+ <pre class="code"><span class="info file"># File 'lib/filestack/utils/utils.rb', line 36</span>
676
+
677
+ <span class='kw'>def</span> <span class='id identifier rubyid_next_offset'>next_offset</span>
678
+ <span class='id identifier rubyid_current_offset'>current_offset</span> <span class='op'>=</span> <span class='ivar'>@offset_sizes</span><span class='lbracket'>[</span><span class='ivar'>@offset_index</span><span class='rbracket'>]</span>
679
+ <span class='ivar'>@offset_index</span> <span class='op'>+=</span> <span class='int'>1</span>
680
+ <span class='kw'>return</span> <span class='id identifier rubyid_current_offset'>current_offset</span>
681
+ <span class='kw'>end</span></pre>
682
+ </td>
683
+ </tr>
684
+ </table>
685
+ </div>
686
+
687
+ <div class="method_details ">
688
+ <h3 class="signature " id="reset-instance_method">
689
+
690
+ #<strong>reset</strong> &#x21d2; <tt>Object</tt>
691
+
692
+
693
+
694
+
695
+
696
+ </h3><table class="source_code">
697
+ <tr>
698
+ <td>
699
+ <pre class="lines">
700
+
701
+
702
+ 42
703
+ 43
704
+ 44</pre>
705
+ </td>
706
+ <td>
707
+ <pre class="code"><span class="info file"># File 'lib/filestack/utils/utils.rb', line 42</span>
708
+
709
+ <span class='kw'>def</span> <span class='id identifier rubyid_reset'>reset</span>
710
+ <span class='ivar'>@retries</span> <span class='op'>=</span> <span class='int'>0</span>
711
+ <span class='kw'>end</span></pre>
712
+ </td>
713
+ </tr>
714
+ </table>
715
+ </div>
716
+
717
+ </div>
718
+
719
+ </div>
720
+
721
+ <div id="footer">
722
+ Generated on Thu Aug 17 10:04:38 2017 by
723
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
724
+ 0.9.9 (ruby-2.4.0).
725
+ </div>
726
+
727
+ </div>
728
+ </body>
729
+ </html>