Files
shields/services/github/github-license.service.js
chris48s 504015c0ba migrate hapi/joi to joi (#5624)
* update joi + joi-extension-semver

* @hapi/joi --> joi

Co-authored-by: repo-ranger[bot] <39074581+repo-ranger[bot]@users.noreply.github.com>
2020-09-30 17:51:02 +00:00

52 lines
1.5 KiB
JavaScript

'use strict'
const Joi = require('joi')
const { renderLicenseBadge } = require('../licenses')
const { GithubAuthV3Service } = require('./github-auth-service')
const { documentation, errorMessagesFor } = require('./github-helpers')
const schema = Joi.object({
// Some repos do not have a license, in which case GitHub returns `{ license: null }`.
license: Joi.object({ spdx_id: Joi.string().required() }).allow(null),
}).required()
module.exports = class GithubLicense extends GithubAuthV3Service {
static category = 'license'
static route = { base: 'github/license', pattern: ':user/:repo' }
static examples = [
{
title: 'GitHub',
namedParams: { user: 'mashape', repo: 'apistatus' },
staticPreview: {
label: 'license',
message: 'MIT',
color: 'green',
},
documentation,
},
]
static defaultBadgeData = { label: 'license' }
static render({ license }) {
if (license === 'NOASSERTION') {
return { message: 'not identifiable by github' }
} else if (license) {
return renderLicenseBadge({ license })
} else {
return { message: 'not specified' }
}
}
async handle({ user, repo }) {
const { license: licenseObject } = await this._requestJson({
schema,
url: `/repos/${user}/${repo}`,
errorMessages: errorMessagesFor('repo not found'),
})
const license = licenseObject ? licenseObject.spdx_id : undefined
return this.constructor.render({ license })
}
}