Release 5.1.0

.env.sample

@@ -30,4 +30,13 @@ SUBMISSION_TOPIC = "dev.sl.projects.submissions"
 PROJECT_SUBMISSION_TOPIC = "dev.sl.projects.submissions"                        // project submission topic 
 
 # SUNBIRD LOCATION AND USER READ
-USER_SERVICE_URL = "http://user-service:3000"                                   // service used for user profile read location search are using this base url
+USER_SERVICE_URL = "http://user-service:3000"                                   // service used for user profile read location search are using this base url
+
+#service name
+SERVICE_NAME = ml-project-service                                               // ml-project service name
+
+# sunbird-rc service
+CERTIFICATE_SERVICE_URL = http://registry-service:8081                          // sunbird-RC registry service URL
+
+PROJECT_CERTIFICATE_ON_OFF = "ON/OFF"                                           // Project certificate enable or disable flag
+

config/globals.js

@@ -76,6 +76,7 @@ module.exports = function () {
       global.schemas[name] = require(PROJECT_ROOT_DIRECTORY + '/models/' + file);
     }
   });
+
 
   // All controllers
   global.controllers = requireAll({

config/kafka.js

@@ -9,6 +9,7 @@
 //dependencies
 const kafka = require('kafka-node');
 const SUBMISSION_TOPIC = process.env.SUBMISSION_TOPIC;
+const CERTIFICATE_TOPIC = process.env.PROJECT_SUBMISSION_TOPIC;
 
 /**
   * Kafka configurations.
@@ -44,6 +45,12 @@ const connect = function() {
       process.env.KAFKA_URL
     );
 
+    //  project certificate details consumer
+    _sendToKafkaConsumers(
+      CERTIFICATE_TOPIC,
+      process.env.KAFKA_URL
+    );
+
     return {
       kafkaProducer: producer,
       kafkaClient: client
@@ -82,6 +89,10 @@ var _sendToKafkaConsumers = function (topic,host) {
       if (message && message.topic === SUBMISSION_TOPIC) {
         submissionsConsumer.messageReceived(message);
       }
+      // call projectCertificateConsumer 
+      if (message && message.topic === CERTIFICATE_TOPIC) {
+        projectCertificateConsumer.messageReceived(message);
+      }
 
     });
 
@@ -90,6 +101,9 @@ var _sendToKafkaConsumers = function (topic,host) {
       if(error.topics && error.topics[0] === SUBMISSION_TOPIC) {
         submissionsConsumer.errorTriggered(error);
       }
+      if(error.topics && error.topics[0] === CERTIFICATE_TOPIC) {
+        projectCertificateConsumer.errorTriggered(error);
+      }
 
     });
 

controllers/v1/certificateTemplates.js

@@ -0,0 +1,16 @@
+/**
+ * name : certificateTemplates.js
+ * author : Vishnu
+ * created-date : 29-Sep-2022
+ * Description : Certificate template related information.
+*/
+
+module.exports = class CertificateTemplates extends Abstract {
+    constructor() {
+        super("certificateTemplates");
+      }
+
+      static get name() {
+        return "certificateTemplates";
+      }
+}

controllers/v1/userProjects.js

@@ -126,7 +126,6 @@ module.exports = class UserProjects extends Abstract {
     async sync(req) {
         return new Promise(async (resolve, reject) => {
             try {
-
                 let createdProject = await userProjectsHelper.sync(
                     req.params._id,
                     req.query.lastDownloadedAt,
@@ -957,4 +956,174 @@ module.exports = class UserProjects extends Abstract {
         })
     }
 
+    /**
+    * @api {post} /improvement-project/api/v1/userProjects/certificateCallback
+    * Project certificate callback
+    * @apiVersion 1.0.0
+    * @apiGroup User Projects
+    * @apiSampleRequest /improvement-project/api/v1/userProjects/certificateCallback
+    * @apiParamExample {json} Request
+    *   {
+            "event": "sunbird-rc-create",
+            "timestamp": 1660145509358,
+            "data": {
+                "userId": "anonymous",
+                "entityType": "ProjectCertificate",
+                "osid": "ce2244a4-1a17-49a0-a3f9-c151161e70bl",
+                "transactionId": "1-3a4892d8-2221-4e96-9434-f4b37886126b",
+                "status": "SUCCESSFUL",
+                "message": ""
+            },
+            "webhookUrl": "http://ml-project-service:3000/v1/userProjects/certificateCallback"
+        }
+    * @apiParamExample {json} Response:
+    /**{
+            "message": "Successfully generated project certificate",
+            "status": 200,
+            "result": {
+                "_id": "63446059eeffea2b819f036e"
+            }
+        }
+    /**
+
+    /**
+     * Project certificate callback.
+     * @method
+     * @name certificateCallback
+     * @param {Object} req - request data.
+     * @returns {JSON} certificate details.
+    */
+
+    async certificateCallback(req) {
+    return new Promise(async (resolve, reject) => {
+            try {
+                //console request body to check if callback is coming or not and to check any structural change is there or not 
+                console.log("-------------callback request body------------",JSON.stringify(req.body))
+                let certificateDetails = await userProjectsHelper.certificateCallback( req.body.data.transactionId, req.body.data.osid );
+                    return resolve({
+                        message: certificateDetails.message,
+                        result: certificateDetails.data
+                    });
+            } catch (error) {
+                return reject({
+                    status: error.status || HTTP_STATUS_CODE.internal_server_error.status,
+                    message: error.message || HTTP_STATUS_CODE.internal_server_error.message,
+                    errorObject: error
+                });
+            }
+        })
+    }
+
+    /**
+    * @api {get} /improvement-project/api/v1/userProjects/certificates
+    * List of user project with certificate
+    * @apiVersion 1.0.0
+    * @apiGroup User Projects
+    * @apiSampleRequest /improvement-project/api/v1/userProjects/certificates
+    * @apiParamExample {json} Response:
+    *   {
+            "message": "User project fetched successfully",
+            "status": 200,
+            "result": {
+                "data": [{
+                        "_id": "60793b80bd49095a19ddeae1",
+                        "title": "Project with learning resources",
+                        "certificate": {
+                            "osid": "1-21c8ecab-7b8d-40f1-9961-cae7fcb6a5f9",
+                            "status": "active",
+                            "templateId": "600acc42c7de076e6f995147",
+                            "templateUrl": "certificateTemplates/6343bd978f9d8980b7841e85/ba9aa220-ff1b-4717-b6ea-ace55f04fc16_2022-9-10-1665383945769.svg",
+                            "issuedOn": "2020-12-03 13:22:31.988Z"
+                        },
+                        "status": "submitted"
+                    },
+                    {
+                        "_id": "6011136a2d25b926974d9ec9",
+                        "title": "Keep Our Schools Alive! (Petition)",
+                        "status": "submitted",
+                        "certificate": {
+                            "eligible": false,
+                            "templateId": "600acc42c7de076e6f995147",
+                            "message": "Not submitted the project the project within program end date"
+                        }
+                    }
+                ],
+                "count": 2,
+                "certificateCount": 1
+            }
+        }
+    /**
+
+    /**
+     * List user project details with certificate
+     * @method
+     * @name certificates
+     * @returns {JSON} User project detaills with certificate
+    */
+
+    async certificates(req) {
+        return new Promise(async (resolve, reject) => {
+                try {
+                    // fetch projects data of user, whish has certificate on completion
+                    let projectDetails = await userProjectsHelper.certificates( req.userDetails.userInformation.userId );
+                    return resolve({
+                        message: projectDetails.message,
+                        result: projectDetails.data
+                    });
+
+                } catch (error) {
+                    return reject({
+                        status: error.status || HTTP_STATUS_CODE.internal_server_error.status,
+                        message: error.message || HTTP_STATUS_CODE.internal_server_error.message,
+                        errorObject: error
+                    });
+                }
+        })
+    }
+
+    /**
+    * @api {post} /improvement-project/api/v1/userProjects/certificateReIssue
+    * ReIssue project certificate (admin api)
+    * @apiVersion 1.0.0
+    * @apiGroup User Projects
+    * @apiSampleRequest /improvement-project/api/v1/userProjects/certificateReIssue
+    * @apiParamExample {json} Response:
+    /**{
+            "message": "Successfully generated project certificate",
+            "status": 200,
+            "result": {
+                "_id": "63446059eeffea2b819f036e"
+            }
+        }
+    /**
+     * ReIssue project certificate
+     * @method
+     * @name certificateReIssue
+     * @returns {JSON} Reissued details
+    */
+
+     async certificateReIssue(req) {
+        return new Promise(async (resolve, reject) => {
+                try {
+                    // ReIssue certificate of given project : projectId is passed as param 
+                    // This console has to be removed- adding to check the Issuer kid value in case rancher doesn't display console while deployment
+                    console.log("+++++CERTIFICATE_ISSUER_KID+++++ : ",CERTIFICATE_ISSUER_KID)
+                    let projectDetails = await userProjectsHelper.certificateReIssue(
+                        req.params._id,
+                    );
+                    return resolve({
+                        message: projectDetails.message,
+                        result: projectDetails.data
+                    });
+
+                } catch (error) {
+                    return reject({
+                        status: error.status || HTTP_STATUS_CODE.internal_server_error.status,
+                        message: error.message || HTTP_STATUS_CODE.internal_server_error.message,
+                        errorObject: error
+                    });
+                }
+        })
+    }
+
 };

databaseQueries/certificateTemplates.js

@@ -0,0 +1,60 @@
+/**
+ * name : certificateTemplates.js
+ * author : Vishnu
+ * created-date : 03-Oct-2022
+ * Description : Certificate template helper for DB interactions.
+ */
+
+// Dependencies 
+
+/**
+    * CertificateTemplates
+    * @class
+*/
+
+module.exports= class CertificateTemplates{
+    /**
+     * certificate template details.
+     * @method
+     * @name certificateTemplateDocument
+     * @param {Array} [filterData = "all"] - certificate template filter query.
+     * @param {Array} [fieldsArray = "all"] - projected fields.
+     * @param {Array} [skipFields = "none"] - field not to include
+     * @returns {Array} certificateTemplates details.
+    */
+
+    static certificateTemplateDocument(
+        filterData = "all", 
+        fieldsArray = "all",
+        skipFields = "none"
+    ) {
+        return new Promise(async (resolve, reject) => {
+            try {
+                let queryObject = (filterData != "all") ? filterData : {};
+                let projection = {}
+
+                if (fieldsArray != "all") {
+                    fieldsArray.forEach(field => {
+                        projection[field] = 1;
+                   });
+               }
+
+               if( skipFields !== "none" ) {
+                   skipFields.forEach(field=>{
+                       projection[field] = 0;
+                   });
+               }
+               let certificateTemplateDoc = 
+               await database.models.certificateTemplates.find(
+                   queryObject, 
+                   projection
+               ).lean();
+
+               return resolve(certificateTemplateDoc);
+
+            } catch (error) {
+                return reject(error);
+            }
+        });
+    }
+}