shields/services/docker/docker-pulls.service.js

'use strict'

const Joi = require('@hapi/joi')
const { metric } = require('../text-formatters')
const { nonNegativeInteger } = require('../validators')
const { BaseJsonService } = require('..')
const {
  dockerBlue,
  buildDockerUrl,
  getDockerHubUser,
} = require('./docker-helpers')

const pullsSchema = Joi.object({
  pull_count: nonNegativeInteger,
}).required()

module.exports = class DockerPulls extends BaseJsonService {
  static get category() {
    return 'downloads'
  }

  static get route() {
    return buildDockerUrl('pulls')
  }

  static get examples() {
    return [
      {
        title: 'Docker Pulls',
        namedParams: {
          user: '_',
          repo: 'ubuntu',
        },
        staticPreview: this.render({ count: 765400000 }),
      },
    ]
  }

  static get defaultBadgeData() {
    return { label: 'docker pulls' }
  }

  static render({ count }) {
    return {
      message: metric(count),
      color: dockerBlue,
    }
  }

  async fetch({ user, repo }) {
    return this._requestJson({
      schema: pullsSchema,
      url: `https://hub.docker.com/v2/repositories/${getDockerHubUser(
        user
      )}/${repo}`,
      errorMessages: { 404: 'repo not found' },
    })
  }

  async handle({ user, repo }) {
    const data = await this.fetch({ user, repo })
    return this.constructor.render({ count: data.pull_count })
  }
}