filestack 2.2.1 → 2.3.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +3 -0
- data/README.md +36 -46
- data/VERSION +1 -1
- data/docs/FilestackCommon.html +293 -293
- data/docs/FilestackFilelink.html +463 -463
- data/docs/IntelligentUtils.html +537 -537
- data/docs/MultipartUploadUtils.html +18 -18
- data/docs/Transform.html +3 -3
- data/docs/UploadUtils.html +7 -7
- data/filestack-ruby.gemspec +2 -2
- data/lib/filestack/mixins/filestack_common.rb +1 -1
- data/lib/filestack/models/filelink.rb +4 -4
- data/lib/filestack/models/filestack_transform.rb +1 -1
- data/lib/filestack/ruby/version.rb +1 -1
- data/lib/filestack/utils/multipart_upload_utils.rb +19 -20
- data/lib/filestack/utils/utils.rb +33 -35
- metadata +6 -6
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: c102fe7fb533cf82413791d4b49e8dd9a76926e0
|
|
4
|
+
data.tar.gz: 64dd9ae18a850ce6f5fa06b81fab6933973582d3
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: c616fd86fe99d2473f2135af8ad062a35ebbc8e2e1cb658c2dc17784f1d27aae056f6842f5495147e108f037b6a8fb133ae4c8e1fbf789bded36a6386216aaf5
|
|
7
|
+
data.tar.gz: 2873772fa6e71ea7d8fab34caa6e366a15c3ee829c83b05197f894bcbf78d97d894003fb33255165d75843a9deb4886e803db0f8383be364a60dfb78ba4de37b
|
data/CHANGELOG.md
CHANGED
data/README.md
CHANGED
|
@@ -1,18 +1,27 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
1
|
+
<p align="center"><img src="https://filestack.com/themes/filestack/assets/images/press-articles/color.svg" align="center" width="100"/></p>
|
|
2
|
+
<h1 align="center">Filestack Ruby SDK</h1>
|
|
3
|
+
<p align="center">
|
|
4
|
+
<a href="https://travis-ci.org/filestack/filestack-ruby.svg?branch=master">
|
|
5
|
+
<img src="https://img.shields.io/travis/filestack/filestack-ruby/master.svg?longCache=true&style=flat-square">
|
|
6
|
+
</a>
|
|
7
|
+
<a href="https://coveralls.io/github/filestack/filestack-ruby?branch=master">
|
|
8
|
+
<img src="https://img.shields.io/coveralls/github/filestack/filestack-ruby/master.svg?longCache=true&style=flat-square">
|
|
9
|
+
</a>
|
|
10
|
+
</p>
|
|
11
|
+
<p align="center">
|
|
12
|
+
Ruby SDK for Filestack API and content management system.
|
|
13
|
+
</p>
|
|
14
|
+
|
|
15
|
+
**Important: This is the readme for 2.1.0.**
|
|
16
|
+
A recent change (2.1.0) has renamed the `Client` to `FilestackClient`, and the `Filelink` to `FilestackFilelink`. Please make neccessary changes before upgrading to newest release if you run 2.0.1 or 2.0.0. This was to address namespace concerns by users with models and attributes named `Client`, and to be more consistent.
|
|
17
|
+
|
|
18
|
+
## Overview
|
|
19
|
+
|
|
20
|
+
* A multi-part uploader powered on the backend by the [Filestack CIN](https://www.filestack.com/products/content-ingestion-network).
|
|
21
|
+
* An interface to the [Filestack Processing Engine](https://www.filestack.com/docs/image-transformations) for transforming assets via URLs.
|
|
22
|
+
* The Filestack Picker - an upload widget for the web that integrates over a dozen cloud providers and provides pre-upload image editing.
|
|
23
|
+
|
|
24
|
+
## Installation
|
|
16
25
|
|
|
17
26
|
Add this line to your application's Gemfile:
|
|
18
27
|
|
|
@@ -30,19 +39,16 @@ Or install it yourself as:
|
|
|
30
39
|
|
|
31
40
|
## Usage
|
|
32
41
|
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
A recent change (2.1.0) has renamed the Client to FilestackClient, and the Filelink to FilestackFilelink. Please make neccessary changes before upgrading to newest release if you run 2.0.1 or 2.0.0. This was to address namespace concerns by users with models and attributes named Client, and to be more consistent.
|
|
36
|
-
|
|
42
|
+
### Import
|
|
37
43
|
```ruby
|
|
38
44
|
require 'filestack'
|
|
39
45
|
```
|
|
40
|
-
Intialize the client using your API key, and security if you are using it.
|
|
46
|
+
Intialize the client using your API key, and security if you are using it.
|
|
41
47
|
```ruby
|
|
42
48
|
client = FilestackClient.new('YOUR_API_KEY', security: security_object)
|
|
43
49
|
```
|
|
44
50
|
### Uploading
|
|
45
|
-
Filestack uses multipart uploading by default, which is faster for larger files. This can be turned off by passing in ```multipart: false```. Multipart is disabled when uploading external URLs.
|
|
51
|
+
Filestack uses multipart uploading by default, which is faster for larger files. This can be turned off by passing in ```multipart: false```. Multipart is disabled when uploading external URLs.
|
|
46
52
|
```ruby
|
|
47
53
|
filelink = client.upload(filepath: '/path/to/file')
|
|
48
54
|
|
|
@@ -52,7 +58,7 @@ filelink = client.upload(external_url: 'http://someurl.com')
|
|
|
52
58
|
```
|
|
53
59
|
|
|
54
60
|
### Security
|
|
55
|
-
If security is enabled on your account, or if you are using certain actions that require security (delete, overwrite and certain transformations), you will need to create a security object and pass it into the client on instantiation.
|
|
61
|
+
If security is enabled on your account, or if you are using certain actions that require security (delete, overwrite and certain transformations), you will need to create a security object and pass it into the client on instantiation.
|
|
56
62
|
|
|
57
63
|
```ruby
|
|
58
64
|
security = FilestackSecurity.new('YOUR_APP_SECRET', options: {call: %w[read store pick]})
|
|
@@ -60,9 +66,9 @@ client = FilestackClient.new('YOUR_API_KEY', security: security)
|
|
|
60
66
|
```
|
|
61
67
|
|
|
62
68
|
### Using FilestackFilelinks
|
|
63
|
-
FilestackFilelink objects are representation of a file handle. You can download, get raw file content, delete and overwrite file handles directly. Security is required for overwrite and delete methods.
|
|
69
|
+
FilestackFilelink objects are representation of a file handle. You can download, get raw file content, delete and overwrite file handles directly. Security is required for overwrite and delete methods.
|
|
64
70
|
|
|
65
|
-
### Transformations
|
|
71
|
+
### Transformations
|
|
66
72
|
Transforms can be initiated one of two ways. The first, by calling ```transform``` on a filelink:
|
|
67
73
|
|
|
68
74
|
```ruby
|
|
@@ -72,7 +78,7 @@ transform = filelink.transform
|
|
|
72
78
|
Or by using an external URL via the client:
|
|
73
79
|
|
|
74
80
|
```ruby
|
|
75
|
-
transform = client.
|
|
81
|
+
transform = client.transform_external('https://someurl.com')
|
|
76
82
|
```
|
|
77
83
|
|
|
78
84
|
Transformations can be chained together as you please.
|
|
@@ -105,7 +111,7 @@ tags = filelink.tags
|
|
|
105
111
|
|
|
106
112
|
This will return a hash with labels and their associated confidence:
|
|
107
113
|
|
|
108
|
-
```ruby
|
|
114
|
+
```ruby
|
|
109
115
|
{
|
|
110
116
|
"auto" => {
|
|
111
117
|
"art"=>73,
|
|
@@ -113,19 +119,19 @@ This will return a hash with labels and their associated confidence:
|
|
|
113
119
|
"carnivoran"=>80,
|
|
114
120
|
"cartoon"=>93,
|
|
115
121
|
"cat like mammal"=>92,
|
|
116
|
-
"fauna"=>86, "mammal"=>92,
|
|
117
|
-
"small to medium sized cats"=>89,
|
|
122
|
+
"fauna"=>86, "mammal"=>92,
|
|
123
|
+
"small to medium sized cats"=>89,
|
|
118
124
|
"tiger"=>92,
|
|
119
125
|
"vertebrate"=>90},
|
|
120
126
|
"user" => nil
|
|
121
127
|
}
|
|
122
128
|
```
|
|
123
129
|
|
|
124
|
-
SFW is called the same way, but returns a boolean value (true == safe-for-work, false == not-safe-for-work).
|
|
130
|
+
SFW is called the same way, but returns a boolean value (true == safe-for-work, false == not-safe-for-work).
|
|
125
131
|
|
|
126
132
|
```ruby
|
|
127
133
|
sfw = filelink.sfw
|
|
128
|
-
```
|
|
134
|
+
```
|
|
129
135
|
|
|
130
136
|
## Versioning
|
|
131
137
|
|
|
@@ -134,19 +140,3 @@ Filestack Ruby SDK follows the [Semantic Versioning](http://semver.org/).
|
|
|
134
140
|
## Issues
|
|
135
141
|
|
|
136
142
|
If you have problems, please create a [Github Issue](https://github.com/filestack/filestack-ruby/issues).
|
|
137
|
-
|
|
138
|
-
## Contributing
|
|
139
|
-
|
|
140
|
-
Please see [CONTRIBUTING.md](https://github.com/filestack/filestack-ruby/CONTRIBUTING.md) for details.
|
|
141
|
-
|
|
142
|
-
## Credits
|
|
143
|
-
|
|
144
|
-
Thank you to all the [contributors](https://github.com/filestack/filestack-ruby/graphs/contributors).
|
|
145
|
-
|
|
146
|
-
[travis_ci]: http://travis-ci.org/filestack/filestack-ruby
|
|
147
|
-
|
|
148
|
-
[travis_ci_badge]: https://travis-ci.org/filestack/filestack-ruby.svg?branch=master
|
|
149
|
-
[code_climate]: https://codeclimate.com/github/filestack/filestack-ruby
|
|
150
|
-
[code_climate_badge]: https://codeclimate.com/github/filestack/filestack-ruby.png
|
|
151
|
-
[coveralls]: https://coveralls.io/github/filestack/filestack-ruby?branch=master
|
|
152
|
-
[coveralls_badge]: https://coveralls.io/repos/github/filestack/filestack-ruby/badge.svg?branch=master
|
data/VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
2.
|
|
1
|
+
2.3.0
|
data/docs/FilestackCommon.html
CHANGED
|
@@ -5,9 +5,9 @@
|
|
|
5
5
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
6
|
<title>
|
|
7
7
|
Module: FilestackCommon
|
|
8
|
-
|
|
8
|
+
|
|
9
9
|
— Documentation by YARD 0.9.9
|
|
10
|
-
|
|
10
|
+
|
|
11
11
|
</title>
|
|
12
12
|
|
|
13
13
|
<link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
|
|
@@ -35,16 +35,16 @@
|
|
|
35
35
|
<div id="main" tabindex="-1">
|
|
36
36
|
<div id="header">
|
|
37
37
|
<div id="menu">
|
|
38
|
-
|
|
38
|
+
|
|
39
39
|
<a href="_index.html">Index (F)</a> »
|
|
40
|
-
|
|
41
|
-
|
|
40
|
+
|
|
41
|
+
|
|
42
42
|
<span class="title">FilestackCommon</span>
|
|
43
|
-
|
|
43
|
+
|
|
44
44
|
</div>
|
|
45
45
|
|
|
46
46
|
<div id="search">
|
|
47
|
-
|
|
47
|
+
|
|
48
48
|
<a class="full_list_link" id="class_list_link"
|
|
49
49
|
href="class_list.html">
|
|
50
50
|
|
|
@@ -54,48 +54,48 @@
|
|
|
54
54
|
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
|
55
55
|
</svg>
|
|
56
56
|
</a>
|
|
57
|
-
|
|
57
|
+
|
|
58
58
|
</div>
|
|
59
59
|
<div class="clear"></div>
|
|
60
60
|
</div>
|
|
61
61
|
|
|
62
62
|
<div id="content"><h1>Module: FilestackCommon
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
|
|
66
66
|
</h1>
|
|
67
67
|
<div class="box_info">
|
|
68
|
-
|
|
69
68
|
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
|
|
73
|
+
|
|
74
74
|
<dl>
|
|
75
75
|
<dt>Includes:</dt>
|
|
76
76
|
<dd><span class='object_link'><a href="UploadUtils.html" title="UploadUtils (module)">UploadUtils</a></span></dd>
|
|
77
77
|
</dl>
|
|
78
|
-
|
|
79
|
-
|
|
80
78
|
|
|
81
|
-
|
|
79
|
+
|
|
80
|
+
|
|
81
|
+
|
|
82
82
|
<dl>
|
|
83
83
|
<dt>Included in:</dt>
|
|
84
84
|
<dd><span class='object_link'><a href="FilestackFilelink.html" title="FilestackFilelink (class)">FilestackFilelink</a></span></dd>
|
|
85
85
|
</dl>
|
|
86
|
-
|
|
87
86
|
|
|
88
|
-
|
|
87
|
+
|
|
88
|
+
|
|
89
89
|
<dl>
|
|
90
90
|
<dt>Defined in:</dt>
|
|
91
91
|
<dd>lib/filestack/mixins/filestack_common.rb</dd>
|
|
92
92
|
</dl>
|
|
93
|
-
|
|
93
|
+
|
|
94
94
|
</div>
|
|
95
95
|
|
|
96
96
|
<h2>Overview</h2><div class="docstring">
|
|
97
97
|
<div class="discussion">
|
|
98
|
-
|
|
98
|
+
|
|
99
99
|
<p>Module is mixin for common functionalities that all Filestack objects can
|
|
100
100
|
call.</p>
|
|
101
101
|
|
|
@@ -103,7 +103,7 @@ call.</p>
|
|
|
103
103
|
</div>
|
|
104
104
|
</div>
|
|
105
105
|
<div class="tags">
|
|
106
|
-
|
|
106
|
+
|
|
107
107
|
|
|
108
108
|
</div>
|
|
109
109
|
|
|
@@ -112,168 +112,168 @@ call.</p>
|
|
|
112
112
|
|
|
113
113
|
|
|
114
114
|
|
|
115
|
-
|
|
115
|
+
|
|
116
116
|
<h2>
|
|
117
117
|
Instance Method Summary
|
|
118
118
|
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
119
119
|
</h2>
|
|
120
120
|
|
|
121
121
|
<ul class="summary">
|
|
122
|
-
|
|
122
|
+
|
|
123
123
|
<li class="public ">
|
|
124
124
|
<span class="summary_signature">
|
|
125
|
-
|
|
126
|
-
<a href="#send_delete-instance_method" title="#send_delete (instance method)">#<strong>send_delete</strong>(handle, apikey, security) ⇒ unirest::Response </a>
|
|
127
|
-
|
|
128
125
|
|
|
129
|
-
|
|
126
|
+
<a href="#send_delete-instance_method" title="#send_delete (instance method)">#<strong>send_delete</strong>(handle, apikey, security) ⇒ Typhoeus::Response </a>
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
|
|
130
130
|
</span>
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
|
|
140
140
|
<span class="summary_desc"><div class='inline'>
|
|
141
141
|
<p>Send the delete api request to delete a filelink.</p>
|
|
142
142
|
</div></span>
|
|
143
|
-
|
|
143
|
+
|
|
144
144
|
</li>
|
|
145
145
|
|
|
146
|
-
|
|
146
|
+
|
|
147
147
|
<li class="public ">
|
|
148
148
|
<span class="summary_signature">
|
|
149
|
-
|
|
149
|
+
|
|
150
150
|
<a href="#send_download-instance_method" title="#send_download (instance method)">#<strong>send_download</strong>(filepath) ⇒ Int </a>
|
|
151
|
-
|
|
152
151
|
|
|
153
|
-
|
|
152
|
+
|
|
153
|
+
|
|
154
154
|
</span>
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
|
|
164
164
|
<span class="summary_desc"><div class='inline'>
|
|
165
165
|
<p>Get the content of a filehandle.</p>
|
|
166
166
|
</div></span>
|
|
167
|
-
|
|
167
|
+
|
|
168
168
|
</li>
|
|
169
169
|
|
|
170
|
-
|
|
170
|
+
|
|
171
171
|
<li class="public ">
|
|
172
172
|
<span class="summary_signature">
|
|
173
|
-
|
|
173
|
+
|
|
174
174
|
<a href="#send_get_content-instance_method" title="#send_get_content (instance method)">#<strong>send_get_content</strong>(url, parameters: nil) ⇒ Bytes </a>
|
|
175
|
-
|
|
176
175
|
|
|
177
|
-
|
|
176
|
+
|
|
177
|
+
|
|
178
178
|
</span>
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
|
|
188
188
|
<span class="summary_desc"><div class='inline'>
|
|
189
189
|
<p>Get the contents of a Filestack handle.</p>
|
|
190
190
|
</div></span>
|
|
191
|
-
|
|
191
|
+
|
|
192
192
|
</li>
|
|
193
193
|
|
|
194
|
-
|
|
194
|
+
|
|
195
195
|
<li class="public ">
|
|
196
196
|
<span class="summary_signature">
|
|
197
|
-
|
|
197
|
+
|
|
198
198
|
<a href="#send_metadata-instance_method" title="#send_metadata (instance method)">#<strong>send_metadata</strong>(handle, security = nil, params) ⇒ Object </a>
|
|
199
|
-
|
|
200
199
|
|
|
201
|
-
|
|
200
|
+
|
|
201
|
+
|
|
202
202
|
</span>
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
203
|
+
|
|
204
|
+
|
|
205
|
+
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
|
|
210
|
+
|
|
211
|
+
|
|
212
212
|
<span class="summary_desc"><div class='inline'></div></span>
|
|
213
|
-
|
|
213
|
+
|
|
214
214
|
</li>
|
|
215
215
|
|
|
216
|
-
|
|
216
|
+
|
|
217
217
|
<li class="public ">
|
|
218
218
|
<span class="summary_signature">
|
|
219
|
-
|
|
219
|
+
|
|
220
220
|
<a href="#send_overwrite-instance_method" title="#send_overwrite (instance method)">#<strong>send_overwrite</strong>(filepath, handle, apikey, security) ⇒ Typhoeus::Response </a>
|
|
221
|
-
|
|
222
221
|
|
|
223
|
-
|
|
222
|
+
|
|
223
|
+
|
|
224
224
|
</span>
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
225
|
+
|
|
226
|
+
|
|
227
|
+
|
|
228
|
+
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
|
|
232
|
+
|
|
233
|
+
|
|
234
234
|
<span class="summary_desc"><div class='inline'>
|
|
235
235
|
<p>Send the overwrite api request to update a filelink.</p>
|
|
236
236
|
</div></span>
|
|
237
|
-
|
|
237
|
+
|
|
238
238
|
</li>
|
|
239
239
|
|
|
240
|
-
|
|
240
|
+
|
|
241
241
|
<li class="public ">
|
|
242
242
|
<span class="summary_signature">
|
|
243
|
-
|
|
243
|
+
|
|
244
244
|
<a href="#send_tags-instance_method" title="#send_tags (instance method)">#<strong>send_tags</strong>(task, handle, security) ⇒ Hash </a>
|
|
245
|
-
|
|
246
245
|
|
|
247
|
-
|
|
246
|
+
|
|
247
|
+
|
|
248
248
|
</span>
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
249
|
+
|
|
250
|
+
|
|
251
|
+
|
|
252
|
+
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
|
|
256
|
+
|
|
257
|
+
|
|
258
258
|
<span class="summary_desc"><div class='inline'>
|
|
259
259
|
<p>Get tags or sfw content from a filelink.</p>
|
|
260
260
|
</div></span>
|
|
261
|
-
|
|
261
|
+
|
|
262
262
|
</li>
|
|
263
263
|
|
|
264
|
-
|
|
264
|
+
|
|
265
265
|
</ul>
|
|
266
|
-
|
|
267
266
|
|
|
268
267
|
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
268
|
+
|
|
269
|
+
|
|
270
|
+
|
|
271
|
+
|
|
272
|
+
|
|
273
|
+
|
|
274
|
+
|
|
275
|
+
|
|
276
|
+
|
|
277
277
|
<h3 class="inherited">Methods included from <span class='object_link'><a href="UploadUtils.html" title="UploadUtils (module)">UploadUtils</a></span></h3>
|
|
278
278
|
<p class="inherited"><span class='object_link'><a href="UploadUtils.html#get_url-instance_method" title="UploadUtils#get_url (method)">#get_url</a></span>, <span class='object_link'><a href="UploadUtils.html#make_call-instance_method" title="UploadUtils#make_call (method)">#make_call</a></span>, <span class='object_link'><a href="UploadUtils.html#send_upload-instance_method" title="UploadUtils#send_upload (method)">#send_upload</a></span></p>
|
|
279
279
|
|
|
@@ -281,19 +281,19 @@ call.</p>
|
|
|
281
281
|
<div id="instance_method_details" class="method_details_list">
|
|
282
282
|
<h2>Instance Method Details</h2>
|
|
283
283
|
|
|
284
|
-
|
|
284
|
+
|
|
285
285
|
<div class="method_details first">
|
|
286
286
|
<h3 class="signature first" id="send_delete-instance_method">
|
|
287
|
-
|
|
288
|
-
#<strong>send_delete</strong>(handle, apikey, security) ⇒ <tt>unirest::Response</tt>
|
|
289
|
-
|
|
290
287
|
|
|
291
|
-
|
|
288
|
+
#<strong>send_delete</strong>(handle, apikey, security) ⇒ <tt>Typhoeus::Response</tt>
|
|
289
|
+
|
|
290
|
+
|
|
291
|
+
|
|
292
|
+
|
|
292
293
|
|
|
293
|
-
|
|
294
294
|
</h3><div class="docstring">
|
|
295
295
|
<div class="discussion">
|
|
296
|
-
|
|
296
|
+
|
|
297
297
|
<p>Send the delete api request to delete a filelink</p>
|
|
298
298
|
|
|
299
299
|
|
|
@@ -302,37 +302,37 @@ call.</p>
|
|
|
302
302
|
<div class="tags">
|
|
303
303
|
<p class="tag_title">Parameters:</p>
|
|
304
304
|
<ul class="param">
|
|
305
|
-
|
|
305
|
+
|
|
306
306
|
<li>
|
|
307
|
-
|
|
307
|
+
|
|
308
308
|
<span class='name'>url</span>
|
|
309
|
-
|
|
310
|
-
|
|
309
|
+
|
|
310
|
+
|
|
311
311
|
<span class='type'>(<tt>String</tt>)</span>
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
312
|
+
|
|
313
|
+
|
|
314
|
+
|
|
315
315
|
—
|
|
316
316
|
<div class='inline'>
|
|
317
317
|
<p>The url of the Filehandle to be deleted (includes security)</p>
|
|
318
318
|
</div>
|
|
319
|
-
|
|
319
|
+
|
|
320
320
|
</li>
|
|
321
|
-
|
|
321
|
+
|
|
322
322
|
</ul>
|
|
323
323
|
|
|
324
324
|
<p class="tag_title">Returns:</p>
|
|
325
325
|
<ul class="return">
|
|
326
|
-
|
|
326
|
+
|
|
327
327
|
<li>
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
<span class='type'>(<tt>
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
328
|
+
|
|
329
|
+
|
|
330
|
+
<span class='type'>(<tt>Typhoeus::Response</tt>)</span>
|
|
331
|
+
|
|
332
|
+
|
|
333
|
+
|
|
334
334
|
</li>
|
|
335
|
-
|
|
335
|
+
|
|
336
336
|
</ul>
|
|
337
337
|
|
|
338
338
|
</div><table class="source_code">
|
|
@@ -369,19 +369,19 @@ call.</p>
|
|
|
369
369
|
</tr>
|
|
370
370
|
</table>
|
|
371
371
|
</div>
|
|
372
|
-
|
|
372
|
+
|
|
373
373
|
<div class="method_details ">
|
|
374
374
|
<h3 class="signature " id="send_download-instance_method">
|
|
375
|
-
|
|
376
|
-
#<strong>send_download</strong>(filepath) ⇒ <tt>Int</tt>
|
|
377
|
-
|
|
378
375
|
|
|
379
|
-
|
|
376
|
+
#<strong>send_download</strong>(filepath) ⇒ <tt>Int</tt>
|
|
377
|
+
|
|
378
|
+
|
|
379
|
+
|
|
380
|
+
|
|
380
381
|
|
|
381
|
-
|
|
382
382
|
</h3><div class="docstring">
|
|
383
383
|
<div class="discussion">
|
|
384
|
-
|
|
384
|
+
|
|
385
385
|
<p>Get the content of a filehandle</p>
|
|
386
386
|
|
|
387
387
|
|
|
@@ -390,42 +390,42 @@ call.</p>
|
|
|
390
390
|
<div class="tags">
|
|
391
391
|
<p class="tag_title">Parameters:</p>
|
|
392
392
|
<ul class="param">
|
|
393
|
-
|
|
393
|
+
|
|
394
394
|
<li>
|
|
395
|
-
|
|
395
|
+
|
|
396
396
|
<span class='name'>filepath</span>
|
|
397
|
-
|
|
398
|
-
|
|
397
|
+
|
|
398
|
+
|
|
399
399
|
<span class='type'>(<tt>String</tt>)</span>
|
|
400
|
-
|
|
401
|
-
|
|
402
|
-
|
|
400
|
+
|
|
401
|
+
|
|
402
|
+
|
|
403
403
|
—
|
|
404
404
|
<div class='inline'>
|
|
405
405
|
<p>Local path of file to be written</p>
|
|
406
406
|
</div>
|
|
407
|
-
|
|
407
|
+
|
|
408
408
|
</li>
|
|
409
|
-
|
|
409
|
+
|
|
410
410
|
</ul>
|
|
411
411
|
|
|
412
412
|
<p class="tag_title">Returns:</p>
|
|
413
413
|
<ul class="return">
|
|
414
|
-
|
|
414
|
+
|
|
415
415
|
<li>
|
|
416
|
-
|
|
417
|
-
|
|
416
|
+
|
|
417
|
+
|
|
418
418
|
<span class='type'>(<tt>Int</tt>)</span>
|
|
419
|
-
|
|
420
|
-
|
|
421
|
-
|
|
419
|
+
|
|
420
|
+
|
|
421
|
+
|
|
422
422
|
—
|
|
423
423
|
<div class='inline'>
|
|
424
424
|
<p>Size of file written</p>
|
|
425
425
|
</div>
|
|
426
|
-
|
|
426
|
+
|
|
427
427
|
</li>
|
|
428
|
-
|
|
428
|
+
|
|
429
429
|
</ul>
|
|
430
430
|
|
|
431
431
|
</div><table class="source_code">
|
|
@@ -450,19 +450,19 @@ call.</p>
|
|
|
450
450
|
</tr>
|
|
451
451
|
</table>
|
|
452
452
|
</div>
|
|
453
|
-
|
|
453
|
+
|
|
454
454
|
<div class="method_details ">
|
|
455
455
|
<h3 class="signature " id="send_get_content-instance_method">
|
|
456
|
-
|
|
457
|
-
#<strong>send_get_content</strong>(url, parameters: nil) ⇒ <tt>Bytes</tt>
|
|
458
|
-
|
|
459
456
|
|
|
460
|
-
|
|
457
|
+
#<strong>send_get_content</strong>(url, parameters: nil) ⇒ <tt>Bytes</tt>
|
|
458
|
+
|
|
459
|
+
|
|
460
|
+
|
|
461
|
+
|
|
461
462
|
|
|
462
|
-
|
|
463
463
|
</h3><div class="docstring">
|
|
464
464
|
<div class="discussion">
|
|
465
|
-
|
|
465
|
+
|
|
466
466
|
<p>Get the contents of a Filestack handle</p>
|
|
467
467
|
|
|
468
468
|
|
|
@@ -471,53 +471,53 @@ call.</p>
|
|
|
471
471
|
<div class="tags">
|
|
472
472
|
<p class="tag_title">Parameters:</p>
|
|
473
473
|
<ul class="param">
|
|
474
|
-
|
|
474
|
+
|
|
475
475
|
<li>
|
|
476
|
-
|
|
476
|
+
|
|
477
477
|
<span class='name'>file_handle</span>
|
|
478
|
-
|
|
479
|
-
|
|
478
|
+
|
|
479
|
+
|
|
480
480
|
<span class='type'>(<tt>String</tt>)</span>
|
|
481
|
-
|
|
482
|
-
|
|
483
|
-
|
|
481
|
+
|
|
482
|
+
|
|
483
|
+
|
|
484
484
|
—
|
|
485
485
|
<div class='inline'>
|
|
486
486
|
<p>The Filelink handle</p>
|
|
487
487
|
</div>
|
|
488
|
-
|
|
488
|
+
|
|
489
489
|
</li>
|
|
490
|
-
|
|
490
|
+
|
|
491
491
|
<li>
|
|
492
|
-
|
|
492
|
+
|
|
493
493
|
<span class='name'>security</span>
|
|
494
|
-
|
|
495
|
-
|
|
494
|
+
|
|
495
|
+
|
|
496
496
|
<span class='type'>(<tt><span class='object_link'><a href="FilestackSecurity.html" title="FilestackSecurity (class)">FilestackSecurity</a></span></tt>)</span>
|
|
497
|
-
|
|
498
|
-
|
|
499
|
-
|
|
497
|
+
|
|
498
|
+
|
|
499
|
+
|
|
500
500
|
—
|
|
501
501
|
<div class='inline'>
|
|
502
502
|
<p>Optional Filestack security object if security is enabled</p>
|
|
503
503
|
</div>
|
|
504
|
-
|
|
504
|
+
|
|
505
505
|
</li>
|
|
506
|
-
|
|
506
|
+
|
|
507
507
|
</ul>
|
|
508
508
|
|
|
509
509
|
<p class="tag_title">Returns:</p>
|
|
510
510
|
<ul class="return">
|
|
511
|
-
|
|
511
|
+
|
|
512
512
|
<li>
|
|
513
|
-
|
|
514
|
-
|
|
513
|
+
|
|
514
|
+
|
|
515
515
|
<span class='type'>(<tt>Bytes</tt>)</span>
|
|
516
|
-
|
|
517
|
-
|
|
518
|
-
|
|
516
|
+
|
|
517
|
+
|
|
518
|
+
|
|
519
519
|
</li>
|
|
520
|
-
|
|
520
|
+
|
|
521
521
|
</ul>
|
|
522
522
|
|
|
523
523
|
</div><table class="source_code">
|
|
@@ -540,16 +540,16 @@ call.</p>
|
|
|
540
540
|
</tr>
|
|
541
541
|
</table>
|
|
542
542
|
</div>
|
|
543
|
-
|
|
543
|
+
|
|
544
544
|
<div class="method_details ">
|
|
545
545
|
<h3 class="signature " id="send_metadata-instance_method">
|
|
546
|
-
|
|
547
|
-
#<strong>send_metadata</strong>(handle, security = nil, params) ⇒ <tt>Object</tt>
|
|
548
|
-
|
|
549
546
|
|
|
550
|
-
|
|
547
|
+
#<strong>send_metadata</strong>(handle, security = nil, params) ⇒ <tt>Object</tt>
|
|
548
|
+
|
|
549
|
+
|
|
550
|
+
|
|
551
|
+
|
|
551
552
|
|
|
552
|
-
|
|
553
553
|
</h3><table class="source_code">
|
|
554
554
|
<tr>
|
|
555
555
|
<td>
|
|
@@ -594,19 +594,19 @@ call.</p>
|
|
|
594
594
|
</tr>
|
|
595
595
|
</table>
|
|
596
596
|
</div>
|
|
597
|
-
|
|
597
|
+
|
|
598
598
|
<div class="method_details ">
|
|
599
599
|
<h3 class="signature " id="send_overwrite-instance_method">
|
|
600
|
-
|
|
601
|
-
#<strong>send_overwrite</strong>(filepath, handle, apikey, security) ⇒ <tt>Typhoeus::Response</tt>
|
|
602
|
-
|
|
603
600
|
|
|
604
|
-
|
|
601
|
+
#<strong>send_overwrite</strong>(filepath, handle, apikey, security) ⇒ <tt>Typhoeus::Response</tt>
|
|
602
|
+
|
|
603
|
+
|
|
604
|
+
|
|
605
|
+
|
|
605
606
|
|
|
606
|
-
|
|
607
607
|
</h3><div class="docstring">
|
|
608
608
|
<div class="discussion">
|
|
609
|
-
|
|
609
|
+
|
|
610
610
|
<p>Send the overwrite api request to update a filelink</p>
|
|
611
611
|
|
|
612
612
|
|
|
@@ -615,85 +615,85 @@ call.</p>
|
|
|
615
615
|
<div class="tags">
|
|
616
616
|
<p class="tag_title">Parameters:</p>
|
|
617
617
|
<ul class="param">
|
|
618
|
-
|
|
618
|
+
|
|
619
619
|
<li>
|
|
620
|
-
|
|
620
|
+
|
|
621
621
|
<span class='name'>filepath</span>
|
|
622
|
-
|
|
623
|
-
|
|
622
|
+
|
|
623
|
+
|
|
624
624
|
<span class='type'>(<tt>String</tt>)</span>
|
|
625
|
-
|
|
626
|
-
|
|
627
|
-
|
|
625
|
+
|
|
626
|
+
|
|
627
|
+
|
|
628
628
|
—
|
|
629
629
|
<div class='inline'>
|
|
630
630
|
<p>Filepath of file to upload</p>
|
|
631
631
|
</div>
|
|
632
|
-
|
|
632
|
+
|
|
633
633
|
</li>
|
|
634
|
-
|
|
634
|
+
|
|
635
635
|
<li>
|
|
636
|
-
|
|
636
|
+
|
|
637
637
|
<span class='name'>handle</span>
|
|
638
|
-
|
|
639
|
-
|
|
638
|
+
|
|
639
|
+
|
|
640
640
|
<span class='type'>(<tt>String</tt>)</span>
|
|
641
|
-
|
|
642
|
-
|
|
643
|
-
|
|
641
|
+
|
|
642
|
+
|
|
643
|
+
|
|
644
644
|
—
|
|
645
645
|
<div class='inline'>
|
|
646
646
|
<p>The Filelink handle</p>
|
|
647
647
|
</div>
|
|
648
|
-
|
|
648
|
+
|
|
649
649
|
</li>
|
|
650
|
-
|
|
650
|
+
|
|
651
651
|
<li>
|
|
652
|
-
|
|
652
|
+
|
|
653
653
|
<span class='name'>apikey</span>
|
|
654
|
-
|
|
655
|
-
|
|
654
|
+
|
|
655
|
+
|
|
656
656
|
<span class='type'>(<tt>String</tt>)</span>
|
|
657
|
-
|
|
658
|
-
|
|
659
|
-
|
|
657
|
+
|
|
658
|
+
|
|
659
|
+
|
|
660
660
|
—
|
|
661
661
|
<div class='inline'>
|
|
662
662
|
<p>Filestack API Key</p>
|
|
663
663
|
</div>
|
|
664
|
-
|
|
664
|
+
|
|
665
665
|
</li>
|
|
666
|
-
|
|
666
|
+
|
|
667
667
|
<li>
|
|
668
|
-
|
|
668
|
+
|
|
669
669
|
<span class='name'>security</span>
|
|
670
|
-
|
|
671
|
-
|
|
670
|
+
|
|
671
|
+
|
|
672
672
|
<span class='type'>(<tt><span class='object_link'><a href="FilestackSecurity.html" title="FilestackSecurity (class)">FilestackSecurity</a></span></tt>)</span>
|
|
673
|
-
|
|
674
|
-
|
|
675
|
-
|
|
673
|
+
|
|
674
|
+
|
|
675
|
+
|
|
676
676
|
—
|
|
677
677
|
<div class='inline'>
|
|
678
678
|
<p>Filestack security object</p>
|
|
679
679
|
</div>
|
|
680
|
-
|
|
680
|
+
|
|
681
681
|
</li>
|
|
682
|
-
|
|
682
|
+
|
|
683
683
|
</ul>
|
|
684
684
|
|
|
685
685
|
<p class="tag_title">Returns:</p>
|
|
686
686
|
<ul class="return">
|
|
687
|
-
|
|
687
|
+
|
|
688
688
|
<li>
|
|
689
|
-
|
|
690
|
-
|
|
689
|
+
|
|
690
|
+
|
|
691
691
|
<span class='type'>(<tt>Typhoeus::Response</tt>)</span>
|
|
692
|
-
|
|
693
|
-
|
|
694
|
-
|
|
692
|
+
|
|
693
|
+
|
|
694
|
+
|
|
695
695
|
</li>
|
|
696
|
-
|
|
696
|
+
|
|
697
697
|
</ul>
|
|
698
698
|
|
|
699
699
|
</div><table class="source_code">
|
|
@@ -750,19 +750,19 @@ call.</p>
|
|
|
750
750
|
</tr>
|
|
751
751
|
</table>
|
|
752
752
|
</div>
|
|
753
|
-
|
|
753
|
+
|
|
754
754
|
<div class="method_details ">
|
|
755
755
|
<h3 class="signature " id="send_tags-instance_method">
|
|
756
|
-
|
|
757
|
-
#<strong>send_tags</strong>(task, handle, security) ⇒ <tt>Hash</tt>
|
|
758
|
-
|
|
759
756
|
|
|
760
|
-
|
|
757
|
+
#<strong>send_tags</strong>(task, handle, security) ⇒ <tt>Hash</tt>
|
|
758
|
+
|
|
759
|
+
|
|
760
|
+
|
|
761
|
+
|
|
761
762
|
|
|
762
|
-
|
|
763
763
|
</h3><div class="docstring">
|
|
764
764
|
<div class="discussion">
|
|
765
|
-
|
|
765
|
+
|
|
766
766
|
<p>Get tags or sfw content from a filelink</p>
|
|
767
767
|
|
|
768
768
|
|
|
@@ -771,69 +771,69 @@ call.</p>
|
|
|
771
771
|
<div class="tags">
|
|
772
772
|
<p class="tag_title">Parameters:</p>
|
|
773
773
|
<ul class="param">
|
|
774
|
-
|
|
774
|
+
|
|
775
775
|
<li>
|
|
776
|
-
|
|
776
|
+
|
|
777
777
|
<span class='name'>task</span>
|
|
778
|
-
|
|
779
|
-
|
|
778
|
+
|
|
779
|
+
|
|
780
780
|
<span class='type'>(<tt>String</tt>)</span>
|
|
781
|
-
|
|
782
|
-
|
|
783
|
-
|
|
781
|
+
|
|
782
|
+
|
|
783
|
+
|
|
784
784
|
—
|
|
785
785
|
<div class='inline'>
|
|
786
786
|
<p>'tags' or 'sfw'</p>
|
|
787
787
|
</div>
|
|
788
|
-
|
|
788
|
+
|
|
789
789
|
</li>
|
|
790
|
-
|
|
790
|
+
|
|
791
791
|
<li>
|
|
792
|
-
|
|
792
|
+
|
|
793
793
|
<span class='name'>handle</span>
|
|
794
|
-
|
|
795
|
-
|
|
794
|
+
|
|
795
|
+
|
|
796
796
|
<span class='type'>(<tt>String</tt>)</span>
|
|
797
|
-
|
|
798
|
-
|
|
799
|
-
|
|
797
|
+
|
|
798
|
+
|
|
799
|
+
|
|
800
800
|
—
|
|
801
801
|
<div class='inline'>
|
|
802
802
|
<p>The filehandle</p>
|
|
803
803
|
</div>
|
|
804
|
-
|
|
804
|
+
|
|
805
805
|
</li>
|
|
806
|
-
|
|
806
|
+
|
|
807
807
|
<li>
|
|
808
|
-
|
|
808
|
+
|
|
809
809
|
<span class='name'>security</span>
|
|
810
|
-
|
|
811
|
-
|
|
810
|
+
|
|
811
|
+
|
|
812
812
|
<span class='type'>(<tt>Filestack::Security</tt>)</span>
|
|
813
|
-
|
|
814
|
-
|
|
815
|
-
|
|
813
|
+
|
|
814
|
+
|
|
815
|
+
|
|
816
816
|
—
|
|
817
817
|
<div class='inline'>
|
|
818
818
|
<p>Security object</p>
|
|
819
819
|
</div>
|
|
820
|
-
|
|
820
|
+
|
|
821
821
|
</li>
|
|
822
|
-
|
|
822
|
+
|
|
823
823
|
</ul>
|
|
824
824
|
|
|
825
825
|
<p class="tag_title">Returns:</p>
|
|
826
826
|
<ul class="return">
|
|
827
|
-
|
|
827
|
+
|
|
828
828
|
<li>
|
|
829
|
-
|
|
830
|
-
|
|
829
|
+
|
|
830
|
+
|
|
831
831
|
<span class='type'>(<tt>Hash</tt>)</span>
|
|
832
|
-
|
|
833
|
-
|
|
834
|
-
|
|
832
|
+
|
|
833
|
+
|
|
834
|
+
|
|
835
835
|
</li>
|
|
836
|
-
|
|
836
|
+
|
|
837
837
|
</ul>
|
|
838
838
|
|
|
839
839
|
</div><table class="source_code">
|
|
@@ -868,7 +868,7 @@ call.</p>
|
|
|
868
868
|
</tr>
|
|
869
869
|
</table>
|
|
870
870
|
</div>
|
|
871
|
-
|
|
871
|
+
|
|
872
872
|
</div>
|
|
873
873
|
|
|
874
874
|
</div>
|
|
@@ -881,4 +881,4 @@ call.</p>
|
|
|
881
881
|
|
|
882
882
|
</div>
|
|
883
883
|
</body>
|
|
884
|
-
</html>
|
|
884
|
+
</html>
|