Files
shields/services/docker/docker.service.js
Paul Melnikow 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

237 lines
6.7 KiB
JavaScript

'use strict'
const LegacyService = require('../legacy-service')
const {
makeBadgeData: getBadgeData,
setBadgeColor,
} = require('../../lib/badge-data')
const { checkErrorResponse } = require('../../lib/error-helper')
const { metric } = require('../../lib/text-formatters')
class DockerStars extends LegacyService {
static get category() {
return 'rating'
}
static get route() {
return {
base: 'docker/stars',
}
}
static get examples() {
return [
{
title: 'Docker Stars',
previewUrl: '_/ubuntu',
keywords: ['docker', 'stars'],
},
]
}
static registerLegacyRouteHandler({ camp, cache }) {
camp.route(
/^\/docker\/stars\/([^/]+)\/([^/]+)\.(svg|png|gif|jpg|json)$/,
cache((data, match, sendBadge, request) => {
let user = match[1] // eg, mashape
const repo = match[2] // eg, kong
const format = match[3]
if (user === '_') {
user = 'library'
}
const path = `${user}/${repo}`
const url = `https://hub.docker.com/v2/repositories/${path}/stars/count/`
const badgeData = getBadgeData('docker stars', data)
request(url, (err, res, buffer) => {
if (
checkErrorResponse(badgeData, err, res, { 404: 'repo not found' })
) {
sendBadge(format, badgeData)
return
}
try {
const stars = parseInt(buffer, 10)
if (Number.isNaN(stars)) {
throw Error('Unexpected response.')
}
badgeData.text[1] = metric(stars)
setBadgeColor(badgeData, data.colorB || '066da5')
sendBadge(format, badgeData)
} catch (e) {
badgeData.text[1] = 'invalid'
sendBadge(format, badgeData)
}
})
})
)
}
}
class DockerPulls extends LegacyService {
static get category() {
return 'downloads'
}
static get route() {
return {
base: 'docker/pulls',
}
}
static get examples() {
return [
{
title: 'Docker Pulls',
previewUrl: 'mashape/kong',
keywords: ['docker', 'pulls'],
},
]
}
static registerLegacyRouteHandler({ camp, cache }) {
camp.route(
/^\/docker\/pulls\/([^/]+)\/([^/]+)\.(svg|png|gif|jpg|json)$/,
cache((data, match, sendBadge, request) => {
let user = match[1] // eg, mashape
const repo = match[2] // eg, kong
const format = match[3]
if (user === '_') {
user = 'library'
}
const path = `${user}/${repo}`
const url = `https://hub.docker.com/v2/repositories/${path}`
const badgeData = getBadgeData('docker pulls', data)
request(url, (err, res, buffer) => {
if (
checkErrorResponse(badgeData, err, res, { 404: 'repo not found' })
) {
sendBadge(format, badgeData)
return
}
try {
const parseData = JSON.parse(buffer)
const pulls = parseData.pull_count
badgeData.text[1] = metric(pulls)
setBadgeColor(badgeData, data.colorB || '066da5')
sendBadge(format, badgeData)
} catch (e) {
badgeData.text[1] = 'invalid'
sendBadge(format, badgeData)
}
})
})
)
}
}
class DockerBuild extends LegacyService {
static get category() {
return 'build'
}
static get route() {
return {
base: 'docker',
}
}
static get examples() {
return [
{
title: 'Docker Automated build',
previewUrl: 'automated/jrottenberg/ffmpeg',
keywords: ['docker', 'automated', 'build'],
},
{
title: 'Docker Build Status',
previewUrl: 'build/jrottenberg/ffmpeg',
keywords: ['docker', 'build', 'status'],
},
]
}
static registerLegacyRouteHandler({ camp, cache }) {
camp.route(
/^\/docker\/build\/([^/]+)\/([^/]+)\.(svg|png|gif|jpg|json)$/,
cache((data, match, sendBadge, request) => {
let user = match[1] // eg, jrottenberg
const repo = match[2] // eg, ffmpeg
const format = match[3]
if (user === '_') {
user = 'library'
}
const path = `${user}/${repo}`
const url = `https://registry.hub.docker.com/v2/repositories/${path}/buildhistory`
const badgeData = getBadgeData('docker build', data)
request(url, (err, res, buffer) => {
if (
checkErrorResponse(badgeData, err, res, { 404: 'repo not found' })
) {
sendBadge(format, badgeData)
return
}
try {
const parsedData = JSON.parse(buffer)
const mostRecentStatus = parsedData.results[0].status
if (mostRecentStatus === 10) {
badgeData.text[1] = 'passing'
badgeData.colorscheme = 'brightgreen'
} else if (mostRecentStatus < 0) {
badgeData.text[1] = 'failing'
badgeData.colorscheme = 'red'
} else {
badgeData.text[1] = 'building'
setBadgeColor(badgeData, data.colorB || '066da5')
}
sendBadge(format, badgeData)
} catch (e) {
badgeData.text[1] = 'invalid'
sendBadge(format, badgeData)
}
})
})
)
// Docker Hub automated integration.
camp.route(
/^\/docker\/automated\/([^/]+)\/([^/]+)\.(svg|png|gif|jpg|json)$/,
cache((data, match, sendBadge, request) => {
let user = match[1] // eg, jrottenberg
const repo = match[2] // eg, ffmpeg
const format = match[3]
if (user === '_') {
user = 'library'
}
const path = `${user}/${repo}`
const url = `https://registry.hub.docker.com/v2/repositories/${path}`
const badgeData = getBadgeData('docker build', data)
request(url, (err, res, buffer) => {
if (
checkErrorResponse(badgeData, err, res, { 404: 'repo not found' })
) {
sendBadge(format, badgeData)
return
}
try {
const parsedData = JSON.parse(buffer)
const isAutomated = parsedData.is_automated
if (isAutomated) {
badgeData.text[1] = 'automated'
setBadgeColor(badgeData, data.colorB || '066da5')
} else {
badgeData.text[1] = 'manual'
badgeData.colorscheme = 'yellow'
}
sendBadge(format, badgeData)
} catch (e) {
badgeData.text[1] = 'invalid'
sendBadge(format, badgeData)
}
})
})
)
}
}
module.exports = [DockerStars, DockerPulls, DockerBuild]