co.aurasphere.botmill.kik.model.AbstractDomain Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of kik-botmill Show documentation
Event-driven framework for Kik Messenger's bots
There is a newer version: 2.0.0-RC1
/**
 * 
 * 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.model;

import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.List;

import co.aurasphere.botmill.kik.KikBotMillContext;
import co.aurasphere.botmill.kik.builder.ActionFrameBuilder;
import co.aurasphere.botmill.kik.exception.KikBotMillException;
import co.aurasphere.botmill.kik.incoming.event.AnyEvent;
import co.aurasphere.botmill.kik.incoming.event.DeliveryReceiptEvent;
import co.aurasphere.botmill.kik.incoming.event.EventType;
import co.aurasphere.botmill.kik.incoming.event.FriendPickerEvent;
import co.aurasphere.botmill.kik.incoming.event.IsTypingEvent;
import co.aurasphere.botmill.kik.incoming.event.LinkMessageEvent;
import co.aurasphere.botmill.kik.incoming.event.MentionEvent;
import co.aurasphere.botmill.kik.incoming.event.PictureMessageEvent;
import co.aurasphere.botmill.kik.incoming.event.ScanDataEvent;
import co.aurasphere.botmill.kik.incoming.event.StartChattingEvent;
import co.aurasphere.botmill.kik.incoming.event.StickerEvent;
import co.aurasphere.botmill.kik.incoming.event.TextMessageEvent;
import co.aurasphere.botmill.kik.incoming.event.TextMessagePatternEvent;
import co.aurasphere.botmill.kik.incoming.event.VideoMessageEvent;
import co.aurasphere.botmill.kik.incoming.event.annotation.BotMillController;
import co.aurasphere.botmill.kik.incoming.event.annotation.BotMillDomain;

/**
 * The Class AbstractDomain.
 * 
 * @author Alvin P. Reyes
 */
public abstract class AbstractDomain implements Domain {

	/** The action frame. */
	private ActionFrame actionFrame;

	/**
	 * Instantiates a new abstract domain.
	 */
	public AbstractDomain() {
		try {
			this.buildAnnotatedDomain();
			this.buildDomain();
		} catch (KikBotMillException e) {
			e.printStackTrace();
		}
	}

	/* (non-Javadoc)
	 * @see co.aurasphere.botmill.kik.model.Domain#buildDomain()
	 */
	@Override
	public void buildDomain() {}

	/**
	 * Builds the annotated domain.
	 *
	 * @throws KikBotMillException the kik bot mill exception
	 */
	protected void buildAnnotatedDomain() throws KikBotMillException {
		Method[] methods = this.getClass().getMethods();
		//	check first if this class is BotMillDomain annotated, if not, throw error.
		if(!this.getClass().isAnnotationPresent(BotMillDomain.class)) {
			throw new KikBotMillException("Domain is not BotMillDomain annotated. Make sure the class " + this.getClass().getName() + " is annotated properly.");
		}else {	//	if annotation is present.
			for (Method method : methods) {
				if (method.isAnnotationPresent(BotMillController.class)) {
					BotMillController botMillController = method.getAnnotation(BotMillController.class);
					try {
						actionFrame = new ActionFrame();
						String textOrPattern = "";
						if(!botMillController.text().equals("")) {
							textOrPattern = botMillController.text();
						}else {
							textOrPattern = botMillController.pattern();
						}
						//	set the event.
						actionFrame.setEvent(toEvent(botMillController.event(),textOrPattern));
						method.invoke(this);	// invoke the method.
						
						//	add the action frame to the context.
						KikBotMillContext.getInstance().addActionFrameToContext(actionFrame);
					} catch (IllegalAccessException | IllegalArgumentException | InvocationTargetException e) {
						e.printStackTrace();
					}
				}
			}
		}
	}
	
	/**
	 * Reply.
	 *
	 * @param reply the reply
	 */
	protected final void reply(Reply reply) {
		actionFrame.addReply(reply);
	}
	
	
	/**
	 * Adds the action frame.
	 *
	 * @param event the event
	 * @param reply the reply
	 */
	protected final void addActionFrame(Event event, Reply reply) {
		ActionFrameBuilder.getInstance().setEvent(event).addReply(reply)
		.buildToContext();
	}
	
	/**
	 * Adds the action frame.
	 *
	 * @param event the event
	 * @param replies the replies
	 */
	protected final void addActionFrame(Event event, List> replies) {
		ActionFrameBuilder.getInstance().setEvent(event).addReplies(replies)
		.buildToContext();
	}
	
	/**
	 * Adds the action frame.
	 *
	 * @param event the event
	 * @param replies the replies
	 */
	protected final void addActionFrame(Event event, Reply... replies) {
		ActionFrameBuilder.getInstance().setEvent(event).addReplies(replies)
		.buildToContext();
	}

	/**
	 * Action frame builder.
	 *
	 * @return the action frame builder
	 */
	protected ActionFrameBuilder actionFrameBuilder() {
		return ActionFrameBuilder.getInstance();
	}
	
	/**
	 * To event.
	 *
	 * @param eventType the event type
	 * @param textOrPattern the text or pattern
	 * @return the event
	 */
	private Event toEvent(EventType eventType, String textOrPattern) {
		switch (eventType) {
		case ANY:
			return new AnyEvent();
		case DELIVERY_RECEIPT:
			return new DeliveryReceiptEvent();
		case FRIEND_PICKER:
			return new FriendPickerEvent();
		case IS_TYPING:
			return new IsTypingEvent();
		case LINK:
			return new LinkMessageEvent();
		case MENTION:
			return new MentionEvent();
		case PICTURE:
			return new PictureMessageEvent();
		case SCAN_DATA:
			return new ScanDataEvent();
		case START_CHATTING:	
			return new StartChattingEvent();
		case STICKER:
			return new StickerEvent();
		case TEXT_MESSAGE:
			return new TextMessageEvent().setText(textOrPattern);
		case TEXT_PATTERN:
			return new TextMessagePatternEvent().setPattern(textOrPattern);
		case VIDEO:
			return new VideoMessageEvent();
		}
		return null; // it's impossible to have a null event, but if it does happen, it will be ignored on the handler.
	}
}