Added Json To Action Frame Processor to allow the engine to convert a JSON response to an Action Frame

Author: Alvin Reyes

src/main/java/co/aurasphere/botmill/kik/builder/TextMessageBuilder.java

@@ -93,7 +93,7 @@ public TextMessageBuilder setBody(String body) {
 	/**
 	 * Sets the delay.
 	 *
-	 * @param delay the delay
+	 * @param delay the delay before this message is process. This is in milliseconds.
 	 * @return the text message builder
 	 */
 	public TextMessageBuilder setDelay(Integer delay) {

src/main/java/co/aurasphere/botmill/kik/incoming/event/annotation/AnyEvent.java

@@ -40,6 +40,5 @@
 @Inherited
 @Retention(RetentionPolicy.RUNTIME)
 public @interface AnyEvent {
-
 
 }

src/main/java/co/aurasphere/botmill/kik/incoming/event/annotation/Event.java

@@ -0,0 +1,44 @@
+/**
+ * 
+ * MIT License
+ *
+ * Copyright (c) 2017 BotMill.io
+ * 
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ * 
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ * 
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ * 
+ */
+package co.aurasphere.botmill.kik.incoming.event.annotation;
+
+import java.lang.annotation.Documented;
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Inherited;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * The Interface Event.
+ */
+@Documented
+@Target(ElementType.CONSTRUCTOR)
+@Inherited
+@Retention(RetentionPolicy.RUNTIME)
+public @interface Event {
+
+}

src/main/java/co/aurasphere/botmill/kik/incoming/event/annotation/TextMessageEvent.java

@@ -32,9 +32,6 @@
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
-import co.aurasphere.botmill.kik.incoming.model.IncomingMessage;
-import co.aurasphere.botmill.kik.model.Event;
-
 /**
  * The Interface TextMessageEvent.
  */

src/main/java/co/aurasphere/botmill/kik/incoming/handler/IncomingToOutgoingMessageHandler.java

@@ -150,7 +150,6 @@ private void outgoingHandler(List<Frame> actionFrames, Message message, boolean
 							outgoingMessage = new co.aurasphere.botmill.kik.outgoing.model.ReadReceiptMessage();
 							outgoingMessage = (co.aurasphere.botmill.kik.outgoing.model.ReadReceiptMessage) reply
 									.processReply(message);
-							;
 						} else if (reply instanceof AnyReply) {
 							// don't treat istyping, start chatting or any
 							// non-text incoming message as any reply.

src/main/java/co/aurasphere/botmill/kik/incoming/handler/JsonToActionFrameHandler.java

@@ -29,6 +29,9 @@
 import java.util.List;
 
 import co.aurasphere.botmill.kik.builder.ActionFrameBuilder;
+import co.aurasphere.botmill.kik.builder.LinkMessageBuilder;
+import co.aurasphere.botmill.kik.builder.PictureMessageBuilder;
+import co.aurasphere.botmill.kik.builder.VideoMessageBuilder;
 import co.aurasphere.botmill.kik.factory.EventFactory;
 import co.aurasphere.botmill.kik.factory.ReplyFactory;
 import co.aurasphere.botmill.kik.incoming.handler.model.JsonAction;
@@ -38,47 +41,127 @@
 import co.aurasphere.botmill.kik.model.ActionFrame;
 import co.aurasphere.botmill.kik.model.Event;
 import co.aurasphere.botmill.kik.model.Frame;
+import co.aurasphere.botmill.kik.model.Message;
+import co.aurasphere.botmill.kik.model.Reply;
 import co.aurasphere.botmill.kik.network.NetworkUtils;
+import co.aurasphere.botmill.kik.outgoing.model.LinkMessage;
+import co.aurasphere.botmill.kik.outgoing.model.PictureMessage;
+import co.aurasphere.botmill.kik.outgoing.model.VideoMessage;
+import co.aurasphere.botmill.kik.outgoing.reply.LinkMessageReply;
+import co.aurasphere.botmill.kik.outgoing.reply.PictureMessageReply;
 import co.aurasphere.botmill.kik.outgoing.reply.TextMessageReply;
+import co.aurasphere.botmill.kik.outgoing.reply.VideoMessageReply;
 
 /**
  * The Class JsonToActionFrameHandler.
  * 
  * @author Alvin P. Reyes
  */
 public class JsonToActionFrameHandler {
-	
+
 	/** The Constant CONST_TEXT. */
 	private static final String CONST_TEXT = "text";
-	
+
 	/** The Constant CONST_PATTERN. */
 	private static final String CONST_PATTERN = "pattern";
 
 	/**
 	 * Json to text message reply.
 	 *
 	 * @param jsonUrl
-	 *            the json url
+	 *            the json url. 
+	 *            
+	 * JSON Format of the source should follow the following convention.
+	 * 
+	 * {
+	 *	"jsonkikbotmill": [
+	 *			{
+	 *				"event":"pattern",
+	 *				"input":"(?i:who (wrote|created|create) (this|you|)[\\?])",
+	 *				"replies":[
+	 *						{"type":"text","text":{"body":"Written by the brilliant minds of Alvin Reyes and Donato Rimenti. Bad-ass Java Developers."}},
+	 *						{"type":"text","text":{"body":"Written by the brilliant minds of Alvin Reyes and Donato Rimenti. Bad-ass Java Developers."}},
+	 *						{"type":"picture", "picture":{"text":"picture","title":"title picture","url":""}},
+	 *						{"type":"link","link": {"text":"link","title":"link title","url":""}},
+	 *						{"type":"video", "video": {"text":"video","title":"title video","url":""}},
+	 *				]
+	 *			}
+	 *		]
+	 *	}
 	 * @return the list
 	 */
 	public static List<Frame> jsonToFrameReply(String jsonUrl) {
-		
-	
+
 		List<Frame> list = new ArrayList<Frame>();
 		String json = NetworkUtils.get(jsonUrl);
 		JsonToActionFrame a = JsonUtils.fromJson(json, JsonToActionFrame.class);
-		
+
 		for (JsonAction jaction : a.getJsonTextAction()) {
-			
+
 			if (jaction.getEvent().equals(CONST_PATTERN)) {
-				
-				
+				list.add(ActionFrameBuilder.getInstance().setEvent(EventFactory.textMessagePattern(jaction.getInput()))
+						.addReplies(processReplies(jaction)).build());
+			}else if (jaction.getEvent().equals(CONST_TEXT)) {
+				list.add(ActionFrameBuilder.getInstance().setEvent(EventFactory.textMessage(jaction.getInput()))
+						.addReplies(processReplies(jaction)).build());
 			}
 		}
 
 		return list;
 	}
 
-	
-	
+	/**
+	 * Process replies.
+	 *
+	 * @param jaction the jaction
+	 * @return the list< reply<? extends message>>
+	 */
+	private static List<Reply<? extends Message>> processReplies(JsonAction jaction) {
+		
+		List<Reply<? extends Message>> replies = new ArrayList<Reply<? extends Message>>();
+		
+		for(JsonReply jsonReply:jaction.getReplies()) {
+			if(jsonReply.getType().equals("text")) {
+				replies.add(ReplyFactory.buildTextMessageReply(jsonReply.getText().getBody()));
+			}
+			
+			if(jsonReply.getType().equals("picture")) {
+				replies.add(new PictureMessageReply() {
+					
+					@Override
+					public PictureMessage processReply(Message message) {
+						return PictureMessageBuilder.getInstance()
+								.setPicUrl(jsonReply.getPicture().getPicUrl())
+								.build();
+					}
+				});
+			}
+			if(jsonReply.getType().equals("video")) {
+				replies.add(new VideoMessageReply() {
+					
+					@Override
+					public VideoMessage processReply(Message message) {
+						return VideoMessageBuilder.getInstance()
+								.setVideoUrl(jsonReply.getVideo().getVideoUrl())
+								.build();
+					}
+				});
+			}
+			if(jsonReply.getType().equals("link")) {
+				replies.add(new LinkMessageReply() {
+					
+					@Override
+					public LinkMessage processReply(Message message) {
+						return LinkMessageBuilder.getInstance().setText(jsonReply.getLink().getText())
+								.setTitle(jsonReply.getLink().getTitle())
+								.setUrl(jsonReply.getLink().getUrl())
+								.build();
+					}
+				});
+			}
+		}
+		
+		return replies;
+	}
+
 }

src/main/java/co/aurasphere/botmill/kik/incoming/handler/model/JsonAction.java

@@ -46,37 +46,78 @@ public class JsonAction {
 	/** The output. */
 	private String input;
 
+	/** The replies. */
 	@SerializedName("replies")
 	private List<JsonReply> replies;
 
+	/**
+	 * Gets the keyboards.
+	 *
+	 * @return the keyboards
+	 */
 	public List<JsonKeyboard> getKeyboards() {
 		return keyboards;
 	}
 
+	/**
+	 * Sets the keyboards.
+	 *
+	 * @param keyboards the new keyboards
+	 */
 	public void setKeyboards(List<JsonKeyboard> keyboards) {
 		this.keyboards = keyboards;
 	}
 
+	/**
+	 * Gets the event.
+	 *
+	 * @return the event
+	 */
 	public String getEvent() {
 		return event;
 	}
 
+	/**
+	 * Sets the event.
+	 *
+	 * @param event the new event
+	 */
 	public void setEvent(String event) {
 		this.event = event;
 	}
 
+	/**
+	 * Gets the input.
+	 *
+	 * @return the input
+	 */
 	public String getInput() {
 		return input;
 	}
 
+	/**
+	 * Sets the input.
+	 *
+	 * @param input the new input
+	 */
 	public void setInput(String input) {
 		this.input = input;
 	}
 
+	/**
+	 * Gets the replies.
+	 *
+	 * @return the replies
+	 */
 	public List<JsonReply> getReplies() {
 		return replies;
 	}
 
+	/**
+	 * Sets the replies.
+	 *
+	 * @param replies the new replies
+	 */
 	public void setReplies(List<JsonReply> replies) {
 		this.replies = replies;
 	}