102 lines
2.6 KiB
JavaScript
102 lines
2.6 KiB
JavaScript
import Joi from 'joi'
|
|
import { nonNegativeInteger } from '../validators.js'
|
|
import { coveragePercentage } from '../color-formatters.js'
|
|
import { BaseJsonService, InvalidResponse } from '../index.js'
|
|
|
|
const documentation = `
|
|
You must specify the read-only API token from the POEditor account to which the project belongs.
|
|
|
|
As per [the POEditor API documentation](https://poeditor.com/docs/api)
|
|
|
|
> All requests to the API must contain the parameter api_token.
|
|
> You can get a read-only key from your POEditor account.
|
|
> You'll find it in [My Account > API Access](https://poeditor.com/account/api).
|
|
`
|
|
|
|
const schema = Joi.object({
|
|
response: Joi.object({
|
|
code: nonNegativeInteger,
|
|
message: Joi.string().required(),
|
|
}).required(),
|
|
result: Joi.object({
|
|
languages: Joi.array()
|
|
.items({
|
|
name: Joi.string().required(),
|
|
code: Joi.string().required(),
|
|
percentage: Joi.number().min(0).max(100).required(),
|
|
})
|
|
.required(),
|
|
}),
|
|
}).required()
|
|
|
|
const queryParamSchema = Joi.object({
|
|
token: Joi.string().required(),
|
|
}).required()
|
|
|
|
export default class POEditor extends BaseJsonService {
|
|
static category = 'other'
|
|
|
|
static route = {
|
|
base: 'poeditor',
|
|
pattern: 'progress/:projectId/:languageCode',
|
|
queryParamSchema,
|
|
}
|
|
|
|
static examples = [
|
|
{
|
|
title: 'POEditor',
|
|
namedParams: { projectId: '323337', languageCode: 'fr' },
|
|
queryParams: { token: 'abc123def456' },
|
|
staticPreview: this.render({
|
|
code: 200,
|
|
message: 'OK',
|
|
language: { percentage: 93, code: 'fr', name: 'French' },
|
|
}),
|
|
keywords: ['l10n'],
|
|
documentation,
|
|
},
|
|
]
|
|
|
|
static render({ code, message, language }) {
|
|
if (code !== 200) {
|
|
throw new InvalidResponse({ prettyMessage: message })
|
|
}
|
|
|
|
if (language === undefined) {
|
|
throw new InvalidResponse({ prettyMessage: 'Language not in project' })
|
|
}
|
|
|
|
return {
|
|
label: language.name,
|
|
message: `${language.percentage.toFixed(0)}%`,
|
|
color: coveragePercentage(language.percentage),
|
|
}
|
|
}
|
|
|
|
async fetch({ projectId, token }) {
|
|
return this._requestJson({
|
|
schema,
|
|
url: 'https://api.poeditor.com/v2/languages/list',
|
|
options: {
|
|
method: 'POST',
|
|
form: {
|
|
api_token: token,
|
|
id: projectId,
|
|
},
|
|
},
|
|
})
|
|
}
|
|
|
|
async handle({ projectId, languageCode }, { token }) {
|
|
const {
|
|
response: { code, message },
|
|
result: { languages } = { languages: [] },
|
|
} = await this.fetch({ projectId, token })
|
|
return this.constructor.render({
|
|
code,
|
|
message,
|
|
language: languages.find(lang => lang.code === languageCode),
|
|
})
|
|
}
|
|
}
|