zcatalyst-cli 1.10.1 → 1.12.1

package/templates/init/functions/java/integ/cliq/com/handlers/BotHandler.java

@@ -21,7 +21,7 @@ import com.zc.cliq.objects.BotContextParam;
 import com.zc.cliq.objects.BotSuggestion;
 import com.zc.cliq.objects.ButtonObject;
 import com.zc.cliq.objects.CardDetails;
-import com.zc.cliq.objects.MessageBuilder;
+import com.zc.cliq.objects.Message;
 import com.zc.cliq.objects.Slide;
 import com.zc.cliq.requests.BotContextHandlerRequest;
 import com.zc.cliq.requests.BotMentionHandlerRequest;
@@ -31,113 +31,120 @@ import com.zc.cliq.requests.BotParticipationHandlerRequest;
 import com.zc.cliq.requests.BotWebhookHandlerRequest;
 import com.zc.cliq.requests.BotWelcomeHandlerRequest;
 import com.zc.cliq.util.ZCCliqUtil;
+import com.zc.component.cache.ZCCache;
 
-public class BotHandler implements com.zc.cliq.interfaces.BotHandler
-{
+public class BotHandler implements com.zc.cliq.interfaces.BotHandler {
 	Logger LOGGER = Logger.getLogger(BotHandler.class.getName());
-	
+
 	@Override
-	public Map<String,Object> welcomeHandler(BotWelcomeHandlerRequest req) {
+	public Map<String, Object> welcomeHandler(BotWelcomeHandlerRequest req) {
 		String uName = req.getUser() != null ? req.getUser().getFirstName() : "user";
 		String text = "Hello " + uName + ". Thank you for subscribing :smile:";
-		MessageBuilder msg = MessageBuilder.getInstance(text);
+		Message msg = Message.getInstance(text);
 		return ZCCliqUtil.toMap(msg);
 	}
-	
+
 	@Override
-	public Map<String,Object> messageHandler(BotMessageHandlerRequest req) {
-		try{
-			
-		String message = req.getMessage();
-		Map<String, Object> resp = new HashMap<String, Object>();
-		
-		String text;
-		if(message == null){
-			text = "Please enable 'Message' in bot settings";
-		}
-		else if(message.equalsIgnoreCase("hi") || message.equalsIgnoreCase("hey")){
-			text = "Hi " + req.getUser().getFirstName() + " :smile: How are you doing?";
-			BotSuggestion suggestion = BotSuggestion.getInstance();
-			suggestion.addSuggestion("Good");
-			suggestion.addSuggestion("Not bad");
-			suggestion.addSuggestion("Meh");
-			suggestion.addSuggestion("Worst");
-			resp.put("suggestions", suggestion);
-		}
-		else if(message.equalsIgnoreCase("Good") || message.equalsIgnoreCase("Not bad")){
-			text = "That's glad to hear :smile:";
-		}
-		else if(message.equalsIgnoreCase("Meh") || message.equalsIgnoreCase("Worst")){
-			text = "Oops! Don't you worry. Your day is definitely going to get better. :grinning:";
-		}
-		else if(message.equalsIgnoreCase("details")){
-			text = "Welcome to details collection center :wink:";
-			
-			BotContext context = BotContext.getInstance();
-			context.setId("personal_details");
-			context.setTimeout(300);
-			
-			BotContextParam param1 = BotContextParam.getInstance();
-			param1.setName("name");
-			param1.setQuestion("Please enter your name: ");
-			
-			BotContextParam param2 = BotContextParam.getInstance();
-			param2.setName("dept");
-			param2.setQuestion("Please enter your department: ");
-			param2.addSuggestion("CSE");
-			param2.addSuggestion("IT");
-			param2.addSuggestion("MECH");
-			
-			context.setParams(param1, param2);
-			resp.put("context", context);
-		}
-		else if(message.equalsIgnoreCase("button")){
-			
-			MessageBuilder msg = MessageBuilder.getInstance("Here's your button");
-			ButtonObject btnObj = new ButtonObject();
-			btnObj.setType(BUTTON_TYPE.RED_OUTLINE);
-			btnObj.setLabel("Button1");
-			Action action = new Action();
-			action.setType(ACTION_TYPE.INVOKE_FUNCTION);
-			ActionData actionData = new ActionData();
-			actionData.setName("btnFunction");// ** ENTER YOUR BUTTON FUNCTION NAME HERE **
-			action.setData(actionData);
-			btnObj.setAction(action);
-			msg.addButton(btnObj);
-			return ZCCliqUtil.toMap(msg);
-		}
-		else{
-			text = "Sorry, I'm not programmed yet to do this :sad:";
-		}
-		
-		resp.put("text", text);
-		return resp;
-		
-		}
-		catch(Exception ex){
+	public Map<String, Object> messageHandler(BotMessageHandlerRequest req) {
+		try {
+			String message = req.getMessage();
+			Map<String, Object> resp = new HashMap<String, Object>();
+
+			String text;
+			if (message == null) {
+				text = "Please enable 'Message' in bot settings";
+			} else if (message.equalsIgnoreCase("hi") || message.equalsIgnoreCase("hey")) {
+				text = "Hi " + req.getUser().getFirstName() + " :smile: How are you doing?";
+				BotSuggestion suggestion = BotSuggestion.getInstance();
+				suggestion.addSuggestion("Good");
+				suggestion.addSuggestion("Not bad");
+				suggestion.addSuggestion("Meh");
+				suggestion.addSuggestion("Worst");
+				resp.put("suggestions", suggestion);
+			} else if (message.equalsIgnoreCase("Good") || message.equalsIgnoreCase("Not bad")) {
+				text = "That's glad to hear :smile:";
+			} else if (message.equalsIgnoreCase("Meh") || message.equalsIgnoreCase("Worst")) {
+				text = "Oops! Don't you worry. Your day is definitely going to get better. :grinning:";
+			} else if (message.equalsIgnoreCase("details")) {
+				text = "Welcome to details collection center :wink:";
+
+				BotContext context = BotContext.getInstance();
+				context.setId("personal_details");
+				context.setTimeout(300);
+
+				BotContextParam param1 = BotContextParam.getInstance();
+				param1.setName("name");
+				param1.setQuestion("Please enter your name: ");
+
+				BotContextParam param2 = BotContextParam.getInstance();
+				param2.setName("dept");
+				param2.setQuestion("Please enter your department: ");
+				param2.addSuggestion("CSE");
+				param2.addSuggestion("IT");
+				param2.addSuggestion("MECH");
+
+				BotContextParam param3 = BotContextParam.getInstance();
+				param3.setName("cache");
+				param3.setQuestion("Do you wish to put this detail in Catalyst Cache ?");
+				param3.addSuggestion("YES");
+				param3.addSuggestion("NO");
+
+				context.setParams(param1, param2, param3);
+				resp.put("context", context);
+			} else if (message.equalsIgnoreCase("button")) {
+
+				Message msg = Message.getInstance("Here's your button");
+				ButtonObject btnObj = new ButtonObject();
+				btnObj.setType(BUTTON_TYPE.RED_OUTLINE);
+				btnObj.setLabel("Button1");
+				Action action = new Action();
+				action.setType(ACTION_TYPE.INVOKE_FUNCTION);
+				ActionData actionData = new ActionData();
+				actionData.setName("btnFunction");// ** ENTER YOUR BUTTON FUNCTION NAME HERE **
+				action.setData(actionData);
+				btnObj.setAction(action);
+				msg.addButton(btnObj);
+				return ZCCliqUtil.toMap(msg);
+			} else {
+				text = "Sorry, I'm not programmed yet to do this :sad:";
+			}
+
+			resp.put("text", text);
+			return resp;
+
+		} catch (Exception ex) {
 			LOGGER.log(Level.SEVERE, "Exception in message handler. ", ex);
 			throw ex;
 		}
 	}
-	
+
 	@Override
 	public Map<String, Object> contextHandler(BotContextHandlerRequest req) {
-		
 		Map<String, Object> resp = new HashMap<String, Object>();
-		if(req.getContextId().equals("personal_details")){
+		if (req.getContextId().equals("personal_details")) {
 			Map<String, String> answers = req.getAnswers();
 			StringBuilder str = new StringBuilder();
-			str.append("Name: ").append(answers.get("name")).append("\n");
-			str.append("Department: ").append(answers.get("dept")).append("\n");
-			
+			str.append("*Name*: ").append(answers.get("name")).append("\n");
+			str.append("*Department*: ").append(answers.get("dept")).append("\n");
+
+			if(answers.get("cache").equals("YES")) {
+				try {
+					ZCCache cache = ZCCache.getInstance();
+					cache.putCacheValue("Name", answers.get("name"), 1L);
+					cache.putCacheValue("Department", answers.get("dept"), 1L);
+					str.append("This data is now available in Catalyst Cache's default segment.");
+				} catch(Exception ex) {
+					System.out.print("Error putting the value to cache: " + ex.toString());
+				}
+			}
+
 			resp.put("text", "Nice ! I have collected your info: \n" + str.toString());
 		}
 		return resp;
 	}
 
 	@Override
-	public Map<String, Object> mentionHandler(BotMentionHandlerRequest req)
-	{
+	public Map<String, Object> mentionHandler(BotMentionHandlerRequest req) {
 		String text = "Hey *" + req.getUser().getFirstName() + "*, thanks for mentioning me here. I'm from Catalyst city";
 		Map<String, Object> resp = new HashMap<String, Object>();
 		resp.put("text", text);
@@ -148,13 +155,11 @@ public class BotHandler implements com.zc.cliq.interfaces.BotHandler
 	public Map<String, Object> menuActionHandler(BotMenuActionHandlerRequest req) {
 		Map<String, Object> resp = new HashMap<String, Object>();
 		String text;
-		if(req.getActionName().equals("Say Hi")){
+		if (req.getActionName().equals("Say Hi")) {
 			text = "Hi";
-		}
-		else if(req.getActionName().equals("Look Angry")){
+		} else if (req.getActionName().equals("Look Angry")) {
 			text = ":angry:";
-		}
-		else{
+		} else {
 			text = "Menu action triggered :fist:";
 		}
 		resp.put("text", text);
@@ -162,60 +167,58 @@ public class BotHandler implements com.zc.cliq.interfaces.BotHandler
 	}
 
 	@Override
-	public Map<String, Object> webhookHandler(BotWebhookHandlerRequest req) throws Exception
-	{	
+	public Map<String, Object> webhookHandler(BotWebhookHandlerRequest req) throws Exception {
 		// Sample handler class for incoming mails in ZohoMail
 		// Please configure the bot in ZohoMail's outgoing webhooks
 		JSONObject reqBody = req.getBody();
 		String summary;
-		String bodyStr = new StringBuilder("*From*: ").append(reqBody.getString("fromAddress"))
-						.append("\n*Subject*: ").append(reqBody.getString("subject"))
-						.append("\n*Content*: ").append((summary=reqBody.getString("summary")).length() > 100 ? summary.substring(0, 100) : summary).toString();
-		MessageBuilder msg = MessageBuilder.getInstance(bodyStr);
-		msg.setBot("PostPerson", "https://previews.123rf.com/images/nastyatrel/nastyatrel2006/nastyatrel200600035/149438272-flat-vector-illustration-chat-bot-icon-flat-line-style-vector-.jpg");
+		String bodyStr = new StringBuilder("*From*: ").append(reqBody.getString("fromAddress")).append("\n*Subject*: ").append(reqBody.getString("subject")).append("\n*Content*: ").append((summary = reqBody.getString("summary")).length() > 100 ? summary.substring(0, 100) : summary).toString();
+		Message msg = Message.getInstance(bodyStr);
+		msg.setBot("PostPerson", "https://www.zoho.com/sites/default/files/catalyst/functions-images/icon-robot.jpg");
 		CardDetails card = CardDetails.getInstance();
 		card.setTitle("New Mail");
-		card.setThumbnail("https://seekicon.com/free-icon-download/mail-icon_18.svg");
+		card.setThumbnail("https://www.zoho.com/sites/default/files/catalyst/functions-images/mail.svg");
 		msg.setCard(card);
-		
+
 		ButtonObject button = new ButtonObject();
 		button.setLabel("Open mail");
 		button.setType(BUTTON_TYPE.GREEN_OUTLINE);
 		button.setHint("Click to open the mail in a new tab");
-		Action action  = new Action();
+		Action action = new Action();
 		action.setType(ACTION_TYPE.OPEN_URL);
 		ActionData actionData = new ActionData();
 		actionData.setWeb("https://mail.zoho.com/zm/#mail/folder/inbox/p/" + reqBody.getLong("messageId"));
 		action.setData(actionData);
 		button.setAction(action);
-		
+
 		msg.addButton(button);
-		
+
 		Slide gifSlide = Slide.getInstance();
 		gifSlide.setType(SLIDE_TYPE.IMAGES);
 		gifSlide.setTitle("");
-		List<String> obj = new ArrayList<String>(){{add("https://media.giphy.com/media/efyEShk2FJ9X2Kpd7V/giphy.gif");}};
+		List<String> obj = new ArrayList<String>() {
+			{
+				add("https://media.giphy.com/media/efyEShk2FJ9X2Kpd7V/giphy.gif");
+			}
+		};
 		gifSlide.setData(obj);
-		
+
 		msg.addSlide(gifSlide);
-		
+
 		return ZCCliqUtil.toMap(msg);
 	}
 
 	@Override
-	public Map<String, Object> participationHandler(BotParticipationHandlerRequest req) throws Exception
-	{
+	public Map<String, Object> participationHandler(BotParticipationHandlerRequest req) throws Exception {
 		String text;
-		if(req.getOperation().equals(CHANNEL_OPERATION.ADDED)){
+		if (req.getOperation().equals(CHANNEL_OPERATION.ADDED)) {
 			text = "Hi. Thanks for adding me to the channel :smile:";
-		}
-		else if(req.getOperation().equals(CHANNEL_OPERATION.REMOVED)){
+		} else if (req.getOperation().equals(CHANNEL_OPERATION.REMOVED)) {
 			text = "Bye-Bye :bye-bye:";
-		}
-		else{
+		} else {
 			text = "I'm too a participant of this chat :wink:";
 		}
-		MessageBuilder msg = MessageBuilder.getInstance(text);
+		Message msg = Message.getInstance(text);
 		return ZCCliqUtil.toMap(msg);
 	}
 }

package/templates/init/functions/java/integ/cliq/com/handlers/CommandHandler.java

@@ -15,39 +15,33 @@ import com.zc.cliq.objects.FormValue;
 import com.zc.cliq.requests.CommandHandlerRequest;
 import com.zc.cliq.util.ZCCliqUtil;
 
-public class CommandHandler implements com.zc.cliq.interfaces.CommandHandler
-{
+public class CommandHandler implements com.zc.cliq.interfaces.CommandHandler {
 	@Override
-	public Map<String, Object> executionHandler(CommandHandlerRequest req) throws Exception{
-		
+	public Map<String, Object> executionHandler(CommandHandlerRequest req) throws Exception {
+
 		Map<String, Object> resp = new HashMap<String, Object>();
 		String text;
 		String commandName = req.getName();
-		if(commandName.equals("catalystresource")){
+		if (commandName.equals("catalystresource")) {
 			List<CommandSuggestion> suggestions = req.getSelections();
-			if(suggestions == null || suggestions.isEmpty()){
+			if (suggestions == null || suggestions.isEmpty()) {
 				text = "Please select a suggestion from the command";
-			}
-			else{
+			} else {
 				String prefix = "Take a look at our ";
-				if(suggestions.get(0).getTitle().equals("API doc")){
+				if (suggestions.get(0).getTitle().equals("API doc")) {
 					text = prefix + "[API Documentation](https://www.zoho.com/catalyst/help/api/introduction/overview.html)";
-				}
-				else if(suggestions.get(0).getTitle().equals("CLI doc")){
+				} else if (suggestions.get(0).getTitle().equals("CLI doc")) {
 					text = prefix + "[CLI Documentation](https://www.zoho.com/catalyst/help/cli-command-reference.html)";
-				}
-				else{
+				} else {
 					text = prefix + "[help documentation](https://www.zoho.com/catalyst/help/)";
 				}
 			}
-		}
-		else if(commandName.equals("getform")){
+		} else if (commandName.equals("getform")) {
 			return getForm();
-		}
-		else{
+		} else {
 			text = "Command executed successfully!";
 		}
-		
+
 		resp.put("text", text);
 		return resp;
 	}
@@ -55,7 +49,7 @@ public class CommandHandler implements com.zc.cliq.interfaces.CommandHandler
 	@Override
 	public List<CommandSuggestion> suggestionHandler(CommandHandlerRequest req) {
 		List<CommandSuggestion> suggestionList = new ArrayList<CommandSuggestion>();
-		if(req.getName().equals("catalystresource")){
+		if (req.getName().equals("catalystresource")) {
 			CommandSuggestion sugg1 = CommandSuggestion.getInstance("API doc", "Catalyst API documentation", "https://www.zohowebstatic.com/sites/default/files/styles/product-home-page/public/catalyst-icon.png");
 			CommandSuggestion sugg2 = CommandSuggestion.getInstance("CLI doc", "Catalyst CLI documentation", "https://www.zohowebstatic.com/sites/default/files/styles/product-home-page/public/catalyst-icon.png");
 			CommandSuggestion sugg3 = CommandSuggestion.getInstance("Help doc", "Catalyst Help documentation", "https://www.zohowebstatic.com/sites/default/files/styles/product-home-page/public/catalyst-icon.png");
@@ -66,20 +60,19 @@ public class CommandHandler implements com.zc.cliq.interfaces.CommandHandler
 		return suggestionList;
 	}
 
-	private static Map<String, Object> getForm()
-	{
+	private static Map<String, Object> getForm() {
 		Form form = Form.getInstance();
 		form.setTitle("Asset Request");
 		form.setHint("Raise your asset request");
 		form.setName("ID");
 		form.setButtonLabel("Raise Request");
 		form.setVersion(1);
-		
+
 		FormActionsObject actions = FormActionsObject.getInstance();
 		actions.setSubmitAction("formFunctionLatest"); // ** ENTER YOUR FORM FUNCTION NAME HERE **
-		
+
 		form.setActions(actions);
-		
+
 		FormInput username = FormInput.getIntance();
 		username.setType(FORM_FIELD_TYPE.TEXT);
 		username.setName("username");
@@ -89,7 +82,7 @@ public class CommandHandler implements com.zc.cliq.interfaces.CommandHandler
 		username.setMandatory(true);
 		username.setValue("Harold Finch");
 		form.addFormInput(username);
-		
+
 		FormInput email = FormInput.getIntance();
 		email.setType(FORM_FIELD_TYPE.TEXT);
 		email.setFormat(FORM_FIELD_TEXT_FORMAT.EMAIL);
@@ -100,7 +93,7 @@ public class CommandHandler implements com.zc.cliq.interfaces.CommandHandler
 		email.setMandatory(true);
 		email.setValue("haroldfinch@samaritan.com");
 		form.addFormInput(email);
-		
+
 		FormInput assetType = FormInput.getIntance();
 		assetType.setType(FORM_FIELD_TYPE.SELECT);
 		assetType.setTriggerOnChange(true);
@@ -112,7 +105,7 @@ public class CommandHandler implements com.zc.cliq.interfaces.CommandHandler
 		assetType.addOption(new FormValue("Laptop", "laptop"));
 		assetType.addOption(new FormValue("Mobile", "mobile"));
 		form.addFormInput(assetType);
-		
+
 		return ZCCliqUtil.toMap(form);
 	}
 }