From 06ea6732deeba93dc1de97b0f903792ae963da67 Mon Sep 17 00:00:00 2001 From: Ty Date: Fri, 22 Mar 2024 18:44:49 -0600 Subject: [PATCH] Add pronouns.cc verification --- src/serviceProviders/index.js | 4 +- src/serviceProviders/pronounscc.js | 100 +++++++++++++++++++++++++++++ 2 files changed, 103 insertions(+), 1 deletion(-) create mode 100644 src/serviceProviders/pronounscc.js diff --git a/src/serviceProviders/index.js b/src/serviceProviders/index.js index 51b01df..2fc31a0 100644 --- a/src/serviceProviders/index.js +++ b/src/serviceProviders/index.js @@ -38,6 +38,7 @@ import * as stackexchange from './stackexchange.js' import * as keybase from './keybase.js' import * as opencollective from './opencollective.js' import * as orcid from './orcid.js' +import * as pronounscc from './pronounscc.js' const _data = { aspe, @@ -64,7 +65,8 @@ const _data = { stackexchange, keybase, opencollective, - orcid + orcid, + pronounscc } export const list = Object.keys(_data) diff --git a/src/serviceProviders/pronounscc.js b/src/serviceProviders/pronounscc.js new file mode 100644 index 0000000..7c2ad9b --- /dev/null +++ b/src/serviceProviders/pronounscc.js @@ -0,0 +1,100 @@ +/* +Copyright 2024 Tyler Beckman + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + +http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +*/ +/** + * pronouns.cc service provider + * @module serviceProviders/pronounscc + * @example + * import { ServiceProviderDefinitions } from 'doipjs'; + * const sp = ServiceProviderDefinitions.data.pronounscc.processURI('https://pronouns.cc/@Alice'); + */ + +import * as E from '../enums.js' +import { ServiceProvider } from '../serviceProvider.js' + +export const reURI = /^https:\/\/pronouns\.cc\/@(.*)\/?/ + +/** + * @function + * @param {string} uri - Claim URI to process + * @returns {ServiceProvider} The service provider information based on the claim URI + */ +export function processURI (uri) { + const match = uri.match(reURI) + + return new ServiceProvider({ + about: { + id: 'pronounscc', + name: 'pronouns.cc', + homepage: 'https://pronouns.cc' + }, + profile: { + display: `@${match[1]}`, + uri: `https://pronouns.cc/@${match[1]}`, + qr: null + }, + claim: { + uriRegularExpression: reURI.toString(), + uriIsAmbiguous: false + }, + proof: { + request: { + uri, + fetcher: E.Fetcher.HTTP, + accessRestriction: E.ProofAccessRestriction.NOCORS, + data: { + url: `https://pronouns.cc/api/v1/users/${match[1]}`, + format: E.ProofFormat.JSON + } + }, + response: { + format: E.ProofFormat.JSON + }, + target: [ + { + format: E.ClaimFormat.URI, + encoding: E.EntityEncodingFormat.PLAIN, + relation: E.ClaimRelation.CONTAINS, + path: ['links'] + }, + { + format: E.ClaimFormat.URI, + encoding: E.EntityEncodingFormat.PLAIN, + relation: E.ClaimRelation.CONTAINS, + path: ['bio'] + } + ] + } + }) +} + +export const tests = [ + { + uri: 'https://pronouns.cc/@Alice', + shouldMatch: true + }, + { + uri: 'https://pronouns.cc/@Alice/', + shouldMatch: true + }, + { + uri: 'https://pronouns.cc/Alice', + shouldMatch: false + }, + { + uri: 'https://pronouns.cc/Alice/', + shouldMatch: false + } +]