Add tool to get all posts and save as a JSON file

Author: PaulAdamDavis

bin/cli.js

@@ -33,6 +33,7 @@ import revueStripe from '../commands/revue-stripe.js';
 import letterdropStripe from '../commands/letterdrop-stripe.js';
 import postTiers from '../commands/post-tiers.js';
 import pageToPost from '../commands/page-to-post.js';
+import getPosts from '../commands/get-posts.js';
 
 prettyCLI.command(addMemberCompSubscriptionCommands);
 prettyCLI.command(removeMemberCompSubscriptionCommands);
@@ -64,6 +65,7 @@ prettyCLI.command(revueStripe);
 prettyCLI.command(letterdropStripe);
 prettyCLI.command(postTiers);
 prettyCLI.command(pageToPost);
+prettyCLI.command(getPosts);
 
 prettyCLI.style({
     usageCommandPlaceholder: () => '<source or utility>'

commands/get-posts.js

@@ -0,0 +1,60 @@
+import {ui} from '@tryghost/pretty-cli';
+import getPosts from '../tasks/get-posts.js';
+
+// Internal ID in case we need one.
+const id = 'get-posts';
+
+const group = 'Content:';
+
+// The command to run and any params
+const flags = 'get-posts <apiURL> <adminAPIKey>';
+
+// Description for the top level command
+const desc = 'Get all posts from 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.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 = getPosts.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 got ${context.found.length} posts in ${Date.now() - timer}ms.`);
+};
+
+export default {
+    id,
+    group,
+    flags,
+    desc,
+    paramsDesc,
+    setup,
+    run
+};

commands/interactive.js

@@ -92,6 +92,10 @@ const run = async () => {
                 name: tasks.postTiers.choice.name,
                 value: tasks.postTiers.choice.value
             },
+            {
+                name: tasks.getPosts.choice.name,
+                value: tasks.getPosts.choice.value
+            },
             new inquirer.Separator('--- Members API Utilities ---------'),
             {
                 name: tasks.addMemberCompSubscription.choice.name,

prompts/get-posts.js

@@ -0,0 +1,34 @@
+import inquirer from 'inquirer';
+import {ui} from '@tryghost/pretty-cli';
+import getPosts from '../tasks/get-posts.js';
+import ghostAPICreds from '../lib/ghost-api-creds.js';
+
+const choice = {
+    name: 'Get all posts',
+    value: 'getPosts'
+};
+
+const options = [
+    ...ghostAPICreds
+];
+
+async function run() {
+    await inquirer.prompt(options).then(async (answers) => {
+        let timer = Date.now();
+        let context = {errors: []};
+
+        try {
+            let runner = getPosts.getTaskRunner(answers);
+            await runner.run(context);
+            ui.log.ok(`Successfully got ${context.found.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

@@ -1,3 +1,5 @@
+/* eslint-disable max-lines */
+
 import zipSplit from './zip-split.js';
 import zipCreate from './zip-create.js';
 import jsonSplit from './json-split.js';
@@ -22,6 +24,7 @@ import addMemberNewsletterSubscription from './add-member-newsletter-subscriptio
 import addMemberCompSubscription from './add-member-comp-subscription.js';
 import removeMemberCompSubscription from './remove-member-comp-subscription.js';
 import postTiers from './post-tiers.js';
+import getPosts from './get-posts.js';
 
 export default {
     zipSplit,
@@ -47,5 +50,6 @@ export default {
     removeMemberCompSubscription,
     contentStats,
     dedupeMembersCsv,
-    postTiers
+    postTiers,
+    getPosts
 };

tasks/get-posts.js

@@ -0,0 +1,82 @@
+import fsUtils from '@tryghost/mg-fs-utils';
+import GhostAdminAPI from '@tryghost/admin-api';
+import {makeTaskRunner} from '@tryghost/listr-smart-renderer';
+import _ from 'lodash';
+import {discover} from '../lib/batch-ghost-discover.js';
+
+const initialise = (options) => {
+    return {
+        title: 'Initialising API connection',
+        task: (ctx, task) => {
+            let defaults = {
+                verbose: false,
+                tag: false,
+                author: 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.fileCache = new fsUtils.FileCache(options.apiURL);
+            ctx.args = _.mergeWith(defaults, options);
+            ctx.api = api;
+            ctx.posts = [];
+            ctx.found = 0;
+
+            task.output = `Workspace initialised at ${ctx.fileCache.cacheDir}`;
+        }
+    };
+};
+
+const getFullTaskList = (options) => {
+    return [
+        initialise(options),
+        {
+            title: 'Fetch Post Content from Ghost API',
+            task: async (ctx, task) => {
+                let postDiscoveryOptions = {
+                    api: ctx.api,
+                    type: 'posts',
+                    limit: 100,
+                    include: 'tags,authors',
+                    progress: (options.verbose) ? true : false
+                };
+
+                try {
+                    ctx.posts = await discover(postDiscoveryOptions);
+                    task.output = `Found ${ctx.posts.length} posts`;
+                } catch (error) {
+                    ctx.errors.push(error);
+                    throw error;
+                }
+            }
+        },
+        {
+            title: 'Saving as JSON file',
+            task: async (ctx) => {
+                await ctx.fileCache.saveFile(`${ctx.fileCache.tmpDir}/posts.json`, JSON.stringify({posts: ctx.posts}, null, 2));
+                ctx.found = ctx.posts.length;
+            }
+        }
+    ];
+};
+
+const getTaskRunner = (options) => {
+    let tasks = [];
+
+    tasks = getFullTaskList(options);
+
+    return makeTaskRunner(tasks, Object.assign({topLevel: true}, options));
+};
+
+export default {
+    initialise,
+    getFullTaskList,
+    getTaskRunner
+};