nodebb-plugin-tenor-gif 1.2.9 → 2.1.0

package/.eslintrc

@@ -1,139 +1,3 @@
 {
-	"extends": "airbnb-base",
-	"parserOptions": {
-		"sourceType": "script"
-	},
-
-	"rules": {
-		// Customized
-		"handle-callback-err": [ "error","^(e$|(e|(.*(_e|E)))rr)" ],
-		"comma-dangle": ["error", {
-			"arrays": "always-multiline",
-			"objects": "always-multiline",
-			"imports": "always-multiline",
-			"exports": "always-multiline",
-			"functions": "never"
-		}],
-		"no-return-await": "off",
-		"no-constant-condition": "off",
-		"no-empty": ["error", { "allowEmptyCatch": true }],
-		"no-underscore-dangle": "off",
-		"no-console": "off",
-		"no-mixed-operators": ["error", { "allowSamePrecedence": true }],
-		"strict": ["error", "global"],
-		"consistent-return": "off",
-		"func-names": "off",
-		"no-tabs": "off",
-		"indent": ["error", "tab"],
-		"no-eq-null": "off",
-		"camelcase": "off",
-		"no-new": "off",
-		"no-shadow": "off",
-		"no-use-before-define": ["error", "nofunc"],
-		"no-prototype-builtins": "off",
-		"new-cap": "off",
-		"no-plusplus": ["error", { "allowForLoopAfterthoughts": true }],
-		"object-curly-newline": "off",
-		"no-restricted-globals": "off",
-		"function-paren-newline": "off",
-		"import/no-unresolved": "error",
-		"quotes": ["error", "single", {
-			"avoidEscape": true,
-			"allowTemplateLiterals": true
-		}],
-		"no-else-return": [ "error", { "allowElseIf": true } ],
-		"operator-linebreak": [ "error", "after" ],
-
-		// ES6
-		"prefer-rest-params": "off",
-		"prefer-spread": "off",
-		"prefer-arrow-callback": "off",
-		"prefer-template": "off",
-		"no-var": "off",
-		"object-shorthand": "off",
-		"vars-on-top": "off",
-		"prefer-destructuring": "off",
-
-		// TODO
-		"import/no-extraneous-dependencies": "off",
-		"import/no-dynamic-require": "off",
-		"import/newline-after-import": "off",
-		"no-bitwise": "off",
-		"global-require": "off",
-		"max-len": "off",
-		"no-param-reassign": "off",
-		"no-restricted-syntax": "off",
-		"no-script-url": "off",
-		"default-case": "off",
-		"linebreak-style": "off",
-
-		// "no-multi-assign": "off",
-		// "one-var": "off",
-		// "no-undef": "off",
-		// "max-nested-callbacks": "off",
-		// "no-mixed-requires": "off",
-		// "brace-style": "off",
-		// "max-statements-per-line": "off",
-		// "no-unused-vars": "off",
-		// "no-mixed-spaces-and-tabs": "off",
-		// "no-useless-concat": "off",
-		// "require-jsdoc": "off",
-		// "eqeqeq": "off",
-		// "no-negated-condition": "off",
-		// "one-var-declaration-per-line": "off",
-		// "no-lonely-if": "off",
-		// "radix": "off",
-		// "no-else-return": "off",
-		// "no-useless-escape": "off",
-		// "block-scoped-var": "off",
-		// "operator-assignment": "off",
-		// "yoda": "off",
-		// "no-loop-func": "off",
-		// "no-void": "off",
-		// "valid-jsdoc": "off",
-		// "no-cond-assign": "off",
-		// "no-redeclare": "off",
-		// "no-unreachable": "off",
-		// "no-nested-ternary": "off",
-		// "operator-linebreak": "off",
-		// "guard-for-in": "off",
-		// "no-unneeded-ternary": "off",
-		// "no-sequences": "off",
-		// "no-extend-native": "off",
-		// "no-shadow-restricted-names": "off",
-		// "no-extra-boolean-cast": "off",
-		// "no-path-concat": "off",
-		// "no-unused-expressions": "off",
-		// "no-return-assign": "off",
-		// "no-restricted-modules": "off",
-		// "object-curly-spacing": "off",
-		// "indent": "off",
-		// "padded-blocks": "off",
-		// "eol-last": "off",
-		// "lines-around-directive": "off",
-		// "strict": "off",
-		// "comma-dangle": "off",
-		// "no-multi-spaces": "off",
-		// "quotes": "off",
-		// "keyword-spacing": "off",
-		// "no-mixed-operators": "off",
-		// "comma-spacing": "off",
-		// "no-trailing-spaces": "off",
-		// "key-spacing": "off",
-		// "no-multiple-empty-lines": "off",
-		// "spaced-comment": "off",
-		// "space-in-parens": "off",
-		// "block-spacing": "off",
-		// "quote-props": "off",
-		// "space-unary-ops": "off",
-		// "no-empty": "off",
-		// "dot-notation": "off",
-		// "func-call-spacing": "off",
-		// "array-bracket-spacing": "off",
-		// "object-property-newline": "off",
-		// "no-continue": "off",
-		// "no-extra-semi": "off",
-		// "no-spaced-func": "off",
-		// "no-useless-return": "off"
-	}
+	"extends": "nodebb"
 }

package/README.md

@@ -2,8 +2,13 @@
 
 ![Searching 'pizza' in the via modal window](/screenshot.png)
 
-This plugin adds a "GIF" button to the default composer and allows you to search and insert GIFs. It is powered by the [Tenor GIF service](https://tenor.com). Kudos to Tenor for providing a simple and easy-to-use API! ❤️
+This plugin adds a "GIF" button to the default composer and allows you to search and insert GIFs. It is powered by the [Tenor GIF service](https://tenor.com). Kudos to Tenor/Alphabet for providing a simple and easy-to-use API! ❤️
 
-Install the plugin via the admin dashboard, or `npm i nodebb-plugin-tenor-gif`. You'll need to register for a Tenor GIF API key here: https://tenor.com/developer/dashboard
+Install the plugin via the admin dashboard, or `npm i nodebb-plugin-tenor-gif`. You'll need to register for a Tenor GIF API key from the [Google Cloud Console](https://console.cloud.google.com/apis/credentials).
 
-Then insert said API, save the config, and reload/restart NodeBB.
+Then insert said API, save the config, and reload/restart NodeBB.
+
+# Migrating from v1 to v2
+
+We are now using v2 of the Tenor GIF API.
+Register for a new v2 API key from the [Google Cloud Console](https://console.cloud.google.com/apis/credentials) and replace the existing key.

package/library.js

@@ -1,39 +1,32 @@
 'use strict';
 
-var controllers = require('./lib/controllers');
-var websockets = require('./websockets');
-var meta = require.main.require('./src/meta');
-var winston = require.main.require('winston');
+const request = require('request-promise-native');
 
-var request = require('request');
+const controllers = require('./lib/controllers');
+const websockets = require('./websockets');
 
-var plugin = {
-	_settings: {
-		key: null,
-	},
-};
+const nconf = require.main.require('nconf');
+const meta = require.main.require('./src/meta');
+const slugify = require.main.require('./src/slugify');
+const cacheCreate = require.main.require('./src/cacheCreate');
+
+const plugin = module.exports;
+
+plugin._cache = cacheCreate({
+	name: 'gifs',
+	max: 20,
+	length: function (n) { return n.length; },
+	maxAge: 1000 * 60 * 60, // 1 hour
+});
 
-plugin.init = function (params, callback) {
-	var router = params.router;
-	var hostMiddleware = params.middleware;
+plugin.init = async (params) => {
+	const { router } = params;
+	const hostMiddleware = params.middleware;
 
 	router.get('/admin/plugins/tenor-gif', hostMiddleware.admin.buildHeader, controllers.renderAdminPage);
 	router.get('/api/admin/plugins/tenor-gif', controllers.renderAdminPage);
 
 	websockets.init();
-	plugin.refreshSettings(callback);
-};
-
-plugin.refreshSettings = function (callback) {
-	meta.settings.get('tenor-gif', function (err, settings) {
-		Object.assign(plugin._settings, settings);
-
-		if (!settings.key || !settings.key.length) {
-			winston.warn('[plugin/tenor-gif] Invalid or missing API Key, plugin disabled');
-		}
-
-		callback(err);
-	});
 };
 
 plugin.addAdminNavigation = function (header, callback) {
@@ -46,45 +39,58 @@ plugin.addAdminNavigation = function (header, callback) {
 	callback(null, header);
 };
 
-plugin.registerFormatting = function (payload, callback) {
-	if (plugin._settings.key) {
+plugin.registerFormatting = async (payload) => {
+	const { key } = await meta.settings.get('tenor-gif');
+	if (key) {
 		payload.options.push({ name: 'gif', className: 'fa fa-tenor-gif', title: 'Insert GIF' });
 	}
 
-	callback(null, payload);
+	return payload;
 };
 
-plugin.query = function (query, callback) {
-	request({
-		url: 'https://api.tenor.com/v1/search?q=' + query + '&key=' + plugin._settings.key,
+plugin.query = async (query) => {
+	let { contentFilter, key, limit } = await meta.settings.get('tenor-gif');
+	if (!limit || limit < 1 || limit > 50) {
+		limit = 10;
+	}
+
+	query = String(query).trim();
+	const commonArgs = `&limit=${limit}&contentfilter=${contentFilter || 'medium'}&key=${key}&client_key=nodebb-${slugify(nconf.get('url'))}`;
+	let url = `https://tenor.googleapis.com/v2/featured?type=featured${commonArgs}`;
+	if (query) {
+		url = `https://tenor.googleapis.com/v2/search?q=${query}${commonArgs}`;
+	}
+
+	let gifs = plugin._cache.get(query);
+	if (gifs) {
+		return gifs;
+	}
+
+	const body = await request({
+		url,
 		method: 'get',
 		json: true,
-	}, function (err, res, body) {
-		if (!plugin._settings.key || (body && body.hasOwnProperty('error'))) {
-			err = new Error('[[error:invalid-login-credentials]]');
-		}
-
-		// Malformed return handling
-		if (!body || !body.results) {
-			return callback(new Error('[[error:invalid-data]]'));
-		}
-
-		if (err) {
-			return callback(err);
-		}
-
-		// Collapse results down to array of images
-		var gifs = body.results.reduce(function (memo, cur) {
-			memo.push({
-				url: cur.media[0].gif.url,
-				thumb: cur.media[0].tinygif.url,
-			});
-
-			return memo;
-		}, []);
-
-		callback(null, gifs);
 	});
-};
 
-module.exports = plugin;
+	if (!key || (body && body.hasOwnProperty('error'))) {
+		throw new Error('[[error:invalid-login-credentials]]');
+	}
+
+	// Malformed return handling
+	if (!body.results) {
+		throw new Error('[[error:invalid-data]]');
+	}
+
+	// Collapse results down to array of images
+	gifs = body.results.reduce((memo, cur) => {
+		memo.push({
+			url: cur.media_formats.gif.url,
+			thumb: cur.media_formats.tinygif.url,
+		});
+
+		return memo;
+	}, []);
+
+	plugin._cache.set(query, gifs);
+	return gifs;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nodebb-plugin-tenor-gif",
-  "version": "1.2.9",
+  "version": "2.1.0",
   "description": "",
   "main": "library.js",
   "repository": {
@@ -21,20 +21,22 @@
   },
   "readmeFilename": "README.md",
   "nbbpm": {
-    "compatibility": "^1.6.0"
+    "compatibility": "^1.6.0 || ^2.0.0"
   },
   "dependencies": {
     "@commitlint/cli": "^9.1.2",
-    "eslint": "^7.7.0",
+    "eslint": "8.x",
     "lint-staged": "^10.0.9",
-    "request": "^2.88.0"
+    "request": "^2.88.0",
+    "request-promise-native": "^1.0.9"
   },
   "devDependencies": {
     "@commitlint/cli": "^9.1.2",
     "@commitlint/config-angular": "^7.1.2",
     "eslint": "^7.7.0",
-    "eslint-config-airbnb-base": "^12.1.0",
-    "eslint-plugin-import": "^2.8.0",
+    "eslint-config-airbnb-base": "^15.0.0",
+    "eslint-config-nodebb": "0.1.1",
+    "eslint-plugin-import": "2.x",
     "husky": "^2.4.0",
     "lint-staged": "^10.0.9"
   }

package/static/lib/.eslintrc

@@ -0,0 +1,3 @@
+{
+	"extends": "nodebb/public"
+}

package/static/lib/admin.js

@@ -1,7 +1,5 @@
 'use strict';
 
-/* globals $, app, socket */
-
 define('admin/plugins/tenor-gif', ['settings'], function (Settings) {
 	var ACP = {};
 
@@ -14,10 +12,7 @@ define('admin/plugins/tenor-gif', ['settings'], function (Settings) {
 					type: 'success',
 					alert_id: 'tenor-gif-saved',
 					title: 'Settings Saved',
-					message: 'Please reload your NodeBB to apply these settings',
-					clickfn: function () {
-						socket.emit('admin.reload');
-					},
+					timeout: 5000,
 				});
 			});
 		});

package/static/lib/main.js

@@ -1,7 +1,5 @@
 'use strict';
 
-/* globals $, document, window, socket, bootbox */
-
 $(document).ready(function () {
 	var Tenor = {};
 
@@ -85,10 +83,6 @@ $(document).ready(function () {
 				});
 
 				queryEl.on('keyup', function () {
-					if (!queryEl.val().length) {
-						return;
-					}
-
 					if (queryTimeout) {
 						clearTimeout(queryTimeout);
 					}
@@ -112,6 +106,9 @@ $(document).ready(function () {
 					callback(this.getAttribute('data-url'), queryEl.val());
 					modal.modal('hide');
 				});
+
+				// Start with empty query
+				queryEl.trigger('keyup');
 			});
 		});
 	};
@@ -123,10 +120,14 @@ $(document).ready(function () {
 		], function (formatting, controls) {
 			if (selectionStart === selectionEnd) {
 				controls.insertIntoTextarea(textarea, '![' + query + '](' + url + ')');
-				controls.updateTextareaSelection(textarea, selectionStart + query.length + 4, selectionEnd + query.length + url.length + 4);
+				controls.updateTextareaSelection(
+					textarea, selectionStart + query.length + 4, selectionEnd + query.length + url.length + 4
+				);
 			} else {
 				var wrapDelta = controls.wrapSelectionInTextareaWith(textarea, '![', '](' + url + ')');
-				controls.updateTextareaSelection(textarea, selectionEnd + 4 - wrapDelta[1], selectionEnd + url.length + 4 - wrapDelta[1]);
+				controls.updateTextareaSelection(
+					textarea, selectionEnd + 4 - wrapDelta[1], selectionEnd + url.length + 4 - wrapDelta[1]
+				);
 			}
 		});
 	};

package/static/templates/admin/plugins/tenor-gif.tpl

@@ -3,12 +3,28 @@
 		<div class="col-sm-2 col-xs-12 settings-header">General</div>
 		<div class="col-sm-10 col-xs-12">
 			<p class="lead">
-				Sign up for your Tenor GIF API Key at the Developer Dashboard: <a href="https://tenor.com/developer/dashboard">https://tenor.com/developer/dashboard</a>, then enter it below and reload your NodeBB.
+				Sign up for your Tenor GIF API Key from the <a href="https://console.cloud.google.com/apis/credentials">Google Cloud Console</a>, then enter it below and reload your NodeBB.
+			</p>
+			<p>
+				<strong>Be careful</strong>: If you use the <i class="fa fa-copy"></i> button to copy the API key, it'll add spaces to the beginning and end. You'll need to remove those.
 			</p>
 			<div class="form-group">
 				<label for="key">API Key</label>
 				<input type="text" id="key" name="key" title="API Key" class="form-control" placeholder="API Key">
 			</div>
+			<div class="form-group">
+				<label for="contentFilter">Content Filter</label>
+				<select class="form-control" id="contentFilter" name="contentFilter">
+					<option value="off">Off</option>
+					<option value="low">Low</option>
+					<option value="medium" selected>Medium (default)</option>
+					<option value="high">High</option>
+				</select>
+			</div>
+			<div class="form-group">
+				<label for="limit">Limit results</label>
+				<input class="form-control" type="number" min="1" max="50" id="limit" placeholder="10" name="limit" />
+			</div>
 		</div>
 	</div>
 </form>

package/websockets.js

@@ -1,13 +1,15 @@
 'use strict';
 
-var SocketPlugins = require.main.require('./src/socket.io/plugins');
+const SocketPlugins = require.main.require('./src/socket.io/plugins');
 SocketPlugins['tenor-gif'] = {};
 
 module.exports.init = function () {
-	var main = module.parent.exports;
+	const main = module.parent.exports;
 
 	SocketPlugins['tenor-gif'].query = function (socket, data, callback) {
-		main.query(data.query, callback);
+		main.query(data.query).then((gifs) => {
+			callback(null, gifs);
+		}).catch(callback);
 	};
 };