@opentermsarchive/engine 4.1.0 → 5.0.0

package/README.md

@@ -1,6 +1,6 @@
 # Open Terms Archive Engine
 
-This codebase is a Node.js module enabling downloading, archiving and publishing versions of documents obtained online. It can be used independently from the Open Terms Archive ecosystem. For a high-level overview of Open Terms Archive’s wider goals and processes, please read its [public homepage](https://opentermsarchive.org).
+This codebase is a Node.js module enabling downloading, archiving and publishing versions of terms obtained online. It can be used independently from the Open Terms Archive ecosystem. For a high-level overview of Open Terms Archive’s wider goals and processes, please read its [public homepage](https://opentermsarchive.org).
 
 For documentation, visit [docs.opentermsarchive.org](https://docs.opentermsarchive.org/)
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opentermsarchive/engine",
-  "version": "4.1.0",
+  "version": "5.0.0",
   "description": "Tracks and makes visible changes to the terms of online services",
   "homepage": "https://opentermsarchive.org",
   "bugs": {

package/scripts/declarations/utils/fixtures/serviceA.json

@@ -1,6 +1,6 @@
 {
   "name": "Service",
-  "documents": {
+  "terms": {
     "Terms of Service": {
       "fetch": "https://domain.example/tos",
       "select": "body"

package/scripts/declarations/utils/fixtures/serviceAMultipleTermsUpdated.json

@@ -1,6 +1,6 @@
 {
   "name": "Service",
-  "documents": {
+  "terms": {
     "Terms of Service": {
       "fetch": "https://domain.example/tos",
       "select": "body",

package/scripts/declarations/utils/fixtures/serviceATermsAdded.json

@@ -1,6 +1,6 @@
 {
   "name": "Service",
-  "documents": {
+  "terms": {
     "Terms of Service": {
       "fetch": "https://domain.example/tos",
       "select": "body"

package/scripts/declarations/utils/fixtures/serviceATermsRemoved.json

@@ -1,6 +1,6 @@
 {
   "name": "Service",
-  "documents": {
+  "terms": {
     "Terms of Service": {
       "fetch": "https://domain.example/tos",
       "select": "body"

package/scripts/declarations/utils/fixtures/serviceATermsUpdated.json

@@ -1,6 +1,6 @@
 {
   "name": "Service",
-  "documents": {
+  "terms": {
     "Terms of Service": {
       "fetch": "https://domain.example/tos",
       "select": "body",

package/scripts/declarations/utils/fixtures/serviceB.json

@@ -1,6 +1,6 @@
 {
   "name": "Service B",
-  "documents": {
+  "terms": {
     "Terms of Service": {
       "fetch": "https://domain.example/tos",
       "select": "body"

package/scripts/declarations/utils/index.js

@@ -50,14 +50,14 @@ export default class DeclarationUtils {
       if (modifiedFilePath.endsWith('.filters.js')) {
         const declaration = await this.getJSONFromFile(this.defaultBranch, `declarations/${serviceId}.json`);
 
-        servicesTermsTypes[serviceId] = Object.keys(declaration.documents); // Considering how rarely filters are used, simply return all term types that could potentially be impacted to spare implementing a function change check
+        servicesTermsTypes[serviceId] = Object.keys(declaration.terms); // Considering how rarely filters are used, simply return all term types that could potentially be impacted to spare implementing a function change check
 
         return;
       }
 
       const originalService = await this.getJSONFromFile(this.defaultBranch, modifiedFilePath);
       const modifiedService = await this.getJSONFromFile('HEAD', modifiedFilePath);
-      const modifiedServiceTermsTypes = Object.keys(modifiedService.documents);
+      const modifiedServiceTermsTypes = Object.keys(modifiedService.terms);
 
       if (!originalService) {
         servicesTermsTypes[serviceId] = modifiedServiceTermsTypes;
@@ -65,11 +65,11 @@ export default class DeclarationUtils {
         return;
       }
 
-      const originalServiceTermsTypes = Object.keys(originalService.documents);
+      const originalServiceTermsTypes = Object.keys(originalService.terms);
 
       modifiedServiceTermsTypes.forEach(termsType => {
         const areTermsAdded = !originalServiceTermsTypes.includes(termsType);
-        const areTermsModified = JSON.stringify(originalService.documents[termsType]) != JSON.stringify(modifiedService.documents[termsType]);
+        const areTermsModified = JSON.stringify(originalService.terms[termsType]) != JSON.stringify(modifiedService.terms[termsType]);
 
         if (!areTermsAdded && !areTermsModified) {
           return;

package/scripts/declarations/validate/service.schema.js

@@ -24,14 +24,14 @@ const schema = {
   type: 'object',
   additionalProperties: false,
   title: 'Service declaration',
-  required: [ 'name', 'documents' ],
+  required: [ 'name', 'terms' ],
   properties: {
     name: {
       type: 'string',
       title: 'Service public name',
       examples: ['Facebook'],
     },
-    documents: {
+    terms: {
       type: 'object',
       properties: termsProperties(),
       propertyNames: { enum: AVAILABLE_TYPES_NAME },

package/src/archivist/services/index.js

@@ -21,7 +21,7 @@ export async function load(servicesIdsToLoad = []) {
   const services = {};
 
   await Promise.all(servicesIds.map(async serviceId => {
-    const { name, documents: terms } = await loadServiceDeclaration(serviceId);
+    const { name, terms } = await loadServiceDeclaration(serviceId);
 
     const service = new Service({ id: serviceId, name });
 
@@ -220,9 +220,9 @@ async function loadServiceHistoryFiles(serviceId) {
     }
   }
 
-  Object.keys(serviceDeclaration.documents).forEach(termsType => {
+  Object.keys(serviceDeclaration.terms).forEach(termsType => {
     serviceHistory[termsType] = serviceHistory[termsType] || [];
-    serviceHistory[termsType].push(serviceDeclaration.documents[termsType]);
+    serviceHistory[termsType].push(serviceDeclaration.terms[termsType]);
   });
 
   sortHistory(serviceHistory);

package/src/archivist/services/terms.js

@@ -16,7 +16,7 @@ export default class Terms {
   toPersistence() {
     return {
       name: this.service.name,
-      documents: {
+      terms: {
         [this.type]: this.hasMultipleSourceDocuments
           ? { combine: this.sourceDocuments.map(sourceDocument => sourceDocument.toPersistence()) }
           : this.sourceDocuments[0].toPersistence(),

package/src/archivist/services/terms.test.js

@@ -65,7 +65,7 @@ describe('Terms', () => {
 
       const expectedResult = {
         name: service.name,
-        documents: { [termsType]: document1AsJSON },
+        terms: { [termsType]: document1AsJSON },
       };
 
       expect(result).to.deep.equal(expectedResult);
@@ -76,7 +76,7 @@ describe('Terms', () => {
 
       const expectedResult = {
         name: service.name,
-        documents: { [termsType]: { combine: [ document1AsJSON, document2AsJSON ] } },
+        terms: { [termsType]: { combine: [ document1AsJSON, document2AsJSON ] } },
       };
 
       expect(result).to.deep.equal(expectedResult);

package/src/reporter/gitlab/index.js

@@ -18,9 +18,7 @@ export default class GitLab {
   static ISSUE_STATE_ALL = 'all';
 
   constructor(repository, baseURL = BASE_URL, apiBaseURL = API_BASE_URL) {
-    const [ owner, repo ] = repository.split('/');
-
-    this.commonParams = { owner, repo };
+    this.repositoryPath = repository;
     this.projectId = null;
     this.baseURL = baseURL;
     console.log('this.baseURL', this.baseURL);
@@ -31,9 +29,8 @@ export default class GitLab {
     const options = GitLab.baseOptionsHttpReq();
 
     try {
-      const repositoryPath = `${this.commonParams.owner}/${this.commonParams.repo}`;
       const response = await nodeFetch(
-        `${this.apiBaseURL}/projects/${encodeURIComponent(repositoryPath)}`,
+        `${this.apiBaseURL}/projects/${encodeURIComponent(this.repositoryPath)}`,
         options,
       );
 
@@ -42,7 +39,7 @@ export default class GitLab {
       if (response.ok) {
         this.projectId = res.id;
       } else {
-        logger.error(`Error while obtaining projectId: ${JSON.strinfigy(res)}`);
+        logger.error(`Error while obtaining projectId: ${JSON.stringify(res)}`);
         this.projectId = null;
       }
     } catch (error) {
@@ -367,15 +364,15 @@ export default class GitLab {
   }
 
   generateDeclarationURL(serviceName) {
-    return `${this.baseURL}/${this.commonParams.owner}/${this.commonParams.repo}/-/blob/main/declarations/${encodeURIComponent(serviceName)}.json`;
+    return `${this.baseURL}/${this.repositoryPath}/-/blob/main/declarations/${encodeURIComponent(serviceName)}.json`;
   }
 
   generateVersionURL(serviceName, termsType) {
-    return `${this.baseURL}/${this.commonParams.owner}/${this.commonParams.repo}/-/blob/main/${encodeURIComponent(serviceName)}/${encodeURIComponent(serviceName, termsType)}.md`;
+    return `${this.baseURL}/${this.repositoryPath}/-/blob/main/${encodeURIComponent(serviceName)}/${encodeURIComponent(serviceName, termsType)}.md`;
   }
 
   generateSnapshotsBaseUrl(serviceName, termsType) {
-    return `${this.baseURL}/${this.commonParams.owner}/${this.commonParams.repo}/-/blob/main/${encodeURIComponent(serviceName)}/${encodeURIComponent(termsType)}`;
+    return `${this.baseURL}/${this.repositoryPath}/-/blob/main/${encodeURIComponent(serviceName)}/${encodeURIComponent(termsType)}`;
   }
 
   // GitLab API responses are not cached unlike GitHub, so this method only exists to satisfy the Reporter interface contract