ES6: migrated "extension"

app/script/extension/GiphyContentSizes.js

@@ -0,0 +1,42 @@
+/*
+ * Wire
+ * Copyright (C) 2017 Wire Swiss GmbH
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see http://www.gnu.org/licenses/.
+ *
+ */
+
+'use strict';
+
+window.z = window.z || {};
+window.z.extension = z.extension || {};
+
+// Enum of different Giphy content sizes.
+z.extension.GiphyContentSizes = {
+  DOWNSIZED: 'downsized',
+  DOWNSIZED_LARGE: 'downsized_large',
+  DOWNSIZED_STILL: 'downsized_still',
+  FIXED_HEIGHT: 'fixed_height',
+  FIXED_HEIGHT_DOWNSAMPLED: 'fixed_height_downsampled',
+  FIXED_HEIGHT_SMALL: 'fixed_height_small',
+  FIXED_HEIGHT_SMALL_STILL: 'fixed_height_small_still',
+  FIXED_HEIGHT_STILL: 'fixed_height_still',
+  FIXED_WIDTH: 'fixed_width',
+  FIXED_WIDTH_DOWNSAMPLED: 'fixed_width_downsampled',
+  FIXED_WIDTH_SMALL: 'fixed_width_small',
+  FIXED_WIDTH_SMALL_STILL: 'fixed_width_small_still',
+  FIXED_WIDTH_STILL: 'fixed_width_still',
+  ORIGINAL: 'original',
+  ORIGINAL_STILL: 'original_still',
+};

app/script/extension/GiphyRepository.js

@@ -0,0 +1,162 @@
+/*
+ * Wire
+ * Copyright (C) 2017 Wire Swiss GmbH
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see http://www.gnu.org/licenses/.
+ *
+ */
+
+'use strict';
+
+window.z = window.z || {};
+window.z.extension = z.extension || {};
+
+z.extension.GiphyRepository = class GiphyRepository {
+  /**
+   * Construct a new Giphy Repository.
+   * @param {z.extension.GiphyService} giphy_service - Giphy REST API implementation
+   * @returns {GiphyRepository} Repository for all interactions with the giphy service
+   */
+  constructor(giphy_service) {
+    this.giphy_service = giphy_service;
+    this.logger = new z.util.Logger('z.extension.GiphyRepository', z.config.LOGGER.OPTIONS);
+    this.gif_query_cache = {};
+  }
+
+  /**
+   * Get random GIF for a word or phrase.
+   *
+   * @param {Object} options - Search options
+   * @param {string} options.tag - Search query term or phrase
+   * @param {Number} [options.retry=3] - How many retries to get the correct size
+   * @param {Number} [options.max_size=3MB] - Maximum gif size in bytes
+   * @returns {Promise} Resolves with a random matching gif
+   */
+  get_random_gif(options) {
+    options = $.extend({
+      max_size: 3 * 1024 * 1024,
+      retry: 3,
+    },
+    options);
+
+    const _get_random_gif = (retries = 0) => {
+      if (options.retry === retries) {
+        throw new Error(`Unable to fetch a proper gif within ${options.retry} retries`);
+      }
+
+      return this.giphy_service.get_random(options.tag)
+      .then(({data: random_gif}) => {
+        return this.giphy_service.get_by_id(random_gif.id);
+      })
+      .then(({data: {images, url}}) => {
+        const static_gif = images[z.extension.GiphyContentSizes.FIXED_WIDTH_STILL];
+        const animated_gif = images[z.extension.GiphyContentSizes.DOWNSIZED];
+
+        if (animated_gif.size > options.max_size) {
+          this.logger.info(`Gif size (${animated_gif.size}) is over maximum size (${animated_gif.size})`);
+          return _get_random_gif(retries + 1);
+        }
+
+        return {
+          animated: animated_gif.url,
+          static: static_gif.url,
+          url: url,
+        };
+      });
+    };
+
+    return _get_random_gif();
+  }
+
+  /**
+   * Get random GIFs for a word or phrase.
+   *
+   * @param {Object} options - Search options
+   * @param {string} options.query - Search query term or phrase
+   * @param {Number} options.number - Amount of GIFs to retrieve
+   * @param {Number} [options.max_size=3MB] - Maximum gif size in bytes
+   * @param {Boolean} [options.random=true] - Will return an randomized result
+   * @param {string} [options.sorting='recent'] - Specify sorting ('relevant' or 'recent')
+   * @returns {Promise} Resolves with gifs
+   */
+  get_gifs(options) {
+    let offset = 0;
+
+    options = $.extend({
+      max_size: 3 * 1024 * 1024,
+      number: 6,
+      random: true,
+      sorting: 'relevant',
+    }
+    , options);
+
+    if (!options.query) {
+      const error = new Error('No query specified');
+      this.logger.error(error.message, error);
+      throw error;
+    }
+
+    if (options.random) {
+      options.sorting = z.util.ArrayUtil.random_element(['recent', 'relevant']);
+
+      const total = this.gif_query_cache[options.query];
+      if (total) {
+        if (options.number >= total) {
+          offset = 0;
+        } else {
+          const range = total - options.number;
+          offset = Math.floor(Math.random() * range);
+        }
+      }
+    }
+
+    return this.giphy_service.get_search({
+      limit: 100,
+      offset: offset,
+      query: options.query,
+      sorting: options.sorting,
+    })
+    .then(({data: gifs, pagination}) => {
+      const result = [];
+
+      if (options.random) {
+        gifs = gifs.sort(function() {
+          return .5 - Math.random();
+        });
+      }
+
+      this.gif_query_cache[options.query] = pagination.total_count;
+
+      for (const gif of gifs.slice(0, options.number)) {
+        const {images} = gif;
+        const static_gif = images[z.extension.GiphyContentSizes.FIXED_WIDTH_STILL];
+        const animation_gif = images[z.extension.GiphyContentSizes.DOWNSIZED];
+
+        if (animation_gif.size <= options.max_size) {
+          result.push({
+            animated: animation_gif.url,
+            static: static_gif.url,
+            url: gif.url,
+          });
+        }
+      }
+
+      return result;
+    })
+    .catch((error) => {
+      this.logger.info(`Unable to fetch gif for query: ${options.query}`, error);
+      throw error;
+    });
+  }
+};