Add tool to add comp plans to members

Author: PaulAdamDavis

README.md

@@ -48,6 +48,7 @@ Available tools include:
 * [`change-visibility-pages`](#change-visibility-pages)
 * [`change-status`](#change-status)
 * [`change-role`](#change-role)
+* [`add-member-comp-subscription`](#add-member-comp-subscription)
 * [`add-member-newsletter-subscription`](#add-member-newsletter-subscription)
 * [`remove-member-newsletter-subscription`](#remove-member-newsletter-subscription)
 * [`change-tags`](#change-tags)
@@ -418,6 +419,15 @@ gctools change-role <apiURL> <adminAPIKey> --newRole 'Contributor'
 gctools change-role <apiURL> <adminAPIKey> --filterRole 'Editor' --newRole 'Author'
 ```
 
+### add-member-comp-subscription
+
+Add complimentary subscriptions for members
+
+```sh
+# Add a compliemty plan to tier ID abcdtierid1234 that expired on May 4th 2025, but only for members with the label slug 'my-member-label-slug'
+gctools add-member-comp-subscription <apiURL> <adminAPIKey> --tierId abcdtierid1234  --expireAt '2025-05-04T00:00:00.000Z' --onlyForLabelSlugs my-member-label-slug
+```
+
 ### add-member-newsletter-subscription
 
 Remove subscriptions for a specific newsletter

bin/cli.js

@@ -3,6 +3,7 @@ import prettyCLI from '@tryghost/pretty-cli';
 
 prettyCLI.preface('Command line utilities for working with Ghost content');
 
+import addMemberCompSubscriptionCommands from '../commands/add-member-comp.js';
 import addMemberNewsletterSubscriptionCommands from '../commands/add-member-newsletter-subscription.js';
 import addPreviewCommands from '../commands/add-preview.js';
 import addTagsCommands from '../commands/add-tags.js';
@@ -30,6 +31,7 @@ import changeTags from '../commands/change-tags.js';
 import revueStripe from '../commands/revue-stripe.js';
 import letterdropStripe from '../commands/letterdrop-stripe.js';
 
+prettyCLI.command(addMemberCompSubscriptionCommands);
 prettyCLI.command(addMemberNewsletterSubscriptionCommands);
 prettyCLI.command(addPreviewCommands);
 prettyCLI.command(addTagsCommands);

commands/add-member-comp.js

@@ -0,0 +1,72 @@
+import {ui} from '@tryghost/pretty-cli';
+import addMemberCompSubscription from '../tasks/add-member-comp-subscription.js';
+
+// Internal ID in case we need one.
+const id = 'add-member-comp-subscription';
+
+const group = 'Members:';
+
+// The command to run and any params
+const flags = 'add-member-comp-subscription <apiURL> <adminAPIKey>';
+
+// Description for the top level command
+const desc = 'Add member complimentary subscription';
+
+// 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('--onlyForLabelSlugs', {
+        defaultValue: null,
+        desc: 'Optional label to filter members'
+    });
+    sywac.string('--tierId', {
+        defaultValue: null,
+        desc: 'The ID for the tier to add the subscription to'
+    });
+    sywac.string('--expireAt', {
+        defaultValue: null,
+        desc: 'When the comp plan should expire in quotes, such as \'2024-05-12T00:00:00.000Z\''
+    });
+    sywac.number('--delayBetweenCalls', {
+        defaultValue: 100,
+        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 = addMemberCompSubscription.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 added ${context.updated.length} subscriptions in ${Date.now() - timer}ms.`);
+};
+
+export default {
+    id,
+    group,
+    flags,
+    desc,
+    paramsDesc,
+    setup,
+    run
+};

commands/interactive.js

@@ -109,6 +109,10 @@ const run = async () => {
                 name: tasks.deleteUnusedTags.choice.name,
                 value: tasks.deleteUnusedTags.choice.value
             },
+            {
+                name: tasks.addMemberCompSubscription.choice.name,
+                value: tasks.addMemberCompSubscription.choice.value
+            },
             {
                 name: tasks.addMemberNewsletterSubscription.choice.name,
                 value: tasks.addMemberNewsletterSubscription.choice.value

lib/admin-api-call.js

@@ -17,6 +17,33 @@ const apiAuthTokenHeaders = (options) => {
     return headers;
 };
 
+const getTiers = async (options) => {
+    const headers = apiAuthTokenHeaders(options);
+
+    let urlString = `${options.apiURL}/ghost/api/admin/tiers/?filter=type%3Apaid%2Bactive%3Atrue&limit=50`;
+
+    let response = null;
+    let results = [];
+    let pageNumber = 1;
+
+    do {
+        // Set the page number of the request
+        let urlPageChange = new URL(urlString);
+        urlPageChange.searchParams.set('page', pageNumber); // `set` adds or updates
+        urlString = urlPageChange.href;
+
+        try {
+            response = await axios.get(urlString, {headers});
+            results = results.concat(response.data.tiers);
+            pageNumber = response.data.meta.pagination.next;
+        } catch (error) {
+            return [];
+        }
+    } while (response.data.meta.pagination.next);
+
+    return results;
+};
+
 const getMemberLabels = async (options) => {
     const headers = apiAuthTokenHeaders(options);
     let urlString = `${options.apiURL}/ghost/api/admin/labels/?limit=50`;
@@ -44,5 +71,6 @@ const getMemberLabels = async (options) => {
 };
 
 export {
+    getTiers,
     getMemberLabels
 };

lib/ghost-api-choices.js

@@ -1,7 +1,28 @@
 import {discover} from './batch-ghost-discover.js';
-import {getMemberLabels} from './admin-api-call.js';
+import {getMemberLabels, getTiers} from './admin-api-call.js';
 import chalk from 'chalk';
 
+const getAPITiers = async ({returnKey = 'slug'}) => {
+    let tiers = [];
+
+    const url = process.env.GC_TOOLS_apiURL;
+    const key = process.env.GC_TOOLS_adminAPIKey;
+
+    let tiersResponse = await getTiers({
+        adminAPIKey: key,
+        apiURL: url
+    });
+
+    tiersResponse.forEach(function (tier){
+        tiers.push({
+            name: `${tier.name} ${chalk.grey(`(${tier.slug} - ${tier.id})`)}`,
+            value: (returnKey) ? tier[returnKey] : tier
+        });
+    });
+
+    return tiers;
+};
+
 const getAPIAuthorsObj = async () => {
     const url = process.env.GC_TOOLS_apiURL;
     const key = process.env.GC_TOOLS_adminAPIKey;
@@ -135,6 +156,7 @@ const getAPIMemberLabels = async ({returnKey = 'slug'}) => {
 };
 
 export {
+    getAPITiers,
     getAPIAuthorsObj,
     getAPITagsObj,
     getAPINewslettersObj,

prompts/add-member-comp-subscription.js

@@ -0,0 +1,68 @@
+import inquirer from 'inquirer';
+import inquirerDatepickerPrompt from 'inquirer-datepicker-prompt';
+inquirer.registerPrompt('datetime', inquirerDatepickerPrompt);
+import chalk from 'chalk';
+import addMemberComp from '../tasks/add-member-comp-subscription.js';
+import {getAPITiers, getAPIMemberLabels} from '../lib/ghost-api-choices.js';
+import ghostAPICreds from '../lib/ghost-api-creds.js';
+import {ui} from '@tryghost/pretty-cli';
+
+const choice = {
+    name: 'Add member complimentary subscription',
+    value: 'addMemberCompSubscription'
+};
+
+const onYearToday = new Date();
+onYearToday.setFullYear(onYearToday.getFullYear() + 1);
+
+const options = [
+    ...ghostAPICreds,
+    {
+        type: 'list',
+        name: 'onlyForLabelSlugs',
+        message: `Select member label: ${chalk.yellow('[Type to search]')}`,
+        pageSize: 20,
+        choices: function () {
+            return getAPIMemberLabels({returnKey: 'slug'});
+        }
+    },
+    {
+        type: 'list',
+        name: 'tierId',
+        message: `Select tier: ${chalk.yellow('[Type to search]')}`,
+        pageSize: 20,
+        choices: function () {
+            return getAPITiers({returnKey: 'id'});
+        }
+    },
+    {
+        type: 'datetime',
+        name: 'expireAt',
+        message: 'End date (UTC):',
+        format: ['dd', ' ', 'mmmm', ' ', 'yyyy'],
+        initial: onYearToday
+    }
+];
+
+async function run() {
+    await inquirer.prompt(options).then(async (answers) => {
+        let timer = Date.now();
+        let context = {errors: []};
+
+        answers.onlyForLabelSlugs = [answers.onlyForLabelSlugs];
+
+        try {
+            let runner = addMemberComp.getTaskRunner(answers);
+            await runner.run(context);
+            ui.log.ok(`Successfully updated ${context.updated.length} posts in ${Date.now() - timer}ms.`);
+        } catch (error) {
+            ui.log.error('Done with errors', context.errors);
+        }
+    });
+}
+
+export default {
+    choice,
+    options,
+    run
+};

prompts/index.js

@@ -19,6 +19,7 @@ import changeRole from './change-role.js';
 import contentStats from './content-stats.js';
 import dedupeMembersCsv from './dedupe-members-csv.js';
 import addMemberNewsletterSubscription from './add-member-newsletter-subscription.js';
+import addMemberCompSubscription from './add-member-comp-subscription.js';
 
 export default {
     zipSplit,
@@ -40,6 +41,7 @@ export default {
     changeStatus,
     changeRole,
     addMemberNewsletterSubscription,
+    addMemberCompSubscription,
     contentStats,
     dedupeMembersCsv
 };

tasks/add-member-comp-subscription.js

@@ -0,0 +1,111 @@
+import Promise from 'bluebird';
+import _ from 'lodash';
+import GhostAdminAPI from '@tryghost/admin-api';
+import {makeTaskRunner} from '@tryghost/listr-smart-renderer';
+import {discover} from '../lib/batch-ghost-discover.js';
+
+const initialise = (options) => {
+    return {
+        title: 'Initialising API connection',
+        task: (ctx, task) => {
+            let defaults = {
+                verbose: false,
+                delayBetweenCalls: 50
+            };
+
+            const url = options.apiURL;
+            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.updated = [];
+
+            task.output = `Initialised API connection for ${options.apiURL}`;
+        }
+    };
+};
+
+const getFullTaskList = (options) => {
+    return [
+        initialise(options),
+        {
+            title: 'Fetch members from Ghost API',
+            task: async (ctx, task) => {
+                let discoveryFilter = [];
+
+                if (options.onlyForLabelSlugs.length) {
+                    discoveryFilter.push(`label:[${options.onlyForLabelSlugs.join(',')}]`);
+                }
+
+                let discoveryOptions = {
+                    api: ctx.api,
+                    type: 'members',
+                    filter: discoveryFilter.join('+')
+                };
+
+                try {
+                    ctx.members = await discover(discoveryOptions);
+                    task.output = `Found ${ctx.members.length} members`;
+                } catch (error) {
+                    ctx.errors.push(error);
+                    throw error;
+                }
+            }
+        },
+        {
+            title: 'Updating members',
+            task: async (ctx) => {
+                let tasks = [];
+
+                await Promise.mapSeries(ctx.members, async (member) => {
+                    tasks.push({
+                        title: `Updating ${member.email}`,
+                        task: async () => {
+                            let newMemberObject = {
+                                id: member.id,
+                                tiers: [
+                                    {
+                                        id: options.tierId,
+                                        expiry_at: options.expireAt
+                                    }
+                                ]
+                            };
+
+                            try {
+                                let result = await ctx.api.members.edit(newMemberObject);
+                                ctx.updated.push(result);
+                                return Promise.delay(options.delayBetweenCalls).return(result);
+                            } catch (error) {
+                                ctx.errors.push(error);
+                                throw error;
+                            }
+                        }
+                    });
+                });
+
+                let taskOptions = options;
+                taskOptions.concurrent = 1;
+                return makeTaskRunner(tasks, taskOptions);
+            }
+        }
+    ];
+};
+
+const getTaskRunner = (options) => {
+    let tasks = [];
+
+    tasks = getFullTaskList(options);
+
+    return makeTaskRunner(tasks, Object.assign({topLevel: true}, options));
+};
+
+export default {
+    initialise,
+    getFullTaskList,
+    getTaskRunner
+};