files.com 1.1.199 → 1.1.201
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/README.md +10 -6
- 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: 95c214f3aaac349f0d5695f3f700990d920c39d16e119214647d2c834c401de0
|
4
|
+
data.tar.gz: f51ca7563f8a4c2ba0d1aacc6214db6ba6895e96ac9399e979b0e29dd3008a5e
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 254a288f7e23fd32fa942a8f5f33bad5a878d6cd39467b0e05b9d0c23816982971729f931b5674b1845e3a0b30acec2cecccfccb00c309270552a67b1593ade3
|
7
|
+
data.tar.gz: 39815990c2fb01010749c5fab913b9a36bbf68bed2c14dccb1d25280dfc5828f2e410bcd6f1573a19c715dac56fdf63f3d800ad89cbd606bf4125d2abc126e71
|
data/README.md
CHANGED
@@ -51,12 +51,14 @@ To initiate a support conversation, you can send an [Authenticated Support Reque
|
|
51
51
|
|
52
52
|
## Authentication
|
53
53
|
|
54
|
+
There are two ways to authenticate: API Key authentication and Session-based authentication.
|
55
|
+
|
54
56
|
### Authenticate with an API Key
|
55
57
|
|
56
58
|
Authenticating with an API key is the recommended authentication method for most scenarios, and is
|
57
59
|
the method used in the examples on this site.
|
58
60
|
|
59
|
-
To use
|
61
|
+
To use an API Key, first generate an API key from the [web
|
60
62
|
interface](https://www.files.com/docs/sdk-and-apis/api-keys) or [via the API or an
|
61
63
|
SDK](/ruby/resources/developers/api-keys).
|
62
64
|
|
@@ -75,14 +77,14 @@ Don't forget to replace the placeholder, `YOUR_API_KEY`, with your actual API ke
|
|
75
77
|
|
76
78
|
### Authenticate with a Session
|
77
79
|
|
78
|
-
You can also authenticate
|
80
|
+
You can also authenticate by creating a user session using the username and
|
79
81
|
password of an active user. If the user is an administrator, the session will have full access to
|
80
|
-
|
82
|
+
all capabilities of Files.com. Sessions created from regular user accounts will only be able to access files that
|
81
83
|
user can access, and no access will be granted to site administration functions.
|
82
84
|
|
83
|
-
|
85
|
+
Sessions use the exact same session timeout settings as web interface sessions. When a
|
84
86
|
session times out, simply create a new session and resume where you left off. This process is not
|
85
|
-
automatically handled by SDKs because we do not want to store password information in memory without
|
87
|
+
automatically handled by our SDKs because we do not want to store password information in memory without
|
86
88
|
your explicit consent.
|
87
89
|
|
88
90
|
#### Logging In
|
@@ -122,6 +124,8 @@ session.destroy()
|
|
122
124
|
|
123
125
|
## Configuration
|
124
126
|
|
127
|
+
The Ruby SDK is configured by setting attributes on the `Files` object.
|
128
|
+
|
125
129
|
### Configuration Options
|
126
130
|
|
127
131
|
#### Base URL
|
@@ -166,7 +170,7 @@ Files.open_timeout = 60
|
|
166
170
|
|
167
171
|
#### Read Timeout
|
168
172
|
|
169
|
-
Read timeout in seconds. The default value is
|
173
|
+
Read timeout in seconds. The default value is 60.
|
170
174
|
|
171
175
|
```ruby title="Example setting"
|
172
176
|
Files.read_timeout = 90
|
data/_VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.1.
|
1
|
+
1.1.201
|
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.201
|
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-12-
|
11
|
+
date: 2024-12-19 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: addressable
|