fr.vsct.tock.bot.connector.messenger.WebhookActionConverter.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of tock-bot-connector-messenger Show documentation
Bot Connector for Facebook Messenger
There is a newer version: 19.3.3
Show newest version
/*
 * Copyright (C) 2017 VSCT
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package fr.vsct.tock.bot.connector.messenger

import fr.vsct.tock.bot.connector.messenger.model.webhook.Attachment
import fr.vsct.tock.bot.connector.messenger.model.webhook.AttachmentType
import fr.vsct.tock.bot.connector.messenger.model.webhook.LocationPayload
import fr.vsct.tock.bot.connector.messenger.model.webhook.MessageWebhook
import fr.vsct.tock.bot.connector.messenger.model.webhook.OptinWebhook
import fr.vsct.tock.bot.connector.messenger.model.webhook.PostbackWebhook
import fr.vsct.tock.bot.connector.messenger.model.webhook.UrlPayload
import fr.vsct.tock.bot.connector.messenger.model.webhook.Webhook
import fr.vsct.tock.bot.engine.action.SendAttachment
import fr.vsct.tock.bot.engine.action.SendChoice
import fr.vsct.tock.bot.engine.action.SendLocation
import fr.vsct.tock.bot.engine.action.SendSentence
import fr.vsct.tock.bot.engine.event.Event
import fr.vsct.tock.bot.engine.event.SubscribingEvent
import fr.vsct.tock.bot.engine.user.PlayerType
import mu.KotlinLogging

/**
 *
 */
internal object WebhookActionConverter {

    private val logger = KotlinLogging.logger {}

    fun toEvent(message: Webhook, applicationId: String): Event? {
        return when (message) {
            is MessageWebhook ->
                with(message.message) {
                    if (quickReply != null) {
                        SendChoice.decodeChoiceId(quickReply!!.payload)
                                .let { (intentName, parameters) ->
                                    SendChoice(
                                            message.playerId(PlayerType.user),
                                            applicationId,
                                            message.recipientId(PlayerType.bot),
                                            intentName,
                                            parameters)
                                }
                    } else {
                        val a = attachments
                        if (a.isNotEmpty()) {
                            val type = a.first().type
                            when (type) {
                                AttachmentType.location -> readLocation(message, a.first(), applicationId)
                                AttachmentType.image -> readImage(message, a.first(), applicationId)
                            // ignore for now
                                else -> readSentence(message, applicationId)
                            }
                        } else {
                            readSentence(message, applicationId)
                        }
                    }
                }
            is PostbackWebhook ->
                SendChoice.decodeChoiceId(message.postback.payload)
                        .let { (intentName, parameters) ->
                            SendChoice(
                                    message.playerId(PlayerType.user),
                                    applicationId,
                                    message.recipientId(PlayerType.bot),
                                    intentName,
                                    parameters)
                        }
            is OptinWebhook ->
                SubscribingEvent(
                        message.sender?.id ?: message.optin.userRef ?: error("optin webhook must have sender or optin.userRef defined"),
                        message.optin.ref,
                        // the recipient id is the page id, ie the tock application id
                        message.recipient.id!!
                )
            else -> {
                logger.error { "unknown message $message" }
                null
            }
        }
    }

    private fun readSentence(message: MessageWebhook, applicationId: String): SendSentence {
        return SendSentence(
                message.playerId(PlayerType.user),
                applicationId,
                message.recipientId(PlayerType.bot),
                message.message.text ?: "",
                mutableListOf(message),
                message.getMessageId()
        )
    }

    private fun readLocation(message: MessageWebhook, attachment: Attachment, applicationId: String): SendLocation {
        logger.debug { "read location attachment : $attachment" }
        return SendLocation(
                message.playerId(PlayerType.user),
                applicationId,
                message.recipientId(PlayerType.bot),
                (attachment.payload as LocationPayload).coordinates.toUserLocation(),
                message.getMessageId()
        )
    }

    private fun readImage(message: MessageWebhook, attachment: Attachment, applicationId: String): SendAttachment {
        logger.debug { "read image attachment : $attachment" }
        return SendAttachment(
                message.playerId(PlayerType.user),
                applicationId,
                message.recipientId(PlayerType.bot),
                (attachment.payload as UrlPayload).url,
                SendAttachment.AttachmentType.image,
                message.getMessageId()
        )
    }
}