-
Notifications
You must be signed in to change notification settings - Fork 121
/
box-client.js
804 lines (683 loc) · 26.2 KB
/
box-client.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
/**
* @fileoverview Box API Client
*/
'use strict';
// ------------------------------------------------------------------------------
// Typedefs and Callbacks
// ------------------------------------------------------------------------------
/**
* A collaboration role constant
* @typedef {string} CollaborationRole
*/
/**
* A Box file or folder type constant
* @typedef {string} ItemType
*/
/**
* An access level constant. Used for setting and updating shared links, folder upload, etc.
* @typedef {?Object} AccessLevel
*/
// ------------------------------------------------------------------------------
// Requirements
// ------------------------------------------------------------------------------
var util = require('util'),
qs = require('querystring'),
errors = require('./util/errors'),
httpStatusCodes = require('http-status'),
isIP = require('net').isIP,
merge = require('merge-options'),
PagingIterator = require('./util/paging-iterator'),
Promise = require('bluebird'),
pkg = require('../package.json');
// API Resource Managers
var Users = require('./managers/users'),
Files = require('./managers/files'),
Folders = require('./managers/folders'),
Collaborations = require('./managers/collaborations'),
Groups = require('./managers/groups'),
Comments = require('./managers/comments'),
SharedItems = require('./managers/shared-items'),
Metadata = require('./managers/metadata'),
Collections = require('./managers/collections'),
Events = require('./managers/events'),
Search = require('./managers/search'),
Tasks = require('./managers/tasks'),
Trash = require('./managers/trash'),
Enterprise = require('./managers/enterprise'),
LegalHoldPolicies = require('./managers/legal-hold-policies'),
WebLinks = require('./managers/web-links'),
RetentionPolicies = require('./managers/retention-policies'),
DevicePins = require('./managers/device-pins'),
Webhooks = require('./managers/webhooks'),
RecentItems = require('./managers/recent-items'),
CollaborationWhitelist = require('./managers/collaboration-whitelist'),
TermsOfService = require('./managers/terms-of-service'),
StoragePolicies = require('./managers/storage-policies');
// ------------------------------------------------------------------------------
// Private
// ------------------------------------------------------------------------------
// The Authorization header label
var HEADER_AUTHORIZATION = 'Authorization',
// Prefix our token with this string in the Authorization header
HEADER_AUTHORIZATION_PREFIX = 'Bearer ',
// The 'BoxApi' header label
HEADER_BOXAPI = 'BoxApi',
// The XFF header label - Used to give the API better information for uploads, rate-limiting, etc.
HEADER_XFF = 'X-Forwarded-For',
// As-User header
HEADER_AS_USER = 'As-User',
// Range of SUCCESS http status codes
HTTP_STATUS_CODE_SUCCESS_BLOCK_RANGE = [
200,
299
];
/**
* Build the 'Authorization' Header for the API
*
* @param {string} accessToken An OAuth Access Token
* @returns {string} A properly formatted 'Authorization' header
* @private
*/
function buildAuthorizationHeader(accessToken) {
return HEADER_AUTHORIZATION_PREFIX + accessToken;
}
/**
* Returns true iff the response is a 401 UNAUTHORIZED that is caused by an expired access token.
* @param {APIRequest~ResponseObject} response - The response returned by an APIRequestManager request
* @returns {boolean} - true iff the response is a 401 UNAUTHORIZED caused by an expired access token
* @private
*/
function isUnauthorizedDueToExpiredAccessToken(response) {
// There are three cases to consider:
// 1) The response body is a Buffer. This indicates that the request was malformed (i.e. malformed url) so return false.
// 2) The status code is UNAUTHORIZED and the response body is an empty object or null. This indicates that the access tokens are expired, so return true.
// 3) The status code is UNAUTHORIZED and the response body is a non-empty object. This indicates that the 401 was returned for some reason other
// than expired tokens, so return false.
if (Buffer.isBuffer(response.body)) {
return false;
}
var isResponseStatusCodeUnauthorized = response.statusCode === httpStatusCodes.UNAUTHORIZED,
isResponseBodyEmpty = !response.body || Object.getOwnPropertyNames(response.body).length === 0;
return isResponseStatusCodeUnauthorized && isResponseBodyEmpty;
}
/**
* Returns a full URL. If the url argument begins with http:// or https://, then url is simply returned.
* Otherwise, the defaultBasePath is prepended to url and returned.
*
* @param {string} defaultBasePath The default root URL that will be prepended if `url` is a partial url
* @param {string} url A full or partial URL that will be used to construct the final URL
* @returns {string} The final URL
* @private
*/
function getFullURL(defaultBasePath, url) {
if (/^https?:\/\//.test(url)) {
return url;
}
return defaultBasePath + url;
}
/**
* Create a valid request object for the Batch API from a standard request
* params object
* @param {Object} params The request params
* @returns {Object} The batch API request object
* @private
*/
function formatRequestForBatch(params) {
var relativePath = params.url.replace(/^http.*?\/\d\.\d\//, '/');
return {
method: params.method,
relative_url: relativePath + (params.qs ? `?${qs.stringify(params.qs)}` : ''),
body: params.body,
headers: params.headers
};
}
/**
* Format a Batch API response object into a standard request response
* for use in response handling
* @param {Object} response The batch API response object
* @returns {Object} The standard response object
* @private
*/
function formatResponseForBatch(response) {
return {
statusCode: response.status,
headers: response.headers,
body: response.response
};
}
/**
* Construct the X-Box-UA header to send analytics identifiers
* @param {Object} [client] Analytics client information
* @returns {string} The header value
*/
function constructBoxUAHeader(client) {
var analyticsIdentifiers = {
agent: `box-node-sdk/${pkg.version}`,
env: `Node/${process.version.replace('v', '')}`
};
if (client) {
analyticsIdentifiers.client = `${client.name}/${client.version}`;
}
return Object.keys(analyticsIdentifiers).map(k => `${k}=${analyticsIdentifiers[k]}`)
.join('; ');
}
/**
* The BoxClient can make API calls on behalf of a valid API Session. It is responsible
* for formatting the requests and handling the response. Its goal is to deliver
* sensible results to the user.
*
* @param {APISession} apiSession An initialized API Session, used to get/revoke tokens and handle
* unauthorized responses from the API.
* @param {Config} config The SDK configuration options
* @param {APIRequestManager} requestManager The API Request Manager
* @constructor
*/
function BoxClient(apiSession, config, requestManager) {
// the API Session used by the client for authentication
this._session = apiSession;
// Attach a request manager instance for making requests
this._requestManager = requestManager;
// An object of custom headers to apply to every request. Modified via BoxClient.setCustomHeader().
this._customHeaders = {};
// Attach the configured properties
this._baseURL = util.format('%s/%s', config.apiRootURL, config.apiVersion);
this._uploadBaseURL = util.format('%s/%s', config.uploadAPIRootURL, config.apiVersion);
this._uploadRequestTimeoutMS = config.uploadRequestTimeoutMS;
this._useIterators = config.iterators;
this._analyticsClient = config.analyticsClient;
// Attach API Resource Managers
this.users = new Users(this);
this.files = new Files(this);
this.folders = new Folders(this);
this.comments = new Comments(this);
this.collaborations = new Collaborations(this);
this.groups = new Groups(this);
this.sharedItems = new SharedItems(this);
this.metadata = new Metadata(this);
this.collections = new Collections(this);
this.events = new Events(this);
this.search = new Search(this);
this.tasks = new Tasks(this);
this.trash = new Trash(this);
this.enterprise = new Enterprise(this);
this.legalHoldPolicies = new LegalHoldPolicies(this);
this.weblinks = new WebLinks(this);
this.retentionPolicies = new RetentionPolicies(this);
this.devicePins = new DevicePins(this);
this.webhooks = new Webhooks(this);
this.recentItems = new RecentItems(this);
this.collaborationWhitelist = new CollaborationWhitelist(this);
this.termsOfService = new TermsOfService(this);
this.storagePolicies = new StoragePolicies(this);
// Array of requests when in batch mode, null otherwise
this._batch = null;
}
/**
* Returns an object containing the given headers as well as other headers (like the authorization header and
* custom headers) that should be included in a request.
* @param {?Object} callerHeaders - headers that the caller wishes to include in the request. This method will not
* override these headers with its own. Thus, if all the headers that this method was planning to add are already
* specified here, this method will return an object with exactly the same headers.
* @param {string} accessToken - the access token that will be used to make the request
* @returns {Object} - a new object with the headers needed for the request
* @private
*/
BoxClient.prototype._createHeadersForRequest = function(callerHeaders, accessToken) {
var headers = {};
// 'Authorization' - contains your valid access token for authorization
headers[HEADER_AUTHORIZATION] = buildAuthorizationHeader(accessToken);
// We copy our own custom headers (XFF, BoxApi, etc.) before copying over the caller-specified headers so that
// the caller-specified headers will take precedence.
Object.assign(headers, this._customHeaders, callerHeaders);
// Add analytics headers last so they cannot be overwritten
Object.assign(headers, { 'X-Box-UA': constructBoxUAHeader(this._analyticsClient) });
return headers;
};
/**
* Makes an API request to the Box API on behalf of the client. Before executing
* the request, it first ensures the user has usable tokens. Will be called again
* if the request returns a temporary error. Will propogate error if request returns
* a permanent error, or if usable tokens are not available.
*
* @param {Object} params - Request lib params to configure the request
* @param {APIRequest~Callback} [callback] - passed response data
* @returns {Promise} Promise resolving to the response
* @private
*/
BoxClient.prototype._makeRequest = function(params, callback) {
var promise;
if (this._batch) {
// eslint-disable-next-line promise/avoid-new
promise = new Promise((resolve, reject) => {
this._batch.push({ params, resolve, reject });
});
} else {
// Check that tokens are fresh, update if tokens are expired or soon-to-be expired
promise = this._session.getAccessToken(this._tokenOptions)
.then(accessToken => {
params.headers = this._createHeadersForRequest(params.headers, accessToken);
if (params.streaming) {
// streaming is specific to the SDK, so delete it from params before continuing
delete params.streaming;
var responseStream = this._requestManager.makeStreamingRequest(params);
// Listen to 'response' event, so we can cleanup the token store in case when the request is unauthorized
// due to expired access token
responseStream.on('response', response => {
if (isUnauthorizedDueToExpiredAccessToken(response)) {
var expiredTokensError = errors.buildAuthError(response);
// Give the session a chance to handle the error (ex: a persistent session will clear the token store)
if (this._session.handleExpiredTokensError) {
this._session.handleExpiredTokensError(expiredTokensError);
}
}
});
return responseStream;
}
// Make the request to Box, and perform standard response handling
return this._requestManager.makeRequest(params);
});
}
return promise
.then(response => {
if (!response.statusCode) {
// Response is not yet complete, and is just a stream that will return the response later
// Just return the stream, since it doesn't need further response handling
return response;
}
if (isUnauthorizedDueToExpiredAccessToken(response)) {
var expiredTokensError = errors.buildAuthError(response);
// Give the session a chance to handle the error (ex: a persistent session will clear the token store)
if (this._session.handleExpiredTokensError) {
return this._session.handleExpiredTokensError(expiredTokensError);
}
throw expiredTokensError;
}
return response;
})
.asCallback(callback);
};
// ------------------------------------------------------------------------------
// Public
// ------------------------------------------------------------------------------
/**
* Enum of valid collaboration roles
*
* @readonly
* @enum {CollaborationRole}
*/
BoxClient.prototype.collaborationRoles = {
EDITOR: 'editor',
VIEWER: 'viewer',
PREVIEWER: 'previewer',
UPLOADER: 'uploader',
PREVIEWER_UPLOADER: 'previewer uploader',
VIEWER_UPLOADER: 'viewer uploader',
CO_OWNER: 'co-owner',
OWNER: 'owner'
};
/**
* Enum of Box item types
*
* @readonly
* @enum {ItemType}
*/
BoxClient.prototype.itemTypes = {
FILE: 'file',
FOLDER: 'folder'
};
/**
* Enum of valid values for setting different access levels. To be used when
* creating and editting shared links, upload emails, etc.
*
* @readonly
* @type {AccessLevel}
*/
BoxClient.prototype.accessLevels = {
OPEN: {access: 'open'},
COLLABORATORS: {access: 'collaborators'},
COMPANY: {access: 'company'},
DEFAULT: {},
DISABLED: null
};
/** @const {string} */
BoxClient.prototype.CURRENT_USER_ID = Users.prototype.CURRENT_USER_ID;
/**
* Set a custom header. A custom header is applied to every request for the life of the client. To
* remove a header, set it's value to null.
*
* @param {string} header The name of the custom header to set.
* @param {*} value The value of the custom header. Set to null to remove the given header.
* @returns {void}
*/
BoxClient.prototype.setCustomHeader = function(header, value) {
if (value) {
this._customHeaders[header] = value;
} else {
delete this._customHeaders[header];
}
};
/**
* Sets the list of requesting IP addresses for the X-Forwarded-For header. Used to give the API
* better information for uploads, rate-limiting, etc.
*
* @param {string[]} ips - Array of IP Addresses
* @returns {void}
*/
BoxClient.prototype.setIPs = function(ips) {
var validIPs = ips.filter(ipString => isIP(ipString)).join(', ');
this.setCustomHeader(HEADER_XFF, validIPs);
this._tokenOptions = {ip: validIPs};
};
/**
* Sets the shared item context on the API Session. Overwrites any current context.
*
* @param {string} url The shared link url
* @param {?string} password The shared link password, null if no password exists.
* @returns {void}
*/
BoxClient.prototype.setSharedContext = function(url, password) {
var sharedContextAuthHeader = this.buildSharedItemAuthHeader(url, password);
this.setCustomHeader(HEADER_BOXAPI, sharedContextAuthHeader);
};
/**
* Removes any current shared item context from API Session.
*
* @returns {void}
*/
BoxClient.prototype.revokeSharedContext = function() {
this.setCustomHeader(HEADER_BOXAPI, null);
};
/**
* Set up the As-User context, which is used by enterprise admins to
* impersonate their managed users and perform actions on their behalf.
*
* @param {string} userID - The ID of the user to impersonate
* @returns {void}
*/
BoxClient.prototype.asUser = function(userID) {
this.setCustomHeader(HEADER_AS_USER, userID);
};
/**
* Revoke the As-User context and return to making calls on behalf of the user
* who owns the client's access token.
*
* @returns {void}
*/
BoxClient.prototype.asSelf = function() {
this.setCustomHeader(HEADER_AS_USER, null);
};
/**
* Revokes the client's access tokens. The client will no longer be tied to a user
* and will be unable to make calls to the API, rendering it effectively useless.
*
* @param {Function} [callback] Called after revoking, with an error if one existed
* @returns {Promise} A promise resolving when the client's access token is revoked
*/
BoxClient.prototype.revokeTokens = function(callback) {
return this._session.revokeTokens(this._tokenOptions)
.asCallback(callback);
};
/**
* Exchange the client access token for one with lower scope
* @param {string|string[]} scopes The scope(s) requested for the new token
* @param {string} [resource] The absolute URL of an API resource to scope the new token to
* @param {Object} [options] - Optional parameters
* @param {ActorParams} [options.actor] - Optional actor parameters for creating annotator tokens with Token Auth client
* @param {SharedLinkParams} [options.sharedLink] - Optional shared link parameters for creating tokens using shared links
* @param {Function} [callback] Called with the new token
* @returns {Promise<TokenInfo>} A promise resolving to the exchanged token info
*/
BoxClient.prototype.exchangeToken = function(scopes, resource, options, callback) {
// Shuffle optional parameters
if (typeof options === 'function') {
callback = options;
options = {};
}
var opts = Object.assign({ tokenRequestOptions: this._tokenOptions || null }, options);
return this._session.exchangeToken(scopes, resource, opts)
.asCallback(callback);
};
/**
* Makes GET request to Box API V2 endpoint
*
* @param {string} path - path to a certain API endpoint (ex: /file)
* @param {?Object} params - object containing parameters for the request, such as query strings and headers
* @param {APIRequest~Callback} callback - passed final API response or err if request failed
* @returns {void}
*/
BoxClient.prototype.get = function(path, params, callback) {
var newParams = merge({}, params || {});
newParams.method = 'GET';
newParams.url = getFullURL(this._baseURL, path);
return this._makeRequest(newParams, callback);
};
/**
* Makes POST request to Box API V2 endpoint
*
* @param {string} path - path to a certain API endpoint (ex: /file)
* @param {?Object} params - object containing parameters for the request, such as query strings and headers
* @param {APIRequest~Callback} callback - passed final API response or err if request failed
* @returns {void}
*/
BoxClient.prototype.post = function(path, params, callback) {
var newParams = merge({}, params || {});
newParams.method = 'POST';
newParams.url = getFullURL(this._baseURL, path);
return this._makeRequest(newParams, callback);
};
/**
* Makes PUT request to Box API V2 endpoint
*
* @param {string} path - path to a certain API endpoint (ex: /file)
* @param {?Object} params - object containing parameters for the request, such as query strings and headers
* @param {APIRequest~Callback} callback - passed final API response or err if request failed
* @returns {void}
*/
BoxClient.prototype.put = function(path, params, callback) {
var newParams = merge({}, params || {});
newParams.method = 'PUT';
newParams.url = getFullURL(this._baseURL, path);
return this._makeRequest(newParams, callback);
};
/**
* Makes DELETE request to Box API V2 endpoint
*
* @param {string} path - path to a certain API endpoint (ex: /file)
* @param {?Object} params - object containing parameters for the request, such as query strings and headers
* @param {APIRequest~Callback} callback - passed final API response or err if request failed
* @returns {void}
*/
BoxClient.prototype.del = function(path, params, callback) {
var newParams = merge({}, params || {});
newParams.method = 'DELETE';
newParams.url = getFullURL(this._baseURL, path);
return this._makeRequest(newParams, callback);
};
/**
* Makes an OPTIONS call to a Box API V2 endpoint
*
* @param {string} path - Path to an API endpoint (e.g. /files/content)
* @param {?Object} params - An optional object containing request parameters
* @param {APIRequest~Callback} callback - Called with API call results, or err if call failed
* @returns {void}
*/
BoxClient.prototype.options = function(path, params, callback) {
var newParams = merge({}, params || {});
newParams.method = 'OPTIONS';
newParams.url = getFullURL(this._baseURL, path);
return this._makeRequest(newParams, callback);
};
/**
* Makes a POST call to a Box API V2 upload endpoint
* @param {string} path - path to an upload API endpoint
* @param {?Object} params - an optional object containing request parameters
* @param {?Object} formData - multipart form data to include in the upload request {@see https://github.com/mikeal/request#multipartform-data-multipart-form-uploads}
* @param {APIRequest~Callback} callback - called with API call results, or an error if the call failed
* @returns {void}
*/
BoxClient.prototype.upload = function(path, params, formData, callback) {
var defaults = {
method: 'POST'
};
var newParams = merge(defaults, params || {});
newParams.url = getFullURL(this._uploadBaseURL, path);
newParams.formData = formData;
newParams.timeout = this._uploadRequestTimeoutMS;
return this._makeRequest(newParams, callback);
};
/**
* Puts the client into batch mode, which will queue calls instead of
* immediately making the API request.
*
* DEPRECATED: Batch API is not supported and should not be used; make calls in parallel instead.
*
* @returns {BoxClient} Current client object
*/
BoxClient.prototype.batch = util.deprecate(function() {
/* eslint-disable no-invalid-this */
this._batch = [];
return this;
/* eslint-enable no-invalid-this */
}, 'Batch API is not supported and should not be used; make calls in parallel instead.');
/**
* Executes a batch of requests.
*
* DEPRECATED: Batch API is not supported and should not be used; make calls in parallel instead.
*
* @returns {Promise<Object>} Promise resolving to the collection of batch responses
*/
BoxClient.prototype.batchExec = util.deprecate(function(callback) {
/* eslint-disable no-invalid-this */
if (!this._batch) {
return Promise.reject(new Error('Must start a batch before executing'))
.asCallback(callback);
}
var params = {
body: {
requests: this._batch.map(batchReq => formatRequestForBatch(batchReq.params))
}
};
var batch = this._batch;
this._batch = null;
return this.post('/batch', params)
.then(res => {
var responses = res.body.responses;
responses.map(x => formatResponseForBatch(x)).forEach((response, index) => {
batch[index].resolve(response);
});
return res.body;
})
.catch(err => {
batch.forEach(req => req.reject(err));
throw err;
})
.asCallback(callback);
/* eslint-enable no-invalid-this */
}, 'Batch API is not supported and should not be used; make calls in parallel instead.');
/**
* Build the 'BoxApi' Header used for authenticating access to a shared item
*
* @param {string} url The shared link url
* @param {string} [password] The shared link password
* @returns {string} A properly formatted 'BoxApi' header
*/
BoxClient.prototype.buildSharedItemAuthHeader = function(url, password) {
var encodedURL = encodeURIComponent(url),
encodedPassword = encodeURIComponent(password);
if (password) {
return util.format('shared_link=%s&shared_link_password=%s', encodedURL, encodedPassword);
}
return util.format('shared_link=%s', encodedURL);
};
/**
* Return a callback that properly handles a successful response code by passing the response
* body to the original callback. Any request error or unsuccessful response codes are propagated
* back to the callback as errors. This is the standard behavior of most endpoints.
*
* @param {Function} callback The original callback given by the consumer
* @returns {?APIRequest~Callback} A new callback that processes the response before passing it to the callback.
*/
BoxClient.prototype.defaultResponseHandler = function(callback) {
var self = this;
if (!callback) {
return null;
}
return function(err, response) {
// Error with Request
if (err) {
callback(err);
return;
}
// Successful Response
if (response.statusCode >= HTTP_STATUS_CODE_SUCCESS_BLOCK_RANGE[0]
&& response.statusCode <= HTTP_STATUS_CODE_SUCCESS_BLOCK_RANGE[1]) {
if (self._useIterators && PagingIterator.isIterable(response)) {
callback(null, new PagingIterator(response, self));
return;
}
callback(null, response.body);
return;
}
// Unexpected Response
callback(errors.buildUnexpectedResponseError(response));
};
};
/**
* Wrap a client method with the default handler for both callback and promise styles
* @param {Function} method The client method (e.g. client.get)
* @returns {Function} The wrapped method
*/
BoxClient.prototype.wrapWithDefaultHandler = function(method) {
var self = this;
return function wrappedClientMethod(/* arguments */) {
// Check if the last argument is a callback
var lastArg = arguments[arguments.length - 1],
callback;
if (typeof lastArg === 'function') {
callback = self.defaultResponseHandler(lastArg);
arguments[arguments.length - 1] = callback;
}
var ret = method.apply(self, arguments);
if (ret instanceof Promise) {
ret = ret.then(response => {
if (response.statusCode >= HTTP_STATUS_CODE_SUCCESS_BLOCK_RANGE[0]
&& response.statusCode <= HTTP_STATUS_CODE_SUCCESS_BLOCK_RANGE[1]) {
if (self._useIterators && PagingIterator.isIterable(response)) {
return new PagingIterator(response, self);
}
return response.body;
}
throw errors.buildUnexpectedResponseError(response);
});
}
if (callback) {
// If the callback will handle any errors, don't worry about the promise
ret.suppressUnhandledRejections();
}
return ret;
};
};
/**
* Add a SDK plugin. Warning: This will modify the box-client interface and can override existing properties.
* @param {string} name Plugin name. Will be accessible via client.<plugin-name>
* @param {Function} plugin The SDK plugin to add
* @param {Object} [options] Plugin-specific options
* @returns {void}
* @throws Will throw an error if plugin name matches an existing method on box-client
*/
BoxClient.prototype.plug = function(name, plugin, options) {
options = options || {};
if ((name in this) && (typeof this[name] === 'function')) {
throw new Error('You cannot define a plugin that overrides an existing method on the client');
}
// Create plugin and export plugin onto client.
this[name] = plugin(this, options);
};
// ------------------------------------------------------------------------------
// Public
// ------------------------------------------------------------------------------
/**
* @module box-node-sdk/lib/box-client
* @see {@Link BoxClient}
*/
module.exports = BoxClient;