shields/services/discourse/discourse.service.js

'use strict'

const camelcase = require('camelcase')
const Joi = require('@hapi/joi')
const { metric } = require('../text-formatters')
const { nonNegativeInteger, optionalUrl } = require('../validators')
const { BaseJsonService } = require('..')

const schema = Joi.object({
  topic_count: nonNegativeInteger,
  user_count: nonNegativeInteger,
  post_count: nonNegativeInteger,
  like_count: nonNegativeInteger,
}).required()

const queryParamSchema = Joi.object({
  server: optionalUrl.required(),
}).required()

class DiscourseBase extends BaseJsonService {
  static get category() {
    return 'chat'
  }

  static buildRoute(metric) {
    return {
      base: 'discourse',
      pattern: metric,
      queryParamSchema,
    }
  }

  static get defaultBadgeData() {
    return { label: 'discourse' }
  }

  async fetch({ server }) {
    return this._requestJson({
      schema,
      url: `${server}/site/statistics.json`,
    })
  }
}

function DiscourseMetricIntegrationFactory({ metricName, property }) {
  return class DiscourseMetric extends DiscourseBase {
    static get name() {
      // The space is needed so we get 'DiscourseTopics' rather than
      // 'Discoursetopics'. `camelcase()` removes it.
      return camelcase(`Discourse ${metricName}`, { pascalCase: true })
    }

    static get route() {
      return this.buildRoute(metricName)
    }

    static get examples() {
      return [
        {
          title: `Discourse ${metricName}`,
          namedParams: {},
          queryParams: {
            server: 'https://meta.discourse.org',
          },
          staticPreview: this.render({ stat: 100 }),
        },
      ]
    }

    static render({ stat }) {
      return {
        message: `${metric(stat)} ${metricName}`,
        color: 'brightgreen',
      }
    }

    async handle(_routeParams, { server }) {
      const data = await this.fetch({ server })
      return this.constructor.render({ stat: data[property] })
    }
  }
}

class DiscourseStatus extends DiscourseBase {
  static get route() {
    return this.buildRoute('status')
  }

  static get examples() {
    return [
      {
        title: `Discourse status`,
        namedParams: {},
        queryParams: {
          server: 'https://meta.discourse.org',
        },
        staticPreview: this.render(),
      },
    ]
  }

  static render() {
    return {
      message: 'online',
      color: 'brightgreen',
    }
  }

  async handle(_routeParams, { server }) {
    await this.fetch({ server })
    // if fetch() worked, the server is up
    // if it failed, we'll show an error e.g: 'inaccessible'
    return this.constructor.render()
  }
}

const metricIntegrations = [
  { metricName: 'topics', property: 'topic_count' },
  { metricName: 'users', property: 'user_count' },
  { metricName: 'posts', property: 'post_count' },
  { metricName: 'likes', property: 'like_count' },
].map(DiscourseMetricIntegrationFactory)

module.exports = [...metricIntegrations, DiscourseStatus]