restore [JitpackDownloads] badge (#3533)
* feat: restore JitpackDownloads badge * chore: use interval name in jitpackdownloads
This commit is contained in:
@@ -1,14 +1,83 @@
|
||||
'use strict'
|
||||
|
||||
const { deprecatedService } = require('..')
|
||||
const Joi = require('joi')
|
||||
const { nonNegativeInteger } = require('../validators')
|
||||
const { BaseJsonService } = require('..')
|
||||
const { downloadCount } = require('../color-formatters')
|
||||
const { metric } = require('../text-formatters')
|
||||
|
||||
module.exports = deprecatedService({
|
||||
route: {
|
||||
base: 'jitpack',
|
||||
pattern: ':period(dw|dm)/:various*',
|
||||
const schema = Joi.object({
|
||||
week: nonNegativeInteger,
|
||||
month: nonNegativeInteger,
|
||||
}).required()
|
||||
|
||||
const intervalMap = {
|
||||
dw: {
|
||||
api_field: 'week',
|
||||
suffix: '/week',
|
||||
},
|
||||
message: 'temporarily unavailable',
|
||||
label: 'downloads',
|
||||
category: 'downloads',
|
||||
dateAdded: new Date('2019-05-27'),
|
||||
})
|
||||
dm: {
|
||||
api_field: 'month',
|
||||
suffix: '/month',
|
||||
},
|
||||
}
|
||||
|
||||
module.exports = class JitpackDownloads extends BaseJsonService {
|
||||
static get category() {
|
||||
return 'downloads'
|
||||
}
|
||||
|
||||
static get route() {
|
||||
return {
|
||||
base: 'jitpack',
|
||||
pattern:
|
||||
':interval(dw|dm)/:vcs(github|bitbucket|gitlab|gitee)/:user/:repo',
|
||||
}
|
||||
}
|
||||
|
||||
static get examples() {
|
||||
return [
|
||||
{
|
||||
title: 'JitPack - Downloads',
|
||||
namedParams: {
|
||||
interval: 'dm',
|
||||
vcs: 'github',
|
||||
user: 'jitpack',
|
||||
repo: 'maven-simple',
|
||||
},
|
||||
staticPreview: JitpackDownloads.render({
|
||||
downloads: 14000,
|
||||
interval: 'dm',
|
||||
}),
|
||||
keywords: ['java', 'maven'],
|
||||
},
|
||||
]
|
||||
}
|
||||
|
||||
static get defaultBadgeData() {
|
||||
return { label: 'downloads' }
|
||||
}
|
||||
|
||||
static render({ downloads, interval }) {
|
||||
return {
|
||||
message: `${metric(downloads)}${intervalMap[interval].suffix}`,
|
||||
color: downloadCount(downloads),
|
||||
}
|
||||
}
|
||||
|
||||
async fetch({ vcs, user, repo }) {
|
||||
return this._requestJson({
|
||||
schema,
|
||||
url: `https://jitpack.io/api/downloads/com.${vcs}.${user}/${repo}`,
|
||||
errorMessages: { 401: 'project not found or private' },
|
||||
})
|
||||
}
|
||||
|
||||
async handle({ interval, vcs, user, repo }) {
|
||||
const json = await this.fetch({ vcs, user, repo })
|
||||
return this.constructor.render({
|
||||
downloads: json[intervalMap[interval].api_field],
|
||||
interval,
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,23 +1,22 @@
|
||||
'use strict'
|
||||
|
||||
const { ServiceTester } = require('../tester')
|
||||
const t = (module.exports = require('../tester').createServiceTester())
|
||||
const { isMetricOverTimePeriod } = require('../test-validators')
|
||||
|
||||
const t = (module.exports = new ServiceTester({
|
||||
id: 'JitpackDownloads',
|
||||
title: 'JitpackDownloads',
|
||||
pathPrefix: '/jitpack',
|
||||
}))
|
||||
t.create('weekly (github)')
|
||||
.get('/dw/github/jitpack/maven-simple.json')
|
||||
.timeout(10000)
|
||||
.expectBadge({ label: 'downloads', message: isMetricOverTimePeriod })
|
||||
|
||||
t.create('no longer available (was weekly github')
|
||||
.get('/dw/github/erayerdin/kappdirs.json')
|
||||
t.create('monthly (github)')
|
||||
.get('/dm/github/dcendents/android-maven-gradle-plugin.json')
|
||||
.timeout(10000)
|
||||
.expectBadge({ label: 'downloads', message: isMetricOverTimePeriod })
|
||||
|
||||
t.create('unknown package (github)')
|
||||
.get('/dw/github/some-bogus-user/super-fake-project.json')
|
||||
.timeout(10000)
|
||||
.expectBadge({
|
||||
label: 'downloads',
|
||||
message: 'temporarily unavailable',
|
||||
})
|
||||
|
||||
t.create('no longer available (was monthly github')
|
||||
.get('/dm/github/erayerdin/kappdirs.json')
|
||||
.expectBadge({
|
||||
label: 'downloads',
|
||||
message: 'temporarily unavailable',
|
||||
message: '0/week',
|
||||
})
|
||||
|
||||
Reference in New Issue
Block a user