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
data/docs/TransformConfig.html ADDED
@@ -0,0 +1,138 @@
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: TransformConfig
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 = "TransformConfig";
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 (T)</a> &raquo;
40
+
41
+
42
+ <span class="title">TransformConfig</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: TransformConfig
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">TransformConfig</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/config.rb</dd>
98
+ </dl>
99
+
100
+ </div>
101
+
102
+
103
+ <h2>Constant Summary</h2>
104
+ <dl class="constants">
105
+
106
+ <dt id="TRANSFORMATIONS-constant" class="">TRANSFORMATIONS =
107
+
108
+ </dt>
109
+ <dd><pre class="code"><span class='qwords_beg'>%w[
110
+ </span><span class='tstring_content'> resize</span><span class='words_sep'> </span><span class='tstring_content'>crop</span><span class='words_sep'> </span><span class='tstring_content'>rotate</span><span class='words_sep'> </span><span class='tstring_content'>flip</span><span class='words_sep'> </span><span class='tstring_content'>flop</span><span class='words_sep'> </span><span class='tstring_content'>watermark</span><span class='words_sep'> </span><span class='tstring_content'>detect_faces</span><span class='words_sep'>
111
+ </span><span class='tstring_content'> crop_faces</span><span class='words_sep'> </span><span class='tstring_content'>pixelate_faces</span><span class='words_sep'> </span><span class='tstring_content'>round_corners</span><span class='words_sep'> </span><span class='tstring_content'>vignette</span><span class='words_sep'> </span><span class='tstring_content'>polaroid</span><span class='words_sep'>
112
+ </span><span class='tstring_content'> torn_edges</span><span class='words_sep'> </span><span class='tstring_content'>shadow</span><span class='words_sep'> </span><span class='tstring_content'>circle</span><span class='words_sep'> </span><span class='tstring_content'>border</span><span class='words_sep'> </span><span class='tstring_content'>sharpen</span><span class='words_sep'> </span><span class='tstring_content'>blur</span><span class='words_sep'> </span><span class='tstring_content'>monochrome</span><span class='words_sep'>
113
+ </span><span class='tstring_content'> blackwhite</span><span class='words_sep'> </span><span class='tstring_content'>sepia</span><span class='words_sep'> </span><span class='tstring_content'>pixelate</span><span class='words_sep'> </span><span class='tstring_content'>oil_paint</span><span class='words_sep'> </span><span class='tstring_content'>negative</span><span class='words_sep'> </span><span class='tstring_content'>modulate</span><span class='words_sep'>
114
+ </span><span class='tstring_content'> partial_pixelate</span><span class='words_sep'> </span><span class='tstring_content'>partial_blur</span><span class='words_sep'> </span><span class='tstring_content'>collage</span><span class='words_sep'> </span><span class='tstring_content'>upscale</span><span class='words_sep'> </span><span class='tstring_content'>enhance</span><span class='words_sep'>
115
+ </span><span class='tstring_content'> redeye</span><span class='words_sep'> </span><span class='tstring_content'>ascii</span><span class='words_sep'> </span><span class='tstring_content'>filetype_conversion</span><span class='words_sep'> </span><span class='tstring_content'>quality</span><span class='words_sep'>
116
+ </span><span class='tstring_end'>]</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
117
+
118
+ </dl>
119
+
120
+
121
+
122
+
123
+
124
+
125
+
126
+
127
+
128
+ </div>
129
+
130
+ <div id="footer">
131
+ Generated on Thu Aug 17 10:04:38 2017 by
132
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
133
+ 0.9.9 (ruby-2.4.0).
134
+ </div>
135
+
136
+ </div>
137
+ </body>
138
+ </html>
data/docs/TransformUtils.html ADDED
@@ -0,0 +1,272 @@
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: TransformUtils
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 = "TransformUtils";
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 (T)</a> &raquo;
40
+
41
+
42
+ <span class="title">TransformUtils</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: TransformUtils
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="Transform.html" title="Transform (class)">Transform</a></span></dd>
80
+ </dl>
81
+
82
+
83
+
84
+ <dl>
85
+ <dt>Defined in:</dt>
86
+ <dd>lib/filestack/utils/utils.rb</dd>
87
+ </dl>
88
+
89
+ </div>
90
+
91
+ <h2>Overview</h2><div class="docstring">
92
+ <div class="discussion">
93
+
94
+ <p>Utility functions for transformations</p>
95
+
96
+
97
+ </div>
98
+ </div>
99
+ <div class="tags">
100
+
101
+
102
+ </div>
103
+
104
+
105
+
106
+
107
+
108
+
109
+
110
+ <h2>
111
+ Instance Method Summary
112
+ <small><a href="#" class="summary_toggle">collapse</a></small>
113
+ </h2>
114
+
115
+ <ul class="summary">
116
+
117
+ <li class="public ">
118
+ <span class="summary_signature">
119
+
120
+ <a href="#add_transform_task-instance_method" title="#add_transform_task (instance method)">#<strong>add_transform_task</strong>(transform, options = {}) &#x21d2; String </a>
121
+
122
+
123
+
124
+ </span>
125
+
126
+
127
+
128
+
129
+
130
+
131
+
132
+
133
+
134
+ <span class="summary_desc"><div class='inline'>
135
+ <p>Creates a transformation task to be sent back to transform object.</p>
136
+ </div></span>
137
+
138
+ </li>
139
+
140
+
141
+ </ul>
142
+
143
+
144
+
145
+
146
+ <div id="instance_method_details" class="method_details_list">
147
+ <h2>Instance Method Details</h2>
148
+
149
+
150
+ <div class="method_details first">
151
+ <h3 class="signature first" id="add_transform_task-instance_method">
152
+
153
+ #<strong>add_transform_task</strong>(transform, options = {}) &#x21d2; <tt>String</tt>
154
+
155
+
156
+
157
+
158
+
159
+ </h3><div class="docstring">
160
+ <div class="discussion">
161
+
162
+ <p>Creates a transformation task to be sent back to transform object</p>
163
+
164
+
165
+ </div>
166
+ </div>
167
+ <div class="tags">
168
+ <p class="tag_title">Parameters:</p>
169
+ <ul class="param">
170
+
171
+ <li>
172
+
173
+ <span class='name'>transform</span>
174
+
175
+
176
+ <span class='type'>(<tt>String</tt>)</span>
177
+
178
+
179
+
180
+ &mdash;
181
+ <div class='inline'>
182
+ <p>The task to be added</p>
183
+ </div>
184
+
185
+ </li>
186
+
187
+ <li>
188
+
189
+ <span class='name'>options</span>
190
+
191
+
192
+ <span class='type'>(<tt>Dict</tt>)</span>
193
+
194
+
195
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
196
+
197
+
198
+ &mdash;
199
+ <div class='inline'>
200
+ <p>A dictionary representing the options for that task</p>
201
+ </div>
202
+
203
+ </li>
204
+
205
+ </ul>
206
+
207
+ <p class="tag_title">Returns:</p>
208
+ <ul class="return">
209
+
210
+ <li>
211
+
212
+
213
+ <span class='type'>(<tt>String</tt>)</span>
214
+
215
+
216
+
217
+ </li>
218
+
219
+ </ul>
220
+
221
+ </div><table class="source_code">
222
+ <tr>
223
+ <td>
224
+ <pre class="lines">
225
+
226
+
227
+ 136
228
+ 137
229
+ 138
230
+ 139
231
+ 140
232
+ 141
233
+ 142
234
+ 143
235
+ 144
236
+ 145
237
+ 146
238
+ 147</pre>
239
+ </td>
240
+ <td>
241
+ <pre class="code"><span class="info file"># File 'lib/filestack/utils/utils.rb', line 136</span>
242
+
243
+ <span class='kw'>def</span> <span class='id identifier rubyid_add_transform_task'>add_transform_task</span><span class='lparen'>(</span><span class='id identifier rubyid_transform'>transform</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
244
+ <span class='id identifier rubyid_options_list'>options_list</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
245
+ <span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
246
+ <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_array'>array</span><span class='op'>|</span>
247
+ <span class='id identifier rubyid_options_list'>options_list</span><span class='period'>.</span><span class='id identifier rubyid_push'>push</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_key'>key</span><span class='embexpr_end'>}</span><span class='tstring_content'>:</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_array'>array</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
248
+ <span class='kw'>end</span>
249
+ <span class='id identifier rubyid_options_string'>options_string</span> <span class='op'>=</span> <span class='id identifier rubyid_options_list'>options_list</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>,</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
250
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_transform'>transform</span><span class='embexpr_end'>}</span><span class='tstring_content'>=</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_options_string'>options_string</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
251
+ <span class='kw'>else</span>
252
+ <span class='id identifier rubyid_transform'>transform</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>
253
+ <span class='kw'>end</span>
254
+ <span class='kw'>end</span></pre>
255
+ </td>
256
+ </tr>
257
+ </table>
258
+ </div>
259
+
260
+ </div>
261
+
262
+ </div>
263
+
264
+ <div id="footer">
265
+ Generated on Thu Aug 17 10:04:38 2017 by
266
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
267
+ 0.9.9 (ruby-2.4.0).
268
+ </div>
269
+
270
+ </div>
271
+ </body>
272
+ </html>
data/docs/UploadUtils.html ADDED
@@ -0,0 +1,673 @@
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: UploadUtils
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 = "UploadUtils";
19
+ relpath = '';
20
+ </script>
21
+
22
+
23
+ <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
24
+
25
+ <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
26
+
27
+
28
+ </head>
29
+ <body>
30
+ <div class="nav_wrap">
31
+ <iframe id="nav" src="class_list.html?1"></iframe>
32
+ <div id="resizer"></div>
33
+ </div>
34
+
35
+ <div id="main" tabindex="-1">
36
+ <div id="header">
37
+ <div id="menu">
38
+
39
+ <a href="_index.html">Index (U)</a> &raquo;
40
+
41
+
42
+ <span class="title">UploadUtils</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: UploadUtils
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="AV.html" title="AV (class)">AV</a></span>, <span class='object_link'><a href="FilestackClient.html" title="FilestackClient (class)">FilestackClient</a></span>, <span class='object_link'><a href="FilestackCommon.html" title="FilestackCommon (module)">FilestackCommon</a></span>, <span class='object_link'><a href="FilestackFilelink.html" title="FilestackFilelink (class)">FilestackFilelink</a></span></dd>
80
+ </dl>
81
+
82
+
83
+
84
+ <dl>
85
+ <dt>Defined in:</dt>
86
+ <dd>lib/filestack/utils/utils.rb</dd>
87
+ </dl>
88
+
89
+ </div>
90
+
91
+ <h2>Overview</h2><div class="docstring">
92
+ <div class="discussion">
93
+
94
+ <p>Includes general utility functions for the Filestack Ruby SDK</p>
95
+
96
+
97
+ </div>
98
+ </div>
99
+ <div class="tags">
100
+
101
+
102
+ </div>
103
+
104
+
105
+
106
+
107
+
108
+
109
+
110
+ <h2>
111
+ Instance Method Summary
112
+ <small><a href="#" class="summary_toggle">collapse</a></small>
113
+ </h2>
114
+
115
+ <ul class="summary">
116
+
117
+ <li class="public ">
118
+ <span class="summary_signature">
119
+
120
+ <a href="#get_url-instance_method" title="#get_url (instance method)">#<strong>get_url</strong>(base, handle: nil, path: nil, security: nil) &#x21d2; String </a>
121
+
122
+
123
+
124
+ </span>
125
+
126
+
127
+
128
+
129
+
130
+
131
+
132
+
133
+
134
+ <span class="summary_desc"><div class='inline'>
135
+ <p>Generates the URL for a FilestackFilelink object.</p>
136
+ </div></span>
137
+
138
+ </li>
139
+
140
+
141
+ <li class="public ">
142
+ <span class="summary_signature">
143
+
144
+ <a href="#make_call-instance_method" title="#make_call (instance method)">#<strong>make_call</strong>(url, action, parameters: nil, headers: nil) &#x21d2; Unirest::Request </a>
145
+
146
+
147
+
148
+ </span>
149
+
150
+
151
+
152
+
153
+
154
+
155
+
156
+
157
+
158
+ <span class="summary_desc"><div class='inline'>
159
+ <p>General request function.</p>
160
+ </div></span>
161
+
162
+ </li>
163
+
164
+
165
+ <li class="public ">
166
+ <span class="summary_signature">
167
+
168
+ <a href="#send_upload-instance_method" title="#send_upload (instance method)">#<strong>send_upload</strong>(apikey, filepath: nil, external_url: nil, security: nil, options: nil, storage: &#39;S3&#39;) &#x21d2; Unirest::Response </a>
169
+
170
+
171
+
172
+ </span>
173
+
174
+
175
+
176
+
177
+
178
+
179
+
180
+
181
+
182
+ <span class="summary_desc"><div class='inline'>
183
+ <p>Uploads to v1 REST API (for external URLs or if multipart is turned off).</p>
184
+ </div></span>
185
+
186
+ </li>
187
+
188
+
189
+ </ul>
190
+
191
+
192
+
193
+
194
+ <div id="instance_method_details" class="method_details_list">
195
+ <h2>Instance Method Details</h2>
196
+
197
+
198
+ <div class="method_details first">
199
+ <h3 class="signature first" id="get_url-instance_method">
200
+
201
+ #<strong>get_url</strong>(base, handle: nil, path: nil, security: nil) &#x21d2; <tt>String</tt>
202
+
203
+
204
+
205
+
206
+
207
+ </h3><div class="docstring">
208
+ <div class="discussion">
209
+
210
+ <p>Generates the URL for a FilestackFilelink object</p>
211
+
212
+
213
+ </div>
214
+ </div>
215
+ <div class="tags">
216
+ <p class="tag_title">Parameters:</p>
217
+ <ul class="param">
218
+
219
+ <li>
220
+
221
+ <span class='name'>base</span>
222
+
223
+
224
+ <span class='type'>(<tt>String</tt>)</span>
225
+
226
+
227
+
228
+ &mdash;
229
+ <div class='inline'>
230
+ <p>The base Filestack URL</p>
231
+ </div>
232
+
233
+ </li>
234
+
235
+ <li>
236
+
237
+ <span class='name'>handle</span>
238
+
239
+
240
+ <span class='type'>(<tt>String</tt>)</span>
241
+
242
+
243
+
244
+ &mdash;
245
+ <div class='inline'>
246
+ <p>The FilestackFilelink handle (optional)</p>
247
+ </div>
248
+
249
+ </li>
250
+
251
+ <li>
252
+
253
+ <span class='name'>path</span>
254
+
255
+
256
+ <span class='type'>(<tt>String</tt>)</span>
257
+
258
+
259
+
260
+ &mdash;
261
+ <div class='inline'>
262
+ <p>The specific API path (optional)</p>
263
+ </div>
264
+
265
+ </li>
266
+
267
+ <li>
268
+
269
+ <span class='name'>security</span>
270
+
271
+
272
+ <span class='type'>(<tt>String</tt>)</span>
273
+
274
+
275
+
276
+ &mdash;
277
+ <div class='inline'>
278
+ <p>Security for the FilestackFilelink (optional)</p>
279
+ </div>
280
+
281
+ </li>
282
+
283
+ </ul>
284
+
285
+ <p class="tag_title">Returns:</p>
286
+ <ul class="return">
287
+
288
+ <li>
289
+
290
+
291
+ <span class='type'>(<tt>String</tt>)</span>
292
+
293
+
294
+
295
+ </li>
296
+
297
+ </ul>
298
+
299
+ </div><table class="source_code">
300
+ <tr>
301
+ <td>
302
+ <pre class="lines">
303
+
304
+
305
+ 111
306
+ 112
307
+ 113
308
+ 114
309
+ 115
310
+ 116
311
+ 117
312
+ 118
313
+ 119
314
+ 120
315
+ 121
316
+ 122
317
+ 123
318
+ 124
319
+ 125</pre>
320
+ </td>
321
+ <td>
322
+ <pre class="code"><span class="info file"># File 'lib/filestack/utils/utils.rb', line 111</span>
323
+
324
+ <span class='kw'>def</span> <span class='id identifier rubyid_get_url'>get_url</span><span class='lparen'>(</span><span class='id identifier rubyid_base'>base</span><span class='comma'>,</span> <span class='label'>handle:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>path:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>security:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
325
+ <span class='id identifier rubyid_url_components'>url_components</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='id identifier rubyid_base'>base</span><span class='rbracket'>]</span>
326
+
327
+ <span class='id identifier rubyid_url_components'>url_components</span><span class='period'>.</span><span class='id identifier rubyid_push'>push</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id identifier rubyid_path'>path</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
328
+ <span class='id identifier rubyid_url_components'>url_components</span><span class='period'>.</span><span class='id identifier rubyid_push'>push</span><span class='lparen'>(</span><span class='id identifier rubyid_handle'>handle</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id identifier rubyid_handle'>handle</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
329
+ <span class='id identifier rubyid_url'>url</span> <span class='op'>=</span> <span class='id identifier rubyid_url_components'>url_components</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
330
+
331
+ <span class='kw'>if</span> <span class='id identifier rubyid_security'>security</span>
332
+ <span class='id identifier rubyid_policy'>policy</span> <span class='op'>=</span> <span class='id identifier rubyid_security'>security</span><span class='period'>.</span><span class='id identifier rubyid_policy'>policy</span>
333
+ <span class='id identifier rubyid_signature'>signature</span> <span class='op'>=</span> <span class='id identifier rubyid_security'>security</span><span class='period'>.</span><span class='id identifier rubyid_signature'>signature</span>
334
+ <span class='id identifier rubyid_security_path'>security_path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>policy=</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_policy'>policy</span><span class='embexpr_end'>}</span><span class='tstring_content'>&amp;signature=</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_signature'>signature</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
335
+ <span class='id identifier rubyid_url'>url</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_url'>url</span><span class='embexpr_end'>}</span><span class='tstring_content'>?</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_security_path'>security_path</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
336
+ <span class='kw'>end</span>
337
+ <span class='id identifier rubyid_url'>url</span>
338
+ <span class='kw'>end</span></pre>
339
+ </td>
340
+ </tr>
341
+ </table>
342
+ </div>
343
+
344
+ <div class="method_details ">
345
+ <h3 class="signature " id="make_call-instance_method">
346
+
347
+ #<strong>make_call</strong>(url, action, parameters: nil, headers: nil) &#x21d2; <tt>Unirest::Request</tt>
348
+
349
+
350
+
351
+
352
+
353
+ </h3><div class="docstring">
354
+ <div class="discussion">
355
+
356
+ <p>General request function</p>
357
+
358
+
359
+ </div>
360
+ </div>
361
+ <div class="tags">
362
+ <p class="tag_title">Parameters:</p>
363
+ <ul class="param">
364
+
365
+ <li>
366
+
367
+ <span class='name'>url</span>
368
+
369
+
370
+ <span class='type'>(<tt>String</tt>)</span>
371
+
372
+
373
+
374
+ &mdash;
375
+ <div class='inline'>
376
+ <p>The URL being called</p>
377
+ </div>
378
+
379
+ </li>
380
+
381
+ <li>
382
+
383
+ <span class='name'>action</span>
384
+
385
+
386
+ <span class='type'>(<tt>String</tt>)</span>
387
+
388
+
389
+
390
+ &mdash;
391
+ <div class='inline'>
392
+ <p>The specific HTTP action (&#39;get&#39;, &#39;post&#39;, &#39;delete&#39;,
393
+ &#39;put&#39;)</p>
394
+ </div>
395
+
396
+ </li>
397
+
398
+ <li>
399
+
400
+ <span class='name'>parameters</span>
401
+
402
+
403
+ <span class='type'>(<tt>Hash</tt>)</span>
404
+
405
+
406
+
407
+ &mdash;
408
+ <div class='inline'>
409
+ <p>The query and/or body parameters</p>
410
+ </div>
411
+
412
+ </li>
413
+
414
+ </ul>
415
+
416
+ <p class="tag_title">Returns:</p>
417
+ <ul class="return">
418
+
419
+ <li>
420
+
421
+
422
+ <span class='type'>(<tt>Unirest::Request</tt>)</span>
423
+
424
+
425
+
426
+ </li>
427
+
428
+ </ul>
429
+
430
+ </div><table class="source_code">
431
+ <tr>
432
+ <td>
433
+ <pre class="lines">
434
+
435
+
436
+ 56
437
+ 57
438
+ 58
439
+ 59
440
+ 60
441
+ 61
442
+ 62
443
+ 63
444
+ 64
445
+ 65</pre>
446
+ </td>
447
+ <td>
448
+ <pre class="code"><span class="info file"># File 'lib/filestack/utils/utils.rb', line 56</span>
449
+
450
+ <span class='kw'>def</span> <span class='id identifier rubyid_make_call'>make_call</span><span class='lparen'>(</span><span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='id identifier rubyid_action'>action</span><span class='comma'>,</span> <span class='label'>parameters:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>headers:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
451
+ <span class='id identifier rubyid_headers'>headers</span> <span class='op'>=</span> <span class='kw'>if</span> <span class='id identifier rubyid_headers'>headers</span>
452
+ <span class='id identifier rubyid_headers'>headers</span><span class='period'>.</span><span class='id identifier rubyid_merge!'>merge!</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="FilestackConfig.html" title="FilestackConfig (class)">FilestackConfig</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="FilestackConfig.html#HEADERS-constant" title="FilestackConfig::HEADERS (constant)">HEADERS</a></span></span><span class='rparen'>)</span>
453
+ <span class='kw'>else</span>
454
+ <span class='const'><span class='object_link'><a href="FilestackConfig.html" title="FilestackConfig (class)">FilestackConfig</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="FilestackConfig.html#HEADERS-constant" title="FilestackConfig::HEADERS (constant)">HEADERS</a></span></span>
455
+ <span class='kw'>end</span>
456
+ <span class='const'>Unirest</span><span class='period'>.</span><span class='id identifier rubyid_public_send'>public_send</span><span class='lparen'>(</span>
457
+ <span class='id identifier rubyid_action'>action</span><span class='comma'>,</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='label'>parameters:</span> <span class='id identifier rubyid_parameters'>parameters</span><span class='comma'>,</span> <span class='label'>headers:</span> <span class='id identifier rubyid_headers'>headers</span>
458
+ <span class='rparen'>)</span>
459
+ <span class='kw'>end</span></pre>
460
+ </td>
461
+ </tr>
462
+ </table>
463
+ </div>
464
+
465
+ <div class="method_details ">
466
+ <h3 class="signature " id="send_upload-instance_method">
467
+
468
+ #<strong>send_upload</strong>(apikey, filepath: nil, external_url: nil, security: nil, options: nil, storage: &#39;S3&#39;) &#x21d2; <tt>Unirest::Response</tt>
469
+
470
+
471
+
472
+
473
+
474
+ </h3><div class="docstring">
475
+ <div class="discussion">
476
+
477
+ <p>Uploads to v1 REST API (for external URLs or if multipart is turned off)</p>
478
+
479
+
480
+ </div>
481
+ </div>
482
+ <div class="tags">
483
+ <p class="tag_title">Parameters:</p>
484
+ <ul class="param">
485
+
486
+ <li>
487
+
488
+ <span class='name'>apikey</span>
489
+
490
+
491
+ <span class='type'>(<tt>String</tt>)</span>
492
+
493
+
494
+
495
+ &mdash;
496
+ <div class='inline'>
497
+ <p>Filestack API key</p>
498
+ </div>
499
+
500
+ </li>
501
+
502
+ <li>
503
+
504
+ <span class='name'>filepath</span>
505
+
506
+
507
+ <span class='type'>(<tt>String</tt>)</span>
508
+
509
+
510
+
511
+ &mdash;
512
+ <div class='inline'>
513
+ <p>Local path to file</p>
514
+ </div>
515
+
516
+ </li>
517
+
518
+ <li>
519
+
520
+ <span class='name'>external_url</span>
521
+
522
+
523
+ <span class='type'>(<tt>String</tt>)</span>
524
+
525
+
526
+
527
+ &mdash;
528
+ <div class='inline'>
529
+ <p>External URL to be uploaded</p>
530
+ </div>
531
+
532
+ </li>
533
+
534
+ <li>
535
+
536
+ <span class='name'>security</span>
537
+
538
+
539
+ <span class='type'>(<tt><span class='object_link'><a href="FilestackSecurity.html" title="FilestackSecurity (class)">FilestackSecurity</a></span></tt>)</span>
540
+
541
+
542
+
543
+ &mdash;
544
+ <div class='inline'>
545
+ <p>Security object with policy/signature</p>
546
+ </div>
547
+
548
+ </li>
549
+
550
+ <li>
551
+
552
+ <span class='name'>options</span>
553
+
554
+
555
+ <span class='type'>(<tt>Hash</tt>)</span>
556
+
557
+
558
+
559
+ &mdash;
560
+ <div class='inline'>
561
+ <p>User-defined options for multipart uploads</p>
562
+ </div>
563
+
564
+ </li>
565
+
566
+ <li>
567
+
568
+ <span class='name'>storage</span>
569
+
570
+
571
+ <span class='type'>(<tt>String</tt>)</span>
572
+
573
+
574
+
575
+ &mdash;
576
+ <div class='inline'>
577
+ <p>Storage destination (s3, rackspace, etc)</p>
578
+ </div>
579
+
580
+ </li>
581
+
582
+ </ul>
583
+
584
+ <p class="tag_title">Returns:</p>
585
+ <ul class="return">
586
+
587
+ <li>
588
+
589
+
590
+ <span class='type'>(<tt>Unirest::Response</tt>)</span>
591
+
592
+
593
+
594
+ </li>
595
+
596
+ </ul>
597
+
598
+ </div><table class="source_code">
599
+ <tr>
600
+ <td>
601
+ <pre class="lines">
602
+
603
+
604
+ 79
605
+ 80
606
+ 81
607
+ 82
608
+ 83
609
+ 84
610
+ 85
611
+ 86
612
+ 87
613
+ 88
614
+ 89
615
+ 90
616
+ 91
617
+ 92
618
+ 93
619
+ 94
620
+ 95
621
+ 96
622
+ 97
623
+ 98
624
+ 99
625
+ 100
626
+ 101
627
+ 102</pre>
628
+ </td>
629
+ <td>
630
+ <pre class="code"><span class="info file"># File 'lib/filestack/utils/utils.rb', line 79</span>
631
+
632
+ <span class='kw'>def</span> <span class='id identifier rubyid_send_upload'>send_upload</span><span class='lparen'>(</span><span class='id identifier rubyid_apikey'>apikey</span><span class='comma'>,</span> <span class='label'>filepath:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>external_url:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>security:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>options:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>storage:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>S3</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
633
+ <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='kw'>if</span> <span class='id identifier rubyid_filepath'>filepath</span>
634
+ <span class='lbrace'>{</span> <span class='label'>fileUpload:</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_open'>open</span><span class='lparen'>(</span><span class='id identifier rubyid_filepath'>filepath</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
635
+ <span class='kw'>else</span>
636
+ <span class='lbrace'>{</span> <span class='label'>url:</span> <span class='id identifier rubyid_external_url'>external_url</span> <span class='rbrace'>}</span>
637
+ <span class='kw'>end</span>
638
+
639
+ <span class='comment'># adds any user-defined upload options to request payload
640
+ </span> <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_merge!'>merge!</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
641
+ <span class='id identifier rubyid_base'>base</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="FilestackConfig.html" title="FilestackConfig (class)">FilestackConfig</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="FilestackConfig.html#API_URL-constant" title="FilestackConfig::API_URL (constant)">API_URL</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>/store/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_storage'>storage</span><span class='embexpr_end'>}</span><span class='tstring_content'>?key=</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_apikey'>apikey</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
642
+
643
+ <span class='kw'>if</span> <span class='id identifier rubyid_security'>security</span>
644
+ <span class='id identifier rubyid_policy'>policy</span> <span class='op'>=</span> <span class='id identifier rubyid_security'>security</span><span class='period'>.</span><span class='id identifier rubyid_policy'>policy</span>
645
+ <span class='id identifier rubyid_signature'>signature</span> <span class='op'>=</span> <span class='id identifier rubyid_security'>security</span><span class='period'>.</span><span class='id identifier rubyid_signature'>signature</span>
646
+ <span class='id identifier rubyid_base'>base</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_base'>base</span><span class='embexpr_end'>}</span><span class='tstring_content'>&amp;signature=</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_signature'>signature</span><span class='embexpr_end'>}</span><span class='tstring_content'>&amp;policy=</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_policy'>policy</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
647
+ <span class='kw'>end</span>
648
+
649
+ <span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='id identifier rubyid_make_call'><span class='object_link'><a href="#make_call-instance_method" title="UploadUtils#make_call (method)">make_call</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_base'>base</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>post</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='label'>parameters:</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
650
+ <span class='kw'>if</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_code'>code</span> <span class='op'>==</span> <span class='int'>200</span>
651
+ <span class='id identifier rubyid_handle'>handle</span> <span class='op'>=</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>url</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_split'>split</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_last'>last</span>
652
+ <span class='kw'>return</span> <span class='lbrace'>{</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>handle</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_handle'>handle</span> <span class='rbrace'>}</span>
653
+ <span class='kw'>end</span>
654
+ <span class='id identifier rubyid_raise'>raise</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span>
655
+ <span class='kw'>end</span></pre>
656
+ </td>
657
+ </tr>
658
+ </table>
659
+ </div>
660
+
661
+ </div>
662
+
663
+ </div>
664
+
665
+ <div id="footer">
666
+ Generated on Thu Aug 17 10:04:38 2017 by
667
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
668
+ 0.9.9 (ruby-2.4.0).
669
+ </div>
670
+
671
+ </div>
672
+ </body>
673
+ </html>