@webex/internal-plugin-avatar 2.59.2 → 2.59.3-next.1

package/src/avatar.js

@@ -1,148 +1,148 @@
-/*!
- * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
- */
-
-import {oneFlight} from '@webex/common';
-import {detectFileType, processImage} from '@webex/helper-image';
-import {WebexPlugin} from '@webex/webex-core';
-import {defaults} from 'lodash';
-
-import AvatarUrlStore from './avatar-url-store';
-import AvatarUrlBatcher from './avatar-url-batcher';
-
-const Avatar = WebexPlugin.extend({
-  namespace: 'Avatar',
-
-  children: {
-    batcher: AvatarUrlBatcher,
-  },
-
-  session: {
-    store: {
-      default() {
-        return new AvatarUrlStore();
-      },
-      type: 'any',
-    },
-    enableThumbnails: {
-      default: true,
-      type: 'boolean',
-    },
-  },
-
-  @oneFlight({keyFactory: (uuid) => uuid})
-  _fetchAllAvatarUrlSizes(uuid, options) {
-    // fetch all possible sizes of avatar and store in cache
-    return Promise.all(
-      this.config.sizes.map((size) =>
-        this.batcher
-          .request({uuid, size})
-          .then((item) => this.store.add(defaults({cacheControl: options.cacheControl}, item)))
-      )
-    );
-  },
-
-  /**
-   * @private
-   * Requests an avatar URL from the api
-   * @param {string} uuid
-   * @param {Object} options
-   * @param {integer} options.size
-   * @param {integer} options.cacheControl
-   * @returns {Promise<string>} the avatar URL
-   */
-  @oneFlight({keyFactory: (uuid, options) => uuid + String(options && options.size)})
-  _fetchAvatarUrl(uuid, options) {
-    return this.store.get({uuid, size: options.size}).catch(() =>
-      Promise.all([
-        this._fetchAllAvatarUrlSizes(uuid, options),
-        // just in case options.size does not fall into the predefined values above
-        this.batcher.request({uuid, size: options.size}),
-      ])
-        // eslint-disable-next-line no-unused-vars
-        .then(([ignore, item]) =>
-          this.store.add(defaults({cacheControl: options.cacheControl}, item))
-        )
-    );
-  },
-
-  /**
-   * Retrieves an Avatar from a cache or the api on misses.
-   *
-   * @param {UserObject|string} user The user, Webex user uuid, or email
-   * @param {Object} [options]
-   * @param {integer} [options.size] In {1600, 640, 192, 135, 110, 80, 50, 40}
-   *                                 Defaults to 80 if falsy
-   * @param {boolean} [options.hideDefaultAvatar] does not return default avatar url if true. Defaults to false
-   * @returns {Promise<string>} A promise that resolves to the avatar
-   */
-  retrieveAvatarUrl(user, options) {
-    if (!user) {
-      return Promise.reject(new Error("'user' is a required parameter"));
-    }
-
-    options = defaults(options, {
-      cacheControl: this.config.cacheControl,
-      size: this.config.defaultAvatarSize,
-    });
-
-    return this.webex.internal.user
-      .asUUID(user)
-      .then((uuid) => this._fetchAvatarUrl(uuid, options))
-      .then((item) => {
-        if (options.hideDefaultAvatar) {
-          return item.hasDefaultAvatar ? null : item.url;
-        }
-
-        return item.url;
-      });
-  },
-
-  /**
-   * Upload a new avatar for the current user
-   *
-   * @param {Blob|File|Buffer} file The new avatar
-   * @returns {Promise} Resolves with the URL of the full-sized avatar
-   */
-  setAvatar(file) {
-    return detectFileType(file, this.logger)
-      .then((type) =>
-        processImage({
-          file,
-          type,
-          thumbnailMaxWidth: this.config.thumbnailMaxWidth,
-          thumbnailMaxHeight: this.config.thumbnailMaxHeight,
-          enableThumbnails: this.enableThumbnails,
-          logger: this.logger,
-          isAvatar: true,
-        })
-      )
-      .then((processedImage) =>
-        this.upload({
-          api: 'avatar',
-          resource: `profile/${this.webex.internal.device.userId}/session`,
-          file: processedImage[0],
-          phases: {
-            upload: {
-              $uri: (session) => session.url,
-            },
-            finalize: {
-              method: 'PUT',
-              api: 'avatar',
-              $resource: (session) =>
-                // eslint-disable-next-line max-len
-                `profile/${this.webex.internal.device.userId}/session/${session.id}`,
-            },
-          },
-        })
-      )
-      .then((res) => {
-        // invalidate user's cached avatar
-        this.store.remove({uuid: this.webex.internal.device.userId});
-
-        return res.url;
-      });
-  },
-});
-
-export default Avatar;
+/*!
+ * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
+ */
+
+import {oneFlight} from '@webex/common';
+import {detectFileType, processImage} from '@webex/helper-image';
+import {WebexPlugin} from '@webex/webex-core';
+import {defaults} from 'lodash';
+
+import AvatarUrlStore from './avatar-url-store';
+import AvatarUrlBatcher from './avatar-url-batcher';
+
+const Avatar = WebexPlugin.extend({
+  namespace: 'Avatar',
+
+  children: {
+    batcher: AvatarUrlBatcher,
+  },
+
+  session: {
+    store: {
+      default() {
+        return new AvatarUrlStore();
+      },
+      type: 'any',
+    },
+    enableThumbnails: {
+      default: true,
+      type: 'boolean',
+    },
+  },
+
+  @oneFlight({keyFactory: (uuid) => uuid})
+  _fetchAllAvatarUrlSizes(uuid, options) {
+    // fetch all possible sizes of avatar and store in cache
+    return Promise.all(
+      this.config.sizes.map((size) =>
+        this.batcher
+          .request({uuid, size})
+          .then((item) => this.store.add(defaults({cacheControl: options.cacheControl}, item)))
+      )
+    );
+  },
+
+  /**
+   * @private
+   * Requests an avatar URL from the api
+   * @param {string} uuid
+   * @param {Object} options
+   * @param {integer} options.size
+   * @param {integer} options.cacheControl
+   * @returns {Promise<string>} the avatar URL
+   */
+  @oneFlight({keyFactory: (uuid, options) => uuid + String(options && options.size)})
+  _fetchAvatarUrl(uuid, options) {
+    return this.store.get({uuid, size: options.size}).catch(() =>
+      Promise.all([
+        this._fetchAllAvatarUrlSizes(uuid, options),
+        // just in case options.size does not fall into the predefined values above
+        this.batcher.request({uuid, size: options.size}),
+      ])
+        // eslint-disable-next-line no-unused-vars
+        .then(([ignore, item]) =>
+          this.store.add(defaults({cacheControl: options.cacheControl}, item))
+        )
+    );
+  },
+
+  /**
+   * Retrieves an Avatar from a cache or the api on misses.
+   *
+   * @param {UserObject|string} user The user, Webex user uuid, or email
+   * @param {Object} [options]
+   * @param {integer} [options.size] In {1600, 640, 192, 135, 110, 80, 50, 40}
+   *                                 Defaults to 80 if falsy
+   * @param {boolean} [options.hideDefaultAvatar] does not return default avatar url if true. Defaults to false
+   * @returns {Promise<string>} A promise that resolves to the avatar
+   */
+  retrieveAvatarUrl(user, options) {
+    if (!user) {
+      return Promise.reject(new Error("'user' is a required parameter"));
+    }
+
+    options = defaults(options, {
+      cacheControl: this.config.cacheControl,
+      size: this.config.defaultAvatarSize,
+    });
+
+    return this.webex.internal.user
+      .asUUID(user)
+      .then((uuid) => this._fetchAvatarUrl(uuid, options))
+      .then((item) => {
+        if (options.hideDefaultAvatar) {
+          return item.hasDefaultAvatar ? null : item.url;
+        }
+
+        return item.url;
+      });
+  },
+
+  /**
+   * Upload a new avatar for the current user
+   *
+   * @param {Blob|File|Buffer} file The new avatar
+   * @returns {Promise} Resolves with the URL of the full-sized avatar
+   */
+  setAvatar(file) {
+    return detectFileType(file, this.logger)
+      .then((type) =>
+        processImage({
+          file,
+          type,
+          thumbnailMaxWidth: this.config.thumbnailMaxWidth,
+          thumbnailMaxHeight: this.config.thumbnailMaxHeight,
+          enableThumbnails: this.enableThumbnails,
+          logger: this.logger,
+          isAvatar: true,
+        })
+      )
+      .then((processedImage) =>
+        this.upload({
+          api: 'avatar',
+          resource: `profile/${this.webex.internal.device.userId}/session`,
+          file: processedImage[0],
+          phases: {
+            upload: {
+              $uri: (session) => session.url,
+            },
+            finalize: {
+              method: 'PUT',
+              api: 'avatar',
+              $resource: (session) =>
+                // eslint-disable-next-line max-len
+                `profile/${this.webex.internal.device.userId}/session/${session.id}`,
+            },
+          },
+        })
+      )
+      .then((res) => {
+        // invalidate user's cached avatar
+        this.store.remove({uuid: this.webex.internal.device.userId});
+
+        return res.url;
+      });
+  },
+});
+
+export default Avatar;

package/src/config.js

@@ -1,33 +1,33 @@
-/*!
- * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
- */
-
-export default {
-  avatar: {
-    batcherWait: 100,
-    batcherMaxCalls: 100,
-    batcherMaxWait: 1500,
-
-    /**
-     * @description avatar URL store TTL, allows avatar updates to eventually be propegated
-     * @type {number} Number of seconds the avatar should remain in store
-     */
-    cacheControl: 60 * 60,
-    /**
-     * @description default avatar size to retrieve if no size is specified
-     * @type {number}
-     */
-    defaultAvatarSize: 80,
-    sizes: [40, 50, 80, 110, 135, 192, 640, 1600],
-    /**
-     * Max height for thumbnails generated when sharing an image
-     * @type {number}
-     */
-    thumbnailMaxHeight: 960,
-    /**
-     * Max width for thumbnails generated when sharing an image
-     * @type {number}
-     */
-    thumbnailMaxWidth: 640,
-  },
-};
+/*!
+ * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
+ */
+
+export default {
+  avatar: {
+    batcherWait: 100,
+    batcherMaxCalls: 100,
+    batcherMaxWait: 1500,
+
+    /**
+     * @description avatar URL store TTL, allows avatar updates to eventually be propegated
+     * @type {number} Number of seconds the avatar should remain in store
+     */
+    cacheControl: 60 * 60,
+    /**
+     * @description default avatar size to retrieve if no size is specified
+     * @type {number}
+     */
+    defaultAvatarSize: 80,
+    sizes: [40, 50, 80, 110, 135, 192, 640, 1600],
+    /**
+     * Max height for thumbnails generated when sharing an image
+     * @type {number}
+     */
+    thumbnailMaxHeight: 960,
+    /**
+     * Max width for thumbnails generated when sharing an image
+     * @type {number}
+     */
+    thumbnailMaxWidth: 640,
+  },
+};

package/src/index.js

@@ -1,17 +1,17 @@
-/*!
- * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
- */
-
-import '@webex/internal-plugin-user';
-import '@webex/internal-plugin-device';
-
-import {registerInternalPlugin} from '@webex/webex-core';
-
-import Avatar from './avatar';
-import config from './config';
-
-registerInternalPlugin('avatar', Avatar, {
-  config,
-});
-
-export {default} from './avatar';
+/*!
+ * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
+ */
+
+import '@webex/internal-plugin-user';
+import '@webex/internal-plugin-device';
+
+import {registerInternalPlugin} from '@webex/webex-core';
+
+import Avatar from './avatar';
+import config from './config';
+
+registerInternalPlugin('avatar', Avatar, {
+  config,
+});
+
+export {default} from './avatar';

package/test/integration/spec/avatar.js

@@ -1,82 +1,82 @@
-/*!
- * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
- */
-
-import '@webex/internal-plugin-avatar';
-
-// import {assert} from '@webex/test-helper-chai';
-// import sinon from 'sinon';
-import fh from '@webex/test-helper-file';
-import WebexCore from '@webex/webex-core';
-import testUsers from '@webex/test-helper-test-users';
-
-describe('plugin-avatar', () => {
-  let mccoy, webex, spock;
-
-  before('create users', () =>
-    testUsers.create({count: 2}).then((users) => {
-      [spock, mccoy] = users;
-
-      webex = new WebexCore({
-        credentials: {
-          authorization: spock.token,
-        },
-      });
-
-      mccoy.webex = new WebexCore({
-        credentials: {
-          authorization: mccoy.token,
-        },
-      });
-    })
-  );
-
-  before('register with wdm', () =>
-    Promise.all([webex.internal.device.register(), mccoy.webex.internal.device.register()])
-  );
-
-  let sampleImageSmallOnePng = 'sample-image-small-one.png';
-
-  before(() =>
-    fh.fetch(sampleImageSmallOnePng).then((file) => {
-      sampleImageSmallOnePng = file;
-    })
-  );
-
-  // describe('#setAvatar()', () => {
-  //   it('sets a user\'s avatar', () => webex.internal.avatar.setAvatar(sampleImageSmallOnePng)
-  //     .then((avatarUrl) => {
-  //       // Note: not downloading the avatar because rackspace CDN is too flaky
-  //       assert.isDefined(avatarUrl);
-  //       assert.match(avatarUrl, /^https?:\/\//);
-  //     }));
-  //
-  //   it('invalidates current user`s cached avatar after uploading a new one', () => {
-  //     webex.internal.avatar.store.remove = sinon.spy();
-  //     return webex.internal.avatar.setAvatar(sampleImageSmallOnePng)
-  //       .then(() => assert.calledWith(webex.internal.avatar.store.remove, {uuid: webex.internal.device.userId}));
-  //   });
-  // });
-  //
-  //
-  // describe('#retrieveAvatarUrl()', () => {
-  //   before(() => Promise.all([
-  //     webex.internal.avatar.setAvatar(sampleImageSmallOnePng),
-  //     mccoy.webex.internal.avatar.setAvatar(sampleImageSmallOnePng)
-  //   ]));
-  //
-  //   it('retrieves an avatar url by email address', () => webex.internal.avatar.retrieveAvatarUrl(spock.email)
-  //     .then((avatarUrl) => {
-  //       // Note: not downloading the avatar because rackspace CDN is too flaky
-  //       assert.isDefined(avatarUrl);
-  //       assert.match(avatarUrl, /^https?:\/\//);
-  //     }));
-  //
-  //   it('retrieves an avatar url by uuid', () => webex.internal.avatar.retrieveAvatarUrl(mccoy.webex.internal.device.userId)
-  //     .then((avatarUrl) => {
-  //       // Note: not downloading the avatar because rackspace CDN is too flaky
-  //       assert.isDefined(avatarUrl);
-  //       assert.match(avatarUrl, /^https?:\/\//);
-  //     }));
-  // });
-});
+/*!
+ * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
+ */
+
+import '@webex/internal-plugin-avatar';
+
+// import {assert} from '@webex/test-helper-chai';
+// import sinon from 'sinon';
+import fh from '@webex/test-helper-file';
+import WebexCore from '@webex/webex-core';
+import testUsers from '@webex/test-helper-test-users';
+
+describe('plugin-avatar', () => {
+  let mccoy, webex, spock;
+
+  before('create users', () =>
+    testUsers.create({count: 2}).then((users) => {
+      [spock, mccoy] = users;
+
+      webex = new WebexCore({
+        credentials: {
+          authorization: spock.token,
+        },
+      });
+
+      mccoy.webex = new WebexCore({
+        credentials: {
+          authorization: mccoy.token,
+        },
+      });
+    })
+  );
+
+  before('register with wdm', () =>
+    Promise.all([webex.internal.device.register(), mccoy.webex.internal.device.register()])
+  );
+
+  let sampleImageSmallOnePng = 'sample-image-small-one.png';
+
+  before(() =>
+    fh.fetch(sampleImageSmallOnePng).then((file) => {
+      sampleImageSmallOnePng = file;
+    })
+  );
+
+  // describe('#setAvatar()', () => {
+  //   it('sets a user\'s avatar', () => webex.internal.avatar.setAvatar(sampleImageSmallOnePng)
+  //     .then((avatarUrl) => {
+  //       // Note: not downloading the avatar because rackspace CDN is too flaky
+  //       assert.isDefined(avatarUrl);
+  //       assert.match(avatarUrl, /^https?:\/\//);
+  //     }));
+  //
+  //   it('invalidates current user`s cached avatar after uploading a new one', () => {
+  //     webex.internal.avatar.store.remove = sinon.spy();
+  //     return webex.internal.avatar.setAvatar(sampleImageSmallOnePng)
+  //       .then(() => assert.calledWith(webex.internal.avatar.store.remove, {uuid: webex.internal.device.userId}));
+  //   });
+  // });
+  //
+  //
+  // describe('#retrieveAvatarUrl()', () => {
+  //   before(() => Promise.all([
+  //     webex.internal.avatar.setAvatar(sampleImageSmallOnePng),
+  //     mccoy.webex.internal.avatar.setAvatar(sampleImageSmallOnePng)
+  //   ]));
+  //
+  //   it('retrieves an avatar url by email address', () => webex.internal.avatar.retrieveAvatarUrl(spock.email)
+  //     .then((avatarUrl) => {
+  //       // Note: not downloading the avatar because rackspace CDN is too flaky
+  //       assert.isDefined(avatarUrl);
+  //       assert.match(avatarUrl, /^https?:\/\//);
+  //     }));
+  //
+  //   it('retrieves an avatar url by uuid', () => webex.internal.avatar.retrieveAvatarUrl(mccoy.webex.internal.device.userId)
+  //     .then((avatarUrl) => {
+  //       // Note: not downloading the avatar because rackspace CDN is too flaky
+  //       assert.isDefined(avatarUrl);
+  //       assert.match(avatarUrl, /^https?:\/\//);
+  //     }));
+  // });
+});