Merge pull request #10 from HWTechClub/pr9

completed all the commands and functions

whatsapp-web.js/src/businessLogic/logic.js

@@ -2,6 +2,7 @@ const { Website } = require("../models/website");
 const { data } = require("../models/data");
 const { Product } = require('../models/product');
 const { User } = require('../models/user');
+const request = require('request');
 
 /**
  * user to be sent the message to
@@ -23,6 +24,17 @@ const addProduct = (id) => {
     // Add a product to the selected website.
     user.getSelectedWebsite().addProduct(product);
 }
+const check = ({checkFunction, callback}) => {
+
+    let checkValue = checkFunction();
+    //if check value is false
+    if(checkValue == '')
+    {
+        return callback();
+    }
+
+    return checkValue;
+}
 
 const checkSelectedWebsiteExist= () => {
 
@@ -40,14 +52,20 @@ const checkSelectedWebsiteExist= () => {
 }
 
 const checkSelectedProductExist = () => {
-    if(user.getSelectedWebsite().getSelectedProduct() == null)
-    {
-        return [
-            `A product should be created or selected`
-        ]
-    }
     
-    return '';
+    return check({
+        checkFunction : checkSelectedWebsiteExist,
+        callback : () => {
+            if(user.getSelectedWebsite().getSelectedProduct() == null)
+            {
+                return [
+                    `A product should be created or selected`
+                ]
+            }
+
+            return '';
+        }
+    });
     
 }
 
@@ -55,7 +73,8 @@ module.exports.setUser = (id) =>{
 
     if(!data.isUser(id))
     {
-        data.addUser(id);
+        
+        data.addUser(new User(id));
     }
     user = data.getUser(id)
 };
@@ -67,120 +86,113 @@ module.exports.setInput= (value) => {
 
 module.exports.onCreateProduct = () => {
 
-    let check = checkSelectedWebsiteExist();
+    return check({
-    if(check)
+        checkFunction : checkSelectedWebsiteExist,
-    {
+        callback : () => {
-        //add the product
+            //add the product
-        addProduct(input['id']);
+            addProduct(input['id']);
             
-        let selectedId = user.getSelectedWebsite().getSelectedProduct().id;
+            let selectedId = user.getSelectedWebsite().getSelectedProduct().id;
         
-        //mesage to be sent to the user
+            //mesage to be sent to the user
-        let message = [
+            let message = [
-            `The product has been created with the id : ${selectedId}`  ,
+                `The product has been created with the id : ${selectedId}`  ,
-            `
+                `
-            This product has been selected. 
+                This product has been selected. 
-            Now you can make change to the product with the following commands : 
+                Now you can make change to the product with the following commands : 
-            1. wg product info 
+                1. wg product info 
-            2. wg product name <product-name> 
+                2. wg product name <product-name> 
-            3. wg product cost <product-cost> 
+                3. wg product cost <product-cost> 
-            4. wg product desc <product-desc> 
+                4. wg product desc <product-desc> 
-            5. wg product image <product-image>
+                5. wg product image <product-image>
-            `
+                `
-        ];
+            ];
+            
+            return message;
+        }
+    });
         
-        return message;
-    }
-    return check;
 }
 
 module.exports.onDeleteProduct = () => {
 
+    return check({
+        checkFunction : checkSelectedWebsiteExist,
+        callback : () => {
 
-    let check = checkSelectedWebsiteExist();
+            if(!user.getSelectedWebsite().deleteProduct(input['id']))
-    if(check)
+            {
-    {
+                return [
+                    `No product with the given id`
+                ];
+            }
         
-        if(!user.getSelectedWebsite().deleteProduct(input['id']))
-        {
             return [
-                `No product with the given id`
+                `The product has been deleted with the id : ` + input['id']
             ];
+
         }
-    
+    });
-        return [
-            `The product has been deleted with the id : ` + input['id']
-        ];
-    
-    }
-
-    return check;
 }
 
 module.exports.onSelectProduct = () => { 
 
     
-    let check = checkSelectedWebsiteExist();
+    return check({
-    if(check)
+        checkFunction : checkSelectedWebsiteExist,
-    {
+        callback : () => {
-        // Find the product with the given id
+
-        if(!user.getSelectedWebsite().selectProduct(input['id']))
+            if(!user.getSelectedWebsite().selectProduct(input['id']))
-        {
+            {
+                return [
+                    `There was no product with the given id. Use the following command to get the list of all id's`,
+                    `wg product all`
+                ];
+            }
+        
             return [
-                `There was no product with the given id. Use the following command to get the list of all id's`,
+                `The product has been selected with the id : ${user.getSelectedWebsite().getSelectedProduct().id}` ,
-                `wg product all`
+                `
+                This product has been selected. 
+                Now you can make change to the product with the following commands : 
+                1. wg product info 
+                2. wg product name <product-name> 
+                3. wg product cost <product-cost> 
+                4. wg product desc <product-desc> 
+                5. wg product image <product-image>
+                `
             ];
+
         }
-    
+    });
-        return [
-            `The product has been selected with the id : ${user.getSelectedWebsite().getSelectedProduct()}` ,
-            `
-            This product has been selected. 
-            Now you can make change to the product with the following commands : 
-            1. wg product info 
-            2. wg product name <product-name> 
-            3. wg product cost <product-cost> 
-            4. wg product desc <product-desc> 
-            5. wg product image <product-image>
-            `
-        ];
-    }
-
-    return check;
 }
 
 module.exports.onGetAllProducts = () => {
 
+    return check({
+        checkFunction : checkSelectedWebsiteExist,
+        callback : () => {
+            let message = [
+                'Your website has following products: '
+            ];
         
-    let check = checkSelectedWebsiteExist();
+            for(let p of user.getSelectedWebsite().getAllProduct())
-    if(check)
+            {
-    {
+                let m = 'Product id: ' + p.id + '\nProduct Name : ' + p.name + '\nProduct description : '+ p.desc + '\nProduct Cost: ' + p.cost + '\nProduct Image : '+ p.image;
-        let message = [
+                message.push(m);
-            'Your website has following products: '
+            }
-        ];
         
-        for(let p of user.getSelectedWebsite().getAllProduct())
+            return message;    
-        {
-            let m = 'Product id: ' + p.id + '\nProduct Name : ' + p.name + '\nProduct description : '+ p.desc + '\nProduct Cost: ' + p.cost + '\nProduct Image : '+ p.image;
-            message.push(m);
         }
-    
+    });
-        return message;    
-    }
-
-    return check;
      
 }
 
 module.exports.onGetProductInfo = () => {
     
-    
+    return check({
-    let check = checkSelectedWebsiteExist();
+        checkFunction : checkSelectedProductExist,
-    if(check)
+        callback : () => {
-    {
-        let check = checkSelectedProductExist();
-        if(check)
-        {
             let selected_product = user.getSelectedWebsite().getSelectedProduct();
             return [
                 `
@@ -192,57 +204,43 @@ module.exports.onGetProductInfo = () => {
                 `
             ];
         }
-    }
+    });
-    return check;
-
 
 }
 
 module.exports.onSetProductName = () => {
-    let check = checkSelectedWebsiteExist();
+
-    if(check)
+    return check({
-    {
+        checkFunction : checkSelectedProductExist,
-        let check = checkSelectedProductExist();
+        callback : () => {
-        if(check)
-        {
             let selected_product = user.getSelectedWebsite().getSelectedProduct();
             selected_product.setName(input['product-name']);
-            let message = [
+            return [
                 'The product name has been set to  '+ selected_product.name
             ];
-            return message;
-        }
-    }
 
-    return check;
+        }
+    });
 }
 
 module.exports.onSetProductCost = () => {
-    let check = checkSelectedWebsiteExist();
+    return check ({
-    if(check)
+        checkFunction : checkSelectedProductExist,
-    {
+        callback : () => {
-        let check = checkSelectedProductExist();
-        if(check)
-        {
             let selected_product = user.getSelectedWebsite().getSelectedProduct();
             selected_product.setCost(input['product-cost']);
-            let message = [
+            return[
                 'The product cost has been set to  '+ selected_product.cost
-                ];
+            ];
-            return message;
-        }
-    }
 
-    return check;
+        }
+    });
 }
 
 module.exports.onSetProductDesc = () => {
-    let check = checkSelectedWebsiteExist();
+    return check({
-    if(check)
+        checkFunction : checkSelectedProductExist,
-    {
+        callback : () => {
-        let check = checkSelectedProductExist();
-        if(check)
-        {
             let selected_product = user.getSelectedWebsite().getSelectedProduct();
             selected_product.setDesc(input['product-desc']);
             let message = [
@@ -250,17 +248,14 @@ module.exports.onSetProductDesc = () => {
             ];
             return message;
         }
-    }
+    });
-    return check;
 }
 
 module.exports.onSetProductImage = () => {
-    let check = checkSelectedWebsiteExist();
+
-    if(check)
+    return check({
-    {
+        checkFunction : checkSelectedProductExist,
-        let check = checkSelectedProductExist();
+        callback : () => {
-        if(check)
-        {
             let selected_product = user.getSelectedWebsite().getSelectedProduct();
             selected_product.setImage(input['product-image']);
             let message = [
@@ -268,8 +263,275 @@ module.exports.onSetProductImage = () => {
             ];
             return message;
         }
-    }
+    });
-    return check;
+}
+
+/**
+ * A help function
+ * @param {void} nothing
+ * @return {help_signal} details on how to use the website
+ */
+
+module.exports.help = () =>
+{
+    let help_signal = [
+        `Here are the following commands that can help you create your website`,
+        `if you want to create a website use *wg create <company name>* and write the name of your company`,
+        `if you already have a website us *wg website <company name>* to get access to the website`,
+        `when creating your website you will be asked to give details of your company. To add these details you will have to write *wg website <firstName>* *wg website <lastName>* etc`,
+        `If you want to check all the products that have already been created for your websit type *wg product all*`,
+        `If you want to create a new product type *wg product new*`,
+        `If you want to select a particular product for manipulating its data, give your product id as such: *wg product <id>`,
+        `To get all information of the product you selected, type *wg product info*`,
+        `To change the product name, type *wg product name <product-name>*`,
+        `To change the product cost, type *wg product cost <product-cost>* `,
+        `To change the product description, type *wg product desc <product-desc>*`,
+        `To change the image of the product, type *wg product image <product-image>*`,
+        `When you are done making your website and want to see it ,type *wg website finished*`,
+        `If you want to delete a product, type *wg delete product<id>* where id is the product id`,
+        `If you want to delete your whole website, type *wg delete website <company name>`,
+        `That is all! Hope you make a great website~`
+    ];
+
+    return help_signal;
+}
+
+/**
+ * wg create 
+ * @param {string} input of the company name
+ * @return {void} gives information on how to add details to website
+ */
+module.exports.onCreateWebsite = () =>
+{
+    user.addWebsite(new Website(input['company_name']));
+
+    return [
+        `welcome to building your own website!`,
+        `We would like you add the following details:`,
+        `wg website firstname *<First_Name>*`, 
+        `wg website lastname *<Last_Name>*`,
+        `wg website companyname *<Company_name>*`, 
+        `wg website logo *<Logo_URL>*`,
+        `wg website banner *<Banner_URL>*`, 
+        `wg website description *<Description>*`, 
+        `wg website email *<Email>*`,
+        `For adding information use *wg website <firstname>*`,
+       
+    ];
 }
 
 
+module.exports.onGetInfo = () => {
+    
+
+    return check({
+        checkFunction : checkSelectedWebsiteExist,
+        callback : () => {
+
+            let website = user.getSelectedWebsite();
+            return [
+                `
+                First Name : ${website.firstName}
+                Last Name : ${website.lastName}
+                Company Name (id) : ${website.companyName }
+                Logo : ${website.logo}
+                Banner : ${website.bannerUrl}
+                Description : ${website.desc}
+                Email : ${website.email}
+                `
+            ];
+        }
+    });
+}
+
+/**
+ *  wg website firstname
+ * @param {string} input of the firstname for website
+ * @return {void} informs you that first name has been added
+ */
+module.exports.onSetFirstName = () =>
+{
+    
+    return check({
+        checkFunction : checkSelectedWebsiteExist,
+        callback : () => {
+
+            user.getSelectedWebsite().firstName = input['firstName'];
+    
+            return [`First name has been set to ${user.getSelectedWebsite().firstName}`];
+        }
+    });
+
+
+}
+
+/**
+ *  wg website lastname 
+ * @param {string} input of the last name for website
+ * @return {void} informs you that last name has been added
+ */
+module.exports.onSetLastName = () =>
+{
+    
+    return check({
+        checkFunction : checkSelectedWebsiteExist,
+        callback : () => {
+
+            user.getSelectedWebsite().lastName = input['lastName'];
+    
+            return [`Last name has been set to ${user.getSelectedWebsite().lastName}`];
+        }
+    });
+}
+
+/**
+ *  wg website logo
+ * @param {string} input of the logo URL for website
+ * @return {void} informs you that logo URL has been added
+ */
+
+module.exports.onSetLogo = () =>
+{    
+    check({
+        checkFunction : checkSelectedWebsiteExist,
+        callback: () => {
+            user.getSelectedWebsite().logoUrl = input['url'];
+    
+            return [`Logo has been set to ${user.getSelectedWebsite().logoUrl}`];
+        }
+    })
+
+}
+
+
+/**
+ *  wg website banner
+ * @param {string} input of the banner URL for website
+ * @return {void} informs you that banner URL has been added
+ */
+module.exports.onSetBanner = () =>
+{    
+    return check({
+        checkFunction : checkSelectedWebsiteExist,
+        callback : () => {
+
+            user.getSelectedWebsite().bannerUrl = input['bannerURL'];
+            return [`Banner has been set to ${user.getSelectedWebsite().bannerUrl}`];
+        }
+    });
+}
+
+
+/**
+ *  wg website description
+ * @param {string} input of the company description for website
+ * @return {void} informs you that description has been added
+ */
+module.exports.onSetDesc = (descriptiondata) =>
+{    
+    return check({
+        checkFunction : checkSelectedWebsiteExist,
+        callback : () => {
+
+            user.getSelectedWebsite().desc = input['desc'];
+            return [`Banner has been set to ${user.getSelectedWebsite().desc}`];
+        }
+    });
+}
+
+/**
+ *  wg website email
+ * @param {string} input of the email for website
+ * @return {void} informs you that email has been added
+ * 
+ */
+
+
+module.exports.onSetEmail = () =>
+{    
+    return check({
+        checkFunction : checkSelectedWebsiteExist,
+        callback : () => {
+
+            user.getSelectedWebsite().email = input['email'];
+            return [`Email has been set to ${user.getSelectedWebsite().email}`];
+        }
+    });
+}
+
+module.exports.onWebsiteFinished = () => {
+    return check({
+        checkFunction : checkSelectedWebsiteExist,
+        callback : async () => {
+            //get json from the website
+            let json = user.getSelectedWebsite().toJson();
+            //creates a promise
+            //resolve and reject value is going to be returned
+            //resolve value = message to be sent
+            let res = new Promise( (resolve, reject) => {
+                request({
+                    url: process.argv[2]+"/generate",
+                    method: "POST",
+                    headers: {
+                        "content-type": "application/json",  // <--Very important!!!
+                    },
+                    body: json
+                }, (error, response, body) => {
+                    //send reject value in promise if error exist
+                    if(error)
+                    {
+                        return reject(error);
+                    }
+                    // messsage to be sent
+                    let returnStatement =  [
+                        `${process.argv[2]}/pages/${JSON.parse(response.body).directory}`,
+                        `*Website ID:* ${JSON.parse(response.body).directory}`,
+                        `*Important to remember the ID*`
+                    ];
+                    //send resolve value id
+                    resolve(returnStatement);
+                });
+            });
+
+            //waits for request to be completed
+            let msg = await res;
+            return msg;
+        }
+    });
+}
+
+module.exports.onDeployWebsite = () => {
+    return check({
+        checkFunction: checkSelectedProductExist,
+        callback : async () => {
+            let res = new Promise( (resolve, reject) => {
+                request({
+                    url: process.argv[2]+"/ipfsdeploy?id="+user.getSelectedWebsite().companyName,
+                    method: "GET",
+                    headers: {
+                        "content-type": "application/json",  // <--Very important!!!
+                    }
+                }, function (error, response, body){
+                    // reject error in promise
+                    if(error)
+                    {
+                        return reject(error);
+                    }
+                    // messsage to be sent
+                    let returnStatement =  [
+                        `https://ipfs.io/ipfs/${JSON.parse(response.body).data}`,
+                        `Takes around 10-30 minutues to deploy`,
+                        `Read more about IPFS https://ipfs.io/`
+                    ];
+                    //send resolve value id
+                    resolve(returnStatement);
+          
+                });
+            });
+
+            let msg = await res;
+            return msg;
+            
+        }
+    });
+}

whatsapp-web.js/src/userInteraction/messages.js

@@ -4,14 +4,10 @@ const logic = require("../businessLogic/logic");
 const { Website } = require("../models/website");
 const { Product } = require('../models/product');
 
-var selected_product = null;// Will keep track of the selected product
-var selected_website = null; // Selected website.
-
-///////////
-//add the commands here
-///////////
 
 
+//commands and the corresponding function to be executed 
+//are input in the array
 const commands = [
      new Command({
         //User command
@@ -34,76 +30,177 @@ const commands = [
         //User command
         command: `wg product new <id>`,
         //function to be executed
-        callback : () =>  logic.onCreateProduct()
+        callback : logic.onCreateProduct
     }),
     new Command({
         //User command
         command: `wg product delete <id>`,
 
         //function to be executed
-        callback : () => logic.onDeleteProduct()
+        callback : logic.onDeleteProduct
     }),
     new Command({
         //User command
         command: `wg product select <id>`,
+        //function to be executed
+        callback : logic.onSelectProduct
+    }),
+        
+        
+    //gives user information on how to create website
+    new Command({
+        //User command
+        command: 'wg help', 
+        //function to be executed
+        callback : logic.help
+    }),
+
+    //helps user to create a website. The first step.
+    new Command({
+        //User command
+        command: 'wg create <company_name>', 
 
         //function to be executed
-        callback : () => logic.onSelectProduct()
+        callback : logic.onCreateWebsite
     }),
+    //Inputs user's first name for website
+    new Command({
+        //User command
+        
+        command: 'wg website firstname <firstName>', 
+
+        //function to be executed
+        callback : logic.onSetFirstName
+    }),
+
+
+    //inputs user last name in website
+    new Command({
+        //User command
+        
+        command: 'wg website lastname <lastName>', 
+
+        //function to be executed
+        callback : logic.onSetLastName
+    }),
+
+    //inputs the logo of the company to website using url of logo
+    new Command({
+        //User command
+        
+        command: 'wg website logo <url>', 
+
+        //function to be executed
+        callback : logic.onSetLogo
+    }),
+
+
+    //inputs the banner for the company to website using url of banner
+    new Command({
+        //User command
+        
+        command: 'wg website banner <bannerURL>', 
+
+        //function to be executed
+        callback : logic.onSetBanner
+    }),
+
+    //inputs the description of the company to be seen in the website
+    new Command({
+        //User command
+        
+        command: 'wg website desc <desc>', 
+
+        //function to be executed
+        callback : logic.onSetDesc
+    }),
+
+    //inputs the email of the company for contacting.
+    new Command({
+        //User command
+        
+        command: 'wg website email <email>', 
+
+        //function to be executed
+        callback : logic.onSetEmail
+    }),
+
+    new Command({
+        //User command
+        
+        command: 'wg website info', 
+
+        //function to be executed
+        callback : logic.onGetInfo
+    }),
+    new Command({
+        //User command
+        
+        command: 'wg website finished', 
+
+        //function to be executed
+        callback : logic.onWebsiteFinished
+    }),
+    //gives user information on how to create website
+
     new Command({
         //User command
         command: `wg product all`,
 
         //function to be executed
-        callback : () => logic.onGetAllProducts()
+        callback : logic.onGetAllProducts
     }),
     new Command({
         //User command
         command: `wg product info`,
 
         //function to be executed
-        callback : () => logic.onGetProductInfo()
+        callback : logic.onGetProductInfo
     }),
     new Command({
         //User command
         command: `wg product name <product-name>`,
 
         //function to be executed
-        callback : () => logic.onSetProductName()
+        callback : logic.onSetProductName
     }),
     new Command({
         //User command
         command: `wg product cost <product-cost>`,
 
         //function to be executed
-        callback : () => logic.onSetProductCost()
+        callback : logic.onSetProductCost
     }),
     new Command({
         //User command
         command: 'wg product desc <product-desc>',
 
         //function to be executed
-        callback : () => logic.onSetProductDesc()
+        callback : logic.onSetProductDesc
     }),
     new Command({
         //User command
         command: 'wg product image <product-image>',
 
         //function to be executed
-        callback : () => logic.onSetProductImage()
+        callback : logic.onSetProductImage
     }),
 ];
 
 
 
-module.exports= onMessage = (message, client) => {
+module.exports= onMessage = async (message, client) => {
 
     let command = null;
 
     //if the message start with wg then proceed
     if(message.body.startsWith("wg"))
     {
+        //loop through all the commands
         for (let c of commands){
+            //check if the message sent is equal to the commands
+            //if the message matches a command,
+            //then save the command in the command variable
             if(c.equals(message.body))
             {
                 command = c;
@@ -111,17 +208,25 @@ module.exports= onMessage = (message, client) => {
             }
         }
         
+        //if the command is not null, implies, the message sent is a valid command
         if(command != null){
             let input = {};
+            //check if the command requires input
             if(command.requireInput){
                 input = command.getInput(message.body);
             }
-            
+            //determine the user
             logic.setUser(message.id.remote);
+            //determine the input
             logic.setInput(input);
 
-            let messageToBeSent = command.callback();
+            //call callback function in the command
+            //await is used, so that if a command is an async function
+            //the program will wait until it is finished
+            //the callback returns a message to be sent to the user
+            let messageToBeSent = await command.callback();
 
+            // send the message to the user
             for (let msg of messageToBeSent)
             {
                 client.sendMessage(message.from, msg, new Object());