Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add [PUB] points badge #7918

Merged
merged 5 commits into from
May 8, 2022
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
55 changes: 55 additions & 0 deletions services/pub/pub-points.service.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
import Joi from 'joi'
import { floorCount } from '../color-formatters.js'
import { BaseJsonService } from '../index.js'
import { nonNegativeInteger } from '../validators.js'

const documentation = `<p>A measure of quality. This includes several dimensions of quality such as code style, platform support, and maintainability.</p>`

const keywords = ['dart', 'flutter']

const schema = Joi.object({
grantedPoints: nonNegativeInteger,
maxPoints: nonNegativeInteger,
}).required()

const title = 'Pub Points'

export default class PubPoints extends BaseJsonService {
static category = 'rating'

static route = { base: 'pub/points', pattern: ':packageName' }

static examples = [
{
title,
keywords,
documentation,
namedParams: { packageName: 'analysis_options' },
staticPreview: this.render({ grantedPoints: 120, maxPoints: 130 }),
},
]

static defaultBadgeData = { label: 'points' }

static render({ grantedPoints, maxPoints }) {
return {
label: 'points',
message: `${grantedPoints}/${maxPoints}`,
color: floorCount((grantedPoints / maxPoints) * 100, 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 grantedPoints = score.grantedPoints
const maxPoints = score.maxPoints
return this.constructor.render({ grantedPoints, maxPoints })
}
}
23 changes: 23 additions & 0 deletions services/pub/pub-points.tester.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
import Joi from 'joi'
import { createServiceTester } from '../tester.js'

export const t = await createServiceTester()

t.create('pub points (valid)')
.get('/analysis_options.json')
.expectBadge({
label: 'points',
message: Joi.string().regex(/^\d+\/130$/),
})

t.create('pub points (not found)').get('/analysisoptions.json').expectBadge({
label: 'points',
message: 'not found',
color: 'red',
})

t.create('pub points (invalid)').get('/analysis-options.json').expectBadge({
label: 'points',
message: 'invalid',
color: 'lightgrey',
})