Files
shields/services/pub/pub-popularity.service.js
chris48s 3eb4959163 migrate examples to openApi part 14; affects [azuredevops discord netlify opencollective pub ros visualstudio] (#9560)
* migrate some services from examples to openApi

* migrate pub version

* improve pub descriptions
2023-12-04 13:09:37 +00:00

55 lines
1.5 KiB
JavaScript

import Joi from 'joi'
import { floorCount } from '../color-formatters.js'
import { BaseJsonService, pathParams } from '../index.js'
import { baseDescription } from './pub-common.js'
const description = `${baseDescription}
<p>This badge shows a measure of how many developers use a package, providing insight into what other developers are using.</p>`
const schema = Joi.object({
popularityScore: Joi.number().min(0).max(1).required(),
}).required()
export default class PubPopularity extends BaseJsonService {
static category = 'rating'
static route = { base: 'pub/popularity', pattern: ':packageName' }
static openApi = {
'/pub/popularity/{packageName}': {
get: {
summary: 'Pub Popularity',
description,
parameters: pathParams({
name: 'packageName',
example: 'analysis_options',
}),
},
},
}
static defaultBadgeData = { label: 'popularity' }
static render({ popularityScore }) {
const roundedScore = Math.round(popularityScore * 100)
return {
label: 'popularity',
message: `${roundedScore}%`,
color: floorCount(roundedScore, 40, 60, 80),
}
}
async fetch({ packageName }) {
return this._requestJson({
schema,
url: `https://pub.dev/api/packages/${packageName}/score`,
})
}
async handle({ packageName }) {
const score = await this.fetch({ packageName })
const popularityScore = score.popularityScore
return this.constructor.render({ popularityScore })
}
}