files.com 1.1.127 → 1.1.129
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +15 -13
- data/_VERSION +1 -1
- data/lib/files.com/version.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 3c960b9d5d4b80d65f84c05f3354cab4788805a81e360747b57d717ff4c54cba
|
4
|
+
data.tar.gz: 6a0ebb8cd98134f2e5c0585f6aa22967dcdb913a25b9ffc8ff58ffd23cfe1c5c
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: d61d61aad27a0451446182948ff03fb111a65e4742652c3b59abd09a51786a888247c4c0ea826b3e2948539732664a9cc740dfc2af1bdf6d3a7afe2ed77c73d9
|
7
|
+
data.tar.gz: 75589ac8a351977f6a7ca868b5bdf53848ffb1b418d4847411aa94e03e413cf3cfb58c570925e3f2f7830e7254464e7cb5af34c62954bc128d8a128977498f9a
|
data/README.md
CHANGED
@@ -9,6 +9,8 @@ The Files.com Ruby gem provides convenient access to all aspects of Files.com fr
|
|
9
9
|
|
10
10
|
Files.com customers use our Ruby gem for directly working with files and folders as well as performing management tasks such as adding/removing users, onboarding counterparties, retrieving information about automations and more.
|
11
11
|
|
12
|
+
The Ruby gem uses the Files.com RESTful APIs via the HTTPS protocol (port 443) to securely communicate and transfer files so no firewall changes should be required in order to allow connectivity to Files.com.
|
13
|
+
|
12
14
|
### Files.com is a Ruby Shop
|
13
15
|
|
14
16
|
At Files.com, we use Ruby as a primary language all over the company. Our main server-side API is developed in Ruby, as are many of our microservices.
|
@@ -79,7 +81,7 @@ session times out, simply create a new session and resume where you left off. Th
|
|
79
81
|
automatically handled by SDKs because we do not want to store password information in memory without
|
80
82
|
your explicit consent.
|
81
83
|
|
82
|
-
#### Logging
|
84
|
+
#### Logging In
|
83
85
|
|
84
86
|
To create a session, the `create` method is called on the `Files::Session` object with the user's username and
|
85
87
|
password.
|
@@ -90,7 +92,7 @@ This returns a session object that can be used to authenticate SDK method calls.
|
|
90
92
|
session = Files::Session.create(username: "username", password: "password")
|
91
93
|
```
|
92
94
|
|
93
|
-
#### Using a
|
95
|
+
#### Using a Session
|
94
96
|
|
95
97
|
Once a session has been created, you can store the session globally, use the session per object, or use the session per request to authenticate SDK operations.
|
96
98
|
|
@@ -106,7 +108,7 @@ Files::Group.list({}, session_id: session.id)
|
|
106
108
|
|
107
109
|
````
|
108
110
|
|
109
|
-
#### Logging
|
111
|
+
#### Logging Out
|
110
112
|
|
111
113
|
User sessions can be ended calling the `destroy` method on the `session` object.
|
112
114
|
|
@@ -116,7 +118,7 @@ session.destroy()
|
|
116
118
|
|
117
119
|
## Configuration
|
118
120
|
|
119
|
-
### Configuration
|
121
|
+
### Configuration Options
|
120
122
|
|
121
123
|
#### Base URL
|
122
124
|
|
@@ -127,7 +129,7 @@ This can also be set to use a mock server in development or CI.
|
|
127
129
|
Files.base_url = "https://SUBDOMAIN.files.com"
|
128
130
|
```
|
129
131
|
|
130
|
-
#### Log
|
132
|
+
#### Log Level
|
131
133
|
|
132
134
|
Supported values:
|
133
135
|
* `nil`
|
@@ -150,7 +152,7 @@ Files.proxy = {
|
|
150
152
|
}
|
151
153
|
```
|
152
154
|
|
153
|
-
#### Open
|
155
|
+
#### Open Timeout
|
154
156
|
|
155
157
|
Open timeout in seconds. The default value is 30.
|
156
158
|
|
@@ -158,7 +160,7 @@ Open timeout in seconds. The default value is 30.
|
|
158
160
|
Files.open_timeout = 60
|
159
161
|
```
|
160
162
|
|
161
|
-
#### Read
|
163
|
+
#### Read Timeout
|
162
164
|
|
163
165
|
Read timeout in seconds. The default value is 80.
|
164
166
|
|
@@ -166,7 +168,7 @@ Read timeout in seconds. The default value is 80.
|
|
166
168
|
Files.read_timeout = 90
|
167
169
|
```
|
168
170
|
|
169
|
-
#### Initial
|
171
|
+
#### Initial Network Retry Delay
|
170
172
|
|
171
173
|
Initial retry delay in seconds. The default value is 0.5.
|
172
174
|
|
@@ -174,7 +176,7 @@ Initial retry delay in seconds. The default value is 0.5.
|
|
174
176
|
Files.initial_network_retry_delay = 1
|
175
177
|
```
|
176
178
|
|
177
|
-
#### Maximum
|
179
|
+
#### Maximum Retry Delay
|
178
180
|
|
179
181
|
Maximum network retry delay in seconds. The default value is 2.
|
180
182
|
|
@@ -182,7 +184,7 @@ Maximum network retry delay in seconds. The default value is 2.
|
|
182
184
|
Files.max_network_retry_delay = 5
|
183
185
|
```
|
184
186
|
|
185
|
-
#### Maximum
|
187
|
+
#### Maximum Network Retries
|
186
188
|
|
187
189
|
Maximum number of retries. The default value is 3.
|
188
190
|
|
@@ -425,7 +427,7 @@ for File and Dir, respectively. (Note that the Files.com SDK uses the
|
|
425
427
|
word Folder, not Dir, and Files::Dir is simply an alias for
|
426
428
|
Files::Folder).
|
427
429
|
|
428
|
-
#### List
|
430
|
+
#### List Root Folder
|
429
431
|
|
430
432
|
```ruby
|
431
433
|
Files::Folder.list_for("/").each do |file|
|
@@ -433,7 +435,7 @@ Files::Folder.list_for("/").each do |file|
|
|
433
435
|
end
|
434
436
|
```
|
435
437
|
|
436
|
-
#### Writing a
|
438
|
+
#### Writing a File
|
437
439
|
|
438
440
|
```ruby
|
439
441
|
Files::upload_file("local.txt", "/remote.txt")
|
@@ -445,7 +447,7 @@ File.open("local.txt") do |local_file|
|
|
445
447
|
end
|
446
448
|
```
|
447
449
|
|
448
|
-
#### Reading a
|
450
|
+
#### Reading a File
|
449
451
|
|
450
452
|
```ruby
|
451
453
|
Files::File.find("foo.txt").read
|
data/_VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.1.
|
1
|
+
1.1.129
|
data/lib/files.com/version.rb
CHANGED
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: files.com
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.1.
|
4
|
+
version: 1.1.129
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- files.com
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2024-09-
|
11
|
+
date: 2024-09-09 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: addressable
|