Add tool to delete member labels

Author: PaulAdamDavis

README.md

@@ -290,6 +290,18 @@ gctools delete-tags --help
 gctools delete-tags <apiURL> <adminAPIKey> --tags hash-gctools, test 1
 ```
 
+### delete-labels
+
+Delete member labels
+
+```sh
+# See all available options
+gctools delete-labels --help
+
+# Delete a specific tag or multiple labels
+gctools delete-labels <apiURL> <adminAPIKey> --labels 'First' 'Second'
+```
+
 
 ### delete-empty-tags
 

bin/cli.js

@@ -21,6 +21,7 @@ import deleteUnusedTagsCommands from '../commands/delete-unused-tags.js';
 import deletePagesCommands from '../commands/delete-pages.js';
 import deletePostsCommands from '../commands/delete-posts.js';
 import deleteTagsCommands from '../commands/delete-tags.js';
+import deleteLabelsCommands from '../commands/delete-labels.js';
 import fetchAssetsCommands from '../commands/fetch-assets.js';
 import findReplaceCommands from '../commands/find-replace.js';
 import interactiveCommands from '../commands/interactive.js';
@@ -55,6 +56,7 @@ prettyCLI.command(deleteUnusedTagsCommands);
 prettyCLI.command(deletePagesCommands);
 prettyCLI.command(deletePostsCommands);
 prettyCLI.command(deleteTagsCommands);
+prettyCLI.command(deleteLabelsCommands);
 prettyCLI.command(fetchAssetsCommands);
 prettyCLI.command(findReplaceCommands);
 prettyCLI.command(interactiveCommands);

commands/delete-labels.js

@@ -0,0 +1,64 @@
+import {ui} from '@tryghost/pretty-cli';
+import deleteLabels from '../tasks/delete-labels.js';
+
+// Internal ID in case we need one.
+const id = 'delete-labels';
+
+const group = 'Members:';
+
+// The command to run and any params
+const flags = 'delete-labels <apiURL> <adminAPIKey>';
+
+// Description for the top level command
+const desc = 'Delete labels in Ghost';
+
+// Descriptions for the individual params
+const paramsDesc = [
+    'URL to your Ghost API',
+    'Admin API key'
+];
+
+// Configure all the options
+const setup = (sywac) => {
+    sywac.boolean('-V --verbose', {
+        defaultValue: false,
+        desc: 'Show verbose output'
+    });
+    sywac.array('--labels', {
+        defaultValue: null,
+        desc: 'Name of the label to delete, in the format \'First\' \'Second\''
+    });
+    sywac.number('--delayBetweenCalls', {
+        defaultValue: 50,
+        desc: 'The delay between API calls, in ms'
+    });
+};
+
+// What to do when this command is executed
+const run = async (argv) => {
+    let timer = Date.now();
+    let context = {errors: []};
+
+    try {
+        // Fetch the tasks, configured correctly according to the options passed in
+        let runner = deleteLabels.getTaskRunner(argv);
+
+        // Run the migration
+        await runner.run(context);
+    } catch (error) {
+        ui.log.error('Done with errors', context.errors);
+    }
+
+    // Report success
+    ui.log.ok(`Successfully deleted ${context.deleted.length} labels in ${Date.now() - timer}ms.`);
+};
+
+export default {
+    id,
+    group,
+    flags,
+    desc,
+    paramsDesc,
+    setup,
+    run
+};

commands/interactive.js

@@ -121,6 +121,10 @@ const run = async () => {
                 name: tasks.dedupeMembersCsv.choice.name,
                 value: tasks.dedupeMembersCsv.choice.value
             },
+            {
+                name: tasks.deleteLabels.choice.name,
+                value: tasks.deleteLabels.choice.value
+            },
             new inquirer.Separator('--- Dangerous API Utilities -------'),
             {
                 name: tasks.deletePosts.choice.name,

lib/admin-api-call.js

@@ -71,6 +71,7 @@ const getMemberLabels = async (options) => {
 };
 
 export {
+    apiAuthTokenHeaders,
     getTiers,
     getMemberLabels
 };

lib/ghost-api-choices.js

@@ -134,11 +134,11 @@ const getAPIRolesObj = async () => {
     ];
 };
 
-const getAPIMemberLabels = async ({returnKey = 'slug'}) => {
+const getAPIMemberLabels = async ({returnKey = 'slug', options}) => {
     let labels = [];
 
-    const url = process.env.GC_TOOLS_apiURL;
-    const key = process.env.GC_TOOLS_adminAPIKey;
+    const url = options?.apiURL ?? process.env.GC_TOOLS_apiURL;
+    const key = options?.adminAPIKey ?? process.env.GC_TOOLS_adminAPIKey;
 
     let labelsResponse = await getMemberLabels({
         adminAPIKey: key,

prompts/delete-labels.js

@@ -0,0 +1,47 @@
+import inquirer from 'inquirer';
+import inquirerSearchCheckbox from 'inquirer-search-checkbox';
+inquirer.registerPrompt('search-checkbox', inquirerSearchCheckbox);
+import {ui} from '@tryghost/pretty-cli';
+import chalk from 'chalk';
+import deleteLabels from '../tasks/delete-labels.js';
+import {getAPIMemberLabels} from '../lib/ghost-api-choices.js';
+import ghostAPICreds from '../lib/ghost-api-creds.js';
+
+const choice = {
+    name: 'Delete labels',
+    value: 'deleteLabels'
+};
+
+const options = [
+    ...ghostAPICreds,
+    {
+        type: 'search-checkbox',
+        name: 'labels',
+        message: `Select labels: ${chalk.yellow('[Type to search]')}`,
+        pageSize: 20,
+        choices: function () {
+            return getAPIMemberLabels({returnKey: false});
+        }
+    }
+];
+
+async function run() {
+    await inquirer.prompt(options).then(async (answers) => {
+        let timer = Date.now();
+        let context = {errors: []};
+
+        try {
+            let runner = deleteLabels.getTaskRunner(answers);
+            await runner.run(context);
+            ui.log.ok(`Successfully deleted ${context.deleted.length} labels in ${Date.now() - timer}ms.`);
+        } catch (error) {
+            ui.log.error('Done with errors', context.errors);
+        }
+    });
+}
+
+export default {
+    choice,
+    options,
+    run
+};

prompts/index.js

@@ -11,6 +11,7 @@ import addTags from './add-tags.js';
 import combineTags from './combine-tags.js';
 import addPreview from './add-preview.js';
 import deleteTags from './delete-tags.js';
+import deleteLabels from './delete-labels.js';
 import deleteUnusedTags from './delete-unused-tags.js';
 import findReplace from './find-replace.js';
 import changeAuthor from './change-author.js';
@@ -40,6 +41,7 @@ export default {
     combineTags,
     addPreview,
     deleteTags,
+    deleteLabels,
     deleteUnusedTags,
     findReplace,
     changeAuthor,

tasks/delete-labels.js

@@ -0,0 +1,114 @@
+import Promise from 'bluebird';
+import axios from 'axios';
+import GhostAdminAPI from '@tryghost/admin-api';
+import {makeTaskRunner} from '@tryghost/listr-smart-renderer';
+import _ from 'lodash';
+import {apiAuthTokenHeaders} from '../lib/admin-api-call.js';
+import {getAPIMemberLabels} from '../lib/ghost-api-choices.js';
+
+const initialise = (options) => {
+    return {
+        title: 'Initialising API connection',
+        task: (ctx, task) => {
+            let defaults = {
+                verbose: false,
+                labels: false,
+                delayBetweenCalls: 50
+            };
+
+            const url = options.apiURL.replace(/\/$/, '');
+            const key = options.adminAPIKey;
+            const api = new GhostAdminAPI({
+                url: url.replace('localhost', '127.0.0.1'),
+                key,
+                version: 'v5.0'
+            });
+
+            ctx.args = _.mergeWith(defaults, options);
+            ctx.api = api;
+            ctx.labels = [];
+            ctx.deleted = [];
+
+            task.output = `Initialised API connection for ${options.apiURL}`;
+        }
+    };
+};
+
+const getFullTaskList = (options) => {
+    return [
+        initialise(options),
+        {
+            title: 'Fetch labels from Ghost API',
+            task: async (ctx) => {
+                if (ctx.args.labels[0].id) {
+                    ctx.labels = ctx.args.labels;
+                } else {
+                    const allLabels = await getAPIMemberLabels({returnKey: false, options});
+
+                    ctx.args.labels.forEach((label) => {
+                        let labelsObject = allLabels.find((labelObj) => {
+                            return labelObj.value.name === label;
+                        });
+
+                        if (labelsObject) {
+                            ctx.labels.push(labelsObject.value);
+                        } else {
+                            ctx.errors.push(`No label found for "${label}"`);
+                        }
+                    });
+                }
+            }
+        },
+        {
+            title: 'Deleting labels from Ghost',
+            skip: (ctx) => {
+                return ctx.labels.length === 0;
+            },
+            task: async (ctx) => {
+                let tasks = [];
+
+                const headers = apiAuthTokenHeaders(options);
+
+                await Promise.mapSeries(ctx.labels, async (label) => {
+                    tasks.push({
+                        title: `Delete label ${label.name}`,
+                        task: async () => {
+                            let urlString = `${options.apiURL}/ghost/api/admin/labels/${label.id}/`;
+
+                            try {
+                                let result = await axios.delete(urlString, {headers});
+                                ctx.deleted.push(label.name);
+                                return Promise.delay(options.delayBetweenCalls).return(result);
+                            } catch (error) {
+                                error.resource = {
+                                    name: label.name
+                                };
+                                error.object = label;
+                                ctx.errors.push(error);
+                                throw error;
+                            }
+                        }
+                    });
+                });
+
+                let taskOptions = options;
+                taskOptions.concurrent = 3;
+                return makeTaskRunner(tasks, taskOptions);
+            }
+        }
+    ];
+};
+
+const getTaskRunner = (options) => {
+    let tasks = [];
+
+    tasks = getFullTaskList(options);
+
+    return makeTaskRunner(tasks, Object.assign({topLevel: true}, {...options, verbose: true}));
+};
+
+export default {
+    initialise,
+    getFullTaskList,
+    getTaskRunner
+};