@orbit-love/stackoverflow/src/index.js

A community project to integrate Stack Overflow interactions into Orbit workspaces

const pkg = require('../package.json')
const questions = require('./questions.js')
const answers = require('./answers.js')
const OrbitActivities = require('@orbit-love/activities')

class OrbitStackOverflow {
	constructor(orbitWorkspaceId, orbitApiKey, stackAppsKey) {
        this.credentials = this.setCredentials(orbitWorkspaceId, orbitApiKey, stackAppsKey)
        this.orbit = new OrbitActivities(this.credentials.orbitWorkspaceId, this.credentials.orbitApiKey, `community-js-stackoverflow-orbit/${pkg.version}`)
	}

    setCredentials(orbitWorkspaceId, orbitApiKey, stackAppsKey) {
        if(!(orbitWorkspaceId || process.env.ORBIT_WORKSPACE_ID)) throw new Error('You must provide an Orbit Workspace ID when initializing Orbit or by setting an ORBIT_WORKSPACE_ID environment variable')
        if(!(orbitApiKey || process.env.ORBIT_API_KEY)) throw new Error('You must provide an Orbit API Key when initializing Orbit or by setting an ORBIT_API_KEY environment variable')
        if(!(stackAppsKey || process.env.STACK_APPS_KEY)) throw new Error('You must provide a Stack Apps Key when initializing StackOverflow or by setting a STACK_APPS_KEY environment variable')
        return {
            orbitWorkspaceId: orbitWorkspaceId || process.env.ORBIT_WORKSPACE_ID,
            orbitApiKey: orbitApiKey || process.env.ORBIT_API_KEY,
            stackAppsKey: stackAppsKey || process.env.STACK_APPS_KEY
        }
    }

    getQuestions(options) {
        return questions.get({
            credentials: this.credentials,
            ...options
        })
    }

    prepareQuestions(list, type = 'orbitActivity', options) {
        return questions.prepare(list, type, options)
    }

    getAnswers(options) {
        return answers.get({
            credentials: this.credentials,
            ...options
        })
    }

    prepareAnswers(list) {
        return answers.prepare(list)
    }

    addActivities(activities) {
        return new Promise(async (resolve, reject) => {
            try {
                let stats = { added: 0, duplicates: 0, errors: [] }
                for(let activity of activities) {
                    await this.orbit.createActivity(activity)
                        .then(() => { stats.added++ })
                        .catch(err => {
                            // If the ORBIT_WORKSPACE_ID does not resolve to a workspace,
                            // throw a specific error message
                            if (err.error == 'Not found') {
                                throw new Error(
                                'No workspace found for the given ORBIT_WORKSPACE_ID.\n' +
                                'You can get your ORBIT_WORKSPACE_ID in the last part of the Orbit workspace URL, i.e. for https://app.orbit.love/my-workspace, the ID is my-workspace'
                                )
                            }
                            if(err && err.errors && err.errors.key) stats.duplicates++
                            else { stats.errors.push(err) }
                        })
                }
                resolve(stats)
            } catch(error) {
                reject(error)
            }
        })
    }
}

module.exports = OrbitStackOverflow