Files
shields/services/github/github-license.service.js
2021-07-09 12:53:55 +01:00

50 lines
1.4 KiB
JavaScript

import Joi from 'joi'
import { renderLicenseBadge } from '../licenses.js'
import { GithubAuthV3Service } from './github-auth-service.js'
import { documentation, errorMessagesFor } from './github-helpers.js'
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()
export default 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 })
}
}