[Homebrew] Add homebrew downloads badge

services/homebrew/homebrew-downloads.service.js

@@ -0,0 +1,77 @@
+'use strict'
+
+const Joi = require('joi')
+const { downloadCount } = require('../color-formatters')
+const { metric } = require('../text-formatters')
+const { BaseJsonService } = require('..')
+const { nonNegativeInteger } = require('../validators')
+
+function getSchema({ formula }) {
+  return Joi.object({
+    analytics: Joi.object({
+      install: Joi.object({
+        '30d': Joi.object({ [formula]: nonNegativeInteger }).required(),
+        '90d': Joi.object({ [formula]: nonNegativeInteger }).required(),
+        '365d': Joi.object({ [formula]: nonNegativeInteger }).required(),
+      }).required(),
+    }).required(),
+  }).required()
+}
+
+const periodMap = {
+  dm: {
+    api_field: '30d',
+    suffix: '/month',
+  },
+  dq: {
+    api_field: '90d',
+    suffix: '/quarter',
+  },
+  dy: {
+    api_field: '365d',
+    suffix: '/year',
+  },
+}
+
+module.exports = class HomebrewDownloads extends BaseJsonService {
+  static category = 'downloads'
+
+  static route = {
+    base: 'homebrew',
+    pattern: 'installs/:interval(dm|dq|dy)/:formula',
+  }
+
+  static examples = [
+    {
+      title: 'homebrew downloads',
+      namedParams: { interval: 'dm', formula: 'cake' },
+      staticPreview: this.render({ interval: 'dm', downloads: 93 }),
+    },
+  ]
+
+  static defaultBadgeData = { label: 'downloads' }
+
+  static render({ interval, downloads }) {
+    return {
+      message: `${metric(downloads)}${periodMap[interval].suffix}`,
+      color: downloadCount(downloads),
+    }
+  }
+
+  async fetch({ formula }) {
+    const schema = getSchema({ formula })
+    return this._requestJson({
+      schema,
+      url: `https://formulae.brew.sh/api/formula/${formula}.json`,
+      errorMessages: { 404: 'formula not found' },
+    })
+  }
+
+  async handle({ interval, formula }) {
+    const data = await this.fetch({ formula })
+    return this.constructor.render({
+      interval,
+      downloads: data.analytics.install[periodMap[interval].api_field][formula],
+    })
+  }
+}

services/homebrew/homebrew-downloads.tester.js

@@ -0,0 +1,28 @@
+'use strict'
+
+const t = (module.exports = require('../tester').createServiceTester())
+const { isMetricOverTimePeriod } = require('../test-validators')
+
+t.create('daily downloads (valid)')
+  .get('/installs/dm/cake.json')
+  .expectBadge({ label: 'downloads', message: isMetricOverTimePeriod })
+
+t.create('yearly downloads (valid)')
+  .get('/installs/dq/cake.json')
+  .expectBadge({ label: 'downloads', message: isMetricOverTimePeriod })
+
+t.create('yearly downloads (valid)')
+  .get('/installs/dy/cake.json')
+  .expectBadge({ label: 'downloads', message: isMetricOverTimePeriod })
+
+t.create('daily downloads (not found)')
+  .get('/installs/dm/not-a-package.json')
+  .expectBadge({ label: 'downloads', message: 'formula not found' })
+
+t.create('yearly downloads (not found)')
+  .get('/installs/dq/not-a-package.json')
+  .expectBadge({ label: 'downloads', message: 'formula not found' })
+
+t.create('yearly downloads (not found)')
+  .get('/installs/dy/not-a-package.json')
+  .expectBadge({ label: 'downloads', message: 'formula not found' })

services/homebrew/homebrew.service.js → services/homebrew/homebrew-version.service.js

@@ -10,14 +10,14 @@ const schema = Joi.object({
   }).required(),
 }).required()
 
-module.exports = class Homebrew extends BaseJsonService {
+module.exports = class HomebrewVersion extends BaseJsonService {
   static category = 'version'
 
   static route = { base: 'homebrew/v', pattern: ':formula' }
 
   static examples = [
     {
-      title: 'homebrew',
+      title: 'homebrew version',
       namedParams: { formula: 'cake' },
       staticPreview: renderVersionBadge({ version: 'v0.32.0' }),
     },

services/test-validators.js

@@ -73,10 +73,12 @@ const isMetricOverMetric = withRegex(
 )
 
 const isMetricOverTimePeriod = withRegex(
-  /^([1-9][0-9]*[kMGTPEZY]?|[1-9]\.[1-9][kMGTPEZY])\/(year|month|four weeks|week|day)$/
+  /^([1-9][0-9]*[kMGTPEZY]?|[1-9]\.[1-9][kMGTPEZY])\/(year|month|four weeks|quarter|week|day)$/
 )
 
-const isZeroOverTimePeriod = withRegex(/^0\/(year|month|four weeks|week|day)$/)
+const isZeroOverTimePeriod = withRegex(
+  /^0\/(year|month|four weeks|quarter|week|day)$/
+)
 
 const isIntegerPercentage = withRegex(/^[1-9][0-9]?%|^100%|^0%$/)
 const isDecimalPercentage = withRegex(/^[0-9]+\.[0-9]*%$/)