Paul MelnikowandGitHub
3ad742e79a
Close #2334 To avoid merge conflicts, I've deferred removing the aliasing logic in `prepareExamples`. That whole function will be refactored momentarily, and there's also #2339 open.
67 lines
1.5 KiB
JavaScript
67 lines
1.5 KiB
JavaScript
'use strict'
|
|
|
|
const BaseJsonService = require('../base-json')
|
|
const Joi = require('joi')
|
|
|
|
const statusSchema = Joi.object({
|
|
status: Joi.string().required(),
|
|
}).required()
|
|
|
|
module.exports = class RequiresIo extends BaseJsonService {
|
|
static get route() {
|
|
return {
|
|
base: 'requires',
|
|
format: '([^/]+)/([^/]+/[^/]+)(?:/(.+))?',
|
|
capture: ['service', 'repo', 'branch'],
|
|
}
|
|
}
|
|
|
|
static get defaultBadgeData() {
|
|
return { label: 'requirements' }
|
|
}
|
|
|
|
async handle({ service, repo, branch }) {
|
|
const { status } = await this.fetch({ service, repo, branch })
|
|
return this.constructor.render({ status })
|
|
}
|
|
|
|
async fetch({ service, repo, branch }) {
|
|
const url = `https://requires.io/api/v1/status/${service}/${repo}`
|
|
return this._requestJson({
|
|
url,
|
|
schema: statusSchema,
|
|
options: { qs: { branch } },
|
|
})
|
|
}
|
|
|
|
static render({ status }) {
|
|
let message = status
|
|
let color = 'lightgrey'
|
|
if (status === 'up-to-date') {
|
|
message = 'up to date'
|
|
color = 'brightgreen'
|
|
} else if (status === 'outdated') {
|
|
color = 'yellow'
|
|
} else if (status === 'insecure') {
|
|
color = 'red'
|
|
}
|
|
return { message, color }
|
|
}
|
|
|
|
static get category() {
|
|
return 'dependencies'
|
|
}
|
|
|
|
static get examples() {
|
|
return [
|
|
{
|
|
title: 'Requires.io',
|
|
pattern: ':service/:user/:repo',
|
|
staticExample: this.render({ status: 'up-to-date' }),
|
|
exampleUrl: 'github/celery/celery',
|
|
keywords: ['requires'],
|
|
},
|
|
]
|
|
}
|
|
}
|