Files
shields/services/microbadger/microbadger.service.js
T
Paul MelnikowandGitHub 02ec19fd22 BaseService terminology: Rename url to route (#2278)
The term “url” is overloaded in services, to refer to the Shields route and also the API URL. Calling the Shields URL a “route” is on the whole more descriptive, and makes it clearer and more obvious which one of these we’re talking about. It’s a small thing, though seems like an improvement.

We have a few functions called `buildUrl`. I’ve renamed them to `buildRoute` when they refer to routes, and left them as `buildUrl` when they refer to API URLs.

I included a minor style tweak and some formatting cleanup in `TUTORIAL.md`.
2018-11-09 15:11:03 -05:00

126 lines
3.4 KiB
JavaScript

'use strict'
const prettyBytes = require('pretty-bytes')
const LegacyService = require('../legacy-service')
const {
makeBadgeData: getBadgeData,
makeLabel: getLabel,
} = require('../../lib/badge-data')
module.exports = class MicroBadger extends LegacyService {
static get category() {
return 'size'
}
static get route() {
return {
base: 'microbadger',
}
}
static get examples() {
return [
{
title: 'MicroBadger Size',
previewUrl: 'image-size/fedora/apache',
keywords: ['docker'],
},
{
title: 'MicroBadger Size (tag)',
previewUrl: 'image-size/_/httpd/alpine',
keywords: ['docker'],
},
{
title: 'MicroBadger Layers',
previewUrl: 'layers/_/httpd',
keywords: ['docker'],
},
{
title: 'MicroBadger Layers (tag)',
previewUrl: 'layers/_/httpd/alpine',
keywords: ['docker'],
},
]
}
static registerLegacyRouteHandler({ camp, cache }) {
camp.route(
/^\/microbadger\/(image-size|layers)\/([^/]+)\/([^/]+)\/?([^/]*)\.(svg|png|gif|jpg|json)$/,
cache((data, match, sendBadge, request) => {
const type = match[1]
let user = match[2]
const repo = match[3]
const tag = match[4]
const format = match[5]
if (user === '_') {
user = 'library'
}
const url = `https://api.microbadger.com/v1/images/${user}/${repo}`
const badgeData = getBadgeData(type, data)
if (type === 'image-size') {
badgeData.text[0] = getLabel('image size', data)
}
const options = {
method: 'GET',
uri: url,
headers: {
Accept: 'application/json',
},
}
request(options, (err, res, buffer) => {
if (res && res.statusCode === 404) {
badgeData.text[1] = 'not found'
sendBadge(format, badgeData)
return
}
if (err != null || !res || res.statusCode !== 200) {
badgeData.text[1] = 'inaccessible'
sendBadge(format, badgeData)
return
}
try {
const parsedData = JSON.parse(buffer)
let image
if (tag) {
image =
parsedData.Versions &&
parsedData.Versions.find(v => v.Tags.some(t => t.tag === tag))
if (!image) {
badgeData.text[1] = 'not found'
sendBadge(format, badgeData)
return
}
} else {
image = parsedData
}
if (type === 'image-size') {
const downloadSize = image.DownloadSize
if (downloadSize === undefined) {
badgeData.text[1] = 'unknown'
sendBadge(format, badgeData)
return
}
badgeData.text[1] = prettyBytes(parseInt(downloadSize))
} else if (type === 'layers') {
badgeData.text[1] = image.LayerCount
}
badgeData.colorscheme = null
badgeData.colorB = '#007ec6'
sendBadge(format, badgeData)
} catch (e) {
badgeData.colorscheme = 'red'
badgeData.text[1] = 'error'
sendBadge(format, badgeData)
}
})
})
)
}
}