@opentermsarchive/engine 0.32.0 → 0.33.0

package/config/default.json

@@ -54,15 +54,6 @@
       "updateTemplateId": 7
     }
   },
-  "reporter": {
-    "githubIssues": {
-      "repositories": {
-        "declarations": "OpenTermsArchive/sandbox-declarations",
-        "versions": "OpenTermsArchive/sandbox-versions",
-        "snapshots": "OpenTermsArchive/sandbox-snapshots"
-      }
-    }
-  },
   "dataset": {
     "title": "sandbox",
     "versionsRepositoryURL": "https://github.com/OpenTermsArchive/sandbox"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opentermsarchive/engine",
-  "version": "0.32.0",
+  "version": "0.33.0",
   "description": "Tracks and makes visible changes to the terms of online services",
   "homepage": "https://github.com/OpenTermsArchive/engine#readme",
   "bugs": {

package/src/api/routes/docs.test.js

@@ -57,7 +57,6 @@ describe('Docs API', () => {
     context('When requested as HTML', () => {
       before(async () => {
         response = await request(app).get(`${basePath}/v1/docs/`);
-        console.log(response);
       });
 
       it('responds with 200 status code', () => {

package/src/api/routes/services.js

@@ -72,12 +72,29 @@ const router = express.Router();
  *             schema:
  *               type: array
  *               items:
- *                 $ref: '#/components/schemas/Service'
+ *                 type: object
+ *                 properties:
+ *                   id:
+ *                     type: string
+ *                     description: The ID of the service.
+ *                   name:
+ *                     type: string
+ *                     description: The name of the service.
+ *                   terms:
+ *                     type: array
+ *                     description: The declared terms types for this service.
+ *                     items:
+ *                       type: object
+ *                       properties:
+ *                         type:
+ *                           type: string
+ *                           description: The type of terms.
  */
 router.get('/services', (req, res) => {
   res.status(200).json(Object.values(services).map(service => ({
     id: service.id,
     name: service.name,
+    terms: service.getTermsTypes().map(type => ({ type })),
   })));
 });
 

package/src/api/routes/services.test.js

@@ -37,6 +37,20 @@ describe('Services API', () => {
         expect(service).to.have.property('name');
       });
     });
+
+    it('each service should have a terms array', () => {
+      response.body.forEach(service => {
+        expect(service).to.have.property('terms').that.is.an('array');
+      });
+    });
+
+    it('each terms should have a type', () => {
+      response.body.forEach(service => {
+        service.terms.forEach(terms => {
+          expect(terms).to.have.property('type');
+        });
+      });
+    });
   });
 
   describe('GET /service/:serviceId', () => {

package/src/index.js

@@ -43,10 +43,14 @@ export default async function track({ services, types, extractOnly, schedule })
   }
 
   if (process.env.GITHUB_TOKEN) {
-    const reporter = new Reporter(config.get('reporter'));
-
-    await reporter.initialize();
-    archivist.attach(reporter);
+    if (config.has('reporter.githubIssues.repositories.declarations')) {
+      const reporter = new Reporter(config.get('reporter'));
+
+      await reporter.initialize();
+      archivist.attach(reporter);
+    } else {
+      logger.warn('Configuration key "reporter.githubIssues.repositories.declarations" was not found; the Reporter module will be ignored\n');
+    }
   }
 
   if (!schedule) {

package/src/reporter/index.js

@@ -132,8 +132,8 @@ If the source documents are accessible in a browser but fetching them always fai
 ### References
 
 - ${latestDeclarationLink}
-- ${latestVersionLink}
-- ${latestSnapshotsLink}
+${this.repositories.versions ? `- ${latestVersionLink}` : ''}
+${this.repositories.snapshots ? `- ${latestSnapshotsLink}` : ''} 
 `;
   /* eslint-enable no-irregular-whitespace */
   }