scrape.js

/* eslint-disable no-console */

const path = require('path')
const chalk = require('chalk')
const Promise = require('bluebird')
const request = require('request-promise')
const {
  configFromEnvOrJsonFile,
  filenameToShellVariable,
} = require('@cypress/env-or-json-file')
const { stripIndent } = require('common-tags')
const R = require('ramda')

function checkToken (token) {
  if (!token) {
    const example = JSON.stringify({
      token: 'foobarbaz',
    })

    console.log(
      chalk.red(
        stripIndent`Cannot scrape docs.
      You are missing your Circle CI API token.
      It should look like this:

        ${example}
    `
      )
    )

    throw new Error('missing token')
  }
}

function getCircleCredentials () {
  // the JSON file should have an object like
  // { "token": "abc123..." }
  // where the token is your personal API token from CircleCI
  // alternatively, put the JSON object into environment variable
  // with file shown by filenameToShellVariable(jsonFile) call
  // which is something like _circle_credentials_json
  // you can load such environment variable quickly from local terminal with
  // https://github.com/bahmutov/as-a
  const jsonFile = path.join('support', '.circle-credentials.json')
  const config = configFromEnvOrJsonFile(jsonFile)

  if (!config) {
    console.error('⛔️  Cannot find CircleCI credentials')
    console.error('Using @cypress/env-or-json-file module')
    console.error('and key', filenameToShellVariable(jsonFile))
    console.error('from file path', jsonFile)
    throw new Error('Cannot load CircleCI credentials')
  }

  return config.token
}

function scrape () {
  return Promise.resolve()
  .then(getCircleCredentials)
  .then(R.tap(checkToken))
  .then((token) => {
    // hmm, how do we trigger workflow?
    // seems this is not supported yet as of July 10th 2017
    // https://discuss.circleci.com/t/trigger-workflow-through-rest-api/13931
    return request({
      url: 'https://circleci.com/api/v1.1/project/github/cypress-io/docsearch-scraper/',
      method: 'POST',
      json: true,
      auth: {
        user: token,
      },
    }).then((body) => {
      console.log(
        '\n',
        'Started Circle CI build:',
        chalk.green(body.build_url),
        '\n'
      )
    })
  })
}

// if we're not being required
// then kick off scraping
if (!module.parent) {
  scrape()
}

module.exports = scrape