Validate response json in [apm appveyor cdnjs clojars gem] also affects [npm] #1883
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,149 @@ | ||
| 'use strict' | ||
|
|
||
| const semver = require('semver') | ||
| const Joi = require('joi') | ||
|
|
||
| const { BaseJsonService } = require('../base') | ||
| const { InvalidResponse } = require('../errors') | ||
| const { | ||
| downloadCount: downloadCountColor, | ||
| } = require('../../lib/color-formatters') | ||
| const { metric } = require('../../lib/text-formatters') | ||
| const { latest: latestVersion } = require('../../lib/version') | ||
| const { positiveInteger } = require('../validators.js') | ||
|
|
||
| const downloadsSchema = Joi.alternatives().try( | ||
| Joi.object({ | ||
| downloads: positiveInteger, | ||
| version_downloads: positiveInteger, | ||
| }).required(), | ||
| Joi.array() | ||
| .items( | ||
| Joi.object({ | ||
| prerelease: Joi.boolean().required(), | ||
| number: Joi.string().required(), | ||
| downloads_count: positiveInteger, | ||
| }) | ||
| ) | ||
| .min(1) | ||
| .required() | ||
|
There was a problem hiding this comment. I hit an edge case here. Depending on which downloads badge we are building ( There was a problem hiding this comment. Yea, the npm downloads badge had the same issue. There I handled it with a switch: There was a problem hiding this comment. Yes - that's a much better way of doing it |
||
| ) | ||
|
|
||
| module.exports = class GemDownloads extends BaseJsonService { | ||
| async fetch(repo, info) { | ||
| const endpoint = info === 'dv' ? 'versions/' : 'gems/' | ||
| const url = `https://rubygems.org/api/v1/${endpoint}${repo}.json` | ||
| return this._requestJson({ | ||
| url, | ||
| schema: downloadsSchema, | ||
| }) | ||
| } | ||
|
|
||
| _getLabel(version, info) { | ||
| if (version) { | ||
| return 'downloads@' + version | ||
| } else { | ||
| if (info === 'dtv') { | ||
| return 'downloads@latest' | ||
| } else { | ||
| return 'downloads' | ||
| } | ||
| } | ||
| } | ||
|
|
||
| async handle({ info, rubygem }) { | ||
| const splitRubygem = rubygem.split('/') | ||
| const repo = splitRubygem[0] | ||
| let version = | ||
| splitRubygem.length > 1 ? splitRubygem[splitRubygem.length - 1] : null | ||
| version = version === 'stable' ? version : semver.valid(version) | ||
| const label = this._getLabel(version, info) | ||
| const json = await this.fetch(repo, info) | ||
|
|
||
| let downloads | ||
| if (info === 'dt') { | ||
| downloads = metric(json.downloads) | ||
| } else if (info === 'dtv') { | ||
| downloads = metric(json.version_downloads) | ||
| } else if (info === 'dv') { | ||
| let versionData | ||
| if (version !== null && version === 'stable') { | ||
| const versions = json | ||
| .filter(function(ver) { | ||
| return ver.prerelease === false | ||
| }) | ||
| .map(function(ver) { | ||
| return ver.number | ||
| }) | ||
| // Found latest stable version. | ||
| const stableVersion = latestVersion(versions) | ||
| versionData = json.filter(function(ver) { | ||
| return ver.number === stableVersion | ||
| })[0] | ||
| downloads = metric(versionData.downloads_count) | ||
| } else if (version !== null) { | ||
| versionData = json.filter(function(ver) { | ||
| return ver.number === version | ||
| })[0] | ||
|
|
||
| downloads = metric(versionData.downloads_count) | ||
| } else { | ||
| throw new InvalidResponse({ | ||
| underlyingError: new Error('version is null'), | ||
| }) | ||
| } | ||
| } else { | ||
| throw new InvalidResponse({ | ||
| underlyingError: new Error('info is invalid'), | ||
| }) | ||
| } | ||
|
|
||
| return { | ||
| label: label, | ||
| message: downloads, | ||
| color: downloadCountColor(downloads), | ||
| } | ||
| } | ||
|
|
||
| // Metadata | ||
| static get defaultBadgeData() { | ||
| return { label: 'downloads' } | ||
| } | ||
|
|
||
| static get category() { | ||
| return 'downloads' | ||
| } | ||
|
|
||
| static get url() { | ||
| return { | ||
| base: 'gem', | ||
| format: '(dt|dtv|dv)/(.+)', | ||
| capture: ['info', 'rubygem'], | ||
| } | ||
| } | ||
|
|
||
| static get examples() { | ||
| return [ | ||
| { | ||
| title: 'Gem', | ||
| previewUrl: 'dv/rails/stable', | ||
| keywords: ['ruby'], | ||
| }, | ||
| { | ||
| title: 'Gem', | ||
| previewUrl: 'dv/rails/4.1.0', | ||
| keywords: ['ruby'], | ||
| }, | ||
| { | ||
| title: 'Gem', | ||
| previewUrl: 'dtv/rails', | ||
| keywords: ['ruby'], | ||
| }, | ||
| { | ||
| title: 'Gem', | ||
| previewUrl: 'dt/rails', | ||
| keywords: ['ruby'], | ||
| }, | ||
| ] | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| 'use strict' | ||
|
|
||
| const Joi = require('joi') | ||
|
|
||
| const { BaseJsonService } = require('../base') | ||
| const { floorCount: floorCountColor } = require('../../lib/color-formatters') | ||
|
|
||
| module.exports = class GemOwner extends BaseJsonService { | ||
| async handle({ user }) { | ||
| const url = `https://rubygems.org/api/v1/owners/${user}/gems.json` | ||
| const json = await this._requestJson({ | ||
| url, | ||
| schema: Joi.array(), | ||
|
There was a problem hiding this comment. Looks like this one is pending ^^ There was a problem hiding this comment. I intentionally left this because in this badge we are not using any of the data in the array - we are just counting the number of elements in it. As long the response is an array we're fine. I've moved the declaration out of the class and made it |
||
| }) | ||
| const count = json.length | ||
|
|
||
| return { | ||
| message: count, | ||
| color: floorCountColor(count, 10, 50, 100), | ||
| } | ||
| } | ||
|
|
||
| // Metadata | ||
| static get defaultBadgeData() { | ||
| return { label: 'gems' } | ||
| } | ||
|
|
||
| static get category() { | ||
| return 'other' | ||
| } | ||
|
|
||
| static get url() { | ||
| return { | ||
| base: 'gem/u', | ||
| format: '(.+)', | ||
| capture: ['user'], | ||
| } | ||
| } | ||
|
|
||
| static get examples() { | ||
| return [ | ||
| { | ||
| title: 'Gems', | ||
| previewUrl: 'raphink', | ||
| keywords: ['ruby'], | ||
| }, | ||
| ] | ||
| } | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
❤️