New: version history in details tab

src/api/APIFactory.js

@@ -12,7 +12,15 @@ import FileAPI from './File';
 import WebLinkAPI from './WebLink';
 import SearchAPI from './Search';
 import RecentsAPI from './Recents';
-import { DEFAULT_HOSTNAME_API, DEFAULT_HOSTNAME_UPLOAD, TYPE_FOLDER, TYPE_FILE, TYPE_WEBLINK } from '../constants';
+import VersionsAPI from './Versions';
+import {
+    DEFAULT_HOSTNAME_API,
+    DEFAULT_HOSTNAME_UPLOAD,
+    TYPE_FOLDER,
+    TYPE_FILE,
+    TYPE_WEBLINK,
+    TYPE_VERSIONS
+} from '../constants';
 import type { Options, ItemType, ItemAPI } from '../flowTypes';
 
 class APIFactory {
@@ -56,6 +64,11 @@ class APIFactory {
      */
     recentsAPI: RecentsAPI;
 
+    /**
+     * @property {VersionsAPI}
+     */
+    versionsAPI: VersionsAPI;
+
     /**
      * [constructor]
      *
@@ -111,6 +124,10 @@ class APIFactory {
             this.recentsAPI.destroy();
             delete this.recentsAPI;
         }
+        if (this.versionsAPI) {
+            this.versionsAPI.destroy();
+            delete this.versionsAPI;
+        }
         if (destroyCache) {
             this.options.cache = new Cache();
         }
@@ -145,6 +162,9 @@ class APIFactory {
             case TYPE_WEBLINK:
                 api = this.getWebLinkAPI();
                 break;
+            case TYPE_VERSIONS:
+                api = this.getVersionsAPI();
+                break;
             default:
                 throw new Error('Unknown Type!');
         }
@@ -228,6 +248,15 @@ class APIFactory {
         this.recentsAPI = new RecentsAPI(this.options);
         return this.recentsAPI;
     }
+
+    /**
+     * API for versions
+     */
+    getVersionsAPI(): VersionsAPI {
+        this.destroy();
+        this.versionsAPI = new VersionsAPI(this.options);
+        return this.versionsAPI;
+    }
 }
 
 export default APIFactory;

src/api/File.js

@@ -6,7 +6,7 @@
 
 import Item from './Item';
 import { getFieldsAsString } from '../util/fields';
-import { FIELD_DOWNLOAD_URL, CACHE_PREFIX_FILE, X_REP_HINTS, TYPED_ID_FILE_PREFIX } from '../constants';
+import { FIELD_DOWNLOAD_URL, CACHE_PREFIX_FILE, X_REP_HINTS } from '../constants';
 import type Cache from '../util/Cache';
 import { getBadItemError, getBadPermissionsError } from '../util/error';
 import type { BoxItem } from '../flowTypes';
@@ -22,17 +22,6 @@ class File extends Item {
         return `${CACHE_PREFIX_FILE}${id}`;
     }
 
-    /**
-     * Returns typed id for file. Useful for when
-     * making file based XHRs where auth token
-     * can be per file as used by Preview.
-     *
-     * @return {string} typed id for file
-     */
-    getTypedFileId(id: string): string {
-        return `${TYPED_ID_FILE_PREFIX}${id}`;
-    }
-
     /**
      * API URL for files
      *

src/api/Item.js

@@ -7,7 +7,7 @@
 import noop from 'lodash/noop';
 import Base from './Base';
 import { getBadItemError } from '../util/error';
-import { ACCESS_NONE, CACHE_PREFIX_SEARCH, CACHE_PREFIX_FOLDER, TYPE_FOLDER } from '../constants';
+import { ACCESS_NONE, CACHE_PREFIX_SEARCH, CACHE_PREFIX_FOLDER, TYPE_FOLDER, TYPED_ID_FILE_PREFIX } from '../constants';
 import type Cache from '../util/Cache';
 import type { BoxItem, FlattenedBoxItem, FlattenedBoxItemCollection, BoxItemPermission } from '../flowTypes';
 
@@ -309,6 +309,17 @@ class Item extends Base {
             .then(this.shareSuccessHandler)
             .catch(this.errorHandler);
     }
+
+    /**
+     * Returns typed id for file. Useful for when
+     * making file based XHRs where auth token
+     * can be per file as used by Preview.
+     *
+     * @return {string} typed id for file
+     */
+    getTypedFileId(id: string): string {
+        return `${TYPED_ID_FILE_PREFIX}${id}`;
+    }
 }
 
 export default Item;

src/api/Versions.js

@@ -0,0 +1,51 @@
+/**
+ * @flow
+ * @file Helper for the box versions API
+ * @author Box
+ */
+
+import Item from './Item';
+import type { FileVersions } from '../flowTypes';
+
+class Versions extends Item {
+    /**
+     * API URL for versions
+     *
+     * @param {string} [id] - a box file id
+     * @return {string} base url for files
+     */
+    getUrl(id: string): string {
+        if (!id) {
+            throw new Error('Missing file id!');
+        }
+        return `${this.getBaseApiUrl()}/files/${id}/versions`;
+    }
+
+    /**
+     * Gets the versions for a box file
+     *
+     * @param {string} id - a box file id
+     * @param {Function} successCallback - Function to call with results
+     * @param {Function} errorCallback - Function to call with errors
+     * @return {Promise}
+     */
+    versions(id: string, successCallback: Function, errorCallback: Function): Promise<void> {
+        if (this.isDestroyed()) {
+            return Promise.reject();
+        }
+
+        // Make the XHR request
+        // We only need the total_count for now
+        return this.xhr
+            .get({
+                id: this.getTypedFileId(id),
+                url: this.getUrl(id)
+            })
+            .then(({ data }: { data: FileVersions }) => {
+                successCallback(data);
+            })
+            .catch(errorCallback);
+    }
+}
+
+export default Versions;

src/api/__tests__/APIFactory-test.js

@@ -9,6 +9,7 @@ import FileAPI from '../File';
 import WebLinkAPI from '../WebLink';
 import SearchAPI from '../Search';
 import RecentsAPI from '../Recents';
+import VersionsAPI from '../Versions';
 import { DEFAULT_HOSTNAME_API, DEFAULT_HOSTNAME_UPLOAD } from '../../constants';
 
 let factory;
@@ -33,6 +34,7 @@ describe('api/APIFactory', () => {
             factory.plainUploadAPI = { destroy: jest.fn() };
             factory.chunkedUploadAPI = { destroy: jest.fn() };
             factory.recentsAPI = { destroy: jest.fn() };
+            factory.versionsAPI = { destroy: jest.fn() };
             factory.destroy();
             expect(factory.fileAPI).toBeUndefined();
             expect(factory.folderAPI).toBeUndefined();
@@ -41,6 +43,7 @@ describe('api/APIFactory', () => {
             expect(factory.plainUploadAPI).toBeUndefined();
             expect(factory.chunkedUploadAPI).toBeUndefined();
             expect(factory.recentsAPI).toBeUndefined();
+            expect(factory.versionsAPI).toBeUndefined();
         });
         test('should not destroy cache by default', () => {
             const { cache } = factory.options;
@@ -68,6 +71,9 @@ describe('api/APIFactory', () => {
         test('should return web link api when type is web_link', () => {
             expect(factory.getAPI('web_link')).toBeInstanceOf(WebLinkAPI);
         });
+        test('should return versions api when type is versions', () => {
+            expect(factory.getAPI('versions')).toBeInstanceOf(VersionsAPI);
+        });
         test('should throw error when type is incorrect', () => {
             expect(factory.getAPI.bind(factory, 'foo')).toThrow(Error, /Unknown Type/);
         });
@@ -156,4 +162,16 @@ describe('api/APIFactory', () => {
             expect(recentsAPI.options.uploadHost).toBe(DEFAULT_HOSTNAME_UPLOAD);
         });
     });
+
+    describe('getVersionsAPI()', () => {
+        test('should call destroy and return versions API', () => {
+            const spy = jest.spyOn(factory, 'destroy');
+            const versionsAPI = factory.getVersionsAPI();
+            expect(spy).toBeCalled();
+            expect(versionsAPI).toBeInstanceOf(VersionsAPI);
+            expect(versionsAPI.options.cache).toBeInstanceOf(Cache);
+            expect(versionsAPI.options.apiHost).toBe(DEFAULT_HOSTNAME_API);
+            expect(versionsAPI.options.uploadHost).toBe(DEFAULT_HOSTNAME_UPLOAD);
+        });
+    });
 });

src/api/__tests__/File-test.js

@@ -18,12 +18,6 @@ describe('api/File', () => {
         });
     });
 
-    describe('getTypedFileId()', () => {
-        test('should return correct typed id', () => {
-            expect(file.getTypedFileId('foo')).toBe('file_foo');
-        });
-    });
-
     describe('getUrl()', () => {
         test('should return correct file api url without id', () => {
             expect(file.getUrl()).toBe('https://api.box.com/2.0/files');

src/api/__tests__/Item-test.js

@@ -523,4 +523,10 @@ describe('api/Item', () => {
             expect(item.getParentCacheKey).toHaveBeenCalledWith('parentId');
         });
     });
+
+    describe('getTypedFileId()', () => {
+        test('should return correct typed id', () => {
+            expect(item.getTypedFileId('foo')).toBe('file_foo');
+        });
+    });
 });

src/api/__tests__/Versions-test.js

@@ -0,0 +1,71 @@
+import Versions from '../Versions';
+
+let versions;
+const versionsResponse = { total_count: 0, entries: [] };
+
+describe('api/Versions', () => {
+    beforeEach(() => {
+        versions = new Versions({});
+    });
+
+    describe('getUrl()', () => {
+        test('should throw when version api url without id', () => {
+            expect(() => {
+                versions.getUrl();
+            }).toThrow();
+        });
+        test('should return correct version api url with id', () => {
+            expect(versions.getUrl('foo')).toBe('https://api.box.com/2.0/files/foo/versions');
+        });
+    });
+
+    describe('file()', () => {
+        test('should not do anything if destroyed', () => {
+            versions.isDestroyed = jest.fn().mockReturnValueOnce(true);
+            versions.xhr = null;
+
+            const successCb = jest.fn();
+            const errorCb = jest.fn();
+
+            return versions.versions('id', successCb, errorCb).catch(() => {
+                expect(successCb).not.toHaveBeenCalled();
+                expect(errorCb).not.toHaveBeenCalled();
+            });
+        });
+
+        test('should make xhr to get versions and call success callback', () => {
+            versions.xhr = {
+                get: jest.fn().mockReturnValueOnce(Promise.resolve({ data: versionsResponse }))
+            };
+
+            const successCb = jest.fn();
+
+            return versions.versions('id', successCb).then(() => {
+                expect(successCb).toHaveBeenCalledWith(versionsResponse);
+                expect(versions.xhr.get).toHaveBeenCalledWith({
+                    id: 'file_id',
+                    url: 'https://api.box.com/2.0/files/id/versions'
+                });
+            });
+        });
+
+        test('should call error callback when xhr fails', () => {
+            const error = new Error('error');
+            versions.xhr = {
+                get: jest.fn().mockReturnValueOnce(Promise.reject(error))
+            };
+
+            const successCb = jest.fn();
+            const errorCb = jest.fn();
+
+            return versions.versions('id', successCb, errorCb).then(() => {
+                expect(successCb).not.toHaveBeenCalled();
+                expect(errorCb).toHaveBeenCalledWith(error);
+                expect(versions.xhr.get).toHaveBeenCalledWith({
+                    id: 'file_id',
+                    url: 'https://api.box.com/2.0/files/id/versions'
+                });
+            });
+        });
+    });
+});