bd288db3a4
* migrate some services from examples to openApi * fixup which --> variant param rename * improve descriptions * migrate gem version * improve descriptions for ruby gems * standardise on packageName for all conda badges
79 lines
2.0 KiB
JavaScript
79 lines
2.0 KiB
JavaScript
import Joi from 'joi'
|
|
import { renderVersionBadge } from '../version.js'
|
|
import { BaseJsonService, pathParam, queryParam } from '../index.js'
|
|
import { description, latest, versionColor } from './gem-helpers.js'
|
|
|
|
const schema = Joi.object({
|
|
// In most cases `version` will be a SemVer but the registry doesn't
|
|
// actually enforce this.
|
|
version: Joi.string().required(),
|
|
}).required()
|
|
|
|
const versionSchema = Joi.array()
|
|
.items(
|
|
Joi.object({
|
|
number: Joi.string().required(),
|
|
}),
|
|
)
|
|
.min(1)
|
|
.required()
|
|
|
|
const queryParamSchema = Joi.object({
|
|
include_prereleases: Joi.equal(''),
|
|
}).required()
|
|
|
|
export default class GemVersion extends BaseJsonService {
|
|
static category = 'version'
|
|
static route = { base: 'gem/v', pattern: ':gem', queryParamSchema }
|
|
static openApi = {
|
|
'/gem/v/{gem}': {
|
|
get: {
|
|
summary: 'Gem Version',
|
|
description,
|
|
parameters: [
|
|
pathParam({
|
|
name: 'gem',
|
|
example: 'formatador',
|
|
}),
|
|
queryParam({
|
|
name: 'include_prereleases',
|
|
schema: { type: 'boolean' },
|
|
example: null,
|
|
}),
|
|
],
|
|
},
|
|
},
|
|
}
|
|
|
|
static defaultBadgeData = { label: 'gem' }
|
|
|
|
static render({ version }) {
|
|
return renderVersionBadge({ version, versionFormatter: versionColor })
|
|
}
|
|
|
|
async fetch({ gem }) {
|
|
return this._requestJson({
|
|
schema,
|
|
url: `https://rubygems.org/api/v1/gems/${gem}.json`,
|
|
})
|
|
}
|
|
|
|
async fetchLatest({ gem }) {
|
|
return this._requestJson({
|
|
schema: versionSchema,
|
|
url: `https://rubygems.org/api/v1/versions/${gem}.json`,
|
|
})
|
|
}
|
|
|
|
async handle({ gem }, queryParams) {
|
|
if (queryParams && typeof queryParams.include_prereleases !== 'undefined') {
|
|
const data = await this.fetchLatest({ gem })
|
|
const versions = data.map(version => version.number)
|
|
return this.constructor.render({ version: latest(versions) })
|
|
} else {
|
|
const { version } = await this.fetch({ gem })
|
|
return this.constructor.render({ version })
|
|
}
|
|
}
|
|
}
|