Files
shields/services/hackage/hackage-deps.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

72 lines
2.1 KiB
JavaScript

'use strict'
const LegacyService = require('../legacy-service')
const { makeBadgeData: getBadgeData } = require('../../lib/badge-data')
const { checkErrorResponse } = require('../../lib/error-helper')
module.exports = class HackageDeps extends LegacyService {
static get category() {
return 'dependencies'
}
static get route() {
return {
base: 'hackage-deps/v',
}
}
static get examples() {
return [
{
title: 'Hackage-Deps',
previewUrl: 'lens',
},
]
}
static registerLegacyRouteHandler({ camp, cache }) {
camp.route(
/^\/hackage-deps\/v\/(.*)\.(svg|png|gif|jpg|json)$/,
cache((data, match, sendBadge, request) => {
const repo = match[1] // eg, `lens`.
const format = match[2]
const reverseUrl = `http://packdeps.haskellers.com/licenses/${repo}`
const feedUrl = `http://packdeps.haskellers.com/feed/${repo}`
const badgeData = getBadgeData('dependencies', data)
// first call /reverse to check if the package exists
// this will throw a 404 if it doesn't
request(reverseUrl, (err, res, buffer) => {
if (checkErrorResponse(badgeData, err, res)) {
sendBadge(format, badgeData)
return
}
// if the package exists, then query /feed to check the dependencies
request(feedUrl, (err, res, buffer) => {
if (err != null) {
badgeData.text[1] = 'inaccessible'
sendBadge(format, badgeData)
return
}
try {
const outdatedStr = `Outdated dependencies for ${repo} `
if (buffer.indexOf(outdatedStr) >= 0) {
badgeData.text[1] = 'outdated'
badgeData.colorscheme = 'orange'
} else {
badgeData.text[1] = 'up to date'
badgeData.colorscheme = 'brightgreen'
}
} catch (e) {
badgeData.text[1] = 'invalid'
}
sendBadge(format, badgeData)
})
})
})
)
}
}