Skip to content

Commit 9142f78

Browse files
bombinobombino
committed
Initial commit
0 parents  commit 9142f78

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

68 files changed

+11172
-0
lines changed

‎.babelrc

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
{
2+
"presets": [
3+
[
4+
"@babel/preset-env",
5+
{
6+
"targets": {
7+
"ie": "11"
8+
}
9+
}
10+
]
11+
],
12+
"plugins": [
13+
"@babel/plugin-proposal-class-properties",
14+
["@babel/plugin-transform-modules-commonjs", {
15+
"loose": true
16+
}],
17+
"@babel/plugin-transform-runtime"
18+
]
19+
}

‎.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
yarn.lock

‎CONTRIBUTORS

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Kevin Bombino <[email protected]>
2+
Martyn Garcia <[email protected]>
3+
Dustin Zeisler <[email protected]>
4+
Rommel Santor <[email protected]>

‎LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
The MIT License
2+
3+
Copyright (c) 2019- Action Verb, LLC (https://www.files.com)
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in
13+
all copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21+
THE SOFTWARE.

‎README.md

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Files.com JavaScript SDK
2+
3+
The Files.com JavaScript SDK provides convenient access to the Files.com API from applications written in JavaScript.
4+
5+
6+
## Installation
7+
8+
To install the package:
9+
10+
* `yarn add files-com`
11+
12+
or
13+
14+
* `npm install files-com`
15+
16+
17+
### Requirements
18+
19+
* Yarn or NPM package system

‎_VERSION

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
1.0

‎files.com-logo.png

13.4 KB
Loading

‎index.js

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
exports.Files = require('./lib/Files')
2+
exports.Logger = require('./lib/Logger')

‎package.json

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
{
2+
"name": "files.com",
3+
"version": "1.0.0",
4+
"description": "Files.com SDK for JavaScript",
5+
"keywords": [
6+
"files.com",
7+
"cloud storage",
8+
"api"
9+
],
10+
"homepage": "https://www.files.com/",
11+
"author": "Files.com <[email protected]> (https://www.files.com/)",
12+
"contributors": [],
13+
"engines": {
14+
"node": "^6 || ^8.1 || >=10.*"
15+
},
16+
"main": "lib/files.js",
17+
"dependencies": {
18+
"@babel/runtime": "^7.10.3",
19+
"axios": "^0.19.2",
20+
"axios-retry": "^3.1.8",
21+
"lodash.isplainobject": "^4.0.6",
22+
"qs": "^6.6.0",
23+
"readable-stream": "^3.6.0",
24+
"safe-buffer": "^5.1.1",
25+
"uuid": "^3.3.2"
26+
},
27+
"license": "MIT",
28+
"devDependencies": {
29+
"@babel/cli": "^7.10.3",
30+
"@babel/core": "^7.10.3",
31+
"@babel/plugin-proposal-class-properties": "^7.10.1",
32+
"@babel/plugin-transform-modules-commonjs": "^7.10.1",
33+
"@babel/plugin-transform-runtime": "^7.10.3",
34+
"@babel/preset-env": "^7.10.3"
35+
},
36+
"scripts": {
37+
"build": "./node_modules/.bin/babel src -d lib"
38+
}
39+
}

‎src/Api.js

+141
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,141 @@
1+
import axios from 'axios'
2+
import axiosRetry from 'axios-retry'
3+
4+
import Files from './Files'
5+
import Logger from './Logger'
6+
import { isEmpty, isObject } from './utils'
7+
8+
class Api {
9+
static _configureAutoRetry = () => {
10+
axiosRetry(
11+
axios,
12+
{
13+
retries: Files.getMaxNetworkRetries(),
14+
retryDelay: retries => {
15+
Logger.info(`Retrying request (retry ${retries} of ${Files.getMaxNetworkRetries()})`)
16+
17+
return Math.min(
18+
retries * Files.getMinNetworkRetryDelay() * 1000,
19+
Files.getMaxNetworkRetryDelay() * 1000
20+
)
21+
},
22+
}
23+
)
24+
}
25+
26+
static _sendVerbatim = async (path, verb, options) => {
27+
const isExternal = /^[a-zA-Z]+:\/\//.test(path)
28+
const baseUrl = Files.getBaseUrl()
29+
30+
if (!isExternal && !baseUrl) {
31+
throw new Error('Base URL has not been set - use Files.setBaseUrl() to set it')
32+
}
33+
34+
const url = isExternal
35+
? path
36+
: `${baseUrl}${Files.getEndpointPrefix()}${path}`
37+
38+
Logger.debug(`Sending request: ${verb} ${url}`)
39+
Logger.debug('Sending options:', options)
40+
41+
Api._configureAutoRetry()
42+
43+
try {
44+
const response = await axios({
45+
method: verb,
46+
timeout: Files.getNetworkTimeout() * 1000,
47+
url,
48+
...options,
49+
})
50+
51+
Logger.debug(`Status: ${response.status} ${response.statusText}`)
52+
53+
if (Files.shouldDebugResponseHeaders()) {
54+
Logger.debug('Response Headers: ')
55+
Logger.debug(response.headers)
56+
}
57+
58+
return {
59+
status: response.status,
60+
reason: response.statusText,
61+
headers: response.headers,
62+
data: response.data,
63+
}
64+
} catch (error) {
65+
if (error.response) {
66+
Logger.error('Exception >', error.response.status, error.response.statusText)
67+
}
68+
69+
Logger.error('Exception >', error.toString())
70+
return null
71+
}
72+
}
73+
74+
static sendFilePart = (externalUrl, verb, data, headers = {}) => {
75+
const params = { data }
76+
77+
if (headers) {
78+
params.headers = headers
79+
}
80+
81+
return Api._sendVerbatim(externalUrl, verb, params)
82+
}
83+
84+
static sendRequest = async (path, verb, params = null, options = {}) => {
85+
const headers = {
86+
...options.headers,
87+
Accept: 'application/json',
88+
'User-Agent': 'Files.com JavaScript SDK v1.0',
89+
}
90+
91+
const isExternal = /^[a-zA-Z]+:\/\//.test(path)
92+
93+
if (!isExternal) {
94+
const sessionId = options.sessionId || Files.getSessionId()
95+
96+
if (sessionId) {
97+
headers['X-FilesAPI-Auth'] = sessionId
98+
} else {
99+
const isCreatingSession = path === '/sessions' && verb.toUpperCase() === 'POST'
100+
101+
// api key cannot be used when creating a session
102+
if (!isCreatingSession) {
103+
const apiKey = options.apiKey || Files.getApiKey()
104+
105+
if (!apiKey) {
106+
throw new Error('API key has not been set - use Files.setApiKey() to set it')
107+
}
108+
109+
headers['X-FilesAPI-Key'] = apiKey
110+
}
111+
}
112+
}
113+
114+
const hasParams = isObject(params) && !isEmpty(params)
115+
116+
if (hasParams) {
117+
options.data = JSON.stringify(params)
118+
headers['Content-Type'] = 'application/json'
119+
}
120+
121+
options.headers = headers
122+
123+
if (Files.shouldDebugRequest()) {
124+
Logger.debug('Request Options:')
125+
Logger.debug({
126+
...options,
127+
data: hasParams
128+
? `payload keys: ${Object.keys(params).join(', ')}`
129+
: '(none)',
130+
headers: {
131+
...headers,
132+
'X-FilesAPI-Key': '<redacted>',
133+
},
134+
})
135+
}
136+
137+
return Api._sendVerbatim(path, verb, options)
138+
}
139+
}
140+
141+
export default Api

‎src/Files.js

+70
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
import { LogLevel } from './Logger'
2+
3+
const endpointPrefix = '/api/rest/v1'
4+
5+
let apiKey
6+
let baseUrl = 'https://app.files.com'
7+
let sessionId = null
8+
9+
let logLevel = LogLevel.INFO
10+
let debugRequest = false
11+
let debugResponseHeaders = false
12+
13+
let maxNetworkRetries = 3
14+
let minNetworkRetryDelay = 0.5
15+
let maxNetworkRetryDelay = 1.5
16+
let networkTimeout = 30.0
17+
18+
class Files {
19+
static setApiKey = value => apiKey = value
20+
static getApiKey = () => apiKey
21+
22+
static setBaseUrl = value => baseUrl = value
23+
static getBaseUrl = () => baseUrl
24+
25+
static setSessionId = value => sessionId = value
26+
static getSessionId = () => sessionId
27+
28+
static getEndpointPrefix = () => endpointPrefix
29+
30+
static setLogLevel = value => logLevel = value
31+
static getLogLevel = () => logLevel
32+
33+
static configureDebugging = options => {
34+
if (typeof options.debugRequest !== 'undefined') {
35+
debugRequest = options.debugRequest
36+
}
37+
38+
if (typeof options.debugResponseHeaders !== 'undefined') {
39+
debugResponseHeaders = options.debugResponseHeaders
40+
}
41+
}
42+
43+
static shouldDebugRequest = () => debugRequest
44+
static shouldDebugResponseHeaders = () => debugResponseHeaders
45+
46+
static configureNetwork = options => {
47+
if (typeof options.maxNetworkRetries !== 'undefined') {
48+
maxNetworkRetries = options.maxNetworkRetries
49+
}
50+
51+
if (typeof options.minNetworkRetryDelay !== 'undefined') {
52+
minNetworkRetryDelay = options.minNetworkRetryDelay
53+
}
54+
55+
if (typeof options.maxNetworkRetryDelay !== 'undefined') {
56+
maxNetworkRetryDelay = options.maxNetworkRetryDelay
57+
}
58+
59+
if (typeof options.networkTimeout !== 'undefined') {
60+
networkTimeout = options.networkTimeout
61+
}
62+
}
63+
64+
static getMaxNetworkRetries = () => maxNetworkRetries
65+
static getMinNetworkRetryDelay = () => minNetworkRetryDelay
66+
static getMaxNetworkRetryDelay = () => maxNetworkRetryDelay
67+
static getNetworkTimeout = () => networkTimeout
68+
}
69+
70+
export default Files

0 commit comments

Comments
 (0)