shields/services/reddit/user-karma.service.js

import Joi from 'joi'
import { anyInteger } from '../validators.js'
import { metric } from '../text-formatters.js'
import { pathParams } from '../index.js'
import RedditBase from './reddit-base.js'

const schema = Joi.object({
  data: Joi.object({
    link_karma: anyInteger,
    comment_karma: anyInteger,
  }).required(),
}).required()

export default class RedditUserKarma extends RedditBase {
  static route = {
    base: 'reddit/user-karma',
    pattern: ':variant(link|comment|combined)/:user',
  }

  static openApi = {
    '/reddit/user-karma/{variant}/{user}': {
      get: {
        summary: 'Reddit User Karma',
        parameters: pathParams(
          {
            name: 'variant',
            example: 'combined',
            schema: { type: 'string', enum: this.getEnum('variant') },
          },
          {
            name: 'user',
            example: 'example',
          },
        ),
      },
    },
  }

  static defaultBadgeData = {
    label: 'reddit karma',
    namedLogo: 'reddit',
  }

  static render({ variant, karma, user }) {
    const label =
      variant === 'combined'
        ? `u/${user} karma`
        : `u/${user} karma (${variant})`
    return {
      label,
      message: metric(karma),
      style: 'social',
      color: karma > 0 ? 'brightgreen' : karma === 0 ? 'orange' : 'red',
      link: [`https://www.reddit.com/u/${user}`],
    }
  }

  async fetch({ user }) {
    return this._requestJson({
      schema,
      // API requests with a bearer token should be made to https://oauth.reddit.com, NOT www.reddit.com.
      url: this.authHelper.isConfigured
        ? `https://oauth.reddit.com/u/${user}/about.json`
        : `https://www.reddit.com/u/${user}/about.json`,
      httpErrors: {
        404: 'user not found',
      },
    })
  }

  transform({ json, variant }) {
    let karma
    if (variant === 'link') {
      karma = json.data.link_karma
    } else if (variant === 'comment') {
      karma = json.data.comment_karma
    } else {
      const total = json.data.link_karma + json.data.comment_karma
      karma = total
    }

    return { karma }
  }

  async handle({ variant, user }) {
    const json = await this.fetch({ user })
    const { karma } = this.transform({ json, variant })

    return this.constructor.render({
      variant,
      karma,
      user,
    })
  }
}