feat(overview-analysis): expose parties overview

README.md

@@ -29,9 +29,13 @@ npm install @codetanzania/ewea-reports --save
 ## Usage
 
 ```js
-import { getPartyAnalysis } from '@codetanzania/ewea-reports';
+import {
+  getOverviewAnalysis,
+  getPartyAnalysis
+} from '@codetanzania/ewea-reports';
 
 const criteria = { ... };
+getOverviewAnalysis(criteria, (error, report) => { ... });
 getPartyAnalysis(criteria, (error, report) => { ... });
 ```
 

src/aggregations/overview.aggregations.js

@@ -0,0 +1,30 @@
+import { isFunction } from 'lodash';
+import { parallel } from 'async';
+import { safeMergeObjects } from '@lykmapipo/common';
+import { getPartyOverview } from './party.aggregations';
+
+export const DEFAULT_OVERVIEW_ANALYSIS = {
+  parties: { total: 0, agency: 0, focal: 0 },
+};
+
+export const getOverviewAnalysis = (criteria, done) => {
+  // normalize arguments
+  const filter = isFunction(criteria) ? {} : criteria;
+  const cb = isFunction(criteria) ? criteria : done;
+
+  // tasks
+  const parties = (next) => getPartyOverview(filter, next);
+  const tasks = { parties };
+
+  // return
+  return parallel(tasks, (error, overviews) => {
+    // back-off on error
+    if (error) {
+      return cb(error);
+    }
+
+    // normalize and return
+    const data = safeMergeObjects(DEFAULT_OVERVIEW_ANALYSIS, overviews);
+    return cb(null, { data });
+  });
+};

src/index.js

@@ -29,6 +29,7 @@ export * from './aggregations/changelog.aggregations';
 export * from './aggregations/event.aggregations';
 export * from './aggregations/party.aggregations';
 export * from './aggregations/predefine.aggregations';
+export * from './aggregations/overview.aggregations';
 
 /**
  * @name info

src/report.http.router.js

@@ -2,6 +2,7 @@ import { getString } from '@lykmapipo/env';
 import { Router } from '@lykmapipo/express-rest-actions';
 
 import { getPartyAnalysis } from './aggregations/party.aggregations';
+import { getOverviewAnalysis } from './aggregations/overview.aggregations';
 
 /* constants */
 const API_VERSION = getString('API_VERSION', '1.0.0');
@@ -47,8 +48,13 @@ const router = new Router({
  * @version 1.0.0
  * @public
  */
-router.get(PATH_OVERVIEW, (request, response) => {
-  response.ok({});
+router.get(PATH_OVERVIEW, (request, response, next) => {
+  return getOverviewAnalysis({}, (error, report) => {
+    if (error) {
+      return next(error);
+    }
+    return response.ok(report);
+  });
 });
 
 /**

test/integration/overview.aggregations.spec.js

@@ -0,0 +1,28 @@
+import {
+  expect,
+  // enableDebug
+} from '@lykmapipo/mongoose-test-helpers';
+
+import { getOverviewAnalysis } from '../../src';
+
+describe('Overview Aggregations', () => {
+  it('should provide overview analysis', (done) => {
+    getOverviewAnalysis((error, report) => {
+      expect(error).to.not.exist;
+      expect(report).to.exist.and.be.an('object');
+      expect(report.data).to.exist.and.be.an('object');
+      expect(report.data.parties).to.be.eql({
+        total: 4,
+        agency: 2,
+        focal: 2,
+        level: 4, // FIX
+        area: 4, // FIX
+        group: 4, // FIX
+        role: 4, // FIX
+        active: 4,
+        inactive: 0,
+      });
+      done(error, report);
+    });
+  });
+});

test/integration/report.http.router.spec.js

@@ -16,7 +16,19 @@ describe('Reports Rest API', () => {
       .expect('Content-Type', /json/)
       .end((error, { body }) => {
         expect(error).to.not.exist;
-        expect(body).to.exist;
+        expect(body).to.exist.and.be.an('object');
+        expect(body.data).to.exist.and.be.an('object');
+        expect(body.data.parties).to.be.eql({
+          total: 4,
+          agency: 2,
+          focal: 2,
+          level: 4, // FIX
+          area: 4, // FIX
+          group: 4, // FIX
+          role: 4, // FIX
+          active: 4,
+          inactive: 0,
+        });
         done(error, body);
       });
   });