refactor [jitpack] service (#2943)

services/jitpack/jitpack.service.js

@@ -1,17 +1,17 @@
 'use strict'
 
-const LegacyService = require('../legacy-service')
-const { makeBadgeData: getBadgeData } = require('../../lib/badge-data')
-const { addv: versionText } = require('../../lib/text-formatters')
-const { version: versionColor } = require('../../lib/color-formatters')
+const Joi = require('joi')
+const { BaseJsonService } = require('..')
+const { renderVersionBadge } = require('../../lib/version')
 
-// This legacy service should be rewritten to use e.g. BaseJsonService.
-//
-// Tips for rewriting:
-// https://github.com/badges/shields/blob/master/doc/rewriting-services.md
-//
-// Do not base new services on this code.
-module.exports = class Jitpack extends LegacyService {
+const schema = Joi.object({
+  version: Joi.string().required(),
+  status: Joi.string()
+    .valid('ok')
+    .required(),
+}).required()
+
+module.exports = class JitPackVersion extends BaseJsonService {
   static get category() {
     return 'version'
   }
@@ -31,58 +31,26 @@ module.exports = class Jitpack extends LegacyService {
           groupId: 'jitpack',
           artifactId: 'maven-simple',
         },
-        staticPreview: {
-          label: 'jitpack',
-          message: 'v1.1',
-          color: 'blue',
-        },
+        staticPreview: renderVersionBadge({ version: 'v1.1' }),
         keywords: ['java', 'maven'],
       },
     ]
   }
 
-  static registerLegacyRouteHandler({ camp, cache }) {
-    camp.route(
-      /^\/jitpack\/v\/([^/]*)\/([^/]*)\.(svg|png|gif|jpg|json)$/,
-      cache((data, match, sendBadge, request) => {
-        const groupId = `com.github.${match[1]}` // github user
-        const artifactId = match[2] // the project's name
-        const format = match[3] // "svg"
+  static get defaultBadgeData() {
+    return { label: 'jitpack' }
+  }
 
-        const pkg = `${groupId}/${artifactId}/latest`
-        const apiUrl = `https://jitpack.io/api/builds/${pkg}`
+  async fetch({ groupId, artifactId }) {
+    return this._requestJson({
+      schema,
+      url: `https://jitpack.io/api/builds/com.github.${groupId}/${artifactId}/latest`,
+      errorMessages: { 401: 'project not found or private' },
+    })
+  }
 
-        const badgeData = getBadgeData('jitpack', data)
-
-        request(apiUrl, (err, res, buffer) => {
-          if (err != null) {
-            badgeData.text[1] = 'inaccessible'
-            sendBadge(format, badgeData)
-            return
-          }
-          if (res.statusCode === 404) {
-            badgeData.text[1] = 'not found'
-            sendBadge(format, badgeData)
-            return
-          }
-          try {
-            const data = JSON.parse(buffer)
-            const status = data['status']
-            let color = versionColor(data['version'])
-            let version = versionText(data['version'])
-            if (status !== 'ok') {
-              color = 'red'
-              version = 'unknown'
-            }
-            badgeData.text[1] = version
-            badgeData.colorscheme = color
-            sendBadge(format, badgeData)
-          } catch (e) {
-            badgeData.text[1] = 'invalid'
-            sendBadge(format, badgeData)
-          }
-        })
-      })
-    )
+  async handle({ groupId, artifactId }) {
+    const { version } = await this.fetch({ groupId, artifactId })
+    return renderVersionBadge({ version })
   }
 }

services/jitpack/jitpack.tester.js

@@ -1,28 +1,15 @@
 'use strict'
 
 const Joi = require('joi')
-const { ServiceTester } = require('../tester')
+const t = (module.exports = require('../tester').createServiceTester())
 
 // Github allows versions with chars, etc.
 const isAnyV = Joi.string().regex(/^v.+$/)
 
-const t = new ServiceTester({ id: 'jitpack', title: 'JitPack' })
-module.exports = t
-
 t.create('version')
-  .get('/v/jitpack/maven-simple.json')
+  .get('/jitpack/maven-simple.json')
   .expectJSONTypes(Joi.object().keys({ name: 'jitpack', value: isAnyV }))
 
 t.create('unknown package')
-  .get('/v/some-bogus-user/project.json')
-  .expectJSON({ name: 'jitpack', value: 'invalid' })
-
-t.create('unknown info')
-  .get('/z/devtools.json')
-  .expectStatus(404)
-  .expectJSON({ name: '404', value: 'badge not found' })
-
-t.create('connection error')
-  .get('/v/jitpack/maven-simple.json')
-  .networkOff()
-  .expectJSON({ name: 'jitpack', value: 'inaccessible' })
+  .get('/some-bogus-user/project.json')
+  .expectJSON({ name: 'jitpack', value: 'project not found or private' })