[openuserjs] Add OpenUserJS service badges

services/openuserjs/openuserjs-base.js

@@ -0,0 +1,49 @@
+import Joi from 'joi'
+import { nonNegativeInteger } from '../validators.js'
+import { BaseJsonService } from '../index.js'
+
+const schema = Joi.object({
+  UserScript: Joi.object({
+    version: Joi.array().items(
+      Joi.object({
+        value: Joi.string().required(),
+      })
+    ),
+    license: Joi.array().items(
+      Joi.object({
+        value: Joi.string().required(),
+      })
+    ),
+  }).required(),
+  OpenUserJS: Joi.object({
+    installs: Joi.array()
+      .items(
+        Joi.object({
+          value: nonNegativeInteger,
+        })
+      )
+      .required(),
+    issues: Joi.array()
+      .items(
+        Joi.object({
+          value: nonNegativeInteger,
+        })
+      )
+      .required(),
+  }).required(),
+}).required()
+
+export default class BaseOpenUserJSService extends BaseJsonService {
+  static defaultBadgeData = { label: 'openuserjs' }
+
+  async fetch({ username, scriptname }) {
+    return this._requestJson({
+      schema,
+      url: `https://openuserjs.org/meta/${username}/${scriptname}.meta.json`,
+      errorMessages: {
+        404: 'user or project not found',
+        429: 'rate limited by remote server',
+      },
+    })
+  }
+}

services/openuserjs/openuserjs-downloads.service.js

@@ -0,0 +1,27 @@
+import { renderDownloadsBadge } from '../downloads.js'
+import BaseOpenUserJSService from './openuserjs-base.js'
+
+export default class OpenUserJSDownloads extends BaseOpenUserJSService {
+  static category = 'downloads'
+  static route = { base: 'openuserjs', pattern: 'dt/:username/:scriptname' }
+
+  static examples = [
+    {
+      title: 'OpenUserJS',
+      namedParams: {
+        username: 'NatoBoram',
+        scriptname: 'YouTube_Comment_Blacklist',
+      },
+      staticPreview: renderDownloadsBadge({ downloads: 47 }),
+    },
+  ]
+
+  static defaultBadgeData = { label: 'downloads' }
+
+  async handle({ username, scriptname }) {
+    const data = await this.fetch({ username, scriptname })
+    return renderDownloadsBadge({
+      downloads: data.OpenUserJS.installs[0].value,
+    })
+  }
+}

services/openuserjs/openuserjs-downloads.tester.js

@@ -0,0 +1,11 @@
+import { isMetric } from '../test-validators.js'
+import { createServiceTester } from '../tester.js'
+export const t = await createServiceTester()
+
+t.create('Downloads')
+  .get('/dt/NatoBoram/YouTube_Comment_Blacklist.json')
+  .expectBadge({ label: 'downloads', message: isMetric })
+
+t.create('Downloads (not found)')
+  .get('/dt/DenverCoder1/NotAScript1.json')
+  .expectBadge({ label: 'downloads', message: 'user or project not found' })

services/openuserjs/openuserjs-issues.service.js

@@ -0,0 +1,34 @@
+import { metric } from '../text-formatters.js'
+import BaseOpenUserJSService from './openuserjs-base.js'
+
+export default class OpenUserJSIssues extends BaseOpenUserJSService {
+  static category = 'issue-tracking'
+  static route = { base: 'openuserjs', pattern: 'issues/:username/:scriptname' }
+
+  static examples = [
+    {
+      title: 'OpenUserJS',
+      namedParams: {
+        username: 'NatoBoram',
+        scriptname: 'YouTube_Comment_Blacklist',
+      },
+      staticPreview: this.render({ issues: 0 }),
+    },
+  ]
+
+  static defaultBadgeData = { label: 'issues' }
+
+  static render({ issues }) {
+    return {
+      message: metric(issues),
+      color: issues ? 'yellow' : 'brightgreen',
+    }
+  }
+
+  async handle({ username, scriptname }) {
+    const data = await this.fetch({ username, scriptname })
+    return this.constructor.render({
+      issues: data.OpenUserJS.issues[0].value,
+    })
+  }
+}

services/openuserjs/openuserjs-issues.tester.js

@@ -0,0 +1,11 @@
+import { isMetric } from '../test-validators.js'
+import { createServiceTester } from '../tester.js'
+export const t = await createServiceTester()
+
+t.create('Issues')
+  .get('/issues/MAX30/TopAndDownButtonsEverywhere.json')
+  .expectBadge({ label: 'issues', message: isMetric })
+
+t.create('Issues (not found)')
+  .get('/issues/DenverCoder1/NotAScript2.json')
+  .expectBadge({ label: 'issues', message: 'user or project not found' })

services/openuserjs/openuserjs-license.service.js

@@ -0,0 +1,39 @@
+import { InvalidResponse } from '../index.js'
+import { renderLicenseBadge } from '../licenses.js'
+import BaseOpenUserJSService from './openuserjs-base.js'
+
+export default class OpenUserJSLicense extends BaseOpenUserJSService {
+  static category = 'license'
+  static route = { base: 'openuserjs', pattern: 'l/:username/:scriptname' }
+
+  static examples = [
+    {
+      title: 'OpenUserJS',
+      namedParams: {
+        username: 'NatoBoram',
+        scriptname: 'YouTube_Comment_Blacklist',
+      },
+      staticPreview: renderLicenseBadge({ licenses: ['GPL-3.0-or-later'] }),
+    },
+  ]
+
+  static defaultBadgeData = { label: 'license' }
+
+  transform(data) {
+    if (!('license' in data.UserScript)) {
+      throw new InvalidResponse({
+        prettyMessage: 'license not found',
+      })
+    }
+    const licenses = data.UserScript.license.map(
+      license => license.value.split('; ')[0]
+    )
+    return { licenses: licenses.reverse() }
+  }
+
+  async handle({ username, scriptname }) {
+    const data = await this.fetch({ username, scriptname })
+    const { licenses } = this.transform(data)
+    return renderLicenseBadge({ licenses })
+  }
+}

services/openuserjs/openuserjs-license.tester.js

@@ -0,0 +1,20 @@
+import { createServiceTester } from '../tester.js'
+export const t = await createServiceTester()
+
+t.create('License (valid)')
+  .get('/l/DenverCoder1/Unedit_and_Undelete_for_Reddit.json')
+  .expectBadge({
+    label: 'license',
+    message: 'MIT',
+  })
+
+t.create('Licenses (multiple)')
+  .get('/l/Marti/oujs_-_Meta_View.json')
+  .expectBadge({
+    label: 'license',
+    message: 'GPL-3.0-or-later, CC-BY-NC-SA-4.0',
+  })
+
+t.create('License (not found)')
+  .get('/l/DenverCoder1/NotAScript3.json')
+  .expectBadge({ label: 'license', message: 'user or project not found' })

services/openuserjs/openuserjs-version.service.js

@@ -0,0 +1,31 @@
+import { InvalidResponse } from '../index.js'
+import { renderVersionBadge } from '../version.js'
+import BaseOpenUserJSService from './openuserjs-base.js'
+
+export default class OpenUserJSVersion extends BaseOpenUserJSService {
+  static category = 'version'
+  static route = { base: 'openuserjs', pattern: 'v/:username/:scriptname' }
+
+  static examples = [
+    {
+      title: 'OpenUserJS',
+      namedParams: {
+        username: 'NatoBoram',
+        scriptname: 'YouTube_Comment_Blacklist',
+      },
+      staticPreview: renderVersionBadge({ version: '0.0.7' }),
+    },
+  ]
+
+  async handle({ username, scriptname }) {
+    const data = await this.fetch({ username, scriptname })
+    if (!('version' in data.UserScript)) {
+      throw new InvalidResponse({
+        prettyMessage: 'version not found',
+      })
+    }
+    return renderVersionBadge({
+      version: data.UserScript.version.at(-1).value,
+    })
+  }
+}

services/openuserjs/openuserjs-version.tester.js

@@ -0,0 +1,18 @@
+import { isVPlusDottedVersionAtLeastOne } from '../test-validators.js'
+import { createServiceTester } from '../tester.js'
+export const t = await createServiceTester()
+
+t.create('Version')
+  .get('/v/DenverCoder1/Unedit_and_Undelete_for_Reddit.json')
+  .expectBadge({
+    label: 'openuserjs',
+    message: isVPlusDottedVersionAtLeastOne,
+  })
+
+t.create('Version (invalid parameters)')
+  .get('/v/DenverCoder1/NotAScript4.json')
+  .expectBadge({ label: 'openuserjs', message: 'user or project not found' })
+
+t.create('Version (no version found)')
+  .get('/v/DenverCoder1/Example_no_version.json')
+  .expectBadge({ label: 'openuserjs', message: 'version not found' })