-
-
Notifications
You must be signed in to change notification settings - Fork 5.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add wikiapiary extension badge
- Loading branch information
Showing
2 changed files
with
76 additions
and
0 deletions.
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
'use strict' | ||
|
||
const Joi = require('joi') | ||
const { metric } = require('../text-formatters') | ||
const { BaseJsonService } = require('..') | ||
|
||
const schema = Joi.object({ | ||
query: Joi.object({ | ||
results: Joi.object() | ||
.required() | ||
.pattern(/^.+:.+$/, { | ||
printouts: Joi.object({ | ||
'Has website count': Joi.array() | ||
.required() | ||
.items(Joi.number().required()), | ||
}).required(), | ||
}), | ||
}).required(), | ||
}).required() | ||
|
||
/** | ||
* This badge displays the total usages of a MediaWiki extensions via | ||
* Wikiapiary. | ||
* | ||
* {@link https://www.mediawiki.org/wiki/Manual:Extensions MediaWiki Extensions Manual} | ||
*/ | ||
module.exports = class WikiapiaryExtension extends BaseJsonService { | ||
static category = 'downloads' | ||
static route = { | ||
base: 'wikiapiary/extensions', | ||
pattern: ':type/:extension', | ||
} | ||
|
||
static examples = [ | ||
{ | ||
title: 'Wikiapiary extension usage', | ||
namedParams: { type: 'Extension', extension: 'ParserFunctions' }, | ||
staticPreview: this.render({ usage: 11170 }), | ||
keywords: ['mediawiki'], | ||
}, | ||
] | ||
|
||
static defaultBadgeData = { label: 'usage', color: 'informational' } | ||
|
||
static render({ usage }) { | ||
return { message: metric(usage) } | ||
} | ||
|
||
async fetch({ type, extension }) { | ||
return this._requestJson({ | ||
schema, | ||
url: `https://wikiapiary.com/w/api.php?action=ask&query=[[${type}:${extension}]]|?Has_website_count&format=json`, | ||
}) | ||
} | ||
|
||
async handle({ type, extension }) { | ||
const response = await this.fetch({ type, extension }) | ||
const [usage] = | ||
response.query.results[`${type}:${extension}`].printouts[ | ||
'Has website count' | ||
] | ||
return this.constructor.render({ usage }) | ||
} | ||
} |
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,12 @@ | ||
'use strict' | ||
|
||
const t = (module.exports = require('../tester').createServiceTester()) | ||
const { isMetric } = require('../test-validators') | ||
|
||
t.create('Extension') | ||
.get('/Extension/ParserFunctions.json') | ||
.expectBadge({ label: 'usage', message: isMetric }) | ||
|
||
t.create('Skins') | ||
.get('/Skin/Vector.json') | ||
.expectBadge({ label: 'usage', message: isMetric }) |